Skip to main content
Release: CX-Jupiter (current)

CX-0067 Ontology Models to realize federated query in Catena-X v1.1.0

ABSTRACT

This standard gives fundamental guidelines for the creation of ontology models to be used in Catena-X. It provides the semantic foundation for the so-called Knowledge Agent Approach that utilizes semantic web technologies for federated queries in data spaces (see Catena-X standard CX-0084).

COMPARISON WITH THE PREVIOUS VERSION OF THE STANDARD

1. INTRODUCTION

Semantics is the art and science of understanding the meaning of data. In the context of Catena-X, this topic has a significant importance in the sense that data providers and consumers need to have the same understanding of what data is to be exchanged (see also FAIR Principles). In the knowledge agent approach, ontologies are used to describe the semantics of data. Ontologies are similar to data models or data schemas in which the semantics and structure of data are described. In addition, ontologies provide a high degree of semantic expressiveness, i.e. formal semantics. This means that there is a logical system behind the ontologies. This allows automatic inference on data like "p-123" is_a part & part is_a physical object => "p-123" is_a physical object. Such inference enables strong typing of data. In this way,the machine can understand the meaning of the vocabulary 'part', that it is a physical object and not a document part or a design model part. It could be that the same vocabularies are used for different things in different data models. The formal semantics of ontologies prevent such misunderstandings in data caused by synonymity or homonymity, etc. and lead to better collaboration and interoperability among data space participants. On the other hand, the ontology-based approach represents the underlying data in assets as a graph structure. This allows flexible querying of typed and linked data.

In applying the ontology-based data modeling in Catena-X, the following fundamentals should be achieved:

  • Maximise Semantics
  • Reduce Complexity
  • Minimise Redundancy

The goal of this standard is to ensure that ontology models are designed with the right quality and in a harmonized way that is compatible with the knowledge agent data processing mechanisms (CX-0084 V1.0.0-1.2.0). The ontology-based data modeling in the knowledge agent approach is explained in detail in section MODELING CONCEPT.

1.1 AUDIENCE & SCOPE

This section is non-normative

In general, this standard applies to the usage of ontologies in Catena-X with a specific focus on the Knowledge Agents data processing pattern (CX-0084). Thus, this standard does not inhibit the usage of other data models, such as SAMM standard for other Catena-X data processing patterns (e.g. for Digital Twin/Asset Administration Shell approach). If any other applications of ontologies in Catena-X emerge or already existing external ontologies shall be included/linked for Catena-X application, this standard will be revised accordingly (if applicable).

The following stakeholders are addressed in particular by this standard:

  • Business Application Providers that create/request specific models/ model extensions to make their application and or business logic work (relevant for certification if solutions are based on knowledge agent approach for data processing).

  • Data Providers that need to supply data and or functional logic based on given specification of an ontology model (not relevant for certification).

  • Enablement Service Providers that offer data integration solutions, e.g. for mapping of ontology models to corporate-internal data models (relevant for certification if solutions for knowledge agent approach are provided).

  • Catena-X e.V. will have a significant role of supervising ontology development (governance process for model development and respective quality criteria, not relevant for certification).

Created ontology models can be utilized as semantic basis for the so called "knowledge agent" approach to exchange data across Catena-X participants. This standard will reference required external standards. Furthermore, it will provide modeling guidelines that extend/restrict given W3C standards to decrease complexity and to make sure that the models are designed in a unified way compatible with CX0084 (knowledge agent standard).

1.2 CONTEXT AND ARCHITECTURE FIT

