This article provides information on how to build the Pega Sales Automation Teams embedded app when using the Constellation architecture.

Creating Teams Splash Screen Servlet

1. Get access to the server by using PuTTY or WinSCP.
2. Navigate to the location of web.xml file, and open it for editing.
3. Search for the first <servlet> tag, and then insert the following XML snippet:
   <servlet>
       <servlet-name>TeamsMeetingSplash</servlet-name>
       <display-name>TeamsMeetingSplash</display-name>
       <description>Teams Meeting Splash</description>
       <servlet-class>com.pega.pegarules.internal.web.servlet.WebStandardBoot</servlet-class>
       <init-param>
            <param-name>PegaEtierClass</param-name>
            <param-value>com.pega.pegarules.session.internal.engineinterface.service.HttpAPI</param-value>
       </init-param>
       <init-param>
             <param-name>AuthenticationType</param-name>
                        <param-value>PRCustom</param-value>
                </init-param>
                <init-param>
                        <param-name>RuntimeServletName</param-name>
                        <param-value>TeamsMeetingSplash</param-value>
                </init-param>
                <init-param>
                        <param-name>AuthService</param-name>
                        <param-value>TeamsMeetingSplash</param-value>
                </init-param>
        </servlet>
<servlet-mapping>
<servlet-name>TeamsMeetingSplash</servlet-name>
                <url-pattern>/TeamsMeetingSplash</url-pattern>
 </servlet-mapping>
