Merge pull request #92 from OfficeDev/v2.1/cmp-new-features-bug-fixes

v2.1 release changes

Wiki/Deployment-Guide.md

@@ -69,6 +69,8 @@ Continuing below steps you can take the cmp.sppkg file from the ***cmp.sppkg***
 
 ### Deploy your Package to SharePoint
 
+<b>IMPORTANT NOTE:</b> If you have just created a new tenant please wait for around 15 minutes before starting with the below steps.
+
 1.	Open SharePoint and sign in using the administrator account. Click on the "dots" icon in the top left corner of the banner.
  <br/>
 
@@ -119,7 +121,7 @@ Continuing below steps you can take the cmp.sppkg file from the ***cmp.sppkg***
 10.	A confirmation dialog is displayed. Ensure the checkbox for "Make this solution available to all sites in the organization" is chosen and click ***Deploy***.
   <br/>
 
-![Quick Start Guide](../Images/Upgrade2.0-2.png) 
+![Quick Start Guide](../Images/Upgrade-2.png) 
 <br/>
 11.	Return to the ***SharePoint admin center***. Under expand the ***Advanced*** menu in the left navigation and select ***API access***. Select and approve all pending requests associated with ***championmanagement***
   <br/>
@@ -128,11 +130,14 @@ Continuing below steps you can take the cmp.sppkg file from the ***cmp.sppkg***
 <br/>
 12.	Return to app list in the App Catalog and select the ***championmanagement*** app. Select the Files tab in the ribbon and click the ***Sync to Teams*** button.
   <br/>
+
 
 ![Quick Start Guide](../Images/SyncToTeams.png) 
 <br/>
 
-### First Run Experience:Add ***Champion Management Platform*** Tab in Teams
+### First Run Experience:Add ***Champion Management Platform*** Tab in Teamst
+
+<b>IMPORTANT NOTE:</b> Please wait for around 20 minutes for API access approvals done in the previous section to take effect before proceeding with the below steps.
 
 1.	Navigate to Microsoft teams, select the Team and channel where you want to install Champion Management Platform. Click ***Add a tab***, choose ***Champion Management Platform*** from the app list, and Save. (Search for Champion)
 
@@ -146,11 +151,21 @@ This first run experience needs to be completed by the person who will be an adm
 ![Quick Start Guide](../Images/AddTab_ChampionAdd.png) 
 
 2. Click 'Add' to create the ***'Champion Management Platform'*** tab to your Teams (Alternately you can also just load the app as a personal app in the left rail here too).
-3. The landing page for an Admin will have access to the *Champion Leaderboard, Digital Badge, Enable Tournament of Teams* and the SharePoint lists (*Champions, Events,Event track Details, Digital Badges*), as well as Manage Approvals.
+3. After clicking on 'Add', the app set up will start and you will see a spinner as shown below. The set up may take around 1-2 minutes.<br/>
+![App Set Up](../Images/AppLoading.png)
+4. After the set up is complete a success message is shown as below. The below snapshot is from Teams in browser. The same message would look different in Teams client.
+<br/>
+![App Set Up](../Images/SuccessMessage.png) 
+5. On clicking 'OK' the landing page is displayed. <br />
+![App Set Up](../Images/AddTab_Teams.png)
+6. If you still see the spinner message and do not see the success message even after 2 minutes or if you see any error alerts, try clicking on refresh icon on top right. If you see the landing page with all the icons shown in the above picture the app set up is complete.<br />
+![App Set Up](../Images/Apprefresh.png)
+If you still do not see the landing page after refresh please create an issue in the Github.
+7. The landing page for an Admin will have access to the *Champion Leaderboard, Digital Badge, Enable Tournament of Teams* and the SharePoint lists (*Champions, Events,Event track Details, Digital Badges*), as well as Manage Approvals.
   <br/>
 
 ![Quick Start Guide](../Images/AddTab_Teams.png) 
-4. Grant Permissions to users:
+8. Grant Permissions to users:
 
 · Navigate to the URL for the Champion Management Platform site as the administrator. 
 

Wiki/Release-Notes.md

@@ -3,13 +3,26 @@ This page contains the different release details for Champion Management Platfor
 ## Version history
 | Version | Release Date |
 |----|----|
