# Host a SiteWise Edge gateway on Siemens Industrial Edge Host a 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?](https://docs.eu1.edge.siemens.cloud/) in the Siemens documentation. **Note** Siemens is not a vendor or supplier for SiteWise Edge. The Siemens Industrial Edge Marketplace is an independent marketplace. **Topics** + [ ## Security ](#sa-security) + [ ## Siemens Secure Storage and the Amazon IoT SiteWise Edge application ](#sa-secure-storage) + [ ## Destinations for Siemens Industrial Edge devices ](#siemens-destinations) + [ ## Migrate from the preview application ](#sa-migrate) + [ ## Troubleshooting ](#sa-troubleshoot) + [ ## Amazon IoT SiteWise Edge application changelog ](#sa-changelog) + [ # Requirements for the Amazon IoT SiteWise Edge application ](siemens-app-gateway-requirements.md) + [ # Create a gateway for Siemens Industrial Edge ](sa-create-config.md) + [ # Create a Siemens Databus user for the application ](sa-databus-user.md) + [ # Access the Amazon IoT SiteWise Edge application ](sa-get-app.md) + [ # Install the application onto a Siemens device ](sa-install-app.md) + [ # Update the Amazon IoT SiteWise Edge application configuration ](sa-update-config.md) + [ # Amazon IoT SiteWise – Data generated by the use of this service ](sa-data-legal.md) ## Security As part of the [Shared Responsibility Model](https://www.amazonaws.cn/compliance/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](destinations-buffered.md) and [Add an Amazon IoT SiteWise Edge real-time destination](destinations-real-time.md). ### 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: + [Understand Amazon IoT SiteWise Edge destinations](gw-destinations.md#source-destination) + [Add an Amazon IoT SiteWise Edge real-time destination](destinations-real-time.md) + [Add an Amazon IoT SiteWise buffered destination using Amazon S3](destinations-buffered.md) + [Understand path filters for Amazon IoT SiteWise Edge destinationsUnderstand path filters](gw-destinations.md#destinations-path-filters) + [Add path filters to Amazon IoT SiteWise Edge destinations](destinations-add-path-filters.md) + [Manage Amazon IoT SiteWise Edge destinations](destinations-manage.md) ## 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](sa-create-config.md). 1. Create a new Siemens Databus user for each new gateway. For more information, see [Create a Siemens Databus user for the application](sa-databus-user.md). 1. 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. 1. Delete the SiteWise Edge gateways you created during the preview in the [Amazon IoT SiteWise console](https://console.amazonaws.cn/iotsitewise/home?region=us-east-1#/gateway). 1. 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](sa-install-app.md). **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 the current version. 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](troubleshooting-gateway.md#troubleshoot-siemens-app). You can also access [Amazon re:Post](https://repost.aws) 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.1 | Bug fixes and improvements [\[See the AWS documentation website for more details\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | | 3.0.0 | New features [\[See the AWS documentation website for more details\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) Bug fixes and improvements [\[See the AWS documentation website for more details\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | | 2.0.1 | Bug fixes and improvements [\[See the AWS documentation website for more details\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | | 2.0.0 | [\[See the AWS documentation website for more details\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | | 1.0.1 | Initial release | # Requirements for the Amazon IoT SiteWise Edge application Requirements To run Amazon IoT SiteWise Edge on Siemens Industrial Edge, you need the following: + A [Siemens Digital Exchange Platform](https://www.dex.siemens.com/) account. + A Siemens Industrial Edge Hub (iehub) account. + A Siemens Industrial Edge Management instance. + The IE App Configuration Service. To learn more, see [https://docs.eu1.edge.siemens.cloud/get_started_and_operate/industrial_edge_management/how_to_setup_operate/vm/operation/app_projects/app_configurations/ie_application_configuration_service/installing_the_ie_acs_manually.html](https://docs.eu1.edge.siemens.cloud/get_started_and_operate/industrial_edge_management/how_to_setup_operate/vm/operation/app_projects/app_configurations/ie_application_configuration_service/installing_the_ie_acs_manually.html) in the *Siemens Industrial Edge Management* documentation. + Access to version 2.0.1 or higher of the Amazon IoT SiteWise Edge application. For more information, see [Access the Amazon IoT SiteWise Edge application](sa-get-app.md). + Either a Siemens Industrial Edge Device (IED) or a Siemens Industrial Edge virtual Device (IEVD). + A minimum of 15 GB disk space for hardware requirements. + 1 GB of RAM with an additional 1 GB of swap memory. + Device configuration to allow outbound traffic on ports 443 and 8883. + A x86-64 bit processor. + Siemens Industrial Edge Management version 1.13.10 or higher. + Device conformance to Siemens Secure Storage requirements. + On virtual devices, IEVD version 1.19 or above. + On physical devices, IED-OS version 2.2 or above. + The latest version of Docker Compose. + Docker Engine version 18.091 or higher. + Required domain access. For more information, see [Amazon IoT SiteWise endpoints](endpoints-and-quotas.md#endpoints). # Create a gateway for Siemens Industrial Edge Create a gateway After you have the proper Siemens accounts and IEM instances, you can create a SiteWise Edge gateway of deployment type **Siemens Industrial Edge device**. **Note** Ensure that you meet all requirements for running a device on Siemens Industrial Edge Management. For more information, see [Requirements for the Amazon IoT SiteWise Edge application](siemens-app-gateway-requirements.md). **To create the configuration file** 1. Navigate to the [Amazon IoT SiteWise console](https://console.amazonaws.cn/iotsitewise/). 1. In the navigation pane, choose **Edge gateways**. 1. Choose **Create gateway**. 1. For **Deployment type**, choose **Siemens Industrial Edge device**. 1. Enter a name for your SiteWise Edge gateway or use the name generated by Amazon IoT SiteWise. 1. (Optional) Under **advanced configuration**, do the following: 1. Enter a name for your Amazon IoT Core Thing or use the name generated by Amazon IoT SiteWise. 1. Choose **Create gateway**. 1. In the **Generate SiteWise Edge gateway configuration file** dialog box, choose **Generate and download**. Amazon IoT SiteWise automatically generates a configuration file that you will use to configure the Amazon IoT SiteWise Edge application. **Important** Keep your gateway configuration file as a backup in the event that you need to restore your Amazon IoT SiteWise Edge application instance. You can securely save your SiteWise Edge gateway configuration file in [Amazon Secrets Manager](https://docs.amazonaws.cn/secretsmanager/latest/userguide/intro.html) for this purpose. Secrets Manager securely stores, manages, and retrieves sensitive information. If you misplace or delete this configuration file, you won't be able to reconnect your Amazon IoT SiteWise Edge application instance to its original gateway if you need to recover it. You'll need to create both a new gateway and a new configuration file. # Create a Siemens Databus user for the application Create a Siemens Databus user Amazon IoT SiteWise Edge on Siemens Industrial Edge ingests data from the Siemens Databus application. To connect SiteWise Edge to the Siemens Databus, you need a Siemens Databus user that provides access to the data you want to securely transfer to Amazon IoT SiteWise. To start, create a Siemens Databus user and then provide the credentials to the SiteWise Edge application. **To create a Siemens Databus user** 1. In your Siemens Industrial Edge Management instance, choose **Edge Management** in the **Platform Applications** section. 1. Choose the **Data connections** icon. 1. Select **Databus**. A list of your connected devices appears. 1. Select the device to connect to the Amazon IoT SiteWise Edge application. 1. Choose **Launch**. The Databus Configurator for your selected device appears. 1. Create a user for your Edge device under **Users**. For more information on creating a user, see [Users](https://docs.eu1.edge.siemens.cloud/get_started_and_operate/industrial_edge_management/operation/iam/03_user-management.html) in the *Siemens Industrial Edge Management* documentation. 1. Select the topics for which this Siemens Databus should have access. These topics restrict what Amazon IoT SiteWise Edge can access. **Important** All topics that a Siemens Databus user has access to are published to Amazon IoT SiteWise. **Note** Siemens Databus users need access to both data and metadata topics. Topics that start with `ie/d` are data topics. And topics that start with `ie/m` are metadata topics. Share topics in pairs so that SiteWise Edge has access to both data and metadata for each respective topic. ![\[A screenshot displaying the Siemens topic types. The image circles the portion of the file path that starts with "ie/d" and "ie/m," respectively.\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/images/gateway-sa-topics.png) 1. Set appropriate permissions for your Siemens Databus configuration. After creating your Siemens Databus configuration, you can install the Amazon IoT SiteWise Edge application on your Siemens Industrial Edge Management. For more information, see [Install the application onto a Siemens device](sa-install-app.md). You can also optionally configure destinations and path filters for your Siemens Industrial Edge gateway. For more information, see [Destinations and path filters](gw-destinations.md). # Access the Amazon IoT SiteWise Edge application Access the application To gain access to the Amazon IoT SiteWise Edge application on Siemens Industrial Edge, [send an email](mailto:aws-iot-swe-siemens-app-support@amazon.com?subject=Access request for SiteWise Edge on Siemens Industrial Edge) requesting access to the SiteWise Edge support team. Include the following information in your email: + Your name and contact information + Company name + Siemens Industrial Edge tenant ID # Install the application onto a Siemens device Install the application After you gain access to the Amazon IoT SiteWise Edge application by emailing the SiteWise Edge support team for Siemens Industrial Edge, assign the application to an instance of Siemens Industrial Edge Management. Then, you can install the Amazon IoT SiteWise Edge application on your device. **To install the Amazon IoT SiteWise Edge application** 1. Verify that the Docker digest provided within Siemens Industrial Edge Management matches the latest version listed in the [Amazon IoT SiteWise Edge application changelog](sitewise-edge-on-siemens.md#sa-changelog). For more information on locating the Docker digest value for Siemens, see the [Managing an app](https://docs.eu1.edge.siemens.cloud/get_started_and_operate/industrial_edge_device/operation/management.html#managing-an-app) in the *Siemens Industrial Edge Device* of the Siemens documentation. Siemens Industrial Edge Management supports one version of the Amazon IoT SiteWise Edge application at a time. Take this step to ensure that you're using the latest version of the application before installing the Amazon IoT SiteWise Edge application on your Siemens Industrial Edge device. 1. Assign the **Amazon IoT SiteWise Edge** application to Siemens Industrial Edge Management. For more information, see [Managing an app](https://docs.eu1.edge.siemens.cloud/get_started_and_operate/industrial_edge_management/how_to_setup_operate/vm/operation/my_installed_apps/managing_an_app.html) in the *Industrial Edge Management* section of the Siemens documentation. 1. Within **Edge Management**, browse the catalog for the **Amazon IoT SiteWise Edge** and choose it. 1. Choose **Install**. **Note** If a **Contact Us** button displays, choose it, and follow the steps to request access to the Amazon IoT SiteWise Edge application on Siemens Industrial Edge. For more information, see [Access the Amazon IoT SiteWise Edge application](sa-get-app.md). 1. Select **Databus\$1Configuration** in the Schema Configurations options. 1. Enter the **Username** and **Password** for the Databus configuration. For more information on creating a Siemens Databus user, see [Create a Siemens Databus user for the application](sa-databus-user.md). 1. Choose the small, round gray checkmark icon next to **Databus\$1Configuration** to turn the icon color green. **Note** The input configurations only apply if the checkmark icon changes from gray to green. Otherwise, the input configuration is ignored. ![\[A screenshot of the Siemens Databus Configurator screen displaying an unfinished process, with a circled gray checkmark icon.\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/images/gateway-sa-gray-checkmark.png) ![\[A screenshot of the Siemens Databus Configurator screen displaying a finished process, with a circled green checkmark icon.\]](http://docs.amazonaws.cn/en_us/iot-sitewise/latest/userguide/images/gateway-sa-green-checkmark.png) 1. Choose **Next** to move onto **Other Configurations** where you can upload your gateway configuration file. 1. Choose **SiteWise\$1Edge\$1Gateway\$1Config** as the location to upload the gateway configuration file. **Note** Ensure that you choose **SiteWise\$1Edge\$1Gateway\$1Config** rather than **SiteWise\$1Edge\$1Support\$1Config\$1Optional**. 1. Select the device to install the application. 1. Choose **Install now**. You can optionally configure the publisher component to export data to the Amazon Cloud. For more information, see [configure the Amazon IoT SiteWise publisher component](configure-publisher-component.md). To configure destinations for your Siemens Industrial Edge gateway, see [Destinations and path filters](gw-destinations.md). # Update the Amazon IoT SiteWise Edge application configuration Update an installed application configuration There are a few things to consider when updating an Amazon IoT SiteWise Edge application configuration on **Siemens Industrial Edge**. **Note** Any change to the Amazon IoT SiteWise Edge application configuration requires a restart of the application. **Reasons to restart the Amazon IoT SiteWise Edge application** + A new Siemens Databus user for the Amazon IoT SiteWise Edge application. + A change to the gateway configuration file (your **SiteWise\$1Edge\$1Gateway\$1Config** file). + A proxy configuration update (which also requires a full IEVD reboot) + To enable debug logs for debugging issues ## Restarting the application 1. In your Siemens Industrial Edge Management instance, choose **Edge Management** in the **Platform Applications** section. 1. Choose **My Installed Apps**. 1. Select the Amazon IoT SiteWise Edge application. 1. Choose **Restart**. # Amazon IoT SiteWise – Data generated by the use of this service Data generated by the use of this service Amazon IoT SiteWise on Siemens Industrial Edge extends cloud capabilities to industrial edge environments, enabling local data processing, analysis, and decision-making. SiteWise Edge integrates with Amazon IoT SiteWise and other Amazon services to provide comprehensive industrial Amazon IoT solutions. Types of Data SiteWise Edge application on Siemens Industrial Edge generates data about application performance, usage, and interactions with other Amazon services, specifically Amazon S3. Data Volume and Collection The amount of data generated varies based on how you use your application and services. Data Storage Data from your application is stored securely on Amazon servers. It is stored in machine-readable formats. Data Access You can access your data through your Amazon account. You can download a copy of your data following instructions listed in this user guide [SiteWise Edge on Siemens](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html). For configuration data for the application, you can follow the instructions in this user guide [Query Industrial Data](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/query-industrial-data.html). Further instructions for bulk data access and export, is available on [Running Bulk Operations Export](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/running-bulk-operations-export.html). Data Management To learn more about your applications' data practices, please review our [Service Terms](https://aws.amazon.com/service-terms/), [Privacy Notice](https://aws.amazon.com/privacy/), and [Service documentation](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/what-is-sitewise.html) which includes materials on how to manage your data. Data Deletion For information about data retention and deletion options, visit these pages in the user guide – [manage data storage](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/manage-data-storage.html), [delete data streams](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/delete-data-streams-method.html) and [delete models and assets](https://docs.amazonaws.cn/iot-sitewise/latest/userguide/delete-assets-and-models.html). Data sharing with others You can authorize third parties to access your Amazon resources via our [Identify and Access Management](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html) processes. Amazon shares personal data with third parties in limited cases included in the [Amazon Privacy Notice](https://aws.amazon.com/privacy/). Need Help? Visit [Customer Support](https://aws.amazon.com/contact-us/) to reach our support team. This is without prejudice to your right to lodge a complaint under applicable law. Data Holder Amazon Web Services EMEA SARL, 38 Avenue John F. Kennedy, L-1855, Luxembourg