Message model overview
Each message model consists of some basic information:
- The name of the message model or specification.
- A description of the scope of the message model and the processes it covers.
- Different versions of the message model.
- Any documents (if available) related to the message model.
- Acknowledgements to the authors of the message model.
Navigate to a message model
All released versions of a certain message model are shown including some meta information (see picture above):
- The version identifier, with the newest version of the message model shown on top.
- The status of the message model, e.g. release, deprecated, etc.
- A diagram icon to navigate to the treeview of the message model. Here you will find the entire specification of a message model version presented in a so-called treeview.
- Documentation belonging to that specific version, e.g. the standard in PDF-format, changelogs, etc.
- The original publication date of the version's x- and/or y-release.
- Release notes containing the changes made in comparison to previous versions.
- References to related specifications.
To navigate to the treeview one of the versions of a message model, click the diagram icon with the specification name underneath it.
View a message model in the treeview
The treeview representation of a message model is split up in two panels:
- The left panel shows the hierarchy of the message model. By default, the root node is selected, in this case
Assignment, and is highlighted in blue. All first sub (or child) elements are shown underneath. An element can be selected by clicking on it (it then becomes blue). This also means all sub elements of the selected element are expanded and shown underneath.
- The right panel shows information on the data element that is selected in the left panel. The main tab is the 'Semantics' tab. This includes:
- The name of the element.
- The definition of the element.
- The syntax path made up of all parent elements, ending with the element itself.
- The namespace specifying the semantic origin of the element (i.e. where the meaning is defined).
- Fixed and/or allowed values that an element should or is allowed to have.
- Restriction notes, specifying a specific datatype or format the filled-in value should comply to, e.g. date notation according to YYYY-MM-DD.
- Business rules that apply to the element.
- Codelists that apply to the element.
- Usage notes applying to the element, providing additional clarification on its usage or certain scenario's.
Another example showing
idOwner as selected element on the left panel with its semantic information on the right panel:
View (XML) examples
For each element an example message or snippet can be provided within the XML examples tab.
The example above shows an entire XML example message including the title of the file (ASSIGNMENTEXAMPLE_V1.4.XML), but each element can also have an example snippet covering a smaller scope.
The examples can be expressed in different syntaxes, e.g. XML and JSON.
Ask a question regarding a certain element
When an element is selected, users are able to ask questions about unclarities or its usage, or can provide a comment for that element. Communities also use this function for reviewing purposes.
The Q&A tab may not be used to request any changes to the message model. For information on submitting change requests, see Change requests.
Switch between versions of a message model
When multiple versions of a message model are available as treeview, it is possible to toggle between the versions. When using this button in the left panel, you can switch versions for the entire message. When using the button in the right panel, you only switch versions for the selected element.
Export message model to spreadsheet
When you want your message model to be exported into spreadsheet format, this can be done by clicking the 'Export to spreadsheet' icon on the top-right.