Page History

...

• A link to the corresponding HTML Model documentation
• A high-level description of the purpose of the class and where it is used within the definition of a reporting event.
• A diagram showing the structure of the class and its relationships with other classes. The Mermaid tool has been used to define and render these diagrams. Either of 2 types of diagram is used on each page:
  • A Class Diagram is used when it is necessary to illustrate the inheritance of attributes between classes. Refer to the Mermaid documentation for class diagrams (available at https://mermaid.js.org/syntax/classDiagram.html) for information about components of class diagrams.
  • An Entity Relationship (ER) Diagram is used in all other cases. Refer to the Mermaid documentation for ER diagrams (available at https://mermaid.js.org/syntax/entityRelationshipDiagram.html) for more information about the components of ER diagrams.
• A description of each of the attributes of the class and how they are populated.
• At least one implementation example, showing how the attributes of the class may be populated for 1 or more instances of the class, or how instances of the class may be referenced in other parts of the model. These examples always include example data represented in YAML format and may also include the same example data represented in tabular format. YAML is a text-based "human-readable data serialization language"—i.e., a compact and understandable way to represent hierarchical data. In YAML, data is represented as attribute/value pairs; the attribute name is shown first, followed by a colon and then the value.
  • If the attribute contains a single simple value (such as a number of a text string), this is represented on the same line as the attribute name, e.g.,:
    

    textAttribute: Some text value here
    numericAttribute: 1.2

  • If the attribute contains an instance of another class, the attributes of the contained class are shown indented below the containing attribute, e.g.,:
    

    complexAttribute:
      textSubAttribute: Value for first attribute of the contained class
      numericSubAttribute: 0
      complexSubAttribute:
        textSubSubAttribute: xxx
        numericSubSubAttribute: 8.5

  • If the attribute contains a list of values, each value in the list is shown indented below and preceded by a hyphen, e.g.,:
    

    textListAttribute:
      - first text value
      - second text value
    numericListAttribute:
      - 18
      - 24
      - 6.5
    complexListAttribute:
      - textSubAttribute: text value for first attribute of first entry in list
        numericSubAttribute: 1.0
      - textSubAttribute: text value for first attribute of second entry in list
        numericSubAttribute: 2.0

Additional information about YAML can be found in Wikipedia (https://en.wikipedia.org/wiki/YAML). Note that in the implementation examples, an ellipsis (...) is used in YAML only to indicate deliberately excluded data.

...