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

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.1.0.0 and later with python options installed.
• Universal Agent for Linux Version 7.1.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.2.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
  • Trigger a File Transfer on UDMG to download a file from a remote partner.
  • Trigger a File Transfer on UDMG to upload a file 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).
  • Task is synchronous with the UDMG transfer and terminates when the transfer is completed (either with success or error)
• 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, HTTP, and HTTPS file transfer protocol

Import Universal Template

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

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

2. To import the Universal Template into your Controller, follow the instructions here.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

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.

Exit Codes

The exit codes for this Universal Extension are described below.

See description of the Transfer Error Code: https://doc.waarp.org/waarp-gateway/0.5.1/fr/reference/errorcodes.html

Extension Output

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

The Extension output contains attribute result. Attribute result contains the following sub-attributes:

An example of the Extension Output for an upload to HTTPS is presented below.

{
    "exit_code": 0,
    "status_description": "SUCCESS",
    "invocation": {
        "fields": {
            "credentials_user": "admin",
            "credentials_password": "****",
            "action": "PUT",
            "protocol": "https",
            "mft_server": "http://b2bmft.stonebranch.com:9180/api",
            "file": "hello.txt",
            "partner": "beeceptor",
            "rule": "beeceptor_send",
            "user": "bee",
            "advanced": false,
            "transfer_date": null,
            "polling_interval": 5
        }
    },
    "result": {
        "status": "SUCCESS",
        "mft_transfer": {
            "transfer_id": "237",
            "start": "2022-06-28T14:06:19.135894+00:00",
            "stop": "2022-06-28T14:06:20.836079+00:00",
            "status": "DONE",
            "step": null,
            "progress": 20,
            "task_number": null,
            "error_code": null,
            "error_msg": null,
            "local_file": "/atests/work/out/hello.txt",
            "remote_file": "/hello.txt"
        }
    }
}

STDOUT and STDERR

STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.

Document References

This document references the following documents.