Skip to main content
Release: CX-Io

CX-0121 Planned Production Output Exchange 1.0.0

ABSTRACT

The supplierSupplier In the context of OSim, the producer of goods.'s Planned Production Output is one of the key determinants for avoiding a shortage at the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.'s site. With information about the supplierSupplier In the context of OSim, the producer of goods.'s Planned Production Output quantities allocated to a specific customerCustomer In the context of OSim, the receiver of produced goods from a supplier., it can be monitored and predicted whether the customerCustomer In the context of OSim, the receiver of produced goods from a supplier. demands can be fully supplied. If this is not the case, the information can be used by the customerCustomer In the context of OSim, the receiver of produced goods from a supplier. to derive adequate countermeasures to keep the impact as low as possible. These measures can range, for example, from creating an adapted production plan with the supplierSupplier In the context of OSim, the producer of goods., rescheduling or reducing the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.'s demand and production to, e.g. organizing an express delivery from an alternative supplierSupplier In the context of OSim, the producer of goods..

However, collecting the Planned Production Output information manually e.g. by phone or e-mail is error prone and slow. As a result, unmet demands often remain unnoticed for too long and unnecessarily restrict the scope for countermeasures. This often leads to shortages, costly fire-fighting measures in the supply chain, production interruptions and ultimately to customerCustomer In the context of OSim, the receiver of produced goods from a supplier. dissatisfaction.

The standardization of the supplierSupplier In the context of OSim, the producer of goods.'s Planned Production Output semantics and exchange APIAPI An API is a way for two or more computer programs to communicate with each other. enables participants in the supply chain to share information about time-bound Planned Production Output quantities at a supplierSupplier In the context of OSim, the producer of goods.'s site in an interoperable manner.

FOR WHOM IS THE STANDARD DESIGNED

COMPARISON WITH THE PREVIOUS VERSION OF THE STANDARD

Changes:

  • integration and usage of digital twins as defined in [CX-0002] Digital Twins in Catena-X
  • harmonization of aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). in accordance with [CX-0126] Industry Core: Part Type
  • discontinuation of the proprietary APIAPI An API is a way for two or more computer programs to communicate with each other. used in v1.0.0 of this standard
  • grammatical, spelling and semantic improvements

New Content:

  • added a note on the obligation of standard implementers to make aware that sensitive data is being handled, see [Chapter 2.1.3]

1 INTRODUCTION

In recent years global supply chains have been significantly affected by global crises. This is compounded by ever-increasing complexity and interdependencies. As a result small and medium-sized enterprises as well as large enterprises are exposed to an increased risk of disruptions in their supply chains. To adapt to short-term fluctuations and develop the right countermeasures, it is essential to have sound information about the Planned Production Output of their suppliersSupplier In the context of OSim, the producer of goods..

This document describes and standardizes the semantic aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). for the Planned Production Output as well as the associated APIAPI An API is a way for two or more computer programs to communicate with each other. to exchange Planned Production Output information between supply chain partners. The supplierSupplier In the context of OSim, the producer of goods.'s Planned Production Output is the planned quantity of a material allocated to a specific customerCustomer In the context of OSim, the receiver of produced goods from a supplier. in a time horizon of up to four weeks, that has not yet been produced. It has not yet been produced and is allocated to a specific partner. The scope of application is limited to existing business relationships and build-to-order (BTO) scenarios. Build-to-stock (BTS) use cases with no existing business relationships are explicitly not covered. In contrast to the strategic Demand and Capacity Management standard (DCM) [CX-0128], the Planned Production Output refers to short-term production planning, i.e. the actual utilization of existing and available capacity that resulted from capacity planning. It shows the latest production schedule-related information for a period of up to four weeks.

1.1 AUDIENCE & SCOPE

This section is non-normative

This standard is relevant for the following roles defined in [CX-OMW]:

  • Data Providers willing to provide Planned Production Output data
  • Data Consumers interested in requesting and receiving Planned Production Output data
  • Business Application Providers interested in providing solutions implementing this standard
  • Consulting Services Providers interested in supporting companies fulfilling the standard

The scope of this standard is only the Planned Production Output aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). and APIAPI An API is a way for two or more computer programs to communicate with each other.. It describes the exchange of Planned Production Output data through a connector in accordance to [CX-0018].

1.2 CONTEXT AND ARCHITECTURE FIT

This section is non-normative

A typical order-based procurement process includes a customerCustomer In the context of OSim, the receiver of produced goods from a supplier. who places an order and a supplierSupplier In the context of OSim, the producer of goods. fulfilling it. If the ordered material is not on stock in a sufficient quantity at a supplierSupplier In the context of OSim, the producer of goods.'s facility (see [CX-0122] Item Stock Exchange) it needs to be scheduled for production. These quantities of scheduled production are the subject of this standard and are referred to as the Planned Production Output. To ensure that the Planned Production Output information will be interpreted, handled and exchanged in an interoperable manner between partners participating in Catena-X, this standard document defines the PlannedProductionOutput aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). and the APIAPI An API is a way for two or more computer programs to communicate with each other. to be used in the Catena-X network.

Figure 1 shows the high-level architecture of the "Planned Production Output Exchange" in the Catena-X dataspace and the services that are involved. Both the data consumer and the data provider must be members of the Catena-X network in order to communicate with each other. With the help of the Credential Service and the Identity Access Management (IAM) each participant can authenticate itself, verify the identity of the requesting party and decide whether to authorize the request. The Planned Production Output data is provisioned in accordance with [CX-0002].

Figure 1: high-level architecture of the Planned Production Output Exchange in Catena-X Figure 1: high-level architecture of the Planned Production Output Exchange in Catena-X

1.3 CONFORMANCE AND PROOF OF CONFORMITY

This section is non-normative

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 keywords MAY , MUST , MUST NOT , OPTIONAL , RECOMMENDED , REQUIRED , SHOULD and SHOULD NOT in this document are to be interpreted as described in [BCP 14] [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

All participants and their solutions will need to prove, that they are conform with the Catena-X standards. To validate that the standards are applied correctly, Catena-X employs Conformity Assessment Bodies (CABs). The proof of conformity for a single semantic model is done according to the general rules for proving the conformity of data provided to a semantic model or the ability to consume the corresponding data. Furthermore, participants agree to follow the normative language of this standardization document and to implement the required APIAPI An API is a way for two or more computer programs to communicate with each other.-Endpoints described in Chapter 4.

1.4 EXAMPLES

The following JSON provides an example of the value-only serialization of the "PlannedProductionOutput" aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing).. It contains the Planned Production Output quantities for three consecutive days in two different sites (BPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory).).

