Prerequisites - Before you start
Please make sure to read the Installation Prerequisites before starting the installation steps below.
The installation may require users in different roles:
|Required (or substituted by Admin), to add Nimbus service functionality to any owned team. Can configure Service Settings, some of which need to be confirmed by a Tenant admin.|
Optional, mainly concerned with the Usage of Nimbus, but not required for installation and first-time setup. Can only adjust User Settings for personal preference and grant Required User Permissions if not done globally by the Tenant Admin.
Nimbus Installation Steps
Need to Uninstall Nimbus instead?
Upload app manifest
For Nimbus to be available in your Tenant (to allow your users to install it from MS Teams Apps list) manifest needs to be uploaded first.
- Retrieve the Nimbus manifest Zip from Luware. Your Nimbus onboarding team will provide you with a download link.
You can have a look inside, but you don't need to unzip the archive for the next steps.Luware Support
Login to MS Teams as Tenant Admin
- Go to Apps
Select “Upload a custom app” option
Choose “Upload for <Your_Organization_Name>” option from the opened drop-down menu
- Select and upload the Nimbus manifest → A message "Added Luware Nimbus to the list" should confirm the successful upload.
Confirm the App's entry and new version within the "Manage Apps" Screen.
Also read on how to update an existing app further below.Luware Nimbus successfully added to the Teams Apps
Go to "Apps" in your Teams client front end and search for "Nimbus" → The Nimbus app entry should now appear in the list of Apps for all users in your Tenant.
Check the permission policies and external access
- Go to Teams Apps > Permission Policies > Global (Org-wide default)
- Check the setup for "Custom Apps" → This must be set to either "Allow all apps" or "Allow Specific apps"
If this does not, please amend to one of above. Depending on Microsoft you might have to wait 24 hours before continuing with the next steps.
- Go to Users > External access
- Allow either "all external domains" or "specific external domains"
Ensure you know about the Required Permissions for Nimbus. Consent will be requested from the corresponding users during service team provisioning and first login.
About Hybrid-Deployment: Deployments in hybrid namespaces may be possible, but are much more complex while offering no functional benefit. Luware only tests and supports service deployments in online-only namespaces.
External access required
TENANT ADMIN You need your tenant to allow external communications with Luware.com. Necessary configuration steps are described in the Microsoft Teams Documentation: Manage external Access.
Some of our customers also use the "Enhanced Presence Privacy Mode" as a global policy, which can be checked via PowerShell:
Get-CsPrivacyConfiguration | Select EnablePrivacyMode
This is a legacy policy used in Lync/SfB which is not available anymore in the Microsoft Teams Admin Center. This is a global setting and always applies to all users of the organization, and unfortunately cannot be deactivated or bypassed for individual users.
If EnablePrivacyMode is set to True, no one can see the Teams Presence status of the users via Teams Federation - and thus Nimbus functionality is completely disabled. To deactivate this policy, run the following command:
Set-CsPrivacyConfiguration -EnablePrivacyMode $false
Why are these steps necessary? Nimbus calls won't get through or distributed as the presence cannot be read. All Nimbus users will be shown as offline and cannot get call invitations.
Before you start
Nimbus can be added to any existing Team within MS Teams. If not marked otherwise, steps below can be performed either by a TENANT ADMIN or TEAM OWNER.
Provisioning a service according to steps below will automatically apply the Advanced Routing license to your service, starting with a minimum set of Nimbus Features. Contact your service partner or Luware support if you need any other Service types with their according license applied.
There is no need to create an Azure user or resource account before adding Nimbus.
First time Nimbus installation
Existing Nimbus installation
TENANT ADMIN Make sure you are the person to provision the first new Nimbus service on your tenant.
During the first installation you will be prompted to select a region for all your (future) tenant data.
After this decision the selection is fixed for your whole tenant and cannot be changed easily, as all your future Nimbus service teams and their call data are automatically stored under that tenant.
We recommend to pick the region mainly for billing (currency) and data-law reasons. Performance should not be affected by your choice.
TEAM OWNER With Nimbus already present on your tenant and at least one service team existing.
All future service provisioning can be done without having to pick a region again.
Please note that once a service has been provisioned via the steps below it is tied to a team in Microsoft Teams. It can not be easily converted to a Contact Center service. Please follow our Use Case - Setting up a Contact Center or - if you already know how to create services - learn how to manually grant individual users Service Permissions.
Add Nimbus to a Team
- There are two methods to add Nimbus to a Team:
- Go to the store and search for Nimbus. Locate the Nimbus app and click "Add "
Alternatively you can go to via Team itself, click on "Add a Tab" to install Nimbus this way.
Equal methods to add Nimbus to a team
You might be requested to log-into your O365 account to confirm the installation.
Select the team you want to Add Nimbus to:
- Read and confirm the License Terms.
Change or keep the "Service Name" (default = team name) and "UPN", then confirm.
These details can be changed later via the Service Settings.
Nimbus installation dialogue
At this point
→ Nimbus is now being installed and a Nimbus-Tab will appear within the team channel:
- All team members will be able to see the Nimbus tab and a limited set of features.
- A team UPN is configured but cannot yet be called yet. (→ Provisioning is required as described below )
- Existing team roles (owner and member) are included as Nimbus users.
- Calls from outside your tenant can't be made just yet.
Further settings are required, e.g. to assign a PSTN → Continue with the next step which will venture into the newly created team's Service Settings.
TENANT ADMIN recommended. Nimbus will ask each (new, individual) user for User Permissions. As a Tenant Admin you can give this consent once so new users are not required to do this individually.
- Open the User Settings
- Under "Admin Permissions" review and grant all required permissions. → The status changes to a Checkmark .
Why is this required and what happens if these rights are not granted? Nimbus will only support basic MS Teams functionality. Check the Required User Permissions page for more details on how to manage and revoke these rights.
Until Admin consent is granted, every new Nimbus user is added as as Team owner. Without consent Nimbus cannot verify which user is a MS Teams "Team Owner" or "Team Member". "Team Owner" is applied as default to allow fast changes to service Configuration and Service Settings. As soon as admin consent is granted the membership will be synced and only the "Team Owners" will have future access to service settings and configuration.
Adapt Service Details
Now it's time for some last adjustments to get the team publicly registered in Microsoft Azure (Cloud) and assign a PSTN (if required).
This step should be done in conjunction with the (future) Service Team Owner and the Tenant Admin on standby.
Precondition: Nimbus has been added to a team → The Nimbus tab is visible for that team.
- When opening Nimbus via the Tab for the first time you are required to log in. Afterwards you will be presented with a screen like the following:
- Go to the Service Settings > "General" Tab
- Double-Check Service Display Name and UPN and adapt as needed.
If you are hybrid deployment, use the online-only namespace such as "lunifico.onmicrosoft.com" to avoid issues. Also refer to our → preconditions on top of this page.
- Optionally you can also assign an external PSTN / E.164 number for your Nimbus team. This requires additional licenses distributed by Microsoft. (Learn more → Refer to "Microsoft 365 Phone System - Virtual User")
- Confirm your changes with "Safe & Trigger". Your tenant admin will need to run the provisioning script to apply these changes
Why is this needed? The Script run will require Tenant Admin TENANT ADMIN permissions as it will connect to Azure and register the service or potential settings.
Note that any changes will always require another Script Run / Runbook Re-Trigger. Details are explained in the next step.
Script Run & Test Call
TENANT ADMIN required task: Each service settings change that affects the endpoint or licensing must be confirmed by a Tenant Administrator. When setting changes are complete, execute the PowerShell script and follow instructions inside.
Infos on the Script
The Nimbus provisioning scripts are automatically propagated with the necessary team information, so there is no need for you to update or manipulate the script manually.
- Upon first execution the script may automatically download necessary dependencies on your system.
- The script is version-controlled, so trying to execute an outdated version will result in an error message and a link where the latest version can be found.
- Every change to the team (e.g. UPN, PSTN or other vital Service settings) will require a re-execution of the script by any user with tenant administrator rights. Other settings without script & execute indicators are applied immediately.
- Changes to the PSTN / E.164 settings are depending on Microsoft's response time and outside of Nimbus "jurisdiction". Please allow for at least 5 minutes for any changes to apply to Azure.
- TEAM OWNER recommended task: Once the script was executed by an administrator all endpoint and necessary licenses should be established.
You can now start a Test Call (available within Service Settings > "General" tab) to see if the bot is taking calls and routing them towards your new (service) team.
Note that test calls are treated like any other call and are counted towards the Reporting metrics. They should be reflected in Nimbus reporting tabs accordingly.
Note that test calls will only contact the UPN of the service. If you want to test PSTN functionality, you have to make a manual phone call.
All done? Some recommended next steps
- Once basic setup is complete you can start the Configuration of your service, e.g. to test various Service Settings, Workflows and other features.
- We recommended to add further "Active" Nimbus service users to your team to handle the incoming test calls in a "closer to real life test scenario".
- Once you are happy with the results, check out our List of Use Cases for.
Optional: Personal App
Add Nimbus to your MS Teams sidebar
In Teams, open the "..." Options dialogue and search for "Nimbus"
Locate the Nimbus app and click on it for more information.
Depending on your partnership Luware and the App installed the name variant of the Nimbus App may vary
Read and confirm the Licensing agreement.
To add the app to your sidebar, click "Add".
You might be requested to log-into your O365 account to confirm the installation.
At this point you should be able to access the Personal App directly from the sidebar.
We recommend pinning it to the sidebar so you always have quick access.
Congratulations! You can start using Nimbus via web login (see "Portal/Admin" links at the top right of this page), access the new Nimbus Teams Tab created after the successful installation.
|Users||Recommended topics to read|
All new Nimbus users