All actions
Basic syntax
--#item:
---depends_on:{earlier_item_id}
---id:{unique_id}
---alias:{item_alias}
---task_stage:{string}
---title:{string}
---description:{string}
---action:{action_name}
---options:{options}
---block:{true|false}
---optional:{true|false}
---undoable:{true|false}
---clearance_level:{adviser|admin|senior|email_address(s)}
---filter[0-9]+|filter:answer {filter}
---filter[0-9]+|outcome:{later_item_id}
---outcome:{later_item_id}
Directives
depends_on |
Optional. ID of an earlier item that this item is dependent on. Format: [a-z0-9]_
|
id |
Always required. ID of this item. Used to reference this item. Must be unique. Format: [a-z0-9]_
|
alias |
Optional. Another way to reference this item. Can be shared with multiple, similar items. Plainly will choose the last alias that has a value. Format: [a-z0-9]_
|
task_stage |
Optional. Used to group items into stages for in-task navigation and Data Studio.
|
title* |
Required, except for hidden actions. This item's heading. Accepts most logic statements.
|
description* |
Optional. Longer-form description of item. Used, for example, to provide instructions/prompts for users. Accepts most logic statements.
|
action |
Always required. Name of the action. Format: [a-z]_
|
options** |
Often required. Provides action-specific options, e.g. template key for document-related actions.
|
block** |
Optional. Blocks further items until this item is completed. Default: false
|
optional* |
Optional. Allows this item to be skipped. Default: false
|
undoable* |
Optional. Allows this item to be undone at any time during workflow. Default: false
|
clearance_level* |
Optional. Item may only be completed by people with matching clearance. Options: adviser, admin or senior (i.e. user is adviser or admin), or a comma-separated list of email_addresses.
|
filter[0-9]+|filter |
Optional. A filter to be applied to this item which, if matched, will trigger an item with the ID set in 'outcome' below. See Match types
|
filter[0-9]+|outcome |
Optional. ID of the item that is triggered when the filter above is matched.
|
outcome |
Optional. ID of an item that is triggered when this item is done. Cannot be used if a filter is also being used.
|
* Not applicable to actions that are hidden, e.g. hidden, auto_email, include_document.
** Common to many but not all actions.
specific_document
User makes a document from a template by inputting data manually.
Additional directives
options |
Required. Key of template being used. Template must be owned by user's account or group, with group-permissions enabled. Format: [a-z0-9]
|
button_text |
Optional. Button clicked by user to create the document. Default: Create document
|
pass_variables |
Optional. Variables to be passed when making document. Format: {key1}_IS_{value1}_AND_{key2}_IS_{value2}. See also Reserved Variables.
|
Examples
Minimal
--#item:
---id:item_12345
---title:Make document
---action:specific_document
---options:a1b2c3d4e5
Kitchen sink
--#item:
---depends_on:item_00000
---id:item_12345
---alias:my_document
---task_stage:Make document
---title:Make a document
---description:You need to make this document in order to proceed.
---action:specific_document
---options:a1b2c3d4e5
---button_text:Let's go!
---pass_variables:description_IS_My document_AND_folder_IS_Sales documents
---block:false
---optional:true
---undoable:true
---clearance_level:foo@bar.com, test@test.com
---filter1|filter:answer IS_BLANK
---filter1|outcome:item_34567
---filter2|filter:answer IS_NOT_BLANK
---filter2|outcome:item_56789
auto_document
Plainly makes a document from a template automatically.
Additional directives
options |
Required. Key of template being used. Template must be owned by user's account or group, with group-permissions enabled. Format: [a-z0-9]
|
stage |
Optional. What steps to automate when creating the document. Accepts create, lock, send or finalise. See 'Document stages' below. Default: create
|
button_text |
Optional. Button clicked by user to re-create the document if the first one is deleted. Default: Create document
|
pass_variables |
Optional. Variables to be passed when making document. Format: {key1}_IS_{value1}_AND_{key2}_IS_{value2}. See also Reserved Variables.
|
Document stages
create |
Plainly will create the document only.
|
lock |
Plainly will create the document and lock it ready for signing.
|
send |
Plainly will create the document, lock it ready for signing and send it to the signatory(s) using the template email.
|
finalise |
For 'Static' document-types, Plainly will create the document and immediately finalise it.
|
Examples
Minimal
--#item:
---id:item_12345
---title:My document
---action:auto_document
---options:a1b2c3d4e5
Kitchen sink
--#item:
---depends_on:item_00000
---id:item_12345
---alias:my_document
---task_stage:Make document
---title:My document
---description:The document should be signed before proceeding.
---action:auto_document
---options:a1b2c3d4e5
---stage:send
---button_text:Let's go!
---pass_variables:description_IS_My document_AND_folder_IS_Sales documents
---block:false
---optional:true
---undoable:true
---clearance_level:foo@bar.com, test@test.com
---filter1|filter:answer IS_BLANK
---filter1|outcome:item_34567
---filter2|filter:answer IS_NOT_BLANK
---filter2|outcome:item_56789
get_document
Gets a specific document and displays it in your workflow. Also imports the document's underlying data.
Additional directives
options |
Required. Key of the document. Document must be owned by user's account or group account. Format: [a-z0-9]
|
done_at |
Required. Marks the action as complete. Otherwise, the workflow will not be able to proceed past this action.
|
Examples
Minimal
--#item:
---id:item_12345
---title:My document
---action:get_document
---options:a1b2c3d4e5f6
---done_at:1
Kitchen sink
--#item:
---depends_on:item_00000
---id:item_12345
---alias:my_document
---task_stage:Review document
---title:My document
---description:Please review this document before proceeding.
---action:get_document
---options:{{first_document|a1b2c3d4e5f6}}
---done_at:1
---filter1|filter:answer IS_BLANK
---filter1|outcome:item_34567
---filter2|filter:answer IS_NOT_BLANK
---filter2|outcome:item_56789
include_document
Imports the data only from a specific document into your workflow. Action is hidden from users on tasks.
Additional directives
options |
Required. Key of the document. Document must be owned by user's account or group account. Format: [a-z0-9]
|
done_at |
Required. Marks the action as complete. Otherwise, the workflow will not be able to proceed past this action.
|
Examples
Minimal
--#item:
---id:item_12345
---action:include_document
---options:a1b2c3d4e5f6
---done_at:1
Kitchen sink
--#item:
---depends_on:item_00000
---id:item_12345
---alias:my_document
---action:include_document
---options:{{first_document|a1b2c3d4e5f6}}
---done_at:1
---filter1|filter:answer IS_BLANK
---filter1|outcome:item_34567
---filter2|filter:answer IS_NOT_BLANK
---filter2|outcome:item_56789
update_document
Updates one or more variables in a document. Action is hidden from users on tasks.
Additional directives
options |
Required. Key of the document. Document must be owned by user's account or group account. Format: [a-z0-9]
|
pass_variables |
Required. Variables to be updated in the document. Format: {key1}_IS_{value1}_AND_{key2}_IS_{value2}. See also Reserved Variables.
|
Examples
Minimal
--#item:
---id:item_12345
---action:update_document
---options:a1b2c3d4e5f6
---pass_variables:counterparty_IS_Testco Limited
Kitchen sink
--#item:
---depends_on:item_00000
---id:item_12345
---alias:my_document
---action:update_document
---options:{{first_document|a1b2c3d4e5f6}}
---pass_variables:counterparty_IS_Testco Limited_AND_folder_IS_Testco documents_AND_delivery_dates_IS_1654087851[|]1678838400[|]{{*today}}
---filter1|filter:done_at IS_BLANK
---filter1|outcome:item_34567
---filter2|filter:done_at IS_NOT_BLANK
---filter2|outcome:item_56789
All actions