

# Host a SiteWise Edge gateway on Siemens Industrial Edge
<a name="sitewise-edge-on-siemens"></a>

Host your gateway on Siemens Industrial Edge using the AWS IoT SiteWise Edge application. Just as with AWS 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 AWS account by running a SiteWise Edge gateway on the device. To do this, request access to the AWS 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 AWS 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)
+ [AWS IoT SiteWise Edge application changelog](#sa-changelog)
+ [Requirements for the AWS 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 AWS IoT SiteWise Edge application](sa-get-app.md)
+ [Install the application onto a Siemens device](sa-install-app.md)
+ [Update the AWS IoT SiteWise Edge application configuration](sa-update-config.md)
+ [AWS IoT SiteWise – Data generated by the use of this service](sa-data-legal.md)

## Security
<a name="sa-security"></a>

As part of the [Shared Responsibility Model](https://aws.amazon.com/compliance/shared-responsibility-model/) between AWS, 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.

**AWS responsibility**  
+ Isolating the partner from the customer AWS 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 AWS IoT SiteWise Edge application
<a name="sa-secure-storage"></a>

To protect credentials and secrets required to run the AWS IoT SiteWise Edge application, Siemens Industrial Edge provides mechanisms to securely store the credentials on the device. The AWS 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 AWS 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 AWS IoT SiteWise Edge application on Siemens Industrial Edge will not run until you have upgraded your device.

## Destinations for Siemens Industrial Edge devices
<a name="siemens-destinations"></a>

When using the AWS IoT SiteWise Edge application on Siemens Industrial Edge, destinations help prepare data before sending it to AWS 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:
+ **AWS IoT SiteWise real-time settings** - Data is sent directly to AWS IoT SiteWise as it's collected
+ **AWS 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 AWS IoT SiteWise buffered destination using Amazon S3](destinations-buffered.md) and [Add an AWS IoT SiteWise Edge real-time destination](destinations-real-time.md).

### Prefixes for path filters
<a name="siemens-path-filters"></a>

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
<a name="create-destination-summary"></a>

View the following topics to learn more about destinations and path filters in MQTT-enabled gateways:
+ [Understand AWS IoT SiteWise Edge destinations](gw-destinations.md#source-destination)
+ [Add an AWS IoT SiteWise Edge real-time destination](destinations-real-time.md)
+ [Add an AWS IoT SiteWise buffered destination using Amazon S3](destinations-buffered.md)
+ [Understand path filters for AWS IoT SiteWise Edge destinationsUnderstand path filters](gw-destinations.md#destinations-path-filters)
+ [Add path filters to AWS IoT SiteWise Edge destinations](destinations-add-path-filters.md)
+ [Manage AWS IoT SiteWise Edge destinations](destinations-manage.md)

## Migrate from the preview application
<a name="sa-migrate"></a>

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 AWS IoT SiteWise Edge gateway application on your IED. 
**Note**  
Prepare for interruptions to data flow as you reconfigure the AWS IoT SiteWise assets previously used by the preview version of the AWS 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 [AWS IoT SiteWise console](https://console.aws.amazon.com/iotsitewise/home?region=us-east-1#/gateway). 

1. Install the AWS 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
<a name="sa-troubleshoot"></a>

To troubleshoot the SiteWise Edge gateway on your Siemens Industrial Edge device, see [Troubleshooting the AWS IoT SiteWise Edge application on Siemens Industrial Edge](troubleshooting-gateway.md#troubleshoot-siemens-app).

You can also access [AWS re:Post](https://repost.aws) to find answers to your questions.

## AWS IoT SiteWise Edge application changelog
<a name="sa-changelog"></a>

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


|  **Version**  |  **Changes**  | 
| --- | --- | 
| 3.0.1 | Bug fixes and improvements[See the AWS documentation website for more details](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | 
| 3.0.0 | New features[See the AWS documentation website for more details](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html)<br />Bug fixes and improvements[See the AWS documentation website for more details](http://docs.aws.amazon.com/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.aws.amazon.com/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html) | 
| 2.0.0 |  [See the AWS documentation website for more details](http://docs.aws.amazon.com/iot-sitewise/latest/userguide/sitewise-edge-on-siemens.html)  | 
| 1.0.1 | Initial release | 