Flow Nodes API Guide

Turbo Apps Suite is a Forms and Flow builder that makes it easy for Business Analysts with little or no programming experience and Developers to design forms and automate backend processes by adding and connecting visual components together. Turbo Flows helps modernize your forms processing with Turbo Flows Builder.

Turbo Flow Builder is a no-code (for certain use cases you can also use low-code) flow builder to process submitted data in all supported backend systems. Flows are powerful, shareable and human readable and can automate any process in a flexible fashion. You can use readymade flows or build your own.

Process Driven

Turbo Flows takes a process-based approach to automation, allowing you to define how your automation works and empowering you to also address dynamic cases such as fetching data from systems like SharePoint, Salesforce, SAP or SQL compliant databases and deciding on next steps based on the dynamic state of the data! You have complete control in designing the flow with our graphical, drag and drop builder and customizing it to your specific needs.

Ready-made Automation

Although designing your own Flow is easy using the Flow Builder, there is also a growing repository of ready-made content that integrates with most enterprise systems and communication channels. Use our readymade flows to send PDF versions of forms to DocuSign for Digital Signatures, Notify users on Teams, Slack etc, send Alerts and Emails at will and much more. These flows can be embedded in other flows to automate complex processes.

Drag and Drop Builder

The Turbo Apps Suite has a drag and drop Flow Builder. You get a limitless canvas to add as many automation steps as you require and connect them up to fulfil every conceivable flow. Starting from simple use cases like updating SQL compliant database, creating Service Orders in Salesforce, sending documents for eSignature via DocuSign or creating Notifications on SAP, setting up Approvals of forms lke Leave Requests, Purchase Orders etc can all be automated in a simple, lucid fashion.

Flow designers do not need any specific coding skills but only need knowledge of the JSON data format and interpreting result sets from systems. To work with databases you have the choice of using SQL queries or no-code, model drive table updates. REST API integration requires understanding of the end points you are posting to and nothing more. OData services can be consumed in a model driven, guided approach. JSON data transformation can be transformed with a graphical editor without writing a single line of code!

Glossary

Sl.	Term	Definition
1.	Flow	The series of steps to execute
2.	Flow steps	The individual steps / parts of the flow, It consists of the operation, the data definition for the step and the system configuration
3.	Operations	The predefined operations that can be used to define the flow steps. Operations are the technical building blocks to access databases, REST or OData services etc
4.	Systems	Systems are the backend systems that you need to connect to fulfil your processes. For e.g. to create an opportunity in Salesforce you will need to configure the Salesforce systems as part of the flow step
5.	Forms	Each flow has to be associated with a form. A form can have any number of flows associated with it but each flow is associated to one form. The flow has access to the user submitted data of the associated form
6.	Task ID	Every form that has to be filled is treated as a task for a user and identified with a unique TaskID
7.	Submission ID	Every form that is filled and submitted is identified with a unique SubmissionID. Every form filling task has at least one submission id. If a task is for a form set, each form of the form set that is completed will also have a submission id
8.	Run on Save	Flow to run when a form is saved. Note that a form can be saved any number of times until it is completed
9.	Run on Complete	Flow to run when a form is completed. This flow is run only once (unless there is an error) and data is finalized
10.	Run on Create	Flow to run when a form is created or instantiated. The flow can be used to prefill the data of the form
11.	Run for Masterdata	Flow to run when master data is required to be updated in the system or sent directly to the Turbo Forms App for form filling
12.	Run via Smart Data Component (SDC)	The flow is run as part of a Smart Data Component to fetch data from external systems based on user input and update form with results
13.	Test Data	Test data for a form that you can save for testing flows before deploying them
14.	Run	Run a flow in the builder to test it. View detailed results and copy intermediate results
15.	Save	Saving a flow also runs a syntax check and returns a list of errors to fix. The flow step with the error is also highlighted
16.	Deploy	Deploy a flow so that it can be run with the associated action (Save, Complete, Create, SDC, Masterdata)

The Flow Builder

The flow builder canvas allows you to drag and drop any number of operations and create the different steps of the flow. Chain steps by connecting them so that dependent steps can be created. Add decision steps to decide on how the process has to proceed. Success of the current step will result in the next step chained to the “Success” connector being executed. Signal an error and terminate the flow at will.

How is a flow created?

In the Flows list, click + Add and fill in the details. The most important step is to select the type of flow to create.

Manual Flow

Create a Manual Flow if you are building a flow to learn, or try something out or if the requirement is to run the flow adhoc. These flows can only be triggered manually using the Run button in the Turbo Apps Builder.

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow

Webhook Flow

Create a Webhook flow if you need to run a flow due to some activity in an external system or similar. The URL provided can be used to post optional data and run the flow for e.g. when a Ticket is created in Salesforce you may want to run a flow and check if there are contractors available to attend to it in your HRM system.

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow
• URL: The created webhook is displayed here and you can copy the URL and configure it in the external system. When a POST happens to teh webhook all parameters and the post body is passed to the flow and can be used for further processing. There is no pre-requisite on parameter names etc.
• Expiry: Date until when he webhook to be valid. A webhook can be revoked and/or extended as the need may be.

Scheduled Flow

Scheduled flows are triggered as per a configured schedule. Use this to run flows at pre-configured intervals for e.g to create an Inspection form every month on the first day etc. You can also use it to refresh Master Data on a schedule.

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow
• Schedule: Minute/Hour/Day/Week/Month/Year based schedules

Form Action Flow

These flows are triggered on certain form actions as below: - Create: Triggered when a form is created per a schedule. Use this to prefill data in the form on creation - Save: Triggered when the form is (partially) saved by the user. Use this to process the submitted data and take decisions, enable other sections of form once some sections are filled in etc. - Complete: Triggered when the form is completed. Use this to submit the form data to SAP, a database, post a notification to Teams to let others know, archive a PDF version of the submitted data in Sharepoint etc. - Approval: Triggered when a user approves a form as part of the configured approval flow.

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow
• Action: Choose from Create, Save, Submit and Approval

Sub Flow

These are flows that can be included as a step in other flows. Common and repetitive actions like posting a Teams notification can be created as Sub Flows. These can then be called as a step in any other flow thus enabling reuse. Further sub flow execution can be controlled when defining the step in the parent flow:

