wm.mft.schedule:executeEvent
Executes an event configured on the Event Management page’s Scheduled Events tab. This service is useful to test the execution of an action defined for a scheduled event. You can also parameterize the settings of an ActiveTransfer Server scheduled event action and use this service to provide the values of the parameters at runtime. Parameterizing the event action settings at runtime helps in reducing the number of events that you configure in ActiveTransfer Server especially when you transfer files across several source and destination file systems.
Input Parameters
scheduleName | String Specifies the name of the event defined on the Scheduled Events tab of the Event Management page in My webMethods. |
allowEmptyValueForParams | String Specifies if the parameterized scheduled event action settings can be empty.  true - Allows null values. If you do not provide a value in the parameterized action setting, the service will assign the value ("") to the setting and the event will execute successfully. false - Do not allow null values. The service will fail and a message is displayed indicating that the value for the parametrized setting is not provided. |
eventParams | Document List The details of the parameterized scheduled event action settings. Variables are: name String The name assigned to the parameterized configuration setting of the scheduled event action. value String The value you want to assign to the parameterized setting. |
Output Parameters
output | Document Specifies if the scheduled event was successfully executed or not. Variables are: success String Takes the value true or false. true - The scheduled event was successfully executed and all files were processed. false - The scheduled event failed with one or more errors. message String A message that indicates the status of the scheduled event. |
Usage Notes
For any remote file path you can parameterize only the URL and not the username and password. The runtime value for the URL should contain the username and password to be used. The URL information should be provided in format
<protocol>://<username>:<password>@<host>:<port>/<path>/. For example,
FTP://user:password@ftp.softwareag.com/outbound/Note: | If you parameterize the file path URL and provide a value for the URL in the format <protocol>://<username>:<password>@<host>:<port>/<path>/, the values specified for the username and password parameters at runtime are ignored. This is applicable for the remote file URLs that you configure in the following actions: Find action : Find URL Copy action : Destination Move action : Destination URL Unzip action : Destination URL Zip action : Zip File Path |
You can parameterize only the following event action settings:
Action | Action Settings |
Find | File URL, File Name, Source Filter |
Copy | Destination URL, Rename file to, Source Filter, File Name |
Decrypt | Decryption Key File, Source Filter |
Send Email | From, To, CC, BCC, Subject, Body, Source Filter |
Encrypt | Decryption Key File, Source Filter |
Execute Script | Command, Arguments, Separator, Working Directory, Source Filter |
Jump | variable, variable2, Source Filter |
Move | Destination URL, Rename file to, Source Filter, File Name |
Rename | New File Name, Source Filter |
Unzip | Destination URL, Source Filter |
Write Content | File Path, Source Filter |
Zip | Zip File Path, File Name, Source Filter, Zip File Name |
