Skip to content

Display Metadata

Displayed data such as reports and forms along with their related schema and connection information are mapped to the open metadata types as follows.

Forms and Reports

Figure 1 shows the types of metadata for forms and reports that integration connectors can create.

Figure 1 - Form

Figure 1 - Report

Figure 1: Forms and Reports metadata

Either can be represented as a set of nested DataContainers with specific input and output DataFields used to represent the individual data items.

Queries

Integration connectors can also create queries that support forms and reports. Figure 2 shows the types of metadata for the queries.

Figure 2 - InformationView

Figure 2: Query metadata

Queries can also be represented as a set of nested data containers and data fields.

Open Metadata Types

Figure 3 shows the open metadata types used to represent the metadata for forms, reports and queries.

Figure 3 - Form

Figure 3 - Report

Figure 2 - InformationView

Figure 3: Form and Report open metadata types

The principle asset types are Form, Report and InformationView for forms, reports and queries respectively.

If the SoftwareCapability that hosts them - such as an Application or ReportingEngine - is catalogued, link each asset to it using the CapabilityAssetUse relationship.

When a DataContainer is created for a report or a form, it is represented as a DisplayDataContainer entity. DataFields are created as DisplayDataField entities.

The DataContainers and DataFields for queries are represented as QueryDataContainer and QueryDataField respectively.

All of these types are subtypes of schema attribute that use the TypeEmbeddedAttribute classification method for defining the schema type.

The different subtypes enable metadata searches to narrow the results to this type of display metadata.

Between a form or report asset and its top-level data containers/fields sit the Schema relationship, DisplayDataSchemaType entity and AttributeForSchema relationship.

Similarly, the combination of Schema relationship, QuerySchemaType entity and AttributeForSchema relationship sits between a query and its top-level data containers/fields.

When a data field/container is nested inside another, it is linked to the structure using the NestedSchemaAttribute relationship.


Raise an issue or comment below