AWSS3ClientForB2Bi Adapter

The AWSS3ClientforB2bi Adapter uses the AWS S3 services to connect to S3 bucket and perform operations.

Need for AWSS3ClientForB2Bi Adapter

At present, the system requires to add the S3 service configuration to every business process, which includes all the parameters required for an S3 connection. This causes duplication of data and the need to redefine business logic, which is not easy.

A new adapter, AWSS3ClientForB2Bi Adapter is introduced that has the ability to manage and override the connection parameters in the business process.

It can perform the following:
  • manage S3 for CRUD operations
  • configure S3 related properties
  • support default adapter configuration

The following table provides an overview of AWSS3ClientForB2Bi Adapter.

System name AWSS3ClientForB2Bi Adapter
Description A new adapter that stores AWS S3 connection properties which can be referred to in the AWS S3 Business Process.
Business usage Connects to AWS S3 service to perform various S3 operations such as get, put, or delete files.
Usage example You can use an AWS S3 Business Process service to store and retrieve files from cloud storage, and in every business process the cloud storage connection details needs to be passed. With the implementation of this adapter, you need not add connection details in every business process. You can just add the adapter reference in the business process.
Preconfigured? No
Requires third party files? Yes
Platform availability All supported platforms
Related services No
Application requirements You must download and install the AWS SDK for Java before performing any of the AWS S3 operations.
Initiates business processes? No
Restrictions This adapter can connect to AWS S3 service, Dell ECS Storage, and IBM Cloud Object Storage only.
Persistence level System default
Testing considerations None

How the AWSS3ClientForB2Bi Adapter Works

In a business process that performs AWS S3 operations on cloud storage, the AWSS3ClientForB2Bi Adapter can be used to store the cloud storage connection details and is used to establish the connection to cloud storage service and perform S3 operations.

Initiating a Business Process that Contains the AWSS3ClientForB2Bi Adapter

When an AWS S3 business process is triggered that contains AWSS3ClientForB2Bi adapter, the business process uses the EndPoint URL, EndPoint Port, Region, Bucket Name specified in the Adapter to establish connection to the cloud storage service. For authentication to the cloud storage service, the Access Key and Secret Key are used.
Note: The Access Key and Secret Key can be kept blank if the keys are specified in the other supported methods. For more information, see Making AWS keys as optional for AWS S3.

Business Process Example


<process name="AWSS3ClientPut">
  <sequence>
        <operation name="AWSS3 Put Service">
          <participant name='AWSS3Client'/>
          <output message='xout'>
            <assign to='action'>put</assign>
            <assign to="S3ClientAdapter">AWSS3Client</assign>
	    <assign to="awss3.filename">dummyfilename</assign>
            <assign to='.' from='PrimaryDocument' />
           <!-- valid values for s3.certficateList are CA certificate names ex: ASISslCert -->
           <assign to="s3.certficateList">dummycertList</assign>
           <!-- valid values for awss3.tlsVersion are TLS1.2-TLS1.3,TLSv1.3,System Default --> 
           <assign to="awss3.tlsVersion">dummytlsversion</assign>
          </output>
         <input message="xin">
           <assign to="." from="*"/>
         </input>
        </operation>
  </sequence>
</process>

Implementing the AWSS3ClientForB2Bi Adapter

To implement the AWSS3ClientForB2Bi Adapter, complete the following tasks:

  1. Create an AWSS3ClientForB2Bi Adapter configuration.
  2. Configure the AWSS3ClientForB2Bi Adapter.
    Note: When configuring the AWSS3ClientForB2Bi Adapter, you cannot pass parameters to the AWSS3ClientForB2Bi Adapter from BPML or configure the adapter using the GPM.
  3. Use the AWSS3ClientForB2Bi Adapter in a business process.

Configuring the AWSS3ClientForB2Bi Adapter

To configure the AWSS3ClientForB2Bi Adapter, you must specify settings for the following fields in Sterling B2B Integrator:

Field Description
Name Unique and meaningful name for the adapter configuration. Required.
Description Meaningful description for this adapter configuration for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time. This is the default value.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this adapter type, they are displayed in the list. Select a group from the list.
EndPoint URL EndPoint URL for S3 storage service. Optional.
EndPoint Port EndPoint Port for S3 storage service. Optional.
Region Region of S3 bucket. Optional.
Bucket Name Name of the S3 bucket. Optional.
Access Key Access key of the user account having permission to perform S3 operations on the bucket. Optional.
Secret Key Secret key of the user account having permission to perform S3 operations on the bucket. Optional.
Connection Retries The number of times AWSS3ClientForB2Bi Adapter tries to connect to the S3 Cloud storage service when there is a connection error. Optional. Minimum valid value is 1.
Connection Timeout Amount of time in milliseconds after which the connection terminates in case of a connection error and the number of connections retries is attempted. Optional.
Proxy Server Select ‘Yes’ if proxy server is to be used to connect to S3 storage service. By default, selected as ‘Yes’. Required.
Use SSL Select ‘Yes’ if SSL is required to be used to connect to S3 storage service. By default, selected as ‘Yes’. Required.
Storage Location Location to store documents retrieved from S3 storage. By default, set as ‘File system’. Other option is ‘Document Store’. Required.
Proxy Host Only displayed if ‘Proxy Server’ property is set to ‘Yes’. Hostname or IP of the Proxy server. Required.
Proxy Port Only displayed if ‘Proxy Server’ property is set to ‘Yes’. Port of the Proxy server. Required.
Proxy Basic Authentication Only displayed if ‘Proxy Server’ property is set to ‘Yes’. Whether proxy server uses basic authentication for connection. By default, selected as ‘Yes’. Required.
Proxy UserName Only displayed if ‘Proxy Server’ property is set to ‘Yes’ and ‘Proxy Basic Authentication’ is set to ‘Yes’. Username to login to proxy server. Required.
Proxy Password Only displayed if ‘Proxy Server’ property is set to ‘Yes’ and ‘Proxy Basic Authentication’ is set to ‘Yes’. Password to login to proxy server. Required.
TLS Version Select the TLS version from the drop-down list. The default value is TLSv1.3.
CA Certificate (Certificate Groups) Certificate used to validate the certificate from S3 storage server. Optional.