CDR Tickets

Issue Number 4925
Summary [Media] Media Images Report
Created 2020-12-30 12:39:49
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2021-05-18 17:50:42
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.281259
Description

This request is the other part of OCECDR-4623 which was completed in Maxwell. This part of the report is not specific to any document type like the current report (Media In Summaries Report). We would like to be able to compare any media set (English and Spanish) whether they are in summaries or not. I am attaching the original specs in this ticket but it may need a few modifications.

Requirements Document for Images Report_upated_Defaults (1).docx

Comment entered 2021-04-08 21:42:11 by Englisch, Volker (NIH/NCI) [C]

I'm reading through the requirements and have a couple of questions:

  • Option CDR-ID:  Once a CDR-ID is specified or a specific title would there still be a need to also specify the other options?  Audience, language, etc. are all predetermined once the CDR-ID or title have been entered.  What about the date range?

  • With entering the CDR-ID or title a single side-by-side image pair will be displayed, right?

  • Option Diagnosis:  There exist 200+ diagnoses and you would like a drop-down menu for all of these?  Does the user select a single one or are you allowing multiple selections?
    Let's assume you're selecting "thyroid cancer".  You would expect 7 pairs of images on the report, right?

  • Which versions of the media doc are you interested in?  Published version, publishable version, last version, etc.?

  • There are some combinations of options you would not use together as mentioned in my first item.  Are there others?

  • You have a section titled "Display".  This also lists additional options.  I'm assuming these "display options" should be part of the initial page when you select your options.

  • When you say under Display item (5) "option to display caption" you are only talking about the caption listed in the media doc, right, because a summary document might specify a caption that's different from the media caption?

  • What are the defaults for the display options?

Comment entered 2021-04-15 14:18:57 by Osei-Poku, William (NIH/NCI) [C]

Option CDR-ID: Once a CDR-ID is specified or a specific title would there still be a need to also specify the other options? Audience, language, etc. are all predetermined once the CDR-ID or title have been entered.

When a CDR-ID is specified, there is no need to also specify the other options.

What about the date range?

Please use the the ProcessingStatusDate in the Media Doc for the date range. In cases where there are multiple ProcessingStatus blocks, use the topmost block.


With entering the CDR-ID or title a single side-by-side image pair will be displayed, right?

That is correct. When a title is entered that does not match exactly or when a wildcard is used, a secondary option screen to select the exact title would be helpful.

Option Diagnosis: There exist 200+ diagnoses and you would like a drop-down menu for all of these? Does the user select a single one or are you allowing multiple selections?

Yes, a drop-down menu would be ideal unless there is a better option, and yes, we would like to be able to select multipiple diagnoses if possible.
The Media Caption and Content Report has a similar list for the diagnosis

Let's assume you're selecting "thyroid cancer". You would expect 7 pairs of images on the report, right?

I think so. I am not sure where you're getting the list of 7 pairs from but in such a case, we would want to see all images that have a diagnosis of "thyroid cancer"

Which versions of the media doc are you interested in? Published version, publishable version, last version, etc.?

Current Working Document

There are some combinations of options you would not use together as mentioned in my first item. Are there others?

I can't think of any other combinations.

You have a section titled "Display". This also lists additional options. I'm assuming these "display options" should be part of the initial page when you select your options.

That is correct.

When you say under Display item (5) "option to display caption" you are only talking about the caption listed in the media doc, right, because a summary document might specify a caption that's different from the media caption?

Yes, that is right.

What are the defaults for the display options?

I have updated the attached requirements document with the defaults.

 Requirements Document for Images Report_upated_Defaults_updated.docx

Comment entered 2021-04-19 13:30:58 by Englisch, Volker (NIH/NCI) [C]

You've updated the requirements document for option 1 (Option to enter a CDR ID of the Media Doc) with a "Default: Spanish". 

Could you explain this default?  Are you asking to not allow displaying a document if the CDR-ID for an English media document has been entered?  Typically, I would assume by specifying a CDR-ID I know which document I'd like to display regardless of its language value and I'll display whichever pair that CDR-ID refers to.

Similarly for the title field:  If you specify Spanish as the default I'm assuming you only want to search for the title of Spanish image documents.  Is that correct?  To me this is the same as for the CDR-ID.  If I know the title (or CDR-ID) I know what I'm going to get.

Comment entered 2021-04-19 13:59:15 by Englisch, Volker (NIH/NCI) [C]

