v26.01: Managing Workflows

Building a workflow involves a structured process from creation through execution. This section guides you through each step of the workflow development lifecycle:

• Creating a New Workflow: Establish the workflow container with name and description.
• Adding to Favorites: Mark frequently used workflows for quick access.
• Editing Workflow Properties: Update workflow metadata as needed.
• Adding Nodes: Build the data pipeline by adding and configuring nodes.
• Publishing Workflows: Save all workflow configurations.
• Running Workflows: Execute the workflow and monitor results.

Each step builds upon the previous one, creating a complete, executable workflow that automates data operations.

Creating a New Workflow

To create a workflow:

1. Navigate to the target functional area in the Explorer pane.
2. Click the + icon option and select Workflow from the available object types.
3. The Workflow Details panel opens on the right side.
4. Enter the workflow name in the Name field (must be unique).
5. Enter a description in the Description field.
6. Confirm or change the Functional Area using the dropdown.
7. Click Create.

The workflow opens in the canvas, ready for design.

Adding to Favorites

To add a workflow to Favorites:

1. Open the workflow in the canvas.
2. Click the star icon next to the workflow name in the Level 2 header.
3. A pop-up window appears titled Add to Favorites, where you can:
   • Enter a name for the favorite.
   • Select a folder to save it.
4. Click ADD to confirm or CANCEL to exit.

Once added, the workflow appears under Favorites in the Explorer panel for quick access.

Note: Favorites are user-specific and persist across sessions.

Editing Workflow Properties

To edit workflow properties:

1. Locate the Workflow Details panel on the right side of the canvas.
2. Edit any of the following fields:
   • Name: Change the workflow identifier (must remain unique).
   • Description: Update contextual information.
   • Functional Area: Select a different functional area from dropdown.
3. Changes take effect immediately in the panel.
4. Click Publish to save changes permanently.

Adding Nodes

Nodes are the building blocks of workflows, with each node performing a specific operation in the data pipeline. Nodes are added through a common process, and connectors are automatically created between nodes to show data flow.

To add a node:

1. Click Add Node in the Level 2 header.

2. The Add Node dialog opens in the center of the canvas.

   The dialog displays available node categories on the left and node types on the right.

   

3. Select the appropriate category based on the operation needed (Read, Calculation, or Write).

4. Choose the specific node type from the available options.

5. The node appears on the canvas.

6. A connector automatically forms between the previous node and the new node.

   The configuration panel opens on the right side.

   

For detailed information on each node type, see Understanding Node Types and Categories.

Adding the Start Node

Every workflow begins with a Start node that defines the workflow entry point.

To add a Start node:

1. Click the centered prompt on the blank canvas.
2. The Start node appears with a play icon.
3. The configuration panel opens on the right.
4. Enter a name or keep the default "Start".
5. Click Publish.

Note: The Start node cannot be deleted and only one Start node exists per workflow. The Start node only provides output connections to downstream nodes. Connectors are automatically created when subsequent nodes are added.

For detailed information on node types and categories, see Understanding Node Types and Categories.

Adding Read Nodes

Read nodes bring data into the workflow from various sources.

To add a Read node:

1. Click Add Node in the Level 2 header.
2. Select the Read category.
3. Choose the node type (Metrics, Table, Sheet, etc.).
4. The node appears on the canvas.
5. A connector automatically forms between the previous node and this new node.
6. Configure the node:
   • Enter a unique name.
   • Click Add in Source section to select data source.
   • Configure Layout (Rows, Columns, Filters).
7. Click Publish.

For detailed information on Read node types and configuration, see Working with Read Node.

Adding Calculation Nodes

Calculation nodes transform data through SQL queries or other methods.

To add a Calculation node:

1. Click Add Node in the Level 2 header.
2. Select the Calculation category.
3. Choose Script.
4. The node appears on the canvas.
5. A connector automatically forms between the previous node and this new node.
6. Configure the node:
   • Enter a unique name.
   • Click Add in Input section to select upstream nodes.
   • Enter SQL query in Query section.
   • Click Validate to check syntax.
7. Click Publish.

For detailed information on Calculation node types and configuration, see Working with Calculation Node.

Adding Write Nodes

Write nodes save processed data to target destinations.

To add a Write node:

1. Click Add Node in the Level 2 header.
2. Select the Write category.
3. Choose the node type (Sheet, Table, etc.).
4. The node appears on the canvas.
5. A connector automatically forms between the previous node and this new node.
6. Configure the node:
   • Enter a unique name.
   • Select output destination.
   • Configure Layout Definition.
   • Select input node.
   • Map source fields to target fields.
   • Choose Write Mode (Overwrite, Merge, or Append).
7. Click Publish.

For detailed information on Write node types and configuration, see Working with Write Node.

Publishing Workflows

Publishing saves all workflow configurations permanently. Workflows can be published at any stage of development, including with incomplete node configurations.

To publish a workflow:

1. Click Publish in the Level 2 header.
2. The system saves all changes including:
   • Canvas layout and node positions.
   • All node configurations.
   • All connections between nodes.
   • Any deletions or modifications.
3. A confirmation message appears.

Note: No validation blocks the publish operation. Workflows can be saved with incomplete or disconnected nodes, though warning icons will display to alert users of configuration issues.

Running Workflows

Execute the workflow to process data and view results.

Executing Workflows

To run a workflow:

1. Ensure all required nodes are configured and published.
2. Click the Run button in the Level 2 header.
3. Execution begins at the Start node.
4. Visual indicators display on nodes:
   • Processing: Loading icon.
   • Successful: Checkmark.
   • Error: Error icon.
5. The Run button becomes disabled during execution.

Note: Execution follows all connected paths from the Start node. Disconnected nodes are skipped during execution.

Viewing Execution Output

To view execution output:

1. Locate the Execution Output section at canvas bottom.
2. Click the expand icon to open the section.
3. Switch between tabs:
   • Data tab: View processed data (500 rows default).
   • Message tab: View timestamped execution logs with node name, message type (Info, Warning, Error), and details.

Troubleshooting Errors

When errors occur during workflow execution:

1. Check nodes with error icons on the canvas.
2. Open the Execution Output section.
3. Click the Message tab.
4. Review error details including node name, error type, and error message.
5. Fix configuration in the affected node.
6. Click Publish to save corrections.
7. Click Run again to re-execute.