Configure a playbook for ServiceNow mobile
Configuring a playbook for ServiceNow® mobile is exactly the same as in a configurable workspace, but with an additional step for embedding the playbook.
Before you begin
Role required: admin
Procedure
Navigate to All > Workspace Experience > Actions & Components > Related Items or Contextual Side Panel.
Click New.
On the form, fill in the fields.
| Field | Description |
|---|---|
| Action label | Label of the Related Item or Contextual Side panel tab. |
| Action name | Unique name for your item. This name can be overridden. |
| Implemented as | Select UI Component. |
| Specify UI component | UI component associated with the action. Enter `now-playbook-experience`. |
| Icon | Icon that is displayed in the Contextual side panel to differentiate from other components. Note: This field is available for the Contextual Side Panel only. |
| Application | Application for the action assignment. |
| Workspace | Option to limit a Related Item or Contextual Side Panel to a specific Workspace. For example, Agent Workspace or HR Workspace. |
| Table | Select the table you want to show the Related Item or Contextual Side Panel on. |
| View | Field to only display a Playbook when this Form View is selected on the parent record. |
| Active | Option to activate the action assignment. |
| Order | Integer that determines the precedence of this action in relation to matching actions with the same name. The lower the number, the more likely it is to be selected against other actions. The typical practice is to use numbers that are in the hundreds. For example, 100, 200, 300, or 400. |
| Tooltip | Message that's displayed when your mouse points to the Related Item tab or Contextual Side Panel icon. |
| Description | Description for the action assignment. This description is displayed in the Action Assignment list and provides context on the form. |
Click the Advanced View related link.
Click the Component Attributes tab.
On the form, fill in the fields.
| Attribute name | Description |
|---|---|
| playbookExperienceId | Associated Playbook experience ID. Copy and paste the sys_id of a Playbook Experience record.Note: If no Playbook experience ID is provided, the global Playbook experience is used by default. |
| parentSysId | Associated parent sys\_id. Enter`{{sysId}}` to automatically take the parentSysId of the record that you're viewing. |
| parentTable | Associated parent table. Enter `{{table}}` to automatically take the parentSysId of the record that you're viewing. |
| compactMode | Option to display a Playbook in compact mode. Typically set to true for Contextual Side Panel and false for Related Item. |
| recordGeneratorQuery | Not currently supported in Agent Workspace. |
| isNewParentRecord | Set to `{{isNewRecord}}`. |
**Note:** Select a different **UI Component** if the attributes are missing from your form. Change the **UI Component** back to **now-playbook-experience** and the attributes will appear.
Select Update.
Click the Conditions tab.
On the form, fill in the fields.
Field Description Script Condition Script condition for the action assignment. Enter sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current). The script condition enables you to show a Playbook only when the record has triggered a process execution.Client Conditions Choose conditions to limit collisions based on your use case. Record Conditions Choose conditions to limit collisions based on your use case. Required Roles Roles to limit Playbook access. Requires create access Option to require create access. Requires read access Option to require read access. Requires write access Option to require write access. Requires delete access Option to require delete access. Select Update.
Result
The playbook is configured for ServiceNow® mobile.
What to do next
Embed your playbook in ServiceNow® mobile. To learn more, see