Configuring a Gateway Integration Endpoint - Amazon S3 Blob Storage

A gateway integration endpoint (GIEP) allows STEP to communicate with an external storage system. Once a GIEP has been created and Amazon S3 Blob Storage is selected, the configuration settings allow you to identify the location of the required data.

Prerequisites

To use the Gateway Integration Endpoint Configuration dialog for Amazon S3 Blob Storage, the following case sensitive properties must be set up first in the sharedconfig.properties file on the STEP application server.

Note: Sensitive configuration values that should be filtered from view are denoted with 'Secret.' This means that the actual values are not visible to users or to Stibo Systems, for example, via Admin Portal configuration lists and remote diagnostics.

Changes to the properties file, outlined below, are implemented when the server is restarted.

  • S3Connection

    The syntax for specifying the connection details is:

    BlobStorage.S3.Secret.Connection.1=<connection-string-alias>,<AWSAccessKeyID>,<AWSSecretAccessKeyPassword>
BlobStorage.S3.Secret.Connection.2=<connection-string-alias2>,<AWSAccessKeyID2>,<AWSSecretAccessKeyPassword2>

    The <connection-string-alias> and <connection-string-alias2> are displayed in the ‘S3 Connection’ dropdown menu for the Gateway Integration Endpoint (explained in the next section). This shows the alias instead of the actual S3 required connection values (aws- access-key, aws-secret-access-key-password, aws region).

  • BucketName

    The syntax for specifying the BucketName is:

    BlobStorage.S3.Secret.BucketName.1=<my-bucket1>
BlobStorage.S3.Secret.BucketName.2=<my-bucket2>

    The <my-bucket1> and <my-bucket2> are displayed in the ‘BucketName’ dropdown menu for the Gateway Integration Endpoint (explained in the next section).

  • Region

    The syntax for specifying the AWS Region Code is:

    BlobStorage.S3.Region.1=<my-region-code>
BlobStorage.S3.Region.2=<my-region-code2>

    The <my-region-code> and <my-region-code2> are displayed in the ‘Region’ dropdown menu for the Gateway Integration Endpoint (explained in the next section).

    For available region codes to use for AWS Region, refer to: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions

    As an example, a valid value would be eu-west-1 if using this region.

    Note: While only two of each property is shown above; you can have additional properties by using a unique integer at the end of the property name (e.g., .1, .2, .3, etc.). When duplicate integers exist, only the last value is displayed in the dialog.

  • Proxy config

    Configuration is needed for on-prem systems if the delivery connection must first pass through a proxy server with its own login requirement.

    The syntax for specifying the proxy is defined in the HTTP Proxy Configurations topic here.

Configuring the Gateway Integration Endpoint

Once the properties as described above are entered into the sharedconfig.properties file, the options outlined within these properties display in the dropdowns in the dialog. If the dropdowns are empty, then the properties are not set up or are set up incorrectly.

  1. On the Gateway Integration Endpoint Configuration dialog, use the following parameters to specify which external system the gateway integration endpoint will access.

    • S3Connection - The desired S3 connection.

    • BucketName - The S3 bucket name to use. This name must already be established on the Amazon account.

    • Region - The AWS Region Code to use.

    • Proxy config - Select the desired HTTP proxy configuration if the delivery connection must first pass through a proxy server with its own login requirement. Intended for use by on-prem systems where the AWS S3 Storage is hosted externally.

    • Connection timeout in seconds - The connection timeout on the request in seconds. If left blank, the driver default is used.

  2. Click Save to complete the configuration.

  3. Enable the endpoint as defined in the Running a Gateway Integration Endpoint topic here.

  4. Test the connection from the gateway as follows:

    • On the Gateway Connectivity flipper, click the Check Connectivity button.

    • In the Check Connectivity dialog, in the Java Script Check Code section, add:

      gateway.checkConnectivity()

    • Click the Check Connectivity button and verify success or make the necessary corrections to connect.

Using the Gateway Integration Endpoint

Configuration of a GIEP is required to set up:

  • Asset Publisher Event Processor

    For more information, refer to the Asset Publisher Processing Plugin Parameters and Triggers topic in the Event Processors section of the System Setup documentation here.

  • Cloud Blob Storage Delivery Method

    For more information, refer to the Cloud Blob Storage Delivery Method topics in the OIEP Delivery Methods (here) and the Export Manager Delivery Methods (here) sections of the Data Exchange documentation.