The knowledge agent approach uses the Semantic Web standards. The Semantic Web is the semantic extension of the Web. In the Web, the content of Web pages is exchanged in a document-based way (Web of Documents). This has the disadvantage that a direct access to a certain content of the documents is not possible. Therefore, a new concept was developed in which the contents of documents are decomposed into data and described by data models (Web of Data). At the same time, a query language was developed with which the desired content can be queried directly. In the Semantic Web, the data models are called ontologies, based on the philosophical meaning 'study of being', because the data on the Web is the digital representation of things in the real world. Semantic Web ontologies are formal languages in which data can be described unambiguously and without redundancy. This makes the ever-growing volumes of data on the web more manageable and usable to generate new knowledge. A good example is the DBpedia project, which makes Wikipedia content available as data. In recent years, Semantic Web standards have been increasingly used in enterprises to create enterprise-wide knowledge graphs to structure internal big data and make it queryable to create knowledge. This concept is extended in the Knowledge Agent standard (CX-0084) to realize data exchange across the Catena-X dataspace.

Semantic Web Standards used in knowledge agent approach

  • OWL 2 QL Profile for modeling ontologies,
  • OWL 2 RL Profile for modeling common dataspace assets,
  • SKOS for vocabularies,
  • RML & R2RML for mapping data source model to asset model to provide data in an asset,
  • SHACL for data quality check and for describing which data is available in the asset and in which form,
  • RDF for description and exchange of graph data,
  • Turtle for persisting,
  • SPARQL profiles for transferring logic and querying catalogues, data and functions.

Modeling Concept

This section explains the concept of ontology-based data modeling of the knowledge agent approach. Furthermore, it is shown how the query of distributed data in dataspaces works on the basis of this concept.

Modeling with Ontologies

In the Knowledge Agent approach, the data is modeled with the Semantic Web Ontology language OWL. This enables object-oriented modeling of domains with classes, attributes and relationships. Object-oriented modeling allows the modeling of a domain from general to specific by creating subclasses. The first step is to define the main classes that describe the domain. In the case of Catena-X, five main classes were defined.

  • Activity: This class comprises actions that are intentionally performed by instances of the actor over the course of the product life cycle and result in state changes in physical and conceptual objects.
  • Actor: This class comprises organization, device or people, either individually or in groups, who have the potential to perform intentional actions of kinds for which someone may be held responsible.
  • Physical object: This class includes objects of a material nature, which are documentation units and have physical boundaries.
  • Conceptual object: This class includes non-material products, human-produced data related to physical objects. The production of such information may have been supported by the use of technical tools.
  • Place: The class Place is determined by reference to the position of objects such as buildings, cities, or special geographic markers.

concept.jpg

Activity-centred Modeling

A well-known approach is the activity-centered or event-based modeling. The CIDOC CRM ontology provides this idea and the main classes based on this concept. In this approach the classes actor, place, physical object and conceptual object are connected through activities. Instead of assigning all information to the physical object. This distributed representation has several advantages:

  • The life cycles of products and documents are represented separately and clearly.
  • The activities have a start and end date so that the data can be queried chronologically.
  • The data can be viewed and queried from different perspectives.
    • Identifies all actors (e.g. companies) involved in an activity (e.g. manufacturing).
    • Identifies all activities performed on a physical object (vehicle).
    • Finds all activities that have been performed at a place.
    • Searches for all physical objects (e.g. material) used in an activity (e.g. manufacturing).
    • Search for conceptual objects related to a physical object in an activity.

model.jpg

Core and Domain Ontologies

The concept described above is the basic modeling pattern in Knowledge Agent. We call it the core ontology. Based on this ontology, specific domain ontologies can be modeled. A domain ontology can be created based on subclasses (e.g. Manufacturing is SubClassOf Activity), subrelations (e.g. has Manufacturer is SubPropertyOf has Participant) and subattributes. The domain ontology has the same structure as the core ontology, but can be extended to include additional classes. The Knowledge Agent approach uses OWL 2 QL for modeling. This is a subset of OWL 2 Full. The reason for this is that it includes most of the main features of conceptual models such as UML class diagrams and ER diagrams. It also provides polynomial time inference for large data sets.

Benefits of the basic modeling pattern:

  • Easy for domain experts to understand and create new domain ontologies.
  • Data is represented in datasets using the same pattern.
  • Data can be queried with general queries such as 'Get All Actors' or specific queries such as 'Get Manufacturer'.

domain.jpg