1. Run as a part of the parent flow, synchronous execution and the result is available for further processing
2. Run as a separate parallel flow but in sequence, useful when running sub activities but need to maintain order execution
3. Run as a separate parallel flow, useful when running sub activities and order execution is not important

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow

Smart Data Flow

These flows are triggered by Smart Data Components in forms and can be executed on button click, barcode scanning etc. For e.g. when a work permit is to be assigned to a contractor or technician, check their credentials to make sure they are holding current certifications to attend to the job.

• Title: Enter a title to identify the flow
• Description: Enter a detailed description regarding the purpose of the flow

Pro Tip

When a flow is designed and results from a step are needed for transformation in the next step, run the flow without the transformation step. Copy the JSON results of the previous step and then add the data mapper for transformation. The copied data can now be pasted in the editor to see real time results of the extraction / transformation. Use the intermediate results to copy data from any of the steps.

Expression Builder

Expression builder is used to specify the input to the flow operations (steps). Expressions can be made up of:

• Form Fields
• Flow Input
• Previous flow step results
• Calculated values (using different functions)
• Data mapper (JSON extraction)
• Defined Environment variables
• Pre-defined macros

For any input to operations, choose the :material-wrench: icon to access the Expression Builder. The expression Builder has multiple panes to organize the data.

• Left Pane: Select form fields, select functions to operate on strings and numbers in calculate nodes
• Right Pane: Select from previous node results. If the current node is a Calcualte node, then the variables/expressions already calculate are also available. Any environment variables that are defined for the form can also be used. And a few predefined macros such as the form submitter’s First Name, Last Name etc can also be used.
• Bottom Pane: The expression

Pro Tip

Any input from above that is added to the expression is depicted as ${xxxxx}. The actual variable is enclosed as a Turbo Apps Macro idenfitied by ${ prefix and } as suffic. If the value is a result of a previous step, the result is prefixed with the step name. Do not modify the values as entered by the builder. When the flow is exeuted, the macros identified by ${macro} are all replaced with actual values

JSONata Expression Builder

Turbo Apps supports JSONata expressions to extract and convert JSON formats. JSONata allows to manipulate JSON data without the need to write any code.

The JSONata expression builder has three panes:

• Left Pane : The sample data to operate on
• Right Top Pane : The JSONata expression. Refer JSONata Docs
• Right Bottom Pane : The result of applying the expression on the data. This is a live preview and results are calculaed and displayed as the expression is built

Pro Tip

For JSONata expression builder, sample data is very important so you can check that the expression provides the desired results. To ease this process, in the Run flow screen, all results from each flow step are displayed. For e.g. if the data that is obtained by calling a REST API needs to be converted, Run the flow and choose that node in the results. Copy the displayed JSON to the example data field.

Database Expression Builder

The Database expression builder allows to list tables, select key columns and also the list of columns to be queried.

OData Expression Builder

Turbo Apps supports loading metadata from OData services. Once the endpoint is configured, the builder automatically loads all the OData services.

The OData Expression Builder allows to:

• Select the Entity
• Select the Entity to Expand
• Select all the required fields from the selected entities

Other fields can then be manually configured

SAP Expression Builder

Turbo Apps supports loading metadata from SAP RFC and BAPI. Once the endpoint is configured, you can search for RFC and BAPI functions from the SAP system.

The SAP Expression Builder allows to:

• Search and select the custom RFC or BAPI
• Select all the required fields for Input to the function and map form fields and other calculated values to the input
• Select all the fields that need to be returned from the Output of the function

---

Systems

All the Integration Services in the flow such as REST, OData, Database etc operate on systems. Systems can be configured in the individual operations.

Systems typically define:

• URL / Server Address
• Port / Protocol
• Authentication Mechanism such as OAuth, Basic etc
• Optional User ID / Password
• And other optional parameters

Systems are defined for each operation type and can be used across flows. For e.g. a flow upload document to SharePoint can define the SharePoint system and in another flow the same system can be used with a differente REST API

Authentication

System authentication can be configured at a system level (Common user id / password, API token etc) or at an individual level based on UserID/Password or OAuth. The entire authentication process is seamlessly managed by Turbo Apps and flow designers only need to choose the authentication model.

---

Flow Operations

Various operations are supported by Turbo App. They are grouped as below

• Services : Operations for Integration
  • REST : REST web services
  • OData : OData web services
  • SAP : Connect to SAP custom RFC functions and BAPI
  • Query : SQL queries on databases
  • Stored Procedure : Execute database stored procedures
  • Active Directory : Lookup on MS Active Directory
  • FTP : Query, Upload and Download files from an FTP server
• Forms : Operations on forms and form data
  • Create : Create and assign a new form
  • Update : Update the existing form data
  • Assign : Assign (add) the form to a new user
  • Read : Read a form’s data
  • Search : Search for forms
  • Share : Share the form with external users
  • Archive : Archive the form and create an archive URL to view archived data
  • Create PDF : Create a PDF of the form
  • Alert : Send an alert
  • Contact : Add / Update external contacts
• Master Data : Operations on Master Data
  • Update a row of data
  • Replace all data
  • Query data
• Code : Executors to customize the flow
  • Execute Java: Execute a Java function as part of the flow
  • Execute JavaScript : Execute JavaScript function as part of the flow
  • Execute Python Script : Execute Python Script (2.7) function as part of the flow
• Others : Miscellaneous operations
  • JSON Parser : Extract and transform JSON data without writing code
  • CSV Parser : Extract and transform CSV data without writing code
  • Condition : Add conditions to determine next steps
  • Calculate : Add expressions to calculate values
  • For Loop : Loop over and process array data
  • Email : Send an email as part of the flow
  • Response : Customize the response from the flow
  • File Store : Upload or Download a file from the file store (cache)
  • Sub Flow : Execute another sub flow (child) as a step of the main (parent) flow
  • Approval Workflow - Execute an approval (decision) workflow

Common Properties

Every flow step (comprising of an operation)) has a set of common properties

• Name : Technical flow step name. Needs to be all lowercase and used when accessing the results of this step
• Description : Detailed notes about the flow step and its purpose
• System : System to use for the flow step (if required)

---

Integration Services

REST

🔧 rest

Execute any REST request on a remote server. The authentication for the endpoint is provided via the SystemProperty file

