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

# OFTP Connector

> Configuration and usage guide for the CData Arc OFTP connector, which sends and receives files via the Odette FTP protocol.

export const TrustedIp = () => <>
    <p><strong>Trusted IP Addresses</strong> セクションでは、次の機能を使用できます。</p>

    <table>
      <thead>
        <tr><th>機能</th><th>説明</th></tr>
      </thead>
      <tbody>
        <tr><td><strong>Add</strong></td><td>新しいIP アドレス範囲を入力します。</td></tr>
        <tr><td><strong>Edit</strong></td><td>選択したIP アドレス範囲を変更します。</td></tr>
        <tr><td><strong>Delete</strong></td><td>選択したIP アドレス範囲をリストから削除します。</td></tr>
      </tbody>
    </table>

    <p>この機能には次の制限が適用されます。</p>

    <ul style={{
  listStyleType: 'disc',
  paddingLeft: '1.5rem'
}}>
      <li style={{
  display: 'list-item'
}}><code>localhost</code> はリストから変更または削除できません。</li>
      <li style={{
  display: 'list-item'
}}>定義された範囲外のIP アドレスはすべて拒否されます。</li>
      <li style={{
  display: 'list-item'
}}>範囲がサポートされています。例えば、エントリ<code>100.10.100.1-15</code> は、<code>100.10.100.1</code> から<code>100.10.100.15</code> までのIP アドレスが許可されることを示します。</li>
      <li style={{
  display: 'list-item'
}}>Classless inter-domain routing（CIDR）表記がサポートされています。例えば、エントリ<code>100.10.100.0/24</code> は、<code>100.10.100.0</code> から<code>100.10.100.255</code> までのIP アドレスが許可されることを示します。</li>
      <li style={{
  display: 'list-item'
}}>ワイルドカードパターンがサポートされています。例えば、エントリ<code>100.10.100.*</code> は、<code>100.10.100</code> で始まるIP アドレスが許可されることを示します。</li>
    </ul>

    <Note>
      <p>クライアントがサーバーに到達するには、明確なネットワークパスが必要です。クラウド環境では、次の3か所で変更が必要になる場合があります。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• クラウドコンソールのネットワークルール。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• アプリケーションをホストするマシンのファイアウォールルール。例えば、Amazon AMI を使用する場合、<em>Uncomplicated Firewall</em>（UFW）を使用して目的のポートでのトラフィックを許可できます。Linux 環境での一般的な方法は、1024 より小さいポートから1024 より大きい非標準ポートへトラフィックを転送し、アプリケーションがその非標準ポートを使用するように設定することです。これにより、非rootユーザーが1024 より小さいポートにバインドする際の権限の問題を回避できます。</p>
      <p style={{
  paddingLeft: '1.5rem',
  marginTop: '0.25rem',
  marginBottom: '0.25rem'
}}>• <a href="/26.3/cloud/ja/getting-started/administration/settings/security">Security</a> タブの<a href="/26.3/cloud/ja/getting-started/administration/settings/network-access">Network Access</a> 部分。</p>
    </Note>
  </>;

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 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 ProfileLogging = () => <>
    <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 Rotate Interval</strong></td>
          <td>新しいログファイルを作成するまでに待機する日数です。</td>
        </tr>
        <tr>
          <td><strong>Log Delete Interval</strong></td>
          <td>古いログファイルを削除するまでに待機する日数です。</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";

The OFTP connector sends and receives files via the Odette FTP protocol.

## Key Capabilities

* Odette FTP support for automotive and manufacturing industry secure file exchange
* Bidirectional file transfer with certificate-based encryption, signing, and compression
* Message routing through intermediary OFTP entities with SSID/SFID configuration
* Automatic retry and resend logic with synchronous and asynchronous receipt handling

## Overview

