How to use the CallCabinet for Microsoft Teams Installer

 

Overview

This document describes what will happen in the background when you run the CallCabinet for Microsoft Teams Installer. This document explains what is created in your organization’s Azure Tenant and how that affects your environment.

*Important* 

Please make sure that only a person with full administrator access to your organization’s Azure Tenant and Active Directory runs this tool.

The person running this tool should also have administrator access for Microsoft Teams as Microsoft Teams will require configuring by the bot.

Should your administrator encounter any issues while running the installer, please refer to this troubleshooting article.

 

Step 1 – Obtaining the script

1. Login to CallCabinet with your CallCabinet account.
2. If you have one company registered on this account, you will be redirected to the installation page automatically. However, should you have more than one company registered on this account, please select the company for which the installation is required.
3. Using the left navigation menu, go to Settings -> Site Management
4. On the Site Management page, click the Provision button for Microsoft Teams.
5. This page provides all the instructions you need to successfully install the Teams bot. Click on the download button, as indicated by 1 in the image above and download the script. Save it in a location that you will remember on your local drive.

 

Step 2 – Run the Script

Proceed to the location where you saved the script on your local machine. Left-click on the script and select “Run with PowerShell”.

PowerShell opens and the script begins executing.

 

Initialization

When the script is executed, it will first initialize and load your Customer Configuration. If a customer configuration does not exist, we will use the default Customer Configuration and create your Configuration with the initial execution.

 

Step 1 – Action Selection

Click on the New Installation button to start a new installation using the automation tool.

Use For:

• New initial installation for CallCabinet Recording for Microsoft Teams.
• Re-Install where Remove Installation was successfully completed.

 

Step 2 – Validation of required modules

For security reasons, the tool will validate and install (if missing) any of the following required PowerShell modules on your organization’s environment where the installer is executed. These modules enable CallCabinet to automate the CallCabinet for Microsoft Teams Installer’s installation process.

These modules are:

• Nuget Provider
• Az.Accounts
• AzureAd
• Microsoft Teams

 

Step 3 – Recorder hosting

Select whether CallCabinet should host the recording components, or if you would prefer to host the recording components yourself.

Note: Hosting the recording components in your own tenant might incur additional costs.

 

Step 4 – Login to your organization’s Azure Account

4.1) If ‘Own Tenant’ is selected during Step 3 above

4.1.1) Your organization’s administrator logs into your organization’s Azure Tenant using an administrator account. The installer will then automatically fetch all the required resources including Countries, State/Regions, Azure Regions and the Subscriptions associated with the Azure Tenant that is logged in.

4.1.2) Your organization’s administrator then needs to select the appropriate Country, State/Region, Azure Subscriptions, Azure Region, CallCabinet site and provide an Estimated Number of Recorded Users for the initial installation to continue.

4.1.3) You will have the opportunity to change the Azure Resource and MS Teams configuration naming for resources; Resource Group, Add Resource Group Tags, Bot Service, Add Bot Service Tags, Bot Application Registration, Recording Policy, Recording AD Group and Application Instance.

If you do not wish to change the naming of any of these resources, you can use the default naming by clicking the “Confirm” button.

4.2) If ‘CallCabinet Tenant’ is selected during Step 3 above

4.2.1) Your organization’s administrator logs into your organization’s Azure Tenant using an administrator account.

4.2.2) Your organization’s administrator then needs to select the appropriate Country, State\Region, CallCabinet Site and provide an Estimated Number of Recorded Users for the initial installation to continue.

 

Step 5 – Create and register CallCabinetBot for Microsoft Teams

5.1) If ‘Own Tenant’ is selected during Step 3 above

The installer will now do the following automated tasks on your organization’s Azure Tenant:

1. Create a new Resource Group “CallCabinetBot” in your Azure Tenant.
2. Create and configure a new Azure Bot in the CallCabinetBot Resource Group.
3. Configure Microsoft Teams Channel for the new Bot.
4. Create and Configure Azure Recording Application in your Azure Tenant.
5. Set API Permissions for Recording Application.
6. Register your new Azure Bot with the CallCabinet Teams Recording service.
7. Create new Microsoft Teams Recording Policy in your Microsoft Teams instance.
8. Create new Recording Group in your Azure Active Directory.

Any exceptions (errors) during this process will be displayed in the output box of the installer. Should a severe exception occur, your organization’s administrator may be forced to close the application and contact CallCabinet support for assistance. Should there be no or less severe exceptions, your administrator will be able to continue with the process.

5.2) If ‘CallCabinet Tenant’ is selected during Step 3 above

The installer will now do the following automated tasks on your organization’s Azure Tenant:

1. Create the relation between your tenant and the MultiTenant Bot and Application hosted in the CallCabinet Tenant.
2. Register your MultiTenant configuration with the CallCabinet Teams Recording service.

 

Step 6 – Bot Application Consent

6.1) At this point, the installer will request to confirm consent for the required permissions in your organization’s Azure Tenant.

6.2) The required permissions will be displayed and your organization’s administrator will need to give consent. The required permissions are:

