Host a SiteWise Edge gateway on Siemens Industrial Edge - 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 (PDF).

Host a SiteWise Edge gateway on Siemens Industrial Edge

Host your gateway on Siemens Industrial Edge using the Amazon IoT SiteWise Edge application. Just as with Amazon IoT Greengrass V2, you can optimize manufacturing processes or improve operational workflows using the SiteWise Edge on Siemens Industrial Edge.

You can ingest data from your Siemens Industrial Edge device to your Amazon account by running a SiteWise Edge gateway on the device. To do this, request access to the Amazon IoT SiteWise Edge application from the SiteWise Edge support team. Then, create a SiteWise Edge gateway resource with a deployment target of Siemens Industrial Edge device - new. Next, download the configuration file, and upload it to your application through the Siemens Industrial Edge Management portal. For more information about running applications on Siemens Industrial Edge, including how to set up the required Siemens resources, see What is Industrial Edge? in the Siemens documentation.

Note

Siemens is not a vendor or supplier for SiteWise Edge. The Siemens Industrial Edge Marketplace is an independent marketplace.

Security

As part of the Shared Responsibility Model between Amazon, our customers, and our partners the following describes who is responsible for the different aspects of security:

Customer responsibility
  • Vetting the partner.

  • Configuring the network access given to the partner.

  • Physically securing the device running SiteWise Edge.

Amazon responsibility
  • Isolating the partner from the customer Amazon Cloud resources.

Partner responsibility
  • Using secure defaults.

  • Keeping the solution secure over time through patches and other appropriate updates.

  • Keeping customer data confidential.

  • Vetting other applications available in the partner marketplace.

Siemens Secure Storage and the Amazon IoT SiteWise Edge application

To protect credentials and secrets required to run the Amazon IoT SiteWise Edge application, Siemens Industrial Edge provides mechanisms to securely store the credentials on the device. The Amazon IoT SiteWise Edge application won't run on a device if it doesn't have support for securely storing these credentials. Run failures caused by missing Secure Storage support are logged in log files.

The following minimum OS versions are required to install and run the Amazon IoT SiteWise Edge application. Upgrade your devices to the latest versions to install the application.

  • For virtual devices: IEVD version 1.19 or above

  • For physical devices: IED-OS version 2.2 or above

The Amazon IoT SiteWise Edge application on Siemens Industrial Edge will not run until you have upgraded your device.

Destinations for Siemens Industrial Edge devices

When using the Amazon IoT SiteWise Edge application on Siemens Industrial Edge, destinations help prepare data before sending it to Amazon IoT SiteWise for further analysis and distribution. You can configure data destination settings for buffered data ingestion using Amazon S3 or use real-time data ingestion. Both allow you to subscribe to MQTT topics using path filters on the Siemens Industrial Edge device deployment target.

The Siemens Industrial Edge deployment target on your gateway supports two primary data handling methods:

  • Amazon IoT SiteWise real-time settings - Data is sent directly to Amazon IoT SiteWise as it's collected

  • Amazon IoT SiteWise buffered using Amazon S3 settings - Data is collected and stored temporarily in batches before being sent to Amazon S3

For more information about configuring these options, see Add an Amazon IoT SiteWise buffered destination using Amazon S3 and Add an Amazon IoT SiteWise Edge real-time destination.

Prefixes for path filters

Path filters for gateways using Siemens Industrial Edge deployment targets combine both the topic and data stream name to create a unique identifier for your data. The combined topic with data stream name is called a prefix in Siemens Industrial Edge gateways. This differs from self-hosted gateways where path filters are based solely on MQTT topics.

Example Path filter structure for Siemens data streams

A typical path filter for a Siemens data stream includes both the topic path and the data stream name:

ie/d/device1/application1/datastream1

Where:

  • ie/d/ is the required prefix for Siemens data streams

  • device1/application1 represents the hierarchical path

  • datastream1 is the specific data stream name

Note

When working with Siemens Industrial Edge data streams, ensure that you include both the metadata (ie/m/) and data (ie/d/) topics in your path filters to receive complete information about your data streams.

Destinations and path filters

View the following topics to learn more about destinations and path filters in MQTT-enabled gateways:

Migrate from the preview application

If you ran SiteWise Edge on Siemens Industrial Edge during the preview phase, you'll need to upgrade from the preview version, version 1.0.1, to the latest version. Do the following to migrate:

  1. Create new SiteWise Edge gateways. For more information, see Create a gateway for Siemens Industrial Edge.

  2. Create a new Siemens Databus user for each new gateway. For more information, see Create a Siemens Databus user for the application.

  3. Uninstall the version 1.0.1 Amazon IoT SiteWise Edge gateway application on your IED.

    Note

    Prepare for interruptions to data flow as you reconfigure the Amazon IoT SiteWise assets previously used by the preview version of the Amazon IoT SiteWise Edge application. While the data history is preserved, there is potential for data loss while you reinstall the new gateway.

  4. Delete the SiteWise Edge gateways you created during the preview in the Amazon IoT SiteWise console.

  5. Install the Amazon IoT SiteWise Edge gateway application on IED using the new gateway configuration file. For more information, see Install the application onto a Siemens device.

    Important

    Installing the new gateway overwrites the preview version of the SiteWise Edge application. It isn't possible to go back to version 1.0.1 after installing version 2.0.0.

After configuring the new gateway and Siemens Databus user, your data flows to your properties.

You can also upgrade your SiteWise Edge application from version directly. However, a new gateway configuration is still necessary.

Troubleshooting

To troubleshoot the SiteWise Edge gateway on your Siemens Industrial Edge device, see Troubleshooting the Amazon IoT SiteWise Edge application on Siemens Industrial Edge.

You can also access Amazon re:Post to find answers to your questions.

Amazon IoT SiteWise Edge application changelog

The following table describes the changes in each version of the Amazon IoT SiteWise Edge application.

Version

Changes

3.0.0

New features

  • Adds additional configuration options in the Amazon IoT SiteWise console for gateways installed on Siemens Industrial Edge:

    • Add and configure Amazon S3 destinations.

    • Remove the Amazon IoT SiteWise real-time destination.

    • Add filters for each destination to control data routing.

  • Adds the option for a global prefix configuration to send all data from the IoT SiteWise publisher in the Siemens IE installer. The prefix is applied after filtering.

Bug fixes and improvements

  • Adds the ability to retry connections to the Siemens Industrial Edge Databus if Amazon IoT SiteWise Edge application’s initial attempt fails.

2.0.1

Bug fixes and improvements

  • Fixes an issue where the app would enter failure state and quit if it was unable to retrieve Amazon credentials on startup. Adds support to retry until successful credential retrieval.

2.0.0

  • The Amazon IoT SiteWise Edge application is now generally available.

  • Application requires Siemens IEVD version 1.19, or Siemens IED-OS version 2.2.

  • Performance improvements: Reduced memory and CPU usage.

  • Debugging improvements: You can now upload an optional config file to enable debug logs.

  • Security enhancements: The application uses SecureStorage API to securely store credentials on the device.

  • Docker digest value: sha256:4a960f29234a190ebb5224c1fd0f3e99faafccc4cb3d93ca13fef247b6656d18

1.0.1

Initial release