August 2019 (version 2.25.5)

Remote Manager version 2.25.5 offers the following features and fixes.

Features and enhancements

Maintenance Mode

In Remote Manager, devices can be put into maintenance mode. When a device is in maintenance mode, alerts for the device fire and reset, but alert notifications for the device are not sent.

You can turn on (or off) maintenance mode for a device by specifying the following in a PUT request to /ws/v1/devices/.

For example:

{
"maintenance_mode":"on"
}

You can filter v1 API requests on maintenance mode using the maintenance_mode query.

For example:

/ws/v1/devices/inventory?query=maintenance_mode='on'

The following APIs can be filtered on maintenance_mode:

/ws/v1/reports/devices/

/ws/v1/devices/

/ws/v1/alerts/status/

/ws/v1/alerts/summary/

In Digi Remote Manager 3.0, devices in maintenance mode show a in the Connection Status column, as well as the message Maintenance Mode On in Connection Status details. Devices in maintenance mode are excluded from all dashboard charts. You can set maintenance mode on or off using the user interface: Devices > Actions > Turn On Maintenance Mode or Devices > Actions > Turn Off Maintenance Mode.

Device name change alarm

The device name change alarm can help you keep track of device identity and make business decisions based on device activity.

  • The device name change alarm fires whenever the name of a device changes.
  • The device name change alarm does not fire when a device name is set for a device that currently has no name.

Device name change triggers Profile Management scan

A device name change triggers an automatic rescan of the renamed device if the device is associated with an active Profile.

Profile manager tracks unique settings by device name

The unique settings spreadsheet downloaded from the Profile edit wizard includes device names as well as device IDs. If both device name and ID are specified for a device, the device name takes precedence.

Device name events appear in event logs

Device name events appear in the event log. To view event logs in Remote Manager classic, go to Admin -> Event Log.

Swap device name

By default, you cannot set a device name to a name that is already in use by another device. However, you can use the v1/devices/inventory allow_swap parameter to successfully swap the name of an existing device with a target device.

When a device name is swapped, the event log shows three messages:

  • Message that indicates the name is removed from the old device.
  • Message that indicates the name is assigned to the target device.
  • Message that indicates a device name swap has occurred.

For example, a PUT request:

ws/v1/devices/inventory/0008CAFE-0B2DC439-AF0836FF-FFE96421?allow_swap=true

With the following payload:

{
  "name": "Bus-0042",
  "group": "InService",
  "tags": [
     "TransitSchedule1"
  ]
}

Swaps name Bus-0042 from the old device to the target device and updates the device group and tags settings.

Order devices returned by a bulk get

You can use the orderby parameter on a v1/devices/bulk GET request to determine the order of returned devices.

Example: /ws/v1/devices/bulk?orderby=name

Query by device geoposition

You can query devices by geoposition on the ws/v1/devices/inventory API using latitude or longitude —geoposition.latitude or geoposition.longitude—or query within or outside a bounding box using the form [ SW corner longitude, SW corner latitude, NE corner longitude, NE corner latitude ] with the within or outside operators.

For example:

  • query=geoposition within [-10, -10, 10, 10]
    Matches any device with coordinates within the specified area.
  • query=geoposition outside [-10, -10, 10, 10]
    Matches any device with coordinates outside the specified area.

Events for monitor activity

  • Added events for monitor activity: disable, disconnect, and reconnect monitors.

To view event logs in Remote Manager classic, go to Admin -> Event Log.

Prevent adding new device with update_only parameter

On POST requests to ws/v1/devices/inventory/{id}, specify update_only=true to verify the specified device ID is already provisioned in the account. If the device does not exist, the POST fails. The default is update_only=false.

Users can modify their account with the v1/users API

All users can use the ws/v1/users API to modify their own account.

Publish v1/jobs events to monitors

  • Monitors can receive v1/jobs events—create, update, and delete—by subscribing to the monitor topic: jobs.
  • Monitors subscribed to the existing monitor topic Job will continue to receive legacy Job events.
  • Added user name field usrUserName to the Job event.

Sample v1/jobs event:

{
      "id": 2177699059,
      "customer_id": 7493,
      "username": "digiuser",
      "job_type": "send_message",
      "job_sync_mode": "asynchronous",
      "job_reply_mode": "all",
      "job_targets": "00000000-00000000-000000FF-FF000000",
      "job_request_payload": "",
      "job_description": "query_setting",
      "job_status": "in_progress",
      "job_target_count": 1,
      "job_submit_time": "2019-07-08T14:00:01.570Z",
      "job_offline_mode": "offline",
      "job_timeout": "2019-07-15T14:00:01.573Z",
    }

Added group support to DataPoint and DataStream monitor topics

You can use the [group=targetGroup] syntax in DataPoint and DataStream monitor topics. Scoping event delivery by group restricts events you receive to events coming from devices in that group only.

For example, monitor topic

 [group=NorthWest]DataPoint/*/metrics/all/eth/*

Receives ethernet metrics from devices in the NorthWest group only.

Dashboard XLS and CSV export

Removed XLS and CSV export from device summary dashboard for connection status history.

Resolved issues

Fix: Automatically fire/reset Monitor alerts

Remote Manager automatically resets the Monitor has not been able to receive new events alert if the monitor has received a message after the alert fired. Note that Remote Manager checks the monitor for alerts and received messages every hour on the half hour (for example, 5:30, 6:30, and so on).

Fix: Corrected v1/settings API Explorer example

Added the attribute name to the URL for the v1/settings examples.

Fix: Monitor messages delayed and/or monitor message with bad JSON content

Click Try the Remote Manager 3.0 Preview to go to the preview. For details on what's included in the preview, click Preview.