+| 2.1 | Apr 4, 2022 |
 | 2.0 | Dec 9, 2021 |
 | 1.3 | Sep 03, 2021 |
 | 1.2 | Jul 22, 2021 |
 | 1.1 | Apr 1, 2021 |
 
 ## Release notes
 
+### 2.1 (Apr 4, 2022)
+
+Below improvements released,
+
+- Bug Fix: Addressed an issue with tournament ranks/points not getting updated correctly for some customers within the Tournament of Teams leaderboard.
+- New Feature: Multi-Tournament support within the Tournament of Teams module. Organizations can now have multiple tournaments occurring at one time
+- New Feature: Introduced image preview feature for the Digital Badge module. Users can now preview their profile pictures with different badges available to them before applying it.
+- New Feature: Implemented the Digital Badge feature native to Tournament of Teams. Users can now use the Digital Badge feature without being added as a member of the Champion Management Platform.
+- New Feature: Implemented an ability that allows admins to update the logo of the Champion Management Platform that sits in the top application bar. Admins will now see a new icon "Manage App Logo" under the "Admin" section in the home page of the App. Upon replacing the image in the SharePoint library, the new app logo will be shown.
+- New Feature: Implemented multilingual support for the application. English support at the moment
+- Other Changes: Minor UI fixes.
+
 ### 2.0 (Dec 9, 2021)
 
 Below improvements released,

Wiki/Solution-Overview.md

@@ -57,13 +57,21 @@ Admin and current Champions of the program can nominate(***Add Members***) peers
 
 The Admin can approve/Reject the champion nominations using Manage Approvals screen. 
 
+### Manage App Logo
+![ManageAppLogo](../Images/ManageAppLogo.png)     
+"Manage App Logo" option can be found under "Admin Tools" section on home page. Clicking on this icon opens the "CMP Logo" SharePoint library. New image can be uploaded to the library to replace the App logo. The new image needs to have below specifications:
+
+Name: AppLogo.jpg<br/>
+Type: JPG<br/>
+Dimensions: 32 X 32 <br/><br/>
+
 ### Digital Badge ![Champion logo](../Images/Champion_small.png)
 Digital Badge is intended to allow Microsoft 365 Champions to apply a ‘Champion’ badge on their profile image. It provides an easy and seamless process to share the recognition as a champion with the team.
  <br/>
 
 ![Quick Start Guide](../Images/Digitalbadge.png) 
 
-CMP administrators can upload multiple badges in the “Digital Badge Assets” library in the share point site. Champions can select from multiple badges and apply on their profile picture. 
+CMP administrators can upload multiple badges in the “Digital Badge Assets” library in the share point site. Champions can select from multiple badges, preview the profile picture and apply on their profile picture. 
 <br/><br/>
 ![Quick Start Guide](../Images/MultipleBadges.png) 
 

Wiki/Tournament-of-Teams.md

@@ -6,7 +6,13 @@ Tournament of Teams is not enabled by default. CMP admin needs to enable it from
 
 On enabling “Tournament of Teams”: 
 
-1. The lists are provisioned in the CMP share point site 
+1. Below lists are provisioned in the CMP share point site:
+
+> * Actions List
+> * ToT Admins
+> * Tournament Actions
+> * Tournaments
+> * User Actions
 
 2. “Tournament of Teams” link is visible under “Quick Start Guide” section of CMP home page. This link navigates the users to “Tournament of Teams” landing page. 
 
@@ -35,26 +41,33 @@ Below are the master lists in Share Point that need to be managed by the TOT Adm
 
 ![Quick Start Guide](../Images/CreateTournament.png) 
 
-### Start/End Tournament 
+### Manage Tournaments 
+
+ - A tournament can be started or ended by an admin using “Manage Tournaments” screen. 
 
- - A tournament can be started or ended by an admin using “Start/End Tournament” screen. 
+ - Multiple tournaments can be can be active at a time. 
 
- - Only one tournament can be active at a time. To start a new tournament the active tournament must be ended. 
 
 ![Quick Start Guide](../Images/ManageTournament.png) 
 
 ### My Dashboard
 
