Define Workflow Characteristics

Prev Next

The Workflow enables you to build complex workflows without requiring coding expertise. It is designed to adapt to your business requirements, offering a low‑code/no‑code environment that simplifies configuration and accelerates automation.

With this understanding of the Workflow’s capabilities, you are now ready to learn how to construct a workflow from the ground up.

Note

Users must have appropriate permissions to access or create a new workflow.

To create a workflow, the required details should be entered by an administrator in the subsequent tabs:

Projects

Projects allow you to organize workflows for better management and visibility. Each project can include multiple workflows, descriptions, and color coding for easy identification.

Figure: Projects

Project widget

The Project widget enables you to create and manage workflows associated with a specific project. It allows you to group and organize all related workflows under a single project for better visibility and management. Each project widget displays key details, including the project icon, project name, a brief description, the number of associated workflows, and the last updated date.

Click Project widget to view the list of workflows created for the selected project.

Figure: Workflow list

You can perform the following actions in the Project widget:

Edit

Editing a project allows you to update its details to ensure accuracy and reflect changes in scope, workflows, or business requirements.

To edit a project, perform the following steps:

  1. Hover over the Project widget.

  2. Click the (Edit) icon.
    The Edit Project page is displayed.

    Figure: Edit Project

  3. Update the required fields and click Update.
    Project Updated Successfully message is displayed.

Duplicate

Creates a duplicate of the selected workflow, allowing reuse of configuration with modifications.

When a workflow is duplicated using the Duplicate (Copy) icon, the application creates a new workflow with the same configuration. The duplicated workflow name is automatically appended with “(Copy)” to indicate that it was created from an existing workflow

Delete

Deleting a project permanently removes it from the Projects list.

To delete a project, perform the following steps:

  1. Hover over the Project widget.

  2. Click the (Delete) icon.

  3. Confirm the deletion when prompted.

Note

Deleting a project may affect associated workflows. Ensure the project is no longer required before deletion.

The following table describe the label listed in the Workflows list page:

Label

Description

VERSION

Displays the current version of the workflow.

ACTIVE

Indicates the workflow is active and eligible for execution based on trigger conditions.

STATUS

Shows the current state of the workflow (Draft, Published, etc.), indicating readiness for deployment.

Create New Project widget / + New Project

You can create a project using either of the following options:

Option 1: Using the New Project button

  1. Click + New Project.
    The Create Project page page is displayed.

    Figure: Create Project

  2. Enter the required project details as described in the following table and click Create.

    Field

    Description

    Project Name

    Enter a unique and meaningful name for the project (mandatory).

    Description

    Provide a brief summary of the project’s purpose or scope.

    Color

    Select a color to visually identify and differentiate the project

Option 2: Using the Create New Project widget

  1. Click the Create New Project tile.
    The Create Project page page is displayed.

    Figure: Create Project

  2. Enter the required project details and click Create.

Project Search

Use the Project Search field to quickly locate projects by entering relevant keywords. The project list dynamically updates to display matching results as you type. This helps users efficiently access specific projects without manually browsing the list.

Project Search

Use the Project Search field to quickly locate projects by entering relevant keywords. The project list dynamically updates to display matching results as you type. This helps users efficiently access specific projects without manually browsing the list.

Workflows

The Workflow Designer provides a visual interface for creating and managing object-driven workflows.

For more information, refer to Design Workflow.

Run History

The Run History screen provides visibility into workflow executions, enabling designers to monitor status, track progress, and review execution details for workflows triggered by system events.

Figure: Run History

The following summary of workflow execution counts by status for quick monitoring and overview is displayed.

  • Running : Displays the number of workflows currently in execution.

  • Completed : Displays the number of workflows successfully executed.

  • Terminated : Displays the number of workflows that were stopped before completion.

You can configure the filter to refine and control the workflow execution list based on selected criteria.

Field

Description

Search

Searches execution records by workflow name or related attributes.

Mode

Filters workflows based on execution mode (for example, Agent, Simulation)

Status

Filters execution records by status. The listed status are:

  • Started (newest first)

  • Started (oldest first)

  • Completed

  • Workflow Name

Page

Controls the number of records displayed per page. The list of pages are:

  • 10 per page

  • 20 per page

  • 50 per page

  • 100 per page

Reset Filters

Clears all applied filters and resets the view.

Click View to view of a specific workflow execution, including its status, execution timeline, node-level details, and input/output data for monitoring and troubleshooting. Users can also view the execution flow through the Diagram tab and analyze detailed execution events in the Logs tab

Figure: Details

Workflow Diagram Tab

Figure: Diagram Tab

Log Tab

Figure: Logs

Deployments

Enables you to view and manage deployments at a project level. It provides a centralized view of all available projects, along with workflow and deployment counts, allowing users to quickly navigate and initiate deployment activities.

Figure: Deployments

You can view the projects in the My Project tab owned or managed by the logged-in user, while Shared with Me displays projects shared with the user for collaboration or review.

Click to initiates the deployment process for workflows within a selected project. Users can configure and deploy workflows to the target environment.

Figure: Create Deployment

The create deployment page comprises following sections:

After the enter the required details, click Finish Deployment.

Deployment Details

The Deployment Details page provides a structured view to configure and initiate workflow deployment with preselected context, ensuring accurate and controlled deployment of a published workflow version.

Figure: Deployment Details

Enter the required details as described in the following table:

Field

Description

Deployment Details

Specifies a unique name for the deployment. This helps identify and track the deployment instance

Project

Selects the project under which the workflow is deployed. This determines the scope and context of the deployment.

Workflow Name

Select the workflow for deployment based on the chosen project. This field is dependent on the selected project.

Workflow Version

Specifies the version of the workflow to be deployed. Only published versions are available for selection.

Inputs

Displays the input parameters required by the selected workflow during deployment. These inputs are used to pass data into the workflow at runtime.

Figure: Inputs

Run Settings

The Run Settings defines how and when the deployed workflow is executed. It allows administrators to configure execution mode and enable diagnostic logging for monitoring and troubleshooting.


Figure: Run Settings

Select the require options as described in the following table:

Field

Description

On Demand

Executes the workflow manually through an API endpoint using a generated key. Suitable for event-driven or integration-based execution.

On Schedule

Executes the workflow automatically at defined intervals. Suitable for recurring or time-based processes.

Enable Diagnostic Logs

Enables detailed execution logging for troubleshooting and analysis. May slightly impact performance due to additional logging.

API Access

The API Access provides the required details to trigger workflow execution programmatically. It includes the endpoint, authentication key, and tenant information needed to invoke the deployed workflow securely.

Figure: API Access

Defines the following key parameters required to securely invoke the deployed workflow through API:

Field

Description

API Endpoint

Displays the endpoint URL used to invoke the deployed workflow. This endpoint is used in API calls to trigger workflow execution

API Key

Provides the authentication key required to securely access the API endpoint. This key must be included in the request to authorize execution.

Tenant

Displays the tenant or environment context under which the workflow is deployed. This ensures the API call is routed to the correct environment.

  • Click to view the API key, it is used for secure viewing.

  • Click to copy the API Endpoint, API Key, or Tenant value for use in external integrations.

Invoke Deployment

The Invoke Deployment provides a ready-to-use API request for triggering the deployed workflow. It enables administrators and external systems to execute workflows programmatically using standard HTTP requests.

Figure: Invoke Deployment