Monitoring Activity from the Transfer Activity Dashboard
- Stonebranch (Deactivated)
- Katie Murphy
- Olivier Michaut
Overview
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 instance can also be monitored by selecting a file transfer record and displaying the transfer instance-specific Transfer Details.
Displaying the Transfer Activity Dashboard
From the UDMG Admin UI navigation pane, select Transfers to display the Transfer Activity dashboard.
The UDMG Admin UI assigns a default color for each of the seven (7) possible statuses for a transfer instance:
| Status | Color |
|---|---|
| Planned | grey |
| Running | green |
| Interrupted | yellow |
| Paused | orange |
| Error | red |
| Done | blue |
| Canceled | purple |
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. |
| Requested | The name of the server/partner the transfer was requested from. |
Path | The file path on the local disk. |
| Remote File Path | The file path on the remote partner. |
| Start Date | Date and time the transfer instance started. |
| Status | The current status of the transfer (possible values: PLANNED, RUNNING, PAUSED, INTERRUPTED, ERROR, DONE, or CANCELLED). |
| Step | The current step of the transfer (possible values: StepNone, StepSetup, StepPreTasks, StepData, StepPostTasks, StepErrorTasks, or StepFinalization). |
| Transferred | The progress (in bytes) of the data transfer. |
| File Size | The size of the file (-1 if unknown). |
Error Code | The error code of the transfer (if an error occurred). |
| Error Message | The error message of the transfer (if an error occurred). |
| isServer | Indicates whether the UDMG Server is acting as a server (true) or as a client (false). |
| isSend | Indicates whether the transfer is a send (true) or a receive (false). |
| UUID | Transfer Unique Identifier, as string. |
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 task bar displays across the top of the Transfer Activity dashboard, which allows you to select which transfer instances display.
By Time Filter
The By Time constraint drop-down list in the Transfer Activity task bar allows you to select a time frame for transfer instances to display on the dashboard.
The default time constraint is 48 hours.
By Status Filter
The By Status field in the Transfer Activity task bar allows you to filter the dashboard so that only transfer instances matching the specified criteria within the selected time constraint are displayed on the dashboard.
By default, the filtering is disabled and all 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 on applying filters.
Toggle Columns Picker
The Toggle Columns picker allows you to select which columns are displayed on the dashboard.
A column can be hidden by selecting Hide in the column header contextual menu.
Displaying Transfer Details
To display Transfer Details for a transfer instance:
- Select the record from the list.
The transfer details are displayed in the Transfer tab.
Transfer Details Field Descriptions
The following table describes the default columns of information displayed in the Transfer Details.
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. |
| Step | The current step of the transfer (possible values: StepNone, StepSetup, StepPreTasks, StepData, StepPostTasks, StepErrorTasks, or StepFinalization). |
| Remote ID | Transfer Unique Identifier (UUID). |
| isServer | Indicates whether the UDMG Server is acting as a server (true) or as a client (false). |
| isSend | Indicates whether the transfer is a send (true) or a receive (false). |
| Start Date | Date and time the transfer instance started. |
| Stop Date | Date and time the transfer instance completed (only for DONE status). |
Error Code | The error code of the transfer (if an error occurred). |
| Error Message | The error message of the transfer (if an error occurred). |
Rule | The name of the transfer rule. |
| File Size | The size of the file (-1 if unknown). |
| Local File Path | The file path on the UDMG server. |
| Remote File Path | The file path on the remote partner. |
Requester | The name of the account that requested the transfer. |
| Requested | The 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 depends on the protocol, the associated pre-, post, and error tasks, and the type of the transfer.
Transfer Output Tab
The Output tab displays the log messages generated for the transfer request execution.
The Output tab displays a green icon, indicating that the log is available for the transfer. This is only the case if Detailed Logging has been enabled, see Logging Configuration.
When switching to this tab, the UDMG Admin UI retrieves and displays the log file. Reload of the log can be triggered with the refresh button inside the Output tab.
