Introduction

Understand the process steps and ETL steps administration functions

Last published at: January 23rd, 2025

Use these feature functions to manage the process steps and ETL steps.

You'll need to go to the Administration - Steps menu option. 

 

The UI is rendered below with the Process step filter selected as default. You may switch the filter to ETL to view the ETL steps.  

 

Select the category drop-down list. The process steps are labeled ALL or specific to its feature function, as shown below. The step categories are sorted alphabetically. The total count of process steps is mentioned in the brackets. 

 

Select ALL categories to view the process steps sorted alphabetically in a table. Each row contains the step icon, name, description, help documentation link, and validation status. Use the search box to narrow down the results. Use the column selector to add or remove columns to the table. 

 

To view the ETL step categories, select ETL filter and ALL categories to view the ETL steps sorted alphabetically in a table. Each row contains the step icon, name, description, help documentation link, and validation status. Use the search box to narrow down the results. Use the column selector to add or remove columns to the table. 

 

Click the ETL filter and select ALL categories to view the ETL steps sorted alphabetically in a table. Each row contains the step icon, name, description, help documentation link, and validation status. Use the search box to narrow down the results. Use the column selector to add or remove columns to the table. 

 

 

Create a step.

The Admin User can create a new custom process step by navigating to the Administration—Steps—Actions—Create menu option. This approach is similar to creating a custom ETL step. 

 

The Create menu option provides a UI that requires information to create a process step. Click on the Validate button to validate the step inputs. 

 

Click on the Create button to create the new process step. The new custom process step is available in the table by category.  

 

 

Edit step information

Search and select the step name from the table displayed. Navigate to the Actions—Edit menu option. The step information for modification is provided below. NOTE: Any step modifications that fail the validation will reset the existing process workflow definitions. 

 

For example, the step display name can be changed here. Click on Update to confirm the changes. 

 

You may choose the PNG file to upload the icon for the step below. 

 

The icon changes for the step are rendered below.  

 

New inputs can be added here, and the input fields and their data types can be modified. The hierarchy of the fields can be ordered by drag-and-drop. The input fields can be configured as required, hidden, or read-only. 

 

The Step return values can be configured here. 

 

 

Search Filter a step.

Select a category from the dropdown list to view the steps belonging to the category. 

 

As shown below, you can type the step name in the search box to filter. 

 

 

Copy a step.

Search and select the step name from the table displayed. Navigate to the Actions—Copy menu option. 

 

A popup window will appear. Provide the new step name and description. Click on the COPY button to confirm the action. 

 

The latest step will be created and listed in the step category. A confirmation message is displayed in the top right-end corner. 

 

Navigate to the step using the appropriate filter (Process or ETL) and the Search text box as below.  

 

Suggestive Steps.

FlowWright can suggest steps when previously configured. To configure, select a step and navigate to the Actions—Suggestive Steps menu option. 

 

A new page displays all steps (across all categories) and provides a checkbox to associate the relevant step with a suggestion quickly. 

 

When you are done, confirm the changes. 

 

 

Remove / Auto Detect a step.

The process step can be removed and configured again when necessary. Search for and select the step name from the table displayed. Then, navigate to the Actions—Remove menu option. 

 

An alert notification prompts you to confirm the changes.

 

The process step is removed successfully. 

 

Navigate to Utils - Auto Detect menu option. A new tab is displayed.

 

Note: The process steps are introduced when FlowWright is updated by a patch release. These steps may be new or modified with feature enhancements. The process steps (including those removed) are displayed in the table after auto-detect.  Select the step to configure manually. Repeat the configuration for all steps in the table if necessary. 

 

The configured step is now available for use. 

 

 

Remove All From Category.

You can use this feature to remove all process steps belonging to a category.  

Select the step and click the Actions - Remove All From Category menu option. 

 

Click OK to confirm. The steps are removed from the category, and a confirmation message is displayed in the top right-end corner. 

 

 

View usage.

Navigate to the View—Usage menu option as below.   

 

The usage for all process steps is rendered as below. 

 

The steps for using Azure Cognitive Services are rendered below. 

 

The usage for Date ETL steps is rendered below. 

 

 

View Error Steps.

To view process steps that have failed configuration, navigate to the View—With Errors menu option. 

 

The process steps that have failed validation are listed in the table, as shown in the image below. 

 

Select the error step. Navigate to the Utils—Reload Step menu option. 

 