An OFTP connection is configured in two places. Configure the OFTP [Profiles](../getting-started/administration/profiles) page with an Odette identifier, settings for the local OFTP server, and other information that is global across all OFTP connections. Then configure individual OFTP connectors with connection settings specific to a single trading partner (a single OFTP entity).

For information on routing an OFTP message through a separate OFTP entity (for example, a clearinghouse), see [Message Routing](#message-routing).

## Profile Configuration

The OFTP profile must be configured before connections can be established with individual OFTP connectors. Click **Profiles > OFTP** on the navbar.

### OFTP Profile Tab

#### Personal Id

*Settings for identifying the local profile.*

| Setting                           | Description                                                                                                                                                                                                              |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Odette Identifier (SSID Code)** | Your Odette identifier. This value is included in outgoing transmissions to identify the sender, and incoming messages must be addressed to this identifier. Odette identifiers are provided by the Odette organization. |
| **Password (SSID Password)**      | The password associated with the **Odette Identifier**. You can choose this value as long as your trading partners have the same value configured on their systems.                                                      |

#### Server Settings

*Settings related to the OFTP server implementation.*

| Setting                     | Description                                                                                      |
| --------------------------- | ------------------------------------------------------------------------------------------------ |
| **Port**                    | The port on which the server listens for incoming connections.                                   |
| **SSL/TLS**                 | Whether SSL/TLS must be negotiated to connect to the server.                                     |
| **TLS Private Certificate** | If TLS/SSL is enabled, specify the TLS/SSL certificate required to verify the server's identity. |
| **Certificate Password**    | The password required to access the TLS/SSL certificate.                                         |

#### Personal Certificate

*Settings related to the private decryption and signature certificate.*

| Setting                         | Description                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data Decryption Certificate** | The certificate used to decrypt incoming messages and sign outgoing messages. Never share this certificate with external parties. Click the **Create Certificate** button to generate a self-signed certificate that is ready to use in an OFTP transaction; a corresponding public key certificate is also generated with the same filename and a `.cer` extension. |
| **Certificate Password**        | The password required to access the **Data Decryption Certificate**.                                                                                                                                                                                                                                                                                                 |

#### Optional Certificate Settings

*Optional settings to define parameters for a certificate.*

| Setting                                | Description                                                                                                                                           |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Auth Challenge Private Certificate** | A certificate with a private key used when challenged by the server to verify authenticity. Accepts PKCS#12 certificates in `.pfx` or `.p12` formats. |
| **Certificate Password**               | The private certificate password.                                                                                                                     |
| **Sign Private Certificate**           | A certificate with a private key used when signing sent messages. Accepts PKCS#12 certificates in `.pfx` or `.p12` formats.                           |
| **Certificate Password**               | The private certificate password.                                                                                                                     |
| **Strong Certificate Verification**    | Only allow strong certificate verification from trusted certificate authorities.                                                                      |

#### Advanced Settings

| Setting                | Description                                                                                |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| **Inactivity Timeout** | The length of time (in seconds) to wait before closing inactive connections to the server. |

#### Lockouts

*Optional settings related to locking server access.*

| Setting               | Description                                                                      |
| --------------------- | -------------------------------------------------------------------------------- |
| **Failed Attempts**   | The number of unsuccessful login attempts allowed before the user is locked out. |
| **Lockout Period**    | The length of time (in minutes) that the user is locked out.                     |
| **Time Check Period** | The length of time (in minutes) that records are kept of failed login attempts.  |

#### Trusted IP Addresses

<TrustedIp />

#### Logging

<ProfileLogging />

#### Miscellaneous

<MiscConnector />

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Host Configuration

*Settings related to the remote OFTP entity to connect to.*

| 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.                                                                                                               |
| **サーバーステータス**                    | コネクタの基盤サービスの現在の状態：**アクティブ**（サービスが実行中）、**非アクティブ**（サービスは設定済みですが現在は実行されていません）、**未設定**（基盤となるプロファイルまたはサービスが設定されていません）。OFTP プロファイルを作成済みかどうかに応じて、**OFTP プロファイルを設定**または**OFTP プロファイルを表示**リンクをクリックして新しいタブでプロファイルを開きます。 |
| **Odette Identifier**            | The Odette identifier for the remote OFTP entity (the trading partner's identifier).                                                                                                                          |
| **Password**                     | The password associated with the partner's identifier.                                                                                                                                                        |
| **Version**                      | The version of the OFTP protocol to use when exchanging files.                                                                                                                                                |
| **Remote Host**                  | The hostname or IP address of the remote OFTP server.                                                                                                                                                         |
| **Port**                         | The port on which to connect to the remote OFTP server.                                                                                                                                                       |
| **Connection Timeout**           | The length of time (in seconds) the connector waits for a connection response before throwing a timeout error.                                                                                                |
| **Use SSL/TLS**                  | Whether to negotiate SSL/TLS when connecting to the remote OFTP server.                                                                                                                                       |
| **Secure Odette Authentication** | Whether to perform application-layer encryption and decryption. To perform this authentication, you must specify both a signing and encryption certificate.                                                   |

#### Connection Info

*Settings related to the OFTP connection parameters.*

| Setting                            | Description                                                                          |
| ---------------------------------- | ------------------------------------------------------------------------------------ |
| **Virtual File Format**            | The OFTP file format to use when transmitting files.                                 |
| **Virtual Outgoing File Security** | Whether to sign and/or encrypt outgoing messages.                                    |
| **Virtual Incoming File Security** | Whether to require signed and/or encrypted incoming messages.                        |
| **Compression**                    | Whether to compress outgoing messages.                                               |
| **Signed Receipts**                | Whether outgoing messages should request or require a signed receipt to be returned. |

#### Trading Partner Certificates

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

| Setting                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Encryption Certificate** | The public key certificate used for encryption when sending messages. This certificate must be paired with the trading partner's private decryption certificate. The trading partner must provide this public key certificate when sharing their OFTP configuration details.                                                                                                                                               |
| **TLS Server Certificate** | The public key certificate used to verify the identity of a TLS/SSL server. This is only necessary if the partner's OFTP system requires HTTPS instead of HTTP. 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 set it to `Any Certificate` to unconditionally trust the target server's identity. |

#### Routing

*Settings related to routing an OFTP message through a separate OFTP entity.*

| Setting             | Description                                                                                                                                                                                                         |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Routing Partner** | If outgoing OFTP messages should be routed through an OFTP entity that is separate from the target OFTP entity, set this field to the OFTP connector that is configured to connect to the intermediary OFTP server. |

For example, if the connector needs to send files to `serverA` and route the file through `serverB`, configure the connector to connect to `serverA` and set this field to an OFTP connector configured to connect to `serverB`. See [Message Routing](#message-routing) for more information.

### Advanced Tab

#### Optional Certificates (PEM/CER Format)

*Settings related to additional certificates to use for enhanced security.*

| Setting                               | Description                                                                                                                              |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **Auth Challenge Certificate**        | The public key certificate to present when challenged by the server to verify authenticity.                                              |
| **Verification Certificate**          | The public key certificate to use when verifying digital signatures on incoming messages.                                                |
| **Receipt Verification Certificate**  | The public key certificate to use when verifying digital signatures on incoming receipts.                                                |
| **Rollover Certificate**              | An additional certificate to use for authentication. This is useful when you need an overlap period while changing certificates.         |
| **Rollover Verification Certificate** | An additional certificate to use for signature verification. This is useful when you need an overlap period while changing certificates. |

#### Alternate Local Profile

*Settings that override the OFTP configuration on the Profile page. Setting an alternate local profile allows the use of different local certificates and identifiers for certain trading partners.*

| Setting                  | Description                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **SSID**                 | Your Odette identifier. This overrides the **Odette Identifier** on the Profiles tab. When set, the OFTP server uses the alternate SSID and password for this partner. When sending, this ID is used as the file sender and for session authentication, unless it is overridden by the relaying partner. If **SSID** and **SFID** are both set, the **SFID** is used when sending the file. |
| **Password**             | The local identifier password.                                                                                                                                                                                                                                                                                                                                                              |
| **SFID**                 | When accepting incoming OFTP files, {siteName} processes messages in this connector as if they were relayed from the local OFTP profile. Unless this value is set, incoming network connections are greeted with the SSID and password from the OFTP profile. If **SSID** and **SFID** are both set, the **SFID** is used when sending the file.                                            |
| **Private Certificate**  | The certificate used to decrypt incoming messages and sign outgoing messages. This overrides the **Data Decryption Certificate** setting on the Profiles page.                                                                                                                                                                                                                              |
| **Certificate Password** | The password required to access the local private certificate.                                                                                                                                                                                                                                                                                                                              |

#### TLS Client Authentication

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

| Setting                  | Description                                                         |
| ------------------------ | ------------------------------------------------------------------- |
| **Use Profile Settings** | Use the private certificate on the Profiles page.                   |
| **Private Certificate**  | The private certificate presented during TLS client authentication. |
| **Certificate Password** | The password required to access the TLS client certificate.         |

#### Automatic Certificate Identification

The fields in this section let you specify patterns that allow the connector to automatically identify certificates. The default wildcard character in each field (\*) instructs the connector to not search for each pattern.

#### Advanced Settings

*Settings not included in the previous categories.*

| Setting                      | Description                                                                                                                                                                                                                                                                              |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Credit Count**             | The maximum credit value to be sent in the initial connection (SSID command).                                                                                                                                                                                                            |
| **Encryption Algorithm**     | The algorithm to use when encrypting outgoing messages.                                                                                                                                                                                                                                  |
| **Exchange Buffer Size**     | The data exchange buffer size, in bytes, to be sent in the initial connection (SSID command).                                                                                                                                                                                            |
| **Enforce Protocol Version** | Whether to accept protocol versions not configured for this partner.                                                                                                                                                                                                                     |
| **File Description Map**     | The map to set file description text for sending files. Use a semi-colon-delimited list of glob patterns for matching filenames. For example, `INVOICE*=This is an invoice;*ORDER*=This is an order`.                                                                                    |
| **Max Record Size**          | When the virtual file format is Fixed or Variable, this field determines the maximum size of each record. The default record size is 128.                                                                                                                                                |
| **File Hash Algorithm**      | The file hash algorithm to use.                                                                                                                                                                                                                                                          |
| **Receipt Hash Algorithm**   | The receipt hash algorithm to use.                                                                                                                                                                                                                                                       |
| **Received Filename Format** | Incoming files are written to the **Transactions** tab using this filename convention. You can use the following macros to ensure that unique filenames are generated: %VirtualFilename%, %VirtualFileDate%, %GUID%.                                                                     |
| **TLS Enabled Protocols**    | The list of TLS/SSL protocols supported when establishing outgoing connections. Best practice is to only use TLS protocols. Some obsolete operating systems do not support TLS 1.2.                                                                                                      |
| **Virtual Filename Map**     | The map from local filenames to outgoing virtual filenames to use when sending files. Use a semi-colon-delimited list of glob patterns for matching filenames. For example, `INVOICE*=filename1;*ORDER*=filename2`.                                                                      |
| **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).                                                  |
| **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                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Send Automation**       | Whether files arriving at the connector are automatically sent as OFTP messages.                                                                                                                                                                                                                                                                                                                                |
| **Retry Interval**        | The number of minutes before a failed send is retried. A retry is triggered when the server does not respond to a send attempt, or responds negatively to communicate that the file was not received.                                                                                                                                                                                                           |
| **Max Attempts**          | The maximum number of times the connector processes the input file. Success is based on a successful server acknowledgement and validation of the receipt (when requested synchronously). If you set this to 0, the connector 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 time frame.                                                                                                                                                                                                       |
| **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 make pull requests to receive messages from the trading partner.                                                                                                                                                                                                                                                                                                     |
| **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

The following settings are required to establish an outgoing OFTP connection:

* Identifier (the trading partner's identifier)
* Password (the password associated with the trading partner's identifier)
* Remote Host
* Port

After establishing a connection, the appropriate trading partner certificates must be configured before files can be securely transferred.

## Send and Receive Files

Once the OFTP profile and partner-specific OFTP connectors have been configured, files can be securely sent and received.

### Send Files

In an OFTP connector, the **Transactions** tab displays the files to be sent to the target trading partner. If **Send Automation** is enabled on the [Automation](#automation-tab) tab, files that reach the Transactions tab of the connector are automatically packaged and sent. Access the log files for all transmissions by expanding the row associated with the transmitted file.

The **Create Test Files** button lets you generate a simple series of test files to send to the trading partner.

### Resend and Retry

An OFTP Resend is triggered when the trading partner is expected to return an asynchronous receipt, but fails to do so within the **Resend Interval** duration (60 minutes by default). The application then attempts to resend the transmission. The application continues resending the message until a receipt is received or the **Max Attempts (async)** is exhausted.

A Retry is triggered when the protocol response from the trading partner's system indicates that the server has not received the transmission. This can indicate a networking or connectivity issue, which is often transient. The application retries the transmission every **Retry Interval** minutes until the transmission is received or the **Max Attempts** is exhausted.

### Receive Files

In an OFTP connector, the **Transactions** tab displays the files that have been received by the application and routed to the connector. Files are routed to a specific OFTP connector based on the Odette identifier present in the incoming OFTP message. Expand each file row to display a list of available logs for the transmission.

These files are available on the connector **Transactions** tab. If the connector is connected to other connectors in the flow, files are automatically moved from the **Transactions** tab of the OFTP connector to the **Transactions** tab of the next connector in the flow.

## Message Routing

Each OFTP connector is configured to connect to a single OFTP entity. Sometimes using OFTP requires a routing scenario where a file originating at one OFTP entity (agent `A` in the image below) needs to pass through another OFTP entity (agent `B`) to reach the destination OFTP entity (agent `C`).

<img src="https://mintcdn.com/cdata-arc/AKthyJ-LnqphL8js/public/images/oftp-relaying.png?fit=max&auto=format&n=AKthyJ-LnqphL8js&q=85&s=8f0ba4efe21c6c0533245e3be3f17fc8" alt="OFTP Routing" width="574" height="354" data-path="public/images/oftp-relaying.png" />

In this scenario, the Odette identifier of agent `B` is the SSID value during the transfer, and the Odette identifier of agent `C` is the SFID. In other words, the SSID identifies the 'middleman' server that the originator connects to, and the SFID identifies the target entity that this 'middleman' should route the OFTP message to.

### OFTP Routing in {siteNameShort}

To accomplish this routing scenario in {siteNameShort}, configure one OFTP connector to connect to agent `B` (the 'middleman' server) and another OFTP connector to connect to agent `C` (the destination server).

Set the **Routing Partner** field (in the [Routing](#routing) portion of the **Settings** tab) for the agent `C` connector to the OFTP connector that is configured to connect to agent `B`.

Files to send out to the destination server should be processed by the OFTP connector configured to connect to agent `C`. The other OFTP connector (targeting agent `B`) is used behind-the-scenes to route the message, but does not directly process files in the Flow.

### SSID vs SFID

If a partner provides a single identifier that they call an SFID, configure an OFTP connector to connect with this entity, and use the SFID as the SSID. If the partner provides an SFID value and an SSID value, the SFID corresponds to server `C` in the above scenario, and the SSID corresponds to server `B`.

## Macros

<MacrosTable />

### Examples

<MacrosExamples />