Skip to main content
The S3 connector integrates with Amazon’s S3 (Simple Storage Service) and other S3-like services (such as Google Storage and Wasabi).

Key Capabilities

  • Amazon S3 and S3-compatible service integration (Google Storage, Wasabi) with IAM role and access key authentication
  • Bucket-based file organization with bidirectional transfers and prefix-based virtual folders
  • Client-side and server-side encryption options with configurable access policies
  • Optional caching to ensure only new or updated files are downloaded

Overview

Each S3 connector can automatically upload to and download from a single S3 bucket. Before you begin, you need an Amazon account with the appropriate credentials (or account credentials for the S3-like service you are using). Specify the upload and download paths in the bucket. The connector supports download filters by file name.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Host Configuration

Settings related to the remote connection target.

Account Settings

Settings related to the account with permission to access the configured Bucket Name.

TLS Settings

Settings related to TLS negotiation with the S3 server.

Upload

Settings related to the path in the specified bucket where files are uploaded.

Download

Settings related to the path in the specified bucket where files are downloaded.

Caching

Settings related to caching and comparing files between multiple downloads.

Arc automatically cleans up the resource cache. This process runs in the background during every receive cycle and removes stale cache entries for files that are no longer present on the remote server. This keeps the cache size manageable without requiring any manual action.

By default, files are retained for 30 days, but you can use the ResourceCacheRetentionDays setting in the Other Settings field on the Advanced tab to adjust it to fit your environment. For example, ResourceCacheRetentionDays=15 retains files for 15 days before removing them.

When you enable caching, the file names are case-insensitive. For example, the connector cannot distinguish between TEST.TXT and test.txt.

Advanced Tab

Advanced Settings

Settings not included in the previous categories.

Proxy Settings

These are a collection of settings that identify and authenticate to the proxy through which the connection should be routed. By default, this section uses the global settings on the Proxy Settings portion of the Security Settings page. Clear the checkbox to supply settings specific to your connector.

SettingDescription
Proxy TypeThe protocol used by a proxy-based firewall.
Proxy HostThe name or IP address of a proxy-based firewall.
Proxy PortThe TCP port for a proxy-based firewall.
Proxy UserThe user name to use to authenticate with a proxy-based firewall.
Proxy PasswordA password used to authenticate to a proxy-based firewall.
Authentication SchemeLeave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.

Message

Message settings determine how the connector searches for messages and manages them after processing.

Note: The settings below are deprecated and hidden by default. They appear only on connectors where they were previously enabled or configured to a non-default value. To retain copies of successfully processed files, right-click the connector in the flow, choose Show Success Path, and connect the success path to a File connector.

SettingDescription
Save to Sent Folder (Deprecated)Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by Encryption at Rest.
Sent Folder Scheme (Deprecated)Groups files in the Sent folder by the selected time interval. Only relevant when Save to Sent Folder is enabled.

Logging

Settings that govern the creation and storage of logs.

SettingDescription
Log LevelThe verbosity of logs generated by the connector. When you request support, set this to Debug.
Log Subfolder SchemeInstructs the connector to group files in the Logs folder according to the selected interval. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank 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 MessagesCheck 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 Transactions tab.

Miscellaneous

Miscellaneous settings are for specific use cases.

SettingDescription
Other SettingsEnables 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.

Automation Tab

Automation Settings

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

Automation Status

Performance

Settings related to the allocation of resources to the connector.

SettingDescription
Max WorkersThe maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page.
Max FilesThe maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page.

Alerts Tab

SLAs Tab

Establishing a Connection

The requirements for establishing an S3 connection are simple:
  • Amazon account credentials (or other S3-like account credentials)
    • Access Key
    • Secret Key
  • A bucket that can be accessed by the above account
For Amazon S3, use this link to obtain Access Key and Secret Key information from Amazon. Optionally, you can secure the connection with S3 servers with TLS by enabling the Use TLS option in the TLS Settings section.

Uploading

Upload to Remote Folders

The Prefix setting in the Upload section of the Settings page specifies the bucket path to upload files to. This allows for the logical separation of files into virtual folders in the same bucket.
S3 servers do not maintain a real folder structure, and Arc uses application logic to present a pseudo folder structure. Slashes in the Prefix (/, \\) are interpreted as representing a folder hierarchy. This allows for uploading to or downloading from ‘subfolders’ in the bucket based on the slashes in the path.

Upload Automation

The S3 connector supports automatic upload via the Automation tab. When Upload automation is enabled, files that reach the Transactions tab for the connector are automatically uploaded to the specified Bucket Name at the specified Prefix. If a file fails to upload, the application attempts to send it again after the Retry Interval has elapsed. This process continues until the Max Attempts has been reached, after which the connector raises an error.

Downloading

Download from Remote Folders

The Prefix setting in the Download section of the Settings page specifies the bucket path to download files from. This allows for the logical separation of files into virtual folders in the same bucket. The File Filter setting provides a way to only download specific filenames in the specified path.
S3 servers do not maintain a real folder structure, and Arc uses application logic to present a pseudo folder structure. Slashes in the Prefix (/, \\) are interpreted as representing a folder hierarchy. This allows for uploading to or downloading from ‘subfolders’ in the bucket based on the slashes in the path.

Download Automation

The S3 connector supports automatic download via the Automation tab. When Download automation is enabled, the connector automatically polls the remote bucket based on the specified Download Interval.

Macros

Examples