CDR Tickets

Issue Number 4623
Summary [Media] Images in Summary Report
Created 2019-05-17 13:30:04
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2020-10-22 14:19:43
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.244293
Description

Please create a new Media (images) report that would display English and Spanish images in a side by side layout. I would also like us to discuss this before attaching the specifications for the report.

Comment entered 2019-05-28 16:21:56 by Englisch, Volker (NIH/NCI) [C]

When I first read this request I was thinking in terms of GlossaryTerm QC report where both languages are within one file but I now realize the Spanish and English media documents are separate files.

Is it correct that you are looking for a report like the report that is displayed when you're clicking "Launch Media File" in XMetaL?

How would you like to call this report?  As a button within XMetaL or as an option on the Admin menu or both ways?

Comment entered 2019-05-28 20:52:47 by Osei-Poku, William (NIH/NCI) [C]

We will want a report on the Admin menu.

Comment entered 2020-08-12 12:54:04 by Englisch, Volker (NIH/NCI) [C]

, other than adding the report to the Admin Menu how would this report be different from OCECDR-4821?

Comment entered 2020-09-03 12:32:32 by Osei-Poku, William (NIH/NCI) [C]

This request 

  • OCECDR-4623  

is an images "ONLY" report while   OCECDR-4821  is a request for a "FULL" images QC report. Meaning it will have some of the other text elements that is currently in the media QC report.

Comment entered 2020-09-03 13:00:17 by Englisch, Volker (NIH/NCI) [C]

This ticket needs some discussion as the button to display the image is not - as most of the other report buttons - creating a report.  Instead it's a mechanism to open the existing image.  In other words, the JPEG file is opened with an application capable of displaying images as opposed to using the browser to display an HTML document/report.  I don't think it is possible to display two JPEG files side-by-side using this process unless both images are within the same JPEG file.

I think we could either add a second button to open the Spanish image in another window or create a new report which includes just the two images side-by-side.

Comment entered 2020-09-03 19:14:24 by Englisch, Volker (NIH/NCI) [C]

, after talking about this report earlier I think I have a better idea of what you're looking for.  You would want to specify one document (by ID or title) and extract all the images from both the corresponding English/Spanish documents to be displayed on a side-by-side report.

Please let me know if the attached sample (created for the colon cancer treatment summary) is what you had in mind.

Comment entered 2020-09-11 13:59:59 by Osei-Poku, William (NIH/NCI) [C]

Thanks, Volker! Yes, this is what we had in mind but also with some other fancy things in addition. We want to be able to do this for summaries and also for media. If you can do both in this ticket, I can create another ticket for the media one since that one appears to be more involving. I have attached the specification so you have a better picture of what we expect. Requirements Document for Images Report.docx

Comment entered 2020-09-14 17:23:03 by Englisch, Volker (NIH/NCI) [C]

I can create another ticket for the media one since that one appears to be more involving.

Please do.  In my opinion these reports are very different in how to process the data although the final output may seem fairly similar.  For the Summary version of the report you are limiting yourself to the media content of a single summary document.  The Media version, however, will have to search across all media documents irrespective to the documents the media is attached to.

Comment entered 2020-09-14 17:26:40 by Englisch, Volker (NIH/NCI) [C]

Could you please explain from the requirements document how option "(5) Option to display caption and content description below each page" is different from option "(7): ii and iii  Display EN, ES captions or both"?

Comment entered 2020-09-17 12:35:27 by Osei-Poku, William (NIH/NCI) [C]

Sorry for the confusion. That is misleading. I have moved ii) and iii) to under 5. I think that is where they belong.

Comment entered 2020-09-30 17:39:40 by Englisch, Volker (NIH/NCI) [C]

May I ask what the benefit would be to display only the English caption (or description) but not the other?  Would it hurt to always show English and Spanish captions when showing captions?  In my opinion, what you may want as options is:

  • Option to enter CDR ID
    or
    Option to search by summary title

  • Option for language: Both, EN, ES

  • Option for caption display: Yes/No

  • Option for description display: Yes/No

Is this correct?

Comment entered 2020-09-30 20:32:18 by Osei-Poku, William (NIH/NCI) [C]
Comment entered 2020-10-02 13:26:31 by Osei-Poku, William (NIH/NCI) [C]

Requirements Document for Images Report_upated_Defaults.docx

I have marked the defaults for some of the search options. Hopefully, this would be helpful but generally, we would want:

Default Language:  Spanish

Default Audience: Patient

Title search should be the default vs CDR Search. I know this will not be enough so if you let me know which other options you want us to determine the defaults, that would be great.

Comment entered 2020-10-06 16:13:56 by Englisch, Volker (NIH/NCI) [C]

Since there will be no need to specify a language option if you're only displaying one document - you wouldn't specify an English summary and specify to only display the Spanish information - I will add an option to "show both languages" as a side-by-side display.  I'm assuming you would want this option to be the default display option.

It sounds to me you'd like the option to display the captions for one language but not the other.  I am guessing what you need is to turn the display of captions (or description and labels) on or off rather than "display only Spanish caption but not English or vice versa".

Comment entered 2020-10-06 16:16:58 by Englisch, Volker (NIH/NCI) [C]

I've updated the ticket title to reflect which media report we are talking about here.  This report will display all the images within a single summary and - if selected - it's Spanish translation.

Comment entered 2020-10-12 20:44:59 by Englisch, Volker (NIH/NCI) [C]

, this report is almost ready.  What's left to do is adding the option to display one language only.

