Skip to content

Data Flow Activities

Configuring Aggregate in Data Flows

Aggregate activity is used to transform data of the input data model by using aggregation. You can use Group by, Having, and / or Order By options in the activity for data aggregation. You can add or remove attributes of the configured input data model. Business rules are applied using the Expression builder when adding a new data model attribute.

Aggregate

Properties: Basic, Aggregate, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Governance: Select Governance if you want governance on your data manipulation.
Governance is required when there are chances that errors or biases at the aggregate level can lead to massive business mistakes.
Governance ensures accuracy, data privacy, and consistency.

Aggregate

  1. Click Aggregate accordion.
    Aggregate property

  2. Select the input data model from the drop-down.
    The input can be the output of any of the preceding activities that appear in the select Input data model drop-down as {activity_name}_Output.
    On selection of the required data model, the attributes of that data model appear in the property panel.
    Data Model attributes

  3. Below the Select Attributes, select the attributes that you prefer to keep.

  4. Below the Alias, enter the alias for the attribute name.
  5. Scroll down below Select Attributes section. Adding Expressions and Group by options appears.
    Aggregating data features

  6. Click Exp to define a new attribute for the input data model using expressions.
    Select type

  7. Select the data type of the new attribute added and enter the Alias for the attribute.

  8. Click fx edit (pencil) icon. The Expression Builder opens, where you can define the rules as per your requirement. Make sure that the check box adjacent to fx is selected to include the attribute as the output data model.
    You can add multiple expressions. Refer to Expression Builder.

  9. Below Group By section, click ++Add for selecting the Group by criteria.
    Group By

  10. Select the Attribute by which you need to group. You can add multiple Group By criteria.

  11. Below the Having section, click Add for adding Having criteria.
    Having

  12. Select the Attribute, function for the attribute, the operation required to be performed, and the expected value for the attribute for which you need to apply the criteria.

  13. Select AND or OR condition to add multiple conditions. For a single condition or while defining the final condition, select the condition as END.
  14. Below the Order By section, click +Add for adding Order by criteria.
    Order By

  15. Select the Attribute by which you need to order.

  16. Select the Order (Ascending or Descending order) that you need. You can add multiple Order By criteria.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Azure IOT Publish Event in Data Flows

The activity Azure IOT Publish is used to publish information on a specific Azure IOT hub connection. The connection configuration of IOT hub needs to be set to this activity.

Azure IOT Publish Event

Properties: Basic, Azure IOT Publish Event, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Azure IoT Publish

  1. Click Azure IOT Publish accordion.
    Azure IOT Publish property
  2. Enter the details as explained below.

    Field Description
    Select Data model Select the input data model.
    The input can be the output of any of the proceeding activities.
    Azure IoT Hub Connection String* Enter the Azure IoT Hub connection string.
    The connection string enables the activity to connect to the specific IoT hub.
    Message* Enter the message details. Message should be in JSON format (key-value pairs). The values should be the name of the attributes of the input data model mapped enclosed with in <@**{attribute_name}** @>

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Custom Query in Data Flows

The activity Custom Query is used to define custom SQL queries for fetching the data from the input data model.

Custom Query

Properties: Basic, Custom Query, Error Handling
Dependent entities: NA
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Custom Query

  1. Click Custom Query accordion.
    Custom Query
    Custom Query property

  2. Enter the details as explained below.

    Field Description
    Custom Query Enter the custom query. The input data model of the custom query is the output data model name of any of the preceding activities that is written in the specific format. The output data model name is the table name for the custom query activity. The table name format should be like the example provided below.
    Select * from <#{Preceding_activity_name}_Output#>
    Example: Select * from <#Reader_2_Output#>
    Custom Query
    Output Attributes Click Attribute .
    Provide the Attribute Name and select the Attribute Type .
    Ourput Attributes
    You can add multiple attributes. At least one attribute is mandatory.
    - Note that the preview of the Custom Query will display the query output.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring DB in Data Flows

