Jump to: navigation, search

Interaction Server

This document provides information about the configuration options that you set on the Interaction Server application object, as well as those you set on other related objects, such as database access points (DAPs).


Important
Additional Interaction Server options can be configured on the Annex tab of any Business Process Interaction Queue or Interaction Queue View object (in the Resources > Scripts folder). Refer to the "Creating Business Process Objects" chapter of the Universal Routing Business Process User’s Guide for more information.

For options that are set on the Interaction Server object itself, each section has its own page. For options that are set on other objects, each object has a page, which may include multiple sections.

Interaction Server application

Options for this component are contained in the following configuration sections:

Tip
In the summary table(s) below, type in the Search box to quickly find options, configuration sections, or other values, and/or click a column name to sort the table. Click an option name to link to a full description of the option. Be aware that the default and valid values are the values in effect with the latest release of the software and may have changed since the release you have; refer to the full description of the option to see information for earlier releases.


Power users: Download a CSV file containing default and valid values and descriptions.

The following options are configured at the application level (in other words, on the application object).

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
agent-reservation reject-subsequent-request true Immediately
agent-reservation request-collection-time 100 Immediately
agent-reservation reservation-time 10000 Immediately
cluster-settings enable-submit true Immediately
cluster-settings media-types Immediately
health-service enable-keepalive false After restart
health-service log-output-timeout 0 Immediately (after current interval)
health-service soap-accept-timeout 10 After restart
health-service soap-endpoint http://{ServerName}:{ServerPort}/health After restart
health-service soap-hostname After restart
Showing 1 to 10 of 123 entries


Database Access Points (DAPs)

Interaction Server uses the following DAPs to connect to various databases for a number of purposes:

Interaction Server DAP

The following options are configured on the Interaction Server DAP.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
settings blob-chunk-size 1024 After restart of Interaction Server
settings connection-string No default value After restart of Interaction Server
settings connections 5 After restart of Interaction Server
settings dbprotocol odbc After restart of Interaction Server
settings odbc-string No default value After restart of Interaction Server
settings queue-size 20000 Immediately
Showing 1 to 6 of 6 entries


Event Logger DAP

The following options are configured on the Event Logger DAP.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
agent-custom-data <custom event content attribute name> No default value After restart of Interaction Server
custom-custom-data <custom event content attribute name> No default value After restart of Interaction Server
event-filtering event-filter-by-id No default value Immediately
event-filtering log-agent-activity true Immediately
event-filtering log-agent-state Immediately
event-filtering log-esp-service true Immediately
event-filtering log-queue true Immediately
event-filtering log-strategy true Immediately
event-filtering log-userdata true Immediately
logger-settings batch-size 500 Immediately
Showing 1 to 10 of 17 entries


MSMQ-MQSeries Event Logger DAP

The following options are configured on the MSMQ-MQSeries Event Logger DAP.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
event-filtering event-filter-by-id No default value Immediately
logger-settings delivery-protocol eventlog After restart
logger-settings delivery-queue-manager-name No default value After restart
logger-settings delivery-queue-name No default value After restart
logger-settings udata No default value Immediately
Showing 1 to 5 of 5 entries


JMS Event Logger DAP

The following options are configured on the JMS Event Logger DAP.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
event-filtering event-filter-by-id No default value Immediately
Showing 1 to 1 of 1 entries


Integrated Capture Points

Interaction Server supports the following integrated capture points to interact with external source systems:

Database Capture Point

The following options are configured on the Database Capture Point.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
db-queries assignedUpdateSql Upon restart
db-queries canceledUpdateSql Upon restart
db-queries capturedUpdateSql Upon restart
db-queries captureQuerySql Upon restart
db-queries completedUpdateSql Upon restart
db-queries errorHeldUpdateSql Upon restart
db-queries errorUpdateSql Upon restart
db-queries heldUpdateSql Upon restart
db-queries queuedUpdateSql Upon restart
db-queries rejectedUpdateSql Upon restart
Showing 1 to 10 of 53 entries


File Capture Point

The following options are configured on the File Capture Point.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
default-values InteractionSubtype InboundNew Upon restart
default-values InteractionType Inbound Upon restart
default-values MediaType workitem Upon restart
inbound-transformer-parameters AllowAnyAttributes false Upon restart
inbound-transformer-parameters CancelQueues iWD_Canceled Upon restart
inbound-transformer-parameters CaseSensitiveActions false Upon restart
inbound-transformer-parameters CaseSensitiveAttributes false Upon restart
inbound-transformer-parameters CompleteQueues iWD_Completed Upon restart
inbound-transformer-parameters ExtendedAttributes Upon restart
inbound-transformer-parameters RestartQueues iWD_New Upon restart
Showing 1 to 10 of 47 entries


JMS Capture Point

The following options are configured on the JMS Capture Point.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
default-values InteractionSubtype InboundNew Upon restart
default-values InteractionType Inbound Upon restart
default-values MediaType workitem Upon restart
inbound-transformer-parameters AllowAnyAttributes false Upon restart
inbound-transformer-parameters CancelQueues iWD_Canceled Upon restart
inbound-transformer-parameters CaseSensitiveActions false Upon restart
inbound-transformer-parameters CaseSensitiveAttributes false Upon restart
inbound-transformer-parameters CompleteQueues iWD_Completed Upon restart
inbound-transformer-parameters ExtendedAttributes Upon restart
inbound-transformer-parameters RestartQueues iWD_New Upon restart
Showing 1 to 10 of 51 entries



Kafka Capture Point

The following options are configured on the Kafka Capture Point.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
consumer-options auto.offset.reset earliest Upon restart
consumer-options max.poll.interval.ms 600000 Upon restart
consumer-options max.poll.records 20 Upon restart
custom-options-provider class-name Upon restart
default-values InteractionSubtype InboundNew Upon restart
default-values InteractionType Inbound Upon restart
default-values MediaType workitem Upon restart
inbound-transformer-parameters AllowAnyAttributes false Upon restart
inbound-transformer-parameters CancelQueues iWD_Canceled Upon restart
inbound-transformer-parameters CaseSensitiveActions false Upon restart
Showing 1 to 10 of 51 entries


Web Service Capture Point

The following options are configured on the Web Service Capture Point.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
default-values InteractionSubtype InboundNew Upon restart
default-values InteractionType Inbound Upon restart
default-values MediaType workitem Upon restart
iwd-parameters CancelQueues iWD_Canceled Upon restart
iwd-parameters CompleteQueues iWD_Completed Upon restart
iwd-parameters empty-string-treatment-in-update ignore Upon restart
iwd-parameters ErrorHeldQueues iWD_ErrorHeld Upon restart
iwd-parameters RejectQueues iWD_Completed Upon restart
iwd-parameters RestartQueues iWD_New Upon restart
settings backlog-accepted-requests 1000 Upon restart
Showing 1 to 10 of 28 entries


Universal Routing Server (URS)

The following options are configured on Universal Routing Server (URS).

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
<Interaction-Server> max-submission-rate No default value Immediately
<Interaction-Server> max-submitted-interactions No default value Immediately; but does not affect interactions already submitted to URS
Showing 1 to 2 of 2 entries


workbin Script

The following options are configured on the workbin Script.

SectionOptionDefaultChanges Take Effect
SectionOptionDefaultChanges Take Effect
Workbin max-workbin-interactions 200 Immediately
Showing 1 to 1 of 1 entries
This page was last edited on May 9, 2022, at 06:12.
Comments or questions about this documentation? Contact us for support!