Track Changes - Merge : Send feedback - Implement send feedback action
SUMMARY
INITIAL NOTE
The context of the present ticket is common/shared between #1490 (closed), #1492 (closed), #1493 (closed), #1579, #1580 (closed), The differences between them lay on the scope and acceptance criteria's.
Context / scenario
The Lead DG is processing the contributions made by the Legal Service and want to provide feedback on their actions (for example, to justify why they are accepting partially an instruction from the Legal Service or why some points have been disregarded).
To achieve this, the Lead DG need to be able to create annotations within the contribution directly, i.e., on the Annotations instance located on the View and Merge section
On the current implementation, this pane only showcases the annotations present in the .leg of the legal service contribution and do not allow for annotations to be created. This is the first task to be tackled : Allow annotations to be created over the contribution, and this opens new challenges:
- The annotations need to be stored on the database, but marked as feedback to contribution annotations
- The annotations need to be associated with the specific contribution (.leg ID)
As soon as the first feedback annotations is created, the version card needs to be enriched with some UI feedback to notify the user that there is pending feedback to be sent to the Legal Service
On MouseOver of this icon, a tooltip would display an info like " Feedback exist for this contribution".Once the Lead DG will have finish their work in that contribution, they will notify Legal Service of these feedback. To that purpose a new action is added to the ribbon menu on top of the View and Merge section named "Send feedback"
The " Send feedback" action will first raise a confirmation dialog, then, if confirmed , it send a notification to the legal service through Notis (to the user who sent the contribution) to indicate feedback(s) comment exist.Legal service can check the feedback(comment annotation) using the Milestone Explorer on the contribution.
In case the legal service wants a rendition of the content with annotation (so it include the feedback comment) of it, they can use the "Export".
Content of the notification send with Notis:
Feedback has/have been provided by the Lead DG while processing the contribution received for the proposal %proposal title% in the %name of the part%.
You can see this feedback in your contribution content using "view contribution" on the contribution : %link%
%proposal title% : is the title of the proposal
%name of the part%: is the name of the part (like "Legal act" or "Annex II" or ....)
%link% : is the link to the contribution in the Milestone explorer
OR (if not doable)
the link to the proposal
On the sent contribution milestone of legal service, the Milestone explorer will show the lead dg feedback annotation within the text alongside the Legal service own annotation
SCOPE
- Show confirmation dialog box prior to triggering the backend action
- Implement "Send Feedback" Action, given that the button is enabled and feedback is pending to be sent
- LOGIC:
- Extract all feedback comments from DB (flagged) and convert them into JSON
- Remove all previously sent feedback already present on the SJ Contribution .leg file
- Insert the extracted feedback comments into the SJ Contribution .leg file
- LOGIC:
OTHER DESCRIPTIONS / DOCUMENTATION
ACCEPTANCE CRITERIAS / GOALS
PRE-CONDITIONS : Send Feedback action button is activated/de-activated according to core"1490
- A user can click on "Send feedback" action button
- Clicking on "Send Feedback" button triggers the showing to confirmation popup
- Clicking on "Cancel" closes the confirmation window with no action taken
- Clicking on "Ok" triggers the backend service call to send feedback
- Once action is preformed, SJ contribution milestone (.leg) contains all feedback comments in JSON format