Skip to content

0531 Document Schemas

Model 0531 shows the definitions for describing the schema of structured documents such as JSON or XML. They are typically attached to assets that are files or document stores.

UML

DocumentSchemaType

The root of the schema is represented by an entity of type DocumentSchemaType. This would link to the asset that represents the document, or the port where the document is passed to a process.

DocumentSchemaAttribute

Each data field in the schema is represented by a DocumentSchemaAttribute entity.

Note that the type information for each attribute within these structures is typically embedded on the DocumentSchemaAttribute through the TypeEmbeddedAttribute classification. Also recall that the NestedSchemaAttribute relationship can be used to capture nested (hierarchical) structures within such documents.

Deprecated types

The SimpleDocumentType, StructDocumentType, MapDocumentType, ArrayDocumentType, and SetDocumentType types have been deprecated because they offer little value since the type is typically stored in the TypeEmbeddedAttribute classification. This change makes the document schemas consistent with other types of schema.