The activity Database (DB) is used to execute Data Manipulation Language (DML) statements. DMLs are elements in the SQL language used for data retrieval and manipulation. Using DML statements, you can perform operations such as adding new rows, updating and deleting existing rows, merging tables, and so on. You can map multiple scripts in the DB.

Note

You cannot preview the database activity output or use the database output as the input for any other activity.

DB

Properties: Basic, Database, Error Handling
Dependent entities: Database Script, Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Database

Note

You should configure the database script(s) - business entitiy before configuring the activity, database.

  1. Click Database accordion.
    Database activity properties

  2. Select the Data Model. Data model can be a data model entity or output from any of the preceding activities.

  3. Select the DB Script.
  4. Click DB Script to add multiple scripts.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Decision Table Executor in Data Flows

A decision table executor activity is used when you need to do some calculations based on conditions or rules and display the result. You can define multiple conditions and calculations in the decision table.

The Decision Model and Notation (DMN) standard provides the industry with a modeling notation for decisions that will support decision management and business rules. The decision table executor activity uses DMN. Configuring conditions or rules in DMN are done using Friendly Enough Expression Language (FEEL). It is mandatory to understand DMN and FEEL before configuring the decision table.

Decision Table

Properties: Basic, Decision Table, Error Handling
Dependent entities: Decision Table, Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Decision Table Executor

Note

You should configure a decision table entity and deploy this entity before mapping it to the activity.

  1. Click Decision Table Executor accordion.
    Decision Table Executor properties

  2. Select Data Model from the Select Datamodel drop-down.

  3. In the Select Decision Table, select the decision table that you have created.
  4. Click the Input / Output variable mapping icon (Pencil icon). The details displayed are as per the decision table designed.
    The input Mapping tab section is active by default. Input Mapping details with an option to choose variables.
    This is a mandatory configuration for the decision table if variable mappings appear.

    Decision Table - Input Mapping

  5. Select the Data model Attributes Variables from the drop-down for each of the Decision Table Input Types.
    Variables of relevant data types that match the input types appear.

  6. Click Output Mapping tab section. Output Mapping details with an option to choose variables.
    Decision Table - Output Mapping

  7. Select the Variables from the drop-down for each of the Decision Table Output. Output data is stored in this variable.
    Select the checkbox on the left side to select and map only those output variables that are needed. At least one output configuration is mandatory for the decision table.

  8. Click Save to save the decision table executor configurations.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring End in Data Flows

End activity represents the end of a flow. There is no outgoing transition link from the End. Multiple End activities can be included in a flow based on the business requirement.

End

Properties: Basic
Dependent entities: NA
Dependent configurations: NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Configuring Execute Dataflow in Data Flows

The Execute Dataflow activity is used to call/trigger and execute a predefined data flow. You need to create a data flow and then map the data flow in the Execute dataflow activity.

Execute Dataflow

Properties: Basic, Execute Data Flow, Error Handling
Dependent entities: Output data model of any other activity
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Execute Data Flow

  1. Click Execute Data Flow accordion.
    Execute Data Flow

  2. In the Select Data model, click the drop-down and select the required data model.

  3. In the Select Data Flow, click the drop-down and select the data flow that needs to be executed as part of the current data flow.
    Attribute Mapper and Variable Mapper sections appear.
    Execute Data Flow properties

  4. Select Data Model Attributes from the Attributes Mapper > Data model Attributes. Attributes in the selected data model appear in the drop-down.

  5. Select Data Model Variables from the Attributes Mapper > Data model Variables. Variables of the data flow that is mapped (child flow) are listed based on the data type of the attribute selected.
  6. Click Attributes to add multiple attributes and provide details as mentioned in Steps 4 and 5.
  7. Select Source Variables from the Variable Mapper > Source Variables. Variables of the current flow are listed in the drop-down.
  8. Select Target Variables from the Variable Mapper > Target Variables. Variables from the data flow that is mapped (child flow) are listed based on the data type of the Source Variable.
  9. Click  Variable to add multiple variables and provide details as mentioned in Steps 7 and 8.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Filter in Data Flows

The activity filter is used to filter the details from the input data by applying functions and conditions.

Filter

