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]: SingleLevelUsageAsBuilt 3.0.0 #638

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
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
#######################################################################
# Copyright (c) 2022,2023, 2024 BASF SE
# Copyright (c) 2022,2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2022,2023, 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
# Copyright (c) 2022,2023, 2024 German Edge Cloud GmbH & Co. KG
# Copyright (c) 2022,2023, 2024 Henkel AG & Co. KGaA
# Copyright (c) 2022,2023, 2024 Mercedes Benz AG
# Copyright (c) 2022,2023, 2024 Robert Bosch Manufacturing Solutions GmbH
# Copyright (c) 2022,2023, 2024 SAP SE
# Copyright (c) 2022,2023, 2024 Siemens AG
# Copyright (c) 2022,2023, 2024 T-Systems International GmbH
# Copyright (c) 2022,2023, 2024 ZF Friedrichshafen AG
# Copyright (c) 2022,2023, 2024 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.1.0#>.
@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#>.
@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.1.0#>.
@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.1.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_usage_as_built:3.0.0#>.
@prefix ext-number: <urn:samm:io.catenax.shared.business_partner_number:2.0.0#>.
@prefix ext-quantity: <urn:samm:io.catenax.shared.quantity:2.0.0#>.
@prefix ext-uuid: <urn:samm:io.catenax.shared.uuid:2.0.0#>.

:SingleLevelUsageAsBuilt a samm:Aspect;
samm:preferredName "SingleLevelUsageAsBuilt"@en;
samm:description "The aspect provides the information in which parent part(s)/product(s)the given item is assembled in. Could be a 1:1 relationship in terms of an e.g. a brake component or 1:n for e.g. coatings. The parent item must refer to an object from as-built lifecycle phase, i.e. a batch or a serialized part."@en;
samm:properties (:catenaXId :customers :parentItems);
samm:operations ();
samm:events ().

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

:customers a samm:Property;
samm:preferredName "Customers"@en;
samm:description "A list of all customers of this item. If the parent items in which this item is assembled into are known, they should be listed as well.\n\nFor serialized items the list should contain only one customer with one parent item.\nAs different subsets of a batch might be sold to different customers this is a list."@en;
samm:characteristic :ListOfCustomersCharacteristic;
samm:exampleValue "BPNL50096894aNXY".

:parentItems a samm:Property;
samm:preferredName "Parent Items"@en;
samm:description "Set of parent items, in which the given child object is assembled in (one structural level up).\n\nFor serialized items the list should contain only one parent item.\nAs different subsets of a batch might be used by a customer in different items this is a list."@en;
samm:characteristic :SetOfParentItemsCharacteristic.

:ListOfCustomersCharacteristic a samm-c:List;
samm:preferredName "List of Customers Characteristic"@en;
samm:description "A list of customers and their related parent items."@en;
samm-c:elementCharacteristic ext-number:BpnlTrait.

:SetOfParentItemsCharacteristic a samm-c:Set;
samm:preferredName "Set of Parent Items"@en;
samm:description "Set of parent items the given child object is assembled in (one structural level up)."@en;
samm:dataType :ParentData.

:ParentData a samm:Entity;
samm:preferredName "Parent Data"@en;
samm:description "Catena-X ID and meta data of the parent item."@en;
samm:properties ([ samm:property :quantity; samm:optional true ] :createdOn [ samm:property :lastModifiedOn; samm:optional true ] :isOnlyPotentialParent :businessPartner :catenaXId).

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

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

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

:isOnlyPotentialParent a samm:Property;
samm:preferredName "Is Only Potential Parent"@en;
samm:description "Expresses the certainty whether the part has been used as component or input material in the produced item. If the value is false, it can be assumed that the part has been used. If the value is true, there are alternatives for that part, and it is unknown if this part item or an alternative part item has been used.\nThis 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. Thus, these items cannot be differentiated from each other.\n"@en;
samm:characteristic samm-c:Boolean;
samm:exampleValue false.

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

:DateTimeTrait a samm-c:Trait;
samm:preferredName "Date Time Trait"@en;
samm:description "Trait to ensure regular expressions with different date and time(zone)formats."@en;
samm-c:baseCharacteristic :DateTimeCharacteristic;
samm-c:constraint :DateTimeRegularExpression.

:DateTimeCharacteristic a samm:Characteristic;
samm:preferredName "Date Time Characteristic"@en;
samm:description "Describes a property which contains the date and time with an optional timezone."@en;
samm:dataType xsd:string.

:DateTimeRegularExpression a samm-c:RegularExpressionConstraint;
samm:preferredName "Date Time Regular Expression"@en;
samm:description "Regular Expression to enable UTC and Timezone formats and the possibility to exclude time information."@en;
samm:value "^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?)?$".
1 change: 1 addition & 0 deletions io.catenax.single_level_usage_as_built/3.0.0/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "status" : "release"}
10 changes: 9 additions & 1 deletion io.catenax.single_level_usage_as_built/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Changelog
All notable changes to this model will be documented in this file.

## [Unreleased]
## [3.0.0] - 2024-02-26
### Changed
- changed `parentItems` property to be a mandatory child of the `SingleLevelUsageAsBuilt` aspect property instead of a child of the `customers` property
- changed `customers` property to be a list of BPNL
- replaced the `quantityNumber` and `measurementUnit` properties with the `itemUnit` and `quantityValue` properties of the shared quantity 2.0.0 aspect model
- replaced the whole `CatenaXIdTraitCharacteristic` and its childs with the `UuidV4Trait` of the shared uuid 2.0.0 aspect model
- replaced the whole `BpnTrait` and its childs with the `BpnlTrait` of the shared business_partner_number 2.0.0 aspect model
- description of some objects were adjusted


## [2.0.0] - 2023-09-01
### Added
Expand Down
Loading