Build the TeamMate Connector Application
Table of Contents
Scope
Intended Audience: White Label Partners, Tier `1 Technicians or higher
This document will show you how to build a custom application for Teams.
Requirements
- Access to the Reseller Provisioning Portal
- Access to the Enterprise Provisioning Portal
- Custom apps enabled at the organization level in Microsoft Teams Admin
- A Microsoft Global Admin user that has a Teams-capable license assigned to it
Setting up the application:
- Log into the TeamMate Reseller Provisioning Portal
- Click App Templates
- Fill out the fields with the following info:
- Version: Update any time you make a change to the app.
- Dev Name: This will show the name of the publisher who created the app in the app store.
- Short Name: Used in the app store and as a header.
- Full Name: Please populate with the same info as section C above - Short Name.
- Short Description: This is used in the app store to help users recognize that they have found the correct app when they do a search.
- Full Description: This will appear as the body of the content on the “About” tab in the app.
-
Team Name: The name of the Microsoft Team for this organization. Each user of the connector within the organization will be a member of this Team. Note: This cannot be deleted once it is created.
If you are using Microsoft licenses intended for governmental use you will need to create the team manually in Teams first, then input the name of that team in this field.
Terms of Use URL: Enter the Reseller's terms of use URL link. By default, this will connect to TeamMate's terms of use. If you would like to copy that data into a page of your own and link to it on your own domain the direct link to TeamMate's policy is https://www.teammatetechnology.com/terms
Website URL: Enter the URL of the Reseller’s website.
Privacy URL: Same rules as the terms of use. The direct link to TeamMate’s terms of use is: https://www.teammatetechnology.com/privacy-policy/
Application Branding Icons: These are icons that will be associated with the Application in Teams. The default will be either the TeamMate swirl or a graphic chosen by the reseller, but you can change this to anything you want (your logo, the Enterprise logo, a telephone graphic, etc.) following Microsoft graphical sizing parameters (192 by 192 pixels and 32 by 32 pixels in transparent .png format).
Portal Single Sign-On Tab Name: If you are planning on using the SSO Portal, you must first set up the PBX SSO settings from the Manage PBX Page. See the screenshot below. As soon as you're done, enter the name of the Tab you want to see. Note: Leave the field blank if SSO is not needed.
PBX Softkeys Management Tab Name: If the enterprise uses feature codes they can be presented in the Teams Application. Choose a name for the tab they will appear on. See more about configuring feature codes here.
Show Card on Inbound/Outbound Call?: This checkbox allows you to control the In-Call and Post-Call notification cards that appear when a call connects through the PBX and when a call ends in the Team Application.
Select Accent Color for Logo: Use the Accent Color to select the color that you would like, press CHOOSE, and the Accent Color will be selected. If your logo has any transparent parts this is the color that will be shown in those areas.
Configurable Tabs: The order in which the tabs in the application appear can be changed with this menu. Drag the tabs to the right-hand box in the order you wish them to appear. Tabs in red are mandatory per Microsoft; tabs in black are optional, so only add the ones the enterprise will be using. The best practice is to put the most-used tab first for a better UI experience. If you intend to use presence monitoring, please ensure you enable the "PBX Softkeys" tab, as that is where that feature is activated.
Select Save PBX Application Template once you're finished editing.
Deploy the Application
- Log into the Enterprise Provisioning Portal using a Microsoft Global Admin account for the organization.
- Under Enterprise Action Items, select Sync PBX App
- An Office365 Permissions requested dialog should appear: Select Accept
- After a few minutes, you should receive 3 notifications saying the Team and application were deployed successfully.
Set Up Application in Teams
- Select More added Apps in Microsoft Teams.
- Search for the Name of the App and click the three dots.
- Select Pin to keep the app on your Teams Account.
This is what a completed app pinned on the Teams application will look like: