CDR Tickets

Issue Number 5270
Summary Modify QC reports to display citations marked up in Misc Doc citations well
Created 2023-08-04 12:17:42
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2023-08-15 12:07:22
Resolution Won't Fix
Path /home/bkline/backups/jira/ocecdr/issue.354470
Description

When a citation that is directly linked in a summary is marked up, it shows up in color or bold (I think depending on the markup) in the References section of the QC report.  For example CDR0000668479 on QA, "The Monkey on Your Shoulder" citation is in insertion markup and it is bolded in the B/U report.

However, when the citation is marked up in a Misc Document like the special considerations ones, they do not show up bolded or in color. For example, on PROD, CDR0000799767 has a link to CDR0000813292 (citation) which is a Misc. Doc, with the "Who benefits from surveillance imaging?" citation marked up but it shows up in the B/U report as not bolded in the References section of the QC report. 

Could you please modify the summaries QC reports so that when a citation in a Misc Doc is marked up, it will show the same as a citation directly in the summary.

Comment entered 2023-08-07 20:26:33 by Englisch, Volker (NIH/NCI) [C]

When I'm looking at the documents on PROD I see that the citations are wrapped within Insertion markup with the text "For testing purposes".  Therefore I like to ask: Is this an academic exercise only or will we frequently be updating/inserting citations within the 2 Special Consideration misc. documents?

The reason why I'm asking this is that I'm trying to get a handle on the cost/benefit for this requested change.  I had asked the same question before but don't remember if I got a definite answer.  Originally, it was my understanding that we were looking to create 2 template-like documents for the special consideration summaries which - once those had been created and finalized - wouldn't change much.  That's why I proposed using the MiscellaneousDocLink approach. 

Being able to display marked-up citations from a misc. document to be properly displayed within the Reference section is the same level of effort as being able to display marked up ListItems - which we had discussed for issue OCECDR-5133 (I think that was the issue).  If we want to be able to display the markup we will have to change the order in which individual documents are being denormalized, so that the insertion/deletion filters are executed after the MiscellenousDocLink is denormalized.

At this point it might be easier to toss out what we have done regarding the Misc. document changes and switch to use SummaryModules instead if the end result of the step-by-step Misc. document filter changes is going to be to have everything available we have for summary modules.

Comment entered 2023-08-15 12:07:12 by Osei-Poku, William (NIH/NCI) [C]

I don't think we should stop using misc docs because of this change. I will just note down that this feature does not work when changes are made in the misc doc instead of the summary.  Thanks!

Comment entered 2023-08-15 15:46:01 by Englisch, Volker (NIH/NCI) [C]

We never included citations in misc. documents before.  How often do you think will it happen going forward that we will need to make changes to citations within misc. documents?  Is it worth it to maybe modify the misc. doc QC report?

Comment entered 2023-08-16 10:03:34 by Osei-Poku, William (NIH/NCI) [C]

I don't think the citations will be updated much but the idea has always been to try to keep all the special consideration content in one place to make updating them easier.

Attachments
File Name Posted User
bolded referenceds.PNG 2023-08-04 11:53:36 Osei-Poku, William (NIH/NCI) [C]
unblolded citations.PNG 2023-08-04 12:12:10 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001513