Administration

The Administration application enables account administrators to manage their users, roles, tenants, applications and business rules and lets them configure a number of settings for their account.

Overview

The following sections will walk you through all functionalities of the Administration application in detail. For your convenience find an overview on the content of this document below.

Section Content
Home Screen Providing information on your capacity usage and subscribed applications.
Managing Users How to create users, edit, disable or delete them.
Managing Permissions How to add and edit global roles and inventory roles, how to assign them to users, and how to grant application access.
Managing applications How to manage subscribed applications and how to manage and configure own applications in your Cumulocity IoT account.
Managing business rules How to reprioritize alarms by alarm mappings.
Managing data retention How to manage and configure retention rules for your data and how to manage stored files in the file repository.
Two-factor authentication How to activate/deactivate two-factor authentication for a user.
Changing settings How to change account settings like application settings or authentication settings, how to manage the properties library and how to configure single sign-on.

Home screen

The Home screen of the Administration application provides

Home screen

The capacity sections show:

Managing users

The user management feature allows you to manage the users within your tenant. With this functionality you may:

Info: The user needs to have a role with the user management permission ADMIN or CREATE to be able to do so.

If your tenant is configured for using single sign-on (SSO) in Software AG Cloud, new users should be created under My Cloud, accessible through the application switcher in the upper right corner, so that they are able to use the single sign-on feature.

For users created via an external authorization server, updating the following settings in Cumulocity IoT will have no effect (will be reset on the next user re-login):

Moreover, password reset in Cumulocity IoT is disabled for users created through an external authentication server.

Info: Users which are using single sign-on cannot change the password of users which are managed by the platform.

Viewing users

To view all users in your tenant, click Users in the Account menu in the navigator.

Expanded view

A user list will be displayed, providing the following information for each user:

To filter the list by username, you can use the filter field at the left of the top menu bar. With the dropdown list you can filter by global roles. For details on filtering, see Getting started > UI functionalities and features > Filtering.

In order to apply the selected filters click Apply.

Initially, the User page only shows the top-level users. To see all users in your account at once, click Expand all at the right of the top bar. This will expand all top-level users, showing their sub-users. Click Collapse all to just show the top-level users again. For details on user hierarchies, refer to Managing user hierarchies.

To add a user

  1. Click Add user at the right of the top menu bar.

Info: If single sign-on is enabled for your tenant, a message will show up which reminds you that you are about to create a local user which will not be able to login via single sign-on. Create new users in My Cloud instead, accessible through the application switcher in the upper right corner, to enable them using the single sign-on feature.

  1. At the left of the New user window, provide the following information to identify the user:

    Field Description
    Username Serves as a unique user ID to identify the user at the system. Note that the username cannot be changed once the user has been created. This field is mandatory.
    Login alias In addition to the username, an optional alias can be provided to be used to log on. In contrast to username, this alias may be changed if required. User alias is not supported for devices.
    Status Enable/disable the user account here. If the user account is disabled the user cannot login.
    Email A valid email address. This field is mandatory.
    First name First name of the user. When the user is logged in, this name appears at the right of the top bar on the User button.
    Last name Last name of the user.
    Telephone A valid phone number. The phone number is required if the user is configured to use two-factor authentication.
    Owner Another user that manages ("owns") the new user. Select a user from the dropdown list and click Done to confirm. Refer to Managing user hierarchies for details on user hierarchies.
    Delegated by Can be activated to delegate user hierarchies and permissions to the user. Refer to Managing user hierarchies for details on delegation.
  2. Select the login options for the user.

    • Two-factor authentication (SMS): If selected, the user will receive a verification code via SMS which is required to complete the authentication. The SMS will be sent to the phone number configured above. For details refer to Two-factor authentication.
    • User must reset password on next login: If selected, you need to provide a password which the user must reset on the next login. Enter a password and confirm it. While entering the password, the strength of the password will be checked. See To change your password for further information on password reset and strenth.
    • Send password reset link as email: If selected, the user will receive an email message with a link to set a password. The email will be sent to the email address configured above.
  3. On the right of the page, select the global roles for the user. Details on global roles are described in Managing Permissions.

  4. Click Save to save your settings.

The new user will be added to the user list.

Info: By default, manually created users always have the “Own_User_Management” permissions set to active.

To edit a user

  1. Click the menu icon at the right of the respective row and then click Edit. All fields except Username and Send password reset link as email can be changed. For details on the fields, see To add a user.
  2. Click Change password to change the password.
  3. Click Save to apply your settings.

Info: You need a role with user management permission to perform this option.

To copy inventory roles

  1. Click the menu icon at the right of the respective row and then click Copy inventory roles from another user.
  2. In the resulting dialog box, select if you want to merge the roles to be copied with the existing user roles (the default) or if you want to replace the existing user roles.
  3. Select the user from which you want to copy roles from the dropdown list.
  4. Click Copy.

The inventory roles will be copied from the selected user.

Info: You need a role with user management permission to perform this option.

To delegate/undelegate user hierarchies

Click the menu icon at the right of the respective row and then click Delegate to delegate your user hierarchies and permissions to a user.

Click Undelegate to remove a delegation.

Refer to Managing User Hierarchies for details on delegation.

Info: You need a role with user management permission to perform this option.

To disable/enable a user

Click the menu icon at the right of the respective row and then click Disable to disable an active user, or click Enable to enable a user that has been disabled.

Info: You need a role with user management permission to perform this option.

To delete a user

Click the menu icon at the right of the respective row and then click Delete.

Info: You need a role with user management permission to perform this option.

Managing permissions

Permissions define what a user is allowed to do in Cumulocity IoT applications. To manage permissions more easily, they are grouped into so-called “roles”. Every user can be associated with a number of roles, adding up permissions of the user.

The following types of roles can be associated with users:

Moreover, application access can be granted to enable a user to use an application.

Global roles

Click Roles in the Accounts menu to display a list of configured roles.

Context menu

In the Global roles tab you can find the roles which grant permissions on a system level. There are several global roles pre-defined, but you can define your own according to your needs.

Info: The pre-defined roles are configured as samples for a particular purpose. You may use them as a starting point and further adapt them to your individual needs.

On creating a new user, make sure that the global roles you assign to the user contain all necessary permissions relevant for this particular user in either of those roles assigned. Permissions from different roles are merged together when assigned to the same user. If, for example, a user only has the role “Cockpit User” (see below), the user is only able to access the Cockpit application and nothing more. But if you also assign inventory permission via some of the available roles, the user will get access to the whole inventory, such as devices, groups, and configurations.

The roles “admins” and “devices” have a special status:

Role    Description
admins Administrative permissions are enabled. The initial administrator, the first user created in a tenant, has this role.
devices Typical permission setup for devices. After registration, a device automatically has this role. Edit this role if your devices require less or more permissions, or assign other roles to your devices.

Furthermore, the following pre-configured roles are initially provided.

