Sumo Customisation
Updated over a week ago

This section details how to customise the Salesforce Classic and Lightning User Interface (UI) to include components that are available in the Sumo application. These steps are optional and not all of the components need to be enabled in order to use the application. Note that the Lightning UI components can be configured to be used in multiple areas throughout the org; however, the instructions provided here will only describe how to configure these components on Object Page Layouts, the Utility Bar and on the Performance Centre page.

Salesforce Lightning

In order to configure the Lightning UI components that are discussed below, customers are required to first set up and deploy Salesforce's My Domain feature. Customers who do not enable this feature will not be able to perform the setup steps that are detailed in this section. However, once My Domain has been set up for the org, customers will be able to access the Lightning components that are contained in Sumo and configure them as required.

Tip: Details on what My Domain is and how it can be enabled and configured can be found in this Salesforce Help article: https://help.salesforce.com/articleView?id=domain_name_overview.htm&type=0

Object Page Layouts

The following operations can be performed for each of the page layouts on each of the following objects: Accounts, Campaigns, Contacts, Leads, Opportunities, Cases, Contracts, Solutions, Events and Tasks. Customers are required to add the same Lightning component to each of the object record pages as the components are context aware, they will return the appropriate data based on the current object.

The following steps are specifically for the Account page layout; however, the same steps can be repeated for the other page layouts using the same Lightning components.

Note: It is recommended that the Classic Visualforce In-line components are removed from the object page layouts so that they are not visible in Lightning Experience in addition to the Lightning version of the components.

In order to add the Lightning components to each page layout, customers will need to be running in Lightning Experience in order to access the Lightning App Builder.

  1. Navigate to any Account record, click on the Setup button and then click on Edit Page

  2. In the Lightning App Builder within the left-side Lightning Components list, locate the Behaviours component under the Custom - Managed section

  3. Drag the Behaviours component onto the page layout and drop it onto a suitable position within the narrow area of the layout (as shown below).

  4. Repeat the same process for the Trophy Cabinet, and position the component above or below the Behaviours component.

Account_record_page_Lightning_components.png
Account_record_page_Lightning_component2.png
  1. Click the Save button to complete the task and save your changes to the page layout

  2. Repeat these steps for the Page Layouts for any of the following Objects as required:

    • Activities - Events

    • Activities - Tasks

    • Campaigns

    • Leads

    • Contacts

    • Opportunities

    • Cases

    • Contracts

    • Solutions

Utility Bar

For each Lightning app that is available to users, customers are able to configure the Utility Bar to include the Performance Stream component. When users are in an app that has the Utility Bar configured, they will have access to the Performance Stream at all times.

Info: The Performance Stream component is designed specifically for the Utility Bar, therefore it is not recommended that this component is deployed on any Lightning App, Home or Record pages.

The following steps detail how the Performance Stream can be added to the Utility Bar in the Sales (Lightning) app; however, the same steps can be repeated to configure the Utility Bar in other Lightning apps.

In order to add the Performance Stream component to the Utility Bar, customers will need to be running in Lightning Experience in order to access the Lightning Experience App Manager.

  1. Click on the Setup button at the top of the screen and then click on the Setup link

  2. Within the sidebar under Platform Tools | Apps click on App Manager

  3. Locate the Lightning version of the Sales app, then select Edit link from the dropdown list

  4. In the App Settings page, click on Utility Items tab

  5. Click the Add Utility Item button and select the Performance Stream from the Custom - Managed section

Performance_Stream_utility_bar.png
  1. In the Properties of the Performance Stream, under Icon click on the cross next to the icon image to remove it

  2. Click on the Choose Icon button, and in the Choose Utility Icon window, select the icon named 'feed'.

  3. Leave the Panel Width and Panel Height as the default values.

  4. Select the Start automatically checkbox

  5. Click the Save button to complete the task and save your changes to the Utility Bar

Toast Notifications