<servlet-mapping>
<servlet-name>TeamsMeetingSplash</servlet-name>
<url-pattern>/TeamsMeetingSplash/*</url-pattern>
</servlet-mapping>
4. Save the file.
5. Restart the server.

Creating Teams meeting app

1. Enable a custom app for the organization in Teams:
   1. Log in to the Microsoft Teams admin center at https://admin.teams.microsoft.com/.
   2. On the left navigation pane, under Teams apps, click Manage apps.
   3. In the Actions list, click Org-wide app settings.
   4. In the Custom apps section, turn on the Let users install and use available apps by default and Let users interact with custom apps in preview settings.
   5. Save your changes.
2. Sign in to Teams at https://teams.microsoft.com/v2/.
3. In the left navigation pane, click Apps.
4. Search for the Developer Portal app, and then open it. 
   This app enables you to build a custom app.
5. On the Apps tab, click New app.
6. Enter a name for your Teams app.
7. Leave the manifest version as the latest version, and click Add.
   The new app's configuration screen opens.
8. On the Basic Information tab (which is under Configure but opens by default when you add a new app), complete the following fields, and then click Save:
   1. Short name
   2. Long description
   3. Developer or company name
   4. Website
   5. Privacy policy (URL)
   6. Terms of use
9. On the App features tab, click Group and channel app, enter the following details, and then click Save:
   1. In the Configuration URL field, enter the Login URL from the TeamsMeetingSplash Authentication Service Rule. 
      You can find this Rule in Dev Studio, under Records > SysAdmin > Authentication Service.
   2. In the Scope section, select the Team and Group chat checkboxes.
   3. In the Context field, add meetingSidePanel. 
      This setting is required so that the meeting app displays in the side panel.
10. Under Configure > Domains, add all the domains for the app to give access to load in Teams:
    For example:
    staging-cdn.constellation.pega.io
    prod.constellation.pega.io
    pega.com
    linkedin.com
    fonts.googleapis.com
    www.linkedin.com
    maps.googleapis.com
    sa-cdn.constellation.pega.io
    fonts.gstatic.com
    staging.constellation.pega.io
    staging2.constellation.pega.io
    teams.cloud.microsoft
    m365.cloud.microsoft
     
11. Click Advanced > Owners, and Add any additional owners to manage the app.
12. Publish the app for use in any of the following ways:
    1. Download the app package and distribute it to an individual.
       You can do this by clicking Publish > Publish to store, and then clicking the Download app package button. Use this method during development.
    2. Publish the app to everyone in the organization.
       You can do this by clicking Publish > Publish to org. 
       This action requires the admin of your organization to approve.
    3. When satisfied with the quality and content of the app, publish the app to the market for everyone to use.
       This action requires a dedicated server for the app to access, and an approval from Microsoft.

Creating the app registration

1. In Microsoft Azure portal, open the Entra ID service.
2. Click Manage > App Registrations.
3. On the App Registration landing page, click New Registration.
4. Enter the name of the app registration.
5. Leave the Support account type radio button defaulted to Accounts in this organization.
6. In the Redirect URI platform list, select Web.
7. Enter the redirect URI.
8. Click Register.
9. Under the Application (client) ID heading, click the Copy to clipboard icon next to the client ID, and save it for a later step.
10. Navigate to Manage > API permissions.
11. Click Add a permission.
12. Click the Microsoft APIs tab.
13. Click Microsoft Graph.
14. Select all the necessary permissions for the app.
15. Click Add permissions.
16. Navigate to Manage > Certificates & secrets.
17. On the Client secrets tab, click New client secret.
18. Enter a description for the client secret.
19. Click Add.
20. In the table of client secrets, click the Copy to clipboard icon for the newly client secret, and save it for a later step.

Enabling Teams meeting app in Sales Automation

1. In Dev Studio, configure the requestor type:
   1. In Dev Studio, click Records > SysAdmin > Requestor Type, and find the BROWSER requestor type for your system.
   2. Add an entry to the Access Group Name field by clicking the Add icon.
   3. Enter your application’s unauthenticated Access Group.
   4. Default the newly entered Access Group by selecting the radio button associated with it.
   5. Save your changes.
2. Enable the Teams servlet:
   1. Search for the MeetingAppTeamsC11nService Authentication Service Rule.
      You can also navigate to this rule from Records > SysAdmin > Authentication Service.
   2. Select the Enable this authentication service checkbox.
   3. Save your changes.
3. Add the Teams meeting app portal to the Access Group of your sales representatives:
   1. In Dev Studio, click Records > Security > Access Group, and open the SalesAutomation-Constellation:SalesRep Access Group.
   2. Click Add portal.
   3. Select MeetingAppCondensePortal.
   4. Save your changes.
4. Update the Teams meeting app portal for a login redirect:
   1. In Dev Studio, click Records > Technical > Activity, and find the MeetingAppRedirect activity.
   2. Save the activity to an open Ruleset or branch.
   3. Check out the Rule.
   4. Expand the Property-Set Step, and update the local.portal property value to MeetingAppCondensePortal.
   5. Save your changes.
5. Update the cross-browser settings:
   1. In Dev Studio, click Configure > Systems > Settings > Cross-Site Requestor Forgery.
   2. In the Cookies Settings section, select the Enable samesite cookie attribute checkbox.
   3. In the Samesite Options list, select None.
6. Enable the CreateSubscriptionForMSTeams job scheduler:
   1. In Dev Studio, click Records > SysAdmin > Job Scheduler.
   2. Search for the CreateSubscriptionForMSTeams job scheduler.
   3. Save the job scheduler to an open ruleset or branch.
   4. Enable the job scheduler.
   5. Save or check in your changes.
7. Set up a keystore:
   1. In Dev Studio, click Records > Security > Keystore, and then locate the MSTeams rule.
   2. Update the Rule with the information from your keystore.
      For more information, see Example of creating a keystore and generating a certificate key below.
   3. In the global search, search for the GetMeetingAppTeamsSettings Data Transform.
   4. Save the Data Transform to an open ruleset.
   5. Update Step 2 of the Data Transform with the certificate key value that you obtained when exporting the certificate by using base64 encoding.
      For more information, see Example of creating a keystore and generating a certificate key below.
   6. Save your changes.
8. Update the MSTeamsClientCode Authentication Profile:
   1. In Dev Studio, click Records > Security > Authentication Profile, and then open the MSTeamsClientCode Authentication Profile.
   2. Enter or paste the client identifier from step 9 in Creating the app registration above.
   3. Enter or paste the client secret from step 20 in Creating the app registration above.
   4. Save your changes.
9. Update the MSTeamsAuthCode Authentication Profile:
   1. In Dev Studio, click Records > Security > Authentication Profile, and then locate the MSTeamsAuthCode Rule.
   2. Enter or paste the client identifier from step 9 in Creating the app registration above.
   3. Enter or paste the client secret from step 20 in Creating the app registration above.
   4. Save your changes.

Additional configuration for Mac users

1. Update your Application Rule’s definition:
   1. In the Dev Studio header, click your application name, and then click Definition.
   2. Click the Security tab.
   3. In the Contect security section, set the policy name to pxDefaultAllowAll.
   4. Set the Mode radio button to Reject and report.
2. Update the dynamic system setting (DSS):
   1. In Dev Studio, click Records > SysAdmin > Dynamic System Settings.
   2. Locate the http/responseHeaders DSS for the owning ruleset Pega-RulesEngine.
   3. Update the DSS value to the following:
      {"X-Content-Type-Options":"nosniff","X-XSS-Protection":"1","Referrer-Policy":"no-referrer","Strict-Transport-Security":"max-age=31536000"}

Adding the Sales Automation meeting app to Teams

Each member of the sales team must perform these steps:

1. While in a Teams meeting, click Apps in the top navigation.
2. Search for your Sales Automation meeting app.
3. Double-click the app to add it as a tab on the top navigation.
4. Optional: If the Sales Automation meeting app is not available, you can import it by clicking Manage apps.
5. Click Save.

Extending the Teams meeting app

When the Teams meeting app runs, Pega Sales Automation sees that the requests are coming in from a specific URL. This URL is the Teams servlet url. The Teams servlet url is mapped to the MeetingAppTeamsSplah Authentication Rule. This rule renders the HTML code to display the content of the modal when adding an app from Teams. When a user clicks Save in that modal, the Teams app redirects to the Pega Sales Automation login screen. This redirect hits a new servlet by using the MeetingAppTeamsServiceC11n Authentication Service Rule.

The MeetingAppTeamsServiceC11n Authentication Service Rule has a post activity, MeetingAppLogin, that redirects to an activity called MeetingAppRedirect. This activity switches the portal of the current user to their secondary portal, MeetingAppCondensePortal.  Because of the new portal, Pega Sales Automation can identify the correct rules to display for the Teams meeting app.

The portal loads the following custom react components:

• MeetingApp: This component loads the Teams SDK, gets all the information about the meeting from Teams, and provides all the necessary setup to run the Teams meeting app in Pega Sales Automation.
• SAIntelligence and ConversationalAI: These components load the Voice AI feature to suggest Cases and knowledge articles in the Teams meeting app. 

Each card in the Attendees and Overview sections is rendered by using a custom React component called GenericSummaryList, in the form of a widget. You can add this widget to any view and customize it from App Studio.  There is also a Knowledge Section containing a widget called Knowledge, which displays knowledge articles, including suggested articles.

Teams events

With the Teams meeting app running, every time something happens in Teams, the system sends a notification, called a Change Notification, to the meeting app. The meeting app then sends the notification to the endpoint URL. For example, when a participant joins, the meeting app sends a Microsoft.Communication.CallRosterUpdate event to Pega Sales Automation. 

Pega Sales Automation includes a REST service, MeetingAppEvents, which calls an activity called ProcessEvents. For Teams, this activity tries to match the event and call the right activity to run to handle the event. For the Microsoft.Communication.CallStarted event, the ProcessEvents activity creates an appointment if it doesn’t exist, and creates a meetinginfo instance to save the meeting with the New status.  For participants joining or leaving events (Microsoft.Communication.CallRosterUpdate), the ProcessEvents activity updates the meetingparticipant table with the corresponding status. For the Microsoft.Communication.CallEnded event, it updates the meetinginfo Rule with the Resolved status. It then loops through all the participants in the meeting and updates their status as left in the meetingparticipant table. 

After an event is processed, Pega Sales Automation sends a notification to the UI to refresh changes using the pub-sub architecture through the Pega Constellation messaging service. For more information, see the Constellation messaging service  documentation.

Change notifications require the creation of a subscription. The system creates the subscription by using the D_CreateSubscriptionForMSTeams Data Page, when the Teams virtual meeting is created while setting up an appointment in Pega Sales Automation. By default, the subscription expires in 3 days. If the appointment is after 3 days, the system does not send the notification. A job scheduler handles this scenario, by running daily, getting the Teams appointments schedule for the day, looping through all the appointments, and creating a subscription for those appointments.

MeetingApp component

The Teams meeting app is its own Pega application component called MeetingApp. You can place this component in any application, in the Component section. Being its own component, the Teams meeting app is not tied exclusively to Pega Sales Automation. You can make it available in Pega Customer Service or any other customer application. The MeetingApp app's class structure is under the base class PegaFW-. It is placed under this class so that these rules are available to any framework due to the generic class structure, and you can add Teams to any application in the future.

In thePegaFW- class, Teams has two class structures through the subclass MeetingApp, which is present under the PegaFW-Int- and PegaFW-Data- classes. The MeetingApp subclass groups the functionality for all the meeting apps such as Zoom, WebEx, and Microsoft Teams into one central place. Teams has a subclass of its own under this subclass.

The PegaFW-Int-MeetingApp class handles the integration from Pega to any external system that Pega needs to interact with. It has all the class structure that is required to handle the JSON data model for the events that are exchanged between Pega Sales Automation and external systems.

The PegaFW-Data-MeetingApp class handles the meeting functionality for any meeting app that Pega supports. It tracks the meeting object, PegaFW-Data-MeetingApp-MeetingInfo, and the participants list for the meeting, PegaFW-Data-MeetingApp-Participants.

The rules used for the MeetingApp component are included in the PegaFW-MeetingApp Ruleset. This Ruleset is generic and might not do much until you specialize it to your application. Therefore, for any specific functionality that you want to add to the Pega Sales Automation application built with Constellation, the generic rules are saved into the PegaSA-DataTier or PegaSA-CaseTier Rulesets and are specialized. For example, if you want to add a Data Page, D_GetAttendeesNotYetJoined, save it to the PegaSA-DataTier Ruleset, and update the class to be Common-LDM-Entity-Contact (because this is the class that represents a person), then you must specialize the Data Transform as well to indicate how to get the attendees information into your application. For example, in Pega Sales Automation, the system gets the attendees information from the class associated with appointments.

Appendix

Sample permissions to add to the app

Example of creating a keystore and generating a certificate key 

1. Download KeyStore Explorer (freeware).
2. Open KeyStore Explorer.
3. Click Create a new KeyStore icon.
4. Keep the default PKCS #12, and click OK.
5. Click Tools > Generate Key Pair.
6. Keep the default RSA Key Size 2048, and click OK.
7. Keep the default, and click the Edit Name icon next to the Name field.
8. In the Common Name (CN) field, enter Pega.
9. In the Organization Unit (OU) field, enter Sales Automation.
10. In the Organization Name (O) field, enter Pegasystems, Inc.
11. In the Locality Name (L) field, enter Waltham.
12. In the State Name (ST) field, enter MA.
13. In the Country (S) field, enter USA.
14. Click OK.
15. Click OK
16. Enter the name of the keystore as MSTeams.
17. Enter a new password.
18. Confirm the new password.
19. In the confirmation dialog box, click OK.
20. Click File > Save to save the keystore.
21. Enter a new password.
22. Confirm the new password.
23. Select the location to save the keystore, and enter a keystore name.
24. Right-click the newly keystore in the list of keystores, and then click Export > Export Certificate Chain.
25. Keep the default value, and select a location to save the certificate.
26. Click Export.
27. In the confirmation dialog box, click OK.
28. Close KeyStore Explorer.
29. Open the exported certificate file by using a text editor.
30. Copy the text in between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.
31. Paste the text into a new text file.
32. Remove the trailing space in each line to merge all the lines together to form one single line.
33. Copy the single line of text as the certificate key.