{
"materialGlobalAssetId":"urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df",
"positions":[
{
"lastUpdatedOnDateTime":"2023-04-01T14:23:00+01:00",
"orderPositionReference": {
"supplierOrderId":"M-Nbr-4711",
"customerOrderId":"C-Nbr-4711",
"customerOrderPositionId":"PositionId-01"
},
"allocatedPlannedProductionOutputs":[
{
"plannedProductionQuantity":{
"value": 10,
"unit":"unit:piece"
},
"productionSiteBpns":"BPNS0123456789ZZ",
"estimatedTimeOfCompletion":"2023-04-01T14:23:00+01:00"
},

{
"plannedProductionQuantity":{
"value":20,
"unit":"unit:piece"
},
"productionSiteBpns":"BPNS0123456789YZ",
"estimatedTimeOfCompletion":"2023-04-02T14:23:00+01:00"
},

{
"plannedProductionQuantity":{
"value": 10,
"unit":"unit:piece"
},
"productionSiteBpns":"BPNS0123456789ZZ",
"estimatedTimeOfCompletion":"2023-04-03T14:23:00+01:00"
}
]
}
]
}

1.5 TERMINOLOGY

This section is non-normative

NameAbrv.Description
Business Partner NumberBPNBPN A BPN is the unique identifier of a partner within Catena-X.A BPNBPN A BPN is the unique identifier of a partner within Catena-X. is the unique identifier of a partner within Catena-X as defined in [CX-0010].
Business Partner Number Legal EntityBPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company).A BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company). is the unique identifier of a partner legal entity within Catena-X as defined in [CX-0010].
Business Partner Number SiteBPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory).A BPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory). is the unique identifier of a partner site within Catena-X as defined in [CX-0010].
Business Partner Number AddressBPNAA BPNA is the unique identifier of a partner address within Catena-X as defined in [CX-0010].
PositionA position within an order defines the product and the quantity the supplierSupplier In the context of OSim, the producer of goods. has to manufacture / supply for a customerCustomer In the context of OSim, the receiver of produced goods from a supplier.. A single order may contain multiple positions for different products.
OrderRequest from a customerCustomer In the context of OSim, the receiver of produced goods from a supplier. towards a supplierSupplier In the context of OSim, the producer of goods. to manufacture / supply a given quantity of a specific product in a predefined time frame.
Allocated StockThe already manufactured and not yet been used products, components or material. They are allocated to a specific customerCustomer In the context of OSim, the receiver of produced goods from a supplier. based on the orders made by the latter and are either still in the supplierSupplier In the context of OSim, the producer of goods.'s warehouse or already in the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.'s warehouse.
ProviderThe party providing the Planned Production Output data. In the context of the Planned Production Output exchange APIAPI An API is a way for two or more computer programs to communicate with each other. this is the supplierSupplier In the context of OSim, the producer of goods..
ConsumerThe party requesting and consuming the Planned Production Output data provided by the provider. In the context of the Planned Production Output exchange APIAPI An API is a way for two or more computer programs to communicate with each other. this is the customerCustomer In the context of OSim, the receiver of produced goods from a supplier..
Stock LocationThe physical location of a stock specified by its corresponding BPNSBPNS The unique identifier of a partner site within Catena-X (e.g., a specific factory). and BPNA. More information on BPNBPN A BPN is the unique identifier of a partner within Catena-X./S/A is provided in [CX-0010].
CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier.The recipient of products ordered from / manufactured by a supplierSupplier In the context of OSim, the producer of goods..
SupplierSupplier In the context of OSim, the producer of goods.The supplierSupplier In the context of OSim, the producer of goods. / manufacturer of a product.
StockTwo way direction of material on stock:
- One can have a stock of material which is ready for delivery to customersCustomer In the context of OSim, the receiver of produced goods from a supplier..
- One can have a stock of material which can be used for the own production.
MaterialThe term material is used as a catalogue item in the meaning of the Industry Core Part Type ([CX-0126]). Whenever referring to material also products, components or items are considered. Semi-finished goods are not intended to be covered.
Production OutputThe output quantity in a defined period of time for a component or material.
Digital TwinDTDigital representation of an assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. that provides data on aspects of the represented data following [CX-0002].
decentralized Digital Twin RegistrydDTRComponent providing registration and discovery APIAPI An API is a way for two or more computer programs to communicate with each other. implementations following [CX-0002]. Sometimes referred to without the "decentralized" BUT in Catena-X those are always decentralized.
Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin.AASTechnical concept for Digital Twins consisting of different standards. Application in Catena-X is described in Digital Twins in Catena-X standard ([CX-0002])
Shell DescriptorTechnical concept of the AAS APIAPI An API is a way for two or more computer programs to communicate with each other. describing metadata of an Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. representing a Digital Twin. It holds identification information and metadata about which submodels are available and where to get the data from (see [CX-0002], [IDTA-01002-3-0]). There may exist multiple Shell Descriptor for the same represented AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. (see [CX-0126]).
Submodel DescriptorTechnical concept of the AAS APIAPI An API is a way for two or more computer programs to communicate with each other. describing metadata of Submodels within a Shell Descriptor (Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin.) (see [CX-0002], [IDTA-01002-3-0]).
Specific AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IdsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use.Identifiers of the Shell Descriptor (Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin.) that refer to common identification data for an assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer./material at hand e.g., manufacturer part Id. Common specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. idsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. used for identification are described in Industry Core Part Type Standard (see [CX-0126]).
Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. IdentifierAAS IDAlso referred to as Shell Descriptor Id, is the technical identifier of the Shell Descriptor.
Global AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IdAlso referred to as Catena-X Id, is the Catena-X identifier for assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. represented by Digital Twins (see [CX-0126]).
AspectA domain-specific view on information and functionality associated with a specific Digital Twin with a reference to a concrete Aspect ModelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). (see [CX-0002]). Within Catena-X, an aspect is formally described using the Semantic Aspect Meta Model (see [CX-0003]).
Semantic IdIdentifier including namespace to specify the semantic description of submodels using the Semantic Aspect Meta Model (SAMM). It allows partners to know the exact data format and semantics when e.g., browsing catalogs (see [CX-0003]).
Data Space ProtocolDSPA set of specifications designed to facilitate interoperable data sharing between entities governed by usage control and based on Web technologies. These specifications define the schemas and protocols required for entities to publish data, negotiate Agreements, and access data as part of a Dataspace. It is governed by the International Data Spaces Association. Connectors compliant to [CX-0018] support the Data Space Protocol.

Table 1: Terminology Planned Production Output Standard

Additional terminology used in this standard can be looked up in the glossary on the association homepage.

2 RELEVANT PARTS OF THE STANDARD FOR SPECIFIC USE CASES

This section is normative

2.1 Planned Production Output Exchange

2.1.1 LIST OF STANDALONE STANDARDS

The following Catena-X standards are prerequisites for the implementation of this standard and therefore MUST be considered / implemented by the relevant parties specified in each of them.