-- Champions can start participating in the active tournament using “My Dashboard”.  
+- Champions can start participating in any of the active tournaments using “My Dashboard”.  
+
+- Champions can select the tournament from either "My Tournaments" or "Active Tournaments" dropdown list. If a user has participated in any of the active tournaments already they will be listed under "My Tournaments" list. All the other active tournaments will be listed under "Active Tournaments" list.
 
-- “My Dashboard” shows the Teams Actions available in the current active tournament. The champions can select the completed actions and save to earn points and a rank in that tournament which is displayed on the left side section of the page. 
+- “My Dashboard” will show the Teams Actions available in the selected tournament. The champions can select the completed actions and save to earn points and a rank in that tournament which is displayed on the left side section of the page. 
+
+- By default, the first tournament in the "My Tournaments" will be selected. If the user has not participated in any of the tournaments yet, first tournament in the "Active Tournaments" will be selected.
 
 - The users must complete at least one action to be considered as a participant in that tournament. The ranks are calculated only among the participants. 
 
 ![Quick Start Guide](../Images/MyDashboard.png) 
 
 ### Leaderboard
 
-Leader board is available to everyone. It shows the list of all participants in the current active tournament along with their points and ranks. 
+- Leader board is available to everyone. It shows the list of all participants in the selected active tournament along with their points and ranks. 
+- By default, the first tournament in the "My Tournaments" will be selected. If the user has not participated in any of the tournaments yet, first tournament in the "Active Tournaments" will be selected.
+
 
 ![Quick Start Guide](../Images/TOTLeaderBoard.png) 

Wiki/Upgrade.md

@@ -1,33 +1,37 @@
-### Upgrade to version 2.0 from 1.3 and 1.2
+### Upgrade to version 2.1 from 2.0, 1.3 and 1.2
 
-If you are already having version 1.3 or 1.2 installed on your tenant follow the below steps to upgrade to version 2.0:
+If you are already having version 2.0, 1.3 or 1.2 installed on your tenant follow the below steps to upgrade to version 2.1 with an admin account:
 
-1.  Navigate to App Catalog with a tenant Admin account. Do not delete the existing  1.3 or 1.2 package. Upload the new package that is downloaded from "sharepoint/solution" folder which will replace the existing package.  
+1.  Navigate to App Catalog with a tenant Admin account. Do not delete the existing package. Upload the new package that is downloaded from "sharepoint/solution" folder which will replace the existing package.  
 
-![Upgrade 1.3](../Images/Upgrade2.0-1.png) 
+![Upgrade 1.3](../Images/Upgrade-1.png) 
 
 2. Click on "Deploy".
 
-![Upgrade 1.3](../Images/Upgrade2.0-2.png) 
+![Upgrade 1.3](../Images/Upgrade-2.png) 
 
 3. "Check In" the package.
 
 ![Upgrade 1.3](../Images/Upgrade2.0-3.png) 
 
-4. Select the package and click "Sync to Teams" from the ribbon and wait for the "Successfully synced to teams solution" message to appear
+4. Select the package and click "Sync to Teams" from the ribbon and wait for the "Successfully synced to teams solution" message to appear.
 
-![Upgrade 1.3](../Images/SyncToTeams.png) 
+![SyncToTeams](../Images/SyncToTeams.png) 
 
-5. Navigate to SharePoint admin center. Under Advanced menu in the left navigation select API access. Select and approve the additional pending request associated with championmanagement as shown below. 
-After approving the permission, it would take some time for it to take effect. 
+5. The Champion Management Platform will be updated to the latest version and you will see changes reflected in Teams. Please note that if you do not see changes reflected in Teams after 30 minutes you can log out and back in and clear the Teams cache to see changes immediately. 
 
-![Upgrade 1.3](../Images/Upgrade2.0-4.png) 
+6. If you already had "Tournament of Teams" enabled before the upgrade, click on "Enable Tournament of Teams" under "Admin Tools" section again. This is to upgrade the Tournament of Teams module which includes the bug fix for inaccurate tournament rankings and points. "Tournament of Teams" icon will not be visible in the "Get Started" section without this step.
+NOTE: If there is any active tournament before the upgrade the leader board will show emails instead of User Display Names after the upgrade. This will not happen for new users or new tournaments. 
 
