Skip to main content

Workflow SDK

Workflow SDK provides fluent API to create workflows with strongly typed interfaces.

APIs​

ConductorWorkflow​

ConductorWorkflow is the SDK representation of a Conductor workflow.

Create a ConductorWorkflow Instance​

ConductorWorkflow<GetInsuranceQuote> conductorWorkflow = new WorkflowBuilder<GetInsuranceQuote>(executor)
    .name("sdk_workflow_example")
    .version(1)
    .ownerEmail("hello@example.com")
    .description("Example Workflow")
    .timeoutPolicy(WorkflowDef.TimeoutPolicy.TIME_OUT_WF, 100)
    .add(new SimpleTask("calculate_insurance_premium", "calculate_insurance_premium"))
    .add(new SimpleTask("send_email", "send_email"))
    .build();

Working with Simple Worker Tasks​

Use SimpleTask to add a simple task to a workflow.

Example:

...
builder.add(new SimpleTask("send_email", "send_email"))
...

Wiring Inputs to Task​

Use input methods to configure the inputs to the task.

See our doc on task inputs for more details.

Example

builder.add(
        new SimpleTask("send_email", "send_email")
                .input("email", "${workflow.input.email}")
                .input("subject", "Your insurance quote for the amount ${generate_quote.output.amount}")
);

Working with Operators​

Each operator has its own class that can be added to the workflow builder.

Register Workflow with Conductor Server​

//Returns true if the workflow is successfully created
//Reasons why this method will return false
//1. Network connectivity issue
//2. Workflow already exists with the specified name and version 
//3. There are missing task definitions
boolean registered = workflow.registerWorkflow();

Overwrite Existing Workflow Definition​​

boolean registered = workflow.registerWorkflow(true);

Overwrite existing workflow definitions & registering any missing task definitions​

boolean registered = workflow.registerWorkflow(true, true);

Create ConductorWorkflow based on the definition registered on the server​

ConductorWorkflow<GetInsuranceQuote> conductorWorkflow = 
                        new ConductorWorkflow<GetInsuranceQuote>(executor)
                        .from("sdk_workflow_example", 1);

Start Workflow Execution​

Start the execution of the workflow based on the definition registered on the server. Use the register method to register a workflow on the server before executing.


//Returns a completable future
CompletableFuture<Workflow> execution = conductorWorkflow.execute(input);

//Wait for the workflow to complete -- useful if workflow completes within a reasonable amount of time
Workflow workflowRun = execution.get();

//Get the workflowId
String workflowId = workflowRun.getWorkflowId();

//Get the status of workflow execution
WorkflowStatus status = workflowRun.getStatus();

See Workflow for more details on the Workflow object.

Start Dynamic Workflow Execution​

Dynamic workflows are executed by specifying the workflow definition along with the execution and do not require registering the workflow on the server before executing.

Use cases for dynamic workflows​
  1. Each workflow run has a unique workflow definition
  2. Workflows are defined based on the user data and cannot be modeled ahead of time statically 
//1. Use WorkflowBuilder to create ConductorWorkflow.
//2. Execute using the definition created by SDK.
CompletableFuture<Workflow> execution = conductorWorkflow.executeDynamic(input);