Workflow:Action: Difference between revisions

From ContactsLaw Documentation
No edit summary
No edit summary
 
Line 6: Line 6:
== Control ==
== Control ==
These actions affect how the process runs.
These actions affect how the process runs.
* '''End''' - Ends the process, skipping any remaining rules or actions.
* '''Pause''' - Pauses the process until a particular date and time.
* '''Start process''' - Starts another process. You can wait until the new process completes, or continue immediately.
* '''Wait for completion''' - Pauses the process until all of its [[Task Item|tasks]] and [[Calendar Item|calendar]] items have been completed. You can choose to wait for only some of the items.


== Existing Items ==
== Existing Items ==
These actions add existing resources to [[Asset|assets]]. In most circumstances, assets are initially empty; therefore, you will need to load resources before you can refer to them.
These actions add existing resources to [[Asset|assets]]. In most circumstances, assets are initially empty; therefore, you will need to load resources before you can refer to them.
* '''Add existing items''' - Adds existing resources to an asset, optionally replacing any existing resources. Operates in a similar way to [[Template Configuration|configuring templates]].
* '''Get row from table''' - Loads a particular row from a [[Custom Field#Tables|table field]] into one or more assets. Used, for example, to edit individual rows using a form.


== New Items ==
== New Items ==
These actions create new resources for certain types of assets. This allows processes to, for example, create new [[Matter|matters]] and [[Document|documents]].
These actions create new resources for certain types of assets. This allows processes to, for example, create new [[Matter|matters]] and [[Document|documents]].
Various items are supported. Where an item depends on another item (e.g. [[invoice]] depends on a matter), you must specify additional assets.


== Update Items ==
== Update Items ==
These actions modify assets and the resources held within them. The process keeps track of pending changes and applies them when the rules have finished.
These actions modify assets and the resources held within them. The process keeps track of pending changes and applies them when the rules have finished.
* '''Generate document''' - Generates a document from a template and uploads the content. Can also overwrite the content of an existing document.
* '''Remove items''' - Removes resources from an asset depending on whether an [[expression]] evaluates to "Yes" or "No". Typically used to prevent a new resource from being created.
* '''Set property''' - Sets a property of an asset using an expression.
* '''Store ledger balance''' - Sets a property of an asset to the balance on a [[ledger]] (or [[account]]).
* '''Update checklist item''' - Changes the status of a [[Checklist Item|checklist item]].
* '''Update custom field''' - Sets the value of a [[Custom Field|custom field]] using an expression. You can choose whether to add a new value or replace existing values.
* '''Update relationship''' - Updates a [[Asset#Relationships|relationship]] between assets using an expression. Typically used to add parties to matters or documents.
* '''Update table''' - Updates a [[Custom Field#Tables|table field]] using expressions. You can choose whether to add, update or delete rows from the table.
* '''Update tags''' - Adds or removes a [[tag]] on an asset. Only certain types of assets support tagging.


== Interactivity ==
== Interactivity ==
These actions pause the process so that users can interact with it. This may involve capturing information or making decisions before the process resumes.
These actions pause the process so that users can interact with it. This may involve capturing information or making decisions before the process resumes.
* '''Ask question''' - Sends a [[Workflow:Prompt|question]] to a [[member]] and waits for a response. You can choose which responses are allowed.
* '''Send message''' - Sends a [[Workflow:Prompt|message]] to a member and waits for acknowledgement.
* '''Show form''' - Creates a new instance of a [[Workflow:Form|form]], sends it to a member and pauses the process until it is completed.
* '''Upload form''' - Uploads a copy of a previously-completed form.
[[Category:Workflow]]
[[Category:Workflow]]

Latest revision as of 13:23, 11 July 2025

Actions describe work to carry out within processes. They are triggered by rules.

Some types of actions cause the process to pause, pending some requirement; when met, a job is scheduled to resume the process.

Control

These actions affect how the process runs.

  • End - Ends the process, skipping any remaining rules or actions.
  • Pause - Pauses the process until a particular date and time.
  • Start process - Starts another process. You can wait until the new process completes, or continue immediately.
  • Wait for completion - Pauses the process until all of its tasks and calendar items have been completed. You can choose to wait for only some of the items.

Existing Items

These actions add existing resources to assets. In most circumstances, assets are initially empty; therefore, you will need to load resources before you can refer to them.

  • Add existing items - Adds existing resources to an asset, optionally replacing any existing resources. Operates in a similar way to configuring templates.
  • Get row from table - Loads a particular row from a table field into one or more assets. Used, for example, to edit individual rows using a form.

New Items

These actions create new resources for certain types of assets. This allows processes to, for example, create new matters and documents.

Various items are supported. Where an item depends on another item (e.g. invoice depends on a matter), you must specify additional assets.

Update Items

These actions modify assets and the resources held within them. The process keeps track of pending changes and applies them when the rules have finished.

  • Generate document - Generates a document from a template and uploads the content. Can also overwrite the content of an existing document.
  • Remove items - Removes resources from an asset depending on whether an expression evaluates to "Yes" or "No". Typically used to prevent a new resource from being created.
  • Set property - Sets a property of an asset using an expression.
  • Store ledger balance - Sets a property of an asset to the balance on a ledger (or account).
  • Update checklist item - Changes the status of a checklist item.
  • Update custom field - Sets the value of a custom field using an expression. You can choose whether to add a new value or replace existing values.
  • Update relationship - Updates a relationship between assets using an expression. Typically used to add parties to matters or documents.
  • Update table - Updates a table field using expressions. You can choose whether to add, update or delete rows from the table.
  • Update tags - Adds or removes a tag on an asset. Only certain types of assets support tagging.

Interactivity

These actions pause the process so that users can interact with it. This may involve capturing information or making decisions before the process resumes.

  • Ask question - Sends a question to a member and waits for a response. You can choose which responses are allowed.
  • Send message - Sends a message to a member and waits for acknowledgement.
  • Show form - Creates a new instance of a form, sends it to a member and pauses the process until it is completed.
  • Upload form - Uploads a copy of a previously-completed form.