SQSClient Adapter

The SQSClient Adapter can be configured to execute business process with the retrieved messages. It connects to the AWS SQS queue and fetches messages.

The following table provides an overview of SQSClient Adapter.

System name SQSClient Adapter
Description A new adapter that connects to AWS SQS to poll for messages.
Business usage Connects to AWS SQS to poll and download messages or S3 Events.
Usage example SQSClient adapter connects to AWS SQS service and downloads messages. The user can also configure S3 events and retrieves files from S3 bucket.
Preconfigured? No
Requires third party files? Yes
Platform availability All supported platforms
Related services No
Application requirements User needs to download and install the AWS SDK for Java.
Initiates business processes? Yes
Invocation Can select BP from the dropdown for invocation.
Business process context considerations The files downloaded are placed as primary document and the business process selected can make use of the document for further processing.
Restrictions This adapter can only poll messages and cannot send messages to AWS SQS queue.
Persistence level System default
Testing considerations None

How the SQSClient Adapter Works

The SQSClient Adapter connects to AWS SQS queue and polls for messages in the given poll interval. If any message found in the queue the message is downloaded and persisted as a document. You can select a business process that can process the document available as primary document.

Implementing the SQSClient Adapter

To implement the SQSClient Adapter, complete the following tasks:

  1. Create an SQSClient Adapter configuration
  2. Configure the SQSClient Adapter

Configuring the SQSClient Adapter

To configure the SQSClient 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 AWS SQS Queue. Optional.
Region Region of SQS Queue. Optional.
Access Key Access key of the user account having permission to poll messages from SQS queue. Optional.
Secret Key Secret key of the user account having permission to poll messages from SQS queue. Optional.
Connection Retries The number of times SQSClient Adapter tries to connect to the SQS queue 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.
Queue Name Name of SQS Queue. Required.
Poll Interval Interval between polling messages. Minimum value 60 seconds. Required.
Proxy Server Select ‘Yes’ if proxy server is to be used to connect to SQS queue service. By default, selected as ‘No. Optional.
Use SSL Select ‘Yes’ if SSL is required to be used to connect to SQS queue service. By default, selected as ‘No. Optional.
CA Certificate (Certificate Groups) Certificate used to validate the certificate from AWS SQS queue. Optional.
Proxy Host Only displayed if ‘Proxy Server’ property is set to ‘Yes’. Hostname or IP of the Proxy server. Optional.
Proxy Port Only displayed if ‘Proxy Server’ property is set to ‘Yes’. Port of the Proxy server. Optional.
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 ‘No’. Optional.
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. Optional.
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. Optional.
Process Event Select how to process the message polled. Required.
Default value is None. Valid value are:
  • None
  • Execute Business Process
  • S3 Event
Document Storage Type Select the document store location for the document. Required.
Business Process Only displayed if Execute Business Process is selected. Optional.
Do you want to store the object in Mailbox? Only displayed if S3 Event selected. Select ‘Yes’ if the document is required to be pushed to any mailbox. Optional.
Mailbox User Only displayed if S3 Event selected. User with permission to the mailbox. Optional.
Mailbox Path Only displayed if S3 Event selected. Mailbox path to where the document is pushed. Optional.