NumberStandardVersion
[CX-0001]EDC Discovery APIAPI An API is a way for two or more computer programs to communicate with each other.1.0.2
[CX-0002]Digital Twins in Catena-X2.2.0
[CX-0003]SAMM Aspect Meta Model1.1.0
[CX-0006]Registration and initial onboarding2.0.0
[CX-0010]Business Partner Number (BPNBPN A BPN is the unique identifier of a partner within Catena-X.)2.0.0
[CX-0018]Dataspace Connectivity3.0.0
[CX-0126]Industry Core Part Type2.0.0

Table 2: List of mandatory standards

The usage of this standard may be complemented with the following Catena-X standards to further extend the range of shortage prevention possibilities:

NumberStandardVersion
[CX-0118]Delivery Information Exchange2.0.0
[CX-0120]Short-term Material Demand Exchange2.0.0
[CX-0122]Item Stock Exchange2.0.0
[CX-0145]Days of Supply Exchange1.0.0
[CX-0146]Supply Chain Disruption Notifications1.0.0

Table 3: List of non-mandatory complementary standards

2.1.2 DATA REQUIRED

No additional data requirements

2.1.3 ADDITIONAL REQUIREMENTS

CONVENTIONS FOR USE CASE POLICY IN CONTEXT DATA EXCHANGE

In alignment with our commitment to data sovereignty, a specific framework governing the utilization of data within the Catena-X use cases has been outlined. A set of specific policies on data offering and data usage level detail the conditions under which data may be accessed, shared, and used, ensuring compliance with legal standards.

For a comprehensive understanding of the rights, restrictions, and obligations associated with data usage in the Catena-X ecosystem, we refer users to

  • the detailed ODRL policy repository [CX-ODRL]. This document provides in-depth explanations of the terms and conditions applied to data access and utilization, ensuring that all engagement with our data is conducted responsibly and in accordance with established guidelines.
  • the ODRL schema template. This defines how policies used for data sharing/usage should get defined. Those schemas MUST be followed when providing services or apps for data sharing/consuming.
ADDITIONAL DETAILS REGARDING ACCESS POLICIES

A Data Provider may tie certain access authorizations ("Access Policies") to its data offers for members of Catena-X and one or several Data Consumers. By limiting access to certain Participants, Data Provider maintains control over its anti-trust obligations when sharing certain data. In particular, Data Provider may apply Access Policies to restrict access to a particular data offer for only one Participant identified by a specific business partner number.

  • Membership
  • BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company).
ADDITIONAL DETAILS REGARDING USAGE POLICIES

In the context of data usage policies (“Usage Policies”), Participants and related services MUST use the following policy rules:

  • Use Case Framework (“FrameworkAgreement”)
  • at least one use case purpose (“UsagePurpose”) from the above mentioned ODRL policy repository.

Additionally, respective usage policies MAY include the following policy rule:

  • Reference Contract (“ContractReference”).

Details on namespaces and ODRL policy rule values to be used for the above-mentioned types are provided via the ODRL policy repository [CX-ODRL].

REMINDER OF ANTITRUST

Notice and/or acknowledgement concepts to raise awareness of antitrust issues during use of this standard are RECOMMENDED, for example through the implementation of a help desk or pop-up info.

2.1.4 DIGITAL TWINS AND SPECIFIC ASSETAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use.

This standard builds upon the Industry Core Part Type [CX-0126] and the Digital Twins in Catena-X [CX-0002] standards. It follows the following design patterns:

  • Usage of the specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. and further identification data for the Digital Twin for the Part Type (see [CX-0126]).
  • Provisioning of the PartTypeInformation on supplierSupplier In the context of OSim, the producer of goods. side (see [CX-0126]).

Because only the supplierSupplier In the context of OSim, the producer of goods. provides planned production output data for the Part Type Twin, the supplierSupplier In the context of OSim, the producer of goods. is in charge of creating a twin that is identifiable for the customerCustomer In the context of OSim, the receiver of produced goods from a supplier..

  • The supplierSupplier In the context of OSim, the producer of goods. of the part has a Digital Twin representation and is then able to offer Planned Production Output data to customersCustomer In the context of OSim, the receiver of produced goods from a supplier..
  • The customerCustomer In the context of OSim, the receiver of produced goods from a supplier., who orders or uses the part, has a Digital Twin representation to offer Planned Production Output data to a supplierSupplier In the context of OSim, the producer of goods..
  • To make the Part Type Twin identifiable for the customersCustomer In the context of OSim, the receiver of produced goods from a supplier., the supplierSupplier In the context of OSim, the producer of goods.
    • MUST create the Digital Twin first.
    • MUST generate the Catena-X ID and ensure that the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.-specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. and submodel descriptors are only accessible by the specific customerCustomer In the context of OSim, the receiver of produced goods from a supplier..
    • MAY use the Digital Twin for multiple customersCustomer In the context of OSim, the receiver of produced goods from a supplier..

The definition of identification data (Catena-X ID, Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. ID, specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. ID) MUST follow the Industry Core Part Type [CX-0126]. Refer to Chapter 4.1.2 for further details.

Note: The Part Type Twin's data is considered sensitive. Data providers MUST implement appropriate measures ensuring that competitors-specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. and/or information about submodels is accessible only to the data consumers it concerns, but not to their competitors.

Figure 2 shows how the shared assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. approach is realized. The orange lines show which submodels belong to the respective AAS. All Planned Production Output-specific submodels are bound to the specific Part Type's context e.g., meaning that the Planned Production Output aspect is described for the specific catalog item on supplierSupplier In the context of OSim, the producer of goods. and customerCustomer In the context of OSim, the receiver of produced goods from a supplier. side represented by the AASs. The orange submodels are the submodels used within this standard's context. The grey submodels are used within the Industry Core [CX-0126](PartTypeInformation, SingleLevelBomAsPlanned, SingleLevelUsageAsPlanned). The blue dashed lines show the references between DTs based on Catena-X UUIDs and BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company). information that may be resolved by the Item Relationship Service (see [CX-0126]).

Figure 2: Conceptual levels of provisioning digital twins Figure 2: Conceptual levels of provisioning digital twins

Figure 2 details two conceptual levels:

  • The AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. level contains the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. (Industry Core Part Type) represented by a Digital Twin. The latter is provisioned as an Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. (AAS) within the decentralized Digital Twin Registry (dDTR) of the data provider (supplierSupplier In the context of OSim, the producer of goods. or customerCustomer In the context of OSim, the receiver of produced goods from a supplier.).
  • The Submodel level represents the actual information that are held by a Digital Twin (DT). Those submodels follow the respective definition of the in Semantic Aspect Meta Model (SAMM) format (see Chapter 3). The dDTR only holds meta-information about the Submodel (e.g. kind of submodel via semantic ID or connector endpoint information).

3 ASPECT MODELAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing).

This section is normative

3.1 "PLANNED PRODUCTION OUTPUT" ASPECT MODELAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing).

3.1.1 INTRODUCTION

The Planned Production Output defines the set of quantities of a material that will be produced for a customerCustomer In the context of OSim, the receiver of produced goods from a supplier. until a given point in time. For the complete semantics and detailed description of its properties refer to the SAMM model in Chapter 3.1.5.1.

3.1.2 SPECIFICATIONS ARTIFACTS

The modeling of the semantic model specified in this document was done in accordance to the "semantic-driven workflow" to create a submodel template specification [SMT].

This aspect modelAspect Model A formal, machine-readable semantic description (expressed with RDF/Turtle) of data accessible from an aspect. Note 1: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM) and be compliant with its validity rules. Note 2: Aspect Models are logical data models that can be used to detail a conceptual model to describe the semantics of runtime data related to a concept; elements of an Aspect Model can/should refer to terms of a standardized Business Glossary (if existing). is written in SAMM 2.1.0 as a modeling language conformant to [CX-0003] as input for the semantic-driven workflow.

Like all Catena-X data models, this model is available in a machine-readable format on GitHub conformant to [CX-0003].

3.1.3 LICENSE

This Catena-X data model is made available under the terms of the Creative Commons Attribution 4.0 International (CC-BY-4.0) license, which is available at Creative Commons.

3.1.4 IDENTIFIER OF SEMANTIC MODEL

The semantic model has the unique identifier

urn:samm:io.catenax.planned_production_output:2.0.0

This identifier MUST be used by the data provider to define the semantics of the data being transferred.

3.1.5 FORMATS OF SEMANTIC MODEL

3.1.5.1 RDF TURTLE

The RDF turtle file, an instance of the Semantic Aspect Meta Model, is the master for generating additional file formats and serializations. It can be found under the following link:

https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.planned_production_output/2.0.0/PlannedProductionOutput.ttl

The open source command line tool of the Eclipse Semantic Modeling Framework is used for generation of other file formats like for example a JSON Schema, aasx for Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. Submodel Template or a HTML documentation.

3.1.5.2 JSON SCHEMA

A JSON Schema can be generated from the RDF Turtle file. The JSON Schema defines the Value-Only payload of the Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. for the APIAPI An API is a way for two or more computer programs to communicate with each other. operation "GetSubmodel".

3.1.5.3 AASX

An AASX file can be generated from the RDF Turtle file. The AASX file defines one of the requested artifacts for a Submodel Template Specification conformant to [SMT].

4 APPLICATION PROGRAMMING INTERFACE

This section is normative

4.1 APIAPI An API is a way for two or more computer programs to communicate with each other. USED TO EXCHANGE "PLANNED PRODUCTION OUTPUT" INFORMATION

As described in Chapter 2.1.4 this standard builds upon the [CX-0002] Digital Twins in Catena-X and [CX-0126] Industry Core Part Type standards. Therefore, the APIsAPI An API is a way for two or more computer programs to communicate with each other. provided by the Digital Twin standard are combined with the part identification defined in the Industry Core standard. This chapter defines how the aforementioned standards and the [CX-0018] standard MUST be used to facilitate the provisioning of Planned Production Output data. The usage of the Discovery Services defined in [CX-0001], [CX-0053] is not mandatory, because this standard assumes an already existing business relationship between the involved parties.

The sequence diagram in Figure 3 provides an overview of the interactions required to register the Part Type Twin.

  • Steps 1 & 2: Register the dDTR access for the partner at the connector
  • Steps 3 & 4: When using the repository pattern, create the submodel (and twin)
  • Steps 5 & 6: Register the submodel endpoint for the partner at the connector
  • Steps 7 & 8: Register or update the twin Shell Descriptor relying on the registered Connector assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. for the submodel endpoint and the identification data of the partners

Figure 3: Flow to create and register a digital twin Figure 3: Flow to create and register a digital twin

The sequence diagram in Figure 4 provides an overview of the interactions required when a supplierSupplier In the context of OSim, the producer of goods. (acting as data provider) provisions Planned Production Output data to a customerCustomer In the context of OSim, the receiver of produced goods from a supplier. (acting as data consumer).

The flow "CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier. reads (updated) Submodel from SupplierSupplier In the context of OSim, the producer of goods." visualizes the sequence of calls when consuming data:

  • Steps 3 - 8: Contract dDTR usage in the connector.
  • Steps 9 - 12: Lookup the Industry Core Part Type Twin for a Part Type based on the common identification data.
  • Steps 13 - 18: Read the Shell Descriptor of the Industry Core Part Type Twin to extract the Planned Production Output submodel endpoint (registered at the connector).
  • Steps 19 - 24: Contract the Planned Production Output data usage in the connector.
  • Steps 25 - 29: Consume and use the Planned Production Output data.

Figure 4: Flow to lookup a digital twin and get a submodel. Figure 4: Flow to lookup a digital twin and get a submodel.

Note: Depending on the use of repository patterns and the design of the Digital Twins, the data may be updated manually in the Submodel endpoint.

4.1.1 CONNECTOR DATA ASSETAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. STRUCTURE

The endpoints for the dDTR and the Submodel Endpoint MUST be made available BUT they MUST NOT be directly called data consumer. Rather, for access to dDTRs and Submodels, there MUST be contracts negotiated in accordance with the DSP. Therefore, the endpoints MUST be offered as connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.. To make these assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. easily identifiable in the connector's catalog, each assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. MUST be configured with a set of properties as described in the corresponding sections below.

The following table provides an overview of the connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. that the parties MUST offer to be able to provision and/or consume Planned Production Output data.

PartyREQUIREDAssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.Purpose
SupplierSupplier In the context of OSim, the producer of goods.Yes"Digital Twin Registry"Allows a consumer to query for Part Type Twins and their Planned Production Output submodels.
SupplierSupplier In the context of OSim, the producer of goods.Yes"Submodel Planned Production Output"Allows a consumer to read actual Planned Production Output data related to a Part Type Twin.

Table 4: Connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.

In the section below the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. definitions of two different kinds of assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. are defined.

Connector Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. Structure for "Digital Twin Registry"

To allow partners to find the "Planned Production Output" data for a specific Industry Core Part Type Twin, the provider MUST register a connector data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. (see details in [CX-0018]) specifying the address of the Digital Twin Registry of the provider (see [CX-0002]).

The data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. MUST be configured with the set of properties as defined in the table below.

