CDR Tickets

Issue Number 4281
Summary [Summaries] Merged Summaries QC Report
Created 2017-06-16 11:31:48
Issue Type New Feature
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2020-01-02 14:00:26
Resolution Won't Fix
Path /home/bkline/backups/jira/ocecdr/issue.210147
Description

As part of the effort related to separating the Unusual Cancers summary into several summary modules (see OCECDR-4280), we would like to create a new QC report that will allow us to reassemble the summary into a single document that can be reviewed by Board members.

Comment entered 2017-06-20 12:29:28 by Englisch, Volker (NIH/NCI) [C]

Is the order in which the individual cancers are currently displayed to be kept or will we create a single document with the cancers sorted alphabetically or use some other sorting mechanism?

Comment entered 2017-06-20 13:03:12 by Juthe, Robin (NIH/NCI) [E]

I'm adding Sharon to this issue so she can comment. I don't know what the plans are for the sequence of the cancers.

Comment entered 2017-06-22 16:34:34 by Juthe, Robin (NIH/NCI) [E]

Just wanted to confirm that Sharon does want the summaries to appear in groups by body system (as they are now).

I think the idea of using an element in the document or something along those lines will be helpful for dictating the sequence/grouping of the content in the merged report. Ideally, we'll come up with a solution that is flexible enough that we can use it as we add more unusual cancer summaries and in other summaries, too.

Comment entered 2017-06-22 16:57:53 by Englisch, Volker (NIH/NCI) [C]

Ideally, we'll come up with a solution that is flexible enough that we can use it as we add more unusual cancer summaries and in other summaries, too.

One idea could be to create a summary document that would need to be marked as NotPublishable and then include the individual childhood summaries via a new ChildSummaryLink element, for instance, used just like SummaryModuleLink elements. It would allow us to still create an introduction for the combined summary report and maintain it in the CDR. The summary would only contain these ChildSummaryLinks along with the introduction.

Is it correct that the merged report will need to mimic the BU QC report or is the RS report needed as well?

Comment entered 2017-06-22 17:26:39 by Juthe, Robin (NIH/NCI) [E]

Ideally, we'd like to have the merged QC report work for both types of reports - B/U and RLSO. The most pressing need is for the RLSO version since that's what Sharon uses.

Comment entered 2017-06-22 17:37:35 by Englisch, Volker (NIH/NCI) [C]

I'm wondering why you would need the RLSO report. It's not used for the board members, I thought, and the editing of the documents would be done via the individual summaries.

I'm sure it's not a big deal either way but would add two buttons to the summary toolbar instead of one.

Comment entered 2017-06-22 17:42:54 by Juthe, Robin (NIH/NCI) [E]

I'm pretty sure Sharon does use the RLSO version for her Board members, possibly because it shows all deleted text.

Comment entered 2017-07-31 18:19:05 by Englisch, Volker (NIH/NCI) [C]

It appears that the SummarySection title, i.e. "Thyroid Tumors", has become the SummaryTitle element in the split summaries with the word "Childhood " added. If we're denormalizing the document as a module we're not including the SummaryTitle in the parent document and the section would start with a summary section called "Incidence".

We may not be able to create our QC report by assuming the unusual cancer summaries are regular module documents in order to include the SummaryTitle and modify the title.

Comment entered 2017-08-14 15:17:34 by Juthe, Robin (NIH/NCI) [E]

The shell summary doc solution seems to work well for Sharon's QC report needs, although we were wondering if it would be possible to add something to Sharon's macro (or a new macro) to delete the redundant "Special Considerations" section from each of the smaller summaries (this section isn't in the smaller summaries yet but it is something she plans to add). She said this section will have the exact same title for each summary so perhaps the macro could pick up on that as it does for the Changes Section?

Comment entered 2017-08-14 15:48:19 by Englisch, Volker (NIH/NCI) [C]

It should be possible to remove the Special Considerations section using a Word macro but it would likely be easier and less error-prone to eliminate a section using a filter. However, given the fact we now want to use the standard QC reports for the unusual cancers I'll have to think how to include a new filter that's not affecting any other reports.

Comment entered 2017-08-14 15:57:21 by Juthe, Robin (NIH/NCI) [E]

Just to clarify, I'm calling it the "Special Considerations" section, but I think the title is longer than that. Sharon will have to provide the complete title when we need it.

Comment entered 2017-08-17 14:45:23 by Juthe, Robin (NIH/NCI) [E]

We discussed the possibility of using a SectionType metadata for these "Special Considerations" sections and having an option on the QC report that would remove this section (through the filter) when selected.

Comment entered 2017-08-22 11:18:05 by Kline, Bob (NIH/NCI) [C]

Robin says that the existing QC report, combined with the shell document she has cobbled together, will meet most of their needs. However, it is likely that Sharon will also need a custom interface for this report which gives her the option of excluding a portion of the separate summaries. Story point estimate represents the work to implement this interface.

Comment entered 2017-08-22 11:26:27 by Juthe, Robin (NIH/NCI) [E]

Per my previous comment we had talked about using SectionType metadata and adding an option on the existing QC reports to remove this section. So, there will likely be a small schema change and a filter change with the addition of a checkbox on the QC report interface.

Comment entered 2017-08-24 17:33:48 by Juthe, Robin (NIH/NCI) [E]

I talked with Sharon and we came up with the following answers to the questions that came up in our meeting today:

1) Every "Special Considerations" section can be removed from the Unusual Cancers summary QC report. There's no need to preserve one instance of this section.

2) We would like the software to determine whether or not to display the "Special Considerations" section with the following logic: if it's a QC report of the module summary, please display it; if it's the QC report of the parent doc and the included modules have this section, do not display it. This means that we do NOT need a checkbox.

3) Please use the following value for the SectionType attribute: "Unusual Cancers Special Considerations". Hopefully, that isn't too long, but if it is, let us know. We could probably drop the word cancer if we need to.

You mentioned that this could be a release independent change if we don't need a checkbox, but I think we'll still need a release to get the schema change into production, right? If not, let me know and I'll move this to the release independent queue.

Thanks!

Comment entered 2017-09-18 18:56:33 by Englisch, Volker (NIH/NCI) [C]

Could you tell me the CDR-ID of the parent document on DEV or do I have to read through Bob's conversion task?

Comment entered 2017-09-19 09:09:02 by Juthe, Robin (NIH/NCI) [E]

CDR0000780676 - Unusual Cancers of Childhood - TEST SHELL DOC

Comment entered 2017-09-19 11:48:53 by Englisch, Volker (NIH/NCI) [C]

We would like the software to determine whether or not to display the "Special Considerations" section with the following logic: if it's a QC report of the module summary, please display it; if it's the QC report of the parent doc and the included modules have this section, do not display it.

In other words: Display a regular QC report unless it's the shell document.
In addition to removing the "Special Consideration" section from the text it has also been removed from the TOC. However, that portion of the filter changes only functions properly when that section is a top-level SummarySection.

The following documents have been updated.

  • SummaryCommon.xml (schema)

  • CDR339576.xml: Module: InLine Markup Formatter

For my information:
These changes are located in cdr-server (fermi)/index.

Comment entered 2017-09-19 11:51:47 by Englisch, Volker (NIH/NCI) [C]

I've updated CDR780672 and CDR780673 on DEV for testing.

This is ready for review on DEV.

Comment entered 2017-09-22 12:47:45 by Englisch, Volker (NIH/NCI) [C]

Changes have been versioned in git (fermi branch):

  • SummaryCommon.xml (1b75d4fb)

  • CDR339576.xml (1b75d4fb)

Comment entered 2017-09-22 13:02:21 by Englisch, Volker (NIH/NCI) [C]

, in case I get hit in the head by a tennis ball over the weekend and forget, this change has not yet been pushed to github. I'm waiting for the review on DEV before pushing it but want you to know that it's currently missing in the (test) build.

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

This looks good to me! I've asked Sharon to take a look too before we test this on QA.

Comment entered 2017-10-06 12:24:29 by Englisch, Volker (NIH/NCI) [C]

, I've updated the fermi branch on github with my changes.

Comment entered 2017-10-13 12:00:26 by Englisch, Volker (NIH/NCI) [C]

Hi , did you have a moment to take a look at these changes for your Unusual Cancers QC report?

Comment entered 2017-10-13 14:02:01 by Englisch, Volker (NIH/NCI) [C]

Sharon confirmed that the changes look good.

Comment entered 2017-10-25 19:50:49 by Juthe, Robin (NIH/NCI) [E]

, it doesn't look like the schema change for the new Section Metadata Section Type value made it to QA. Could you please add it? Thanks!

Comment entered 2017-10-26 09:21:19 by Kline, Bob (NIH/NCI) [C]

Done, thanks.

Comment entered 2017-10-26 11:45:35 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

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

Unable to verify this one yet, but I'll reopen if there's a problem.

Comment entered 2018-01-30 16:09:40 by Juthe, Robin (NIH/NCI) [E]

Reopening this ticket so we can revisit the possibility of having an unusual cancers-specific QC report. The complications associated with this may be worthwhile given the module-within-module problem. This is not an immediate need, so I have lowered the priority.

Comment entered 2018-02-08 14:23:55 by Juthe, Robin (NIH/NCI) [E]

Creating a specific QC report for this purpose is MUCH less work than addressing the module-within-module problem (which would likely require rewriting the full summaries filter set). It will be important to consider the flexibility of the new report when it is developed to allow for revised summary titles, new cancer types, and deleted cancer types. We will still need to delete the redundant special considerations section in this new report.

Comment entered 2018-05-11 14:46:38 by Juthe, Robin (NIH/NCI) [E]

The changes referenced above and completed in September 2017 to strip the Special Considerations sections of the Unusual Cancers summary no longer seem to be in place on PROD. Sharon ran a RLSO QC report of the Unusual Cancers summary and the Special Considerations section within each of the modules is displaying on the report. I believe this is a filter issue. Perhaps something was inadvertently replaced during the Hawking update?

Comment entered 2018-05-11 15:06:55 by Englisch, Volker (NIH/NCI) [C]

I ran a PublishPreview report and that does not show the Special Consideration section, so Cancer.gov is OK, right?

Comment entered 2018-05-11 15:08:39 by Juthe, Robin (NIH/NCI) [E]

Yes, Cancer.gov is OK.

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

, I'm guessing this is a problem I created. I'm thinking I probably updated the filter for hawking without merging master into hawking first before pushing the changes. I'm hoping you can help me understand which step I've missed.

I'll restore the changes, Robin, and let you know when it's done.

Comment entered 2018-05-11 18:16:56 by Kline, Bob (NIH/NCI) [C]

From what I can tell, it looks as if you applied commit 1b75d4f on September 22, suppressing the Unusual Cancers Special Considerations sections. Then on March 20 you applied commit e1127ab, removing the change you had committed in September.

Comment entered 2018-05-14 10:50:38 by Englisch, Volker (NIH/NCI) [C]

That's correct but I didn't actively remove the change. I'll have to go through my comments and think about it a little more but I believe the section was removed by merging branches. Most likely I pushed a local branch to github without having first merged master into the local branch - or something like that.

Comment entered 2018-05-15 18:45:54 by Englisch, Volker (NIH/NCI) [C]

The filter changes to remove the Special Considerations section have been restored on STAGE and PROD.

Please verify on PROD.

Comment entered 2018-05-24 18:26:46 by Englisch, Volker (NIH/NCI) [C]

, can we close this ticket or is there a reason why we need to keep it open at this point?

Comment entered 2018-05-31 13:02:39 by Juthe, Robin (NIH/NCI) [E]

So the direction of this issue has morphed a couple of times, but I think we should keep this open based on the comments on Jan 30 and Feb 8. I believe we still will need to create a QC report specific to the Unusual Cancers summary since we have the problem of modules within modules.

Comment entered 2020-01-02 14:00:26 by Juthe, Robin (NIH/NCI) [E]

Decided this is not needed at this time. Will reopen if we need it at a later date.

Elapsed: 0:00:00.001454