Processes
Last updated
Last updated
The examples below will take you through creating your first process, to customizing it, and deleting it.
As a bare minimum, you need to provide the title
key.
Congratulations, you have created your first process!
A process, on its own, is not very useful. Let's add a checklist field.
Here are some code snippets demonstrating how to convert a JSON object to a Transit encoded string:
Using transit-js
For example, given a checklist configuration as a JSON object such as
After converting it to Transit encoded JSON string and escaping it, it should look like
which can then be used in the payload as
Available configuration
Label
Multiline
Placeholder
Default value
Supressing notification for default value
Available configuration
Label
Placeholder
Available configuration
Label
Default users
Supressing notification for default value
Multivalued toggle (default off)
Available configuration
Label
Placeholder
Max value
Min value
Step (only applicable to the web UI)
Default value
Supressing notification for default value
Minimum places to display after decimal point (only applicable to the web UI)
Round off if number digits entered after decimal are more than configured (default false
, only applicable to web UI)
Available Configuration
Open by default (when status is set to)
Available Configuration
Label
Multivalued toggle
Show full preview toggle (only applicable to web UI)
Sorting by file name through name
or upload date using date
Default files
Suppressing notification for default value
Restrict upload sources
Available Configuration
Label
Optional file field to attach the PDF to, instead of PDF field
Customize checklist behavior through preview
(don't attach to checklist, attach only latest to checklist, attach all to checklist, respectively)
Sequence of PDFs to stitch
Generate from a template using PDFGeneratorAPI, specify a templateId
Generate from a template using Adobe, specify name
(a file, which is a template)
Generate from a native file, specify fieldId
(a file field)
Button text (by default Generate PDF
)
Available Configuration
Label
Who is authorized to create a revision
All the participants
The owner
Roles
Specific users
Groups
Users from a field (must be a user field)
Who is authorized to mark a revision current
All the participants (of the current revision)
All the participants (of the revision being marked current)
The owner (of the current revision)
The owner (of the revision being marked current)
Roles
Specific users
Groups
Users from a field (of the current revision) (must be a user field)
Users from a field (of the revision being marked current) (must be a user field)
Only when a specific status is set
Fields to copy
Navigate to new revision automatically when created (Only applicable for web UI)
Mandate writing comment when creating revision
Automations
On the new current revision
Add participants
Remove participants
Add participants to fields
Send message
Update privacy
Unarchive
On the old current revision
Add participants
Remove participants
Add participants to fields
Send message
Update privacy
Update status
Auto archive
Available Configuration
Label
Show "Request Approval" button
Minimum required approvers
Required approvers
Set to some
to let anyone sign
Set to adhoc
to dynamically choose who can sign (Will override Minimum required approvers
and Show "Request Approval" button
)
Who can approve
All participants
The owner
Prevent requester from approving
Users
Roles
Groups
Users in field(s) (Must be a user field)
Who can cancel
All participants
Approvers/signatories
Prevent requester from approving
Users
Roles
Groups
Users in field(s) (Must be a user field)
Can cancel when
Allow cancellation post approval (allowCancelOnApproval
)
Allow cancelling of approvals in progress
(canCancelPartialApproval
)
Require comments
During approval
During rejection
During cancellation
Contingent of previous approval(s)
Hide/disable when inactive
Disable previous approvals while field is approved or in progress
Lock fields
When mode is set to new
, fields
will be locked during and post approval/rejection
When mode is set to inherit
, fields will continue to be locked under previous approval
Lock status
On start / request of signature
On approval
On rejection
On cancellation
Cancel all contingent approvals on rejection
Automations
On start / request of signature
Update status
Add participants
Remove participants
Change owner
Send message
Update privacy
On approval
Update status
Add participants
Remove participants
Change owner
Send message
Update privacy
Mark revision as current
On rejection
Update status
Add participants
Remove participants
Change owner
Send message
Update privacy
On cancellation
Update status
Add participants
Remove participants
Change owner
Send message
Update privacy
Available Configuration
Label
Set as child or parent conversation
Multiselect toggle
Allow selecting existing conversations through select
Allow creating new conversations through create
Autofill related conversation
Specify type of conversation
Process id through workflow
(Only valid if type
is set to "workflow"
)
Configure embedded fields (Only valid if type
is set to workflow
)
Show field names in preview
Show status and due date
Sort conversations
Select existing conversations by criteria
Show/hide archived conversations
Suppress title hyperlink to the record
Available Configuration
Label
Specify process and embedded fields
Allow linking multiple records
Autofill related records
Allow archived conversations
Show compressed preview
Show status, owner and due date
Disable title hyperlink to record
Set current process as child or parent
Allow selecting existing record
Allow creating new record
Allow manual revision linking
Select existing record by criteria
Title
Available Configuration
Label
Allow multiple
Specify form templates
Let's start by creating a blank process using the API.
Checklist fields are added/updated/removed to a process through thechecklistFields
array.
Each element in the array represents a checklist field.
The checklist field configuration is present in the attrs
key, which is a encoded JSON string.
To convert a JSON object to a Transit encoded JSON string, you can make use of various libraries which have implemented the Transit spec. When writing the string, ensure you use the json-verbose
type, instead of json
.
In the examples below, we may opt to write JSON objects for readability. You will need to convert them to Transit before making the API call.
To delete a checklist field, use the API and remove the checklist field you want to delete from the checklistFields
array.
To restore a checklist field, use a combination of the and APIs.
The API should include the field you want in its response, even if it is deleted.
To restore it, set the values of deleted
, deletedAt
and deletedBy
to null
when using the API. Make sure you do not modify the rest of the checklist field object.
Title of the Workflow template
Purchase order
Description of the Workflow template
Get the list of items for purchase
List of member IDs
["Q79THCOJ5CcvWRMPeIVZiq1ezu42","fcsknAS1txaGbWyYIILvu56dtir2"]
List of groups
List of process owner IDs
Owner ID
Q79THCOJ5CcvWRMPeIVZiq1ezu42
Numbering scheme for the Workflow template
Purchase order ###
List of checklist IDs
List of notification groups
List of file names
Privacy setting
full
ID of the workflow
11
Title of the Workflow Template
Workflow Template
Description of the Workflow Template
Get the list of items for purchase
List of member IDs associated with the Workflow Template
["Q79THCOJ5CcvWRMPeIVZiq1ezu42","fcsknAS1txaGbWyYIILvu56dtir2"]
List of group information
List of process owner IDs
["Q79THCOJ5CcvWRMPeIVZiq1ezu42"]
Owner ID of the Workflow Template
Q79THCOJ5CcvWRMPeIVZiq1ezu42
Numbering scheme for the Workflow Template
Purchase order ###
List of notification groups
List of files
Privacy setting for the Workflow Template
none
Privacy settings information
{"whitelist":["fcsknAS1txaGbWyYIILvu56dtir2"]}
Flag indicating if the Workflow Template is a draft
false