...
Standalone dictionary structure
Below is the commom common structure of the standalone dictionary with used tags and attributes description.
Structure | Description |
---|
<fixdic> | Root tag of the dictionary. |
| | |
| @id | ID of the used dictionary. Valid values are: |
|
| @fixversion | FIX version of the used dictionary. E.g.: 4.4, 4.2, T1.1, etc. |
|
| @title | The name of the dictionary. E.g.: FIX 5.0 SP2 EP, FIX 4.4 (with errata 20030618) |
|
| @version | Dictionary version. |
|
| @date | Date of the last dictionary update. |
|
| <typelist> | Section which describes types used in the dictionary. |
| |
|
| <typedef> | Definition of the type. |
| |
|
|
| @type | Type name. E.g.: Percentage, Amt, char |
| | |
|
|
| @extends | Specified if the type extends one of existing types. E.g.: - <typedef type="Percentage" extends="float">
- <typedef type="Boolean" extends="char">
|
| |
|
|
| @valuetype | Type of the value (specifies either type is multiple value type and type of the underlying value). |
| |
|
|
| @displayname | Name to be displayed (specifies either type is multiple value type and type of the underlying value). |
| | |
|
|
| <descr>...</descr> | Description of the type. |
| | |
| <fielddic> | Section which describes fields used in the dictionary. |
| |
|
| <valblockdef> | Definition of the block of element's values. Can be zero or more elements. E.g. for countries, currencies, products, securities, etc. |
| |
|
|
| @id | Unique identifier of the block. |
| | | |
|
|
| <item> | Item of the block - name of the item. |
| | | |
|
|
|
| @val | Serial number of the item. |
| | |
|
|
|
| @id | Unique identifier of the item. Id is an optional attribute and is used when description of an item value is longer than 4 words or has any special characters. |
| | |
|
|
|
| <msgref> | Reference to the message where mentioned item is used - name of the message. |
| | | | |
|
|
|
|
| @msgtype | Type of the reference message. |
| | | | | | | | | |
|
|
| <range> | Range of values to be supported - purpose of the range. |
| | |
|
|
|
| @minval | Minimum value to be supported. |
| | |
|
|
|
| @maxval | Maximum value to be supported. |
| | | | | | | | |
|
|
| <multi> | List of items. The field can contain multiple items separated by space. |
| | |
|
|
|
| <item>...</item> | The structure is the same as described for fixdic/fielddic/valblockdef/item. |
| | | |
|
|
| <descr>...</descr> | Description. |
| | | |
|
| <fielddef> | Definition of the field. |
| | | | | | | | | |
|
|
| @lenfield | Only for fielddef with type="data" or type="XMLData" |
| | |
|
|
| <alias>...</alias> | Alternative field name. |
| | |
|
|
| <multi> | List of items. The field can contain multiple items separated by space. |
| | | |
|
|
|
| <item>...</item> | The structure is the same as described for fixdic/fielddic/valblockdef/item. |
| | | | |
|
|
| <item>...</item> | Can be zero or more item elements in the field definition. Only one item can be specified for the field. The structure is the same as described for fixdic/fielddic/valblockdef/item. |
| |
|
|
| <range>...</range> | The structure is the same as described for fixdic/fielddic/valblockdef/range. |
| | |
|
|
|
| <valblock idref="..."/> | Reference to the id of the <valblockdef> element. |
| | |
|
|
| <descr>...</descr> | Description of the field. |
| |
| <msgdic> | Section which describes messages used in the dictionary. |
| |
|
| <blockdef> | Definition of the block. Can be zero or more definitions. |
| | |
|
|
| @id | Identifier of the block definition. |
| |
|
|
| @name | Name of the block definition. |
| | | | |
|
|
| <field> | Definition of the field. |
| | | | | | | | | |
|
|
|
| @req | Specified if the field is mandatory or not. |
| | | |
|
|
|
| @condreq | Specified if there is a condition when the field is mandatory. |
| | |
|
|
|
| <comment>...</comment> | Comment. |
| | | | |
|
|
| <block> | Block description. |
| | | |
|
|
|
| @idref | Reference to the id of the block. |
| | | |
|
|
|
| @req | Specified if the block is mandatory or not. |
| | |
|
|
|
| @condreq | Specified if there is a condition when the field is mandatory. |
| | |
|
|
|
| <comment>...</comment> | Comment. |
| | | | |
|
|
| <group> | Group description. |
| | | |
|
|
|
| @nofield | Tag of the group. |
| | | | | | |
|
|
|
| <field>...</field> | The structure is the same as described for fixdic/msgdic/blockdef/field. |
| | | |
|
|
|
| <block>...</block> | The structure is the same as described for fixdic/msgdic/blockdef/block. |
| | |
|
|
|
| <group>...</group> | The structure is the same as described for fixdic/msgdic/blockdef/group. |
| | | | |
|
|
| <descr>...</descr> | Description. |
| | | |
|
| <msgdef> | Definition of the message. Can be zero or more definitions. |
| | | | | | |
|
|
| @admin | Defines if the message is session level or application level message. |
| | |
|
|
| <alias>...</alias> | Alternative message name. Can be zero or more elements. |
| |
|
|
| <field>...</field> | The structure is the same as described for fixdic/msgdic/blockdef/field. |
| | |
|
|
| <block>...</block> | The structure is the same as described for fixdic/msgdic/blockdef/block. |
| | |
|
|
| <group>...</group> | The structure is the same as described for fixdic/msgdic/blockdef/group. |
| |
|
|
| <descr>...</descr> | Description. |
| | |
| <descr>...</descr> | Description. |
</fixdic> | - |
Additional dictionary specifics
Below is the commom structure of the additional dictionary with specific tags and attributes description.
Structure | Description |
---|
<fixdics> | Root tag of the additional dictionary. |
|
| <delete> | Dictionary delete operation. Can be zero or one <delete> element. |
| |
|
| <fixdic> | Dictionary to be updated. Can be zero or more <fixdic> elements. |
| | |
|
|
| @id | ID of the additional dictionary. |
| | |
|
|
| @parent_id | ID of the original dictionary additional dictionary based on. Valid values are: - FIX40
- FIX41
- FIX42
- FIX43
- FIX44
- FIX50
- FIX50SP1
- FIX50SP2
- FIX50SP2EP
- FIXT11
|
| | |
|
|
| @fixversion | FIX version additional dictionary based on. |
| | |
|
|
| @title | The name of the additional dictionary. |
| |
|
|
| @version | Additional dictionary version. |
| | |
|
|
| @date | Date of the last additional dictionary update. |
| |
|
|
| ... | <typedef>/<valblockdef>/<fielddef>/<blockdef>/<msgdef> to be added/updated. The structure of listed elements is the same as described in standalone dictionary structure. |
| | |
| <update> | Dictionary update operation. Can be zero or one <update> element. |
| |
|
| ... | The structure is the same as for <delete> element. |
Please see the article How to use custom dictionaries for the cases of additional dictionaries usage.
...