Using OPC-UA node filters - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Using OPC-UA node filters

When you define OPC-UA data sources for an Amazon IoT SiteWise gateway, you can define node filters. Node filters let you limit which data stream paths the gateway sends to the cloud. You can use node filters to reduce your gateway's startup time and CPU usage by only including paths to data that you model in Amazon IoT SiteWise. By default, gateways upload all OPC-UA paths except those that start with /Server/. You can use the * and ** wildcard characters in your node filters to include multiple data stream paths with one filter. To learn how to set up OPC-UA sources for your gateway, see Configuring data sources.

Note

Amazon IoT SiteWise restarts your gateway each time you add or edit a source. Your gateway won't ingest data while it's restarting. The time to restart your gateway depends on the number of tags on your gateway's sources. Restart time can range from a few seconds (for a gateway with few tags) to several minutes (for a gateway with many tags).

The following table lists the wildcards that you can use to filter OPC-UA data sources.

OPC-UA node filter wildcards
Wildcard Description
* Matches a single level in a data stream path.
** Matches multiple levels in a data stream path.
Note

If you configure a source with a broad filter and then later change the source to use a more restrictive filter, Amazon IoT SiteWise stops storing data that doesn't match the new filter.

Example scenario using node filters

Consider the following hypothetical data streams:

  • /WA/Factory 1/Line 1/PLC1

  • /WA/Factory 1/Line 1/PLC2

  • /WA/Factory 1/Line 2/Counter1

  • /WA/Factory 1/Line 2/PLC1

  • /OR/Factory 1/Line 1/PLC1

  • /OR/Factory 1/Line 2/Counter2

Using the previous data streams, you can define node filters to limit what data to include from your OPC-UA source.

  1. To select all nodes in this example, use /WA/.

  2. To select all PLC data streams, use /*/*/*/PLC* or /**/PLC*. You can include multiple directories or folders with the ** wildcard characters.

  3. To select all counters in this example, use /WA/**/Counter*.

  4. To select all counters from Line 2, use /**/Line 2/Counter*.