CDR Tickets

Issue Number 4483
Summary [Summaries] Display of Comment Attributes in XMetaL
Created 2018-05-25 15:37:22
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2018-06-14 17:37:42
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.226722
Description

We would like to make it easier to identify which comments have been assigned certain attributes (e.g., internal, external, Advisory Board, and permanent) without having to click within the comment element and view the attribute inspector.

One possible solution we discussed is to display text within the comment field indicating which of these attributes have been assigned. This text should only appear in XMetaL, and not be displayed in the QC reports.

For internal comments, please add "(Internal)" at the end of the comment string.
For external comments, please add "(External)" at the end of the comment string.
For AB comments, please add "AB-Comment:" at the beginning of the comment element (as is done in the QC reports).
For permanent comments, please add "Permanent-Comment:" at the beginning of the comment element (as is done in the QC reports)

Thank you!

Comment entered 2018-06-08 13:51:44 by Englisch, Volker (NIH/NCI) [C]

For internal comments, please add "(Internal)" at the end of the comment string.
For external comments, please add "(External)" at the end of the comment string.

There exist comments without either the Internal or External audience specified. How would you like these to be displayed? Options are empty parenthesis "()" or nothing at all.

Comment entered 2018-06-08 13:53:49 by Englisch, Volker (NIH/NCI) [C]

For AB comments, please add "AB-Comment:" at the beginning of the comment element (as is done in the QC reports).
For permanent comments, please add "Permanent-Comment:" at the beginning of the comment element

Permanent and advisory-board comments aren't exclusive and you could have comments that are both, permanent as well as advisory-board comments. What type of string would you like to display in this situation?

Comment entered 2018-06-08 13:54:16 by Juthe, Robin (NIH/NCI) [E]

Let's go with nothing at all for those comments. There should be a relatively small number of them given that the insert comment macro includes an internal attribute by default.

Comment entered 2018-06-08 13:55:37 by Juthe, Robin (NIH/NCI) [E]

I think this would be an edge case 🙂, but let's go with "Permanent-AB-Comment:" for these comments.

Comment entered 2018-06-08 14:17:35 by Englisch, Volker (NIH/NCI) [C]

Are we making the same changes for the ResponseToComment elements or can we assume a response to a Permanent-AB-Comment would be a Permanent-AB-Response itself?

Comment entered 2018-06-08 14:19:02 by Englisch, Volker (NIH/NCI) [C]

The CSS changes for the Comment element are ready on DEV.

Comment entered 2018-06-08 18:50:59 by Englisch, Volker (NIH/NCI) [C]

The CSS for the in-line comments has been adjusted as requested. Please let me know if we also want to make changes to the ResponseToComment elements.
The following file has been modified:

  • Summary.css

Local repository: [ising 1dd1408]

Comment entered 2018-06-13 15:53:44 by Juthe, Robin (NIH/NCI) [E]

Sorry, just catching up on JIRA comments - yes, please make the same changes to the ResponseToComment elements. We can't really make that assumption since each comment/response has its own set of attributes and we're using this display of the attributes in XMetaL to make sure we've assigned them appropriately. Thanks.

Comment entered 2018-06-14 17:37:23 by Englisch, Volker (NIH/NCI) [C]

I made the additional changes to the ResponseToComment element as well:

  • Summary.css

https://github.com/NCIOCPL/cdr-client/commit/73e374

Comment entered 2018-06-21 15:03:05 by Juthe, Robin (NIH/NCI) [E]

This looks good on DEV. Thanks!

Comment entered 2018-07-18 15:36:37 by Beckwith, Margaret (NIH/NCI) [E]

QA verified.

Comment entered 2018-08-09 14:40:06 by Englisch, Volker (NIH/NCI) [C]

Comment attributes are now displayed on PROD.
Closing ticket.

Elapsed: 0:00:00.001479