Application

Click Application in the Settings menu to change applications settings.

Application settings

To change application settings

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.

  • Set it to “*” to allow communication from any host.
  • Set it to http://my.host.com, http://myother.host.com to allow applications from http://my.host.com and from http://myother.host.com to communicate with the platform.

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

Related topics

Properties library

Requirements

ROLES & PERMISSIONS:

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

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:

  • Custom inventory properties are used to extend the inventory data model. They can be used in the Asset table widget and Asset properties widget.
  • Custom tenant properties are available during tenant creation. The custom properties can be edited under Subtenants in the Custom properties tab of each tenant. Additionally, these properties can be viewed and exported in the Usage statistics.
  • Custom alarm and event properties can be used as custom fields which can be added to your reports and will be available in the Export page in the Cockpit application.
Related topics

To add a custom property

  1. Select the tab for the desired property and click Add 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 must 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.

SMS provider

Requirements

ROLES & PERMISSIONS:

To view SMS provider configurations: READ permission for the permission type “SMS” To set or remove SMS provider configurations: ADMIN permission for the permission type “SMS”

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.

  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.

Connectivity

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

Requirements

ROLES & PERMISSIONS:

The Connectivity menu item is only available if you are logged in to the Cumulocity IoT platform as administrator and if you have READ or ADMIN permission for the permission type “Connectivity”.

To view connectivity settings: READ permission for the permission type “Connectivity” To set or remove connectivity provider configurations: ADMIN permission for the permission type “Connectivity”

The following provider settings may currently be specified:

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.