• Read all call records
• Access media streams in a call as an app
• Initiate outgoing 1 to 1 calls from the app
• Initiate outgoing group calls from the app
• Join group calls and meetings as an app
• Join group calls and meetings as a guest
• Read online meeting details
• Read and create online meetings
• Read all users’ full profiles
• Sign in and read user profile

Upon clicking ‘Accept’ your administrator will be redirected to a CallCabinet web page that will acknowledge consent, before returning to the installer.

 

Step 7 – CallCabinet acknowledges

Your organization’s administrator will see the CallCabinet web page that acknowledges consent provided. This page can then be closed to return to the installer.

 

Step 8 – CallCabinet Redundancy Bot

This page will only be available if you have redundancy on your Purchase Order and Redundancy service has been enabled by a CallCabinet Support Engineer in the CallCabinet portal. If you have any queries, please reach out to your CallCabinet Account Manager.

 

On this page you have an option to create an Redundancy Bot for your solution. If you do not wish to add an redundancy bot, you can leave the checkbox unchecked and click on the ‘Next’ button to continue with the installation.

When creating a Redundancy Bot, mark the ‘Create Redundancy Bot?’ checkbox and select the Host for the Redundancy Bot.

Similar to Step 3 this will determine where the Redundancy Bot is Hosted. Either in your Own Tenant or in the CallCabinet Tenant. We support all possible configuration combinations between the Main Recording Bot and Redundancy Bot.

• Own Tenant – Own Tenant
• Own Tenant – CallCabinet Tenant
• CallCabinet Tenant – CallCabinet Tenant
• CallCabinet Tenant – Own Tenant

Should you select ‘Own Tenant’ as the Host for the Redundancy Bot, please select the following configuration properties:

• Azure Subscription
• Azure Region (Note: You will not be able to select the same Region you selected for the main bot. This is to ensure if a region is out of service, the bot in this region will record normally)
• CallCabinet Site (Note: You can select the same site as with the main bot. This will enable parallel recording, calls will be stored in the CallCabinet Cloud Storage container and missed calls processed to the site on a daily basis. If a different site is selected all calls will be uploaded to the second CallCabinet Site.)

Should you select ‘CallCabinet Tenant’ as the Host for the Redundancy Bot, please select the following configuration properties:

• Azure Region (Note: You will not be able to select the same Region you selected for the main bot. This is to ensure if a region is out of service, the bot in this region will record normally)
• CallCabinet Site (Note: You can select the same site as with the main bot. This will enable Parallel recording, calls will be stored in the CallCabinet Cloud Storage container and missed calls processed to the site on a daily basis. If a different site is selected all calls will be uploaded to the second CallCabinet Site.)

Click the ‘Next’ button to create the Redundancy Bot.

This step creates the same objects as described in Step 5 when creating the Main Bot.

After the Redundancy bot is successfully created. Click the ‘Next’ button to continue.

You will then need to Accept Permissions for the Redundancy Bot. This is the same permissions listed in Step 6 when creating the Main Bot.

After providing consent. Click the ‘Next’ button to continue the process.

 

Step 9 – Resource Confirmation

If ‘CallCabinet Tenant’ is selected during Step 3 above. You will have the opportunity to change the MS Teams configuration naming for resources, Recording Policy, Recording AD Group and Application Instance.

If you do not wish to change the naming of any of these resources, you can use the default naming by clicking the “Confirm” button.

Step 10 – Login to Microsoft Teams

Your organization’s administrator will need to login to your Microsoft Teams instance using an administrator account. The CallCabinet for Microsoft Teams Installer will then automate the following tasks in your organization’s Microsoft Teams instance and Azure Active Directory:

• Create Application Instance
• Create Compliance Recording Policy
• Create Compliance Recording Application
• Set Compliance Recording Policy
• Set Compliance Recording Application
• Create Azure AD Group
• Assigning Group Policy to AD Group

Should you have opted to create a Redundancy Bot to your solution, your administrator will be prompted to login to your Microsoft Teams instance using an administrator account a second time. The CallCabinet for Microsoft Teams Installer will then automate the following tasks in your organization’s Microsoft Teams instance and Azure Active Directory:

• Create Compliance Recording Application
• Set Compliance Recording Policy
• Assigning Main Bot Group and Recording Policy to the Redundancy Application Instance

If required, you can override the UPN domain used to create the Application Instance. To do so, please:

1. Click ‘Override UPN Domain?’ checkbox.
2. Enter the required domain.
3. Click the ‘Save’ button.

After saving the process continues normally by logging in to Microsoft Teams.

 

Step 11 – Activation of CallCabinet functionality

Upon successful completion of the required steps as explained above, the installer will automatically create a CallCabinet Support Ticket for activation of the recording functionality. CallCabinet will then activate your organization’s recording functionality and confirm back to your organization’s administrator by replying to the same CallCabinet Support Ticket.

Should your organization’s want to continue finalizing your organization’s setup at this point, they are free to continue with the next step while waiting for the activation process described above.

 

Step 12 – Setting up users to be recorded

This is the final part of the process. Your organization’s administrator will now need to specify which members (users) of your organization will be recorded by CallCabinet. Please refer to this article on how to do this.

Once you’ve set up all the users, your organization is all set to experience the power of CallCabinet. We trust it will bring immense value to your organization. Should you experience any difficulties, please contact CallCabinet Support.