Data Serialization

In the ontology-based approach, the data is serialized in graph structure using the Resource Description Framework (see RDF). Each node, also called a resource, is uniquely identified by a URI. The edges are called property in RDF Graph because each relation forms a subject-predicate-object triple. The nodes can be linked to other nodes (so-called object property). The relations used are from the Domain Ontology. At the same time, nodes can be linked to literals (so-called datatype property). With the property rdf:type, the nodes can be instantiated with domain classes.

data.jpg

The RDF graphs are stored in RDF databases (so-called triple store) and can be serialized in various formats such as xml, json, ttl, etc. Different data sources such as relational databases, XML, JSON and CSV files can be mapped to RDF graphs using standardized languages such as RML and R2RML. Based on the mapping, the data can be transformed or virtualized. Virtualization allows the data to be processed as RDF graphs without transforming it and storing it in a different location.

Serialization of data based on Turtle syntax:

@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix cx-core: <https://w3id.org/catenax/ontology/core#> .
@prefix cx-vehicle: <https://w3id.org/catenax/ontology/vehicle#> .
@prefix exp: <https://www.example.com#> .

# Vehicle Ontology
cx-vehicle:Vehicle rdf:type owl:Class ;
rdfs:subClassOf cx-core:PhysicalObject.

cx-vehicle:vehicleIdentificationNumber rdf:type owl:DatatypeProperty ;
rdfs:subPropertyOf cx-core:id ;
rdfs:domain cx-vehicle:Vehicle ;
rdfs:range xsd:string .

# Sample instance
exp:vehicle_1 rdf:type cx-vehicle:Vehicle, cx-core:PhysicalObject;
cx-core:name "Goggomobile"
cx-core:id "ABCDEFG1HI2J34567".
cx-vehicle:vehicleIdentificationNumber "ABCDEFG1HI2J34567".

Digital Twin and Ontologies

A digital twin is a digital object in a defined digital platform, such as the Web, data spaces, etc., that represents a real-world object and is identifiable and discoverable based on a defined unique identification. In the knowledge agent approach, a digital twin is an existing instance of a class of a domain ontology. The domain ontologies describe what kind of real-world objects it represents. With the cx-core:id all instances are identifiable in the Catena-X data space. A shape graph for the data provider's asset describes which digital twins are published in its asset. This makes the digital twins discoverable.

Taxonomy

A taxonomy is a collection of terms and their meaning. The terms are structured in a hierarchical form, whereby the relationships become broader and narrower. Taxonomies can be seen as a dictionary that ensures the correct use of terms. Ontologies use the terms to describe a domain. Domain ontologies can grow very quickly and become confusing. Therefore, it is not recommended to define classes for all types of a domain in an ontology. Instead of defining new subclasses, the instances can be typed using terms from the taxonomy. For this purpose, a Catena-X taxonomy is created with SKOS, which can be extended based on the classes of the core ontology. For example, the class Vehicle in the Vehicle Ontology describes vehicles. A small car is a special type of vehicle for which there it is not necessary to create a separate class. Instead, the term can be included in the taxonomy and the instances can be specified from there.

@prefix dct: <https://purl.org/dc/terms/> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix cx-core: <https://w3id.org/catenax/ontology/core#> .
@prefix cx-vehicle: <https://w3id.org/catenax/ontology/vehicle#> .
@prefix cx-taxo: <https://w3id.org/catenax/ontology/taxonomy#> .

# Catena-X Taxonomy
cx-taxo:Thing a skos:Concept;
skos:prefLabel "Thing"@en .

cx-taxo:PhysicalObject a skos:Concept ;
skos:broader cx-taxo:Thing ;
skos:narrower cx-taxo:PhysicalObject ;
skos:prefLabel "Physical Object"@en .

cx-taxo:Vehicle a skos:Concept ;
skos:broader cx-taxo:PhysicalObject ;
skos:narrower cx-taxo:SmallCar ;
skos:prefLabel "Vehicle"@en .

