Overviews¶
Alarms¶
Devices can raise alarms to indicate that there is a problem requiring an intervention.
IoT Extension displays alarms at the level of individual devices and across all devices:
- Click "Alarms" in the overview menu in the navigator, to check the alarms for all devices.
- Switch to the "Alarm" tab in the details of a particular device, to check the alarms of this specific device.
By default,
- only unresolved alarms are shown. If you turn on "Show cleared alarms" at the right of the top menu bar, you will see the entire alarm history.
- alarms are shown as coming in from the devices in realtime. Click "Realtime" in the top menu bar to disable realtime updates.
Alarms are classified according to their severity. IoT Extension includes four different alarm types:
| Severity | Description |
|---|---|
| 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. |
The "Alarm" tab is split into four sections corresponding to these alarm types.
By clicking one of the buttons at the top, the corresponding section will be hidden. Click it again to show the section again.
Within each section, the alarms are sorted by their occurrence, displaying the most recent alarm first.
In each row, the following information for an alarm is provided:
| Info | Description |
|---|---|
| Severity | One of "critical", "major", "minor", "warning" (see above). |
| Count | The number of times this alarm was sent by the device. Only one alarm of a particular type can be active for a certain device. If another alarm of the same type is sent by the device, the number is increased by 1. |
| Description | An arbitrary text describing the alarm. |
| 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 changed the status to "Acknowledged" to indicate that someone is working on the alarm. - "Cleared": When either someone manually set the status to "Clear" or when the device detected by itself that the problem has gone. |
| Last occurrence | Timestamp of the last occurrence of the alarm (device time). |
| Device | The name of the device. Clicking the name leads you to the detailed view of the device. |
Click the arrow on the right of a row to expand it and display further details on the alarm.
- "Status": Providing further information on the alarm status and showing the type of the alarm. The type info is used for duplicating alarms and for configuring the priority of alarms in the "Administration" application
- "Change Log": Providing the server time when the alarm was created, which may differ from the device time.
To change the status of an alarm, hover over it and click the button for the desired status or click the menu icon and from the context menu select the desired status.
It is also possible to change the status of all alarms to "clear" at once. Click "Clear all" in the top menu bar, to clear all alarms of the selected severities.
Device control¶
Operations are used to remotely control devices.
IoT Extension displays operations at the level of individual devices and across all devices:
- Click "Device control" in the Overview menu in the navigator to see the operations for all devices.
- Switch to the "Control" tab in the details of a particular device to see the operations of this specific device.
There are two types of operations in Device control:
- Single operations execute on a single device
- Bulk operations comprise of the same single operation executed on a set of devices
Single operations:
The list of single operations is displayed in the Single operations tab.
Single operations can have one of the following statuses:
| State | Description |
|---|---|
| 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. |
By clicking one of the state buttons at the top, the corresponding operations will be hidden. Click it again to show the operations again.
Click "Realtime" at the right of the top menu bar to see operations coming in from the devices in realtime.
Operations are listed in descending time order. Operations are executed strictly according to this order.
For each operation, the following information is provided:
| Info | Description |
|---|---|
| Status | One of "pending", "executing", "successful", "failed" (see above). |
| Name | Name of the operation. |
| Device | The name of the device. Clicking the name leads you to the detailed view of the device. |
Clicking a row expands it and displays further details on the operation.
- "Details": Providing information on the operation name and status. In case of status = FAILED the reason for the failure is provided.
- "History of Changes": Providing information on the past changes of the operation.
Bulk operations:
For easier handling of devices, MindConnect IoT Extension offers bulk operations. With bulk operations, you can execute operations at once for each devices within one group.
To filter the list of bulk operations by operation type, click the dropdown list in the top menu bar and select a set of operation types, then click “Apply”. Bulk operations can have the following operation types:
| Operation type | Description |
|---|---|
| Configuration update | The bulk operation updates the configuration of the selected devices. |
| Firmware update | The bulk operation updates the firmware on the selected devices. |
| Software update | The bulk operation updates the software on the selected devices. |
| Apply device profile | The bulk operation applies a device profile on the selected devices. |
To filter the list of bulk operations by status, click one of the status buttons in the top menu bar. Bulk operations can have one of the following statuses:
| Status | Description |
|---|---|
| Scheduled | The bulk operation has been created and is on hold until the scheduled time. |
| Executing | The bulk operation is being executed. |
| Canceled | The bulk operation was created but canceled before the scheduled time. |
| Completed with failures | The bulk operation completed with failures for some devices. |
| Completed successfully | The bulk operation has been successfully executed on all devices. |
To filter the list of bulk operations by date, select a date in both the Date from and Date to date pickers, then click “Apply” right next to it. To clear the filter, click “Clear” right next to it.
Click “Realtime” at the right of the top menu bar to see operations coming in from the devices in real-time. Click “Reload” to update the list once manually.
You can add bulk operations using the “New bulk operation” option.
For each operation, the following information is provided:
| Info | Description |
|---|---|
| Status | One of “Scheduled”, “Executing”, “Canceled”, “Completed with failures”, “Completed successfully”. |
| Name | Name of the operation. |
| Progress bar | Only for executing and completed bulk operations. Shows the operation’s progress in percent. |
| Start and finish dates | Only for executing and completed bulk operations. For executing bulk operations, the finish date is an approximation based on the bulk operation settings. |
| Refresh button | Only for executing bulk operations. Updates the progress bar. |
Clicking the arrow button at the right in a row expands the row and displays further details on the bulk operation.
- Details: Providing information on the start date, delay, status, and result of the bulk operation.
- Operation: Providing information on the operation in the form of a JSON object.
- Operations: Only present for executing or completed bulk operations. Providing information on the status and the device of single operations entailed in the bulk operation.
- History of Changes: In a second tab, providing information on the past changes of the bulk operation.
For more information such as creating, editing, cancel bulk operations, see https://cumulocity.com/guides/10.7.0/users-guide/device-management/#a-nameto-view-bulk-operationsato-view-bulk-operations.
Events¶
Troubleshooting devices at a more detailed level can be done with the help of events. Events are low-level messages sent by devices that are usually used for application-specific processing. For example, a vending device sends its realtime sales in the form of events.
IoT Extension displays events at the level of individual devices and across all devices:
- To see the events of this specific device, click the "Events" tab.
- To see the operations for all devices, click "Events" in the overview menu in the navigator.
Per default, events are shown as coming in from the devices in realtime. To disable realtime updates, click "Realtime" at the right of the top menu bar.
For each event, the following information is provided:
| Info | Description |
|---|---|
| Timestamp | Timestamp when the event has been executed. |
| Name | Name of the event. |
| Device | The name of the device sending the event. Clicking the name leads you to the detailed view of the device. |
In the event list the latest entry is displayed on top.
Clicking a row expands it and displays further details on the event (as type and position of the device).
Since devices may send large amounts of event data, you can filter the data to be displayed by date.
Select a start date and an end date from the fields in the top menu bar and click the "Filter" button to apply the filter. You can filter the events based on the types by entering the event type in the "Event type" field. Click the "Clear" button to clear the filter again.