Role Description
CEP Manager Can access all smart rules and event processing rules.
Cockpit User Can access the Cockpit application. In addition, you should add a role providing access to devices.
Device management User Can access the Device Management application. The user will be able to use the simulator and to run bulk operations. In addition, you should add a role providing access to devices.
Global Manager Can read and write all devices.
Global Reader Can read all devices.
Global User Manager Can manage all users.
Shared User Manager Can manage sub-users. The subscription plan needs to include user hierarchies to be able to manage sub-users.
Tenant Manager Can manage tenant-wide settings, such as own applications, data brokerage, data retention, options and tenant statistics.

You may also see the following legacy roles:

Role Description
business Can access all devices and their data but has no management permission in the tenant.
readers Can read all data (including users, in contrast to “Global Readers”).

To add a global role

Click Add Role in the Global roles tab.

In the New global role page you will see a list of permission types at the left and a list of applications to be accessed at the right.

The following screenshot shows the settings for the “admins” role.

Admin example

Permission levels

For each type, you can select the following permission levels:

Info: CREATE permissions are related to the concept of ownership in Cumulocity IoT. If you have created an object, you are the owner of it and can manage it without requiring any further permissions. For example, if you have CREATE permission for “Inventory”, you can create devices and groups, and fully manage these devices and groups. You cannot manage any devices or groups that you did not create yourself, unless you also have the UPDATE permission or an additional inventory role (see below). This concept helps to assign minimal permissions to devices. It also enables you to limit user management permissions to sub-users, if you subscribed to user hierarchies.

Select the checkbox at the top of a column to set the respective level to all permission types.

Permission categories

The following permission categories are available by default:

Category Description
Alarms View or edit alarms.
Application management View or edit the applications available in this account.
Audits View or create audit logs.
Bulk operations View or create bulk operations.
CEP management View or edit CEP rules.
Data broker Send data to other tenants or receive data from other tenants.
Device control View or edit commands for devices resp. send commands to devices. Also used for device registration.
Events View or create events.
Global smart rules Configure global smart rules.
Identity View or edit identifiers for devices.
Inventory View or edit inventory data.
Measurements View or create measurements.
Option management View or edit account options such as password policies.
Retention rules View or edit retention rules.
Schedule reports Manage the schedule of report exporting.
Simulator Configure simulated devices.
Sms Configure SMS.
Tenant management View, create, edit or delete subtenants.
Tenant statistics View the usage data for this account, as shown on the Home screen of the Administration application.
User management View or edit users, global roles and permissions.
Own user management View or edit your own user.

There may be additional permissions visible depending on the features in your subscription plan. These are documented along with the respective feature.

Important: When new features with new permissions are added to Cumulocity IoT, these are not automatically added to existing roles. If you notice that you cannot use a new feature that was recently announced, check your permissions.

Assigning global roles

You can assign global roles to users either directly in the user list, or by opening the page for a particular user and adding them there.

Important: By default it is not possible to change roles of SSO users (created automatically during SSO login) as those would be overridden by dynamic access mapping. However this behaviour can be changed. For more information refer to Administration > Changing settings in the User guide.

To assign global roles from the user list
  1. Click the Global roles column of a particular user to open a list of global roles.
  2. Select or clear the respective checkboxes.
  3. Click Apply to save your settings.

Apply global role

To assign global roles from the user page

Click on the row of the respective user in the user list. In the user page, select or clear the checkboxes for the relevant global roles at the right. Click Save to save your settings.

Attach global role

Inventory roles

Inventory roles contain permissions that you can assign to groups of devices. For example, an inventory role can contain the permission to restart a device. You can assign this inventory role to a group of devices “region north” and to a user “smith”. The result is that the user “smith” can restart all devices that are in the group “region north” or any of its subgroups.

To view the currently configured inventory roles, click Roles in the Accounts menu and switch to the Inventory roles tab.

Context menu

In the Inventory roles tab you can manage user permissions for particular groups and/or its children. There are several default inventory roles defined, but you can define your own according to your needs.

The following default inventory roles are initially available in new tenants:

Role Description
Manager Can read all data of the asset and manage all inventory data but cannot perform operations. In addition, can manage inventory data (including dashboards) and alarms.
Operations: All Can remotely manage the assets by sending operations to a device (for example software updates, remote configurations).
Operations: Restart Device Can restart devices.
Reader Can read all data of the asset.

To add an inventory role

Click Add Role in the Inventory roles tab.

At the top of the page you can edit the name of the inventory role. Click on the name, edit it and click the green checkmark to save your edits.

Role details

Permissions are grouped into the following categories:

Category Description
Alarms Permissions related to working with alarms from devices.
Audits Permissions related to audit logs.
Events Permissions related to working with events from devices.
Inventory Permissions for viewing and editing devices.
Measurements Permissions related to measurements.
Device control Permissions to remote control devices.
Full access Complete access to the associated devices, mainly to simplify configuration.

Info: Service providers will see an additional permission “Support” in their Management tenant. This permission lets users of the service provider give support to their customer’s users, see Support user access.

Add a permission to the role by clicking the plus icon next to the desired category.

In the Type field, specify a type to further restrict the type of data that this permission applies to. Access will be only granted to objects that contain the specified Type.

For example, assume that your device sends measurements related to device management, such as “c8y_SignalStrength”, and actual production measurements. You want a user to only see the device management measurements. In this case, enter “c8y_SignalStrength” as type. This will allow the user to only see measurements that contain the type “c8y_SignalStrength”. Note that the user will be able to see the entire measurement object including other types that may be part of the same measurement object.

By default, the Type field contains an asterisk “*” selecting all types.

Info: For further information on possible types, check your device documentation, the Cumulocity IoT sensor library or the device management library. The type being used here is the so-called “fragment type”, not the “type” property. You need to enter all fragment types send in a measurement to make the measurement visible; similar for other types of data.

In the Permission field, select a permission level from the dropdown list:

Important: When you add a permission, you may see a small exclamation mark. The exclamation mark indicates that the permission that you have just added is not effective, because another, “higher” permission set for the user already includes the respective permission. Check if you have set, for example, “Full access” or if there is another permission in the same section with “*” as type and ALL as permission.

As another example, assume that you are using tracking devices. You want to allow your user to see all devices, but not to change anything. In addition, the user should be able to follow tracks of devices on a map. Tracks are recorded using an event with fragment type “c8y_Position” (see Sensor library). To do so, assign READ permission on inventory as well as on events with type “c8y_Position” as shown in the image below.

Permission example

Assigning inventory roles to users

Inventory roles are assigned to a user and a group of devices.

To assign inventory roles, click User in the Accounts menu, select a user in the user list and switch to its Inventory roles tab.

In the Inventory roles tab you will see a tree of device groups. To assign an inventory role, click on the arrow right from a group. Select the relevant roles and click Apply. For details on the roles hover over the info icon next to it or refer to Viewing inventory roles.

Important: If a user already has a global role containing inventory permissions, the user will be able to see or change all devices regardless of what inventory roles you set here.

Inventory roles are inherited from groups to all their direct and indirect subgroups, and to the devices in these groups. If you select, for example, a role with read permissions on alarms for a group of devices, the user will be able to see alarms of all devices in this group and all its subgroups.

