Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use.

Version Information

Refer to Changelog for version history information.

Overview

Universal Data Mover Gateway (UDMG) is Stonebranch’s secure managed file-transfer (MFT) solution for orchestrating data movement across on-prem, cloud, and partner environments. It provides encrypted transfers, centralized credential and endpoint management, policy-based governance, and detailed auditing. UDMG integrates tightly with the Universal Automation Center (UAC), enabling unified security, logging, and access control across automated workflows.

This extension integrates the functionality of UDMG into UAC, allowing users to trigger and monitor UDMG file-transfer pipelines (UDMG 3.2+), by allowing transfers to be initiated programmatically as part of broader UAC workflows. Transfer completion is reflected directly in the task instance status, supporting reliable workflow chaining and ensuring secure data movement without manual intervention.

Key Features

Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Supported Actions

There is a single Top-Level action controlled by the Action Field:

• Initiate File Transfer

Action Output

{
	"exit_code": 0,
	"status_description": "File Transfer executed successfully.",
	"invocation": {
		"extension": "ue-udmg-mft",
		"version": "1.0.0",
		"fields": { ... },
	},
	"result": {
		"schedule_details": {
			"scheduleId": 143,
			"transferId": 201,
			"pipeline": "remote-to-local",
			"username": "credentials_username",
			"source": "/home/ue-dev/ftp_up/file.txt",
			"destination": "/data/",
			"schedule": "2025-12-08T15:54:59.092Z",
			"status": "Completed",
			"executedAt": "2025-12-08T15:55:00.875783675Z",
			"completedAt": "2025-12-08T15:55:00.982892203Z",
			"transferAttempt": [
				{
					"attemptNumber": 1,
					"transferId": 201,
					"startedAt": "2025-12-08T15:55:00.875790975Z",
					"completedAt": "2025-12-08T15:55:00.982891903Z"
				}
			]
		},
		"transfer_details": {
			"uuid": "de7-xxx-ad",
			"updatedAt": "2025-12-08T15:55:00.982291779Z",
			"transferId": 201,
			"sessionId": 201,
			"sessionUUID": "76b7-xxx-dbb090",
			"accountName": "credentials_username",
			"protocol": "SFTP",
			"pipeline": "remote-to-local",
			"endpointSource": "remote_sftp_server",
			"endpointSourceType": "remote:sftp:server",
			"endpointDestination": "local_fs",
			"endpointDestinationType": "local::filesystem",
			"source": "/home/ue-dev/ftp_up/bli.txt",
			"destination": "/data2/bli.txt",
			"workDirectory": "/home/udmg/dev",
			"progress": 17,
			"fileSize": 17,
			"isSend": false,
			"isSchedule": true,
			"scheduleId": 143,
			"status": "Completed",
			"startedAt": "2025-12-08T15:55:00.873122968Z",
			"completedAt": "2025-12-08T15:55:00.982291179Z"
		}
	}
}

{
	"exit_code": 1,
	"status_description": "Transfer Failed: Schedule with ID 124 resulted in failure, reason is 'Max 
retries exceeded. Last error: failed to get source file path '/filename.txt': object not found'",
	"invocation": {
		"extension": "ue-udmg-mft",
		"version": "1.0.0",
		"fields": { ... },
	},
	"result": {
		"schedule_details": {
			"scheduleId": 27,
			"transferId": 187,
			"pipeline": "remote-to-local",
			"username": "credentials_username",
			"source": "/filename.txt",
			"destination": "/data/ftp_up/",
			"schedule": "2025-11-25T16:25:38.783Z",
			"status": "Failed",
			"errorMessage": "Max retries exceeded. Last error: failed to get source file path '
/filename.txt': object not found",
			"executedAt": "2025-11-25T16:28:00.632465032Z",
			"completedAt": "2025-11-25T16:28:00.633933497Z",
			"transferAttempt": [
				{
					"attemptNumber": 1,
					"transferId": 187,
					"startedAt": "2025-11-25T16:26:00.714397687Z",
					"completedAt": "2025-11-25T16:26:00.715876153Z",
					"errorMessage": "failed to get source file path '/filename.txt': object not found"
				}
			]
		}
	}
}

