> ## 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>これらのオプションを使用すると、コネクタの実行中のさまざまなタイミングで、ターゲットサーバー上でカスタムコマンドを実行できます。</p>

    <Note>以下で説明するコマンドは一般的に受け入れられますが、コマンドを使用する前に、ターゲットサーバーがそのコマンドを受け入れられることをサーバー管理者に必ず確認してください。</Note>

    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>After Connect</strong></td><td>接続した直後にこのコマンドを実行します。</td></tr>
        <tr><td><strong>After Get</strong></td><td>各ファイルをダウンロードした後にこのコマンドを実行します。</td></tr>
        <tr><td><strong>After Put</strong></td><td>各ファイルをアップロードした後にこのコマンドを実行します。</td></tr>
        <tr><td><strong>Before Get</strong></td><td>各ファイルをダウンロードする前にこのコマンドを実行します。</td></tr>
        <tr><td><strong>Before Put</strong></td><td>各ファイルをアップロードする前にこのコマンドを実行します。</td></tr>
      </tbody>
    </table>

    <p>上記で説明したフィールドに含めることで、ターゲットサーバーに送信できるコマンドは次のとおりです。</p>

    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>onerror</code>：<code>fail</code> 引数を渡すと、カスタムスクリプトから発生したエラーをトランザクション全体のエラーとして扱うようコネクタに指示します。<code>fail</code> がない場合、コネクタは例外をログに記録して処理を続行します。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>cd</code>：ディレクトリを変更します。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>mkdir</code>：ディレクトリを作成します。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>rn</code> または <code>move</code>：ファイルの名前を変更または移動します。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>del</code> または <code>rm</code>：ファイルを削除または除去します。</p>
    <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <code>rmdir</code>：ディレクトリを削除します。</p>
    {extraCommands}

    <p>CData Arc は、これらのコマンドで次のマクロをサポートしています。これらはすべて次の構文を使用します。<code>%Macro%</code>。<code>%Date%</code> や <code>%SourceFilename%</code> などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。引数を取るマクロは次の構文を使用します。<code>%Macro:argument%</code></p>

    <table>
      <thead>
        <tr><th>マクロ</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td>MsgHeader:<em>headername</em></td><td>メッセージのヘッダー値に評価されます（例：%MsgHeader:headername%）。</td></tr>
        <tr><td>SourceFilename</td><td>現在処理されているファイルのファイル名（拡張子を含む）に評価されます。</td></tr>
        <tr><td>SourceFilenameNoExt</td><td>現在処理されているファイルのファイル名（拡張子を除く）に評価されます。</td></tr>
        <tr><td>Date</td><td>ファイルが最後に更新された日付をyyyy-MM-dd 形式（例：2024-02-13）で評価します。</td></tr>
        <tr><td>DateTime</td><td>ファイルが最後に更新された日時をyyyy-MM-dd'T'HH:mm:ss 形式（例：2024-02-13T08:14:22）で評価します。</td></tr>
        <tr><td>Time</td><td>ファイルが最後に更新された時刻をHH:mm:ss 形式（例：08:14:22）で評価します。</td></tr>
        <tr><td>DateTime.tz</td><td>ファイルが最後に更新された日時をyyyy-MM-dd'T'HH:mm:ss zzz 形式（例：2024-02-13T08:14:22 PST）で評価します。</td></tr>
        <tr><td>Time.tz</td><td>ファイルが最後に更新された時刻をHH:mm:ss zzz 形式（例：08:14:22 PST）で評価します。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>システムの現在の日時を指定された形式（<code>format</code>）で評価します。利用可能な日時形式については、<a href="/26.3/cloud/ja/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">日付形式のサンプル</a>を参照してください。</td></tr>
      </tbody>
    </table>

    <p><strong>例</strong>：ダウンロード後に、各ファイルをダウンロードフォルダからHistory サブフォルダに移動したいとします。<strong>After Get</strong> フィールドを使用して、<code>%SourceFilename%</code> マクロとともに<code>move</code> コマンドを指定します。</p>

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

export const CommonProxySettings = () => <>
    <p>これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションは<a href="/26.3/cloud/ja/getting-started/administration/settings/security">Security Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/proxy-settings">Proxy Settings</a> 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。</p>
    <table>
      <thead>
        <tr><th>設定</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Proxy Type</strong></td>
          <td>プロキシベースのファイアウォールで使用されるプロトコル。</td>
        </tr>
        <tr>
          <td><strong>Proxy Host</strong></td>
          <td>プロキシベースのファイアウォールの名前またはIP アドレス。</td>
        </tr>
        <tr>
          <td><strong>Proxy Port</strong></td>
          <td>プロキシベースのファイアウォールのTCP ポート。</td>
        </tr>
        <tr>
          <td><strong>Proxy User</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するユーザー名。</td>
        </tr>
        <tr>
          <td><strong>Proxy Password</strong></td>
          <td>プロキシベースのファイアウォールで認証するために使用するパスワード。</td>
        </tr>
        <tr>
          <td><strong>Authentication Scheme</strong></td>
          <td>デフォルトの<strong>None</strong> のままにするか、次の認証スキームのいずれかを選択します：<strong>Basic</strong>、<strong>Digest</strong>、<strong>Proprietary</strong>、または<strong>NTLM</strong>。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const CommonCacheCleanup = () => <>
    <p>Arc はリソースキャッシュを自動的にクリーンアップします。この処理はすべての受信サイクルの間にバックグラウンドで実行され、リモートサーバー上にすでに存在しないファイルの古いキャッシュエントリを削除します。これにより、手動での操作を必要とせずにキャッシュサイズを管理可能な状態に保ちます。</p>
    <p>デフォルトでは、ファイルは30 日間保持されますが、<strong>Advanced</strong> タブの<strong>Other Settings</strong> フィールドにある<code>ResourceCacheRetentionDays</code> 設定を使用して、お使いの環境に合わせて調整できます。例えば、<code>ResourceCacheRetentionDays=15</code> とすると、ファイルは削除されるまで15 日間保持されます。</p>
  </>;

export const SlasTab = ({siteName = "CData Arc"}) => <>
    <p><em>サービスレベルアグリーメント（SLA）の設定に関する設定です。</em></p>
    <p>
      SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA を<em>At Risk</em> としてマークします。これは、SLA が間もなく達成されない場合に<em>Violated</em> としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。
    </p>
    <p>
      SLA を定義するには、<strong>Expected Volume</strong> をオンに切り替え、<strong>Settings</strong> タブをクリックします。
    </p>
    <img src="/public/images/sla_empty.png" alt="SLA Empty" />
    <ul>
      <li>コネクタに送信と受信の個別のアクションがある場合は、ラジオボタンを使用してSLA がどちらの方向に適用されるかを指定します。</li>
      <li>ウィンドウの<strong>Expect at least</strong> 部分で、次を設定します。
        <ul>
          <li>処理を見込む最小トランザクション数（ボリューム）を設定します。</li>
          <li><strong>Every</strong> フィールドを使用して期間を指定します。</li>
          <li>SLA を有効にするタイミングを指定します。<strong>Starting on</strong> を選択した場合は、日付および時刻フィールドを入力します。</li>
          <li>SLA を有効にしたい曜日のチェックボックスをオンにします。必要に応じて、ドロップダウンで<strong>Everyday</strong> を選択します。</li>
        </ul>
      </li>
      <li>ウィンドウの<strong>Set status to 'At Risk'</strong> 部分で、SLA をAt Risk としてマークするタイミングを指定します。
        <ul>
          <li>デフォルトでは、SLA が違反状態になるまで通知は送信されません。これを変更するには、<strong>Send an 'At Risk' notification</strong> をオンにします。</li>
        </ul>
      </li>
    </ul>
    <p>
      次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。
    </p>
    <img src="/public/images/sla_defined.png" alt="SLA Configuration Example" />
    <Note>
      必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar で<strong>Settings</strong> をクリックし、<strong>Alerts &gt; General Alerts</strong> に移動します。タブレットと鉛筆のアイコンをクリックして編集し、<strong>SLA Alerts</strong> 設定のチェックを外します。
    </Note>
  </>;

export const AlertsTab = ({siteNameShort = "Arc"}) => <>
    <p><em>アラートの設定に関する設定です。</em></p>
    <p>
      サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} は<a href="/26.3/cloud/ja/getting-started/administration/settings/alerts">Alerts</a> タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、<strong>Override global setting</strong> をオンに切り替えます。
    </p>
    <p>
      デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、<strong>Enable</strong> チェックボックスのチェックを外します。
    </p>
    <p>
      <strong>Subject</strong>（必須）を入力します。<strong>Allow {siteNameShort}Script in Subject</strong> をチェックすると、<strong>Subject</strong> フィールドで{siteNameShort}Script を使用できます。これを選択すると、<strong>{siteNameShort}Script エディタ</strong>ボタンが表示されます（<img src="/public/images/rest_arcscript_editor.png" alt="arcscript editor button" style={{
  display: 'inline',
  verticalAlign: 'middle',
  margin: 0
}} />）。
    </p>
    <p>
      必要に応じて<strong>Recipient</strong> のメールアドレスをカンマ区切りのリストで入力します。
    </p>
  </>;

export const MiscConnector = () => <>
    <p><em>Miscellaneous 設定は、特定のユースケース向けの設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Other Settings</strong></td>
          <td>非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：<code>setting1=value1;setting2=value2</code>）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const Logging = () => <>
    <p><em>ログの作成と保存を制御する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Log Level</strong></td>
          <td>コネクタが生成するログの詳細度です。サポートを依頼する際は、これを<strong>Debug</strong> に設定してください。</td>
        </tr>
        <tr>
          <td><strong>Log Subfolder Scheme</strong></td>
          <td>選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。<strong>Weekly</strong> オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。</td>
        </tr>
        <tr>
          <td><strong>Log Messages</strong></td>
          <td>処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、<strong>Transactions</strong> タブからファイルのコピーをダウンロードできなくなる場合があります。</td>
        </tr>
      </tbody>
    </table>
  </>;

