Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

UDMG (Universal Data Mover Gateway) is a business-to-business MFT (Managed File Transfer) Solution. It provides the capabilities to securely manage File transfers with external business partners (i.e. Customers or Suppliers), and between any endpoint in today’s Hybrid-IT infrastructure, on-premises, or in the cloud (public and or private).

This Universal Extension provides the capability to perform file transfer where UDMG is the client and upload or download files to remote partners.

Version Information

Refer to 191594497 for version history information.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

Both Windows and Linux agents are supported.

• Universal Agent for Windows x64 Version 7.3.0.0 and later with python options installed.
• Universal Agent for Linux Version 7.3.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.3.0.0 and later.

Network and Connectivity Requirements

Universal Agent requires connectivity towards the UDMG Server REST API.

Key Features

This Universal Extension provides the following key features:

• 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

To use the Universal Template, you first must perform the following steps.

...

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 191594497.

Configure Universal Task

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

Input Fields

The input fields for this Universal Extension are described below.

Task Examples

PUT a file to HTTPS partner

Example for sending a file to a HTTPS server.

...

The configuration on UDMG for the partner:

GET a file from an SFTP server

Example for downloading a file from an SFTP server.

...

The configuration on UDMG for the partner:

Task Execution

Dynamic Commands

Cancelation

When the task instance is canceled on the Controller, a cancel command is issued on the UDMG transfer to attempt a graceful termination.

Task Output

Output Only Fields

The output fields for this Universal Extension are described below.

These fields are also available as task instance variables, with the ops_mft_ prefix:

UDMG Transfer Error Code

Exit Codes

The exit codes for this Universal Extension are described below.

Extension Output

In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.

...

...

{
    "exit_code": 0,
    "status_description": "Task executed successfully",
    "invocation": {
        "fields": {
            "credentials_user": "admin",
            "credentials_password": "****",
            "action": "MGET",
            "protocol": "sftp",
            "mft_server": "http://udmg.stonebranch.com:8080/api",
            "file": "m*.png",
            "output": null,
            "partner": "rebex",
            "rule": "rebex_receive_example",
            "user": "demo",
            "wait_for_completion": true,
            "transfer_date": null,
            "polling_interval": 5,
            "max_file_to_monitor": 100,
            "ue_task_uuid": "168355254050277290080KCA7YT971DJ"
        }
    },
    "result": {
        "mft_transfer": {
            "transfer_id": "479",
            "start": "2023-05-11 10:44:30.493303+00:00",
            "stop": "2023-05-11 10:44:31.144255+00:00",
            "status": "DONE",
            "step": "StepNone",
            "transfer_progress": "3 out of 3 files",
            "task_number": null,
            "error_code": "TeOk",
            "error_msg": null,
            "local_file": "/data/in/m*.png",
            "remote_file": "/pub/example/m*.png",
            "transfer_uuid": "1656611231072518144",
            "transfer_info": {
                "udmg_sftp_client_version": "SSH-2.0-Go",
                "udmg_sftp_config_ciphers": [
                    "aes128-gcm@openssh.com",
                    "chacha20-poly1305@openssh.com",
                    "aes128-ctr",
                    "aes192-ctr",
                    "aes256-ctr"
                ],
                "udmg_sftp_config_kex": [
                    "curve25519-sha256@libssh.org",
                    "ecdh-sha2-nistp256",
                    "ecdh-sha2-nistp384",
                    "ecdh-sha2-nistp521",
                    "diffie-hellman-group-exchange-sha256",
                    "diffie-hellman-group1-sha1",
                    "diffie-hellman-group14-sha1"
                ],
                "udmg_sftp_config_mac": [
                    "hmac-sha2-256-etm@openssh.com",
                    "hmac-sha2-256",
                    "hmac-sha1",
                    "hmac-sha1-96"
                ],
                "udmg_sftp_failed_auth_methods": [
                    "none"
                ],
                "udmg_sftp_hostkey_algo": "ssh-rsa",
                "udmg_sftp_kex_algo": "curve25519-sha256@libssh.org",
                "udmg_sftp_read_algos": {
                    "cipher": "aes128-gcm@openssh.com",
                    "compression": "none",
                    "mac": ""
                },
                "udmg_sftp_server_version": "SSH-2.0-RebexSSH_5.0.8466.0",
                "udmg_sftp_sucessful_auth_methods": "password",
                "udmg_sftp_write_algos": {
                    "cipher": "aes128-gcm@openssh.com",
                    "compression": "none",
                    "mac": ""
                },
                "udmg_ue_task_uuid": "168355254050277290080KCA7YT971DJ",
                "udmg_xfer_childIDs": [
                    480,
                    481,
                    482
                ],
                "udmg_xfer_files": [
                    "mail-editor.png",
                    "mail-send-winforms.png",
                    "mime-explorer.png"
                ],
                "udmg_xfer_log": "/config/logs/479.log",
                "udmg_xfer_wildcard": true
            }
        },
        "mft_transfer_files_summary": {
            "done": 3,
            "error": 0,
            "cancelled": 0
        },
        "errors": []
    }
}

STDOUT and STDERR

STDERR provides additional information to User about the task instance execution. Verbosity is increased with the Task Log Level, The Debug level can lead to extensive details and is only recommended for troubleshooting.

...

...

  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

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.

...

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

Document References

This document references the following documents.

Changelog

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

Deprecations and Breaking Changes

• 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 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)
• 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)

Deprecations and Breaking Changes

• Breaking Change: minimum universal agent version set to 7.3

Enhancements

• Add: set target filename (rename file) (#31174)
• Add: transfer status as UC 7.3 extension status field. (#31041)
• Add: retry failed transfer with Task Re-run. (#29599)
• Add: show UUID. (#30733)
• Add: show transfer info fields. (#30930)
• Add: support for PeSIT and PeSIT-TLS protocols (#31051)

Fixes

• Fix: optimize number of API calls. (#29247)

ue-mft-transfer-1.0.0 (2022-06-30)

• Initial version