> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AS3 Connector

> Configuration and usage guide for the CData Arc AS3 connector, which supports sending and receiving files using the AS3 protocol over FTP with AS2-style security.

export const CommonServerCommands = ({extraCommands}) => <>
    <p>These options allow you to execute custom commands on the target server at various times during connector execution.</p>

    <Note>While the commands described below are commonly accepted, be sure to check with the target server administrator to ensure that the server can accept a command before trying to use it.</Note>

    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>After Connect</strong></td><td>Execute this command directly after connecting.</td></tr>
        <tr><td><strong>After Get</strong></td><td>Execute this command after downloading each file.</td></tr>
        <tr><td><strong>After Put</strong></td><td>Execute this command after uploading each file.</td></tr>
        <tr><td><strong>Before Get</strong></td><td>Execute this command before downloading each file.</td></tr>
        <tr><td><strong>Before Put</strong></td><td>Execute this command before uploading each file.</td></tr>
      </tbody>
    </table>

    <p>Following are the commands you can submit to the target server when you include them in the fields described above:</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>onerror</code>: Pass the <code>fail</code> argument to instruct the connector to treat errors that come from the custom scripts as errors for the overall transaction. Without <code>fail</code> the connector logs any exceptions and continues processing.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>cd</code>: Change directory.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>mkdir</code>: Create directory.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>rn</code> or <code>move</code>: Rename or move file.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>del</code> or <code>rm</code>: Delete or remove file.</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>rmdir</code>: Remove directory.</p>
    {extraCommands}

    <p>CData Arc supports the following macros with these commands. They all use the following syntax: <code>%Macro%</code>. Some macros, such as <code>%Date%</code> and <code>%SourceFilename%</code>, do not require an argument, but others do. The macros that take an argument use the following syntax: <code>%Macro:argument%</code>.</p>

    <table>
      <thead>
        <tr><th>Macro</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td>MsgHeader:<em>headername</em></td><td>Evaluates to the header value of the message (for example: %MsgHeader:headername%).</td></tr>
        <tr><td>SourceFilename</td><td>Evaluates to the filename (extension included) of the file currently being processed.</td></tr>
        <tr><td>SourceFilenameNoExt</td><td>Evaluates to the filename (without the extension) of the file currently being processed.</td></tr>
        <tr><td>Date</td><td>Evaluates to the date the file was last modified in a yyyy-MM-dd format (for example, 2024-02-13).</td></tr>
        <tr><td>DateTime</td><td>Evaluates to the datetime the file was last modified in a yyyy-MM-dd'T'HH:mm:ss format (for example, 2024-02-13T08:14:22).</td></tr>
        <tr><td>Time</td><td>Evaluates to the time the file was last modified in a HH:mm:ss format (for example, 08:14:22).</td></tr>
        <tr><td>DateTime.tz</td><td>Evaluates to the datetime the file was last modified in a yyyy-MM-dd'T'HH:mm:ss zzz format (for example, 2024-02-13T08:14:22 PST).</td></tr>
        <tr><td>Time.tz</td><td>Evaluates to the time the file was last modified in a HH:mm:ss zzz format (for example, 08:14:22 PST).</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>Evaluates to the current datetime of the system in the specified format (<code>format</code>). See <a href="/26.3/self-hosted/en/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">Sample Date Formats</a> for the available datetime formats.</td></tr>
      </tbody>
    </table>

    <p><strong>Example</strong>: After downloading, you want to move each file from the download folder to a History subfolder. Use the <strong>After Get</strong> field to supply the <code>move</code> command with the <code>%SourceFilename%</code> macro.</p>

    <img src="/public/images/server_command_example.png" alt="Server command example" width="500" />
  </>;

