Create Record activity
Summarize
Summary of Create Record activity
The Create Record activity in ServiceNow playbooks allows you to pause the playbook and prompt an end user to create a record via a form view. This activity is designed to facilitate user-driven record creation within a specified table and form, enhancing interaction and data collection during the playbook execution.
Show less
This activity is available to users with admin, playbook.admin, or pdauthor roles and can be added as a common activity in a playbook.
Configuration and Inputs
To set up the Create Record activity, configure the following key inputs in the activity properties panel:
- Label: Title displayed on the activity and playbook card.
- Description: Information about the activity’s purpose or expected outcome.
- Run condition: Conditions that determine when the activity runs, using data from prior activities.
- Start Rule: Defines when the activity or stage begins, with options such as starting when the process/stage starts or after specific stages/activities complete.
- Start with delay: Optionally delays the start of the activity or stage.
- Table: Specifies the target table where the new record will be created.
- Create Record View: Sets the form view presented to the user for record creation. If not specified, the default view is used. The form view can be edited with Form Builder.
- Template Fields: Predefined field values to populate during record creation.
Outputs
The activity provides outputs that can be used by subsequent activities in the playbook, including:
- Table Name: The table containing the newly created record.
- Create Record View: The form view used for record creation.
- Record Created Sys ID: The unique identifier of the created record, enabling reference and further automation.
Design Considerations
- Create specialized form views for the activity that show only necessary fields, including required fields or those validated by business logic, to streamline user input and ensure data integrity.
- Because the Create Record activity requires interactive user input and pauses the playbook, it can block dependent activities from starting. To avoid delays, design playbooks so that non-interactive activities run before interactive ones like Create Record.
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
| 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 , 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. 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 Note: Many form views are not supported in Workspace. |
| Template Fields | Template Value | Field values to set during record creation. |
Outputs
| 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.