Skip to content

Commit

Permalink
docs: update app release process Technical Integration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jjeroch committed Jul 7, 2024
1 parent 37cd10d commit 97befa6
Showing 1 changed file with 43 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -1,20 +1,56 @@
### Step 4 - Technical Integration

For technical integration, the app roles get loaded inside the step 4. Those roles are necessary to enable in the customer subscription scenario the possible user federation including assigned user roles.
#### Table of content
* [App Roles](#app-roles)
* [Technical User Roles](#technical-user-roles)

With the technical integration feature, the user can:
#### App Roles

- upload those app user roles via csv file
- preview uploadable roles
- trigger the role creation for the app (roles can get later updated again via the app change process)
- delete uploaded roles
During step 4 of the release process, app roles are loaded to facilitate user federation, allowing users with assigned roles to access the app in a customer's subscription environment.

The function allowed app provider to manage app roles effectively. The following functionalities are included:

- **Upload App User Roles**: Users can upload app user roles through a CSV file. This allows for batch processing of multiple roles, streamlining the integration process.
- **Preview Uploadable Roles**: Before committing the roles to the system, users can preview the roles contained in the CSV file. This ensures that the correct roles are being uploaded and minimizes errors.
- **Trigger Role Creation**: Once the roles are uploaded and reviewed, users can trigger the creation of these roles for the app. This is an initial setup process, but roles can be subsequently updated through the app change process if necessary.
- **Delete Uploaded Roles**: If a role is no longer needed or was uploaded in error or incorrectly, users have the option to delete previously uploaded roles.

##### Visual Guide

The image below provides a visual representation of the role upload during the technical integration process.

<p align="center">
<img width="500" alt="File Upload Successful" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/technical-integration-file-upload-successful.png">
</p>

<br>
<br>

#### Technical User Roles

As a second function of the app offering process, the 'Technical Integration' feature allows app providers to define a technical user profile. This profile specifies the technical requirements and credentials necessary for the app to interface directly with centralized hosted services on behalf of the customer.

##### Purpose of the Technical User Profile
A technical user profile is essential for apps that require access to centralized services such as wallets, the BPDM (Business Partner Data Management) pool, registries, and other critical infrastructure components. The profile ensures that the app can operate within the technical and security parameters set by these services.

##### Marketplace Visibility and Customer Decision-Making
The technical user profile is made visible to customers within the app offering on the marketplace. This transparency allows customers to:

- Review the technical requirements of the app.
- Assess compatibility with their own company's security guidelines.
- Make an informed decision on whether to subscribe to the app offering based on the technical user profile provided.

##### Visual Reference
Below is the image of the 'Technical Integration' screen, where app providers can configure and showcase the technical user profile for their app offering.

<br>

<p align="center">
<img width="500" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/technical-integration-file-upload-successful.png">
<img width="832" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/technical-integration-screen.png">
</p>

App providers are encouraged to ensure that the technical user profile accurately reflects the technical requirements and complies with the necessary security standards. For additional information or assistance, app providers should consult the technical documentation or reach out to the support team.

<br>
<br>

Expand Down

0 comments on commit 97befa6

Please sign in to comment.