Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-8180

UX for History cleanup functionality

    Details

    • Title Keywords:
      UX history cleanup

      Description

      History Cleanup Functionality

      As a user, I should be able to:

      Stage 1

      • See the time until the next scheduled cleanup job run (use relative date?)
      • See the current status of the cleanup job [ healthy | broken/has incidents | running ]
      • Trigger an immediate cleanup job run (deactivate when currently running?)
      • A manually triggered run can be stopped, we'll look into stopping batch runs later.
      • In case of incident, show the incident’s error message and link to logfile (open in new window/tab), and give option to resolve the incident.

      Stage 2

      • See a of process definition versions, each consisting of the following data:Number of
      • Process definition name (link to process definition)
      • Process definition version (more then one version can exist at a time)
      • Time to live as configured for this process definition version (editable via input[type=number])
      • Number of finished jobs for this process definition version
      • Number of jobs that will be cleaned with next cleanup job run (= number of finished jobs w/ time to live expired)

      Stage 3

      • See current cleanup job efficiency / efificiency history (this could go to dashboard as well) TBD
      • See Cleanup Incident history (Discuss details with Svetlana re data to show that makes sense and that we have etc.) TBD

        Issue Links

          Activity

          Hide
          franz.heidl Franz Heidl added a comment - - edited

          Roman Smirnov, please add which exact data set should be shown for all the types of entities in the previous comment.

          Show
          franz.heidl Franz Heidl added a comment - - edited Roman Smirnov , please add which exact data set should be shown for all the types of entities in the previous comment.
          Hide
          franz.heidl Franz Heidl added a comment -

          For now, we can use tabs to show the lists of cleanable items for each of the above categories (Since these lists can have up to 50 items per page, there's no point in stacking the lists/tables on top of each other).

          I will come up with something like an overview to put on top (overall number of finished items, overall number of ceanable items)

          Show
          franz.heidl Franz Heidl added a comment - For now, we can use tabs to show the lists of cleanable items for each of the above categories (Since these lists can have up to 50 items per page, there's no point in stacking the lists/tables on top of each other). I will come up with something like an overview to put on top (overall number of finished items, overall number of ceanable items)
          Hide
          franz.heidl Franz Heidl added a comment - - edited

          OK, according to the docs Roman linked above, we will have the following columns for each table:

          Process Definitions
          Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable

          Case Definitions
          Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable

          Decision Definitions
          Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable

          Batch Operations
          Type | History Time to Live | Finished | Cleanable

          History Time to Live should be editable (input[type=number] with a label stating clearly that it is time in days, select[minutes, seconds, hours, days, weeks -> We need to clarify what should go here, when editing Time to live in info panel there's no input possible (only a number), only once you have entered a number and confirmed you'll see that it's days. This needs improvement!)

          No matter with what we come up here, we should align the input in info panel to work the same way/accept the same input.

          Show
          franz.heidl Franz Heidl added a comment - - edited OK, according to the docs Roman linked above, we will have the following columns for each table: Process Definitions Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable Case Definitions Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable Decision Definitions Name (fall back to key if no name given) | Version | History Time to Live | Finished | Cleanable Batch Operations Type | History Time to Live | Finished | Cleanable History Time to Live should be editable (input [type=number] with a label stating clearly that it is time in days, select[minutes, seconds, hours, days, weeks -> We need to clarify what should go here, when editing Time to live in info panel there's no input possible (only a number), only once you have entered a number and confirmed you'll see that it's days. This needs improvement! ) No matter with what we come up here, we should align the input in info panel to work the same way/accept the same input.
          Hide
          franz.heidl Franz Heidl added a comment - - edited

          Update Wireframe:

          Table for cleanable items: remove select for timeframe (hours, days, weeks, etc.). Time to live will always be persisted in days. An input of different timespans would be convenient, but the user would expect his input to always appear onte page the exact same way he made it:

          2 weeks -> 2 weeks

          BUT we would not persist the original input, hence he would see:

          2 weeks -> 14 days once he comes back to the page, and this is confusing.

          So we only allow the input of days and label the input accordingly.

          Show
          franz.heidl Franz Heidl added a comment - - edited Update Wireframe: Table for cleanable items: remove select for timeframe (hours, days, weeks, etc.). Time to live will always be persisted in days. An input of different timespans would be convenient, but the user would expect his input to always appear onte page the exact same way he made it: 2 weeks -> 2 weeks BUT we would not persist the original input, hence he would see: 2 weeks -> 14 days once he comes back to the page, and this is confusing. So we only allow the input of days and label the input accordingly.
          Hide
          franz.heidl Franz Heidl added a comment - - edited

          Updated list of Columns for Batch Operations, removed "Name" – batch operations don’t have a name!

          Show
          franz.heidl Franz Heidl added a comment - - edited Updated list of Columns for Batch Operations, removed "Name" – batch operations don’t have a name!

            People

            • Assignee:
              smirnov Roman Smirnov
              Reporter:
              franz.heidl Franz Heidl
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development