CDR Tickets

Issue Number 3976
Summary [Summaries] Summary Metadata Report Options
Created 2015-09-23 18:04:42
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2015-11-12 12:04:59
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.170746
Description

We would like to add the ability to customize the output of the summary metadata report to include certain components of the summary metadata. We can discuss the best solution for this, but one potential solution could be to add a list such as the one below with checkboxes beside each item. Anything checked would be included in the report. Whichever solution we come up with will need to include the new NLM elements (Editorial Board, Summary Abstract, and Summary Keywords).

CDR ID
Summary Title
Board
Editorial Board
Audience
Language
Description
Pretty URL
Topics
Purpose Text
Section Metadata
Summary Abstract
Summary Keywords

Comment entered 2015-11-11 11:26:00 by Kline, Bob (NIH/NCI) [C]

Something like this for the form?

(Just in case you were thinking about requesting that we condense the form by custom alignment of the check boxes in a table-like grid: I'd prefer to avoid hand-crafted HTML if possible, because by using the classes we've built for generating forms and reports we lower our chances of introducing security vulnerabilities into the web pages.)

Any preferences on which check boxes are checked by default?

Comment entered 2015-11-12 12:04:59 by Kline, Bob (NIH/NCI) [C]

Enhancement implemented on DEV.

Comment entered 2016-03-08 15:59:35 by Juthe, Robin (NIH/NCI) [E]

Hi Bob, there are two Boards listed for most of the summaries - the Advisory Board and the Editorial Board. (The Ed. Board is listed again in the Ed. Board element because this is provided to NLM as the author of the summary.) However, this report is only displaying one of the Boards (seems to be the Advisory Board, maybe because it comes first alphabetically?). Could you please display all associated Boards and change the option from "Board" to "Board(s)"?

As for the defaults, I think what you have chosen is fine once we make this change to display all Boards. Thanks!

Comment entered 2016-03-10 10:03:29 by Kline, Bob (NIH/NCI) [C]

I put together the options page using your list of displayable fields as specified in the original request. Two of those fields were "Board" and "Editorial Board." The only logical interpretation of "Board" I could come up with, given that "Editorial Board" was the other of these two, was the advisory board. If you check both, you'll get both boards. Did you have something else in mind for these two options? Might it be less confusing to make both options explicit ("Editorial Board" and "Advisory Board")?

Comment entered 2016-03-10 13:33:31 by Juthe, Robin (NIH/NCI) [E]

We decided in the status meeting to include both "Board(s)" and "Editorial Board (for NLM)" in the list of available options for this report.

Comment entered 2016-03-11 12:01:07 by Kline, Bob (NIH/NCI) [C]

I did some digging back into OCECDR-3885, and unless I'm misunderstanding something, the SummaryEditorialBoard element is injected by the publishing filters programmatically; in other words, this value is not maintained separately by hand from the multiply-occurring PDQBoard elements which are children of the SummaryMetaData block, as we thought in yesterday's status meeting. If my current understanding is correct, it would seem superfluous to have a separate field in the report for this new element, and my question would be: do you want the report to keep the separate check boxes for the two boards (possibly renaming "Board" to "Advisory Board"), or do you still want to collapse that into a single check box, and drop the ability to control which boards get displayed? If I've missed something in my picture of how we've implemented OCECDR-3885, please help me find where we're storing the separately-maintained board name.

Comment entered 2016-03-11 18:09:07 by Juthe, Robin (NIH/NCI) [E]

Thanks for digging this up, Bob. Sorry for misremembering that. I think our original plan was to add a new element (as I wrote in the description of that issue) but wiser minds prevailed (no surprise there!). 🙂

I think we should keep the separate check boxes and rename "Board(s)" to "Advisory Board" as you suggest.

Comment entered 2016-03-12 11:45:29 by Kline, Bob (NIH/NCI) [C]

Column name changed as requested (on DEV).

Comment entered 2016-03-14 12:11:43 by Juthe, Robin (NIH/NCI) [E]

This looks good, but could you please select "Editorial Board" as a default option as well, now that we've decided to separate the two Boards? Thanks.

Comment entered 2016-03-14 12:16:09 by Kline, Bob (NIH/NCI) [C]

Done.

Comment entered 2016-03-14 12:22:27 by Juthe, Robin (NIH/NCI) [E]

Thanks. That looks good, although I just noticed that the Advisory Board column heading on the report output says Editorial Board.

Comment entered 2016-03-14 14:24:37 by Kline, Bob (NIH/NCI) [C]

Fixed.

Comment entered 2016-03-14 14:29:02 by Juthe, Robin (NIH/NCI) [E]

Thanks, verified on DEV.

Comment entered 2016-04-01 14:04:36 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

Comment entered 2016-05-23 16:35:12 by Juthe, Robin (NIH/NCI) [E]

Verified on PROD.

Attachments
File Name Posted User
summary-metadata-report-form.jpg 2015-11-11 11:17:31 Kline, Bob (NIH/NCI) [C]

Elapsed: 0:00:00.001684