Skip to content

Commit

Permalink
chore: change links from usercontent to static
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskueffner committed Feb 2, 2024
1 parent 839ae1a commit 753e8a6
Show file tree
Hide file tree
Showing 114 changed files with 240 additions and 240 deletions.
2 changes: 1 addition & 1 deletion docs/developer/01. Onboarding/01. Invite/01. Summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<br>

<img width="1044" alt="image" src="https://user-images.githubusercontent.com/94133633/217117360-bbe57f2a-f0d3-4b32-aacf-823a45ca449d.png">
<img width="1044" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/login-process-diagramm.png">
<br>

Scenario: New Member gets an individual invite by the CX Organization or Operator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The invitation is the starting point of a company onboarding.
A user of the company is getting invited by the CX Admin and the invitation endpoint is triggering in the backend the creation of the identity relevant elements.
<br>
<br>
<img width="998" alt="image" src="https://user-images.githubusercontent.com/94133633/210187547-2e101125-33a5-44db-bda8-c65afef71407.png">
<img width="998" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/login-process-responsibilities.png">
<br>
<br>

Expand Down
6 changes: 3 additions & 3 deletions docs/developer/01. Onboarding/02. Registration/01. Login.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Pre-condition: The authorized organization onboarding party must have received a
After receiving the CX invite email (incl. registration login URL and one-time-password), the user can directly start the login to the company registration.
<br>

<img width="600" alt="image" src="https://user-images.githubusercontent.com/94133633/217643866-dcdb669e-5dbb-4b5d-8577-77d80f6ba1d6.png">
<img width="600" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/company-selection-screen.png">
<br>

After selecting the company for login; the user can login via the email and password (first time; the one-time-password shared via email)

<img width="600" alt="image" src="https://user-images.githubusercontent.com/94133633/217644067-91ea8590-ba4e-4c79-b4c6-7c5b7008b4f5.png">
<img width="600" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/company-login-screen.png">
<br>

After the successful login; the user can directly start to proceed with the company registration form.
Expand All @@ -38,7 +38,7 @@ Based on the fetched status; the frontend logic will decide how the user proceed
1. If the status is any status before "SUBMITTED" (< id "7"); the company registration form gets displayed; starting with the introduction screen.
If company registration data have been previously added/saved already, the data will be displayed inside the registration form; otherwise an empty registration form will be displayed.
2. If the status is in status "SUBMITTED" (= id "7"); the information screen "application in validation" screen is getting displayed.
<img width="443" alt="image" src="https://user-images.githubusercontent.com/94133633/216842731-5a2097ac-240c-44fe-aa0b-8396d0474690.png">
<img width="443" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/successful-registration-submission.png">

3. If the status is in status "APPROVED" (= id "8"); the user should get redirected to the portal "home" page

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Below you can find the sub-chapter overview for an easy navigation
## Functional View

<br>
<img width="400" alt="image" src="https://user-images.githubusercontent.com/94133633/210187915-d4adf4a4-ac0f-4512-b4f6-f53d7e3bc7d8.png">
<img width="400" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/registration-data-input.png">
<br>
In step 1 of the registration application, the company administrator need to add the legal company details. 2 Options are available

Expand All @@ -41,7 +41,7 @@ In step 1 of the registration application, the company administrator need to add
Flow diagram for option a) and b)

<br>
<img width="1050" alt="image" src="https://user-images.githubusercontent.com/94133633/210187844-366e7cff-6e69-417b-9aa5-073d2409815a.png">
<img width="1050" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/company-data-verification-process-flow.png">

<br>
<br>
Expand Down Expand Up @@ -182,7 +182,7 @@ The unique identifier is a location based attribute; means, after the user enter
initially when opening the registration form step 1 "company data"; the unique identifier section is not displayed.
Only when entering the country code; the unique id section is getting displayed (see screen below)

<img width="601" alt="image" src="https://user-images.githubusercontent.com/94133633/216842872-4891a050-00f3-4ba4-a97e-b223f22a5170.png">
<img width="601" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/country-identifier-options.png">

