XML File Capture Point Service

The XML File Capture Point is an iWD service for capturing tasks from XML files. The XML files can be formatted according to the standard iWD XML message schema (described in detail in the Appendix of the iWD 8.0 Deployment Guide), or in a custom XML format.

To handle custom XML formats, two transformation scripts must be created—one for input transformation, and one for output transformation. iWD currently supports the Groovy scripting language for these purposes. For more information on transformation scripts, see the standard iWD input and output transformation scripts that are included in the iWD core package. These transformation scripts are enabled if you import the iwd_transform.xml file into the iWD System or managed tenant. The iwd_transform.xml file is installed when you install the iWD Manager installation package, in the config directory. For example, at C:\Program Files\GCTI\iWD Manager\config.

In addition to the options described in Service Details, the following properties are configurable for the XML File Capture Point:   

startAutomatically

Whether the service should be started automatically after the configuration deployment.

logLevel

The Service log level. This should be set to Default unless otherwise instructed by Genesys Technical Support. See "Service Log Levels" for a description of each log level.  Depending on the setting of this property, additional logging properties might be available. Refer to "Logging Service" for descriptions of these common properties.

checkIfAlreadyCaptured

If true, iWD will verify whether another task that has a given captureId already has been captured.  

timezone

The time zone of the XML File Capture Point. Date/time values are converted from the specified time zone to UTC, before those values are stored in iWD. Also, any date/time values that are included in response XML files are converted to the specified time zone. If this parameter is not specified, it defaults to the tenant time zone.

defaultMediaType

The media type attribute that is assigned to tasks captured by the capture point. The list of available media types is retrieved dynamically from Configuration Server. In Configuration Server itself, the media type attribute is configured as a type of Business Attribute. The default media type used by the capture point may be overwritten if it is specified in the <mediaType> attribute in the <CreateTask> message.

defaultTaskExpirationInDays

The default task expiration date. All tasks that are captured by this capture point will expire after the specified amount of days. This value can be overridden by explicitly specifying the task expirationDateTime attribute in the capture data.

interactionServerConnector

Mandatory dependency: The Interaction Server Connector Service  that should be used for connectivity to Interaction Server.

threads

Performance tuning: The size of the thread pool.

idleSleepTimeSeconds

Service-idle period when there are no more tasks to process.

emergencySleepThreshold

Exception handling: Once distribution attempts fail the specified number of times, processing is held.

emergencySleepSeconds

Exception handling: Specifies how long to hold processing after the emergencySleepThreshold for failed distribution attempts has been reached.

incomingFileDirectory

The directory in which the XML File Capture Point looks for new files to capture.

capturedFileDirectory

The directory into which captured files are placed.

completedFileDirectory

The directory into which completed tasks are exported. Each task is exported to an xml file with the naming convention <interaction id>.xml.

rejectedFileDirectory

The directory into which rejected tasks are exported. Each task is exported to an xml file with the naming convention <interaction id>.xml.

errorFileDirectory

The directory into which files that contain errors are placed.

TransformScriptingService

Optional dependency: Scripting Service. If specified, XML input/output is transformed using input-/output- transformation scripts.

TransformInputScript

The input transformation script; must be specified when TransformScriptingService is selected.

TransformOutputScript

The output transformation script; must be specified when TransformScriptingService is selected.

TransformOutputRootNode

The name of the XML root node in output files.

backupFor

High Availability: The primary XML File Capture Point Service in a high availability setup scenario. This service will perform a backup role in such a setup, and will take over processing if the primary service becomes unavailable.