Skip to content

Commit d70e064

Browse files
authored
chore(irs): updated readme turotial guide
1 parent 3d48d95 commit d70e064

File tree

1 file changed

+58
-29
lines changed

1 file changed

+58
-29
lines changed

dpp-tutorial/irs-drill-down.md

Lines changed: 58 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -63,50 +63,72 @@ You must have the following components up and running:
6363
- A preconfigured data consumer conenctor with IRS plugin enabled
6464
- Accessibility of components over the network
6565

66+
## 1° Generate the Ids
6667

67-
## 1° Lookup BOMAsBuilt Relationships of the Component
68+
Please generate two UUIDs from the UUID generator https://www.uuidgenerator.net/
6869

70+
### BOMAsBuiltID
71+
```bash
72+
uuid:urn:<UUID-1>
73+
```
74+
75+
### SerialPartID
76+
```bash
77+
uuid:urn:<UUID-2>
78+
```
79+
Store these IDs in some notepad editor for later use.
6980

70-
* Search for the <<UUID>UUID> of the component which was used to from the given sheet of paper. You can also find the same information [here](./resources/test-data/carParts.json) in a test JSON file.
81+
## 2° Lookup BOMAsBuilt Relationships of the Component
7182

7283
To find your part and be able to copy and paste the information:
7384

74-
1 - Search by uuid with CTRL + F:
85+
1 - Go to the file [bomAsBuiltRelationships](./resources/test-data/bomAsBuiltRelationships.json)
7586

76-
![search id](./resources/screenshots/idsearch.png)
87+
2 - Search by uuid with CTRL + F:
7788

78-
You will get your information in a paper:
89+
> [!TIP]
90+
> You will get the UUID in the paper or [here](./resources/test-data/carParts.json)
7991
8092
Example:
8193

8294
```json
8395
{
84-
"f10c0181-ce80-4139-81f0-a59226c88bfe": {
85-
"Name":"TRUNK LID HINGE (LEFT)",
86-
"PCF (Product Carbon Footprint)": "189 kgCO2e",
87-
"Height": "24 cm",
88-
"Width": "2 cm",
89-
"Length": "38 cm",
90-
"Weight": "1.4 kg",
91-
"id": "f10c0181-ce80-4139-81f0-a59226c88bfe",
92-
"Part Instance ID": "DLH-5159",
93-
"Manufacturing Date": "01.12.2023",
94-
"Placed on Market Date": "15.01.2024",
95-
"List of Materials": "Aluminum",
96-
"Hazard Materials": "Lead, Butyl, Cyanoacrylates, Polyurethane",
97-
"Guarantee": "24 months"
96+
"catenaXId": "urn:uuid:48acc23b-7cb8-4288-b620-9eb3d9dce6bf",
97+
"childItems": [
98+
{
99+
"catenaXId": "urn:uuid:f10c0181-ce80-4139-81f0-a59226c88bfe",
100+
"quantity": {
101+
"value": 1.0,
102+
"unit": "unit:piece"
103+
},
104+
"hasAlternatives": false,
105+
"createdOn": "2022-02-03T14:48:54.709Z",
106+
"businessPartner": "BPNL00000003B2OM",
107+
"lastModifiedOn": "2022-02-03T14:48:54.709Z"
108+
},
109+
{
110+
"catenaXId": "urn:uuid:12e656bb-948e-44eb-9b5e-88d7deedf388",
111+
"quantity": {
112+
"value": 1.0,
113+
"unit": "unit:piece"
114+
},
115+
"hasAlternatives": false,
116+
"createdOn": "2022-02-03T14:48:54.709Z",
117+
"businessPartner": "BPNL00000003B2OM",
118+
"lastModifiedOn": "2022-02-03T14:48:54.709Z"
119+
}
120+
]
98121
}
99-
}
100122
```
101123

102-
2 - Copy the json content and paste it into the notepad editor for latter use.
124+
3 - Copy the json content and paste it into the notepad editor for later use.
103125

104126
> [!TIP]
105127
> Copy and paste the data for creating your digital product pass faster!
106128
107129

108130

109-
## 2° Add BOMAsBuilt Relationships to the Submodel Server
131+
## 3° Add BOMAsBuilt Relationships to the Submodel Server
110132

111133
The BOMAsBuilt data retrieved in [previous step](#1-lookup-bomasbuilt-relationships-of-the-component) can be stored into the submodel data service.
112134

@@ -119,6 +141,9 @@ Example: uuid:urn:6fb9a71b-aee6-4063-a82e-957022aeaa7a
119141
> [!IMPORTANT]
120142
> Please substitute the <<UUID>UUID> with the one generated above.
121143
144+
> [!CAUTION]
145+
> Please dont re-use UUIDs.
146+
122147

123148
Open a new terminal and run the following command to add your data into the data service:
124149
> POST /uuid:urn:<<UUID>UUID>
@@ -137,11 +162,16 @@ curl --location '<DATA_SERVICE_URL>/uuid:urn:<UUID>' \
137162
--header 'Content-Type: application/json' \
138163
```
139164

140-
## 3° Lookup SerialPart Item of the Component
165+
## 4° Lookup SerialPart Item of the Component
141166

142167
Once the BOMAsBuilt relationship is added the submodel server, similarly, search for the Id of serial part component with the same UUID as used to search for BOMAsBuilt relationship.
143168

144-
1 - Search by uuid with CTRL + F:
169+
1 - Go to the file [serialPartItems](./resources/test-data/serialPartItems.json)
170+
171+
2 - Search by uuid with CTRL + F:
172+
173+
> [!TIP]
174+
> You will get the UUID in the paper or [here](./resources/test-data/carParts.json)
145175
146176
Example:
147177

@@ -170,14 +200,13 @@ Example:
170200
}
171201
```
172202

173-
2 - Copy the json content and paste it into the notepad editor for latter use.
203+
3 - Copy the json content and paste it into the notepad editor for later use.
174204

175205

176-
## 4° Add SerialPart Item to the Submodel Server
206+
## 5° Add SerialPart Item to the Submodel Server
177207

178-
The serial part data retrieved in [previous step](#3-lookup-serialpart-item-of-the-component) can be stored into the submodel data service.
208+
The serial part data retrieved in [previous step](#4-lookup-serialpart-item-of-the-component) can be stored into the submodel data service.
179209

180-
* Generate a new UUID from here: https://www.uuidgenerator.net/
181210

182211
```bash
183212
Example: uuid:urn:6fb9a71b-aee6-4063-a82e-957022aeaa7a
@@ -204,7 +233,7 @@ curl --location '<DATA_SERVICE_URL>/uuid:urn:<UUID>' \
204233
--header 'Content-Type: application/json' \
205234
```
206235

207-
## 5° Attach BOMAsBuilt to Existing Digital Twin
236+
## 6° Attach BOMAsBuilt to Existing Digital Twin
208237

209238
* Get existing digital Twin by Base64 encoded digital twin Id
210239

0 commit comments

Comments
 (0)