2.5 Release (#189)

CMP 2.5 Release

.github/policies/resourceManagement.yml → .github/resourceManagement.yml

@@ -1,101 +1,101 @@
-id: 
-name: GitOps.PullRequestIssueManagement
-description: GitOps.PullRequestIssueManagement primitive
-owner: 
-resource: repository
-disabled: false
-where: 
-configuration:
-  resourceManagementConfiguration:
-    scheduledSearches:
-    - description: 
-      frequencies:
-      - hourly:
-          hour: 6
-      filters:
-      - isIssue
-      - isOpen
-      - hasLabel:
-          label: 'needs: author feedback'
-      - hasLabel:
-          label: 'status: no recent activity'
-      - noActivitySince:
-          days: 3
-      actions:
-      - closeIssue
-    - description: 
-      frequencies:
-      - hourly:
-          hour: 6
-      filters:
-      - isIssue
-      - isOpen
-      - hasLabel:
-          label: 'needs: author feedback'
-      - noActivitySince:
-          days: 3
-      - isNotLabeledWith:
-          label: 'status: no recent activity'
-      actions:
-      - addLabel:
-          label: 'status: no recent activity'
-      - addReply:
-          reply: This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for **4 days**. It will be closed if no further activity occurs **within 3 days of this comment**.
-    - description: 
-      frequencies:
-      - hourly:
-          hour: 6
-      filters:
-      - isIssue
-      - isOpen
-      - hasLabel:
-          label: duplicate
-      - noActivitySince:
-          days: 1
-      actions:
-      - addReply:
-          reply: This issue has been marked as duplicate and has not had any activity for **1 day**. It will be closed for housekeeping purposes.
-      - closeIssue
-    eventResponderTasks:
-    - if:
-      - payloadType: Issue_Comment
-      - isAction:
-          action: Created
-      - isActivitySender:
-          issueAuthor: True
-      - hasLabel:
-          label: 'needs: author feedback'
-      - isOpen
-      then:
-      - addLabel:
-          label: 'needs: attention :wave:'
-      - removeLabel:
-          label: 'needs: author feedback'
-      description: 
-    - if:
-      - payloadType: Issues
-      - not:
-          isAction:
-            action: Closed
-      - hasLabel:
-          label: 'status: no recent activity'
-      then:
-      - removeLabel:
-          label: 'status: no recent activity'
-      description: 
-    - if:
-      - payloadType: Issue_Comment
-      - hasLabel:
-          label: 'status: no recent activity'
-      then:
-      - removeLabel:
-          label: 'status: no recent activity'
-      description: 
-    - if:
-      - payloadType: Pull_Request
-      then:
-      - inPrLabel:
-          label: 'Status: In PR'
-      description: 
-onFailure: 
-onSuccess: 
+id: 
+name: GitOps.PullRequestIssueManagement
+description: GitOps.PullRequestIssueManagement primitive
+owner: 
+resource: repository
+disabled: false
+where: 
+configuration:
+  resourceManagementConfiguration:
+    scheduledSearches:
+    - description: 
+      frequencies:
+      - hourly:
+          hour: 6
+      filters:
+      - isIssue
+      - isOpen
+      - hasLabel:
+          label: 'needs: author feedback'
+      - hasLabel:
+          label: 'status: no recent activity'
+      - noActivitySince:
+          days: 3
+      actions:
+      - closeIssue
+    - description: 
+      frequencies:
+      - hourly:
+          hour: 6
+      filters:
+      - isIssue
+      - isOpen
+      - hasLabel:
+          label: 'needs: author feedback'
+      - noActivitySince:
+          days: 3
+      - isNotLabeledWith:
+          label: 'status: no recent activity'
+      actions:
+      - addLabel:
+          label: 'status: no recent activity'
+      - addReply:
+          reply: This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for **4 days**. It will be closed if no further activity occurs **within 3 days of this comment**.
+    - description: 
+      frequencies:
+      - hourly:
+          hour: 6
+      filters:
+      - isIssue
+      - isOpen
+      - hasLabel:
+          label: duplicate
+      - noActivitySince:
+          days: 1
+      actions:
+      - addReply:
+          reply: This issue has been marked as duplicate and has not had any activity for **1 day**. It will be closed for housekeeping purposes.
+      - closeIssue
+    eventResponderTasks:
+    - if:
+      - payloadType: Issue_Comment
+      - isAction:
+          action: Created
+      - isActivitySender:
+          issueAuthor: True
+      - hasLabel:
+          label: 'needs: author feedback'
+      - isOpen
+      then:
+      - addLabel:
+          label: 'needs: attention :wave:'
+      - removeLabel:
+          label: 'needs: author feedback'
+      description: 
+    - if:
+      - payloadType: Issues
+      - not:
+          isAction:
+            action: Closed
+      - hasLabel:
+          label: 'status: no recent activity'
+      then:
+      - removeLabel:
+          label: 'status: no recent activity'
+      description: 
+    - if:
+      - payloadType: Issue_Comment
+      - hasLabel:
+          label: 'status: no recent activity'
+      then:
+      - removeLabel:
+          label: 'status: no recent activity'
+      description: 
+    - if:
+      - payloadType: Pull_Request
+      then:
+      - inPrLabel:
+          label: 'Status: In PR'
+      description: 
+onFailure: 
+onSuccess: 

.vscode/launch.json

@@ -7,9 +7,9 @@
   "configurations": [
     {
       "name": "Hosted workbench",
-      "type": "pwa-chrome",
+      "type": "edge",
       "request": "launch",
-      "url": "https://enter-your-SharePoint-site/_layouts/workbench.aspx",
+      "url": "https://{tenantDomain}/_layouts/workbench.aspx",
       "webRoot": "${workspaceRoot}",
       "sourceMaps": true,
       "sourceMapPathOverrides": {

.yo-rc.json

@@ -2,11 +2,16 @@
   "@microsoft/generator-sharepoint": {
     "isCreatingSolution": true,
     "environment": "spo",
-    "version": "1.15.0",
+    "version": "1.17.0",
     "libraryName": "clb",
     "libraryId": "5099a3ef-113f-4baf-bb6a-a73b1dd286f8",
     "packageManager": "npm",
     "isDomainIsolated": false,
-    "componentType": "webpart"
+    "componentType": "webpart",
+    "sdkVersions": {
+      "@microsoft/teams-js": "2.9.1"
+    },
+    "nodeVersion": "16.18.0",
+    "@microsoft/microsoft-graph-client": "3.0.2"
   }
 }

Wiki/Customizations.md

@@ -60,6 +60,35 @@ Below are the high level steps to get you started on customizing the template.
 1. Delete the "TeamsSPFxApp.zip" folder and create a new zip folder with the images and the manifest file in the same location with the same name.
 1. Generate a new package file and follow the deployment instructions in the deployment guide.
 
+## Customize the App Title
+
+1. Follow the steps from `Standard Installation` section in the Deployment Guide. If you are having classic App Catalog skip the step 12 and if you are having modern App Catalog skip the step 4 under `Modern App Catalog` section.
+1. Instead of syncing the app to Teams through App Catalog follow the below steps.
+
+1. Download the folder `teams` from the app [repository](https://github.com/OfficeDev/microsoft-teams-apps-champion-management.git) locally.
+
+1. Open `teams` folder locally and open the `manifest.json` file and make the below changes. 
+
+   - To change the App title as it appears in App Store, modify the below properties in the manifest file
+     * name
+     * description 
+     <br /> 
+NOTE: Make sure the App Title doesn't exceed 30 characters.
+
+    ![Customization](../Images/CustomizeAppTitle1.png)  
+
+   - To change the App title as it appears on the tab, modify the below property in the manifest file
+     * staticTabs
+<br/><br/>
+
+    ![Customization](../Images/CustomizeAppTitle2.png)  
+
+1. Delete the `TeamsSPFxApp.zip` folder and create a new zip folder with the 2 images and the manifest file in the same location with exactly the same name `TeamsSPFxApp.zip`.
+
+1. Navigate to `Teams Admin Center` and upload the `TeamsSPFxApp.zip` zip file. The title changes to the app will take effect in Teams as shown below.
+
+![Customization](../Images/CustomizeAppTitle3.png)  
+
 ## Customize Member List
 
 Below customizations can be done in the Member list with no code changes required in the solution.

Wiki/Deployment-Guide.md

@@ -1,4 +1,4 @@
-# Installation Types (Customized vs Standard)
+# Installation Types (Standard vs Customized)
 
 ## Standard Installation
 The standard installation assumes you would like to take the SharePoint package file located in our GitHub repository and install using the configuration outlined in this readme file (assets all created under a SharePoint site
@@ -52,19 +52,27 @@ 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***.
 
-    ![Quick Start Guide](../Images/Upgrade-2.png) 
+    ![Quick Start Guide](../Images/Upgrade-2.png)
 
-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***.
+11.	select the ***championmanagement*** app. Select the Files tab in the ribbon and click the ***Sync to Teams*** button.
+
+    ![Quick Start Guide](../Images/SyncToTeams.png) 
+
+12. Repeat steps 8-10 to deploy another package "mgt-spfx-vv3.sppkg" to the App catalog. This package can be picked from ***"sharepoint/solution"*** location of the GitHub repo here. This package is required for the person card feature when hovering over a champion name in the app.
+
+    ![Quick Start Guide](../Images/GraphtoolkitModern.png)     
+
+13.	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***.
 
     **User.ReadWrite** : Allows the app to read the signed-in user's full profile. It also allows the app to update the signed-in user's profile information on their behalf. CMP app uses this permission to read and update the user's profile image with the digital badge.
 
-    **Sites.Manage.All** : Allows the app to manage and create lists, documents, and list items in all site collections on behalf of the signed-in user. CMP app uses this permission to create lists in the SharePoint site.
+    **User.Read.All** : Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. CMP uses this permission to display person cards for all champions.
+
+    **People.Read**: Allows the app to read a scored list of people relevant to the signed-in user. The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications. CMP uses this permission to display person cards for all champions.
 
     ![Quick Start Guide](../Images/APIAccess.png) 
 
-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.
 
-    ![Quick Start Guide](../Images/SyncToTeams.png) 
 
 ### Modern App Catalog 
 
@@ -78,14 +86,18 @@ Continuing below steps you can take the cmp.sppkg file from the ***cmp.sppkg***
 
     ![Quick Start Guide](../Images/Modern_AppCatalog2.png)
 
-1. Click on "Go to API access page" to approve the permissions.
+1. Click on "Go to API access page" to approve the permissions. Refer to step 13 from previous section for details. 
 
     ![Quick Start Guide](../Images/Modern_AppCatalog3.png)
 
-1. Once done, click on "Add to Teams" to make this app available in Teams
+1. Once done, click on "Add to Teams" to make this app available in Teams. Sometimes you may see an error after clicking "Add to Teams". Navigate to "Manage Apps" in Teams Admins center to verify if the ChampionManagementPlatform is created. If yes, you can ignore the error and proceed.
 
     ![Quick Start Guide](../Images/Modern_AppCatalog4.png)
 
+1. Repeat steps 1-2 to deploy another package file "mgt-spfx-vv3.sppkg" to the App catalog by selecting "Enable this app and it to all sites" option. This package can be picked from ***"sharepoint/solution"*** location of the GitHub repo here. This package is required for the person card feature when hover over a champion name in the app.
+
+    ![Quick Start Guide](../Images/GraphtoolkitModern.png)    
+
 ## Customized Installation
 
 The customized installation makes the assumption you wish to change the default variables (site location, text or visual aspects, etc) with the Champion Management Platform. Customizing the installation takes it outside of 
@@ -153,6 +165,8 @@ If desired the administrator can configure the installation location including t
 
 3.	Navigate to the solution folder where you cloned and locate the newly created ***cmp.sppkg*** package in ***"sharepoint/solution"***.
 
+4. Follow the instructions in the previous sections of this deployment guide to deploy the custom package. 
+
 ## First Run Experience: Add **Champion Management Platform** Tab in Teams
 
 **NOTE:** Please wait for around 20 minutes for API access approvals done in the previous section to take effect before proceeding with the below steps.

Wiki/Release-Notes.md

@@ -3,6 +3,7 @@ This page contains the different release details for Champion Management Platfor
 ## Version history
 | Version | Release Date |
 |----|----|
+| 2.5 | Dec 21, 2023 |
 | 2.4 | Dec 6, 2022 |
 | 2.3 | Jul 28, 2022 |
 | 2.2 | May 17, 2022 |
@@ -14,6 +15,19 @@ This page contains the different release details for Champion Management Platfor
 
 ## Release notes
 
+### 2.5 (Dec 21, 2023)
+
+Below improvements released,
+
+- New Feature: Ability for Admins to modify App Title from "Manage Config Settings" page under "Admin Settings". The app title is applied to the app header and navigation.
+- New Feature: Champions Report for Admins
+- New Feature: Leaderboard UI improvements
+- New Feature: Champions' names in the app are replaced with Person cards.
+- New Feature: Accessibility compliant UI
+- Bug Fix: When a tournament name has a apostrophe an error shows up "My Dashboard" of "Tournament of Teams module"
+- Removed dependency on 'Sites.Manage.All' API permission. This permission is no longer required to set up the app.
+- Upgraded SPFX version from 1.15 to 1.17.
+
 ### 2.4 (Dec 6, 2022)
 
 Below improvements released,

Wiki/Solution-Overview.md

@@ -108,16 +108,26 @@ There are three tabs in the Admin Tasks Screen,
 
 ![Quick Start Guide](../Images/ChampionsListTab.png) 
 
-2. Manage Config Settings - Admin can enable Champion Event Approvals, show/hide Region, Country and Group columns.
+2. Manage Config Settings - Admin can do the following on this screen.
 
-    If the "Champion Event Approvals" is enabled, the events submitted by the champions thereafter will go through the admin approval process and the points will be awarded only after the approval. Admin can also configure the Power Automate Flow template in the tenant to send notifications to the CMP Manager at regular intervals if there are any pending event requests available.
+    - Modify App Title. The modified App Title will reflect on the app header and navigation breadcrumbs in all screens.
+    - Show/hide Region, Country and Group columns. The changes reflect in "Add Member" screen while adding new champions.
+    - Admin can enable Champion Event Approvals. If the "Champion Event Approvals" is enabled, the events submitted by the champions thereafter will go through the admin approval process and the points will be awarded only after the approval. Admin can also configure the Power Automate Flow template in the tenant to send notifications to the CMP Manager at regular intervals if there are any pending event requests available.
 
 ![Quick Start Guide](../Images/ConfigSettings.png) 
 
 3. Champion Activities - If the "Champion Event Approvals" is enabled, then all the pending event requests submitted by champions will be listed in this grid. Admin can either Approve/Reject the requests. A bell icon will be shown in the header if there are any pending requests.
 
 ![Quick Start Guide](../Images/ChampionActivitiesTab.png) 
 
+## Champions Report
+
+- Champions Report is available only to admins under "Admin Tools" section.
+- The Report displays a snapshot of all the events recorded by all the champions. 
+- The Report can be filtered based on a champion and a date range.
+
+    ![Quick Start Guide](../Images/CMPReport.png) 
+
 
 ## Tournament of Teams