CDR Tickets

Issue Number 4285
Summary [Summaries] Summaries DLM Report - Options for Modules, Blocked, Unpublished Summaries
Created 2017-07-13 15:49:11
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2017-10-19 13:56:43
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.211416
Description

We would like to add options to the report interface to specify whether to include modules, blocked, and unpublished summaries (e.g., temporary or in-progress docs). By default, none of these documents should be included on this report.

Comment entered 2017-09-11 17:31:52 by Kline, Bob (NIH/NCI) [C]

Ready for user testing on DEV. This report is another one with a complicated set of logic, so please check carefully to make sure it does exactly what you want.

https://github.com/NCIOCPL/cdr-admin/commit/5732052ce03837da1f328124602b359599e88e65

Comment entered 2017-09-22 10:26:31 by Juthe, Robin (NIH/NCI) [E]

As discussed yesterday, we've noticed a number of issues with this report:

1. It appears the CDR ID column is empty whenever we run the report directly from XMetaL (in other words, the report runs in IE.) When I run the report in another browser, such as chrome, the IDs display.
2. Please have the report display anything that has "Available As Module=Yes" as an attribute when the Include Modules option is selected.
3. Please add "[module]" after the title of any modules included on the report.
4. Could the default date range be adjusted to today's date as the end date and one week prior to today's date as the start date? (, please let us know if this poses a problem for CIAT.)
5. The checkboxes for the new options to include modules, blocked summaries, and unpublished summaries do not line up with other checkboxes on the report interface.
6. I'm not sure what "CCB Report" stands for on the Sheet tab in Excel. Could we change this to "DLM Report"?
7. Lastly, I'm seeing a couple of modules on the report when I run it for Cancer Genetics with a date range of 1/1/12 to today and the Include Modules option is NOT selected. Since we're changing the way modules get included on this report from using the ModuleOnly attribute to using the AvailableAsModule attribute, this point is probably moot but I'll want to retest this exact scenario again to be sure we're OK.

Thanks!

Comment entered 2017-09-22 10:27:23 by Juthe, Robin (NIH/NCI) [E]

Adding Margaret and William to the issue.

Comment entered 2017-09-22 12:24:08 by Kline, Bob (NIH/NCI) [C]

Go ahead and push this ticket back into the sprint's "To Do" column when you're ready for me to start working on these changes.

Comment entered 2017-09-22 14:57:08 by Kline, Bob (NIH/NCI) [C]

4. Could the default date range be adjusted ....

I'm working through the changes, and I've got most of them taken care of (saving the invisible column mystery for last). I'm about to change the default date, and it's easy to do, but before I make the change I wanted to make sure it's what you really want. The code looked very carefully crafted to apply some very specific logic, which made me think the way the form works now was the result of a deliberate decision, and not some random bug, so I went back to figure out why we had done it the way we did it. This is what I found (in OCECDR-2353):

Margaret:
We talked about this the other day, ....

Just to capture in writing the rest of what I remember of our discussions: I believe I agreed that I would:

  1. Use Javascript to ....

  2. Use Javascript to ....

  3. Use the calendar widget ....

  4. Seed the form with dates for the "Date Last Modified (User)" fields to represent the previous week (Saturday through Friday). The cutoff for switching to the week just ending will be 6:00 p.m. Friday.

Please advise if any of this doesn't match your recollection of what we said.

So please let me know if you'd still like me to make this change to the default date range, or if the comment above jogs your memory and you decide to keep the current default dates.

Comment entered 2017-09-22 15:18:10 by Kline, Bob (NIH/NCI) [C]
  1. It appears the CDR ID column is empty whenever we run the report directly from XMetaL (in other words, the report runs in IE.)

Here's what I think is happening when you run the report from Internet Explorer. Since IE is deeply rooted in the operating system, it is able to tell Excel to open the report in a "protected" mode, which prevents the functions from running. The cells in the first column contain the =HYPERLINK() function (the first argument is the URL, and the second argument is the display value). You can see this in the value window if you walk your cursor with the arrow keys to one of these cells (rather than clicking on it with your mouse). You should be presented with a button that lets you get out of this "protected" view and see the values:

I'm not sure why Microsoft thought showing you the display values in protected mode was risky, but does this solve the problem?

Comment entered 2017-09-22 16:17:56 by Kline, Bob (NIH/NCI) [C]

7. Lastly, I'm seeing a couple of modules on the report ....

Currently, the Lynch Syndrome and Breast Cancer Risk and Peutz-Jeghers syndrome (PJS) summaries are included on the report. Both of them are flagged as available for use as modules, but they are both published (at least on DEV) as standalone summaries. Please confirm that you want both of these excluded from the report if the Modules option is not selected (in other words, if a document can be used as a module, it must be considered to be a module in the context of this report's logic, even if it is used as a non-module).

Comment entered 2017-09-22 16:35:01 by Kline, Bob (NIH/NCI) [C]

6. I'm not sure what "CCB Report" stands for ....

Best I could come with is that when the CDR project started back in the late 90's, the name of Michael Arluk's shop (for which we worked) was "Computer Communications Branch," commonly referred to as "CCB." I have no idea if this is the genesis for that name on the report's tab (or if so, why). :-) In any case, the tab's name is now "DLM Report" as requested.

Comment entered 2017-09-22 17:27:23 by Kline, Bob (NIH/NCI) [C]

5. The checkboxes for the new options ... do not line up ....

Fixed.

Comment entered 2017-09-22 17:28:43 by Kline, Bob (NIH/NCI) [C]

3. Please add "[module]" ...

Added.

Comment entered 2017-09-22 17:31:32 by Kline, Bob (NIH/NCI) [C]

2. ... display anything that has "Available As Module=Yes" when the Include Modules option is selected.

Done.

Comment entered 2017-09-25 14:39:59 by Osei-Poku, William (NIH/NCI) [C]

4. Could the default date range be adjusted to today's date as the end date and one week prior to today's date as the start date? (Osei-Poku, William (NIH/NCI) [C], please let us know if this poses a problem for CIAT.)

This is request is fine with CIAT. It will not pose any problems.

Comment entered 2017-09-26 07:30:32 by Kline, Bob (NIH/NCI) [C]
Comment entered 2017-10-05 13:19:54 by Juthe, Robin (NIH/NCI) [E]

Yes, I think this is OK. Just wanted to add that it is also hiding the values in the system date column when we run the report for the system DLM. Clicking "Enable editing" displays the data for that column as well.

Comment entered 2017-10-05 13:23:33 by Juthe, Robin (NIH/NCI) [E]

Bob, could you please adjust the date range to today's date as the end date and one week prior to today's date as the start date? Margaret and I reviewed the comment above but we would still like to make this change. Thanks.

Comment entered 2017-10-05 15:27:25 by Juthe, Robin (NIH/NCI) [E]

Verified on DEV.

Comment entered 2017-10-26 12:15:57 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

Comment entered 2017-10-27 13:04:19 by Osei-Poku, William (NIH/NCI) [C]

It is probably too late now but I did run two instances of this report on QA this afternoon. One with Include Module only selected and the other one with all three Include options selected. The other options selected are HP under Audience and All under English summaries, and a date range from 9/1/2017 to 9/30/2017 HP summaries . I expected to see all modules including (779396 which is a module - not the only module excluded) in the first file (Include Modules) but it is was not included. It was only included when All the three include options are selected. Unless I am doing something wrong, it does appear that not all documents marked as available for Module are included in the results.

Comment entered 2017-10-30 07:02:53 by Kline, Bob (NIH/NCI) [C]

The refresh of QA from PROD wiped out the indexing of the @AvailableAsModule attribute. I have reindexed it and you should get the expected results again.

Comment entered 2017-10-30 21:06:35 by Osei-Poku, William (NIH/NCI) [C]

Thank you! The results are as expected now.

Comment entered 2018-01-29 11:49:51 by Juthe, Robin (NIH/NCI) [E]

Verified on PROD.

Attachments
File Name Posted User
screenshot-1.png 2017-09-22 15:16:20 Kline, Bob (NIH/NCI) [C]

Elapsed: 0:00:00.001388