Connecting with the IBM Watson IoT Platform

Administrators can use the IoT Connector wizard in the Administration Work Center to configure a connection to the Watson™ IoT Platform, specify how to import data from IoT sensors, and map the data that is imported from devices to asset and location meters.

Selecting an IoT Service

About this task

The first step in the IoT Connector wizard is to select the Watson IoT Platform service.

Procedure

  1. In the Administration Work Center, from the side menu, click Integration and select the IoT Connector tab.
  2. Select the IoT Connection Service subtab.
  3. On the Select an IoT Service page of the wizard, select IBM Watson® IoT Platform and then click Next.

Configuring the IoT Service

About this task

To configure the IoT service, review the endpoint information and provide details that are needed for your connection.

Procedure

  1. On the Configure the IoT Service page, specify information for linking to your instance of Watson IoT Platform. Most of the fields are already populated with the required information, but you must provide some details for your connection.
    1. In the URL field, ensure that you specify the appropriate values for your connection, as shown in the following example. 
      https://ctx:iotforg.internetofthings.ibmcloud.com/api/v0002/

      Replace ctx:iotforg with your orgid.

  2. Click Test connection.
  3. Specify connection information for your Cloudant® NoSQL DB historian.
    • In the Cloudant Bucket Interval field, specify the interval of time that you selected when you created your Cloudant NoSQL DB account, such as DAY, WEEK, or MONTH.
    • In the Database Name field, specify the database that you selected when you set up the Cloudant NoSQL DB account.
  4. Click Test connection.
  5. Click Next.

Configuring Endpoint Properties

About this task

The next step is to configure the endpoint properties for requesting data from your IoT platform.

Procedure

The Configure End Point Properties page displays information about the endpoints for gathering your data. In most cases, you do not have to enter or modify the content that is displayed in the fields. Review the information for the endpoints to ensure their accuracy and click Next.

Registering Device Types

About this task

After you configure endpoints, you can register the device types for your platform.

Procedure

The Register Device Types page lists the device types that are not registered as assets or location. To register a device type, select one or more device types, click Register as asset or Register as location, and click Next.

Mapping Data Schemas

About this task

The Map Data Schemas page lists all device types that are registered with the Maximo product. The next step is to map device types to asset or location meters.

Procedure

  1. On the Map Data Schemas page, select the device type that you want to map to a meter and click the edit icon.
  2. On the Schema tab, select the option to enter a device type or retrieve a sample device message for the selected device type.
    Option Description
    Enter manually Choose this option to enter a device type manually. You must supply the JSON message for the device type that is selected in the Watson IoT Platform, in the exact format that is used in the platform.
    Detect from a connected device Choose this option to retrieve a sample JSON message that has device type properties from Watson IoT Platform.
  3. If you chose to detect the properties from a connected device, complete the following steps.
    1. Specify whether to enter a specific device ID or to retrieve device type properties from the first available sample message that is returned for the device type.
      Table 1. How to retrieve properties
      Field Description
      From first available Choose this option to select the device type properties from the first sample message that is returned for the device type.
      From device ID Choose this option to enter a specific device ID.
    2. Optional: If you chose to specify a device ID, enter the ID.
    3. Click Get now.
  4. Save your changes.
  5. Select the Device Type Mappings tab.
  6. Click Add mapping.
  7. Click Select meter.
  8. In the Select Meter window, select the appropriate meter and click Done.
  9. In the IoT Device Type Property field, select the property that you want to map to the meter.
  10. In the Data Collection section, select whether to collect all readings or aggregated data.
    Table 2. How to collect data
    Field Description
    Aggregated Choose this option to collect aggregated data.
    All readings Choose this option to collect all readings.
  11. Optional: If you selected Aggregated, complete the following steps:
    1. To specify how to collect aggregated data, in the Value field, select the type of aggregation that you want for the collection.
    2. In the Time Period field, specify the reporting period for the aggregated data.
  12. In the Data Synchronization section, complete the following steps to configure the cron task that schedules data synchronization:
    1. In the Cron Task Instance Name field, select an existing cron task instance for data synchronization or add a new cron task instance.
    2. Optional: If you add a new cron task instance, in the Cron Task Instance Name field, enter a name.
    3. Optional: If you add a new cron task, in the Schedule field select the schedule for running the cron task.
    4. Click Cron Task Instance Active to activate the cron task.
  13. Click Done.

What to do next

After you map device types to asset or location meters, associate the devices with specific assets or locations.