If a user has inventory access to a group of devices, the user will also have that access to all dashboards for that group of devices in the Cockpit application.

You can also copy inventory roles from another user. To copy roles, click Copy inventory roles from another user. In the upcoming window, select a user from the list and click Copy. At the top you can select if you want to merge the roles with the existing user roles (the default) or if you want to replace the existing user roles. Copying roles makes it easier to manage the permissions of many users as you can create a reference user and then copy the permissions from there.

Copy roles

Troubleshooting permissions

If you try to perform actions without sufficient permissions, an error message will occur.

To help troubleshooting permissions, click the User button at the right of the top bar. From the context menu, select Access denied requests. In the resulting window details on the denied accesses are provided. An administrator user or the product support can help in fixing the permissions.

Granting application access

The Application Access tab shows a list of all available applications in your tenant in alphabetical order.

To assign applications to the user, simply select the respective applications and click Save.

For more information on application management, see Administration > Managing applications.

Application access

Info: If a user has global permission to read all applications, an information box will be shown.

Viewing audit logs

Audit logs show the operations that users have carried out.

To view the audit log list, click Audit logs in the Accounts menu. For each log entry, the following information is provided:

Column Description
Server time Server time when the operation was processed.
Event Type of operation, for example "Alarm created", "Smart rule deleted". Below it, the user who processed it is displayed.
Description Provides further information depending on the operation, for example, the device name, alarm text, operation status.
Device time Device time when the operation was processed. This can differ from the server time.

Only the last 100 logs are visible. Scroll down the page to Load more to view more log entries.

Audit logs

Info: The audit log list is not automatically refreshed after a realtime update for operations. Click Reload at the right of the top menu bar to update the list to the latest operations.

Filtering logs

In order to easily search through logs, you may filter logs for

To apply a filter, click the Apply button next to the respective filter field. To discard filters, click the X icon next to the Apply button (only visible if filters are set).

Managing applications

The Cumulocity IoT platform distinguishes between applications and microservices, see also Developing applications in the Concepts guide.

Both can be accessed via the Ecosystem menu in the navigator.

Additionally, in Enterprise tenants, it is possible to configure Default subscriptions, that means you can specify a list of applications that are subscribed by default to every new tenant on creation and/or to all existing tenants on platform upgrade. For details, see Enterprise tenant > Default subscriptions.

Applications menu

Applications

Click Applications in the Ecosystem menu in the navigator to display a list or grid of all applications in your account.

All applications

In the All applications tab, you can see all applications available in your tenant. There are two kinds of applications:

Your applications are available through the application switcher in the top bar.

App switcher

Subscribed applications

Cumulocity IoT provides a variety of applications for different purposes. Depending on your installation and/or optional services your tenant will show a selection of the potentially available applications.

Below all applications are listed which are by default available in the Standard tenant or Enterprise tenant. In addition, numerous optional applications might be subscribed to your tenant.

Info: In the All applications tab, subscribed applications are labeled as “Subscribed”. Subscribed applications may not be added, modified or removed by the user but only by a tenant administrator.

Applications subscribed by default

Name in the UI Functionality Identification in the API Technical type Availability
Administration Lets account administrators manage users, roles, tenants and applications administration Web application Standard tenant, Enterprise tenant
Cockpit Manage and monitor IoT assets and data from a business perspective cockpit Web application Standard tenant, Enterprise tenant
Device Management Manage and monitor devices, and control and troubleshoot devices remotely devicemanagement Web application Standard tenant, Enterprise tenant
Streaming Analytics Manage and edit Analytics Builder models and EPL apps (if enabled) Streaming Analytics Web application Standard tenant (limited version for Analytics Builder), Enterprise tenant (full version)

Custom applications

Custom applications may be

In the All applications tab, custom applications are labeled as “Custom”.

To add a custom application

Click Add application at the top right of the All applications tab.

Add application methods

In the resulting dialog box, select one of the following methods:

To upload a web application
  1. Click Add application at the top right of the All applications tab.
  2. Select Upload web application.
  3. In the resulting dialog box, drop a ZIP file or browse for it in your file system.

The application is created once the ZIP file has been successfully uploaded.

Important: The ZIP file must contain the index.html and cumulocity.json in its root directory, otherwise the application will not work.

  1. Click Add application at the top right of the All applications tab.
  2. Select External application.

    External application

  3. In the resulting dialog box, enter the name of the application. The name will be shown as title of the application.
  4. Enter an application key, used to identify this application.
  5. Enter the external URL where the application can be reached.
  6. Click Save to create the application.

For details on the fields, see also Application properties below.

To duplicate an application

Duplicating an application might be useful if you want to customize a subscribed application according to your needs. Duplicating a subscribed application creates a copy of the application as an own application, with a link to the original application.

  1. Click Add application at the top right of the All applications tab.
  2. In the upcoming dialog, select Duplicate existing application.
  3. Select the desired application from the dropdown list.

    Duplicate application

  4. In the next window, provide a name for the application. By default, the name of the original application is provided, extended by a number.

    Duplicate application

  5. Provide an application key, used to identify this application. By default, the key of the original application is provided, extended by a number.
  6. Provide the application path as part of the URL to invoke the application. By default, the path of the original application is provided, extended by a number. If you set it to the path of the original subscribed application, your own application will overrule the subscribed application.
  7. Finally, click Duplicate to create the application.

For details on the fields, see also Application properties below.

Info: If you want your “own application” to overrule a subscribed standard application, the path of the “own application” needs to be set to the path of the original subscribed application.

Application properties

To display further details on an application, click it to open its Properties tab.

Application properties

In the Properties tab, each application will show the following information, depending on the application type (hosted or external):

Field Description Hosted (web application) External
ID Unique ID to identify the application Automatically provided Automatically provided
Name Application name; will be shown as title of the application in the top bar and in the application switcher Automatically created Specified by the user
Application key Used to identify the application and to make it available for subscription, see the Concepts guide Automatically created Specified by the user
Type Application type Hosted External
Path Part of the URL invoking the application Automatically created Specified by the user; for example, if you use "hello" as application path, the URL of the application will be "/apps/hello"

To edit an application

Simply click the application or click the menu icon at the right of an entry and then click Edit.

In the Properties tab, several fields can be modified, depending on the application type (see Application properties).

Important: Never change the system application names (such as “Device Management”, “Cockpit”). Otherwise, tenant initialization will fail.

To delete an application

Click the menu icon at the right of an entry and then click Delete.

If you delete an application that overwrites a subscribed application, the currently subscribed application becomes available to all users. Additionally, the users will then also benefit from future upgrades of the subscribed application.

It is not possible to delete subscribed applications. This can only be done by the owner of the subscribed application.

Uploading archives

For custom applications, multiple file versions can be stored in Cumulocity IoT when they were created by uploading either a ZIP file or a MON file. Each version is called an archive. You can upload different versions at the same time and switch between these versions.

To upload an archive

  1. Open the application properties for the respective application by clicking on it.
  2. Click the plus button at the bottom of the Activity log section and browse for the archive in your file system or simply drop the archive file.
  3. Click Upload to upload the archive to your Cumulocity IoT account.
