Process Editor Library Steps

Symphona Flow’s Process Editor comes with an extensive pre-built library of steps (contained within the “Step Library”) that you can drag-and-drop in the editor to easily create automated business Processes. Whether you’re just getting started with Flow or need a quick refresher on certain steps, this guide is for you!

In this guide, we’ll go over:

• An overview of each step in the Process Editor Step Library, organized by category
• How to configure each step
• Example use cases of how to use these step in a real automation flow

Let’s dive in!

Table of Contents

The Process Editor makes available many steps to help you automate Processes. The following list contains all of the steps which you can use today when building Processes:

• Process Editor Library Steps
• Table of Contents
• Logic Steps
• Evaluate Expression
• Set Parameter Value
• Generate Random UUID
• JSON Editor
• Create Custom Log
• Replace Keys in Content
• Try and Catch
• Time
• Get Current Date / Time
• Wait Duration
• Flow
• Conditional Branch
• Trigger Process
• End Process
• Loop
• Loop
• End Loop Early
• External Task
• Generate External Task
• Await External Task Completion
• Validation
• Validate Map Entries
• Validate List Values
• Integration Steps
• REST API
• Invoke REST API (General)
• Invoke REST API (Get File)
• SOAP API
• Invoke SOAP API
• SFTP
• Move File Between Locations (SFTP)
• SSH
• Execute SSH Command
• Database
• Execute SQL Command
• Communication
• Send Email
• Send SMS
• Service Ticket
• Create Service Ticket
• Create Service Ticket Task
• Fallout Ticket
• Create Fallout Ticket
• File
• Excel
• Extract Data (Excel)
• Create Spreadsheet (Excel)
• Validate Values Match Across Files (Excel)
• Return Formula Result (Excel)
• Look Up Values (Excel)
• Validate Values (Excel)
• Update Data (Excel)
• AI
• Prompt AI
• Analyze
• Identify Sentiment (AI)
• Identify Intent (AI)
• Summarize (AI)
• Translate (AI)
• Get Fields (AI)
• File
• Extract Text (File AI)
• Extract Form (File AI)
• Extract Table (File AI)
• Web UI

Logic Steps

Evaluate Expression

The Evaluate Expression step in the Logic category evaluates a logical expression (i.e. evaluating statements as “true” or “false”, performing calculations, etc.) and store the output in a new or existing Process parameter. To use this step, you must configure the following fields:

• Evaluation Expression: The expression to be evaluated
• The Evaluation Expression may use a combination of static constant values, dynamic parameter values, and operators (e.g. >, <, =, +, -, *, etc.) as defined here
• Throw Error If Result is False: Whether an exception should be thrown if the result is “false”, resulting in a Fallout Ticket being generated
• Output Parameter: Expression Result: The Process parameter name which will have the value of the evaluated expression for use in later steps
• Expected Data Type of Result: The expected data type of the Expression Result

Example use cases:

1. Comparing dates, text, numbers, and other data stored in parameters or constant values
2. Evaluating conditional statements for use in later steps, like for performing parameter value validation
3. Performing calculations, like addition and multiplication, between parameter and constant values

Set Parameter Value

The Set Parameter Value step in the Logic category sets the values stored in either a new or existing Process parameters. For each Process parameter defined in a Set Parameter Value step, you must configure the following fields:

• Output Parameter: Target Parameter: The Process parameter name which the new value should be stored in (either a new or existing Process parameter) for use in later steps
• New Parameter Value: The value to be assigned to the Target Parameter (may use a combination of static constant values and dynamic parameter values)
• Expected Data Type: The expected data type of the Target Parameter (must match the type of data specified in the New Parameter Value field)

Example use cases:

1. Setting an initial value for a Process parameter
2. Copying the value from one Process parameter to another one

Generate Random UUID

The Generate Random UUID step in the Logic category generates a new random universally unique identifier value (UUID), providing a fully unique value. To use this step, you must configure the following fields:

To use this step, you must specify:

• Output Parameter: Generated UUID: The Process parameter name which should contain the outputted UUID value for use in later steps

Example use case:

1. Assigning a random UUID value as the ID field to a new record stored in a database

JSON Editor

The JSON Editor step in the Logic category is designed to modify and manipulate JSON data according to your specific requirements. Before using this step, you must configure the following fields:

• Input JSON: Holds the JSON data that will be manipulated. The source JSON can be static or dynamically provided.
• Action Type: Determines what kind of operation will be executed on the JSON data. Actions are: add, update, or delete.
• JSON Path: Specifies the location within the JSON data where the action should take place.
• Key-Value Pair (optional): Indicates the data to be added or the update to be made at the specified JSON path.
• Output Parameter: Out Content: The process parameter that will store the manipulated JSON content.

Create Custom Log

The Create Custom Log step in the Logic category allows you to record custom log entries within your process execution. This step enables you to document specific events or messages, making it easier to trace workflow behavior, debug issues, or audit operations. When using this step, you must configure the following fields:

• Log Title: The Log Title field specifies a concise summary or identifier for the log entry.
• Log Description: The Log Description field provides a detailed narrative of the log entry. This description should include all pertinent information, such as contextual details, dynamic parameter values, and any other relevant data points.

Replace Keys in Content

• Input Content: Specifies the original content in which key replacements will be performed. The content can be static or dynamically provided via process parameters.
• Input Request Keys Values: Provides a collection of key-value pairs that will be used to replace keys within the Input Content.
• Parameter Name: The name of the key that is expected to be found within the Input Content.
• Parameter Value: The value that will replace the existing key in the Input Content. This value can be either a static literal or dynamically sourced from a process parameter.
• Output Parameter: Output Content: The Process parameter where the updated content (with the replaced keys) will be stored for further use in subsequent steps.

Try and Catch

The Try and Catch step provides error handling capabilities within your process flows, allowing you to gracefully manage exceptions and failures that may occur during execution. This step creates a controlled environment where you can attempt to execute a series of steps and define alternative actions if any errors occur.

• How it Works:

The Try and Catch step consists of two main sections:

1. Try Block: Contains the steps you want to execute under normal circumstances
2. Catch Block: Contains the steps that will execute if an exception occurs in the Try block

When the process reaches this step, it will first attempt to execute all steps within the Try block. If any step fails or throws an exception, the process will immediately jump to the Catch block and execute the alternative flow you've defined.

• Output Parameters

The Try and Catch step provides two optional output parameters to help you handle and track errors:

1. Fallout Message: Captures the error message or exception details when a failure occurs in the Try block
2. Fallout Step Name: Records the name of the specific step that caused the exception

Both parameters can be configured as new parameters or mapped to existing ones, allowing you to log errors, send notifications, or use the failure information in subsequent steps.

Time

Get Current Date / Time

The Get Current Date / Time step in the Logic > Time category obtains the current date and time from a specified time zone. To use this step, you must configure the following fields:

• Time Zone: The time zone you would like to get the date / time from (selected from a list of provided options)
• Get Date: Whether you would like the date returned (’Yes’ / ‘No’)
• If ‘Yes’, the current date will be returned in the output
• Get Time: Whether you would like the time returned (’Yes’ / ‘No’)
• If ‘Yes’, the current time will be returned in the output
• Output Parameter: Current Date / Time: The Process parameter name where the date / time should be stored in for use in later steps

Example use case:

1. Get the current local time for comparing dates (in other later steps)

Wait Duration

The Wait Duration step in the Logic > Time category allows you to pause Process execution for a specified duration before executing the next step (up to a maximum duration of 604,800 seconds or 7 days). To use this step, you must configure the following fields:

• Wait Time (Sec): The duration the Process should pause execution in seconds (either a static constant value or a dynamic parameter value)

Example use cases:

1. Wait for a value from an API to have some specified value by repeatedly waiting for a set duration in a loop
2. Wait before changing the status of a Service Ticket automatically

Flow

Conditional Branch

The Conditional Branch step in the Logic category enables conditional flows, where certain steps will be executed depending on whether its conditions have been fulfilled.

We have written the following guide on how to create conditional flows using the Conditional Branch step.

Example use case:

1. Choose whether to send an email or set up a Service Ticket based on the status of a customer order

Trigger Process

The Trigger Process step in the Logic category allows you to initiate a subprocess within a larger workflow. This enables modular execution, where a separate process can be triggered to handle specific tasks while the main process continues or waits for completion.

For more details, see our guide on subprocess triggering.

End Process

The End Process step in the Logic > Flow category ends the Process execution early with a “Success” status.

Loop

Loop

The Loop step in the Logic > Loop category allows you to create a loop that can iterate multiple times over a series of steps which can be dragged into the loop in the editor view. To use this step, you must configure the following fields:

• End Condition: The end condition of the loop (i.e. the condition that, when fulfilled, will make the loop end)
• The Evaluation Expression may use a combination of static constant values, dynamic parameter values, and comparison operators (e.g. >, <, =, etc.) as defined here
• Max Loop Iterations: The maximum amount of loop iterations (commonly to avoid accidental endless loops)
• [Optional] Output Parameter: Loop Iteration #: The Process parameter name where the current loop iteration is stored for use in later steps

Example use cases:

1. Loop over a set of rows in a spreadsheet to extract the values and perform actions with them
2. Repeatedly invoke an API a set number of times using a loop

End Loop Early

The End Loop Early step in the Logic > Loop category will end a loop before the loop’s specified end condition is met.

IMPORTANT: this step can only be used within a loop.

Example use case:

1. Conditionally breaking out of a loop when some rule is met before the loop’s regular end condition

External Task

External Tasks are helpful when you would like to pause Process execution while some actions are being performed in another digital system, and then resume Process execution once that digital system notifies to Symphona indicating task completion, similar to the software development concept of “callbacks”.

Generate External Task

Added to the Process flow before an Await External Task Completion step, the Generate External Task step in the Logic > External Task category creates a new External Task with a unique task ID to be later sent to a third-party digital system (e.g. via an API request). To use this step, you must configure the following fields:

• Output Parameter: Generated Task ID: The Process parameter name where the generated task ID should be stored in for use in later steps

Await External Task Completion

The Await External Task Completion step in the Logic > External Task category pauses Process execution until the External Task Completion API is invoked for a given External Task ID. To use this step, you must configure the following fields:

• External Task ID: The External Task ID which the step is awaiting completion of (either a static constant value or a dynamic parameter value)
• Maximum Wait Time: The maximum wait time this step will await completion before throwing a Fallout exception (either a static constant value or a dynamic parameter value)
• [Optional] Output Parameter: External Task Execution Response: The Process parameter name where the execution response data should be stored in for use in later steps

To complete an External Task, you must call the External Task Completion API. Please refer to the API documentation section of this portal for more information on the API request details.

Validation

Validate Map Entries

The Validate Map Entries step in the Logic > Validation category validates a set of keys and values (map of data) stored in a JSON map format against a specified expression. To use this step, you must configure the following fields:

• Map: The Process parameter containing the JSON map to be validated
• Should Validate Keys or Values: Whether to validate keys or value against the Evaluation Expression (’Values’ / ‘Keys’)
• Evaluation Expression: The expression that will be used to validate the Map’s keys or values
• The Evaluation Expression may use a combination of static constant values, dynamic parameter values, and comparison operators (e.g. >, <, =, etc.) as defined here
• [Optional] Output Parameter: All Entries True: The Process parameter name which will have the value ‘true’ if all entries evaluate to ‘true’ (meaning every Map entry has successfully passed the evaluation expression) or ‘false’ otherwise
• [Optional] Output Parameter: Evaluation Results: The Process parameter name where the evaluation results is stored for each entry within the Map (as a Map with values ‘true’ or ‘false’ for each entry of the evaluated Map) for use in later steps

Example use case:

1. Given a map of customer names and their phone numbers, validate that each customer has an associated phone number

Validate List Values

The Validate List Entries step in the Logic > Validation category validates a list values stored in a JSON map format against a specified expression. To use this step, you must configure the following fields:

• List: The JSON list of values to be validated (either static constant values or a dynamic parameter value)
• Evaluation Expression: The expression that will be used to validate the List’s values
• The Evaluation Expression may use a combination of static constant values, dynamic parameter values, and comparison operators (e.g. >, <, =, etc.) as defined here
• [Optional] Output Parameter: All Entries True: The Process parameter name which will have the value ‘true’ if all entries evaluate to ‘true’ (meaning every List entry has successfully passed the evaluation expression) or ‘false’ otherwise
• [Optional] Output Parameter: Evaluation Results: The Process parameter name where the evaluation results is stored for each entry within the List (as a List with values ‘true’ or ‘false’ for each entry of the evaluated List) for use in later steps

Example use case:

1. Validate if every item in a numerical list has a value larger than 500

Integration Steps

REST API

Invoke REST API (General)

The Invoke REST API (General) step in the Integration > REST API category executes a REST API request to integrate with other digital systems which expose API endpoints. Note that the response data size is limited to 25KB, and the API being invoked must be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• API URL: The API URL (or API endpoint) you would like to invoke
• API Request Method: The request method to use for the request (’GET’, ‘POST’, ‘PUT’, ‘DELETE’, ‘PATCH’, ‘HEAD’, ‘OPTIONS’)
• Body Type: The request body type you want (’Form Data’, ‘JSON’, ‘XML’, ‘JavaScript’, ‘HTML’, ‘Text’), most commonly ‘Form Data’
• [Optional] API Request Body Parameters: The body parameters to use for the API request
• [Optional] API Request Header Parameters: The header parameters to use for the API request
• API Retry: Is the API allowed to try connecting again before giving up
• [Optional] Number of Retries: How many times the API is allowed to try again.
• [Optional] Delay Between Retries: How many milliseconds between each attempt
• Throw Error if API Fails: Should a Fallout Ticket be created if the API Fails
• [Optional] Output Parameter: Extracted Field Value: The Process parameter name to contain API response data for use in later steps
• Note that JSON dot notation can be used to access sub-fields within a given API response field
• [Optional] Output Parameter - Response Headers: Stores HTTP response headers, such as content type or authentication details.
• [Optional] Output Parameter - Response Status Code: Captures the HTTP status code to check if the request was successful or failed.
• [Optional] Output Parameter - Execution Result: Saves the overall outcome of the process for success or error handling.

Example use cases:

1. Create a new record in your CRM using its exposed API endpoints
2. Get recent transactions from your accounting software using its exposed API endpoints

Invoke REST API (Get File)

The Invoke REST API (Get File) in the Integration > REST API category executes a REST API request to fetch a file from other digital systems which expose API endpoints. Note that the fetched file will be stored in File Manager, and the API being invoked must be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• API URL: The API URL (or API endpoint) you would like to invoke
• Body Type: The request body type you want (’Form Data’, ‘JSON’, ‘XML’, ‘JavaScript’, ‘HTML’, ‘Text’), most commonly ‘Form Data’
• [Optional] API Request Body Parameters: The body parameters to use for the API request
• [Optional] API Request Header Parameters: The header parameters to use for the API request
• Output Parameter: Response: The Process parameter name to contain the file ID of fetched file for use in later steps

Example use case:

1. Get a Excel file from another system so it can be processed by later steps

SOAP API

Invoke SOAP API

The Invoke SOAP API step in the Integration > SOAP API category executes a SOAP API request to integrate with other digital systems which expose SOAP endpoints. Note that the response data size is limited to 25KB, and the API being invoked must be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• API URL: The SOAP API URL (or SOAP endpoint) you would like to invoke
• API Request Method: The request method to use for the request ('POST', 'GET')
• Body Type: The request body type, which is 'XML' for SOAP requests
• API Request Body: The SOAP XML body content for the API request
• [Optional] API Request Header: The header parameters to use for the SOAP API request
• API Retry: Whether the API is allowed to try connecting again before giving up ('Allowed', 'Not Allowed')
• [Optional] Number of Retries: How many times the API is allowed to retry (1-5 retries)
• [Optional] Delay Between Retries: How many milliseconds to wait between each retry attempt
• [Optional] Output Parameter: Response Body: The Process parameter name to contain the SOAP API response data for use in later steps
• [Optional] Output Parameter: Response Headers: Stores HTTP response headers, such as content type or authentication details
• [Optional] Output Parameter: Response Status Code: Captures the HTTP status code to check if the request was successful or failed

Example use cases:

1. Integrate with legacy enterprise systems that use SOAP web services
2. Access government or financial services APIs that require SOAP protocol
3. Connect to enterprise software applications with SOAP-based APIs

SFTP

Move File Between Locations (SFTP)

The Move File Between Locations (SFTP) step in the Integration > SFTP category transfers a file from one location to another. Note that the source and target hosts must be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• Source Host Name / IP Address: The host name or the IP address of where the source file is currently being stored
• Target Host Name / IP Address: The host name or the IP address of where the file should be moved to
• Source Folder: The folder containing the source file
• Source File: The name of file in the source system
• Target Folder: The folder where the file should be moved to in the target system
• Target File: The name of the file in the target system (can be the same as the Source File if no name change is desired)
• Output Parameter: SFTP Response: The Process parameter name to store the SFTP response for use in later steps
• Output Parameter: SFTP Status: The Process parameter name to store the SFTP status for use in later steps

Example use case:

1. Transfer an order confirmation document from one file repository to another

SSH

Execute SSH Command

