### User Story

**As** an OpenProject user
**I want** to be able to see, in the list and the Gantt chart views, an overview of changes that have been made compared to a specific date in the past
**so that** I better understand the status and progress of my project.

### Extend the data model and the API to save and query historic values of work packages

* Extend the data model
* Extend the API
* It is possible to filter on historic values, e.g.
* All work packages that have been in status "scheduled" on 2022-01-01
* All work packages that were assigned to version 12.1 and all work packages that have been added or removed since a specific date.

`Note: The largest uncertainty when planning and estimating this feature comes from the performance requirements. We need to ensure that this feature also works for large organizations that have large data sets with a high number of concurrent requests.`

## Extend work package filters to request historic values from the API

* Extend the view to allow users to query a date (in the past)
* A specific date and hour:
* **\[open\]** What granurality, reconfirm with devs.
* We might have to directly display a date/hour picker as a modal.
* ~~B: A relative date, e.g:~~
* ~~24 hours~~
* ~~1 week~~
* ~~1 month~~
* Rebuild work package queries to allow requesting a list of relevant work packages, including the changes.

Begin of the insertion<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52535/content">End of the insertion Begin of the deletion <figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/27111/content"></div></figure>End of the deletion

## Extend the work packages list view to display changes

* Changes to the following work package core attributes are highlighted in a diff view.
* Status
* Assignee
* Accountable
* Project
* Start date
* Finish date
* Type
* Priority
* Subject
* Version
* Work packages that were added or removed within the specified time period, ie, between the comparison date and today, are highlighted (e.g. deliverables that were added to the project scope or features that were removed from a release).
* List the number of attributes that have been changed in that time period. This number also includes changes to the work package description, the details of which which are not shown in the list view.

Begin of the insertion## Front-end changes

End of the insertion <figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" Begin of the insertionsrc="/api/v3/attachments/52534/content"></div></figure>End of the insertion Begin of the deletion src="/api/v3/attachments/31714/content"></div></figure>End of the deletion

Begin of the insertion#### **Toolbar icon:**

* Add a new dropdown button withEnd of the insertion Begin of the deletion ## ExtendEnd of the deletion the Begin of the insertionlabel &quot;Changes&quot;
* With left icon &quot;baseline&quot; (new)
* Right icon (up/down, similar to the Create or Table/GANTT/Cards buttons)
* Clicking on this button triggers a drop modal, with this structure:
* A selector field with label &quot;Show changes&quot; and a switch to the right.
* This is off by default, and all the other fields in the modal are also disabled until this switch is enabled.
* A short text (Body Small/Regular, Grey 2): &quot;View changes made to work packages in the currentEnd of the insertion Begin of the deletion GanttEnd of the deletion view Begin of the insertionbetween within a time period.&quot;
* A form item with label &quot;Changes since&quot; and a dropdown with these options:
* yesterday (default)
* last working day
* last week
* last month
* a specific date
* between two specific dates
* A form item with label &quot;Time&quot; and an HTML input (type time),
* format &quot;hh:mm&quot;
* Input text by default is the current local time
* \[open\] The bottom text is the user timezone, eg. &quot;CET (UTC +1)&quot;
* Action bar (grey background)
* with one button &quot;Apply&quot; (primary, no icons)
* this button disabled by default and only enabled if there are changesEnd of the insertion to Begin of the deletion displayEnd of the deletion the Begin of the insertionmodal

#### **Modal behaviour**

* The &quot;Show changes&quot; switch on top enables the show changes/baseline mode (see below for how it affects table view)
* Disabling this existsEnd of the insertion changes Begin of the insertionmode and disables all fields in the modal (except the action bar), but preserves entered valuesEnd of the insertion

Begin of the insertion<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52539/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52537/content">

