CARDS-2679: Populate selectable area question with selectable zone options on variant selection #1960

veronikaslc · 2025-05-01T20:22:49Z

CARDS-2679

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

modules/data-entry/src/main/frontend/src/questionnaireEditor/ListInput.jsx

modules/data-entry/src/main/frontend/src/questionnaireEditor/bodyParts.json

veronikaslc · 2025-05-12T16:08:48Z

@marta- Can you please post here what we decided to do on the last meeting? My memory is not clear

...ata-entry/src/main/resources/SLING-INF/content/libs/cards/dataEntry/SelectableArea/Face.json

modules/data-model/forms/api/src/main/resources/SLING-INF/nodetypes/forms.cnd

modules/data-entry/src/main/frontend/src/questionnaireEditor/ListInput.jsx

marta- · 2025-05-15T01:04:20Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

+    if (optionsLoaded && fieldsReader?.variant && fieldsReader.variant.length > 0) {
+      let selectableZones = {}; //here we get the zones json from the JCR node corresponding to variant


Instead of pulling variant specifically, we look through the context and see if any of the stored fields also provide defaultOptions. If yes, we use that map to load generate the answer options. If there's more than one entry in the context that specifies defaultOptions, I think it's reasonable to only take into account the first one.

marta- · 2025-05-15T22:47:16Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/EditorInput.jsx

              <FormattedText variant="caption">{hint}</FormattedText>
            }>
-              <Info color="primary" />
+              <Info color="primary" sx={{mb: "-2px", ml: "2px"}}/>


This doesn't seem to have any effect. Instead, adding display: flex to the Typography style helps improve and control the alignment.

marta- · 2025-05-15T22:47:42Z

modules/data-model/forms/api/src/main/resources/SLING-INF/nodetypes/forms.cnd

+  //Children
+
+  // Container for the selectable zones names corresponding to the variant
+  + defaultOptions (nt:unstructured)


Add new line at the end of the file.

marta- · 2025-05-15T22:49:07Z

modules/utils/src/main/java/io/uhndata/cards/serialize/internal/DefaultOptionsProcessor.java

