CDR Tickets

Issue Number 5048
Summary Update XMetal to display SVPC summaries differently from non SVPC summaries
Created 2021-10-15 15:03:01
Issue Type New Feature
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Osei-Poku, William (NIH/NCI) [C]
Status Closed
Resolved 2021-10-18 18:32:59
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.300673
Description

As a CDR patient summary editor, I want to be able to see the difference between a PDQ CDR document and a SVPC summary document in XMetal.

We are making changes to the summary schema to be able to create or modify summaries as SVPC summaries and we are also making changes to be able to combine several SVPC summaries into one master content partner summary for the PDQ content partners. These summaries would be created in the CDR which already has several PDQ summaries. In order not to confuse the regular PDQ summaries with the SVPC summaries, we would want to be able to additionally differentiate the SVPC summaries from the PDQ summaries visually.

Scenario: CDR has the ability to display SVPC summaries differently from other non SVPC summaries

Given: I am a CDR patient summary editor

  And I have permissions to edit patient summary documents in XMetal

When I mark a CDR document as a SVPC summary document

Then the XMetal should display it as a SVPC summary with a different background color, for example

 

Scenario: CDR has the ability to display SVPC summaries differently from other non SVPC summaries

Given I am a CDR user

When I retrieve a SVPC summary

Then the XMetal should visually display it differently from other PDQ summary documents.

(Or: If I retrieve a PDQ summary

Then XMetal should display it normally with the purple background)

Comment entered 2021-10-15 18:16:17 by Englisch, Volker (NIH/NCI) [C]

, I will assume you are talking about changes to the display in XMetaL in this ticket.

I have made changes on DEV to setup the first scenario, choosing SeaShell as the background color

Regarding the second scenario I'm not understanding how this differs from the first scenario.  The background color is set based on the SVPC attribute of the Summary element and the permissions of a user to modify a document are irrelevant.

Comment entered 2021-10-15 21:43:53 by Kline, Bob (NIH/NCI) [C]

"The CDR" is not specific enough. The ticket should specify whether it's talking about XMetaL, or some report, and if the latter, which report.

Comment entered 2021-10-18 08:20:31 by Osei-Poku, William (NIH/NCI) [C]

Thanks  Yes, this is a change in the appearance of XMetal. I have reviewed the change and it doesn't stand out well enough but I think it is OK to keep the changes you've made. Are you able to also change the background color of the blocks as well? Please see attached screenshot from DEV. 


Regarding the second scenario I'm not understanding how this differs from the first scenario. 

The second scenario is the same as the first scenario in terms of the outcome but I wanted to make sure not only a summary editor should be able to see the difference but other CDR users should be able to see the difference as well. Or not to create the impression that you need to be a summary 

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


"The CDR" is not specific enough. The ticket should specify whether it's talking about XMetaL, or some report, and if the latter, which report

Thanks  I have updated the ticket to clarify the requirements.

Comment entered 2021-10-18 10:26:02 by Englisch, Volker (NIH/NCI) [C]

I can certainly make the color of the white background stand out more but I don't believe that would be a welcome change for the users.

The advantage of changing the background color of the Summary element is that it included a change for the entire document.  Changes to of the "purple blocks" are limited to specific elements: CdrDocCtl, SummaryMetaData, etc and a color change to those would mostly be off the viewpoint for an editor but I can try to modify those, too.

Is it just the background color you like to have modified or the element's background color and/or label color as well?

Comment entered 2021-10-18 11:06:28 by Osei-Poku, William (NIH/NCI) [C]


I can certainly make the color of the white background stand out more but I don't believe that would be a welcome change for the users.

I agree. I think the Seashell color is OK for now. 

 


Changes to the "purple blocks" are limited to specific elements: CdrDocCtl, SummaryMetaData, etc and a color change to those would mostly be off the viewpoint for an editor but I can try to modify those, too.

I think changing the purple blocks color of the CDrDocCtl and SummaryMetaData should be good. When a user first retrieves a summary document, the CdrDocCtl and/or the SummaryMetaData block is displayed. That should be enough, the editor does not need to see the change throughout the document to know that it is a SVPC summary.

Comment entered 2021-10-18 18:26:25 by Englisch, Volker (NIH/NCI) [C]

I have made additional modifications to the legacy summary display for the SVPC documents.

 

As you can see, the change modifies the document's background color from "white" to "seashell".  It modifies the background color of the elements SummaryMetaData and CdrDocCtl, and it adds a SVPC header to the top of the document:

Comment entered 2021-10-19 09:20:44 by Osei-Poku, William (NIH/NCI) [C]

Thanks . I think this stands out pretty well. We will review and let you know there are any questions.

Comment entered 2021-10-19 14:44:55 by Englisch, Volker (NIH/NCI) [C]

The following CSS has been modified to change the display in XMetaL:

This is ready for review on DEV.

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

Verified on DEV. Thanks!

Comment entered 2021-10-29 16:33:58 by Englisch, Volker (NIH/NCI) [C]

Due to the attribute name change the following CSS files had to be adjusted:

  • Summary.css

  • Summary_structure.css

 https://github.com/NCIOCPL/cdr-client/commit/e94ac6a

Comment entered 2022-05-26 13:56:00 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA and PROD. Thanks!

Attachments
File Name Posted User
Screen Shot 2021-10-18 at 18.19.07.png 2021-10-18 18:22:44 Englisch, Volker (NIH/NCI) [C]
Screen Shot 2021-10-18 at 18.20.05.png 2021-10-18 18:25:29 Englisch, Volker (NIH/NCI) [C]
SVPC background.PNG 2021-10-18 08:20:28 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001544