Skip to content

Updated custom outputType options for researchOutputTable to include "description"/"comment" #12

@jupiter007

Description

@jupiter007

Currently, when a user saves a custom output type in Research output table question form, it is saved in the question's JSON like:

{
			"meta": {
				"schemaVersion": "1.0",
				"labelTranslationKey": "researchOutput.outputType"
			},
			"content": {
				"meta": {
					"schemaVersion": "1.0"
				},
				"type": "selectBox",
				"options": [
					{
						"label": "Audiovisual",
						"value": "audiovisual",
						"selected": false
					},
					{
						"label": "Collection",
						"value": "collection",
						"selected": false
					},
					{
						"label": "Data paper",
						"value": "data-paper",
						"selected": false
					},
					{
						"label": "Dataset",
						"value": "dataset",
						"selected": false
					},
					{
						"label": "Event",
						"value": "event",
						"selected": false
					},
					{
						"label": "Image",
						"value": "image",
						"selected": false
					},
					{
						"label": "Interactive resource",
						"value": "interactive-resource",
						"selected": false
					},
					{
						"label": "Model",
						"value": "model",
						"selected": false
					},
					{
						"label": "Other",
						"value": "other",
						"selected": false
					},
					{
						"label": "Physical object",
						"value": "physical-object",
						"selected": false
					},
					{
						"label": "Service",
						"value": "service",
						"selected": false
					},
					{
						"label": "Software",
						"value": "software",
						"selected": false
					},
					{
						"label": "Sound",
						"value": "sound",
						"selected": false
					},
					{
						"label": "Text",
						"value": "text",
						"selected": false
					},
					{
						"label": "Workflow",
						"value": "workflow",
						"selected": false
					},
					{
						"label": "My output type",
						"value": "my-output-type",
						"selected": false
					}
				],
				"attributes": {
					"help": "",
					"multiple": false,
					"labelTranslationKey": "researchOutput.outputType.heading"
				}
			},
			"enabled": true,
			"heading": "Output Type",
			"required": true
		},

However, when they add a custom output type, they should be able to add a "description" field that will be used with the "info icon" tooltip, so that users can click on the "info icon" to get more details about that specific output type. However, there is currently no place to store that in the schema.

We need to add description to the schema. It should be optional so that it is backwards compatible We can replace "Selected" with "Description" because we don't need selected in this view.

This is to support when people add custom variables to the Output Types with descriptions, where we have the user enter it for their own variables and we take a snapshot of the description from the default ones.

Image

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions