CDR Tickets

BZDATETIME::2011-09-08 11:18:53
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1

For now I've taken care of the "features" in (3) and (4) on MAHLER.
For (3) there was indeed a default set of 3 levels if no level had been specified.
I am still leaving a limit in place but this limit is now set to 9. I haven't seen a summary with more than 7 levels of headings.

For (4) I was individually specifying elements not to be displayed which caused all elements that had been added to the summary schema since the report was created to be displayed in funny ways. It's now fixed to also drop future new elements.

I understand what should be done for (1) but we need to have a little talk about (2) regarding the markup to be displayed.
Notice that the report is currently displaying marked up text but without mark-up.

BZDATETIME::2011-09-09 10:13:15
BZCOMMENTOR::Volker Englisch
BZCOMMENT::2

(In reply to comment #0)
> 1. Add the ability to run the report for a single summary by entering either
> the CDR ID or Summary Title.

I am wondering how you would want the initial pages to look like? I can imagine three options:
a) First page: Select if the report should be run for a single summary (A) or
for multiple summaries (B)
Second page:
Option A: Enter the CDR-ID or Summary Title
Option B: Same page as we're using currently

b) First page: Same page as we're currently using but setup with the two
options:
1) Report for all summaries
2) Second option to enter CDR-ID or Summary Title

c) First page: Same page as we're currently using with one additional option
to go to another page to enter CDR-ID or Summary Title when
checked.

I would also need some information if the options currently available should be available for the individual report as well (display with or without CDR-ID, restrict to HP or Patient summaries, etc.)

BZDATETIME::2011-09-28 17:07:07
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

(In reply to comment #0)
> 2. ... and display markup in the TOC lists when applicable.

I've implemented item 2(b). Insertion/Deletion markup is now displayed on the report.

Please note, this is merely the display of insertion (red color) and deletion (red color and line-through). I am not looking at the markup attributes (Editorial, Advisory, publish, approve, proposed, etc.).

I've modified the filter and program
CDR000160 - Summaries Toc Report
SummariesTocReport.py

BZDATETIME::2011-09-29 10:29:35
BZCOMMENTOR::Robin Juthe
BZCOMMENT::4

(In reply to comment #3)
> (In reply to comment #0)
> > 2. ... and display markup in the TOC lists when applicable.
> I've implemented item 2(b). Insertion/Deletion markup is now displayed on the
> report.
> Please note, this is merely the display of insertion (red color) and deletion
> (red color and line-through). I am not looking at the markup attributes
> (Editorial, Advisory, publish, approve, proposed, etc.).
> I've modified the filter and program
> CDR000160 - Summaries Toc Report
> SummariesTocReport.py

I agree with the option in 2b to show both report options (A&B) on the same page. We should keep the option to include/exclude the CDR ID when option A is chosen, but the other options (HP or patient, summary type, summary language) are no longer relevant since we're selecting an individual summary. We can talk about this today if you have other questions.

BZDATETIME::2011-10-27 11:21:49
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5

I am close to being done with this report but there are a couple questions about details in functionality and display.

On MAHLER, when running the report I added the section 'Single Summary' to the interface we already used. This section contains two fields to be entered for the CDR-ID or the summary title. If either of these has been entered a single summary report will be created regardless of the check boxes selected at the bottom.
When you specify a TOC level or select the 'With CDR-ID' option this does apply to the single summary report when a CDR-ID has been entered but not for the single summary when a title has been entered.

Do we want these two options available for the single report or not?
If we do we probably need to modify the display to make it clear these options are for both types of the report.

I suggest to have a look at the changes now and then we can decide what would make sense to add.

This is ready for review on MAHLER.

BZDATETIME::2011-10-27 12:07:09
BZCOMMENTOR::Robin Juthe
BZCOMMENT::6

(In reply to comment #5)
> When you specify a TOC level or select the 'With CDR-ID' option this does apply
> to the single summary report when a CDR-ID has been entered but not for the
> single summary when a title has been entered.
> Do we want these two options available for the single report or not?

Yes, these options should be available for the single report, so I agree that we should change the display a bit. How about something like this:

Select Single Summary
--CDR ID
--Title

OR

Select Multiple Summaries
--Select Audience
--Select Summary Language/Type

---------------------------

Display Options (would be applicable to both versions of the report)
--Display CDR ID
--Specify Number of TOC Levels

Will the single summary selection bring us to another page to select the version?

BZDATETIME::2011-10-27 13:14:06
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7

(In reply to comment #6)
> Will the single summary selection bring us to another page to select the
> version?

Oh, the version; I forgot about the version. No, currently you can't pick the version and I have to add that.

BZDATETIME::2011-11-22 16:02:42
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

(In reply to comment #0)
> 2. Add the ability to select a version of the summary

I am trying to come up with a good way of specifying a version and I was wondering if I should take the text "select a version" literally?

Here are some thoughts about this:
a) If you are entering the CDR-ID of a summary I could create a new page after
pressing submit that allows the user to select a version. However, it
may be a little silly to select (or enter) just the version number and I'm
guessing that a user who knows the CDR-ID will also know the version
number to use. In addition, for a user who just wants the report for the
CWD having to select a version is obviously extra work.
So, I'm debating about adding a field after the CDR-ID
field on the initial page for a version number (similar to entering the
TOC level). If the field is filled in we're using the specified version,
otherwise the report will run with the CWD.
Alternatively we would create a new page after entering the CDR-ID to
select or enter a version number.
Another option could be to use a check-box and only have the user select
a version if either the CDR-ID or title fields are filled in and the
checkbox is checked. Otherwise proceed by using the CWD.

b) If you are entering a search string a page comes up listing all of the
summaries with the supplied substring in it's title. There is one row
displayed for each summary with the format
[CDR-ID] Summary Title
i) I am wondering if you do want to see the CDR-ID? If this
information isn't useful I could just drop it here (or add to
the end of the title).
It's probably just me but I don't think it doesn't look good to have
the pick-list start with the CDR-ID.
ii) Again, I am guessing that a user who wants to run this report for a
version instead of the CWD, she probably knows the version number.
We might just want to add a text box next to each summary to be
entered here?

I'm thinking my personal preference would be to add a check-box for specifying a version number. What is yours?

BZDATETIME::2011-11-28 12:16:59
BZCOMMENTOR::Robin Juthe
BZCOMMENT::9

(In reply to comment #8)
> (In reply to comment #0)
> > 2. Add the ability to select a version of the summary
> I am trying to come up with a good way of specifying a version and I was
> wondering if I should take the text "select a version" literally?
> Here are some thoughts about this:
> a) If you are entering the CDR-ID of a summary I could create a new page after
> pressing submit that allows the user to select a version. However, it
> may be a little silly to select (or enter) just the version number and I'm
> guessing that a user who knows the CDR-ID will also know the version
> number to use. In addition, for a user who just wants the report for the
> CWD having to select a version is obviously extra work.

I think it would be more efficient to be able to select the version from a picklist of possible versions (with version comments displayed), rather than having to know the version number. Some of us know CDR IDs of the summaries, but I don't know if anyone has the version numbers memorized :-) While we could easily look up the version number, I think it would probably save time to have a second screen on the report itself from which we could select the appropriate version.
I don't think the extra work for a person who wants to run the report for the CWD will be significant. The picklist could present with the CWD pre-selected, so the user only has to hit submit. (similar to the version picklist we are presented with when we run a QC report for a summary, which we are all quite familiar with).

> b) If you are entering a search string a page comes up listing all of the
> summaries with the supplied substring in it's title. There is one row
> displayed for each summary with the format
> [CDR-ID] Summary Title
> i) I am wondering if you do want to see the CDR-ID? If this
> information isn't useful I could just drop it here (or add to
> the end of the title).
> It's probably just me but I don't think it doesn't look good to have
> the pick-list start with the CDR-ID.

I agree - I don't think we need to see the CDR ID at the beginning of the string (at the end, in brackets, would be fine). It also puts the documents in chronological order rather than alphabetical order, and I think alphabetical order would be more appropriate.

> ii) Again, I am guessing that a user who wants to run this report for a
> version instead of the CWD, she probably knows the version number.
> We might just want to add a text box next to each summary to be
> entered here?

Please see my comments above. In this case, it would be a third screen the user has to get to to select the version, but I still don't think the extra work of going to a third screen outweighs the work of looking up the version number.

BZDATETIME::2011-11-28 16:52:42
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

(In reply to comment #9)
> I think it would be more efficient to be able to select the version from a
> picklist of possible versions

Good thing I asked.
This is ready for review on MAHLER.

BZDATETIME::2011-11-30 12:52:32
BZCOMMENTOR::Volker Englisch
BZCOMMENT::11

We talked about a few more changes to the report and user interface:

• For the last version of the report the options to specify the TOC levels and
  the display of the CDR-ID was only available for the 'All Summaries' option
  of the report but not for the 'Single Summary' option.

I moved these two options in between the options only available for one or
the other report.

• There was a question regarding the display of markup for the TOC reports
  I had said that the 'All Summaries' option is displaying the publishable
  versions of the summaries. However, this is incorrect. The report only
  shows summaries for which a publishable version exists but the TOC itself
  is coming from the CWD.
  I have modified the report to display markup for the single summaries only
  and remove the markup from the 'All Summaries' option of the report.

This is ready for further review on MAHLER.

BZDATETIME::2011-12-01 17:08:14
BZCOMMENTOR::Robin Juthe
BZCOMMENT::12

(In reply to comment #11)
> We talked about a few more changes to the report and user interface:
> - For the last version of the report the options to specify the TOC levels and
> the display of the CDR-ID was only available for the 'All Summaries' option
> of the report but not for the 'Single Summary' option.
> I moved these two options in between the options only available for one or
> the other report.

The display looks good and I've confirmed that the options apply to both versions of the report - thanks.

> - There was a question regarding the display of markup for the TOC reports
> I had said that the 'All Summaries' option is displaying the publishable
> versions of the summaries. However, this is incorrect. The report only
> shows summaries for which a publishable version exists but the TOC itself
> is coming from the CWD.

Good to know. Thanks.

> I have modified the report to display markup for the single summaries only
> and remove the markup from the 'All Summaries' option of the report.
> This is ready for further review on MAHLER.

I'm not seeing markup in the single summary version of the report. I put some fake summary sections into CDR 62863 in markup for testing.

BZDATETIME::2011-12-01 17:24:55
BZCOMMENTOR::Volker Englisch
BZCOMMENT::13

(In reply to comment #12)
> I'm not seeing markup in the single summary version of the report. I put some
> fake summary sections into CDR 62863 in markup for testing.

This is odd because I tested with CDR62907 and that does show markup.
I'll have to look at this a little more.

BZDATETIME::2011-12-02 09:28:33
BZCOMMENTOR::Robin Juthe
BZCOMMENT::14

(In reply to comment #13)
> (In reply to comment #12)
> > I'm not seeing markup in the single summary version of the report. I put some
> > fake summary sections into CDR 62863 in markup for testing.
> This is odd because I tested with CDR62907 and that does show markup.
> I'll have to look at this a little more.

Good point. There's a difference in the markup in the headings in these two documents. CDR62863 has new headings entirely in markup and CDR62907 has markup within a published heading. So, it looks like the markup is only displaying in the latter case.

BZDATETIME::2011-12-02 10:50:32
BZCOMMENTOR::Volker Englisch
BZCOMMENT::15

Of course! The template to select the individual Section Titles picks up the Title elements and all of its children. All parents are ignored, so if you mark up a title like this:
<Title><Insertion>Robin is waiting for Santa Claus</Insertion></Title>
the markup will be displayed properly but if it's marked up as
<Insertion><Title>Robin is waiting for Santa Claus</Title></Insertion>
it will not because the template itself will only see what's inside the Title element.

As Alan says: This requires some head scratching!

Would it be worth it to copy to production what we already have or would you rather want to wait until we figured out how to correct the report?

BZDATETIME::2011-12-02 11:03:04
BZCOMMENTOR::Robin Juthe
BZCOMMENT::16

(In reply to comment #15)
> Of course! The template to select the individual Section Titles picks up the
> Title elements and all of its children. All parents are ignored, so if you
> mark up a title like this:
> <Title><Insertion>Robin is waiting for Santa Claus</Insertion></Title>
> the markup will be displayed properly but if it's marked up as
> <Insertion><Title>Robin is waiting for Santa Claus</Title></Insertion>
> it will not because the template itself will only see what's inside the Title
> element.
> As Alan says: This requires some head scratching!
> Would it be worth it to copy to production what we already have or would you
> rather want to wait until we figured out how to correct the report?

Gotcha. Yes, let's promote what we have to Bach in the meantime.

BZDATETIME::2011-12-02 17:59:41
BZCOMMENTOR::Volker Englisch
BZCOMMENT::17

The following filters and programs have been copied to FRANCK and BACH:
CDR000160 - Summaries TOC Report - R10269
SummariesTocReport.py - R10268

These changes are fixing item 1, 3, and 4 of the original request but only partially item 2 (the markup display).

I will be addressing the markup in phase II ... starting now.

BZDATETIME::2011-12-06 16:18:11
BZCOMMENTOR::Volker Englisch
BZCOMMENT::18

I modified the SummaryTOCReport and I think I am now able to display both "types" of markup in the single CDR-ID report.

Please have another look on MAHLER.

BZDATETIME::2011-12-07 12:24:10
BZCOMMENTOR::Robin Juthe
BZCOMMENT::19

(In reply to comment #17)
> The following filters and programs have been copied to FRANCK and BACH:
> CDR000160 - Summaries TOC Report - R10269
> SummariesTocReport.py - R10268

I'm getting an error message (below) when I click on this report from the OCCM Board Managers list in the CDR admin menu on Bach.

"CGI Error
The specified CGI application misbehaved by not returning a complete set of HTTP headers."

BZDATETIME::2011-12-07 13:16:27
BZCOMMENTOR::Volker Englisch
BZCOMMENT::20

I'm not sure what happened. I must have copied a version that wasn't ready yet but that's fixed now. Sorry!

BZDATETIME::2011-12-15 11:41:33
BZCOMMENTOR::Robin Juthe
BZCOMMENT::21

(In reply to comment #20)
> I'm not sure what happened. I must have copied a version that wasn't ready yet
> but that's fixed now. Sorry!

This looks good on Bach and has already come in handy! Thanks Volker. I'll let you double-check that the versions on Bach and Mahler are identical before we close the issue.

BZDATETIME::2011-12-16 15:56:28
BZCOMMENTOR::Volker Englisch
BZCOMMENT::22

(In reply to comment #21)
> I'll let you double-check that the versions on Bach and Mahler are identical
> before we close the issue.

Everything looks good on all servers. You're free to close this issue.

BZDATETIME::2011-12-16 15:57:00
BZCOMMENTOR::Robin Juthe
BZCOMMENT::23

(In reply to comment #22)
> (In reply to comment #21)
> > I'll let you double-check that the versions on Bach and Mahler are identical
> > before we close the issue.
> Everything looks good on all servers. You're free to close this issue.

Closed.