CDR Tickets

Issue Number 5114
Summary Module text showing in QC Reports when it should not
Created 2022-05-26 17:27:46
Issue Type Bug
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2022-08-19 20:09:47
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.319114
Description

There seems to be a problem with module documents that have been marked as QC-only in summaries. Part of the sections of the links modules are showing in the standard QC report even if you have not checked the box to include content from the module documents.  When I looked at it most of the content was coming from sections with markup. Please take a look at version 1021 of CDR0000062872 on PROD.  The Salivary gland and Laryngeal sections are not showing any module text (as it should be); however, the Midline tract section is showing just the Clinical Presentation and Outcome section of the summary module. None of the other sections show. 

 

Comment entered 2022-06-07 16:05:50 by Englisch, Volker (NIH/NCI) [C]

I am unable to replicate the situation presented here.  I will try to take a look at what's going on by creating test documents on QA.

Comment entered 2022-06-14 17:04:31 by Englisch, Volker (NIH/NCI) [C]

It appears that the SummaryKeyword values are displayed for the regular QC report and as seen in your screenshot but you're not mentioning this as an issue, .  The QC report should show without any content from the module, right?

Comment entered 2022-07-12 11:19:55 by Osei-Poku, William (NIH/NCI) [C]

Hi Volker,

I do not understand your question about the SummaryKeyword. Could you please explain further? With regards to the Modules, yes, nothing from the Module documents should be displaying when running the regular QC report.

Comment entered 2022-07-14 18:31:12 by Englisch, Volker (NIH/NCI) [C]

You probably don't understand my question because I took care of the problem and you can't see it anymore. 

If you look at the image you provided, you can see that the output for the section "Midline Tract Carcinoma Involving the NUT Gene" displays the text "childhood midline tract carcinoma".  Same for all of the other summaries. This text is coming from the module's element SummaryKeyWord.  All of the module's keywords are listed here.  However, we should be listing the module's Title, which I'm doing now.

Comment entered 2022-07-14 18:56:51 by Osei-Poku, William (NIH/NCI) [C]

OK. Thanks for explaining this, Volker!  Is this ready for testing?

Comment entered 2022-07-18 12:27:44 by Englisch, Volker (NIH/NCI) [C]

Yes, you can go ahead and test this.

Comment entered 2022-08-02 18:35:22 by Osei-Poku, William (NIH/NCI) [C]

This seems to be working but the QC report displays the title of the Module when it shouldn't

You can take a look at this summary  - 574548. The title shows whether 

you select for QC-Only or not. 

 

Comment entered 2022-08-19 20:09:14 by Englisch, Volker (NIH/NCI) [C]

The following filters have been modified to fix the module display issue:

  • CDR0000335166.xml - Filter title: Module: Checkbox Formatter

  • CDR0000339576.xml - Filter title: Module: InLine Markup Formatter

  • CDR0000434822.xml - Filter title: Module: QC Filter Templates - Summary

  • CDR0000712005.xml - Filter title: Denormalization Filter: Summary Module

  • CDR0000335169.xml - Filter title: Module: STYLE Default  (trailing white space changes)

  • CDR0000380958.xml - Filter title: Module: STYLE QC Summary  (trailing white space changes)

I had to copy the modified filters to DEV and QA since I needed to test with a document version that wasn't available on DEV.

Please take another look, .

Comment entered 2022-09-01 12:26:58 by Osei-Poku, William (NIH/NCI) [C]

We tested on DEV and everything appears to work correctly. I assume in this case, there is no need to repeat the testing on QA, right?

Comment entered 2022-09-01 12:48:07 by Englisch, Volker (NIH/NCI) [C]

I will run some diff reports on QA to confirm the publishing output hasn't changed and I haven't introduced some other issues.  It is up to you if you want to do some additional checking on QA once the filters have been copied.

Comment entered 2022-09-10 21:46:56 by Englisch, Volker (NIH/NCI) [C]

The diff reports on QA came out clean except for some of the summaries with modules. 

, these are the summaries that show differences if you want to double check that these come out as expected now:

  • CDR62792.xml

  • CDR62836.xml

  • CDR62932.xml

  • CDR62945.xml

  • CDR774921.xml

Comment entered 2022-09-13 18:37:07 by Osei-Poku, William (NIH/NCI) [C]

Could you point me to what to look for? We looked at some of the summaries and couldn't find anything odd. One of the summaries is an invalid document so that might be the reason for it to be included in the list you provided but the rest appear to be OK so I am not sure why they are showing up in your list.

Comment entered 2022-09-13 19:30:32 by Englisch, Volker (NIH/NCI) [C]

, these documents are showing up with differences because we fixed the filters to correctly handle modules.  Naturally, summaries with modules will show differences in a diff report.  The purpose of the diff reports in general is to confirm that we did not break anything.  I ran the QC reports for every document type that is sharing one of the modified filters.  For some minor filter changes, i.e. adding an element, it's also possible to use the output of the diff report and confirm that everything is behaving as expected.  For these summaries that do use modules, however, we can now see major text differences and it's not easy to inspect these automatically.  For these I just wanted you to have a look at the output and confirm that the filter output provides what you expected.

Comment entered 2022-09-28 13:50:12 by Osei-Poku, William (NIH/NCI) [C]

We have reviewed before and after QC reports after the filter change and did not find anything different. Also, the reports appear to be displaying the modules correctly as reported earlier.

Comment entered 2022-09-28 15:23:49 by Englisch, Volker (NIH/NCI) [C]

, would you like me to copy the filter changes to PROD today or should we wait until after Friday's publishing job?

Comment entered 2022-09-29 10:21:59 by Osei-Poku, William (NIH/NCI) [C]

Please copy the changes to PROD. We did a last minute review and found what appears to be a bug but it is also on PROD so I will create a separate ticket to take care of it. Essentially when a list item text is in proposed deletion text, it doesn't show in the the B/U report but it does show in the RL/SO report. I will create a separate ticket with an example for further investigation.

Comment entered 2022-09-29 10:22:23 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

Comment entered 2022-09-30 18:34:18 by Englisch, Volker (NIH/NCI) [C]

The updated filters have been pushed to STAGE and PROD.

Please verify on PROD and close this ticket if things look good.

Comment entered 2022-10-20 11:39:48 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD. Thanks!

Attachments
File Name Posted User
MicrosoftTeams-image (11).png 2022-08-02 18:28:59 Osei-Poku, William (NIH/NCI) [C]
MicrosoftTeams-image (12).png 2022-08-02 18:32:44 Osei-Poku, William (NIH/NCI) [C]
MicrosoftTeams-image (13).png 2022-08-02 18:33:31 Osei-Poku, William (NIH/NCI) [C]
module content showing in QC reports.jpg 2022-05-26 17:26:22 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001328