MessageWay Translation

MessageWay Translation sends a file to a MessageWay server for translation or data format conversion.

The resulting output files are added to the 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 might result in multiple output files. If no processing rules match the input file, or if errors occur, no output files might be created.

The MessageWay translation engine is very powerful, and the various EDI (Electronic Data Interchange) standards governing data format are complex. For detailed information on how to set up a MessageWay server for translation, see the translation-related MessageWay manuals, such as MessageWay Translator Workbench User's Guide and Reference

For more information about the script itself, see the topic Common Applications - MessageWay Translation.

Input Parameters

• MWayConn_Host (Required) - Hostname of the MessageWay server.
• MWayConn_SSL - Whether to use SSL. Default is True.

  Note: if you use SSL, you must specify the certificate fingerprint of the MessageWay server in MWayConn_SSLFingerprint. If the server is on the same computer as MOVEit Automation, 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_User (Required) - MessageWay username.
• MWayConn_Password (Required) - MessageWay user's password.
• 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. Can include macros. The MessageWay translation engine can base its translation rules partly on the sender's name.
• MWayConn_MIMEType - Arbitrary MIME type string. Can include macros.
• MWayConn_RetryCount - Maximum number of retries to connect to MessageWay. Default is 0. The script retries 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. Default is 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. Default is 7200 (two hours).
• MWayConn_PollIntervalSeconds - The number of seconds to wait between queries to MessageWay to determine whether processing has completed. Can include macros. Default is 5 seconds.
• MWayConn_ExceptionsInsteadOfData - Tells the script how to behave when any exception occurs (meaning poorly formatted data).

  True: No data files are returned. Instead, the exception report files are returned.

  False (default) Only data files are returned. If False and exceptions do occur, you must look up the exception reports directly through MessageWay.

• MWayConn_TraceFilename - The full path to a file that receives 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 that receives a copy of the results file from the MessageWay helper utility. Can 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.) If no report files are returned, this parameter is empty if no report files are returned.

  Note: if the report is too long to fit in a task parameter, it might 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 Automation regards a script returning error 5300 as a successful process, which, depending on circumstances, might not be the desired behavior.

For maximum flexibility, the best practice is to 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 consists of report files rather than data files.

If you want to send report files to a different destination, using an Advanced Task and checking for a process error code of 5300 is recommended.

See also Advanced Topics - MessageWay CLI.