Properties: Basic, Filter, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Filter

  1. Click Filter accordion.
    Filter Properties

  2. Select the input data model from the drop-down. The input can be the output of any of the preceding activities that appears in the select Input data model drop-down as {activity_name}_Output.
    The Condition Builder template appears.

  3. Click  Add to add a condition. Condition Builder prompts you with drop-downs and textbox for entering input.
    Condition Builder
  4. Select the Attribute, Function for the attribute, and the operation to be done in the respective drop-downs.
  5. Enter the Value for the attribute for which you need to apply the criteria.
  6. Select AND and OR condition to add multiple conditions.
    For a single condition or to end a condition, select condition as END.
  7. Click the delete icon to delete the condition.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Fork in Data Flows

The activity Fork is used to split a transition link into several sub-transition links. These sub-transition links follow a parallel, but, a different course of action. The sub-transition links are eventually joined together using the activity-Join at some point in the flow. You can use multiple Fork and Join activities; however, to be noted that a flow should have an equal number of Fork and Join activities.

Fork

Properties: Basic
Dependent entities: NA
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Configuring Hadoop Writer in Data Flows

The activity Hadoop Writer is used to write new data or result set to a Hadoop file system.

Hadoop Writer

Properties: Basic, Hadoop Writer, Error Handling
Dependent entities: Hadoop Entity
Dependent configuration(s): Hadoop

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Hadoop Writer

  1. Click Hadoop Writer accordion.
    Hadoop Writer properties

  2. Select the input data model from the drop-down. The input can be the output of any of the preceding activities that appear in the select Input data model drop-down as {activity_name}_Output.

  3. In the Select Hadoop Entity, select the Hadoop entity name. Only the write-type entities appear in the list.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Insert Data Entity in Data Flows

The activity, Insert Data Entity is used to insert records into the data entity table from the selected data model.
A data entity is a custom-defined data type variable. The data entity is created and managed in the Manage > Data Catalog section.

Tip

Refer to Manage - Data Catalog – Data Entities to create and Management > Data Catalog > Data Entities.

Insert Data Entity

Properties: Basic, Insert Data Entity
Dependent entities: NA
Dependent configuration(s): Data Entity (configured in Manage > Data Catalog)

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Insert Data Entity

  1. Click Insert Data Entity accordion.
    Insert Data Entity
    Insert Data Entity properties

  2. In the Select Data model, select the data model. The input model can be the output of any of the preceding activities that appear in the select Input data model drop-down as {activity_name}_Output.

  3. Select DataEntity. When you select the data entity, the attributes of that data entity table appear below as the left-side columns. On the right side the data model details appear.
    The primary column of the data entity table and the data model are mapped automatically.
    Data Entry attributes

  4. In the right-side drop-down, corresponding to each attribute select the data model attribute. The data model attributes appear based on the data type of the data entity on the left side.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Join in Data Flows

The activity Join is used for joining parallel transition links which are split by the Fork activity. The number of Join activity in a workflow is equal to the number of Fork activity.

Join

Properties: Basic
Dependent entities: NA
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Configuring Merger in Data Flows

The activity Merger is used to merge two different data models. The data models can be merged based on attributes that are logically matching. You can choose to select the required attributes or all of the attributes from both the data models.

Merger

