Version 23.4.8839

• Overview
• Connector Configuration
  • Settings Tab
    • Authorization
    • Send
    • Receive
  • Automation Tab
    • Automation Settings
    • Performance
  • Advanced Tab
    • Other Settings
    • Miscellaneous
• Establishing a Connection
  • Uploading
  • Downloading

The SharePoint Connector uploads to and downloads from the SharePoint cloud storage service.

Overview

Each SharePoint Connector connects to a specified SharePoint storage account. Within the remote storage, a single folder is set as the upload target and a single folder is set as the download target.

Files that reach the SharePoint Connector in the CData Arc flow are uploaded to the upload target folder, and files found in the download target folder are downloaded and entered into the Arc flow. The connector supports upload and download filters to only send and receive specified file names and/or file extensions.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Authorization

Settings related to the SharePoint account authorization.

• 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.
• URL The SharePoint URL associated with the appropriate storage account. The name of the SharePoint site must be included at the end of the URL by appending the following to the base URL: “/sites/mySiteName”.
• User The username credential associated with the appropriate storage account.
• Password The password credential associated with the appropriate storage account.

Send

Settings related to uploading to the remote storage.

• Remote Folder Files processed by the connector will be uploaded to this specified remote folder.
• Overwrite remote files Whether files that already exist in the remote folder should be uploaded (overwritten) or skipped.

Receive

Settings related to downloading from the remote storage.

• Remote Folder The remote folder from which files will be downloaded. Multiple folders can be specified in a comma-delimited list.
• File Mask A glob pattern that determines which files within the Remote Folder should be downloaded (e.g. *.txt). If multiple File Masks are required, the Receive Filter advanced field should be used.
• Delete files (after received) Whether files that are successfully downloaded should be deleted from the remote storage afterwards.

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

• Send Whether files arriving at the connector will automatically be uploaded.
• Retry Interval The amount of time before a failed upload is retried.
• Max Attempts The maximum number of times the connector will process the input file. Success is measured based on a successful server acknowledgement. If this is set to 0, the connect will retry 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.

Performance

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.

Advanced Tab

Other Settings

Settings not included in the previous categories.

• Receive Filter A glob pattern filter to determine which files should be downloaded from the remote storage (e.g. *.txt). Negative patterns may be used to indicate files that should not be downloaded (e.g. -*.tmp). This setting should be used when multiple File Mask patterns are desired. Multiple patterns may be separated by commas, with later filters taking priority except when an exact match is found.
• Log Level The verbosity of logs generated by the connector. When requesting support, it is recommended to set this to Debug.
• Recurse Subdirectories Whether to download files in subfolders of the target remote path.
• 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 Whether the log entry for a processed file includes a copy of the file itself.
• Save to Sent Folder Whether files processed by the connector should be copied to the Sent folder for the connector.

Miscellaneous

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

The following settings are required to establish a connection to SharePoint:

• URL
• User
• Password

The Test Connection button can be used to verify that the connection parameters are correct.

Uploading

To upload files, set the Send -> Remote Folder field to the folder where files should be uploaded to. Each SharePoint Connector uploads to a single specified folder location.

The Overwrite remote files option can be toggled to determine whether files that already exist in the remote folder should be overwritten or skipped.

After configuring, any files placed into the Send Folder of the connector will be uploaded to the remote storage. If Send Automation is enabled, the upload will happen automatically; otherwise, individual files can be Sent via the Input tab of the connector settings.

Downloading

To download files, set the Receive -> Remote Folder field to the folder where files should be downloaded from. Multiple download folders can be specified in a comma-delimited list.

The File Mask field can be set to a glob filter (e.g. *.txt), and only files matching this filter will be downloaded. To specify multiple filters, the Receive Filter setting can be configured in the Advanced tab.

The Delete files (after received) option toggles whether or not successfully downloaded files should be removed from the remote storage afterwards.

After configuring, files will be downloaded according to the Receive Automation settings, or by manually clicking the Receive button within the Output tab.