Trading Partner Regex File Download

This Action downloads a file or files to the local system.

 

 

Parameters tab

ACTION

Name — Identifies the name of the Action. The system-generated default name, depicted in the image above, can be changed to a different name to suit your preferences. The Name must be unique within the current Trigger workflow.

 

Notes — Describes the Action.

 

The values in the Name and Notes fields are displayed in a tooltip when you mouse over an Action node.

 

CONNECTION

Partner — Identifies the Trading Partner that is used in the Trigger Action. The dropdown list displays the Trading Partners created in AUTOMATION > Trading Partners that are compatible with this Action. Select the desired Trading Partner from the list. The connection information (e.g., hostname, port, etc.) used in the Action is obtained from the Trading Partner.

 

TARGET

Remote Directory — Identifies the remote directory name to download the files from.

 

Regular Expression — Identifies the expression used to determine what files to download.

 

Expression Type — Identifies the expression type, which is either a wildcard or regular expression.

 

Local Directory — Identifies the path where the files will be downloaded to.

 

Latency Period — Identifies the number of seconds that should pass from the file's last modification time in order to include the file in the download.

 

Fail if No Files Found — If selected, the Action fails if no files match the expression specified.

 

Perform Checksum — If selected, results in a file comparison after the download - to ensure data integrity.

 

Preserve File Timestamp — If selected, the date modified time stamp is preserved. The creation date is always the time the download occurred, regardless of the status of this field.

 

Delete on Success — If selected, the original file(s) are deleted after the download.

 

Ignore Bucket Name Validation — If selected, bucket name validation is skipped. This is useful if your bucket name does not follow S3 bucket naming conventions.

 

This field is applicable only when the Trading Partner type is S3 Compatible.

 

Advanced tab

 

CONNECTION

Reading Buffer Size — Identifies the amount of data (KB) that can be read in 1 request.

 

Writing Buffer Size — Identifies the amount of data (KB) that can be written in 1 request. When the write buffer is full, the system pushes the data to its destination.

 

For more details see Trigger Actions with Buffer Size Fields

 

Transfer mode — Identifies the Transfer Mode which includes binary, ASCII or auto.

 

Passive — If selected, passive mode is used.

TRANSFER

Threads — Identifies the number of threads.

 

EXECUTION

Retry Limit — Identifies the number of times a failed Action is retried before aborting the process.

 

When Retry is > 0 and a file transfer is interrupted, the transfer resumes where it left off if a connection can be re-established within the specified number of retries.

 

Retry Interval — Identifies the number of seconds in between retries.

 

Priority — Identifies the Action’s priority. An Action can be interrupted by an Action with a higher priority. The highest priority is 1. The maximum priority value is 1000. Priority comes into play when certain scenarios occur, like when Triggers or transfers are exceeded (see Settings for more information).

 

LOG

Debug file — Identifies the complete file path where debugging information is saved during an Action's execution. The system logs information and errors for both successful and failed Actions.

 

  • The file can be located anywhere on the MFT Server system.

  • If the file does not exist, it is created, and debug information is appended to it.

  • If the file already exists, debug information is appended to the existing file.

 

 

It is recommended you specify a debug file name that will allow you to quickly identify which Action produced the file. If you would like the file name to match the name of your Trigger, use the built-in event variable %TriggerName%.

 

If you would like to use a new file each time the Action executes, you can append a date/time stamp the root of the file name.

%DateFormat(CurrentDate(),"MM.dd.yyyy_H.m.s")%.txt. This will result in individual debug files each time an Action is run, instead of using a single file that may grow overly large when it is repeatedly appended to.

Debug files are not purged by the system. To prevent too many files from growing unchecked, you can create a Current Time event Trigger, using a condition (e.g. DayofWeek = 5) to clean up the files at the time specified using a Delete Files Action. See Using time based triggers.

If you plan on using a single directory on the MFT Server to store all the debug files, you can create a global variable in Triggers > Settings and reference that variable in the debug file name.

%GetGlobalVariable("DirName")% where DirName consists of a directory name. If the location of the directory should ever change, you can update the value of one global variable to reflect the change.

See below an example debug file name that uses all the file naming tips described in this section.

 

%GetGlobalVariable("DirName")%%TriggerName%%DateFormat(CurrentDate(),"MM.dd.yyyy_H.m.s")%.txt, where the DirName global variable is equal to C:\MFTServerDebugFiles\.

Trigger Error Message — Used when a Trigger Action fails. The two uses are described below.

 

  1. The Trigger Error Message is displayed in the Trigger Error column of the Action history (Triggers > History > View).

     

  2. If you create an error-handling Trigger, the Trigger Error Message is passed to the error-handling Trigger.

  • An error-handling Trigger is a distinct Trigger that uses the Trigger Error Event type, as selected in the Trigger > Parameters dialog.

  • If a Trigger Error event occurs, the Trigger Error Trigger runs.

  • The Trigger Error Message is accessible in the Trigger Error Trigger as a variable named TriggerErrorMessage.

The image below depicts the Trigger Error Message displayed in the history of a failed Trigger Action.

 

 

The image below depicts selecting the Trigger Error Event type used to handle Trigger errors.

 

 

The image below depicts a Trigger Action (part of the Trigger Error Trigger workflow) accessing a Trigger Error Message. This is accomplished using the TriggerErrorMessage variable. To reference built-in variables, enclose the variable name in percent signs (%).

 

 

As a practical use case example, you can reference the Trigger Error Message in the body of an Email Action that is part of the Trigger Error workflow. The email alerts interested parties that a Trigger Action failed.

Log Action — When selected, Trigger Action records are added to the Domain > AUDIT > Logging module. The state of the Action is included, such as action started, action completed, and action failed. When unselected, Action records are not added to the Logging module. However, the Trigger itself is still logged.

Buttons

Add Variable — Displays a list of built-in event variables. Each Trigger has several event variables you can use in one or more of the Trigger Action fields. When a variable is selected from the list, it is added to the Action field that is currently active. Built-in event variables are enclosed using the percent sign (e.g., %DomainName%).

 

In addition to using built-in variables, you can also specify a user-defined global variable, created in AUTOMATION > Triggers > Settings. To reference a global variable (Defining global variables), use the %GetGlobalVariable% function.

 

%GetGlobalVariable("DirName")% retrieves the global variable named DirName. When using global variables, specify the variable name enclosed in quotes, as depicted in this example.

 

Add Function — Displays a list of built-in functions. Functions are useful for formatting or parsing a Trigger event variable. When a function is selected from the list, it is added to the Action field that is currently active. For more details about functions and their usage, see Function types.

 

Link Action — Displays a list of Actions. When an Action is selected, the Action ID is returned.

 

An Action ID (a string of alphanumeric characters) is an input parameter used in the GetActionResult function. This function returns the results of a previously executed Action in the current Trigger workflow. This means that Action results can be passed to a linked (following) Action.

 

The GetActionResult function also supports using the Action Name as an input parameter. This is an enhancement added in a more current version of MFT Server.

Using Link Action

  1. Select a field in the Trigger Action that you want to populate using the results of a previous Action.

     

  2. Click Add Function. A list of functions displays.

     

  3. Select GetActionResult(actionId). The field displays %GetActionResult(actionId)%.

     

  4. Highlight the word actionId in the field.

     

  5. Click Link Action. A list of Actions displays.

     

  6. Select an Action. The actionId text is replaced with the Action ID.

The GetActionResult function looks similar to this: %GetActionResult("bee7cd8b-8021-4e19-8f76-1ae382e60c9d")%