eclipse-tractusx / portal-frontend

Portal Frontend
Apache License 2.0
4 stars 25 forks source link

Update Overlay for "How to Configure Your Connector" #718

Closed jjeroch closed 2 months ago

jjeroch commented 2 months ago

Summary: The overlay for "How to Configure Your Connector" needs to be updated in order to retrieve the data from the endpoint GET: api/administration/companydata/decentralidentity/urls. Currently, the overlay displays static content, but we want to make it dynamic by fetching the necessary data from the mentioned endpoint.

Page: /technicalsetup (note the page is getting renamed with the ticket implementation of https://github.com/eclipse-tractusx/portal-frontend/issues/694)

Steps to Implement:

  1. Add a new function in the frontend codebase to make a GET request to the api/administration/companydata/decentralidentity/urls endpoint.
  2. Retrieve the necessary data from the response and store it in a variable.
  3. Update the overlay component to use the retrieved data.
  4. Modify the overlay's content to dynamically display the fetched data, such as the configuration steps, URLs, and other relevant information.
  5. Test the updated overlay to ensure that the data is being fetched correctly and displayed as expected.
image

Text Values:

Headline DE: "" EN: "Configure Your Connector"

Description DE: "Dies Beschreibung bietet schrittweise Anweisungen zur Konfiguration Ihres Connectors. Bitte befolgen Sie die unten stehenden Anweisungen, um die erforderlichen Konfigurationswerte einzustellen. Stellen Sie sicher, dass Sie die richtigen Werte für jede Konfigurationseinstellung eingeben. Sobald Sie diese Werte eingestellt haben, ist Ihr Connector ordnungsgemäß konfiguriert und einsatzbereit." EN: "This description provides step-by-step instructions on how to configure your connector. Please follow the instructions below to set the necessary configuration values. Please ensure that you enter the correct values for each configuration setting. Once you have set these values, your connector will be properly configured and ready to use."

Part 01 DE: "iatp.sts.oauth.token_url: Der Token-Endpunkt der dezentralen Identitätsverwaltungsinstanz ist {fetched from the GET endpoint as defined below - value of the attribute DecentralIdentityManagementAuthURL}" EN: "iatp.sts.oauth.token_url: the token endpoint of the decentral identity management instance is {fetched from the GET endpoint as defined below - value of the attribute DecentralIdentityManagementAuthURL}"

Part 02 DE: "iatp.sts.oauth.client.id: Technische Benutzer-Client-ID Ihres technischen Benutzers für den spezifischen Connector. Stellen Sie sicher, dass Sie die technischen Benutzer trennen – jeder Connector ist ein technischer Benutzer. Technische Benutzer können im gefunden und angefragt werden technical user self-service. Sie können den technischen Benutzer auch im Rahmen der Connector-Registrierung erstellen." EN: "iatp.sts.oauth.client.id: technical user client ID of your technical user for the specific connector. Ensure you separate the technical users - each connector one technical user. Technical users can get found and requested inside the technical user self-service. You can also create the technical user as part of the connector registration."

Part 03 DE: "iatp.sts.oauth.client.secret_alias: Alias, unter dem Sie Ihr DIM-Client-Geheimnis im Tresor gespeichert haben. Im Tresor sollte das Geheimnis des oben definierten technischen Benutzers gespeichert werden. Sie können das Geheimnis im Inneren sehen technical user self-service." EN: "iatp.sts.oauth.client.secret_alias:** alias under which you saved your DIM client secret in the vault. Inside the vault the secret of the technical user defined above should be stored. You can view the secret inside the technical user self-service."

Part 04 DE: "iatp.sts.dim.ur: Base-URL Ihrer dezentralen Identitätsverwaltungsinstanz. Bitte verwenden Sie die folgenden Angaben für Connectors, die unter Ihrer Firmenidentität laufen: {fetched from the GET endpoint as defined below - value of the attribute DecentralIdentityManagementServiceURL}" EN: "iatp.sts.dim.ur: base url of you decentral identity management instance. Please use the following details for connectors running under your company identity: {fetched from the GET endpoint as defined below - value of the attribute DecentralIdentityManagementServiceURL}"


IMPORTANT:

jjeroch commented 2 months ago

NOTE: the endpoint is currently only available at -rc.dev Swagger: https://portal-backend-rc.dev.demo.catena-x.net/api/administration/swagger/index.html