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

Important: Prior to configuration, dropdown parameters that rely on a property are empty. To display the value(s) in the configuration dialog, log into the Self-Service UI, select the environment, and on the 'Configuration properties' tab, configure the property for your system.

Refer to the Self-Service UI 'User guide' for information about setting configuration properties, including the use of the ${CUSTOMER_SECRETS_ROOT} and ${CUSTOMER_CONFIG_ROOT} variables.

'Secret' configuration values are sensitive and are hidden in the display. 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.

Multiple entries can be added to the dropdown parameters using dynamic properties. Each configuration entry must have a unique integer or alpha identifier (indicated by [*]) as described below. When duplicate identifiers exist, only the last value is displayed in the dropdown.

Allow a few minutes for changes made in the Self-Service UI 'Configuration properties' tab to display in the workbench. Refer to the Self-Service UI topic for more information.

Configure data for the dropdown parameters:

  1. Configure the S3Connection dropdown parameter using the BlobStorage.S3.Secret.Connection.[*] property. For example, using this configuration, two options are displayed in the 'S3Connection' dropdown:

    On the 'Add configuration property value' dialog, the Value field includes the alias, the access key ID, and the access key password, each separated by a comma. Only the alias is displayed in the ‘S3Connection’ dropdown for the Gateway Integration Endpoint (explained in the next section). The access key ID and password are hidden.

  2. Configure the BucketName dropdown parameter using the BlobStorage.S3.Secret.BucketName.[*] property and a name that is already established on the Amazon account. For example, using this configuration, two options are displayed in the 'BucketName' dropdown for the Gateway Integration Endpoint (explained in the next section):

  3. Configure the Region dropdown parameter using the BlobStorage.S3.Region.[*] property. For example, using this configuration, two options are displayed in the 'Region' dropdown for the Gateway Integration Endpoint (explained in the next section):

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

  4. Proxy config dropdown parameter. Proxy functionality is intended for facilitating internet access, which is always available from SaaS environments. If a proxy is necessary for your scenario, contact Stibo Systems Support.

Configuring the Gateway Integration Endpoint

Once the properties described above are configured, the values created in these properties display in the configuration dialog dropdowns. If a dropdown is empty, revisit the 'Configuration properties' tab in the Self-Service UI to correct the error. Refer to the Self-Service UI topic for more information.

  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.

    • Region - The AWS Region Code to use.

    • Proxy config - Proxy functionality is intended for facilitating internet access, which is always available from SaaS environments. If a proxy is necessary for your scenario, contact Stibo Systems Support.

    • 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.

  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: