Configure UXF client actions for playbook
- UpdatedAug 3, 2023
- 2 minutes to read
- Vancouver
- Navigation and UI
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
Create playbook UXF client actions for use within UI Builder.
Before you begin
Role required: admin
Use UXF client actions to trigger events within UI Builder. UXF Client Actions can be used in the Playbook, Stage, and Activity Actions.
Procedure
- Navigate to All > Playbook Experience > Actions Playbook Actions, Stage Actions, or Activity Actions.
- Select an action assignment or click New to create a new one.
-
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. An action assignment overrides others with the same name. Implemented as Select UXF Client Action. Specify Client Action Select the magnifying glass icon ( ) and choose a Client Action.
Tooltip Text that displays when an agent points their cursor over a button or icon. Icon Icon that displays in the activity card. Render Mode Render mode on a Playbook card. Specify how the action renders 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.- When an activity contains a form that's too large to fit on a card, the form is hidden in a modal.
- 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.
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. - Click Submit.
What to do next
Implement the UXF client action for playbook using UI Builder.