Skip to main content Skip to search Skip to main navigation
Contact

File Utility

Product information "File Utility"

The File Utility Universal Extension provides filesystem inspection and discovery capabilities directly from the Universal Controller. This Universal Task allows customers to search directories for matching files and folders, and to retrieve detailed metadata for individual files, straight from the Universal Controller. 

Working entirely on the Universal Agent host's filesystem, the extension supports recursive directory traversal, flexible name pattern matching using glob or regular expressions, time-based and size-based filters, sorting, and optional checksum computation for integrity verification. Results from directory searches are written to STDOUT as CSV and can optionally be saved to a local file on the agent host. 

Key Features

  • Search a directory recursively or non-recursively and return matched entries as CSV. 
  • Filter results by name pattern (glob or regex), entry type, time range, and file size. 
  • Retrieve full metadata for a single file or directory, including timestamps, size, and entry type. 
  • Compute MD5 or SHA-256 checksums for file integrity verification. 
  • Validate expected file extension and minimum size, failing the task if expectations are not met.
Extension Name: ue-file-utility
Universal Template Name: File Utility
Version: 1.0.0
Compatibility : UC/UA 7.8 and above
Workflow

Use Case 1: Validate an Inbound File Delivery and Archive it

uc1_file_utility_workflow

Description

This workflow discovers the files delivered into a directory on a Universal Agent host, validates the newest delivery, and archives it with an entry in a manifest log retained across runs. A File Utility Task searches the inbound directory for entries matching the delivery pattern that were modified within a given time window and writes the result set as CSV, a second File Utility Task collects the metadata of the newest match and computes its checksum while validating it against an expected size and extension, and a Linux/Unix Task moves the validated file into an archive directory while appending its name, size, and checksum to the log.

The workflow demonstrates how File Utility turns the state of a filesystem into information the Universal Controller can act on. The search result determines which file the rest of the workflow processes, the validation decides whether processing continues at all, and the checksum computed on the Agent host travels forward as a variable. A file delivered by an external system becomes a monitored and verifiable step of a broader orchestration rather than an assumption.

Business Value

  • Detection of files delivered by external systems without polling scripts or custom code maintained on the Agent host.
  • Assurance that a delivery is complete before any downstream processing consumes it, so that a truncated or unexpected file fails the workflow instead of corrupting the result.
  • An auditable record of every delivery processed, including its checksum, retained across executions.
  • Early termination when nothing has been delivered, so that an empty window is reported rather than silently treated as success.
  • Central scheduling and monitoring of filesystem driven workloads alongside the rest of the automation estate.

Technical Capabilities

  • Searches a directory tree on a Universal Agent host with combined name pattern, entry type, size, and relative time filters, returning the result set as CSV both to STDOUT and to a file on the host.
  • Sorts the result set by modification time so that the newest delivery is selected deterministically, and exposes its path through both the extension result and a task output field.
  • Fails the workflow with a dedicated exit code when no entry matches the filters, allowing an empty result to gate the downstream tasks.
  • Collects the full filesystem metadata of a single file, including size, timestamps, permissions, and entry type, and computes an MD5 or SHA-256 checksum of its contents.
  • Validates a file against an expected minimum size and expected extension, failing with a dedicated exit code when the expectation is not met.
  • Passes the discovered path, file name, size, and checksum to downstream tasks as Universal Controller variables, so that values computed on the Agent host are available to the rest of the workflow.
  • Resolves every host path, Agent name, delivery pattern, and expectation from Universal Controller global variables, keeping the workflow portable across environments.

The solution shows that a directory on an Agent host can be treated as a source of events rather than a black box. What arrived, whether it is complete, and what was done with it all become part of the scheduled and auditable record of the Universal Automation Center.