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.
    The listener data information is displayed in a form according to the listener type: file or time listener.
    • Time listener
    • Properties:

      PropertyDescription
      ComponentThe component name
      IdentifierThe globally unique identifier of the listener
      InteractionThe name of the interaction
      FlowThe name of the flow. It must be a valid Java identifier.
      ScheduleA valid CRON expression used by time listeners to know when to trigger time events. Refer to Cron expressions
      User IDUser ID used for authorization for Event Processor operations.
      User DomainUser Domain used for authorization for Event Processor operations.
    • File listener
    • Properties:

      PropertyDescription
      Component The component name
      IdentifierThe globally unique identifier of the listener
      InteractionThe name of the interaction
      FlowThe name of the flow. It must be a valid Java identifier.
      Details 
      FolderThe folder path where the listener will be searching for files Eg.: D:/scanFolder
      Work FolderThe 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. Eg.:If you specify ‘work’ value then the used folder will be ‘D:/scanFolder/work’
      Property fileThe event property file pattern key. It must be defined in the file patterns keys list.
      Collection type nameThe collection type name used to import a file.
      Collection type versionVersion of the collection type
      User IDUser ID used for authorization in event processor operations.
      User DomainUser Domain used for authorization in event processor operations.
      File PatternsThe list of file patterns that helps the listener to identify each group of files. To define a file pattern you specify:
      KeyThe logical name of file pattern. Eg. :dataFile
      PatternThe pattern expression used to identify a file from the Folder. Eg.: data_*.txt
  2. 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.
    The listener data information is displayed in a form according to the listener type: file or time listener.
    • Time listener
    • PropertyDescription
      ComponentThe component name
      Identifier

      The globally unique identifier of the listener.

      InteractionThe name of the interaction
      FlowThe name of the flow. It must be a valid Java identifier.
      Schedule

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

      Eg.: 0 0 12 * * ?

      User IDUser ID used for authorization for Event Processor operations.
      User DomainUser Domain used for authorization for Event Processor operations.
    • File listener
    • PropertyDescription
      ComponentThe component name
      Identifier

      The globally unique identifier of the listener

      InteractionThe name of the interaction
      FlowThe name of the flow. It must be a valid Java identifier.
      Details 
      FolderThe folder path where the listener will be searching for files Eg.: D:/scanFolder
      Work FolderThe 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. Eg.:If you specify ‘work’ value then the used folder will be ‘D:/scanFolder/work’
      Property fileThe event property file pattern key. It must be defined in the file patterns keys list.
      Collection type nameThe collection type name used to import a file.
      Collection type versionVersion of the collection type
      User IDUser ID used for authorization in event processor operations
      User DomainUser Domain used for authorization in event processor operations
      File PatternsThe list of file patterns that helps the listener to identify each group of files. To define a file pattern you specify:
      KeyThe logical name of file pattern. Eg: dataFile, errorFile, propertyFile
      Pattern

      The pattern expression used to identify a file from the Folder.

      Eg.: data_*.txt, error_*.txt, property_*.txt

      The patterns must be consistent: each pattern should have the same number of ‘*’ characters.

      Eg.: data_*.dat and error_*_file*.err are not consistent.

  2. Modify listener parameters as needed
  3. Save your changes.
  4. 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 you 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