/n software Adapters for BizTalk

Questions / Feedback?

CloudStorage Adapter

Properties   Configuration Settings  

The CloudStorage Adapter allows easy uploading and downloading to major cloud service providers.

Remarks

The CloudStorage Adapter provides a simple way to upload and download files from a variety of cloud storage providers. Supported services are:

  • Amazon S3
  • Azure Blob
  • Azure File
  • Backblaze B2
  • Box.com
  • Digital Ocean Spaces
  • Dropbox
  • Google Cloud Storage
  • Google Drive
  • Hadoop DFS
  • IBM Cloud Object Storage
  • Linode Object Storage
  • Microsoft OneDrive
  • Wasabi
To begin, the adapter must first be configured to allow access to the specified ServiceProvider. Depending on the provider specified the credentials may either be specified or obtained using OAuth.

Authorization

The following providers use OAuth 2.0 for authorization:

  • Box.com
  • Dropbox
  • Google Cloud Storage*
  • Google Drive
  • Microsoft OneDrive

To perform OAuth authorization first open the OAuth Authorization dialog by clicking the ellipses (...) button of the OAuthAuthorization property at design time. This will open a dialog. Within the dialog specify the ClientId, ClientSecret, and CallbackURL values for the registered application.

After specifying the necessary values press the Authorize button to authorize the application. This will launch a browser and prompt the user to grant access. After access is granted the adapter will populate the following values:

All necessary values will be saved in the CacheLocation for use in subsequent requests by the adapter. The adapter will use the cached values and will automatically refresh the token if needed. In this way any user interaction is only required at design time, not at runtime.

To authenticate with the the other providers, set the AccountInfo property values shown in the table below:

Provider Relevant fields
Amazon S3 AccessKey and SecretKey
Azure Blob Account and AccessKey
Azure File Account and AccessKey
Backblaze B2 ApplicationKeyId and ApplicationKey
Digital Ocean Spaces AccessKey and SecretKey
Google Cloud Storage* ProjectId (if using OAuth authentication); or, AccessKey and SecretKey
Hadoop DFS Multiple HTTP authentication schemes are supported; refer to AuthMechanism for more information. HadoopURL must always be set.
IBM Cloud Object Storage Account and AccessKey
Linode Object Storage Account and AccessKey
Wasabi AccessKey and SecretKey

*Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) follow the instructions for OAuth, above, and set the ProjectId field of the AccountInfo property. To authenticate with an access and secret key, set the AccessKey and SecretKey fields of the AccountInfo property instead.

CloudStorage Receive Adapter

At runtime the adapter will connect to the cloud storage provider every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the BizTalk Message Engine as individual messages.

In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode to remove files from the server that have been downloaded. Alternatively DownloadCacheFile may be used to keep a list of files which have already been downloaded.

CloudStorage Send Adapter

The adapter will connect to the cloud storage provider whenever it has a message to send. The adapter will attempt to upload to the specified RemotePath. If Overwrite is set to True, the adapter will delete or overwrite remote files as necessary to complete the operation.

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.

AccountInfoAccount credentials.
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.
FileMaskIndicates the type of files to download from the server.
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).
MaxThreadsThe maximum number of threads that the adapter may consume.
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the adapter.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedFileDateThe modified date of the remote file received by the adapter.
ReceivedFileNameThe name of the remote file received by the adapter.
ReceivedFileSizeThe size of the file in bytes.
RemotePathThe current path on the server.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the adapter runtime license key.
ServiceProviderThe cloud storage 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 local 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.

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.

AccountInfoAccount credentials.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
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.
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the adapter.
OverwriteWhether or not the adapter should overwrite files during transfer.
RemoteFileThe name of the remote file.
RemotePathThe current path on the server.
RuntimeLicenseSpecifies the adapter runtime license key.
ServiceProviderThe cloud storage 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.

Configuration Settings


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

DateFormatThe date format of the file time.
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.
DocsExportFormatThe file format to export Google Docs files as when downloading.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
DrawingsExportFormatThe file format to export Google Drawings files as when downloading.
EnableFileDetailsComparisonWhether the receive adapter should consider metadata differences when deciding whether to download a file again.
RegionThe region the to make requests against when using an S3-like service provider.
SheetsExportFormatThe file format to export Google Sheets files as when downloading.
SlidesExportFormatThe file format to export Google Slides files as when downloading.
UseVirtualHostingThe URL style to use when making requests with an S3-like service provider.
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.

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