Skip to main content

Workflow Steps

The Cognaize Platform Workflow Engine supports a variety of step types, each designed to perform specific functions within a workflow. These steps can be customized and sequenced according to the unique requirements of each workflow. Below is an overview of the existing step types within the system, along with their functionalities and mandatory parameters.

GATEKEEPER​

Description​

The GATEKEEPER step is crucial for initiating the processing of a document within a workflow. It creates a "nebula" around the uploaded document, essentially preparing and securing the document for subsequent steps in the workflow.

Mandatory Parameters​

  • For Process:

    • documentId: This parameter is essential for identifying the document to be processed. It is used by the GATEKEEPER step to create the corresponding nebula.

  • For Workflow:

    • gatekeeperUrl: This parameter specifies the URL of the Gatekeeper service. It is crucial for the workflow to know where to send the document for nebula creation.

MODEL​

Description​

The MODEL step involves running a specific model on the document. This could be an AI model or any other type of computational model that analyzes the document and extracts or processes information based on predefined criteria.

Mandatory Parameters​

  • For Workflow:
    • modelUrl: This is the API URL where the model is hosted. This parameter is necessary for the workflow to know where to send the document for model processing.

DISTRIBUTION​

Description​

The DISTRIBUTION step is designed for distributing tasks or information extracted from the document to various endpoints, systems, or teams. This step is particularly useful for workflows that involve multi-departmental collaboration or external integrations.

Mandatory Parameters​

  • For Workflow:

    • taskDefinitionId: This parameter identifies the specific task to be distributed. It defines what action needs to be taken or what information needs to be distributed as part of this step.

  • For Process:

    • weight: This parameter might define the priority, volume, or any other metric that influences how the task is distributed or handled. It is a crucial parameter for managing the distribution logic effectively.

Each of these step types is designed to be flexible and configurable to suit a wide range of workflow requirements. By understanding and utilizing these steps, users can design powerful and efficient workflows tailored to their specific operational needs.