Merge pull request #18 from pnp/alexc-msft/promptbuddy-integration

Prompt Buddy integration

Author: alexc-MSFT

Documentation/Architecture.md

@@ -2,6 +2,8 @@
 
 The below documentation details the architecture of the Prompt Pulse solution. Prompt Pulse is provided as a Power Apps solution file (**unmanaged**), this allows easy updates when new versions are released.
 
+The Prompt Buddy integration is provided as a Dataverse for Teams solution file (**unmanaged**) and is deployed separately from the Prompt Pulse solution.
+
 ## Connectors
 
 The following connectors are used in the Prompt Pulse solution:
@@ -18,6 +20,11 @@ It's worth noting that Group Chats and Viva Engage Communities are pulled into t
 
 The above connectors are also used in the Power Automate flows.
 
+The following connectors are used in the Prompt Buddy Integration solution:
+
+- Dataverse
+- SharePoint
+
 ## Service Account
 
 **It is highly recommended to deploy Prompt Pulse using a dedicated service account/M365 user** and share the app across the organization/with the required users. The UPN for this service account is stored in the configuration list.
@@ -26,6 +33,8 @@ Adaptive cards and Viva Engage notifications are sent using the account that dep
 
 In addition, in order to post the cards/notifications, the user account sending them needs to be member of the Team, Group Chat, Viva Engage community, this is handled automatically (with the exception of Group Chats) through the app. **Bear this in mind because not using a service account would result in the user who deployed the solution being added to these locations**.
 
+This service account can also be used to deploy the Prompt Buddy integration.
+
 ## Power App
 
 The Prompt Pulse Power App is a canvas app using mostly **modern** controls where possible. Prompts that are shared/scheduled are stored in the **Prompts** SharePoint list.
@@ -34,6 +43,10 @@ The app uses the above connectors (and flows listed below) to interact with the
 
 The app can be customized if you wish, though it's worth noting that customizations will be lost if you attempt to update the solution in the future when new releases are available.
 
+## Prompt Buddy Integration
+
+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.
+
 # Flows
 
 Detailed information about the flows used in the solution can be found below:
@@ -102,6 +115,14 @@ This flow is required because the native Viva Engage connector does not return t
 
 This flow is triggered from the Power App when the user clicks the **Upload** button. It parses the content of the csv file and returns it as JSON.
 
+## Prompt Pulse Sync
+
+This flow is triggered on a recurrent scheduled inside the Dataverse for Teams environment in which the Prompt Buddy app resides. It performs the following high-level steps:
+
+- Get Prompt Buddy Microsoft 365 Copilot prompts.
+- Loop through prompts and create a list item in the Prompts list, set the value of the 'SyncedToPulse' column to true and set the 'BuddyId' column to the unique id of the dataverse record.
+- Loop through prompts in the Prompts list and create the relevant records in the Prompt Buddy dataverse tables, set the 'SyncedToBuddy' column to true.
+
 ## 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:
@@ -122,6 +143,10 @@ As detailed in the [Overview](Overview.md) documentation, there are 3 SharePoint
 | Scheduled    | Yes/No  | Whether or not the prompt has been scheduled.
 | ScheduledDateTime    | Date and time  | Date/Time to send the prompt.
 | Status    | Choice  | Status of the prompt.
+| SyncedToBuddy    | Yes/No  | Whether or not the prompt has been synced to Prompt Buddy (only used if the Prompt Buddy integration is deployed).
+| SyncedToPulse    | Yes/No  | Where or not the prompt has been synced from Prompt Buddy to Pulse (only used if the Prompt Buddy integration is deployed).
+| BuddyId    | Single line of text  | Unique id of the prompt in the Prompt Buddy dataverse prompts table.
+
 
 ### Users list
 

Documentation/Deployment-guide.md

