CDR Tickets

Issue Number 3441
Summary [Mobile] Vendor filter changes to accomodate mobile elements and attributes
Created 2011-11-02 10:32:45
Issue Type Improvement
Submitted By Beckwith, Margaret (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2012-02-16 11:59:02
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107769
Description

BZISSUE::5135
BZDATETIME::2011-11-02 10:32:45
BZCREATOR::Margaret Beckwith
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

We need to make vendor filter changes to handle the new include/exclude mobile attributes, and the new mobile url element. These changes need to be made by Nov. 15 to make it into the next release.
I will create a test document in Mahler that has the table with the "exclude from mobile" attribute, and media links with the "include on mobile" attribute, and that has a mobile url element.

Comment entered 2011-11-03 13:25:15 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-03 13:25:15
BZCOMMENTOR::Bob Kline
BZCOMMENT::1

This needs to be done soon.

Comment entered 2011-11-04 18:19:02 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-04 18:19:02
BZCOMMENTOR::Volker Englisch
BZCOMMENT::2

While I'm working on this I'm starting to have a couple of questions.

1) Will the mobile site be English only or English and Spanish?

2) For sections that are added to the summary by the filter such as
'About PDQ' it's easy to add these new attributes.
However, for SummarySections that are in the document such as the
'To Learn More ...' sections should we ignore any attributes the users
may have set already or should we honor those attributes?

3) Besides the About PDQ and the To Learn More sections which ones will need
to be suppressed?

4) Will the MobileURL be populated before we publish, does it need to be
created by the filter or will it be entered manually?

I'm sure I'll have more questions later.

Comment entered 2011-11-08 12:12:49 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2011-11-08 12:12:49
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::3

See my responses in ALL CAPS next to your questions below:

(In reply to comment #2)
> While I'm working on this I'm starting to have a couple of questions.
> 1) Will the mobile site be English only or English and Spanish? ENGLISH and SPANISH.
> 2) For sections that are added to the summary by the filter such as
> 'About PDQ' it's easy to add these new attributes.
> However, for SummarySections that are in the document such as the
> 'To Learn More ...' sections should we ignore any attributes the users
> may have set already or should we honor those attributes? I AM NOT SURE HOW TO ANSWER THIS; WHAT ATTRIBUTES ARE YOU TALKING ABOUT?
> 3) Besides the About PDQ and the To Learn More sections which ones will need
> to be suppressed? TO LEARN MORE, GET MORE INFORMATION FROM NCI, CHANGES TO THIS SUMMARY, AND ABOUT PDQ
> 4) Will the MobileURL be populated before we publish, does it need to be
> created by the filter or will it be entered manually? IT WILL BE ENTERED PROGRAMMATICALLY USING A SPREADSHEET BEFORE WE PUBLISH FOR THE FIRST RELEASE OF CANCER.GOV MOBILE; AFTER THAT IT WILL BE ENTERED MANUALLY FOR ANY NEW SUMMARY.
> I'm sure I'll have more questions later.

Comment entered 2011-11-08 13:23:12 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-08 13:23:12
BZCOMMENTOR::Volker Englisch
BZCOMMENT::4

(In reply to comment #3)
> > 2) For sections that are added to the summary by the filter such as
> > 'About PDQ' it's easy to add these new attributes.
> > However, for SummarySections that are in the document such as the
> > 'To Learn More ...' sections should we ignore any attributes the users
> > may have set already or should we honor those attributes? I AM NOT SURE HOW TO ANSWER THIS; WHAT ATTRIBUTES ARE YOU TALKING ABOUT?

I'm talking about the IncludedDevices/ExcludedDevices attributes. These attributes are present in the schema which means anybody could enter these and somebody could have entered
<SummarySection ExcludedDevices="ebook"/>
Should I - at this point - ignore any user entered device attributes and create
<SummarySection ExcludedDevices="mobile"/>
or carry over the existing devices and create
<SummarySection ExcludedDevices="ebook mobile"/>

Comment entered 2011-11-15 17:52:12 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-15 17:52:12
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5

