Output File

xformviamway's outfile is an XML file describing the results of the translation. The actual data and report files resulting from the MessageWay processing are separate files which are pointed to by outfile. Here's a sample file:

<Output>

  <InputProcessingStatus>Accepted</InputProcessingStatus>

  <RFiles>

    <RFile>

      <MessageID>2010080413120504btdb</MessageID>

      <CacheFilename>C:\TEMP\MIC\c88-0002/2010080413120504btdb.tmp</CacheFilename>

      <FileType>Output</FileType>

      <Filename>M2010080413120504btdb.dat</Filename>

    </RFile>

    <RFile>

      <MessageID>2010080413120504c55l</MessageID>

      <CacheFilename>C:\TEMP\MIC\c88-0002/2010080413120504c55l.tmp</CacheFilename>

      <FileType>Output</FileType>

      <Filename>M2010080413120504c55l.dat</Filename>

    </RFile>

    <RFile>

      <MessageID>2010080413120504deg9</MessageID>

      <CacheFilename>C:\TEMP\MIC\c88-0002/2010080413120504deg9.tmp</CacheFilename>

      <FileType>Output</FileType>

      <Filename>M2010080413120504deg9.dat</Filename>

    </RFile>

    <RFile>

      <MessageID>2010080413120504egd8</MessageID>

      <CacheFilename>C:\TEMP\MIC\c88-0002/2010080413120504egd8.tmp</CacheFilename>

      <FileType>Report</FileType>

      <Filename>2010080413120504ac2j.txt</Filename>

    </RFile>

  </RFiles>

  <ErrorCode>0</ErrorCode>

  <ErrorDescription></ErrorDescription>

  <ShouldRetry>false</ShouldRetry>

  <OriginalMessageID>2010080413120504ac2j</OriginalMessageID>

</Output>

The XML tags are described below.

Name	Description
InputProcessingStatus	The processing status as returned by MessageWay. The possible values are: Accepted Rejected Accepted with errors Partially accepted (empty) An empty value usually indicates an error.
RFile	Each RFile node represents a single file returned from MessageWay. The subnodes are: MessageID - The Message ID of the file inside MessageWay. This is typically useful only if you are going to look up the message from the MessageWay Dashboard. CacheFilename - The filename of a file created by MessageWay. This file will be in the OutputDir specified in the input file. FileType - Either Data or Report. MessageWay Data files contain the translated output. A single input file might result in multiple data output files. MessageWay Report files contain descriptions of the processing of the input file, including detailed error messages if the input file contained incorrect data. Filename - The name of the file (message) as it is known inside MessageWay.
ErrorCode	An error code giving the overall success of the process. 0 means success. Non-zero values mean failure. Generally, translation runs that result in exceptions due, for instance, to invalid input data result in an error code of 0. Non-zero errors are normally returned only if xformviamway cannot connect to or login to the MessageWay error, or if the MessageWay server returns an ill-formatted response.
ErrorDescription	An error description elaborating on the error that causes a non-zero ErrorCode. If ErrorCode is 0, ErrorDescription will be empty.
ShouldRetry	true if the xformviamway run failed, but in a way that implies that a subsequent run may succeed. For instance, if xformviamway cannot not connect to the MessageWay server, it returns a ShouldRetry of true, because the MessageWay server may be down only temporarily. ShouldRetry is false if the xformviamway run succeeded, or if it failed in a way that implies that a retry is unlikely to succeed. ShouldRetry is intended to be used by retry logic of the process invoking xformviamway.
OriginalMessageID	The message ID assigned by MessageWay to the input file. This can be useful for analysingThe message ID assigned by MessageWay to the input file. This can be useful for analysing message flow via MessageWay Dashboard. OriginalMessageID will be empty if MessageWay did not accept the input file - for instance, if the user could not login.