Panel

Table of Contents

Actions
- GET: trigger a File Transfer on UDMG to download a file from a remote partner.
- PUT: trigger a File Transfer on UDMG to upload a file to a remote partner.
- MGET:trigger a Wildcard File Transfer on UDMG to download several files from a remote partner.
- MPUT: trigger a Wildcard File Transfer on UDMG to upload several files to a remote partner.
File Transfer Control
- Capability to pause a partial transfer.
- Capability to resume a paused transfer.
- Capability to cancel a transfer (from planned, running, paused, or error status).
- Capability to retry a failed transfer.
- Synchronous mode: the task monitors the UDMG transfer and terminates when the transfer is completed (either with success or error).
- Asynchronous mode: the task registers the UDMG transfer and terminates when the transfer request is acknowledged on UDMG.
Input/Output
- Capability for the UAC task author, to retrieve the list of partners from UDMG for a given protocol.
- Capability for the UAC task author, to retrieve the list of transfer rules from UDMG for a given partner.
- Monitor of the transfer with periodic polling from UDMG and display to output-only fields and extension output.
Other
- Support for SFTP, HTTPS, PeSIT, and PeSIT-TLS file transfer protocol.

Import Universal Template

...

This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to IntegrationModifications.

Configure Universal Task

For a new Universal Task, create a new task, and enter the required input fields.

...

Field

Input type

Default value

Type

Description

Action

Required

PUT

Choice

Action performed upon the task execution.
Available actions:

GET
PUT
MGET
MPUT

Protocol

Required

SFTP

Choice

The transfer protocol.
Available values:

SFTP
HTTP
HTTPS
PeSIT
PeSIT-TLS

Note

title	Note

The protocol serves as a filter for the Partner list. The actual protocol for the file transfer is the one that is configured on UDMG for the selected Partner

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.

User Name as "Runtime User".
User Password as "Runtime Password".

The user must have read permissions for rules and partners, read/write permission for transfers

Source File

Required

-

Text

The name of file,

local file for PUT
remote file for GET
wildcard pattern for local files
wildcard pattern for remote files

Target File

Introduced in version 1.1.0

Optional

-

Text

The name of file on the target system after the transfer,

remote file for PUT
local file for GET
not used for MGET and MPUT

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.

Actions PUT/GET: Wait for the single transferred to be completed.
Actions MPUT/MGET: Wait for the child file transfers to be completed or not. The extension will always wait for the parent process to be completed successfully, regardless of this configuration attribute.

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 One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLLED or ERROR 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 size in KB, MB, or GB for a Single Transfer, "x out of y files" for a Wildcard Transfer
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 size in KB, MB, or GB for a Single Transfer, "x out of y files" for a Wildcard Transfer.
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 One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLLED or ERROR
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

...

Expand

Code Block

  id  status    localFilepath                    start                             stop                                filesize    progress             remoteID  errorCode    errorMsg    step      taskNumber    remoteFilepath                       rule                   isSend    requested    requester
----  --------  -------------------------------  --------------------------------  --------------------------------  ----------  ----------  -------------------  -----------  ----------  --------  ------------  -----------------------------------  ---------------------  --------  -----------  -----------
 480  DONE      /data/in/mail-editor.png         2023-05-11 10:44:30.493303+00:00  2023-05-11 10:44:40.853704+00:00       16471       16471  1656611233584906240  TeOk                     StepNone                /pub/example/mail-editor.png         rebex_receive_example  False     rebex        demo
 481  DONE      /data/in/mail-send-winforms.png  2023-05-11 10:44:30.493303+00:00  2023-05-11 10:44:50.856191+00:00       35414       35414  1656611233622654976  TeOk                     StepNone                /pub/example/mail-send-winforms.png  rebex_receive_example  False     rebex        demo
 482  DONE      /data/in/mime-explorer.png       2023-05-11 10:44:30.493303+00:00  2023-05-11 10:45:00.860761+00:00       49011       49011  1656611233656209408  TeOk                     StepNone                /pub/example/mime-explorer.png       rebex_receive_example  False     rebex        demo

Document References

This document references the following documents.

...

Integration Modifications

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

Python code modifications should not be done.
Template Modifications
- General Section
  - "Name", "Extension", "Variable Prefix", "Icon" should not be changed.
- Universal Template Details Section
  - "Template Type", "Agent Type", "Send Extension Variables", "Always Cancel on Force Finish" should not be changed.
- Result Processing Defaults Section
  - Success and Failure Exit codes should not be changed.
  - Success and Failure Output processing should not be changed.
- Fields Restriction Section
  The setup of the template does not impose any restrictions, However with respect to "Exit Code Processing Fields" section.
  1. Success/Failure exit codes need to be respected.
  2. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining success or failure of a task.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Document References

This document references the following documents.

Document Link	Description
Universal Templates	User documentation for creating, working with and understanding Universal Templates and Integrations.
Universal Tasks	User documentation for creating Universal Tasks in the Universal Controller user interface.
Credentials	User documentation for creating and working with credentials.
Resolvable Credentials Permitted Property	User documentation for Resolvable Credentials Permitted Property.

Anchor

	Changelog
	Changelog

Changelog

ue-mft-transfer-1.2.0 (2023-05-09)

...

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

Enhancements

Add: Support Wildcard Transfer (#32198, #32195, #32201)
1. New actions "MPUT" and "MGET" for wildcard tansferstransfers:
  - 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)
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)

...

Versions Compared

Old Version 5

New Version Current

Key

Import Universal Template

Configure Universal Task

Document References

Integration Modifications

Document References

Changelog

ue-mft-transfer-1.2.0 (2023-05-09)

Enhancements

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

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Import Universal Template

Configure Universal Task

Document References

Integration Modifications

Document References

Changelog

ue-mft-transfer-1.2.0 (2023-05-09)

Enhancements

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