Versions Compared

Old Version 1

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 2

changes.mady.by.user Stonebranch

Saved on

Key

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

...

Template NameExtension NameExtension Version
UDMG File Transferue-mft-transfer1.1.0.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.

...

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

...

Universal Controller Version 7.23.0.0 and later.

Network and Connectivity Requirements

...

  • 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, HTTP, and HTTPS file transfer protocol

...

Dynamically fetched list of partner names.
FieldInput typeDefault valueTypeDescription
ActionRequiredPUTChoiceAction performed upon the task execution.
Available actions:
  • PUT
  • GET
ProtocolRequiredSFTPChoice
The transfer protocol.
Available values:
  • SFTP
  • HTTP
  • HTTPS
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
PartnerRequired

Target File

Introduced in version 1.1.0

Optional-Dynamic ChoiceTextThe 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.

...

Example for sending a file to a HTTPS server.

Image RemovedImage Added


The configuration on UDMG for the partner:

Image RemovedImage Added

GET a file from an SFTP server

Example for downloading a file from an SFTP server.

Image RemovedImage Added

The configuration on UDMG for the partner:

Image RemovedImage Added

Task Execution

...

FieldTypeDescription
Transfer IDTextThe unique identifier of the transfer on UDMG
Transfer StatusText

The current status of the transfer
One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLLED or ERROR

Used for Task instance Extension Status.

Transfer Start TimeTextThe date and time the transfer has started
Transfer End TimeTextThe date and time the transfer has ended
Transfer StepTextThe current processing step of the transfer
One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION
Transfer ProgressIntegerThe progress (in bytes) of the data transfer
Error CodeTextThe error code of the transfer (if an error occurred)
Error MessageTextThe error message (if an error occurred)
Transfer Task NumberTextThe number of the task in the processing step. Especially for the steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'
Local FileTextLocal file path
Remote FileTextRemote file path

Exit Codes

Transfer UUID

Introduced in version 1.1.0

TextThe UUID of the transfer on UDMG

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

Image Added

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

...

AttributeTypeDescription
transfer_idstringThe unique identifier of the transfer on UDMG
statusstringThe current status of the transfer
One of PLANNED, RUNNING, PAUSED, INTERRUPTED, DONE, CANCELLLED or ERROR
startstringThe date and time the transfer has started
stopstringThe date and time the transfer has ended
stepstringThe current processing step of the transfer
One of NONE, PRE TASKS, DATA, POST TASKS, ERROR TASKS or FINALIZATION
progressnumberThe progress (in bytes) of the data transfer
error_codestringThe error code of the transfer (if an error occurred)
error_msgstringThe error message (if an error occurred)
task_numberstringThe number of the task in the processing step. Especially for the steps 'PRE TASKS', 'POST TASKS', and 'ERROR TASKS'
local_filestringLocal file path
remote_filestringRemote file path

...

remote_id

Introduced in version 1.1.0

stringThe UUID of the transfer on UDMG

transfer_info

Introduced in version 1.1.0

arrayThe transfer information fields

An example of the Extension Output for an download from SFTP is presented below.

...

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.

...

STDOUT and STDERR

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

Fixes

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

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

  • Initial version