Notifications - Turn-key research data management repository

<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="canonical" href="https://inveniordm.docs.cern.ch/customize/notifications/"> <link rel="prev" href="../i18n-and-l10n/"> <link rel="next" href="../../develop/"> <link rel="icon" href="../../images/favicon.svg"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40"> <title>Notifications - Turn-key research data management repository</title> <link rel="stylesheet" href="../../assets/stylesheets/main.8c3ca2c6.min.css"> <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css"> <link rel="stylesheet" href="../../stylesheets/extra.css"> <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> </head> <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#notifications" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <header class="md-header" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href="../.." title="Turn-key research data management repository" class="md-header__button md-logo" aria-label="Turn-key research data management repository" data-md-component="logo"> <img src="../../images/logo-rdm.png" alt="logo"> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> Turn-key research data management repository </div> <div class="md-header__topic" data-md-component="header-topic"> Notifications </div> </div> </div> <form class="md-header__option" data-md-component="palette"> <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0"> <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="orange" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1"> <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> <label class="md-search__icon md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class="md-search__options" aria-label="Search"> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a href="https://github.com/inveniosoftware/docs-invenio-rdm" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a href="../.." class="md-tabs__link"> Home </a> </li> <li class="md-tabs__item"> <a href="../../features/" class="md-tabs__link"> Features </a> </li> <li class="md-tabs__item"> <a href="../../install/" class="md-tabs__link"> Install </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../" class="md-tabs__link"> Customize </a> </li> <li class="md-tabs__item"> <a href="../../develop/" class="md-tabs__link"> Develop </a> </li> <li class="md-tabs__item"> <a href="../../deploy/" class="md-tabs__link"> Deploy </a> </li> <li class="md-tabs__item"> <a href="../../reference/" class="md-tabs__link"> Reference </a> </li> <li class="md-tabs__item"> <a href="../../releases/" class="md-tabs__link"> Releases </a> </li> <li class="md-tabs__item"> <a href="../../maintenance/" class="md-tabs__link"> Maintainers </a> </li> <li class="md-tabs__item"> <a href="../../contribute/" class="md-tabs__link"> Onboard & Contribute </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="../.." title="Turn-key research data management repository" class="md-nav__button md-logo" aria-label="Turn-key research data management repository" data-md-component="logo"> <img src="../../images/logo-rdm.png" alt="logo"> </a> Turn-key research data management repository </label> <div class="md-nav__source"> <a href="https://github.com/inveniosoftware/docs-invenio-rdm" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../.." class="md-nav__link"> Home </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" > <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> Features </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> Features </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../features/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../features/ux/" class="md-nav__link"> Beautiful UX </a> </li> <li class="md-nav__item"> <a href="../../features/scalable/" class="md-nav__link"> Highly scalable </a> </li> <li class="md-nav__item"> <a href="../../features/customization/" class="md-nav__link"> Customizable </a> </li> <li class="md-nav__item"> <a href="../../features/interoperable/" class="md-nav__link"> Interoperable </a> </li> <li class="md-nav__item"> <a href="../../features/powerful/" class="md-nav__link"> Powerful </a> </li> <li class="md-nav__item"> <a href="../../features/secure/" class="md-nav__link"> Secure </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_8" > <label class="md-nav__link" for="__nav_2_8" id="__nav_2_8_label" tabindex="0"> Features walk-through </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_8"> Features walk-through </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../features/features-walk-through/" class="md-nav__link"> Features overview </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/banners/" class="md-nav__link"> Site banners </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/notifications/" class="md-nav__link"> Notifications </a> </li> <li class="md-nav__item"> <a href="../../features/features-walk-through/access_requests/" class="md-nav__link"> Access requests </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" > <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> Install </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_3"> Install </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../install/" class="md-nav__link"> Quick start </a> </li> <li class="md-nav__item"> <a href="../../install/requirements/" class="md-nav__link"> System requirements </a> </li> <li class="md-nav__item"> <a href="../../install/cli/" class="md-nav__link"> Install CLI </a> </li> <li class="md-nav__item"> <a href="../../install/scaffold/" class="md-nav__link"> Scaffold </a> </li> <li class="md-nav__item"> <a href="../../install/build-setup-run/" class="md-nav__link"> Build, setup & run </a> </li> <li class="md-nav__item"> <a href="../../install/configuration/" class="md-nav__link"> Configure </a> </li> <li class="md-nav__item"> <a href="../../install/run/" class="md-nav__link"> Use </a> </li> <li class="md-nav__item"> <a href="../../install/migrate/" class="md-nav__link"> Migrate </a> </li> <li class="md-nav__item"> <a href="../../install/destroy/" class="md-nav__link"> Destroy </a> </li> <li class="md-nav__item"> <a href="../../install/troubleshoot/" class="md-nav__link"> Troubleshooting </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked> <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex=""> Customize </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_4"> Customize </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" > <label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0"> Look-and-feel </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_2"> Look-and-feel </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../look-and-feel/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../look-and-feel/logo/" class="md-nav__link"> Change logo </a> </li> <li class="md-nav__item"> <a href="../look-and-feel/templates/" class="md-nav__link"> Change templates </a> </li> <li class="md-nav__item"> <a href="../look-and-feel/theme/" class="md-nav__link"> Change theme </a> </li> <li class="md-nav__item"> <a href="../look-and-feel/font/" class="md-nav__link"> Change font </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../authentication/" class="md-nav__link"> Authentication </a> </li> <li class="md-nav__item"> <a href="../emails/" class="md-nav__link"> Sending emails </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" > <label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0"> Search </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_5"> Search </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../search/" class="md-nav__link"> Change facets/sorting </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_6" > <label class="md-nav__link" for="__nav_4_6" id="__nav_4_6_label" tabindex="0"> Vocabularies </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_6"> Vocabularies </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../vocabularies/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../vocabularies/resource_types/" class="md-nav__link"> Resource types </a> </li> <li class="md-nav__item"> <a href="../vocabularies/affiliations/" class="md-nav__link"> Affiliations </a> </li> <li class="md-nav__item"> <a href="../vocabularies/names/" class="md-nav__link"> Names </a> </li> <li class="md-nav__item"> <a href="../vocabularies/funding/" class="md-nav__link"> Funding </a> </li> <li class="md-nav__item"> <a href="../vocabularies/subjects/" class="md-nav__link"> Subjects </a> </li> <li class="md-nav__item"> <a href="../vocabularies/users/" class="md-nav__link"> Users </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7" > <label class="md-nav__link" for="__nav_4_7" id="__nav_4_7_label" tabindex="0"> Metadata </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_7"> Metadata </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../metadata/optional_fields/" class="md-nav__link"> Optional metadata </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7_2" > <label class="md-nav__link" for="__nav_4_7_2" id="__nav_4_7_2_label" tabindex="0"> Custom fields </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_7_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_7_2"> Custom fields </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../metadata/custom_fields/records/" class="md-nav__link"> Add fields to records </a> </li> <li class="md-nav__item"> <a href="../metadata/custom_fields/communities/" class="md-nav__link"> Add fields to communities </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../record_landing_page/" class="md-nav__link"> Record landing page </a> </li> <li class="md-nav__item"> <a href="../static_pages/" class="md-nav__link"> Static pages </a> </li> <li class="md-nav__item"> <a href="../dois/" class="md-nav__link"> DOI registration </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_11" > <label class="md-nav__link" for="__nav_4_11" id="__nav_4_11_label" tabindex="0"> Other PIDs integrations </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4_11"> Other PIDs integrations </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../other-pids/urns/" class="md-nav__link"> DNB URNs </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../s3/" class="md-nav__link"> Storage </a> </li> <li class="md-nav__item"> <a href="../upload_limits/" class="md-nav__link"> Upload Limits </a> </li> <li class="md-nav__item"> <a href="../metadata_only/" class="md-nav__link"> Metadata-only records </a> </li> <li class="md-nav__item"> <a href="../Logging/" class="md-nav__link"> Logging </a> </li> <li class="md-nav__item"> <a href="../i18n-and-l10n/" class="md-nav__link"> Internationalisation (i18n) and Localisation (l10n) </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> Notifications </label> <a href="./" class="md-nav__link md-nav__link--active"> Notifications </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#templates" class="md-nav__link"> Templates </a> </li> <li class="md-nav__item"> <a href="#notifications_backends" class="md-nav__link"> NOTIFICATIONS_BACKENDS </a> </li> <li class="md-nav__item"> <a href="#notifications_builders" class="md-nav__link"> NOTIFICATIONS_BUILDERS </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" > <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0"> Develop </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5"> Develop </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" > <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0"> Getting started </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_2"> Getting started </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/getting-started/source-code/" class="md-nav__link"> Source code </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/package-development/" class="md-nav__link"> Package development </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/instance-development/" class="md-nav__link"> Instance development </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/debugging/" class="md-nav__link"> Debugging </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/code-style/" class="md-nav__link"> Coding style </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/virtualenvs/" class="md-nav__link"> Virtual environments </a> </li> <li class="md-nav__item"> <a href="../../develop/getting-started/help/" class="md-nav__link"> Getting help </a> </li> <li class="md-nav__item"> <a href="../../develop/process/" class="md-nav__link"> Development process </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" > <label class="md-nav__link" for="__nav_5_3" id="__nav_5_3_label" tabindex="0"> Best practices </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_3"> Best practices </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/best-practices/accessibility/" class="md-nav__link"> Accessibility (a11y) </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/commits/" class="md-nav__link"> Commits, PRs & reviews </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/css-js/" class="md-nav__link"> CSS/JavaScript </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/react/" class="md-nav__link"> React </a> </li> <li class="md-nav__item"> <a href="../../develop/best-practices/ui/" class="md-nav__link"> User interface </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" > <label class="md-nav__link" for="__nav_5_4" id="__nav_5_4_label" tabindex="0"> Topic guides </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_4"> Topic guides </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/topics/resource/" class="md-nav__link"> Building resources </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/service/" class="md-nav__link"> Building services </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/serializers/" class="md-nav__link"> Building serializers </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/uow/" class="md-nav__link"> Grouping atomic operations </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/validation/" class="md-nav__link"> Sanitize input data </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/theming/" class="md-nav__link"> Theming </a> </li> <li class="md-nav__item"> <a href="../../develop/topics/administration_panel/" class="md-nav__link"> Administration panel </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" > <label class="md-nav__link" for="__nav_5_5" id="__nav_5_5_label" tabindex="0"> How-to guides </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_5"> How-to guides </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/howtos/i18n/" class="md-nav__link"> Translation (i18n) </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/custom_fields/" class="md-nav__link"> Create a new custom field </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/custom_code/" class="md-nav__link"> Create custom code and views </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/add_javascript/" class="md-nav__link"> Add JavaScript </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/override_components/" class="md-nav__link"> Override UI React components </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/search_terms_migration/" class="md-nav__link"> Create search terms mappings </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/alembic/" class="md-nav__link"> Create a database migration </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/security-fix/" class="md-nav__link"> Fix a vulnerability </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/dev_email/" class="md-nav__link"> Test emails locally </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/route_migration/" class="md-nav__link"> Migrate legacy routes </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/backup_search_indices/" class="md-nav__link"> Back up search indices </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/restrict_access/" class="md-nav__link"> Restrict access to pages </a> </li> <li class="md-nav__item"> <a href="../../develop/howtos/notifications/" class="md-nav__link"> Create and configure notifications </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_6" > <label class="md-nav__link" for="__nav_5_6" id="__nav_5_6_label" tabindex="0"> Architecture </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_6"> Architecture </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/architecture/" class="md-nav__link"> Introduction </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/infrastructure/" class="md-nav__link"> Infrastructure </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/software/" class="md-nav__link"> Software </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/runtime/" class="md-nav__link"> Runtime </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/requests/" class="md-nav__link"> Requests </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/communities/" class="md-nav__link"> Communities </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/records/" class="md-nav__link"> Records </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/event_handling/" class="md-nav__link"> Event handling </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/notifications/" class="md-nav__link"> Notifications </a> </li> <li class="md-nav__item"> <a href="../../develop/architecture/reading/" class="md-nav__link"> Recommended reading </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_7" > <label class="md-nav__link" for="__nav_5_7" id="__nav_5_7_label" tabindex="0"> Concepts </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5_7"> Concepts </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../develop/concepts/concurrency-control/" class="md-nav__link"> Optimistic concurrency control </a> </li> <li class="md-nav__item"> <a href="../../develop/concepts/transactions/" class="md-nav__link"> Database transaction management </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../deploy/" class="md-nav__link"> Deploy </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" > <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0"> Reference </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7"> Reference </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../reference/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../reference/cli/" class="md-nav__link"> CLI </a> </li> <li class="md-nav__item"> <a href="../../reference/configuration/" class="md-nav__link"> Configuration </a> </li> <li class="md-nav__item"> <a href="../../reference/metadata/" class="md-nav__link"> Metadata </a> </li> <li class="md-nav__item"> <a href="../../reference/metadata/optional_metadata/" class="md-nav__link"> Optional metadata </a> </li> <li class="md-nav__item"> <a href="../../reference/oai_pmh/" class="md-nav__link"> OAI-PMH </a> </li> <li class="md-nav__item"> <a href="../../reference/export_formats/" class="md-nav__link"> Export formats </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_8" > <label class="md-nav__link" for="__nav_7_8" id="__nav_7_8_label" tabindex="0"> REST API </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_8"> REST API </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../reference/rest_api_index/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_quickstart/" class="md-nav__link"> Quickstart </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_communities/" class="md-nav__link"> Communities </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_drafts_records/" class="md-nav__link"> Drafts and Records </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_groups/" class="md-nav__link"> Groups </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_members/" class="md-nav__link"> Members </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_requests/" class="md-nav__link"> Requests </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_users/" class="md-nav__link"> Users </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_reviews/" class="md-nav__link"> Reviews </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_vocabularies/" class="md-nav__link"> Vocabularies </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_names/" class="md-nav__link"> Names </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_funders/" class="md-nav__link"> Funders </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_awards/" class="md-nav__link"> Awards </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_oaipmh_sets/" class="md-nav__link"> OAI-PMH Sets </a> </li> <li class="md-nav__item"> <a href="../../reference/rest_api_statistics/" class="md-nav__link"> Statistics </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_9" > <label class="md-nav__link" for="__nav_7_9" id="__nav_7_9_label" tabindex="0"> Custom fields </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_9"> Custom fields </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../reference/custom_fields/widgets/" class="md-nav__link"> UI widgets </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_10" > <label class="md-nav__link" for="__nav_7_10" id="__nav_7_10_label" tabindex="0"> Administration </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7_10"> Administration </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../reference/administration_reference/" class="md-nav__link"> Reference </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../reference/file_storage/" class="md-nav__link"> File storage </a> </li> <li class="md-nav__item"> <a href="../../reference/statistics/" class="md-nav__link"> Usage statistics </a> </li> <li class="md-nav__item"> <a href="../../reference/notifications/" class="md-nav__link"> Notifications </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" > <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0"> Releases </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8"> Releases </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../releases/maintenance-policy/" class="md-nav__link"> Maintenance policy </a> </li> <li class="md-nav__item"> <a href="../../releases/upgrade-policy/" class="md-nav__link"> Upgrade policy </a> </li> <li class="md-nav__item"> <a href="../../releases/security-policy/" class="md-nav__link"> Security policy </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_5" > <label class="md-nav__link" for="__nav_8_5" id="__nav_8_5_label" tabindex="0"> Version v12.0 LTS </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_5"> Version v12.0 LTS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v12/version-v12.0.0/" class="md-nav__link"> Release Notes v12.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v12/upgrade-v12.0/" class="md-nav__link"> Upgrade from v11 to v12 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_6" > <label class="md-nav__link" for="__nav_8_6" id="__nav_8_6_label" tabindex="0"> Version v11.0 STS </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_6"> Version v11.0 STS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v11/version-v11.0.0/" class="md-nav__link"> Release Notes v11.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v11/upgrade-v11.0/" class="md-nav__link"> Upgrade from v10 to v11 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_7" > <label class="md-nav__link" for="__nav_8_7" id="__nav_8_7_label" tabindex="0"> Version v9.1 LTS </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_7"> Version v9.1 LTS </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v9/version-v9.1.0/" class="md-nav__link"> Release Notes v9.1 </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/version-v9.0.0/" class="md-nav__link"> Release Notes v9.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/migrate-docker-images/" class="md-nav__link"> Migrate Docker images </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/migrate-opensearch-v9/" class="md-nav__link"> Migrate v9 to OpenSearch </a> </li> <li class="md-nav__item"> <a href="../../releases/v9/upgrade-v9.0/" class="md-nav__link"> Upgrade from v8 to v9 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8" > <label class="md-nav__link" for="__nav_8_8" id="__nav_8_8_label" tabindex="0"> Legacy Versions </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8"> Legacy Versions </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_1" > <label class="md-nav__link" for="__nav_8_8_1" id="__nav_8_8_1_label" tabindex="0"> Version v10.1 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_1_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_1"> Version v10.1 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v10/version-v10.1.0/" class="md-nav__link"> Release Notes v10.1 </a> </li> <li class="md-nav__item"> <a href="../../releases/v10/version-v10.0.0/" class="md-nav__link"> Release Notes v10.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v10/upgrade-v10.0/" class="md-nav__link"> Upgrade from v9 to v10 </a> </li> <li class="md-nav__item"> <a href="../../releases/migrate-docker-images/" class="md-nav__link"> Migrate Docker images </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_2" > <label class="md-nav__link" for="__nav_8_8_2" id="__nav_8_8_2_label" tabindex="0"> Version v8.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_2"> Version v8.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v8/version-v8.0.0/" class="md-nav__link"> Release Notes v8.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v8/upgrade-v8.0/" class="md-nav__link"> Upgrade from v7 to v8 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_3" > <label class="md-nav__link" for="__nav_8_8_3" id="__nav_8_8_3_label" tabindex="0"> Version v7.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_3"> Version v7.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v7/version-v7.0.0/" class="md-nav__link"> Release Notes v7.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v7/upgrade-v7.0/" class="md-nav__link"> Upgrade from v6 to v7 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_4" > <label class="md-nav__link" for="__nav_8_8_4" id="__nav_8_8_4_label" tabindex="0"> Version v6.0.5 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_4"> Version v6.0.5 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v6/version-v6.0.5/" class="md-nav__link"> Release Notes v6.0.5 </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/upgrade-v6.0.5/" class="md-nav__link"> Upgrade from v6.0.x to v6.0.5 </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/version-v6.0.0/" class="md-nav__link"> Release Notes v6.0.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v6/upgrade-v6.0/" class="md-nav__link"> Upgrade from v4 to v6 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_5" > <label class="md-nav__link" for="__nav_8_8_5" id="__nav_8_8_5_label" tabindex="0"> Version v5.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_5"> Version v5.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v5/version-v5.0.0/" class="md-nav__link"> Release Notes v5.0 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_6" > <label class="md-nav__link" for="__nav_8_8_6" id="__nav_8_8_6_label" tabindex="0"> Version v4.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_6"> Version v4.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v4/version-v4.0.0/" class="md-nav__link"> Release Notes v4.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v4/upgrade-v4.0/" class="md-nav__link"> Upgrade from v3 to v4 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_7" > <label class="md-nav__link" for="__nav_8_8_7" id="__nav_8_8_7_label" tabindex="0"> Version v3.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_7"> Version v3.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v3/version-v3.0.0/" class="md-nav__link"> Release Notes v3.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v3/upgrade-v3.0/" class="md-nav__link"> Upgrade from v2 to v3 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_8" > <label class="md-nav__link" for="__nav_8_8_8" id="__nav_8_8_8_label" tabindex="0"> Version v2.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_8"> Version v2.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v2/version-v2.0.0/" class="md-nav__link"> Release Notes v2.0 </a> </li> <li class="md-nav__item"> <a href="../../releases/v2/upgrade-v2.0/" class="md-nav__link"> Upgrade from v1 to v2 </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_8_9" > <label class="md-nav__link" for="__nav_8_8_9" id="__nav_8_8_9_label" tabindex="0"> Version v1.0 </label> <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_8_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8_8_9"> Version v1.0 </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../releases/v1/version-v1.0.0/" class="md-nav__link"> Release Notes v1.0 </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" > <label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0"> Maintainers </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_9"> Maintainers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../maintenance/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../maintenance/newcomers/" class="md-nav__link"> Newcomers </a> </li> <li class="md-nav__item"> <a href="../../maintenance/board-workflow/" class="md-nav__link"> Sprintboard workflow </a> </li> <li class="md-nav__item"> <a href="../../maintenance/pr-community-board/" class="md-nav__link"> Community PR board </a> </li> <li class="md-nav__item"> <a href="../../maintenance/release-management/" class="md-nav__link"> Release management </a> </li> <li class="md-nav__item"> <a href="../../maintenance/modules/" class="md-nav__link"> Modules on GitHub </a> </li> <li class="md-nav__item"> <a href="../../maintenance/branch-management/" class="md-nav__link"> Branch management </a> </li> <li class="md-nav__item"> <a href="../../maintenance/demosite/" class="md-nav__link"> Demo site & docs </a> </li> <li class="md-nav__item"> <a href="../../maintenance/docker-images/" class="md-nav__link"> Docker images </a> </li> <li class="md-nav__item"> <a href="../../maintenance/rfcs/" class="md-nav__link"> RFCs </a> </li> <li class="md-nav__item"> <a href="../../maintenance/documentation/" class="md-nav__link"> Writing documentation </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" > <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0"> Onboard & Contribute </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_10"> Onboard & Contribute </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../contribute/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../contribute/onboarding/" class="md-nav__link"> Onboarding </a> </li> <li class="md-nav__item"> <a href="../../contribute/code-of-conduct/" class="md-nav__link"> Code of conduct </a> </li> <li class="md-nav__item"> <a href="../../contribute/copyright-policy/" class="md-nav__link"> Copyright policy </a> </li> <li class="md-nav__item"> <a href="../../contribute/roadmap/" class="md-nav__link"> Roadmap </a> </li> <li class="md-nav__item"> <a href="../../contribute/translators-guide/" class="md-nav__link"> Translators guide </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#templates" class="md-nav__link"> Templates </a> </li> <li class="md-nav__item"> <a href="#notifications_backends" class="md-nav__link"> NOTIFICATIONS_BACKENDS </a> </li> <li class="md-nav__item"> <a href="#notifications_builders" class="md-nav__link"> NOTIFICATIONS_BUILDERS </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="notifications">Notifications<a class="headerlink" href="#notifications" title="Permanent link">¶</a></h1> Depending on your instance needs regarding notifications, you might want to customize the configuration values provided by the <code>invenio-notifications</code> module. Specifically, we are going to have a look at templates and the following variables: <ul> <li><a href="#notifications_backends">NOTIFICATIONS_BACKENDS</a></li> <li><a href="#notifications_builders">NOTIFICATIONS_BUILDERS</a></li> </ul> <h2 id="templates">Templates<a class="headerlink" href="#templates" title="Permanent link">¶</a></h2> In order to provide your own customized templates or override parts of existing ones, templates can be placed in the <code>my_site/templates/semantic-ui/invenio_notifications</code> folder. The file name then has to match the base template name (e.g. <code>community-submission.submitted.jinja</code>). Let's have a look at a base template and then customize parts of it for our own needs. Assume a notification context like this: <div class="highlight"><pre><code>{ "request": { "links": { "self_html": "<link to the request>", }, "created_by": { "id": 3, "username": "Chris the Creator", }, "receiver": { "id": "3fc4fcaa-ce2c-4ec7-97cd-4b29ca204035", "metadata": { "title": "Notification Community", }, "links": { "self_html": "<link to the community>", } }, "topic": { "id": "49e72dea-f14a-4774-a52d-a3d581fed86e", "metadata": { "title": "My Submitted Record", }, } } } </code></pre></div> <div class="highlight"><pre><code>{# notifications/community-submission.submitted.jinja #} {%- block subject -%} New record submission for your community {{ notification.context.get("request").get("receiver").get("metadata").get("title") }} submitted by {{ notification.context.get("request").get("created_by").get("username") }} {%- endblock subject -%} {%- block html_body -%} The record "{{ notification.context.get("request").get("topic").get("metadata").get("title") }}" was submitted to your community {{ notification.context.get("request").get("receiver").get("metadata").get("title") }} by {{ notification.context.get("request").get("created_by").get("username") }}. <a href="{{ notification.context.get("request").get("links").get("self_html") }}" class="button">Review the request</a> {%- endblock html_body -%} {%- block plain_body -%} The record "{{ notification.context.get("request").get("topic").get("metadata").get("title") }}" was submitted to your community {{ notification.context.get("request").get("receiver").get("metadata").get("title") }} by {{ notification.context.get("request").get("created_by").get("username") }}. Review the request: {{ notification.context.get("request").get("links").get("self_html") }} {%- endblock plain_body -%} </code></pre></div> We are pretty happy with most of the content, but want to override the <code>html_body</code> to include a link to the community and all requests. To do this, we will create a file with the same name and extend the base template. <div class="highlight"><pre><code>{% extends "invenio_notifications/community-submission.submitted.html" %} {% block html_body %} The record "{{ notification.context.get("request").get("topic").get("metadata").get("title") }}" was submitted to your community {{ notification.context.get("request").get("receiver").get("metadata").get("title") }} by {{ notification.context.get("request").get("created_by").get("username") }}. <a href="{{ notification.context.get("request").get("receiver").get("links").get("self_html") }}" class="button">Check out the community"</a> <a href="{{ notification.context.get("request").get("links").get("self_html") }}" class="button">Review the request</a> <a href="{{ notification.context.get("request").get("receiver").get("links").get("self_html") + "/requests" }}" class="button">Check out all community requests</a> {% endblock %} </code></pre></div> <h2 id="notifications_backends">NOTIFICATIONS_BACKENDS<a class="headerlink" href="#notifications_backends" title="Permanent link">¶</a></h2> This config variable allows to specify the available backends. For instance, you can provide an implementation of your institute specific tool of communication and send notifications via this backend. For this, simply extend the <code>NotificationBackend</code> class and implement the <code>send</code> method. <div class="highlight"><pre><code>from invenio_notifications.backends import JinjaTemplateLoaderMixin, NotificationBackend, class InstitutationalBackend(NotificationBackend, JinjaTemplateLoaderMixin): """Base class for notification backends.""" id = "institutional-backend" """Unique id of the backend.""" def send(self, notification, recipient): """Send the notification message as markdown to a user.""" template = self.render_template(notification=notification, recipient=recipient) institutation_communication_tool.send_message(user_id=recipient.data["id"], template["md_body"]) </code></pre></div> This backend can now be specified (e.g. in <code>invenio.cfg</code>): <div class="highlight"><pre><code>NOTIFICATION_BACKENDS = { EmailNotificationBackend.id: EmailNotificationBackend, InstitutationalBackend.id: InstitutationalBackend, } </code></pre></div> <h2 id="notifications_builders">NOTIFICATIONS_BUILDERS<a class="headerlink" href="#notifications_builders" title="Permanent link">¶</a></h2> This config variable defines which builder class should be used for a specific notification type. Let us assume that you want to override who will get notified in the event of a community record submission (community curator and owner) and add the previously defined backend (so recipients will get notified via whatever the base class has defined and via the <code>InstitutationalBackend</code>). To do this, we will create a custom builder, which will inherit most of the properties from the existing base class. <div class="highlight"><pre><code>from institutational_package.notifications import InstitutationalBackend from invenio_communities.notifications.generators import CommunityMembersRecipient from invenio_rdm_records.notifications.builders import CommunityInclusionSubmittedNotificationBuilder class CustomSubmissionBuilder(CommunityInclusionSubmittedNotificationBuilder): # properties not overwritten will keep their base value recipients = [ CommunityMembersRecipient(key="request.receiver", roles=["curator", "owner"]), ] recipient_backends = CommunityInclusionSubmittedNotificationBuilder.recipient_backends + [ InstitutationalBackend(), ] </code></pre></div> This builder can now be specified (e.g. in <code>invenio.cfg</code>): <div class="highlight"><pre><code>NOTIFICATIONS_BUILDERS = { CustomSubmissionBuilder.type: CustomSubmissionBuilder, } </code></pre></div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../i18n-and-l10n/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Internationalisation (i18n) and Localisation (l10n)"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footer__title"> Previous <div class="md-ellipsis"> Internationalisation (i18n) and Localisation (l10n) </div> </div> </a> <a href="../../develop/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview"> <div class="md-footer__title"> Next <div class="md-ellipsis"> Overview </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> <div class="md-copyright__highlight"> Copyright © 2019-2024 CERN, Northwestern University and contributors. </div> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> <div class="md-social"> <a href="https://github.com/inveniosoftware" target="_blank" rel="noopener" title="github.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.footer", "content.code.copy"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.525ec568.min.js"></script> </body> </html>

CINXE.COM

Notifications - Turn-key research data management repository