[New Model]: Shared CatenaX Identifier (UUIDv4)

[jacewski-bosch]

Model Description

A lot of released models reference the CatenaX ID. It would make sense to create a shared aspect for it. For simpler dependency management I would suggest creating a separate model for it. For backward compatibility reasons, it might be necessary to create 2 or 3 versions of it, Since originally the CatenaXId was just added raw and unprefixed, while it has been changed to be prefixed by a UUID URN.

• version 1.0.0 describing the older unprefixed version
• version 2.0.0 describing the newer prefixed URN prefixed version
• version 1.1.0 allowing both

Relevant Standards

https://datatracker.ietf.org/doc/html/rfc4122

Example Data

see the following relevant snippet from an already released model.

...
:catenaXId a bamm:Property;
    bamm:name "catenaXId";
    bamm:preferredName "Catena-X Identifier"@en;
    bamm:description "The fully anonymous Catena-X ID of an object, organization or concept, valid for the Catena-X dataspace."@en;
    bamm:characteristic :CatenaXIdTrait;
    bamm:exampleValue "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379".
:CatenaXIdTrait a bamm-c:Trait;
    bamm:name "CatenaXIdTrait";
    bamm:preferredName "Catena-X ID Trait"@en;
    bamm:description "Trait to ensure data format for Catena-X ID"@en;
    bamm-c:constraint :UUIDv4RegularExpression;
    bamm-c:baseCharacteristic :UUIDv4.
:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint;
    bamm:name "UUIDv4RegularExpression";
    bamm:preferredName "Catena-X Id Regular Expression"@en;
    bamm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en;
    bamm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)";
    bamm:see <https://datatracker.ietf.org/doc/html/rfc4122>.
:UUIDv4 a bamm:Characteristic;
    bamm:name "UUIDv4";
    bamm:preferredName "UUIDv4"@en;
    bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en;
    bamm:dataType xsd:string.

MS1 Criteria

• [x] The proposed aspect model does not exist already
• [x] The proposed aspect model does not extend an existing aspect but introduces completely new functionality
• [x] The proposal references a Catena-X use case
• [x] Relevant standards are mentioned/linked
• [x] A first draft of the data structure is provided in an example

[ZazraltMagic]

• [ok]model doesn't exist
• [ok] not relevant for shared aspect model
• [ok] not individual use case, for all BAMM models that uses catenaXId
• [ok] standard is linked, uuid with prefix
• [ok] example given

@bs-jokri MS1 approved

[arnoweiss]

While you're at it - I think there is a general conversation to be had about how closely the models should be tied to Catena-X. There is a general consensus that Submodel Templates generated from SAMM should be proposed in the IDTA. The IDTA will not standardize something that is called "catenaXId". My proposal would be to avoid:

{
  "catenaXId": "foobar"
}

and to encourage something like

{
  "idType": "catenaXId",
  "value": "foobar"
}

Of course this is going to be ugly af when SAMM-properties are mapped to AAS-properties but it's the best I can think of.

[BirgitBoss]

The alternative might be also something like a property "assetId" and a value like urn:dataspace:catena-x:caenaXId:foobar

or two models: one with an abstract identifier and another one derived from it with a catena-x specific ID

abstract id catenaXId inherits from abstract id

[arnoweiss]

@jacewski-bosch - can I assist you with the modeling in any way?