export const MacrosExamples = ({extraMacros = []}) => <>
    <p>
      %Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。
      引数を取るすべてのマクロは次の構文を使用します。<code>%Macro:argument%</code>
    </p>

    <p>引数を取るマクロの例を次に示します。</p>

    <ul>
      <li>%Header:headername%：<code>headername</code> はメッセージ上のヘッダーの名前です。</li>
      <li>%Header:mycustomheader% は、入力メッセージに設定された<code>mycustomheader</code> ヘッダーの値に解決されます。</li>
      <li>%Header:ponum% は、入力メッセージに設定された<code>ponum</code> ヘッダーの値に解決されます。</li>
      <li>%RegexFilename:pattern%：<code>pattern</code> は正規表現パターンです。例えば、<code>%RegexFilename:^([\w][A-Za-z]+)%</code> は、ファイル名の最初の単語にマッチしてそれに解決され、大文字・小文字を区別しません（<code>test_file.xml</code> は<code>test</code> に解決されます）。</li>
      <li>%Vault:vaultitem%：<code>vaultitem</code> は<a href="/26.3/cloud/ja/getting-started/administration/settings/global-settings-vault">Vault</a> 内のアイテムの名前です。例えば、<code>%Vault:companyname%</code> は、Vault に保存された<code>companyname</code> アイテムの値に解決されます。</li>
      <li>%DateFormat:format%：<code>format</code> は許容される日付形式です（詳細は<a href="/26.3/cloud/ja/scripting/value-formatters/date-formatters#sample-date-formats">日付形式のサンプル</a>を参照してください）。例えば、<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code> は、ファイルの日付とタイムスタンプに解決されます。</li>
      {extraMacros.filter(item => item.example).map(item => <li key={`ex-${item.name}`}>{item.example}</li>)}
    </ul>

    <p>次の例に示すように、より高度なマクロを作成することもできます。</p>

    <ul>
      <li>1 つのファイル名で複数のマクロを組み合わせる：<code>%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%</code></li>
      <li>マクロの外側にテキストを含める：<code>MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%</code></li>
      <li>マクロの内側にテキストを含める：<code>%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%</code></li>
    </ul>
  </>;

export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
    <p>
      ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。
      ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を
      動的に含めることができ、各ファイルに有用な文脈を提供します。
    </p>

    <p>{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。<code>%Macro%</code></p>

    <table>
      <thead>
        <tr><th>マクロ</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td>ConnectorID</td><td>コネクタのConnectorID に評価されます。</td></tr>
        <tr><td>ConnectorName</td><td>コネクタの名前に評価されます。ファイル名やパスに接続名を含めることができます。例えば、どのデータベース接続が生成したかによってバックアップファイルにタグを付けるために使用できます。</td></tr>
        <tr><td>Ext</td><td>コネクタが現在処理しているファイルの拡張子に評価されます。</td></tr>
        <tr><td>Filename</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。</td></tr>
        <tr><td>FilenameNoExt</td><td>コネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。</td></tr>
        <tr><td>MessageId</td><td>コネクタが出力しているメッセージのMessageId に評価されます。</td></tr>
        <tr><td>RegexFilename:<em>pattern</em></td><td>コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。</td></tr>
        <tr><td>Header:<em>headername</em></td><td>コネクタが現在処理しているメッセージ上の対象ヘッダー（<code>headername</code>）の値に評価されます。</td></tr>
        <tr><td>LongDate</td><td>システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。</td></tr>
        <tr><td>ShortDate</td><td>システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。</td></tr>
        <tr><td>DateFormat:<em>format</em></td><td>システムの現在の日時を指定された形式（<code>format</code>）で評価します。利用可能な日時形式については、<a href="/26.3/cloud/ja/scripting/value-formatters/date-formatters#date-formats-with-literal-characters">日付形式のサンプル</a>を参照してください。</td></tr>
        <tr><td>Vault:<em>vaultitem</em></td><td>指定されたVault アイテムの値に評価されます。</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>コネクタへのリソースの割り当てに関する設定です。</em></p>
    <table>
      <thead>
        <tr>
          <th>設定</th>
          <th>説明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><strong>Max Workers</strong></td>
          <td>このコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、<a href="/26.3/cloud/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</td>
        </tr>
        <tr>
          <td><strong>Max Files</strong></td>
          <td>コネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、<a href="/26.3/cloud/ja/getting-started/administration/settings/advanced-settings">Advanced Settings</a> ページの<a href="/26.3/cloud/ja/getting-started/administration/settings/performance-settings">Performance Settings</a> 部分にあるデフォルト設定が上書きされます。</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#ローカルファイルシステムとのやり取り) to manage local file systems instead of this setting.                                                                                     |

#### Proxy Settings

<CommonProxySettings />

#### 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 />