MainWorkflowClient Documentation

Purpose

The MainWorkflowClient component is designed to serve as a primary interface for interacting with the main workflow of Vantage's analytics and data platform. It acts as a wrapper around workflow instances, allowing users to manage workflows seamlessly and efficiently. This component is crucial for enabling users to visualize, control, and interact with their data analytics processes through a streamlined workflow interface.

Settings

The MainWorkflowClient component incorporates a singular critical setting, which is the store prop passed to the WorkflowWrapper. Below is a detailed breakdown of this setting.

1. Setting: store

• Input Type: Object
• Description:
  • The store setting takes an object that is a reference to the current workflow instance store, in this case, mainWorkflowStore.
  • This object contains the state and methods needed to manage the lifecycle of workflows within the application. It is essential for ensuring that the component can correctly fetch, display, and update the workflow data.
  • Changing this setting to another workflow store (if one were available) would redirect the component to manage a different set of workflows and data.
• Default Value:
  • The default value is mainWorkflowStore, which is imported from the the workflow store module. This default ensures that the MainWorkflowClient component is always connected to a valid and necessary store unless specified otherwise.

How It Works

The MainWorkflowClient is a feature that leverages the application framework to render the WorkflowWrapper component. By passing in the mainWorkflowStore as a property to WorkflowWrapper, it enables that child component to access and manipulate workflow data appropriately. The WorkflowWrapper is responsible for handling rendering logic, state management, interactions, and possibly UI elements to display ongoing workflows, which can include progress indicators, data visualizations, etc.

This setup promotes modularity in the Vantage platform; MainWorkflowClient can focus purely on connecting to the workflow store, while WorkflowWrapper encapsulates the more complex UI and logic associated with workflow handling.

Data Expectations

MainWorkflowClient expects the following data structure from mainWorkflowStore:

• Workflow Instances: An array of objects representing each workflow, containing
  • id: Unique identifier for the workflow instance.
  • status: Current state of the workflow (e.g., running, completed, failed).
  • startTime: Timestamp indicating when the workflow started.
  • endTime: Timestamp indicating when the workflow completed (if applicable).
• Actions: Functions for starting, stopping, and resetting workflows.
• Error Handling: Mechanism to capture and manage any errors during the workflow execution.

AI Integrations

Currently, there are no explicit AI integrations specified within the MainWorkflowClient. However, it is important to note that the workflows themselves may leverage AI or machine learning algorithms as part of their processing logic, especially if tied to analytics functionalities. Any future integration can enhance the capabilities of the workflows and the data analytics provided through this component.

Billing Impacts

The MainWorkflowClient, by itself, does not introduce direct billing impacts. However, the workflows instantiated and managed through this component may involve computational resources or API calls that contribute to platform usage, potentially affecting overall billing. Users should remain aware of the billing structure for Vantage, particularly regarding the workload associated with the workflows being processed.

Use Cases & Examples

Use Case 1: Data Transformation Workflow

In this use case, a business analyst wants to execute a data transformation workflow to clean and aggregate customer data from multiple sources for reporting.

Use Case 2: Regular Reporting Automation

A financial department requires consistent reporting on monthly revenue streams. They can set up a workflow that automatically fetches data, processes it, and generates visual reports.

Use Case 3: Machine Learning Model Training

Data scientists can leverage the MainWorkflowClient to trigger workflows that involve training machine learning models on large datasets while monitoring their status and performance metrics.

Detailed Example Configuration

Use Case: Data Transformation Workflow

To configure the MainWorkflowClient for this specific scenario, the following setup can be implemented in the main application file:

'use client';

// Internal import

export default function MainWorkflowClient() {
    return (
        <WorkflowWrapper
            store={mainWorkflowStore}
        />
    );
}

In this example, mainWorkflowStore should be initialized with a set of workflows designed to perform various transformations, such as filtering duplicates, aggregating sales data, and generating summary statistics. Users can initiate these workflows through the interface provided by WorkflowWrapper, visualize their status, and react to any issues that arise during execution.