Device management


The Device Management application shows you your connected devices and enables you to manage their status. The Device Management gives you the following options:

The Device Management Application looks like this:

Device Management

The following sections will walk you through the various menus of the Device Management application.

Connecting devices manually

This section describes the general procedure for manually connecting devices to your Cumulocity account. Only some steps in the procedure may be specific to the type of device that you are using. Locate your device type in the "Device Guide ", the start page of the developer center of our website, to find more information or consult the manual of your device if there are any difficulties.

To connect devices to your Cumulocity account, click "Device Registration" in the navigator and follow these steps:

  1. Enter the ID of the device in the "Device ID" text field and click "Register Device". To determine the ID, consult the device documentation. For mobile devices, the ID is usually the IMEI (International Mobile Equipment Identity) often found on the back of the device.
  2. Now the device listed is visible by its IMEI number with the status reading as "Waiting for connection". Turn on the device and wait for a connection to be established.
  3. After the device connected, the status should change to "Waiting for acceptance". You will need to confirm that this is indeed the device you want to add by clicking on the green "accept" button on the right of your device's listing.
  4. The status of your device should now read "Accepted". Once that happens your device will be connected to your account.

You are now ready to manage the device.

Device registration

Bulk-registering devices

For connecting larger amounts of devices, you can upload a CSV file with the IDs and credentials. When uploading the CSV file, Cumulocity creates user accounts for each device listed in the file. Devices can then connect securely to Cumulocity without the need to do a manual "Device Registration" step as described in the previous section.

The CSV file needs to have a header row followed by the actual data. The header row needs to contain at least one column marked "ID" and one column marked "Credentials". Here is an example of a valid CSV format:


Use the "Upload" button to upload the CSV file, as shown in the screenshot below. After the data is imported, you will get feedback on the number of devices that were pre-registered as well as on any potential errors that may have occurred.

Bulk registration

To connect the devices, the devices need to be pre-provisioned with related information. More specific, each device needs to be configured as follows:

  • Username: The username to access Cumulocity must have the form <tenant>/device_<id>. <Tenant> refers to the tenant where the CSV file is imported, and <id> refers to the respective value in the CSV file.
  • Password: The password to access Cumulocity, equals the value "Credentials" in the CSV file.
  • Device in managed object representation. Fields: "Type", "Name", "Iccid", "Idtype", "Path", "Shell" in the CSV file.

If you own a Cumulocity Enterprise Edition, you can also register devices across multiple tenants by adding a "tenant" column to the spreadsheet and importing the CSV file from the "management" tenant.

For more information on the file format and accepted CSV variants, please see Bulk device credentials.

Viewing the connected devices

To view the connected devices, you can use the following tools.

  • Select "All devices", which lists all connected devices (in pages of 1.000 devices).
  • Search for the device using the "search" text field.
  • Arrange devices in groups and view the groups.

In all cases, you will see a list of devices as shown in the example below. The list consists of the following columns:

  • An icon representing the connection status as described in "Connection monitoring".
  • The name of the device.
  • Depending on browser width, the model and the serial number of the device.
  • The alarm status of the device, how many critical, major, minor or warning level alarms are currently unresolved for the device. See "Alarms" for more information on working with alarms.
  • A button for deleting the device.

Deleting a device means to remove the device from Cumulocity database including all its generated data. Alternatively, to deleting a device, you can also arrange devices into groups with one group holding all retired devices. This ensures that all reports remain correctly. To prevent alarms from being raised for the retired devices, disable connection monitoring. Deleting a device does not delete the data of its child devices.

Device List

In case a list contains more than 1.000 entries, only the first 1.000 entries are shown. Click the "Load more" link at the bottom to load the next 1.000 entries.

Searching for devices

Cumulocity includes a full-text search for devices. By entering a search term into the "search ..." text field, you can find all devices that contain that term. The image below shows an example of searching for devices that contain the term "Ublox C027". You can search for any text properties of a device. Prefixes are also supported. For example, a search for "Ublox" would also return the devices containing "Ublox C027". Suffixes are currently not supported. For example, searching for "C027" would not return the "Ublox C027".

Grouping Devices

Devices can be arbitrarily grouped according to your use case. A device can be located in multiple groups, and groups themselves can be part of multiple groups again.

Cumulocity distinguishes between top-level groups and subgroups. Top-level groups are shown in the navigator at top-level in the section "Groups". They are your main entry point. Subgroups are used to further subdivide groups.

