This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
bw:crystal_reports_tool [2019/10/07 14:30] akoehler [Example 2] |
bw:crystal_reports_tool [2022/08/02 16:50] (current) akoehler |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| This document describes the use of the Bizweaver Crystal Reports tool. | This document describes the use of the Bizweaver Crystal Reports tool. | ||
| - | ====== Audience ====== | + | =====Related Documents===== |
| - | This document is intended for developers | + | The following pages contain additional information that may be helpful with the development |
| - | ====== Related Documents ====== | + | * **[[bw: |
| + | * **[[bw: | ||
| - | The following documents contain additional information that may be helpful with the development of Bizweaver workflows. | + | =====Before You Begin===== |
| - | * [[bw: | + | You must have a Crystal Reports source file (.RPT) to use this tool. |
| - | * [[bw: | + | |
| - | * [[bw: | + | |
| - | ====== Before You Begin ====== | + | <WRAP center round important 80%> |
| + | To ensure proper functionality of Crystal Reports with Bizweaver, TLS 1.0 and 1.1 need to be enabled on the Bizweaver server. | ||
| + | </ | ||
| - | You must have a Crystal Reports | + | <WRAP center round tip 80%> |
| + | General information about configuring | ||
| + | </ | ||
| - | The source files need to reside on the same server as Bizweaver. We have found that the Crystal Reports runtime engine, which actually generates the reports, does not function well when the report is on another server and is accessed via a network share. | + | The source |
| - | ====== Crystal Reports Tool ====== | + | =====Crystal Reports Tool===== |
| The Crystal Reports tool is used to execute a previously developed Crystal Report within a workflow. The resulting output can then be saved to disk, printed, or used for other purposes such as an attachment for email distribution. | The Crystal Reports tool is used to execute a previously developed Crystal Report within a workflow. The resulting output can then be saved to disk, printed, or used for other purposes such as an attachment for email distribution. | ||
| Line 27: | Line 30: | ||
| The configuration of the Crystal Reports tool is illustrated by the examples that follow | The configuration of the Crystal Reports tool is illustrated by the examples that follow | ||
| - | ====== Example 1 ====== | + | =====General Configuration===== |
| - | The following example illustrates a simple workflow to generate | + | <WRAP center round tip 80%> |
| + | The Crystal Reports tool has a dependency on the Crystal | ||
| + | </ | ||
| - | {{:: | + | The following example illustrates a simple workflow to generate a Crystal Report, saved to disk and printed. Typical production examples will be more complicated. An example of a report that uses parameters is found later in this document. |
| - | - Enter a unique **Name**. | + | {{ :: |
| - | - See rules above. | + | |
| - | - Enter an optional **Description**. | + | |
| - | - **Report Source Path** identifies the Crystal Report source file to be executed. | + | |
| - | ===== Output Options ===== | + | * Enter a unique **Name**. |
| + | * See rules above. | ||
| + | * Enter an optional **Description**. | ||
| + | * **Report Source Path** identifies the Crystal Report source file to be executed. | ||
| + | * **Output Options** and **Parameters** are described below. | ||
| + | * **Login Information** defines the target server and database where your data is found, as well as the logon credentials. | ||
| + | * Select the target **DB Type** from the drop-down; either __SQL__ or __HANA__. | ||
| + | |||
| + | |||
| + | =====Output Options===== | ||
| Output options are selected via the appropriate checkbox. | Output options are selected via the appropriate checkbox. | ||
| - | {{: | + | {{ : |
| At least one option must be selected but both can be selected as well. | At least one option must be selected but both can be selected as well. | ||
| - | ==== Print Option ==== | + | ====Print Option ==== |
| The **Print** option generates the report and sends it to the printer selected from the drop-down list. The number of copies can also be selected. | The **Print** option generates the report and sends it to the printer selected from the drop-down list. The number of copies can also be selected. | ||
| - | {{: | + | {{ : |
| - | ==== Save to Disk Option ==== | + | ====Save to Disk Option==== |
| - The **Save to disk** option generates the report and saves it to disk in PDF format. Click the [ …] button for a standard Windows “save as” dialog. | - The **Save to disk** option generates the report and saves it to disk in PDF format. Click the [ …] button for a standard Windows “save as” dialog. | ||
| Line 58: | Line 69: | ||
| - **Server, Database, Username, and Password** are used to connect to the desired database needed to execute the report. | - **Server, Database, Username, and Password** are used to connect to the desired database needed to execute the report. | ||
| - | ====== Example 2 ====== | + | =====Parameters===== |
| Many Crystal Reports will use parameters to define the information to be reported. When a parameter is detected in the report it is listed in the **Parameters** section of the tool. | Many Crystal Reports will use parameters to define the information to be reported. When a parameter is detected in the report it is listed in the **Parameters** section of the tool. | ||
| - | {{: | + | {{ : |
| The value assigned to each parameter could be a static value, a Bizweaver Step Variable, a value from a Bizweaver User variable, or, as in this case, a value from a previous SQL step. Press F4 while in the “Parameter Value” field to display the list of available variables. | The value assigned to each parameter could be a static value, a Bizweaver Step Variable, a value from a Bizweaver User variable, or, as in this case, a value from a previous SQL step. Press F4 while in the “Parameter Value” field to display the list of available variables. | ||
| Line 68: | Line 79: | ||
| In this example the parameter in the Crystal Report is “CardType.” In the image above a variable in the workflow is used to provide the value for the parameter. The following image shows the same parameter provided as a static value. | In this example the parameter in the Crystal Report is “CardType.” In the image above a variable in the workflow is used to provide the value for the parameter. The following image shows the same parameter provided as a static value. | ||
| - | {{: | + | {{ : |
| - | The rest of the tool setup is the same a described in **// | + | =====Managing Output Files===== |
| - | + | ||
| - | ====== Managing Output Files ====== | + | |
| When you create PDF files as output you will usually need to do something with the file. The three main options are to leave the file in place, move the file to a different folder, or delete the file. | When you create PDF files as output you will usually need to do something with the file. The three main options are to leave the file in place, move the file to a different folder, or delete the file. | ||
| - | Moving or deleting the file is done with the File Operations tool. See the **// | + | Moving or deleting the file is done with the File Operations tool. Information about using this tool is found **// |
| + | |||
| + | ====Crystal Reports Variables==== | ||
| + | ^Name ^Description^ | ||
| + | |ActionPrint|This indicates if the print checkbox is selected| | ||
| + | |ActionSave|This indicates if the save to disk checkbox is selected| | ||
| + | |Database|This indicates the database selected for the Crystal Report| | ||
| + | |DBType|This indicates the database type ex. SQL, HANA| | ||
| + | |Format|This indicates the format of the output file radio button that is selected ex. PDF, | ||
| + | |NoOfCopies|This indicates the number of copies to be printed| | ||
| + | |ParamColl|This indicates the parameter entered if any| | ||
| + | |Password|This indicates the password used for the Crystal Report| | ||
| + | |Printer|This indicates the printer that is used| | ||
| + | |ReportOutputPath|This indicates the save location of the report with extension| | ||
| + | |ReportSourcePath|This indicates the source location of the Crystal Report| | ||
| + | |Server|This indicates the server the Crystal Report is connecting to| | ||
| + | |User|This indicates the user for the database that Crystal Reports is connecting to| | ||
| + | |StepMessage|During a failure the reason for failure will be populated here| | ||
| + | |StepStatus|True or False| | ||