Primeur Online Docs
Data Mover 1.20
Data Mover 1.20
  • 🚀GETTING STARTED
    • What is Primeur Data Mover
    • Main features of Primeur Data Mover
    • Primeur Data Mover deployment
    • Navigate through Primeur Data Mover
  • 📚INFRASTRUCTURE
    • STENG, clusters and servers
      • Adding a cluster and a STENG
      • Deleting a STENG
    • DMZ Gateways
      • Blocking users automatically at the DMZ level 🚀
    • DMZ Clusters
      • Load balancing across active DMZ clusters for outbound file transfers 🚀
  • 👥Actors
    • Who are the actors
    • Create your first actor
    • Configure an actor 🚀
      • Users Tab
      • Groups Tab
      • VFS Tab
      • File Resource Tab
      • Connection Contract Tab
      • Client Connections Tab
    • Search files by actor
    • Actor Lineage 🚀
      • Aggregation of flows by protocol 🚀
      • Lineage with connection contracts 🚀
      • Lineage with input, mediation and output contracts 🚀
      • Lineage with any contract type 🚀
  • 🗄️VIRTUAL FILE SYSTEMS
    • Virtual File Systems (VFS) 🚀
      • Creating a VFS 🚀
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
    • Searching files in all VFS
    • Storage Classes 🚀
      • Storage Class: SMB v3 or later versions 🚀
      • Storage Class: Azure Blob Storage 🚀
      • Storage Class: Amazon S3 🚀
      • Storage Class: Google Storage 🚀
      • Storage Class: Local File System 🚀
    • Retention Classes
  • 📝Contracts
    • What is a contract
    • Create your first contract
      • Create an Input Contract
        • Define the contract info
        • Associate the contract with the actor
        • Define the contract actions
        • Set the contract variables
      • Create a Mediation Contract
      • Create an Output Contract
      • Create a Connection Contract
        • Create a contract clause
        • Associate the VFS with file processing rules
        • File Processing Rules
    • Managing contracts 🚀
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
  • 🧱Workflows
    • What is a workflow
    • Create your first workflow template
    • Trigger types
      • Trigger types for input contracts
      • Trigger types for mediation and output contracts
    • Service tasks
      • Standard service tasks
      • Triggerable service tasks 🚀
      • Spazio selectors and filebox metadata management
      • Error management
    • Variables
      • Variables in workflows and contracts
      • Handling process variables
    • Workflow templates
      • System workflow templates
        • Workflow templates for input contracts
        • Workflow templates for mediation contracts
        • Workflow templates for output contracts
      • Custom workflow templates
        • Workflow template toolbar
        • Workflow template Shape repository panel
        • Workflow template working area
        • Workflow template BPMN-diagram panel
      • Error workflow templates
    • Editing workflow templates
    • DataFlow Instance Context (DFIC) 🚀
  • 🛸TRANSPORT PROTOCOLS AND CONNECTORS
    • Data Mover client and server roles
    • Client Connections
      • Client Connection: FTP
      • Client Connection: FTPS
      • Client Connection: SFTP
      • Client Connection: HTTP
      • Client Connection: HTTPS
      • Client Connection: PESIT
      • Client Connection: SMB v3 or later versions
      • Client Connection: POP3 or IMAP
      • Client Connection: SMTP
      • Client Connection: PR4/PR4S
      • Client Connection: PR5
      • Client Connection: PR5S
      • Client Connection: HDFS
      • Client Connection: HDFSS
      • Client Connection: Amazon S3 🚀
      • Client Connection: Google Cloud Storage
        • Credentials
      • Client Connection: Azure Blob Storage
      • Client Connection: IBM Sterling Connect:Direct
      • Client Connections retry settings
    • Server Connections 🚀
      • Server Connection: FTP
      • Server Connection: FTPS
      • Server Connection: SFTP
      • Server Connection: HTTP
      • Server Connection: HTTPS
      • Server Connection: PeSIT
      • Server Connection: PR4
      • Server Connection: PR5
      • Server Connection: PR5S 🚀
      • Server Connection: IBM Sterling Connect:Direct
    • Protocol Connections Reference
    • Stopping all servers in one go
  • 💻API
    • HTTP MFT Rest API
    • Job Manager APIs 🚀
    • SFTP Server sessions APIs 🚀
    • Audit Logs APIs 🚀
  • 🔓Security
    • Identity and Access Management
    • Users & Groups
      • Setting the password policy
      • Creating Internal Users 🚀
      • Creating Internal Groups
      • Creating External Users
      • Creating External Groups
    • Key Stores and Trust Stores
      • Key Store 🚀
        • Creating a Key 🚀
        • Creating a Certificate 🚀
        • Importing a Key or a Certificate
        • Creating a Symmetric key
        • Examples
      • Trust Store 🚀
        • Importing Keys 🚀
        • Importing Certificates
      • Untrusted Cache 🚀
      • Trusting Keys and Certificates
      • PGP Key Store and PGP Trust Store
        • PGP Key Store
        • Importing keys into the PGP Trust Store
    • ICAP
      • Configuring ICAP
      • Defining an ICAP rule
  • 🎧FILE EVENT LISTENER
    • What is the File Event Listener
    • Configuring File Event Listeners
      • Setting the File Event Listener Engine
      • Defining a contract for the File Event Listener
      • Setting events to be monitored 🚀
    • RegEx Rules 🚀
    • Monitoring File Event Listeners
  • 👑FILE MANAGER
    • What is the File Manager
    • Logging into File Manager
    • Managing the File Manager 🚀
      • The list of results
      • Creating new folders
      • Uploading files
      • Downloading files 🚀
      • Searching for files and folders
      • Deleting files 🚀
      • Bulk actions 🚀
    • File Manager and VFS
    • Customizing File Manager externals
      • The configuration-wui.json file 🚀
      • How to customize the Login window and the logo
      • How to customize the footer
      • How to configure the Upload with Metadata option
      • How to customize bulk actions 🚀
  • 🧑‍⚖️FILE ROUTING
    • What is File Routing 🚀
    • Routing Rules
      • The Rules tab
      • The Categories tab
      • The Output tab
    • How to create a rule 🚀
      • Add metadata 🚀
      • Select ACTIONS
      • Select OUTPUTS
      • Policy for the selection of metadata rules
    • Configuration of the environment in Data One
      • Set up Storage Classes
      • Set up Retention Classes
      • Configure the Actor
      • Set up File Resources
    • Associate the Routing Rule with a Contract
    • Example
  • 📩NOTIFICATION CHANNELS
    • What are Notification Channels
    • Configuring the default Email Notification Channel
    • Configuring a new Email Notification Channel
    • Trusting Certificates
    • Managing Templates
      • Data Watcher Macros
      • Contract Macros
      • ICAP Macros
      • Central Log Macros
      • Email Templates
      • Editing default templates
      • Loading a new template
  • 💬LOGS & AUDIT
    • Logs 🚀
      • Logs options 🚀
      • Troubleshooting error analysis in Logs
    • Audit Options 🚀
      • Export audit logs 🚀
      • List of Audit entity types 🚀
      • Audit message codes 🚀
    • Log Notifiers 🚀
      • FEL message codes
  • 🕒MONITORING
    • Jobs
      • Details about Jobs 🚀
      • jobman.sh CLI
    • Job Manager
    • Job Queues
      • Managing Job Queues
    • File Transfers
      • Ongoing
      • Finished
      • Reports
    • File Transfers Rules
      • Configuring Rules
  • 🧐HOW TO...
    • ... use different DNS names 🚀
    • ... configure a Cron Expression
    • ... configure an application
    • ... customize the header
    • ... run searches in Data Watcher 🚀
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
    • ... fine tune Data Mover
      • Email sender for the Notification Channel
  • 🗒️RELEASE NOTES
    • Data One 1.20.10
    • Data One 1.20.9
    • Data One 1.20.8
    • Data One 1.20.7
      • Data One 1.20.7.1
    • Data One 1.20.6
    • Data One 1.20.5
    • Data One 1.20.4
    • Data One 1.20.3
    • Data One 1.20.2
    • Data One 1.20.1
    • Data One 1.20.0