we would like to be able to select multipiple diagnoses if possible.

When the user selects multiple diagnoses how are you expecting those values to be used for the selection of media documents?

  • Display only those images for which all specified diagnoses exist and therefore limiting the query result or

  • Display all images for which one of the specified diagnoses matches and therefore expanding the query result

  • Other

Also, since we are looking at pairs of images, would you want to include a pair in the display if only one of the media documents lists a matching diagnosis?

Same question for category!

Comment entered 2021-04-19 14:55:30 by Osei-Poku, William (NIH/NCI) [C]


You've updated the requirements document for option 1 (Option to enter a CDR ID of the Media Doc) with a "Default: Spanish". 

Could you explain this default?  Are you asking to not allow displaying a document if the CDR-ID for an English media document has been entered?  Typically, I would assume by specifying a CDR-ID I know which document I'd like to display regardless of its language value and I'll display whichever pair that CDR-ID refers to.

Similarly for the title field:  If you specify Spanish as the default I'm assuming you only want to search for the title of Spanish image documents.  Is that correct?  To me this is the same as for the CDR-ID.  If I know the title (or CDR-ID) I know what I'm going to get. 

That is right. Since we are providing the CDR-ID and title, there is no need for a default.

Comment entered 2021-04-19 15:00:48 by Osei-Poku, William (NIH/NCI) [C]
  • Display all images for which one of the specified diagnoses matches and therefore expanding the query result

In terms of sorting, the ones with a single image should be at the end of the report. 

 


Also, since we are looking at pairs of images, would you want to include a pair in the display if only one of the media documents lists a matching diagnosis?

Yes.

Comment entered 2021-04-19 19:23:00 by Englisch, Volker (NIH/NCI) [C]

I'm assuming that you don't want to use the "audience" as a search parameter for the media documents because there doesn't exist an element that identifies a media document as a patient or HP document.  The audience is used as a parameter for the caption and description but not for the entire document.

Comment entered 2021-04-20 11:59:02 by Osei-Poku, William (NIH/NCI) [C]

That is right. We don't need it for such purposes.

Comment entered 2021-04-21 13:12:28 by Englisch, Volker (NIH/NCI) [C]

I need additional clarification regarding the search criteria:

Is it correct that the three search criteria - Diagnosis, Category, and date range - can all be specified together?  You don't wan to exclusively search for only a diagnosis or a category.

For the date range you specified a default range of one week.  Should I assume that every search result must be limited to the displayed date range?

Comment entered 2021-04-21 13:32:55 by Osei-Poku, William (NIH/NCI) [C]


Is it correct that the three search criteria - Diagnosis, Category, and date range - can all be specified together?  You don't wan to exclusively search for only a diagnosis or a category.

{QUTOE}

We want to be able to also search by just one of the categories. In some cases, to limit the results, we may choose any combinations of the three criteria including all three criteria when needed being selected. 

 

For the date range you specified a default range of one week.  Should I assume that every search result must be limited to the displayed date range?

Comment entered 2021-04-21 14:28:30 by Englisch, Volker (NIH/NCI) [C]

Since the default date range is pre-populated every search will be limited to this date range.  If this is not what you have intended we shouldn't pre-populate the date range.

Comment entered 2021-04-26 18:21:22 by Englisch, Volker (NIH/NCI) [C]

At this point the side-by-side report is nearly completed.  There are, however, two items from the requirements I have not yet completed.  Both of these are related to the selection or display of English/Spanish documents.  The following options have been implemented:

Single document pair display:

  • Option to enter a CDR ID

  • Option to enter part of the document title

Multiple document pair display (a.k.a. search):

  • Search by diagnosis

  • Search by category

  • Search by date range

Display options:

  • Checkbox for displaying caption

  • Checkbox for displaying content description

  • Checkbox for displaying labels

I would now like to discuss the two language options that are part of the requirements.

  • Option to specify the language (English/Spanish) as a search criteria
    Based on your information, , not to display any documents/document pairs of a Spanish translation does not exist I'm having a hard time imagining how you would use this option

  • Option to display images from only one language driven by the search option above
    I'm having the same question here.

Maybe you could explain what needs to happen in regard to those requirements with a specific example.  You can look at the current implementation of the report on DEV under the Media report menu item "Media Images Report".

