InvenioRDM v13.0¶
DATE
We're happy to announce the release of InvenioRDM v13.0! Version 13 will be maintained until at least 6 months following the next release. Visit our maintenance policy page to learn more.
Try it¶
What's new?¶
Our latest release, v13, is here, and it's packed with an incredible array of new features and major improvements. We're diving straight into the highlights, then wrapping up with a comprehensive list of all the other valuable enhancements.
Audit logs¶
InvenioRDM now comes with a new audit logs feature. See the related documentation here.
Jobs¶
This release introduces a new Jobs feature, providing a comprehensive way to manage asynchronous tasks via the UI or REST API. Jobs are triggered via the admin UI or REST API, run using Celery, and support logging, argument validation, and result tracking. See the related documentation here.
ORCID and ROR integrations¶
You can now setup jobs to automatically and recurrently fetch ORCID and ROR latest databases.
For ORCID, read more on the names vocabulary documentation page.
With the ROR job, you can automatically load funders or affiliations vocabulary from the InvenioRDM administration panel, and schedule updates with new ROR releases. Instructions can be found on the affiliations vocabulary documentation page. We have also upgraded the integration with ROR to version 2.0 and enhanced the metadata to include organization aliases, status, types, locations, and acronyms, making it easier to find the correct organization or funders.
Optional DOI¶
You can now let users to choose if they need a DOI or not when uploading. See how to configure it in the related documentation.
Search improvements¶
Both users and records search have been enhanced to return more accurate results for common names/titles, partial matches (even with typos) and names/titles with accents or diacritics.
Creators, affiliations and funders autocompletion has been improved so that suggestions appear faster and better match what you type.
Warning
This change requires the re-creation of the search cluster mappings for some of the indices. See breaking changes for more informations.
Administration panel¶
You'll find several new improvements in the administration panel:
- The default number of results of has been increased from 10 to 20 on all panels
- Records and draft panel:
- More of the title is shown by default
- Improved display of files and stats information
- Fixed narrow viewport display, such as on mobile
- Owner now links to the ID in the user panel
- User panel:
- ORCID and GitHub icons now link to the user's profile
Compare revisions¶
The new Compare Revisions feature allows administrators to audit record updates and follow changes over time.
From the Records list, click the “Compare revisions…” button in the Actions column to open a side-by-side comparison window:
A modal window appears, allowing you to choose two revisions to compare:
The changes are then displayed in a JSON side-by-side diff view:
Revisions VS versions
This feature allows admins to compare revisions, not versions. A revision is the result of editing a record, where each published edit creates a new revision. A new version is a different record which is semantically linked to the previous record. At this time it is not possible to compare different records, including versions.
New Metadata Fields¶
There is a new field called copyright for copyright information, specification available here. This field will require reindexing upon the version upgrade.
There are new thesis metadata fields including department, type, date_submitted, date_defended. thesis:university had been moved to university inside of the thesis:thesis section, alongside the other new fields.
There is a new edition field under imprint.
Requests sharing¶
When a record is shared, its inclusion requests will be also accessible. There is a new filter in the My Dashboard to show the records shared with me.
Communities¶
Themed communities¶
Communities can now have their own theming with a custom font and colors, which apply to all community pages including records and requests. Below is an example of one "default" and two themed communities on Zenodo.
Themed communities benefit from a custom homepage, defined via HTML template in <instance>/templates/themes/<theme>/invenio_communities/details/home/index.html.
Subcommunities¶
It is now possible to create hierarchical relationships between communities, allowing for departments, subject areas and other structures to be represented via related communities. Records from the "child" community are automatically indexed in the "parent" community, allowing all the records of the children to be browsed in the parents. The communities are also bidirectionally linked so that it is easy to navigate between both.
Having subcommunities also enables the Browse page, which lists all the subcommunities and collections of that community.
Note
Currently communities can only have one level of hierarchy (i.e., no grand-child communities) and communities can only have one parent community.
Collections¶
Collections introduce a powerful new way to organize and curate records within your InvenioRDM instance. This major feature enables administrators to create dynamic, query-based groupings of records that automatically stay current as new content is added.
Collections provide dedicated pages showing all records matching specific criteria.
Hierarchical organization
Collections allow you to define hierarchical groupings of records, enabling users to browse content by subject, resource type, funding program, or any other metadata field.
The collection browser provides an organized view of all available collections within a community.
Common use cases
- Group content by research disciplines using a hierarchical vocabulary
- Organize historical records by publication date
- Organize records by funding programs (Horizon 2020, NSF, institutional grants)
- Create resource type collections (datasets, publications, software)
- Highlight featured content or special collections
Collections integrate seamlessly with existing community features and are accessed through intuitive URLs. The feature is currently managed through Python shell commands, with an administrator user interface planned for future releases.
Read more about the Collections feature.
Curation¶
It is now possible to configure automated checks in your communities to provide instant feedback on draft review and record inclusion requests. Checks provide feedback to both the user and reviewer that submissions to your community are compliant with your curation policy. For example, you can enforce that submissions to your community must be preprints, funded by a specific grant or any other requirement on the metadata or files.
Helm charts¶
To be announced?
FAIR signposting level 1¶
In order to increase discoverability, FAIR signposting level 1 can be enabled with the configuration flag APP_RDM_RECORD_LANDING_PAGE_FAIR_SIGNPOSTING_LEVEL_1_ENABLED = True. Once enabled, FAIR signposting information will be directly included in the Link HTTP response header.
FAIR signposting level 2 was already enabled by default since v12. The response header of each record's landing page includes a Link header pointing to a JSON-based linkset which contains the FAIR signposting information.
Please note that for records having many authors, files, or licenses, FAIR signposting will fall back to level 2 only, in order to avoid generating excessively big HTTP response headers.
However, since enabling FAIR signposting level 1 does increase the size of HTTP response headers, it is recommended to edit the nginx configuration and specify uwsgi_buffer_size with a higher limit than the default values. If you have enabled uwsgi_buffering on;, then uwsgi_buffers may also be adjusted.
server {
# ...
# Allow for larger HTTP response headers for FAIR signposting level 1 support
uwsgi_buffer_size 16k;
# optional if uwsgi_buffering on;
uwsgi_buffers 8 16k;
# ...
}
Custom schemes for persistent identifiers¶
The Invenio idutils module handles validation and normalization of persistent identifiers used in scholarly communication, and existing customizations may be affected by changes in v13. The library has been restructured to use a configurable scheme system with a new entrypoint mechanism for registering custom identifier schemes.
See the related documentation how to add your own custom schemes.
EuroSciVoc Subjects¶
Optional Feature¶
You can now import EuroSciVoc subjects using the new Jobs system. If you previously had imported EuroSciVoc subjects, you will need to update the existing records, drafts, and communities that were using these subjects and then deleting the old subjects in the database. This is necessary due to changes in the structure, such as the introduction of the props property and updates to the id format.
Note that mapping updates are needed. Also, you would need to reindex the relevant subjects, records, drafts and communities.
CORDIS Awards¶
Optional Feature¶
CORDIS data can now be imported to enhance OpenAIRE awards using the new Jobs system. This update allows for the addition of supplementary information to the awards, including subjects (Note: The EuroSciVoc subjects are needed for this), organizations, and other related metadata. The three funding programs supported are HE, FP7 and H2020.
Note that mapping updates are needed. Also, you would need to reindex the relevant awards, records, drafts and communities.
Miscellaneous additions¶
Here is a quick summary of the myriad other improvements in this release:
- The creators' roles are now displayed PR
- You can now see and show the version of InvenioAppRDM and any other module Issue Change the config ADMINISTRATION_DISPLAY_VERSIONS = [("invenio-app-rdm", f"v{version}")] and append to the list the version you want to display.
- The users API endpoint is now protected, in order to access the list of users it's required to be logged in.
- Custom awards: relaxed required fields (see PR)
- The configuration flags that control the visibility of menu items in the administration panel have been removed, and they are now visible by default. You can remove such flags from your configuration file (if existing) or leave them there, they will have no effect. Removed flags:
COMMUNITIES_ADMINISTRATION_DISABLEDUSERS_RESOURCES_ADMINISTRATION_ENABLEDJOBS_ADMINISTRATION_ENABLED- Following the latest COUNTER spec, the list of robots and machines have been updated to ensure the stats are counted on human usage.
- Logging: The Flask root logger level has been set to
DEBUG, enabling all log messages to pass through by default. Handlers are now responsible for filtering messages at the desired level, offering more flexibility for development and production environments. - Sitemaps are now generated for search engines and other crawlers to discover and index important content (records and communities by default, but customizable). Sitemaps are even automatically linked in your
robots.txtfor ease of discoverability by machine agents. - ...and many more bug fixes!
Breaking changes¶
- Direct imports of identifier schemes (e.g., from idutils.isbn import normalize_isbn) are now deprecated and will be removed in future versions. If you have custom code that directly imports scheme modules, you'll need to update it to use the new API.
- Mapping updates in Subjects, Awards, Records (including percolators), Drafts and Communities
Limitations and known issues¶
- fill me in
Requirements¶
InvenioRDM v13 now supports:
- Python 3.9, 3.11 and 3.12
- Node.js 18+
- PostgreSQL 12+
- OpenSearch v2
Notably, older versions of Elasticsearch/Opensearch, PostgreSQL, and Node.js have been phased out.
Upgrading to v13.0¶
We support upgrading from v12 to v13. See the upgrade guide for how.
Questions?¶
If you have questions related to these release notes, don't hesitate to jump on discord and ask us!
Credit¶
The development work of this impressive release wouldn't have been possible without the help of these great people:
- CERN: Alex, Anna, Antonio, Javier, Jenny, Karolina, Lars, Manuel, Nicola, Pablo G., Pablo P., Zacharias
- Northwestern University: Guillaume
- TU Graz: Christoph, David, Mojib
- TU Wien: Max
- Uni Bamberg: Christina
- Uni Münster: Werner
- Front Matter: Martin
- KTH Royal Institute of Technology: Sam
- Caltech: Tom