```dif
! GET /api/registration/company/country/{alpha2Code}/uniqueidentifiers
Expand All @@ -207,11 +207,11 @@ Response Body

###### Result on UI

<img width="855" alt="image" src="https://user-images.githubusercontent.com/94133633/216842966-d590263b-8793-43cb-bba5-8f9fcdd06b2e.png">
<img width="855" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/country-identifiers-data-mapping.png">

Translation of technical api response keys to human readable titles:

<img width="357" alt="image" src="https://user-images.githubusercontent.com/94133633/216842986-eea5153f-318d-466b-b9f1-8775f64ee7cc.png">
<img width="357" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/identifier-translations.png">
<br>

**NOTE**
Expand All @@ -235,14 +235,14 @@ In case that multiple identifier are submitted, the user needs to be able to sel
Below you can find an example of the implemented design for "multiple identifier"

<br>
<img width="605" alt="image" src="https://user-images.githubusercontent.com/94133633/216847241-9f8f8292-0be6-4886-814b-a451b91a5589.png">
<img width="605" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/country-identifier-multiple-registered.png">

<br>
<br>

###### Implemented Pattern

<img width="1012" alt="image" src="https://user-images.githubusercontent.com/94133633/216843013-8601c1eb-372a-4f39-87ec-f849fbfb4d20.png">
<img width="1012" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/country-identifier-patterns.png">

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Add Aditional Users

<br>
<img width="400" alt="image" src="https://user-images.githubusercontent.com/94133633/210187937-82a3eb9f-4953-4f3c-8841-cfb16c89f248.png">
<img width="400" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/registration-invite-user.png">
<br>
As part of the registration and onboarding process a number of users will be needed to support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Select company role & sign terms and conditions

<br>
<img width="400" alt="image" src="https://user-images.githubusercontent.com/94133633/210187987-d0dee3e8-c180-44f7-a2d2-ae78a1b020b9.png">
<img width="400" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/registration-company-role.png">
<br>
For the company role selection the Company Admin can select the company role within the network
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
## Upload registration relevant documents

<br>
<img width="400" alt="image" src="https://user-images.githubusercontent.com/94133633/210188158-22d3f21a-bb4e-4c39-b619-a000cb446c87.png">
<img width="400" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/registration-upload-certificates.png">
<br>
In Step 4, the users are asked to upload the company identification.
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In case the registration login/initial registration form load endpoints run on a
Example:
<br>

<img width="727" alt="image" src="https://user-images.githubusercontent.com/94133633/221536363-e51cd70a-4554-4c8f-9230-1887edfa0243.png">
<img width="727" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/500-internal-server-error.png">

<br>
<br>
Expand All @@ -25,7 +25,7 @@ If the login can not get confirmed, the login will display the following error:
Example:
<br>

<img width="944" alt="image" src="https://user-images.githubusercontent.com/94133633/221536935-087c024b-8b51-48b1-b48c-d5b5da9a78e3.png">
<img width="944" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/company-login-wrong-password.png">

<br>
<br>
Expand All @@ -39,17 +39,17 @@ Error scenarios:
- error incorrect added country code

- Snackbar
<img width="211" alt="image" src="https://user-images.githubusercontent.com/94133633/221539775-3aea57ff-1746-4ee2-a234-c6e00f64e285.png">
<img width="211" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/error-no-identifier.png">

- error incorrect bpn added

- input field error
<img width="635" alt="image" src="https://user-images.githubusercontent.com/94133633/221540184-ab87c032-4d73-4cee-a439-34d4c6477800.png">
<img width="635" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/bpnl-search-invalid.png">

- error bpn not found

- input field error
<img width="636" alt="image" src="https://user-images.githubusercontent.com/94133633/221540475-459f7799-9bf1-4f29-859d-c265cdd4b182.png">
<img width="636" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/bpnl-search-doesnt-exist.png">

- error on saving company data

Expand All @@ -75,7 +75,7 @@ Error scenarios:
- Agreement pre-saved data load unsuccessful
- Agreement saved unsuccessfully
- Snackbar
<img width="278" alt="image" src="https://user-images.githubusercontent.com/94133633/221542370-d89a44ff-dea0-4968-ad2c-96936d524452.png">
<img width="278" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/error-terms-conditions-agreements.png">

<br>
<br>
Expand All @@ -92,7 +92,7 @@ Error scenarios:

- Documents upload unsuccessful
- Dropzone error
<img width="535" alt="image" src="https://user-images.githubusercontent.com/94133633/221542628-58fcaed5-4408-4968-97d4-534751e4b0d7.png">
<img width="535" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/upload-file-error-to-large.png">

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Endpoints supports pagination and search via companyName
## 2 Get Application Details

<br>
<img width="1633" alt="image" src="https://user-images.githubusercontent.com/94133633/220194282-1be6d0c7-ad13-423e-92e5-bcf6af5a3091.png">
<img width="1633" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-details-api-call.png">
<br>
<br>
Additionally to the endpoint of #1 where application key data are included, the GET application details endpoint is used to provide additional details to the operator / application approval buddy.
Expand Down Expand Up @@ -168,7 +168,7 @@ The API is downloading the document which is selected by the user.<br>
<br>

<p align="center">
<img width="686" alt="image" src="https://user-images.githubusercontent.com/94133633/220194871-0ed768d6-46b0-49e9-be48-63dddd35dfe7.png">
<img width="686" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-download-document.png">
</p>
<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Acting user: CX Admin (Operator)
<br>
<br>

<img width="1406" alt="image" src="https://user-images.githubusercontent.com/94133633/221039379-564466c0-51dd-4458-abef-1b47b4fce32d.png">
<img width="1406" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-popup.png">

By clicking on one of the process steps, the overlay wth process step details gets displayed.
Depending on the status, the user can execute a number of action / next steps. In general 3 action states are possible and defined below

<img width="1540" alt="image" src="https://user-images.githubusercontent.com/94133633/221039482-c9caa7e3-0127-4b77-bc96-df19586d6811.png">
<img width="1540" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/status-frontend-options.png">

<br>
<br>
Expand Down Expand Up @@ -49,31 +49,31 @@ IMPORTANT: the "retriggerable" attribute is relevant / important for the FE busi
##### #1 Registration Validation

<br>
<img width="1358" alt="image" src="https://user-images.githubusercontent.com/94133633/220343179-d6b844e9-d893-4d8f-ab48-4982767f21ac.png">
<img width="1358" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/approve-decline-status-mapping.png">
<br>

##### #2 BPN Creation

<br>
<img width="1358" alt="image" src="https://user-images.githubusercontent.com/94133633/220343333-a15a7e04-58eb-47b6-809b-286757952d8b.png">
<img width="1358" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/bpn-status-mapping.png">
<br>

##### #3 Managed Identity Wallet

<br>
<img width="1358" alt="image" src="https://user-images.githubusercontent.com/94133633/220343439-10255e1d-53e6-45b8-8271-0e16e3e4c0ac.png">
<img width="1358" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/bpn-status-mapping.png">
<br>

##### #4 Clearinghouse

<br>
<img width="1361" alt="image" src="https://user-images.githubusercontent.com/94133633/220343558-aac1e6d9-c9be-4c04-b068-f63f3cab3849.png">
<img width="1361" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/clearinghouse-status-mapping.png">
<br>

##### #5 Self Description LP

<br>
<img width="1358" alt="image" src="https://user-images.githubusercontent.com/94133633/220343632-8c634ddc-81c8-4f30-993e-2716280de22b.png">
<img width="1358" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/selfdescription-status-mapping.png">

<br>
<br>
Expand All @@ -87,7 +87,7 @@ The list below shows an overview of all application approval steps:
<br>
<br>
<p align="center">
<img width="800" alt="image" src="https://user-images.githubusercontent.com/94133633/216109363-bbfa5758-73b6-4b2a-9588-fc8832eeadf4.png">
<img width="800" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-confirmation-workflow.png">
</pr>
<br>
<br>
Expand Down Expand Up @@ -134,7 +134,7 @@ The endpoint can only get triggered/executed if the application is in the status
##### Scenario: Decline

<br>
<img width="827" alt="image" src="https://user-images.githubusercontent.com/94133633/217916501-dbadf9e9-2a1a-4a0e-911f-8be3f0c5df0a.png">
<img width="827" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-cancel-popup.png">
<br>

The endpoint "decline" sets the "Registration_Verification" checklist item to "FAILED" incl. a time stamp, as well as the decline message added by the operator.
Expand Down Expand Up @@ -331,7 +331,7 @@ Standard validations apply:
<br>
<br>

<img width="624" alt="image" src="https://user-images.githubusercontent.com/94133633/210288308-f217bc4e-211c-4223-b63d-07a7bef146f4.png">
<img width="624" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-enter-bpn-popup.png">

<br>
<br>
Expand Down Expand Up @@ -384,7 +384,7 @@ The "Clearinghouse Check" is getting automatically triggered when the following
- application is in status "submitted"
<br>

<img width="450" alt="image" src="https://user-images.githubusercontent.com/94133633/216144714-07d07704-7ee8-4f71-b2f3-b6b2767ea87c.png">
<img width="450" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/clearinghouse-backend-flow.png">
<br>

The interface is an asynchronous interface - due to this the application checklist item associates with two process steps; the interface is explained below in two steps
Expand Down Expand Up @@ -594,7 +594,7 @@ With the execution of the application activation, the system will:
<br>
The bpn can get manually added (as a workaround) if the registration company request doesn't have a business partner number added and the registration request is in the status "submitted".
<br>
<img width="1213" alt="image" src="https://user-images.githubusercontent.com/94133633/210288619-5b526c86-25b2-4be7-a73c-da07ce3a0214.png">
<img width="1213" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-possible-interactions.png">
<br>
BPNs can only get added by CX Admins.
As mentioned above, the implementation is a workaround only and will get replaced by the actual bpn connection as soon as the reference implementation is available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ While the company application is processing the application validations; the adm
To decline the application the "Cancel Application" Button is enabled for all applications which did not reach the "CONFIRMED" / "DECLINED" status so far.

<br>
<img width="827" alt="image" src="https://user-images.githubusercontent.com/94133633/217916501-dbadf9e9-2a1a-4a0e-911f-8be3f0c5df0a.png">
<img width="827" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-cancel-popup.png">
<br>

##### API Implementation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Acting user: CX Admin (Operator)
The board supports filter, search and the actual approval / validation function of new company registration requests.
<br>
<br>
<img width="1000" alt="image" src="https://user-images.githubusercontent.com/94133633/210287568-1591aba6-2f12-4b11-bf12-4ceba24af1aa.png">
<img width="1000" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-overview-narrow.png">

<br>
<br>

## Functional Details

<img width="1030" alt="image" src="https://user-images.githubusercontent.com/94133633/210288536-91900625-b007-4323-b756-77d81d562176.png">
<img width="1030" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-overview-wide.png">
<br>
<br>

Expand All @@ -32,7 +32,7 @@ With using the application details button, application details such as
- details to the approval flow status

<br>
<img width="1000" alt="image" src="https://user-images.githubusercontent.com/94133633/210288576-e97207fe-fb86-44ed-991a-f6c9de7b47c8.png">
<img width="1000" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-requests-details-api-call.png">

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@

Status uses the chipcard instead of the status icon. API response data mapping explained below:

<img width="356" alt="image" src="https://user-images.githubusercontent.com/94133633/219890309-ec193338-4588-48e7-94c8-7cd2c96e0d18.png">
<img width="356" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/application-status-data-mapping.png">

<br>

##### SD Registration:

MUI Element/Icon used to display status based on the API response:

<img width="649" alt="image" src="https://user-images.githubusercontent.com/94133633/219890514-540e1b76-1c49-4a6d-9f25-d7e8718485c6.png">
<img width="649" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/selfdescription-status-data-mapping.png">

In the scenario where the documentId is NULL; tooltip is implemented with an additional information about the self-description status.

Expand All @@ -36,7 +36,7 @@ In the scenario where the documentId is NULL; tooltip is implemented with an add

Host displayed based on the API response:

<img width="356" alt="image" src="https://user-images.githubusercontent.com/94133633/219891220-ecfc4b97-f639-475e-8c87-e9f75f287194.png">
<img width="356" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/company-name-data-mapping.png">

<br>
<br>
Expand Down
Loading

0 comments on commit 753e8a6

Please sign in to comment.