Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 3.82 KB

InstallationGuide.md

File metadata and controls

71 lines (50 loc) · 3.82 KB
Raw

Installation Guide

Product DFT

Install from the command line:

docker pull ghcr.io/catenax-ng/product-dft-backend:main

It is necessary to inject the environment variables, credentials and URLs that can be found on application.properties file.

CatenaX variables

Property Value Description Example
manufacturerId MANUFACTURERID Id of manufacturer CatenaX

Digital Twins variables:

Property name Environment Variable Name Description Example Value
digital-twins.hostname DIGITAL-TWINS_HOSTNAME hostname for Digital Twins https://
digital-twins.authentication.url DIGITAL-TWINS_AUTHENTICATION_URL authentication url for Digital Twins https://
digital-twins.authentication.clientId DIGITAL-TWINS_AUTHENTICATION_CLIENTID client ID authentication for Digital Twins sa-cl6-cx-4
digital-twins.authentication.clientSecret DIGITAL-TWINS_AUTHENTICATION_CLIENTSECRET client secret authentication for Digital Twins VrL8uSG5Tn3NrFiY39vs0klTmlvsRRmo

The values are on the Vault. *Must create a GitHub token to access

EDC variables:

Property name Environment Variable Name Description Example Value
edc.hostname EDC_HOSTNAME edc hostname https://
edc.apiKeyHeader EDC_APIKEYHEADER API KEY header for edc X-Api_Key
edc.apiKey EDC_APIKEY API KEY for edc 123456
dft.hostname DFT_HOSTNAME hostname for DFT https://
dft.apiKeyHeader DFT_APIKEYHEADER url authentication key for edc asset payload Api-Key
dft.apiKey DFT_APIKEY url authentication code for edc asset payload someCode
edc.enabled EDC_ENABLED enable / disable edc true / false

The values are in the Vault. *Must create a GitHub token to access

Upload a file:

When a file .csv is uploaded, the program checks whether the file is a SerialPartTypization or an AssemblyPartRelationship and there is a pipeline for each one. Apart from both upload Batch upload is additional feature were added into DFT.

For Serial Part Typization:

  1. Maps the content of the line with an Aspect.
  2. Generates the UUID if it does not contain a UUID.
  3. Registers in DigitalTwins.
  4. Stores the line in the database.

For Assembly Part Relationship:

  1. Maps the content of the line with an Aspect Relationship.
  2. checks if an Aspect exists so it can be related to that Aspect.
  3. Registers in DigitalTwins.
  4. Stores the line in the database.

For Batch Upload:

  1. Maps the content of the line with an Batch.
  2. Generates the UUID if it does not contain a UUID.
  3. Registers in DigitalTwins.
  4. Stores the line in the database.

The file .csv is loaded in memory, the content is saved and then, the file is removed from memory.

If the file is not .csv, it is read, processed and is considered as FAILED