Managing Actions

You can define actions and trigger them to enable webMethods.io MFT to perform a configured task or set of tasks.

Types of webMethods.io MFT actions

There are two types of webMethods.io MFT actions:

Adding a Post-Processing Action

You can define a post-processing action for execution when a user uploads, downloads, or deletes a file.

To add a post-processing action

  1. On the navigation pane, select Actions > Post-Processing.

  2. On the Post-Processing actions page, you can do one of the following:

    • If you want to create a new action, click .
    • If you want to create a copy of an action that already exists, select an existing action, and click .

  3. To define the conditions that trigger the action, specify the following details:

    Field Description
    Action name Type a unique name for the post-processing action.
    Description Type a brief description for the post-processing action.
    Active Click the toggle button to activate or deactivate the action.
    Criteria Click . In the Criteria dialog box, configure the following criteria based on which webMethods.io MFT will execute tasks, and click Ok.
    Execute the tasks below when a user performs the file operation Select the file operation from the list.
    Note: If you specify an action based on the deletion of a file, make sure that any subsequent tasks you define for the action do not rely on the presence of the deleted file.
    Virtual folder To specify any folder or a particular folder, select Any folder or Specific folder respectively.
    For Specific folder, type a specific folder name in the box. You can use wildcard characters in the folder name box (for example, *baseName). By default, webMethods.io MFT considers file activity in any folder structure when evaluating action criteria.
    File transfer status To specify a file transfer status, select Success or Failure, Success, or Failure.
    Task execution by To enable webMethods.io MFT to execute the action for file operations performed by particular users, groups, or roles, select Any user or Specific users and click , select the users, and click OK.
    Execute tasks To specify whether to execute the tasks immediately, after the user exits all sessions, or after the user is idle for few seconds, select Immediately, After the user exists all sessions, or After the user is idle for and type the number of seconds to wait before executing the action in the box.
    Tasks Select one or more of the following tasks, and define configurations for each of the tasks in the Properties section accordingly:
    Parallel processing
    Enable parallel processing Select this option if you want to enable parallel processing of files in multiple threads.
    Start parallel processing for files after Select the task after which webMethods.io MFT must start parallel processing of files in multiple threads from the list. webMethods.io MFT first executes the task you select here, and any other tasks before it, sequentially.
    Maximum number of parallel processes Type the maximum number (between one and 999) of parallel threads that webMethods.io MFT can create to simultaneously process files.
  4. Click Add. The new post-processing action appears in the post-processing actions list.

Adding a Scheduled Action

You can define a scheduled action for execution at a specific date and time.

To add a scheduled action

  1. In the navigation pane, select Actions > Scheduled.

  2. On the Scheduled actions page, you can do one of the following:

    • If you want to create a new action, click .
    • If you want to create a copy of an action that already exists, select an existing action, and click .

  3. To define the conditions that trigger the action, specify the following details:

    Field Description
    Action name Type a unique name for the scheduled action.
    Description Type a brief description for the scheduled action.
    Active Click the toggle button to activate or deactivate the action.
    Schedule settings Click . In the Configure criteria dialog box, select one of the following options from the list to specify how often webMethods.io MFT should execute the tasks associated with an action, and click OK:
    • Run once: Specify the Date and Time to execute the task. Click the calendar icon to select a date from the calendar.
    • Yearly: Specify a date range, the months, the days within the month, and the time interval you want to execute the task each year.
    • Monthly: Specify a date range, the days within the month, and the time interval you want to execute the task each month.
    • Weekly: Specify a date range, the days of the week, and the time interval you want to execute the task each week.
    • Daily: Specify a date range and the time interval you want to execute the task each day.
    • Hourly: Specify a date range and the time interval you want to execute the task each hour.
    • Fixed interval: Specify a date range and the time interval that should wait before executing the next task for a scheduled action.
    Tasks Select one or more of the following tasks, and define configurations for each of the tasks in the Properties section accordingly:
    Parallel processing
    Enable parallel processing Select this option if you want to enable parallel processing of files in multiple threads.
    Start parallel processing for files after Select the task after which webMethods.io MFT must start parallel processing of files in multiple threads from the list. webMethods.io MFT first executes the task you select here, and any other tasks before it, sequentially.
    Maximum number of parallel processes Type the maximum number (between one and 999) of parallel threads that webMethods.io MFT can create to simultaneously process files.
  4. Click Add. The new scheduled action appears in the scheduled actions list.

