Before you start
☝Please note that Nimbus operation is not possible until your Tenant is configured on Luware side. Read the Installation Prerequisites to learn about related concepts such as Required App Permissions and License Management details for Nimbus apps, users and services.
Once you are ready, get in touch with your Customer Success contact. Once the Tenant details are set, you can start with the installation steps below.
🔎Note that The installation involves users in different Roles:
TENANT ADMIN |
Required - needs to upload the Nimbus app to your tenant and confirm certain Service Settings changes made by team owners via Provisioning Script. 🤔 How can I get Tenant Administrator rights? Create a new security group in Azure AD (or choose an existing one) and send us its Object ID. ☝ Don’t forget that you need to be a member of this security group. Group owners will not be taken into account. Click to learn how to create a security group...Create new security group
Define group details
Tenant name and Object ID
|
TEAM OWNER | 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. |
TEAM MEMBERS | Optional - Mainly concerned with the Usage of Nimbus, but not required for installation and first-time setup. Can only adjust User Preferences (Portal) 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
TENANT ADMIN Actions on this page require MS Teams administrator rights to access the Microsoft Teams admin center and perform app updates on your tenant.
INC App Manifest Update notice
Update Notice - Nimbus App Manifest
In March 2024 the new Microsoft Teams client will be unavoidable and rolled out by Microsoft for all users. Older versions of the Nimbus App Manifest will not support SSO (Single-Sign-On) and will cause problems on the new Teams client.
✅ Tenant Admin Action required: If your Nimbus App in use is lower than version 1.0.23166 you must update the Nimbus Personal App on your tenant immediately. After the Teams client rollout your App will be rendered inoperable.
You can retrieve the newest app manifest here:
Nimbus App Manifest URLs
Switzerland 01 | https://portal.ch-01.luware.cloud/api/manifests/V1/Nimbus.zip |
---|---|
Switzerland 02 | https://portal.ch-02.luware.cloud/api/manifests/V1/Nimbus.zip |
Germany 01 | https://portal.dewe-01.luware.cloud/api/manifests/Nimbus.zip |
Germany 02 | https://portal.dewe-02.luware.cloud/api/manifests/Nimbus.zip |
United Kingdom 01 | https://portal.ukso-01.luware.cloud/api/manifests/Nimbus.zip |
Australia 01 | https://portal.aue-01.luware.cloud/api/manifests/Nimbus.zip |
West Europe 01 | https://portal.euwe-01.luware.cloud/api/manifests/Nimbus.zip |
East United States 01 | https://portal.use-01.luware.cloud/api/manifests/Nimbus.zip |
Manifest upload
For Nimbus to be available in your tenant (and to allow your users to install it from MS Teams Apps list), the app manifest needs to be uploaded first. To do so, perform the following steps:
-
Retrieve the Nimbus manifest ZIP file from Luware.
💡 You can have a look inside, but you don't need to unzip the archive for the next steps.
INC Nimbus App Manifest URLs
Switzerland 01 | https://portal.ch-01.luware.cloud/api/manifests/V1/Nimbus.zip |
---|---|
Switzerland 02 | https://portal.ch-02.luware.cloud/api/manifests/V1/Nimbus.zip |
Germany 01 | https://portal.dewe-01.luware.cloud/api/manifests/Nimbus.zip |
Germany 02 | https://portal.dewe-02.luware.cloud/api/manifests/Nimbus.zip |
United Kingdom 01 | https://portal.ukso-01.luware.cloud/api/manifests/Nimbus.zip |
Australia 01 | https://portal.aue-01.luware.cloud/api/manifests/Nimbus.zip |
West Europe 01 | https://portal.euwe-01.luware.cloud/api/manifests/Nimbus.zip |
East United States 01 | https://portal.use-01.luware.cloud/api/manifests/Nimbus.zip |
- Login to MS Teams Admin Center as Tenant Admin.
- Go to Teams apps → Manage apps.
- Select the option Upload new app.
-
Click the Upload button and select the manifest ZIP file.
⮑A "New app added" message should confirm the successful upload. - Verify the app's entry and new version within the Manage apps Screen.
Need to update an existing Manifest?
To update an existing Nimbus app (e.g. with a new manifest):
- Using a Tenant Admin account, login to the MS Teams admin center
- Go to Teams apps > Manage apps
- Select the existing Nimbus app entry
- Under "New version", select "Upload file"
Differences in Setup: App centric | Permission policies
Microsoft is in the process of migrating their user centric app permission policies over to app centric management. Please choose the option that applies to your Teams tenant.
App centric management introduces new admin settings to control who in the tenant can install Teams apps. First, admins can set a default value for new apps that are published to Teams app store. Second, admins can edit the availability of an app to 'All users can install', 'Specific users and groups can install', or 'No user can install'. This feature evolves the existing app permission policies and provides admins with the ability to manage access to the app individually. The app permission policies for existing customers are migrated to maintain existing app availability in the tenant.
More information on app centric management can be found here:
https://learn.microsoft.com/en-us/microsoftteams/app-centric-management
New: App centric management
- On the Manage apps page for the uploaded Nimbus app, go to the Users and groups tab.
- Ensure that the app is made available to all of your Nimbus end users and administrators.
💡We recommend making the app available to Everyone to decrease your management overhead, as only configured and authenticated users will be able to sign-in.
Legacy: Check app permission policies
- Still within Teams Admin Center, go to Teams Apps → Permission policies
- Add a new permission policy entry to the list
- For each app permission policy that will be assigned to your Nimbus administrators and end users, check the settings for custom apps. This must be set to either Allow all apps or Allow specific apps. If this is not the case, please amend it to one of above.
💡Note that changes may take a while before fully replicated throughout MS Teams, eventually making the Nimbus app become visible to your users.
Inform your users to adopt the update
- After each successful app manifest change, you may want to inform your local Nimbus users about the update. Pop-ups in MS Teams will also inform users that new versions are available.
- Note that users with the Nimbus Personal App installed will need to click View update and install the app via Update.
- The update notice may also appear for Teams using the Nimbus Teams Tab. In this case, the update needs to be confirmed by either a tenant admin or team owner.
Manifest updates and end user experience
While optional in most cases, app updates are always disruptive to an extend. To keep impacts low, we will inform you in our Release Notes, and communicate significant changes in advance whenever your app manifest should or must be updated.
In any case, be aware of the following changes after an app update:
- Permission changes: App updates may entail changed User Permissions and App Permissions as well as changes to the available User Login and Settings experience. Make sure to read the Introduction to Nimbus and our Security Whitepapers to learn how Nimbus uses this data.
-
Single sign-on (SSO): Nimbus supports single sign-on, reducing the amount of necessary logins for Nimbus, especially in a multi-service-participation scenario for your MS Teams users.
🔍 After initial consent, the login token from MS Teams will be used for Nimbus as well. See also User Preferences (Portal). - ✅ SSO requires the latest app manifest to be installed on your tenant. Note that after a new manifest update, each Nimbus user needs to confirm the Nimbus app update as described in the step above. This will grant permissions for individual login token usage and enable the latest single sign-on features.
💡 Good to know: When your userbase exclusively uses Nimbus in-browser, the manifest update and notify procedures described on this page do not apply. However, users will always need to sign-on every time they open Nimbus in a browser, regardless of their login status in MS Teams.
Follow-Up: Service Provisioning
✅Once the Nimbus App is installed on your tenant, you can start with Service Provisioning. Note that further Installation Prerequisites such as externally supplied PSTN Licenses and Nimbus License Management contingencies come into play.
🔎In case you want to set up a service outside of your MS-Teams, refer to Use Case - Setting up a basic IVR Service and Use Case - Setting up a Contact Center respectively.
Learn how to do this
Service Provisioning
Before you start
The Nimbus Installation must be completed before you can start with Service Provisioning.
☝Please note that Service Provisioning is not possible until your Tenant is configured on Luware side. Read the Installation Prerequisites to learn about related concepts such as Required App Permissions and License Management for Nimbus Apps and Services. Note that additional User Permissions will be requested from all onboarded Nimbus users during service team provisioning and first user login.
Once you are ready, get in touch with your Customer Success contact.
INC Nimbus External Access Requirement
EXTERNAL ACCESS REQUIRED
TENANT ADMIN You need your tenant to allow external communications with the "luware.com" domain.
Learn more about managing external access
🔍 The necessary configuration steps are described in the Microsoft Teams Documentation: Manage external Access.
You will also need to disable the "Enhanced Presence Privacy Mode" policy which prevents visibility of the Teams Presence.
About the "Enhanced Presence Privacy Mode"
The "Enhanced Presence Privacy Mode" is a global configuration which, if enabled, prevents all external organizations from viewing the Teams Presence status of your users via Teams Federation.
If this mode is enabled, Nimbus will see all users as permanently Offline, and thus won't be able to distribute calls to them.
☝ This is a legacy configuration option used in Lync / Skype for Business which is not available anymore in the Microsoft Teams Admin Center. It can only be viewed and configured via PowerShell. As a global setting it applies to all users and cannot be deactivated or bypassed for individual users.
✅ To check whether this is enabled in your tenant by running the following PowerShell command:
Get-CsPrivacyConfiguration | Select EnablePrivacyMode
The command will return "True" if the Enhance Presence Privacy Mode is enabled, or "False" (default value) if it is disabled.
✅ To deactivate it, run the following PowerShell command:
Set-CsPrivacyConfiguration -EnablePrivacyMode $false
🤔 Why are these steps necessary? Without being able to read the Teams presence data of your users, Nimbus will consider them as Offline and thus not available for call distribution. They will not be able to receive any inbound calls or place any outbound calls via Nimbus.
Provisioning Steps
GOOD TO KNOW
Nimbus can be added to any existing Team within MS Teams. If not marked otherwise, all steps below can be done performed either by a TENANT ADMIN or TEAM OWNER.
🔍 Determine who can provision services: Administrators may change the minimum role needed or completely disable provisioning of new teams via Tenant Administration > Provisioning.
💡 License Management Note: Provisioning a service according to steps below will automatically apply the Advanced Routing license to your service the default set of Nimbus Features. Contact your service partner or Luware support if you need any other Service types with the according license contingency.
☝Before starting your provisioning, please note:
First time Nimbus installation | Existing Nimbus installation |
---|---|
TENANT ADMIN - Make sure you are the FIRST person to provision the first new Nimbus service on your tenant. Only during the first installation you will be prompted to select a region for all your (future) tenant data. Refer to the Introduction to Nimbus and our Whitepapers in the Documents section for more details on which data gets stored. ☝ After this decision is made, tenant data is stored on the corresponding region. This first selection cannot be changed, 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 / compliance 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, future Service Provisioning can be done without having to pick a region again. |
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 "
OR - Navigate to the Team itself, click on "Add a Tab" to install Nimbus this way.
- Go to the store and search for Nimbus. Locate the Nimbus app and click "Add "
Equal methods to add Nimbus to a team
💡You might be requested to log-into your O365 account to confirm the installation.
💡If a Nimbus service already existed for this team, the previous tab will be restored.
-
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 General Service Settings
-
Select an Organization Unit (OU) for your new service.
🤔 What is this? The OU determines placement and visibility of the new service, its users and related Configuration resources. 💡 This can be changed later via General Service Settings.
💡 When uncertain what to select here, leave this setting at its default.
💡 Note that this field may be disabled or hidden depending on your logged-in user rights.
→ 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 can access Nimbus Features.
- Note that the Service UPN is defined but cannot yet be called yet. (→ A script provisioning script run is required as described below)
- Existing MS Teams roles (owner and member) are included as Nimbus users. More on this in Role Access Concept.
- Calls from outside your tenant can't be made just yet. This requires a PSTN license assignment.
✅ 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.
Grant Consent
TENANT ADMIN recommended. Nimbus will ask each (new) user for Required User Permissions. As a Tenant Admin you can give this consent once so users are not required to do this individually.
- Open the User Preferences (Portal)
- 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. Read Required User Permissions for more details on how to manage and revoke these rights.
Adapt Service Details
Now it's time for some last adjustments to get the team publicly registered in Microsoft Azure (Cloud) and assign and – if required – add an externally reachable PSTN.
✅ Precondition: Nimbus has already been added to a team → The Nimbus tab is visible for that team. This step should be done in conjunction with the (future) Service Team Owner and the Tenant Admin on standby.
- 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 SIP-address and adapt them as needed.
💡 If you are hybrid, use the online-only namespace such as lunifico.microsoft.com to make it simpler. - 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 "SAVE & APPLY".
- TENANT ADMIN Your tenant admin needs to run the provisioning script to apply changes marked with a ☝ warning sign.
🤔 Why is this needed? The Script run will require Tenant Admin permissions as it will connect to Azure and register the service or potential settings.
✅ Note that future changes will always require another Script Run. Details are explained in the next step.
Script Run & Test Call
TENANT ADMIN required. Each service settings change that affects the call endpoints or phone number licensing must be confirmed by a Tenant Administrator: When all settings are to your liking, execute the PowerShell script and follow instructions inside. |
TEAM OWNER Optionally: Once the script was executed by an administrator the call endpoints and necessary licenses should be established. |
The script can be downloaded via your User Preferences (Portal) page or by using the following links: Nimbus Provisioning Script URLs
|
RECOMMENDED: TEST CALL
You can now start a Test Call (also available within General Service Settings) to see if the bot is taking calls and routing them towards your new (service) team. Read the next steps below to configure your new service.
|
💡 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.
|
💡Note that test calls are made to the UPN of the service. PSTN calls you need to test with manually dialing from a user with an according PSTN license or using your cell phone. 🔍Test calls are treated like any other call and are counted towards the Reporting metric. They should be reflected in Nimbus service reporting tabs accordingly. |
Recommended next steps
- Familiarize yourself with the Role Access Concept system of Nimbus.
- Test the Login to the Nimbus front- and admin panels either in the Teams App or a separate browser window.
Frontend (Portal) URLs |
Admin Panel URLs |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nimbus Portal URLs
✅ Make sure to configure your web proxies to allow access to these domains or whitelist the complete *.luware.cloud domain.
|
Nimbus Admin URLs
✅ Make sure to configure your web proxies to allow access to these domains or whitelist the complete *.luware.cloud domain.
|
-
Start customizing Nimbus to your liking:
- Once basic setup is complete you can start the Configuration of your service, e.g. to test various Service Settings, Workflows, Opening Hours.
- As a great starter we recommend Use Case - Creating a Call Workflow. Check out our Use Cases category for further inspiration.
- We recommended adding more Nimbus users to your new service team to verify any changes to your settings in a test call scenario.
- Once you are familiar with your first service, learn more about the other Service types and their related features.
Optional: Install the Personal Nimbus App
✅Every Nimbus user can optionally follow the Personal App Installation steps and use the Nimbus Personal App directly in their MS Teams client. The app is a quick way to access personal Nimbus service functionality without having to leave MS Teams.
Learn how to do this
Personal App Installation
PRECONDITIONS
The Nimbus needs to be provisioned by your Tenant Administrator first before the Personal App can be added to your Teams client.
🤔 What does this App do? The App opens Nimbus portal (the frontend UI) in your Teams application for easy access. You can still continue to use Nimbus in your browser. A link to the Nimbus portal is located on top of this Knowledge Base and within the App itself.
💡 Installing the personal app optional. Once you are part of a service team Nimbus continues to function and distribute calls without the it. We recommend using app for users of multiple service teams as it conveniently aggregates access and data to all your teams.
Add Nimbus to your MS Teams sidebar
In Teams, open the "..." Options dialog and search for "Nimbus" |
Adding the Nimbus App to MS Teams
|
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. 💡 Nimbus stores personal information during use. Make sure you read the privacy policy and terms of use carefully. |
Pinning the installed Nimbus App to the sidebar
|
To add the app to your sidebar, click "Add". 💡 You might be requested to log in to your O365 account to confirm the installation. 🔍 Please note that Nimbus will ask for Required User Permissions which might change with future updates and expanded Nimbus Features. Make sure to review the permissions on a regular basis. |
|
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. |
Getting Started
🌟 Congratulations! You can start using Nimbus via web login in your browser (see Portal and Admin links at the top right of this page), or access the Nimbus Teams Tab created in your MS Teams client after your first successful Nimbus Service Provisioning .
Users |
Recommended topics to read |
---|---|
ALL new Nimbus users |
|
TENANT ADMIN |
|
TEAM OWNER (Service Owners) |
|
TEAM MEMBERS (Service Users) |
|