For Sumo Players to receive Toast Notifications in Lightning Experience when they have earned a Reward, customers must follow the steps below in order to configure the URL Settings in the Application Configuration page. The steps below describe how to configure the Toast Notifications when in Lightning Experience; however, the steps can be carried out in either Salesforce Classic or Lightning Experience.

Note: The Performance Stream must be configured as described above in order for the Toast Notifications to function.

  1. Click on the Setup button at the top of the screen and then click on the Setup link

  2. Within the sidebar under Platform Tools | Apps click on Installed Packages

  3. Click Configure next to the Sumo package

  4. Expand the Configuration section, and then locate the URL Settings

  5. In the Domain field, enter the domain name of the org in the format: https://domain.lightning.force.com replacing domain with the domain that the org is using. This information can be found by inspecting the URL in the Address Bar of your Web Browser

Note: Ensure that https:// is set at the beginning of the Domain field and no characters are present at the end of the domain, i.e. after the .com or other specified domain extension.

  1. Click the Save button to complete the task and set the Domain URL

  2. Log out of the org immediately and then log back in

Performance Centre

The Performance Centre is the main page from where Sumo Players can monitor their performance in real time. The following steps describe how this page can be created using a specific Lightning Custom Layout that is provided in this release, and then configured by adding the new Lightning Sumo Player UI components.

Info: Following these steps will provide Sumo Players access to the Performance Centre on a Desktop. If access is required on Mobile and Tablet devices via Salesforce1, please see the Salesforce1 Setup page.

  1. Click on the Setup button at the top of the screen and then click on the Setup link

  2. Within the sidebar under Platform Tools | User Interface click on Lightning App Builder

  3. Click on the New button

  4. Select App Page and then click the Next button

  5. In the Label field, enter Performance Centre and then click the Next button

  6. Under the Custom section in the left-side, select Performance Centre Template and then click the Finish button

  7. In the Lightning App Builder, drag and drop the following Lightning Sumo Player UI components onto the Performance Centre page as shown below:

    • Scoreboard

    • Leaderboard

    • Trophy Cabinet

    • Behaviours

    • Behaviour Progress

Performance_Centre_layout.png
  1. Once the components have been added to the Performance Centre page, click on the Save button

  2. In the Page Save modal that is displayed, click on the Activate button

  3. In the Activation modal under the Page Settings tab, click on the Change... link next to the Icon

  4. In the Select an icon modal, locate and click on the Radar Dish icon

    Performance_Centre_icon.png
  5. In the Activation modal under the Lightning Experience tab, select the Sales Lightning App in the left column, and then click on the Add page to app button to add the Performance Centre page to the right column

  6. In the right column, drag and drop the Performance Centre to the desired position that it will be displayed on the Tab bar

  7. Repeat steps 12 and 13 for all other Lightning Apps that require access to the Performance Centre page

  8. Click the Save button to return to the Lightning App Builder

  9. Click the Back button to complete the task and finish configuring the Performance Centre page

Manual Rewarding (Optional)

Follow the steps below to set up the Manual Rewarding functionality, which allows Sumo users with the required permission to award individual Sumo Players with Rewards and Badges. Once set up, those Sumo users with the required permission can generate Rewards using the Create Reward UI that is accessed via Chatter.

  1. Click on the Setup button at the top of the screen and then click on the Setup link

  2. Within the sidebar under Platform Tools | User Interface | Global Actions click on Publisher Layouts

  3. Click Edit next to Global Layout

  4. In the Global Layout section at the top of the page, click on Mobile & Lightning Actions:

Manual_rewards_Mobile_and_Lightning_actions.png

Info: You may be required to override the predefined actions in Salesforce Mobile & Lightning Experience Actions in order to add the Create Reward action. If this is performed, please remove the currently added Create Reward (success__Manual_Rewards_Classic) action that is inherited via the override before continuing.

  1. Locate Create Reward and drag it onto the Salesforce Mobile & Lightning Experience Actions Global Publisher:

