listOfMessageDef Document

  • Article

 

The listOfMessageDef document contains data stored in the xref_MessageDef and xref_MessageArgument SQL Server tables. The document has the following structure:

<?xml version="1.0" encoding="UTF-8"?>  
<listOfMessageDef>  
    <messageDef>  
        <code>INVALID_CREDIT</code>  
        <description>The credit code is not valid.</description>  
        <argumentName idXRefName="Credit Type">Credit Type</argumentName>  
    </messageDef>  
.  
.  
.  
</listOfMessageDef>

The document contains one or more messageDef elements. The following table describes the parts of the document:

Element Attribute Description
messageDef Contains code, description, and argumentName elements.
code A string of up to 50 characters that uniquely identifies the message.
description A string of up to 1000 characters describing the message.
argumentName A string of up to 50 characters that is the name of the argument inserted in the message.
argumentName idXRefName A string of up to 50 characters that must match one of the idxRefName values in the listOfIDXRef document.

The code element is mapped to a unique identifier used as a value in other tables.

See Also

Importing Data for the Cross Referencing Functoids
listOfIDXRef Document
listOfMessageText Document