sig#810: Enhancement of Company Data Management UI: Integration of Extended Error Handling for Sharing State

[jjeroch]

Ticket Title:

Enhancement of Company Data Management UI: Integration of Extended Error Handling for Sharing State

---

Description:

We are aiming to improve the user experience of the Company Data Management interface by introducing a more comprehensive error handling mechanism. The enhancement involves integrating the GET /v6/sharing-state endpoint to the current UI workflow. This new feature will enable the UI to display whether the processing of company data that are in a "PENDING" state is still in progress or if there has been an error during the processing. The error detection will be facilitated by checking for specific response body attributes provided by the endpoint.

---

Acceptance Criteria:

1. Endpoint Integration: Incorporate the GET /v6/sharing-state endpoint into the Company Data Management UI logic.
2. Error Handling Logic: Implement logic to detect and handle errors based on the response body attributes: "sharingStateType", "sharingErrorCode", and "sharingErrorMessage".
3. UI Feedback: Update the UI to provide feedback to the user when company data is in a "PENDING" state and to show appropriate error messages if the "SharingProcessError" is identified.
4. Retry Mechanism: Include a retry mechanism or guidance for the user to rectify the error if possible.
5. Logging: Ensure that all error states and the associated error messages are logged for further investigation and audit purposes.
6. Documentation: Update the technical documentation to reflect the new changes and error handling procedures.
7. Testing: Develop unit tests and integration tests to validate the new functionality and error handling logic.

---

Technical Implementation Details:

• Call the GET /v6/sharing-state endpoint for company data with the "PENDING" status.
• Parse the response body for the attributes: "sharingStateType", "sharingErrorCode", and "sharingErrorMessage".
• Develop a new UI component or modify existing components to display the sharing state and error information.
• Implement a service layer to encapsulate the logic for error detection and handling.
• Design a user-friendly error message display, possibly with tooltips or a dedicated error information section.

---

Dependencies:

• Ensure the backend service for the GET /v6/sharing-state endpoint is fully operational and accessible.

---

Impact Assessment:

• The enhancement may require a brief downtime or maintenance window if the changes affect critical functionality.
• User training or communication may be necessary to inform about the new error handling features.

---

Rollout Plan:

1. Develop and test the new features in a development environment.
2. Perform code reviews and iterate based on feedback.
3. Deploy to a staging environment for integration testing.
4. Conduct user acceptance testing (UAT) with a select group of users.
5. Plan and execute the deployment to production with appropriate change management processes.
6. Monitor the feature post-release for any unforeseen issues.

---

Please proceed with the implementation following the above specifications. Let's enhance our user experience and improve the robustness of our

[jjeroch]

In the scenario of an Error, the Status "Error" (in red) is supposed to get displayed, NOT "Pending". Additionally we need an solution to display the error well. to be identified how we might do this. First, frontend logic, afterwards design ;)

[manojava-gk]

Initial design to show Error in listing page and in the detail page. @jjeroch @MaximilianHauer

[manojava-gk]

@jjeroch @MaximilianHauer created a new site from portal successfully

[MaximilianHauer]

@manojava-gk

error message

i assume we should limit the errormessage only to show the message part and not everything

table header

please add the following table header

[manojava-gk]

@manojava-gk

error message

i assume we should limit the errormessage only to show the message part and not everything

table header

please add the following table header

As discussed, error message is coming from sharing-states api response. It is not handled from portal side.

Table header is updated