To create a top-level group, click on the cross button at the top-right next to the search field, then select "Add new group". A small window will appear. Enter group name and search for the desired devices that should be added to the group. Mark the devices and press the "Create group with X devices" button to finish the process. ("X" will be the number of devices that you marked.)

A group can be created with "0" devices in it.

Device Management

You can also add devices to a group in two other ways:

  • Select a device and scroll down to the "Groups" section on the "Info" tab. Use the drop-down menu called "Select and Search groups" to select a group to add this device to.
  • Select a group and go to the tab "Sub-assets" on the left and select it. Then click "Assign devices" at the top right of the group list. A new menu appears. Search for the devices that should be added in the search field. Then mark the relevant devices in the result and click the "Assign x devices" button at the bottom of the result list.

Adding top-level groups

To create a subgroup, just click "Add Group" when viewing a group.

To edit a group, click on the group's name. This allows you to edit the name of the group and assign user permissions for the group. For more information on permissions, see the Administration guide.

Using Smart Groups

Smart groups are groups dynamically constructed based on filtering criteria. They have a temporary character because the group members can change constantly. These groups do not have fixed member listings.They have fixed criteria instead. This type of group can be used, for bulk upgrades for devices of a certain type to a new software or firmware version.

Adding top-level groups

Smart groups can be created by selecting "All devices". To create a new group, simply use filters to select devices. Now click on “Create smart group” and name the group.

Create a smart group

When the group is created, it will appear as top-level group in the “Groups” section. You can adjust filter criteria by selecting the "Sub-assets" tab and modify the filter settings.

Adding top-level groups

Users can also delete smart groups from the top level groups. This operation is irreversible.

Smart groups are not shown when using the Cockpit application.

Adding top-level groups

Adding top-level groups

Viewing the device details

By clicking on a device in a device list, detailed information about the device is displayed. What is actually shown depends on the device type and your configuration of the user interface. If a device has not sent any measurements yet, there will be no "Measurement" tab.

At the top of the device details display, the name of the device is shown. Below the name, a list of breadcrumbs is displayed. If the device is part of an asset hierarchy (such as a group), you can use the breadcrumbs to easily navigate up that hierarchy. Since devices can be part of multiple hierarchies, several rows of breadcrumbs may be shown.

To the right of the name, a cogwheel is shown. Clicking on the cogwheel displays a drop-down menu with further actions that you can take.

If the device is compatible, an "Initiate measurement poll" menu item is available from the cogwheel. Using this item, you can request a device to send measurements with a specified frequency for a specific duration. This type of debugging avoids too much data traffic generated by sending measurements.

Device details

Device details are divided into a number of tabs. The most common standard tabs visible are:


The "Info" tab displays generic information for a device (from top left to bottom):

  • Connection monitoring: The connection monitoring configuration, as described in more detail below.
  • Name and Type: The display name of the device for you to edit, as well as an identifier for the specific type of device.
  • Hardware: Hardware information read from the device.
  • Mobile: If the device contains a modem, the mobile network information will be shown here. You will also see a "Locate" link. If enough information could be obtained, "Locate" will determine the rough location of the device using the database. This will not always be successful and depends on the format that the connected mobile network uses to report its data to the modem.
  • Groups: The groups this device is a part of. You can add and remove groups here. For more information, see "Grouping devices".
  • System: This section shows
    • The internal ID of the device (for access from Cumulocity's APIs).
    • The "owner" of the device (the Cumulocity user who created this device).
    • The time stamp when the device data was last updated.
    • A button to disconnect the device, provided you have administrative access to users and the device was connected using the "Device registration" feature.
  • Notes: Text notes for a device you can share with your co-workers.

Many other fields in this tab are editable. It only makes sense to edit them if the device does not provide this information by itself. If the device provides this information, your edits will be overwritten by incoming information from the device. To save your edits, click on the "Save changes" button at the bottom of the screen.

"Last communication" and "Last updated" are two entirely different time stamps. "Last communication" indicates when a device has last sent data. "Last updated" indicates when the inventory entry of the device was last updated. This update may have originated from the device, from the web user interface or from another application.

Child devices

This tab shows other devices that are connected to the currently displayed device. For example, if you look at a gateway, the tab lists all machines connected to the gateway.


This tab provides a default visualization of numeric data provided by the device in the form of charts. Charts are grouped into types of measurements, which can contain multiple graphs or "series". For example, the screenshot below shows a chart for motion measurement including graphs for acceleration in the three dimensions, and a chart with modem statistics in the form of signal strength and bit error rate.


If a chart contains graphs with different units, one Y-axis is rendered per unit. For example, motion measurements consist of three parameters with unit "meter per square second"; so only one axis is rendered. Modem statistics consist of signal strength in decibel milliwatts and bit error rate in percent, so one axis is rendered for each graph.

To see detailed information about the measured values, hover your mouse cursor over the chart. A tooltip will be displayed with detailed information on the measurement most close to your cursor. (The tooltip will "snap" to the closest measurement.)

Time Ranges and Measurements

By default, charts show the raw data of the last hour. You can change the time range on the X-axis by clicking on the drop-down menu reading "Last hour".

If you increase the time range, the drop-down menu reading "No aggregation" will switch to "hourly" or "daily". The chart now shows ranges instead of individual raw data points. For "hourly", the chart will show a range of the minimum and maximum value measured in one hour. For "daily", the chart will show the minimum and maximum value measured over one day. Likewise, the tooltips will now show ranges of values instead of individual values.

This enables you to get an efficient overview over larger time periods. A graph will only show 5.000 data points per graph maximum not to overload your desktop browser. If you select a fine focus resulting in more than 5.000 data points, a warning message will be shown: "Data has been truncated. Please use aggregation."

Clicking on the "Realtime" button will enable real-time user interface updates of the graphs as new data flows into the system from the connected devices. You can influence the graphical display and axes limits by setting up so-called "KPIs", see the Administration guide.

Important: In order to see measurement graphs, the device has to send measurements in a specified fragment format.

"fragment_name" : { "serie_name" : { "value" : ... "unit" : ... } }

Real example:

"c8y_SpeedMeasurement": { "Speed": { "value": 1234, "unit": "km/h" } }

Fragment_name and serie_name can be replaced by different valid json property name, but that name cannot contain whitespaces and special characters like [],*. The structure has to be exactly as above, two-level deep json object.


The "Alarms" tab displays the alarms of a device. Please see the Section "Working with alarms" for more information.


This tab lists the operations that are sent to a device or were sent to a device. Please see the Section "Working with operations" for more information on operations.


Text configuration

The text configuration allows you to configure the parameters and initial settings of your device. You can manually add or edit a device configuration.

Device details

Adding or editing a device configuration

To manually add or edit a device configuration:

  • Navigate to your desired device.
  • Click on the "Configuration" tab.
  • Under "Configuration", you can add or edit the device configuration as desired.
  • When ready, click "Save".

Binary configuration

The binary configuration allows you to retrieve, modify or save configuration data. The configuration data contains the parameters and the initial settings of your device. This option can be found here:

Device details
A good use-case example for the configuration snapshot is when applying the same configuration to multiple devices. With the configuration snapshot, you can configure one device, download the snapshot and apply it to other devices.

Configuration Snapshot

Retrieving a current snapshot configuration from a device

In order to retrieve a current snapshot from a device, navigate to the device and then click on the "Configuration" tab. Then click on "Get new snapshot from device" at the top right corner. The retrieved snapshot can be found in the "Configuration repository".

The "Configuration repository" is located under the "Management" menu.

Retrieve Configuration Snapshot

Applying snapshot configuration to a device

In order to apply a new snapshot, navigate to a device and then click on "Configuration". Under "Configuration snapshot", you can select a configuration repository entry to use from the drop-down menu. When the entry file is selected, click on "Put new snapshot to device".

Apply new snapshot to a device

Applying a snapshot configuration from one device to another device

  • Navigate to the configuration tab of the device which has your desired configuration.
  • Retrieve the current snapshot from the device by clicking on "Get new snapshot from device".
  • Navigate to the configuration tab of the other device, select the new snapshot from the drop down menu and click on "Put new snapshot to device".

When you apply snapshot configuration from one device to another, the configuration may contain data that is device specific!

Creating a snapshot configuration from a file

New configurations can be added to the "Configuration snapshots" list by clicking on "Add configuration snapshot". Then, you will be redirected to the "Configuration repository". All device configurations are kept in the "Configuration repository" which is located under the "Management" menu item. To add a new snapshot:

  • Enter "Name".
  • Enter "Description.
  • Write the "Device Type" which can be found in the "Info" tab of the target device.
  • Add the "Configuration snapshot file" by clicking either "Upload" or "Choose file".
  • When ready, click "Save".

Configuration Snapshot Repository


This tab allows you to manage and update the firmware of a device and the software installed on a device. To install a new firmware, click on "Install firmware", then select a firmware image from the firmware repository and click the "Install" button.

Similar, to install a software on the device, click "Install software", select a software package from the software repository and click the "Install" button. Hover over a particular software package and click the "x" button to remove the package from the device.


Installing software and firmware usually includes a restart of the device. To monitor the progress of an installation, visit the "Control" tab.


This tab enables low-level troubleshooting of a device, see "Troubleshooting devices" for more information.


The "Location" tab by default shows the location as reported by the device on a map. For devices that do not report a location, you can also manually set the location. Simply place the "pin" in the correct place of the displayed map.

The tab shows when a device contains c8y_Position property. When you send a new c8y position event, you can also set the same c8y_Position fragment on the device and it will automatically mark its position on the map.


The device shell enables you to interactively work with remote devices. Many industrial devices support some form of command language, be it AT commands for modems, CSV-style commands for many tracking devices or elaborate scripting mechanisms such as Tixi TiXML. In the shell, you can send commands in the respective language of the device and interactively view the results of the commands.

The shell user interface is split into two parts:

  • A list of the previously executed commands. By default, the last three commands are visible.
  • A command prompt to enter new commands, which are added to the list.

The list displays status, date and text of a command. Clicking on a list item reveals the result of the command (provided it has been executed).

Device shell

In the command prompt, you can enter arbitrary command text. To send the command text to the device, click the "Execute" button. The "Execute" button can only be selected if the device is online.

To help you with the command syntax, frequently used commands are available for some devices by clicking the "Get predefined" button. Select a command and click "Use" to copy the command to the command prompt, or select "Execute" to execute the command straight away.

Shell commands


The ability to view, edit or control certain devices can be limited to users and user groups. For more information on managing permissions, please visit the Administration guide. Use the application switcher to go to the Administration application.


Devices can record the history of their movements in Cumulocity. Using the tracking tab, you can select a time period and visualize the movements of the device during this time period. Movements are shown as red lines on the map.

Next to the map, the individual recordings with their time are listed ("location update events"). When you click a recording, a "pin" on the map will show the location at the time of the recording.

The Tracking tab shows up when device contains c8y_Position property.


Depending on the type of device and the integration into Cumulocity, you can also configure device-side geo-fencing and motion detection.

Additionally, when the feature is activated, and with compatible devices, Cell ID information can be used to determine the position of the device. Currently, the services from Combain and Google are supported. The user can see the tracks based on both data, or filter out GPS based data or Cell ID based data.

Service monitoring

In addition to connection monitoring, Cumulocity features a separate service monitoring for machines. See "Service monitoring" for more information.


Using the "Logs" tab, you can request log information from devices. Log information can be filtered according to date ranges, type of log, keywords and the maximum number of lines to transfer.

To request a log from a device you have the following options:

  • Select the date and time range.
  • Choose the type of log. The supported logs are usually device-specific.
  • Enter an optional text to filter the log. For example, if you enter "Users", only lines with the word "Users" in them will appear in the returned log information.
  • Select the maximum number of lines to display (counted from the end).
  • Click "Request log".

Request log

Requesting a log from a device may take some time. After the log has been transferred from the device to Cumulocity, it will appear in the list below the selection widgets. The entry in the list includes the log time range that was queried. Click on the entry in the list to show the log on the page. Hover over the entry to access the download and delete symbols. Using the download symbol, you can download the log excerpt to your local PC. Using the delete symbol, you can delete the log file.


Finally, Cumulocity can associate devices and assets with multiple external identities. For example, devices often can be identified by the IMEI of their modem, by a microcontroller serial number as well as by an asset tag. This tab lists all the identities recorded for a particular device.

This is useful when you have non-functional hardware and need to replace the hardware without losing the data that was recorded. Just connect the new hardware to your account and modify the identity entry of the old hardware to contain the identity of the new hardware.

Connection monitoring

Cumulocity can automatically monitor the connection to your devices. If you want the connection to a device to be monitored, visit the "Info" tab of the device. On that tab, check the "Required Interval" field at the top. This field defines how often you expect to hear from the device. For example, if you set "Required interval" to 60, you expect that the device communicates at least once in an hour with Cumulocity. The interval is either set by the device itself, based on the device's knowledge how often it will try to send data, or it is set manually by you.

The various connection states are illustrated on the image below. The top arrow represents traffic from the device to Cumulocity. It can be green, red or grey. Green means that data was sent within the required interval. Red means that it was not sent within the required interval. Grey means that no required interval is configured.

The bottom arrow indicates the state of the push connection that is used to send commands from Cumulocity to the device (a connection to /devicecontrol/notifications API, NOT to realtime API). It can be either green or grey. Green means that the connection is established. Grey means that the connection is not established. In case of a grey arrow, either the device does not support push connections, or there is an error.

"Maintenance mode" is a special connection state indicating that the device is currently being maintained and should not be monitored. While a device is being maintained, no alarms for that device are raised. You can enable maintenance mode by setting the required interval to a negative value.

Connection states

Connection monitoring is not real-time. For example, the state of the connection will not change immediately when you switch off a device. Depending on your network, it may take about 20 minutes until a broken connection is discovered, since the network will retry sending data for a significant amount of time.

When a device is detected to be offline (stops sending data within required interval and top arrow changes to red color), an unavailability alarm is created for the device reading "No communication with the device since

Service monitoring

Cumulocity distinguishes between connection monitoring and service monitoring. Connection monitoring only indicates that the device is communicating with Cumulocity, it does not automatically mean it is functional or not.

Service monitoring indicates if the device is in service. For example, a vending machine is in service if it is ready to sell goods. A vending machine can sell goods using cash money without a connection to Cumulocity. From the perspective of a merchant, it is in service. Similar, if you switch off the power on a gateway, the devices behind the gateway can still continue to work.

Cumulocity considers a device to be in service while there is no critical, unresolved alarm present for the machine. This is displayed as a share of time such an alarm was present. If a machine didn't have any critical alarms whatsoever during a time period, it was 100% in service. If half of the time there was some critical, unresolved alarm, the machine was 50% in service.

Service monitoring

While a machine is offline, Cumulocity assumes by default that the machine continues to stay in service as it was before it lost connection. If it was out of service before, Cumulocity assumes the machine to be out of service during a connection outage.

There can be exceptions from this rule. If your vending machines rely exclusively on cashless payment, losing the connection to the network means that your machine is out of service and stops selling. For this case, unavailability alarms must be set to have "CRITICAL" priority instead of "MAJOR" priority in the Administration application.

Cumulocity can display service availability at the level of individual devices or across all devices. If you select "Service monitoring" in the navigator, the overall service across all devices is shown. On that page, you will also see a histogram of how many devices had what service availability in the past month (see the above screenshot).

Locating devices

By clicking on "Map" in the navigator, a map of all devices in your account is shown. Devices are shown as "pins" that you can click to see the name of the device. Clicking the name of the device takes you to the detailed view of the device. By clicking the "Realtime" checkbox, the map will refresh automatically when devices are moving.

Working with alarms

Devices can raise alarms to indicate that there is a problem requiring an intervention. They can be viewed in various places:

  • By clicking on "Only unresolved" in the "Alarms" tab to see alarms of all devices that have not been cleared yet.
  • By clicking on "Alarms" in the navigator to see the entire alarm history.
  • By clicking on a device and selecting the "Alarms tab" to see the alarms of that device. By default, only unresolved alarms are shown, but you can disable the "Only unresolved" checkbox to see all alarms.

The alarm display is split into four sections, separately listing alarms of different priorities. In each section, the most recent alarm is displayed first. The image below shows the detailed display of an alarm after it is clicked. The detail view contains the following items:

  • Alarm severity: The severity of the alarm. Cumulocity's alarm severities are:
    • Critical: The device is out of service and should be fixed immediately.
    • Major: The device has a problem that should be fixed.
    • Minor: The device has a problem that may be fixed.
    • Warning: There is a warning.
  • Status: The status of the alarm. An alarm can be:
    • Active: When it was raised and nobody is so far working on the alarm.
    • Acknowledged: When someone clicked the "acknowledged" button to indicate that someone is working on the alarm.
    • Cleared: When either someone clicked the "clear" button to manually clear an alarm, or when the device detected by itself that the problem was removed.
  • Count: The number of times that this alarm was sent by the device. Cumulocity deduplicates alarms so that only one alarm of a particular type can be active/acknowledged for a particular device. If another alarm of the same type is sent by the device, the count is increased.
  • Description: A text description of the alarm.
  • Device: The name of the device. Clicking the name leads you to the detail view of the device.
  • Date created: The timestamp when the alarm was created first.
  • Type: The type of the alarm. This text is used for duplicating alarms and for configuring the priority of alarms in the Administration application.
  • Additional information: An alarm can contain arbitrary additional information provided by the device.
  • Audit log: Along with the alarm, a log of changes to the alarm is stored. This creates an alarm history with various data.

Alarm display

Working with operations

Operations are used to remote control devices. You can click on the "Device control" menu in the navigator to view all operations that have been sent to a device and that are still queued for being sent to a device. Similar, you can select the "Control" tab of a particular device to view that device's operations.

Operations can be in any of four states:

  • Pending: The operation has just been created and is waiting for the device to pick it up.
  • Executing: The operation has been picked up by the device and is being executed.
  • Successful: The operation has been successfully executed by the device.
  • Failed: The operation could not be executed by the device.

Clicking on an operation shows the parameters of the operation. For example, clicking on a configuration operation will display the configuration that is sent to the device. Clicking on a failed operation shows the reason of the failure.

The "All" button shows all operations for a device, regardless of whether they were processed already. The device is listing these operations in ascending time order. Operations are executed strictly according to this order.


Bulk Operations

For easier handling of devices, Cumulocity features "Bulk operations". With "Bulk operations" you can now easily execute operations for each device in one group.

To execute bulk operations for the one group you have those options:

  • Select a device and navigate to the "Control" tab.
  • Create an operation.
  • Hover over the operation you want to execute.
  • Click on the cogwheel.
  • Click on "Execute for entire group".

Execute bulk operations

For more information about operations refer to Working with operations.

In order to view the status and progress of your operations simply click on the desired group, then click on "Bulk operations".

Bulk operations tab

Bulk operations can also be edited. To edit an operation hover over the desired operation first and then click on the blue marker button.A new window will pop-up. "Start Date" and "Delay" values can be changed. To change operation details click on "Show operation details". When ready click on "Reschedule" to apply changes or click on "Cancel" to discard changes.

To delete operations click on the cross button.

Troubleshooting devices

Events are low-level messages sent by devices that are usually used for application-specific processing. For example, a vending device sends its real-time sales in the form of events. If you need to troubleshoot a device at a more detailed level, visit the "Events" tab. Clicking on individual events will reveal more information on the data contained in the event. Similar, you can see all events across all devices by selecting "Events" in the navigator.

Since devices may send larger amounts of event data, you can filter the data shown here by date. You can also click the "real-time" checkbox to see events coming in from the devices in real-time.

Managing device firmware and software

Cumulocity provides a central place to collect reference firmware and software for devices in the "Firmware repository" and the "Software repository".

To update firmware or to add software packages on a specific device you have to follow three steps:

  1. Upload the firmware or software files in the Administration application. (This step is optional and is not mandatory since the manufacturer might offer the firmware online.)

  2. Select and save the files in the "Firmware repository". To add a new firmware image to the repository, visit the "Firmware repository" and click the "Add firmware" button. Then type the name of the firmware, its version and the URL from which the device can download the firmware. Similar use the "Software repository" to add reference software packages.

  3. Install the firmware on a specific device. First navigate to "All Devices", select the desired device, then go to "Software" on Device Details and click on "Install firmware". Installing software packages is very similar. You follow the same steps as mentioned before, but you choose "install software" instead. (For more info on this step please refer to "Software".)

You must visit the Administration application to store other types of binaries in Cumulocity.

Cumulocity provides users with the ability to execute firmware or software updates for multiple devices simultaneously. To do so:

  • Execute the software update in a single device to test that the new version really works
  • Navigate to the operation and select "Execute for the whole group"
  • Fill the form to schedule the bulk operation and click on the "Create" button

The operation status can be viewed under the name of the selected group in the "Bulk operation" tab.

For more info on bulk operations refer to Dealing with bulk operations

Managing device credentials

The "Device credentials" menu lists all credentials that have been generated for your connected devices. Each device that has been registered shows up here with the naming convention "device_<id>".

In most cases, you should not need to edit anything. Exceptions are:

  • You have carried out a factory reset on a device. In this case, the device will often loose its assigned credentials. Find the credentials and click the "x" button to delete the credentials in Cumulocity as well. Then continue with the normal registration process to re-register the device.
  • If you would like to temporarily disconnect a device use the "Deactivate" button next to the device credentials.
  • If you would like to assign more permissions to an individual device click the device credentials and select additional or different user groups for the device.

Bulk provisioning

Device credentials can be also provided from CSV file. Files can be uploaded using the button pointed with an arrow. More details on the file structure can be found in under Bulk-registering devices above.


With the Cumulocity Simulator, all aspects of IoT devices can be simulated:

  • Setting up a simulated device or a network of simulated devices
  • Specify which operations the device can process
  • Create work instructions based on predefined message templates or user defined templates and schedule work steps
  • Create up to ten devices of a defined type
  • Generate messages for measurements, alarms, events and inventory
  • View simulation problems as alarms

What is a simulator?

With the simulator, you can create artificial devices that have the same level of functionality as connected hardware devices.

A simulator uses a playlist to simulate messages that the device sends to the Cumulocity platform. A playlist is a series of instructions that the simulator executes one after the other. When the last instruction is reached, the simulator starts again with the first one.

An instruction can either send a message (measurements, alarms, events and inventory) or wait for a specified time (sleep).

A message is defined by choosing a message template (like sending a temperature) and providing the values for this template (23.0 degrees). Many predefined message templates are provided, “create measurement”, “send event”, “create” and “cancel” an alarm. These are based on MQTT static templates. Additionally, custom message templates can be defined using the SmartREST template editor.

Set up a simulator

To set up a simulator go to the Navigator in the Device Management and choose "Simulators" under the section "Devices".

New Simulator

Simulators can be added by clicking on "New" which will open a card. Then you can choose if you want to define a new simulator or choose a preset. The name of the simulator will be determined and up to 10 instances from this simulator.

Add Simulator


The other option available is to create a simulator from a preset. Currently, there are two different presets available: A "temperature measurement" preset and a "position update" event preset.

Add Add Temperature Preset

Add Position Preset

Edit Simulator

Existing simulators are listed on this page. Simulators can be edited, cloned or removed by clicking on the cogwheel in the top right corner of the card. That opens a drop-down menu with those options.

Adding Instructions to the Simulator

After setting up a simulator you can add instructions what your simulator should do. Instructions are single work steps added to a playlist. The simulator will work through this list. To see an example click on the Temperature Simulator.

Add Instructions

The following overview will appear:

Add Instructions Step 2

Within this preset there are sample instructions already added. You can identify 2 steps: "Create measurement" and "Sleep".

Instruction Details


The measurement instruction refers to a fragment. This refers to the example shown below. Fragments are used to identify capabilities of a managed object. Find more details about fragments here: Sensor Library

Add Instructions Step 3

The "Sleep" instruction requires one value for its duration in seconds. The panel on the right half of the screen changes according to the type of instructions you choose.

Add Instructions Step 4

Adding Operations to a Simulator

Directly underneath the instructions tab, you find supported operations. In this menu, you can turn on or off specific operations like Configuration or Software/Firmware update.

Operations Off

Operations On

Some operations are turned on. You can also specify customized operations by using the add custom operation button.

Alarms (within the Simulator menu)

The last tab in the simulator menu are alarms.

Simulator Alarm

These are not the alarms related to the simulated device, these are alarms connected to the simulator itself. If a simulator does not work correctly, you will see alarms or a warning here.

SmartRest Templates


Using the SmartRest editor, developers can easily create new SmartRest templates and update existing ones. This applies to SmartRest 2.0 templates for MQTT as well. The SmartRest templates are a collection of request and response templates used to convert CSV data and Cumulocity Rest API calls. For example, you can use SmartRest templates to easily add devices to the platform instead of manually writing the requests each time. To ease the device integration, Cumulocity already supports static templates that can be used without the need for creating your own templates. These templates focus only on the most used messages for device management. For more info about the static templates, see here.

The SmartRest templates are located in the “Device types” section in the navigator. In the templates list, you can see the template ID, name and the number of messages and responses contained in the template.

template view

There are two ways to add a SmartRest template:

  • Import an already existing template.
  • Create a new template.

Importing an existing SmartRest template

In order to import an already existing template first click on the “Import” button located on the top right.

Import template

Choose the file to upload and enter the template name and unique ID.

Adding a new SmartRest template

To add a new template first click on the “New” button.

Add template

Enter the template name and unique template ID. Both fields are mandatory and should be filled. When ready, press “Continue”.

Adding a message

The message template contains all necessary information to convert the SmartRest request into a corresponding Rest API call which is then sent to the platform.

To add a new message, first navigate to the “Messages” tab in your desired SmartRest template, then click on the “Add message” field and fill the following fields:

  • Message ID: Unique integer that will be used as a message identifier. It must be unique among all message and response templates.
  • Name: This field is mandatory.
  • Target Rest API: Choose one of the Rest API options that will be targeted in this message. (Measurement, Alarm, Inventory, Event or Operation)
  • Method: Select the request method.
  • Select the “Includes response” checkbox if you wish to process the result of the request with response templates.
  • Rest API built-in fields: These fields are optional and are different depending on the target Rest API option selected. In case no value is provided, a device will be able to set it when sending an actual message.
  • Rest API custom fields: Additional fields can also be added, enter the API “Key” and choose your desired data type.
  • Preview: Here you can see the preview of your request.
  • Click “Save” when ready.


To remove a message, simply click on the message and then click on “Remove”.

Adding a response

A response template contains the necessary information to extract data values from a platform Rest API call response which is then sent back to the client in a CSV data format.

To add a new response, first navigate to the response tab in your desired SmartRest template, then click on “Add response” and fill the following fields:

  • Response ID: Enter a unique ID which will be used as a response identifier.
  • Name: Enter the name of the response.
  • Base Pattern: Enter the base pattern of the response.
  • Condition: Enter the condition value of the response.
  • Pattern: At least one pattern is required. Enter a pattern value.
  • When ready, click on “Save”.


To remove a response, simply click on the message and then click on “Remove”.

Exporting templates

In order to export a template, click on the additional options menu of the desired template and then click on “Export”.


Exporting CSV file

Navigate to the “CSV preview” tab in the desired template. In this tab you can see additional information about the “Messages” and “Responses”. Click on the “Export” CSV button. Then, a small window will pop-up. Select your prefered options for the CSV and click on “Download”.

Export CSV

Editing or removing templates

To edit a template, either click on the desired template or click on the extra menu and then “Edit”.

To delete a template click on the additional menu of the template and then click on “Remove”.

Remove template

Cloud Remote Access


Cumulocity Cloud Remote Access implements Virtual Network Computing (VNC) to remotely access operating panels and other devices with a graphic user interface. The operators of the devices can thus work with the devices via a web browser, as if they were in front of them.


Cloud Remote Access works as in the illustration below. Starting from the remote-controlled device: The device runs a VNC server and is connected to a gateway compatible with Cloud Remote Access. This gateway must be registered as a device within the "Device Management" application in Cumulocity. More information about registering devices and instructions can be found here: Device Registration


With Cloud Remote Access a user can

  • View status visualizations and track updates of remote devices immediately as if the user is at the device location
  • Connect to remote devices easily, because complex VPN setups are not required.


The connection to remote devices is securely encrypted through TLS technology. Additionally, passwords are encrypted in your Cumulocity account, so that you do not need to manage them elsewhere.

Using Cloud Remote Access

Cloud Remote Access is available in the Device Management application.


  • A Cloud Remote Access compatible gateway connected to your Cumulocity account.
  • A device with a VNC server that is connected to the gateway and reachable from the gateway.
  • Cloud Remote Access included into your subscription plan. If you do not see the "Remote access" tab below, please contact

In Cumulocity you can locate gateway devices with “All devices” inside the Device Management application.

router device

Select the gateway from the list. Below can see the tab “Remote access” if your subscription plan includes Cloud Remote Access. Click on it and a list panel will appear.


You can configure remote devices by clicking on “Add endpoint”.

The "endpoint" is the IP address and port of the VNC server running on the device. This IP address and port need to be reachable from the gateway.

To be able to configure an endpoint, you need the following permissions: Remote access: set to “Change” and Device Control set to “Change”. To read data a “Read” permission is sufficient. For more information on setting up permissions, please see the administration user's guide

A dialog will open as shown below. Enter the IP address and port, as well as the password of the VNC server. Once the endpoint is added, it will be displayed in the list.

Remote access endpoint

To connect to configured endpoints go to the Tab “Remote access” and choose an endpoint to connect to. These endpoints represent the remote controlled devices. When you click on “connect”, the VNC connection will start. To do so you need to have at least “Read” rights for the remote access functionality and “Change” for the Device Control. More information about users and rights can be found here.

Connect Endpoint

A new browser tab will open and you see the front screen or operating panel of the device you are connected to within moments. The top bar of the screen will state “starting VNC handshake” when the process is starting.

The small cogwheel at the end of the row opens a dialog to edit or remove endpoints.

Edit endpoints


Please check if you have sufficient permissions, if you want to set up new endpoints. To do so you need to have “Change” rights for Remote Access and Device Control. Without Device Control “Change”, you can not register any device and without Remote Access “Change” you can not add an endpoint for remote access. To establish a connection to a remote operating panel a “Read” permission for Remote Access is sufficient.

The VNC connection via a Gateway to a remote VNC server can also fail because of network problems. In this case you need to contact your network administrator.

Tested on the following VNC Servers:

  • Real VNC Connect 6.0.2
  • TightVNC 1.3.9
  • TigerVNC 1.7.0
  • EfonVNC 4.2