Powered by GitBook
On this page
  1. FILE EVENT LISTENER
  2. Configuring File Event Listeners

Setting events to be monitored 🚀

PreviousDefining a contract for the File Event ListenerNextRegEx Rules 🚀

Last updated 18 days ago

Configuration of events to be monitored occurs in the Setup → File Event Listeners section of Data Mover.

When going to Setup → File Event Listeners, the following home page appears listing already configured File Event Listeners. If nothing is configured, the page will show that no results are available.

To create a new listener event, follow these steps:

  1. In Setup → File Event Listeners, click the NEW button.

  2. The New File Event Listener window will appear.

  3. In the New File Event Listener window, fill in the fields:

    • Name (*): assign a name to the File Event Listener. Maximum 128 characters are accepted.

    • Description: (optional) enter a description for the File Event Listener you are configuring. Maximum 255 characters are accepted.

    • Status: (optional) select the status of the activity. Possible options are:

      • On: the configuration is saved and file events are monitored.

      • Off: the configuration is saved but file events are not monitored.

    • Actor (*): select an actor to be associated with your File Event Listener..

After you have selected an Actor, the following fields will appear:

  • Location type (*): select the location type for your File Event Listener. You can either select a local (file system folder) or a remote location (SFTP, SMB3).

  • Monitoring details:

    • Client Connection (*): (Only for remote location types: SFTP and SMB3) select the Client Connection associated with the protocol type previously chosen.

    • Check every (*): specify the polling interval in minutes (default) or seconds. For minutes, values accepted go from 1 (minimum) to 1440 (maximum). For seconds, values accepted go from 30 (minimum) to 86400 (maximum). The default value is 10 minutes.

    • Cluster (*): select the STENG cluster where the File Event Listener will run.

  • Events to be monitored (*): specify the events to be monitored. Files created and modified can be monitored. Note that only contracts associated with the system-onDemand_FEL_v2 system workflow will be displayed in this section. To enable an event, check the box and select the associated action to be fired in the list of all defined actions.

  • Paths to be monitored:

    • Paths (*): define the paths that must be monitored. Enter one path name at a time and press the Add button to confirm. At least one path must be specified. Note that a path can be monitored by only one File Event Listener at a time. The path will appear below the Add button and can be removed clicking the x.

    • 🚀 Recursive monitoring (*): define if folders and subfolders must be monitored recursively. Select:

      1. Disabled (default) if you do not want to apply recursive monitoring.

      2. Enabled if you want to apply recursive monitoring.

      3. Limited to define a specific number of nested levels.

    • File Name: select which files to monitor/not to monitor in each path through Wildcards or a RegEx. You can specify a filename pattern using these Wildcards: * (asterisk), this can represent any number of characters (including zero) and ? (question mark), this can represent any single character. Each multiple selection must be separated by a , (comma). Here are some examples:

      • *.log filters all files with the .log extension

      • test*filters all files with a filename that starts with the word test

      • test*.log filters all files with a filename that starts with the word test and that have the .log extension

      • test?.log filters all files with a filename that starts with the word "test" followed by a single character and that have the .log extension