export const CommonProxySettings = () => <>
    <p>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 <a href="/26.3/self-hosted/en/getting-started/administration/settings/proxy-settings">Proxy Settings</a> portion of the <a href="/26.3/self-hosted/en/getting-started/administration/settings/security">Security Settings</a> page. Clear the checkbox to supply settings specific to your connector.</p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>The protocol used by a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>The name or IP address of a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>The TCP port for a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>The user name to use to authenticate with a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>A password used to authenticate to a proxy-based firewall.</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>Leave the default <strong>None</strong> or choose from one of the following authentication schemes: <strong>Basic</strong>, <strong>Digest</strong>, <strong>Proprietary</strong>, or <strong>NTLM</strong>.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const CommonCacheCleanup = () => <>
    <p>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.</p>
    <p>By default, files are retained for 30 days, but you can use the <code>ResourceCacheRetentionDays</code> setting in the <strong>Other Settings</strong> field on the <strong>Advanced</strong> tab to adjust it to fit your environment. For example, <code>ResourceCacheRetentionDays=15</code> retains files for 15 days before removing them.</p>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>Settings related to configuring Service Level Agreements (SLAs).</em></p>
    <p>
      SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. {siteName} sends emails to warn the user when an SLA is not met, and marks the SLA as <em>At Risk</em>, which means that if the SLA is not met soon, it will be marked as <em>Violated</em>. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.
    </p>
    <p>
      To define an SLA, toggle <strong>Expected Volume</strong> on, then click the <strong>Settings</strong> tab.
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.</li>
      <li>In the <strong>Expect at least</strong> portion of the window:
        <ul>
          <li>Set the minimum number of transactions you expect to be processed (the volume)</li>
          <li>Use the <strong>Every</strong> fields to specify the time frame</li>
          <li>Indicate when the SLA should go into effect. If you choose <strong>Starting on</strong>, complete the date and time fields.</li>
          <li>Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose <strong>Everyday</strong> if necessary.</li>
        </ul>
      </li>
      <li>In the <strong>Set status to 'At Risk'</strong> portion of the window, specify when the SLA should be marked as at risk.
        <ul>
          <li>By default, notifications are not sent until an SLA is in violation. To change that, check <strong>Send an 'At Risk' notification</strong>.</li>
        </ul>
      </li>
    </ul>
    <p>
      The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click <strong>Settings</strong> on the navbar, then navigate to <strong>Alerts &gt; General Alerts</strong>. Click the tablet and pencil icon to edit, and uncheck the <strong>SLA Alerts</strong> setting.
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>Settings related to configuring alerts.</em></p>
    <p>
      Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, {siteNameShort} uses the global settings on the <a href="/26.3/self-hosted/en/getting-started/administration/settings/alerts">Alerts</a> tab. To use other settings for this connector, toggle <strong>Override global setting</strong> on.
    </p>
    <p>
      By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the <strong>Enable</strong> checkbox.
    </p>
    <p>
      Enter a <strong>Subject</strong> (mandatory). Check <strong>Allow {siteNameShort}Script in Subject</strong> to use {siteNameShort}Script in the <strong>Subject</strong> field. When you select this, the <strong>{siteNameShort}Script Editor</strong> button appears (<img src="/public/images/rest_arcscript_editor.png" alt="arcscript editor button" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />).
    </p>
    <p>
      Optionally, enter a comma-separated list of <strong>Recipient</strong> emails.
    </p>
  </>;