The Execute SSH Command step in the Integration > SSH category executes a shell commands on a remote server via SSH. Note that the target host server be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• Hostname: The hostname where the Command will be executed
• Username: The username to access the host server
• Password: The password to access the host server
• Command: The command to execute on the host server (may use a combination of static constant values and dynamic parameter values)
• [Optional] Command Arguments: The command arguments to include with the command
• Output Parameter: SSH Execution Response: The Process parameter name to store the SSH execution response for use in later steps
• Output Parameter: SSH Execution Result: The Process parameter name to store the SSH execution result for use in later steps

Example use case:

1. Orchestrate execution of multiple existing shell scripts on a set of servers

Database

Execute SQL Command

The Execute SQL Command step in the Integration > Database category step executes an SQL command on a target database, enabling data to be fetched or updated. Note that the target database be publicly available (e.g. not restricted within a given IT network). To use this step, you must configure the following fields:

• Database Name: The name of the database to send the SQL commands to
• Database Type: The type of database being connected to (’Postgres’, ‘Oracle’, ‘Microsoft SQL Server’)
• Host IP Address: The IP address of the database server to establish the connection.
• Port Number: The port number used to communicate with the database server.
• Service Name / ID: The unique identifier or service name for the target database.
• Database Username: The database username to use to connect to the database
• Database Password: The database password to use to connect to the database
• SQL Command: The SQL statement to invoke on the target database
• Output Parameter: SQL Response: The Process parameter name where to store the SQL response for use in later steps

Example use case:

1. Send a SELECT command to your company’s CRM, pull its list of active customers, and store it in the SQL response parameter

Communication

Send Email

The Send Email step in the Communication category allows you to send an outbound email to one or more specified addresses. To use this step, you must specify:

• Subject Line: The subject line
• Destination Email: The email or list of emails you want to send the email to (can be a static or dynamic parameter)
• Message: The email message
• File Attachment (optional): The file attachment to send with the email

Example use case:

1. Automate an email reply to simple customer queries

Send SMS

The Send SMS step in the Communication category allows you to send an outbound SMS to one or more phone numbers (Canada / USA). To use this step, you must specify:

• Destination Phone Number(s): The phone number(s) you want to send a message to (can be a static or dynamic parameter)
• Message: The message you want to send
• Sender phone number: The phone number to use for sending the SMS (must set one up in Settings)

Example use case:

1. Automate an SMS reply to common customer queries sent via mobile

Service Ticket

Create Service Ticket

The Create Service Ticket step in the Service Ticket category allows you to create a Service Ticket for manual tasks. These Service Tickets will be created within Serve. To use this step, you must configure the following fields:

• Ticket Name: The name of the Service Ticket.
• [Optional] Description: Provide a description of the Service Ticket.
• Ticket Type: Choose a ticket type from a dropdown.
• Field Data Mappings: If available for the selected Ticket Type and needed, define what constant or Process parameter values are stored in the Service Ticket’s Additional Fields.
• [Optional] Assignee: The user who is initially assigned to the ticket.
• [Optional] File Attachments: The file attachments in the ticket.
• [Optional] Output Parameter: Service Ticket ID: The Process parameter name where the Service Ticket ID should be stored for use in later steps.

Example use case:

1. Create a Service Ticket when a customer requests support with an unfulfilled order.

Create Service Ticket Task

The Create Service Ticket Task step in the Service Ticket category allows you to create a Service Ticket Task for a specified Service Ticket. To use this step, you must configure the following fields:

• Name: The name of the Service Ticket Task.
• Task Type: The task type (’To-Do’, ‘Approval’).
• Description: The description of the task type.
• Await Task Completion: Whether the Process will pause execution until an action is performed on the Ticket Task.
• [Optional] Timeout (Min): The timeout duration (in minutes) for the task to be completed. If awaiting task completion and the timeout duration is surpassed without any Ticket Task action taken, the Action Performed output parameter will be set to “Timeout”. Max timeout is 10,080 min (7 days).
• [Optional] Related Service Ticket ID: The ID of the parent Service Ticket to associate this task with (if no value is provided, a new Service Ticket will be automatically created).
• Reopen Service Ticket: Whether to reopen the Service Ticket.
• [Optional] Output Parameter: Ticket Task ID: The Process parameter name where the Ticket Task ID should be stored for use in later steps.
• [Optional] Output Parameter: Service Ticket ID: The Process parameter name where the Service Ticket ID should be stored for use in later steps.
• [Optional] Output Parameter: Action Performed: The Process parameter name where the Action Performed should be stored for use in later steps.

