CDR Tickets

Issue Number 3278
Summary [Summary] Modification to Summaries Comments Report to Show/Hide Certain Comments
Created 2010-12-08 15:42:30
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2011-02-14 14:23:05
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107606
Description

BZISSUE::4968
BZDATETIME::2010-12-08 15:42:30
BZCREATOR::Robin Juthe
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

Now that we have additional attributes available for comments (Duration=Permanent and Source=Advisory Board - see issue 4940), we would like to modify the interface for the summaries comments report in order to have the option to display or hide comments of either type.

This could be accomplished by adding two more checkboxes below the menu titled, “Type of comments to display”. These options could be:

  • Permanent comments (P)

  • Advisory Board comments (A)

This adds another layer of complexity since all comments are also either internal or external, and there are already checkboxes to display comments with either audience. As an example, an Internal and Permanent comment should only display if the checkboxes for BOTH "Interal comments" and "Permanent comments" are selected.

Comment entered 2011-01-24 11:52:38 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-01-24 11:52:38
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1

(In reply to comment #0)
> As an example, an Internal and Permanent comment should only
> display if the checkboxes for BOTH "Interal comments" and "Permanent comments"
> are selected.

Is the intention to use the options for this report in the same way as it's implemented currently for the OCECDR-3277 (Display comments in QC reports)?
There we are displaying internal and permanent comments only if both options are checked (as is requested in the bug description) but we are not displaying all internal comments if only the internal option is checked. If we're going that route of replicating what we had done in OCECDR-3277 we would be changing the functionality of the current report.

Comment entered 2011-01-27 17:27:06 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-01-27 17:27:06
BZCOMMENTOR::Robin Juthe
BZCOMMENT::2

(In reply to comment #1)
> Is the intention to use the options for this report in the same way as it's
> implemented currently for the OCECDR-3277 (Display comments in QC reports)?
> There we are displaying internal and permanent comments only if both options
> are checked (as is requested in the bug description) but we are not
> displaying all internal comments if only the internal option is checked. If
> we're going that route of replicating what we had done in OCECDR-3277 we would be
> changing the functionality of the current report.

In a nutshell, yes...

The main idea is that we want to have the ability to exclude permanent comments from this report. So, I think we're up against the same set of options of "internal (no permanent)" and "all permanent" as we have for the QC reports.

Comment entered 2011-01-31 13:02:13 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-01-31 13:02:13
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

Should we add the same set of options as for the QC reports and only option 1+2 or 3+4 can be selected at the same time?
[ ] I - Internal Comments (excluding permanent comments)
[ ] P - Permanent Comments (internal & external)

[ ] E - External Comments (excluding advisory comments)
[ ] A - Advisory Comments (internal & external)

[ ] All Comments
[ ] R - Response to Comments

Should the selection of "All Comments" include the option of "Response to Comments"?

Comment entered 2011-02-02 13:56:47 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-02-02 13:56:47
BZCOMMENTOR::Volker Englisch
BZCOMMENT::4

I've talked with Robin regarding my last comment and the report is now ready for testing. In terms of the options available we are now using the same functionality as we have implemented for the Comments display of the QC reports. We are using two groups of two options:
Group A) Internal Comments (excluding permanent)
Permanent Comments
Group B) External Comments (excluding advisory)
Advisory Comments
Within each group one of the options or both options together can be selected. If an option in Group A is selected while an option in Group B is changed all options in Group A will be cleared and vice versa.
The option for 'All Comments' either selects or clears all of the options from Group A and B.
The option for 'Response to Comments' acts independently. When checked the responses are included in the report or excluded otherwise.

When testing please make sure to test all three display options:

  • Summaries by Board

  • Summary by ID

  • Summary by Title
    since each of these could potentially modify the selected options for the comment types to be displayed.

The program modified is
SummaryComments.py

My test document on MAHLER is 'Genetics of Skin Cancer' (CDR552637)

This is ready for review on MAHLER.

Comment entered 2011-02-10 17:05:20 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-02-10 17:05:20
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5

I have copied the program to FRANCK for testing while MAHLER is unavailable. I didn't copy a test document though.

Comment entered 2011-02-11 17:48:51 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-02-11 17:48:51
BZCOMMENTOR::Robin Juthe
BZCOMMENT::6

Tested on Franck. I tested by Board (using Pediatric), by CDR ID (using 299612) and by summary title (Childhood Brain Stem Glioma & Genetics of Prostate Cancer), selecting various options for the display. All worked well!!

Changing status to verified. Please promote these changes to Bach when feasible (not sure if we need Mahler back first?).

Thanks!

Comment entered 2011-02-14 14:06:38 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-02-14 14:06:38
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7

The following program has been copied to FRANCK and BACH:
SummaryComments.py - R10031

Please verify on BACH and close this bug.

Comment entered 2011-02-14 14:23:05 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2011-02-14 14:23:05
BZCOMMENTOR::Robin Juthe
BZCOMMENT::8

Verified on BACH. Closing issue. Thanks!

Elapsed: 0:00:00.001478