Please have a look at the interface options I mentioned at our last CDR meeting since these are different from what was listed in the requirements document.  You can find the report as part of the Media reports under "Media in Summary Report".

Comment entered 2020-10-13 17:21:28 by Englisch, Volker (NIH/NCI) [C]

The following files have been created/updated:

This is ready for review on DEV.

Comment entered 2020-10-21 09:20:36 by Osei-Poku, William (NIH/NCI) [C]

Thanks This report seems to be for one aspect of what we wanted- reporting on images in summaries. One of things we wanted for this report is to also compare files that are not necessarily in summaries but can be retrieved for a specified category. I am not sure if we talked about doing that part of the report in the next release or not.

Comment entered 2020-10-21 12:11:48 by Englisch, Volker (NIH/NCI) [C]

This report seems to be for one aspect of what we wanted- reporting on images in summaries.

That's correct.  In your requirements document you had combined two very different types of report into a single Media report interface.  Except for the requirement of displaying English and Spanish media documents side-by-side their isn't much of a connection between both reports.  One report is searching for media documents within the CDR based on criteria like diagnosis, audience, date range, etc. while the other report is displaying images from a single document (and its language counterpart).  Because of this I had modified the title of the ticket and we discussed we would handle both of these reports separately.  On Sep 11, Sep 14 you suggested creating a separate ticket for the media search report.

We did not talk about "when" we would create the other report but given the fact that we're nearly at the end of Maxwell, a new ticket of this size would need to be handled as part of our next release.

Comment entered 2020-10-21 15:04:38 by Osei-Poku, William (NIH/NCI) [C]

Thanks for the clarification. I forgot about that discussion.

Comment entered 2020-10-21 15:06:31 by Osei-Poku, William (NIH/NCI) [C]

It looks like if you select a summary that does not have an image, you get the following error message:  Sample summary (CDR0000765469)

'Summary' object has no attribute 'bail'

 

 I think it would be good to have a more user friendly message that says the summary selected does not have images.

Comment entered 2020-10-21 15:17:09 by Osei-Poku, William (NIH/NCI) [C]

When I uncheck "Display English and Spanish Document" and enter 'CDR0000269044' leaving all the defaults intact, I get the following error message:

invalid literal for int() with base 10: 'CDR0000269044'

 

Comment entered 2020-10-21 16:04:53 by Englisch, Volker (NIH/NCI) [C]

Good test!  I did not try to run the report on a document without an image.

I will fix that in a moment.

Comment entered 2020-10-21 17:50:04 by Englisch, Volker (NIH/NCI) [C]

The error message wasn't trying to tell you that there weren't any media files but it was trying to tell you that it had problems telling you what the error was.

This has now been fixed.

Comment entered 2020-10-21 17:59:53 by Englisch, Volker (NIH/NCI) [C]

Another good catch!  I didn't expect the CDR-ID to not be an integer value.  

This has now been fixed.

Comment entered 2020-10-21 19:25:57 by Osei-Poku, William (NIH/NCI) [C]

It is working now. Thanks!

Comment entered 2020-10-21 19:26:23 by Osei-Poku, William (NIH/NCI) [C]

It is working now. Thanks!

Comment entered 2020-10-21 19:28:16 by Osei-Poku, William (NIH/NCI) [C]

Is it possible to have the option to enlarge the image? I know this is a new requirement so it needs to wait until the next CDR release, that is fine. Also, please include the Title of the summary and the CDR ID in the header of the report.

Comment entered 2020-10-22 10:20:32 by Englisch, Volker (NIH/NCI) [C]

Is it possible to have the option to enlarge the image? 

Yes, but I need more information of what you mean by "enlarge the image" as I can imagine several different approaches:

  • Display the images bigger. The images are currently displayed with a width of 400px - the same size we're using for our side-by-side glossary report.  You may want to display the images larger as a whole but remember, since this is a multi-column report when the image size gets bigger than the column width itself the report might start to look bad as written.

  • Implement an option to specify the size of the images

  • Make the images a link to allow individual images to be displayed in full size

  • Create an option or link allowing an image (and its language counterpart?) to be displayed at a larger size

  • other

The amount involved to "enlarge the image" will vary greatly between these options and depending on the image size chosen there may be additional changes to the report necessary.

Comment entered 2020-10-22 11:26:21 by Osei-Poku, William (NIH/NCI) [C]

This is the option we'd like - 

Make the images a link to allow individual images to be displayed in full size

Comment entered 2020-10-22 14:19:37 by Englisch, Volker (NIH/NCI) [C]

The report has been setup so that you can click on the image in order to display the full size version.

Bug fixes and additional changes are now on github:
https://github.com/NCIOCPL/cdr-admin/commit/1ad606d

Comment entered 2020-10-23 11:16:54 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thank you!

Comment entered 2020-11-16 09:31:09 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

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

Verified on PROD. Thanks!

Attachments
File Name Posted User
Images for.docx 2020-09-03 19:15:58 Englisch, Volker (NIH/NCI) [C]
imagesreport error_Display_unchecked.PNG 2020-10-21 15:17:05 Osei-Poku, William (NIH/NCI) [C]
images report error.PNG 2020-10-21 15:06:28 Osei-Poku, William (NIH/NCI) [C]
Requirements Document for Images Report_upated_Defaults.docx 2020-10-02 13:22:18 Osei-Poku, William (NIH/NCI) [C]
Requirements Document for Images Report_upated.docx 2020-09-17 12:33:56 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001412