ObjectPropertyPurposeUsage & Constraints
@idIdentifier of the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.The assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. ID MUST be unique and therefore MUST NOT be reused elsewhere.
propertieshttpHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.://purl.org/dc/terms/typeDefines the "Digital Twin Registry" according to the Catena-X taxonomy.MUST be set to {"@id": "https://w3id.org/catenax/taxonomy#DigitalTwinRegistry"} to allow filtering the data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. catalog for the respective "Digital Twin Registry".
propertieshttpsHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.://w3id.org/catenax/ontology/common#versionThe version of the standard defining the implemented APIAPI An API is a way for two or more computer programs to communicate with each other. of the "Digital Twin Registry"MUST correspond to the version of the standard defining the Interfaces of the "Digital Twin Registry". The value MUST be set to "3.0" for "Digital Twin Registries" used by this standard.
dataAddress@typeType of the DataAddress node.MUST be set to "DataAddress".
dataAddressbaseUrlDefines the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. endpoint of the corresponding "Digital Twin Registry Endpoint".The {{ DIGITAL_TWIN_REGISTRY_ENDPOINT }} refers to an URL under which the APIAPI An API is a way for two or more computer programs to communicate with each other. of the "Digital Twin Registry" endpoint is available. HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. transport protocol MUST be used.
dataAddressproxyBodyDefines whether the endpoint allows to proxy the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. bodySHOULD be set to "false" to not allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive a HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. body via the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request.
dataAddressproxyMethodDefines whether the endpoint allows to proxy the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. methodSHOULD be set to "false" to only allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive GET requests.
dataAddressproxyPathDefines whether the endpoint allows to proxy paths for the URLMUST be set to "true" to allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive appended paths of the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request.
dataAddresstypeDefines the type of data plane extension handling the data exchangeMUST be set to "HttpData" to provide an APIAPI An API is a way for two or more computer programs to communicate with each other. via an HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. proxy endpoint.

Table 5: Connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. request properties

Additionally security identification information MAY be added to secure the "Decentralized Digital Twin Registry".

When searching the Catalog of a provider, a consumer SHOULD use the following properties AND their values to identify the Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. specifying "Digital Twin Registry". In the connector Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. descriptions the APIAPI An API is a way for two or more computer programs to communicate with each other. version valid for this standard is mentioned for the property https://w3id.org/catenax/ontology/common#version. The requester of a Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. MUST be able to handle multiple Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. for this endpoint, being differentiated only by the version. The requester SHOULD choose the Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. set with the highest compatible version number implemented by themselves. If the requester cannot find a compatible version with their own, the requester MUST terminate the data transfer.

PropertyValue
http://purl.org/dc/terms/type{"@id": "https://w3id.org/catenax/taxonomy#DigitalTwinRegistry"}

Table 6: Connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. request properties values.

An example connector data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. definition is given below.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

{
"@context": {
"@vocab": "https://w3id.org/edc/v0.0.1/ns/",
"cx-common": "https://w3id.org/catenax/ontology/common#",
"cx-taxo": "https://w3id.org/catenax/taxonomy#",
"dct": "http://purl.org/dc/terms/"
},
"@id": "{{CONNECTOR_ASSET_ID}}",
"properties": {
"dct:type": {"@id": "cx-taxo:DigitalTwinRegistry"},
"cx-common:version": "3.0"
},
"privateProperties": {
},
"dataAddress": {
"@type": "DataAddress",
"type": "HttpData",
"baseUrl": "{{ DIGITAL_TWIN_REGISTRY_ENDPOINT }}",
"proxyQueryParams": "true",
"proxyBody": "false",
"proxyPath": "true",
"proxyMethod": "false",
}
}
Connector Data AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. Structure for "Submodel"

To allow partners to receive the "Planned Production Output" data as defined in Chapter 3, the provider MUST register a connector data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. (see details in[ CX-0018]) specifying the address of the submodel endpoint (see [CX-0002]) providing the actual data.

The data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. MUST be configured with the set of properties as defined in the table below.

ObjectPropertyPurposeUsage & Constraints
@idIdentifier of the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer.The assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. ID MUST be unique and therefore MUST NOT be reused elsewhere.
propertieshttpHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.://purl.org/dc/terms/typeDefines the "Submodel APIAPI An API is a way for two or more computer programs to communicate with each other." according to the Catena-X taxonomy.MUST be set to {"@id": "https://w3id.org/catenax/taxonomy#Submodel"} to allow filtering the data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. catalog for the respective "Submodel APIAPI An API is a way for two or more computer programs to communicate with each other.".
propertieshttpsHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.://admin-shell.io/aas/3/0/HasSemantics/semanticIdThe semantic identifier of the "Planned Production Output" SAMM.MUST be set to {"@id": "urn:samm:io.catenax.planned_production_output:2.0.0#PlannedProductionOutput"} to externally define how the Submodel must be interpreted. MUST NOT be set, if different submodels may be returned by this APIAPI An API is a way for two or more computer programs to communicate with each other..
propertieshttpsHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes.://w3id.org/catenax/ontology/common#versionVersion of the Submodel Interface SpecificationMUST be set to "3.0" in accordance to [CX-0002].
dataAddress@typeType of the DataAddress node.MUST be set to "DataAddress".
dataAddressbaseUrlDefines the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. Submodel endpoint provisioning the Planned Production Output dataThe {{ SUBMODEL_ENDPOINT }} refers to an URL under which the Submodel APIAPI An API is a way for two or more computer programs to communicate with each other. Endpoint ([CX-0002]) is available to provide the "Planned Production Output" . HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. transport protocol MUST be used.
dataAddressproxyBodyDefines whether the endpoint allows to proxy the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. bodySHOULD be set to "false" to not allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive a HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. body via the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request.
dataAddressproxyMethodDefines whether the endpoint allows to proxy the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. methodSHOULD be set to "false" to only allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive GET requests.
dataAddressproxyPathDefines whether the endpoint allows to proxy paths for the URLMUST be set to "true" to allow the APIAPI An API is a way for two or more computer programs to communicate with each other. endpoint to receive appended paths of the HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. request. Setting this parameter depends on the implementation of the submodel lookup.
dataAddresstypeDefines the type of data plane extension handling the data exchangeMUST be set to "HttpData" to provide an APIAPI An API is a way for two or more computer programs to communicate with each other. via an HTTPSHTTP HTTP is an application-layer protocol for transmitting hypermedia documents (such as HTML). It was designed for communication between web browsers and web servers, but can also be used for other purposes. proxy endpoint.

Table 7: Connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. request properties

Additionally security identification information MAY be added to secure the "Submodel APIAPI An API is a way for two or more computer programs to communicate with each other.".

When searching the data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. catalog of a provider, a consumer SHOULD use the assetId previously determined via subprotocolBody of the SubmodelDescriptor's endpoint definition of subprotocol type "DSP". Refer to Chapter 4.1.2 for the definition of the subprotocolBody.