Example use cases:

1. Create a sub-task for an existing Service Ticket.
2. Add an approval step to the Process so execution pauses until the Ticket Task is marked as ‘Complete’.

Fallout Ticket

Create Fallout Ticket

The Create Fallout Ticket step in the Fallout Ticket category allows you to create a Fallout Ticket to stop Process execution and record an error. To use this step, you must configure the following fields:

• Description: The error message for the ticket.

Example use case:

1. Create a Fallout Ticket if some condition in a Conditional Branch is met

File

Excel

Extract Data (Excel)

The Extract Data step in the File > Excel category extracts data from specified cells from an Excel spreadsheet. To use this step, you must configure the following fields:

• File: The Excel spreadsheet containing the data (either uploaded or from a Process parameter).
• Output Parameters: Extracted Data: The Process parameter names where the extracted data should be stored, for each configuring:
• The Process parameter name.
• The cell numbers containing the data you want to extract.
• The expected data type of the data you plan to extract.

Example use case:

1. Extract a list of data from a spreadsheet.

Create Spreadsheet (Excel)

The Create Spreadsheet step in the File > Excel category creates a new Excel spreadsheet document. To use this step, you must configure the following fields:

• File Name: The name of the file.
• [Optional] Initial Data: The initial data for the spreadsheet (defined within the spreadsheet table editor view)
• Output Parameter: File: The Process parameter name where the file should be stored for use in later steps.

Example use case:

1. Create a new spreadsheet to store the summaries of customer inquiries.

Validate Values Match Across Files (Excel)

The Validate Values Match Across Files step in the File > Excel category compares given ranges between two spreadsheets. To use this step, you must configure the following fields:

• File 1: The first Excel file.
• File 1 Key Range: The range for the keys in the first file.
• File 1 Value Range: The range for the values in the first file.
• File 2: The second Excel file.
• File 2 Key Range: The range for the keys in the second file.
• File 2 Value Range: The range for the values in the second file.
• Output Parameter: All Values The Same: The Process parameter name where the result of whether all values are the same (‘true’ or ‘false’) should be stored for use in later steps.
• Output Parameter: Evaluation Results: The Process parameter name where the row-by-row evaluation results should be stored for use in later steps.

Example use case:

1. Compare monthly order data for your SKUs for the years 2022 and 2023.

Return Formula Result (Excel)

The Return Formula Result step in the File > Excel category returns a formula result from a given Excel spreadsheet. To use this step, you must configure the following fields:

• Formula: The formula you want to evaluate.
• File: The Excel spreadsheet to apply the formula to (either uploaded or from a Process parameter).
• [Optional] Output Parameter: Cell to Store Result: The Excel cell to store the formula result in (e.g. ‘A1’).
• Output Parameter: Formula Result: The Process parameter name where the evaluated formula result should be stored for use in later steps.

Example use case:

1. Calculate the total number of orders in a given month and subtract returns.

Look Up Values (Excel)

The Look Up Values step in the File > Excel category looks up values provided in an input list within a range of spreadsheet cells. To use this step, you must configure the following fields:

• Values to Look Up: The series of values to look up in the spreadsheet.
• File: The Excel spreadsheet containing the values (either uploaded or from a Process parameter).
• Look Up Cell Range: The look up spreadsheet cell range to search for the values in.
• Output Parameter: All Values Found (True / False): The Process parameter name to store the result of whether all values were found.
• Output Parameter: Look Up Results: The Process parameter name where the look up results should be stored for use in later steps.

Example use case:

1. Look for the order data associated with the SKU Name “Hanley’s Mint Soap” in the spreadsheet “SKU Order Data - February 2022”.

Validate Values (Excel)

The Validate Values step in the File > Excel category validates specified row / column values in an Excel document. To use this step, you must configure the following fields:

• Evaluation Expression: The conditional expression that will be used to validate each value within the Evaluation Cell Range.
• File: The Excel spreadsheet to be validated (either uploaded or from a Process parameter).
• Evaluation Cell Range: The Excel cell range to apply the evaluation against.
• Output Parameter: All Values True: The Process parameter name where the result of whether all values were evaluated as ‘true’ should be stored for use in later steps.
• Output Parameter: Evaluation Results: The Process parameter name where the evaluation results should be stored for use in later steps.

Example use case:

1. Validate if monthly orders for the past year are greater than 100.

Update Data (Excel)

