Skip to main content
Version: 3.3

Transfers

Whenever a file transfer is created in UDMG, a corresponding Record named a Transfer is created to track the transfer status and related metadata.

You can monitor Transfers from the Transfers Dashboard.

Protocols

Transfers can have one of the following protocols:

ProtocolDescription
AS2The file transfer was an AS2 transfer and part of a Local AS2 Server to Local Filesystem or Local Filesystem to Remote AS2 Server Pipeline.
CloudThe file transfer was a Cloud transfer and part of a Local Filesystem to Remote Cloud Storage or Remote Cloud Storage to Local Filesystem Pipeline.
FTPThe file transfer was an FTP(S) transfer and part of a Local FTP(S) Server to Local Filesystem, Local Filesystem to Remote FTP(S) Server, or Remote FTP(S) Server to Local Filesystem Pipeline.
FTP-CloudThe file transfer was an FTP(S) and Cloud transfer and part of a Local FTP(S) Server to Remote Cloud Storage Pipeline.
HTTPSThe file transfer was an HTTPS (WTC) transfer and part of a Local HTTPS Server to Local Filesystem Pipeline.
HTTPS-CloudThe file transfer was an HTTPS (WTC) and Cloud transfer and part of a Local HTTPS Server to Remote Cloud Storage Pipeline.
SFTPThe file transfer was an SFTP transfer and part of a Local SFTP Server to Local Filesystem, Local Filesystem to Remote SFTP Server, or Remote SFTP Server to Local Filesystem Pipeline.
SFTP-CloudThe file transfer was an SFTP and Cloud transfer and part of a Local SFTP Server to Remote Cloud Storage Pipeline.

Statuses

Transfers can have one of the following statuses:

StatusDescription
PendingFor UDMG as Client Pipeline transfers only. The transfer was scheduled via the UDMG REST API, but its scheduled execution time has not yet been reached.
StartedThe file transfer was initiated.
RunningThe file transfer is in progress.
ProcessingThe file transfer is currently being processed, such as during ICAP scanning or Tasks execution.
UploadingFor Microsoft Azure File Storage transfers only. The file is currently in a temporary directory during upload. See Azure Files Exception.
CompletedThe file transfer completed successfully.
FailedThe file transfer failed due to a system failure, task failure, or because it was aborted.
CancelledThe file transfer was cancelled by an Admin.
StoppedThe file transfer was stopped.

Status Lifecycle

info

For UDMG as Client Pipelines only, transfer retry behavior is controlled by the transfer block in the UDMG Server configuration file. For more information, see Transfers Retry.

The Uploading status applies only to Microsoft Azure File Storage transfers. See Azure Files Exception.

Viewing the Transfers Dashboard

To view the Transfers Dashboard, click Monitoring > Transfers from the Sidebar. Here you can view a table of Transfer Records.

The Transfers table automatically refreshes every 10 seconds. You can also manually refresh the table at any time with the Refresh button in the top-right corner.

There are various ways to customize your view of the Transfers table. As with any Record Table, you can toggle which columns are displayed by clicking the Columns button above the list (see Selecting Columns). You can further customize how the Transfers table is displayed through Sorting and Filtering, detailed below.

Sorting

By default, the Transfers list is sorted by Last Update. As with any Record Table, you can sort by a different field by clicking the column header.

Filtering

UDMG displays up to 80,000 of the most recent Transfer Records on the Transfers Dashboard at once. Filtering allows you to narrow this list down to a smaller set of Records. You can filter the Transfers Dashboard in several ways, including Time, Status, and Name.

Time Filter

You can filter Transfers by Time by clicking the Time Filter above the table, to the right of the Search bar.

Time filter

Select one of the following times:

  • 5 minutes
  • 10 minutes
  • 30 minutes
  • 1 hour
  • 12 hours
  • 24 hours
  • 48 hours
  • 1 week
  • 2 weeks
  • 1 month
  • 3 months
  • 6 months
  • 1 year

Only Transfers whose Last Update occurred within the selected timeframe appear in the table.

Status Filter

You can filter Transfers by Status by clicking the Status Filter above the table, to the right of the Time Filter:

Status filter

Select one of the following statuses:

  • All
  • Cancelled
  • Completed
  • Failed
  • Processing
  • Running
  • Started
  • Stopped
  • Uploading

Only Transfers of the selected Status appear in the table. Selecting All includes Transfers of any Status.

Filtering by Other Fields

You can filter Transfers by Pipeline or Account.

Click the Record name of one of the above fields. For example, the Pipeline:

Pipeline filter

The Search bar is automatically populated with the selected name. Only Transfer Records with the selected Pipeline appear in the table. To clear the filter, you can either click the x in the Search bar, or click the Pipeline again.

You can filter by Account Name in the same way, by clicking the Name in the respective column. If the column is not currently visible, you must enable it with the Columns button.

Searching

You can further filter Transfer Records by using the free text functionality of the Search bar. When you type plain text in the search bar, it searches for matching values in the following columns:

  • Account
  • Pipeline
  • Source Path
  • Destination Path
  • Source Endpoint
  • Destination Endpoint

The Search only applies to Records that are currently in the table (across all pages). For example, if 1,000 Transfer Records have been returned, then the Search bar searches these 1,000 Records. You can also search using a column key and value pair. To search, prefix your search value with [Column Key]::. For example, searching status::completed returns only Transfers whose Status is Completed.

Search

For a list of available Column Keys and their corresponding Column Names, see the table below:

Column NameColumn Key
AccountaccountName
Destination EndpointendpointDestination
Destination Pathdestination
Is ScheduleisSchedule
Is SendisSend
Pipelinepipeline
Protocolprotocol
Statusstatus
Session IDsessionId
Schedule IDscheduleId
Source EndpointendpointSource
Source Pathsource
Transfer IDid
Protocolprotocol
Statusstatus
Session IDsessionId
Scheduled IDscheduledID
Source EndpointendpointSource
Source Pathsource
Transfer IDid
info

For isSend and isSchedule, use true or false as the value. For example, to filter for Transfers that were sent, use isSend::true.

Managing Transfers

Viewing Transfer Details

To view the details of a Transfer Record, follow these steps:

  1. From the Sidebar, click Monitoring > Transfers.
  2. Click the ID of the Transfer Record you want to view.

You can click the Refresh button above the Transfer details to display the latest Transfer status and information.

Transfer Metadata

Transfer details include the following read-only metadata:

NameDescription
Transfer IDThe local identifier of the transfer.
Status

Current status of the Transfer.

For more information, see Statuses.

Transfer UUIDUniversally Unique Identifier of the transfer.
AccountName of the Account that initiated the Transfer.
Session IDThe session identifier of the transfer.
ProtocolThe protocol of the Transfer.
Session UUIDUniversally Unique Identifier of the transfer session.
PipelineName of the Pipeline used for the Transfer.
Schedule IDThe local identifier of a transfer to or from a remote system.
Working DirectoryThe current working directory for the UDMG Server.
Pipeline Business ServiceThe Business Service associated with the Pipeline used for the Transfer.
SourceThe full file path of the Source. See the associated Pipeline for path Details.
DestinationThe full file path of the Destination. See the associated Pipeline for path details.
Endpoint SourceThe Source Endpoint of the associated Pipeline.
Endpoint DestinationName of the Destination Endpoint of the associated Pipeline.
Endpoint Source TypeThe Endpoint type of the Source Endpoint of the associated Pipeline.
Endpoint Destination TypeThe Endpoint type of the Destination Endpoint of the associated Pipeline.
File SizeThe size of the file in bytes. This value only updates once the Transfer completes. While the Transfer is still in progress, the file size is 0.
Bytes TransferredThe number of bytes as the file is transferred. After the file is transferred it matches the File Size.
Is ScheduledSpecifies whether the Transfer was scheduled or not. If Yes, the Transfer was scheduled, and it was a Remote Transfer. If No, the Transfer was not scheduled, and it was a Local Transfer.
Is SendSpecifies whether the file was downloaded from or uploaded to UDMG. If Yes, the Account downloaded the file from UDMG or the file was pushed to a remote server (Remote Transfer). If No, the Account uploaded a file to UDMG or the file was pulled from a remote server (Remote Transfer).
Cancel ReasonThe error message of the Transfer if it is cancelled. When a Transfer is cancelled manually, this field shows the Username of the User who canceled the Transfer.
Failure ReasonThe error message of the Transfer if it fails.
StartedDate and time the Transfer started.
Completed

Date and time the Transfer ended. This field is left blank if the Transfer is still in progress (Status is Running).

info

The Completion Time is given regardless of whether the Transfer is successful. If a Transfer ends because it fails or is cancelled, it is still considered to have "ended."

Message IDAS2-specific message identifier.
Partner IDAS2 trading partner identifier.
MDN Status

Status of the Message Disposition Notification (MDN).

If Is Send is Yes, possible values are:

  • Pending
  • Valid
  • Invalid
  • Error
  • Timeout
  • Rejected
  • Failed

If Is Send is No, possible values are:

  • Pending
  • Retrying
  • Failed
  • Sent
  • Suppressed
MDN Receipt DateDate and time the MDN receipt was delivered.
MLS

Defines the minimum security requirements that incoming AS2 messages must meet. Options:

  • Signed and Encrypted
  • Compressed, Signed, and Encrypted
MDN Disposition ModeSpecifies whether UDMG expects MDNs synchronously (returned in the same HTTPS session) or asynchronously (returned as a separate HTTP request).
MICSpecifies whether the Message Integrity Check (MIC) returned from the MDN matches the locally calculated MIC.
MIC AlgorithmSpecifies the hash algorithm used to generate the MIC for MDN validation.

Cancelling a Transfer

Users can cancel an existing Transfer through the UDMG REST API.

Endpoint

Use this endpoint to request cancellation of the Transfer:

PUT /api/v1/domains/{domainId}/transfers/cancel/{transferId}

Authentication

This endpoint requires authentication.

The authenticated User must have an Admin Role within the Domain.

Parameters

ParameterDescription
{domainId}The UUID of the Domain that owns the Transfer.
{transferId}The UUID of the Transfer to cancel.

Response Example

JSON
{
"uuid": "a1a4aa99-1ef2-4779-87a2-049af0255666",
"updatedAt": "2026-04-23T20:34:12.276365357Z",
"version": 1,
"transferId": 285544,
"sessionId": 285479,
"sessionUUID": "7a23faf3-9d8d-42a7-bb31-c686cc234e43",
"accountName": "partner-user",
"protocol": "SFTP",
"pipeline": "inbound-files",
"endpointSource": "partner-sftp",
"endpointSourceType": "local:sftp:server",
"endpointDestination": "shared-storage",
"endpointDestinationType": "local::filesystem",
"source": "/uploads/report.csv",
"destination": "/var/data/inbound/report.csv",
"workDirectory": "/var/udmg/work",
"progress": 3129344,
"fileSize": 0,
"isSend": false,
"isSchedule": false,
"scheduleId": 0,
"status": "Cancelled",
"cancelReason": "action: cancel by user: udmg.domain-admin",
"startedAt": "2026-04-23T20:33:56.246752686Z",
"completedAt": "2026-04-23T20:34:12.276364569Z"
}