-6. The Champion Management Platform will be updated to the latest version and you will see changes reflected in Teams. Please note that if you do not see changes reflected in Teams after 30 minutes you can log out and back in and clear the Teams cache to see changes immediately. 
+![Upgrade-3](../Images/Upgrade-3.png) 
 
-### Upgrade to version 2.0 from 1.1
+7. The below graph permission can be removed from "API Permissions" in sharePoint admin portal only if this permission is not used in any other apps in your tenant. The upgraded package for CMP is not using this API anymore.
 
-If you are already having 1.1 installed on your tenant and want to upgrade to 2.0 the existing app and SharePoint site 'ChampionManagementSite' have to be deleted. 
+![Upgrade-4](../Images/Upgrade-4.png) 
+
+### Upgrade to version 2.1 from 1.1
+
+If you are already having 1.1 installed on your tenant and want to upgrade to 2.1 the existing app and SharePoint site 'ChampionManagementSite' have to be deleted. 
 
 If you have current members and events you will want to export those list items and import re-import them into the respective list areas. We have expanded our lists to have some additional data as well so you may need to populate additional fields. 
 

config/package-solution.json

@@ -3,7 +3,7 @@
   "solution": {
     "name": "championmanagement",
     "id": "5099a3ef-113f-4baf-bb6a-a73b1dd286f8",
-    "version": "2.0.0.0",
+    "version": "2.1.0.0",
     "includeClientSideAssets": true,
     "skipFeatureDeployment": true,
     "isDomainIsolated": false,"developer": {
@@ -25,12 +25,7 @@
        {
         "resource": "Microsoft Graph",
         "scope": "Sites.Manage.All"
-       },
-       {
-        "resource": "Microsoft Graph",
-        "scope": "User.ReadBasic.All"
-       }
-
+       }       
       ]
 
   },

gulpfile.js

@@ -18,7 +18,14 @@ build.configureWebpack.mergeConfig({
     }
 
 });
+var getTasks = build.rig.getTasks;
+build.rig.getTasks = function () {
+  var result = getTasks.call(build.rig);
 
+  result.set('serve', result.get('serve-deprecated'));
+
+  return result;
+};
 build.initialize(gulp);
 
 build.configureWebpack.mergeConfig({

package.json

@@ -41,15 +41,19 @@
     "bootstrap": "^4.6.0",
     "classnames": "^2.3.1",
     "ejs": "^3.1.6",
+    "follow-redirects": "^1.14.7",
     "gulp-update": "0.0.2",
     "immer": "^9.0.6",
     "jquery": "^3.6.0",
     "loadash": "^1.0.0",
     "lodash": "^4.17.20",
     "lodash.template": "^4.5.0",
     "merge": "^2.1.1",
+    "minimist": "^1.2.6",
     "moment": "^2.29.1",
     "msteams-ui-components-react": "^0.5.0",
+    "node-fetch": "^2.6.7",
+    "node-forge": "^1.3.0",
     "nodemon": "1.12.1",
     "office-ui-fabric-react": "6.189.2",
     "popper.js": "^1.16.1",
@@ -69,6 +73,7 @@
     "rxjs": "^6.6.7",
     "typescript": "^4.4.4",
     "typestyle": "1.5.1",
+    "url-parse": "^1.5.6",
     "webpack": "^1.15.0"
   },
   "resolutions": {
@@ -84,9 +89,11 @@
     "ansi-html": "https://registry.yarnpkg.com/ansi-html-community/-/ansi-html-community-0.0.8.tgz#69fbc4d6ccbe383f9736934ae34c3f8290f1bf41",
     "browserslist": "4.16.5",
     "css-what": "5.0.1",
-    "minimist": "0.2.1",
+    "minimist": "1.2.6",
     "ansi-regex": "^5.0.1",
-    "json-schema": "^0.4.0"
+    "json-schema": "^0.4.0",
+    "node-fetch": "2.6.7",
+    "node-forge": "^1.3.0"   
   },
   "devDependencies": {
     "@microsoft/rush-stack-compiler-2.9": "0.7.16",