docs: Manufacturing as a Service KIT 24.05 #878

dominikoeh · 2024-05-07T06:12:40Z

Description

Manufacturing Capability API
Request for Quotation API

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
Copyright and license header are present on all affected files

@danielmiehle @maximilianong @jSchuetz88

...are Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx

danielmiehle · 2024-05-14T06:36:07Z

...s/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md

+
+Manufacturing-as-a-Service (MaaS) scenarios focus on connecting buyers having a request for specific manufacturing process steps or products to be manufactured with the appropriate manufacturing supplier, who has the corresponding capabilities and resources. This connection depends on the capabilities that are offered on the supplier side and that are required on the buyer side.
+
+The Manufacturing Capability API defines how to share the manufacturing capabilities, e.g. to onboard them to a Manufacturing Network Registry. Manufacturing Network Platforms and MaaS Manufacturer Application can use the Manufacturing Capability API to onboard their manufacturing capabilities in the Manufacturing Network Registry (see figure).


Who operates the services such as Manufacturing Network Registry or the Marketplace? Are these services part of a MaaS business app?

The services can either be operated by the company that develops and offers a MaaS application, or be connected by other operators (e.g. Smart Factory Web from Fraunhofer IOSB).

danielmiehle · 2024-05-14T06:36:59Z

...s/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md

+
+The Manufacturing Capability API defines how to share the manufacturing capabilities, e.g. to onboard them to a Manufacturing Network Registry. Manufacturing Network Platforms and MaaS Manufacturer Application can use the Manufacturing Capability API to onboard their manufacturing capabilities in the Manufacturing Network Registry (see figure).
+
+The Request for Quotation API defines detailed requirements, deadlines and evaluation criteria for obtaining quotations from potential manufacturers for specific products or services. The necessary capabilities can be derived from the defined RfQ, which can subsequently be used in the MaaS Manufacturer Application for feasibility analyses or calculations (see figure).


Do you also describe how the APIs work with the EDC? Should we also include the EDC in your RefArc?

We do not want to specify this, as otherwise we would always have to update the KIT in future when a new EDC version is released. We have therefore made the note "As illustrated in the deployment view, the software components of this whitebox will usually be hosted and owned by different companies. Thus, each communication between the components on this whitebox level is protected by Eclipse Dataspace Connectors (EDCs). Moreover, EDC and asset discovery are applied as described by the Digital Twin KIT."

danielmiehle · 2024-05-14T06:59:48Z

...are Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx

@@ -0,0 +1,25 @@
+---
+id: manufacturing-capability-aspect-model


General reminder: Did you check if you need legal attributions for your pictures (esp. for the pictures with the Siemens logo)?
https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-07

I will check this with the Siemens colleagues and provide feedback as soon as possible.

@danielmiehle i checked with my colleagues and the pictures are all unrestricted.

HFocken

Thank you for the great addition! I finally feel like I really understand MaaS. One overarching comment - from an outside reader perspective, the adoption and architecture page read quite similar and I'm a bit confused, which one is the one to go to as an interested reader that is looking for a starting point - maybe you could provide a bit of guidance to readers at the beginning of each page.

HFocken · 2024-05-23T10:30:53Z

.../kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md

+
+The following diagram covers the general business process addressed in the CDME.
+
+![Figure - Business process considered for CDME. Out of scope steps have not been elaborated and are therefore not covered by the technical architecture. (Schoeppenthau et al. 2023).](resources/image-2023-11-2_13-54-35.png)


It might just be me but this image and others fail to render in the rich diff - please verify for all images.

Images appear to render when building with docusaurus

HFocken · 2024-05-23T10:33:27Z

.../kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md

+
+##### Catena-X Core Components
+
+As illustrated in the deployment view, the software components of this whitebox will usually be hosted and owned by different companies. Thus, each communication between the components on this whitebox level is protected by Eclipse Dataspace Connectors (EDCs). Moreover, EDC and asset discovery are applied as described by the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit).


You might also want to add a reference to the Connector KIT, if you highlight the EDC.

link to Connector KIT has been added

HFocken · 2024-05-23T10:34:37Z

.../kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md

