Skip to main content

Workflow Setup Guide

This guide walks you through the common process of creating and configuring workflows in Unstract. All workflow types follow the same foundational setup process, with specific differences highlighted in their respective deployment guides.

Prerequisites​

Before creating a workflow, you must export a Prompt Studio project as a tool. This exported tool will be used to process your data within the workflow.

Workflow Setup Process​

Workflows are configured through a streamlined 4-step wizard interface:

Workflow Creation Wizard

Step 1: Configure Source Connector​

Select and configure where your input data comes from.

  • Available Source Types:
    • File System (for ETL and Task pipelines)
    • API (for API deployments)

See Source Configuration for source specific settings

Step 2: Configure Destination Connector​

Select and configure where your processed data will be stored.

  • Available Destination Types:
    • Database (for ETL and HITL workflows)
    • File System (for Task pipelines)
    • API (for API deployments - no configuration needed)

See Destination Configuration for destination specific settings

info

Refer Connectors for filesystem or database connector setup

Step 3: Select Exported Prompt Studio Project​

Choose the tool that will process your data.

  • Actions:
    1. Your previously exported Prompt Studio projects will be available for selection
    2. Use Change Prompt Studio project to select a different project
    3. Click Configure Settings to modify tool-specific settings
info

At this point, you can run and test the workflow, select Actions -> Run Workflow to ensure it's working as expected. This is optional but recommended.

Step 4: Deploy Workflow​

Deploy your workflow with the appropriate deployment type. After deployment, you'll see a confirmation message with your workflow identifier.

Deployment Types Overview​

Different deployment types are optimized for specific use cases:

Deployment TypeSourceDestinationPrimary Use Case
ETL PipelineFile SystemDatabaseAutomated data extraction and loading into databases
Task PipelineFile SystemFile SystemAutomated data extraction and loading into filesystem
API DeploymentAPIAPIOn-demand API-based processing
HITL (Human-in-the-Loop)File SystemDatabaseETL with human review and approval workflow

Monitoring and Debugging​

  • Check the Debug Panel at the bottom of the interface for a high level view of what's being executed.
  • For more detailed logs, check the Logs side navigation menu -> Workflow Sessions -> select your desired workflow session.