Merge pull request #20 from pnp/alexc-msft/reporting-and-bugfixes

Bug fixes and reporting functionality

Author: alexc-MSFT

Documentation/Architecture.md

@@ -47,6 +47,12 @@ The app can be customized if you wish, though it's worth noting that customizati
 
 Integration with Prompt Buddy is provided through a single flow (details can be found below) which adds Prompt Buddy prompts to the **Prompts** list and Prompt Pulse prompts to the relevant dataverse tables used by Prompt Buddy. This keeps both solutions in sync and ensures prompts can be accessed from both apps.
 
+## Reporting
+
+Basic reporting can be found in the **Reporting** list in the form of a single list item. This list item is created automatically if it does not exist by the app and flows.
+
+If multiple list items exist in this list, only the first item is updated in terms of the numeric data.
+
 # Flows
 
 Detailed information about the flows used in the solution can be found below:
@@ -125,7 +131,7 @@ This flow is triggered on a recurrent scheduled inside the Dataverse for Teams e
 
 ## Data Source
 
-As detailed in the [Overview](Overview.md) documentation, there are 3 SharePoint lists used in prompt pulse. Please see the details of each list below and what each column is used for:
+As detailed in the [Overview](Overview.md) documentation, there are 4 SharePoint lists used in prompt pulse. Please see the details of each list below and what each column is used for:
 
 ### Prompts list
 
@@ -162,4 +168,12 @@ As detailed in the [Overview](Overview.md) documentation, there are 3 SharePoint
 | -------- | ------- | ------- | 
 | Value  | Single line of text | The configuration value.
 
+### Reporting list
+
+| Column Name    | Type | Used for |
+| -------- | ------- | ------- | 
+| PromptsSent  | Number | The number of prompts sent in Prompt Pulse either directly or via scheduling.
+| AppLaunches  | Number | The number of times the app has been launched/opened.
+| PromptsCopied  | Number | The number of times prompts have been copied (clicking the prompt card) in the app.
+| PromptsLiked  | Number | The total of prompts that have been liked by users.
 

Documentation/Deployment-guide.md

@@ -43,7 +43,6 @@ Note - You must create ALL of the columns below even if you are not deploying th
 | ChannelIds    | Multiple lines of text  |
 | GroupChatIds    | Multiple lines of text  |
 | CommunityIds    | Multiple lines of text  |
-| MessageId    | Single line of text  |
 | Scheduled    | Yes/No  | Default value = No |
 | ScheduledDateTime    | Date and time  | Include time |
 | Status    | Choice  | Not Sent, Send, Sent, Failed | Default value = Not Sent
@@ -61,31 +60,53 @@ Note - You must create ALL of the columns below even if you are not deploying th
 | LikedPrompts | Lookup     | Source list = 'Prompts', Select a column = 'ID' |
 | TutorialComplete | Yes/No     | Default value = No |
 
-6. Create a list name 'Configuration'.
+6. Create a list named 'Reporting'.
 7. Create the following columns:
 
 | Column Name    | Type |
 | -------- | ------- | 
-| Value  | Single line of text   
+| PromptsSent  | Number
+| AppLaunches  | Number
+| PromptsCopied  | Number
+| PromptsLiked  | Number
 
-8. Create a list item in the above list with the following details:
+8. Create a list named 'Configuration'.
+9. Create the following columns:
+
+| Column Name    | Type |
+| -------- | ------- | 
+| Value  | Single line of text  
+
+10. Create a list item in the above list with the following details:
 
 Title: AppId
 
 Value: Leave empty
 
-9. Create a second list item in the above list with the following details:
+11. Create a second list item in the above list with the following details:
 
 Title: ServiceAccountUPN
 
 Value: UPN (Email) of your service account
 
-9. Create a third list item in the above list with the following details:
+12. Create a third list item in the above list with the following details:
 
 Title: PromptBuddyInstalled
 
 Value: 'true' (if you wish to integrate with Prompt Buddy) or 'false'.
 
+13. Create a fourth list item in the above list with the following details:
+
+Title: ShowShareEngage
+
+Value: 'true' (if you wish to allow sharing to Viva Engage) or 'false'.
+
+14. Create a fifth list item in the above list with the following details:
+
+Title: ShowShareUsers
+
+Value: 'true' (if you wish to allow sharing to users) or 'false'.
+
 ## Step 2: Deploy Power Apps solution
 
 1. Navigate to **Power Apps** as the service account.
