diff --git a/docs/Arc42.md b/docs/Arc42.md index b44ce56f..688472e2 100644 --- a/docs/Arc42.md +++ b/docs/Arc42.md @@ -210,16 +210,16 @@ Backend API Swagger-ui Ex: [https://domain_url/api/swagger-ui/index.html](https:



-| Module | Description | Execution order | -|---------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------- | -| CreateAspect | Used when Serial Part Typization is created on the frontend using the table or submit the json request with the content.

It set the row position and process id in each item. | 0 | -| MapToAspect | Convert the string that came on the uploaded CSV file to an Aspect dto.

It also validate the mandatory fields are fulfilled. | 1 | -| MapFromAspectRequest | Convert from the AspectRequest object to an Aspect dto.
It also validate the mandatory fields are fulfilled. | 1 | -| GenerateUUId | Check if Aspect have a non null and non blank uuid. If not it will generate one UUID with the defined prefix "urn:uuid:". | 2 | -| DigitalTwinsAspect | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Aspect with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | -| EDCAspect | Do the interface in the Eclipse Data Connector (EDC)

- It will lookup for a previous asset registry;
- If no asset registry is found it will create an asset with a applied OR default policy and contract definition; | 4 | -| BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 | -| StoreAspect | Store the Aspect in the SDE database. | 6 | +| Module | Description | Execution order | +|---------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------- | +| CreateAspect | Used when Serial Part Typization is created on the frontend using the table or submit the json request with the content.

It set the row position and process id in each item. | 0 | +| MapToAspect | Convert the string that came on the uploaded CSV file to an Aspect dto.

It also validate the mandatory fields are fulfilled. | 1 | +| MapFromAspectRequest | Convert from the AspectRequest object to an Aspect dto.
It also validate the mandatory fields are fulfilled. | 1 | +| GenerateUUId | Check if Aspect have a non null and non blank uuid. If not it will generate one UUID with the defined prefix "urn:uuid:". | 2 | +| DigitalTwinsAspect | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Aspect with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | +| EDCAspect | Do the interface in the Eclipse Data Connector (EDC)

- It will lookup for a previous asset registry;
- If no asset registry is found it will create an asset with a applied OR default policy and contract definition; | 4 | +| BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 | +| StoreAspect | Store the Aspect in the SDE database. | 6 |
@@ -233,7 +233,7 @@ Backend API Swagger-ui Ex: [https://domain_url/api/swagger-ui/index.html](https: | MapToAspectRelationship | Convert the string that came on the uploaded CSV file to an Aspect Relationship dto.

It also validate the mandatory fields are fulfilled. | 1 | | MapFromAspectRelationshipRequest | Convert from the AspectRelationshipRequest object to an Aspect Relationship dto.

It also validate the mandatory fields are fulfilled. | 1 | | FetchCatenaXId | Check if Aspect Relationship have a non null and non blank parent uuid and child uuid.

- Lookup call with Digital Twins for both parent and child aspect else parent or child not found will be thrown;
- If parent and child are found both uuid will be set on the Aspect Relationship;
- If parent or child are not found an exception will be thrown; | 2 | -| DigitalTwinsAspectRelationship | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Aspect Relationship with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | +| DigitalTwinsAspectRelationship | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Aspect Relationship with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | | EDCAspectRelationship | Do the interface in the Eclipse Data Connector (EDC)

- It will lookup for a previous asset registry;
- If no asset registry is found it will create an asset plus a default policy and contract definition; | 4 | | BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 | | StoreAspectRelationship | Store the Aspect Relationship in the SDE database. | 6 | @@ -244,16 +244,16 @@ Backend API Swagger-ui Ex: [https://domain_url/api/swagger-ui/index.html](https:



-| Module | Description | Execution order | -|--------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------- | -| CreateBatch | Used when Batch upload is created on the frontend using the table or submit the json request with the content.

It set the row position and process id in each item. | 0 | -| MapToBatch | Convert the string that came on the uploaded CSV file to an Batch dto.

It also validate the mandatory fields are fulfilled. | 1 | -| MapFromBatchRequest | Convert from the BatchRequest object to an Batch dto.

It also validate the mandatory fields are fulfilled. | 1 | -| GenerateUUId | Check if Batch have a non null and non blank uuid. If not it will generate one UUID with the defined prefix "urn:uuid:". | 2 | -| DigitalTwinsAspect | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Batch with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | -| EDCBatch | Do the interface in the Eclipse Data Connector (EDC)

- It will lookup for a previous registry;
- If no registry is found it will create an asset plus a default policy and contract definition; | 4 | -| BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 | -| StoreBatch | Store the Batch in the SDE database. | 6 | +| Module | Description | Execution order | +|--------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------- | +| CreateBatch | Used when Batch upload is created on the frontend using the table or submit the json request with the content.

It set the row position and process id in each item. | 0 | +| MapToBatch | Convert the string that came on the uploaded CSV file to an Batch dto.

It also validate the mandatory fields are fulfilled. | 1 | +| MapFromBatchRequest | Convert from the BatchRequest object to an Batch dto.

It also validate the mandatory fields are fulfilled. | 1 | +| GenerateUUId | Check if Batch have a non null and non blank uuid. If not it will generate one UUID with the defined prefix "urn:uuid:". | 2 | +| DigitalTwinsAspect | Do the interface in the Digital Twins registry.

- It will lookup for shells and if no shell is found it will create one;
- If a single shell exists for the given key it will use that shell;
- If multiple shell are found it will through an exception;
- It will lookup for sub models. If no sub model is found it will create one;
- If a sub model is found it will set the Batch with that sub model id;
- Once done with twins registry and submodel creation then create contract rule;

Please note that a shell can only have two sub models at the time being. | 3 | +| EDCBatch | Do the interface in the Eclipse Data Connector (EDC)

- It will lookup for a previous registry;
- If no registry is found it will create an asset plus a default policy and contract definition; | 4 | +| BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 | +| StoreBatch | Store the Batch in the SDE database. | 6 |
@@ -272,7 +272,7 @@ Backend API Swagger-ui Ex: [https://domain_url/api/swagger-ui/index.html](https: | StorePartAsPlanned | Store the PartAsPlanned in the SDE database. | 5 |
-#### **BoM As-Planned - PartTypeInformation** +#### **BoM As-Planned - PartTypeInformation **



diff --git a/docs/images/part_type_information.svg b/docs/images/part_type_information.svg index 2a8813b4..ce67ea93 100644 --- a/docs/images/part_type_information.svg +++ b/docs/images/part_type_information.svg @@ -1,5 +1,5 @@ -MapToPartTypeInformationMapFromPartTypeInformationCreatePartTypeInformationGenerateUuIdDigitalTwinsPartTypeInformationEDCPartTypeInformationStorePartTypeInformation \ No newline at end of file