| Issue Number | 3323 |
|---|---|
| Summary | Misplaced term comments |
| Created | 2011-03-16 10:20:21 |
| Issue Type | Improvement |
| Submitted By | Osei-Poku, William (NIH/NCI) [C] |
| Assigned To | Kline, Bob (NIH/NCI) [C] |
| Status | Closed |
| Resolved | 2011-03-31 11:57:52 |
| Resolution | Fixed |
| Path | /home/bkline/backups/jira/ocecdr/issue.107651 |
BZISSUE::5016
BZDATETIME::2011-03-16 10:20:21
BZCREATOR::William Osei-Poku
BZASSIGNEE::Bob Kline
BZQACONTACT::William Osei-Poku
Bob's comments taken from OCECDR-3294 comment #10
2. I also noticed that the schema allows Comment elements at
two
different places at the top level of the document. Using
proximity to associate two sibling elements is not the best
way to indicate that the two elements belong with each other
(the proper way to do that is to use a wrapper element which
contains both elements). Having this ambiguity in the schema
made it unnecessarily tricky to identify the proper position
at which the new elements were to be inserted. I recommend
that we consider modifying the schema (and the documents, if
Comment elements have been used at both positions) so that
Comment elements which apply to the entire document are all
located in the same place, and those which don't apply to the
entire document are appropriately nested at the position
where they logically belong. Because of this problem, I
strongly suggest that the review of the converted documents
look at the entire documents (not just the diffs) to confirm
that the program found the right location for the new elements.
BZDATETIME::2011-03-16 10:21:26
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::1
Email follow up from Bob:
---Original Message
From: Bob Kline bkline@rksystems.com
Sent: Friday, March 11, 2011 6:29 PM
To: Margaret Beckwith; Osei-Poku, William; Volker Englisch; Alan
Meyer
Subject: Misplaced term comments
Didn't see an issue for this, but here's the requested report for
the
Comment elements inserted near the top of the Term documents.
Please
review these to determine whether there's any information which would
be
lost be moving all of these to the standard position for top-level
Comment elements, just above the PdqKey and DateLastModified
elements.
If so, we'll discuss how to repackage those elements to preserve
that
information while eliminating the ambiguity in the schema.
Otherwise,
we'll just move them to the standard Comment position.
BZDATETIME::2011-03-21 10:28:46
BZCOMMENTOR::Bob Kline
BZCOMMENT::2
As I recall the discussion of this issue at Thursday's meeting, we decided to add an attribute to the definition of the Comment element in the common schema and move the Comments in Term documents to the standard position near the bottom of the documents. The new attribute will be named 'context' and will be populated manually by CIAT with "PreferredName" for the subset of the elements to be moved for which this value is appropriate. Does this match everyone else's recollection?
BZDATETIME::2011-03-21 13:23:32
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::3
(In reply to comment #2)
> As I recall the discussion of this issue at Thursday's meeting, we
decided to
> add an attribute to the definition of the Comment element in the
common schema
> and move the Comments in Term documents to the standard position
near the
> bottom of the documents. The new attribute will be named
'context'
Yes. The above is correct.
> and will be
> populated manually by CIAT with "PreferredName" for the subset of
the elements
> to be moved for which this value is appropriate. Does this match
everyone
> else's recollection?
I think we agreed that the new attribute will only be assigned to new comments elements going forward and not for existing comments that are going to be moved.
Also, I hope it is okay to user "Preferred Name" instead of "PreferredName" as that is what most users are familiar with.
BZDATETIME::2011-03-21 14:05:52
BZCOMMENTOR::Bob Kline
BZCOMMENT::4
(In reply to comment #3)
> Also, I hope it is okay to user "Preferred Name" instead of
"PreferredName" as
> that is what most users are familiar with.
It will uncontrollled uncontrolled free text, in order to make it as generally useful as possible, so you can enter anything you like.
BZDATETIME::2011-03-21 14:06:41
BZCOMMENTOR::Bob Kline
BZCOMMENT::5
(In reply to comment #4)
> It will uncontrollled uncontrolled free text, in order to make
it as generally
> useful as possible, so you can enter anything you like.
I meant to type "It will accept uncontrolled free text, ...." :-)
BZDATETIME::2011-03-22 11:54:44
BZCOMMENTOR::Bob Kline
BZCOMMENT::6
The schema modifications have been installed on Mahler.
BZDATETIME::2011-03-23 10:42:40
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::7
(In reply to comment #6)
> The schema modifications have been installed on Mahler.
Verified schema change on Mahler. I guess the next step will be the global change to move the comments. Should I create a new issue for that?
BZDATETIME::2011-03-23 11:19:39
BZCOMMENTOR::Bob Kline
BZCOMMENT::8
(In reply to comment #7)
> Verified schema change on Mahler. I guess the next step will be
the global
> change to move the comments. Should I create a new issue for
that?
Too late. :-) I've already done the work. Ready for review on Mahler:
http://mahler.nci.nih.gov/cgi-bin/cdr/ShowGlobalChangeTestResults.py?dir=2011-03-22_18-01-20
You'll notice some documents at the bottom which have no changes. These are documents that are not valid to start with; most (if not all) have OtherName elements where they shouldn't be. I realized that I could have tightened up the logic to eliminate these documents from this task's global change job (and I will before we do a live test on Mahler), but I wanted to make sure you have a chance to see those documents first. We'll need another task to clean those up.
BZDATETIME::2011-03-23 17:33:26
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::9
(In reply to comment #8)
> (In reply to comment #7)
>
> You'll notice some documents at the bottom which have no changes.
These are
> documents that are not valid to start with; most (if not all) have
OtherName
> elements where they shouldn't be. I realized that I could have
tightened up
> the logic to eliminate these documents from this task's global
change job (and
> I will before we do a live test on Mahler), but I wanted to make
sure you have
> a chance to see those documents first. We'll need another task to
clean those
> up.
Done! OCECDR-3331
I looked at the test results and they all appear to be fine except one that seems to be removing and adding back the pdqkey:
CDR0000042760
+ <PdqKey>
+ 6557
+ </PdqKey>
<PdqKey>
6557
</PdqKey>
I think we are ready for a live run on Mahler.
BZDATETIME::2011-03-24 10:15:39
BZCOMMENTOR::Bob Kline
BZCOMMENT::10
(In reply to comment #9)
> I looked at the test results and they all appear to be fine
except one that
> seems to be removing and adding back the pdqkey:
>
> CDR0000042760
Actually, that was a case in which the software was confused by misplaced OtherName elements, and it moved a Comment element when no Comment elements were out of place. I've modified the software to avoid that problem. Here's another test run on Mahler:
http://mahler.nci.nih.gov/cgi-bin/cdr/ShowGlobalChangeTestResults.py?dir=2011-03-24_10-03-49
BZDATETIME::2011-03-29 16:24:45
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::11
(In reply to comment #10)
> (In reply to comment #9)
>
> > I looked at the test results and they all appear to be fine
except one that
> > seems to be removing and adding back the pdqkey:
> >
> > CDR0000042760
>
> Actually, that was a case in which the software was confused by
misplaced
> OtherName elements, and it moved a Comment element when no Comment
elements
> were out of place. I've modified the software to avoid that
problem. Here's
> another test run on Mahler:
>
> http://mahler.nci.nih.gov/cgi-bin/cdr/ShowGlobalChangeTestResults.py?dir=2011-03-24_10-03-49
I looked at some of the test results and they looked good. Please run in live mode on Franck.
BZDATETIME::2011-03-29 17:22:29
BZCOMMENTOR::Bob Kline
BZCOMMENT::12
(In reply to comment #11)
> Please run in live mode on Franck.
Done.
BZDATETIME::2011-03-30 11:09:38
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::13
(In reply to comment #12)
> (In reply to comment #11)
>
> > Please run in live mode on Franck.
>
> Done.
Verified on Franck. Please run in test mode on Bach.
BZDATETIME::2011-03-30 14:13:51
BZCOMMENTOR::Bob Kline
BZCOMMENT::14
(In reply to comment #13)
> Please run in test mode on Bach.
Done:
http://bach.nci.nih.gov/cgi-bin/cdr/ShowGlobalChangeTestResults.py?dir=2011-03-30_12-53-42
BZDATETIME::2011-03-30 15:59:26
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::15
(In reply to comment #14)
> (In reply to comment #13)
>
> > Please run in test mode on Bach.
>
> Done:
>
> http://bach.nci.nih.gov/cgi-bin/cdr/ShowGlobalChangeTestResults.py?dir=2011-03-30_12-53-42
Verified. Please run in live mode on Bach.
BZDATETIME::2011-03-30 16:18:48
BZCOMMENTOR::Bob Kline
BZCOMMENT::16
(In reply to comment #15)
> Verified. Please run in live mode on Bach.
Done.
BZDATETIME::2011-03-31 11:57:52
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::17
(In reply to comment #16)
> (In reply to comment #15)
>
> > Verified. Please run in live mode on Bach.
>
> Done.
Verified on Bach.
A couple of the comments with long text which are mostly URLs stretch beyond the space provided for the comment field. The text overflows beyond the right edge of the comment field (box). I think this is a CSS issue so I will put in an issue for Volker to take a look.
I am closing this issue. Thank you!
Elapsed: 0:00:00.001557