+
+#### 5.2.2 Marketplace / MaaS Buyer Application - MaaS Portal
+
+The Siemens MaaS Portal is the prototypical implementation of a federated marketplace in CDME. It is a cloud-based Mendix application and connects offer and demand within a manufacturing network of networks. The prototypical environment also acts as the MaaS Buyer Application. A user account management organizes the access and menu workflow. The MaaS Portal further offers a request configuration, including a user account-specific request history. After searching for potential suppliers, the graphical user interface plots a list of suppliers or shows them in a map view, including all filter criteria information for supplier selection and quotation request. In addition, users can obtain information about the network partners and the onboarding process. The idea is to also offer a marketplace for digital services, supporting the order management and execution process.


This is a reference to a commercial platform in Open Source - are you sure, you want to include the company name? A reference implementation should be Tractus-X, not company-owneded.

@HFocken I don't understand why a reference implementation shouldn't be company owned. Our architecture was implemented using the low-code platform Mendix from Siemens (which is the only reference to a commercialized product). The MaaS portal itself is not a commercial product but just a demonstrator.

A reference implementation should never be company owned and this would be the only case where this would be done that way (according to our knowledge) - we established the category "success stories" for that reason. Reference implementations should not be branded but as open and accessible as possible.

You can highlight that you used Mendix to establish the reference implementation, but otherwise UNTIL 10:30am TODAY:

Either remove the brand name from the Reference implementation title here

Move the whole section to "success stories"

Thank you!

Content has been adapted in new request: 614e0ea

/cc @nbarysch @maximilianong @danielmiehle

#898

HFocken · 2024-05-23T11:11:35Z

docs-kits/kits/Manufacturing as a Service Kit/page_adoption-view.md

+Within the Manufacturing-as-a-Service KIT, two main standards were defined:
+
+- Manufacturing Capability Model and API - for declaration of offered and required manufacturing capabilities
+- Request for Quotation Model and API - for manufacturing demand configuration


Does it make sense to link to the standards here again?

A link to the standard section has been added

jSchuetz88

Thank you for the contribution. Only minor remarks from my side regarding some inconsistencies with the referenced data models.

jSchuetz88 · 2024-05-24T00:44:53Z

docs-kits/kits/Manufacturing as a Service Kit/page_adoption-view.md

-model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.request_for_quotation/2.0.0>
+An aspect model defining detailed requirements, deadlines and evaluation criteria for obtaining quotations from potential manufacturers for specific products or services. Manufacturing-as-a-Service (MaaS) scenarios focus on connecting buyers having a request for specific manufacturing process steps or products to be manufactured with the appropriate manufacturing supplier, who has the corresponding capabilities and resources. Sharing information about the demand with all required configuration and contact data is necessary for potential suppliers to evaluate the request and formulate an offer. A common description of the request for quotation based on a standardized semantic definition is therefore key for facilitating such an information exchange between Catena-X participants. This ensures an open network for every Catena-X member to join and enables interoperability between the partners.
+
+Link to the semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.request_for_quotation/2.0.0>


This should be aligned with CX-0129 Request for Quotation (v2.0.0), as it refers to urn:samm:io.catenax.request_for_quotation:3.0.0 as the data model for R24.05.

Edit: The data model v3.0.0 seems already to be references in the other sections of this KIT, too.

model references have been updated

jSchuetz88 · 2024-05-24T00:46:30Z

docs-kits/kits/Manufacturing as a Service Kit/page_adoption-view.md

-model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.manufacturing_capability/2.0.0>
+An aspect model representing manufacturing capabilities, based on the concepts for products, processes, resources and capabilities, as well as their relations to each other. Sharing information about the required and available manufacturing capabilities in an interoperable manner is fundamental for any MaaS solution providing basic and value-added services such as automated search and matchmaking.
+
+Link to the semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.manufacturing_capability/2.0.0>


This should be aligned with CX-0115 Manufacturing Capability Exchange (v1.0.0), as it refers to urn:samm:io.catenax.manufacturing_capability:3.1.0 as the standardized data model.

Edit: The data model v3.1.0 seems already to be referenced in the other sections of this KIT, too.

model references have been updated

danielmiehle