End of the insertion * Begin of the insertionThese options do not inherently change the structure of the modal and set the comparison time to:
* yesterday (default, currentEnd of the insertion Begin of the deletion Start and/or finishEnd of the deletion date Begin of the insertion- 1 day)
* last working day (current date - n days, where n is non-working days)
* last week (current date - 7 days)
* last month (same day and year but current month - 1)
* These options do change the structure of the modal:
* a specific date
* between two specific dates
* Option &quot;a specific date&quot; adds:
* a &quot;Date&quot; fieldEnd of the insertion Begin of the deletion was movedEnd of the deletion to the Begin of the insertionleft of the &quot;Time&quot; form field (50% width each) with:
* Standard date picker date field, with a &#39;Today&#39; link underneath
* a mini calendar underneath
* with current month open by default
* clicking on any day changes the value of the &quot;Date&quot; field
* non-working days are displayed but enabled/clickableEnd of the insertion Begin of the deletion past.End of the deletion
* Begin of the insertionOption &quot;between two specific dates&quot; replaces the &quot;Time&quot; field with a rangeEnd of the insertion Begin of the deletion Start and/or finishEnd of the deletion date Begin of the insertionpicker:
* There are two sets of Date/time fields, with labels &quot;From&quot; and &quot;To&quot;
* The first field is a standard date picker date field, with a &#39;Today&#39; link underneath
* The time field is the same as described earlier but without the &quot;Time&quot; label
* Below each set of Date/field field is a mini-calendar that looks and works the same as a work package range date picker:
* two months showing (current and next month)
* a previous button (left arrow)End of the insertion Begin of the deletion was movedEnd of the deletion to the Begin of the insertionleft of the first mini calendar&#39;s Month/year line
End of the insertion Begin of the deletion future.
End of the deletion * Begin of the insertiona next button (right arrow) to the right of the second mini calendar&#39;s Month/year line
* non-working days are displayed but enabled/clickable
* Either theEnd of the insertion Begin of the deletion Start and/or finishEnd of the deletion date Begin of the insertionfield in &quot;From&quot; or &quot;To&quot; can be _active_, and this affects which date field is affect when the user clicks on a day in mini calendars

<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52547/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52548/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52549/content">

<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52538/content">

#### **Show changes mode indicator**

When the &quot;Show changes&quot; mode is enabled:

<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52540/content">

* There is show changes mode indicator underneath the toolbar: a rectangular area with stroke (Grey 4, 1 px), with 0.75 rem top/bottom margin and 1 rem left/right margin.
* On the left edge, the text: &quot;Changes since {date} {time}&quot;
* On the right edge, legends:
* add icon (Feedback/Success/Dark, 16px), with label &quot;Now meets filter criteria ({number of work packages concerned})&quot;
* minus1 icon (Basic/Grey 1, 16px), with label &quot;No longer meets filter criteria ({number of work packages concerned})&quot;
* arrow-left-right icon (Feedback/Info/Dark, 16px), with label &quot;Maintained with changes  ({number of work packages concerned})&quot;

#### **Work package table list**

When the &quot;Show changes&quot; mode is enabled:

<figure class="image op-uc-figure"><div class="op-uc-figure--content"><img class="op-uc-image" src="/api/v3/attachments/52541/content"></div></figure>

* A new column isEnd of the insertion Begin of the deletion wasEnd of the deletion added Begin of the insertionto the work package table view:
* The header is the baseline icon
* The column can have one of four values:
* blank: when there are no changes in the comparison period
* the green add icon: when the work package has been added to the view in the comparison period
* the grey minus1 icon: when the work package has been removed from the view in the comparison period
* or arrow-left-right icon: when the work package is maintained in the view in the comparison period, but modifications were made
* On hover of these icons, a tooltip is displayed with these text values:
* addition: &quot;Added to view within the comparison time period&quot;
* removal: &quot;Removed from view within the comparison time period&quot;
* modification: &quot;Modified within the comparison time period&quot;End of the insertion
* Begin of the insertionFor modifications to values of columns visible in the table (amongst attributes that are tracked by this feature)
* The value is now displayed in two lines:
* Line 1: the original value is displayed in Caption/Regular, Grey 3, with strikethrough
* this is true of all kinds of values, including type, status and assignee
* Line 2: the new value in Body Small/Bold, Grey 1, with these particularities:
* new type and new status are displayed in their normal style
* assignee is displayed with the mini avatar, but in a smaller 20 × 20px instead of the regular 24 × 24 pxEnd of the insertion Begin of the deletion Start and/or finish date was removed.End of the deletion

Begin of the insertion#### **Mobile view**

In the mobile view of the work package table list:

End of the insertion <figure class="image op-uc-figure" Begin of the insertionstyle="width:320px;"><divEnd of the insertion Begin of the deletion style="width:75%;"><divEnd of the deletion class="op-uc-figure--content"><img class="op-uc-image" Begin of the insertionsrc="/api/v3/attachments/52542/content"></div></figure>End of the insertion Begin of the deletion src="/api/v3/attachments/27113/content"></div></figure>End of the deletion

