Administration panel - 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/develop/topics/administration_panel/"> <link rel="prev" href="../theming/"> <link rel="next" href="../../howtos/i18n/"> <link rel="icon" href="../../../images/favicon.svg"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.40"> <title>Administration panel - 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="#administration-panel" 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"> Administration panel </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"> <a href="../../../customize/" class="md-tabs__link"> Customize </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href="../../" 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--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" > <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0"> Customize </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <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="../../../customize/" 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="../../../customize/look-and-feel/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../../customize/look-and-feel/logo/" class="md-nav__link"> Change logo </a> </li> <li class="md-nav__item"> <a href="../../../customize/look-and-feel/templates/" class="md-nav__link"> Change templates </a> </li> <li class="md-nav__item"> <a href="../../../customize/look-and-feel/theme/" class="md-nav__link"> Change theme </a> </li> <li class="md-nav__item"> <a href="../../../customize/look-and-feel/font/" class="md-nav__link"> Change font </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../customize/authentication/" class="md-nav__link"> Authentication </a> </li> <li class="md-nav__item"> <a href="../../../customize/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="../../../customize/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="../../../customize/vocabularies/" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="../../../customize/vocabularies/resource_types/" class="md-nav__link"> Resource types </a> </li> <li class="md-nav__item"> <a href="../../../customize/vocabularies/affiliations/" class="md-nav__link"> Affiliations </a> </li> <li class="md-nav__item"> <a href="../../../customize/vocabularies/names/" class="md-nav__link"> Names </a> </li> <li class="md-nav__item"> <a href="../../../customize/vocabularies/funding/" class="md-nav__link"> Funding </a> </li> <li class="md-nav__item"> <a href="../../../customize/vocabularies/subjects/" class="md-nav__link"> Subjects </a> </li> <li class="md-nav__item"> <a href="../../../customize/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="../../../customize/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="../../../customize/metadata/custom_fields/records/" class="md-nav__link"> Add fields to records </a> </li> <li class="md-nav__item"> <a href="../../../customize/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="../../../customize/record_landing_page/" class="md-nav__link"> Record landing page </a> </li> <li class="md-nav__item"> <a href="../../../customize/static_pages/" class="md-nav__link"> Static pages </a> </li> <li class="md-nav__item"> <a href="../../../customize/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="../../../customize/other-pids/urns/" class="md-nav__link"> DNB URNs </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../../customize/s3/" class="md-nav__link"> Storage </a> </li> <li class="md-nav__item"> <a href="../../../customize/upload_limits/" class="md-nav__link"> Upload Limits </a> </li> <li class="md-nav__item"> <a href="../../../customize/metadata_only/" class="md-nav__link"> Metadata-only records </a> </li> <li class="md-nav__item"> <a href="../../../customize/Logging/" class="md-nav__link"> Logging </a> </li> <li class="md-nav__item"> <a href="../../../customize/i18n-and-l10n/" class="md-nav__link"> Internationalisation (i18n) and Localisation (l10n) </a> </li> <li class="md-nav__item"> <a href="../../../customize/notifications/" class="md-nav__link"> Notifications </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_5" checked> <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex=""> Develop </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true"> <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="../../" 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="../../getting-started/source-code/" class="md-nav__link"> Source code </a> </li> <li class="md-nav__item"> <a href="../../getting-started/package-development/" class="md-nav__link"> Package development </a> </li> <li class="md-nav__item"> <a href="../../getting-started/instance-development/" class="md-nav__link"> Instance development </a> </li> <li class="md-nav__item"> <a href="../../getting-started/debugging/" class="md-nav__link"> Debugging </a> </li> <li class="md-nav__item"> <a href="../../getting-started/code-style/" class="md-nav__link"> Coding style </a> </li> <li class="md-nav__item"> <a href="../../getting-started/virtualenvs/" class="md-nav__link"> Virtual environments </a> </li> <li class="md-nav__item"> <a href="../../getting-started/help/" class="md-nav__link"> Getting help </a> </li> <li class="md-nav__item"> <a href="../../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="../../best-practices/accessibility/" class="md-nav__link"> Accessibility (a11y) </a> </li> <li class="md-nav__item"> <a href="../../best-practices/commits/" class="md-nav__link"> Commits, PRs & reviews </a> </li> <li class="md-nav__item"> <a href="../../best-practices/css-js/" class="md-nav__link"> CSS/JavaScript </a> </li> <li class="md-nav__item"> <a href="../../best-practices/react/" class="md-nav__link"> React </a> </li> <li class="md-nav__item"> <a href="../../best-practices/ui/" class="md-nav__link"> User interface </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" checked> <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="true"> <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="../resource/" class="md-nav__link"> Building resources </a> </li> <li class="md-nav__item"> <a href="../service/" class="md-nav__link"> Building services </a> </li> <li class="md-nav__item"> <a href="../serializers/" class="md-nav__link"> Building serializers </a> </li> <li class="md-nav__item"> <a href="../uow/" class="md-nav__link"> Grouping atomic operations </a> </li> <li class="md-nav__item"> <a href="../validation/" class="md-nav__link"> Sanitize input data </a> </li> <li class="md-nav__item"> <a href="../theming/" class="md-nav__link"> Theming </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"> Administration panel </label> <a href="./" class="md-nav__link md-nav__link--active"> Administration panel </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="#summary" class="md-nav__link"> Summary </a> </li> <li class="md-nav__item"> <a href="#intended-audience" class="md-nav__link"> Intended audience </a> </li> <li class="md-nav__item"> <a href="#overview" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="#domain-dictionary" class="md-nav__link"> Domain dictionary </a> </li> <li class="md-nav__item"> <a href="#administration-panel_1" class="md-nav__link"> Administration panel </a> <nav class="md-nav" aria-label="Administration panel"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#architecture" class="md-nav__link"> Architecture </a> </li> <li class="md-nav__item"> <a href="#views" class="md-nav__link"> Views </a> <nav class="md-nav" aria-label="Views"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-resource-based-view" class="md-nav__link"> Create a resource based view </a> <nav class="md-nav" aria-label="Create a resource based view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#folder-structure" class="md-nav__link"> Folder structure </a> </li> <li class="md-nav__item"> <a href="#list-view" class="md-nav__link"> List view </a> <nav class="md-nav" aria-label="List view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#create-view" class="md-nav__link"> Create view </a> <nav class="md-nav" aria-label="Create view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_1" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#edit-view" class="md-nav__link"> Edit view </a> <nav class="md-nav" aria-label="Edit view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_2" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#details-view" class="md-nav__link"> Details view </a> <nav class="md-nav" aria-label="Details view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_3" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#views-registration" class="md-nav__link"> Views registration </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#create-custom-view" class="md-nav__link"> Create custom view </a> <nav class="md-nav" aria-label="Create custom view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_4" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#customisation-dashboard-view" class="md-nav__link"> Customisation: dashboard view </a> </li> <li class="md-nav__item"> <a href="#customisation-jinja-templates" class="md-nav__link"> Customisation: Jinja templates </a> </li> <li class="md-nav__item"> <a href="#customisation-react-components" class="md-nav__link"> Customisation: React components </a> </li> <li class="md-nav__item"> <a href="#permissions" class="md-nav__link"> Permissions </a> </li> <li class="md-nav__item"> <a href="#admin-actions-permissions" class="md-nav__link"> Admin actions permissions </a> <nav class="md-nav" aria-label="Admin actions permissions"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#custom-permissions" class="md-nav__link"> Custom permissions </a> </li> </ul> </nav> </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_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="../../howtos/i18n/" class="md-nav__link"> Translation (i18n) </a> </li> <li class="md-nav__item"> <a href="../../howtos/custom_fields/" class="md-nav__link"> Create a new custom field </a> </li> <li class="md-nav__item"> <a href="../../howtos/custom_code/" class="md-nav__link"> Create custom code and views </a> </li> <li class="md-nav__item"> <a href="../../howtos/add_javascript/" class="md-nav__link"> Add JavaScript </a> </li> <li class="md-nav__item"> <a href="../../howtos/override_components/" class="md-nav__link"> Override UI React components </a> </li> <li class="md-nav__item"> <a href="../../howtos/search_terms_migration/" class="md-nav__link"> Create search terms mappings </a> </li> <li class="md-nav__item"> <a href="../../howtos/alembic/" class="md-nav__link"> Create a database migration </a> </li> <li class="md-nav__item"> <a href="../../howtos/security-fix/" class="md-nav__link"> Fix a vulnerability </a> </li> <li class="md-nav__item"> <a href="../../howtos/dev_email/" class="md-nav__link"> Test emails locally </a> </li> <li class="md-nav__item"> <a href="../../howtos/route_migration/" class="md-nav__link"> Migrate legacy routes </a> </li> <li class="md-nav__item"> <a href="../../howtos/backup_search_indices/" class="md-nav__link"> Back up search indices </a> </li> <li class="md-nav__item"> <a href="../../howtos/restrict_access/" class="md-nav__link"> Restrict access to pages </a> </li> <li class="md-nav__item"> <a href="../../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="../../architecture/" class="md-nav__link"> Introduction </a> </li> <li class="md-nav__item"> <a href="../../architecture/infrastructure/" class="md-nav__link"> Infrastructure </a> </li> <li class="md-nav__item"> <a href="../../architecture/software/" class="md-nav__link"> Software </a> </li> <li class="md-nav__item"> <a href="../../architecture/runtime/" class="md-nav__link"> Runtime </a> </li> <li class="md-nav__item"> <a href="../../architecture/requests/" class="md-nav__link"> Requests </a> </li> <li class="md-nav__item"> <a href="../../architecture/communities/" class="md-nav__link"> Communities </a> </li> <li class="md-nav__item"> <a href="../../architecture/records/" class="md-nav__link"> Records </a> </li> <li class="md-nav__item"> <a href="../../architecture/event_handling/" class="md-nav__link"> Event handling </a> </li> <li class="md-nav__item"> <a href="../../architecture/notifications/" class="md-nav__link"> Notifications </a> </li> <li class="md-nav__item"> <a href="../../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="../../concepts/concurrency-control/" class="md-nav__link"> Optimistic concurrency control </a> </li> <li class="md-nav__item"> <a href="../../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="#summary" class="md-nav__link"> Summary </a> </li> <li class="md-nav__item"> <a href="#intended-audience" class="md-nav__link"> Intended audience </a> </li> <li class="md-nav__item"> <a href="#overview" class="md-nav__link"> Overview </a> </li> <li class="md-nav__item"> <a href="#domain-dictionary" class="md-nav__link"> Domain dictionary </a> </li> <li class="md-nav__item"> <a href="#administration-panel_1" class="md-nav__link"> Administration panel </a> <nav class="md-nav" aria-label="Administration panel"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#architecture" class="md-nav__link"> Architecture </a> </li> <li class="md-nav__item"> <a href="#views" class="md-nav__link"> Views </a> <nav class="md-nav" aria-label="Views"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#create-a-resource-based-view" class="md-nav__link"> Create a resource based view </a> <nav class="md-nav" aria-label="Create a resource based view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#folder-structure" class="md-nav__link"> Folder structure </a> </li> <li class="md-nav__item"> <a href="#list-view" class="md-nav__link"> List view </a> <nav class="md-nav" aria-label="List view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#create-view" class="md-nav__link"> Create view </a> <nav class="md-nav" aria-label="Create view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_1" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#edit-view" class="md-nav__link"> Edit view </a> <nav class="md-nav" aria-label="Edit view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_2" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#details-view" class="md-nav__link"> Details view </a> <nav class="md-nav" aria-label="Details view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_3" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#views-registration" class="md-nav__link"> Views registration </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#create-custom-view" class="md-nav__link"> Create custom view </a> <nav class="md-nav" aria-label="Create custom view"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#usage_4" class="md-nav__link"> Usage </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#customisation-dashboard-view" class="md-nav__link"> Customisation: dashboard view </a> </li> <li class="md-nav__item"> <a href="#customisation-jinja-templates" class="md-nav__link"> Customisation: Jinja templates </a> </li> <li class="md-nav__item"> <a href="#customisation-react-components" class="md-nav__link"> Customisation: React components </a> </li> <li class="md-nav__item"> <a href="#permissions" class="md-nav__link"> Permissions </a> </li> <li class="md-nav__item"> <a href="#admin-actions-permissions" class="md-nav__link"> Admin actions permissions </a> <nav class="md-nav" aria-label="Admin actions permissions"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#custom-permissions" class="md-nav__link"> Custom permissions </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="administration-panel">Administration panel<a class="headerlink" href="#administration-panel" title="Permanent link">¶</a></h1> Introduced in InvenioRDM v10 <h2 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">¶</a></h2> The following document is a developer guide to the InvenioRDM administration panel, detailing its programmatic interface and usage. <h2 id="intended-audience">Intended audience<a class="headerlink" href="#intended-audience" title="Permanent link">¶</a></h2> This guide is intended for developers of InvenioRDM. <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h2> Invenio administration panel gives the administrator an easy and simple web interface to effectively manage an instance of InvenioRDM. <h2 id="domain-dictionary">Domain dictionary<a class="headerlink" href="#domain-dictionary" title="Permanent link">¶</a></h2> The following terms are introduced to facilitate defining the domain: <ul> <li><code>administration panel</code> - the interface panel enabling a <code>manager</code> to administrate the instance of InvenioRDM in a developer-independent way.</li> <li><code>administrator</code> - a person with domain knowledge, with a special set of permissions, able to manage an InvenioRDM instance, not necessarily having developer skills.</li> <li><code>frontsite</code>, <code>end user interface</code> - currently known InvenioRDM interface, accessible by anonymous and logged-in users, without administrator role.</li> <li><code>administration view</code> - content of the administration panel (pages)</li> </ul> <h2 id="administration-panel_1">Administration panel<a class="headerlink" href="#administration-panel_1" title="Permanent link">¶</a></h2> <img alt="Administration Panel" src="../img/administration/administration_wireframe.png" /> An instance developer can register new entries in the menu (see the administration <a href="https://github.com/inveniosoftware/rfcs/blob/master/rfcs/rdm-0067-administration-panel.md">RFC</a>). A menu entry will display the associated views in the panel section. The navbar menu layouts are customizable to meet the needs of the InvenioRDM instance. <h3 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permanent link">¶</a></h3> <img alt="Architecture diagram" src="../img/administration/administration_architecture.png" /> The views are implemented as shown on the diagram below. InvenioRDM developer can implement a new admin view by inheriting one of the following view classes: <table> <thead> <tr> <th>View</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>AdminView</td> <td>Base view class, provides flask view blueprint registration and administration side menu registration</td> </tr> <tr> <td>AdminResourceDetailView</td> <td>Details view base - displays details of a single item of the resource</td> </tr> <tr> <td>AdminResourceListView</td> <td>ListView base - displays a search page with all the resource items of a given type</td> </tr> <tr> <td>AdminResourceCreateView</td> <td>View generating a form to add a new instance of a resource</td> </tr> <tr> <td>AdminResourceEditView</td> <td>View generating a form to edit an existing resource item</td> </tr> </tbody> </table> <h3 id="views">Views<a class="headerlink" href="#views" title="Permanent link">¶</a></h3> <h4 id="create-a-resource-based-view">Create a resource based view<a class="headerlink" href="#create-a-resource-based-view" title="Permanent link">¶</a></h4> Administration resource based views are using existing REST API. The CRUD operations are provided for any existent InvenioRDM <a href="../resource/">resource</a> (e.g. community, record, OAISet - meaning they follow the REST API resource architecture pattern). As an example, a step-by-step guide is provided to generate an administration view for OAI-PMH Sets. <h5 id="folder-structure">Folder structure<a class="headerlink" href="#folder-structure" title="Permanent link">¶</a></h5> To create an administration view for a module, the following structure is recommended: <div class="highlight"><pre><code>invenio-rdm-records |-- administration |-- __init__.py |-- views |-- __init__.py |-- oai.py </code></pre></div> Views are implemented in <code>invenio_rdm_records/administration/views/<myview>.py</code>. We strongly recommend to follow this proposed folder structure as it promotes clear code organisation, however it is not technically required. <h5 id="list-view">List view<a class="headerlink" href="#list-view" title="Permanent link">¶</a></h5> A ListView displays a list of records that are retrieved from an InvenioRDM <a href="../resource/">resource</a> REST APIs endpoint. By default, <code>Invenio-Administration</code> provides a core module that generates this view, based on given <code>ListView</code> configuration. By default, the ListView is represented as a table. The view uses a search app, bootstrapped using <a href="https://inveniosoftware.github.io/react-searchkit/">React-SearchKit</a>. It provides a tabular view of the resources, as well as a set of features such as searching, sorting and even faceting. <img alt="List view layout" src="../img/administration/administration_list_view.png" /> Each row contains a set of actions that can be performed on a resource. These actions can be the "default" ones, such as "Edit" or "Delete", but can also be extended to support custom actions that are only available for that specific resource, e.g. feature a community. <h6 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h6> This is an example of ListView configuration for OAI-PMH set resource. <div class="highlight"><pre><code>from invenio_administration.views.base import AdminResourceListView class OaiPmhListView(AdminResourceListView): """Configuration for OAI-PMH sets list view.""" api_endpoint = "/oaipmh/sets" name = "OAI-PMH" resource_config = "oaipmh_server_resource" search_request_headers = {"Accept": "application/json"} title = "OAI-PMH Sets" category = "Site management" pid_path = "id" icon = "exchange" template = "invenio_rdm_records/oai-search.html" display_search = True display_delete = True display_edit = True item_field_list = { "spec": {"text": "Set spec", "order": 1}, "name": {"text": "Set name", "order": 2}, "search_pattern": {"text": "Search query", "order": 3}, "created": {"text": "Created", "order": 4}, "updated": {"text": "Updated", "order": 5}, } search_config_name = "RDM_OAI_PMH_SEARCH" search_facets_config_name = "RDM_OAI_PMH_FACETS" search_sort_config_name = "RDM_OAI_PMH_SORT_OPTIONS" create_view_name = "oaipmh_create" resource_name = "name" </code></pre></div> For the full attributes list and description visit the <a href="../../../reference/administration_reference/">reference docs</a>. <h5 id="create-view">Create view<a class="headerlink" href="#create-view" title="Permanent link">¶</a></h5> <img alt="Create view layout" src="../img/administration/administration_create_view.png" /> A create view displays a page on which a resource can be created. By default, <code>Invenio-Administration</code> provides a core module that generates this view based on given <code>CreateView</code> configuration. Form fields are configured as class attributes. If the <code>form_fields</code> attribute is not implemented, the view will display all the fields configured in the resource's <a href="../serializers/#data-transformations">serializer</a>. <h6 id="usage_1">Usage<a class="headerlink" href="#usage_1" title="Permanent link">¶</a></h6> This is an example of CreateView configuration for OAI-PMH set resource. <div class="highlight"><pre><code>class OaiPmhCreateView(AdminResourceCreateView): """Configuration for OAI-PMH sets create view.""" name = "oaipmh_create" url = "/oai-pmh/create" resource_config = "oaipmh_server_resource" pid_path = "id" api_endpoint = "/oaipmh/sets" title = "Create OAI-PMH set" list_view_name = "OAI-PMH" form_fields = { "name": {"order": 1, "text": "Set name"}, "spec": {"order": 2, "text": "Set spec"}, "search_pattern": {"order": 3, "text": "Search query"}, } </code></pre></div> For the full attributes list and description visit the <a href="../../../reference/administration_reference/">reference docs</a> <h5 id="edit-view">Edit view<a class="headerlink" href="#edit-view" title="Permanent link">¶</a></h5> <img alt="Edit view layout" src="../img/administration/administration_edit_view.png" /> This view displays a form to edit a selected resource. Form fields are customizable to each resource by implementing marshmallow <a href="../serializers/#data-transformations">schema</a> <h6 id="usage_2">Usage<a class="headerlink" href="#usage_2" title="Permanent link">¶</a></h6> This is an example of EditView configuration for OAI-PMH set resource. <div class="highlight"><pre><code>class OaiPmhEditView(AdminResourceEditView): """Configuration for OAI-PMH sets edit view.""" name = "oaipmh_edit" url = "/oai-pmh/<pid_value>/edit" resource_config = "oaipmh_server_resource" pid_path = "id" api_endpoint = "/oaipmh/sets" title = "Edit OAI-PMH set" list_view_name = "OAI-PMH" form_fields = { "name": {"order": 2, "text": "Set name"}, "spec": {"order": 3, "text": "Set spec"}, "search_pattern": {"order": 4, "text": "Search query"}, "created": {"order": 5}, "updated": {"order": 6}, } </code></pre></div> For the full attributes list and description visit the <a href="../../../reference/administration_reference/">reference docs</a> <h5 id="details-view">Details view<a class="headerlink" href="#details-view" title="Permanent link">¶</a></h5> <img alt="Details view layout" src="../img/administration/administration_details_view.png" /> By default, this view displays the details of a selected resource. It can be configured to display/hide a set of fields. It can be extended or completely overridden by a custom view. For OAI-PMH sets, as seen in the figure, this view uses a custom Jinja template and <code>React</code> to render a second table that displays OAI-PMH Sets links. More information on template override and custom React components will be detailed later in this guide. <h6 id="usage_3">Usage<a class="headerlink" href="#usage_3" title="Permanent link">¶</a></h6> This is an example of DetailView configuration for OAI-PMH set resource. <div class="highlight"><pre><code>class OaiPmhDetailView(AdminResourceDetailView): """Configuration for OAI-PMH sets detail view.""" url = "/oai-pmh/<pid_value>" api_endpoint = "/oaipmh/sets" search_request_headers = {"Accept": "application/json"} name = "OAI-PMH details" resource_config = "oaipmh_server_resource" title = "OAI-PMH Details" template = "invenio_rdm_records/oai-details.html" display_delete = True display_edit = True list_view_name = "OAI-PMH" pid_path = "id" item_field_list = { "name": {"text": "Set name", "order": 1}, "spec": {"text": "Set spec", "order": 2}, "search_pattern": {"text": "Search query", "order": 3}, "created": {"text": "Created", "order": 4}, "updated": {"text": "Updated", "order": 5}, } </code></pre></div> For the full attributes list and description visit the <a href="../../../reference/administration_reference/">reference docs</a> <h5 id="views-registration">Views registration<a class="headerlink" href="#views-registration" title="Permanent link">¶</a></h5> In order to render views in <code>Invenio-Administration</code>, they must be registered from the module on which they are implemented. To register your new view, you will have to: <ol> <li>Create views in the module.</li> <li>Configure views to match your needs.</li> <li>Register views in <code>Invenio-Administration</code> entry point group.</li> </ol> In OAI-PMH sets example, views are registered in <code>Invenio-Administration</code> as individual entry points from <code>invenio-rdm-records</code>. Edit the setup.cfg in the module and add: <div class="highlight"><pre><code>[options.entry_points] invenio_administration.views = invenio_rdm_records_oai_list = invenio_rdm_records.administration.views.oai:OaiPmhListView invenio_rdm_records_oai_edit = invenio_rdm_records.administration.views.oai:OaiPmhEditView invenio_rdm_records_oai_create = invenio_rdm_records.administration.views.oai:OaiPmhCreateView invenio_rdm_records_details = invenio_rdm_records.administration.views.oai:OaiPmhDetailView </code></pre></div> <h4 id="create-custom-view">Create custom view<a class="headerlink" href="#create-custom-view" title="Permanent link">¶</a></h4> A custom view can be created by inheriting directly from <code>AdminView</code>. <h5 id="usage_4">Usage<a class="headerlink" href="#usage_4" title="Permanent link">¶</a></h5> In your <code><invenio-module></code> (called <code>invenio_module</code> for simplicity), create a <code><filename>.py</code> file: <div class="highlight"><pre><code>from invenio_administration.views.base import AdminView class MyCustomView(AdminView): """My custom view.""" name = "customview" category = "My category" template = "invenio_module/custom_view_template.html" # placed in templates/invenio_module/custom_view_template.html url = None menu_label = "Custom View" icon = "user" </code></pre></div> The class defined for the custom view must be registered as an entry point, as follows: Edit the <code>setup.cfg</code> of your module and add: <div class="highlight"><pre><code>[options.entry_points] invenio_administration.views = invenio_module_admin_custom_view = invenio_module.path.to.filename:MyCustomView </code></pre></div> For the full attributes list and description visit the <a href="../../../reference/administration_reference/">reference docs</a> <h3 id="customisation-dashboard-view">Customisation: dashboard view<a class="headerlink" href="#customisation-dashboard-view" title="Permanent link">¶</a></h3> The dashboard view (also known as index view) is a first page that administrator sees after loging into the administration panel. <img alt="" src="../img/administration/administration_dashboard.png" /> For simple customisations, dashboard view can be overridden by adding new Jinja template in your local instance, as follows: <code>templates/invenio_administration/index.html</code>. In case of more complex use cases, the dashboard view can be configured by creating a view that inherits from the <code>AdminView</code> and updating the config variable <code>ADMINISTRATION_DASHBOARD_VIEW</code> with the new declared view. <div class="highlight"><pre><code>ADMINISTRATION_DASHBOARD_VIEW = ( "invenio_administration.views.dashboard.AdminDashboardView" ) </code></pre></div> <h3 id="customisation-jinja-templates">Customisation: Jinja templates<a class="headerlink" href="#customisation-jinja-templates" title="Permanent link">¶</a></h3> The views are defined by Jinja templates, and this can be easily extendable and overridable by redefining their blocks. If you would like to customize any of the exising default administration views, you can do so by overriding their Jinja templates, for each type of the view can be overridden by using the Jinja's inheritance: <div class="highlight"><pre><code> {% extends "invenio_administration/details.html" %}  {% extends "invenio_administration/edit.html" %}  {% extends "invenio_administration/search.html" %}  {% extends "invenio_administration/create.html" %}  {% extends "invenio_administration/index.html" %} </code></pre></div> In each view you can override or extend different blocks, mainly there are 2 blocks that can be overridden to display our custom content: <ul> <li><code>admin_page_content</code>: Content of each view. It's present in all the views.</li> <li><code>JavaScript</code>: Main block to place any JavaScript content.</li> </ul> <div class="highlight"><pre><code>{% extends "invenio_administration/details.html" %} {% block admin_page_content %} {# MY custom content #} {% endblock admin_page_content %} {% block javascript %} # don't forget the parent JS assets! {{ super() }} # don't forget to add proper assets to your template {{ webpack['invenio-administration-search.js'] }} {% endblock %} </code></pre></div> More information about <code>blocks</code> and template inheritance is available in <a href="https://Jinja.palletsprojects.com/en/3.0.x/templates">Jinja documentation</a>. To find more about the different blocks that can be overridden in each of the views you can check the code of the views <a href="https://github.com/inveniosoftware/invenio-administration/tree/main/invenio_administration/templates/semantic-ui/invenio_administration">here</a>. <h3 id="customisation-react-components">Customisation: React components<a class="headerlink" href="#customisation-react-components" title="Permanent link">¶</a></h3> In addition to Jinja, in each view there is the possibility to overwrite single building block of the UI - React components. If you would like to, for example, change layout of the default view, you can create your own React component to display the view. Create a js file (<code>MyComponent.js</code>) containing your custom component, which you have to place in <code>/assets/js</code> folder of your module. <div class="highlight"><pre><code>class MyComponent extends Component { render() { return "Hello World!" } } const domContainer = document.getElementById("invenio-details-config"); domContainer && ReactDOM.render( <MyComponent />, domContainer ); </code></pre></div> Add the <code>.js</code> file as webpack entry - inside <code>webpack.py</code> file of your module: <div class="highlight"><pre><code>theme = WebpackThemeBundle( __name__, "assets", default="semantic-ui", themes={ "semantic-ui": dict( entry={ + "my-component": + "./js/path/to/my/new/file/MyComponent.js", ... </code></pre></div> Once the file was added as webpack entry, we can add it to the template we are overriding. Make sure webpack.py file is registered as entry point in your module. <div class="highlight"><pre><code>{% extends "invenio_administration/details.html" %} {% block admin_page_content %} <div id="invenio-details-config" > </div> {% endblock admin_page_content %} {% block javascript %} # don't forget the parent JS assets! {{ super() }} # make sure the name of the asset matches the name you registered in the webpack entry {{ webpack['my-component.js'] }} {% endblock %} </code></pre></div> Make sure unique html tag ID in your <code>.js</code> file and Jinja template match. If you need to overwrite only the React components in your view (without customising Jinja templates) - you can skip the step above, and use one of the existing DOM elements identifiers: <ul> <li><code>invenio_administration/create.html</code> -> id="invenio-administration-create-root"</li> <li><code>invenio_administration/details.html</code> -> id="invenio-details-config"</li> <li><code>invenio_administration/edit.html</code> -> id="invenio-administration-edit-root"</li> <li><code>invenio_administration/search.html</code> -> id="invenio-search-config"</li> </ul> <h3 id="permissions">Permissions<a class="headerlink" href="#permissions" title="Permanent link">¶</a></h3> Only users with action <code>administration-access</code> granted are allowed to access the Invenio Administration panel. This new permission's action has been introduced in InvenioRDM v10.0.0. There are two ways to grant this permission: <ol> <li> Permission can be added using a role: <div class="highlight"><pre><code> # make sure you are inside your instance's directory cd my-site # Create a role named administration pipenv run invenio roles create administration # Allow access to administration to the administration role pipenv run invenio access allow administration-access role administration # Add administration role to an user email pipenv run invenio roles add <user_email> administration </code></pre></div> </li> <li> Permission can be added to a specific user: <div class="highlight"><pre><code> # Grant access to a specific user to the action administration-access pipenv run invenio access allow administration-access user <user_email> </code></pre></div> </li> </ol> <h3 id="admin-actions-permissions">Admin actions permissions<a class="headerlink" href="#admin-actions-permissions" title="Permanent link">¶</a></h3> Any request endpoint which is handled by administration panel (creating a resource, editing a resource, featuring a community, etc.), must have <code>Administration()</code> permission added, for example: <div class="highlight"><pre><code>from invenio_administration.generators import Administration from invenio_records_permissions import BasePermissionPolicy class OAIPMHServerPermissionPolicy(BasePermissionPolicy): """OAI-PMH permission policy.""" can_read = [Administration()] can_create = [Administration()] can_delete = [Administration()] can_update = [Administration()] can_read_format = [Administration()] </code></pre></div> <h4 id="custom-permissions">Custom permissions<a class="headerlink" href="#custom-permissions" title="Permanent link">¶</a></h4> You can customize your individual permissions per view by overwriting <code>decorators</code> class attribute as shown below (see also <a href="https://flask.palletsprojects.com/en/2.2.x/views/#view-decorators">Flask class based views documentation</a>). <div class="highlight"><pre><code>from invenio_administration.permissions import administration_permission class MyView: decorators = [administration_permission.require(http_exception=403)] </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="../theming/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Theming"> <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"> Theming </div> </div> </a> <a href="../../howtos/i18n/" class="md-footer__link md-footer__link--next" aria-label="Next: Translation (i18n)"> <div class="md-footer__title"> Next <div class="md-ellipsis"> Translation (i18n) </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

Administration panel - Turn-key research data management repository