Update Record activity
Update a record with the field values you specify.
Roles and availability
- This activity is available as a common activity. Users with the admin, playbook.admin, or pd_author can add this activity to a playbook.
Inputs
Open the activity properties panel and configure your activity to add values for the following inputs. If the input value varies, use the pill-picker to show where to get the
value. To learn more about the pill-picker, see Dot-walking examples.
| Input | Type | Description |
|---|---|---|
| Label | String | Title to display as activity and playbook card. |
| Description | String | Information to display about activity usage or outcome. |
| Run condition | Condition Builder | Conditions that must be met to run an activity or stage. You can use data from prior activities to build conditions. 注: Select Show additional options to see this field. |
| Start Rule | Choice | Under , select a start rule for when your stage should start running:
|
| Start with delay | True/False | Option to wait for a duration of time before running an activity or stage. When enabled, this input displays the Start with delay input properties. 注: Select Show additional options to see this field. |
| Table | Table Name | Table containing the record to update. |
| Record | Reference | Reference to the record you want to update. |
| Fields | Template Value | Field values to change during record update. |
| Wait for user input | Choice | Option to pause the playbook until the end user manually completes or skips the activity. Only users with the playbook.admin role can edit this field. By default, the activity waits for user action or data before it completes. |
Advanced inputs
After configuring the required inputs for your activity, you can also choose to configure additional inputs. In the side panel, select Show additional
options to display these advanced inputs. For more information, see Activity experience.
| Input | Type | Description |
|---|---|---|
| Assignment Group | Reference.Group [sys_user_group] | Group responsible for completing the task associated with the activity. 注: Select Show additional options to see this field. |
| Assigned To | Reference.User [sys_user] | User responsible for completing the task associated with the activity. 注: Select Show additional options to see this field. |
| Fields to show after update | String | Comma-separated list of fields to display for an updated record. |
Outputs
These outputs can provide data to other activities in your playbook. You can access this data as activity inputs when you configure your activity:
| Output | Type | Description |
|---|---|---|
| Table | Table Name | Table containing updated record. |
| Record | Document ID | Reference to record updated. |
Design considerations
- Create form views for activities that you want to render in a playbook
- Use a form view to display only the fields your users need to update a record. Your view should display required fields or those fields validated by other business logic. See View Management.
- Run non-interactive activities before interactive activities
- If an Update Record activity interactively gathers data from users, it prevents the playbook from starting any dependent activities. For example, an Update Record activity would prevent starting After Previous activities, which may be in other stages. Where possible, design your playbooks to run non-interactive activities before interactive activities that could block them.