export const Message = () => <>
    <p><em>Message settings determine how the connector searches for messages and manages them after processing.</em></p>
    <p><strong>Note:</strong> 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 <strong>Show Success Path</strong>, and connect the success path to a <a href="/26.3/self-hosted/en/connectors/file">File connector</a>.</p>
    <table>
      <thead>
        <tr><th>Setting</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Save to Sent Folder</strong> (Deprecated)</td>
          <td>Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by <a href="/26.3/self-hosted/en/getting-started/administration/settings/encryption-at-rest">Encryption at Rest</a>.</td>
        </tr>
        <tr>
          <td><strong>Sent Folder Scheme</strong> (Deprecated)</td>
          <td>Groups files in the <strong>Sent</strong> folder by the selected time interval. Only relevant when <strong>Save to Sent Folder</strong> is enabled.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous settings are for specific use cases.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>Enables you to configure hidden connector settings in a semicolon-separated list (for example, <code>setting1=value1;setting2=value2</code>). Normal connector use cases and functionality should not require the use of these settings.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>Settings that govern the creation and storage of logs.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>The verbosity of logs generated by the connector. When you request support, set this to <strong>Debug</strong>.</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>Instructs the connector to group files in the Logs folder according to the selected interval. The <strong>Weekly</strong> 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.</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>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 <strong>Transactions</strong> tab.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      Some macros, such as %Ext% and %ShortDate%, do not require an argument, but others do. All
      macros that take an argument use the following syntax: <code>%Macro:argument%</code>
    </p>

    <p>Here are some examples of the macros that take an argument:</p>

    <ul>
      <li>%Header:headername%: Where <code>headername</code> is the name of a header on a message.</li>
      <li>%Header:mycustomheader% resolves to the value of the <code>mycustomheader</code> header set on the input message.</li>
      <li>%Header:ponum% resolves to the value of the <code>ponum</code> header set on the input message.</li>
      <li>%RegexFilename:pattern%: Where <code>pattern</code> is a regex pattern. For example, <code>%RegexFilename:^([\w][A-Za-z]+)%</code> matches and resolves to the first word in the filename and is case insensitive (<code>test_file.xml</code> resolves to <code>test</code>).</li>
      <li>%Vault:vaultitem%: Where <code>vaultitem</code> is the name of an item in the <a href="/26.3/self-hosted/en/getting-started/administration/settings/global-settings-vault">vault</a>. For example, <code>%Vault:companyname%</code> resolves to the value of the <code>companyname</code> item stored in the vault.</li>
      <li>%DateFormat:format%: Where <code>format</code> is an accepted date format (see <a href="/26.3/self-hosted/en/scripting/value-formatters/date-formatters#sample-date-formats">Sample Date Formats</a> for details). For example, <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> resolves to the date and timestamp on the file.</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>You can also create more sophisticated macros, as shown in the following examples:</p>

    <ul>
      <li>Combining multiple macros in one filename: <code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>Including text outside of the macro: <code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>Including text within the macro: <code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      Using macros in file naming strategies can enhance organizational efficiency and contextual
      understanding of data. By incorporating macros into filenames, you can dynamically include
      relevant information such as identifiers, timestamps, and header information, providing
      valuable context to each file.
    </p>

    <p>{siteName} supports these macros, which all use the following syntax: <code>%Macro%</code>.</p>

    <table>
      <thead>
        <tr><th>Macro</th><th>Description</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>Evaluates to the ConnectorID of the connector.</td></tr>
        <tr><td>ConnectorName</td><td>Evaluates to the name of the connector. Enables you to include the connection name in file names or paths: for example, to tag backup files by which database connection produced them.</td></tr>
        <tr><td>Ext</td><td>Evaluates to the file extension of the file currently being processed by the connector.</td></tr>
        <tr><td>Filename</td><td>Evaluates to the filename (extension included) of the file currently being processed by the connector.</td></tr>
        <tr><td>FilenameNoExt</td><td>Evaluates to the filename (without the extension) of the file currently being processed by the connector.</td></tr>
        <tr><td>MessageId</td><td>Evaluates to the MessageId of the message being output by the connector.</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>Applies a RegEx pattern to the filename of the file currently being processed by the connector.</td></tr>
        <tr><td>Header:<em>headername</em></td><td>Evaluates to the value of a targeted header (<code>headername</code>) on the current message being processed by the connector.</td></tr>
        <tr><td>LongDate</td><td>Evaluates to the current datetime of the system in long-handed format (for example, Wednesday, January 24, 2024).</td></tr>
        <tr><td>ShortDate</td><td>Evaluates to the current datetime of the system in a yyyy-MM-dd format (for example, 2024-01-24).</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>Evaluates to the current datetime of the system in the specified format (<code>format</code>). See <a href="/26.3/self-hosted/en/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">Sample Date Formats</a> for the available datetime formats.</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>Evaluates to the value of the specified vault item.</td></tr>
        {extraMacros.map(item => <tr key={item.name}>
            <td>{item.name}</td>
            <td>{item.description}</td>
          </tr>)}
      </tbody>
    </table>
  </>;

export const Performance = () => <>
    <p><em>Settings related to the allocation of resources to the connector.</em></p>
    <table>
      <thead>
        <tr>
          <th>Setting</th>
          <th>Description</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>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 <a href="/26.3/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.3/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the <a href="/26.3/self-hosted/en/getting-started/administration/settings/performance-settings">Performance Settings</a> portion of the <a href="/26.3/self-hosted/en/getting-started/administration/settings/advanced-settings">Advanced Settings</a> page.</td>
        </tr>
      </tbody>
    </table>
  </>;

export const siteNameShort = "Arc";

export const siteName = "CData Arc";

AS3 connectors support sending and receiving files using the Applicability Statement 3 (AS3) protocol.

## Key Capabilities

* Secure file transfer combining FTP protocol with [AS2](./as2)-style security
* Digital encryption and signature support for enhanced security
* MDN receipt generation and processing for reliable delivery confirmation
* Support for both upload and download operations with filtering
* TLS/SSL support with client authentication capabilities

## Overview

Each AS3 connector is configured to exchange files with a single AS3 trading partner. AS3 connectors use the FTP protocol to transfer files, and add security and verification through digital encryption and signatures. Configuring an AS3 trading relationship requires exchanging AS3-specific profile details, such as AS3 identifiers and digital certificates, and the connection details for the target FTP server.

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Trading Partner Info

*Settings for identifying and connecting to a specific AS3 trading partner.*

