Azure Blob Connector
Azure Blob Connector
The Azure Blob connector supports uploading to and downloading from the Azure Blob cloud storage service.
Each Azure Blob connector connects to a specified Microsoft Azure storage account. Within the remote storage, you set a single container as the upload target, and a list of containers as the download target.
Files that reach the Azure Blob connector in the CData Arc flow are uploaded to the upload target container, and files found in the download target container are downloaded and entered into the Arc flow. The connector supports upload and download filters to send and receive only specific file names and/or file extensions.
This section contains all of the configurable connector properties.
Settings related to the Azure account used to access the Azure Blob service.
- Connector Id The static, unique identifier for the connector.
- Connector Type Displays the connector name and a description of what it does.
- Connector Description An optional field to provide a free-form description of the connector and its role in the flow.
- Account The Azure Blob account to access.
- AccessKey The access credential (provided by Microsoft) for the specified account.
Settings related to uploading to the remote storage.
- Container Name Files processed by the connector are uploaded to this container.
- Overwrite Whether to overwrite or skip existing files.
Settings related to downloading from the remote storage.
- Container Name The container from which files are downloaded.
- File Mask A glob pattern that determines which files in the Remote Path should be downloaded (for example, *.txt). If you need to specify multiple file masks, use the Receive Filter on the Advanced tab instead.
- Delete files (after received) Check this to delete successfully downloaded files from the remote storage.
Settings related to caching and comparing files between multiple downloads.
- File Size Comparison Check this to keep a record of downloaded file names and sizes. Previously downloaded files are skipped unless the file size is different than the last download.
- Timestamp Comparison Check this to keep a record of downloaded file names and last-modified timestamps. Previously downloaded files are skipped unless the timestamp is different than the last download.
Settings related to the automatic processing of files by the connector.
- Send Whether files arriving at the connector are automatically uploaded.
- Retry Interval The amount of time before a failed upload is retried.
- Max Attempts The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely.
- Receive Whether the connector should automatically poll the remote download path for files to download.
- Receive Interval The interval between automatic download attempts.
- Minutes Past the Hour The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
- Time The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
- Day The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
- Minutes The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
- Cron Expression A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.
Settings related to the allocation of resources to the connector.
- Max Workers The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Settings > Automation page.
- Max Files The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Settings > Automation page.
These are a collection of settings that identify and authenticate to the proxy through which the Azure Blob connection should be routed. By default, this section uses the global settings on the Settings Page. Clear the checkbox to supply settings specific to your connector.
- Proxy Type The protocol used by a proxy-based firewall.
- Proxy Host The name or IP address of a proxy-based firewall.
- Proxy Port The TCP port for a proxy-based firewall.
- Proxy User The user name to use to authenticate with a proxy-based firewall.
- Proxy Password A password used to authenticate to a proxy-based firewall.
- Authentication Scheme Leave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.
Settings not included in the previous categories.
- Recurse Whether to download files in subfolders of the target remote path.
- Processing Delay The amount of time (in seconds) by which the processing of files placed in the Input folder is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.
- Timeout The duration the connector waits for a connection response before throwing a timeout error.
- Receive Filter A glob pattern filter to determine which files should be downloaded from the remote storage (for example, *.txt). You can use negative patterns to indicate files that should not be downloaded (for example, -*.tmp). Use this setting when you need multiple File Mask patterns. Multiple patterns can be separated by commas, with later filters taking priority except when an exact match is found.
- Save to Sent Folder Check this to copy files processed by the connector to the Sent folder for the connector.
- Sent Folder Scheme Instructs the connector to group messages in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all messages for the week in that folder. The blank setting tells the connector to save all messages directly in the Sent folder. For connectors that process many messages, using subfolders helps keep messsages organized and improves performance.
- Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
- Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
- Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.
Miscellaneous settings are for specific use cases.
- Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example,
setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.
Establishing a Connection
Establishing a connection to the Azure Blob service requires Azure account credentials:
Use the Test Connection button to verify that the account information provided is valid.
Uploading and Downloading
To upload files, set the Container Name in the Send portion of the Settings page to the container where files should be uploaded. Each Azure Blob connector uploads to a single container.
Use the Overwrite remote files option to indicate whether files that already exist in the container should be overwritten or skipped.
After configuration is complete, files placed in the connector Input tab are uploaded to the remote storage. If Send Automation is enabled, the upload happens automatically; otherwise, you can send individual files from the Input tab.
To download files, set the Container Name in the Receive portion of the Settings page to the container from where files should be downloaded. Use a comma-delimited list to specify multiple download containers.
Use the File Mask to set a glob filter (for example *.txt) that limits the downloads to files matching the filter. To specify multiple filters, use the Receive Filter option on the Advanced tab.
Use Delete to specify whether successfully downloaded files should be removed from the remote storage.
After configuration is complete, files are downloaded according to the Receive Automation settings, or you can manually click the Receive button on the Output tab.