Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Manage devices

You can create, edit, or remove devices from the IIoT Core Services UI.

Key definitions.

  • Device

    A device in IIoT Core Services can be either a Core device or a gateway that collects data. A Core device can be a cluster or worker node running IIoT Core Services. You can manage devices from the Device page in the IIoT Core Services UI.

  • Core

    A Core device is added to the device inventory when you install IIoT Core Services. You can edit the description or location, but you cannot add or remove a Core device from the inventory. You can see alerts for the device and check its status and current state.

  • Gateway

    A gateway is generally a small-footprint device close to an asset from which data is collected. It can be used to temporarily hold data in environments with intermittent connectivity. Once connectivity is established, the gateway can then transmit the data to IIoT Core Services for storage and analytics. After a gateway device is provisioned with the provided CLI tool, it can be managed by IIoT Core Services. See Registering and provisioning IIoT Gateway using CLI.

Add a gateway to the device inventory

You can add a gateway to the device inventory in the IIoT Core Services UI, so that data routes can be configured to collect data from the gateway device.

Procedure

  1. In the IIoT Core Services UI, select the Device tab.

  2. Click Add Device.

  3. Enter the following information:

    FieldDescription
    NameEnter a name for the device.
    Device TypeSpecify the type of device to be added. Gateway is currently the only option.
    Inventory IDSpecify the unique identifier for the device. It must match the Inventory ID that is set during the gateway installation.
    Location (Optional)Specify the location of the device.
    Description (Optional)Specify a description for the device.
    Additional Properties (Optional)Click Add Property to create additional fields to describe the device if necessary, such as an RFID, a boolean status, or a URL. You can add properties individually or import a set of properties from a JSON file. Then click Apply.
    Enable PollingSelect to enable polling on the management plane. Polling allows the gateway to periodically connect to the Core server and pull tasks for controlling and monitoring the device at certain time intervals instead of keeping connections open.
    NoteToggling the polling parameters does not affect data collection.
    Polling IntervalSet how frequently the gateway polls for new connect messages.
    Polling Retry IntervalSpecify the period of time between the end of the timeout period of the last retry and the next retry.
    Polling Max RetriesSpecify the maximum number of retries in one polling session.
    Endpoint Database Defragmentation ScheduleSelect a database defragmentation schedule to keep the database optimized:
    • Monthly
    • Weekly
    • Daily (Midnight)
    • Hourly
  4. Click Add to add the new device to the repository.

Results

The device is shown in the device list, with a Device State of Inventory and a Status of N/A.

After the gateway device is created, you can configure it to receive data. By provisioning the gateway, you can create data routes to specify where the data flows to. See how to register and provision IIoT Gateway in Registering and provisioning IIoT Gateway using CLI.

Edit a device

You can edit a device in the device inventory in the IIoT Core Services UI.

What you can edit depends on the device type:

  • IIoT Core: Location, Description.
  • IIoT Gateway: Name, Location, Description, Additional Properties.

To edit a device, select Edit from the Actions menu next to the device description in the device inventory.

Procedure

  1. In the IIoT Core Services UI, select the Device tab.

  2. To edit a device, select Edit from the Actions menu next to the device description for that device.

  3. Make the necessary edits.

  4. Click Save to update the device properties.

Delete a device

You can delete a device from the device inventory in the IIoT Core Services UI. Perform this task when you no longer need to collect data from the device, such as when that device is inoperable or physically removed. Deleting a device also deletes any data routes associated with it. When a gateway device is deleted in the IIoT Core Services UI, it is completely reset and ready to be added and provisioned again.

Procedure

  1. In the IIoT Core Services UI, select the Device tab.

  2. To delete a device, select Delete from the Actions menu next to the device description for that device.

  3. Confirm the deletion by clicking Delete, or click Cancel to keep the device in inventory.

Bookmark a device

You can bookmark devices for easy reference as an individual user.

Procedure

  1. In the IIoT Core Services UI, select the Device tab.

  2. For a particular device, select the Actions menu icon and select Bookmark/Unbookmark to bookmark it.

    A black bookmark appears on the device row when activated.
    NoteTo unbookmark a device, select the corresponding Actions menu icon and select Bookmark/Unbookmark.
  3. (Optional) To only search for bookmarked devices, select the Bookmarks check box on the Devices inventory page.