v3.1.0

Researchers

Researchers can now expand/collapse the Guidance and Comments sections when editing their DMPs. This gives the researcher more space to see their answers. Clicking on the 'Comments & Guidance' label will collapse/expand the section for that question. (Thanks to @benjaminfaure for contributing this feature #3123)

Screenshot of the new collapsible guidance/comments section:

Changes to the 'Project Details' page (must be enabled):

• Users can now specify a primary research domain for their project (e.g. Biology, Computer Science, Humanities, etc.). This information appears in the DMP's JSON as a 'tag'.
• Users can now indicate and describe any ethical concerns that concern their research data. Clicking the checkbox will display a field to describe the concerns and a URL field to link to a report. This information appears in the DMP's JSON.

A new 'Research Outputs' tab that allows users to specify information about their intended research outputs (must be enabled) (thanks to @briri and @nicolasfranck for these contributions #2738 #2814 #3134)

Screenshot of the new Research Outputs tab:

The 'Research Outputs' tab allows users to:

• Specify the type (e.g. dataset, software, image, etc.), name and a description of the output, size (if applicable), whether or not it contains sensitive info or PII, what the initial access level will be (e.g. open, restricted, closed) and the anticipated publication date.
• Select an appropriate license (must be enabled) (note that the options come from the SPDX license registry) (#2607)
• Select any metadata standards that will be followed (e.g. Dublin Core) (must be enabled) (note that the list of standards comes from the RDA Metadata standards catalog) (#2798)
• Select the repositories they intend to preserve the object in (e.g. Dryad, Zenodo, GitHub, or an institutional repository) (must be enabled) (note that the list of repositories comes from the re3data registry) (#2605)

Screenshot of the Repository selection window (functionality for Metadata Standards is similar):

After a user enters information about their research outputs, the data will appear in the PDF as an addendum in a table format (#2812) (the Download page includes a checkbox to include/exclude this new addendum)

Screenshot of Research Outputs as an addendum to the PDF:

The research output information will also appear in the JSON output (and API v1 output) for the DMP:

Screenshot of new JSON Output (also delivered by API v1) showing a Research Output translated into the RDA Common Standard:

Organisational Administrators

Admins may now specify a helpdesk email address when editing their Organisation's details. This email will be used in the email signature for emails sent from the system (assuming the recipient of the email is a member of the same Organisation) (thanks to @johnpinto1 #3140)

Note that, if enabled, the new 'Research Outputs' tab may duplicate data entry for users if your templates are already asking for specific information about the intended research outputs (e.g. which repositories, what licenses, etc.). You can prevent this duplication of effort by editing your template and removing/rewording those questions. The new research output info appears in an addendum to the PDF of the DMP. It also appears as 'Dataset' information in the JSON output (see above screenshots). If you do change your template, do not forget to re-publish once you have made your changes!

Bug Fixes:

• Fixed an issue that was preventing Org Admins from seeing the 'Share' tab #3131
• Fixed an issue that was causing errors when Org Admins tried to save changes to a template #3038
• Patched an issue that continued to show users as collaborators on a Plan's Share tab even after they had removed themselves from the Plan #3126
• Fixed an issue that was causing TinyMCE editors to have an incorrect size when they initially load #3141
• Various fixes for the APIs
  • Patched issue that was always using the default template when creating a new DMP in API v1 #3137
  • Fixed an issue that was preventing plans from being created via API v0 #3135
  • Addressed an issue that was preventing users from being unassigned from a department in API v0 #3132

Developers

Enabling new functionality

By default, your guidance and comments section of the 'Write Plan' page will be expanded. If you want to change this so that it is collapsed by default, you can change the guidance_comments_opened_by_default setting in the config/initializers/_dmproadmap.rb file. If you want to disable this functionality entirely you can change the guidance_comments_toggleable setting.

The 'Research domain' dropdown and 'Ethical issues' fields on the Project Details page and the new 'Research outputs' tab are disabled by default. If you would like to use them, you must enable them (enable_research_domain, enable_ethical_issues and enable_research_outputs) in the config/initializers/_dmproadmap.rb file. Note that changes to this file require a restart of the application.
There are a few additional configuration options for components of the 'Research outputs' page:

• To allow your users to select metadata standards for a research output, you should:
  • enable the setting in the _dmproadmap.rb initializer - enable_metadata_standard_selection
  • Run bin/rails external_api:load_rdamsc_standards RAILS_ENV=[env] to populate the metadata_standards table
• To allow your users to select repositories for a research output, you should:
  • enable the setting in the _dmproadmap.rb initializer - enable_repository_selection
  • Run bin/rails external_api:load_re3data_repos RAILS_ENV=[env] to populate the repositories table
• To allow your users to select a license for their research outputs, you should:
  • enable the setting in the _dmproadmap.rb initializer - enable_license_selection
  • Run bin/rails external_api:load_spdx_licenses RAILS_ENV=[env] to populate the licenses table with data
  • Review the list of 'preferred' licenses in the _dmproadmap.rb initializer and modify if needed. Note that if you should use the %{latest} token we 'preferring' a license that have a version (see example in the config file).

We have added information to the Administration Wiki page about enabling/disabling functionality and our recommendations on which Rake tasks should be run on a schedule.

Additional changes:

• Updated API V1 to convey the new Research Output info as Datasets in the JSON output (see screenshot above)
• Added a new generic modal search dialog (currently used for repository and metadata standard selection). This component allows the page to define its own search/filter options and display search results in its own way. (Included a README.md in the app/views/layouts/modal_search dir to help describe how to implement for new data)
• Modification to the way the Plan is associated with its grant (basically a shortcut to get at the identifier record)
• Added new Services (and corresponding config files) to services/external_apis that fetch data for the License, Metadata Standard and Repository tables. These also have callable Rake tasks in lib/tasks/utils/external_api.rake to help you initialize the tables and update the contents on a regular basis
• Reverted change to our use of string format tokens that was made during an upgrade of Rubocop. The preferred format is once again Some %{variable_name} text #3128
• Synced latest translations from Translation.io
• Updated all Gem and JS dependencies