1. Add or choose an existing system providing the REST end point
2. Choose the contenttype and accepttype
3. Choose the HTTP Verb that is to be executed (default GET)
4. Add other optional parameters that are necessary
5. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
6. Save

Parameters

Param	Type	Required	Default	Description
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
system	String	True		The REST system endpoint configuration
contenttype	String	True	application/json	The content type
accept	String	True	application/json	The accept type
httpverb	String	True	get	The HTTP verb (action) to call
postquerystring	Boolean	False	False	Indicates if the post parameters also have to be sent as a query string (True or False)
instanceurl	String	False		With some services like Salesforce, ServiceNow etc, the URL is dynamic and may need to be changed from what is configured in the system properties. This is usually referred to as the instanceUrl and can be set to override the system properties
urlpath	String	False		The (url) path for the call
attachments	String	False		Comma separated list of Attachment IDs of the files to be posted to the end point. The attachment IDs are obtained by uploading the files to the Unvired Platform using the attachmentrequest flow
headerparameters	Key-Value	False		JSON array of header parameters to pass to this call
postparameters	Key-Value	False		JSON array of post parameters to pass to this call
body	String	False		Data to be posted as raw body to the endpoint
failonerror	Boolean	False	False	If this is a non-critical step in the flow, failonerror can be set to false so that the flow will continue

Output

Output	Type	Value
result	String	The result of the REST execution
error	String	The error from the REST execution if any

Navigation

Navigation	Comment
SUCCESS	If the REST call executed successfully
FAILURE	If there was an error while executing the REST call

---

SAP

sap

Execute any SAP RFC or BAPI function on an SAP server. The authentication for the endpoint is provided via the SystemProperty file

1. Add or choose an existing system providing the SAP server details
2. Choose the function
3. Select the Input and Output structures and the mapping for input
4. Add other optional parameters that are necessary
5. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
6. Save

Parameters

Param	Type	Required	Default	Description
system	String	True		The REST system endpoint configuration
operation	String	True	Execute	The SAP operation
accept	String	True	application/json	The accept type
function	String	True		The BAPI or RFC to execute
data	JSON	True		The data for the function call
transaction	Boolean	False	False	If an SAP transaction is required or not

Output

Output	Type	Value
result	String	The result of the REST execution
error	String	The error from the REST execution if any

Navigation

Navigation	Comment
SUCCESS	If the REST call executed successfully
FAILURE	If there was an error while executing the REST call

---

SQL Query

query

Run a SQL query on a database or insert/update/delete data directly using JSON input

1. Add or choose an existing database system
2. Add other optional parameters that are necessary
3. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
system	String	True		The Database system configuration
query	String	False	False	The query to execute on the database.
operation	String	False		The database operation: insert, update or delete
keys	String	False		The keys of the table(s) for the specified operation
data	JSON	False		The data to be persisted in the database as JSON for the specified operation
flattenoutput	Boolean	False	False	Flatten output if single row of data
errormessageonnodata	String	False		If no data found has to be treated as an error, set this error message

Pro Tip

Either query or operation/keys/data has to be specified

Output

Output	Type	Value
result	String	The result of the DB execution
error	String	The error from the DB execution if any

Navigation

Navigation	Comment
SUCCESS	If the DB call executed successfully
FAILURE	If there was an error while executing the DB call or if errormessageonnodata is set and no data found

---

Stored Procedure

storedproc

Run a Stored Procedure on a database

1. Add or choose an existing database system
2. Set the stored procedure name to execute
3. Add other optional parameters that are necessary
4. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
5. Save

Parameters

Param	Type	Required	Default	Description
system	String	True		The Database system configuration
spname	String	True		The stored procedure name
spinput	JSON	True		The input for the stored procedure (SP) specified above. A valid input provides the input and output parameters as JSON
errormessageonnodata	String	False		If no data found has to be treated as an error, set this error message

Pro Tip

spinput is of the form:

{"whereclause":{"type":"in","value":"'colname'=2"}, "countrows":{"type":"OUT"}}

Here the parameter whereclause is an input parameter and has the value ‘colname=2’ and countrows is an output parameter

Output

Output	Type	Value
result	String	The result of the stored procedure execution
error	String	The error from the stored procedure execution if any

Navigation

Navigation	Comment
SUCCESS	If the stored procedure executed successfully
FAILURE	If there was an error while executing the stored procedure or if errormessageonnodata is set and no data found

---

Active Directory

ads

Query a Microsoft Active Directory Service for user and other information

1. Add or choose an existing MS Active Directory system
2. Choose the desired action a. Authenticate: Authenticate the give domain, user and password on the ADS server
   b. GetAttributes: Retrieves the given User’s attributes from the ADS
   c. SetAttribute: Sets the provided attrubute for the user. Attributes may be added (Add), changed (Replace) or deleted (Delete) as specified in the input
   d. ListObjects: Retrieves a list of users matching the listing (input) criteria
   e. SearchObjects: Searches for a list of users matching the searc (input) criteria
3. Add other optional parameters that are necessary. Depending on the Action, additional parameters need to be provided
4. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
5. Save

Parameters

Param	Type	Required	Default	Description
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
system	String	True		The Active Directory system configuration
action	String	True		The action to perform on the Active Directory server (Authenticate, GetAttributes, SetAttribute, ListObjects, SearchObjects)
operation	String	False		The operation to perform, required if action is SetAttributes (Add/Replace/Delete)
searchcontrols	String	False		The scope of the search to be performed, required if action is SearchObjects (Object, OneLevel, SubTree)
field	String	False		The attibute to modify or the field to search for (e.g. sAMAccountName)
value	String	False		The value to set for the attibute or the field value to search for
basedn	String	False		base DN or point from where to search for users, specified here or in system configuration
domain	String	False		ADS domain of the authenticating user, specified here or in system configuration
user	String	False		ADS user id of the authenticating user, for other operations can be specified here or in system configuration
password	Sensitive	False		ADS password of the authenticating user, for other operations can be specified here or in system configuration

Output

Output	Type	Value
result	String	The result of the ADS operation specified
error	String	The error if any from running the ADS operation

Navigation

Navigation	Comment
SUCCESS	If the operation executed successfully
FAILURE	If there was an error while executing the operation

---

OData

odata

Execute any OData request on a remote server. The authentication for the endpoint is provided via the SystemProperty file

