[Performance] View process velocity in a custom time range

• Type: Story
• Status: Closed
• Priority: Minor
• Resolution: Completed
• Affects Version/s: None
• Fix Version/s: 7.1.X, 7.2.X
• Component/s: Workflow
• Labels:
  • dxp-7.2-sp1
  • fc_19_07
  • fw_test_needed
  • liferay-dxp-72-sp1
  • liferay-fixpack-dxp-2-7210
• Branch Version/s:
  7.2.x, 7.1.x
• Backported to Branch:
  Committed
• Epic Link: Workflow Performance Metrics for SP-1
• Sprint: Workflow_7.2_SP1_02, Workflow_7.2_SP1_03, Workflow_7.2_SP1_04, Workflow_7.2_SP1_05

As an Operation Manager, I want to see the metrics of my process in a customizable time range, so that I can configure my workflow report to show exacly the data that I need to attend my business needs.

Context

Custom time range
Today our Workflow Analytics only allows users to chose fixed time frame option (today, yesterday, last 30 days, etc.). Those time frames are quite useful to make analysis on current or recent scenarios. However, some of our customer needs are based on evaluate and/or compare with the past, or even make specific analysis involving periods that are not exactly neither of the ones that we offer in our current version of the product.

To address those use cases, we need to allow the user to choose the time frame that he wants to see for those metrics and address his business needs.

Acceptance Criteria

• Given a process with several completed instances, when the user accesses the Performance tab of the Workflow Metrics, then the system should allow the user to choose the date of start and date of end to be considered for the velocity analysis of that process.

• Given a process with several completed instances, when the user chooses a custom time range for the Velocity metrics in the Workflow Analytics, then the system should calculate and display for the user the velocity/throughput of the process in that time frame given.

• Given a process with several completed instances, when the user chooses a custom time range for the Velocity metrics in the Workflow Analytics, then the system should plot and display a chart with the velocity/throughput of the process along that time frame given.

• The option to define a custom range should be included at the all time range filters;
• Consider the first hour of the starting day as 00:00 and the last hour of the ending day to be 23:59 of that day;
• When selecting a custom time range, the options from the velocity unit filter should be available according to the range size;
• At the custom range form, when one of the fields are left empty, the system should automatically fill in with the last selected date;
• At the custom range form, in case the user selects a future date, the system should automatically set the date to the current day;
• At the custom range form, the oldest date accepted is 1970;
• When opening the custom range form, the start and end dates should reflect the current selected period;
  • If an older date is typed, the system should display the appropriate error message;
• At the custom range form, consider MM/DD/YYYY as the default date format for english-US;
  • The date format should update according to the system translation/localization set up;
• The card help text should inform the system date format;
• The card help text should update according to the system translation/localization set up;
• At the chart, when a custom time range is selected, the granularity and velocity unit options will update accordingly depending on the time range size, as described bellow;

Time period rules 

• From 0 to 1 day:
  • Displayed in hours, 2 to 24 points, 2 to 6 labels (in hours, eg.: 12 AM);
• From 2 to 7 days:
  • Displayed in days, 2 to 7 points, 2 to 7 labels (in days);
• From 8 to 30 days:
  • Displayed in days, 8 to 30 points, 2 to 6 labels (in days);

• From 31 to 90 days:
  • Displayed in weeks, 4 to 14 points, 4 to 8 labels (day ranges per week, eg: 9-15 Jun or 28 Jun - 3 Aug);
• From 91 to 180 days:
  • Displayed in months, 3 to 7 points, 3 to 7 labels (in months);
• From 181 to 365 days:
  • Displayed in months, 7 to 13 points, 7 to 8 labels (in months);
• From 366 days to 2 years:
  • Displayed in months, 13 to 24 points, 7 to 8 labels (in months);
• Greater than 2 years:
  • Displayed in years, 2 to n points, 2 to 8 labels (in years);

Definitions of Done

• Related tests created and passed successfully;
• All Acceptance Criteria were passed;
• Make sure that all system documentation were updated (if necessary);
• Validated by QA, Product Designer and/or PM;
• No critical issue related to Story scope (ex.: similar of a FP4, FP5 bug);
• Code with peer review completed.

Design Deliverables

• Mockup: https://www.figma.com/file/vX43hkfVMVwsw8xsA7J4vU/02-custom-time-range?node-id=530%3A11278
• Popover: https://www.figma.com/file/vX43hkfVMVwsw8xsA7J4vU/02-custom-time-range?node-id=367%3A589