standardize license configuration

[philippconzett]

What this PR does / why we need it: This PR is part of the work to make license information from Dataverse installations harvestable in a way that complies with DataCite recommendations as described in issue #8512 Standardize standard license configuration.

Which issue(s) this PR closes: Together with other PRs, this PR closes #8512.

Special notes for your reviewer: See my comment from January 5, 2023 to issue #8512.

Suggestions on how to test this: In a test environmen:

1. Install the JSON license files.
2. Create a dataset.
3. Select a standard license.
4. Export DataCite metadata.
5. Verify that the license information is as recommended by DataCite.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: No.

Is there a release notes update needed for this change?: Yes. See my comment from January 5, 2023 to issue #8512.

Additional documentation: The longer we wait implementing this change, the more installations will have to do clean-ups. Therefore, I hope this PR can be prioritized.

[pdurbin]

@philippconzett hi! Just checking if you're open to adding additional JSON files (additional licenses) to this PR. Please see some comments from earlier today starting here: https://github.com/IQSS/dataverse.harvard.edu/issues/193#issuecomment-1372560833

Alternatively, we could add them later, of course, in a new PR.

[pdurbin]

JP and I just wrote some guidance on adding licenses the future: https://github.com/IQSS/dataverse/pull/10426#issuecomment-2050108042

Please take a look and let us know what you think!

[jmurugan-fzj]

@pdurbin Where can I find the up-to-date list of licenses which could be used for the dataset creation? More specifically, what all values can be provided in the metadata "name" field below while creating the data set in dataverse

I tried "CC0 1.0" & "CC BY 4.0", both of them succeed, whereas the other versions for e.g. "CC BY 3.0" simply fails with the following server error: Reason: Bad Request, Info: {'status': 'ERROR', 'message': 'Error parsing Json: Invalid or unsupported license: CC BY 3.0'}

At-least it would be nice to see the list of presently supported values for "name" field, is this documented somewhere? I looked in the help pages, but could not find it anywhere quickly: complete list of presently supported license names!

Also I have noticed that the value set for "uri" field is not considered at all during the dataset creation, even if I give some wrong URI or invalid value too, the dataset is created with the license specified in the name field and appropriate URI is automatically populated from the name, is this a bug?

Metadata reference: dataset-create-new-all-default-fields.json

[pdurbin]

@jmurugan-fzj hi! Now that the following #10426 has been merged, there is new guidance coming in the next release (probably 6.3) on what to put for "name", "uri" etc. Here's a screenshot from a preview at https://dataverse-guide--10426.org.readthedocs.build/en/10426/installation/config.html#contributing-to-the-collection-of-standard-licenses-above

Does that help?

[qqmyers]

FWIW: /api/licenses tells you which licenses are installed and active (ones you can select for a new/draft dataset) for a give Dataverse installation.

[jp-tosca]

Hi @jmurugan-fzj, regarding your 3 points:

1. This message is a bit unclear, sorry about that. This is not a parsing error but indeed this happens because the license is not installed.
2. As @qqmyers mentioned, there is an API to check the licenses on the installation so that should eliminate these errors.
3. The URI parameter as documented on the code:

https://github.com/IQSS/dataverse/blob/2bf05c1ef34bf60ccdbc671f30ed312b9842c2e7/src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java#L470-L475

So it should be prioritized over the name to search for the license but it seems optional. Please feel free to open an issue if you think this has a different behavior. Let me know if you have any questions or if we can provide any additional help.

[jmurugan-fzj]

/api/licenses

@qqmyers Thanks for the information, I see that more details available here in native API page

I have one more question related to the license support: We have an older version: 4.20 installed in our institute and does not seem to support this particular endpoint:

• https://data.fz-juelich.de/api/licenses {"status":"ERROR","code":404,"message":"'/api/v1/licenses' endpoint does not exist on this server. Please check your code for typos, or consult our API guide at http://guides.dataverse.org."}
• https://data.fz-juelich.de/api/info/version

Presently I use "CC0 1.0" for creating the datasets, but the license information is populated as "None" in the created metadata: e.g. sample created dataset metadata So I assume the license management is not supported at all in version 4.2?

Do you know from which version on wards is the license terms management properly supported? We would like to have the license terms also properly documented along with our datasets. If you could tell me a particular version, this will be really helpful and I can ask the administration here to upgrade to that particular one or above.

[jmurugan-fzj]

@jmurugan-fzj hi! Now that the following #10426 has been merged, there is new guidance coming in the next release (probably 6.3) on what to put for "name", "uri" etc. Here's a screenshot from a preview at https://dataverse-guide--10426.org.readthedocs.build/en/10426/installation/config.html#contributing-to-the-collection-of-standard-licenses-above

Does that help?

@pdurbin Thank you very much, this is exactly what I was looking for and very helpful (y)

[jmurugan-fzj]

Hi @jmurugan-fzj, regarding your 3 points:

1. This message is a bit unclear, sorry about that. This is not a parsing error but indeed this happens because the license is not installed.
2. As @qqmyers mentioned, there is an API to check the licenses on the installation so that should eliminate these errors.
3. The URI parameter as I documented on the code

https://github.com/IQSS/dataverse/blob/2bf05c1ef34bf60ccdbc671f30ed312b9842c2e7/src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java#L470-L475

So it should be prioritized over the name to search for the license but it seems optional. Please feel free to open an issue if you think this has a different behavior. Let me know if you have any questions or if we can provide any additional help.

@jp-tosca Thanks again for the detailed response, sorry for being unclear in my previous question, I was not aware of the fact that the licenses need to be added before creating the datasets, with the help page links provided above, now the license terms usage is more clear to me :)

Regarding the URI field, I don't see this really as a critical issue at the moment, now that I am aware of the endpoint:/api/licenses, I can even restrict the possible values for the "name" & "url" field, so all good! Thanks again for the quick response and support (y)

[qqmyers]

@jmurugan-fzj - support for multiple licenses was added in v5.10 and there's a v5.10.1 that is probably the minimum you'd want. That said, we strongly recommend keeping current.

[jmurugan-fzj]

@jmurugan-fzj - support for multiple licenses was added in v5.10 and there's a v5.10.1 that is probably the minimum you'd want. That said, we strongly recommend keeping current.

@qqmyers That's very helpful, let me discuss with the team here and I would also like to go for the latest version, Thanks again :)

[pdurbin]

@philippconzett what do you think we should do with this PR? Can we close it now that the following PR has been merged?

• #11232

Thanks!

[philippconzett]

Sounds good to close. Sorry for the tardiness!