Here's how to schedule your process flows using the SDK:

1. Choose the Process Flow

You can choose the process flow you want to schedule for a future execution. In Wexa Studio, click on "Schedule" for more details.

Using SDK to List Available Process Flows:

2. Create New Schedule

Click on "+New Schedule" in Wexa Studio.

Using SDK to Create Schedules:

3. Choose Schedule Type

A sidebar appears asking you to choose the Schedule Type: Once or Recurring

3.1 Once

For Once, you can choose your preferred time.

SDK Example for One-Time Schedule:

3.2 Recurring

Users can choose this option if they want to execute the process flow multiple times in the future. Users can select the frequency and the interval between two consecutive executions.

SDK Example for Recurring Schedule:

List and Manage Schedules:

Executing a Process Flow

1. Run Process Flow

A Process Flow can be run by clicking the "Play" icon in Wexa Studio, or programmatically using the SDK.

Using SDK to Execute Process Flow:

2. Fill Input Details

Once done, the user will be prompted to fill details for the input of the process flow. With the SDK, you provide these as input_variables in the execution payload.

Example with Multiple Input Variables:

3. Monitor Execution

Once you hit run, the Process Flow starts its execution which can be viewed on the Task Manager screen in Wexa Studio, or monitored using the SDK.

Monitor Execution with SDK:

Control Execution:

Settings - Input Form

1. Access Process Flow Settings

Navigate to the Process Flow section via the sidebar in Wexa. Click the three dots (⋯) next to the desired process flow. Select Settings from the dropdown menu.

Using SDK to Access Process Flow Configuration:

2. Configure Input Forms

2.1 Go to Goal Settings

In the settings panel, switch to the Goal Settings tab. Locate the Input Form section and click Add Input Form.

2.2 Add Input Fields

Select from available input types:

Short Text: Single-line text input

Table: Structured data input

Date and Time: Date/time picker

File Upload: File attachment

Long Text: Multi-line text input

Number: Numeric input

One Option (Dropdown): Single selection

List of Texts: Multiple text entries

Configuring Input Forms with SDK:

Input forms are configured through the AgentFlow's goal template and input variables. When executing, provide structured input:

Example Setup with Multiple Fields:

3. Set Up the Goal Template

In the Template Editor, reference input values using Unique IDs enclosed in double curly braces {{unique_id}}.

Critical: Ensure Unique IDs in the template exactly match those set in the input form.

Updating Goal Template with SDK:

4. Finalize and Test the Form

4.1 Save the Form

Click Save and Finish to complete the setup in Wexa Studio. With SDK, the configuration is saved when you update the AgentFlow.

4.2 Test the Input Form

Run the process flow by clicking the Run button in Wexa Studio, or execute it using the SDK:

4.3 Field Customization

Optional/Required: Fields can be marked as optional or required (handled in Wexa Studio UI)

Advanced Fields: Marked fields collapse under an "Advanced" section for cleaner forms

History

History enables users to view the status of past process flows that were executed by user type at specific times.

Accessing Execution History with SDK:

Execution Status Types:

pending: Execution is queued

running: Execution is in progress

completed: Execution finished successfully

failed: Execution encountered an error

paused: Execution is paused

cancelled: Execution was cancelled

Schedule a Process Flow

1. Choose the Process Flow#

2. Create New Schedule#

3. Choose Schedule Type#

3.1 Once#

3.2 Recurring#

Executing a Process Flow#

1. Run Process Flow#

2. Fill Input Details#

3. Monitor Execution#

Settings - Input Form#

1. Access Process Flow Settings#

2. Configure Input Forms#

2.1 Go to Goal Settings#

2.2 Add Input Fields#

3. Set Up the Goal Template#

4. Finalize and Test the Form#

4.1 Save the Form#

4.2 Test the Input Form#

4.3 Field Customization#

History#