@@ -19,6 +19,14 @@ To begin, you will need:
 - Regional settings set correctly on the SharePoint site for your timezone and locale (this is important for the scheduling to work correctly).
 - The [latest release](https://github.com/pnp/prompt-pulse/releases/latest) of Prompt Pulse.
 
+### Prompt Buddy Integration
+
+If you wish to integrate with Prompt Buddy, it must be deployed and set up in a Teams Team before deploying Prompt Pulse.
+
+Once Prompt Pulse is deployed, follow 'Step 5' below to deploy the Prompt Buddy integration, this requires deployment of an additional Power Apps solution.
+
+Note - You must create ALL of the columns below even if you are not deploying the integration.
+
 ## Step 1: Create SharePoint Lists
 
   1. Navigate to the SharePoint site.
@@ -39,6 +47,10 @@ To begin, you will need:
 | Scheduled    | Yes/No  | Default value = No |
 | ScheduledDateTime    | Date and time  | Include time |
 | Status    | Choice  | Not Sent, Send, Sent, Failed | Default value = Not Sent
+| Source    | Choice  | Pulse, Buddy
+| SyncedToBuddy    | Yes/No  | Default value = No
+| SyncedToPulse    | Yes/No  | Default value = No
+| BuddyId    | Single line of text  |
 
 4. Create a list named 'Users'.
 5. Create the following columns:
@@ -68,6 +80,12 @@ Title: ServiceAccountUPN
 
 Value: UPN (Email) of your service account
 
+9. 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'.
+
 ## Step 2: Deploy Power Apps solution
 
 1. Navigate to **Power Apps** as the service account.
@@ -113,4 +131,31 @@ Before rolling out Prompt Pulse, it is neccessary to configure the permisions on
 3. Break permission inheritance on the **Prompts** and **Users** lists and add only users/groups that will use Prompt Pulse.
 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
+
+These steps deploy the integration between Prompt Pulse and Prompt Buddy. This integration is provided in the form of a single Flow which is responsible for syncronizing items from the Prompt Buddy dataverse tables to the Prompts SharePoint list and visa versa.
+
+You may use any account to deploy this flow (it will need to be a member of the Teams Team in which Buddy is deployed), however it is worth noting that any prompts synced to Buddy will be created as the user who deploys this flow. Therefore you may wish to use the service account.
+
+This flow runs on a recurrent schedule and by default runs every hour, feel free to edit the flow and update the interval as needed.
+
+1. Launch Microsoft Teams. 
+2. Open the Power Apps app in Teams.
+3. Navigate to the **Build** tab.
+4. Select the environment in the left pane in which Prompt Buddy is deployed.
+5. Click **See all** in the list items created in the environment.
+6. Click **Import > Import solution** from the menu bar.
+7. Click **Browse** and locate the **PromptPulseBuddyIntegration_1.0.0.0.zip** solution zip file (if there is a newer version please use that).
+8. Click **Next**.
+9. Click **Next**.
+10. Click **Sign in** next to each of the connectors and wait for the green tick.
+11. Click **Next**.
+12. On the **Environment Variables** pane, select the SharePoint site you created and the **Prompts** List.
+13. Click **Import**.
+14. A message should be displayed to say the solution has been imported successfully.
+15. Locate the **Prompt Pulse Sync** flow and click on it.
+16. Click **Run** from the menu bar and click **Run flow**.
+18. Verify the run completes without errors.
+19. The integration is now deployed and the flow will automatically sync the prompts in both solutions.
+
 ### Deployment is now complete - enjoy using Prompt Pulse!

Documentation/Images/prompt-pulse-all-screenshot.png

@@ -6,6 +6,8 @@ Prompt Pulse consists of the following components:
 - 6 x Power Automate flows.
 - 3 x SharePoint lists for data storage
 
+Separate Dataverse for Teams solution for integration with Prompt Buddy containing 1 Power Automate flow.
+
 For more details on what each of these does please check out the [Architecture](Architecture.md) documentation.
 
 ## The App
@@ -16,6 +18,8 @@ The app is fully responsive, works on mobile devices 📱 and supports dark mode
 
 To get the most out of Prompt Pulse, we recommend using the app in Microsoft Teams either as a pinned app and/or add the app into individual teams as a tab. 
 
+Prompt Pulse integrates with Prompt Buddy, follow the [Deployment guide](Deployment-guide.md) to deploy the integration.
+
 When a user launches Prompt Pulse for the first time, they will be taken through a tutorial explaining how to use the app. 
 
 ## Using the app
@@ -49,7 +53,7 @@ From the main screen, users can view the latest 20 prompts. To use a prompt simp
 
 You can then paste the prompt into Microsoft 365 Copilot. 
 
-The **All Prompts** tab allows you to view all prompts that have been shared, text can also be copied by clicking the tile.
+The **All Prompts** tab allows you to view all prompts that have been shared, text can also be copied by clicking the tile. If the integration with Prompt Buddy is deployed, an icon will be visible showing the 'source' of the prompt (Pulse or Buddy).
 
 The adaptive card also has a button which will take a user straight to the **All Prompts** screen. Please note - this will open the app as a 'personal' app due to restrictions with deeplinking, if the user does not have the app installed they will be prompted to install it.
 
@@ -80,21 +84,39 @@ The **Send Now** option sends the prompt straight away and removes it from the s
 
 Prompts can be imported into Prompt Pulse in bulk, enabling you to easily schedule and send prompts right away, encouraging the use of Copilot from the get go.
 
+Prompts can be imported from CSV or Prompt Buddy.
+
 A csv file has been provided [Prompts.csv](../Prompts.csv) with pre-built prompts for you to import. Feel free to edit the csv and add/remove as many prompts as you like (you will also be able to remove when importing). The pre built csv will be update periodically with new prompts so please keep an eye out for changes.
 
-To import prompts, follow the steps below:
+#### Import from CSV
+
+To import prompts from CSV, follow the steps below:
 
 1. Navigate to the import screen by clicking the **Import Prompts** tab.
-2. Use the attachment control to upload the csv file (only csv files are supported AND the csv file must be in the same format as the provided sample).
-3. Click **Upload**.
-4. The table will update to show all the prompts from the csv.
-5. For each row/prompt, choose whether to schedule or send the prompt (**send** will send the prompt straight away when imported). Also choose the locations to share the prompt to.
-6. Once ready, click **Import**, this will import the prompts into the SharePoint list and send/schedule them as per your selections.
+2. Click the **CSV file** button.
+3. Use the attachment control to upload the csv file (only csv files are supported AND the csv file must be in the same format as the provided sample).
+4. Click **Upload**.
+5. The table will update to show all the prompts from the csv.
+6. For each row/prompt, choose whether to schedule or send the prompt (**send** will send the prompt straight away when imported). Also choose the locations to share the prompt to.
+7. Once ready, click **Import**, this will import the prompts into the SharePoint list and send/schedule them as per your selections.
 
 **To delete prompts that you do not wish to import, use the trash icon.**
 
 <img src="https://github.com/pnp/prompt-pulse/blob/main/Documentation/Images/prompt-pulse-import-screenshot.png?raw=true" alt="Prompt Pulse Import Prompts Screenshot"><br/>
 
+#### Import from Prompt Buddy
+
+To import prompts from Prompt Buddy, follow the steps below:
+
+1. Navigate to the import screen by clicking the **Import Prompts** tab.
+2. Click the **Prompt Buddy** button.
+3. Use the table at the top to add prompts to import by clicking the **+** icon. This table shows Prompt Buddy prompts that have not yet been imported into Prompt Pulse.
+4. Prompts added will appear in the **Selected Prompts** table.
+6. For each row/prompt, choose whether to schedule or send the prompt (**send** will send the prompt straight away when imported). Also choose the locations to share the prompt to.
+7. Once ready, click **Import**, this will import the prompts and send/schedule them as per your selections.
+
+<img src="https://github.com/pnp/prompt-pulse/blob/main/Documentation/Images/prompt-pulse-import-buddy-screenshot?raw=true" alt="Prompt Pulse Import Prompt Buddy Prompts Screenshot"><br/>
+
 ### Tips
 
 - Use a dedicated service account/M365 user when deploying Prompt Pulse (adaptive cards will be sent from this account).
@@ -117,12 +139,15 @@ Bear the above in mind when using Prompt Pulse, in a future iteration we will lo
 
 There are 6 flows that are part of the Prompt Pulse solution, these are listed below along with a brief description of what these do, for more details please view the [Architecture](Architecture.md) documentation.
 
+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 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.
 - Get Engage Communities: This flow is used in the Power App and returns a list of Viva Engage Communities that the current user is a member of.
 - Parse Prompt CSV: This flow is used in the Power App and parses the content of the uploaded csv file and returns it in JSON format.
+- Prompt Pulse Sync: This flow is used when Prompt Buddy is deployed, it syncronizes prompts from Prompt Buddy to Prompt Pulse and visa versa.
 
 ## Data Storage