Begin of the insertion* the &quot;Changes&quot; button in the toolbar is not visible
* it is hidden behind the more icon
* the Show changes mode indicator _is_ visible when active but
* the legends are not shown
* the &quot;Changes since {date} {time}&quot; line is centred
* cards are displayed as described below

#### **Cards view**

<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52545/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52543/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52544/content">

* In the work package cards view, changes are indicated with icons described above but that are:
* displayed to the right of the status
* this is true for desktop as well as mobile views

#### **Work package table configuration**

In the work package table configuration modal:

<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/52546/content">

* There is a new tab titled &quot;Show changes&quot;
* This tab has the same settings as the the Show changes modal

End of the insertion ## Begin of the insertion~~Notes (no longer relevant, archived 14.03.2023)~~End of the insertion Begin of the deletion NoteEnd of the deletion

* Begin of the insertion~~BetterEnd of the insertion Begin of the deletion BetterEnd of the deletion display currently selected comparison Begin of the insertiondate.~~End of the insertion Begin of the deletion date.End of the deletion
* Begin of the insertion~~ShowEnd of the insertion Begin of the deletion ShowEnd of the deletion the date also in the button? Begin of the insertion(Baseline:~~ _~~24 hours~~_~~)~~End of the insertion Begin of the deletion (Baseline: _24 hours_)End of the deletion
* Begin of the insertion~~EnablingEnd of the insertion Begin of the deletion EnablingEnd of the deletion baseline will never &quot;filter&quot; work packages out; on the contrary, it can show new ones (that met the current filter criteria in the Begin of the insertionpast).~~End of the insertion Begin of the deletion past).End of the deletion
* Begin of the insertion_~~**\[toEnd of the insertion Begin of the deletion _**\[toEnd of the deletion be discussed\]** Baseline takes into account filter criteria, and then shows differences in the context of those Begin of the insertionfilters:~~_End of the insertion Begin of the deletion filters:_End of the deletion
* Begin of the insertion_~~&quot;Additions&quot;End of the insertion Begin of the deletion _&quot;Additions&quot;End of the deletion == work packages that did not meet the criteria in the baseline past but now Begin of the insertiondo~~_End of the insertion Begin of the deletion do_End of the deletion
* Begin of the insertion_~~&quot;Removals&quot;End of the insertion Begin of the deletion _&quot;Removals&quot;End of the deletion == work packages that now do not meet the filter criteria but did in the Begin of the insertionpast~~_End of the insertion Begin of the deletion past_End of the deletion
* Begin of the insertion~~**NOTE:End of the insertion Begin of the deletion **NOTE:End of the deletion This behaviour doesn&#39;t make sense as this is what is exactly what the baseline does by itself; showing what was in the past meeting the filter criteria and now don&#39;t and the other way around while addition and removal of work packages are the complete work package creation or Begin of the insertiondeletion.**~~End of the insertion Begin of the deletion deletion.**End of the deletion
* Begin of the insertion_~~**\[toEnd of the insertion Begin of the deletion _**\[toEnd of the deletion be discussed\]** Show only work packages that are additions or removals (based on my Begin of the insertioncriteria).~~_End of the insertion Begin of the deletion criteria)._End of the deletion
* Begin of the insertion_~~&quot;NewEnd of the insertion Begin of the deletion _&quot;NewEnd of the deletion bugs newly added to the version within the last Begin of the insertionweek&quot;~~_End of the insertion Begin of the deletion week&quot;_End of the deletion
* Begin of the insertion_~~Baseline,End of the insertion Begin of the deletion _Baseline,End of the deletion version added as a Begin of the insertionfilter.~~_End of the insertion Begin of the deletion filter._End of the deletion
* Begin of the insertion_~~Option:End of the insertion Begin of the deletion _Option:End of the deletion only show additions, or Begin of the insertionremovals.~~_End of the insertion Begin of the deletion removals._End of the deletion
* Begin of the insertion~~**NOTE:End of the insertion Begin of the deletion **NOTE:End of the deletion Again, this behaviour doesn&#39;t make sense as this is what is exactly what the baseline does by Begin of the insertionitself.**~~End of the insertion Begin of the deletion itself.**End of the deletion
* Begin of the insertion~~AndEnd of the insertion Begin of the deletion AndEnd of the deletion filtering a view with baseline enabled will show work packages that meet the criteria in the Begin of the insertionpresent~~ _~~and~~_ ~~inEnd of the insertion Begin of the deletion present _and_ inEnd of the deletion the Begin of the insertionpast.~~End of the insertion Begin of the deletion past.End of the deletion
* Begin of the insertion~~**\[open\]**End of the insertion Begin of the deletion **\[open\]**End of the deletion Changing the value of the present might &quot;hide&quot; the intermediate value (so that it now shows the past and Begin of the insertionthe~~ _~~new~~_ ~~present).~~End of the insertion Begin of the deletion the _new_ present).End of the deletion
* Begin of the insertion~~NeedEnd of the insertion Begin of the deletion NeedEnd of the deletion to review choice of colours: why red, green, Begin of the insertionorange?~~End of the insertion Begin of the deletion orange?End of the deletion
* Begin of the insertion~~WeEnd of the insertion Begin of the deletion WeEnd of the deletion might potentially need new icons: new, changed and Begin of the insertionremoved.~~End of the insertion Begin of the deletion removed.End of the deletion
* Begin of the insertion~~**\[open\]**End of the insertion Begin of the deletion **\[open\]**End of the deletion Currently, it&#39;s possible to highlight rows based on Begin of the insertionattributes:~~End of the insertion Begin of the deletion attributes:End of the deletion
* Begin of the insertion~~WhatEnd of the insertion Begin of the deletion WhatEnd of the deletion do we do? Remove this feature or make it a choice between Baseline highlighting and Begin of the insertionthis.~~End of the insertion Begin of the deletion this.End of the deletion
* Begin of the insertion~~Add:~~End of the insertion Begin of the deletion Add:End of the deletion
* Begin of the insertion~~SubjectEnd of the insertion Begin of the deletion SubjectEnd of the deletion has been Begin of the insertionchanged:~~End of the insertion Begin of the deletion changed:End of the deletion
* ~~&quot;Buy beer&quot;~~
* Begin of the insertion~~&quot;Buy coffee&quot;~~End of the insertion Begin of the deletion &quot;Buy coffee&quot;End of the deletion
* Begin of the insertion~~CanEnd of the insertion Begin of the deletion CanEnd of the deletion we Begin of the insertiontrack~~ _~~all~~_ ~~attributesEnd of the insertion Begin of the deletion track _all_ attributesEnd of the deletion (including custom fields), or do we need a limited set of Begin of the insertionattributes?~~End of the insertion Begin of the deletion attributes?End of the deletion
* Begin of the insertion~~**\[open\]**End of the insertion Begin of the deletion **\[open\]**End of the deletion Ideally, all work package attributes are Begin of the insertiontracked.~~End of the insertion Begin of the deletion tracked.End of the deletion
* ~~If not, how do we indicate in a list view that something has changed? (Or if it&#39;s not tracked, how do we let the user know that this is not tracked)~~

## Begin of the insertionFigma linkEnd of the insertion Begin of the deletion VisualsEnd of the deletion

Begin of the deletion * Work package list view:
* Before baseline
* Set up baseline (modal)
* Illustrate status changes: eg. merged, tests (QA tester, show progress)
* Illustrate: date changes (what was delayed?)
* After baseline (showing different kinds of changes)
* GANTTEnd of the deletion View Begin of the insertionFigma mockups here: [https://www.figma.com/file/RkQ2T9f5yrXH3srz8SP8vv/Show-change-(Baseline---track-changes)?node-id=1164%3A38835&amp;t=el6jgjA9M9DyCM3x-1](https://www.figma.com/file/RkQ2T9f5yrXH3srz8SP8vv/Show-change-(Baseline---track-changes)?node-id=1164%3A38835&t=el6jgjA9M9DyCM3x-1)End of the insertion

## Out of scope for this epic

* Filter for only things that have been added/removed (red or green rows).
* Cannot filter to show only things that have been moved from status A to status B.
* Track changes of relations between work packages.
* Board view and team planner views. Begin of the insertion
* Extend the Gantt view to display the changes
* Start and/or finish date was moved to the past.
* Start and/or finish date was moved to the future.
* Start and/or finish date was added
* Start and/or finish date was removed.End of the insertion

## Figma link

https://www.figma.com/file/RkQ2T9f5yrXH3srz8SP8vv/?node-id=0%3A1