CDR Tickets

Issue Number 4587
Summary Modify XML tool for World Server translation
Created 2019-03-01 11:22:31
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2019-07-03 17:48:47
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.240899
Description

Please modify the program used for generating xml files of CDR summaries to translate in World Server, to exclude text marked up with the "proposed" RevisionLevel attribute.

Comment entered 2019-06-20 19:51:49 by Kline, Bob (NIH/NCI) [C]

Let's drill down into these requirements some more. I have always assumed that the program would only have been used after the revision markup in the original English document had been resolved and eliminated one way or another, since it didn't seem like a good idea to start translating until the creators of the document being translated were finished deciding what should be in that document. However, this request leads me to believe that this assumption was wrong. So the first thing to bear in mind is that "text marked up with the 'proposed' RevisionLevel attribute" could be referring to an Insertion or a Deletion element. Dropping the contents of both of these elements based on the value of the RevisionLevel attribute is logically inconsistent. If that doesn't make sense, think about this: an Insertion element with RevisionLevel="proposed" means (in this context): "someone proposed adding this content to the document, but hasn't succeeded in convincing anyone to approve that addition." In that case, it makes sense to conclude that you might want to drop the element and its contents. However, a Deletion element with RevisionLevel="proposed" means "someone proposed removing this existing content from the document, but hasn't succeeded in convincing anyone to approve that removal." You can see (I hope) that proceeding with the removal anyway, in spite of the fact that the proposed removal was disapproved (or at least was not approved) is going in the opposite direction taken for a proposed (but not approved) addition of content.

Also, are you implying that you want all of the other revision markup preserved? I would suggest that you consider either having the software apply the standard revision markup resolution we use in similar cases (we have a filter to do that), specifying the level of changes (both insertions and deletions) which you want applied, abandoning the changes which have a "lower" RevisionLevel value, or (and, as noted above, it could be argued that this would be the preferred approach), defer the use of the program to export the English summary document until all the decisions about what should actually be in the document have already been made (and applied using the filter to which I just referred), making this ticket unnecessary.

I'm assigning the ticket to you, , for clarification of the requirements.

Comment entered 2019-06-21 08:55:20 by Osei-Poku, William (NIH/NCI) [C]

 One quick question. My understanding about this is that the program generates the XML based on the last publishable version of the summary. So, I would assume that there wouldn't be any deletion or insertion markup in the XML file. Is this how we should expect the program to behave?

Comment entered 2019-06-21 11:26:08 by Kline, Bob (NIH/NCI) [C]

Comment entered 2019-06-21 12:58:28 by Osei-Poku, William (NIH/NCI) [C]

Thanks! So, it looks like if we are using the publishable version then we shouldn't be running into this issue. I will check with Linda and perhaps conclude that this change is not needed.

Comment entered 2019-07-03 12:12:12 by Osei-Poku, William (NIH/NCI) [C]

We agreed on having you apply the standard revision markup resolution instead of the proposed exclusion of all proposed revision level markup.

Comment entered 2019-07-03 17:48:47 by Kline, Bob (NIH/NCI) [C]

The tool has been modified on DEV. Here's a pair of links you can use to start testing. Be careful to pay attention to nested revision markup. For example, you might be tempted to think that the contents of a Deletion element with a RevisionLevel of proposed should show up in the document, and often that is how it should work. However, if that Deletion element is itself enclosed in an Insertion element which also has a RevisionLevel of proposed, then that whole block will be gone in the retrieved summary. Tricky stuff, that revision markup. 🙂

https://cdr-dev.cancer.gov/cgi-bin/cdr/get-english-summary.py?id=62687&ver=lastp

versus

https://cdr-dev.cancer.gov/cgi-bin/cdr/ShowCdrDocument.py?Session=guest&vtype=lastpub&doc-id=62687

Comment entered 2019-07-04 09:22:02 by Kline, Bob (NIH/NCI) [C]
Comment entered 2019-07-11 10:57:32 by Osei-Poku, William (NIH/NCI) [C]

Could you please run the program on version 404 and post the link ?

Comment entered 2019-07-11 11:36:05 by Kline, Bob (NIH/NCI) [C]

Actually, you can run the script on any version you like

https://cdr-dev.cancer.gov/cgi-bin/cdr/get-english-summary.py

Comment entered 2019-07-23 14:12:48 by Osei-Poku, William (NIH/NCI) [C]

The tool works well in handling the proposed text now. So, the issue appears to be fixed now. Thanks!

However, we ran into another problem that has to to with "Approved" Insertion and Deletion markup in one of the documents on DEV CDR62932 version 399. The "Approved" Insertion markup text in the summary is included in the XML while the "Approved" Deletion text is deleted from the XML. Is this the expected behavior of the program? While users assign "Approved" revision level attributes to the text, they really not ready to publish yet and they should not be translated yet.

Comment entered 2019-07-23 14:35:46 by Kline, Bob (NIH/NCI) [C]

If you want to change the level passed to the filter, please create a new ticket.

Comment entered 2019-07-23 14:42:26 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thanks!

Comment entered 2019-08-05 15:52:34 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

Comment entered 2019-09-09 09:36:19 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD. Thanks!

Attachments
File Name Posted User
image-2019-06-21-11-25-31-088.png 2019-06-21 11:25:33 Kline, Bob (NIH/NCI) [C]

Elapsed: 0:00:00.001220