Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Paris Now Platform Capabilities Now Platform capabilities Workspace Setting up Workspace Setting up Record View in workspace Set up a custom Playbook user experience Custom Playbook actions

    Custom Playbook actions

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Custom Playbook actions

    Customize Playbook interactions by setting up conditions that add buttons and list items. This customization enables you to submit forms, open records, and complete and skip activities across all Playbook experiences.

    Overview

    Playbook actions use actions which can run server scripts, dispatch client actions, or render UI components when triggered. When running server scripts, the current variable is tied to the activity’s associated record.

    Flow Data records (sys_flow_data) are often used as associated records to control the configuration of a flow through an action server script. These server scripts can set the state of the flows to complete or skipped, enabling an agent to directly effect logic within a flow.

    Flow Data records can also collect user data from an agent to use within a flow.

    An associated record can be tied to any table, and you can define your own actions beyond these default actions to accomplish the business process workflow logic that you want.

    Default actions

    The following default actions are supported in Playbook.
    Action Name Description
    Skip

    skip_instructional

    Skips an instructional process step
    Skip

    skip_email

    Skips sending an email
    Skip

    skip_knowledge

    Skips a knowledge process step
    Skip

    skip_update

    Skips an update record process step
    Skip

    skip_list

    Skips a list process step
    Skip

    skip_create

    Skips a create record process step
    Create Record

    create_record

    Informs process automation to create record
    Send Email

    send_email

    Informs process automation to send email
    Update

    update_record

    Informs process automation to update record
    Skip Activity Skip activity that hasn't started yet
    Mark Complete

    mark_complete_knowledge

    Marks a knowledge process step complete
    Mark Complete

    mark_complete_instructional

    Marks an instructional process step complete
    Mark Complete

    mark_complete_list

    Marks a list process step complete

    Customize Playbook actions

    Customize Playbook actions using forms, conditions, and scripts, components, or client actions. This customization enables users to submit forms, open records, and complete and skip activities.

    Before you begin

    Role required: playbook_experience admin

    About this task

    • Default actions can't be edited. These actions are displayed as read only.
    • Actions can only operate against one record.

    Procedure

    1. Create the action and specify details.
      1. Navigate to Playbook Experience > Activity Actions.
      2. Select an action assignment or click New to create a new one.
        Note: For a list of default actions, see Playbook actions.
      3. On the form, fill in the fields.
        Table 1. Action Assignment form
        Field Description
        Action Label Label that appears on the button created through the action.
        Action Name Name for your action that appears in the action assignment list.
        Implemented as Type of action that is implemented. For example, UI Component.
        Specify UI Component UI component that is associated with the Implemented as field. When the Implemented as field is set to UI Component, this field specifies a UI component that is displayed when the action is triggered.
        Declarative Actions Render Mode Render mode on a Playbook card. Specify how the action should be rendered on the Playbook card. Select Button, Header Dropdown, or Header Icon.
        Button Type Button type that's displayed in the Playbook UI. Select Primary, Secondary, or Tertiary.
        Form fields required Option that communicates that the action requires data from the user to proceed.
        This field is consumed in the Playbook experience UI in the following ways.
        1. When an activity contains a form that's too large to fit on a card, the form is hidden in a modal.
        2. When an Activity contains a form but doesn't have actions that require form fields, the form is not rendered. Instead, the fields on the form are rendered as a stacked collection of label-value pairs.
        This field can be overridden by creating a custom activity renderer.
        Tooltip Message that's displayed in the Playbook UI when your cursor points to the action.
        Description Description for the action that's displayed in the Action Assignments list.
        Application Application for the action assignment.
        Workspace Workspace that the playbook action is associated with. For example, ServiceNow®ITSM or HR.
        Note: This field is not required.
        Table Field to limit this action to activities with this associated table.
        View Field to limit this action to activities with this Form View.
        Active Option to activate the action.
        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. This ordering enables you to override other actions with your own. The typical practice is to use numbers that are in the hundreds. For example, 100, 200, 300, or 400.
      4. Click Update.
    2. Set up conditions for the action.
      1. Click the Conditions tab.
      2. On the form, fill in the fields.
        Table 2. Conditions form
        Field Description
        Script Condition Script condition for the action assignment. Enter sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current). This script enables you to show a Playbook only when the record has triggered a process execution.
        Note: Adding queries involving multiple joins can impair performance.
        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.
    3. If Server Script is selected in the Implemented as field, provide script for the action.
      • Server scripts can reference the associated record of an activity using the Current variable.
      • Calling current.update() updates the associated record with values that the user provides from embedded forms on Playbook cards.
      • Server scripts can reference the parent record of an activity using the parent variable.
    4. If Client Action is selected in the Implemented as field, optionally specify the payload mapping on the Action Attributes tab.

      Payload mapping enables you to override portions of the payload dispatched by the client action. For example, the Preview Record client action enables you to open a record on a new Workspace tab. Using payload mapping, you can specify a related item tab that's displayed when the form is opened. Set the defaultTab to do this.

    5. If UI Component is selected in the Implemented as field, optionally specify the component’s attributes on the Component Attributes tab.
    6. Click Submit.

    What to do next

    Integrate your Playbook experience with Workspace.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Custom Playbook actions

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Custom Playbook actions

      Customize Playbook interactions by setting up conditions that add buttons and list items. This customization enables you to submit forms, open records, and complete and skip activities across all Playbook experiences.

      Overview

      Playbook actions use actions which can run server scripts, dispatch client actions, or render UI components when triggered. When running server scripts, the current variable is tied to the activity’s associated record.

      Flow Data records (sys_flow_data) are often used as associated records to control the configuration of a flow through an action server script. These server scripts can set the state of the flows to complete or skipped, enabling an agent to directly effect logic within a flow.

      Flow Data records can also collect user data from an agent to use within a flow.

      An associated record can be tied to any table, and you can define your own actions beyond these default actions to accomplish the business process workflow logic that you want.

      Default actions

      The following default actions are supported in Playbook.
      Action Name Description
      Skip

      skip_instructional

      Skips an instructional process step
      Skip

      skip_email

      Skips sending an email
      Skip

      skip_knowledge

      Skips a knowledge process step
      Skip

      skip_update

      Skips an update record process step
      Skip

      skip_list

      Skips a list process step
      Skip

      skip_create

      Skips a create record process step
      Create Record

      create_record

      Informs process automation to create record
      Send Email

      send_email

      Informs process automation to send email
      Update

      update_record

      Informs process automation to update record
      Skip Activity Skip activity that hasn't started yet
      Mark Complete

      mark_complete_knowledge

      Marks a knowledge process step complete
      Mark Complete

      mark_complete_instructional

      Marks an instructional process step complete
      Mark Complete

      mark_complete_list

      Marks a list process step complete

      Customize Playbook actions

      Customize Playbook actions using forms, conditions, and scripts, components, or client actions. This customization enables users to submit forms, open records, and complete and skip activities.

      Before you begin

      Role required: playbook_experience admin

      About this task

      • Default actions can't be edited. These actions are displayed as read only.
      • Actions can only operate against one record.

      Procedure

      1. Create the action and specify details.
        1. Navigate to Playbook Experience > Activity Actions.
        2. Select an action assignment or click New to create a new one.
          Note: For a list of default actions, see Playbook actions.
        3. On the form, fill in the fields.
          Table 1. Action Assignment form
          Field Description
          Action Label Label that appears on the button created through the action.
          Action Name Name for your action that appears in the action assignment list.
          Implemented as Type of action that is implemented. For example, UI Component.
          Specify UI Component UI component that is associated with the Implemented as field. When the Implemented as field is set to UI Component, this field specifies a UI component that is displayed when the action is triggered.
          Declarative Actions Render Mode Render mode on a Playbook card. Specify how the action should be rendered on the Playbook card. Select Button, Header Dropdown, or Header Icon.
          Button Type Button type that's displayed in the Playbook UI. Select Primary, Secondary, or Tertiary.
          Form fields required Option that communicates that the action requires data from the user to proceed.
          This field is consumed in the Playbook experience UI in the following ways.
          1. When an activity contains a form that's too large to fit on a card, the form is hidden in a modal.
          2. When an Activity contains a form but doesn't have actions that require form fields, the form is not rendered. Instead, the fields on the form are rendered as a stacked collection of label-value pairs.
          This field can be overridden by creating a custom activity renderer.
          Tooltip Message that's displayed in the Playbook UI when your cursor points to the action.
          Description Description for the action that's displayed in the Action Assignments list.
          Application Application for the action assignment.
          Workspace Workspace that the playbook action is associated with. For example, ServiceNow®ITSM or HR.
          Note: This field is not required.
          Table Field to limit this action to activities with this associated table.
          View Field to limit this action to activities with this Form View.
          Active Option to activate the action.
          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. This ordering enables you to override other actions with your own. The typical practice is to use numbers that are in the hundreds. For example, 100, 200, 300, or 400.
        4. Click Update.
      2. Set up conditions for the action.
        1. Click the Conditions tab.
        2. On the form, fill in the fields.
          Table 2. Conditions form
          Field Description
          Script Condition Script condition for the action assignment. Enter sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(current). This script enables you to show a Playbook only when the record has triggered a process execution.
          Note: Adding queries involving multiple joins can impair performance.
          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.
      3. If Server Script is selected in the Implemented as field, provide script for the action.
        • Server scripts can reference the associated record of an activity using the Current variable.
        • Calling current.update() updates the associated record with values that the user provides from embedded forms on Playbook cards.
        • Server scripts can reference the parent record of an activity using the parent variable.
      4. If Client Action is selected in the Implemented as field, optionally specify the payload mapping on the Action Attributes tab.

        Payload mapping enables you to override portions of the payload dispatched by the client action. For example, the Preview Record client action enables you to open a record on a new Workspace tab. Using payload mapping, you can specify a related item tab that's displayed when the form is opened. Set the defaultTab to do this.

      5. If UI Component is selected in the Implemented as field, optionally specify the component’s attributes on the Component Attributes tab.
      6. Click Submit.

      What to do next

      Integrate your Playbook experience with Workspace.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login