Properties: Basic, Merger, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Merger

  1. Click Merger accordion.
    Merger properties

  2. In the Data Model Merger section, select the input data model from the drop-down for both the LHS and RHS. The input can be the output of any of the preceding activities that appear in the select Input data model drop-down as {activity_name}_Output.
    The data of these data models are merged based on your mapping.

  3. In the Select Attributes to Join, select the JOIN type that you want to apply for the two data models.

    • JOIN: The JOIN returns all records when there is a match in the left (table 1) or right (table 2) table records.
    • INNER JOIN: The INNER JOIN selects records that have matching values in both tables.
    • LEFT JOIN: The LEFT JOIN returns all records from the left table (table 1), and the matching records from the right table (table 2). The result is “0” records from the right side if there is no match.
    • LEFT OUTER JOIN: The LEFT OUTER JOIN returns all the records from the left table (table 1) that are not matching with the right table (table 2).
    • RIGHT JOIN: The RIGHT JOIN returns all records from the right table (table 2), and the matching records from the left table (table 1). The result is “0” records from the left side if there is no match.
    • RIGHT OUTER JOIN: The RIGHT OUTER JOIN returns all the records from the right table (table 2) that are not matching with the left table (table 1).
  4. In the LHS select an attribute and select a corresponding attribute in the RHS.

  5. Click  Attribute to add and map more attributes of the data model. Only those attributes that are mapped are considered for merging. Based on the mapping, Output Attribute gets listed.
    Output Attributes for the selected attributes

  6. Select (check) the required items in the Output Attributes. (Click header checkbox [Select All] to select all the attributes.)

  7. In the Alias field, provide the alias name for the attribute.
    At runtime, as per the selection of the attributes and the configurations, the merger activity merges the data.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring ML Predictor in Data Flows

ML Predictor is used for predicting a particular output based on the input data model and the configurations. Two types of Machine Learning (ML) models can be mapped to the ML predictor: ML Dataset and SKLearn model using Python coding through Jupyter Notebook.

The ML models created through the SKLearn model (in Main menu > Jupyter Notebook) should be published for utilizing them in the ML predictor activity. The ML models are listed in the Input ML model drop-down of the ML Predictor property.

Based on the input ML model (and the configurations defined for that model), the ML predictor predicts the output value. The accuracy of the predicted value depends on the input data provided for the ML model.

ML Predictor

Properties: Basic, ML Predictor, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): ML Model (Platform ML and Jupyter Notebook)

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

ML Predictor

  1. Click ML Predictor accordion.
    ML Predictor
    The ML Predictor properties

  2. Below the Input Data Model select a data model from the Data Model list. This can be the output of any of the preceding activities as applicable.

  3. Below the ML Model, select an ML model from the drop-down. The ML model lists the models that are created through the Manage > ML Projects and Main menu > Jupyter Notebook Portlet.
    When you select the ML Model, the Variables and ML Attributes section appears.

    Variables and ML attributes mapping

  4. Select a data model attribute corresponding to each ML Attribute. Based on the data type of the ML attribute, data attributes are listed in each drop-down.

  5. Scroll down to view further properties that appear as part of the ML model.

    ML Output and Accuracy

    • The ML Output Attribute is the prediction column in the model that gets populated when you select the ML model.
    • Select Required Accuracy. This creates a column named “Model Accuracy” as the last column of your result set and the accuracy value is populated in that column.
    • Accuracy is the accuracy value that the model provides and this is automatically captured from the ML model. Model Accuracy appears based on the ML model selected.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Reader in Data Flows

The activity Reader is used to read the data from the source file (data source). The data model entity will have the configuration details of what all to be read from the data source.

Reader

Properties: Basic, Reader, Variable Mapping, Error Handling
Dependent entities: Data Model (business entity), Variable
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Data Reader

  1. Click Reader accordion.
    Reader property
Field Description
Select Datamodel* Select the input data model from the drop-down that lists the data model names
Document Variable* Enter a variable of type document. You must create a variable in the variable section and select it here.
Static File path Enter the file path of the document.

Variable Mapping

Variable is used when the data needs to be dynamically passed as a file path or JSON data.

  1. Click Variable Mapping accordion.
    Variable Mapping Properties

  2. Enter the Attribute Mapping Variable. The variables are created in the business activity section and they should be of the type, alphanumeric. This variable will hold the data for the Reader activity; for example, a JSON format of the input file that can read by the Reader activity.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Rule Executor in Data Flows

The activity, Rule Executor is used for executing rules for the selected data model and getting an output based on the success or failure of the rule.

Rule Executor

