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

Enhancement of Technical User E2E Experience in Dataspace #789

Open
8 tasks
jjeroch opened this issue Jul 13, 2024 · 2 comments
Open
8 tasks

Enhancement of Technical User E2E Experience in Dataspace #789

jjeroch opened this issue Jul 13, 2024 · 2 comments
Assignees
Labels
portal Feature/Bug for Portal component Prep-R24.12
Milestone

Comments

@jjeroch
Copy link

jjeroch commented Jul 13, 2024

Summary:

This epic aims to significantly improve the end-to-end experience for technical users in the dataspace environment. It encompasses the expansion of the current API to include additional technical user information, UI enhancements for better information sharing, and the introduction of a central service for consistent user management.

Objectives:

  1. API Enhancement: Expand the GET technical user information API to include the type of technical user (synchronous/asynchronous) and the associated service endpoint.
  2. UI Enhancements: Upgrade the User Interface to display the new technical user type and service endpoint information during the technical user creation process and on the technical user detail page.
  3. Naming Convention Review: Analyze and, if necessary, revise the portal table naming convention for external technical users, which is currently labeled "DIM".
  4. Central Service Introduction: Develop and integrate a central service that will provide comprehensive details about technical user management, similar to the existing KITS (Knowledge Information Tracking System).

User Stories:

User Story 1: API Expansion for Technical User Information

Description:
As an API Developer, I need to enhance the GET technical user information API to include the technical user type and service endpoint so that this information can be programmatically retrieved and utilized in various systems.

Acceptance Criteria:

  • The API should return whether the technical user is synchronous or asynchronous.
  • The API should provide the service endpoint associated with the technical user.
  • The API changes must maintain backward compatibility with existing integrations.

User Story 2: UI Enhancement for Technical User Creation

Description:
As a Frontend Developer, I need to update the technical user self-service creation UI to include fields for technical user type and service endpoint so that operators can specify and view this information during user setup.

Acceptance Criteria:

User Story 3: UI Enhancement for Technical User Detail Page

Description:
As a Frontend Developer, I need to enhance the technical user detail page to display the new technical user type and service endpoint information for better transparency and user experience.

Acceptance Criteria:

  • The detail page should clearly display whether the technical user is synchronous or asynchronous.
  • The detail page should show the associated service endpoint.
  • The UI should handle scenarios where this new information is not available for existing technical users.
  • The UI should inform the enduser about the technical user status details.

User Story 4: Portal Table Naming Review for External Technical Users

Description:
Review and possibly rename the portal table for external technical users to ensure clarity and consistency across the platform.

Acceptance Criteria:

  • The naming should be intuitive and self-explanatory.
  • Any changes in naming should be communicated and documented.
  • The change should be reflected across all instances in the platform where it is used.

User Story 5: Central Service Introduction for Technical User Management (Documentation)

Description:
Introduce a central service that provides detailed information about technical user management to streamline the process and make it consistent across the portal.

Acceptance Criteria:

  • The service should act as a single source of truth for technical user management details.
  • The service must integrate seamlessly with the existing portal UI.
  • Documentation for the central service should be available and accessible via the portal UI.

Tasks:

  • Define the API contract for the new technical user information.
  • Implement the API changes and ensure backward compatibility.
  • Design the UI changes for the technical user creation and detail pages.
  • Develop the UI enhancements and integrate them with the backend services.
  • Conduct a comprehensive review of the naming convention for external technical users.
  • Develop and document the central service for technical user management.
  • Perform thorough testing for all new features and changes.
  • Prepare and execute a deployment plan.

Out of Scope:

  • Overhauling the entire technical user management system is out of scope for this epic.
  • Any changes to unrelated systems or features not mentioned in the user stories.

Milestones:

  1. API and Backend Development Completion: tbd
  2. UI Design and Development Completion: tbd
  3. Central Service and Documentation Completion: tbd
  4. PR Creation for review by committers: tbd
  5. Full Integration and Testing Completion: tbd
@jjeroch jjeroch added the portal Feature/Bug for Portal component label Jul 13, 2024
@jjeroch jjeroch self-assigned this Jul 13, 2024
@MaximilianHauer MaximilianHauer self-assigned this Jul 30, 2024
@evegufy
Copy link
Contributor

evegufy commented Jul 31, 2024

Committers:
@evegufy
@Phil91
@ntruchsess
@oyo

@stephanbcbauer stephanbcbauer added this to the 24.12 milestone Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
portal Feature/Bug for Portal component Prep-R24.12
Projects
Status: IN PROGRESS
Status: Work in progress
Development

No branches or pull requests

4 participants