Deleting a path to be monitored

When you remove a path from the list of paths to be monitored, all associated Wildcards and RegEx you have selected will be removed as well. If you decide to monitor the path/folder at a later date, you will need to insert Wildcards and RegEx again as the system does not retain their history.

  • 🚀 Ignore policies: (optional) specify if any of these files must be ignored:

    • Error on paths (ignored by default, so incorrect or non-existing paths do not cause the File Event Listener to stop and viceversa)

    • Pre-existing files on the first scan

    • Files with size smaller than a specific number of bytes

    • (Only for the file system folder location) Files created/modified in the last X seconds (default 60 seconds, range 1 to ∞ seconds) – UPDATE TIME

    • Files created/modified in the last X runs (default 1 run) – POLL INTERVAL. Note that a run corresponds with the number of polls, or checks, that must pass with the file not changing in size before it is considered stable and eligible for processing.

    • Specific files patterns included in a blacklist. Files must be separated by commas, and can contain “_” wildcard e.g. _.partial, _.part, temp_

At the top of the list of results, multiple options are available.

The status of the monitoring can be identified at a glance in the result list with these icons:

Each icon is completed with a tooltip.

If a File Event Listener instance is listening to more than one directory, those are shown in the Paths column. The column shows up to two paths, additional paths can be seen in the tooltip that appears by hovering over the More paths defined wording.

In the Filters panel on the right, you can filter results by:

  • Name of the File Event Listener

  • Contract the File Event Listener is associated with

  • Status (enabled or disabled)

  • Event (file created or file modified)

  • Actor the File Event Listener is associated with

  • Location type

Wildcards and RegEx can have a maximum of 2000 characters! See the following page for more information about RegEx rules. Click on the icon next to the File Name wording for a brief description of Wildcards and RegEx rules. At least one path must be specified. Note that a path can be monitored by only one File Event Listener at a time. The path will then appear below the Add button and can be removed clicking the x.

Learn how to use the toolbar on the right of the page . Multiple activities can be Enabled or Disabled in one go by simply checking the activity in the result list and then selecting Enable or Disable in the drop-down list. Checking the box on the left of SELECTED, all entries in the result list will be selected or deselected.

the listening activity is enabled and running.

the listening activity is disabled and not running.

an error in the listening activity has occurred. The reason for the error can be detected in the Central Log.

the File Event Listener engine is down. The reason for the error can be detected in the Central Log.

Clicking the icon on the right of the row, the Edit and Delete options are available.

🎧
here