Set up adding records to a related list

Configure user experiences > Configure UIs and portals > Workspace UI > Setting up your legacy workspace > Setting up Record View in legacy workspace >

Create an Add button so agents can add records to a Related List.

Role required: workspace_admin

You can create an Add button that enables agents to add records to lists. This functionality supports one-to-many (o2m) and many-to-many (m2m) tables. In the following example, we use the task_location tables and create the Add button for incidents. So, when you open a incident, you can click the new related list, Affected Locations , to see incidents (tasks) that occurred at the same location. Many incidents might occur at one location, and one incident might involve many locations.

The general procedure is to add the Related List, Affected Locations that is associated with the many-to-many table, task_location, and then create a Workspace Action to create the Add button that adds, in our example, locations to an incident.

When an agent clicks Add , a modal opens showing the agent locations where the incident can be added.

To understand the following example, enter task_location.list in the Filter Navigator to show the task_location table.

The table shows the associations between the location (cmn_location) and task (task) tables. In the example, there are none.

Add a new Related List, Affected Locations , which opens with incident records. Open an incident by navigating to Incident > Open and click an incident. Confirm that you're in the Workspace View by clicking your profile icon ( ), selecting Configure Page , and then selecting Form Layout . Set up a related list for the Incident table by clicking your profile icon ( ), selecting Configure Page , and then selecting Related Lists . On the Configuring related lists on Incident form, in View name , select Workspace . Select Affected Locations and use the arrows to move it into the Selected column. The task_location value is called Affected Locations . Click Save . You've added Affected Locations as a related list for all incident records.

Use a Workspace Action to create an Add button that enables agents to add locations to an incident. Navigate to 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 Label that appears on the button in the Related Lists area. Make this Add. In the previous image, the Add button will appear next to the New button. Action name The name for this record that appears in the list of related list actions, Workspace Experience > Actions & Components > Related List Actions . Implemented as Select UI Component because you are creating a button. Specify UI component Select sn-multi-record-associator . Button type Select Primary . Primary buttons are green. Secondary buttons are gray. Record Selection Required Checkbox to make record selection required. Tooltip Text that appears when agents hover a mouse over the UI component. Description Verbose description of this Workspace Action. Application Application that this component applies to. Global means that the component applies to all applications. Workspace Workspace this UI component appears in. Table Table this related list action shows up on. For an o2m relationship, make sure the table is your o2m related list table. For example, incident. For an m2m relationship, make sure the table is your m2m table. For example, task_location. In our example, select task_location. View Select workspace . Active Toggle to turn on (selected) and off this UI component. Order The sequence order in which this UI component appears in a horizontal list of UI components. The lower the value, the further left the location.

Under Related Links , click Advanced view to give the component the properties it needs to function. On the Component Attributes tab, fill in the fields. Table 2. Component Attributes form Field Description label Name that appears on the top of the modal when you click the Add button.

extensionPoint In our example, leave this blank. This field filters the list in the modal. When an agent clicks Add , every possible association is shown between the cmn_location and task tables. This field prevents some of those associations. To learn how to create an extension point, see Using extension points to extend application functionality . userGivenTable Table that appears in the modal. In our example, we want to open the locations agents can add, so select cmn_location. Select task_location for m2m relationships. For o2m relationships, select the table associated with the many portion of your o2m. For example, Incident . hideSelectAll Field that enables you to hide Select All. Select True to hide Select All. referencedfieldName Field displayed in the modal from the userGivenTable . In our example, enter location (lowercase). To find the field name, right-click the Location field title on the many-to-many table form.

This field is not used for o2m relationships.

type Record relationship type. Select an o2m or m2m relationship for the records. o2m enables a parent record in one table that can reference several child records. m2m enables multiple records in a table that are associated with multiple records in another table. parentFieldName The name of the field you're making the reference from, in this example, it's task. To find the field name, right-click the field title.

columns Comma-separated list of columns you want displayed in the modal. For example, in the cmn_location table, you might want name and city. So, enter name,city. view The view of the list. Do not add a value; the default view is fine.

Click Update . You've created an Add button that shows up in the Related Lists area when an incident record opens.

Make sure the Add button appears and works. Open an incident by navigating to Incident > Open and clicking an incident. Click the Affected Locations Related List. You should see the Add button in Related Lists. Click Add . A modal appears.

Select several check boxes to add those addresses to the incident record and then click Add . The addresses you selected appear in Affected Locations .

Enter task_location.list in the Filter Navigator to show the task_location table. The new locations should appear in the table.

Add a remove action. You can create a remove button that enables agents to remove records from a related list and disassociate that record from the parent table. This functionality supports o2m and m2m tables.

Navigate to Workspace Experience > Actions & Components > Related List Actions and click New . On the form, fill in the fields. Table 3. Action Assignment form Field Description Action label Label that appears on the button in the Related Lists area. Make sure the action label includes ({ {count}}) . Action name The name for this record that appears in the list of related list actions, Workspace Experience > Actions & Components > Related List Actions . Implemented as Select Server Script . Specify UI component Select sn-multi-record-associator . Button type Select Primary . Primary buttons are green. Secondary buttons are gray. Record Selection Required Checkbox to make record selection required. Toggle the checkbox. Tooltip Text that appears when agents hover a mouse over the UI component. Description Verbose description of this Workspace Action. Application Application that this component applies to. Global means that the component applies to all applications. Workspace Workspace this UI component appears in. Table Table this related list action shows up on. For an o2m relationship, make sure the table is your o2m related list table. For example, incident. For an m2m relationship, make sure the table is your m2m table. For example, task_location. In our example, select task_location. View Select workspace . Active Toggle to turn on (selected) and off this UI component. Order The sequence order in which this UI component appears in a horizontal list of UI components. The lower the value, the further left the location.

Click the menu icon ( ) and click Save . Under Related Links click Advanced view . Click the Server Script tab. Enter a server script in the scripting field. current.deleteRecord(); into the server script field. For m2m relationships, enter current.deleteRecord();. For o2m relationships, enter current.[field_name] = ''; current.update();.

Under Related Links click Advanced view , and click the Confirmation Settings tab. Toggle Confirmation required . Click Update .

Select a component from the list to set it up. Tabs Notifications Form Header UI Actions Ribbon Related Items Form pane Actions & Components Activity Stream Contextual Side Panel

Parent Topic: Set up Related Items in legacy workspace