Properties: Basic, Rule Executor, Error Handling
Dependent entities: Output data model of any preceding activity in the flow, Query
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Rule Executor

  1. Click Rule Executor accordion.
    Rule Executor properties

  2. Below the Select Data Model, select a data model from the list. This can be the output of any of the preceding activities as applicable.

  3. In the Select Rule, select a Query that you have defined. Queries are business entities. You can create and define a local query or organization-level query.
  4. Click the pencil icon adjacent to Select Rule. The Rule Mapper pop-up appears.
    Rule Mapper

  5. In the Rule Mapping, select the Data Model Attributes (RHS) corresponding to the Rule Attributes (LHS).

  6. In the Output Mapping table, for each Output Attribute enter the Value (RHS) as explained below.

    Output Attributes Description
    Output Column Enter the name that is to be displayed for the output column. A column with this name is amended to the result set and the output messages (Rule success or Failure message which are defined below) are stored in that column
    Message on Rule Success Success message that is to be displayed on the output column if the execution result is a success
    Message on Rule Failure Failure message that is to be displayed on the output column if the execution result is a failure
  7. Click Save to save the Rule Mapping configurations.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Set Variable in Data Flows

The Set Variable activity is used to hold the result set data output in a variable. You can either hold the complete result set in a variable or the last row data output to variable(s) based on the configuration.

Set Variable

Properties: Basic, Set Variable, Error Handling
Dependent entities: Variables
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Set Variable

  1. Click {x}Set Variable accordion.
    Set Variable properties

  2. Select the data model. When you select the data model, the variable mapping details appear.
    Set Variable

    Setting the Whole data set as variable and mapping variables to attribute.

  3. If you want to set the complete result set to accommodate in a variable, select the Set Whole Data Set box.

    In the Select Variable, select the variable in which you want to hold the complete data. You should create the required variable in the entity section.
    Or if you want to set each of attribute of the last entry of the result set to different variables, deselect the Set Whole Data Set box.
    Variable-Attribute mapping

  4. Select the Variable and Attribute. You should create the required variables in the entity section. Attributes are listed from the data model that you selected.

  5. Click the delete icon to delete a variable mapping that you entered.
  6. Click Variable to add multiple variable-attribute mapping.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Start in Data Flows

Start activity is used to indicate the start of a workflow. All the workflows start with Start. There will be only one Start activity for a workflow.

Start

Properties: Basic
Dependent entities: NA
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Configuring Transformer in Data Flows

Transformer activity is used to transform the input data model or manipulate the input data using expressions / functions as per your requirement.

Transformer

Properties: Basic, Transformer, Error Handling
Dependent entities: Output data model of any preceding activity in the flow
Dependent configuration(s): NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Transformer

  1. Click Transformer accordion.
    Transformer properties

  2. Select the input data model from the drop-down.
    The input can be the output of any of the preceding activities that appear in the select Input data model drop-down as {activity_name}_Output.
    On selection of the required data model, the attributes of that data model appear in the property panel.

    Transformer properties on selection of the input model

  3. Corresponding to attributes under Name, enter an alias name below the Alias column if required.

  4. Scroll down the properties. The Function and Expression feature appears at the end of the attribute list.
    Adding Expressions

  5. Click Exp to create rules or define functions using the expression editor. The Expression details appear.
    Select type

  6. Select the data type and enter the Alias (if required) for the expression.

  7. Click fx (pencil) icon. The Expression Builder opens where you can define the rules as per your requirement. Make sure that the check box is selected in order to include the attribute in the result set.
    You can add multiple expressions also. Refer to Expression Builder.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Trigger Workflow in Data Flows

The activity, Trigger Workflow is to trigger a process flow. You need to design and deploy a process flow before configuring the trigger workflow activity.

Trigger Workflow

Properties: Basic, Trigger Workflow, Error Handling
Dependent entities: Process flow
Dependent configurations: NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Trigger Workflow

  1. Click Trigger Workflow accordion.
    Trigger Workflow properties

  2. In the Select Data Model, select the Data model. The mapping of Datamodel Attributes and Workflow Variables appears.

  3. In the Select Workflow, select the process flow. The Variables in this workflow are listed in the Workflow Variables section.
    Data model attributes and workflow variables mapping

  4. Select Data model Attributes and the corresponding Workflow Variables as how you need to map. Workflow variables list the variables that are in the selected process flow and that which is matching with the data type of the selected data model attribute.

    The process flow is executed for each row entry in the data model. Hence, the number of process flow instances for this data flow will be equal to the number of rows in the data model.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Update Attributes in Data Flows