Manual_rewards_Publisher_Lightning.png
  1. Click the Save button to complete the task and save your changes to the Global Layout

  2. Within the sidebar select Administration | Users | click on Users

  3. Click on the name of the user who should be delegated the permission to use Manual Rewarding

  4. Under Permission Set Assignments click the Edit Assignments button

  5. In the Available Permission Sets list, add Create Manual Rewards to the Enabled Permission Sets list

  6. Click the Save button

Salesforce Classic

Object Page Layouts

The following operations can be performed for each of the page layouts on each object that has Visualforce In-line Components available. These objects are: Accounts, Campaigns, Contacts, Leads, Opportunities, Cases, Contracts, Solutions, Events and Tasks. Whilst the Visualforce component names vary by object they all follow the same naming format, which is "ObjectName Behaviours" and "ObjectName Rewards", e.g. "Account Behaviours" for the in-line Visualforce component that is available to display Behaviours on the Accounts standard page layout. Similarly, the standard layout pages all follow a similar naming convention, which is "ObjectName Layout".

The following steps are specifically for the Account page layout and in-line Visualforce components but can be repeated for the other page layouts when considering the naming rules described.

In order to add the Visualforce elements to each Page Layout, firstly make a copy of the Object's page layout. These new versions of the Object's page layout will be the versions that are provisioned (via User Profiles or Permission Sets) to Sumo Players:

  1. Enter Setup by clicking on the "Setup" link at the top of the screen

  2. Within the sidebar select Build | Customize | Accounts | Page Layouts

  3. Click Edit beside the Account Layout page layout

  4. Select "Save as..." from the Save menu at the top of the page

  5. Give the new layout a relevant name, e.g. "Account Layout - Sumo"

  6. Click Save

Then add the Visualforce elements to the new page layout; the recommended layout is as follows:

  1. Add a new section named Sumo at the top, just above Account Information.

  2. Uncheck Detail Page and Edit Page in the Section Properties, to set the header to hidden:

Object_page_SuMo_section.png
  1. Click OK

  2. In the Account Layout section at the top of the page, click on Visualforce Pages:

Account_page_layout_VF.png
  1. There will be two Visualforce elements listed, Account Behaviours and Account Rewards

  2. In turn, drag each of these elements from the Visualforce Pages list and drop the elements into the new Sumo section – Account Behaviours on the left and Account Rewards on the right.

Account_page_layout_drag.png
  1. Once both the Account Behaviours and Account Rewards elements are in position, hover the cursor over the Account Behaviours element and click the Properties icon that appears in the top-right corner:

Account_page_layout_resize_nudges.png
  1. In the resulting pop-up window, set the Height (in pixels) field to 80 and click OK:

Account_page_layout_height_80.png
  1. Repeat steps 7 and 8 for the Account Rewards element.

  2. Click the Save button to complete the task and save your changes to the page layout

  3. Repeat these steps for the Page Layouts for any of the following Objects as required:

    • Activities - Events

    • Activities - Tasks

    • Campaigns

    • Leads

    • Contacts

    • Opportunities

    • Cases

    • Contracts

    • Solutions

Home Page Layout

Sumo for Salesforce provides Summary Components that provide information for Players on their status and progression through the "competitions". Please follow the steps below to add any of these components to your organisation's Home Page layouts.

We recommend creating a separate Home Page Layout for users set up as "Sumo Players".

  1. Enter Setup by clicking on the Setup link at the top of the screen

  2. Within the sidebar select Build | Customize | Home | Home Page Layouts

  3. Click Edit beside the home page layout(s) that you wish to add the Sumo components to

  4. In the Select Wide Components to Show section, select Sumo Performance History if required

  5. In the Select Narrow Components to Show section, select any of the following components:

    • Sumo

    • Sumo Promotions

    • Sumo Performance *

    • Sumo Rewards *

    • Sumo Competitions *

Home_Page_Layout_select_components.png

