Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel2

...

Universal Data Mover Gateway provides a Transfer Activity dashboard to enable the monitoring of file transfer activity. The Transfer Activity dashboard shows, by default, a list of all file transfers pending. The pending file transfers can have one of the seven (7) file transfer statuses, including planned, running, paused, or error. The Transfer Activity dashboard is not automatically refreshed.

Each specific transfer record instance can also be monitored by selecting a file transfer record and displaying the transfer recordinstance-specific Transfer Details

Displaying the Transfer Activity Dashboard

...

The UDMG Admin UI assigns a default color for each of the seven (7) possible statuses for a transfer instance:

StatusColor
Plannedgrey
Runninggreen
Interruptedyellow
Pausedorange
Errorred
Doneblue
Canceledpurple

Transfer Activity

...

Dashboard Column Descriptions

The following table describes the default columns of information displayed in the Transfer Activity dashboard.

Column

Description

Transfer ID

The local identifier of the transfer.

Rule

The name of the transfer rule.

Transfer Protocol

The protocol used to perform the transfer.

Requester

The name of the account that requested the transfer.

RequestedThe name of the server/partner the transfer was requested from.

Path

The file path on the local disk.

Remote File PathThe file path on the remote partner.
Start DateDate and time the transfer instance started.
StatusThe current status of the transfer (possible values: PLANNED, RUNNING, PAUSED, INTERRUPTED, ERROR, DONE, or CANCELLED).
StepThe current step of the transfer (possible values: StepNone, StepSetup, StepPreTasks, StepData, StepPostTasks, StepErrorTasks, or StepFinalization).
TransferredThe progress (in bytes) of the data transfer.
File SizeThe size of the file (-1 if unknown).

Error Code

The error code of the transfer (if an error occurred).

Error MessageThe error message of the transfer (if an error occurred).
isServerIndicates whether the UDMG Server is acting as a server (true) or as a client (false).
isSendIndicates whether the transfer is a send (true) or a receive (false).
UUIDTransfer Unique Identifier, as string.

Anchor
list task bar
list task bar

Transfer Activity

...

Dashboard Column Headers

A contextual menu opens up when clicking on a column header.

  • Search: input a value to filter on the column content
  • Asc: perform ascending sort on the column values
  • Desc: perform descending sort on the column values
  • Hide: hide the column, it can be restored with the Toggle Columns picker

Transfer Activity

...

Dashboard Task Bar

A Transfer Activity Listtask bar displays across the top of the Transfer Activity Listdashboard, which allows you to select which transfer instances display on the list.


By Time Filter

The By Time constraint drop-down list in the Transfer Activity Listtask task bar allows you to select a time frame for which you want transfer instances to display on the listdashboard.

The default time constraint is 48 hours.

...

The By Status field in the Transfer Activity List task bar allows you to filter the list dashboard so that only transfer instances matching the specified criteria within the selected time constraint display are displayed on the listdashboard.


By default, the filtering is disabled , showing transfers for and all the statuses' transfers are displayed. The user can

  • Select a set of individual status checkboxes

See the generic description of the List Task Bar for detailed information an on applying filters.

...

Toggle Columns Picker

The Toggle Columns button picker allows you to select which column columns are displayed in on the listdashboard.Note that a


Note

A column can

...

be hidden by selecting Hide in the column header contextual menu.


Displaying Transfer Details

To display Transfer Details for a transfer recordinstance:

  • Select the record from the list.

...

The following table describes the default columns of information displayed on in the Transfer Details tab.

Column

Description

Status Color-coded icon: the current status of the transfer (possible values: PLANNED, RUNNING, PAUSED, INTERRUPTED, ERROR, DONE or CANCELLED).

ID

The local identifier of the transfer.

Protocol

The protocol used to perform the transfer.

StepThe current step of the transfer (possible values: StepNone, StepSetup, StepPreTasks, StepData, StepPostTasks, StepErrorTasks, or StepFinalization).
Remote IDTransfer Unique Identifier (UUID).
isServerIndicates whether the UDMG Server is acting as a server (true) or as a client (false).
isSendIndicates whether the transfer is a send (true) or a receive (false).
Start DateDate and time the transfer instance started.
Stop DateDate and time the transfer instance completed (only for DONE status).

Error Code

The error code of the transfer (if an error occurred).

Error MessageThe error message of the transfer (if an error occurred).

Rule

The name of the transfer rule.

File SizeThe size of the file (-1 if unknown).
Local File PathThe file path on the UDMG server.
Remote File PathThe file path on the remote partner.

Requester

The name of the account that requested the transfer.

RequestedThe name of the server/partner the transfer was requested from.


From the Transfer Details, you can also display additional Details about the transfer instance:

Info tab

Displays Metadata for the transfer instance.

Output tab

Displays complete log messages for the transfer.

Transfer Info Tab

The Info tab lists all additional informational fields available to the transfer instance. These fields are added and updated during the transfer execution. 

The internal fields have a reserved name starting with the udmg_ prefix. Additional custom informational fields can be set during the transfer registration by the client on the interface. The reserved fields (with udmg_) shall not be set by the client unless it is required for correct processing (i.e., for the wildcard mode). The list of informational fields and values for a specific transfer depend depends on the protocol, the associated pre-, post, and error tasks, and the type of the transfer.

...

Anchor
transfer log tab
transfer log tab

Transfer Logs Tab

The Logs tab displays the log messages generated for the transfer request execution.

The Logs tab displays a green icon, indicating that the log is available for the transfer. This is only the case if the Detailed Logging has been enabled, see Logging Configuration.

When switching to this tab, the UDMG Admin UI retrieves and displays the log file and displays it. Reload of the log can be triggered with the refresh button inside the Log tab pane.