Read a Message from an IoT Device

To read a device-to-cloud message from a device that is registered in Microsoft Azure IoT, do the procedure in this topic.

Figure: Read Message from Device Configuration screen

Read Message from Device Configuration screen

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library open the Microsoft Azure IoT Microsoft Azure IoT icon tab.
      2. On the Microsoft Azure IoT Microsoft Azure IoT icon tab, drag the Read Message From Device Read Message From Device icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click Read Message From Device Configuration Read Message From Device Configuration icon.

Procedure

  1. On the Read Message from Device screen, in the Microsoft Azure IoT field, select your Microsoft Azure IoT access token.

    To create a new access token, click Access Token for Microsoft Azure IoT.

  2. Complete these fields as necessary.
    Field Name Definition

    Device ID
    Function:
    Specifies the device ID for your IoT device.
    Accepted Values:
    A valid device ID.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
    Limitations:

    Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

    Device Key
    Function:
    Specifies a device key from Microsoft Azure IoT.
    Accepted Values:
    A valid device key from Microsoft Azure IoT.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
    Limitations:

    Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

    Retry Count
    Function:
    Specifies the number of times Microsoft Azure IoT tries to read messages from the IoT devices.
    Accepted Values:
    A positive integer.
    Default Value:
    60
    Accepts Process Data Variables:
    Yes

    Delay Between Retry (milliseconds)
    Function:
    Specifies a time interval in milliseconds between each retry.
    Accepted Values:
    A positive integer.
    Default Value:
    1000
    Accepts Process Data Variables:
    Yes

    Payload
    Function:
    Specifies the payload to store at runtime.
    Accepted Values:
    • Save Response to This Variable - Specifies a process data variable to store the JSON payload at runtime.
    • Map Payload to Process Schema - Connects the values in your payload with your AgilePoint schema.

      Click Map to Schema button to open the Schema Mapper. Use this screen to connect the response to process schema.

    Default Value:
    None
    Accepts Process Data Variables:
    Yes
    Limitations:

    Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

    Sample Payload JSON
    Function:
    Specifies a JSON code snippet that connects your payload to the schema.
    To Open this Field:
    1. On the Read Message from Device Configuration screen, click Map Response to Process Schema.
    Accepted Values:
    A JSON code snippet.
    Default Value:
    None
    Accepts Process Data Variables:
    No

    Map Schema Map Schema icon
    Opens this Screen:
    Schema Mapper
    To Open this Field:
    1. On the Read Message from Device Configuration screen, click Map Response to Process Schema.
    Function of this Screen:
    Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema..
    Limitations:

    Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?