CDR Tickets

Issue Number 3575
Summary [Summaries] Identifying Modules in Summary Reports
Created 2013-01-03 14:18:07
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2013-08-08 10:55:10
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107903
Description

BZISSUE::5273
BZDATETIME::2013-01-03 14:18:07
BZCREATOR::Robin Juthe
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

A number of our summary reports now include modules. While this is OK and even preferable in most cases, we think it would be helpful to add "(Module Only)" after the document title if the document has the attribute ("Module Only = Yes") so that it can be easily identified as a non-standalone summary when the reports are generated.

The affected reports are listed below:

Summaries Lists
Summaries Comments
Summaries Comprehensive Review Date
Summaries Markup
Summaries TOC Lists
PDQ Board Members and Topics

I'm not sure whether each report will need to be modified or whether you will be able to change the presentation of the module document title in one place and have it trickle down to the report display. If each report needs to be modified separately, please begin with the Summaries Lists report since Margaret uses that to tally the number of summaries (she will subtract modules from her total) and then we should talk about the level of effort required for the other reports and prioritize accordingly. Thanks!

Comment entered 2013-01-03 20:29:55 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2013-01-03 20:29:55
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1

Would you like the title of the summary to be modified to add the 'Module Only' text string or just the report display?

We could modify the 'DocTitle for Summary' filter that automatically creates and updates the document title but I will have to check first if these titles are actually displayed in the reports or if they are coming from a different place (i.e. the query_term table).

Comment entered 2013-01-31 11:34:54 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2013-01-31 11:34:54
BZCOMMENTOR::Robin Juthe
BZCOMMENT::2

Now that we have completed the DocTitle filter changes in OCECDR-3579 I went back and checked each of the reports listed in comment 1 to see if this changed the display of the summary titles. Unfortunately, the "(module)" did not appear after the summary titles of modules in any of these reports, so it seems more work needs to be done to add the parenthetical note after the document title in these reports.

Comment entered 2013-02-01 15:05:57 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2013-02-01 15:05:57
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

Reports Completed:
[X] Summaries Lists
[X] Summaries Comments
[X] Summaries Comprehensive Review Date
[X] Summaries Markup
[ ] Summaries TOC Lists
[ ] PDQ Board Members and Topics

Comment entered 2013-02-01 15:14:55 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2013-02-01 15:14:55
BZCOMMENTOR::Robin Juthe
BZCOMMENT::4

(In reply to comment #3)
> Reports Completed:
> [X] Summaries Lists
> [X] Summaries Comments
> [X] Summaries Comprehensive Review Date
> [X] Summaries Markup
> [ ] Summaries TOC Lists
> [ ] PDQ Board Members and Topics

Which server?

Comment entered 2013-02-21 12:50:57 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2013-02-21 12:50:57
BZCOMMENTOR::Robin Juthe
BZCOMMENT::5

(In reply to comment #3)
> Reports Completed:
> [X] Summaries Lists
> [X] Summaries Comments
> [X] Summaries Comprehensive Review Date
> [X] Summaries Markup

Verified these reports on Mahler.

Comment entered 2013-02-22 14:31:19 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2013-02-22 14:31:19
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6

The following reports have been updated on FRANCK and BACH:
[X] Summaries Lists
Updated 'SummariesLists.py' to R11419
[X] Summaries Comments
Updated 'SummaryComments.py' to R11419
[X] Summaries Comprehensive Review Date
Updated 'SummaryCRD.py' to R11419
[X] Summaries Markup
Updated 'SummariesWithMarkup.py' to R11419

[ ] Summaries TOC Lists
[ ] PDQ Board Members and Topics

Comment entered 2013-05-09 18:06:01 by Juthe, Robin (NIH/NCI) [E]

BZDATETIME::2013-05-09 18:06:01
BZCOMMENTOR::Robin Juthe
BZCOMMENT::7

Revising priority after the discussion in today's CDR meeting.

Comment entered 2013-06-11 14:36:37 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2013-06-11 14:36:37
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

[X] Summaries TOC Lists

The TOC report works a little differently that the others. Here the data doesn't get directly extracted by a SQL query. Instead, the output of a filter gets appended for each summary to produce the final report.

I've modified the filter
CDR000160 - Summaries TOC Report
I'm hoping it's OK to display the string '(Module only)' even if the report is run for a single summary.

This report is ready for review on MAHLER.

Comment entered 2013-06-11 17:28:05 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2013-06-11 17:28:05
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9

[X] PDQ Board Members and Topics

The report has bee updated by modifying the program
PdqBoards.py

It is ready for review on MAHLER.

Comment entered 2013-07-11 16:19:21 by Juthe, Robin (NIH/NCI) [E]

I just verified the Summaries TOC Report and the PDQ Board Members and Topics Report on MAHLER. Both now display (Module Only) after summary modules.

Comment entered 2013-08-08 10:55:10 by chengep

Just doing some administrative tasks on this issue. It was already fixed, but I had to reopen it so that I could assign it to patch release 3.0.1. I am reclosing the issue now.

Comment entered 2013-08-08 19:20:43 by Englisch, Volker (NIH/NCI) [C]

#$@%^&!!! JIRA ate my comment. This issue is not complete yet but it's too late for me to retype the comment I just lost.

Comment entered 2013-08-12 15:34:54 by Englisch, Volker (NIH/NCI) [C]

This issue had been completed and reviewed on the OCE-MAHLER system. However, the changes had never been versioned in subversion and therefore got lost when we moved to the CBIIT environment.
I was able to retrieve the changes from my backups and move them to DEV but it's probably a good idea to take a quick look again before we're calling this issue verified. The two documents that needed to be installed from backup were:

  • R11940 : PdqBoards.py

  • R11939 : CDR000160 (Summaries Toc Report)

Comment entered 2013-08-21 17:35:37 by Juthe, Robin (NIH/NCI) [E]

I verified the following reports on DEV:

Reports Verified:
[X] Summaries Lists - this displays "(Module)" after the title.
[X] Summaries Comments - this displays "(Module)" after the title.
[X] Summaries Comprehensive Review Date - this displays "(Module)" after the title.
[X] Summaries Markup - this displays "(Module)" after the title.
[X] Summaries TOC Lists - *this displays "(Module Only)" after the title.*

***We should probably remove the word "Only" in the parenthetical note in the Summaries TOC report to be consistent with the others...

[ ] PDQ Board Members and Topics

The PDQ Board Members and Topics report did not display "(Module)" after the module summaries.

Comment entered 2013-08-26 18:05:20 by Englisch, Volker (NIH/NCI) [C]

I removed the "only" from the Summaries TOC Lists report:

  • R11972 : CDR000160 (Summaries Toc Report)

Comment entered 2013-08-26 18:29:14 by Englisch, Volker (NIH/NCI) [C]

> The PDQ Board Members and Topics report did not display "(Module)"
> after the module summaries.

Sorry for that. I must have forgotten to copy the modified script to the CGI directory. I've done that now. Please take another look.

Comment entered 2013-08-27 11:10:23 by Juthe, Robin (NIH/NCI) [E]

Verified changes to Summaries TOC report and PDQ Board Members and Topics on DEV.

Comment entered 2013-08-29 12:31:04 by Juthe, Robin (NIH/NCI) [E]

Verified in production.

Elapsed: 0:00:00.001414