The Update Data step in the File > Excel category updates data in the specified cells of an Excel spreadsheet. To use this step, you must configure the following fields:

• File: The Excel spreadsheet to be modified (either uploaded or from a Process parameter).
• Updated Data: Opens the uploaded spreadsheet in an editor where you can make and store your changes.

Example use case:

1. Update the “Monthly Orders” spreadsheet whenever a new order is placed.

AI

Prompt AI

For additional information and detailed explanations on how to fully utilize our AI, see our AI Prompting section here.

The Prompt AI step in the AI category allows you to send a prompt to our generative AI engine. To use this step, you must configure the following fields:

• Knowledge Source: The knowledge source you want to use (the AI model, a custom knowledge base, or both).
• Knowledge Base: The target knowledge base if you selected the knowledge base option. You can learn more about how to configure Knowledge Bases here.
• Prompt: The prompt you want our AI to act on (input data must be less than 24,000 characters).
• [Optional] Context: Provide context to our AI so it can better execute your prompt (context length must be less than 8,200 characters).
• Enhance Queries: Whether you want to enhance queries.
• Model: Select which AI model you want to use (e.g. ‘OpenAI GPT-4o’).
• Max Knowledge Base Results: The maximum number of chunks of info retrieved from the knowledge base when generating a response, if you selected a custom knowledge base. Greater values typically improve response quality but also increase the number of tokens consumed.
• Validate Response Before Sending: Whether to perform a secondary check on the output to increase response accuracy (will reduce response speed).
• Include References in Response: Whether to include a reference in the generated response text, showing the source of the information procured.
• Enable Multi-Lingual Support: Whether to automatically translate the response to the language of the prompt (will reduce response speed).
• Response Variability: The randomness of the response (values closer to 0 will return more deterministic and repetitive responses).
• Max Response Length (Number of Tokens): The maximum response length (maximum response length is 8,192 tokens or about 32,768 characters).
• Output Parameter: Response: The Process parameter name where the response should be stored for use in later steps.
• Output Parameter: Source References: The Process parameter name where the source references should be stored for use in later steps.

Example use case:

1. Provide our AI with a knowledge base of your organization’s brand and communication guidelines as well as past logs of previous customer service interactions. Give it context that it is a customer service agent that must adhere to the guidelines and provide quality customer service based on the interactions it has been given. Keep its response variability low to avoid hallucinations and provide it common prompts (e.g. “How do I reset my password?”, “I want to open a new account.”, etc.).

Analyze

Identify Sentiment (AI)

The Identify Sentiment step in the AI > Analyze category allows you to use our AI to identify the sentiment of a given input. To use this step, you must configure the following fields:

• Input Type: The input type (‘Text’).
• Input: The input content to analyze.
• Classification Type: Select the classification to perform (’Positive or Negative’, ‘Positive, Negative, Emotions’).
• Output Parameter: Sentiment: The Process parameter name where the identified sentiment should be stored for use in later steps.

Example use case:

1. Identify and collect the sentiment of customer service emails and transcripts to determine how customers really feel, in the moment, about your organization’s customer service.

Identify Intent (AI)

The Identify Intent step in the AI > Analyze category allows you to use our AI to identify the intent of a given input. To use this step, you must configure the following fields:

• Input Type: Choose the input type (’Text’).
• Input: The input content to analyze.
• Intent Options: The list of possible intents the content should be classified into.
• Output Parameter: Intent: The Process parameter name where the identified intent should be stored for use in later steps.

Example use case:

1. Identify the intent of emails coming into a payables inbox to determine which emails are actually payable items and which are irrelevant.

Summarize (AI)

The Summarize step in the AI > Analyze category allows you to use our AI to summarize a given input. To use this step, you must configure the following fields:

• Input Type: Choose the input type (’Text’).
• Input: The input content to summarize.
• Expected Summary Length: Select the expected summary length (’Short’, ‘Medium’, ‘Long’).
• Output Parameter: Summary: The Process parameter name where the summary should be stored for use in later steps.

Example use case:

1. Summarize a customer complaint and link it within a newly created Service Ticket.

Translate (AI)

The Translate step in the AI > Analyze category allows you to use our AI to translate a given input into a provided target language. To use this step, you must configure the following fields:

• Input Type: Choose the input type (’Text’).
• Input: The input content to translate.
• Target Language: Choose the language you want to translate the Input to.
• Output Parameter: Translated Text: The Process parameter name where the translated text should be stored for use in later steps.