@@ -129,6 +150,7 @@ Before rolling out Prompt Pulse, it is neccessary to configure the permisions on
 1. Amend the permissions on the **Prompts** list (Advanced Settings) to **Create items and edit items that were created by the user**.
 2. Amend the permissions on the **Users** list (Advanced Settings) to **Read items that were created by the user** and **Create items and edit items that were created by the user**.
 3. Break permission inheritance on the **Prompts** and **Users** lists and add only users/groups that will use Prompt Pulse.
+4. Break permission inheritance on the **Configuration** and **Reporting** lists and ensure that only admins have write access to these lists, users should have read access.
 4. Ensure that admins who may need to read, edit and delete all list items have **Full Control**/**Owner** permissions on the SharePoint site.
 
 ## Step 5: Deploy Prompt Buddy Integration

Documentation/Images/reporting-list-screenshot.png

@@ -4,7 +4,7 @@ Prompt Pulse consists of the following components:
 
 - Power App
 - 6 x Power Automate flows.
-- 3 x SharePoint lists for data storage
+- 4 x SharePoint lists for data storage
 
 Separate Dataverse for Teams solution for integration with Prompt Buddy containing 1 Power Automate flow.
 
@@ -47,6 +47,8 @@ From the main screen, the process for sharing a prompt is as follows:
 
 <img src="https://github.com/pnp/prompt-pulse/blob/main/Documentation/Images/prompt-pulse-share-screenshot.png?raw=true" alt="Prompt Pulse Share Screenshot"><br/>
 
+**Note - Viva Engage and Users radio buttons are only enabled if the 'ShowShareEngage' and 'ShowShareUsers' list items in the Configuration list are set to true.**
+
 ### Viewing/using prompts
 
 From the main screen, users can view the latest 20 prompts. To use a prompt simply click the prompt **'tile'** and the prompt text will be copied to your clipboard. 
@@ -119,6 +121,21 @@ To import prompts from Prompt Buddy, follow the steps below:
 
 <img src="https://github.com/pnp/prompt-pulse/blob/main/Documentation/Images/prompt-pulse-import-buddy-screenshot.png?raw=true" alt="Prompt Pulse Import Prompt Buddy Prompts Screenshot"><br/>
 
+#### Reporting
+
+Basic reporting to showcase the adoption of Prompt Pulse is now available in the form of a SharePoint list. A single list item will be created in this list by the app and flows if it does not exist.
+
+The 'Reporting' list shows the following information:
+
+- PromptsSent - The number of prompts sent in Prompt Pulse either directly or via scheduling.
+- AppLaunches - The number of times the app has been launched/opened.
+- PromptsCopied - The number of times prompts have been copied (clicking the prompt card) in the app.
+- PromptsLiked - The total of prompts that have been liked by users.
+
+You may wish to create your own reports using tools such as Excel or PowerBI to visualize this data.
+
+<img src="https://github.com/pnp/prompt-pulse/blob/main/Documentation/Images/reporting-list-screenshot?raw=true" alt="Prompt Pulse Reporting List Screenshot"><br/>
+
 ### Tips
 
 - Use a dedicated service account/M365 user when deploying Prompt Pulse (adaptive cards will be sent from this account).
@@ -143,7 +160,7 @@ There are 6 flows that are part of the Prompt Pulse solution, these are listed b
 
 As mentioned earlier there is an additional flow for the Prompt Buddy integration.
 
-- Send Prompt: This flow executes when a list item is created or modified in the 'Prompts' list and sends the prompt to the specified location using adaptive cards or in the case of Viva Engage, a message.
+- Send Prompt: This flow executes when a list item is created or modified in the 'Prompts' list and sends the prompt to the specified location using adaptive cards or in the case of Viva Engage, a message. 
 - Send Scheduled Prompt: This flow runs on a recurrent schedule (5 minutes by default) and is responsible for checking for scheduled prompts in the list and sending these.
 - Like Prompt: This flow runs when a user clicks the **Like Prompt** button in the adaptive cards and adds the prompt to the users' liked prompts.
 - Get Group Chats: This flow is used in the Power App and retrieves a list of group chats that the current user is a member of where the Prompt Pulse account is a member of the chat.
@@ -160,6 +177,7 @@ There are 3 SharePoint lists used in the solution:
 - Prompts: Stores the prompts shared/scheduled in the app.
 - Users: Stores the users who have opened/used Prompt Pulse and their liked prompts.
 - Configuration: Stores configuration settings for Prompt Pulse.
+- Reporting: Stores basic reporting data for Prompt Pulse.
 
 These lists can be easily extended or changed should you wish to modify/customize Prompt Pulse. You can of course edit and delete prompts directly from the list if required. Avoid modifying the values of the GroupId, GroupChatId, TeamId, ChannelId and MessageId columns as these are used heavily in the Power Automate flows.