Application archive

Once uploaded, the recently uploaded version is automatically the active version, that is the version of the application that is currently being served to the users of your account. This version cannot be deleted.

Info: The archive functionality is not available for subscribed applications, as only the owner of the application can perform these actions.

To restore an older application version

Users can restore previous versions of an application from an archive.

  1. Open the application properties for the respective application by clicking on it.
  2. In the Activity log section, open the context menu for the desired version by clicking the menu icon and select Set as active to make it the active version.

To reactivate a single application

If a hosted application is not deployed correctly, users may reactivate it.

  1. Open the application properties for the respective application by clicking on it.
  2. In the Activity log section, open the context menu for the desired version by clicking the menu icon and select Reactivate.

The selected application will be reactivated by removing the respective files from the application directory and unpacking the host application package again.

Features

Features are applications which are built-in and not represented by an explicit artifact (like microservices or web applications).

In the Features tab, you will find a list of all features subscribed in your tenant. In an Enterprise tenant, the following features are available by default:

Name in the UI Functionality Identification in the API Availability
Feature-branding Customize the look of your tenants to your own preferences feature-branding Enterprise tenant
Feature-broker Share data selectively with other tenants feature-broker Enterprise tenant
Feature-user-hierarchy Reflect independent organizational entities in Cumulocity IoT that share the same database feature-user-hierarchy Enterprise tenant

Info: All applications listed here are of the type “Feature”.

Other features may show up, depending on the individual subscriptions of your tenant.

Managing and monitoring microservices

Click Microservices in the Ecosystem menu in the navigator to display a list or grid of all microservices subscribed to your account.

Microservices list

A microservice is a specific type of application, that is a server-side application used to develop further functionality on top of Cumulocity IoT. As web applications, microservices can either be subscribed to your tenant by the platform or by a service provider, or they can be owned by you as custom applications, see Custom microservices.

Subscribed microservices

Cumulocity IoT provides a variety of microservice applications for different purposes. Depending on your installation and/or optional services your tenant will show a selection of the potentially available applications.

Below you find a list of all microservices which are by default subscribed in a Standard tenant and/or Enterprise tenant. In addition, numerous optional microservices might be subscribed to your tenant.

Microservices subscribed by default

Name in the UI Functionality Identification in the API Availability
Apama-ctrl-1c-4g Full Apama microservice. Runtime for Analytics Builder, EPL Apps, and smart rules apama-ctrl-1c-4g Enterprise tenant
Apama-ctrl-starter Restricted version of the Apama microservice. Runtime for an unlimited number of smart rules and a limited number of Analytics Builder models apama-ctrl-starter Standard tenant
Apama-ctrl-smartrules Restricted version of the Apama microservice. Runtime for smart rules only, no Analytics Builder models or EPL apps available apama-ctrl-smartrules Only available for self-hosted installations
Device-simulator Simulate all aspects of IoT devices device-simulator Standard tenant, Enterprise tenant
Report agent Schedule data exports from within the Cockpit application report agent Standard tenant, Enterprise tenant
Smartrule Use the smart rules engine and create smart rules to perform actions based on realtime data. Requires one of the following microservices: apama-ctrl-1c-4g, apama-ctrl-starter, or apama-ctrl-smartrules smartrule Standard tenant, Enterprise tenant
Sslmanagement Activate your own custom domain name by using an SSL certificate sslmanagement Enterprise tenant

Info: All applications listed here are of the type “Microservice”.

Custom microservices

To add a microservice as custom application

  1. Click Add microservice at the top right.
  2. In the resulting dialog box, drop a ZIP file or browse for it in your file system. Note that the size limit of the file to be uploaded is 500 MB.
  3. The microservice application is created once the ZIP file has been successfully uploaded.

Important: The ZIP file must contain the application manifest and the Docker image of the microservice. Refer to General aspects in the Microservice SDK guide for information on preparing and deploying the microservice package.

Microservice properties

To display further details on a microservice, click it to open its Properties tab.

Microservice properties

In the Properties tab, each microservice will show the following information:

Field Description Comment
ID Unique ID to identify the microservice Automatically provided
Name Application name; will be shown as title of the microservice application in the top bar Automatically inferred from the ZIP file name (recognized version number is dropped), unless provided in the microservice's manifest file
Application key Used to identify the microservice application and to make it available for subscription, see the Concepts guide Automatically created, based on the ZIP file name
Type Application type Microservice
Path Part of the URL invoking the application Automatically created as .../service/

Below, you will additionally find information on the microservice version, as well as on its isolation level and billing mode, see Enterprise tenant > Usage statistics and billing > Microservice usage for details on these parameters.

Microservice subscription

At the top right of the Properties tab, you find a toggle to subscribe to or unsubcribe from a microservice.

Microservice subscription

Changing the subscription is only possible for custom microservices, that is microservices being owned by you.

Microservice permissions

In the Permissions tab you can view the permissions required for the respective microservice, and the roles provided for it.

Microservice permissions

Monitoring microservices

You can monitor microservices hosted by Cumulocity IoT in two ways.

Status information

The status of the microservice can be checked in the Status tab of the respective microservice application.

Microservice status

To view the status you need the following permissions: role Application management READ and role Inventory READ.

The following information is provided on the Status tab:

The status information is available for subscribed applications as well as for own applications. Information on subscribed subtenants is only visible for the application owner.

Alarms and events

Most of the alarms and events visible in the Status tab are strictly technical descriptions of what’s going on with the microservice.

There are two user-friendly alarm types:

User-friendly alarms are created for the microservice owner tenant only. They are also automatically cleared when the situation gets back to normal, that is all the microservice instances are working properly.

User-friendly alarms can be used to create smart rules. For details on creating smart rules of various types, see Smart rules.

For example, to send an email, if a microservice is down, create an “On alarm send email” smart rule.

In the On alarm matching section, use c8y_Application_Down as an alarm type. As a target asset select the microservice which you would like to monitor, for example “echo-agent-server”.

Log files

Cumulocity IoT offers viewing logs which provide more details on the status of microservices.

To view logs, open the Logs tab of the respective microservice.

Microservice log

At the top of the page, you can select the instance of the microservice, for which you want to view the logs.

Info: If your microservice was re-scaled into two instances you should be able to switch between them, but it is not possible to see the logs from both instances at once.

Next to the instance dropdown you can select the time range for the log entries to be shown by selecting a date from the calendar and entering a time.

Info: The time entered here may differ from the server time due to different time zones.

At the top right, additional functionality is provided:

Initially, the Logs tab shows the latest logs of the microservice instance.

At the bottom right you find navigation buttons:

If no logs are available in the selected time range, a message is shown accordingly:

Microservice log

Info: There is no possibility to see the logs from the previously running instances. However, inside the instance there is a Docker container running, and if only this one was restarted (not the whole instance) you should see the logs from the currently running and also lately terminated Docker container.

Logs are always loaded from the Docker container using both stdout and stderr sources, and there is no possibility to distinguish/filter by the source.