Example use case:

1. Translate customer requests from foreign markets into English and store the output into the descriptions of Service Tickets.

Get Fields (AI)

The Get Fields step in the AI > Analyze category allows you to use our AI to get fields from a given input. To use this step, you must configure the following fields:

• Input Type: Choose the input type (’Text’).
• Input: The input content to obtain fields from.
• Output Parameter: Fields: The Process parameter names where the specified fields should be stored for use in later steps.

Example use case:

1. Extract specific customer information from service inquiries to populate support tickets accurately.

File

Extract Text (File AI)

The Extract Text (File AI) step leverages AI technology to extract textual content from a designated file. This step enables you to specify a page range, control the extraction process, and choose whether to receive the output as plain text or store it in a file. Before using this step, you must configure the following fields:

• File: Select the target file from which the text will be extracted. You can choose a static file or dynamically specify the file using process parameters.
• Start Page # (Optional): Defines the starting page number in the file from which the text extraction should begin.
• End Page # (Optional): Defines the ending page number to limit the extraction process to a specific section of the file.
• Store extracted text in file: A toggle option that enables you to decide if the extracted text should be saved directly into a file.
• Output Parameter: Specifies where the extracted data will be stored for later use. Depending on whether you choose to store the extracted text in a file or not, one of the following will be populated.
• Extracted Text: Contains the raw extracted text.
• File: Contains the file where the extracted text is stored.

Extract Form (File AI)

The Extract Form (File AI) step leverages AI technology to extract textual content from a designated form. This step enables you to specify a page range, control the extraction process. The input type must be: PNG, JPEG, TIFF, or PDF. Before using this step, you must configure the following fields:

• File: Select the target file from which the text will be extracted. You can choose a static file or dynamically specify the file using process parameters.
• Start Page # (Optional): Defines the starting page number in the file from which the text extraction should begin.
• End Page # (Optional): Defines the ending page number to limit the extraction process to a specific section of the file.
• Output Parameter: Specifies where the extracted data will be stored for later use.
• Extracted Text: Contains extracted text.

Extract Table (File AI)

The Extract Table (File AI) step leverages AI technology to extract textual content from a table. This step enables you to specify a page range, control the extraction process. Before using this step, you must configure the following fields:

• File: Select the target file from which the text will be extracted. You can choose a static file or dynamically specify the file using process parameters.
• Start Page # (Optional): Defines the starting page number in the file from which the text extraction should begin.
• End Page # (Optional): Defines the ending page number to limit the extraction process to a specific section of the file.
• Store Extracted CSV In File: the extracted CSV will be stored in File Manage.
• Output Parameter: Specifies where the extracted data will be stored for later use.
• Extracted Text: Contains extracted text.

Web UI

Web UI steps allow a Process to interact with both desktop and website elements on a given desktop and website. Please see our separate in-depth guide on how to use the Web UI steps.

• Process Editor Library Steps
• Table of Contents
• Logic Steps
• Evaluate Expression
• Set Parameter Value
• Generate Random UUID
• JSON Editor
• Create Custom Log
• Replace Keys in Content
• Try and Catch
• Time
• Get Current Date / Time
• Wait Duration
• Flow
• Conditional Branch
• Trigger Process
• End Process
• Loop
• Loop
• End Loop Early
• External Task
• Generate External Task
• Await External Task Completion
• Validation
• Validate Map Entries
• Validate List Values
• Integration Steps
• REST API
• Invoke REST API (General)
• Invoke REST API (Get File)
• SOAP API
• Invoke SOAP API
• SFTP
• Move File Between Locations (SFTP)
• SSH
• Execute SSH Command
• Database
• Execute SQL Command
• Communication
• Send Email
• Send SMS
• Service Ticket
• Create Service Ticket
• Create Service Ticket Task
• Fallout Ticket
• Create Fallout Ticket
• File
• Excel
• Extract Data (Excel)
• Create Spreadsheet (Excel)
• Validate Values Match Across Files (Excel)
• Return Formula Result (Excel)
• Look Up Values (Excel)
• Validate Values (Excel)
• Update Data (Excel)
• AI
• Prompt AI
• Analyze
• Identify Sentiment (AI)
• Identify Intent (AI)
• Summarize (AI)
• Translate (AI)
• Get Fields (AI)
• File
• Extract Text (File AI)
• Extract Form (File AI)
• Extract Table (File AI)
• Web UI