/n software Adapters for BizTalk

Questions / Feedback?

S3 Adapter

Properties   Configuration Settings  

The S3 Adapter provides access to Amazon's Simple Storage Service (S3), as well as other S3-like services.

Remarks

The S3 Adapter allows you to access Amazon's Simple Storage Service (S3), and other S3-like services, securely over an SSL connection. S3 services allow you to store arbitrary data objects in buckets and access them from anywhere using an Internet connection. Please refer to the Amazon S3 documentation (or the documentation for another S3-like service provider) for additional details.

To select which S3 service provider the S3 Adapter should communicate with, use the ServiceProvider property. Possible values are:

  • spAmazonS3 (0) (default): Amazon S3
  • spDigitalOcean (1): Digital Ocean Spaces
  • spGoogleStorage (2): Google Cloud Storage
  • spWasabi (3): Wasabi
  • spBackblazeB2 (4): Backblaze B2
  • spIBM (7): IBM Cloud Object Storage
  • spOracle (8): Oracle Cloud Object Storage
  • spLinode (9): Linode Object Storage
  • spOther (255): Other Provider

Authentication

You will need to sign up for an account with the desired S3 service and obtain an access key and secret key for it. Once you have a valid access key and secret key, use them to set the AccessKey and SecretKey properties. Once this is done, you may begin uploading/downloading files to and from your buckets.

Note: AccessKey and SecretKey must be set before attempting to use the adapter, unless ServiceProvider is set to spGoogleStorage (2) and you wish to authenticate using OAuth 2.0; refer to the OAuthAuthorization and GoogleProjectId properties for more information.

S3 Receive Adapter

The S3 Receive Adapter will download objects specified by the ObjectMask property contained within the specified Bucket.

S3 Send Adapter

The S3 Send Adapter requires a Bucket and a ObjectKey to specify the location to upload files to.

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 to use for authentication.
BucketThe name of the bucket to make requests against.
DeleteModeControls if and when the remote object is deleted after download.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
GoogleProjectIdA Google Cloud Platform project Id string.
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).
MaxThreadsThe maximum number of threads that the adapter may consume.
OAuthAuthorizationOAuth Authorization Information.
ObjectDelimiterThe delimiter string to use when listing objects.
ObjectMaskIndicates the type of files to download from the S3 server.
ObjectPrefixA prefix used to restrict the results returned when listing objects.
OracleNamespaceThe Oracle Cloud Object Storage namespace string.
OtherDefines a set of configuration settings to be used by the adapter.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedObjectDateThe date of the remote object received by the S3 adapter.
ReceivedObjectNameThe name of the remote object received by the S3 adapter.
ReceivedObjectSizeThe size of the remote object received by the S3 adapter.
RegionThe region the adapter will make requests against.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the adapter runtime license key.
SecretKeyThe secret key to use for authentication.
ServiceProviderThe S3 service provider.
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.
TempPathA temporary directory where data can be stored before the adapter processes it.
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.
UseSSLWhether to use SSL/TLS when connecting.
UseVirtualHostingDetermines which style request to use.

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 to use for authentication.
AccessPolicyThe canned access policy to apply when uploading objects.
BucketThe name of the bucket to make requests against.
ContentDispositionContent disposition to send when uploading objects.
ContentTypeContent type to send when uploading objects.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
GoogleProjectIdA Google Cloud Platform project Id string.
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.
OAuthAuthorizationOAuth Authorization Information.
ObjectKeyThis is the name of file being uploaded to the server.
OracleNamespaceThe Oracle Cloud Object Storage namespace string.
OtherDefines a set of configuration settings to be used by the adapter.
RegionThe region the adapter will make requests against.
RuntimeLicenseSpecifies the adapter runtime license key.
SecretKeyThe secret key to use for authentication.
ServiceProviderThe S3 service provider.
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.
UseSSLWhether to use SSL/TLS when connecting.
UseVirtualHostingDetermines which style request to use.

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.
DeleteOnUploadErrorWhether to delete the remote file when an error occurs after upload begins.
DirDelimiterThe delimiter for subfolders on the S3 server that should not be maintained in the local directory.
IgnoreBucketRestrictionsAllows the user to ignore Amazon-defined bucket name restrictions.
IncludeObjectMD5Includes the MD5 digest of the object data if set.
MaxObjectsThe maximum number of objects for the server to return.
ProcessAllPagesWhether or not to continue processing if results are paged.
SessionTokenThe session token to send in the request when using temporary credentials.
StorageClassSpecify the storage class to be used for the uploaded object.
URLThe URL to use for Other service providers.
UseEC2RoleCredentialsIf set to true, authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
UseServerSideEncryptionIf true, use server side encryption.
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]