1. Add or choose an existing database system
2. Set the metadata to the OData definition from the service metadata. Use the Odata Expression Builder as required
3. Choose the operation
   a. Create: Create an entity b. Update: Update an entity c. Merge: Merge an entity d. Delete: Delete an entity e. Select: Search for entities based on filter f. Read: Read/Get an entity
4. Set the desired entity name
5. Add other optional parameters that are necessary
6. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
7. Save

Parameters

Param	Type	Required	Default	Description
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
system	String	True		The OData system configuration
metadata	JSON	True		Metadata of Entities and fields to retrieve/save as part of this operation
operation	String	True		The operation to perfor (Create, Update, Merge, Delete, Select, Read)
entity	String	True		Name of the entity to operate on
entitydata	JSON	False		The entity to process
filter	String	False		Refer OData documentation to provide the filter https://www.odata.org/getting-started/basic-tutorial/#filter
parameters	String	False		Refer OData documentation to provide the filter https://www.odata.org/getting-started/basic-tutorial/#count
expand	String	False		Refer OData documentation to provide the filter https://www.odata.org/getting-started/basic-tutorial/#expand
errormessageonnodata	String	False		If no data found has to be treated as an error, set this error message

Example

Metadata:

[{"entitySet":"Customers","entityType":"customer","keys":["CustomerID"],"fields":[{"name":"CustomerID","type":"String","nullable":false},{"name":"CompanyName","type":"String","nullable":false}],"navigation":["Orders","CustomerDemographics"]}]

Output

Output	Type	Value
result	String	The result of the OData execution
error	String	The error if any from running the OData service

Navigation

Navigation	Comment
SUCCESS	If the operation executed successfully
FAILURE	If there was an error while executing the operation or if errormessageonnodata is set and no data found

---

FTP

ftp

Upload and Download files from an FTP server

1. Add or choose an existing FTP system
2. Set the FTP action (Get, Put, Delete, Create Directory, List, Rename)
3. Choose Transfer Mode (Ascii/Binary) and Connection Mode (Active/Passive)
4. Set the remote directory
5. Add other optional parameters that are necessary
6. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
7. Save

Parameters

Param	Type	Required	Default	Description
system	String	True		The FTP system configuration
operation	String	True		Choose the operation from Get, Put, Delete, CreateDir, List, Rename
mode	String	True		Choose the mode from ASCII, Binary
connectionmode	String	True		Choose the connection mode from Active and Passive
currentdirectory	String	True		The remote directory to operate in
filename	String	False		The file to upload or download. For listing a regex to filter can be passed. For rename operation, the remote source file name with full path. Required for operation Get, Put, Delete and Rename (Optional for List)
attachmentid	String	False		The attachment ID of the file to upload to FTP server from cache. Required for operation Put
newdirectory	String	False		The directory to create within the working directory. Required for operation CreateDir
newfilename	String	False		For rename operation the remote destination file name with full path
mimetype	String	False		The mime type of the file to upload

Output

Output	Type	Value
result	String	The result of the FTP command execution
error	String	The error from the FTP command execution if any

Navigation

Navigation	Comment
SUCCESS	If the FTP command executed successfully
FAILURE	If there was an error while executing the FTP command

---

Code Executors

Execute Java Code

execjava

Execute any Java function (Process Agent) that is designed and developed using the Unvired Modeller

1. Choose the library that has the function that needs to be executed
2. Choose the function that needs to be executed (based on the Library selected above)
3. Add as many inputs as may be required for the function. You will need to use any documentation provided for the function or check with the developer. Every input is added as a key-value pair and will be posted to the function in the right format
4. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
5. Save

Parameters

Param	Type	Required	Default	Description
function	String	True		Function that needs to be executed
input	Key-Value	False		Choose as many key value pairs providing the parameter name and the value that forms to input to the function

Output

Output	Type	Value
result	String	The result of the function execution
error	String	The error if any from running the function

Navigation

Navigation	Comment
SUCCESS	If the function executed successfully
FAILURE	If there was an error while executing the function

---

Execute Python Script

execpython

Execute a Python script snippet as part of the flow

1. Choose all the input parameters that are required for the Python script using the Expression Builder
2. Click Generate to generate the function stub. Add your code to the execute() method only
3. Any additional local functions you require can be added after this method and before the main reference section
4. Follow the inline comments and edit the Python code as required
5. Outputs that need to be returned from the function and available for subsequent flow steps are returned as part of a result[] JSON dictionary.
6. Save

Need other inputs?

If you need additional inputs after the stub is generated, add the required input parameters and hit the Generate button. Don’t worry, all changes made by you after the indicated comment will be retained

Need to return more outputs?

If you need to return additional outputs after the stub is generated, add the required output parameters to the result[] dictionary and Save. The outputs will be extracted automatically.

Parameters

Param	Type	Required	Default	Description
input	String	True		Comma separated list of input parameters that are required as input for the Python script
function	String	True		Choose the function that needs to be executed
Script	Python	True		The skeleton of the script is generated for you. Subsequently when changes are made to the input parameters, the input propagation will be automatically regenerated. Outputs that need to be returned from the function and available for subsequent flow steps are returned as part of a result[] JSON dictionary. Follow the inline comments to ensure proper syntax and structure

Output

Output	Type	Value
result	String	All the variables that are assigned to the result[] JSON dictionary
error	String	The error if any from running the function present in the result[] dictionary

Navigation

Navigation	Comment
SUCCESS	If the function executed successfully
FAILURE	If there was an error while executing the function

Python Version

Turbo Apps uses Jython to execute these scripts and hence only Python version 2.7 is supported. All Jython supported packages are installed and available. We may at a later date support Python versions > 3 later.

---

Execute JavaScript

execjavascript

Execute a JavaScript snippet as part of the flow

1. Choose all the input parameters that are required for the JavaScript using the Expression Builder
2. Click Generate to generate the function stub. Type in your code in the execute() method only
3. Any additional local functions you require can be added after this method
4. Follow the inline comments and edit the JavaScript code as required
5. Outputs that need to be returned from the function and available for subsequent flow steps are returned as part of a result[] JSON dictionary.
6. Save

Need other inputs?

If you need additional inputs after the stub is generated, add the required input parameters and hit the Generate button. Don’t worry, all changes made by you after the indicated comment will be retained

Need to return more outputs?