Comment entered 2021-04-27 10:00:47 by Osei-Poku, William (NIH/NCI) [C]
  • Option to specify the language (English/Spanish) as a search criteria
    Based on your information, , not to display any documents/document pairs of a Spanish translation does not exist I'm having a hard time imagining how you would use this option

  • Option to display images from only one language driven by the search option above
    I'm having the same question here.

OK. I will review what is on DEV and let you know but what we would want happen is that, if both languages are selected, display images that have a match for both languages. If English is selected, display all English images even even they don't have a Spanish match. If Spanish is selected, display all Spanish images even if they don't have English match.  Essentially, selecting English means, English only and Selecting Spanish means, Spanish only.

Comment entered 2021-04-27 10:43:19 by Englisch, Volker (NIH/NCI) [C]

I understand now.  In the last media side-by-side report the option meant to display either both images or just the Spanish version.  This is actually a different search instead of a different display option.

Comment entered 2021-04-27 10:55:03 by Osei-Poku, William (NIH/NCI) [C]

Great. I just looked at it on DEV and it looks good. Thank you! I think proceeding with what I said I above should be fine. Also, I know you are not done yet and this would probably be fixed eventually, when I select the CDR ID option, can you suppress (do not display) the Report Filtering, Date Range, and Language Options?

Comment entered 2021-04-27 15:06:02 by Englisch, Volker (NIH/NCI) [C]

when I select the CDR ID option, can you suppress (do not display) the Report Filtering, Date Range, and Language Options?

In that case you probably want to suppress those sections when specifying a title as well because the search options are only used when not title or CDR ID has been specified.  You would need a third option to have these sections appear when needed.  I'll see how easy it would be to achieve the request.

Comment entered 2021-05-14 15:48:12 by Englisch, Volker (NIH/NCI) [C]

I'm getting close to the end of this report but I still have to deal with the audience.  You've confirmed that the audience would not be used as part of the search parameters because a media document itself is not audience specific.  That leaves the question if or how you would like to handle the caption and description?  Would you want to 

  • always display both items, patient and HP

  • always display patient item only

  • have another display option to select patient, HP, or both

  • have another display option to select patient or HP

Currently, only patient information is shown.

Comment entered 2021-05-14 16:12:24 by Osei-Poku, William (NIH/NCI) [C]

I will go with this option:

 

  • have another display option to select patient, HP, or both

Comment entered 2021-05-14 22:00:04 by Englisch, Volker (NIH/NCI) [C]

The following program is ready to review on DEV:

  • MediaLanguageCompare.py

Comment entered 2021-05-19 10:38:36 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thanks!

Comment entered 2021-06-04 11:17:08 by Osei-Poku, William (NIH/NCI) [C]

The display appears to have changed from when we tested on DEV. The results were displaying side by side but it appears to be displaying vertically now. Please see examples from both DEV and QA attached. 

Comment entered 2021-06-04 12:22:17 by Englisch, Volker (NIH/NCI) [C]

Sorry, , the CSS file needed for this report was missing.  I created it and the report shows now in two columns.

Comment entered 2021-06-04 12:23:33 by Englisch, Volker (NIH/NCI) [C]

Note to self:

This is a manual task to copy the CSS file:

Comment entered 2021-06-07 09:10:14 by Kline, Bob (NIH/NCI) [C]

 deploying the CSS is not a manual step. The .css file needs to be commited in the newton branch and added to the deployment build set.

Comment entered 2021-06-07 13:11:22 by Englisch, Volker (NIH/NCI) [C]

, I saved the CSS file to the repository and pushed it to GH.

Comment entered 2021-06-07 13:23:28 by Kline, Bob (NIH/NCI) [C]

Thanks, I've added it to the newton build package.

Comment entered 2021-06-08 16:59:28 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

Comment entered 2021-06-23 07:42:08 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD. Thanks!

Attachments
File Name Posted User
DEV images Report Interface.PNG 2021-06-04 11:17:03 Osei-Poku, William (NIH/NCI) [C]
DEV Images Report Output.PNG 2021-06-04 11:17:03 Osei-Poku, William (NIH/NCI) [C]
QA images report interface.PNG 2021-06-04 11:17:03 Osei-Poku, William (NIH/NCI) [C]
QA images report output.PNG 2021-06-04 11:17:03 Osei-Poku, William (NIH/NCI) [C]
Requirements Document for Images Report_upated_Defaults_updated.docx 2021-04-15 14:18:52 Osei-Poku, William (NIH/NCI) [C]
Requirements Document for Images Report_upated_Defaults (1).docx 2020-12-30 12:37:02 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001231