Uploaded image for project: 'Nuxeo Admin Console'
  1. Nuxeo Admin Console
  2. NAC-24

Admin console - single doc reindex

    XMLWordPrintable

    Details

    • Type: User story
    • Status: Resolved
    • Priority: Critical
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 23.0.0
    • Component/s: Admin Console

      Description

      As a system administrator, I can reindex a single document
      [REINDEX-SINGLEDOC]

      Context:
      ES endpoint https://doc.nuxeo.com/rest-api/1/elasticsearch-endpoint/

      Typical support request when a document can't be found anymore. Happens in case a job failed somewhere or some elasticsearch configuration was updated, very low risk given the volume.

      AC
      Within the elasticsearch reindex menu entry
      An option is provided to reindex a single document:

      Tab name: "Document"
      Title: "Reindex a single document"

      Parameters:

      • Document ID or Path
        • Placeholder: Document ID or Path [Should display a message "* indicates a required field"]
          An id or a path should be provided, otherwise an error message is displayed
          "Please provide a document id or a document path"

      Errors are handled so that when a problem is detected:

      • The error message coming back from the server is displayed. Sample errors that could happen:
        • Document id or path does not exist
        • Error returned by the server 
        • An error dialogue should appear with following format:
          • 'Your action was not executed due to an internal error'
          • Status: status code received from the server (like 404, 500)
          • Details' Detail message received from the server
          • And a "Close" button
      • I can go back to the form and parameters are kept so that I can fix any mistake easily and try again

      When a valid id or path is provided:

      • Reindex button selected
      • Request is sent
      • No confirmation is required to send the action.
      • "Action Launched" confirmation is displayed with the outcome, e.g. "Congratulations! Your action is launched with ID 3c55ecfb-3ea8-477a-b07c-0cc5c7e7a88e. Remember to take a note of the ID if you want  to monitor the action later on."
        • A "Copy Action ID" button should display to help user to copy the action ID for future reference and a "Close" button to close the "Action Launched" dialogue. 
        • Once "Copy Action ID" selected this should trigger a a javascript alert with a message "Action ID copied to clipboard!" and button "Ok" to cancel the alert.
      • Then verify this action passing this ID "3c55ecfb-3ea8-477a-b07c-0cc5c7e7a88e" as URL param via this bulk endpoint [_*envURL/api/v1/management/bulk/<action-id>*_] in order to check the status. [_**This step is just for testing purpose**_]
        • state - completed
      • A "Go back" action allows me to go launch another request.[_*This point is discontinued from current scope*_]
      • Fields have been reset so that I don't launch the same request twice by accident.

        Attachments

        1. reindex-tabs.png
          510 kB
          Swarnadipa Choudhury

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 3 days, 3 hours Original Estimate - 3 days, 3 hours
                  3d 3h
                  Remaining:
                  Time Spent - 1 week, 1 day Remaining Estimate - 1 day, 1 hour
                  1d 1h
                  Logged:
                  Time Spent - 1 week, 1 day Remaining Estimate - 1 day, 1 hour
                  1w 1d