Managing business rules

Alarm mapping

Alarm mapping enables you to change the severity and text of alarms to adapt them to your business priorities. For example, a loss of the connection to a device is by default a MAJOR alarm but may be critical to you. To change this, add an alarm mapping to change alarms related to connection losses to CRITICAL.

Click Alarm mapping in the Business Rules menu to see a list of all alarm mappings.

Alarm mapping

For each alarm mapping, the alarm severity, the alarm type and a description (optional) are shown.

To add alarm mapping

  1. Click Add alarm mapping in the top menu bar.
  2. Enter the alarm type to be modified.
  3. In the New description field, optionally enter a new description for the alarm. If you leave this field empty, the original text from the alarm will be kept.
  4. Select the desired new severity, or select “Drop” to not show the alarm at all.
  5. Click Save to save your settings.

Info: The alarm type provided as an alarm mapping is interpreted as alarm type prefix: "<type-prefix>*". If you create, for example, an alarm mapping to address alarms of type "crit-alarm", the mapping is effective for any type of alarm that starts with this value, for example, "crit-alarm-1", "crit-alarm-2", or "crit-alarm-xyz".

To edit an alarm mapping

Expand an alarm mapping to edit it. You may modify the description and the alarm severity. The alarm type is not editable.

Info: Refresh the list to discard any changes without saving.

Edit alarm mapping

To delete an alarm mapping

To delete an alarm mapping, hover over it and click the delete icon which appears on hovering over the row.

Managing data

Retention rules

Retention rules gives you control on how long data is stored in your account. By default, all historical data is deleted after 60 days (configurable in the system settings).

You might however want to store measurements for 90 days for example, but delete alarms already after 10 days.

Retention rules are usually run during the night. When you edit a retention rule, you will not see an immediate effect in the Usage section on the Home screen of the Administration application.

Click Retention rules in the Management menu to view a list of retention rules configured for your account.

Retention rules

For each rule, the rule name, details on the data to be deleted (fragment type, type and source, see below) and the maximum age in days is provided.

The asterisk ("*") indicates that data with any value will be cleaned up.

Data types

The following data types are covered under retention rules:

Info: Retention rules do not apply to files stored in the files repository.

To add a retention rule

  1. Click Add rule in the top menu bar.
  2. In the resulting dialog box, select the type of data to be cleaned up (alarms, measurements, events, operations, audit logs or all).
  3. Enter a fragment type if you want to be more specific about the data to be cleaned up. To clean up all connection loss alarms with this rule, select “Alarm” and enter “c8y_UnavailabilityAlarm” as property into the Type field.
  4. If you want to remove data only from a specific device, enter the device ID into the Source field.
  5. Enter the Maximum age in days (max. allowed value is 10 years in days).
  6. Click Save to save your settings.

The retention rule will be added to the list.

Info: Per default, an asterisk ("*") is set in all fields except the Maximum age field, to include all values.

Info: Alarms are only removed if they have a status of CLEARED.

To edit a retention rule

Simply click the row of the rule you want to edit.

For details on the fields, see To add a retention rule.

To delete a retention rule

Hover over the rule you want to delete and click the delete icon at the right.

Delete retention rule

Info: All retention rules are executed sequentially and independent of each other. So if we have two retention rules, a more specific one with a greater maximum age that defines a subset of the documents that are defined by a more common rule with a lower maximum age, then effectively it will work as if we had a single, more common rule.

For example given the two following rules:

Retention rules

All measurements with the type c8y_Temperature which are older than 30 days will be removed, including those where the source equals 12345.

On the other hand when we have the following retention rules defined:

Retention rules

The retention process removes the measurements with the type c8y_Temperature which are older than 30 days, all other measurements will be removed when they are older than 60 days.

Info: The source parameter is the ID of the device. When it is defined, the retention process only removes the documents directly related to the device represented by the source, not its children or groups it belongs to.

Managing files in the file repository

The file repository provides an overview of the files stored in your account.

Click Files repository in the Management menu to see a list of files.

The files listed can come from various sources. They can be software images, configuration snapshots taken from devices, log files from devices or web applications uploaded from the All applications page.

For each file, the name of the file, its owner, the file type (for example, image/bmp, text/csv), its size and the date when it was last updated is provided.

Files Repository

To upload a file from your file system

Click Upload file in the top menu bar.

Files Repository download modal

In the resulting dialog box, select a file to be uploaded. If you want to upload more than one file, click Add file to select another file. You may also delete a file before uploading by clicking the delete icon at the right of the file field.

To download a file from your account

Click the menu icon at the right of the respective row and then click Download.

To delete a file from your account

Click the menu icon at the right of the respective row and then click Delete.

Info: If the file corresponds to an active application, it cannot be deleted. You first need to remove or upgrade the application to be able to delete it.

Two-factor authentication

The two-factor authentication (TFA) is an extra layer of security that only completes authentication with a combination of two different factors: something the users know (username and password) and something they have (for example, smartphone) or something they are (for example, fingerprint). You can read more on how to configure TFA in the authentication settings section.

There are two possible TFA strategies: SMS and TOTP. Only one of them can be active at a time.

To check whether TFA is enabled for a certain user, go to the Users page and see the TFA status column right from the password strength column. A key icon indicates that TFA is enabled and by hovering over it you can see the strategy that is being used.

TFA status

SMS

When adding a user and TFA is enabled, a mobile phone number must be specified. Without a valid phone number a login is impossible.

How to enable a specific user

  1. In the Administration application, navigate to Accounts > Users and select a user in the Users page.
  2. Select the checkbox next to Enable two-factor authentication.
  3. Click Save.

Enable TFA

Info: This process can only be executed in the Administration application and is not available under User settings.

TOTP (Google Authenticator)

Users must install a TOTP application on their smartphone (Google Authenticator is recommended), freely available both on App Store and Play Store.

Setup

Opposed to the SMS strategy TOTP must be set up by each user. By opening User settings in the top right corner and then clicking Set up two-factor authentication they can start the setup process. Trigger TOTP setup

IF TFA is enabled, the user will be presented a QR code at login, that needs to be scanned with the previously installed TOTP mobile application.

Alternatively, the secret can also be inserted manually in case scanning the QR code is not an option.

TOTP setup process

After this process the mobile application will generate a new code every 30 seconds that can be used to complete the authentication process.

Revoking the secret

If a user loses access to the TFA code, for example, if a user loses the phone or uninstalls the application, and needs to set it up again, the secret must be revoked.

Although TOTP must be set up by each user individually, revoking the secret can only be done by a user with “user management ADMIN” permission.

To revoke the secret follow these steps:

  1. In the Administration application, navigate to Accounts > Users and select a user in the Users page.
  2. Scroll down to Login options.
  3. Click Revoke TOTP secret.
  4. Confirm by clicking Revoke.

TOTP secret revoke

Disabling TOTP for a user

If a user wants to turn off the use of TOTP (and thus TFA) completely, the secret must be revoked and TOTP enforcement must be disabled.

Although TOTP must be set up by each user individually, revoking the secret and disabling TOTP enforcement can only be done by a user with “user management ADMIN” permission.

To disable TOTP for a user follow these steps:

  1. In the Administration application, navigate to Accounts > Users and select the user in the Users page.
  2. Scroll down to Login options.
  3. Clear the Enforce TOTP for the user checkbox.
  4. Click Revoke TOTP secret.
  5. Confirm by clicking Revoke.
  6. Click Save to save your changes.

TOTP disable user

Changing settings

From the Settings menu, administrators can manage various settings for the account:

Changing authentication settings

Click Authentication in the Settings menu if you want to view or change the Login or TFA settings.

Password settings

Info: To see the Authentication menu entry, you must have “Tenant management” ADMIN permission (ROLE_TENANT_ADMIN or ROLE_TENANT_MANAGEMENT_ADMIN).

Login settings

In the Preferred login mode field, you can select one of the following options:

This login mode will be used by the platform’s applications as the default method to authenticate users. Device authentication stays unchanged.

Important: Each time you change the login mode you will be forced to log out. Other users will need to log out and log in again so that the change is applied.

In the field Password validity limit, you can limit the validity of user passwords by specifying the number of days after which users must change their passwords. If you do not want to force your users to change passwords, use “0” for unlimited validity of passwords (default value).

Info: The password validity limit is not imposed on users with a “devices” role. This prevents device passwords from expiring.

By default, users can use any password with eight characters or more. If you select Enforce that all password are “strong” (green), users must provide strong passwords as described in Getting Started > User options and settings > To change your password.

Info: The password validity limit and the password strength may not be editable, if configured by the platform administrator.

Basic Auth restrictions

Even if OAI-Secure authentication is configured for users, basic authentication remains available for devices and microservices using the platform. To provide a higher security level the basic authentication can be restricted.

Use the Forbidden for web browsers toggle to disallow the usage of basic authentication for web browsers. Moreover you can specify the following parameters:

Info: If the user agent is not found in the list of trusted or forbidden user agents then Cumulocity IoT will try to verify if it is a web browser using an external library.

OAI-Secure session configuration

OAI-Secure is a more secure alternative to the Basic Auth mode that also supports username and password login. In OAI-Secure mode the credentials in the initial request are exchanged for a JWT token that is set as a cookie in the web browser or returned in the response body. Based on the configuration OAI-Secure can support full session management or work as a standard JWT authentication where the user session lifetime is limited by the token expiration time.

When there is no configuration related to the session, OAI-Secure issues a JWT token with a certain lifetime. If the token expires then the user is forced to re-login because token refresh is not supported. This behavior is very inconvenient for the user if the token lifetime is short because the user is forced to re-login frequently.

With the configuration of the session (session configuration turned on)

Using OAI-Secure with session configuration is more convenient and secure, and can be used to achieve a behavior which is similar to the authentication based on HTTP sessions.

The OAI-Secure token acts as a session identifier on the client site (web browser). Such a token identifier which is stored in the cookie can have a preconfigured short lifetime. Then, the Cumulocity IoT platform is responsible for renewing the session identifier without a user interaction. It is sufficient that the user’s action causes the web browser to send a request to Cumulocity IoT. Then, Cumulocity IoT can examine if the renewing of the session identifier should be executed and perform the operation if necessary. Cumulocity IoT offers extensive configuration related to this behavior so that tenant administrators can adjust the configuration to their needs.

If the Use session configuration option is enabled, the following settings can be configured on tenant level by a tenant administrator:

Field Description Default
User agent validation required If turned on, the user agent sent in headers of consecutive requests in the scope of one session will be compared and a request with changed user agent will not be authorized. false
Session absolute timeout Defines the maximum period of time that the user can use Cumulocity IoT without having to re-authenticate. 14 days
Session renewal timeout Expected to be much shorter than the absolute timeout. Defines the time after which the Cumulocity IoT tries to provide a new token (session identifier). The renewal may take place only when Cumulocity IoT receives an HTTP request from a client with a non-expired token and the period of time between obtaining the token and the execution of the request is greater than the renewal timeout. 1 day
Maximum parallel sessions per user Defines the maximum number of sessions which can be started by each user (for example on different machines or browsers). When a user exceeds this limit, then the oldest session will be terminated and the user will be logged out on this particular device. 5 sessions
Token lifespan Defines the time for which a token is active. The user is able to access the Cumulocity IoT only with a valid token. This configuration option is always available, it does not depend on session configuration. See Token and cookie settings below. 2 days

Info: The relation between the time parameters should be the following: renewal timeout < token timespan < absolute timeout. The recommended setting for the renewal timeout is approximately half of the token lifespan.

During the session token renewal the previous token is revoked and a new one is provided. The parameter renewal token delay defines the delay used to make this process smooth and not disturbing for the user. The old token is still valid for this period (1 minute by default). This way both tokens, old and new, are accepted by Cumulocity IoT. This parameter is only configurable on platform level and cannot be modified by the tenant administrator.

Token generation with OAI-Secure

OAI-Secure is primarily based on JWT stored in a browser cookie. It can be also used to generate JWT in the response body. The lifespan of the tokens and the cookie is configurable by tenant options belonging to the category oauth.internal.

JWT tokens stored in the browser cookie have a default validity time of two weeks. This can be changed with tenant options:

The minimum allowed value is 5 minutes.

Lifespan configuration of cookies

Cookies used to store a JWT token in a browser have their own validity time that can be changed with tenant options:

The default value is two weeks. It can also be set to any negative value so that the cookie will be deleted when the user closes the browser.

Lifespan configuration of JWT in response body

The lifespan of JWT tokens generated in the response body is configured with the following tenant options:

Refer to the Tenant API in the Cumulocity IoT OpenAPI Specification for more details.

Info: If external communication to the Management tenant has been blocked, then it is only possible to access the tenant in a secure way (for example via SSH tunnel). This means that you can just as well use basic authentication. Additionally, it is not possible to use single sign-on since the communication from the external authorization server is also blocked. Therefore, the authentication method is automatically set to “Basic authentication” if the Management tenant is configured to block external communication.

TFA settings

Select the checkbox Allow two-factor authentication if you want to allow TFA in your tenant (only possible for administrators).

You may select one of the following options:

Info: The TOTP method is only available with the login mode “OAI-Secure”.

Click Save TFA settings to apply your settings.

Important: Each time you change the TFA method you will be forced to log out. User TFA settings are cleared and need to be configured again.

Info: Users with a “devices” role are excluded from TFA and TOTP. This is also true when TOTP is enforced for all users.

Configuring single sign-on

Cumulocity IoT provides single sign-on functionality, that allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol, for example Azure Active Directory. Currently authorization code grant is supported only with access tokens in form of JWT.

Info: This feature is built on top of cookies technology. To be able to use it, you must have cookies enabled in the settings of your browser.

This feature is enabled since Cumulocity IoT version 10.4.6. For correct behavior any microservice needs to use the microservice SDK with version 10.4.6 or later.

