Versions Compared

Old Version 7

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Olivier Michaut

Saved on

Key

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


Panel

Table of Contents


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

Template NameExtension NameExtension Version
UDMG File Transferue-mft-transfer1.1.0

Refer to Changelog 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
    • 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).
    • Capability to retry a failed transfer.
    • 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, HTTPS, PeSIT, and PeSIT-TLS 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.

FieldInput typeDefault valueTypeDescription
ActionRequiredPUTChoiceAction performed upon the task execution.
Available actions:
  • PUT
  • GET
ProtocolRequiredSFTPChoice
The transfer protocol.
Available values:
  • SFTP
  • HTTP
  • HTTPS
  • PeSIT
  • PeSIT-TLS
Note
titleNote

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 ServerRequired-TextUDMG Server URL.
For example: http://localhost:8080/api
MFT CredentialsRequired-CredentialsUDMG 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 FileRequired-TextThe name of file,
  • local file for PUT
  • remote file for GET

Target File

Introduced in version 1.1.0

Optional-TextThe name of file on the target system after the transfer,
  • remote file for PUT
  • local file for GET
PartnerRequired-Dynamic ChoiceDynamically 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.
RuleRequired-Dynamic ChoiceDynamically 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 AccountRequired-TextThe name of the account to use for the connection to the selected Partner.
The account credentials are configured on UDMG.
AdvancedOptionalFalseBooleanBy checking this field, more fields are available for advanced configuration.
Polling IntervalOptional5IntegerThe amount of time (in seconds) the task will wait before polling to check the transfer status.
Valid values from 0.

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

Command NameAllowed Task Instance StatusDescription
PauseRUNNINGIssue the pause command on the UDMG transfer
ResumeRUNNINGIssue the resume command on the UDMG transfer

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 field are also available as task instance variables, with ops_mft_ prefix:

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

...

Panel

{
  "exit_code": 0,
  "status_description": "SUCCESS",
  "invocation": {
    "fields": {
      "credentials_user": "mft1",
      "credentials_password": "****",
      "action": "GET",
      "protocol": "sftp",
      "mft_server": "http://b2bmft.stonebranch.com:9180/api",
      "file": "Winter.jpg",
      "output": "Winter_renamed.jpg",
      "partner": "wftpserver",
      "rule": "wftpserver_receive",
      "user": "demo",
      "advanced": false,
      "transfer_date": null,
      "polling_interval": 1
    }
  },
  "result": {
    "status": "SUCCESS",
    "mft_transfer": {
      "transfer_id": "21",
      "start": "2023-01-30T18:37:36.480008+00:00",
      "stop": null,
      "status": "DONE",
      "step": "StepNone",
      "progress": 664950,
      "task_number": null,
      "error_code": "TeOk",
      "error_msg": null,
      "local_file": "/data/in/Winter_renamed.jpg",
      "remote_file": "/download/Winter.jpg",
      "transfer_uuid": "1620129116105736192",
      "transfer_info": {}
    }
  }
}

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.

Document LinkDescription
Universal TemplatesUser documentation for creating, working with and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.

Anchor
Changelog
Changelog
Changelog

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