Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sig#796: Application Status Endpoint Update to Reflect Feature Toggle Impact #948

Closed
Tracked by #796
jjeroch opened this issue Jul 21, 2024 · 5 comments
Closed
Tracked by #796
Assignees
Labels
enhancement New feature or request

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Jul 21, 2024

DRAFT ticket, details to be added as soon as backend is available

Description:

In alignment with the backend changes introduced in issue #837, this ticket is to ensure that the frontend application properly interprets and displays the updated application status information. The backend has implemented a feature toggle that enables or disables Clearinghouse connectivity for Self-Description (SD) processes. Consequently, the application status endpoints' output may now vary depending on the toggle's state. The frontend must accurately represent these changes to the users.

Objectives:

  • Adapt the frontend to correctly interpret the new application status responses from the backend.
  • Update the application status UI to show when steps are skipped or marked as not applicable due to the feature toggle's state.
  • Ensure that the reasons for any skipped steps are clearly displayed to the user for transparency and to support audit requirements.

Acceptance Criteria:

  • Endpoint Interpretation: Update the frontend to correctly understand and process the modified GET application status endpoint responses.
  • UI Representation: Modify the application status UI to clearly indicate steps that are "n/a" (not applicable) when the clearinghouse connectivity is disabled by the feature toggle.
  • Transparency and Auditability: Display an informational comment or note next to each skipped step in the application status UI, providing users with the rationale for the skipped steps. (information to be handed over by the backend endpoint)
  • Documentation: Update the frontend documentation to describe the changes in the application status representation and the handling of feature toggle-related status changes.

Implementation Steps:

  1. Conduct a preliminary analysis to determine the necessary UI changes based on the new application status endpoint outputs.
  2. Implement the UI changes in the frontend application, ensuring compatibility with the backend updates.
  3. Add frontend logic to parse and display comments or notes explaining why certain steps are skipped or marked as not applicable.
  4. Test the updated UI with various scenarios, including both enabled and disabled states of the feature toggle.
  5. Update all relevant frontend documentation to reflect the new features and changes.

Linked Backend Ticket:

@MaximilianHauer
Copy link

% calculation would need to be adjusted - note skipped should be handled as done

@MaximilianHauer MaximilianHauer moved this from NEW USER REQUEST to BACKLOG in Portal Aug 19, 2024
@MaximilianHauer
Copy link

MaximilianHauer commented Aug 19, 2024

For this story the following screen/pages need to be adjusted.

New Status in the registration view

Due to the implementation of a new status for the self description step we need to be able to show the status skipped
that is provided via the endpoint GET: /api/administration/registration/applications/{applicationId}/checklistDetails

image

furthermore the text of the SELF_DESCRIPTION_LP needs to be enhanced by another status info

src/assets/locales/**en**/main.json

 "SKIPPED": {
          "title": "No action needed from your side",
          "description": "The self-description creation was skipped on purpose. This process will be retriggered by the CX Operator as soon as possible."
        },

/assets/locales/**de**/main.json

 "SKIPPED": {
          "title": "No action needed from your side",
          "description": "Die Erstellung der Selbstbeschreibung wurde absichtlich übersprungen. Dieser Prozess wird vom CX-Operator so bald wie möglich wieder ausgelöst."
        },

Acceptance criteria

  • button with the label "skipped" should be clearly visible on the self-description step of the registration flow.
  • the color of the button should be grey in the same design as the other buttons
  • the color of the background of the "self description should be grey
  • The documentation is adjusted properly as soon as the status is skipped in the self description step

Connector SD Checkbox should be empty if connector status is skipped

as the connector in future can be created without a sd document the checkbox needs to be adjusted to represent the missing document.
GET: /api/administration/connectors field selfDescriptionDocumentId should be empty

image

Furthermore the tooltip should be replaced by

ENG: The SD Document is not yet loaded. This could be due to the deactivation of the Sd Factory. This process will be retriggered as soon as possible by the CX Admin
DE: Das SD-Dokument ist noch nicht geladen. Dies könnte auf die Deaktivierung der SD-Fabrik zurückzuführen sein. Dieser Prozess wird so bald wie möglich vom CX-Administrator neu ausgelöst.

Acceptance criteria

  • If the status of the SD factory during the connector creation is skipped it should show the checkbox as empty

Infotext should reflect the information that the SD factory is currently skipped

Progress-Circle should reflect the new status skipped as white

the new status for the self description should show white in the circle if this stepp was skipped.
image

Acceptance criteria

  • If the self description status is skipped the circle should show the step as white

@MaximilianHauer
Copy link

added tooltip description

@MaximilianHauer
Copy link

@lavanya-bmw regarding this adjustment
image

the count should display 7/7 but the background color should not be green and the titel should be "partially completed"

@MaximilianHauer
Copy link

approved.

@github-project-automation github-project-automation bot moved this from IN REVIEW to USER READY in Portal Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

3 participants