ClassificationSystems Schema

Alias: clsf

Version: 1.0.3

A schema for classifying elements

This schema contains classes for modeling classification systems, which are organized sets of definitions used for classifying or categorizing real-world Objects.

In BIS, a ClassificationSystem consists of one or more ClassificationTables. Each ClassificationTable is an ISubModeledElement whose sub-model holds Classifications. Within the sub-model, the Classifications can be arranged in a hierarchy using the ClassificationOwnsSubClassifications parent-child relationship and grouped using ClassificationGroup and ClassificationGroupGroupsClassifications.

Class and Instance Diagrams

Table of contents

Entity Classes

Classification (Classification) EntityClass

An element that represents a single entry in a classification system

Base Class: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description for this Classification string
Inherited properties
Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json
IsPrivate If true, this bis:DefinitionElement should not be displayed in the GUI. boolean

ClassificationGroup (Classification group) EntityClass

ClassificationGroup groups classifications

Base Class: BisCore:GroupInformationElement

Properties

Name Description Type Extended Type
Description Description for this ClassificationGroup string
Inherited properties
Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json

ClassificationSystem (Classification System) EntityClass

An element used to represent a classification system

Base Class: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Source Source (or publisher) for this classification string
Edition The edition or version of the classification system from which the classification notation is derived. string
Location Resource identifier or locator, provided as URI, URN or URL, of the classification. string
Description Description for this ClassificationSystem string
Inherited properties
Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json
IsPrivate If true, this bis:DefinitionElement should not be displayed in the GUI. boolean

ClassificationTable (Classification Table) EntityClass

An element used to represent a table in a classification system

Base Class: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description for this ClassificationTable string
Inherited properties
Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code value for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores a human-readable real-world identifier of the Entity represented by the bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json
IsPrivate If true, this bis:DefinitionElement should not be displayed in the GUI. boolean

Relationship Classes

ClassificationGroupGroupsClassifications RelationshipClass

Maps Classification to its group

Base Class: BisCore:ElementGroupsMembers

Strength: Referencing

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: groups

Multiplicity: (0..*)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: is grouped in

Multiplicity: (0..*)

Constraint Classes:

ClassificationOwnsSubClassifications RelationshipClass

A relationship used to indicate that one classification specializes another classification

Base Class: BisCore:ElementOwnsChildElements

Strength: Embedding

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: owns

Multiplicity: (0..1)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: is owned by

Multiplicity: (0..*)

Constraint Classes:

ClassificationSystemOwnsClassificationTable RelationshipClass

Maps classification systems to their tables

Base Class: BisCore:ElementOwnsChildElements

Strength: Embedding

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: owns

Multiplicity: (0..1)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: is owned by

Multiplicity: (0..*)

Constraint Classes:

ClassificationSystemOwnsClassifications RelationshipClass Deprecated

DEPRECATED: Identifies classifications directly owned by a classification system

Base Class: BisCore:ElementOwnsChildElements

Strength: Embedding

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: owns

Multiplicity: (0..1)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: is owned by

Multiplicity: (0..*)

Constraint Classes:

ElementHasClassifications RelationshipClass

Assigns Classifications to Elements

Base Class: BisCore:ElementRefersToElements

Strength: Referencing

Strength Direction: Forward

Source

Is Polymorphic: true

Role Label: has classification

Multiplicity: (0..*)

Constraint Classes:

Target

Is Polymorphic: true

Role Label: classifies

Multiplicity: (0..*)

Constraint Classes:

Last Updated: 21 November, 2022