+        final Function<Node, JsonValue> serializeNode)
+    {
+        try {
+            if (child.getName().equals("defaultOptions")) {


Even though child is expected to have a name, flipping the two is always safer:

Suggested change

if (child.getName().equals("defaultOptions")) {

if ("defaultOptions".equals(child.getName())) {

marta- · 2025-05-16T01:05:34Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

+          "@path": path + "/AnswerOption" + stringToHash(key)
+     }));
+
+      setOptions(variantOptions);


Bug: every time a selectable area question is opened for editing, the options are overwritten with the ones defined by the selected variant.

Addressed in b8ceeea - although I'm not very happy with the method (having a state variable that is set to true when options are generated from defaultOptions, and to false in all places that update options from user input. A more elegant solution is welcome.

Bug: now once user customes any variat selection it's not possible to change variant and prepopulate another set.

That is intentional so the user wouldn't lose their work.

However, it sounds like the right way to approach this is to enable the user to choose what they want to do with the suggested answer options. When different suggested options are available in the context, display a dialog that shows existing options (if any) and suggested options, and allow the user to merge the suggested into the existing, replace the existing with the suggested, or ignore the suggestions.

marta- · 2025-05-16T01:05:45Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

+        .map(([key, value]) => ({
+          label: value,
+          value: key,
+          noneOfTheAbove : false,


noneOfTheAbove: false is unnecessary.

Removed in b8ceeea .

marta- · 2025-05-16T01:05:51Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

+          label: value,
+          value: key,


Not a big deal, but label = value and value = key is a bit odd. Better names for the arguments would help.

Changed [key, value] to [key, label] in b8ceeea .

marta- · 2025-05-16T01:06:05Z

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx

+  // Pre-populate selectableQuestion answer options with selectable zones according to the selected variant if any selected
+  useEffect(() => {
+    if (fieldsReader?.variant?.[0]?.defaultOptions) {
+      let variantOptions = Object.entries(fieldsReader?.variant?.[0]?.defaultOptions)
+        .filter(([key]) => !key.startsWith("@") && !key.startsWith("jcr:"))
+        .map(([key, value]) => ({
+          label: value,
+          value: key,
+          noneOfTheAbove : false,
+          "@path": path + "/AnswerOption" + stringToHash(key)
+     }));
+
+      setOptions(variantOptions);
+    }
+  },
+  [fieldsReader.variant]);
+


This code still references variant specifically, and the comments mention selectable zones. Instead, it should be agnostic of the question type. Any structured property that defines defaultOptions should be able to populate the answer options.

Addressed in commit b8ceeea - only lightly tested.

marta- · 2025-05-16T01:14:26Z

Usability issue: now that the defaultOptions are loaded from a node, their order looks random and "Left foot" may appear before "Jaw". I could not think of any quick fixes yet. Ideas to improve this are welcome @veronikaslc @sdumitriu .

…tions on variant selection

…tions on variant selection Better variable name

…tions on variant selection Proper resource management

…tions on variant selection Addressed codereview comments

…tions on variant selection * Made the code that extracts defaultOptions from variant nodes more generic * Bug fix: prevented the variant's defaultOptions from always overwriting user options * Minor polishing of the generated options

veronikaslc force-pushed the selectable-options branch 2 times, most recently from 0ab1fa8 to a2e97ac Compare May 1, 2025 20:27

This comment was marked as resolved.

Sign in to view

marta- reviewed May 1, 2025

View reviewed changes

modules/data-entry/src/main/frontend/src/questionnaireEditor/AnswerOptions.jsx Outdated Show resolved Hide resolved

marta- reviewed May 1, 2025

View reviewed changes

modules/data-entry/src/main/frontend/src/questionnaireEditor/ListInput.jsx Show resolved Hide resolved

marta- reviewed May 1, 2025

View reviewed changes

modules/data-entry/src/main/frontend/src/questionnaireEditor/bodyParts.json Outdated Show resolved Hide resolved

veronikaslc force-pushed the selectable-options branch from a2e97ac to 4b67215 Compare May 2, 2025 00:41

veronikaslc changed the title ~~[misc] Populate selectable are question with body part options on variant selection~~ CARDS-2679: Populate selectable area question with selectable zone options on variant selection May 2, 2025

Base automatically changed from mui-upgrade to dev May 4, 2025 23:29

marta- reviewed May 15, 2025

View reviewed changes

...ata-entry/src/main/resources/SLING-INF/content/libs/cards/dataEntry/SelectableArea/Face.json Outdated Show resolved Hide resolved

marta- reviewed May 15, 2025

View reviewed changes

modules/data-model/forms/api/src/main/resources/SLING-INF/nodetypes/forms.cnd Outdated Show resolved Hide resolved

marta- reviewed May 15, 2025

View reviewed changes

modules/data-entry/src/main/frontend/src/questionnaireEditor/ListInput.jsx Show resolved Hide resolved

marta- reviewed May 15, 2025

View reviewed changes

veronikaslc added the Test me! Ready for testing label May 15, 2025

marta- reviewed May 15, 2025

View reviewed changes

marta- reviewed May 16, 2025

View reviewed changes

marta- added the testing... Testing in progress label May 16, 2025

veronikaslc added incomplete Some of the target functionality has not yet been implemented and removed Test me! Ready for testing testing... Testing in progress labels May 20, 2025

veronikaslc added the on hold To be reviewed at a later time, awaiting other fixes, decisions, etc. label Jun 24, 2025

veronikaslc added 2 commits November 18, 2025 01:42

CARDS-2679: Populate selectable area question with selectable zone op…

e30c307

…tions on variant selection

CARDS-2679: Populate selectable area question with selectable zone op…

c332ee3

…tions on variant selection Better variable name

veronikaslc and others added 5 commits November 18, 2025 01:42

CARDS-2679: Populate selectable area question with selectable zone op…

7e7aa9e

…tions on variant selection Proper resource management

[misc] Better tooltip icon positioning

0de7cf1

[misc] Avoid input switch from uncontrollable to controllable behaviour

76ec805

CARDS-2679: Populate selectable area question with selectable zone op…

374233f

…tions on variant selection Addressed codereview comments

veronikaslc force-pushed the selectable-options branch from b8ceeea to 5db6aae Compare November 18, 2025 06:45

		if (optionsLoaded && fieldsReader?.variant && fieldsReader.variant.length > 0) {
		let selectableZones = {}; //here we get the zones json from the JCR node corresponding to variant

	if (child.getName().equals("defaultOptions")) {
	if ("defaultOptions".equals(child.getName())) {

CARDS-2679: Populate selectable area question with selectable zone options on variant selection #1960

Are you sure you want to change the base?

CARDS-2679: Populate selectable area question with selectable zone options on variant selection #1960

Uh oh!

Conversation

veronikaslc commented May 1, 2025 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

veronikaslc commented May 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marta- commented May 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

veronikaslc commented May 1, 2025 •

edited by atlassian bot

Loading