Task Configuration Definitions

After you add an action and define the conditions that trigger the action, you must define one or more tasks to execute when the action is triggered. After you define tasks for a post-processing or scheduled action activate the action as described in Activating or Deactivating Actions.

A post-processing action is triggered for each file based on the criteria configured in the action. The action is triggered by a file upload, file download, or a file delete. The action is executed for one file at a time. If an error occurs in the action, the file processing is stopped after processing the files in the current task.

For scheduled action, the “find” task is the first task that you define, by default. Otherwise, the scheduled action will fail. The files listed by the find task is the source of input files for the action. If the find task returns more than one file, the subsequent tasks will operate on all the files. Each task configured in the action will complete the operation on all the files in the list and pass on the set of files to the subsequent task.

If an error task is configured in the action, one error task is executed for each file transaction that has an error. If the find task returns an empty list, subsequent tasks will be executed with 0 files as input.

Find Task Configuration

You can configure the following properties for the Find file operation task:

Field Description
Task name Type a unique name for the task.
Source location Select one of the following options to configure the location where the file will be searched for:
  • Remote path, if the destination location is on a remote server or network, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://:/DestinationFolder/.
Note: If you want to find and copy files from remote, third-party HTTP(S) servers, ensure that the you provide appropriate certificate alias here. Deselect ActiveTransfer HTTP(S) Server box for third-party HTTP(S) servers and specify the File Name Identification to locate the file name either from the URL or a specific file name.
  • Type the User name and Password for the remote server.
  • Click Test Connection to check the connection to the remote server.
Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the certificate alias parameters. You can then use the folder that you configured in the Virtual folder option of the Source location in the task.
  • Virtual folder: To specify a virtual folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.
Note: The virtual folder that you select should be configured on the same webMethods.io MFT instance on which the action is configured.
Any file name Select this option if you want find files with any name.
Specific file name Select this option if you want to filter files with specific names (for example, *.xml) and type the file name in the text box. This option is disabled if you select Any file name.
Execute error task Select this option to execute an error task if the file operation fails.
Advanced
Exclude folders Select this option if you want webMethods.io MFT to ignore folders and their contents in the find task.
Folder depth Specify the folder depth if you want to include subfolders in the search criteria for the find task. The default value is 1 which restricts the search to the root folder.
Maximum items to find Specify the number of records to restrict in the find task results. The default is 0 which includes all the records that match the search criteria for the find task.
Last file modification Specify one of the following time periods in which the file was last modified to narrow the search:
  • before, if you want to specify the time before which files were modified.
  • within, if you want to specify the time (including the current date) within which files were modified.
Note: You must specify at least one time criteria if you select a time variable.

In the Days, Hours, Minutes boxes respectively, type the days, hours, and minutes at which to apply the selected time variable.

For example, let us assume that you have specified the time variable as Before, with 2 days and 6 hours as the time variable. When webMethods.io MFT executes the find task on 30 April, it searches for all files that were modified before 4 p.m. on 27 April. If you change the time variable to Within, when webMethods.io MFT executes the find task at 12 pm on 30 April, it searches for files that were modified between 28 April and 30 April 4 a.m.
Fail if no files are found Select this option if you want the find operation to fail if no files are found.
File stability and scanning
Scan for files and check for stability Select one of the following options:
  • Exclude file after first scan, if you want the find operation to scan and check only once.
  • Scan file multiple times, if you want the file operation to check at regular intervals. Type the seconds and minutes.
Retry [ ] times at an interval of [ ] seconds If you want webMethods.io MFT to retry a failed find task. Type the number of retries and the retry interval in seconds.
Sort files Select this option to enable webMethods.io MFT to search for files in a particular order. You can sort files based on last modified date, file size, and file name under Sort field, and ascending or descending order under Sort order.

Note: If you configure Maximum items to find with a specific value (for example, 4) and select this option, then webMethods.io MFT reads every file within the folder and finds files based on the Sort files criteria. This might result in a decrease in the performance of the Find task.
Assign Partner Select this option if you want to assign a partner for the action and do one of the following:
  • Select the partner to assign from the list of configured partners in webMethods.io MFT.
  • Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.