PropertyValue
https://w3id.org/edc/v0.0.1/ns/id{{CONNECTOR_ASSET_ID}} specified in the DSP endpoint of the SubmodelDescriptor (see Chapter 4.1.2)

Table 8: Connector data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. request properties values

An example connector data assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. definition is given below.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

{
"@context": {
"@vocab": "https://w3id.org/edc/v0.0.1/ns/",
"cx-common": "https://w3id.org/catenax/ontology/common#",
"cx-taxo": "https://w3id.org/catenax/taxonomy#",
"dct": "http://purl.org/dc/terms/",
"aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/"
},
"@id": "{{CONNECTOR_ASSET_ID}}",
"properties": {
"dct:type": {"@id": "cx-taxo:Submodel"},
"cx-common:version": "3.0",
"aas-semantics:semanticId": {"@id": "urn:samm:io.catenax.planned_production_output:2.0.0#PlannedProductionOutput"} },
"privateProperties": {
},
"dataAddress": {
"@type": "DataAddress",
"type": "HttpData",
"baseUrl": "{{ SUBMODEL_ENDPOINT }}",
"proxyQueryParams": "false",
"proxyBody": "false",
"proxyPath": "true",
"proxyMethod": "false",
}
}

4.1.2 INDUSTRY CORE PART TYPE TWIN REGISTRATION AND DEFINITION

4.1.2.1 SHELL DESCRIPTOR REGISTRATION

To allow partners to receive the actual "Planned Production Output" data as defined in Chapter 3, the provider MUST register a Shell Descriptor in the dDTR (see [CX-0002]) so that a partner:

  • May lookup the Industry Core Part Type Twin based on known identification data.
  • May identify the connector endpoint providing access to the Planned Production Output submodel data.

The Shell Descriptors represent each an Industry Core Part Type Twin and MUST follow the rules as defined in Chapter 2.1.4.

The Shell Descriptor MUST be configured with the set of properties as defined in the table below.

Object in ShellDescriptorPropertyPurposeUsage & Constraints
idDefines the technical ID of the Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. representing a partner's twin.MUST be unique following Industry Core Part Type standard ([CX-0126]) and is a technical Id randomly assigned as multiple Part Type Twins may be created for one Part Type. E.g. this number differs for the twins created at supplierSupplier In the context of OSim, the producer of goods. and customerCustomer In the context of OSim, the receiver of produced goods from a supplier. side.
globalAssetIdDefines the Catena-X ID of the twin.MUST be aligned with the partner's material. When referring to the same Part Type Twin, the same number MUST be used (see [CX-0126]).
specificAssetIdsIdentifiers that may be used to lookup Part Type Twins.MUST be set to according to the Industry Core Part Type standard ([CX-0126]). See Table 10 for respective specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use.. The "customerPartId" MUST be set by CustomersCustomer In the context of OSim, the receiver of produced goods from a supplier. and SHOULD be set by SuppliersSupplier In the context of OSim, the producer of goods..
submodelDescriptoridTechnical identifier of a SubmodelDescriptor.MUST be set to a unique identifier.
submodelDescriptorsemanticIdThe semantic identifier of the "Planned Production Output" SAMM.MUST be set to { "type": "ExternalReference", "keys": [{ "type": "GlobalReference", "value": "urn:samm:io.catenax.planned_production_output:2.0.0#PlannedProductionOutput" }] } to externally define how the Submodel must be interpreted.
submodelDescriptor > endpointinterfaceDefines the Submodel Interface [CX-0002] and the version.MUST be set to "SUBMODEL-3.0" to rely on current specification.
submodelDescriptor > endpoint > protocolInformationhrefDefines the direct link to the public APIAPI An API is a way for two or more computer programs to communicate with each other. of the connector's data plane with a path that SHOULD be appended by the proxy, if needed.MUST be set to the public APIAPI An API is a way for two or more computer programs to communicate with each other. of the dataplane providing the data with the path appended to directly access the submodel.
submodelDescriptor > endpoint > protocolInformationsubprotocolDefines the usage of the connector based on DSP to access and use the submodel.MUST be set to "DSP" to define the connector endpoint of the subprotocol.
submodelDescriptor > endpoint > protocolInformationsubprotocolBodyDefines the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. id in the connector and the connector address to access and use the submodel.MUST be set to "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}" to provide the necessary information for contracting the submodel endpoint. Refer to Chapter 4.1.2 for the definition of the assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. of the subprotocolBody.

Table 9: Properties relevant for the Shell Descriptor definition

When searching the submodel in the dDTR of a provider, a consumer SHOULD use the specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. as defined in [CX-0126]. Table 10 gives an overview of the specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. that the data provider added to the ShellDescriptor so that the data consumer may find the Industry Core Part Type Twin.

Specific AssetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IdValue
digitalTwinType"PartType". Set to identify twins compliant to the Industry Core Part Type (see [CX-0126]).
manufacturerIdSupplierSupplier In the context of OSim, the producer of goods. / Manufacturer partner BPNLBPNL The unique identifier of a legal entity of a partner within Catena-X (e.g., a company). (see [CX-0010])
manufacturerPartIdSupplierSupplier In the context of OSim, the producer of goods. / Manufacturer partner identification number of the part.
customerPartIdCustomerCustomer In the context of OSim, the receiver of produced goods from a supplier. partner identification number of the part.

Table 10: Specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. of Industry Core Part Type Twins proposed to be used to lookup a twin in the dDTR

The Shell Descriptor defines the metadata of the Industry Core Part Type Twin. The following example Shell Descriptor represents a supplierSupplier In the context of OSim, the producer of goods.'s Shell Descriptor of a supplierSupplier In the context of OSim, the producer of goods. who provides two customersCustomer In the context of OSim, the receiver of produced goods from a supplier. access to a "Planned Production Output" submodel. For further information on the creation of Part Type Twins, refer to Chapter 2.1.4.

Following [CX-0002], when searching the data assetsAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. catalog of a provider, a consumer SHOULD use the assetId determined via subprotocolBody of the SubmodelDescriptor's endpoint definition of subprotocol type "DSP" of the Submodel Descriptor of interest.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