cx-taxo:SmallCar a skos:Concept ;
skos:broader cx-taxo:Vehicle ;
skos:prefLabel "Small Car"@en .



# Instance Vehicle
exp:vehicle_1 rdf:type cx-vehicle:Vehicle;
dct:type cx-taxo:SmallCar.

Asset Content Description

The Common Ontology contains classes and properties to describe assets on a meta-level. The asset class describes the URL from which the SPRAQL endpoint can be reached, which ontology was used to describe the data, what form the data has based on SHACL, which business partner provides the asset, and so on. The descriptions are helpful for ordinary users and necessary for application configuration.


@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix cx-core: <https://w3id.org/catenax/ontology/core#> .
@prefix cx-vehicle: <https://w3id.org/catenax/ontology/vehicle#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .

# Asset description
exp:asset_1 rdf:type cx-common:Asset;
cx-core:id "asset_1";
dct:type cx-taxo:GraphAsset;
cx-common:name "Vehicle dataset";
rdfs:isDefinedBy <https://w3id.org/catenax/ontology/vehicle>;
cx-common:shapeGraph exp:vehicleShapeGraph;
cx-common:dataAddress exp:dataAddress_1

exp:dataAddress_1 rdf:type cx-common:DataAddress;
cx-common:baseUrl "http://provisioning-agent:8080/sparql";


# Asset content description (exp:vehicleShapeGraph)
exp:VehicleShape a sh:NodeShape ;
sh:targetClass cx-vehicle:Vehicle ;
sh:property [
sh:path cx-vehicle:vehicleIdentificationNumber ;
sh:pattern "[A-Z0-9]{17}";
sh:minCount 1 ;
] ;
sh:property [
sh:path cx-core:name ;
sh:datatype xsd:string ;
sh:minCount 1 ;
] .

Modeling of the Functions

In the Knowledge Agent approach, in addition to publishing static data, it is also possible to offer services that perform calculations. These services can be called as functions with parameters. The functions can be modeled using the ontology function. The function parameters are defined by the cx-fx:argument. The ontology also contains function configuration properties that are required to configure the service.


@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix cx-core: <https://w3id.org/catenax/ontology/core#> .
@prefix cx-vehicle: <https://w3id.org/catenax/ontology/vehicle#> .
@prefix exp: <https://www.example.com#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .


# Sample Function

exp:GetModelYear rdf:type cx-fx:Function;
rdfs:comment "Returns the model year for a given vehicle identification number.".

exp:vin rdf:type cx-fx:argument ;
rdfs:domain cx-fx:Function ;
rdfs:range xsd:string.

exp:ModelYear rdf:type cx-fx:Result;

Functions are defined in a similar way to data in SHACL. In addition, the cx-sh:hasAsArgument property can be used to define which data property is required for a function argument to execute the function.


# Function Ontology

exp:GetModelYearShape a sh:NodeShape ;
sh:targetClass exp:GetModelYear ;
sh:property [
cx-sh:hasAsArgument cx-vehicle:vehicleIdentificationNumber;
sh:path exp:vin ;
sh:pattern "[A-Z0-9]{17}";
sh:minCount 1 ;
] .

Data Query

The RDF graphs can be accessed using the SPARQL query language via a SPARQL HTTP protocol. SPARQL allows the definition of complex instance relationships and the search for the defined patterns in the RDF graphs.

General query example: Returns all physical objects and their name and activities.

PREFIX cx: <https://w3id.org/catenax/ontology/core#>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX exp: <http://www.example.com#>

select ?activity ?physicalObject ?name
where {
?activity rdf:type cx:Activity.
?physicalObject rdf:type cx:PhysicalObject.
?physicalObject cx:name ?name.
?activity cx:refersToPhysicalObject ?physicalObject.
}

Query result (for mime-type "text/csv"):

?activity?physicalObject?name
exp:manufacturing_1exp:vehicle_1"Goggomobil"

The same result (for mime-type "application/sparql-results+json"):

