CDR Tickets

Issue Number 5142
Summary [Summary] Modify Comment element to easily identify notes meant for translators
Created 2022-09-21 16:44:41
Issue Type New Feature
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2022-09-23 13:32:14
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.328099
Description

As a translator, I want to be able identify comments in a summary that have specifically been left for me so that I can apply it during translation.

Several comments are left in a summary document for both internal and external users. Some of the internal comments are meant specifically for translators. However, it is sometimes difficult to identify the specific translation comments among the other comments within the summary document. We would want to be able mark a comment that has specifically been left for translators so that they can be easily identified.

 

Acceptance criteria:

Scenario: CDR has the ability to mark comments specifically for translation

Given I am a CDR summary editor

  And I have permissions to create or modify summaries

 When I create or modify a summary that needs to be translated

     And I add a comment for translators

Then I want to be able to “tag” the comment accordingly

Comment entered 2022-09-21 17:02:51 by Kline, Bob (NIH/NCI) [C]

Your two scenarios are asking for two distinct things. The second would be a styling change which would implement (so probably needs a separate ticket). The first would seem to call for expanding the list of valid values for the audience attribute of the Comment element (type {}CommentAudience{}). Do you agree?

Comment entered 2022-09-21 17:27:08 by Osei-Poku, William (NIH/NCI) [C]

I agree on moving the second scenario to another ticket.


The first would seem to call for expanding the list of valid values for the audience attribute of the Comment element (type {}CommentAudience{}). Do you agree?

I am hesitant to add another value to the list of audiences because that captures the two main categories of audience and what we are asking for is a type of Internal audience. Would it be possible to make change so that when Internal is selected, there will be a secondary attribute value of "ForTranslators", for example to select within the element? I think there is a similar feature in Person and Organization address blocks or so. The default would just be internal without any further selection but there will be an option to  select "ForTranslators", if needed.

Comment entered 2022-09-21 17:57:40 by Englisch, Volker (NIH/NCI) [C]

I agree with . Modifying the 'audience' feels like a can of worms.  I would still consider the translator comments as internal - with an asterisk.

Comment entered 2022-09-22 08:32:36 by Kline, Bob (NIH/NCI) [C]

Hmm, it would seem then that we picked the wrong name for that attribute, because the "{}audience{}" for the comment is exactly what you're trying to convey. Perhaps "{}visibility"{} or "{}scope"{} would have been more appropriate. Oh, well, probably too late now to do anything about that problem.

Can you show me an example of the feature you referred to for Person and Organization address blocks?

Comment entered 2022-09-22 12:01:24 by Osei-Poku, William (NIH/NCI) [C]


Can you show me an example of the feature you referred to for Person and Organization address blocks?

Please see CDR0000002202 and CDR0000029008 on DEV. Here are screenshots too.

Comment entered 2022-09-22 12:58:18 by Kline, Bob (NIH/NCI) [C]

What I'm looking for is an example of the behavior you described above, in which a second attribute appears on an element only if a first attribute has a specific value.

Comment entered 2022-09-22 13:27:47 by Englisch, Volker (NIH/NCI) [C]

We don't have that currently.

Comment entered 2022-09-23 11:12:23 by Osei-Poku, William (NIH/NCI) [C]

As we discussed in the CDR meeting yesterday, I have removed the second scenario so that this ticket will focus on just the schema change.

Comment entered 2022-09-23 13:32:14 by Kline, Bob (NIH/NCI) [C]

New optional  specific-internal-audience attribute added to the Comment element, with a valid value set initially containing only the single "translators" value. Installed on CDR DEV.

Comment entered 2023-03-07 10:07:35 by Kline, Bob (NIH/NCI) [C]
Comment entered 2023-03-21 15:54:36 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV.

Comment entered 2023-05-09 12:44:37 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA.

Comment entered 2023-06-01 11:47:27 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD. Thanks!

Attachments
File Name Posted User
Public contact.PNG 2022-09-22 12:00:29 Osei-Poku, William (NIH/NCI) [C]
Public contact1.PNG 2022-09-22 12:00:52 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001475