Skip to main content

File Connector and File Monitor

The File Connector monitors local or network directories for files and uploads them to the platform for processing.

File Connector

The File Connector monitors local or network directories for files and uploads them to the platform for processing. It runs as a Windows service and includes a web-based interface for configuring upload definitions, scheduling jobs, and monitoring activity.

Unlike the Historian and Measurement Connectors, the File Connector does not query an external data system — it simply watches configured directories and transfers whatever files it finds.


Connector interface

The interface is accessed via a web browser. It displays the current time and time zone used by the connector, which may differ from the local time of the machine used to access it.


Event log

The Event Log records connector activity. Each entry shows the job or event name, result, summary message, timestamp, and duration. Events are colour-coded by status. Selecting an entry shows additional detail and error messages. Older entries are removed after a retention period.


Configure Uploads

The Configure Uploads screen defines the directories monitored by the connector and how files from those directories are uploaded. Each upload configuration specifies:

  • Name — display name for the configuration

  • Local Directory — the directory monitored for new or updated files

  • Remote Credentials — the credentials used to upload files, which determine which platform instance receives them

  • File Extensions — restricts uploads to specific file types; leave blank to include all files

  • Include Subdirectories — whether files in subfolders of the monitored directory are also included

A test connection option is available to verify connectivity to the platform using the configured credentials before scheduling jobs.


Scheduled jobs

Scheduled Jobs define when upload configurations are executed automatically. Each job specifies a name, the upload configuration to run, a start date, an optional end date, a repeat interval, and an active/inactive toggle.

When a job runs, the connector scans the monitored directory for files and uploads them to the platform. Uploaded files are moved to a Processed folder automatically. If a file with the same name already exists in the Processed folder, the new file is renamed with a timestamp to avoid overwriting it.

Jobs can be executed manually without affecting the configured schedule. If the connector service restarts, scheduled jobs recalculate their next execution time and missed jobs must be triggered manually.



File Monitor

The File Monitor is the component running within the platform instance that receives files uploaded by connectors and triggers the appropriate import process. It acts as the bridge between files arriving in the platform's storage location and the processes that handle them.


How it works

When a connector uploads a file, the File Monitor detects it, identifies the matching File Handler based on the file name, creates a process execution entry using the file as input, and passes control to the import process. Once processing is complete, the file is removed from storage.


Configuring File Handlers

File Handlers are configured in the platform and define which files trigger which processes. Each handler specifies a file name pattern and the import process to run when a matching file is detected. File name patterns follow the same regular expression syntax used in email processing rules.

Navigate to the File Monitor configuration in the Configuration application to create and manage handlers.


File Processor Logs

The File Processor Logs screen records File Monitor activity.

Status

Meaning

Ran

The File Monitor executed but no files were available

Success

A file was detected and the associated process completed successfully

Failed

The process did not complete successfully

If the File Monitor finds a file but no matching File Handler exists, the run is logged as successful but the file is not processed — it is silently ignored.


Troubleshooting

If a file fails to process, check that the connector successfully uploaded the file, the File Monitor timer is running in the platform instance, a File Handler exists that matches the file name, and the associated process executed without errors. Review the Process Execution record and the File Processor Logs (File Processing \> File Processor Logs) to identify where the failure occurred.<br><br>The File Monitor is designed to ignore files that are 0 bytes in size. As a result, the monitoring process may appear to complete successfully, while empty files remain in the S3 incoming bucket without being processed. <br>This behaviour is intentional and has been implemented to prevent downstream processes from running against empty input files, which could otherwise result in processing errors or invalid outputs.

Did this answer your question?