Portal Playbook Widget

  • Release version: Xanadu
  • Updated August 1, 2024
  • 3 minutes to read

    • Explore the Portal Playbook Widget.

    About the widget

    The Playbook widget is an iFrame that enables administrators to specify where a playbook event should be directed. The iFrame URL is the UI Builder Playbooks Portal page. The widget handles events that playbook is listening for via the Session Storage API so that it knows when to perform an action in portal, like opening a record or list in a modal within Service Portal.

    The out-of-the-box components are built for any Playbook Experience you may need for your Service Portal users. We do not recommend directly editing the out-of-the-box UI Builder Playbook Portal Page, the Service Portal Playbook widget, or the Playbook Content Item. Changing the out-of-the-box components can result in technical problems.

    If, for example, you need a UXF Client Action to work for your instance of the playbook page, we recommend cloning the playbook widget instead.

    Note:
    To learn more about how to clone or create your own widget instead, see Developing custom widgets.

    Cloning a Playbook Service Portal Widget

    Navigate to All > Service Portal > Widgets and find the Playbook widget.
    Note:
    If you clone the Playbook widget, make sure that all out-of-the-box actions and configuration properties are copied over to your cloned widget.
    Table 1. Form Fields
    Field Description
    Name Enter a name for the cloned widget.
    ID The widget ID is created automatically based on the widget name by default, but you can change it to whatever you want.
    Description Add an optional description that provides details for the widget does.
    Application Choose an application scope that you want your widget to run in. Selecting Global lets your playbook run in any application scope. For more information, see Application scope.
    Public Select if your widget is public. If unchecked, your widget is private and only authenticated users with the snc_internal or snc_external role can see the widget.
    Roles Restrict access to the widget to certain roles.
    Body HTML template Leverage the Angular JS two-way binding to bind your controller variables to your markup.
    Danger:
    Only make changes to HTML templates if you have advanced coding knowledge and a firm understanding of AngularJS and the platform API.
    The iFrame URL is the URL of the UI Builder page. To learn more about the HTML template field, see . and .
    Warning:
    Make sure the iFrame URL of your cloned widget is different from the iFrame URL for the out-of-the-box widget.
    CSS Configure the widget CSS. Configuring CSS in an actual widget affects all instances of that widget. To learn more about the CSS field, see . and .
    Server script Script the server-side logic. This is helpful primarily with interacting with the Glide platform through server-side APIs.
    Danger:
    A server script requires knowledge of the ServiceNow API to work with record data.
    To learn more about the Server script field, see . and .
    Client controller In Angular, HTML templates contain Angular-specific elements and attributes. Angular combines the template with information from the model and client controller to render the dynamic view that a user sees in the browser. Identifier name for a reference to the controller in the directive's scope
    Danger:
    A client script requires knowledge of both the ServiceNow API and AngularJS to create a client controller.
    controllerAs The HTML template uses the controllerAs syntax for basic binding.
    Link Use a link function to directly manipulate the DOM.
    Danger:
    The link function requires knowledge of AngularJS.
    To learn more about the Link field, see . and .
    Has preview Select the checkbox to enable a preview of the widget in the Widget Editor.
    Demo data Provide data when previewing the widget in the widget editor.
    Data table Select a table to use as a data source.
    Fields Select fields to display as instance options.
    Option schema Allows a Service Portal admin to configure a widget. To learn more about the Option schema field, see . and Widget option schema.
    Docs Select a Service Portal documentation link.

    Check for errors in the UI Builder Playbook Experience Portal page config and events properties, e.g. disable the Open Record event as a maint user.