Set up a ribbon configuration in CSM Configurable Workspace

Create a ribbon setting and add that setting to a ribbon configuration for CSM Configurable Workspace.

Before you begin

Role required: workspace_admin, ui_builder_admin, admin

About this task

Use the steps in this task to set up a ribbon configuration for CSM Configurable Workspace.

• Create a ribbon setting, such as creating another version of the Customer 360 ribbon component.
• Add the ribbon setting to a ribbon configuration.
• Set the width and the order of the ribbon setting within the ribbon configuration.

Note:

You can also use ribbon settings from CSM Agent Workspace in CSM Configurable Workspace if you add the setting to the ribbon configuration.

One ribbon configuration CSM/FSM Configurable Workspace Ribbon Config, is included with CSM Configurable Workspace. This configuration includes the Customer 360, Timeline, and Active SLA ribbon components. You can use this configuration in the base system without completing any additional configuration steps.

Procedure

1. Create a ribbon setting.
   1. Navigate to All > Now Experience Framework > Configuration Settings > UX Ribbon Setting.
   2. Select New.
   3. Fill in the fields on the Ribbon Setting form.

      Table 1. Ribbon Setting form

      Field	Description
      Name	A label that describes this ribbon setting. It often includes the table associated with this ribbon.
      Ribbon component	The component to add to the ribbon setting, including Customer360, Timeline, Active SLA, or a custom ribbon component. Note: You can only add one component at a time. To make a second component appear in the ribbon, repeat this procedure to create another ribbon setting and add a different component.
      Table	The table associated with this ribbon setting. Anytime an agent selects a record from this table, the ribbon setting appears with this component.
      Width	The number of columns that the component occupies in the ribbon. The width of the page is 12 columns. When using multiple components, the total combined width of all the components must equal 12 or less. Note: For CSM Configurable Workspace, set the width of the ribbon component on the Ribbon Configuration Setting form (see step 3).
      Application	The scope of this ribbon. Global means the ribbon works with all applications.
      Order	The location of this component in the ribbon. Ordering the components goes from left to right. For example, if you associate three components with a table, the component with the lowest order appears on the left and the component with the highest order appears on the right. Note: For CSM Configurable Workspace, set the order of the ribbon component on the Ribbon Configuration Setting form (see step 3).
      Active	Toggle to turn this component on or off in the ribbon for this table.
      Inherit	If set to true, the ribbon configuration can be inherited by child tables. For this to be effective, a child table shouldn’t have any configured ribbon settings. The Inherit field is false by default.
      Experience restricted	If set to true, the ribbon component is restricted to Configurable Workspaces. If set to false, the ribbon component is global and appears in CSM Agent Workspace (legacy). This field is set to true by default.

   4. Select Submit.
2. Create a ribbon configuration as a container for your ribbon setting.
   1. Navigate to Now Experience Framework > Configuration Settings > UX Ribbon Configurations.
   2. Select New.
   3. Fill in the fields on the UX Ribbon Configuration form.

      Table 2. UX Ribbon Configurations form

      Field	Description
      Name	Unique name for this ribbon configuration.
      Application	The scope of this ribbon configuration. Global means the ribbon works with all applications.
      Active	Toggle to turn this component on/off in the ribbon for this table.
      Description	Short description of this ribbon configuration that displays in the UX Ribbon Configurations list.

   4. Select Submit.
3. Add the ribbon setting to the ribbon configuration.
   1. Navigate to Now Experience Framework > Configuration Settings > Ribbon Configuration Settings.
   2. Select the configuration from the UX Ribbon Configurations list.
   3. Fill in the fields on the Ribbon Configuration Setting form.

      Table 3. Ribbon Configurations Settings form

      Field	Description
      Table	The table associated with this ribbon setting. Anytime an agent selects a record from this table, the ribbon setting appears with this component.
      Ribbon	The ribbon setting to add to the ribbon configuration.
      Configuration	The desired ribbon configuration.
      Application	The scope of this ribbon. Global means the ribbon works with all applications.
      Order	The location of this component in the ribbon. Ordering the components goes from left to right. For example, if you associate three components with a table, the component with the lowest order appears on the left and the component with the highest order appears on the right.
      Width	The number of columns the component occupies in the ribbon. The width of the page is 12 columns. When using multiple components, the total combined width of all the components must equal 12 or less. Note: The width is ignored if the ribbon is configured to display in the contextual side panel.
      Active	Toggle to turn this component on/off in the ribbon for this table.

   4. Select Submit.

What to do next

You can display the form ribbon at the top of the form or in the Contextual side panel. For more information, see the following topics:

• CSM Configurable Workspace form ribbon and components
• Display the form ribbon and form header secondary values in the Contextual side panel