JScape: Managed File Transfer
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
This integration provides UAC customers the ability to manage and integrate their JSCAPE Managed File Transfer Server processes within their UAC automation processes and workflows.
This integration delivers a JSCAPE MFT Universal Template that allows UAC customers to build Tasks to perform the following JSCAPE Managed File Transfer Server functions:
PGP Encrypt
PGP Decrypt
Run a UDM Gateway Trigger
SFTP File Upload
SFTP File Download
Trading Partner File Upload
Trading Partner File Download
Trading Partner File Upload using a Regex or Generic Filename Pattern
Trading Partner File Download using a Regex or Generic Filename Pattern
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.6 or higher. Tested with the Universal Agent bundled Python distribution.
Python modules required:
requests version 2.22.0
Software Requirements for Universal Agent
Either:
Universal Agent for Windows x64 Version 7.0.0.0 and later with python options installed
Universal Agent for Linux Version 7.0.0.0 and later with python options installed
Software Requirements for Universal Controller
Universal Controller Version 7.0.0.0 and later
Software Requirements for the Application to be Scheduled
JSCAPE Managed File Transfer Server version 12 and higher.
Integration Description
Integration Flow
The JSCAPE MFT Universal Task performs the following:
Login to JSCAPE MFT Server
Check JSCAPE MFT Server Version
Create Temporary JSCAPE MFT Server Trigger with a generated unique name to perform the desired action. Except Run Trigger which runs the requested Trigger definition directly.
Run JSCAPE MFT Server Trigger.
Get JSCAPE MFT Server Trigger Status
If Successful, delete the Temporary Trigger definition (Except Run Trigger)
Retrieve Trigger Log
Output Only Fields
The JSCAPE MFT Universal Task Instances will provide the following display information:
Fieldname | Description |
|---|---|
Trigger Name | Returns the generated temporary trigger name, except for Run Trigger when the Trigger name is displayed. |
Trigger Status | Returns the current status of the Trigger. |
Trigger ID | Returns the JSCAPE MFT Server Trigger Process ID. |
MFT Server Version | Returns the version of the JSCAPE MFT Server. |
Dynamic Commands
The following Universal Task Instance specific commands are available:
Command Name | Allowed Task Instance Status' | Description |
|---|---|---|
Cancel (Kill) Trigger | RUNNING | Issues the JSCAPE MFT Server Kill command against the running Trigger. |
Cleanup (Delete) Temporary Trigger | FAILED | Deletes the temporary Trigger. Use this option if you do not want to rerun a failed temporary Trigger, failed triggers are not automatically deleted to facilitate a rerun of the Trigger. It is recommended to Force Finish the failed Universal Task instance after deleting the temporary trigger. This command is not effective for Run Trigger. |
Task Instance Rerun Behavior
Performing a rerun against a JSCAPE MFT Universal Task instance behaves as follows.
When the task is rerun and no JSCAPE MFT Server Trigger Process ID is available a new Trigger will be created and run.
When the task is rerun and a JSCAPE MFT Server Trigger Process ID is available a JSCAPE MFT Server Rerun command will be issued against the existing Trigger. Note that for the Run Trigger Function the behavior of the JSCAPE MFT Server Rerun command can be impacted by the “On Rerun Restart All Actions” option in the Task instance definition.
Import Universal Template
To use the Universal Template, you first must perform the following steps:
This Universal Task requires the Resolvable Credentials feature, check that the Resolvable Credentials Permitted system property has been set to true. For more information about Resolvable Credentials click here.
Download the provided ZIP file.
In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.
Click Import Template.
Select the template ZIP file and Import.
When the template has been imported successfully, the Universal Template will appear on the list, refresh your Navigation Tree to see these tasks in the Automation Center Menu.
Configure Universal Task
Create JSCAPE MFT Tasks as required.
Field Descriptions for JSCAPE MFT Universal Task
Function = PGPEncrypt
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the PGPEncrypt Function. |
Encrypted File Name | The name of the target encrypted file. |
Plain Text File Name | The name of the source plaintext file. |
PGP Key | Select the PGP Key to use for encryption. |
Delete Source File | Specify if the source plaintext file is to be deleted. |
Compress | Specify if the target encrypted file is to be compressed. |
Function = PGPDecrypt
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the PGPDecrypt Function. |
Encrypted File Name | The name of the source encrypted file. |
Plain Text File Name | The name of the target plaintext file |
PGP Key | Select the PGP Key to use for encryption. |
Delete Source File | Specify if the source encrypted file is to be deleted. |
Function = RunTrigger
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the RunTrigger Function. |
Trigger Name | Select the required JSCAPE MFT Server Trigger. |
On Rerun Restart All Actions | Check this option to restart Trigger form the beginning when performing a rerun of the task instance, leave unchecked to start from the failed or cancelled Trigger action. |
Function = SFTPUpload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the SFTPUpload Function. |
SFTP Host | Specify the remote SFTP server Host Name or IP address. |
SFTP Port | Specify the remote SFTP server port. |
SFTP Credential | Select the Credential definition to access the remote SFTP server. |
Local File Name | Specify the location of the Local File. |
Remote Directory | Specify the remote SFTP Server Directory. |
Transfer Mode | Specify the Transfer Mode. |
Overwrite if File Exists | Check to overwrite destination file(s) if it exists. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Function = SFTPDownload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the SFTPDownload Function. |
SFTP Host | Specify the remote SFTP server Host Name or IP address. |
SFTP Port | Specify the remote SFTP server port. |
SFTP Credential | Select the Credential definition to access the remote SFTP server. |
Local File Name | Specify the location of the Local File. |
Remote File Name | Specify the remote SFTP File. |
Transfer Mode | Specify the Transfer Mode. |
Overwrite if File Exists | Check to overwrite destination file(s) if it exists. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Function = TradingPartnerUpload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the TradingPartnerUpload Function. |
Trading Partner | Select the JSCAPE MFT Server Trading Partner definition. |
Local File Name | Specify the location of the Local File. |
Remote Directory | Specify the remote Trading Partner Directory. |
Transfer Mode | Specify the Transfer Mode. |
Passive Mode | Check to use passive mode. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Function = TradingPartnerDownload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the TradingPartnerDownload Function. |
Trading Partner | Select the JSCAPE MFT Server Trading Partner definition. |
Local File Name | Specify the location of the Local File. |
Remote File Name | Specify the remote Trading Partner File. |
Transfer Mode | Specify the Transfer Mode. |
Passive Mode | Check to use passive mode. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Function = TradingPartnerRegExUpload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the TradingPartnerRegExUpload Function. |
Trading Partner | Select the JSCAPE MFT Server Trading Partner definition. |
Regular Expression / Wildcard | Specify the Regular Expression or Wildcard. |
Expression Type | Select either "Regular Expression" or "Widlcard". |
Local Directory | Specify the location of the Local File. |
Remote Directory | Specify the remote Trading Partner Directory. |
Transfer Mode | Specify the Transfer Mode. |
Passive Mode | Check to use passive mode. |
Fail if No Files Found | Check to fail if no files match the specified expression (Regular Expression or Wildcard). |
Delete on Success | Check to delete source files after successful transfer. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Function = TradingPartnerRegExDownload
Field | Description |
MFT Server URL | MFT Server URL: that is, https://localhost:11443 |
MFT Server Credential | UC credential definition containing a valid JSCAPE MFT Server Administrator username and password. |
Domain | Select the required JSCAPE MFT Server Domain name. |
Function | Select the TradingPartnerRegExDownload Function. |
Trading Partner | Select the JSCAPE MFT Server Trading Partner definition. |
Regular Expression / Wildcard | Specify the Regular Expression or Wildcard. |
Expression Type | Select either "Regular Expression" or "Widlcard". |
Local Directory | Specify the location of the Local File. |
Remote Directory | Specify the remote Trading Partner Directory. |
Transfer Mode | Specify the Transfer Mode. |
Passive Mode | Check to use passive mode. |
Fail if No Files Found | Check to fail if no files match the specified expression (Regular Expression or Wildcard). |
Delete on Success | Check to delete source files after successful transfer. |
Retry Limit | Specify the Maximum Retry Attempts. |
Retry Interval | Specify the Interval in Seconds Between Retries. |
Examples for JSCAPE MFT Universal Tasks
Document References
This document references the following documents:
Name | Description |
|---|---|
User documentation for creating Universal Templates in the Universal Controller user interface. | |
User documentation for creating Universal Tasks in the Universal Controller user interface. |