Key Capabilities
- Real-time content adaptation and security scanning
- Support for both request modification (REQMOD) and response modification (RESPMOD) modes
- TLS encryption support for secure communications
- Customizable HTTP encapsulation for legacy system compatibility
- Flexible authentication options including private certificate support
- Functions as a Transform step in the flow. Files that are flagged as needing attention yield errors, while other files proceed down the flow as usual.
Connector Configuration
This section contains all of the configurable connector properties.Settings Tab
Settings related to the core configuration of the connector.| 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. |
| ICAP URI | (Required) The ICAP Uniform Resource Identifier (URI) of the ICAP server to connect to. Must be in this format: icap://<hostname>:<port>/<service_name>. |
| Allow ArcScript in ICAP URI | Allows for the evaluation of ArcScript expressions in the URI. When you select this, the ArcScript Editor button appears ( |
| ICAP Headers | Optional headers for specialized server requirements. Use this to add custom ICAP request headers that you want to include in the outgoing ICAP request. |
| Allow ArcScript in Headers | Allows for the evaluation of ArcScript expressions in the headers before the query is issued. For example, [_ | now('yyyy-MM-dd')] evaluates the current date, and [_message.header:headername] evaluates the headername header from the input message context. |
| TLS Configuration | Check this to enable TLS encryption for the ICAP connection. |
| TLS Server Certificate | The public key certificate used to verify the identity of an TLS/SSL server. This is only necessary if the ICAP server has enabled TLS. Set it to Any Certificate to unconditionally trust the ICAP server’s identity. Only relevant when TLS Configuration is enabled. |
| 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
TLS Client Authentication
Other Settings
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. |
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.Performance
Settings related to the allocation of resources to the connector.
| Setting | Description |
|---|---|
| Max Workers | The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
| Max Files | The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
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. Incoming responses appear on this tab.Events Tab
The following are available in the Response event:
- StatusCode: The ICAP response status code (such as 200, 204, or 4xx)
- _response: The ICAP response. You can use
[_response.header:xxx]to get a specific header. - _message: To refer to the input message (headers and body), and adding headers to the output.