The application will attempt to reload the step and configure it using the defaults in the setup file.

 

 

View process definitions using specific process steps.

Search and select the process step from the table. Then, navigate to the View—Processes—Used by menu option. 

 

This step lists all process definitions or workflows, and the application executes a background task using it. The user is notified when the job is completed. 

 

A user notification is rendered upon job completion.

 

Please select the appropriate notification and click the pop-out icon to view it. 

 

The list of process definitions or workflows using this decision step is a popup window. Select the process definition hyperlink to view the definition in detail.

 

The email notification is included here for reference. 

 

 

View process definitions without using a specific process step.

Search and select the process step from the table. Then, navigate to the View—Processes—Not Used by a menu option. 

 

This step lists all process definitions or workflows, and the application executes a background task using it. The user is notified when the job is completed. 

 

A user notification is rendered upon job completion.

 

Please select the appropriate notification and click the pop-out icon to view it. 

 

The list of process definitions or workflows using this decision step is a popup window. Select the process definition hyperlink to view the definition in detail.

 

The email notification is included here for reference. 

 

 

Export a step.

Search and select the step name from the table displayed. Navigate to the Export—XML menu option. The step information is exported/downloaded as an XML file for sharing between FlowWright environments. 

 

Search and select the step name from the table displayed. Navigate to the Export—SQL menu option. The step information is exported as an SQL file, which can be executed in the target FlowWright environment database to insert this step. 

 

The SQL file content is included here for reference. 

 

 

Import a step.

Navigate to the Import—XML menu option to import the step into a FlowWright environment. 

 

Select the XML file from the local folder and click Import to accept the changes.  

 

The step configuration is overwritten, and a confirmation message is displayed in the top right-end corner as below. 

 

 

Auto Detect.

Navigate to the Utils—Auto Detect menu option to identify new and modified steps that must be manually configured for your FlowWright environment. 

 

The auto-detect feature opens on a new page. The table lists the steps by step name, namespace, and DLL path configuration. 

 

Select the step row and click on the Manage—Configure menu option. The step will be configured manually. Use “Select all records” to configure more than one step row in the table. Use “Upload DLL” to configure your custom process step. 

 

An alert notification confirms the successful step configuration. 

 

 

Auto Detect from DLL.

Navigate to Utils—Auto Detect from the DLL menu option to identify new and modified custom steps that must be manually configured for your FlowWright environment. 

 

Select the custom step DLL from the drop-down list. 

 

Click the Select button to confirm the action. The step will be configured manually, and an alert notification will confirm its successful configuration. 

 

 

Auto Detect from Directory.

Navigate to Utils—Auto Detect from the Directory menu option to identify new and modified custom steps that must be manually configured for your FlowWright environment. 

 

Select the directory from the drop-down list. 

 

Click the Select button to confirm. The step will be configured manually, and an alert notification will confirm its successful configuration. 

 

Reload a step.

The process step can be reloaded when new steps are introduced in the process DLL or when necessary. Search and select the step name from the table displayed. Navigate to the Utils—Reload Step menu option. 

 

Click the OK button to proceed. 

 

An alert notification prompts you to confirm the changes.

 

Globalize a step.

This feature allows you to globalize the process step resources. Search for and select the step name from the table displayed. Navigate to Utils - Globalize menu option.

 

An alert notification prompts you to confirm the changes.

 

An alert notification confirms the changes.

 

Navigate to the Administration—Globalization—Global tab. Select the StepInputs option. Select the secondary culture to translate and confirm the changes. 

 

Select Translate—Azure Translate—Resource Group to initiate translation. This feature requires Azure ML settings to function. 

 

The resource items are globalized, and a confirmation message is displayed in the top right-end corner. 

 

 

Test a step.

Search and select the step name from the table displayed. Navigate to Utils - Test menu option. 

 

A new page is rendered to test the step functionality, as shown in the following UI. If required, select test mode ON. Provide the necessary values to the input fields as below. Click the Test button to start. 

 

Notice that the step returns TRUE, and the step state is COMPLETE, with the time taken in milliseconds. The step returns FALSE for a false condition or ERROR with a message for an incorrect condition. 

 

 

Step Request.

Navigate to Support - Request Item to ask the FlowWright support team for any enhancements or challenges noticed. 

 

You'll have to provide the necessary details to email the request to the product team.