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
- Box
- Dropbox
- Google Drive
- OneDrive
- SharePoint Online
Authorization
The following providers use OAuth 2.0 for authorization:
- Box
- Dropbox
- Google Drive
- Microsoft OneDrive
To perform OAuth authorization first open the OAuth Authorization dialog by clicking the elipses (...) 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 Amazon S3 set AmazonS3AccessKey and AmazonS3SecretKey.
To authenticate with SharePoint Online set SharePointURL, SharePointUser, and SharePointPassword.
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.
| AmazonS3AccessKey | The Amazon S3 Access Key. |
| AmazonS3SecretKey | The Amazon S3 Secret Key. |
| DeleteMode | Controls if and when the remote object is deleted after download. |
| EncryptionAlgorithm | The encryption algorithm. |
| EncryptionPassword | The encryption password. |
| ErrorThreshold | The maximum number of errors before the adapter shuts down. |
| FileMask | Indicates the type of files to download from the cloud storage provider. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| OAuthAuthorization | OAuth Authorization Information. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileDate | The modified date of the remote file received by the CloudStorage adapter. |
| ReceivedFileName | The name of the remote file received by the CloudStorage adapter. |
| ReceivedFileSize | The size of the file in bytes. |
| RemotePath | The current path on the server. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| ServiceProvider | The cloud storage service provider. |
| SharePointPassword | The SharePoint user's password. |
| SharePointURL | The SharePoint site URL. |
| SharePointUser | The SharePoint user. |
| SSLAcceptServerCert | Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| TempPath | A temporary local directory where data can be stored before the adapter processes it. |
| Timeout | A timeout for the adapter. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The 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.
| AmazonS3AccessKey | The Amazon S3 Access Key. |
| AmazonS3SecretKey | The Amazon S3 Secret Key. |
| ConnectionLifetime | Instructs the adapter whether or not to leave the connection to the server open. |
| EncryptionAlgorithm | The encryption algorithm. |
| EncryptionPassword | The encryption password. |
| Firewall | A set of properties related to firewall access. |
| HTTPProxy | A set of properties related to proxy access. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the adapter may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| OAuthAuthorization | OAuth Authorization Information. |
| Other | Defines a set of configuration settings to be used by the adapter. |
| Overwrite | Whether or not the adapter should overwrite files during transfer. |
| RemoteFile | The name of the remote file. |
| RemotePath | The current path on the server. |
| RuntimeLicense | Specifies the adapter runtime license key. |
| ServiceProvider | The cloud storage service provider. |
| SharePointPassword | The SharePoint user's password. |
| SharePointURL | The SharePoint site URL. |
| SharePointUser | The SharePoint user. |
| SSLAcceptServerCert | Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| Timeout | A timeout for the adapter. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the adapter where and how to report information about its operations. |
| URI | The 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.
| DateFormat | The date format of the file time. |
| DeleteOnSuspend | Specifies whether files may be deleted from server when message is suspended. |
| DownloadCacheFile | When set, only new files will be downloaded from the server. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseManagedSecurityAPI | Tells the adapter whether or not to use the system security libraries or a managed implementation. |
| PersistedConnectionTimeout | How long to leave a persisted connection alive. |