Skip to content

chore: update arc42 documentation #937

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 18, 2025
Merged

chore: update arc42 documentation #937

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
326b15d
chore: update arc42 documentation
ReneSchroederLJ Aug 13, 2025
9ea0da5
chore: auto format markdown files
ReneSchroederLJ Aug 18, 2025
7fb6da0
fix: update scdn version in documentation
ReneSchroederLJ Aug 18, 2025
11596aa
Merge branch 'main' into arc-42-update-r25-09
ReneSchroederLJ Aug 18, 2025
36c0771
fix: scdn version number in readme
ReneSchroederLJ Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ insert_final_newline = true

[*.yaml]
indent_size = 2

[*.md]
indent_size = 2
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The **need for configuration updates** is **marked bold**.

* Updated open API ([#929](https://github.com/eclipse-tractusx/puris/pull/929))
* Updated dependencies to resolve high and critical security vulnerabilities ([#932](https://github.com/eclipse-tractusx/puris/pull/932))
* Updated Arc42 documentation ([#937](https://github.com/eclipse-tractusx/puris/pull/937))

## v3.2.0

Expand Down
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ information about prerequirements and getting started guides.
Beside the dependencies provided in the Helm Chart, the following dependencies have been tested for R24.05 to run PURIS:

| Application | App Version | Chart Version |
|-------------------------------------------------------------------------------------------------------------------|-------------|---------------|
| [Tractus-X Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector) | 0.10.0 | 0.10.0 |
| ----------------------------------------------------------------------------------------------------------------- | ----------- | ------------- |
| [Tractus-X Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector) | 0.10.0 | 0.10.0 |
| [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/tree/main/charts/registry) | 0.8.0 | 0.8.0 |

## Overview of Implemented Standards

The application follows the following Catena-X standards (business-wise) to the following degree:

| Standard | Level of implementation |
|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
| [CX-0118 Delivery Information Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0118-ActualDeliveryInformationExchange) | Compliant. |
| [CX-0120 Short-Term Material Demand Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0120-ShortTermMaterialDemandExchange) | Compliant. |
| [CX-0121 Planned Production Output Exchange 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0121-PlannedProductionOutputExchange) | Compliant. |
| [CX-0122 Item Stock Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0122-ItemStockExchange) | Compliant. |
| [CX-0145 Days of Supply Exchange 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0145-DaysofsupplyExchange) | Compliant. |
| [CX-0146 Supply Chain Disruption Notifications 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0146-SupplyChainDisruptionNotifications) | Missing functionality to react and close. |
| Standard | Level of implementation |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| [CX-0118 Delivery Information Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0118-ActualDeliveryInformationExchange) | Compliant. |
| [CX-0120 Short-Term Material Demand Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0120-ShortTermMaterialDemandExchange) | Compliant. |
| [CX-0121 Planned Production Output Exchange 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0121-PlannedProductionOutputExchange) | Compliant. |
| [CX-0122 Item Stock Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0122-ItemStockExchange) | Compliant. |
| [CX-0145 Days of Supply Exchange 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0145-DaysofsupplyExchange) | Compliant. |
| [CX-0146 Supply Chain Disruption Notifications 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0146-SupplyChainDisruptionNotifications) | Compliant. |

## Known Knows

Expand Down
11 changes: 6 additions & 5 deletions docs/architecture/01_introduction_and_goals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Introduction and Goals

Supply networks are complex. Supply or demand shortages affect multiple partners along the
supply network. In case a shortage occurs, partners need to collect and exchange manually
supply network. In case a shortage occurs, partners need to collect and exchange data manually
while discussing the potential actions to take.

PURIS FOSS tries to address this manual collection of data. The application tries to facilitate
this information exchange by implementing the respective information exchange.

PURIS FOSS tries to solve short-term information needs within a given business relationship.
The information are production and supply chain related. The full-fledged vision is a dashboard
The information is production and supply chain related. The full-fledged vision is a dashboard
allowing partners to make their situation transparent exchanging production-related demands,
planned production quantities and stocks. This information is visualized and exchanged
on a day granularity and shall be enhanced by delivery information.
Expand All @@ -24,23 +24,24 @@ providing data sovereignty.
## Requirements Overview

The following requirements shall be fulfilled:

- Exchange material flow related data (demand, production outputs, stocks and delivery information)
- Visualize the exchanged information.

## Quality Goals

| Quality Goal | Motivation and Description |
|---------------------------|---------------------------------------------------------------------------------------------|
| ------------------------- | ------------------------------------------------------------------------------------------- |
| Compatibility to Catena-X | PURIS FOSS follows similar patterns as use cases in resiliency topics and overall Catena-X. |
| Fast usage | PURIS FOSS allows partners to exchange data with as less onboarding effort as needed |
| Fast usage | PURIS FOSS allows partners to exchange data with as little onboarding effort as needed |
| Data sovereignty | PURIS FOSS follows Catena-X and GAIA-X requirements for data sovereignty |

## Stakeholders

Key stakehoders for puris are:

| Stakeholder | Goal or Interest |
|------------------------|---------------------------------------------|
| ---------------------- | ------------------------------------------- |
| Catena-X Ecosystem | Integration of the Ecosystem concepts |
| Politics and Companies | more resilient supply networks |
| SME | less efforts for integration |
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/02_architecture_constraints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
PURIS FOSS follows the following constraints:

| Constraint | Background or motivation |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| IDS & GAIA-X Compliance | Data sharing, storing and processing must be in compliance to the standards provided by GAIA-X and IDS. |
| Data Sharing between Companies | Companies must use IDS compliant and certified connectors along with an approved Catena-X information model for communication. This guarantees interoperability between certified participants. The Eclipse Dataspace Connector is highly recommended for this purpose. The data should stay inside the connector if full data sovereignty is necessary. |
| Data sovereignty | To ensure data sovereignty, data owners need to attach machine readable access policies and contract policies to their data before sharing. The data consumer has to accept the usage policies before processing the data. Connectors (+ the underlying / corresponding systems) must technically enforce those usage policy descriptions. |
| Managed Identity Wallet (MIW) | MIW is a central Catena-X Service, which allows storing credentials to prove claims in the Catena-X data space. |
| Interoperability between Data Applications | Data exchange MUST follow standards so that different vendors applications may exchange data. This allows to reduce the risk of vendor-lock-ins. |
| Semantic Aspect Meta Model (SAMM) | Tooling used in Catena-X to semantically describe data. |
| Digital Twins in Catena-X & Industry Core | Standards CX-0002 and CX-0126 describe how Digital Twins following with the Asset Administration Shell shall be used. PURIS standards are built on these foundations. |
| Digital Twins in Catena-X & Industry Core | Standards CX-0002 and CX-0126 describe how Digital Twins following the Asset Administration Shell shall be used. PURIS standards are built on these foundations. |

## NOTICE

Expand Down
28 changes: 16 additions & 12 deletions docs/architecture/03_system_scope_and_context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
# System Scope and Context

The first draft of this application only targets to provide a possibility to enter and exchange stock information
related to partners. This application scope follows the following information.
The application's scope is to enable the creation, update and exchange of demand, production, delivery, stock and days of supply information related to the partners. In addition the application enbles sending, updating, forwarding and resolving of supply chain disruption notifications. This application scope follows the following information.

## Business Context

PURIS FOSS may be operated in any supply network, but currently will likely be operated in the
automotive supply network. Different functions within a company operate supply chain functions. They can either work on
long-term functions (such as demand and capacity management - not handled by this application) or short-term functions
(like supply reliability - supported by this application).
(like supply reliability - supported by this application).

![Business Context](img/03-business-context.svg)

**Disposition**
### Disposition

The disposition has a major information need to keep a material flow into and out of the production. The disposition
steers the allocation of material within the production. PURIS supports the disposition to identify shortages by
providing relevant information regarding the material flow.

**Production (Process)**
### Production (Process)

Production is the actually value-adding process of a manufacturer. Its demand is derived by outer factors such as
orders. A lack of material in supply chains leads to shortages. The production process has to be seen as a consumer of
data provided by PURIS (Catena-X data consumer) and as a provider of data to PURIS (Catena-X data provider). In that way
PURIS is able to fulfill the disposition's information need.

**Logistics**
### Logistics

For a production process it is necessary to fulfill its logistics requirements. That means that the material in demand
is given in the necessary quantity at the right time at the right place (see seven Rs above). PURIS targets to support
the information flow to overview this problem task.

**(Automotive) Supply Chain**
### (Automotive) Supply Chain

Supply chains synchronize demands with the supply. They are networks and not linear, as each customer commonly has more
than 1 supplier of services or physical goods. Supply chains are commonly supported by three flows: material flow,
finance flow and information flow. For PURIS the information flow is the relevant one.
Expand All @@ -49,23 +52,23 @@ The Technical Context has been derived from the architecture constraints:

![Technical Context](img/03-technical-context.svg)

**PURIS FOSS**
### PURIS FOSS

The PURIS FOSS is a system consuming short-term supply information supporting identification and mitigating shortages.

**SAMM**
### SAMM

SAMM is a technology used to define submodel information for the Asset Administration Shell (AAS). SAMM is used to
define the actual payload of the APIs used in PURIS FOSS.

**Tractus-X Connector**
### Tractus-X Connector

The [Tractus-X Connector](https://github.com/eclipse-tractusx/tractusx-edc) (abbreviated and simplified as EDC) is a
Catena-X specific implementation of
the [Eclipse Dataspace Components Connector (EDC)](https://github.com/eclipse-edc/Connector) is an open-source framework
which can be used to participate within an International Data Space (IDS).

*Sovereign Data Exchange*
### Sovereign Data Exchange

To ensure data sovereignty, access and usage policies (prohibitions, permissions, obligations) may be attached as a
machine readable defintion by data owners before sharing their data. The data consumer has to accept the policies before
Expand All @@ -76,7 +79,8 @@ compliant to the usage policies, since the policies define data processing rules
Within Catena-X an odrl policy profile has been defined. The implementation of sovereign data exchange is explained in
the [concepts section](./08_concepts.md).

**Digital Twins & Industry Core**
### Digital Twins & Industry Core

The Industry Core defines a layer on top of the combination of IDS and Digital Twin platform capabilities. It defines
the Part Type Twin as a "catalog item" representing a material that has not yet been built (serialized) but sourced. The
[Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Digital%20Twin%20Kit/Adoption%20View%20Digital%20Twin%20Kit)
Expand Down
Loading