Note: For virtual folders, use this option only if you want to override the partners configured for the folders.

A find task retrieves a list of files from a specified location. The files listed by a find task are passed on to the subsequent task for processing. If there are multiple find tasks for an action, the files found by each “find” task are added to the list passed on to it from the previous task.

For example, consider the following sequence of tasks and the webMethods.io MFT behavior for each task:

Sequence Number What does webMethods.io MFT do?
1 Finds files in the given source location A. Let us call these files list 1.
2 Executes the Integration Service on file list 1.
3 Finds files in the given source location B. Let us call these files list 2.
4 Executes the Integration Server service on both list 1 and list 2 files.
5 Encrypts the files in list 1 and list 2.

Copy Task Configuration

You can configure the following properties for the Copy file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, webMethods.io MFT considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.

Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.

Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐| (*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Destination location Select one of the following options to configure the location where the file will be copied to:
  • Remote path, if the destination location is on a remote server, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://<host\>:<port\>/DestinationFolder/.
  • Note: If you want to find and copy files from remote third-party HTTP(S) servers, ensure that you provide appropriate certificate alias here.
    • Type the User name and Password for the remote system.
    • Click Test Connection to check the connection to the remote server.
    Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the certificate alias parameters. You can then use the folder that you configured in the Virtual folder option of the Destination location in the task.
  • Virtual folder: To specify a folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.
  • Note: The folder that you select should be configured on the same instance on which the action is configured.
Execute error task Select this option to execute an error task if the file operation fails.
Advanced
Create directory Select this option to enable to create the destination folder if the folder specified in Destination location is not present. If Destination location path does not include a folder, copies the file directly to the specified directory path.
Rename file to Select this option to rename the file to the specified name in the box.
Check if the file exists at destination Select this option to check if the file already exists at the destination and perform one of the following options:
  • Skip the transfer if file exists: This option skips the file transfer if the file with the same file name exists at the destination. However, further actions will not be performed on that particular file at the destination.
  • Example: Consider you want to perform Copy and Rename tasks respectively on a file. The Copy task skips that particular file if the file already exists at the destination. Additionally, the Rename task also will not be performed on that particular file.
  • Fail the action if file exists: This option fails the action if a file with the same filename exists at the destination location. In this case, the execution of the action stops and is a marked failure.
    During parallel execution, only the particular file which is already at the destination will not be processed. However, the remaining files will complete their processing and is transferred to the destination.
  • Example:
    • For parallel execution:
      Let us consider that you want to perform Copy and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Copy and Rename tasks fail only for that particular file which is at the destination. However, webMethods.io MFT will continue processing the remaining files for Copy and Rename tasks respectively.
    • For non-parallel execution:
      Let us consider that you want to perform Copy and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Copy and Rename tasks fail only for that particular file which is at the destination. However, webMethods.io MFT will copy the remaining files but will not process the Rename task for these files. Additionally, any subsequent task for these files will not be performed.
    Note: If you rename a particular file using Rename file to option, then Fail the action if file exists option checks for the renamed filename at the destination. The renamed file will be added to the destination only if it does not match the rest of the filename.
Use temporary file name Select this option and type a temporary name for the file to use while copying the file. The file is renamed to its original name after the copy file operation is complete.
Preserve file modification date Select this option to retain the time stamp indicating when the file was last modified.
Check for stability If you want the file operation to check its progress at regular intervals, specify the time in seconds in the following format: Every [ ] seconds up to [ ] seconds, where, [ ] is the text box to type the value in seconds.
Retry [ ] times at an interval of [ ] seconds Select this option to retry a failed copy operation for the specified number of times at the interval specified in seconds.
Resume transfer from the point of interruption Select this option to resume an interrupted or failed copy operation from the point of interruption.
Command before upload If you want to execute a SITE command before copy task, then choose this option. For example, while working with Mainframe servers, value for record size and block size can be sent to the server before upload by setting the following value to this new configuration field: SITE LRECL=<record\_size\> BLKSIZE=<block\_size\>.
Simple mode Select this option to change the file transfer mode to simple mode and if you are transferring files to AS/400 systems. This mode is applicable to FTP, FTPS, or FTPES protocols.
ASCII mode Select this option to change the file transfer mode to ASCII mode and select one of the following Convert line endings options for to change the line endings of the file: CRLF - Windows, CR - MAC OS Classic, LF - Unix, or No change. This mode is applicable for FTP, FTPS, or FTPES protocols.
By default, webMethods.io MFT uses the Binary file transfer mode for the copy operation.
Assign partner Select this option if you want to assign a partner for the action and do one of the following:
  • Select the partner to assign from the list of configured partners in webMethods.io MFT.
  • Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.

Note: For virtual folders, use this option only if you want to override the partners configured for the folders.

A copy task copies all the files passed on from the previous task to the location specified in Destination location. However, the files copied to the specified destination will not be available to the subsequent task for processing. The list of files in the source location is passed on to the subsequent task.

Move Task Configuration

You can configure the following properties for the Move file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, webMethods.io MFT considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option. Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Destination location Select one of the following options to configure the location where the file will be copied to:
  • Remote path, if the destination location is on a remote server, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://<host\>:<port\>/DestinationFolder/.
    Note: If you want to find and move files from remote third-party HTTP(S) servers, ensure that the you provide appropriate file path here.
    • Type the User name and Password for the remote system.
    • Click Test Connection to check the connection to the remote server.
    • Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the certificate alias parameters. You can then use the folder that you configured in the Virtual folder option of the Source location in the task.
  • Virtual folder: To specify a virtual folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.
  • Note: The virtual folder that you select should be configured on the same webMethods.io MFT instance on which the action is configured.
Execute error task Select this option to execute an error task if the file operation fails.
Advanced
Create directory Select this option to enable webMethods.io MFT to create the destination folder if the folder specified in Destination location is not present. If Destination location path does not include a folder, webMethods.io MFT copies the file directly to the specified directory path.
Rename file to Select this option to rename the file to the specified name in the box.
Check if the file exists at destination Select this option to check if the file already exists at the destination location and perform one of the following options:
  • Skip the transfer if file exists: This option skips the file transfer if the file with the same file name exists at the destination. However, further actions will not be performed on that particular file at the destination.
  • Example: Consider you want to perform Move and Rename tasks respectively on a file. The Move task skips that particular file if the file already exists at the destination. Additionally, the Rename task also will not be performed on that particular file.
  • Fail the action if file exists: This option fails the action if a file with the same filename exists at the destination location. In this case, the execution of the action stops and is a marked failure.
    During parallel execution, only the particular file which is already at the destination will not be processed. However, the remaining files will complete their processing and is transferred to the destination.
  • Example:
    • For parallel execution: Let us consider that you want to perform Move and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Move and Rename tasks fail only for that particular file which is at the destination. However, webMethods.io MFT will continue processing the remaining files for Move and Rename tasks respectively.
    • For non-parallel execution: Let us consider that you want to perform Move and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Move and Rename tasks fail only for that particular file which is at the destination. However, webMethods.io MFT will move the remaining files but will not process the Rename task for these files. Additionally, any subsequent task for these files will not be performed.
Note: If you rename a particular file using Rename file to option, then Fail the action if file exists option checks for the renamed filename at the destination. The renamed file will be added to the destination only if it does not match the rest of the filename.
Use temporary file name Select this option and type a temporary name for the file to use while moving the file. The file is renamed to its original name after the move file operation is complete.
Note: Temporary file name will not be used for a file being moved within an operating system or server.
Preserve file modification date Select this option to retain the time stamp indicating when the file was last modified.
Check for stability If you want the file operation to check its progress at regular intervals, specify the time in seconds in the following format: Every [ ] seconds up to [ ] seconds, where, [ ] is the text box to type the value in seconds.
Retry [ ] times at an interval of [ ] seconds Select this option to retry a failed move operation for the specified number of times at the interval specified in seconds.
Resume transfer from the point of interruption Select this option to resume an interrupted or failed move operation from the point of interruption.
Command before upload If you want to execute a SITE command before move task, then choose this option. For example, while working with Mainframe servers, value for record size and block size can be sent to the server before upload by setting the following value to this new configuration field: SITE LRECL=<record\_size\> BLKSIZE=<block\_size\>.
Simple mode Select this option to change the file transfer mode to simple mode and if you are transferring files to AS/400 systems. This mode is applicable for FTP, FTPS, or FTPES protocols.
ASCII mode Select this option to change the file transfer mode to ASCII mode and choose one of the following Convert line endings options for webMethods.io MFT to change the line endings of the file:
  • CRLF - Windows
  • CR - MAC OS Classic
  • LF - Unix
  • No change
This mode is applicable for FTP, FTPS, or FTPES protocols.
By default, webMethods.io MFT uses the Binary file transfer mode for the Move operation.
Assign partner Select this option if you want to assign a partner for the action and do one of the following:
  • Select the partner to assign from the list of configured partners in webMethods.io MFT.
  • Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.
Note: For virtual folders, use this option only if you want to override the partners configured for the folders.

A move task moves all the files passed on from the previous task to the location specified in Destination location. The files are removed from the source folder. The list of files in the destination location is passed on to the subsequent task.

For example, an action configured with the following tasks:

  1. Find task: Find files in Source location = <source folder>
  2. Encrypt task: Encrypt the files.
  3. Move task: Moves the files to the Destination location = <destination folder>

The action results in the following:

  1. Find task lists all the files in the <source folder>.
  2. Encrypt task encrypts all the files listed by the find task.
  3. Move task moves the files that are encrypted by the encrypt task to the <destination folder>.

Delete Task Configuration

You can configure the following properties for the Delete file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Retry [ ] times at an interval of [ ] seconds Select this option to retry a failed delete operation for the specified number of times at the interval specified in seconds.
Execute error task Select this option to execute an error task if the file operation fails.

A “delete” task deletes the files that are passed on from the previous task. The deleted files are not passed on to the subsequent task. If a file filter is configured in the task, only then the files that do not match the file filter are passed on to the next task.

Rename Task Configuration

You can configure the following properties for the Rename file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
New file name Type a new file name for the file.
Retry [ ] times at an interval of [ ] seconds Select this option to retry a failed rename operation for the specified number of times at the interval specified in seconds.
Skip renaming subfolders if parent folder is renamed Select this option to rename a parent folder but not the folder beneath the folder.
Execute error task Select this option to execute an error task if the file operation fails.|

A rename task renames the files passed on from the previous task. The files that are renamed are not passed on to the next task.

Encrypt Task Configuration

You can configure the following properties for the Encrypt file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Encryption key alias Type the certificate alias for the public key file.
ASCII-Armor Select this option to wrap PGP files in BASE64-encoded format to make them more secure when emailing them.
Encrypt with integrity check Select this option to configure Modification Detection Code (MDC) to decrypt files that are encrypted with ’s event.
Execute error task Select this option to execute an error task if the file operation fails.

An encrypt task encrypts files passed on from the previous task. supports only PGP- based file encryption. The encrypted file is saved with the name Original-filename.PGP. After the successful execution of an encrypt task, the source folder location contains both, the original files and the corresponding encrypted files, but only the encrypted files are passed on to the subsequent task for processing. If you select Delete original file, the original files are deleted. If you configure a move task after an encrypt task, the move task moves the encrypted file and not the original file.

Decrypt Task Configuration

You can configure the following properties for the Decrypt file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Decryption key alias Type the certificate alias for the private key file. Note: can decrypt the file only if the file is encrypted with the corresponding public key.
Derive file name from input file Select this option to the retain the original filename of the encrypted file.
ASCII-Armor Select this option to wrap PGP files in BASE64-encoded format to make them more secure when emailing them.
Delete original file Select this option to delete the original file and retain only the decrypted files.
Execute error task Select this option to execute an error task if the file operation fails.

A decrypt task decrypts files passed on from the previous task and creates decrypted files without the .PGP extension. The source folder location contains both, the original files and the corresponding decrypted files. If you select Delete original file, the original files are deleted. For example, you have configured a post-processing action which is triggered by a file uploaded to a folder (for example, a folder named incoming) that points to a physical location. You have also configured the following tasks in the action:

  1. Move task: To move a file that matches the filter, *invoice*.PGP from the incoming folder to the working folder.
  2. Decrypt task: To decrypt the file with the Delete original file option is selected.

After the action is executed successfully, the decrypted file (without the PGP extension) is available in the working folder, and deletes the original encrypted file. If you want to make the files from the incoming folder available to an task that is configured to execute after the decrypt task, ensure that you do the following:

Zip Task Configuration

You can configure the following properties for the Zip file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Destination location Select one of the following options to configure the location where the file will be zipped:
  • Remote path, if the destination location is on a remote server, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://<host\>:<port\>/DestinationFolder/.
    • Type the User name and Password for the remote system.
    • Click Test Connection to check the connection to the remote server.
    • Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the certificate alias parameters. You can then use the folder that you configured in the Virtual folder option of the Source location in the task.
  • Virtual folder: To specify a virtual folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.
  • Note: The virtual folder that you select should be configured on the same instance on which the action is configured.
Create directory Select this option to enable to create the destination folder if the folder specified in Destination location is not present.
ZIP file name Type a name for the ZIP file. Alternatively, you can provide a variable name such as {stem}.zip as the ZIP file name. {stem}.zip is the default file name.
Assign partner Select this option if you want to assign a partner for the action and do one of the following:
  • Select the partner to assign from the list of configured partners in webMethods.io MFT.
  • Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.
Note: For virtual folders, use this option only if you want to override the partners configured for the folders.

The zip task compresses a specified file or a set of files and copies the compressed file to the location specified in Destination location. After the successful execution of the zip task, the original source files and the target zip file are available to the subsequent task. If the input path is that of a folder, does not compress the files/contents of the specified folder.

In single-thread, sequential processing, each action results in a single zip file. However, if the zip task occurs after parallel processing starts, each thread results in a separate zip file.

Unzip Task Configuration

You can configure the following properties for the Unzip file operation task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Delete original ZIP file Select this option to delete the original ZIP file after it is unzipped.
Destination location Select one of the following options to configure the location to which the contents of the file will be extracted:
  • Remote path, if the destination location is on a remote server, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://<host\>:<port\>/DestinationFolder/.
    • Type the User name and Password for the remote system.
    • Select **** if you want to recover from a download that was not completed.
    • Click Test Connection to check the connection to the remote server.
    • Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the certificate alias parameters. You can then use the folder that you configured in the Virtual folder option of the Source location in the task.
  • Virtual folder: To specify a virtual folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.
Note: The virtual folder that you select should be configured on the same instance on which the action is configured.
Assign partner Select this option if you want to assign a partner for the action and do one of the following:
  • Select the partner to assign from the list of configured partners in webMethods.io MFT.
  • Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.
Note: For virtual folders, use this option only if you want to override the partners configured for the folders.
Execute error task Select this option to execute an error task if the file operation fails.

The unzip task decompresses the specified zip file. After a successful unzip task, both the original zip file and the extracted files are passed on to the subsequent task. If the “unzip” task occurs after parallel processing starts, all files resulting from the “unzip” task are treated as part of a single thread. Therefore, in the Activities section of the Action Log page, maintains the File Seq No of the original zip file for the particular thread until the action execution is completed.

Send Email Task Configuration

You can configure the following properties for the Send email task:

Field Description
Task name Type a unique name for the task.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
From The value you specify in From overrides the value specified in the mft.user.email.from parameter for this task.
To Type the email address of the recipient.
Cc Type the email addresses of additional recipients.
Bcc Type the email addresses of recipients that must be hidden.
Subject Type text to appear in the subject line of the email (for example, Disconnect:?User %user_name%). The value you specify in Subject overrides the value specified in the mft.user.email.subject parameter for this task.
Variables/Templates Select an option to assist you in completing the body of the email from the list. There are several examples of common email messages available.
Body Modify the content populated from the your selection in Variables/Templates or type your own text. You can use variables in the body of the email.
Execute error task Select this option to execute an error task if the file operation fails.

Based on the name of files specified in the source filter, the send email task sends emails to the recipients configured in a file task. Transfer of the specified files triggers the send email task.

In single-thread, sequential processing, runs the send email task only once for all files of an action, and includes the information for all files in a single, consolidated email. Therefore, each action results in one email. However, if the send email task occurs after parallel processing of files starts in an action, the number of emails sends depends on the number of threads in the action. Let us consider the example of an action having three parallel threads for processing. When the action execution is completed, sends one email for each thread, resulting in a total of three emails for the action.

Jump Task Configuration

You can define a Jump task that causes webMethods.io MFT to skip one or more tasks and execute a designated task in the action. A Jump task is unconditional by default. You can also define a jump condition based on which Jump task is executed. webMethods.io MFT executes the tasks defined in an action sequentially until it encounters a Jump task. The Jump task is triggered if any one file in the list satisfies the Jump condition.

You can configure the following properties for the Jump task:

Field Description
Task name Type a different name for the task or retain the name that is automatically assigned by webMethods.io MFT.
Note: Each task in an action must have a unique name. webMethods.io MFT assigns a default name for a task which is the task type itself. For example, Jump for a Jump task. When you add a task that already exists in the action with its default name, webMethods.io MFT appends the default name with a numeral starting at 1. For example, Jump1.
File filter Type the name of the file if you want to filter files with specific names. By default, considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Jump condition Select a condition you want to execute for a jump task from the list, select the Qualifier from the list, and type a Value of the server variable. For example, {ext} Equals xml triggers a jump task for all XML files.
Jump to task Select a task to jump to from the list.
Execute error task Select this option to execute an error task if the file operation fails. For more details, see Error Task Configuration.

The Jump task changes the sequence in which the tasks are executed. The task specified in the “Jump” task is executed instead of the next task in the sequence. The “Jump” task however does not modify the list of files that are passed on from the task prior to the Jump task to the task that is triggered by the Jump task.

Exclude Task Configuration

You can exclude files from a task or a set of tasks by defining an Exclude task prior to these tasks. The Exclude task uses a File filter to exclude files from all the tasks in the action that follow the Exclude task. The files that match the exclude criteria are not be passed on to the next task.

You can configure the following properties for the Exclude task:

Field Description
Task name Type a different name for the task or retain the name that is automatically assigned by webMethods.io MFT. Note: Each task in an action must have a unique name. webMethods.io MFT assigns a default name for a task which is the task type itself. For example, Jump for a Jump task. When you add a task that already exists in the action with its default name, appends the default name with a numeral starting at 1. For example, Jump1.
File filter Type the name of the file if you want to filter files with specific names. By default, webMethods.io MFT considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option.
Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out.
Few examples for regular expressions are:
  • (.(?!purchaseorder))*: Excludes files with the file URL containing purchaseorder.
  • */out/.*: Include files with the file URL containing the folder out.
  • ^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.
  • NEW-((*.doc)⏐(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_.
Execute error task Select this option to execute an error task if the file operation fails.

Error Task Configuration

You can configure an error task webMethods.io MFT execute if any of the configured tasks for a post-processing, scheduled, or monitor folder action fail. You can define any of the tasks that webMethods.io MFT offers as the error task. For example, if a file copy task fails, you can use the send email task to notify an administrator of the failure.

The error task is subjected to the following conditions:

Activating or Deactivating Actions

By default, a newly created post-processing or scheduled action is inactive. This enables you to work on configuring an action without any concern that the partially configured action is running. After you fully configure the action, you can activate it to associate it with a service.

You can also activate or deactivate more than one action at a time.

To activate or deactivate actions

  1. On the navigation pane, select Actions.

  2. On the Post-Processing actions or Scheduled actions page, select one or more actions, and do one of the following:

Tip: Each page of the actions list displays a maximum of 50 actions. Only select the actions visible on a single page.

Modifying a Post-Processing or Scheduled Action

You can edit the configuration settings of an existing post-processing, scheduled, or monitor folder action.

To modify an action

  1. On the navigation pane, select Actions.

  2. On the Post-Processing actions or Scheduled actions page, click on an action that you want to edit.

  3. Modify the required configuration settings for the action.

  4. Click Save.
    The action is updated with the modified settings.

Searching for a Post-Processing or Scheduled Action

You can search the post-processing or scheduled actions list to locate an action based on the action name and status.

To search for an action

  1. On the navigation pane, select Actions.

  2. On the Post-Processing actions or Scheduled actions page, specify all or one of the following search criteria:

Field Description
Action name Type the name of the action you want to view.
Status Select either Active or Inactive to filter the actions based on active or inactive actions respectively.

3. Click Reset to reset values and Apply for the changes to take effect.
The actions list is populated with the actions matching your search criteria.