| Panel | |
|---|---|
|
...
| Field | Input type | Default value | Type | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| Action | Required | PUT | Choice | Action performed upon the task execution. Available actions:
| |||||
| Protocol | Required | SFTP | Choice | The transfer protocol. Available values:
| |||||
| MFT Server | Required | - | Text | UDMG Server URL. This is the URL for the REST API endpoint, the port is configured in the UDMG Server configuration file. For example: http://localhostudmg.stonebranch.com:8080/api | |||||
| MFT Credentials | Required | - | Credentials | UDMG Server Credentials. The Credentials definition should be as follows.
| |||||
| Source File | Required | - | Text | The name of file,
| |||||
Target File Introduced in version 1.1.0 | Optional | - | Text | The name of file on the target system after the transfer,
| |||||
| Partner | Required | - | Dynamic Choice | Dynamically fetched list of partner names. The list is restricted to the partners that support the selected Protocol. The user can select the required partner name from a drop-down list. | |||||
| Rule | Required | - | Dynamic Choice | Dynamically fetched list of transfer rules. The list is restricted to the rules that are assigned to the selected Partner. The user can select the required rule from a drop-down list. | |||||
| Partner Account | Required | - | Text | The name of the account to use for the connection to the selected Partner. The account credentials are configured on UDMG. | |||||
Wait for Transfer Completion Introduced in version 1.2.0 | Required | True | Boolean | By checking this field, the extension monitors the completion of the transfer on UDMG before completing its execution.
| |||||
| Polling Interval | Optional | 5 | Integer | The amount of time (in seconds) the task will wait before polling to check the transfer status. Valid values from 0. | |||||
Max Files to Monitor Introduced in version 1.2.0 | Required | 100 | Integer | The number of files, above which no monitor will be done, apart from the successful trigger of the file transfer. In practice this means that for the actions MGET & MPUT, if a wildcard transfer results in more child transfers than the number indicated, the extension will not check the transfer status of these files, and proceed to completion with a special return code (see corresponding section in this document). |
...
| Field | Type | Description |
|---|---|---|
| Transfer ID | Text | The identifier of the transfer on UDMG |
| Transfer Status | Text | The current status of the transfer Used for Task instance Extension Status. |
| Transfer Start Time | Text | The date and time the transfer has started (UDMG Server time) |
| Transfer End Time | Text | 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. |
| Transfer Step | Text | The current processing step of the transfer One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION |
Transfer Progress Modified in version 1.2.0 | Text | The progress of the data transfer in human readable format
|
| Error Code | Text | The UDMG transfer error code. See the table below. |
| Error Message | Text | The error message (if an error occurred) |
| Transfer Task Number | Text | The number of the task in the processing step. Only for the Transfer Steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS' |
| Local File | Text | Local file path |
| Remote File | Text | Remote file path |
Transfer UUID Introduced in version 1.1.0 | Text | The UUID of the transfer on UDMG |
...
| Attribute | Type | Description |
|---|---|---|
| mft_transfer | object | The details of the main transfer record (the single transfer or the parent transfer in case of Wildcard Transfer). |
| mft_transfer.transfer_id | string | The identifier of the transfer on UDMG. |
| mft_transfer.status | string | The current status of the transfer One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLLED or ERROR. |
| mft_transfer.start | string | The date and time the transfer has started (UDMG Server time) |
| mft_transfer.stop | string | 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. |
| mft_transfer.step | string | The current processing step of the transfer One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION. |
| mft_transfer.transfer_progress | text | The progress of the data transfer in human readable format
|
| mft_transfer.error_code | string | The error code of the transfer (if an error occurred). |
| mft_transfer.error_msg | string | The error message (if an error occurred). |
| mft_transfer.task_number | string | The number of the task in the processing step. Only for the steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'. |
| mft_transfer.local_file | string | Local file path. |
| mft_transfer.remote_file | string | Remote file path. |
mft_transfer.transfer_uuid Introduced in version 1.1.0 | string | The UUID of the transfer on UDMG. |
mft_transfer.transfer_info Introduced in version 1.1.0 | object | The transfer information fields. Set of metadata associated to the transfer on UDMG Server. The fields with udmg_ prefix are set internally by UDMG server. The fields with udmg_ue prefix are set by the UDMG File Transfer task. |
mft_transfer.transfer_info.udmg_ue_task_uuid Introduced in version 1.2.0 | string | The UUID of the UDMG File Transfer task. It can be used to easily correlate the UC task executions and the corresponding UDMG file transfers. |
mft_transfer.transfer_info.udmg_xfer_wildcard Introduced in version 1.2.0 | boolean | Indicator that this is a wildcard transfer. Only for MPUT and MGET. |
mft_transfer.transfer_info.udmg_xfer_childIDs Introduced in version 1.2.0 | array | A list of UDMG transfer IDs that are created in the context of this file file transfer. For each file matched the filename input, one file transfer process is created in UDMG. Only for MPUT and MGET. |
mft_transfer.transfer_info.udmg_xfer_files Introduced in version 1.2.0 | 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. |
mft_transfer_files_summary Introduced in version 1.2.0 | object | Summary counters |
| mft_transfer_files_summary.done | number | Number of file transfers with success. |
| mft_transfer_files_summary.error | number | Number of file transfers in error state. |
| mft_transfer_files_summary.cancelled | number | Number of file transfers that are cancelled. |
errors Introduced in version 1.2.0 | array | List of errors for the child transfers. |
...
| Field | Description |
|---|---|
| id | The identifier of the transfer on UDMG |
| status | The current status of the transfer |
| localFilepath | The path of the file on the local disk |
| start | The date and time the transfer has started (UDMG Server time) |
| stop | The date and time the transfer has ended (UDMG Server time) |
| filesize | The size of file in byte (or -1 when unknown) |
| progress | The progress of the data transfer in bytes |
| remoteID | The UUID of the transfer on UDMG |
| errorCode | The UDMG transfer error code. |
| errorMessage | The 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 |
| taskNumber | The number of the task in the processing step. Only for the Transfer Steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS' |
| remoteFilepath | The path to the file on the remote partner |
| rule | The name of the trasnfer rule |
| isSend | Indicates whether the transfer is a send (true) or a receive (false) |
| requested | The name of the server/partner that requested the transfer |
| requester | The name of the account that requested the transfer |
...
Breaking Change: Transfer Progress output only field is changed to text value (#32195)
Enhancements
Add: Support Wildcard Transfer (#32198, #32195, #32201)- New actions "MPUT" and "MGET" for wildcard tansfers:
- 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
- "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
- "Max files to monitor" parameter: limit the number of child transfers that are monitored by the task instances, 100 by default.
- "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.
- New actions "MPUT" and "MGET" for wildcard tansfers:
Add: Refresh task instance output with re-run (#32463)Add: Keep UC task instance ID in UDMG file transfer metadata field udmg_ue_task_uuid (#30931)
ue-mft-transfer-1.1.0 (2023-01-31)
...