Before switching to the single sign-on option it is mandatory that:

Info: In order to use the single sign-on feature for Enterprise tenants, the enterprise domain must be set up as redirect URI in the basic configurations. If single sign-on providers have a list of allowed domains, the enterprise domain should be added to that list.

Configuration settings

To enable the feature, the administrator must configure a connection with the authorization server. This is done in the Administration application.

Click the Single sign-on tab in the Authentication page.

At the top left, you can select a template. The selected option has an effect on the look of the panel. The default template is “Custom” which allows for a very detailed configuration with virtually any authorization server using OAuth2 authorization code grant. Other templates provide simplified views for well known and supported authorization servers. In the next steps there will first be a definition of how to use the “Custom” template followed by a view dedicated to Azure Active directory.

Custom template

Request configuration

As the OAuth protocol is based on the execution of HTTP requests and redirects, a generic request configuration is provided.

The first part of the Single sign-on page consists of the request configuration. Here you can configure the HTTP request address, request parameters, headers and body in case of token and refresh requests. The authorize method is executed as a GET, token and refresh method by POST requests.

Info: Be aware that the body field of each request, after filling placeholders with values, is sent in the request ‘as is’. This means it is not encoded by Cumulocity IoT. Many authorization servers require values inside the body to be URL-encoded (x-form-urlencoded). This can be achieved by entering already encoded values in a body field.

Specifying a logout request is optional. It performs front-channel single logout. If configured, the user is redirected to the defined authorization server logout URL after logging out from Cumulocity IoT.

OAuth configuration

The Basic section of the Single sign-on page consists of the following configuration settings:

OAuth configuration

Field Description
Redirect URI Redirect parameter. Can be used in request definitions as a ${redirectUri} placeholder
Client ID OAuth connection client ID. Can be used in request definitions as a ${clientId} placeholder
Button name Name displayed on the button on the Login page
Issuer OAuth token issuer
Provider name Name of the provider
Visible on Login page Indicates whether the login option is enabled or not.
Audience Expected aud parameter of JWT
Group (Deprecated in favor of dynamic access mapping since 9.20)The initial group assigned to the user on first login
Applications (Deprecated in favor of dynamic access mapping since 9.20)The initial applications assigned to the user on first login

Each time a user logs in, the content of the access token is verified and is a base for user access to the Cumulocity IoT platform. The following section provides the mapping between JWT claims and access to the platform.

OAuth configuration

In the example above, if a user tries to login a decoded JWT claims look like:

{
...
"user": "john.wick",
...
}

The user will be granted access to the global role “business” and the default application “cockpit”.

If no access mapping matches the user access token, the user will get an “access denied” message when trying to log in. This will also happen if there is no access mapping defined causing all users to be unable to log in using SSO.

New rules can be added by clicking Add access mapping at the bottom. An access mapping statement can consist of multiple checks like in the image below. You can add a rule to an existing statement by clicking and. Click the Minus button to remove a rule.

New roles are added to the user from every matching access mapping. If one access mapping statement assigns the role “admin” and a second one assigns the role “business” and both meet the defined conditions, then the user will be granted access to the global roles “business” and “admin”."

When using “=” as operator you may use wildcards in the Value field. The supported wildcard is asterisk (*) and it matches zero or more characters. For example, if you enter “cur*” this matches “cur”, “curiosity”, “cursor” and anything that starts with “cur”. “f*n” matches “fn”, “fission”, “falcon”, and anything that begins with an “f” and ends with an “n”.

In case the asterisk character should be matched literally it must be escaped by adding a backslash (\). For example, to match exactly the string “Lorem*ipsum” the value must be “Lorem\*ipsum”.

OAuth configuration

In this case the following claim will match the condition:

{
...
"user": {
   "type": "human"
},
"role": [
   "ADMIN"
],
...
}

As you can see, there is an option to verify if a value exists in a list via the “in” operator. Values can also be embedded in other objects. In this case a dot in the key implies looking into an embedded object.

By default, dynamic access mapping assigns user roles, based on the access token, on every user login. This means, that it is not possible to change the user roles inside Cumulocity IoT as these would be overridden on next user login. To change this behaviour, select the Use dynamic access mapping only on user creation checkbox at the bottom of the Access mapping section.

OAuth configuration

When selected, dynamic access mapping will be used only when a new user logs in to fill in the initial roles. When a user already exists in Cumulocity IoT, the roles will not be overridden nor updated. Selecting this option also enables admins to edit roles of SSO users in the user management. For details, refer to Administration > Managing permissions in the User guide.

When a user logs in with an access token, the username can be derived from a JWT claim. The claim name can be configured in the User ID configuration window.

OAuth configuration

If the Use constant value checkbox is selected, a constant user ID is used for all users who log in to the Cumulocity IoT platform via SSO. This means that all users who log in via SSO share the same user account in the Cumulocity IoT platform. Usage of this option is not recommended.

Next, the User data mappings can be configured:

OAuth configuration

On user login, user data like first name, last name, email and phone number can also be derived from JWT claims. Each field represents the claim name that is used to retrieve the data from JWT. The user data mapping configuration is optional and as admin manager you can only use the required fields. If the configuration is empty or the claim name cannot be found in the JWT token then the values in the user data are set as empty.

Mapping for alias is not available because it is not used in the context of single sign-on login.

Each access token is signed by a signing certificate. Currently there are three options to configure the signing certificates.

  1. By specifying the Azure AD certificate discovery address.

OAuth configuration

  1. By specifying the ADFS manifest address (for ADFS 3.0).

OAuth configuration

  1. By providing the public key of a certificate manually to Cumulocity IoT. A certificate definition requires an algorithm information, public key value and validity period.

OAuth configuration

  1. By specifying the JWKS (JSON Web Key Set) address.

OAuth configuration

Info: Cumulocity IoT only supports certificates with RSA key, either as a (“n”, “e”) parameters pair or “x5c” certificate chain. Other key types (for example Elliptic-curves) are not supported.

Placeholders

Inside some fields you can use placeholders that are resolved by Cumulocity IoT at runtime. Available placeholders are:

Placeholder Description
clientId Value of the Client ID field
redirectUri Value of the Redirect URI field
code Code returned by the authorization server in response to authorization request
refreshToken Refresh token returned by the authorization server after token request

These placeholders can be used in authorization requests, token requests, refresh requests and logout request in the fields: URL, body, headers and request parameters

To use a placeholder in a field, put it inside two curly brackets preceded with a dollar sign: OAuth configuration

Placeholders can also be used as a part of text: OAuth configuration

Placeholders are not validated for correctness. Any not recognized or misspelled placeholder will be left in text unprocessed.

Integration with Azure AD

Azure AD configuration

The integration was successfully verified against Azure AD. The configuration steps are available in https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-protocols-oauth-code.

When configuring your Azure AD, use your full domain address as redirect URI. For the purpose of this document we assume that it is “http://documentation.cumulocity.com/tenant/oauth”. The redirect URI must be set for a web application and not for a single-page application. There are no additional steps on Azure AD required.

Cumulocity IoT configuration

