> ## 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.
# AI Connector
> Connect to AI models via a REST API to process messages using configurable prompts and generate structured outputs within your data flows.
export const CommonActionType = ({resource = "script"}) => <>
このコネクタは、3 つのコネクタアクションタイプのいずれも実行できます。
• Trigger は、スケジュールに基づいて{resource}を実行し、フローに送信するファイルを生成する場合があります。このアクションはフローの起点として機能します。
• Transform は、フローからのメッセージを{resource}への入力として受け取り、出力を生成します。このアクションはフローの中間として機能します。
• Terminal は、フローからのメッセージを{resource}への入力として受け取り、フローの終端として機能します。
;
export const SlasTab = ({siteName = "CData Arc"}) => <>
サービスレベルアグリーメント（SLA）の設定に関する設定です。
SLA を使用すると、フロー内のコネクタが送受信すると見込まれるボリュームを設定し、そのボリュームを達成すると見込まれる期間を設定できます。{siteName} は、SLA が達成されない場合にユーザーへ警告するメールを送信し、SLA をAt Risk としてマークします。これは、SLA が間もなく達成されない場合にViolated としてマークされることを意味します。これにより、ユーザーは介入してSLA が達成されない理由を特定し、適切な対応を取る機会を得られます。At Risk 期間の終了時点でもSLA が達成されない場合、SLA はviolated としてマークされ、ユーザーに再度通知されます。
SLA を定義するには、Expected Volume をオンに切り替え、Settings タブをクリックします。
- コネクタに送信と受信の個別のアクションがある場合は、ラジオボタンを使用してSLA がどちらの方向に適用されるかを指定します。
- ウィンドウのExpect at least 部分で、次を設定します。
- 処理を見込む最小トランザクション数（ボリューム）を設定します。
- Every フィールドを使用して期間を指定します。
- SLA を有効にするタイミングを指定します。Starting on を選択した場合は、日付および時刻フィールドを入力します。
- SLA を有効にしたい曜日のチェックボックスをオンにします。必要に応じて、ドロップダウンでEveryday を選択します。
- ウィンドウのSet status to 'At Risk' 部分で、SLA をAt Risk としてマークするタイミングを指定します。
- デフォルトでは、SLA が違反状態になるまで通知は送信されません。これを変更するには、Send an 'At Risk' notification をオンにします。
次の例は、月曜日から金曜日まで毎日1000 件のファイルを受信すると見込むコネクタ向けに設定されたSLA を示しています。1000 件のファイルが受信されていない場合、期間の終了の1時間前にAt Risk 通知が送信されます。
必要に応じてSLA アラートをオフにすることができます。これはメンテナンスウィンドウ中に役立ちます。navbar でSettings をクリックし、Alerts > General Alerts に移動します。タブレットと鉛筆のアイコンをクリックして編集し、SLA Alerts 設定のチェックを外します。
;
export const AlertsTab = ({siteNameShort = "Arc"}) => <>
アラートの設定に関する設定です。
サービスレベルアグリーメント（SLA）を実行する前に、通知用のメールアラートをセットアップする必要があります。デフォルトでは、{siteNameShort} はAlerts タブのグローバル設定を使用します。このコネクタに別の設定を使用するには、Override global setting をオンに切り替えます。
デフォルトではエラーアラートが有効になっており、エラーが発生するたびにメールが送信されます。これをオフにするには、Enable チェックボックスのチェックを外します。
Subject（必須）を入力し、必要に応じてRecipient のメールアドレスをカンマ区切りのリストで入力します。
;
export const CommonProxySettings = () => <>
これらは、接続のルーティング先となるプロキシを識別し認証するための一連の設定です。デフォルトでは、このセクションはSecurity Settings ページのProxy Settings 部分にあるグローバル設定を使用します。チェックボックスをオフにすると、コネクタ固有の設定を指定できます。
| 設定 | 説明 |
|---|
| Proxy Type |
プロキシベースのファイアウォールで使用されるプロトコル。 |
| Proxy Host |
プロキシベースのファイアウォールの名前またはIP アドレス。 |
| Proxy Port |
プロキシベースのファイアウォールのTCP ポート。 |
| Proxy User |
プロキシベースのファイアウォールで認証するために使用するユーザー名。 |
| Proxy Password |
プロキシベースのファイアウォールで認証するために使用するパスワード。 |
| Authentication Scheme |
デフォルトのNone のままにするか、次の認証スキームのいずれかを選択します：Basic、Digest、Proprietary、またはNTLM。 |
;
export const Message = () => <>
Message 設定は、コネクタがメッセージを検索する方法と、処理後にメッセージを管理する方法を決定します。
| 設定 | 説明 |
|---|
| Save to Sent Folder |
コネクタが処理したファイルをコネクタのSent フォルダにコピーするには、これをオンにします。 |
| Sent Folder Scheme |
選択した間隔に従って、コネクタがSent フォルダ内のファイルをグループ化するよう指示します。例えば、Weekly オプションは、コネクタが毎週新しいサブフォルダを作成し、その週のすべての送信済みファイルをそのフォルダに保存するよう指示します。空白の設定は、コネクタがすべてのファイルをSent フォルダに直接保存するよう指示します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでファイルを整理しやすくなり、パフォーマンスを向上できます。 |
;
export const MiscConnector = () => <>
Miscellaneous 設定は、特定のユースケース向けの設定です。
| 設定 |
説明 |
| Other Settings |
非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：setting1=value1;setting2=value2）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。 |
;
export const Logging = () => <>
ログの作成と保存を制御する設定です。
| 設定 |
説明 |
| Log Level |
コネクタが生成するログの詳細度です。サポートを依頼する際は、これをDebug に設定してください。 |
| Log Subfolder Scheme |
選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。Weekly オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。 |
| Log Messages |
処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、Transactions タブからファイルのコピーをダウンロードできなくなる場合があります。 |
;
export const MacrosExamples = ({extraMacros = []}) => <>
%Ext% や %ShortDate% などの一部のマクロは引数を必要としませんが、引数を必要とするものもあります。
引数を取るすべてのマクロは次の構文を使用します。%Macro:argument%
引数を取るマクロの例を次に示します。
- %Header:headername%：
headername はメッセージ上のヘッダーの名前です。
- %Header:mycustomheader% は、入力メッセージに設定された
mycustomheader ヘッダーの値に解決されます。
- %Header:ponum% は、入力メッセージに設定された
ponum ヘッダーの値に解決されます。
- %RegexFilename:pattern%：
pattern は正規表現パターンです。例えば、%RegexFilename:^([\w][A-Za-z]+)% は、ファイル名の最初の単語にマッチしてそれに解決され、大文字・小文字を区別しません（test_file.xml はtest に解決されます）。
- %Vault:vaultitem%：
vaultitem はVault 内のアイテムの名前です。例えば、%Vault:companyname% は、Vault に保存されたcompanyname アイテムの値に解決されます。
- %DateFormat:format%：
format は許容される日付形式です（詳細は日付形式のサンプルを参照してください）。例えば、%DateFormat:yyyy-MM-dd-HH-mm-ss-fff% は、ファイルの日付とタイムスタンプに解決されます。
{extraMacros.filter(item => item.example).map(item => - {item.example}
)}
次の例に示すように、より高度なマクロを作成することもできます。
- 1 つのファイル名で複数のマクロを組み合わせる：
%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
- マクロの外側にテキストを含める：
MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
- マクロの内側にテキストを含める：
%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%
;
export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
ファイル命名戦略でマクロを使用すると、データの整理効率と文脈の理解を高めることができます。
ファイル名にマクロを組み込むことで、識別子、タイムスタンプ、ヘッダー情報などの関連情報を
動的に含めることができ、各ファイルに有用な文脈を提供します。
{siteName} は次のマクロをサポートしています。これらはすべて次の構文を使用します。%Macro%
| マクロ | 説明 |
|---|
| ConnectorID | コネクタのConnectorID に評価されます。 |
| Ext | コネクタが現在処理しているファイルの拡張子に評価されます。 |
| Filename | コネクタが現在処理しているファイルのファイル名（拡張子を含む）に評価されます。 |
| FilenameNoExt | コネクタが現在処理しているファイルのファイル名（拡張子を除く）に評価されます。 |
| MessageId | コネクタが出力しているメッセージのMessageId に評価されます。 |
| RegexFilename:pattern | コネクタが現在処理しているファイルのファイル名に正規表現パターンを適用します。 |
| Header:headername | コネクタが現在処理しているメッセージ上の対象ヘッダー（headername）の値に評価されます。 |
| LongDate | システムの現在の日時を長い形式（例：Wednesday, January 24, 2024）で評価します。 |
| ShortDate | システムの現在の日時をyyyy-MM-dd 形式（例：2024-01-24）で評価します。 |
| DateFormat:format | システムの現在の日時を指定された形式（format）で評価します。利用可能な日時形式については、日付形式のサンプルを参照してください。 |
| Vault:vaultitem | 指定されたVault アイテムの値に評価されます。 |
{extraMacros.map(item =>
| {item.name} |
{item.description} |
)}
;
export const siteNameShort = "Arc";
export const siteName = "CData Arc";
AI connectors are designed to connect to a number of AI models that expose a REST API. The supported list is [below](./ai#ai-config-tab).
## Key Capabilities
* Multi-provider AI integration
* Flexible prompt engineering
* Customizable AI model selection
* Structured output control
* Intelligent content processing
## Overview
The {siteName} AI connector is a flexible integration tool that connects to any AI model via REST APIs, enabling you to process input messages using configurable system and user prompts to generate structured outputs within your data flows. It supports popular AI services like OpenAI, Gemini, Ollama, and other OpenAI-compatible providers, with full control over API endpoints, models, and parameters. With {siteNameShort}Script-enabled prompts and customizable output formats, the connector enables use cases such as extracting insights from unstructured feedback, translating content across languages, and transforming text data into actionable structured information.
### Actions
## Connector Configuration
This section contains all of the configurable connector properties.
### AI Config Tab
If you have not already configured the global AI settings at **Settings > Advanced > AI Settings**, the **AI Config** tab displays a message that you must do this before you can use the connector. Click the **Configure AI Settings** button, and follow the instructions in [AI Settings](../getting-started/administration/settings/ai-settings). If the global settings have already been configured but you want to override them in this connector, click **Edit**. To override the global settings, toggle on **Override global setting**. Now you can select which AI provider you want to use, enter the appropriate connection details and then save the configuration. The connector supports the following providers:
* Claude
* Deepseek
* Gemini
* Grok
* Ollama (cloud and local)
* OpenAI
* OpenAI Compatible (any AI provider that implements OpenAI's API)
Use the **Edit AI Settings** pane to define the **Base URL** (only available when the provider is **Ollama** or **OpenAI Compatible**), add the provider's **API Key**, and select a **Model**.
To populate the **User Prompt** field, you can click **Suggested Prompts** to see a set of predefined prompts for a variety of use cases, or you can enter your own prompt directly into the field. This is where you define the task or request that you want the connector to perform when it receives a file. For example, you could enter something like *Summarize the inbound EDI X12 file using natural language* so that employees who are not familiar with the EDI X12 structure can read the summary and understand what information the document contains. This field supports {siteNameShort}Script.
You can also choose to **Attach input messages to requests**. This is especially useful when you are providing binary files (such as a PDF or image) to the AI provider.
To include non-binary files in the request, you need to use \_message.body in your prompt, like this:
```
[_message.body]
```
See the Summarize option in the Suggested Prompts dropdown for a complete example.
Toggle **System Prompt** to provide a set of specific instructions, constraints, languages, or roles that the AI provider should use when providing its response. For example: *Do not use any em dashes or emojis in your response.* This field also supports {siteNameShort}Script.
The way in which you test your configuration and prompts varies by the connector's [action type](#actions):
* If your connector is a trigger, click the **Test** button.
* If your connector is a transform or terminal, on the **Testing** tab, paste content into the **Input Body** or use the dropdown to add **Headers** and values, then click the **Test** button.
In both cases, the test results appear in the **Testing** tab. Logs from the test are displayed in the **Log** tab.
### Settings Tab
*Settings related to the core configuration of the connector.*
#### Configuration
| 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. |
| **Action** | The action this connector is performing: trigger, transform, or terminal. |
| **Output in JSON** | If your model supports structured outputs, check this to deliver the connector output in JSON format. This is useful when you want to ensure the AI output is structured and machine-readable, so it is easier to parse, extract data, or use in downstream connectors and processes. |
#### Advanced Settings
| Setting | Description |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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). |
### Advanced Tab
#### Other Settings
| Setting | Description |
| ----------- | --------------------------------------------------------------------------------- |
| **Timeout** | The AI response timeout, in seconds. By default, this value is set to 60 seconds. |
#### Proxy Settings
#### Message
#### Logging
#### Miscellaneous
### Automation Tab
#### Automation Settings
*Settings related to the automatic processing of files by the connector.*
| Setting | Description |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Send** | Whether files arriving at the connector are automatically uploaded. |
| **Retry Interval** | The amount of time before a failed upload is retried. |
| **Max Attempts** | The maximum number of times the connector processes the input file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely. |
| **Receive** | Whether the connector should automatically poll the remote download path for files to download. |
| **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*. |
### Alerts Tab
### SLAs Tab
### Transactions Tab
This tab lists all messages associated with the connector. Use the search bar to find specific messages, or click the funnel icon to apply a filter. You can filter by time, message direction, and/or status.
Options on this tab vary depending on the connector's [action type](#actions):
* If your connector is a **Trigger**, use the **Receive Files** button to start the flow.
* If your connector is a **Transform** or **Terminal**, use the **Upload Files** button to upload files to the flow.
## Macros
### Examples