{
"head": {
"vars": [
"activity",
"physicalObject",
"name"
]
},
"results": {
"bindings": [
{
"activity": {
"type": "uri",
"value": "http://www.example.com#manufacturing_1"
},
"physicalObject": {
"type": "uri",
"value": "http://www.example.com#vehicle_1"
},
"name": {
"type": "literal",
"value": "Goggomobil"
}
}
]
}
}


Specific query example: Returns all vehicles and their name and manufacturing activities.


PREFIX cx: <https://w3id.org/catenax/ontology/core#>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX exp: <http://www.example.com#>

select ?activity ?physicalObject ?name
where {
?activity rdf:type cx:Manufacturing.
?physicalObject rdf:type cx:Vehicle.
?physicalObject cx:name ?name.
?activity cx:refersToPhysicalObject ?physicalObject.
}

Query result is the same as the first one:

?activity?physicalObject?name
exp:manufacturing_1exp:vehicle_1"Goggomobil"

Federated Query

An important advantage of SPARQL is that multiple repositories can be accessed from a single query. This feature gives Catena-X the great advantage of being able to query distributed data in different assets at the same time.

example.jpg

Federated query example: Returns all vehicle names from the OEM asset and for the same vehicles the names of the diagnosis results from the service asset.


PREFIX cx: <https://w3id.org/catenax/ontology/core#>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>

select ?vehicleName ?vehicleVin ?diagnosisResultName
where {

# OEM Asset
  SERVICE <https://catena-x.net/asset/oem/asset_1> {
?physicalObjectOEM rdf:type cx:Vehicle.
    ?physicalObjectOEM cx:vin ?vehicleVin.

#Service Asset
    SERVICE <https://catena-x.net/asset/service/asset_2> {
?physicalObjectService rdf:type cx:Vehicle.
      ?physicalObjectService cx:vin ?vehicleVin.
?physicalObjectService cx:name ?vehicleName.
?activity rdf:type cx:Diagnosis.
?activity cx:refersToPhysicalObject ?physicalObjectService.
      ?activity cx:refersToConceptualObject ?conceptualObject.
      ?conceptualObject cx:name ?diagnosisResultName.
}
  }
}

Federated Query result (for mime-type "text/csv"):

?vehicleName?vehicleVin?diagnosisResultName
"Goggomobil""ABCDEFG1HI2J34567""Cylinder misfire"
"Fliewatuut""0815""Rotor breakdown"
"Herby""4711""Low Oil Pressure"

Skill

A Skill in the knowledge agent approach is any Data/Federated Query which

  • is parameterizable by a set of input variables
  • is published in the dataspace as a contractible asset with a unique id
  • maybe invoked either on consumer-side (by downloading the query test) or provider-side (by execution of the query)

For example, above federated query could be invoked under the assetname SkillAsset?supplier=ListDiagnosis and the following input parameter set (using contenttype "application/sparql-results+json")


{
"head": {
"vars": [
"vehicleVin"
]
},
"results": {
"bindings": [
{
"vin": {
"type": "literal",
"value": "ABCDEFG1HI2J34567"
}
},
{
"vin": {
"type": "literal",
"value": "4711"
}
}
]
}
}

Skill invocation result (for mime-type "text/csv"):

?vehicleName?vehicleVin?diagnosisResultName
"Goggomobil""ABCDEFG1HI2J34567""Cylinder misfire"
"Herbie""4711""Low Oil Pressure"

1.4 CONFORMANCE

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MAY, MUST, MUST NOT, OPTIONAL, RECOMMENDED, REQUIRED, SHOULD and SHOULD NOT in this document document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

1.5 PROOF OF CONFORMITY

This section is normative

The type of ontology model characterized in this standard provides the basis for federated query with Knowledge Agent approach. To check for conformity, enablement service providers MUST prove to CAB (Conformity Assessment Bodies) that their offered solutions are able to process ontology models specified by this standard. Processing in this context means, that it is shown how the service to be certified opens/imports an ontology file without errors. The ontology files to be used for this conformance test MUST be retrieved from the corresponding repository governed by Catena-X e.V. in Ontology Hub. Data providers and business application providers do not need a certification against this standard by CAB.