{
"id": "{{TECHNICAL_TWIN_ID}}",
"globalAssetId": "{{MATERIAL_NUMBER_CX}}",
"idShort": "Semiconductor",
"specificAssetIds": [
{
"name": "digitalTwinType",
"value": "PartType",
"externalSubjectId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "{{SUPPLIER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{CUSTOMER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{OTHER_CUSTOMER_BPNL}}"
}
]
}
},
{
"name": "manufacturerPartId",
"value": "{{MATERIAL_NUMBER_SUPPLIER}}",
"externalSubjectId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "{{SUPPLIER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{CUSTOMER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{OTHER_CUSTOMER_BPNL}}"
}
]
}
},
{
"name": "manufacturerId",
"value": "{{SUPPLIER_BPNL}}",
"externalSubjectId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "{{SUPPLIER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{CUSTOMER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{OTHER_CUSTOMER_BPNL}}"
}
]
}
},
{
"name": "customerPartId",
"value": "{{MATERIAL_NUMBER_CUSTOMER}}",
"externalSubjectId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "{{SUPPLIER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{CUSTOMER_BPNL}}"
}
]
}
},
{
"name": "customerPartId",
"value": "{{MATERIAL_NUMBER_OTHER_CUSTOMER}}",
"externalSubjectId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "{{SUPPLIER_BPNL}}"
},
{
"type":"GlobalReference",
"value":"{{OTHER_CUSTOMER_BPNL}}"
}
]
}
}
],
"submodelDescriptors": [
{
"id": "e5c96ab5-896a-482c-8761-efd74777ca97",
"semanticId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "urn:samm:io.catenax.item_stock:2.0.0#PlannedProductionOutput"
}
]
},
"endpoints": [
{
"interface": "SUBMODEL-3.0",
"protocolInformation": {
"href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}",
"endpointProtocol": "HTTP",
"endpointProtocolVersion": [
"1.1"
],
"subprotocol": "DSP",
"subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}",
"subprotocolBodyEncoding": "plain",
"securityAttributes": [
{
"type": "NONE",
"key": "NONE",
"value": "NONE"
}
]
}
}
]
},
{
"id": "a6c96ab5-896a-482c-8761-efd74777ca99",
"semanticId": {
"type": "ExternalReference",
"keys": [
{
"type": "GlobalReference",
"value": "urn:samm:io.catenax.item_stock:2.0.0#PlannedProductionOutput"
}
]
},
"endpoints": [
{
"interface": "SUBMODEL-3.0",
"protocolInformation": {
"href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}",
"endpointProtocol": "HTTP",
"endpointProtocolVersion": [
"1.1"
],
"subprotocol": "DSP",
"subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}",
"subprotocolBodyEncoding": "plain",
"securityAttributes": [
{
"type": "NONE",
"key": "NONE",
"value": "NONE"
}
]
}
}
]
}
]
}
4.1.2.2 LOOKING UP A PART TYPE TWIN IN THE DDTR

To query the dDTR of a data provider, after contracting the usage via the data provider's connector (see [CX-0018]), the lookup APIAPI An API is a way for two or more computer programs to communicate with each other. (see [CX-0002]) can be used relying on the specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use. defined by the Industry Core Part Type (see [CX-0126]) that can be seen in Table 10 (table of shellDescriptorRegistration with specific assetAsset On the Data Provider side, an Asset describes the data set which will be shared or can be consumed by a Data Consumer. IDsIDS The International Data Space enables 'smart services' and business processes across companies and industries while ensuring data sovereignty and self-determined control of data use.).

An example call relying on all information is given in the code sample below.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

GET: {{PARTNER_CONNECTOR_DATA_PLANE}}/lookup/shells?assetIds={"name":"digitalTwinType", "value": "PartType"},{"name":"manufacturerPartId", "value": "{{MATERIAL_NUMBER_SUPPLIER}}"},{"name":"manufacturerId", "value": "{{SUPPLIER_BPNL}}"},{"name":"customerPartId", "value": "{{MATERIAL_NUMBER_CUSTOMER}}"}

As a result identifiers of the ShellDescriptors will be returned. With this data, a data provider can read the ShellDescriptor to extract the endpoint data of the data provider. An example is given in the code sample below.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

GET: {{PARTNER_CONNECTOR_DATA_PLANE}}/shell-descriptors/{{AAS_IDENTIFIER}}
4.1.2.3 FETCHING SUBMODEL DATA

To fetch the Planned Production Output Submodel data at the submodel endpoint of a data provider, after contracting the usage via the data provider's connector (see [CX-0018]), the submodel APIAPI An API is a way for two or more computer programs to communicate with each other. (see [CX-0002]) can be used.

An example call relying on all information is given in the code sample below.

Note: Expressions in double curly braces {{}} must be substituted with a corresponding value.

GET: {{HREF_PATH}}/$value

5 PROCESSES

This section is normative

The processes described are intended to serve as guidance and recommendation for the use of the "Planned Production Output Exchange" standard in different scenarios. In the field a combination of several scenarios is common practice. This process description does not claim to be exhaustive, but rather is intended to support the involved parties in finding beneficial and legally acceptable solutions.

5.1 ACTORS AND ROLES

The following actors and roles occur in the described processes.

ActorsRoleDescription
CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier.The customerCustomer In the context of OSim, the receiver of produced goods from a supplier. acts as the data consumer in this standard.A business partner that procures items from suppliersSupplier In the context of OSim, the producer of goods. and requests information about their planned production output.
SupplierSupplier In the context of OSim, the producer of goods.The supplierSupplier In the context of OSim, the producer of goods. acts as the data provider in this standard.A business partner that supplies items to customersCustomer In the context of OSim, the receiver of produced goods from a supplier.. As such, a supplierSupplier In the context of OSim, the producer of goods. is responsible for providing consistent and up-to-date Planned Production Output data.

Table 11: Actors and roles

5.2 PROCESS REPRESENTATIONS

5.2.1 SINGLE CUSTOMERCustomer In the context of OSim, the receiver of produced goods from a supplier. SCENARIO

The most straightforward process is described as a relationship between one supplierSupplier In the context of OSim, the producer of goods. and one customerCustomer In the context of OSim, the receiver of produced goods from a supplier. where an item is specifically planned and produced for the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.. There are no third party customersCustomer In the context of OSim, the receiver of produced goods from a supplier. that procure the same material from the supplierSupplier In the context of OSim, the producer of goods..

The production output is planned by the supplierSupplier In the context of OSim, the producer of goods. on a daily basis so that this data should be provided without further adaptions to the customerCustomer In the context of OSim, the receiver of produced goods from a supplier.. Also having multiple customersCustomer In the context of OSim, the receiver of produced goods from a supplier. may be handled as a single customerCustomer In the context of OSim, the receiver of produced goods from a supplier. scenario, if customerCustomer In the context of OSim, the receiver of produced goods from a supplier.-specific material numbers are used for the production planning in the internal systems of the supplierSupplier In the context of OSim, the producer of goods.. An example where the total Planned Production Output is allocated to a single customerCustomer In the context of OSim, the receiver of produced goods from a supplier. is shown in the table below:

Day 1Day 2Day 3Sum
Total Planned Production Output15152050
Allocated to CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier. A15152050

Table 12: Planned Production Output for a single customerCustomer In the context of OSim, the receiver of produced goods from a supplier. scenario