LGTM - thanks for your updates. Ready to merge!

nbarysch · 2024-05-24T11:41:34Z

Thank you for the great addition! I finally feel like I really understand MaaS. One overarching comment - from an outside reader perspective, the adoption and architecture page read quite similar and I'm a bit confused, which one is the one to go to as an interested reader that is looking for a starting point - maybe you could provide a bit of guidance to readers at the beginning of each page.

Hello @HFocken, thank you very much for your feedback. We understood it and implemented it as far as possible, so that the adoption view is the entry point to the KIT. In addition to the vision, mission and business value, the architecture and standards are discussed at a high detail level. The Architecture View goes much deeper into detail. What would be your suggestion? I would like to avoid extensive changes.

Best regards
Nikita

maximilianong · 2024-05-24T11:44:18Z

@dominikoeh this branch has conflicts - please fix it

dominikoeh · 2024-05-24T13:07:18Z

@dominikoeh this branch has conflicts - please fix it

Merge Conflict has been resolved

/cc @danielmiehle @maximilianong

danielmiehle

LGTM

maximilianong · 2024-05-27T06:40:36Z

Sorry but we needed to revert this merge because Hannos concerns / feedback regarding commercial reference implementation in open source need to be fixed first.

#878 (comment)

HFocken

Thank you for implementing the change requests! Good to go!

dominikoeh added 4 commits April 5, 2024 13:31

feat: add software development view for the maas use case

faedab1

feat: aligned software development view

d515e8a

feat: add architecture view to maas kit

b513d36

add white background to transparent images

28fde35

dominikoeh mentioned this pull request May 7, 2024

[Manufacturing as a Service] Release Checks eclipse-tractusx/sig-release#685

Closed

19 tasks

fix: linting

3e66aa2

danielmiehle requested review from danielmiehle, maximilianong and jSchuetz88 May 14, 2024 06:25

danielmiehle reviewed May 14, 2024

View reviewed changes

dominikoeh added 3 commits May 15, 2024 14:16

fix: punctuation for API specification

1edda9b

chore: update DEPENDENCIES

ffc173e

docs: remove empty chapters

fd13aaa

HFocken suggested changes May 23, 2024

View reviewed changes

jSchuetz88 suggested changes May 24, 2024

View reviewed changes

dominikoeh added 3 commits May 24, 2024 08:41

fix: add link to the standards section

91c5666

fix: update model references

5beb1d4

fix: link to Connector KIT

1cdb56f

danielmiehle self-requested a review May 24, 2024 07:19

danielmiehle previously approved these changes May 24, 2024

View reviewed changes

maximilianong previously approved these changes May 24, 2024

View reviewed changes

Merge branch 'main' into 24-05/maas/software-development-view

bdfb92a

dominikoeh dismissed stale reviews from maximilianong and danielmiehle via bdfb92a May 24, 2024 12:43

docs: add comments for distinguishing OpenAPI files in resiliency domain

eb3ae55

danielmiehle requested review from danielmiehle and maximilianong May 24, 2024 13:24

danielmiehle approved these changes May 24, 2024

View reviewed changes

maximilianong approved these changes May 27, 2024

View reviewed changes

maximilianong merged commit 3ee95b2 into eclipse-tractusx:main May 27, 2024
5 checks passed

maximilianong mentioned this pull request May 27, 2024

Revert "docs: Manufacturing as a Service KIT 24.05" #897

Merged

dominikoeh mentioned this pull request May 27, 2024

Manufacturing as a Service KIT 24.05 #898

Merged

2 tasks

HFocken reviewed May 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Manufacturing as a Service KIT 24.05 #878

docs: Manufacturing as a Service KIT 24.05 #878

dominikoeh commented May 7, 2024 •

edited

Loading

danielmiehle May 14, 2024

nbarysch May 16, 2024

danielmiehle May 14, 2024

nbarysch May 16, 2024

danielmiehle May 14, 2024

nbarysch May 16, 2024

nbarysch May 21, 2024

HFocken left a comment

HFocken May 23, 2024

dominikoeh May 24, 2024

HFocken May 23, 2024

dominikoeh May 24, 2024

