Create a related list
- UpdatedJan 30, 2025
- 4 minutes to read
- Yokohama
- Navigation and UI
Create a related list to provide agents with information related to an open record automatically.
Before you begin
Role required: admin
About this task
Related lists appear as tabs above the Form pane.
Procedure
- Navigate to All > Workspace Experience > Actions & Components > Related List Actions and click New.
-
On the form, fill in the fields.
Table 1. Action Assignment form Field Description Action label Name of the component you're adding as a related list. Action name Name that describes what you're adding. Implemented as - UI component—Displays an icon in a field, form, list, or related list to perform a function, such as adding an attachment to a record, adding a component in the contextual side panel, displaying a form for users to fill out, or searching for a record.
- Client action—Takes action on the client side, such as dialing a phone number, opening a record, or opening a form to edit a record. There are a preset number of client actions, such as call number, remove notification, and show notifications. You cannot create new ones. Use this option, for example, with a phone number field to enable the agent to dial a phone number by clicking the icon. The client actions that come with Agent Workspace have handlers in the browser that carry out the actions.
- Server script—Executes a script on the server, for example, to assign a record to someone, or delete a record. Use this option whenever your action involves changing the database.
Specify UI component Shown only when Implemented as is UI component. Click the magnifying glass icon ( ) and select the component to add as a related list.
Specify client action Shown only when Implemented as is Client action. Click the magnifying glass icon ( ) and select the client action to add as a related list.
Icon Icon to use in the Related Items section that agents click to use this component. 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 is open, this component can appear as a related list. View A set of visual configurations. This value is typically Workspace. Active Toggle to make this component active as a related list. Order An integer that governs the placement of this icon in the list of related lists. The lower the number, the higher 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. - In the related lists, click Advanced view.
- (Optional) On the Conditions tab, use the condition builder to create filters that prevent the component's icon from appearing in the related lists.
- (Optional) If Implemented as is Server Script, on the Server Script tab, add the server script.
- (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 use of this component.
- (Optional)
On the Action Exclusion tab, click
New to exclude children table from inheriting this
component as a related list, or from this table inheriting components from a
parent table.
-
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 Related Items list. Exclude this table Toggle to prevent this Table from inheriting this component from its parent table. Exclude all child tables Toggle to prevent child tables of Table from inheriting this component in the list of Related Items. - Click Submit.
-
On the form, fill in the fields.
- Click Update.
What to do next
Select a component from the list to set it up.