(In reply to comment #0)
> I will create a test document in Mahler that has the table with the "exclude
> from mobile" attribute, and media links with the "include on mobile" attribute,
> and that has a mobile url element.

Before I create that test document myself I was wondering if you had already created one on MAHLER?

Comment entered 2011-11-15 19:03:23 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-15 19:03:23
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6

I've modified the following filters to handle the IncludedDevices/ExcludedDevices attributes for SummarySections, MediaLinks, and Tables. I've also updated the Gatekeeper DTD accordingly.
CDR000157 - Vendor Filter: Summary
CDR271370 - Module: Vendor Filter Templates

I will still need an answer to my question in comment #4. At the moment I ignore all user entered attribute values for these two attributes.

This task is not done yet but I believe it is done in the sense that Cancer.gov can receive data.

Comment entered 2011-11-16 10:38:27 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2011-11-16 10:38:27
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::7

I created a test document on Mahler. It is the Bladder Cancer Treatment summary for patients. I must have put a comment about creating this in another issue.

Comment entered 2011-11-16 12:14:34 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-16 12:14:34
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

The Percussion requirements state that the Include/ExcludeDevices attributes are valid for the element LiteralLayout.

Does anybody know what this element was intended for? It has never been used in any of our summaries as far as I can tell and maybe we should just remove it from the DTD rather then coding for a phantom element?

Comment entered 2011-11-16 12:40:04 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-16 12:40:04
BZCOMMENTOR::Bob Kline
BZCOMMENT::9

(In reply to comment #8)
> The Percussion requirements state that the Include/ExcludeDevices attributes
> are valid for the element LiteralLayout.
>
> Does anybody know what this element was intended for? It has never been used
> in any of our summaries as far as I can tell and maybe we should just remove it
> from the DTD rather then coding for a phantom element?

That was for text content which needed to have it's whitespace layout preserved (for example, protocol abstracts converted from the Oracle PDQ system).

Comment entered 2011-11-16 17:31:26 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-16 17:31:26
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

I've modified the filters to preserve/create the IncludedDevices / ExcludedDevices attributes for the following elemants.

[X] Para
[o] LiteralLayout
[X] Table
[X] ItemizedList
[X] OrderedList
[X] QandASet
[o] Contact
[X] MediaLink
[X] SummarySection

o: The LiteralLayout and Contact elements are currently not used within
summaries and I'm guessing this will not change, right?

[ ] MiscellaneousDocLink
Note: I have my doubts that we really want to add the attribute to this
element. Wouldn't we rather want to set the attribute on the
enclosing SummarySection element?

[ ] PlaceHolder
Note: The PlaceHolder is generally used to replace inline text only.
I'm not sure adding the attribute to this element will make much
sense.

[ ] SummaryModuleLink
Note: This is not in production yet, so I will not include the attribute
at the moment.

Comment entered 2011-11-17 17:14:30 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-17 17:14:30
BZCOMMENTOR::Volker Englisch
BZCOMMENT::11

(In reply to comment #2)
> 2) For sections that are added to the summary by the filter such as
> 'About PDQ' it's easy to add these new attributes.
> However, for SummarySections that are in the document such as the
> 'To Learn More ...' sections should we ignore any attributes the users
> may have set already or should we honor those attributes?

As discussed at today's CDR status meeting is has been decided that the existence of a user-entered Included/Excluded-Devices attribute will take precedence over the automated population of these attributes. If the filter encounters an element where either the IncludedDevices or the ExcludedDevices attribute exists, it will leave the existing attribute(s) as is.
There is one exception to this rule, namely when the attribute has been set to ExcludedDevices="None" (or IncludedDevices="All"). In this case the attributes will be removed because the behavior will be identical to the attributes not to exist at all.

Comment entered 2011-11-17 17:28:03 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-17 17:28:03
BZCOMMENTOR::Volker Englisch
BZCOMMENT::12

(In reply to comment #10)
I'd like to summarize what was discussed at our meeting today:
The following elements may contain the new Included/Excluded-Devices attributes:
> [X] Para
> [X] Table
> [X] ItemizedList
> [X] OrderedList
> [X] QandASet
> [X] MediaLink
> [X] SummarySection

These two elements are not being used within a Summary and can be ignored in the summary filters:
> [o] Contact
> [o] LiteralLayout

The PlaceHolder element will be replaced by our filters and substituted by text content. Cancer.gov will never see this element:
> [ ] PlaceHolder

The MiscellaneousDocLink is generally displayed within a SummarySection and the entire SummarySection would need to be suppressed if the content of the DocLink should not be displayed. The attribute could be removed from this element.
> [ ] MiscellaneousDocLink

The SummaryModuleLink is not part of the Summary filters at this point and will need to be handled later. The element will be converted into a SummarySection.
> [ ] SummaryModuleLink

Comment entered 2011-11-18 13:57:50 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-18 13:57:50
BZCOMMENTOR::Volker Englisch
BZCOMMENT::13

I believe I've finished all of the filter and DTD changes that we've talked about yesterday. The filter changes have been copied to SVN
CDR000157 - Vendor Filter: Summary - R10264
CDR271370 - Module: Vendor Filter Templates - R10264

This is ready for testing (which, I guess, will be done by Blair).

Comment entered 2011-12-09 14:58:42 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-12-09 14:58:42
BZCOMMENTOR::Volker Englisch
BZCOMMENT::14

I've modified the DTD and passed it on to Blair. However, based on Bob's discussion with Blair we may need to tweak the DTD a little more.

Comment entered 2012-01-13 13:56:15 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-01-13 13:56:15
BZCOMMENTOR::Volker Englisch
BZCOMMENT::15

Per request I had submitted three summaries with IncludedDevices/ExcludedDevices to Gatekeeper for testing. Blair does not want additional data at this point.

I'm waiting for further instructions from him on when to send a full summary set.

Comment entered 2012-01-13 14:41:50 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-01-13 14:41:50
BZCOMMENTOR::Volker Englisch
BZCOMMENT::16

I ran a test job on MAHLER and identified two problems:
a) I included the Included/ExcludedDevices for both the HP and the Patients
summaries when it should only be added to the patient treatment summaries.
b) I did not remove the 'ExcludedDevices=none' attribute. (See comment 11)
(I did not handle the 'IncludedDevices=all' since this attribute isn't
valid in the DTD/schema.)

This has been fixed now.
CDR000157 - Vendor Filter: Summary

Comment entered 2012-01-20 15:46:42 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-01-20 15:46:42
BZCOMMENTOR::Volker Englisch
BZCOMMENT::17

I've provided the Cancer.gov team with a full set of Summary documents from MAHLER yesterday. The documents were pushed to GatekeeperCA.cancer.gov.

Comment entered 2012-01-27 16:20:29 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-01-27 16:20:29
BZCOMMENTOR::Volker Englisch
BZCOMMENT::18

Filters to migrate later this evening:
CDR000157 - Vendor Filter: Summary - R10300
CDR271370 - Module: Vendor Filter Templates - R10264

Please note from an earlier comment. We will need to address this after the migration now that the SummaryModuleLink is part of the elements available in production:
The SummaryModuleLink is not part of the Summary filters at this point
and will need to be handled later. The element will be converted into a
SummarySection.
> [ ] SummaryModuleLink

Comment entered 2012-01-27 22:17:25 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-01-27 22:17:25
BZCOMMENTOR::Volker Englisch
BZCOMMENT::19

Updating multiple related bugs at once:

The following filters have been updated on BACH:

  • CDR000157 - Vendor Filter: Summary - R10300

  • CDR271370 - Module: Vendor Filter Templates - R10264

  • CDR712005 - Denormalization Filter: Summary Module - R10299

  • CDR723649 - Denormalization Filter: Summary Module IDs - R10299

  • CDR723518 - Denormalization Filter: Summary Count Tables and Figures

  • R10299

  • CDR723519 - Denormalization Filter: Summary Resolve Table and Figure Number

  • R10308

  • CDR335424 - Denormalization Filter: Summary - R10307

  • CDR409593 - Copy XML for Summary Report - R10310

  • CDR609947 - Vendor Filter: Convert CG to Public Data - R10309

The DTD has been updated:

  • pdq.dtd - R10122

  • pdqCG.dtd - R10306

The CSS has been updated:

  • Summary.css - R10312

  • Summary_structure.css - R10312

  • Summary.ctm - R10311

The filter set 'Denormalization Summary Set' has been updated to include the following members:

  • Denormalization Filter: Summary Add Board Member - Spanish

  • Denormalization Filter: Summary Module

  • Denormalization Filter: Summary Module IDs

  • Denormalization Filter: Summary

  • Denormalization Filter: Summary Citation Formatting

  • Denormalization Filter: Summary Reference List

  • Denormalization Filter: Summary Reference De-Dup

  • Denormalization Filter: Summary Reference Numbering

  • Denormalization Filter: Summary InLine Numbering

  • Denormalization Filter: Summary Citation Wrapper Add

  • Denormalization Filter: Summary Citation Wrapper Sort

  • Denormalization Filter: Summary Count Tables and Figures

  • Denormalization Filter: Summary Resolve Table and Figure Number

Comment entered 2012-02-09 10:10:12 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-02-09 10:10:12
BZCOMMENTOR::Volker Englisch
BZCOMMENT::20

The mobile website is soon to be launched. At that point we should be able to close this issue.

Comment entered 2012-02-16 11:59:02 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2012-02-16 11:59:02
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::21

Closing issue since mobile site launched without any issues.

Elapsed: 0:00:00.001876