Microsoft Power Automate Connector
Nimbus supports MS (Microsoft Power Automate) by providing a separate Connector called "Luware Nimbus".
Some possible use cases could be:
- A Simple Notification: Retrieve Nimbus Task -> Task gets Lost → Trigger an E-Mail
- Live-Data Exchange during Calls: On Updated Nimbus Task → Retrieve caller Info → Request Task Details from your CRM or User Directory → Update the Task Details
- Call-Routing according to lists and parameters: e.g. VIP or Blacklist handling of calls based on Whitelists / Blacklists you keep within your service team.
Preconditions
- A Microsoft Power Automate subscription with "Premium Tier" license is required to set up the necessary connectors in your Flows.
Note that the pricing for these accounts is determined by Microsoft and outside your Luware subscription.
- Flow interaction requires an existing Nimbus service / team to be provisioned on your tenant. Power Automate Trigger Events react to activities in currently active Workflows – as defined per Workflow Service Settings. More on this in the Trigger Events chapter below.
- You need either Team Owner or Tenant Administrator to set up these Flow tasks.
We recommend setting up flows as a Tenant Administrator as you have full access to services and related data entities within their respective Organization Units. This is also reducing the risk that flows stop working as data entities move or become unavailable due to permission constraints. More info on this in the "User Access per Role" chapter below.
Add Nimbus Power Automate Connector to your Tenant
Add Custom Connectors
- Log into your Microsoft Power Automate https://flow.microsoft.com account
- Expand the "Data" menu item on the left panel and select Custom Connectors
- Add the top right, click "New custom connector" and select "Import an OpenAPI file"
- Enter Nimbus and the environment (e.g. Nimbus Production), then choose the OpenApi file according to your data cluster location: Power Automate API URLs:
How can I find out my location? The location of your data cluster is picked once during the first Service Provisioning. You can also see it in your browser URL when logging into the Nimbus Administration which redirects you to the location where your Nimbus instance is installed.
Define Connector Details
- Unfortunately a couple of things can not be specified in the OpenApi File. So we will need to edit them manually now.
- Upload the connector icon
- Set the Icon background color to #6E2878
- Upload the connector icon
Create an App Registration in your Azure Tenant
Register a new App on your Azure Tenant.
Refer to: https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app
How to register a new Azure App- Go to portal.azure.com > App Registrations > New registration
- Name your application "Luware PowerAutomate Connector"
→ The end result should look like this:
Keep this page open as you will need the Application (client) ID later.
Create the Application Secret for your new App.
Learn more at https://learn.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#add-a-client-secret
Fill out your Flow Config as follows. Use your ClientId and Resource URL and fill out the Client secret with the step above.
Note that these values are unique to you. Screenshots below are just examples.
Field
Description
Filled-out App
Auth Type
OAuth 2.0 (automatically filled)
Identity Provider
Attention: By default Generic OAuth 2 is selected → Select Azure Active Directory
Client ID
Application / Client ID
Taken from Azure App Registration (Overview > "Application (client) ID") → See previous step above.
Client Secret
Application / Client Secret
Taken from Azure App Registration (Certificates & secrets > Client secrets > New client secret > "Client Secret Value" → See previous step above.
Make sure to paste the secret itself, not the Secret ID.
Login URL
https://login.windows.net/ (automatically filled)
Tenant ID
common (automatically filled)
Resource URL
Same as Application / Client ID
Taken from Azure App Registration (Overview > "Application (client) ID") → See previous step above.
Scope
https://graph.microsoft.com/User.Read (automatically filled)
Redirect URL
https://global.consent.azure-apim.net/redirect
Will be automatically filled in once the connector is created → See next step below.
- Click on "Create connector".
The Redirect URL will be filled in automatically.
In Azure, make sure to enter the Redirect URL in your Enterprise Application Registration.
Show me how...- Add the Redirect URL:
- Check your App registration , should have at least 1 Redirect URL and 1 secret.
- Add the Redirect URL:
- Test your connector: On the last page of the connector creation process you can test your connector.
"New Connection" and sign in with the account with which you will be creating the flows.
Connection refused? Your tenant admin needs to give consent on the "User.Read" Permissions of the Nimbus App registration. This will allow you to Sign-In on the connector on behalf of the tenant administrator.
Delegated User.Read Permission required for the Connector
Optionally share the connector with other owners / users if needed. When doing so, please keep the following notes in mind:
Sharing the Connector
- All users which need access to a shared flow to also need to be granted access to the Nimbus Power Automate Connector App itself.
- Keep in mind that each user accessing the Nimbus connector also needs a Microsoft Power Automate license to create flows.
Microsoft product licensing cost are outside of Luware scope.
- Nimbus grants connector access only to Nimbus Service / Team Owners or Administrators Roles with according Permissions on your Tenant.
New users sharing the connector require the according role assigned (within User Administration ). Also refer to Service Permissions for more details on how user rights are granted per service.
Most of our customers create Nimbus Power Automate Flows with a service account that is also Nimbus Tenant Admin at the same time. This ensures unhindered access to all services and their required flows while keeping maintenance on a minimal level.
Next Steps
You are now ready to use the Nimbus Connector within a Flow.
- As you clicked "Create Connector" in the earlier step, the Triggers and Actions will be available for your flows. → Read the next chapter to test this feature.
- A consent warning may be shown once you add the Nimbus connector trigger / action event for the first time. → Once you re-add the item it should work permanently.
Add and configure Trigger Events
Flow Triggers and Workflows
Once the connector is added and enabled on your Tenant you can make use of Nimbus Trigger Events to react to activities in your service Workflows.
The diagram at the right showcases when such Trigger Events occur during a call.
Please Note: Power Automate pricing, performance and scope are determined by Microsoft and rely on working Azure infrastructure. We recommend to test and check your flow performance regularly and account for delays (e.g. with announcements) when connecting to external systems or relying on user input.
Trigger Access per User Role
The access to Nimbus call event triggers and the data they access depends on Nimbus Roles and Permissions granted to the user:
Partner Admins | Can not use triggers for services in the customer tenant with his own account. |
---|---|
OU Admin | Can use triggers and access config, but is generally not involved / not recommended to manage live call-data. |
Tenant Admin |
|
Team Owner |
|
Creating an example Flow
The example below also assumes that you have access to a CRM, User Directory or similar Database that provides useful conversation context to the pending Nimbus tasks (calls).
Important: Any input for Nimbus context data fields and parameters must be of "plain text"-type. Other forms of media are currently not supported.
Related Pages
Refer to the following chapters:
- Context - Fields and Parameters
- Trigger Events
- Additional Use Cases can be found on the bottom of this page.
Create New Flow
- Log into your Microsoft Power Automate / Flow https://emea.flow.microsoft.com account
- Navigate to "My Flows" and "+ Create" a new Flow
- Name your Flow to your choice like "Nimbus User Details Connector"
- Add a Flow Trigger by searching for "Luware" or "Nimbus".
- Configure the Trigger Connection by clicking on "..." → select a user account with corresponding team owner permissions.
Configure the Trigger Properties according to the table below.
Available Flow TriggersName Usage Scenario GetOnNewTasks Automatically triggers once on "Calling" workflow event → The "Start" point of any Workflow
Workflows are configured in a Team's Workflows.
Use either this trigger or GetOnUpdatedTasks as part of a Flow, not both.
GetOnUpdatedTasks Triggers multiple times on specified events, as described in Trigger Events.
Events are part of (any manually added) workflow steps, done via a specific Nimbus team's Workflows.
Use either this trigger or GetOnNewTasks as part of a Flow, not both.
Add an action for data-retrieval
The next step depends on your connected System. The goal is to look up the user / UPN calling your Nimbus team and retrieve user details.
Azure Active Directory "GetUser" example:
- Add an "Action" item to your flow
- Choose "Azure AD" in the Action search field
- Select the "Get User" Action → The Action is now named accordingly
- As an example field "User ID or Principal Name" you can select "MsCallerID"
This is an example. You can select a user with other identifiers as needed, depending what works as a lookup ID on your database.
Note that these data retrieval actions can (and should) be configured with a timeout behavior so they don't stall the system in case of an unresponsive user database.
Update the Nimbus TaskItem
Now it's time to update the Nimbus task with the context retrieved from your connected database in the previous step.
Add an "UpdateTask" action to your flow
Name Usage Scenario UpdateTask Requires either GetOnNewTasks or GetOnUpdated Tasks in the same flow.
Updates the Task Item with Context - Fields and Parameters
Refer to the table below for the following steps.
Fill in " RequestID " by using the Dynamic Content Nimbus field of the same name,
Fill in other dynamic values as needed and provided by your CRM / external database. For each field, add "dynamic data" within the UpdateTask Nimbus Action:
Excerpt Table below. Refer to Context - Fields and Parameters for a full list.
Property Name Type Contents RequestID
string Dynamically generated
ID to identify and Update Tasks
Created
DateTime - Incoming
- InIVR
- InQueue
- ConnectedToUser
- Terminated
Type String Type of the session.
Default "Incoming"
Terminated DateTime Dynamically generated
Time when Session was terminated
ServiceLine Strings - Name (Team Name)
- DisplayName
- UPN (Team UPN)
- PhoneNumber
Customer
UPN, Phonenumber - UPN
- PhoneNumber
Contex tParameters Key.value pair - CustomerFirstName
- CustomerLastName
- CustomerCompany
- CustomerTitle
- CustomerDepartment
- CustomerStreetAddress
- CustomerPostcode
- CustomerCity
- CustomerState
- CustomerCountry
- CustomerPhoneNumber
Further context can be provided in custom fields
- Use "Customer.Customfields" to provide additional context as needed / provided by your systems.
Those custom fields will be shown throughout the Nimbus UI. For example here in the Attendant Console call hub or your "My Sessions" tab in the personal Nimbus app.
Use the "Flow Checker" to test your flow. -->When everything is OK, save and close the flow and you're done.
Good to know
- You may also access, update and manipulate connected Address Books using the dedicated Nimbus "Clear/Get/Remove Contact" flow steps. Please note that this may also affect Attendant Console users when accessing the same Address books.
- Nimbus will not wait for Flows to complete, nor request any updates by itself as it may impact call performance. If a flow is not working as intended, the call context in a Nimbus task is simply not updated.
- Microsoft is constantly updating Flow with new connectors and triggers. Feel free to experiment with advanced IF/THEN and switch conditions and error-handling loops in your flows.
- Keep in mind that context takes at least 1-2s for each Flow to update, which might delay information gathering during huge call volumes. Use the "Flow Checker" history to review performance during peak hours and consider shortening your flows if necessary.
- When creating Flows that intend to inform your team via Teams Message or Email, consider enabling the native Adaptive Cards support in a "Queue" Workflow Activity instead. Adaptive Cards may also show context if provided by a Flow.
Example Use Cases
By using Power Automate flows you can greatly extend the interaction range of Nimbus. Here are some example use cases that showcase how make use of Trigger Events and Context - Fields and Parameters within your flows and beyond:
This list is an excerpt. You can also check our full List of Use Cases to learn about other areas of Nimbus.