5.2.2 MULTIPLE CUSTOMERCustomer In the context of OSim, the receiver of produced goods from a supplier. SCENARIO

To have multiple customersCustomer In the context of OSim, the receiver of produced goods from a supplier. for a specific item as a supplierSupplier In the context of OSim, the producer of goods. is a scenario that requires a proper adjustment of the Planned Production Output data provided by the supplierSupplier In the context of OSim, the producer of goods.. The supplierSupplier In the context of OSim, the producer of goods. must not simply provide the total quantities of the Planned Production Output to both customersCustomer In the context of OSim, the receiver of produced goods from a supplier. since they are not specific. On the one hand, they are not helpful and, on the other hand, they cause a legal issue if they allow customersCustomer In the context of OSim, the receiver of produced goods from a supplier. to draw conclusions about each other. A simplified illustration of the situation where the total Planned Production Output is allocated to different customersCustomer In the context of OSim, the receiver of produced goods from a supplier. is shown in the table below:

Day 1Day 2Day 3Sum
Total Planned Production Output351585135
Allocated to CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier. A15152050
Allocated to CustomerCustomer In the context of OSim, the receiver of produced goods from a supplier. B2006585

Table 13: Planned Production Output for a multiple customerCustomer In the context of OSim, the receiver of produced goods from a supplier. scenario

Since sharing data on a horizontal level is critical from a legal perspective a supplierSupplier In the context of OSim, the producer of goods. must make sure that the data he provides to a customerCustomer In the context of OSim, the receiver of produced goods from a supplier. does not include information that allows conclusions about a competitor. This standard does not and cannot check data for being legally compliant on a semantic and technical level. Therefore, each user must make sure to comply with applicable laws when providing information. For the allocation of Planned Production Output data to a specific partner, it is recommended to evaluate the following proposals:

Derive from orders or call-offs that have been received:

  1. get orders or call-offs
  2. calculate quotations based on needed amounts per day / week
  3. apply quotation per day or production order

Derive from incoming Short-Term Material Demand [CX-0120]:

  1. request latest demand per customerCustomer In the context of OSim, the receiver of produced goods from a supplier. per site
  2. determine the needed end of production date per customerCustomer In the context of OSim, the receiver of produced goods from a supplier. and site
  3. calculate quotations based on the needed amount per day / week
  4. apply quotations per day or production order

Potential drawbacks: heavyweight computation with external involvement

Derive from scheduled deliveries [CX-0118]:

  1. get the estimated time of departure (ETD) for the scheduled deliveries per customerCustomer In the context of OSim, the receiver of produced goods from a supplier. and site
  2. calculate quotations based on needed amounts per day
  3. apply quotation per day or production order

Potential drawbacks: scheduled deliveries might be derived from produced goods (wrong circularity)

5.2.3 NON-DAILY BASED PLANNED PRODUCTION OUTPUT

One possible scenario is that production planning is not done on a daily basis. The planned production output is determined by a production order whose estimated date of completion does not necessarily match with the real completion date of the produced items. The example below shows a scenario where the complete production order of a supplierSupplier In the context of OSim, the producer of goods. equals to a total of 45 items planned to be finished on the third day. However, in reality, the production will already start on the first day and will only be finished on day three.

  • in total 45 items are planned as production output for the third day
  • the actual production starts on day one with an output of 15 items per day
  • the total planned quantity will be finished on day three
Day 1Day 2Day 3Sum
Planned Production Output004545
Actual Production Output15151545

Table 14: Non-daily-based Planned Production Output scenario

In this case, the accuracy of the planned production output data provided to the customerCustomer In the context of OSim, the receiver of produced goods from a supplier. is reduced. This loss of granularity and the weakening of the information base can be particularly disadvantageous in the event of a shortage. Hence it is recommended to plan the production output on a daily basis.

However, if this is not possible the data providing supplierSupplier In the context of OSim, the producer of goods. SHOULD consider working with partial completion confirmations for the already finished items that belong to a Planned Production Output. Confirming partially completed production orders lowers on the one hand the remaining planned production quantity and on the other hand increases the available and allocated Item Stock (see [CX-0122]).
This enables the data-consuming customerCustomer In the context of OSim, the receiver of produced goods from a supplier. to be provided with a more accurate and up-to-date representation of the still remaining Planned Production Output quantities as well as with available stock data. In any case, the supplierSupplier In the context of OSim, the producer of goods. must ensure that the information is consistent and plausible.

6 REFERENCES

6.1 NORMATIVE REFERENCES

NumberStandardVersion
[CX-0001]EDC Discovery APIAPI An API is a way for two or more computer programs to communicate with each other.1.0.2
[CX-0002]Digital Twins in Catena-X2.2.0
[CX-0003]SAMM Aspect Meta Model1.1.0
[CX-0006]Registration and initial onboarding2.0.0
[CX-0010]Business Partner Number (BPNBPN A BPN is the unique identifier of a partner within Catena-X.)2.0.0
[CX-0018]Dataspace Connectivity3.0.0
[CX-0053]Discovery Finder and BPNBPN A BPN is the unique identifier of a partner within Catena-X. Discovery Service APIsAPI An API is a way for two or more computer programs to communicate with each other.1.1.0
[CX-0118]Delivery Information Exchange2.0.0
[CX-0120]Short-term Material Demand Exchange2.0.0
[CX-0122]Item Stock Exchange2.0.0
[CX-0126]Industry Core Part Type2.0.0
[CX-0128]Demand and Capacity Management2.0.0
[CX-0145]Days of Supply Exchange1.0.0
[CX-0146]Supply Chain Disruption Notifications1.0.0

6.2 NON-NORMATIVE REFERENCES

This section is non-normative

ContextLink
[CX-OMW]Catena-X Operating Model Whitepaper. Download from: https://catena-x.net/fileadmin/_online_media_/CX_Operating_Modelv2.1_final.pdf
[CX-ODRL]Catena-X ODRL Profile repository: https://github.com/catenax-eV/cx-odrl-profile
[RFC2119]Bradner, S. Key words for use in RFCs to Indicate Requirement Levels. Available online: https://datatracker.ietf.org/doc/html/rfc2119
[RFC8174]Leiba, B. Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words. Available online: https://datatracker.ietf.org/doc/html/rfc8174
[SMT]How to create a submodel template specification. Guideline. Download from: https://industrialdigitaltwin.org/wp-content/uploads/2022/12/I40-IDTA-WS-Process-How-to-write-a-SMT-FINAL-.pdf
[IDTA-01002-3-0]Specification of the Asset Administration ShellAsset Administration Shell The AAS is a digital representation of an asset; it is a form of a digital twin. Part 2: Application Programming Interfaces. Download from: https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API.pdf

6.3 REFERENCE IMPLEMENTATIONS

This section is non-normative

Not applicable.

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