Version

    Howtos

    Create a file event listener listening to changes on local file system
    Observe file from one Cluster node
    Quickly setup failure notification
    Quickly enable or disable file event listener

    Create a file event listener listening to changes on local file system

    This guide shows a way to create a new listener checking appearance of a file (new_invoices.txt) on a local file system (/mnt/sdb2/). The appearance will trigger a graph (graph/checkInvoices.grf) from the InvoicesProcessing sandbox.

    In Event Listeners, click New Listener and select File Listener.

    Enter the Name of the listener, e.g. Invoices.

    Enter the Path to the directory where files will appear: /mnt/sdb2. You can check that CloverDX can access this directory (the directory exists and permissions are set up properly) with the Validate Accessibility button.

    If the observed directory becomes inaccessible, CloverDX Server can send you an email. To do so, tick Send email on check failure and enter recipient(s).

    The event should be triggered on file appearance - set Type of check to File added.

    Enter the file name new_invoices.txt to Filename pattern.

    If the file is created empty, but the content is written after some time, tick Ignore empty files. Doing so, the task will be executed after the file contains some data.

    If it takes a long time to copy the whole file to the observed position, the CloverDX Server can perform several check to ensure that the file to process is not to be changed. Tick Trigger task when file has not changed for and enter the number of checks. If you tick Ignore empty files, this checks will be performed after the file is not empty.

    Choose Sandbox with the graph (InvoicesProcessing) and the graph (graph/checkInvoices.grf).

    To save the changes, click on the Create button.

    Observe file from one Cluster node

    Create the listener in the same way as on the Server.

    Switch Initialize by to One of selected nodes.

    Add the particular node(s) from Available nodes to Selected nodes.

    Quickly setup failure notification

    To create a notification for when the file event listener fails, check the Send email on check failure option. and enter email addresses separated by commas.

    The entered email addresses are remembered and pre-filled the next time the button is pressed. If the popup is closed with invalid email addresses entered, the field is cleared.

    When creating the notification, a Task Failure Listener is created with an email task listening to the selected File Event Listener. The first entered email address will be used as the Reply-to(Sender) address. The subject and body of the email is as predefined by the Task Failure template. The trigger limit is set to 5.

    Editing failure notification

    If there is a Task Failure Listener listening to given File Event Listener then instead of the Create Notification button a Notification Detail button is displayed. This button redirects to the Task Failure Listener page and shows the details of the Task Failure Listener listening to the File Event Listener. If more than one Task Failure Listeners are listening to the File Event Listener, then the details of the first one is shown.

    Quickly enable or disable file event listener

    In Event ListenersFile Event Listeners, there is a table with event listeners. In this table, click the icon in the Enabled column.

    Pasting URL

    The whole URL including user name and password can be pasted at once. Click Paste URL and paste the string.

    If the name or password in URL contain special characters, e.g. +, the special characters should be encoded: ftp://anonymous:test%2B@example.com/dir/file.txt

    Note: use encoding accepted by the java.net.URLDecoder.decode() function.