Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-32304

Design story - Admin console principles

    XMLWordPrintable

    Details

    • Type: User story
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Admin Center

      Description

      This is a design story that details a sample job to be done.
      Expected output: high fidelity mockup of a first flow of the admin console. Should be linked to this ticket and if possible attached so that it's kept for future reference.

      Overall flow is shown in the screenshot attached in this ticket, I recommend keeping it handy as it shows the corresponding wireframes:
      NXP-32248

      ______________________________

      Sample task
      As a system administrator, I want to reindex the content of a folder in Elasticsearch and monitor the action's progress.

      Flow
      I try to access the URL for the admin console (e.g., mynuxeoserver.com/nuxeo/nuxeoadmin)
      The URL is protected: I am taken to the standard Nuxeo authentication form (this is already existing, nothing new to do here)
      Once I authenticate, I am redirected to the admin console
      If I do not have access to the admin console, I see an error message (e.g., error 401) and the UI does not load

      => See NXP-32249 https://doc.nuxeo.com/rest-api/1/management-endpoint/#authentication , only administrators and dedicated technical users can use the corresponding API endpoints and will be granted access.

      Provided that I have access to this console:

      The UI loads.
      A confirmation message is presented full screen (see https://jira.nuxeo.com/browse/NXP-32250). I can't proceed further until I confirm.

      After confirming, I get to a homepage where I see:

      • A menu on the left that lists options (see NXP-32255)
      • A homepage that contains some basic but important information (see NXP-32251)

      TIP: when something is mentioned in [brackets] you can find the relevant ticket by adapting this query with the relevant keyword by , e.g. if you see [PROBES-SUMMARY] you can find it by using this: https://jira.nuxeo.com/browse/NXP-32254?jql=text%20~%20%22PROBES-SUMMARY%22%20AND%20%22Epic%20Link%22%20%3D%20NXP-32248

      I click on the "Elasticsearch reindex" option in the menu on the left.

      A new page is loaded. It shows 3 tabs to reindex a document, a folder, from a query (see NXP-32255 NXP-32260 NXP-32261 NXP-32262)

      By default I am on the option to reindex a single document.

      I click on the "Folder" tab to get the form to reindex a folder.

      The form is loaded.

      I enter the parameter and submit (see NXP-32261). Note: there is no client side validation in this specific example, but it will be needed in other cases like NXP-32260.

      I am requested for confirmation because the action could impact a lot of documents (see NXP-32275 NXP-32276). I can cancel or confirm.

      I confirm: request is sent.

      Request can fail on the server side (e.g., I provided a document ID that does not exist). The error is displayed and I can go back to the form, keeping my parameters in the process (maybe it was a typo, don't want to re enter everything).

      I fix my typo, submit. Request is successfully executed. Great. Server returns a command id.

      I see a confirmation that my request is processed (see NXP-32261), and:

      • I can click on a button to go back: takes me back to the form, parameters are reset
      • I can click on a button to monitor that specific action: I am taken to a page where I see the status of my command, see NXP-32284

      If I navigate away from the status of my command:
      I need to remember the command id, navigate to the appropriate menu entry (see NXP-32283), enter the command id and submit to see where it stands. Yes, this is made on purpose in version 1 to keep the scope minimal.

      Other options will use a similar pattern:

      • choose menu entry
      • choose tab
      • enter parameters
      • submit
      • possibly, be asked for confirmation
      • display result and offer to monitor the action

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              bchauvin Bertrand Chauvin
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: