Universal Event Integration

Each time a file transfer occurs on UDMG Server, a Publish Event Task can publish a Universal Event to Universal Controller.

These events can then trigger a Universal Monitor Task for file processing or other automated actions.

Universal Events can be published at specific Event Types (transfer lifecycle events), depending on how Publish Event Tasks are configured in the Pipeline Workflow.

Flow Overview

The following diagram illustrates how UDMG publishes a Universal Event and how it is processed in Universal Controller.

At a high level, the flow is as follows:

1. A file transfer is executed in UDMG through a Pipeline.
2. The Pipeline's Workflow has Publish Event Tasks assigned to different Event Types (transfer lifecycle events).
3. When a trigger condition is met, the corresponding Publish Event Task is executed.
4. The Publish Event Task publishes a Universal Event to Universal Controller.
5. The event is matched against a Universal Event Template, which defines its structure and attributes.
6. A Universal Monitor task listens for events that match the configured template and optional filtering criteria.
7. A Universal Monitor trigger evaluates the monitored events and initiates one or more downstream tasks.
8. The triggered tasks are executed using the event attributes, which contain file transfer metadata from UDMG.

This flow enables UDMG file transfer activity to be integrated into Universal Controller workflows for monitoring, automation, and further processing.

Configuration Steps

Overview

To set up Universal Event Integration for UDMG file transfers, you need to complete the following steps:

Step	Description
1	Create a Universal Event Template for UDMG file transfers in Universal Controller. This template defines the structure and attributes of the events that UDMG will publish.
2	Configure UDMG Server to send events to Universal Controller. This involves editing the UDMG Server Configuration File to enable the Universal Controller integration and provide the necessary connection details and default event settings.
3	Create a Publish Event Task in UDMG. This Task will be responsible for publishing events to Universal Controller when specific transfer lifecycle events occur.
4	Create a Pipeline in UDMG and assign the Publish Event Task to the Pipeline Workflow. This will ensure that events are published at the appropriate points during the file transfer process.
5	Create a Universal Monitor task in Universal Controller to handle the events. This Universal Monitor task will listen for events that match the Universal Event Template and can be configured to filter events based on their attributes.
6	Configure a Universal Monitor trigger in Universal Controller to trigger downstream tasks based on the events. This allows you to automate actions in response to file transfer events, such as processing transferred files, sending notifications, or updating records.

1. Create a Universal Event Template for UDMG File Transfers

In Universal Controller, create a Universal Event Template so that UDMG file transfer events can be monitored by a Universal Monitor task.

As part of the UDMG installation, a Universal Event Template is provided in XML format. This file can be imported into Universal Controller to create a Universal Event Template with the required structure and attributes for UDMG file transfer events.

The XML file is located in the UDMG installation directory, by default:

# Linux
/opt/udmg/etc/samp/

# Windows
C:\Program Files\Stonebranch\UDMG Server\samp\

info

For instructions on creating a Universal Event Template, refer to Universal Controller documentation.

2. Set the Configuration File to Send Events to Universal Controller

In the UDMG Server Configuration File, edit the uac block to enable the Universal Controller integration and provide the required connection details, along with default event settings.

For example:

udmg-server.hcl

uac {
  enable                 = true
  urls                   = ["https://uac.example.com:8443/uac/", "https://uac-backup.example.com:8443/uac/"]
  username               = "udmg_user"
  password               = "secret_password"
  event_name             = "udmg_transfer"
  event_ttl              = "60"
  override_publish_event = true
}

info

If uac.override_publish_event is set to true, the uac.event_name, uac.username, and uac.password values can be overridden by the following Publish Event Task fields: Event Name (Overrides Default), and Event Credentials (Overrides Default).

3. Create a Publish Event Task

In UDMG, create a Publish Event Task by following these steps.

4. Create a Pipeline and Assign the Task

In UDMG, create a new Pipeline by following the steps in the corresponding Pipeline page.

Then, assign the Publish Event Task created in step 3 to the Pipeline Workflow by following these steps.

5. Create a Universal Monitor Task to Handle the Event

In Universal Controller, create a Universal Monitor task and select the Universal Event Template created in step 1.

Optionally, you can define additional filtering criteria based on event attributes, which include file transfer metadata from UDMG.

For instructions on creating a Universal Monitor task, refer to Universal Controller documentation.

6. Configure a Universal Monitor Trigger for Further Processing

In Universal Controller, create a Universal Monitor trigger and select the Universal Monitor task created in step 5.

Select one or more tasks to trigger for each event. Event attributes are passed to the triggered tasks as variables, allowing those tasks to access file transfer details.

Variable names use the following format: ops_trigger_<universal_event_template_name>_<event_attribute_name>.

For example, ops_trigger_udmg_transfer_filesize for the filesize attribute.

For instructions on creating a Universal Monitor trigger, refer to Universal Controller documentation.