If you need to return additional outputs after the stub is generated, add the required output parameters to the result[] dictionary and Save. The outputs will be extracted automatically.

Parameters

Param	Type	Required	Default	Description
input	String	True		Choose all the input parameters that you require for the Pytho script to operate on
function	String	True		Choose the function that needs to be executed
Script	JavaScript	True		The skeleton of the script is generated for you. Subsequently when changes are made to the input parameters, the input propagation will be automatically regenerated. Outputs that need to be returned from the function and available for subsequent flow steps are returned as part of a result[] JSON dictionary. Follow the inline comments to ensure proper syntax and structure

Output

Output	Type	Value
result	String	All the variables that are assigned to the result[] JSON dictionary
error	String	The error if any from running the function present in the result[] dictionary

Navigation

Navigation	Comment
SUCCESS	If the function executed successfully
FAILURE	If there was an error while executing the function

JavaScript NPM Modules

Turbo Apps uses the GraalVM to run JavaScript snippets. Given the need to keep the environment secure, no additional packages are made available. You can inline add additional functions to complete the required functionality. If any standard npm module is required please contact Unvired Support and the DevOps team will provide access or alternatives after security evaluation.

---

Form Operations

Create Form

formcreate

Creates a new form / formset (and the corresponding task) and assigns it to a team or user

1. Choose the Form from the dropdown. If the technical name of the form has to be picked up from a different form field (for e.g. based on a user’s choice a particular form has to be created), choose form field and select the form field
2. Enter the comment to inform the user of the need of this form assignment to them
3. Add any of the optional parameters to provide more input to the creation
4. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
5. Save

Parameters

Param	Type	Required	Default	Description
formname	String	True		The (technical) formname to create a submission
user	String	False		User (named user who is part of the company/domain) to whom the form needs to be assigned to.
team	String	False		Team to whom the form needs to be assigned to. Note that either user or team needs to be provided
comment	String	True		Helpful notes to fill the form
formdata	JSON	False		Data to prefill the form if required
relatedtask	String	False		Provide the related task id if this form is a consequence of the other form. It could be for e.g. the form that is currently creating this new form
tasktype	String	False	fill	Choose from fill or review
priority	String	False	low	Choose the priority for filling this form. Acceptable values are low, medium and high
duedate	Date	False		Provide an optional due-date by when the form has to be completed. MM/DD/YYYY format.
extreference	String	False		External reference for the task. For e.g if this form is being created due to a Service Order in Salesforce, the extreference can be set to the Service Order ID of Salesforce for later association

Output

Output	Type	Value
result	String	The task ID of the form / formset created
error	String	The error from the creation if any

Navigation

Navigation	Comment
SUCCESS	If the form / formset was created successfully
FAILURE	If there was an error while creating the form / formset

---

Update Form

formupdate

Updates the (current) form and saves it. Use this operation if you want to update the data that has been submitted and make changes to it and save. For e.g. the external system might compute certain values that need to be also saved in the form.

1. Set the updated form data
2. Add any of the optional parameters to provide more input to the creation
3. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
updateddata	JSON	True		Form data to update and save
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
extreference	String	False		External reference for the task. For e.g if this form is being created due to a Service Order in Salesforce, the extreference can be set to the Service Order ID of Salesforce for later association

Output

Output	Type	Value
result	String	The data of the updated form
error	String	The error from the update if any

Navigation

Navigation	Comment
SUCCESS	If the form data was updated successfully
FAILURE	If there was an error while updating the formdata

---

Assign Form

formassign

Assigns the (current) form to another user. You can also unassign (delete) a user from a form if they are not required any longer.

1. Enter a comment for the change
2. Choose the user to assign/unassign
3. Alternatively you can choose a team to assign/unassign
4. Set the parameter remove to true to unassign
5. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
6. Save

Parameters

Param	Type	Required	Default	Description
comment	String	True		Helpful notes for the user/team
user	String	False		User (named user who is part of the company/domain) to whom the form needs to be assigned to.
team	String	False		Team to whom the form needs to be assigned to. Either one of user or team needs to be provided
remove	Boolean	False	False	Set to true to unassign the form

Output

Output	Type	Value
result	String	If the form is assigned or unassigned
error	String	The error from the assignment or unassignment if any

Navigation

Navigation	Comment
SUCCESS	If the form data was assigned successfully
FAILURE	If there was an error while assigning the form

---

Read Form

formread

Reads the form identified by the task id (and submission id if form set) and returns the data. Useful if data from an already filled in form is needed for any other operation later.

1. Enter the task Id that identifies the submission uniquely.
2. Enter the submission Id also if it task refers to a form set.
3. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
taskid	String	True		Unique ID identifying the task to fill the form
submissionId	String	False		Unique ID identifying the form submission (required if the task is for a formset)
team	String	False		Team to whom the form needs to be assigned to. Either one of user or team needs to be provided
remove	Boolean	False	False	Set to true to unassign the form

Output

Output	Type	Value
result	String	If the form is assigned or unassigned
error	String	The error from the assignment or unassignment if any

Navigation

Navigation	Comment
SUCCESS	If the form data was assigned successfully
FAILURE	If there was an error while assigning the form

---

Search Forms

formsearch

Search submissions matching the criteria provided. At least one of the search criteria (users, teams, fornname, status or date) is required

1. Enter any one of the search criteria for searching for submissions
2. Enter the submission Id also if it task refers to a form set.
3. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
formname	String	False		The technical form name to search for submissions
returnfields	String	False		List of comma separated field names to return as part of search fields in addition to the standard search fields
completedbyusers	String	False		User(s) who have completed the forms
completedbyteams	String	False		Team(s) who have completed the forms
submitstartdate	Date	False		Submissions that were submitted after this date (format based on user’s locale)
submitenddate	Date	False		Submissions that were submitted before this date (format based on user’s locale)
status	String	False	Status of the forms to search for (open, inprogress, completed, archived, failed)
formdata	JSON	False	Search based on form data. The input is a JSON object of fieldname:value. Multiple fields can be included.
extreference	String	False		External reference to find submissions

Output

Output	Type	Value
result	JSON	JSON array of submissions matching the criteria
error	String	The error from the search if any

Navigation

Navigation	Comment
SUCCESS	If the search was successful
FAILURE	If there was an error during the search

---

Share Form

formshare

Create a link to share with external users who do not have a login to the forms system

1. Enter task ID to share, for current you can set it to ${taskid}
2. Choose the share type. Public will allow anyone with the common URL to submit data and private can be accessed only by the user with the URL (each private share generates a unique share URL)
3. Enter the days for the share to be valid
4. Enter the email ids to share with (These users should already be present as external users in the system)
5. Choose if (in private share only) users can save and return to the form later or they need to complete it in one session
6. Optionally disable email invite (if the URL is going to be shared otherwise for e.g. maybe via text)
7. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
8. Save

Parameters

Param	Type	Required	Default	Description
taskId	String	True		Task ID identifying the form to be shared
sharetype	String	True		The type of shared link to create. Public share can be accessed by anyone with the link, private share links are for sharing with the specified users email
expirydays	Number	True		The number of days until when the shared link is valid
shareto	String	False		Comma separated list of email ids for sharing, required only if share type is private
draftsave	Boolean	False	False	Allow users to save the form with partly filled data and fill later, required only if share type is private
sendshareemail	Boolean	False	True	Should an email with a link be sent?

Output

Output	Type	Value
result	String	Share link on success
error	String	The error from the share if any

Navigation

Navigation	Comment
SUCCESS	If the share was successful
FAILURE	If there was an error during the share

---

Archive Form

formarchive

Archive the form and create a link to the archived data to view it. Archived data cannot be modified any longer.

1. Enter task ID to archive, for current you can set it to ${taskid}
2. Enter the submission Id also if it task refers to a form set.
3. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
taskId	String	True		Task ID identifying the form to be shared
submissionId	String	False		Unique ID identifying the form submission (required if the task is for a formset)

Output

Output	Type	Value
result	String	Archive link on success
error	String	The error from the archive operation if any

Navigation

Navigation	Comment
SUCCESS	If the archive was successful
FAILURE	If there was an error during the archive operation

---

Create PDF of form submittions

formpdf

Export the form to PDF

1. Enter task ID to export to PDF, for current you can set it to ${taskid}
2. Enter the submission Id also if it task refers to a form set.
3. Choose the orientation desired (portrait or landscape)
4. Enter the Header and Footer text if you want to override defaults from settings
5. Optionally choose if the flow has to stop / fail if the PDF creation failed for some reason
6. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
7. Save

Parameters

Param	Type	Required	Default	Description
taskId	String	True		Task ID identifying the form to be shared
submissionId	String	False		Unique ID identifying the form submission (required if the task is for a formset)
orientation	String	False		The orientation for generating the PDF (portrait or landscape)
header	HTML	False		The PDF header HTML
footer	HTML	False		The PDF footer HTML
failonerror	Boolean	False	False	If this is a non-critical step in the flow, failonerror can be set to false so that the flow will continue

Output

Output	Type	Value
result	String	Attachment ID of the cached PDF file if successful
error	String	The error from the PDF export if any

Navigation

Navigation	Comment
SUCCESS	If the PDF was successfully exported
FAILURE	If there was an error during the PDF export

---

Send an Alert for a form

formalert

Send an alert to a user or team regarding a form they are working on

1. Enter task ID to attache the alert to, for current you can set it to ${taskid}
2. Choose the orientation desired (portrait or landscape)
3. Enter the Header and Footer text if you want to override defaults from settings
4. Optionally choose if the flow has to stop / fail if the PDF creation failed for some reason
5. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
6. Save

Parameters

Param	Type	Required	Default	Description
taskId	String	True		Task ID identifying the form to be shared
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
users	String	False		User (named user who is part of the company/domain) to whom the alert needs to be sent to.
teams	String	False		Teams to whom the alert needs to be sent to. Either users or teams needs to be specified
comment	String	True		The alert message / comment
severity	String	False	Info	The alert severity. Choose from Error, Warning, Info, Mention
failonerror	Boolean	False	False	If this is a non-critical step in the flow, failonerror can be set to false so that the flow will continue

Output

Output	Type	Value
result	String	Alert text on success
error	String	The error from the alert creation if any

Navigation

Navigation	Comment
SUCCESS	The alert was sent successfully
FAILURE	If there was an error during the alert creation

Alert Icon

Based on the severity an Alert icon is also displayed in the App. Use Error to show an error message to the user. Similarly use Warning for non fatal issues and Info for information alerts. If the comment is @mentioning someone, then you can set the severity to Mention

---

Master Data Operations

Master Data Reload

masterdatareload

Manage master data. Use this operation to create flows that download master data from backend systems such as SAP and replace the data in the Turbo Apps database.

1. Compute the data and set it
2. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
3. Save

Parameters

Param	Type	Required	Default	Description
masterdataname	String	True		he Masterdata entity to update
data	JSON	True		JSON object with rows of data for udpating the database

Output

Output	Type	Value
result	String	Message that all master data is updated successfully
error	String	The error while performing the masterdata operations

Navigation

Navigation	Comment
SUCCESS	If the master data creation / modification / deletion was successful
FAILURE	If there was an error while performing the required action on the master data

---

Master Data Update

masterdataupdate

Manage master data. Use this operation to Add, Modify or delete a single Master data record

1. Compute the data and set it
2. Choose the operation mode - Update or Delete. Update will insert if row not existing
3. Delete and Update will be performed based on the key field selected in the master data design
4. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
5. Save

Parameters

Param	Type	Required	Default	Description
masterdataname	String	True		he Masterdata entity to update
operation	String	True	Update	Update or delete data. Update will insert if not existing
data	JSON	True		JSON object with row of data for udpating or deleting from the database

Output

Output	Type	Value
result	String	Message that all master data is updated successfully
error	String	The error while performing the masterdata operations

Navigation

Navigation	Comment
SUCCESS	If the master data creation / modification / deletion was successful
FAILURE	If there was an error while performing the required action on the master data

---

Master Data Read

masterdataread

Read master data. Use this operation to read master data with an optional filter

1. Provide a filter condition to filter the master data
2. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
3. Save

Parameters

Param	Type	Required	Default	Description
masterdataname	String	True		he Masterdata entity to update
filter	String	False		The filter condition to restrict the master data

Output

Output	Type	Value
result	String	Message that all master data is read successfully
error	String	The error while performing the masterdata read

Navigation

Navigation	Comment
SUCCESS	If the master data read was successful
FAILURE	If there was an error while reading the master data

