Versions Compared

Key

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


Panel

Table of Contents

...

AttributeTypeDescriptionVersion Information
mft_transferobjectThe details of the main transfer record (the single transfer or the parent transfer in case of Wildcard Transfer).Introduced in 1.0.0
mft_transfer.transfer_idstringThe identifier of the transfer on UDMG.Introduced in 1.0.0
mft_transfer.statusstringThe current status of the transfer
One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELED or ERROR.
Introduced in 1.0.0
mft_transfer.startstringThe date and time the transfer has started (UDMG Server time)Introduced in 1.0.0
mft_transfer.stopstring

The date and time the transfer has ended (UDMG Server time).

For a wildcard transfer, this is when the listing of matching files and the registration of the child transfers is completed.

Introduced in 1.0.0
mft_transfer.stepstringThe current processing step of the transfer
One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION.
Introduced in 1.0.0
mft_transfer.transfer_progresstextThe progress of the data transfer in human-readable format
  • size in KB, MB, or GB for a Single Transfer,
  • "x out of y files" for a Wildcard Transfer.
Introduced in 1.0.0
mft_transfer.error_codestringThe error code of the transfer (if an error occurred).Introduced in 1.0.0
mft_transfer.error_msgstringThe error message (if an error occurred).Introduced in 1.0.0
mft_transfer.task_numberstringThe task number in the processing step.
Only for the steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'.
Introduced in 1.0.0
mft_transfer.local_filestringLocal file path.Introduced in 1.0.0
mft_transfer.remote_filestringRemote file path.Introduced in 1.0.0

mft_transfer.transfer_uuid

stringThe UUID of the transfer on UDMG.Introduced in 1.1.0

mft_transfer.transfer_info

object

The transfer information fields. 

Set of metadata associated with the transfer on the UDMG Server.

Fields with the udmg_ prefix are set internally by the UDMG server.

Fields with the udmg_ue prefix are set by the UDMG File Transfer task.

Introduced in 1.1.0

mft_transfer.transfer_info.udmg_ue_task_uuid

stringThe UUID of the UDMG File Transfer task.
It can be used to easily correlate the UC task executions and the corresponding UDMG file transfers.
Introduced in 1.2.0

mft_transfer.transfer_info.udmg_xfer_wildcard

boolean

Indicator that this is a wildcard transfer.

Only for MPUT and MGET.

Introduced in 1.2.0

mft_transfer.transfer_info.udmg_xfer_cmd

string

'list' is an indicator that this is a wildcard list command.

Only for LIST.

Introduced in 1.3.0

mft_transfer.transfer_info.udmg_xfer_childIDs

array

A list of UDMG transfer IDs that are created in the context of this file file transfer. For each file matching the filename input, one file transfer process is created in UDMG.

Only for MPUT and MGET.

Introduced in 1.2.0

mft_transfer.transfer_info.udmg_xfer_files

array

The list of files that matched the user input. Each of these files is transferred with a separate file transfer execution, which transfer IDs can be found in “udmg_xfer_childIDs“ list.

Only for MPUT and MGET.

Introduced in 1.2.0

mft_transfer_files_summary

objectSummary countersIntroduced in 1.2.0
mft_transfer_files_summary.donenumberNumber of file transfers with success.Introduced in 1.0.0
mft_transfer_files_summary.errornumberThe number of file transfers in error state.Introduced in 1.0.0
mft_transfer_files_summary.cancellednumberThe number of file transfers that are canceled.Introduced in 1.0.0

errors

arrayList of errors for the child transfers.Introduced in 1.2.0

...

FieldTypeDescriptionVersion Information
Transfer IDTextThe identifier of the transfer on UDMG.Introduced in 1.0.0
Transfer StatusText

The current status of the transfer.
One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLED or ERROR.

Used for Task instance Extension Status.

Introduced in 1.0.0
Transfer Start TimeTextThe date and time the transfer has started (UDMG Server time).Introduced in 1.0.0
Transfer End TimeText

The date and time the transfer has ended (UDMG Server time).

For a wildcard transfer, this is when the listing of matching files and the registration of the child transfers is completed.

Introduced in 1.0.0
Transfer StepTextThe current processing step of the transfer.
One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION.
Introduced in 1.0.0

Transfer Progress

TextThe progress of the data transfer in human-readable format.
  • size in KB, MB, or GB for a Single Transfer.
  • "x out of y files" for a Wildcard Transfer.

Introduced in 1.0.0

Modified in 1.2.0

Error CodeText

The UDMG transfer error code.

See the table below.

Introduced in 1.0.0
Error MessageTextThe error message (if an error occurred).Introduced in 1.0.0
Transfer Task NumberTextThe task number in the processing step.
Only for the Transfer Steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'.
Introduced in 1.0.0
Local FileTextLocal file path.Introduced in 1.0.0
Remote FileTextRemote file path.Introduced in 1.0.0

Transfer UUID

TextThe UUID of the transfer on UDMG.Introduced in 1.1.0

...

FieldDescription
idThe identifier of the transfer on UDMG
status

The current status of the transfer
One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELED, or ERROR

localFilepathThe path of the file on the local disk
startThe date and time the transfer has started (UDMG Server time)
stop

The date and time the transfer has ended (UDMG Server time)

filesizeThe size of the file in bytes (or -1 when unknown)
progressThe progress of the data transfer in bytes
remoteIDThe UUID of the transfer on UDMG
errorCodeThe UDMG transfer error code.
errorMessageThe error message (if an error occurred)

step

The current processing step of the transfer
One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION
taskNumberThe task number in the processing step.
Only for the Transfer Steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'
remoteFilepathThe path to the file on the remote partner
ruleThe name of the transfer rule
isSendIndicates whether the transfer is a send (true) or a receive (false)
requestedThe name of the server/partner that requested the transfer
requesterThe name of the account that requested the transfer

...

  • Deprecation: Integration is now compatible with Universal Controller and Universal Agent of version 7.3 and up.

Enhancements

...

  • Breaking Change: Transfer Progress output only field is changed to text value (#32195)

Enhancements

  • AddSupport Wildcard Transfer (#32198, #32195, #32201)
    1. New actions "MPUT" and "MGET" for wildcard transfers:
      • support for wildcard in source file parameter,
      • creation of wildcard transfer on UDMG,
      • monitoring of child transfers on UDMG,
      • tabular report on STDOUT with final child transfer status,
      • short summary report in EXTENSION output,
      • PAUSE, RESUME, and CANCEL commands are propagated to child transfers
    2. "Transfer Progress" output field is redefined to show human readable value
      • size in KB, MB, or GB for single transfer,
      • "x out of y files" for wildcard transfer
    3. "Max files to monitor" parameter: limit the number of child transfers that are monitored by the task instances, 100 by default.
    4. "Wait for transfer completion" parameter: task instance only returns when the transfer is completed (with DONE or CANCELLED status) on UDMG.
      For wildcard transfers, only returns when all child transfers are completed. Activated by default.
  • Add: Refresh task instance output with re-run (#32463)
  • AddKeep UC task instance ID in UDMG file transfer metadata field udmg_ue_task_uuid (#30931)

ue-mft-transfer-1.1.0 (2023-01-31)

...