In addition to technical conformance of the file format, the content of models also needs to be reviewed to be compliant with this standard and overall federated query approach. This proof of conformity is done by Catena-X e.V and their given governance process for semantic modeling. The corresponding organization is still to be created by Catena-X e.V. (Technical Committee for Modeling - TC4M). Respective quality criteria are listed in section MODELING GUIDELINES. Thus, CAB will not review model content.

1.7 TERMINOLOGY

*This section is non-normative_

SyntaxDescription
AttributeAn attribute represents a characteristic of an entity/class/individual, e.g. foaf:Person foaf:name "Max". An attribute is called 'owl:DatatypeProperty' in OWL
ClassA class is a set of individuals with shared structure/properties, i.e. kinds of things
Data MappingA data mapping connects the logical data model (ontology) with the underlying external physical data model (RDB schema)
InstanceAn instance is an object of a class
Knowledge graph (KG)A knowledge graph is a graph-structured database where knowledge is represented in the ontology and instances. There are two types of KGs: RDF and Labeled Property Graphs
LiteralA literal represents a data value, i.e. an element with a data type (string or integer), e.g. foaf:Person foaf:name "Max"
NamespaceA namespace is the base URI: Example: http://www.w3.org/1999/02/22-rdf-syntax-ns# with the prefix rdf
OntologyAn OWL ontology is a semantic data model based on description logic that consists of classes, relations, attributes for a specific domain of interest/discourse
RelationA relation represents how two individuals are connected/related, e.g. cx:Bob cx:knows cx:Tom. A relation is called 'owl:ObjectProperty' in OWL
TripleA triple is statement consisting of subject-predicate-object that is defined by RDF
Uniform Resource Identifier (URI)An URI is an unique identifier for a (web) resource
Use CaseA Use Case (description) is an excerpt/a composition of a set of domain ontologies. It lists consuming and providing roles as well as cardinality/existence constraints on classes, relations and attributes for a specific application

2 MAIN CONTENT

This section is normative

Modeling Guidelines

To facilitate the modeling process, a joint knowledge acquisition workshop with stakeholders (data producers, consumers, subject matter experts) is helpful. This workshop should have the following objectives:

  • Specify the ontology domain and scope
  • Collect the requirements, data sources
  • Prevent misunderstanding and moderate the expectations
  • Collect relevant classes, relations, attributes

This section defines modeling guidelines that help develop compliant domain ontologies based on the Core Ontology. New ontologies or adaptation of existing ontologies are created upon request of Catena-X use cases.

Content Modeling Guidelines

This section provides guidelines for effectively developing useful and reusable ontologies.

IDPriorityGuidelineDescription
G11SHOULDDefine business requirements - Who knows, produces, consumes the data?
- State the business questions and define Asset queries
- Define the source data needed for the asset
G12MUSTModel scope - Identify the specific classes, attributes, and relationships for source data from existing domain ontologies. If none exist, create a new ontology or extend existing domain ontologies
G13aMUSTCreate Domain Ontology - Import the core ontology and develop the domain ontology based on the modeling concept (1.2.1 MODELING CONCEPT)
- Define import dependency in ontologies
- Define turtle file name followed by 'ontology' in snake_case
- Specify title of ontology followed by 'Ontology' in title case with whitespaces (domain) + ' Ontology', e.g. 'Vehicle Ontology'
- Specify version, use three integers separated with two dots
- Specify author, full name(s) of main responsible(s) comma separated
- Specify contributor, full name(s) domain expert(s) comma separated
- Specify description, i.e. state business problem and business questions
G13bSHOULDCreate Domain Ontology - Use a short, unambiguous domain name so that everyone can easily understand the meaning
G14MUSTCreate Classes- Specify the (machine-readable) identifier in English
- Use only noun or a phrase of nouns
- Specify the (human-readable) name in English and German
- Specify the definition in English, only short sentence
- Don't create subclasses unless the subclass has a specific attribute or relation. In this case, use Catena-X taxonomy (or other taxonomies) to type instances with dct:type (see http://purl.org/dc/elements/1.1/type)
G15MUSTCreate Relations - Specify the (machine-readable) identifier in English
- Use a complete verb phrase (e.g. is part of, knows)
- Specify the (human-readable) name in English and German
- Specify the domain
- Specify the range
- Specify the definition in English, only short sentence
G16MUSTCreate Attributes - Specify the (machine-readable) identifier in English
- Use a noun or a phrase of nouns
- Use class name as specifier, if the attribute is specific to the class
- Specify the (human-readable) name in English and German
- Specify the domain
- Specify the range
- Specify the definition in English, only short sentence
G16MAYDefine Use Cases - Select Classes, Relations, Attributes based on their (machine-readable) identifier in English
- Declare consuming roles
- Declare providing roles
- Declare Policies