---

Other Operations

JSON Parser

:material-shuffle: jsonparser

Run a JSONata expression on the source data to extract the required data

1. Choose from either Forms Fields or Previous Nodes
2. Click on the expression builder
3. Paste a sample JSON to operate on (It is expected that at run time, the variable you selected at step 1 will have this data).
4. Type in your JSONata expression. Refer the JSONata Docs for more information.
5. Use the JSONata Expression Builder to check the sameple output and make sure that the data is what you need and has no errors.
6. Save

Parameters

Param	Type	Required	Default	Description
sourcedata	JSON	True		The input JSON data to extract from.
mapexpression	String	True		Choose the function that needs to be executed

Output

Output	Type	Value
result	String	The extracted JSON data
error	String	The error from the JSONata extraction

Navigation

Navigation	Comment
SUCCESS	If the extraction executed successfully
FAILURE	If there was an error while running the extraction

---

CSV Parser

csvparser

Parse the CSV file or data and create an array of JSON objects or viceversa for further processing

1. Choose the input data format (CSV or JSON)
2. Choose the file or data to process
3. Use the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
inputformat	String	True	CSV	The input format to convert - CSV or JSON
attachmentid	String	False		The cached file ID to convert
data	String	False		The CSV or JSON data. Either attachmentID or data needs to be provided

Output

Output	Type	Value
result	String	The converted CSV or JSON data
error	String	The error from the CSV conversion

Navigation

Navigation	Comment
SUCCESS	If the conversion executed successfully
FAILURE	If there was an error while converting

---

Condition

condition

Evaluate a condition to decide on what the next step in the flow should be. Conditions are typical If-Then-Else steps. Conditions can be chained in that Then or Else can lead to other condition evaluations.

1. Use the Query Builder UI to add And / Or condition groups.
2. For example if And is chosen, all expressions within that will be combined with an AND operator. Similarly if Or is chosen, all expressions within that will be combined with an OR operator.
3. Add as many condition groups and expressions within to make up the condition.
4. Select from form fields, calculated expressions and previous step results for the condition expressions.
5. Save the condition

Parameters

Param	Type	Required	Default	Description
query	JSON	True		The JSON representation of the designed condition

Output

Output	Type	Value
result	String	The result of the evaluation of condition as a True or False
error	String	The error from the JSONata extraction

Navigation

Navigation	Comment
THEN	Condition evaluated to a True, execute the THEN step
ELSE	Condition evaluated to a False, execute the ELSE step
FAILURE	If there was an error while evaluating the condition

---

Calculate

calculate

Evaluate expressions and store results that can be used in following flow steps. Expressions can be made from form fields, previous results and combined with functions as required. Expressions already defined can be used in further computations.

1. You can add a simple Expression (String/Math) or JSONata expression to operate on JSON data
2. Once added set the variable name.
3. Expression: a. Set the variable type (String, Number, Date) b. Use the Expression Builder to combine fields and functions
4. JSONata expression:
   a. Set the variable type (String, Number, Date) b. Choose the field or other results on which the JSONata expression has to be applied c. Use the JSONata Expression Builder to build and test the expression
5. Add as many variables as required (maximum 50 in each calculat enode)
6. Save the condition

Functions supported as part of Expressions

A number of functions are supported as part of the calculate expression. Complete list below:

Category	Name	Input	Details	Example
Date	adddates	DateFld1, DateFld2	Adds two dates (form fields formats are used)	adddates(${start}, ${end})
	diffdates	DateFld1, DateFld2	Difference of DateFld2 - DateFld1 (form fields formats are used)	diffdates(${end}, ${start})
	advancedate	DateFld, Number, Unit	Advances date in field by number of days,weeks,months or years as specified by unit. If time in field then unit is hours,minutes or seconds	advancedate(${start}, days, 2)
Number	+	NumFld1, NumFld2	Adds two numeric fields	${num1} + ${num2}
	-	NumFld1, NumFld2	Subtracts two numeric fields	${num1} - ${num2}
	*	NumFld1, NumFld2	Multiplies two numeric fields	${num1} * ${num2}
	/	NumFld1, NumFld2	Divides two numeric fields	${num1} / ${num2}
	round	NumFld, Decimals	Rounds numeric field to desired decimals	round(${num1},2)
	truncate	NumFld, Decimals	Truncates numeric field to desired decimals	truncate(${num1},2)
String	assign	StrFld	Assigns string value to variable	assign(“Text to assign”)
	concat	StrFld1 to StrFldN	Concatenates all the string values and/or fields	concat(“This”, “is”, “a”, ${StrFld})
	trim	StrFld	Trims leading and trailing spaces	trim(${StrFld})
	uppercase	StrFld	Uppercase of string field	uppercase(${StrFld})
	lowercase	StrFld	Lowercase of string field	lowercase(${StrFld})
	length	StrFld	Returns length of string (number)	length(${StrFld})
	indexof	StrFld, SearchStr	Returns index of SearchStr in StrFld if found, else -1	indexof(${StrFld},“search”)
	substring	StrFld, Start, End	Substring from Start index to End index (0 based)	substring(${StrFld}, 1, 3)
	search	StrFld, SearchStr	Returns JSON array of all occurences of search string, empty array if not found	search(${StrFld}, “search”)
	searchregex	StrFld, Regex	Returns JSON array of all occurences of regular expression, empty array if not found	search(${StrFld}, “search”)
	replace	StrFld, Search, Replace	Replaces all occurences of search string with replace string	replace(${StrFld}, “search”, “replace”)
	replaceregex	StrFld, Regex, Replace	Replaces all occurences of search string with replace string	replace(${StrFld}, “regex”, “replace”)
	split	StrFld, Pattern	Splits string field into a JSON array based on pattern	split(${StrFld}, ”,“)
	base64encode	StrFld	Encodes string field base64	base64encode(${StrFld})
	base64decode	StrFld	Decodes base64 string	base64decode(${StrFld})
	encrypt	StrFld	Encrypts string field AES256	encrypt(${StrFld})
	decrypt	StrFld	Decrypts string field AES256	decrypt(${StrFld})

Pro Tip

If you need to set a variable to a string literal do not set value directly but use the assign function. For e.g. to set a variable strvar = “some-string” use assign(“some-string”)

Parameters