| Setting                   | Description                                                                                     |
| ------------------------- | ----------------------------------------------------------------------------------------------- |
| **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. |
| **AS3 Identifier**        | The AS3 identifier specific to the target trading partner.                                      |

#### Local Profile

*Settings that identify the local AS3 profile.*

| Setting                  | Description                                                                   |
| ------------------------ | ----------------------------------------------------------------------------- |
| **Local AS3 Identifier** | Your AS3 identifier.                                                          |
| **Private Certificate**  | The certificate used to decrypt incoming messages and sign outgoing messages. |
| **Certificate Password** | The password required to access the local private certificate.                |

#### Connection Info

*Settings related to connection parameters for the target FTP server.*

| Setting                      | Description                                                                                                                                                                                                                                                                 |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Host**                     | The hostname or IP address of the FTP server.                                                                                                                                                                                                                               |
| **Port**                     | The port on which to connect to the FTP server.                                                                                                                                                                                                                             |
| **User**                     | The username credential for logging in to the FTP server.                                                                                                                                                                                                                   |
| **Password**                 | The password credential for logging in to the FTP server.                                                                                                                                                                                                                   |
| **TLS Type**                 | How to negotiate TLS/SSL when connecting to the server. Choose **Explicit** to establish a plain text connection where TLS/SSL is then started with an explicit command. Choose **Implicit** to immediately negotiate TLS/SSL without establishing a plain text connection. |
| **Send Message Security**    | Whether to sign and/or encrypt outgoing AS3 messages. CData strongly recommends you use signatures and encryption.                                                                                                                                                          |
| **Receive Message Security** | Whether to require that signatures and encryption are present for incoming AS3 messages. An error is thrown if a received message does not have a required security parameter.                                                                                              |
| **Compression**              | Whether to compress the payload of outgoing messages.                                                                                                                                                                                                                       |
| **Connection Timeout**       | The length of time (in seconds) the connector waits for a connection response before throwing a timeout error.                                                                                                                                                              |

#### MDN Receipts

*Settings related to requesting MDNs when sending AS3 messages.*

| Setting                 | Description                                                                                                                                                                   |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Request MDN Receipt** | Whether an MDN receipt should be returned in response to outgoing AS3 messages. CData strongly recommends that you request MDN receipts.                                      |
| **MDN Path**            | The folder path on the server where the partner uploads MDN receipts.                                                                                                         |
| **Security**            | Whether the MDN receipt should include a signature block verifying the message integrity and identity of the recipient. Again, CData strongly recommends you use this option. |

#### Upload

*Settings related to how outgoing AS3 messages are uploaded.*

| Setting         | Description                                                                          |
| --------------- | ------------------------------------------------------------------------------------ |
| **Remote Path** | The folder path on the remote FTP server where outgoing messages should be uploaded. |

#### Download

*Settings related to how incoming AS3 messages are downloaded.*

| Setting          | Description                                                                                                       |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Remote Path**  | The folder path on the remote FTP server from which incoming messages should be downloaded.                       |
| **File Mask**    | A glob pattern that determines which files within the **Remote Path** should be downloaded (for example, \*.txt). |
| **Delete files** | Whether files should be deleted from the FTP server after they are successfully downloaded.                       |

#### Trading Partner Certificates

*Settings related to the public certificates provided by the trading partner.*

| Setting                      | Description                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Encryption Certificate**   | The public key certificate used for AS3 encryption when sending messages. This certificate must be paired with the trading partner's private certificate, and the trading partner should provide a public key certificate when sharing AS3 configuration details.                                                                                                                                                     |
| **Verification Certificate** | The public certificate used to verify AS3 signatures when receiving messages. This field is often unnecessary; most AS3 parties use the same private certificate for both signing and decrypting. If this field is not specified, the application uses the **Encryption Certificate** to verify signatures.                                                                                                           |
| **TLS Server Certificate**   | The public certificate used to verify the identity of an SSL/TLS server. This is only necessary if the FTP server requires FTPS (FTP over TLS/SSL). If the trading partner does not provide a TLS server certificate, you can leave this setting blank to allow the underlying OS/JVM to perform certificate validation, or it can be set to `Any Certificate` to unconditionally trust the target server's identity. |

### Advanced Tab

#### Local Profile

*Settings related to client authentication when two-way SSL authentication is required.*

| Setting                  | Description                                                                                                                                                   |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Use Profile**          | Whether to use the **Private Certificate** configured on the Profiles page as the TLS certificate for client authentication.                                  |
| **Private Certificate**  | The private certificate presented during TLS client authentication. Only applicable if you are not using the same private certificate from the Profiles page. |
| **Certificate Password** | The password required to access the TLS client certificate.                                                                                                   |

