SharePoint Configuration
Version 23.3.8698
Version 23.3.8698
SharePoint Configuration
Once you have created a connection to SharePoint, the following sections help you configure the connector so you can send and receive files.
Connector Configuration
This section contains all of the configurable connector properties.
Settings Tab
Configuration
See Sharepoint Connection Setup for detailed instructions on how to create a connection to Sharepoint.
Send Configuration
Settings related to uploading to the remote storage.
- Remote Folder Files processed by the connector are uploaded to this folder. Hover over the field to display a list of supported macros.
- Overwrite Whether to overwrite or skip existing files.
Receive Configuration
Settings related to downloading from the remote storage.
- Remote Folder The remote folder from which files are downloaded. Use a comma-delimited list to specify multiple paths.
- File Mask A glob pattern that determines which files in the Remote Path should be downloaded (for example, *.txt).
- Delete Check this to delete successfully downloaded files from the remote storage.
Caching
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.
Automation Tab
Automation Settings
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.
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
Advanced Settings
Settings not included in the previous categories.
- Recurse Subdirectories 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 length of time (in seconds) the server waits for a connection response before throwing a timeout error.
- Local File Scheme A scheme for assigning filenames to messages that are output by the connector. You can use the following macros to reference contextual information:
%ConnectorId%, %Filename%, %FilenameNoExt%, %Ext%, %ShortDate%, %LongDate%, %RegexFilename%, %DateFormat%, %Header%.
For example: %FilenameNoExt%_%ShortDate%%Ext% - 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.
Message
- 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.
Logging
- 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
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.
Sending and Receiving
Send Files to Sharepoint
To send files, set the Remote Folder in the Send Configuration portion of the Settings page to the folder where files should be uploaded. Each Sharepoint connector uploads to a single folder location.
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.
Receive Files from Sharepoint
To receive files, set the Remote Folder in the Receive Configuration portion of the Settings page to the folder from where files should be downloaded. Use a comma-delimited list to specify multiple folders.
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.