Param	Type	Required	Default	Description
query	JSON	True		The JSON representation of the designed condition

Output

Output	Type	Value
variable-name(s)	String	Result of the expressio
error	String	The error from the evaluation

Navigation

Navigation	Comment
SUCCESS	If the evaluation executed successfully
FAILURE	If there was an error while evaluating the expression

---

Email

email

Send emails to users as part of the flow. This could be notifications or other messages as required.

1. Set the subject of the email. You can use form fields and other results as part of the subject text
2. Set the message of the email. You can use form fields and other results as part of the message text
3. Add users and/or groups who are part of the Forms application. You can also add external users by typing in their email directly
4. Add any attachments that you may need. These could be PDF versions of the filled form or files that have been attached to the form. If needed use the Data Mapper to extract the Attachment IDs from the forms which can then also be attached to the email.
5. Save

Parameters

Param	Type	Required	Default	Description
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required
system	String	True		The REST system endpoint configuration
users	String	False		List of users to send email to
groups	String	False		List of groups to send email to
emails	String	False		List of external email ids to send email to
subject	String	True		Email subject
message	String	True		Email message
attachment	String	False		Comma separated list of attachments to attach to the email
failonerror	Boolean	False	False	If this is a non-critical step in the flow, failonerror can be set to false so that the flow will continue

Output

Output	Type	Value
result	String	The result of the send email operation
error	String	The error from the email sending

Navigation

Navigation	Comment
SUCCESS	If the send email executed successfully
FAILURE	If there was an error while executing the send email call

---

File Store

filestore

Upload and/or Download a file to/from the File Store (cache) in the BASE64 or text format.

1. Set the attachment ID to download.
2. Save

Parameters

Param	Type	Required	Default	Description
attachentid	String	True		Unique ID identifying the attachment to retrieve. Could be the output of a PDF conversion call or attachments that are uploaded as part of the form etc.
format	String	False	base64	Format to return the data in. Default is base64, else pass text for utf-8 text

Output

Output	Type	Value
result	String	The base64 or utf-8 text version of the file contents
error	String	The error from the file upload or download

Navigation

Navigation	Comment
SUCCESS	If the file was uploaded or downloaded successfully
FAILURE	If there was an error while uploading or downloading the file

---

Response

response

A simple operation that publishes the respponse of the workflow

1. HTTP return code (default 201)
2. Either the result or error for response has to be provided.
3. Optionally HTTP headesrs can also be passed in
4. Save

Parameters

Param	Type	Required	Default	Description
responsetype	String	True	Success	Success or Failure to return
httpcode	Number	True	201	HTTP code to return
body	String	True		Contents to return in HTTP body
headers	Key-Value	False		Choose as many key value pairs providing the parameter name and the value to add to the HTTP response header

Output

Output	Type	Value
result	String	The configured result
error	String	The configured error if any

Navigation

Navigation	Comment
SUCCESS	If responsetype is SUCCESS, the operation results in a success
FAILURE	If responsetype is ERROR, the operation results in an error

---

Sub Flow

subflow

Execute any sub flow from the parent flow

1. Choose the sub flow to execute
2. Choose the mode of execution (As part of parent, Separately in sequence or parallel)
3. Save

Parameters

Param	Type	Required	Default	Description
flowname	String	True		The flow to execute
flowinput	JSON	False		The special input for the sub flow
mode	String	True		As part of parent flow, Asynchronously in sequence, Asynchronusly in parallel

Output

Output	Type	Value
result	String	The subflow result
error	String	The subflow error if any

Navigation

Navigation	Comment
SUCCESS	If subfow is executed successfully
FAILURE	If subfow is executed with an error

---

For Loop

forloop

Execute the subsequent step in a loop with an element of the array data

1. Choose the data to iterate on
2. Choose the format of the aggregated result of the loop (JSON Array or CSV)
3. Save

Parameters

Param	Type	Required	Default	Description
iterabledata	JSON	True		The array to iterate on
aggregateddataformat	String	True		JSON Array or Comma separated values

Output

Output	Type	Value
result	String	The aggreagated result
error	String	The error if any

Navigation

Navigation	Comment
SUCCESS	If all loop executions executed successfully
FAILURE	If any loop execution is executed with an error

---

Workflow Approval

:fontawesome-solid-code-branch: approvalworkflow

Execute the workflow approval steps

1. Choose the approval levels required and the approvers for each level
2. Handle the different decisions
3. Use the Expression Builder to inject fields and other results that will be substituted with actual values at run time
4. Save

Parameters

Param	Type	Required	Default	Description
approvaldata	JSON	True		The approval levels and approvers
approvalform	String	True		The form being approved
formdata	JSON	True		The input form data to calculate from. Will be set by default, override if form data has been updated in flow or as required

Output

Output	Type	Value
result	String	The result of the apprvoal
error	String	The error from the approval

Navigation

Navigation	Comment
APPROVED	If the approval is completely approved
REJECTED	If the approval is rejected
RETURNED	If the approval is returned to requestor
CONTINUE	If the approval cycle has to still continue
FAILURE	If there was an error while approving

---

Contact (External User)

contact

Manage contacts (external users). For external form sharing with contacts, the external users need to be maintained in the system. Use this operation to Create/Modify/Delete contacts.

1. Choose the action to perform from Create, Update and Delete
2. Set the First Name if creating or updating it
3. Set the Last Name if creating or updating it
4. Set the Email ID of the external user
5. Choose if the external user is private to you or to be shared with other members of your organization
6. Enter the phone number if required
7. For all variables make use of the Expression Builder to inject fields and other results that will be substituted with actual values at run time
8. Save

Parameters

Param	Type	Required	Default	Description
action	String	True	Create	Choose the action to perform with the external user (Create/Update/Delete)
firstname	String	False		First Name needs to be provided for Create and optionally for update
lastname	String	False		Last Name needs to be provided for Create and optionally for update
email	String	True		Email ID of the external user. External users are uniquely identified by their email id.
private	Boolean	False	False	Public contacts will be shared with other users within your organization
phone	String	False		Phone number of the external user

Output

Output	Type	Value
result	String	Unique ID of the created/modified/deleted user
error	String	The error from the operation if any

Navigation

Navigation	Comment
SUCCESS	If the external user creation / modification / deletion was successful
FAILURE	If there was an error while performing the required action on the external user

---