HFocken May 23, 2024

nbarysch May 24, 2024

HFocken May 27, 2024 •

edited

Loading

dominikoeh May 27, 2024

HFocken May 27, 2024

HFocken May 23, 2024

dominikoeh May 24, 2024

jSchuetz88 left a comment

jSchuetz88 May 24, 2024

dominikoeh May 24, 2024

jSchuetz88 May 24, 2024

dominikoeh May 24, 2024

danielmiehle left a comment

nbarysch commented May 24, 2024

maximilianong commented May 24, 2024

dominikoeh commented May 24, 2024 •

edited

Loading

danielmiehle left a comment

maximilianong commented May 27, 2024 •

edited

Loading

HFocken left a comment


		Manufacturing-as-a-Service (MaaS) scenarios focus on connecting buyers having a request for specific manufacturing process steps or products to be manufactured with the appropriate manufacturing supplier, who has the corresponding capabilities and resources. This connection depends on the capabilities that are offered on the supplier side and that are required on the buyer side.

		The Manufacturing Capability API defines how to share the manufacturing capabilities, e.g. to onboard them to a Manufacturing Network Registry. Manufacturing Network Platforms and MaaS Manufacturer Application can use the Manufacturing Capability API to onboard their manufacturing capabilities in the Manufacturing Network Registry (see figure).


		The Manufacturing Capability API defines how to share the manufacturing capabilities, e.g. to onboard them to a Manufacturing Network Registry. Manufacturing Network Platforms and MaaS Manufacturer Application can use the Manufacturing Capability API to onboard their manufacturing capabilities in the Manufacturing Network Registry (see figure).

		The Request for Quotation API defines detailed requirements, deadlines and evaluation criteria for obtaining quotations from potential manufacturers for specific products or services. The necessary capabilities can be derived from the defined RfQ, which can subsequently be used in the MaaS Manufacturer Application for feasibility analyses or calculations (see figure).

		@@ -0,0 +1,25 @@
		---
		id: manufacturing-capability-aspect-model


		The following diagram covers the general business process addressed in the CDME.

		![Figure - Business process considered for CDME. Out of scope steps have not been elaborated and are therefore not covered by the technical architecture. (Schoeppenthau et al. 2023).](resources/image-2023-11-2_13-54-35.png)


		##### Catena-X Core Components

		As illustrated in the deployment view, the software components of this whitebox will usually be hosted and owned by different companies. Thus, each communication between the components on this whitebox level is protected by Eclipse Dataspace Connectors (EDCs). Moreover, EDC and asset discovery are applied as described by the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit).


		#### 5.2.2 Marketplace / MaaS Buyer Application - MaaS Portal

		The Siemens MaaS Portal is the prototypical implementation of a federated marketplace in CDME. It is a cloud-based Mendix application and connects offer and demand within a manufacturing network of networks. The prototypical environment also acts as the MaaS Buyer Application. A user account management organizes the access and menu workflow. The MaaS Portal further offers a request configuration, including a user account-specific request history. After searching for potential suppliers, the graphical user interface plots a list of suppliers or shows them in a map view, including all filter criteria information for supplier selection and quotation request. In addition, users can obtain information about the network partners and the onboarding process. The idea is to also offer a marketplace for digital services, supporting the order management and execution process.

docs: Manufacturing as a Service KIT 24.05 #878

docs: Manufacturing as a Service KIT 24.05 #878

Conversation

dominikoeh commented May 7, 2024 • edited Loading

Description

Pre-review checks

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HFocken left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HFocken May 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jSchuetz88 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielmiehle left a comment

Choose a reason for hiding this comment

nbarysch commented May 24, 2024

maximilianong commented May 24, 2024

dominikoeh commented May 24, 2024 • edited Loading

danielmiehle left a comment

Choose a reason for hiding this comment

maximilianong commented May 27, 2024 • edited Loading

HFocken left a comment

Choose a reason for hiding this comment

dominikoeh commented May 7, 2024 •

edited

Loading

HFocken May 27, 2024 •

edited

Loading

dominikoeh commented May 24, 2024 •

edited

Loading

maximilianong commented May 27, 2024 •

edited

Loading