Get Device Information activity

An activity that gets the information of a device that is registered in Microsoft Azure IoT.

Configure the Get Device Information activity

To configure the Get Device Information activity, do the procedure in this topic.

Examples

Internet of Things (IoT) Example: Fire Alarm Management Application

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, in the Activity Library open the Microsoft Azure IoT tab.
  2. On the Microsoft Azure IoT tab, drag the Get Device Information activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Get Device Information activity.

Fields

Field Name	Definition
Display Name	Function: Specifies the activity name that shows in your process. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Function: Specifies an optional text description for your activity. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No

Field Name

Definition

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data Variables:

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:: Specifies an optional text description for your activity.
Accepted Values:: More than one line of text.
Default Value:: None
Accepts Process Data Variables:: No

Get Device Information

Specifies the device whose information to get.

Fields

Field Name	Definition
Microsoft Azure IoT	Function: Specifies the access token that connects to your Microsoft Azure IoT service. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No
Add Token	Opens this Screen: Access Token for Microsoft Azure IoT Function of this Screen: Configure an access token to connect to Microsoft Azure IoT.
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?
Connection State	Function: Specifies the process data variable that stores the device's connection state. Accepted Values: A process data variable with the string data type. These are the values that can come from Microsoft Azure IoT: Connected - The device is connected to Microsoft Azure IoT. Disconnected - The device is not connected to Microsoft Azure IoT. Default Value: None Accepts Process Data Variables: Yes
Connection State Updated Time	Function: Specifies the process data variable that stores the date and time when the Connection State was last checked. Accepted Values: A process data variable. 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?
Etag	Function: Specifies the process data variable that stores an Etag that identifies the device. Accepted Values: A process data variable. 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?
Generation ID	Function: Specifies the process data variable that stores the generation ID for your IoT device. Accepted Values: A process data variable. 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?
Status	Function: Specifies the process data variable that stores the device's current status. Accepted Values: A process data variable with the string data type. These are the values that can come from Microsoft Azure IoT: Enabled - The device can connect. Disabled - The device can not send or receive messages. Default Value: None Accepts Process Data Variables: Yes
Status Reason	Function: Specifies the process data variable that stores the reason the device is in specified status. Accepted Values: A process data variable. 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?
Status Updated Time	Function: Specifies the process data variable that stores the date and time the Status was last checked. Accepted Values: A process data variable. 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?
Cloud To Device Message Count	Function: Specifies the process data variable that stores the number of cloud-to-device messages that are in queue to send to the device. Accepted Values: A process data variable. 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?