{
	"exit_code": 0,
	"status_description": "File Transfer cancelled successfully",
	"invocation": {
		"extension": "ue-udmg-mft",
		"version": "1.0.0",
		"fields": { ... }
	},
	"result": {
		"schedule_details": {
			"id": 86,
			"pipeline": "local-to-remote",
			"username": "credentials_username",
			"source": "/data/filename.txt",
			"destination": "/ftp_up/",
			"schedule": "2025-10-21T13:07:09.478Z",
			"status": "Cancelled",
			"errorMessage": "Transfer schedule cancellation requested by ue-udmg-mft integration",
			"completedAt": "2025-10-21T13:07:13.141959231Z"
		}
	}
}

Configuration Examples

Example: Initiate a File Transfer, without polling for its completion

This task is a simple example for initiating a File Transfer on UDMG and immediately exiting.

Example: Initiate a File Transfer, polling for its completion and requesting all available information

This task uses initiates a File Transfer on UDMG verifying the connection with the specified CA bundle, waiting for its completion and retrieving all available information. All optional environment variables have been set to appropriate values.

Importable Configuration Examples

This integration provides importable configuration examples along with their dependencies, grouped as Use Cases to better describe end to end capabilities.

Initial Preparation Steps

• STEP 1: Go to Stonebranch Integration Hub and download the "UDMG Transfer" integration. Extract the downloaded archive on a directory in a local drive.

• STEP 2: Locate and import the above integration to the target Universal Controller. For more information refer to the "How To" section in this document

• STEP 3: For "UDMG Transfer", inside directory named "configuration_examples" you will find a list of definition zip files. Upload them one by one respecting the order presented below, by using the "Upload" functionality of Universal Controller: 

  • variables.zip

  • credentials.zip

  • tasks.zip

  • workflows.zip

• STEP 4: Update the uploaded UAC Credential entity introduced with proper Username / Password

• STEP 5: Update the UAC global variables introduced with variables.zip file. Their name is prefixed with "ue_udmg_mft". Review the descriptions of the variables as they include information on how they should be populated.

The "Upload" functionality of Universal Controller allows Users to import definitions exported with the "Download" functionality.

How to "Upload" Definition Files to a Universal Controller

Login to Universal Controller and:

• STEP 1: Click on "Tasks" → "All Tasks"

• STEP 2: Right click on the top of the column named "Name"

• STEP 3: Click "Upload..."

In the pop-up "Upload..." dialogue:

• STEP 1: Click "Choose File".

• STEP 2: Select the appropriate zip definition file and click "Upload".

• STEP 3: Observe the Console for possible errors.

Use Case 1: Local File Processing via UDMG Transfer (SFTP)

Input Fields

Output Fields

The following output-only fields provide better visibility during the execution of Universal Task Instances.

Environment Variables

Environment Variables can be set from Environment Variables task definition table. The following environment variables can affect the behavior of the extension.

Cancelation and Rerun

• In case of cancellation, monitoring of the transfer is halted. The cancellation is propagated to UDMG, cancelling the ongoing file transfer, and retrieving information relevant to the schedule and transfer before exiting.

• In case of rerun the extension follows the same execution flow as the initial execution. As such, the transfer will once again be initiated, with the result depending on the state of the source and target directories. Note that in case the transfer has already been completed and the file remains unchanged on both systems, the transfer will be instantly completed on the UDMG side.

Exit Codes

STDOUT and STDERR

STDOUT of this integration is empty

STDERR provides additional information to the user, the verbosity of which is tuned by the Log Level Task Definition field.

How To 

Import Universal Template

To use the Universal Template, you first must perform the following steps.

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

2. Import the Universal Template into your Controller,

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

Integration Modifications

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

• Python code modifications should not be done.

• Template Modifications

  • General Section

    • "Name", "Extension", "Variable Prefix", and "Icon" should not be changed.

  • Universal Template Details Section

    • "Template Type", "Agent Type", "Send Extension Variables", and "Always Cancel on Force Finish" should not be changed.

  • Result Processing Defaults Section

    • Success and Failure Exit codes should not be changed.

    • Success and Failure Output processing should not be changed.

  • Fields Restriction Section
    The setup of the template does not impose any restrictions. However, concerning the "Exit Code Processing Fields" section.

    1. Success/Failure exit codes need to be respected.

    2. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.

Event Template configuration related to “Metric Label Attributes” & “Optional Metric Labels” is allowed. However, administrators should be cautious of high cardinality scenarios that might occur.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Document References

This document references the following documents:

Changelog

ue-udmg-mft-1.0.0 (2025-12-19)

Initial Version release