CDR Tickets

Issue Number 3444
Summary [Deep linking] Changes to vendor filter to allow deep-linking to PDQ content
Created 2011-11-02 10:59:01
Issue Type Improvement
Submitted By Beckwith, Margaret (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2012-07-26 14:39:17
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107772
Description

BZISSUE::5138
BZDATETIME::2011-11-02 10:59:01
BZCREATOR::Margaret Beckwith
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

My notes are vague on this, but it looks like what we need to do is change the vendor filter to include the deep-linking elements and pull them into the top level.

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

BZDATETIME::2011-11-08 12:24:38
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::1

I was hoping that one of you (Bob, Alan,Volker) who were at the meeting with Bryan where we discussed this could expand on the issue. I don't understand it well enough to do that.

Comment entered 2011-11-22 08:58:24 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-22 08:58:24
BZCOMMENTOR::Bob Kline
BZCOMMENT::2

From task #5137:

[X] users identify one or more elements which can be targets
[X] schema on Mahler is modified
[ ] publishing DTD on Mahler is modified
[ ] publishing filter on Mahler is modified
[ ] test summaries are modified, adding perma-targ attributes
[ ] test summaries are published and made available for testing

Comment entered 2011-11-29 17:46:49 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-29 17:46:49
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

I've modified the Cancer.gov DTD and the summary vendor filter to implement the changes for the deep linking:
pdqCG.dtd
CDR000157 - Vendor Filter: Summary

This is ready for testing on MAHLER.
(I've used the document CDR650101 for testing)

Comment entered 2011-11-29 17:47:58 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-11-29 17:47:58
BZCOMMENTOR::Volker Englisch
BZCOMMENT::4

[X] users identify one or more elements which can be targets
[X] schema on Mahler is modified
[X] publishing DTD on Mahler is modified
[X] publishing filter on Mahler is modified
[ ] test summaries are modified, adding perma-targ attributes
[ ] test summaries are published and made available for testing

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

BZDATETIME::2011-12-08 12:18:24
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::5

I was going to add the attributes to the summary,and realized that I have no idea what to put in for PT ID, PT title, or PT url. Do we need to come up with a convention for what gets entered or am I really missing something?

Comment entered 2011-12-08 16:20:50 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-12-08 16:20:50
BZCOMMENTOR::Bob Kline
BZCOMMENT::6

I just spoke with Blair, and we came to the following conclusions:

  • We don't need to send the PermaTargUrl to Gatekeeper. We have no way of
    knowing what that URL will be. We'll keep it in the schema (it's optional)
    as a place where some time in the future we might want a place to store
    the URL we'd get back from Percussion.

  • The PermaTargTitle is also optional; we'll only store a value in that
    attribute when the requestor who asks us to make the portion of the
    document stably linkable specifically provides us with the string he
    or she would like to have appear in the Percussion user interface to
    identify the link target. If the attribute is present, the publishing
    filter will export its value to Gatekeeper. Otherwise, the publishing
    filter will construct a title value using the title of the summary,
    concatenated with the title of the summary section, if the target is
    a summary section which has a section title, concatenated with the
    value of the PermaTargId.

  • The DTD needs to provide Gatekeeper with two IDs for each PermaTarg
    block: one is the PermaTargId (cannot change once the target is
    created) and the other is the fragment ID (cdr:id) of the fragment
    currently represented by the PermaTargId.

  • We need a mechanism in the CDR Server for generating a new PermaTargId.
    One way to implement the mechanism is to have the PermaTargId
    attribute added by the user to a section, with a value recognized
    by the CDR Server as a request that the attribute be populated
    with a newly generated unique ID value. For example, the user
    sets PermaTargId="0" and stores the document, and when the document
    is returned to the client the value "0" is replaced with "103".
    A new task needs to be created in Bugzilla to implement this
    mechanism. Please assign it to Alan, since he is the author of
    the very similar mechanism to automatically populate the cdr:id
    attributes. You could include as part of this task the validation
    logic needed to make sure that once a perma-targ has been created
    it cannot be removed without explicit action taken by a user with
    permission to delete a perma-targ, or you could make a separate
    task for the validation.

Comment entered 2011-12-16 09:57:56 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2011-12-16 09:57:56
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7

Adding Alan as a CC.

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

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

Waiting for Alan's changes in OCECDR-3469 to be completed.

Comment entered 2012-05-18 18:52:43 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-05-18 18:52:43
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9

(In reply to comment #6)
> * The PermaTargTitle is also optional; ... Otherwise, the publishing
> filter will construct a title value using the title of the summary,
> concatenated with the title of the summary section, if the target is
> a summary section which has a section title, concatenated with the
> value of the PermaTargId.

For right now I am not including the PermaTargId value to the concatenated PermaTargTitle since this attribute is already available as a separate attribute for PermaTarg. It's easy to add if Blair still wants to have that included.

The filter has been modified and is ready for testing on MAHLER.

Comment entered 2012-05-21 18:12:33 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-05-21 18:12:33
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

As discussed earlier, the DTD has been modified to define the Permatargs as follows:
<!ELEMENT PermaTargs (PermaTarg+)>

<!ELEMENT PermaTarg EMPTY>
<!ATTLIST PermaTarg FragmentId CDATA #REQUIRED
PermaTargId CDATA #REQUIRED
PermaTargTitle CDATA #IMPLIED
PermaTargUrl CDATA #IMPLIED>

Comment entered 2012-05-21 18:14:44 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-05-21 18:14:44
BZCOMMENTOR::Volker Englisch
BZCOMMENT::11

Modified DTD for Cancer.gov including the new PermaTargs block (SVN - R10404)

Comment entered 2012-05-21 18:14:44 by Englisch, Volker (NIH/NCI) [C]

Attachment pdqCG.dtdR10404 has been added with description: PDQ DTD for Cancer.gov

Comment entered 2012-06-12 11:30:37 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-06-12 11:30:37
BZCOMMENTOR::Volker Englisch
BZCOMMENT::12

William has marked up these summaries on MAHLER to include PermaTargs:

62707 Non-Hodgkin Lymphoma Treatment
62832 Lung Cancer Screening
62787 Breast Cancer Treatment
62956 Non-Small Cell Lung Cancer Treatment
458088 Acupuncture
62845 Pain

I ran a publishing job on MAHLER for these documents and pushed them to Gatekeeper CA for Blair to process.

Comment entered 2012-06-28 11:45:13 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2012-06-28 11:45:13
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::13

I just want to add a comment here about the fact that we can't add permatargs to sections of documents that have an "exclude from mobile" or "exclude from desktop" attribute on them. Basically any section that is meant to be used only on mobile or only on desktop can't have one because publishing will fail. This happened with the Patient Non-small cell lung cancer summary when the permatarg was added to the Related Info section and the Changes section. These sections get the "exclude from mobile" attribute added during publishing. William corrected this summary and Volker came in off the beach long enough to republish it (thanks!).

Comment entered 2012-07-06 18:33:00 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-07-06 18:33:00
BZCOMMENTOR::Volker Englisch
BZCOMMENT::14

These summaries have been republished because there was a problem with the SummaryRef href-ID which was caused due to a bug in the code for the Summary Module changes.

Comment entered 2012-07-12 10:31:08 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2012-07-12 10:31:08
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::15

(In reply to comment #12)
> William has marked up these summaries on MAHLER to include PermaTargs:
> 62707 Non-Hodgkin Lymphoma Treatment
> 62832 Lung Cancer Screening
> 62787 Breast Cancer Treatment
> 62956 Non-Small Cell Lung Cancer Treatment
> 458088 Acupuncture
> 62845 Pain
> I ran a publishing job on MAHLER for these documents and pushed them to
> Gatekeeper CA for Blair to process.

I have included a summary module in 62707 to test OCECDR-3404

Comment entered 2012-07-23 17:00:50 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2012-07-23 17:00:50
BZCOMMENTOR::Volker Englisch
BZCOMMENT::16

The following filter has been copied to BACH:
CDR000157: Vendor Filter: Summary - R10470

The HP disclaimer text (OCECDR-3489) can now be previewed in PublishPreview.
For the module and deep-linking changes the documents will need to be prepared and for the screening and prevention changes the MobileURL element will need to be populated. The ExcludeDevices attribute could be checked in the XML.

Comment entered 2012-07-26 14:39:17 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2012-07-26 14:39:17
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::17

(In reply to comment #16)
> The following filter has been copied to BACH:
> CDR000157: Vendor Filter: Summary - R10470

We decided in today's CDR Meeting to close this issue.
Issue closed.

Attachments
File Name Posted User
pdqCG.dtdR10404 2012-05-21 18:14:44 Englisch, Volker (NIH/NCI) [C]

Elapsed: 0:00:00.001590