Top
Systemwalker Runbook Automation Studio User's Guide
Systemwalker

C.4 File Listener File (fileListenerConf.xml)

A file listener monitors the files in a specified directory. When a file handler detects a new or modified file, it notifies the Systemwalker Runbook Automation file handler so that automatic functions (such as starting a process instance or selecting an activity) can be executed. A file listener is generally used to integrate Systemwalker Runbook Automation with other enterprise applications.

Create process definitions and add to the file listener the triggers that start process instances. Create a trigger event data file (XML file) and save it to the filelistener directory.

File format

The file name is <DMSRoot>/apps/<application ID>/fileListenerConf.xml.

A sample file is displayed below:

<FileListener>
   <Directory> 
      <ScanInterval>60000</ScanInterval>
      <StabilizationPeriod>2000</StabilizationPeriod>
      <PostProcessing>
         <onSuccess>
            <Delete></Delete>
         </onSuccess>
               <onError>
            <Move>
            </Move>
         </onError>
      </PostProcessing>
   </Directory>
</FileListener>

The table below describes the tags:

Item

Description

<Directory>

Configuration of the directory that monitors new and modified files.

<Path>

Path of the directory that monitors files.
In SaaS mode or non-SaaS mode, if the path is not specified, then <ServerSharedRoot>/tenants/<tenant name>/apps/<application ID>/filelistener is used.

<ScanInterval>

Number of milliseconds between each check for new files in the directory.

<StabilizationPeriod>

This setting is for monitoring file sizes to check for changes before a file is processed (the unit is milliseconds).

<PostProcessing><onSuccess>

Action to take when a file process succeeds. Possible values are: "<Delete>" and "<Move>".

<PostProcessing><onError>

Action to take when a file process fails. Possible values are "<Delete>" and "<Move>".

<Delete>

Determines that the file will be deleted.

<Move>

Determines that the file will be moved to the specified directory.

On success:

  • In non-SaaS mode, the file is moved to the specified directory.

  • If the path is not specified in SaaS mode or in non-SaaS mode, the file is moved to <ServerSharedRoot>/tenants/<tenant name>/apps/<application ID>/filelistener/success.

On error:

  • In non-SaaS mode, the file is moved to the specified directory.

  • If the path is not specified in SaaS mode or in non-SaaS mode, the file is moved to <ServerSharedRoot>/tenants/<tenant name>/apps/<application ID>/filelistener/error.