clsExecuteETLJob Step
Description:
This step is used to execute an ETL job from the process workflow.
Inputs
- etlDef – select ETL definition
- variablesToPass – pass selected variables
- globalsToPass – pass selected globals
- variableToStoreID – variables/globals to store ETL Instance ID
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
Example:
Let’s build and execute the “clsExecuteETLJobDef” example.
- Create a new process definition called “clsExecuteETLJobDef” and open the definition in designer mode.
- Drag "UpdateVariable, UpdateGlobal, and clsExecuteETLJob” steps to the canvas.
- Connect the dots between the “Start” and other steps, as shown above.
- Define a variable or a global to store the result.
- Click the "updateVariable" step to configure its "Required" properties. Provide a name for the step. Click the Save button.
- Click the "updateVariable" step to configure its "Optional" properties. Click the button to initialize multiple variables required for the process, or provide the reference and the value for a single variable. Select the Expression as “No” if the variable value has no expression to evaluate. Click the Save button to confirm the configuration. In the example below, the variable value stores the input file path required for the ETL definition. Click the Save button.
- Click the "updateGlobal" step to configure its "Required" properties. Provide a name for the step. Click the Save button.
- Click the "updateGlobal" step to configure its "Optional" properties. Click the button to configure multiple global references. Click the Add Row(+) button to insert an empty row. Provide the global name and value. Click the Save button. You may insert multiple global references by adding more rows. Select “Has Expression” as “No” if the global value has no C# expression to evaluate. Click the Save button.
- Click the "clsExecuteETLJob" step to configure its "Required" properties. Provide a name for the step. Select the ETL definition to execute from the drop-down list. Click the Save button.
- Click the "clsExecuteETLJob" step to configure its "Optional" properties. Click the button to configure multiple variables to pass to the ETL Definition during execution. Click the Add Row (+) button to insert an empty row. Select the pre-configured variable from the drop-down list. Click the Save button. You may insert multiple variable references by adding new rows. Provide a variable or a global reference to store the ETL Instance ID value. Click the Save button.
- Click the button to configure multiple globals to pass to the ETL Definition during execution. Click the Add Row (+) button to insert an empty row. Select the pre-configured global from the drop-down list. Click the Save button. You may insert multiple global references by adding new rows. Click the Save button.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.
- Navigate to the ETL - Definition page and select the above-referenced definition from the table. Click the Actions - Design menu option. The design definition is rendered on the new page for modification. Select the CSV Input File step. On the Required tab, provide the variable reference passed from the process definition for the input file path. Click the Save button.
- Select the CSV Output File step. On the Required tab, provide the global reference passed from the process definition for the output file path. Click the Save button.
- Navigate to the Process Definition page. Save the process definition, create a new instance, and then execute it. Render the process instance. The process step has executed the ETL job, as shown below.
- Navigate to the ETL - Instances page. Render the above instance to view. The ETL process step has been executed using the variable and global references passed from the Process instance, as shown below.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.