#### Server Commands

<CommonServerCommands />

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                             | Description                                                                                                                                                                                                                                                                                                                                                                  |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Active Mode**                     | Whether to enable Active or Passive mode on the remote FTP server. Passive mode is less likely to result in firewall interference with the connection.                                                                                                                                                                                                                       |
| **Clear Command Channel**           | Check this to send FTP commands using a cleartext channel instead of an encrypted channel.                                                                                                                                                                                                                                                                                   |
| **Clear Data Channel**              | Check this to have the application use a clear data channel when communicating with the FTP server.                                                                                                                                                                                                                                                                          |
| **Encryption Algorithm**            | The algorithm to use when encrypting outgoing AS3 messages.                                                                                                                                                                                                                                                                                                                  |
| **EPSV**                            | Check this to use extended passive mode. This might be necessary if you need to use a protocol other than IPv4.                                                                                                                                                                                                                                                              |
| **Excluded Extensions**             | A comma-delimited list of file extensions that should not be processed by the connector.                                                                                                                                                                                                                                                                                     |
| **FSwitch**                         | Used in conjunction with **Simple Dir List**. Check this to restrict the directory listing to files only.                                                                                                                                                                                                                                                                    |
| **Local File Scheme**               | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see [Macros](#macros).                                                                                                                                      |
| **Prot for Implicit TLS**           | Tells the server that the data channel is protected for implicit TLS connections. Select the TLS type on the **Settings** tab.                                                                                                                                                                                                                                               |
| **Remote Host Address for Passive** | Only applicable when **Active Mode** is not set. Leave blank to have the application parse the remote host to send replies from the previous server response. When this is checked, the application uses the value of the RemoteHost setting instead.                                                                                                                        |
| **Signature Algorithm**             | The algorithm to use when signing outgoing messages. The same algorithm is requested for the corresponding MDN receipts.                                                                                                                                                                                                                                                     |
| **Simple Dir List**                 | Check this when you need a simple directory listing command for servers that send back long responses that cannot be parsed. After you set this, if the connector is still unable to parse the directory listing, add the **FSwitch** setting to restrict the directory listing to files only.                                                                               |
| **TLS Enabled Protocols**           | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. SSL v2 and SSL v3 are considered vulnerable and should only be used if your partner does not support higher versions. Keep in mind that TLS v1.3 is not universally adopted, and might be refused if the destination server does not support it. |
| **Processing Delay**                | The amount of time (in seconds) by which the processing of files placed in the **Transactions** tab is delayed. This is a legacy setting. Best practice is to [use a File connector](../flows/designing-a-flow#interacting-with-the-local-file-system) to manage local file systems instead of this setting.                                                                 |

#### Proxy Settings

<CommonProxySettings />

#### Message

<Message />

#### Logging

<Logging />

#### Miscellaneous

<MiscConnector />

### Automation Tab

#### Automation Settings

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

| Setting                   | Description                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Upload**                | Whether files arriving at the connector should automatically be uploaded.                                                                                                                                                                                                                                                                                                                                       |
| **Retry Interval**        | The number of minutes 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, and validation of the receipt (when requested synchronously). If you set this to 0, the connect retries the file indefinitely.                                                                                                                                            |
| **Resend Interval**       | The number of minutes before unacknowledged messages are resent. A resend is triggered when the server receives the file, but an asynchronous MDN receipt is not provided within the expected timeframe.                                                                                                                                                                                                        |
| **Max Attempts (async)**  | The maximum number of times the connector processes the input file when asynchronous receipts are requested. Success is based on the return of an asynchronous receipt within the **Resend Interval** after a successful server acknowledgement. If a successful server acknowledgement is not returned, **Max Attempts** is applied instead. If this is set to 0, the connector resends the file indefinitely. |
| **Receive**               | Whether the connector should automatically poll the remote download path(s) for files to download.                                                                                                                                                                                                                                                                                                              |
| **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

<Performance />

### Alerts Tab

<AlertsTab />

### SLAs Tab

<SlasTab />

## Establishing a Connection

To connect to the remote FTP server, specify the **Host**, **Port**, **User**, **Password**, and **TLS Type** required by the server. Use the Test Connection button to verify that the connection parameters are correct.

Once connected, set the upload and download **Remote Path** so that files are placed in and read from the appropriate location to communicate with the trading partner.

## Automatic Cache Cleanup

<CommonCacheCleanup />

The same cache cleanup process works with [MDN receipts](#mdn-receipts).

## Macros

<MacrosTable />

### Examples

<MacrosExamples />