The activity, Update attributes is used to update the values for a selected data model attribute. You can define rules (queries) for a selected data model.

Update Attributes

Properties: Basic, Update Attributes, Error Handling
Dependent entities: Queries, Output data model of any preceding activity in the flow
Dependent configurations: Data model

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Update Attributes

  1. Click Update Attributes accordion.
    Update Attributes properties

  2. Select the Data model from the Select Data model list.

  3. In the Select Rule, select the Query that you have configured. You can create and define a local query or an organization-level query.
  4. Click the pencil icon adjacent to Select Rule. The Rule Mapper pop-up appears.
    Rule Mapper

  5. In the Rule Mapping RHS, select the Data Model Attributes corresponding to the Rule Mapping LHS where the Rule Attributes are listed.

  6. In the Output Mapping, for each key input, enter the values as explained below.

    Output Mapping

    Field Description
    Attribute (header name) This header is automatically updated when you select an attribute.
    Output Mapping
    By default, the header name will be “Attribute”.
    Attribute (output key name) Select the attribute for which you need to update the values.
    On Rule Success Success message that is to be updated as the selected attribute value if the execution result is a success. You can use attribute variable and string functions in this field.
    On Rue Failure Failure message that is to be updated as the selected attribute value if the execution result is a failure. You can use attribute variable and string functions in this field.
    • Click Add to select multiple attributes in the output mapping and you can define output messages for each success/failure of a particular attribute.
  7. Click Save to save the Rule Mapping configurations.

  8. Click Rule for configuring multiple Queries (Rules). Queries for the rules should be created before configuring.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Webservice in Data Flows

The activity, Webservice is used to achieve web communication. Web service is an component for communication that integrates and encodes the activities in the web applications. SOAP (Simple Object Access Protocol) and REST (REpresentational State Transfer) are the two components of Web services.

The activity, WebService is used to call any API services (external APIs or internal APIs within the platform – e.g., Data Catalog APIs). You need to configure a Webservice entity for configuring the activity WebService.

Webservice

Properties: Basic, Webservice, Error Handling
Dependent entities: Rule, Email, WebService
Dependent configurations: NA

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Refer to Entering Basic Properties.

Webservice

  1. Click Webservice accordion.
    Web service properties

  2. Select Data Model from the Select Datamodel drop-down. When you select a data model, the Attribute Mapper section appears.

  3. Select a web service from the drop-down from the Select Webservice. Webservice entity should be configured as per your requirement so that you can map it in the web service activity.

    • Refer to Entity – Webservice business entity.

    Selected Data model with Attribute Mapper details

  4. Select an appropriate Attribute Type for each Attribute Name.

  5. Click Output Attribute for adding more attributes.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Configuring Writer in Data Flows

The activity Writer is used to write data or result set to a database or file (e.g., RDBMS or a File or a NoSQL).

Note

You cannot preview the Writer activity output or use/map the writer output for any other activity.

Writer

Properties: Basic, Writer, Error Handling
Dependent entities: Data model/Output data model of any preceding activity in the flow
Dependent configuration(s): Data source

Basic

The basic activities in the data flows have basic details related to that activity. This is common to all the activities in the data flow.

  • Click an activity in the canvas and then the Basic accordion in the Property panel to enter the basic details.

Basic

Field Description
Name* Enter the name of the activity.
Character limit:50
Data Type: Alphanumeric and underscore.
Description Describe the activity.
Character limit: 1000
Data Type: Alphanumeric and symbols.

Writer

  1. Click Writer accordion.
    Writer properties

  2. Enter the details as explained below.

    Field Description
    Select Input Select the input data model.
    The input can be the output of any of the preceding activities.
    Write To Select a type from Write To .
    Write To
    - File : Writes the output to a file (CSV, JSON, Parquet) file.
    Refer to Writing into File.
    - RDBMS : Writes the output to the relational database.
    Refer to Writing into RDBMS or NoSQL.
    - NoSQL : Writes the output to a non-relational database.
    Refer to Writing into RDBMS or NoSQL.

