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

[New Model]: PartTypeInformation 1.0.0 #603

Merged
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
148 changes: 148 additions & 0 deletions io.catenax.part_type_information/1.0.0/PartTypeInformation.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
#######################################################################
# Copyright (c) 2024 BASF SE
# Copyright (c) 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
# Copyright (c) 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML)
# Copyright (c) 2024 German Edge Cloud GmbH & Co. KG
# Copyright (c) 2024 Henkel AG & Co. KGaA
# Copyright (c) 2024 Mercedes Benz AG
# Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
# Copyright (c) 2024 SAP SE
# Copyright (c) 2024 Siemens AG
# Copyright (c) 2024 T-Systems International GmbH
# Copyright (c) 2024 ZF Friedrichshafen AG
# Copyright (c) 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.part_type_information:1.0.0#>.
@prefix ext-classification: <urn:samm:io.catenax.shared.part_classification:1.0.0#>.
@prefix ext-number: <urn:samm:io.catenax.shared.business_partner_number:2.0.0#>.
@prefix ext-uuid: <urn:samm:io.catenax.shared.uuid:2.0.0#>.

:PartTypeInformation a samm:Aspect;
samm:preferredName "Part Type Information"@en;
samm:description "A Part Type Information represents an item in the Catena-X Bill of Material (BOM) on a type level in a specific version."@en;
samm:properties(:catenaXId :partTypeInformation [ samm:property :partSitesInformationAsPlanned; samm:optional true ]);
samm:operations();
samm:events().

:catenaXId a samm:Property;
samm:preferredName "Catena-X ID"@en;
samm:description "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace."@en;
samm:characteristic ext-uuid:UuidV4Trait;
samm:exampleValue "580d3adf-1981-44a0-a214-13d6ceed9379".

:partTypeInformation a samm:Property;
samm:preferredName "Part Type Information"@en;
samm:description "The part type from which the serialized part has been instantiated."@en;
samm:characteristic :PartTypeInformationCharacteristic.

:partSitesInformationAsPlanned a samm:Property;
samm:preferredName "Part Sites Information as Planned"@en;
samm:description "A site is a delimited geographical area where a legal entity does business (geographical address with geo coordinates). A site always has a primary physical address. It is possible that further physical addresses are specified for the site. P.O. box details are only possible in addition to the physical address. A site has a 1:n relation to addresses, means at least one address is necessary and multiple addresses are possible."@en;
samm:see <https://confluence.catena-x.net/x/QkBHAw>;
samm:characteristic :partSitesInformationAsPlannedCharacteristic.

:PartTypeInformationCharacteristic a samm:Characteristic;
samm:preferredName "Part Type Information Characteristic"@en;
samm:description "The characteristics of the part type."@en;
samm:dataType :PartTypeInformationEntity.

:partSitesInformationAsPlannedCharacteristic a samm-c:Set;
samm:preferredName "Part Sites Information as Planned Characteristic"@en;
samm:description "The characteristic of the part site information that represents a set of possible site to a respective part."@en;
samm:dataType :partSitesInformationAsPlannedEntity.

:PartTypeInformationEntity a samm:Entity;
samm:preferredName "Part Type Information Entity"@en;
samm:description "Encapsulation for data related to the part type."@en;
samm:properties(:manufacturerPartId :nameAtManufacturer [ samm:property ext-classification:partClassification; samm:optional true ]).

:partSitesInformationAsPlannedEntity a samm:Entity;
samm:preferredName "Part Sites Information as Planned Entity"@en;
samm:description "Describes the ID, function and validity date of a site for the associated part in the AsPlanned context."@en;
samm:properties(:catenaXsiteId :function [ samm:property :functionValidFrom; samm:optional true ] [ samm:property :functionValidUntil; samm:optional true ]).

:manufacturerPartId a samm:Property;
samm:preferredName "Manufacturer Part ID"@en;
samm:description "Part ID as assigned by the manufacturer of the part. The part ID identifies the part in the manufacturer`s dataspace. The part ID references a specific version of a part. The version number must be included in the part ID if it is available. The part ID does not reference a specific instance of a part and must not be confused with the serial number."@en;
samm:characteristic :PartIdCharacteristic;
samm:exampleValue "123-0.740-3434-A".

:nameAtManufacturer a samm:Property;
samm:preferredName "Name at manufacturer"@en;
samm:description "Name of the part as assigned by the manufacturer."@en;
samm:characteristic :PartNameCharacteristic;
samm:exampleValue "Mirror left".

:catenaXsiteId a samm:Property;
samm:preferredName "Catena-X site identifier"@en;
samm:description "The identifier of the site according to Catena-X BPDM. The catenaXsiteId must be a valid Catena-X BPN. The BPN is a unique, unchangeable identifier for business partners / company locations from foundation to closure, regardless of the different business relationships / structures between or within the business partners or company locations."@en;
samm:characteristic ext-number:BpnsTrait;
samm:exampleValue "BPNS1234567890ZZ".

:function a samm:Property;
samm:preferredName "Function"@en;
samm:description "The function of the site in relation to the part (i.e. the activity within the value chain of the part that is performed at the site)."@en;
samm:characteristic :FunctionCharacteristic;
samm:exampleValue "production".

:functionValidFrom a samm:Property;
samm:preferredName "Function valid from"@en;
samm:description "Timestamp, from when the site has the specified function for the given part."@en;
samm:characteristic :DateTrait;
samm:exampleValue "2024-01-29T12:00:00.123+02:00".

:functionValidUntil a samm:Property;
samm:preferredName "Function valid until"@en;
samm:description "Timestamp, until when the site has the specified function for the given part."@en;
samm:characteristic :DateTrait;
samm:exampleValue "2024-01-29T12:00:00.123+02:00".

:PartIdCharacteristic a samm:Characteristic;
samm:preferredName "Part ID characteristic"@en;
samm:description "The part ID is a multi-character string, usually assigned by an ERP system."@en;
samm:dataType xsd:string.

:PartNameCharacteristic a samm:Characteristic;
samm:preferredName "Part Name characteristic"@en;
samm:description "Part name in string format from the respective system in the value chain."@en;
samm:dataType xsd:string.

:FunctionCharacteristic a samm-c:Enumeration;
samm:preferredName "Function characteristic"@en;
samm:description "Describes the characteristics of the function for a site related to the respective part."@en;
samm:dataType xsd:string;
samm-c:values("production" "warehouse" "spare part warehouse").

:DateTrait a samm-c:Trait;
samm:preferredName "Date Trait"@en;
samm:description "Trait to ensure regular expressions with different date 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 "^(?:[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?Z|[0-9]{4}-[0-9]{2}-[0-9]{2}(?:T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:[.][0-9]+)?(?:Z|[+-][0-9]{2}:[0-9]{2}))?)$".
1 change: 1 addition & 0 deletions io.catenax.part_type_information/1.0.0/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "status" : "release"}
7 changes: 7 additions & 0 deletions io.catenax.part_type_information/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to this model will be documented in this file.

## [1.0.0] 2024-02-12

- Initial version of the aspect model PartTypeInformation (formerly PartAsPlanned)
Loading