/n software Adapters for BizTalk

Questions / Feedback?

SQS Adapter

Properties   Configuration Settings  

The SQS Adapter provides access to Amazon's Simple Queue Service (SQS).

Remarks

The SQS Adapter connects to Amazon's SQS service to download or upload messages in queues. SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. Please refer to Amazon SQS documentation for details.

To begin set AccessKey and SecretKey to the corresponding values for the AWS account. Queue specifies the existing queue to work with.

SQS Receive Adapter

The SQS Receive Adapter will download messages from the specified Queue. To delete messages after they are downloaded set DeleteMode to OnSuccess.

By default if messages are not deleted they may be returned in subsequent polling intervals if they are still present in the queue. To prevent duplicate messages from being downloaded even if they are still present in the SQS queue set DownloadCacheFile to a file on disk where information about downloaded message is stored. When DownloadCacheFile is specified the adapter will check if the message has previously been downloaded, and will skip it if so.

SQS Send Adapter

The SQS Send Adapter uploads messages to the specified Queue. The SQS Send Adapter is designed to be simple to use and requires only minimal configuration. By default the adapter will read the SQS message data from the BizTalk message body, however Message may also be set explicitly.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Receiver Property List


The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.

AccessKeyThe Access Key for the Amazon Web Services account.
DeleteModeControls if and when the remote message is deleted after download.
DownloadCacheFileThe file location where downloaded message information is cached.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxMessagesThe maximum number of messages retrieved from the queue.
MaxThreadsThe maximum number of threads that the adapter may consume.
OtherDefines a set of configuration settings to be used by the adapter.
PollingIntervalThe amount of time, in seconds, between download attempts.
QueueThe name of the queue to access.
ReceivedMessageIdThe Id of the message received by the SQS adapter.
ReceivedMessageMD5The MD5 hash of the remote message received by the SQS adapter.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the adapter runtime license key.
SecretKeyThe Secret Key for the Amazon Web Services account.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseFIFOQueueWhether the adapter should use FIFO queues instead of standard queues.
VisibilityTimeoutThe visibility duration for messages in the queue in seconds.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

AccessKeyThe Access Key for the Amazon Web Services account.
FirewallA set of properties related to firewall access.
HTTPProxyA set of properties related to proxy access.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageThe message to add to the specified queue.
MessageGroupIdThe ID that groups together messages in a FIFO queue.
OtherDefines a set of configuration settings to be used by the adapter.
QueueThe name of the queue to access.
RuntimeLicenseSpecifies the adapter runtime license key.
SecretKeyThe Secret Key for the Amazon Web Services account.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UseFIFOQueueWhether the adapter should use FIFO queues instead of standard queues.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
DownloadCacheFileDurationThe number of minutes that a message will remain in the download cache.
URLIf set, the default URL will be overridden by this value.
UseEC2RoleCredentialsIf set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 20.0 [Build 7724]