Writing into File

When you select the Write To as File, the below configuration details appear.
Write To File Properties

  • File Format: Select the File Format that you require to write the output. The file formats supported are CSV, JSON, and Parquet.

    File format

    Parquet is built to handle flat columnar storage data formats. It is a column-oriented data storage format.

    • File Name: Provide a filename. Output file will take this file name.
    • Local Directory: Provide the local path in which the file needs to be dumped.

Writing into RDBMS or No SQL

The configuration details for the RDBMS and the NoSQL are the same except for the selection of database type. For RDBMS, you should select only a relational database and for No SQL, you should select a non-relational database.

When you select Write To as RDBMS or NoSQL, the below configuration details appear.

Write to RDBMS/NoSQL properties

  1. If you want to capture the data source name in a variable, select Is Datasource Variable Required?. Select Variable option appears.

    The data source variable of type, alphanumeric should be created (in the business entity, Variables) and mapped in this section.
    Data source variable - checked

    If you do not wish to provide the Data source variable then deselect the “Is Data source Variable Required?” Data source dropdown list appears.
    Data source variable - Unchecked

    In the Data source, select the required data source.

  2. Enter the Table Name. You can enter an existing table name in the selected data source or a new table name that is to be created in the selected data source.

  3. Select the Save Mode.
    Save mode

  4. Append: To append the output data to the selected table. This will retain the already existing data.

  5. Delete Before Append: To delete the already existing data before adding or appending the output data.
  6. Overwrite: To overwrite the existing data if it matches the output that is been getting inserted.

Additional Columns

Additional Columns section allows you to add any additional column named, Instance Id in the result set. When you write the writer output to a database, this column also gets amended to the result set table.

  1. Click the Additional Column accordion.
    Additional Columns

  2. Select Instance Id box.

Error Handling

When an error occurs in an activity, the system either proceeds with the error or will hang up the process based on the configuration. Error handling allows you to handle the error occurred in the activity level through configurations.

To configure error handling for a particular activity:

  1. Click Error Handling accordion for the activity. Error Handling

  2. Check the Continue If Error check box if you want to continue the workflow even if the error occurs.
    Else uncheck the checkbox to break or stop the workflow execution when an error occurs.

  3. Select Trigger Error Workflow, if you want to trigger the process flow mapped in the dataflow configuration during an error in the dataflow.

Consider you have configured the Error Handling in the data flow level. That is, you have mapped a Error Process flow in the Data Flow Error Handling section.
You must select Error Workflow in flow level and then select Trigger Error Wrokflow in the activity level to trigger that workflow.

Currently, the same error workflow is triggered for any activity as the error workflow is in the data flow level.

Different workflow for different activities: If you want to trigger different workflow for different activities, you can capture the activity details from the error workflow Node variable and based on the captured node details, you can apply rules for the further execution of the flow.

Getting the Azure IoT Hub Connection String

To get the Azure IoT Hub Connection String, you need to have valid Azure credentials.

  1. Log on to the Azure Portal.
  2. In the jumpbar, click New, then click Internet of Things, and then click Azure IoT Hub.
  3. In the New IoT Hub blade, specify the desired configuration for the IoT Hub.
  4. Once the new IoT hub options are configured, click Create. It can take a few minutes for the IoT hub to be created. To check the status, you can monitor the progress on the Startboard. Or, you can monitor your progress from the Notifications section.
  5. After the IoT hub has been created successfully, open the blade of the new IoT hub, take note of the hostname URI, and click Shared access policies.
  6. Select the Shared access policy called iothubowner, then copy and take note of the connection string on the right blade.
  7. Your IoT hub is now created, and you have the connection string you need to use the Device Explorer tool. This connection string enables applications to perform management operations on the IoT hub such as adding a new device to the IoT hub.

For more details, refer to
https://thingspro-programming-guide.netlify.app/application-note/how_to_get_azure_iot_device_connection_string/