Pre-Upgrade Information

The instructions provided in this section relate to upgrading the Base Application, SuMo, from v5.56.x to 6.24.x and the Motivate Extension Package from Version 1.12 to 2.0. Installations on any SuMo version below v5.56.x, must first upgrade to the latest v5 release (see Note below for specific version details) before starting the upgrade process. Failure to do so may result in an incomplete or incorrectly configured installation.

The majority of the upgrade process is automated and instructions on how to initiate this process are included in the Automated Upgrade section of this page. Once the automated upgrade process has successfully completed, you should follow the Post-Upgrade Steps which need to be performed in order complete the upgrade process.

Pre-Upgrade checks

Ensure that all Targeted Competitions have Finished before beginning the upgrade process. Finished and Declared competitions will be set to Archived (note that the competitors' scores and rank positions will be retained and reward records will not be deleted, but they will not benefit from the new v6 features which associates Rewards earned with the Competition from which they were derived).

All Level Sets (not just those that are active) will be converted to Experience Groups. The members currently within those level sets will be created as Members of the equivalent Experience Group. Behaviours (determined from the Rewards already earned by the members) will also be created for Experience Groups derived from Level Sets. All Reward records earned by those members will then be associated to the Behaviours and Members in the Experience Group.

Achievements (Behaviours in v6) that are In Progress will not retain the aggregate value tracking and will therefore start tracking again from zero following the upgrade. The upgrade should therefore be scheduled for a point in time where active tracking of aggregate Achievements (outside of Competitions) has completed or does not need to be rolled over into the next period.

Group Competitions will be converted to Experience Groups. The members currently within those level sets will be created as Members of the equivalent Experience Group. No Behaviours or Reward records will be associated to Experience Groups derived from Group Competitions.

Ideally, make sure there aren't any Seed Achievements in use, because to take full advantage of the new Version 6 functionality, a Seed Data Overwrite is required as part of the Post-Upgrade steps later in this documentation. Seed Achievements which have been edited and are being used (i.e. are Active) can be cloned prior to upgrade in order to ensure that changes to the seed Achievements (Base Behaviours in v6) can be reviewed following the upgrade.

Batch Assessment Achievements are being deprecated in this release. Therefore, Achievements set to "Every time the Object's Batch Assessment is run" should be replaced with Scheduled Achievements before upgrading.

Automated Upgrade

Upgrade the Base Application

To upgrade the Motivate base app from version 5 to version 6, there are two phases prior to continuing with the Post-Upgrade Steps: Upgrade to v6.24.12 followed by Upgrade to the Version 6 Release 4 package.

You should have already been provided with the two URLs for these two phases; please contact CloudApps if you have not received them.

To begin the installation process, click on the first URL link for upgrading to SuMo for Salesforce v6.24.12 (or paste the URL into your browser address bar); please ensure that you install this version before attempting to install the SuMo for Salesforce Version 6 Release 4 package.

If you aren't already logged in, you will be re-directed to the Salesforce.com login screen and prompted to enter login credentials for the org into which you wish to install the application. Log in using your System Administrator credentials to begin the installation.

Following a successful login you will be presented with the Package Upgrade screen.

1. Select the Install for Admins Only radio button
2. If you would like to see the full details, click on the View Components and API Access links at the bottom of the screen.
3. Click the Upgrade button:
   Image Removed
   The upgrade usually takes several minutes to complete, and you will typically see a message indicating this. In these circumstances you will receive an email notification message once the upgrade has completed.
4. Repeat the above steps in order to upgrade to the SuMo for Salesforce Version 6 Release 4 package.

Upgrade Motivate

You should have already been provided with a URL for upgrading the Motivate extension package. Please contact NewVoiceMedia if you have not received this.

To begin the upgrade process, click on the URL link (or paste the URL into your browser address bar) and click Upgrade:

Image Removed

Once the upgrade has completed, you will be able to continue with the Post-Upgrade Steps.

Post-Upgrade Steps

Prior to using the product, it is necessary for a System Administrator to customise certain aspects of the application that cannot be done automatically during the package upgrade. The steps are necessary due to the changes that have been introduced in this version.

Automated Setup

To automatically set up items that cannot be carried out by the Salesforce update process:

1. Enter Setup by clicking on the Setup link at the top of the screen
2. Within the sidebar select Build | Installed Packages
3. Click on Configure next to the Motivate package name
4. On the Application Configuration page, expand the Installation & Upgrade section
5. Click Run next to Automated Setup
   Image Removed

Update Seed Data

The Seed Data has been modified for Version 2, and the Version 1 Seed Data will need to be overwritten to benefit from new functionality introduced.

Within the same Installation & Upgrade section as above:

1. Select the Update (overwrite) checkbox
2. Click Run next to Seed Content Management:
   Image Removed

Motivate App tabs

If any of the Motivation Designers have customised their own Motivate Application tabs, they will not see the tab updates that were deployed by the Automated Setup routine (performed above). As a consequence they will not see either the Competitions or Experience Tabs and will instead see a Collectives tab. We therefore recommend that the following steps to overwrite their custom tabs should be performed; each user will then need to customise their tabs again, if required.

1. Within the sidebar select Build | Create | Apps
2. Click Edit next to Motivate
3. Select the Overwrite Users' Personal Custom App Customizations checkbox:
   Image Removed
4. Select which Profiles the tabs should be assigned to
5. Click Save

...

Follow these steps to update the tab styles used within the Motivate app, as they cannot be updated during the upgrade process. Updating the tab styles will ensure that the tabs display correctly in both the Salesforce Classic UI and the Lightning Experience user interface.

Custom Object Tabs

1. Within the sidebar select Build | Create | Tabs
2. Under the Custom Object Tabs section, click Del in the Action column to delete the Challenges and Competition Performance tabs
   Image Removed
3. Click Edit next to Base Behaviours
4. Next to Tab Style click the Lookup button
5. Click on the style Star
6. Click Save
7. Repeat steps 3-6 for the remaining tab styles as follows:
   • Collectives - change to style Hexagon
   • Graphics - change to style Camera
   • Player Performance - change to style Measuring Tape
   • Rewards - change to style Ticket
8. The Custom Object Tabs section should now be as follows:
   Image Removed

Web Tabs

1. Under the Web Tabs section, click Edit next to Gallery
2. On the next screen, leave the 2 columns with salesforce.com sidebar option selected, click Next
3.  From the Tab Style lookup, select Jewel
4. Click Next
5. Click Save
   Image Removed

Visualforce Tabs

1. Under the Visualforce Tabs section, click Delete next to Objectives
2. As within the Custom Object Tabs section above, edit the following 4 styles:
   • Administration - change to Wrench
   • Launch Inspire - change to TV Widescreen
   • Motivate (the second one in the list) - change to People
   • Motivate1 - change to People
3. The Visualforce Tabs section should now be as follows:
   Image Removed

Motivation Designer - Supplementary Permission Set

The "Motivation Designer (Supplementary)" permission set requires one additional record type permission that cannot be assigned automatically during the Upgrade process.

1. In the Salesforce Setup, within the sidebar navigate to Administer | Manage Users | Permission Sets
2. Click on the Permission Set name Motivation Designer (Supplementary)
3. Click on the Object Settings link
4. Click on the Collectives object name
5. Click Edit and, under Collective: Record Type Assignments add Template to the assigned record types (Competition and Experience Group should already be assigned; if they aren't, then please also assign these now):
   Image Removed
6. De-select the Objective record type (this is no longer required)
7. Click the Save button

Object Page Layouts & Assignment

Collectives page layout

1. In Salesforce Setup, within the sidebar select Build | Create | Objects
2. Click on the Collective link
3. Go to the Page Layouts section and click the Page Layout Assignment button
4. Click the Edit Assignment button
5. Select all the items in the Experience Group column:
   Image Removed
6. Select Experience Group Layout from the Page Layout To Use picklist
7. Click Save

Behaviours Page Layout

To prevent saving Behaviour records without a linked Base Behaviour (which will ensure data integrity):

1. Within the sidebar select Build | Create | Objects
2. Click on the Behaviour link
3. Go to the Page Layouts section and click Edit next to the Team Achievement Layout page layout
4. Click the Properties icon (spanner) beside the Base Behaviour field and select the "Required" checkbox
   Image Removed
5. Click OK
6. Click Save

Base Behaviour Page Layout

1. Within the sidebar select Build | Create | Objects
2. Click on the Base Behaviour link
3. Go to the Field Sets section and click Edit next to the Information field set name
4. Move the Undesirable field from the end of the list, to between Channel and Experience Group and move Comments to the end of the list as shown in the screenshot below
   Image Removed
5. If the Promoted field is within this Field Set, we suggest removing it. The Promoted value is best set on the Behaviour itself (with the default always starting as un-promoted).
6. Click Save

Player Performance page layout

1. Within the sidebar select Build | Create | Objects
2. Click on the Player Performance link
3. Go to the Page Layouts section and click the Page Layout Assignment button
4. Click the Edit Assignment button
5. Select all the items in the Page Layout column:
   Image Removed
6. Select Performance Layout from the Page Layout To Use picklist
7. Click Save

User page layout

1. Within the sidebar select Build | Customize | Users | Page Layouts
2. In the User Page Layouts section, click on the Edit link next to the Page Layout Name for the layout assigned to Users that have been set up as Motivate Users
3. Scroll down to the Motivate section
4. Remove any of the Deprecated fields that are on the page, ie:
   • Level - DEPRECATED
   • Experience - DEPRECATED
   • Last Game Reset - DEPRECATED
   • Set Id - DEPRECATED (this may not be on the page layout
5. Repeat steps 2-4 for any other User Page Layouts, if required

Subtab App

1. Within the sidebar select Build | Create | Apps
2. Under the Subtab Apps section, click Edit next to Profile (Self)
3. In the Selected Tabs list, select Challenges and remove it (so that it appears in the Available Tabs list)
   Image Removed
4. Click the Save button to complete the task and save your changes

Post-Upgrade configuration

Leaderboard Trends & Performance History

If "Leaderboard Trends" were enabled in version 1, they will need to be re-enabled following the upgrade. A new combined function ("History & Trend Frequency" available on the Administration Tab) now also records each Player's score in order to populate their Performance History Chart with historical performance data. This function was performed separately in version 1, but has now been incorporated into a single function in version 2 for simplicity and ease of management.

Inspire sample Channel "Motivation"

...