Manage listeners

The Listeners list is the first panel displayed when you select the Listeners tab. This panel displays the list of file and time listeners.

You can:

Any changes performed on a listener are automatically notified to the event processor that is using them.

Display listener information

  1. In the Listener list, click on the corresponding Id cell of a listener.
  2. The listener data information is displayed in a form according to the listener type: file or time listener.
    • Time listener
    • Property Description
      Component The component name
      Identifier The globally unique identifier of the listener
      Interaction The name of the interaction
      Flow The name of the flow. It must be a valid Java identifier.
      Active

      Activate or deactivate the listener.

      The listener triggers time events only when it is activated.

      Schedule A valid CRON expression used by time listeners to know when to trigger time events. Refer to Cron expressions
      User ID User ID used for authorization for Event Processor operations.
      User Domain User Domain used for authorization for Event Processor operations.
    • File listener
    • Property Description
      Component The component name
      Identifier The globally unique identifier of the listener
      Interaction The name of the interaction
      Flow The name of the flow. It must be a valid Java identifier.
      Active

      Activate or deactivate the listener.

      The listener triggers file events only when it is activated.

      Details  
      Folder The folder path where the listener will be searching for files. For example, D:/scanFolder
      Work Folder The folder name, relative to the Folder parameter, where the listener is moving the files it is working on. You can specify also an absolute path. For example, if you specify the value 'work' then the used folder will be D:/scanFolder/work
      Custom property file The event property file pattern key. This field must contain a value from the file patterns keys list other than dataFile, propertyFile or errorFile.
      Collection type name The collection type name used to import a file.
      Collection type version Version of the collection type
      User ID User ID used for authorization in event processor operations.
      User Domain User Domain used for authorization in event processor operations.
      File Patterns The list of file patterns that helps the listener to identify each group of files. To define a file pattern you specify:
      Key

      The logical name of the file pattern. Predefined keys:

      • dataFile – used for data file
      • propertyFile – used for property file
      • errorFile – used for error file
      Pattern

      The pattern expression used to identify a file from the Folder.
      For example, data_*.txt, error_*.txt, property_*.txt

      The patterns must be consistent: each pattern should have the same number of ‘*’ characters.
      For example, data_*.dat and error_*_file*.err are not consistent.

  3. You can now:
    • Edit this listener.
    • Remove this listener
    • Return to the list of listeners by clicking the Listeners tab.

Edit listener information

  1. Select a listener in the list and click on the corresponding Id cell.
  2. The listener data information is displayed in a form according to the listener type: file or time listener.
    • Time listener
    • Property Description
      Component The component name
      Identifier The globally unique identifier of the listener.
      Interaction The name of the interaction
      Flow The name of the flow. It must be a valid Java identifier.
      Active

      Activate or deactivate the listener.

      The listener triggers time events only when it is activated.

      Schedule

      A valid CRON expression used by time listeners to know when to trigger time events.

      For example, 0 0 12 * * ?

      User ID User ID used for authorization for Event Processor operations.
      User Domain User Domain used for authorization for Event Processor operations.
    • File listener
    • Property Description
      Component The component name
      Identifier The globally unique identifier of the listener
      Interaction The name of the interaction
      Flow The name of the flow. It must be a valid Java identifier.
      Active

      Activate or deactivate the listener.

      The listener triggers file events only when it is activated.

      Details  
      Folder The folder path where the listener will be searching for files For example, D:/scanFolder
      Work Folder The folder name, relative to the Folder parameter, where the listener is moving the files it is working on. You can specify also an absolute path. For example, if you specify the value 'work' then the used folder will be D:/scanFolder/work
      Custom property file The event property file pattern key. This field must contain a value from the file patterns keys list other than dataFile, propertyFile or errorFile.
      Collection type name The collection type name used to import a file.
      Collection type version Version of the collection type
      User ID User ID used for authorization in event processor operations
      User Domain User Domain used for authorization in event processor operations
      File Patterns The list of file patterns that helps the listener to identify each group of files. To define a file pattern you specify:
      Key

      The logical name of the file pattern. Predefined keys:

      • dataFile – used for data file
      • propertyFile – used for property file
      • errorFile – used for error file
      Pattern

      The pattern expression used to identify a file from the Folder.
      For example, data_*.txt, error_*.txt, property_*.txt

      The patterns must be consistent: each pattern should have the same number of ‘*’ characters.
      For example, data_*.dat and error_*_file*.err are not consistent.

  3. Modify listener parameters as needed.
  4. Save your changes.
  5. The listener data information is displayed.

Create a new listener

  1. From the Listener list, click Add Time Listener to a add a new time listener or click Add File Listener to add a new file listener.
  2. Depending on the listener type, a default value is generated for the Identifier field.
  3. Complete the listener fields.
  4. Save your changes.
  5. You are redirected to the Listener list page.

Duplicate a listener

  1. Select a listener and click Duplicate
  2. The listener data information is displayed in an edition form according to the duplicated listener type: file or time listener.
  3. The Identifier field value is automatically updated.
  4. Modify listener parameters as needed.
  5. Save your changes.
  6. You are redirected to the Listener list page.

Remove a listener

  1. Select one or more listeners in the list and click Remove.
  2. Confirm your action.
  3. You are redirected to the Listener list page.

Related Links