v4.1.0

Overview

Note: This version includes a change to the research_outputs table! We have added a new research_outputs.research_output_type field that stores a string value. It is a replacement for the old research_outputs.output_type integer field.

You will need to run: bin/rails db:migrate && bin/rails v4:upgrade_4_1_0 which will:

• Migrate your existing data from the research_outputs.output_type (Integer) field to the new research_outputs.research_ouput_type (String) field.
• Add a new 'OTHER' license to the licenses table. This new license is meant for scenarios where a user's institution or repository provides restricted access to the data the description is 'Custom Data Use Agreements/Terms of Use'. The option will appear for the user by default within the existing License select box
• The enum that backs the Initial Access level of a research Output has changed from 'open (0)', 'embargoed (1)', 'restricted (2)' and 'closed (3)' to: 'unrestricted (0)', 'restricted (2)', 'other (3)'. The script migrates any research outputs that had an initial research_outputs.access level set to 'embargoed' (1) to 'other' (3). The enum was left intact to accommodate the migrations, it will be updated in the next release.

New Functionality

Template administrators now have the ability to enable/disable the 'Research Outputs' tab. If they disable the tab, a researcher will not see the research outputs tab when editing their plan. The new 'Preferences' tab is visible for admins when they edit their template. It also provides additional options to tailor the research outputs tab for their template.

Screenshot of the Preferences tab and the enable/disable checkbox Screenshot of the Output Types preferences. The admin can use the defaults or specify their own (including removing default options) and also provide a tooltip for researchers to help guide their selection process. Screenshot of the Repository preferences showing a scenario where the admin has selected some repositories from the re3data registry and also defined a custom repository. When the researcher adds a research output, these preferred repositories will be displayed by default (they still have the option to select from the full re3data repository list. The admin can also provide a tooltip for researchers to help guide their selection process. Screenshot of the Metadata Standard preferences showing a scenario where the admin indicates that a specific metadata standard is the preferred standard. When the researcher adds a research output, these preferred standards will be displayed by default (they still have the option to select from the full list. The admin can also provide a tooltip for researchers to help guide their selection process. Screenshot of the license preferences. The admin can use the defaults or specify their own (including removing default options) and also provide a tooltip for researchers to help guide their selection process.

Changes

Updated the Admin Template edit page with a new 'Preferences' tab. This new tab allows admins to specify whether or not the Research Outputs tab will be available to the researcher when filling out their plan. If enabled, the admin can specify preferred/recommended output types, licenses, metadata standards and repositories. They can also provide guidance to the research to help them with their selections of those items.

• Added the following columns to the templates table
  • enable_research_outputs
  • user_guidance_output_types
  • user_guidance_repositories
  • user_guidance_metadata_standards
  • user_guidance_licenses
  • customize_output_types
  • customize_repositories
  • customize_metadata_standards
  • customize_licenses
• Updated the Templates model (and RSpec factory and tests) to use new field
• Created the Template Preferences View
• Removed 'Embargoed' from the list of Research Output Type's initial access level and changed the names of the other options. (Left the enum intact on the model for now so that data can be migrated)
• Added a new 'OTHER' license type (does not appear in JSON output because it has no valid URI)
• Added column research_output_type to the research_outputs table
• Added v4:upgrade_4_1_0 rake task to migrate data from output_type and output_type_description to the new research_output_type field. The task also adds a default 'OTHER' license and migrates resource_output.access from embargoed to closed
• Updated the ResearchOutput model (and RSpec factory and tests) to use new field
• Replaced the old output_types enum on the ResearchOutput model with DEFAULT_OUTPUT_TYPES array
• Updated presenters (and RSpec tests) and controller to work with the new field
• Created table template_licenses
  • Created UI to save preferred Licenses for a Template
• Created table template_output_types
  • Created UI to save preferred Output Types for a Template
• Created table template_repositories
  • Customize modal search to populate this relation
• Created table template_metadata_standards
  • Customize modal search to populate this relation
• Modify repositories table to allow for the definition of customized repositories for a template.
  • UI to create customized repositories
  • UI to select customized, preferred and/or standard repositories for a research output.
• Updated Gem and JS dependencies