When the “Azure AD” template is selected the configuration panel will look similar to the following:

OAuth configuration OAuth configuration OAuth configuration

Field Description
Azure AD Address Address of your Azure AD tenant
Tenant Azure AD tenant name
Application ID Application ID
Redirect URI Address of your Cumulocity IoT tenant followed by /tenant/oauth
Client secret Azure AD client secret if applicable
Button name Button name
Token issuer Token issuer value in form of a HTTP address

Optionally single logout can be configured:

OAuth configuration

Field Description
Redirect after logout Activates single logout by redirecting the user, after logout, to the authorization server logout endpoint
Redirect URL Address to redirect the user to after successful logout from the authorization server

The second part of the panel is the same as for the “Custom” template, where access mapping, user data mapping, user ID field selection and signature verification address are provided.

OAuth configuration

Troubleshooting

It can be particularly helpful to inspect the content of the authorization token sent to the platform as some of its fields contain the information required for the correct configuration described above.

In Administration application, after clicking on Accounts > Audit logs you can filter by the category “Single sign-on” and look for entries “Json web token claims”.

The contexts of the token will be presented in JSON format.

Audit token content

Changing application settings

Click Application in the Settings menu to change applications settings.

Default application

Under Default application, you can select a default application from the list which will apply to all users within the tenant. Whenever the platform is accessed, for example, by domain name only, without mentioning a specific application, the application selected as default application is used as default landing page.

Info: All users must have access to this application.

Under Access control, administrators can enable cross-origin resource sharing or “CORS” on the Cumulocity IoT API.

The Allowed Domain setting will enable your JavaScript web applications to directly communicate with REST APIs.

For further information, see http://enable-cors.org.

Managing the properties library

Click Properties library in the Settings menu, to add custom properties to inventory objects, alarms, events and tenants.

Properties library

With custom properties, you can extend the data model of Cumulocity IoT built-in objects. You may create the following custom values:

Info: Custom properties are visible to all authenticated users of the tenant, regardless of their inventory role permission.

To add a custom property

  1. Select the tab for the desired property and click Add property.

    Add new property

  2. In the resulting dialog box, provide a unique name as identifier and a label for the property and select its data type from the dropdown list.

  3. Additionally, select validation rules for the new property:

Checkbox Description
Required If selected, the property needs to be provided, for example, during alarm creation. Not available if the property type is "Boolean".
Default Value Provide a default value to be automatically filled in the custom property field. Only available for properties with type "String".
Minimum Enter a minimum integer value.
Maximum Enter a maximum integer value.
Minimum length Enter the minimum length required for the string.
Maximum length Enter the maximum length required for the string.
Regular expression Add a regular expression which will be required in order to fill the custom property field.
  1. Click Save to create the new property.

To edit a custom property

  1. Click on the name of a property in the list to open it.
  2. Do your edits. For details on the fields see To add a custom property.
  3. Click Save to save your settings.

To remove a custom property

  1. Click on the name of a property in the list to open it.
  2. Click Remove to delete the property.

Providing SMS provider credentials

SMS are used throughout the platform for various features like two-factor authentication and user notifications, for example, on alarms.

By providing your credentials you enable platform features that utilize SMS services.

To enter SMS provider credentials

  1. Click SMS provider in the Settings menu.

    Select SMS provider

    Info: To see the SMS provider configuration, you must have the permission SMS READ. To modify the SMS provider configuration, you must have the permission SMS ADMIN.

  2. In the SMS provider page, select one of the available SMS providers from the SMS provider dropdown field. You can start typing to filter items and more easily find your preferred provider.

  3. In the resulting dialog, enter the required credentials and properties or specify optional settings, which differ depending on the provider you selected.

  4. Click Save to save your settings.

Info: OpenIT does not serve new customers anymore and is in the process of shutting down their SMS provider business. We therefore recommend you to select one of the other SMS providers.

Managing the connectivity settings

In the Connectivity page, you can manage credentials for different providers. In order to add or replace credentials ADMIN permissions are required.

The following provider settings may currently be specified:

Provider settings

To provide or replace credentials

  1. Switch to the tab of your desired provider.
  2. Enter the URL of the provider.
  3. Enter the credentials of your provider platform. Depending on the provider, these credentials will be either the credentials of your account in the provider platform or the credentials with which you can register in the Cumulocity IoT connectivity page, will be displayed in your account in the provider platform.
  4. Finally, click Save to save your settings.

Depending on the provider you have selected, there may be additional fields, which will be explained in the respective agent documentation, see Protocol integration guide.

Platform configuration settings

From the Management tenant, you can configure properties which apply globally to the whole Cumulocity IoT deployment.

Click Configuration in the Settings menu, to access the Configuration page.

Configuration settings

Most of the settings you can configure here are also available in the Enterprise tenant. For details, refer to Enterprise tenant > Customizing your platform.

In addition, the following settings can be configured in the Management tenant only.

Passwords

In the Passwords section, you can specify password settings like default strength, length or validity for the users in your tenant.

Passwords settings

Select the checkbox Enforce “green” passwords for all users to enforce the users in your tenant to use passwords that meet the conditions for “green” passwords, see also Getting started > User options and settings.

Support user

In the Support user section you can configure the parameters for the support user access for subtenant users.

This feature enables Cumulocity IoT platform providers (Software AG in case of the public cloud instances or service providers with on-prem installations) to support their customers by accessing their users using a support user. A support user is a user in the Management tenant that has specific permissions, that is, to access subtenant users in case of any issues. Refer to Support user access for more information.

Support user configuration

In the field Activate support user, specify if support user access is activated for subtenant users. Possible values you can enter here are:

In the Validity limit field, you can optionally specify the support duration, that means, for how many hours support user access will be prolonged after each support user request from a subtenant user. Enter a number specifying the number of hours. The default value is 24 hours.

The expiry date-time will be updated based on the duration specified in the Validity limit field, for example, if the current expiry date-time is 01/09/2018 15:00 and duration has been kept at 24 hours, the enabling support user will update the expiry date to 01/10/2018 15:00.

Details on the status of support requests and support user access for a tenant can be found in the Properties tab of the tenant, see Enterprise tenant > Managing tenants.

Configuring a support user

A support user is a user in the Management tenant with specific permissions. This user can log in to the target tenant and impersonate the target user.

To configure a user in the Management tenant as support user, you need to assign the relevant roles to the user. This can either be done by using a global role or by inventory roles.

Using a global role

  1. Create a role “Support” with “Support READ” and “Support ADMIN” permission.
  2. Assign the role “Support” to the respective user and remove all other roles for the user.

Using inventory roles

Using inventory roles, you can selectively assign a support user for specific subtenants.

  1. Create an inventory role called “Support” with type = “*” and permission = “All”.
  2. Create a group of all subtenants which you want to be supported by the user.
  3. Assign the “Support” inventory role to above group as described in Administration > Managing permissions > Assigning inventory roles to users.

Info: The support user feature does not work when the support user has two-factor authentication enabled, but no phone number is provided. The phone number must be provided first, in order to login as a support user.