Note: It is recommended that only the Sumo and Sumo Promotions components be selected in the Narrow Components section, as shown above; this is because the Sumo component incorporates the remaining 3 components (i.e. Sumo Performance, Sumo Rewards and Sumo Competitions).
​
When added to the Sidebar, the Sumo component will rotate through these three individual components. Alternatively, these three components can be added individually to be displayed in the Sidebar separately.

  1. Click Next to proceed to Step 2. Order the components

  2. In the Narrow (Left) Column list, order the components as required - ideally with the Sumo components at the top (so that they are always visible).

  3. In the Wide (Right) Column list, order the components as required:

Home_Page_Layout_order_components.jpg
  1. Click Save to complete the task and return to the Home Page Layout list view

  2. Repeat steps 3-9 for all the Home Page Layouts that should contain the Sumo summary components, and assign the modified Home Page to the Profile used by Sumo Players.

Customised Sidebar Display (Recommended)

Once the Home page layout and sidebar have been configured you have the option to display the customised sidebar (containing the Sumo components) alongside all pages or just on the home page. We recommend showing the customised sidebar components alongside all pages. Perform the following steps to configure this option:

  1. Enter Setup by clicking on the "Setup" link at the top of the screen

  2. Within the sidebar select Build | Customize | User Interface

  3. Within the "Sidebar" section, check the box "Show Custom Sidebar Components on All Pages".

  4. Click Save

Subtab Apps (Recommended)

  1. Enter Setup by clicking on the "Setup" link at the top of the screen

  2. Within the sidebar select Build | Create| Apps

  3. Under the Subtab Apps section, click Edit next to "Profile (Others)"

  4. In the Available Tabs list, select Motivate and Rewards and add them to Selected Tabs, adjusting the order as required - and optionally changing the Default Landing Tab to Motivate, e.g:

Profile_Others_tabs.png
  1. Click the Save button to complete the task and save your changes

  2. Then, also under the Subtab Apps section, click Edit next to "Profile (Self)"

  3. In the Available Tabs list, select Motivate, Rewards, Competitions and Behaviours, add them to the Selected Tabs list:

Profile_Self_tabs.png
  1. Adjust the order for display as required. The recommended order is:

    • Motivate

    • Rewards

    • Competitions

    • Behaviours

  2. Optionally change the Default Landing Tab to Motivate.

  3. Leave Show in Lightning Experience unchecked

  4. Click the Save button to complete the task and save your changes.

Manual Rewarding (Optional)

Follow the steps below to set up the Manual Rewarding functionality, which allows Sumo users with the required permission to award individual Sumo Players with Rewards and Badges. Once set up, those Sumo users with the required permission can generate Rewards using the Create Reward UI that is accessed via Chatter.

  1. Enter Setup by clicking on the "Setup" link at the top of the screen

  2. Within the sidebar select Build | Create | Global Actions | Publisher Layouts

  3. Click Edit next to Global Layout

  4. In the Global Layout section at the top of the page, click on Quick Actions:

Manual_rewards_Quick_Actions.png
  1. Locate Create Reward and drag it onto the Salesforce Classic Publisher Global Publisher:

Manual_rewards_Publisher.png
  1. Click the Save button to complete the task and save your changes to the Global Layout

  2. Within the sidebar select Administer | Manage Users | Users

  3. Click on the name of the user who should be delegated the permission to use Manual Rewarding

  4. Under Permission Set Assignments click the Edit Assignments button

  5. In the Available Permission Sets list, add Create Manual Rewards to the Enabled Permission Sets list

  6. Click the Save button

The user who has been assigned the Create Manual Rewards Permission Set will also need their Role set as a Spectator in the collective, via the Competition Assistant or Experience Group Assistant.

Tip: After setting up Manual Rewarding, go to the Graphics tab and setup some Badges that are of type Manual Badge - only these Badges can be awarded to users via the Create Reward UI.

Did this answer your question?