Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Model Update]: SingleLevelBomAsBuilt #273

Merged
merged 8 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions io.catenax.single_level_bom_as_built/2.0.0/SingleLevelBomAsBuilt.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
#######################################################################
# Copyright (c) 2022,2023 BASF SE
# Copyright (c) 2022,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2022,2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
# Copyright (c) 2022,2023 German Edge Cloud GmbH & Co. KG
# Copyright (c) 2022,2023 Henkel AG & Co. KGaA
# Copyright (c) 2022,2023 Mercedes Benz AG
# Copyright (c) 2022,2023 Robert Bosch Manufacturing Solutions GmbH
# Copyright (c) 2022,2023 SAP SE
# Copyright (c) 2022,2023 Siemens AG
# Copyright (c) 2022,2023 T-Systems International GmbH
# Copyright (c) 2022,2023 ZF Friedrichshafen AG
# Copyright (c) 2022,2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This work is made available under the terms of the
# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
# which is available at
# https://creativecommons.org/licenses/by/4.0/legalcode.
#
# SPDX-License-Identifier: CC-BY-4.0
#######################################################################

@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.0.0#> .
@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.0.0#> .
@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.0.0#> .
@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.0.0#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.single_level_bom_as_built:2.0.0#> .

:SingleLevelBomAsBuilt a samm:Aspect ;
samm:preferredName "Single Level Bill of Material as Built"@en ;
samm:description "The single-level bill of material represents one sub-level of an assembly and does not include any lower-level subassemblies. The as-built lifecycle references all child items as manufactured by the manufacturer referencing only child items in an as-built lifecycle themselves (e.g. serial parts or batches), unless parts can only be tracked by an part ID (on a type level).\n\nIf it is unclear which item has been built-in into the parent item, all potential parts must be listed. This is the case when, e.g. the same item is supplied by two suppliers and the item is only tracked by a customer part ID during assembly, these items can not be differentiated from each other.\n"@en ;
samm:properties ( :catenaXId :childItems ) ;
samm:operations ( ) ;
samm:events ( ) .

:catenaXId a samm:Property ;
samm:preferredName "Catena-X ID"@en ;
samm:description "The Catena-X ID of the given part (e.g. the assembly), valid for the Catena-X dataspace."@en ;
samm:characteristic :CatenaXIdTraitCharacteristic ;
samm:exampleValue "urn:uuid:055c1128-0375-47c8-98de-7cf802c3241d" .

:childItems a samm:Property ;
samm:preferredName "Child Items"@en ;
samm:description "Set of child items, of which the given parent item is assembled by (one structural level down)."@en ;
samm:characteristic :SetOfChildItemsCharacteristic .

:CatenaXIdTraitCharacteristic a samm-c:Trait ;
samm:description "Trait to ensure UUID v4 data format"@en ;
samm-c:baseCharacteristic :Uuidv4Characteristic ;
samm-c:constraint :Uuidv4RegularExpression .

:SetOfChildItemsCharacteristic a samm-c:Set ;
samm:preferredName "Set of Child Items"@en ;
samm:description "Set of child items the parent item is assembled by (one structural level down)."@en ;
samm:dataType :ChildData .

:Uuidv4Characteristic a samm:Characteristic ;
samm:preferredName "UUID v4 Characteristic"@en ;
samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en ;
samm:see <https://tools.ietf.org/html/rfc4122> ;
samm:dataType xsd:string .

:Uuidv4RegularExpression a samm-c:RegularExpressionConstraint ;
samm:preferredName "Catena-X Id Regular Expression"@en ;
samm: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 ;
samm:see <https://datatracker.ietf.org/doc/html/rfc4122> ;
samm: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}$)" .

:ChildData a samm:Entity ;
samm:preferredName "Child Data"@en ;
samm:description "Catena-X ID and meta data of the assembled child item."@en ;
samm:properties ( :createdOn :quantity [ samm:property :lastModifiedOn; samm:optional true ] :catenaXId [ samm:property :businessPartner; samm:optional false ] :hasAlternatives ) .

