Skip to content

AWS SiteWise Exporter Component

The AWS SiteWise Exporter component subscribes to a Bus and exports data, which matches a subscription pattern, using REST to AWS SiteWise using the BatchPutAssetPropertyValue action

These requests to SiteWise are authenticated using signature headers which are generated based on AWS secret keys. For further information on the generated signature, refer to the AWS Reference guide.

To map data to the correct Assets and Asset Properties in AWS SiteWise, the Exporter component uses Property Aliases. Every reading sent by the Exporter component is identified by a Property Alias in the following format:

AliasStem/DeviceName/ResourceName

The following table describes the Property Alias fields:

Field Description
AliasStem Part of the exporter configuration

For further information, see the AliasStem parameter in AWS SiteWise Exporter Configuration Variables below
DeviceName Used to identify the reading in XRT

Identifies the device for the reading

The convention if using Raw format data is to assume that the device name is the trailing element of the topic name
ResourceName Used to identify the reading in XRT

Identifies the device resource for the reading

Property Aliases must be set accordingly on the Asset Properties in AWS SiteWise. The exporter may be configured (using the ProfileDirs and StateDirs elements) to automatically create Asset Models and Assets within SiteWise to correspond to the profiles and devices in XRT. When Assets are created this way, appropriate Property Aliases are also set.

For further information on the data model and terminology, refer to the AWS API Reference documentation.

AWS SiteWise Exporter Configuration Variables

The following table describes the AWS SiteWise exporter configuration variables:

> >
Parameter Type Description Valid Values Required
Bus String The name of the Bus component to use The name of an existing Bus component Y
Logger String The name of the Logger component to use The name of an existing Logger component N
QueueSize Unsigned Integer The size of the queue for the subscriber to hold messages Default: 4 N
Pattern String The pattern to match on the Bus component for subscription Default: # N
AliasStem String The property identifier The unique identifier of an asset property N
AccessKey String The access key for an Identity and Access Management (IAM) user The key generated for an IAM user Y
SecretAccessKey String Used only with AccessKey

The secret access key for an IAM user
The secret key generated for an IAM user Y
Region String The AWS region Valid values include:
  • eu-central-1
  • us-east-1
  • us-west-2
For a full list of regions supporting SiteWise see AWS IoT SiteWise endpoints.
Y
ProfileDirsArray of Strings Directories from which to load profiles. If an AssetModel does not exist for a profile, one will be created. example:
[
  "config/modbus/profiles",
  "config/opcua/profiles"
]
N
StateDirsArray of Strings Directories from which to load devices. If an Asset does not exist for a device, one will be created. example:
[
  "config/bacnet/state"
]
N
Back to top