Component configuration

In order to trigger actions automatically using the Event Processor, the user needs to configure InterPlay and the other products or components that interact with it using Administration. The configuration is then stored in the registry.

For each component, the user can define:

Event listeners

The Event listeners specify how the incoming events are recognized or generated. The following graphic displays the possible Event listeners:

An Event listener is defined by a map of properties. The following table displays the generic properties for any type of Event listener:

Property Type Size Description
id (*) String 30 Listener identifier
flow String 30

Default flow name for the generated event.

A flow identifies a data exchange between at least two components without transformation of the payload.

interaction String 30 Default interaction name for the generated event. An interaction identifies a set of flows.

(*) mandatory fields

When an Event listener is triggered, it generates an event and sends it to the Event Processor. An event is defined by a map of properties. The following table displays the generic properties set by an Event listener to a generated event:

Property Type Description
type String

Event type.

Possible values:

  • FileEvent for File listener
  • TimeEvent for Time listener
flow String From configuration
interaction String From configuration
externalId String Functional identifier for the event

A set of properties are computed automatically by the system on the event. The following table displays these properties:

Property Type Description
creationDate DateTime Time when the event occurred
componentId String Component identifier
listenerId String Listener identifier from the configuration
interactionId String Identifier of the interaction instance

Time listener

Listener waiting for a given time, one-time or recurrent.

For Time listeners set the following property:

  • Property - schedule (*)
  • Type - String
  • Size - 50
  • Description - Cron expression that creates a timestamp at fixed times, dates or intervals. For information on how to use cron expressions, refer to Cron expressions

(*) mandatory

File listener

Waits for a file. When it gets it, it triggers the event.

The following table display the properties for File listeners:

Property Type Size Description
Folder (*) String 150 Listened folder.
workFolder (*) String 150 Folder where the files are moved after being processed. Its path must be relative to the folder that is listened.
eventProperties String 100

Pattern that matches the file to find.

The file contains custom properties for the event. These properties overwrite the input properties, except for the following read-only properties which cannot be overwritten:

  • type
  • interactionId
  • listenerId
  • creationDate
  • componentId
  • Hidden properties:
    • -errorParameters
    • -flagFile
    • -fileGroupDir
    • -fileGroupFiles

collectionTypeName String 50 Collection Type used to import the file. Used only if the property file is not provided.
collectionTypeVersion Int 4 Version of the collection type.

(*) mandatory fields

A File listener can have a set of file patterns defined to identify the files the File listener is waiting for. The following table displays the properties that define a file pattern:

Property Type Description
dataFile String The path to the data file
errorFile String The path to the error file
propertyFile String The path to the property file
collectionTypeName String The name of the collection type used to import the document
collectionTypeVersion String The version of the collection type used to import the document

REST listener

For REST listeners, the properties found in the URL are added as properties of the event. They overwrite all the other properties.

For information on how to define listeners, see Manage listeners


Resources are logical resources that can be referenced in rules, like folders. A resource is component-specific. Resources can change on the component depending on the environment.

The following table displays the properties for resources:

Property Type Size Description
Id String 30  
filePath String 150  

For information on how to define resources, see Manage resources.


The actions that can be triggered by the Event Processor depend on the components involved. Each Event processor is configured to define the actions to trigger depending on incoming events and action results.

According to the configuration, the possible actions are:

  • Import/export a file.
  • Trigger a transformation.
  • Move a file to a folder.
  • Send an event to another component using a REST call.

Related Links