:createdOn a samm:Property ;
samm:preferredName "Created On"@en ;
samm:description "Timestamp when the relation between the parent item and the child item was created, e.g. when the serialized child part was assembled into the given part."@en ;
samm:characteristic samm-c:Timestamp ;
samm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime .

:quantity a samm:Property ;
samm:preferredName "Quantity"@en ;
samm:description "Quantity of which the child item is assembled into the parent item. In general it is '1' for serialized parts."@en ;
samm:characteristic :QuantityCharacteristic .

:lastModifiedOn a samm:Property ;
samm:preferredName "Last Modification Date"@en ;
samm:description "Timestamp when the assembly relationship between parent item and child item was last modified."@en ;
samm:characteristic samm-c:Timestamp ;
samm:exampleValue "2022-02-03T14:48:54.709Z"^^xsd:dateTime .

:businessPartner a samm:Property ;
samm:preferredName "Business Partner"@en ;
samm:description "The supplier of the given child item."@en ;
samm:characteristic :BpnTrait ;
samm:exampleValue "BPNL50096894aNXY" .

:hasAlternatives a samm:Property ;
samm:preferredName "Has Alternatives"@en ;
samm:description "Expresses wether the part is built-in or wether it is one of several options. If the value is false, it can be assumend this exact item is built-in. If the value is true, it is unknown wether this or an alternative item is built-in.\nThis is the case when, e.g. the same item is supplied by two suppliers, the item is only tracked by a customer part ID during assembly. Thus, these items can not be differentiated from each other.\n\n"@en ;
samm:characteristic :HasAlternativesCharacteristic .

:QuantityCharacteristic a samm-c:Quantifiable ;
samm:description "Describes the quantity in which the child item is assembled in the given parent item by providing a quantity value and the measurement unit in which the quantity is measured."@en ;
samm:dataType :Quantity .

:BpnTrait a samm-c:Trait ;
samm:preferredName "BPN Business Partner Number Trait"@en ;
samm-c:baseCharacteristic :BpnCharacteristic ;
samm-c:constraint :BpnConstraint .

:HasAlternativesCharacteristic a samm:Characteristic ;
samm:preferredName "Has Alternatives Characteristic"@en ;
samm:description "Describes the value whether the child data has alternatives."@en ;
samm:dataType xsd:boolean .

:Quantity a samm:Entity ;
samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en ;
samm:properties ( :quantityNumber :measurementUnit ) .

:BpnCharacteristic a samm:Characteristic ;
samm:preferredName "BPN Characteristic"@en ;
samm:dataType xsd:string .

:BpnConstraint a samm-c:RegularExpressionConstraint ;
samm:preferredName "BPN Constraint"@en ;
samm:description "Business Partner Number Regular Expression allowing only BPNL which stands for a legal entity."@en ;
samm:value "^(BPNL)([0-9]{8})([a-zA-Z0-9]{4})$" .

:quantityNumber a samm:Property ;
samm:preferredName "Quantity Number"@en ;
samm:description "The number of objects related to the measurement unit"@en ;
samm:characteristic :NumberOfObjects ;
samm:exampleValue "2.5"^^xsd:double .

:measurementUnit a samm:Property ;
samm:description "Unit of Measurement for the quantity of serialized objects"@en ;
samm:see <https://eclipse-esmf.github.io/samm-specification/2.0.0/appendix/unitcatalog.html> ;
samm:characteristic samm-c:UnitReference ;
samm:exampleValue "unit:litre"^^samm:curie .

:NumberOfObjects a samm:Characteristic ;
samm:description "Quantifiable number of objects in reference to the measurementUnit"@en ;
samm:dataType xsd:double .

1 change: 1 addition & 0 deletions io.catenax.single_level_bom_as_built/2.0.0/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "status" : "release"}
12 changes: 11 additions & 1 deletion io.catenax.single_level_bom_as_built/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# Changelog
All notable changes to this model will be documented in this file.

## [Unreleased]
## [2.0.0] - 25.09.2023
### Added
- property called hasAlternative
- Boolean characteristic

### Changed
- Description of the main property 'SingleLevelBomAsBuil' was adapted to the new requirements of the model

### Removed
-


## [1.0.0]
### Added
Expand Down