Create Record activity
Pause the playbook and prompt the end user to create a record in a form view. Use this activity to allow the end user to create a record. This activity requires you to configure the desired table for which record to create, and the desired form view that the end user will see when creating the record.
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.Note: Select Show additional options to see this field. | ||
| Start Rule | Choice | Under Schedule > Start Rule, select a start rule for when your stage should start running:- When process starts: Your stage starts running as soon as the playbook starts. - After specific stages: Your stage starts running after specified stage(s) have finished running. Under Schedule > Start Rule, select a start rule for when your activity should start running:- When stage starts: Your activity starts running as soon as its stage starts running. Your stage starts running when your playbook is triggered. - After specific activities: Your activity starts running after specified activities have finished 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.Note: Select Show additional options to see this field. | ||
| Table | Table Name | Table in which to insert new record. | ||
| Create Record View | String | Form view to use for record creation. If you don't provide a form view, the system uses the default view. Use the new tab button Image omitted: new-tab-button.png Template Fieldsa button that opens a new tabto open and edit a form view with Form Builder in a new Workflow Studio tab.<strong>Note:</strong> Many form views are not supported in Workspace.</td></tr><tr><td> | Template Value | Field values to set during record creation. |
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 new record. |
| Create Record View | String | Form view used for record creation. |
| Record Created | Sys ID | Unique identifier of the record that this activity created. |
Design considerations
Create form views for activities that you want to render in a playbook during runtime.
Use a form view to display only the fields your users need to create 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
While a Create Record activity interactively gathers data from users, it prevents the playbook from starting any dependent activities. For example, a Create 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.