WorkflowOutputNodeEditor Documentation

Purpose

The WorkflowOutputNodeEditor component is designed to facilitate the configuration of workflow output nodes within the Vantage analytics & data platform. This component allows users to define output names, making the data generated by the workflow easily identifiable and accessible for subsequent workflows or dashboards. By configuring the output node properly, users can enhance the interconnectivity of their data workflows.

Settings

Output Name

1. Name: Output Name
2. Input Type: String
3. Description: The output name is a user-defined string that labels the data produced by this workflow output node. This name is essential for clarity and helps other workflows identify and utilize this output effectively. If the output name is changed, it directly impacts how other workflows perceive and refer to this output. For instance, a descriptive name like "Processed Data" clarifies its purpose over a generic name like "Output 1".
4. Default Value: Empty string ("")

Tooltips

• Name: Show Tooltips
• Input Type: Boolean
• Description: The component uses tooltips to provide additional context about settings. When enabled, users can see informative bubbles that explain what the output name setting relates to. This enhances user understanding, especially for newcomers to the platform who may need guidance on naming conventions. Disabling tooltips will remove these contextual hints from the UI.
• Default Value: True (tooltips are shown by default)

How It Works

The WorkflowOutputNodeEditor interacts with the application state through props, specifically selectedNode, config, and updateField. Here's how it operates:

1. Input Handling: The component accepts a config object, which includes the current settings for the output node. It reads the outputName property and displays it in a text input field.
2. Repository of Output Names: The component provides a dedicated area where users can input or modify the output name. Changes made in the input field are captured through the onChange event handler, triggering the updateField function to update the outputName value in the parent component's state, allowing for real-time interaction.
3. Tooltips: Conditional rendering of tooltips is controlled through the showTooltips variable, which is determined by the useTooltips hook. These tooltips provide additional context and descriptions for input fields.

Data Expectations

The WorkflowOutputNodeEditor expects the following data through its config prop:

• outputName: A string (can be empty), representing the name of the output.

The updateField prop should be a function capable of accepting two parameters: a key (in this case, 'outputName') and its new value.

Example of Data Structure:

{
  "outputName": "Processed Data"
}

Use Cases & Examples

Use Cases

1. Data Pipeline Management: In scenarios where multiple workflows operate on shared datasets, using the output name to clearly define each output enables consistency and eases future workflows' integration.

2. Reporting Automation: When creating reports where datasets are sourced from various workflows, a clear naming convention allows users to streamline and automate report generation by selectively referring to specific output names.

3. Collaborative Workflows: When multiple team members interact with workflows, clearly named output nodes enhance communication and understanding across the team members regarding the purpose and functionality of the outputs.

Example Configuration

Use Case: Data Pipeline Management

A data analyst is working on a project that processes raw sales data and needs a clear name for the output node to ensure its usability in future data analysis workflows.

Configuration Data:

{
  "outputName": "Monthly Sales Analysis"
}

Setup Steps:

1. Open the WorkflowOutputNodeEditor.
2. In the Output Name field, input Monthly Sales Analysis.
3. Save the configuration.

This setup ensures that any other connected workflows can easily reference the Monthly Sales Analysis output, promoting efficiency and clarity during data processing tasks.