In other articles (Create a Cumulocity IoT trigger, Create a Cumulocity IoT Connector) we described how to create webMethods.io components interacting with Cumulocity IoT.
Triggers and connnectors rely on a connection to the target Cumulocity IoT tenant which is managed as an Account in webMethods.io
The purpose of this document is to explain in detail how to create a Cumulocity IoT Account in webMethods.io to access Cumulocity IoT resources.
Cumulocity IoT credentials with admin permissions on “Application management” are required to be able to create a Cumulocity IoT Account in webMethods.io.
If you are unsure your credentials have the necessary permissions, please check this in this Cumulocity IoT
As in Cumulocity IoT permissions are not granted directly to users, but applied to roles which are in turn assigned to users, this has to be checked in two steps:
- Check the roles assigned to the user, e.g. “admins” and “business” in this example
- Find out if any of the assigned roles has “admin” permission on “Application management”. In this example the role “admins” does have the required permission
Once it has been checked that the Cumulocity IoT credentials have the required permission, the Cumulocity IoT Account can be configured in webMethods.io.
For Cumulocity IoT Accounts, only the properties below are taken into account. All other properties are ignored and their default value can be left unchanged.
- Account Name: This is the name that will be displayed in the list of Cumulocity IoT connections in both trigger and connector settings.
Server URL: This is the URL of the target Cumulocity IoT instance.
Only the root path is to be provided (like
https://mytenant.cumulocity.comfor instance) with no “
/” at the end.
Username / Password: Credentials of the Cumulocity account to be used.
Note that these credentials require admin permissions for “Application management”.
Cumulocity Application Name: This is the name of an internal Cumulocity IoT microservice application that will be created / reused for data access. Unless there is any specific usage requirement, the default name “
wmio-connector-app” can be used.
The Cumulocity IoT Accounts in webMethods.io Integration are shared between Cumulocity IoT triggers and connectors and can be created from / applied to both types of components.
After the successful creation of the Cumulocitiy IoT Account, the new Account is available for selection in the trigger or connector settings.
With this article you have all the required knowledge to create a Cumulocity IoT Account in webMethods.io.
As a next step you can read:
- webMethods.io Integration: create a Cumulocity IoT trigger
- webMethods.io Integration: create a Cumulocity IoT connector
- Cumulocity integration with webMethods.io
The Cumulocity IoT triggers and connectors in webMethods.io Integration do not access Cumulocity IoT directly with the provided account credentials.
Instead of this, upon creation of a new Cumulocity IoT Account, several actions are carried out in the background by webMethods.io:
- The provided credentials are used to create / reuse the microservice application in Cumulocity IoT with the provided Application Name - hence the required admin permissions for “Application management”.
- The microservice application is granted all rights needed for the triggers and connectors, in particular for the subscription to Cumulocity IoT notifications.
- A “Service User” for the microservice application is kept internally in webMethods.io and is not visible to anyone.
This Service User is used by webMethods.io to access Cumulocity IoT during the execution of the workflows.
This means that the user credentials used to create the account can later be modified or deleted without any impact on the execution of the workflows.