AI Connector

AI connectors are designed to connect to a number of AI models that expose a REST API. The supported list is below.

Key Capabilities

Multi-provider AI integration
Flexible prompt engineering
Customizable AI model selection
Structured output control
Intelligent content processing

Overview

The CData Arc 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 ArcScript-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. 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 ArcScript. 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:

<BEGIN FILE>
[_message.body]
<END FILE>

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 ArcScript. The way in which you test your configuration and prompts varies by the connector’s action type:

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.

Advanced Tab

Other Settings

Setting	Description
Timeout	The AI response timeout, in seconds. By default, this value is set to 60 seconds.

Proxy Settings

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

Setting	Description
Proxy Type	The protocol used by a proxy-based firewall.
Proxy Host	The name or IP address of a proxy-based firewall.
Proxy Port	The TCP port for a proxy-based firewall.
Proxy User	The user name to use to authenticate with a proxy-based firewall.
Proxy Password	A password used to authenticate to a proxy-based firewall.
Authentication Scheme	Leave the default None or choose from one of the following authentication schemes: Basic, Digest, Proprietary, or NTLM.

Message

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

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

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

Logging

Settings that govern the creation and storage of logs.

Setting	Description
Log Level	The verbosity of logs generated by the connector. When you request support, set this to Debug.
Log Subfolder Scheme	Instructs the connector to group files in the Logs folder according to the selected interval. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
Log Messages	Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Transactions tab.

Miscellaneous

Miscellaneous settings are for specific use cases.

Setting	Description
Other Settings	Enables you to configure hidden connector settings in a semicolon-separated list (for example, `setting1=value1;setting2=value2`). Normal connector use cases and functionality should not require the use of these settings.

Automation Tab

Automation Settings

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

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.
Start Date and Time	The date and time at which the automation first runs. Every run after that follows the interval setting above. The last and next run times appear in the Automation Status section.

Automation Status

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:

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.

Getting Started

Flows

EDI Trading Partner Management Console

Connectors

Mapping

APIs and Automation

How-To Guides

Scripting

Software License and Third-Party Copyrights

Key Capabilities

Overview

Actions

Connector Configuration

AI Config Tab

Settings Tab

Configuration

Advanced Settings

Advanced Tab

Other Settings

Proxy Settings

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Automation Status

Alerts Tab

SLAs Tab

Transactions Tab

Macros

Examples

​Key Capabilities

​Overview

​Actions

​Connector Configuration

​AI Config Tab

​Settings Tab

​Configuration

​Advanced Settings

​Advanced Tab

​Other Settings

​Proxy Settings

​Message

​Logging

​Miscellaneous

​Automation Tab

​Automation Settings

​Automation Status

​Alerts Tab

​SLAs Tab

​Transactions Tab

​Macros

​Examples

Key Capabilities

Overview

Actions

Connector Configuration

AI Config Tab

Settings Tab

Configuration

Advanced Settings

Advanced Tab

Other Settings

Proxy Settings

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Automation Status

Alerts Tab

SLAs Tab

Transactions Tab

Macros

Examples