Set up using a value in a reference field to take action. For example, add an icon in a field with a phone number to dial that phone number. Or, add an icon in a reference field that opens a user record in a tab.

Before you begin

Role required: admin

A field decorator is an icon that's added to a reference field in the Form pane that an agent can click to perform some action. Workspace supports up to three decorators per field.

The objective in setting up Workspace Action field decorators is to enable agents to do things on one page that otherwise would require opening additional pages. For example, instead of opening another page to display the record of the user named in an incident, the agent just clicks the Workspace Action field decorator in the Caller field to open the user record in a tab.

The field action, Open Record, must exist as a Workspace Action definition before you create a new action assignment. The icon, icon-user, must be an icon available in your instance.

1. Navigate to Workspace Experience > Actions & Components > Field Decorators.
   A list of existing field decorators appears.
2. Click New.
3. On the form, fill in the fields.

   The following table adds a field decorator icon to URL fields. When agents click the icon, the URL opens.

   Table 1. Action Assignment form

   Field	Description
   Action label	Name of the field decorator, for example, Open a URL. You can use double braces, {{}}, to insert values in the text at runtime, for example, {{count}}. For example, you can show the number of records an agent selects using braces.
   Action name	Name that appears for this record in the list of action assignments: Workspace Experience > Actions & Components > Field Decorators, for example, open_a_url.
   Implemented as	Client Action is the only valid selection for field decorators. The field decorator appears as an icon in a field, form, list, or related list. When clicked, the decorator performs an action, such as calling a phone number, opening a record, updating content, or opening a URL. UI component is a UI element that you can place in many areas in Workspace. Client Action dispatches an action specified in Specify client action. Server Script take actions on the server changing database records, such as adding, removing, or modifying them.
   Specify client action	Click the magnifying glass icon () and select the action to take. To open a URL, select Open URL. This field only appears when Implemented as is Client Action. You cannot add custom actions to this list.
   Specify UI component	Click the magnifying glass icon () and select the component to add. This field only appears when Implemented as is UI Component.
   Decorator applies to	Field type means the decorator appears for all fields of this type. Specific field means the decorator appears only when the field you specify opens. Many specific fields are of the same field type. For example, select Field type to apply this field decorator icon to all URL fields.
   Field type	Select the field type where you want the field decorator to appear, for example, Reference. Many fields are of type Reference. As another example, to dial a phone number, select Phone Number. This field, Field type only appears when Decorator applies to is Field type.
   Field name	Select the field where you want the field decorator to appear. The choices of fields depends on the value of Table. For example, select Date. This field only appears when Decorator applies to is Specific field.
   Icon	Clickable icon that appears in the field specified by Field type or Field name that initiates the action.
   Tooltip	Text that displays when and agent hovers a mouse over the icon.
   Description	Short description of this component.
   Application	Application that this component applies to. Global means that the component applies to all applications.
   Workspace	Workspace this component belongs in, for example, Agent Workspace, ITSM, CSM, and so forth.
   Table	Table this component is tied to. When a record from this table opens, the field decorator appears in the field(s) specified by Field type or Field Name. The default is Global. You can leave the default value so that the field decorator icon appears for any open record that has the field specified by Field type. If you specify a table, then only when records from that table are open can the field decorator icon appear.
   View	A set of visual configurations. This value is typically Workspace.
   Active	Toggle to make this field decorator appear (selected) or not.
   Order	An integer that governs the placement of this icon in the list of field decorators in a field. The lower the number, the further left in the list. The typical practice is to make these numbers hundreds, for example, 100, 200, 300, and 400, so you can put new icons between existing ones in the future.

4. Right-click the top banner and select Save.
   Related links appear.
5. (Optional) On the Action Exclusion tab, click New to exclude children tables from inheriting this component in the Contextual Side panel, or this table inheriting components from a parent table.
   Components in the Contextual Side panel appear according to the records open in Agent Workspace. Child tables inherit these components by default. You can prevent that from happening.
   1. On the form, fill in the fields.

      Table 2. Action Exclusion form

      Field	Description
      Action assignment	Click the magnifying glass icon () and select an action assignment, which specifies the
      Table	Table associated with this component. Every time Agent Workspace opens a record from this table, this component's icon appears in the Contextual Side panel.
      Exclude this table	Toggle to prevent this Table from inheriting this component from its parent tables.
      Exclude all child tables	Toggle to prevent child tables of Table from inheriting this field decorator.

   2. Click Submit.
6. Under Related Links, click Advanced view.
   Up to this point, you have not specified the URL you want to open when an agent clicks the field decorator icon. This is the task you perform in Advanced view.
7. On the Action Attributes tab, in Payload Map, select the action attribute you want to define. In this example, select url.
8. In the value field, enter the URL to open.
9. (Optional) On the Conditions tab, in Script Condition, enter a script that can hide the field decorator.
10. (Optional) On the Conditions tab, in Client Conditions, specify conditions on the client that would hide the field decorator.

    Client conditions are reevaluated whenever an agent makes a change in a list of records. For example, you might hide the button for a list action until an agent selects one or more records in a list. The client condition, then, is "count is greater than zero," where count is the number of records selected.

11. (Optional) On the Conditions tab, in Record Conditions, specify a field and a value such that if an open record has a field with that value, the field decorator icon would not appear.
12. (Optional) On the Conditions tab, in Required Roles, specify roles an agent must have to see the field decorator.
13. (Optional) On the Confirmations Settings tab, select the Confirmation Required check box if you want to display a pop up that asks the agent to confirm the action to be taken by the field decorator.
14. Click Update.

Result

The field decorator icon appears in all record fields of type reference for all of the tables you specified in Table. Clicking an icon would open the URL specified in the Payload Map.