"MessageWay Translation" sends a file to a MessageWay server for translation or data format conversion.
The resulting output files are added to MOVEit Central's list of files to process, which typically means they are sent to one or more destinations, depending on the task's configuration. The original input file is ignored, which means that the task will do no further processing on it, and it will not be sent to task destinations.
Depending on the input file and the translation rules configured on the MessageWay server, a single input file may result in multiple output files. On the other hand, if no processing rules match the input file, or if errors occur, no output files may be created.
The MessageWay translation engine is very powerful, and the various EDI (Electronic Data Interchange) standards governing data format are complex. Consult the translation-related MessageWay manuals, such as MessageWay Translator Workbench User's Guide and Reference, for detailed information on how to set up a MessageWay server for translation.
MWayConn_Host (Required) - Hostname of the MessageWay server.
MWayConn_SSL - Whether SSL is to be used. Default: True. Note: if you use SSL, you must specify the MessageWay server's certificate's fingerprint in MWayConn_SSLFingerprint. If the server is on the same computer as MOVEit Central, you can safely specify False here and avoid having to know the certificate's fingerprint.
MWayConn_Port - TCP port number. Default: 6280 if not SSL, or 6243 if SSL. You generally do not need to specify this parameter.
MWayConn_SSLFingerprint - Hexadecimal fingerprint (MD5 or SHA1) of the server's certificate. Required if MWayConn_SSL is True. (There is no way to specify that any certificate should be accepted.) The string consists of groups of 2 hex characters separated by spaces.
MWayConn_Recipient - Destination of translated files. For example, the destination "translate:moveit" means that there must be a translation location named "translate" and a mailbox named "moveit" configured in MessageWay. The specified user must have sufficient access to these locations.
MWayConn_Sender - Arbitrary sender's name. May include macros. The MessageWay translation engine may base its translation rules partly on the sender's name.
MWayConn_MIMEType - Arbitrary MIME type string. May include macros.
MWayConn_RetryCount - Maximum number of retries to connect to MessageWay. Defaults to 0. The script will retry only if certain types of errors occur, such as an inability to connect to the MessageWay server.
MWayConn_RetrySeconds - Number of seconds between attempts to connect to MessageWay. Defaults to 30.
MWayConn_MaxSeconds - The maximum number of seconds to wait for MessageWay to process the file. A value of 0 means no limit. May include macros. Defaults to 7200 (two hours).
MWayConn_PollIntervalSeconds - The number of seconds to wait between queries to MessageWay to determine whether processing has completed. May include macros. Defaults to 5 seconds.
MWayConn_ExceptionsInsteadOfData - Tells the script how to behave when any exception occurs (meaning poorly formatted data). True means no data files should be returned; instead, the exception report files are returned. Defaults to False, which means only data files are returned. If False and exceptions do occur, you will have to look up the exception reports directly through MessageWay.
MWayConn_TraceFilename - The full path to a file which will receive a detailed trace log of the script's communications with the MessageWay server. For example, C:\tmp\MWTrace.txt. Use this parameter only to debug problems interacting with the MessageWay server.
Debugging Parameters
The following parameters are rarely used, and are primarily used during product development.
MWayConn_ResultsDebugFilename - The full path to a filename which will receive a copy of the results file from the MessageWay helper utility. May include macros. By default, no debug copy of the results file is made.
MWayConn_ForceAtLeastSeconds - The minimum number of seconds to wait after downloading results from MessageWay, prior to processing the files. This parameter was implemented to allow testing features like progress bars. By default, no additional waiting is done.
Output Parameters
MWayConn_Report - Contains the last translation exception report file returned from MessageWay. (Typically, only one report file is returned.) This parameter will be empty if no report files are returned. Note: if the report is too long to fit in a task parameter, it may be truncated.
Error handling
This script returns error 5300 if the translation takes place, but returns one of the following error statuses:
Partially Accepted
Accepted with Errors
Rejected
When running a Traditional task, MOVEit Central will regard a script returning error 5300 as a successful process, which, depending on circumstances, may not be the desired behavior. For maximum flexibility, it is recommended that you use this script with Advanced rather than Traditional tasks. This is especially recommended if you set MWayConn_ExceptionsInsteadOfData to True, because in this case, if translation exceptions occur, the output from the task will be report files rather than data files. You may very well want to send report files to a different destination; if this is the case, using an Advanced Task and checking for a process error code of 5300 is recommended.
