SWIFT Module 7.1 SP10.July 2020 | Package Services | XML Parsing Templates for SWIFT FIN Messages | Parsing Template Structure | Line Attribute Syntax of a Parsing Template
 
Line Attribute Syntax of a Parsing Template
 
Hint Processing
The lineAttribute elements typically define a single field in the message, although they are also used in the generic parsing template to include an entire block of fields. The syntax of the lineAttribute directive is shown below.
<block id="id" isMandatory="true|false"
EAImap="string" extractHint="hint" idHint="hint"
[ blockLoadField="true"]>
Note:
Note that optional parameters are shown in square braces [ ].
Elements
Values
Description
id
field id
or
field id list
The field tag in the SWIFT message, including delimiting characters. Mutually exclusive fields are depicted as a comma separated list (see fields 52, 56 and 57 in the example parsing template above).
isMandatory
true / false
Specifies if the field represented by the lineAttribute must be present in an incoming message.
*false—The lineAttribute is optional and is not needed for the message to be considered valid.
*true—The lineAttribute must be present or the message will fail validation.
In an outgoing message, the corresponding field in the Enterprise document (specified by the EAImap element) must be populated, or the message will fail validation.
EAImap
document field name
or
document field name list
The name of the field in the Enterprise document that the lineAttribute is mapped to or from. By convention, the EAImap value for lineAttributes are prefixed with “O” for optional fields or “M” for mandatory fields.
Mutually exclusive fields are depicted as a comma separated list that must match the field ID list.
extractHint
Parameter list
The first member must be BR; field is enclosed by braces. DL—Field is delimited. CK—Field contains the entire block data in a single chunk.
Note:
CK is used for the generic parsing template only.
Syntactical clue used to identify the beginning and end of fields. For an incoming message, extractHint is used to identify the end of the field data and to strip any braces from the raw data. For a full explanation of this element, see Hint Processing.
idHint
Parameter list
The first member of which must be FL, ID is fixed length, or CK, ID will not be extracted as the field contains the entire block in a single chunk.
Syntactical clue used to identify and strip the ID of the field extracted using the extractHint. The idHint is applied to the raw data line and typically uses a fixed length parameter to return the first few characters of the data.
For SWIFT Module to identify the field correctly, the text returned by idHint using FL must match the value in the lineAttribute ID element. For a full explanation of this element, see Hint Processing.
blockLoadField
true (if specified)
Optional element that causes the lineAttribute to be referenced by a subsequent loadBlockHint directive. blockLoadField must precede loadBlockHint in the parsing template.