Technical Modeling Guideline

Technical modeling guidelines are necessary for the correct use of ontologies in assets.

IDPriorityGuidelineDescription
G21MUSTOntology export - Export ontology from editor as turtle file: (domain) + '_ontology.ttl', e.g. 'vehicle_ontology.ttl'
G22MUSTResolve redundancies - All classes, relations, attributes are uniquely defined in an ontology
G23MUSTOntology consistency - Check for conflicts with ontology reasoner
G24SHOULDOntology quality - Scan your ontology with the Ontology Pitfall Scanner (see https://oops.linkeddata.es/)
G25MUSTOntology use - Merge domain ontologies if necessary for the assets
G26SHOULDUse Case - Check use case constraints for assets depending on role
G27MUSTAsset Content Description - Create a shape graph based on SHACL for all classes and properties used in the asset

Syntactical Modeling Guidelines

Syntactic modeling guidelines increase comprehensibility and enable unified modeling of ontologies.

IDPriorityGuidelineDescription
G31SHOULDGeneral & Language - Avoid bad naming, consider interpretation and context
- Make names more specific if it has more than one interpretation
- Try to name examples, since it supports in the semantics
- Use short, meaningful, unambiguous names
- Use both English and German names, since it improves the semantics
- Avoid omitting definitions or bad definitions
- Don't use vague terms, e.g. model, data, ...
- Use only US English terms and name British terms as synonyms, e.g. meter/metre
- Don't use acronyms and abbreviations
- Note: natural language exhibits ambiguity, inaccuracy, uncertainty, vagueness
G32MUSTIdentifiers/URIs- Use only alphanumeric characters [A-z0-9] (IRI/URI standard)
- Use PascalCase/UpperCamelCase for classes (RDF/OWL standard)
- Use camelCase/lowerCamelCase for relations and attributes (RDF/OWL standard)
- Use the naming convention table (see below)
G33MUSTNaming Conventions - Use only alphanumeric characters with whitespaces [A-z0-9 ] + Umlaute (ÄäÖöÜüß)
- Use title case with whitespaces for classes and attributes for better human-readability
- Use lower case with whitespaces for relations
- Use the naming convention table (see below)

Naming convention table for identifiers and names:

conventionidentifiername_enname_de
languageEnglishEnglishGerman
readabilitymachine-readablehuman-readablehuman-readable
termsgeneric termsbusiness termsbusiness terms
character range[A-z0-9][A-z0-9 -][A-z0-9 -ÄäÖöÜüß]
separatornonewhitespacewhitespace
class casePascalCaseTitle CaseTitle Case
relation casecamelCaselower caselower case
attribute casecamelCaseTitle CaseTitle Case
acronymsnoyesyes

3 REFERENCES

3.1 NORMATIVE REFERENCES

3.2 NON-NORMATIVE REFERENCES

This section is non-normative

3.3 REFERENCE IMPLEMENTATIONS

This section is non-normative

Copyright © 2024 Catena-X Automotive Network e.V. All rights reserved. For more information, please visit here.