Using NAKALA: NAKALA Data Repository documentation¶

Useful links¶

!!! info “Nakala documentation - Get informed: https://documentation.huma-num.fr/nakala/ - Prepare your data: https://documentation.huma-num.fr/nakala-preparer-ses-donnees/ - Describe your data: https://documentation.huma-num.fr/nakala-guide-de-description/ - Check for updates: https://documentation.huma-num.fr/nakala-release-notes/

!!! info “Nakala web interface - Test: https://test.nakala.fr - Explore and use: https://nakala.fr

!!! “Nakala API” info - The test API is available at: apitest.nakala.fr - The production API is available at: https://api.nakala.fr/doc - Nakala API tutorial: https://gitlab.huma-num.fr/huma-num-public/notebook-api-nakala

!!! info “Requesting access to Nakala: 2 steps”. 1. Create a HumanID. You’ll find instructions for creating a HumanID account on the https://documentation.huma-num.fr/humanid/ page. 2. Request access to your Nakala space on the HumanID portal: on the “My services” page, click on “Request access” in the Nakala insert. Your Nakala access will be examined and processed by the Huma-Num team within approximately 1 to 3 weeks.

!!! “Contact us” info - If you have any questions about Nakala, please contact us at nakala@huma-num.fr.

Introduction and overview¶

What is Nakala?¶

Nakala is a research data repository for the Humanities and Social Sciences.

The Nakala data repository offers services at several stages in the life cycle of research data in the humanities and social sciences: preservation, publication and reuse.

According to the Research Data Alliance (RDA), “a research data repository can be defined as an online service for managing the description of datasets for preservation and reuse. A repository exposes detailed metadata for each dataset and facilitates access to the data. Information […] includes essential metadata, provenance metadata and conditions of use.” (source (fr))

Nakala homepage: https://www.nakala.fr/

Responsibility for continued access to data hosted in Nakala is entrusted to Huma-Num. Further details are provided in the FAQ.

Who can use Nakala?¶

In order to deposit data in Nakala, the user must be from the French academic world or participate in a project whose main supporting team is from the French academic world.

What data can be deposited?¶

The data submitted must be research data from scientific projects in the Social Sciences and Humanities. Nakala does not accept administrative data.

For a definition of research data, consult the online resource: Inist-CNRS, Définition(s) des données de la Recherche ; Publié le 15/03/2022 | DOI : 10.13143/b4zc-8e79 [consulté le 11/05/2022] : https://doranum.fr/plan-gestion-donnees-dmp/definitions-des-donnees-de-la-recherche/

Where are the data stored?¶

The data in Nakala are stored on servers managed by Huma-Num and hosted in France, at the IN2P3 computing center.

For further details, please refer to the FAQ.

How are data backed up?¶

Nakala data is stored on a network storage device. A snapshot of the data is taken at regular intervals. In addition, a tape backup is performed daily. Nakala metadata is stored in a SQL database backed up daily on Huma-Num’s infrastructure.

For technical details, please refer to FAQ.

How much does it cost to use Nakala?¶

Nakala is fully supported by Huma-Num in terms of development, upgrades and maintenance. As such, no fees are charged when data is deposited in Nakala.

Why store your research data in Nakala?¶

Preserving digital data involves a range of best practices and tools that are complex to articulate. Secure storage means backing up computer files and verifying the integrity of each copy. Long-term preservation or archiving involves maintaining the readability of the information content of data (computer files) and peripheral information (metadata) over time. Maintaining this readability may involve transformations (format conversions) in the event of obsolescence.

Nakala offers three levels of service:

• A default level, which is controlled by automatic checks during the process of data deposit in NAKALA. The data is described, contextualized and stored securely.
• A second level, where these data deposits are curated for data format and metadata quality by HumaNum’s team and partners before, during, and after deposit. This is a prerequiste for the third level of longterm preservation, and a request must be made to cogrid@huma-num.fr
• A final, advanced level, in partnership with CINES. In this advanced repository circuit, long-term preservation is ensured by CINES. CINES provides additional guarantees such as the legal value of the deposit, file integrity, format migration for readability, etc. For long-term preservation of data deposited in Nakala, a request must be made to cogrid@huma-num.fr.

Some advantages of using Nakala :

• A secure copy of your data and metadata on a secure infrastructure
• Perennial identifiers that can be cited in your publications (DOI)
• A general data description schema, Dublin Core
• Access to your data with no volume or time limits
• Fine-tuned management of data access, sharing and publication rights
• a search engine that exploits and indexes metadata as well as the content of text files (markdown files, CSV files, OCRized images, PDF files, etc.) for a broader search.
• Making metadata available in an interoperable way through APIs and the OAI-PMH protocol, enabling it to be used and/or referenced by external aggregators, such as the specialized search engine ISIDORE.

How can I follow Nakala’s development?¶

The following page describes Nakala updates and upgrades: https://documentation.huma-num.fr/nakala-release-notes/.

Main features¶

Nakala data¶

The term “data” in Nakala refers to the association of one or more files and a set of information describing them (metadata).

Registering data therefore necessarily involves loading one or more files into Nakala and describing them with metadata.

To validate the record, choose between the following two options:

• “Create”
• Publish”.

These two modes of data recording imply a significant difference in data status.

Private or public status¶

Private status¶

Creating data makes it visible only to the data depositor and to users to whom rights have been granted by the data depositor. This is a transitory state before final publication, for example for an intermediate proofreading or validation stage.

For data with private status, Nakala limits storage space. Each user can store up to 10,000 pieces of private data (or the equivalent of a maximum of 100 GB).

Private data can be deleted at any time by any user who has the right to modify it.

Public status¶

Publish data makes it publicly accessible and reusable.

By default, the files and description (metadata) of public data can be consulted by any Nakala visitor. However, you can define an access limit (embargo) on the files of your choice. They will then be visible only after the time limit has expired. However, these files remain accessible to those who have read rights to the data. The description will always be visible and freely accessible.

There is no storage limit for published data.

Data publication is definitive. A DOI is automatically assigned to published data. The function of a persistent identifier is to identify a resource in a stable, long-term manner. This is why, once a piece of data has been published on Nakala, the depositor can neither delete nor unpublish it.

For further information, please refer to the paragraph on deleting data.

Assigning a DOI to public data¶

Nakala automatically assigns a unique, perennial DOI to each piece of public data. This DOI is assigned instantly, as soon as the data is published. Each DOI is registered with DataCite.

A perennial identifier enables :

• Identify and access data over the long term
• Facilitate referencing and citation of the data.

Perennial identifiers are one of the criteria for making data FAIR.

Data types and formats¶

Nakala accepts all types of digital research data from scientific projects in the Humanities and Social Sciences, whether or not these data are associated with a publication. This includes text, image, video and sound files. Likewise, Nakala accepts all file formats. However, we recommend the use of open formats for long-term data readability and interoperability. For further details, please refer to the “Preparing data” section of our online documentation: https://documentation.huma-num.fr/nakala-preparer-ses-donnees/#choisir-les-formats.

Data description with Dublin Core¶

• The “Description Guide” section of the NAKALA documentation provides useful tips for describing your data.

In Nakala, the data description standard (metadata schema) is Dublin Core Metadata Initiative.

While there is no cost in financial terms for Nakala users, the people who deposit data have an important and crucial role to play in making this data intelligible in the long term. Thus, it is recommended to provide as much information as possible about the data; to be consistent and systematic when describing a dataset; and to rely as much as possible on terms from standard repositories to fill in certain description fields (keywords and geographical locations, for example). This will provide a quality description framework for the data, optimizing its semantic understanding and interoperability, and guaranteeing better traceability of the data over time (provenance, producer/author, context of use, production context, etc.). This virtuous framework also enables us to meet the FAIR-ization criteria for research data.

To help and support you in this quality approach, don’t hesitate to turn to local research support staff, whether in MSHs, laboratories, libraries (service commun de documentation - SCD, for example), etc.

Five metadata specific to Nakala are mandatory to deposit data:

• Title** (nakala:title, multiple values)
• Type** (nakala:type, unique)
• Author** (nakala:creator, multiple values)
• Date** (nakala:created, unique)
• License** (nakala:license, unique)

This is the minimum set of information required to report and cite data. However, we strongly recommend that you provide as much information as possible for each piece of data, to make it as intelligible as possible (context, origin, etc.). With this in mind, you can add and select as many DCMI description fields as you wish to complete the data description.

In Nakala, the license you enter in the ‘License’ field applies to all files in the deposited data. The metadata of public data is considered public, and as such is subject to an open license with free reuse, provided the source of the information is acknowledged: CC-BY.

Main filing features¶

Web interface submission¶

The NAKALA Data Repository is available at: https://www.nakala.fr/.

To access the repository web interface, the user must have created a HumanID account and requested access to Nakala.

HumanID portal: request access to Nakala.

The “Submit your data” form allows you to :

• upload one or more files and present them in the order of your choice
• fill in the mandatory metadata (main metadata of the repository)
• select and fill in additional metadata fields
• define data sharing and access rights
• integrate the data into one or more collections
• save data as “private” (create) or “public” (publish)

Nakala data repository form

API repository¶

Nakala is accessible via an API (Application Programming Interface): https://api.nakala.fr/doc.

To access the repository API, the user must have created a HumanID account and requested access to Nakala. This access will be examined and processed by the Huma-Num team within approximately 1 to 3 weeks.

The Nakala API enables you to create, manage and administer your repositories on Nakala. The API allows you to :

• explore data and collections
• manage data
• manage collections
• manage user groups
• manage users
• search in implemented vocabularies

• The test API is available at: apitest.nakala.fr
• The Production API is available at: https://api.nakala.fr/doc
• Nakala API tutorial: https://gitlab.huma-num.fr/huma-num-public/notebook-api-nakala

Batch deposit¶

Batch deposit is not currently available on the Nakala web deposit interface. However, using the API, it is possible to define a batch deposit script. For details, see https://gitlab.huma-num.fr/huma-num-public/notebook-api-nakala.

Versioning data¶

For public data, adding, deleting or loading a new version of a file automatically generates a new version of the data. The form of the initial DOI is retained. Adding or modifying metadata does not generate a new version of the data.

For further details, please refer to the “Data version management” paragraph: https://documentation.huma-num.fr/nakala/#gestion-des-versions-dune-donnee.

Sharing data published in Nakala¶

Nakala offers a system for exposing public data and metadata.

There are several ways of exploiting the public data deposited in Nakala:

• create a mini-website to promote a public collection using the Nakala_Press publishing module (see the documentation “Publish with Nakala_Press” offered by Huma-Num)
• use existing tools such as a CMS, a blog, a search engine, etc.
• develop your site on top of Nakala APIs
• reference your data in specialized search engines, such as Isidore.

It is also possible to expose your files in digital environments external to Nakala. For example, a video file can be inserted into web pages, as in the case of a Hypothesis research notebook or a web documentary. For further details, please refer to the online documentation: link to “Presenting your data” documentation.

Metadata harvesting¶

Nakala has its own OAI-PMH repository at https://api.nakala.fr/oai2. Every public collection constitutes an OAI set in Nakala’s OAI-PMH repository. Each OAI set can be indexed by the Isidore search engine and presented as a collection in Isidore. To be indexed by Isidore, you must send a request to isidore-sources@huma-num.fr. Similarly, all Nakala users can use the web address of the OAI-PMH warehouse to have metadata harvested by document portals.

Connection with Zotero¶

A connection between Nakala and Zotero is available, enabling you to use Zotero’s Web module to reference Nakala data in your bibliographic manager, along with all the corresponding metadata.

Data archiving¶

Data deposited in Nakala does not automatically enter into a long-term archiving process. To set up this process, you need to contact Huma-Num members via cogrid@huma-num.fr.

Main administration functions¶

Choice of license (mandatory) and reuse framework¶

In Nakala, the depositor is required to enter a publication and reuse license for the digital files associated with the data. This license protects the data producer and defines the types of re-use granted to third parties concerning the files.

The metadata of published data is considered public in Nakala, and as such is subject to an open license with free reuse, provided the source of the information is acknowledged (CC-BY license).

Rights management¶

The depositor is able to assign specific rights associated with roles to individual users and lists of users on :

• data
• collections
• user lists to manage rights

In this way, the depositor can target users and manage their roles on the resource. For each role, the Nakala team has defined a set of differentiated consultation, modification, deletion and publication rights. Rights on data files are inherited from data deposit rights, i.e. the user’s role is defined at data deposit level and will be applied to all the files making up the data deposit.

NAKALA_PRESS site rights are inherited from the rights of the collection from which the website was created.

Restricted access to a file (embargo)¶

For public data, the depositor can choose to restrict access to some or all files by specifying a visibility date for each file (embargo). Embargoed files are then accessible only to the depositor. However, it is possible to share access to embargoed files with other users, provided they have been assigned a role within the data deposit.

Managing data versions¶

When public data files are modified (addition, deletion, loading of a new version of a file), a new version of the data is automatically generated, and the old versions remain accessible on the landing page.

All versions remain accessible on the data presentation page, although the latest version is highlighted. Please note that only the latest version of a data item is sent and updated to Datacite, as Nakala does not offer a versioned DOI. When the modification only concerns metadata, this does not lead to the creation of a new version.

To access a specific version, add a version number to the data URL, prefixed with a dot ‘. Example: For the dataset 10.34847/nkl.f43by03n, adding the suffix .v1 to its URL https://nakala.fr/10.34847/nkl.f43by03n points directly to version 1 of this dataset: https://nakala.fr/10.34847/nkl.f43by03n.v1

On the datas API (data management), use the GET /datas/{id}/versions request to retrieve the list of data versions. To access the specific version of a dataset, you need to add a version number to the end of the dataset identifier. Example: 10.34847/nkl.eabbbf68.v2 gives access to version 2 of data 10.34847/nkl.eabbbf68

Grouping data into collections¶

To organize data in Nakala, you can create collections. Data can belong to several collections.

A collection has 2 possible statuses: private or public. A private collection can contain data with both ‘private’ and ‘public’ status. A public collection contains only public data. Any authenticated user can therefore create collections containing his or her own data and the public data of other users. However, this user will have no rights over public data deposited by others, unless a user has granted him/her a specific role over this data.

A collection groups together a coherent set of data. The coherent grouping of data within collections should be considered according to your own documentary, scientific or other needs. Collections can be organized by theme, data type or format, etc., but it is not possible to create sub-collections. Nakala does not allow you to create a hierarchical tree structure between collections. You can create as many collections as you need and share them with other users to whom you have assigned specific rights. As a reminder, managing rights to a collection is independent of managing rights to the data it contains. This means that a user who has rights over a collection does not automatically have the same rights over the data that has been grouped together within that collection.

The collection identifier is internal to Nakala. It is not a perennial identifier, which is why collections can be deleted.

URLs for public collections are constructed in the form: https://nakala.fr/collection/{identifier}.

Each Nakala collection corresponds to an OAI set. In this way, Nakala users can use the web address of the OAI-PMH repository to have metadata harvested by documentary portals (ISIDORE, Gallica, etc.).

Example of a query containing all the data in an OAI set (i.e. a collection): https://api.nakala.fr/oai2?verb=ListRecords&metadataPrefix=oai_dc&set=doi_10.34847_nkl.569a75l1

For this type of query, the OAI set identifier corresponds to the collection identifier, with the prefix doi_ (or hdl_) added and the / replaced by _.

Example for a handle (data published before December 2020): https://api.nakala.fr/oai2?verb=ListRecords&metadataPrefix=oai_dc&set=hdl_11280_46b54420

Deleting data¶

Private data can be deleted by the depositor and any other user who has been granted modification rights.

On the other hand, public data cannot be deleted, as any organization that assigns DOIs is contractually bound to maintain information about the data, and to link to a page presenting the resource.

If the user requires a public data item to be deleted, he/she should send a request to nakala@huma-num.fr. Please note that only the data files will be permanently deleted. The DOI of the data will be preserved and will link to a page presenting the data, indicating that the data has been deleted: access to the deleted data therefore points to a “tombstone” mentioning minimal metadata.

Getting started with Nakala¶

The Nakala home page is accessed via the address https://www.nakala.fr/.

NAKALA Test¶

We strongly encourage you to test the data repository to discover, under simulated conditions, the full range of Nakala’s functionalities. This allows you to check that Nakala meets your needs, and to get to grips with Nakala without permanently saving your data, as the test environment is regularly reset and the data deleted. This sandbox is totally independent of the production environments available from https://nakala.fr/ and https://api.nakala.fr/doc.

!!! info “Links for testing Nakala - The test web interface is available at: test.nakala.fr. - The test APIs are available at: https://apitest.nakala.fr/doc.

**Please note that it is not possible to use your HumanID account to access the test interfaces. To test Nakala, four accounts are made available to users on the home page of test.nakala.fr. For each of these 4 accounts, an API key is provided.

Home of the test environment : list of accounts

API key¶

This key is intended for a restricted audience wishing to use the Nakala API to develop scripts independent of the web repository interface.

To use the test API https://apitest.nakala.fr/doc, you need to log in with one of the 4 API keys made available on the test web interface at https://test.nakala.fr.

You’ll find your personal API key linked to your HumanID account by clicking on “My profile”, once you’ve logged in with your HumanID.

Personal API key - My profile section

Nakala data deposit form¶

*Drop form view

Preamble¶

• Create a HumanID account
• Request access to Nakala from the HumanID portal
• Have prepared the files to be uploaded and the associated metadata. For guidance, please refer to the documentation: https://documentation.huma-num.fr/nakala-preparer-ses-donnees/
• Once connected to Nakala, open the upload form from the home page by clicking on “I’m uploading my data to Nakala”.

“Deposit files” zone¶

In this area, upload the file(s) by drag & drop, copy & paste or by clicking on “Browse” to open your file explorer.

If several files are loaded, you can organize them in the order of your choice:

• in alphabetical order, with a single click on the “Sort alphabetically” button
• by manually moving them one by one to define their order in the list.

To make it easier to organize the files loaded into a dataset, we strongly recommend that you draw up a naming plan and a classification plan for your data, before depositing it in Nakala.

Organize the order of files

To set an embargo on your files for a certain date and add a description to each file, click on the file name or check the box to open an information block which allows you to :

• set an access date by clicking on the “Visibility date” field and choosing a date from the calendar
• make the file inaccessible over the long term by ticking ‘Never’.
• add free text in the ‘Description’ field. To save this information to the file, click on the ‘Save’ button.

*Adding an embargo

You can delete a file from a private data set at any time by checking the box of the file you wish to delete, then clicking on the “Delete file” button. You can set the same description and visibility date for several files by selecting the files via the checkboxes. The description and visibility date will apply to all selected files.

Add a description, delete a file and save.

“Main repository metadata” zone¶

The “Repository main metadata” zone contains five mandatory metadata fields. This minimum set of information is essential for reporting, sharing and citing your data.

Repository type’: select the most appropriate type for your data from the list.

Title’: Enter an explicit title that provides information on the content of the data. To add another title, click on the + button to the right of the ‘Title’ field.

Add an additional title.

Specify the title language by clicking on “No language information”. The default setting is 5 languages: English, French, Spanish, German and Italian. To specify other languages, enter the first letters of the language name in the empty field, and a list of suggestions will appear. Select the language of your choice.

Add the language in which the data title is expressed.

Authors’: this metadata accepts only and strictly personal names composed of a surname and a first name. To enter an author’s name, type the first letters of his or her surname or first name. Nakala proposes a list of authors, by autocompletion, based on authors already registered in the database by other users. Select the author of your choice. The Authors field is repeatable.

*Add an author

Search for and select multiple authors in the list !

If the author’s name does not appear in the list of proposals, enter at least two characters: the message “No users in the list? Add other authors” message appears. Click on “Add other authors”.

Functionality for adding a new author.

A block opens in which you must enter a first and last name. Only the ORCID is optional. Save by clicking on “+ Add”. Please note: until the data has been saved, the authors you have created will not be saved.

*Create an author

In the case of data whose author is not known in the form of name/first name, or if it is a legal entity, an unknown author, etc., check the “Anonymous” box.

Author in a form other than Surname/First Name: tick ‘Anonymous’.

Then transfer the information to the most appropriate Dublin Core property (dcterms:creator, dcterms:contributor or dcterms:publisher, for example) by clicking on “Add metadata” in the “Add other metadata” zone.

Creation date’: indicate the date on which the content of the resource was created. The date must be in the format YYYY or YYYY-MM or YYYY-MM-DD. If this information does not exist, or if the dates do not correspond to the expected format, check the “Unknown” box. Then transfer the temporal information to the appropriate Dublin Core properties - dcterms:created, dcterms:date, dcterms:temporal, etc. - by clicking on “Add metadata”. - by clicking on “Add metadata” in the “Add other metadata” area.

Date in non-compliant format: check ‘Unknown’.

License’: a selection of seven licenses is offered by default. To select other licenses from the 400 available, enter the first few characters of the license name in the empty field. This will display a list of proposals. Select license.

Search for a license in the list.

“Additional information” zone¶

Filling in the three optional metadata fields in the “Additional information” zone is highly recommended for understanding and indexing the data. A precise description of the data allows it to be contextualized, making it intelligible in the long term. Adding keywords and the language of the content facilitates and improves the search for the data, since it enables better indexing.

*Additional information” area

Description’: describe the content of the resource. Specify the language in which the description is given by clicking on “No language information”: select the language from the five default languages or search the list, entering the language name in the empty field.

Keywords’: indicate here the subject(s) of the data content. You can enter several keywords in this field.

By clicking on “No language information”, select the language of the keywords from the five default languages, or search the list by entering the name of the language in the empty field.

Languages’: enter the language of the data, where relevant: for example, for an audio recording, a video or a text. By default, five languages are available: English, French, Spanish, German and Italian.

*Default languages

However, the Nakala repository provides over 7,000 languages according to ISO-639-1 and ISO-639-3 standards. To enter a language, type the first few letters in the empty field, and a list of suggested languages will be displayed. Select the language.

*Search for other languages

“Add other metadata” zone¶

Providing as much detailed information as possible about the data makes it easier for third parties to understand. This is why you can add further information in the “Add other metadata” zone. All fields are repeatable.

By clicking on “Add metadata”, select the DCMI terms property of your choice in “Property”.

Add metadata: select a DCMI property.

You can specify the encoding of the value entered in the property, by selecting it from the ‘Type’ list. For example, to add the geographic coordinates of the city of Perth in Australia, select the “dcterms:spatial” property, enter the value “name=Perth, W.A.; east=115.85717; north=-31.95301” and specify the encoding ‘dcterms:Point’. Take care to respect the syntax or value expected by the chosen encoding.

To delete a metadata, click on the red cross to the right of the field.

Add metadata: type the value specified in the dcterms:spatial property.

“Links to other data published in Nakala” zone¶

The “Relations to other data published in Nakala” zone lets you declare and create symmetrical relations between data that has been published in Nakala. To create a relationship between data A and data B, both must have been published beforehand, so that Nakala can assign them a DOI. Then, on the record for data A, by clicking on ‘Add a relationship’, select the ‘Relationship type’ from the sub-properties listed, and in ‘Target identifier’, copy/paste the identifier (not the URI) of data B. The reverse relationship to data A will be automatically added to data B’s metadata.

Create a relationship between two pieces of data published in Nakala.

If relations on data for which you are responsible have been added by a third party and these relations are questionable, simply contact us at nakala@huma-num.fr. If necessary, the Nakala team will be able to remove the automatically generated symmetrical relationship.

Share rights to this data with other users” area¶

In the “Share rights to this data with other users” area, you can grant rights to data to other users. To share data rights, the user must first create a HumanID account and request access to Nakala.

Rights can be granted individually or to a group of users. To grant rights to a group of users, first create user lists via the “Lists” section of the Nakala menu, one list per role.

The depositor automatically assumes the role of data “manager”, in the sense of rights management. The data manager can share data rights with other users, by assigning them a specific role. To assign the role of manager to other users, you must first create a list, even if it contains only one user name. In the manager list, you will have selected the user(s) to whom you wish to give this role, which will enable these users to manage sharing rights on the data.

To grant the manager role to other users, the depositor must click on his own name, which is displayed on the “Manager” line in the “Share rights to this data with other users” area. An empty field opens: enter the name of the user list you have previously created and select it. The name of the list will be displayed in this field.

*Add a list of managers

To assign the roles of administrator, editor or reader to other users: in “Add a user or user list”, enter the name of a user or list, then select it. The name will be displayed with a default reader role (eye icon).

*Search for a user

Click on the icon to display the list of roles and select the role to assign to this user or group of users. Repeat the action for each user and/or each list to which you wish to assign a role on the data.

Select the role to assign.

“Manage collections of this data” zone¶

To organize your data, you can link it to collections created beforehand. Search for the collection by entering its name or identifier in “Search my collections (name, handle)”, or select a collection from the list by clicking on the + button to the right of the collection name.

Search for a collection in the list.

A new box appears, displaying the collections you’ve selected that include the data.

To delete a selected collection, click on the red cross on the far right.

Collections selection

“Create or Publish” zone¶

To save your data, you can choose between “Create” and “Publish”.

Creating data gives it a private status: it then has restricted access. This can be useful to enable the depositor to document, organize and validate data being finalized in Nakala, before publication. Private data will only be visible to users with whom you have shared rights to this data, according to their role. The data will not be indexed by the search engine and will therefore not appear in search results. It can be deleted. For each depositor, the volume of private data storage is limited to 100 GB, equivalent to 9,999 private data.

By clicking on “Publish”, your data will automatically and instantly receive a DOI. It will be public, freely accessible and reusable by any visitor to Nakala. It will be possible to consult the data, reuse it within the strict framework of the license and download the files, with the exception of embargoed files. Publication of data is final. However, you will always be able to modify its metadata and files. Only adding or deleting files, or uploading another version of a file, will generate a new version of the data. The original DOI will be retained.

Collection creation form¶

Form for creating a collection.

As a reminder :

• data can belong to several collections
• a collection has two possible statuses: private or public
• a private collection can contain data with both ‘private’ and ‘public’ status
• a public collection contains only public data
• a collection can be deleted
• rights management for a collection is independent of rights management for the data it contains
• it is not possible to create sub-collections
• to create a Nakala_Press site, you must have created a public collection.

There is no functionality for creating a hierarchical tree structure between collections. However, there are two alternatives:

• play with collection names. For example, create a “Project name” collection that groups all the data together with the “Project name - videos”, “Project name - photographs”, “Project name - transcriptions”, “Project name - annotations”, etc. collections.
• and/or by using relationship properties such as dcterms:isPartOf, dcterms:hasPart, dcterms:references, dcterms:isReferencedBy, etc. between the various collections to be linked.

Main collection metadata” zone¶

The “Collection main metadata” zone contains two mandatory metadata items: the collection status and title.

Status’: two statuses are available: private or public. Select the status of your choice. A private collection can include both private and public data. A public collection includes only public data.

Title’: Enter the collection title. To add another title, click on the + button to the right of the ‘Title’ field.

Add an additional title.

Specify the title language by clicking on “No language information”. The default setting is 5 languages: English, French, Spanish, German and Italian. To specify other languages, enter the first letters of the language name in the empty field, and a list of suggestions will appear. Select the language of your choice.

Add language to metadata.

“Additional information” zone¶

Fill in the two optional metadata fields in the “Additional information” zone to understand the objectives of this grouping.

Description’: add a description to contextualize the intellectual organization of this data.

Keywords’: enter one or more keywords here. You can enter several keywords in this field.

These fields are repeatable.

Specify the language of this information by clicking on ‘No language information’. The default setting is 5 languages: French, English, Spanish, German and Italian.

To enter other languages, enter the first letters of the language name in the empty field, and a list of suggestions will appear. Select the language of your choice.

Add other metadata” zone¶

The “Add more metadata” area lets you add as much information about the collection as you like. All fields are repeatable.

By clicking on “Add metadata”, select the qualified Dublin Core property of your choice in “Property”. To delete a metadata, click on the red cross to the right of the field.

*Add metadata

You can specify the encoding of the value entered in the property, by selecting it from the ‘Type’ list. For example, to enter a URI pointing to a repository: select the Dublin Core property of your choice and specify the encoding ‘dcterms:URI’ in the ‘Type’ field. Take care to respect the syntax or value expected by the chosen encoding.

Add a metadata: type the value entered in a property.

“Share rights to this collection with other users” zone¶

In the “Share rights to this collection with other users” area, you can grant rights to the collection to other users. To share rights to the data, the user must first create a HumanID account and request access to Nakala.

Rights can be assigned individually or to a group of users. To assign rights to a group of users, first create user lists via the “Lists” section of the Nakala menu, one list per role.

The depositor automatically assumes the role of “manager” of the collection, in the sense of rights management. The collection manager can thus share rights to the collection with other users, by assigning them a specific role. To grant the role of manager to other users, the depositor must first create a list, even if it contains only one user. In the manager list, you will have selected the user(s) to whom you wish to give this role, which will enable these users to manage sharing rights on the data.

To add to the list, click on the user’s own name displayed on the “Manager” line in the “Share rights to this collection with other users” area. An empty field opens, where you can enter the name of the user list you’ve created and select it. The list name will be displayed.

Add a list of managers to the collection !

To assign the roles of administrator, editor or reader to other users: in “Add a user or user list”, enter the name of a user or list, then select it. The name will be displayed with a default reader role (eye icon).

Add users

Click on the icon to display the list of roles and select the role to assign to this user or group of users. Repeat the action for each user and/or each list to which you wish to assign a role on the data.

Select the role to assign to users on the collection.

“Create” zone¶

To save the collection, click on “Create”. A confirmation message will appear, asking you to create a new collection or to return to the page listing the collections you have created or that other users have shared with you.

Public collection: create a NAKALA_PRESS site¶

When a public collection is created, the “Create a NAKALA_PRESS site” button appears at the top of the collection presentation page. This button is used to publish the public collection as a website, which can be configured using the NAKALA_PRESS module. For documentation on how to create a website with NAKALA_PRESS, see the documentation page “Publish your data on a website with Nakala_Press”.

Public collection: create a NAKALA_PRESS site

Nakala user manual¶

Access to Nakala repository¶

Nakala home page

Once your account has been created and your access to the service validated by the Huma-Num team, you can access Nakala by either :

• by going directly to the web interface, via the Nakala URL: https://nakala.fr. Click on the “Login” button at the top right of the page to access the HumanID form. Enter your login and password, then validate.
• through the HumanID portal via the URL https://humanid.huma-num.fr/: enter your login and password in the form and validate. The HumanID portal displays all the services offered by Huma-Num: click on the “Access” button for the Nakala service.

Click here to access Nakala from the HumanID portal.

Search engine¶

The search engine allows you to explore the public content of the Nakala repository. The search engine indexes :

• Public collection metadata
• Public data metadata
• Content of public data files, except those under embargo
• Public data file metadata (currently limited to a “Description” field)

Search results propose a list of public data and collections. This means that data and collections that have not been published will not appear in the results. When you click on the title of a resource, you will be taken to a public presentation page for that resource.

To find data published in Nakala, enter one or more descriptive terms in the search bar. Confirm your query by clicking on the magnifying glass icon or the enter key. By placing your cursor in the search bar and pressing the Enter key on your keyboard, the results will display all Nakala public data in descending order of date of deposit (from most recent to oldest).

You can refine your queries :

• using Boolean operators
• using wildcards

Boolean operators¶

The following Boolean operators can be used:

• AND for results that contain both terms. E.g.: the query “négatif AND édifice” will retrieve all Nakala resources containing the terms “négatif” and “édifice”.
• OR for results containing at least one of the terms. E.g.: the query “manuel OR guide” will retrieve all Nakala resources containing either the term “manuel” or the term “guide”.
• NOT for results that do not contain the term. E.g.: “humanities NOT digital” for results that do contain the term “humanities”, but are not associated with the term “digital”.

Query wildcards¶

A number of metacharacters can also be used:

• The asterisk * to replace several characters. E.g.: “Humanit*”: results will retrieve collections and data containing the terms “Humanités”, “Humanité”, “Humanitaire”, “Humanitaires”, “Humanity”, “Humanitarian”, etc.
• The question mark ? to replace a single character. E.g.: Humanit? : results will retrieve collections and data containing the terms “Humanité” and “Humanity”.
• Parentheses () to define a priority for retrieving results in AND and OR queries. E.g.: “(manual OR guide) AND jurisprudence”: the search will retrieve results containing “manual” and “jurisprudence” or “guide” and “jurisprudence”.
• Quotation marks” for results containing the exact sequence of terms entered, in the same order. E.g.: “secondary education” to find resources containing this exact expression.

Combine Boolean operators to refine your queries and optimize your searches.

Data presentation page (landing page)¶

When a (non-authenticated) visitor clicks on the title of a public data item in the search results, or an (authenticated) user clicks on the “Consult” eye icon (see administration buttons), they access a public view of the data item. A presentation page (corresponding to the landing page) offers a public view of the data.

Presentation page (visitor not logged in)

Landing page (logged-in user)

This data presentation page displays :

• at the top of the page, the following metadata: type (in the form of an icon), title, identifier, version number if applicable (e.g. “Presentation page (logged-in user)”), status, author, description. If the title and/or description have been entered in more than one language, you can choose the display language by switching from one language to another: see screenshot “Presentation page (visitor not logged in)”.
• for each file making up the data, a box displays: the file name; a viewer enabling you to consult the file, except for embargoed files, whose preview displays “File access restricted”; two icons embedded in the file preview: “View raw file” (eye icon), which opens the file image in a new browser tab, and “Download” (download icon), which automatically launches the download of this file to your local computer; below the image : the file identifier (ID) and two URLs: the integration URL useful for displaying this file in an environment external to Nakala (for example, on a website page or in a search engine) and the download URL; the file description, if applicable (as in the example “Presentation page (visitor not logged in)”). By hovering over the image, buttons appear at the top left of the image to zoom in, zoom out, open full screen and rotate the image.
• Keywords entered in the “Keywords” field. These keywords are dynamic: by clicking on a keyword, Nakala will open a page listing all Nakala resources tagged with this keyword.
• The license that defines the framework for reusing this data
• Show complete list of metadata” opens a window displaying all the metadata entered for this data item.
• the name of the collection(s) containing the data
• the name of the depositor and the date of deposit
• A “Cite” block which automatically displays the names of the authors entered in the “Authors” field at the time of deposit, the year of deposit, the title, the type, the name of the Nakala repository and the data identifier.
• A “Relationships” block, which is displayed if one or more relationships have been created between this data and others published in Nakala.
• A “Share” block that makes it easy to share this data via the mailbox and various social networks.

Home page after authentication¶

The different zones of the home page.

1- Header¶

Page header

The header offers three functionalities:

• Click on the logo to return to the home page at any time.
• Choose the interface language: Nakala’s interface is available in French (Fr), English (En) and Spanish (Es).
• Clicking on the “Submit” button gives direct access to the “Submit your data” form.

2- Authentication management¶

Authentication (logged-in user)

Click on the button in the shape of a circle displaying your initials to access your authentication management:

• The “My profile” section takes you to a page containing the personal information recorded when you created your HumanID account and your API key.
• The “Logout” button at Nakala.

3- Main menu¶

Main menu view

Clicking on the dot-shaped button displaying your initials also opens the navigation bar, allowing you to access Nakala’s main menu items:

• Dashboard” for monitoring your activities in Nakala
• Data” for administration and consultation of the list of your data and the data that other users have shared with you
• Collections” for administration and consultation of the list of your collections and collections shared with you by other users
• Lists” for administration and management of user group rights to your data and collections
• Websites” for administration and management of your websites developed with the Nakala_Press module.

4- Footer¶

*Page footer

The footer provides direct links to various pages, both internal and external to Nakala:

• Documentation” links to the Nakala documentation page (external page): https://documentation.huma-num.fr/nakala/
• About” opens the credits page for the Nakala design and development team.
• Contact” opens your mailbox with the recipient nakala@huma-num.fr
• API” refers to the Nakala API documentation page (external page). An API (Application Programming Interface) is a software interface that enables two applications to communicate with each other. It formally defines the classes, functions and protocols that can be used for these interactions. Its use generally requires skills in a programming language in order to write complex interaction chains.
• OAI” opens a page on Nakala’s OAI access point, enabling navigation in the warehouse’s metadata, through the various actions of the OAI-PMH protocol. It is the basic URL of this access point, together with the identification of a collection, that can be reported to a service (e.g. Isidore) to enable it to reference the resources in the collection.
• Legal notice” refers to the general conditions of use for Huma-Num services (external page).
• Service developed by Huma-Num - 3.1.0”: the numbering corresponds to the version number of the Nakala software code. By hovering over the version number, the date of the last update appears.

5- Main content¶

Main content of the home page.

• I deposit my data in nakala” button: gives direct access to the “Deposit your data” data deposit form.
• Search in NAKALA…” search bar to explore and find all public data and collections

Access to the “Submit your data” form¶

You can access the “Submit your data” form from :

• the home page, by clicking on “upload my data in nakala”.
• the header of each page by clicking on the “Submit” button
• the “Data” section by clicking on “Deposit data +”.

Main menu at a glance¶

The Nakala menu has several sections:

• “My profile” links to a page containing the personal information registered when you created your HumanID account and your API key.
• Logout” allows you to log out of Nakala.
• Dashboard” provides a statistical view of the deposits you have registered from your account.
• Data” lists the data you have deposited and/or that depositors have shared with you, and provides quick-access buttons for administering this data (view; edit; manage collections of this data).
• Collections” lists the collections you have created and/or that depositors have shared with you, along with quick-access buttons for administering these collections (consult; edit; delete).
• Lists” for managing user groups. These lists can be used to create user groups with associated data rights.

Authentication management¶

To manage your authentication, you have :

• My profile” to access your personal information and API key.
• the “Logout” button to quit Nakala.

*My Profile” section

“My Profile” section¶

Clicking on “My Profile” takes you to two areas:

• “My profile”
• “My API key”.

“My profile” area¶

From this area, you can access your login and the information recorded when you created your HumanID account. The “Edit my profile” button takes you to your HumanID account page.

“My API key” zone¶

Nakala is accessible via an API which enables users with the appropriate technical skills to create, manage and administer repositories in Nakala via programming languages, scripts or command lines in order, for example, to carry out batch repositories. The API key displayed is used to authenticate you for operations on the API. The “Generate new API key” button is used to obtain a new API key. This can be useful if you’ve transferred your API key to a third party, such as a service provider. Once you generate a new API key, the previous key is deleted and is no longer operational: the service provider can no longer work on your data with the key you transferred to him.

Disconnect¶

When you click on the “Logout” button, the following confirmation message appears: “You have logged out of the remote service. Would you like to log out of HumanID as well?” :

• Clicking on “Accept” will log you out of Nakala, and you will have to authenticate with your HumanID to access it again.
• Refuse” closes the Nakala service, while retaining your HumanID authentication. Simply click on “Connect” on the Nakala home page to re-establish your connection to Nakala.
• Back to portal” takes you to the HumanID portal page.

Disconnection: confirmation message.

“Dashboard” section¶

The “Dashboard” section provides a diagrammatic view of your activity in Nakala.

Dashboard view

This section includes :

• “My published data”: the number of data items you have published. For public data, there is no limit to how much you can deposit, even for data with embargoed files.
• “My private storage” shows the amount of data you have created, without publishing it. This data is restricted and cannot be consulted publicly: it has “private” status. The number of private data items you can create is limited: a user can deposit no more than 9,999 private data items (or a volume equivalent to 100 GB).

• My data” shows the total amount of data you have deposited, according to the following filters:

  • by deposit date (this date is automatically recorded when you deposit data)
  • by file type
  • by data type
  • by data status
  • by license type. Hovering over license names displays details of each license.

• My collections” shows the number of :

  • collections you’ve created and their status
  • websites developed with Nakala_Press, and specifies the number of websites you have activated (put online) or deactivated (not published).

Data” section¶

Data section view

As a reminder, the term “data” in Nakala refers to the association of one or more files with a set of information (metadata) describing them. Depositing data therefore necessarily involves loading one or more files into Nakala and describing them with metadata.

In the “Data” section, two tabs are available at the top of the page:

• “My data” presents in list form the data you have deposited in Nakala
• Shared with me” lists data to which a third party has granted you rights.

In the “My data” and “Shared with me” tabs, you can organize the list of data.

From this section, you can also make a new deposit by clicking on the “+ Deposit data” button. Documentation on the data deposit form is available in the “Nakala data deposit form” section.

Data list¶

For each data item, you will find the following information:

• an icon corresponding to the data type
• title: the mandatory title entered in the “Main metadata of the deposit” box
• Deposit date: the date on which you deposited the data. This date is automatically recorded when data is deposited.
• Status”: the status of the data is directly linked to its registration mode. When submitting data, you can choose between “Create” and “Publish”. “Create” allows you to save the data without publishing it. The data will then have a private status: it will not be freely consultable, but only by you and by users to whom you have granted rights (for the question of rights and roles: see paragraph ###). Data saved with the “Publish” button is public and can therefore be freely consulted. However, when data is public but contains one or more files for which access is restricted (i.e. you have defined a visibility date), the status “Under embargo” will be displayed.

You can view this list of data as thumbnails by clicking on the 6-square icon. Each data item will then display a preview of the first file loaded into it.

List of data in thumbnail format !

Data administration options¶

For each item of data in the list, administration buttons are displayed by clicking on the icon with the 3 vertically aligned dots.

Data administration options

Clicking on this icon opens several options:

• View: this gives access to the data presentation page, as it will be publicly displayed. From this view, you can also administer the data using the “Modify”, “Delete” (only available for private data) and “Manage collections of this data” buttons.
• Edit: to access the data description form
• Delete: this option is only available for data with private status. You will be asked to confirm that the data has been permanently deleted.
• Manage collections of this data: to add the data to a previously created collection. A dialog box displays the collections you have created or that have been shared with you. To select a collection, click on the + to the right of the collection name, which will then appear in “My collections containing this data”. Click on the “Save” button to confirm.

List filter options¶

Filters can be used to restrict the list of data:

• Search by title”: this filter searches for the mandatory title entered in the “Main repository metadata” box.
• Type”: this information is taken from the “Repository type” field
• Status”: private, public or embargoed. The “Under embargo” status concerns public data for which one or more files are under embargo.
• Year of deposit”.

Sorting options on the list¶

The list can be sorted by :

• Date of deposit (descending): sorting suggested by default.
• Title (A -> Z): alphabetical order
• Title (Z -> A): in reverse alphabetical order
• Deposit date (ascending): oldest to most recent
• Type (A -> Z): alphabetical order
• Type (Z -> A): in reverse alphabetical order
• Status (A -> Z) : alphabetical order
• Status (Z -> A) : in reverse alphabetical order

Data management page¶

When you click on the title of a piece of data in the lists available in the “My data” or “Shared with me” sections, you will be taken, as a submitter or as a sharing user, to a data presentation page that is different from the public presentation page (landing page). This management page provides an overview of the data and direct access buttons for data administration.

Data management page

This page displays :

• The following metadata: type (as icon), title, identifier, status, author, description, submission and modification dates, total file size. If the title and/or description have been entered in more than one language, you can choose the display language by switching from one language to another.
• Quick-access buttons for managing the data: “Manage collections of this data”, “View data presentation page”, and an “Other” button that lets you :
  • Share data by e-mail and on social networks
  • View a complete list of the data’s metadata
  • Modify: to open the modification form
• The names and volumes of the files making up the data (and the words “File restricted” for embargoed files), with consultation and download options for each file.
• The name of the collection(s) in which the data is stored
• Roles assigned to users
• Relationship(s) with other Nakala public data.

Collections” section¶

Collections section view

To organize data in Nakala, you can create data collections.

A collection groups together a coherent set of data. You can thus create several collections corresponding to different research projects and shared with several contributors who are assigned specific rights to each collection.

Collections can be organized by theme, data type or format, etc. The coherent grouping of data within collections should be considered according to your own documentary, scientific or other needs.

Data can belong to several collections. Nakala does not allow you to create a hierarchical tree structure between collections. The collection identifier is internal to Nakala. It is not a DOI, which is why collections can be deleted.

A collection has 2 possible statuses: private or public. A private collection can contain data with both ‘private’ and ‘published’ status. A public collection can only contain published data.

Managing rights to a collection is independent of managing rights to the data it contains. This means that a user who has rights to a collection does not automatically have rights to the data in that collection. Users can therefore group their own data or that of other users into collections, according to their status.

Two tabs are available in the “Collections” section:

• “My collections” presents in list form the collections you have created in Nakala
• Shared with me” lists collections to which a third party has assigned rights.

Access to the “Create a new collection” form¶

From this section, you can create a new collection by clicking on the “+ Create a new collection” button.

Documentation on the collection creation form is available in the “Collection creation form” section.

Collection list¶

For each collection, you’ll find the following information:

• title: the mandatory title entered in the “Main deposit metadata” block
• deposit date: automatically calculated when the collection is registered
• collection status: public or private

Collection administration options¶

For each collection in the list, administration buttons appear by hovering over the vertically aligned 3-dot icon on the right.

Clicking on this icon allows you to :

• View: access to the collection’s presentation page, as it will be publicly displayed
• Edit: access to the collection’s metadata form
• Delete: a message asks you to confirm that you wish to permanently delete the collection.

Filter options¶

Filters can be used to restrict the list of collections:

• Search by title”: this filter searches for the mandatory title entered in the “Collection main metadata” box.
• Status: private or public
• Year of creation

Sorting options¶

The list can be sorted by :

• Deposit date (descending): suggested by default
• Title (A -> Z): alphabetical order
• Title (Z -> A): in reverse alphabetical order
• Deposit date (ascending): oldest to most recent
• Type (A -> Z): alphabetical order
• Type (Z -> A): in reverse alphabetical order
• Status (A -> Z) : alphabetical order
• Status (Z -> A) : in reverse alphabetical order

Collection management page¶

When you click on the title of a collection in the lists available from the “My collections” or “Shared with me” tabs, you access a presentation page for the collection that is different from the public presentation page.

Collection management page

This page displays :

• Collection title, ID and status. Clicking on “View collection details” displays all registered metadata, as well as the name of the depositor and shared users.
• A “View” button to access the collection’s public presentation page.
• Quick access buttons to administer the collection: “Create a NAKALA_PRESS site”, “Delete” and “Modify”.
• A list of data grouped together in this collection. This list offers view, filter and sort options similar to those available in the “Data” section.

Creating a Nakala_Press site¶

For documentation on how to create a website with the Nakala_Press module from a public collection, see the documentation page “Publish your data on a website with Nakala_Press”.

Lists” section¶

View of the Lists section.

To facilitate the sharing of data and collections between several users, it is possible to create lists of users (belonging to the same project, for example). These lists are then added to resources in the “Share rights to this data with other users” box. Each list is associated with a role. The recommendation is to create one list per role. In this way, you create a list from which you select all the users to whom you wish to grant identical roles. When you share the rights to a resource, the role settings will apply to all users in the list.

To share the manager role, you need to create a list of users.

Managing list rights¶

When a submitter adds a user to a list, the submitter must assign that user a role on the list.

Two roles are available:

• Administrator”: a list administrator has management rights over the list: he/she can therefore delete and add users. When adding a user, the list administrator selects the user’s role on the list (administrator or member).
• Member”: list members can only view the names of users in the list to which they belong. They cannot make any modifications.

List roles¶

List administrator¶

For each list, by clicking on the vertically aligned 3-dot icon on the far right, a list administrator has access to 3 options: “View”; “Edit”; “Delete”. Clicking on “View” will display the names of users attached to the list and their role on the list (administrator or list member). “Modify” allows you to change the title of the list, add or remove users, and assign a role or modify the role of each user. By clicking on “Delete”, the list will be permanently removed. You will be prompted to confirm deletion.

List member¶

When a user is a “member” of a list, he/she can only consult the names of users on the list to which he/she belongs. They cannot modify the list.

Creating user lists¶

Click on “+ Create a new list” to open the user list creation form, in the “Lists” section.

Enter the list name in the “Title” field. We recommend that you specify in the list name the role that will be assigned to all users on this list. This will make it easier to assign the role when, at resource level, you add the list and have to select the role to be associated with this list in the “Share rights to this data with other users” box. Example: Project_Name_Manager; Project_Name_Admin; Project_Name_Editor, etc.

Add users one by one to the list. Each list can contain as many users as required. When a user is added, an icon appears, giving you the choice between two options: “Administrator” or “Member” of the list. For each user, select the list role you wish to grant him/her.

Click on the “Create” button.

Create a user list.

User list and shared rights¶

It’s only once you’ve created your lists that you’ll be able to use them for the resources you deposit in Nakala. From the data deposit form, select your lists and assign them the role of your choice using the “Share rights to this data with other users” box. For further details, please refer to the documentation on the data deposit form.

From the collection creation form, select your lists and assign them the role of your choice using the “Share rights to this collection with other users” box. For further details, please refer to the documentation on the collection creation form.

“My lists” and “Shared with me” tabs¶

Two tabs are available in the “Lists” section:

• “My lists” displays the user lists you have created
• Shared with me” displays lists to which another user has assigned rights.

When you click on the title of a list in the lists available from the “My lists” or “Shared with me” sections, you access a list presentation page which displays all list members and the role of each on the list.

From here, you can also create a new list by clicking on the “+ Create new list” button.

Filter options¶

From the “My lists” and “Shared with me” tabs, you can refine results by searching by list name (title) or by user name:

• “Filter on titles and users”: these filters search in list titles and in the names of users registered in the lists to which you have access.

Sorting options¶

By default, the list is sorted by creation date (descending order).

You can also sort the list by :

• Title (A -> Z): alphabetical order
• Title (Z -> A): in reverse alphabetical order
• Date (ascending): oldest to most recent
• Date (descending): newest to oldest

Websites” section¶

View of the Websites section

For each website, you’ll find the following information:

• the site name: this is the prefix you entered when you clicked on the “Create a NAKALA_PRESS site” button
• the title of the collection used for the website
• site status: a green dot indicates that the site is public; a red dot means that the site is private and therefore not accessible
• site creation date

Website administration options¶

For each website in the list, administration buttons appear by hovering over the vertically aligned 3-dot icon on the right.

Clicking on this icon allows you to :

• View: access to the site’s home page, if public, as displayed publicly
• Administer: access to features for managing your website
• Delete: a message asks you to confirm the definitive deletion of the website.

Filter options¶

Filters allow you to narrow down the list by searching in the name of the websites you’ve created and the title of the collections used to create your websites.

Sorting options¶

The list can be sorted by :

• Site (A -> Z): alphabetical order
• Site (Z -> A): in reverse alphabetical order
• Date (ascending): oldest to most recent
• Date (descending): suggested by default

Resource rights management¶

The depositor can assign roles to other users on the following resources:

• data
• collections
• user lists

To assign a role to a user, the latter must first have created a HumanID account and requested access to Nakala. The depositor will then be able to select and manage the user’s role on the resources he has created.

For each role, the Nakala team has defined a set of differentiated consultation, modification, deletion and publication rights. Rights on data files are inherited from data rights, i.e. the user’s role is defined at data level and will be applied to all files.

For published data, the depositor has the option of limiting access to files (embargo) by entering a visibility date on each file. Embargoed files are then accessible only to the depositor. However, it is possible to share access to embargoed files with other users, provided they have been assigned a role on the data.

Management rights for a collection are independent of management rights for the data it contains. This means that if you give a user read rights on a collection that contains unpublished data, the user will not automatically have read rights on this data. You’ll need to give that same user read rights on a per-data level if you want him to be able to access it.

List of roles¶

List of roles on a data item and a collection:

• Submitter
• Manager
• Administrator
• Editor
• Reader

Visitors to Nakala in anonymous mode, i.e. unauthenticated persons, can consult public resources and download public data files, except for embargoed files.

List of API roles¶

Here’s the equivalent of the role names to be used in the API:

• Depositor = ROLE_DEPOSITOR
• Manager = ROLE_OWNER
• Administrator = ROLE_ADMIN
• Editor = ROLE_EDITOR
• Reader = ROLE_READER

Description of the rights associated with each role¶

Depositor (role_depositor)

The depositor is an authenticated user who creates and uploads resources (data and collections) to Nakala. By default, the depositor also automatically has the role of manager for the resources he deposits. This means that the depositor has full administrative and sharing rights to the resource. The depositor can share management rights with a user of his/her choice, or with a user group (to create a user group, see § on lists). For example, to share the role of manager on a datum, the submitter creates a list of users, which he then links to “Manager” in the “Share rights to this datum with other users” field. Users registered in the manager list are then able to share the management of this data. When a user becomes a manager, he or she will find this resource again once logged in, in the “My data” or “My collections” list. Sharing or transferring the role of manager can be useful when the depositor in charge of resource creation in Nakala leaves his/her position within the research team. This allows other team members designated as “managers” to take over resource management.

Manager (role_owner)

When a resource is created in Nakala, the depositor is by default the manager.

The resource manager is the only person who can add other managers to the resource.

The manager of a data item or collection has all sharing and administrative rights to the resource. He/she manages the sharing of the management and can also grant specific roles to users of his/her choice. A manager also has access to all resource modification functions.

Every resource in Nakala must have a manager. By default, the depositor is the manager of the resource he is depositing in Nakala. It is possible to transfer this role to other users and remove it from the depositor. For shared management, it is necessary to create a list of users.

When a user is designated as “manager”, he or she will find the resource once logged in, in the “Data” section, “My data” tab, or in the “Collections” section, “My collections” tab.

For further details on the rights associated with a “Manager” role, please refer to the table summarizing rights by role.

Administrator (role_admin)

The administrator role gives access to all resource sharing and modification functions, with the exception of the list of managers. Thus, an administrator who does not have the role of manager can neither delete nor replace the list of resource managers.

When a user is designated “administrator”, he or she will find the resource once logged in, in the “Data” section, “Shared with me” tab, or in the “Collections” section, “Shared with me” tab.

The “administrator” role can be removed from a user by a manager and by another resource administrator.

For further details on the rights associated with an “Administrator” role, please refer to the table summarizing rights by role.

Editor (role_editor)

The “Editor” role gives the user access to part of the resource’s editing functionality. An editor does not manage any sharing options: it cannot assign any role on the resource to other users. For this reason, the “Share rights to this data with other users” field is not displayed in the data or collection form.

For further details on the rights associated with an “Editor” role, please refer to the table summarizing rights by role.

Reader (role_reader)

The “Reader” role only allows the user to :

• consult the presentation page of a private or public resource
• consult and download a file with restricted access (embargo) to private or public data. A reader does not have access to any resource modification or sharing functions.

For further details on the rights associated with a “Reader” role, please refer to the role rights summary table.

Role rights summary table¶

Private data	Manager	Administrator	Editor	Reader	Visitor (unauthenticated)
Consultation of the public presentation page	+	+	+	+	-
Consultation of the management page	+	+	+	-
View embargoed files	+	+	+	-
Download files	+	+	+	-
Modification of metadata and files	+	+	-	-
Modify management rights	+	-	-	-	-
Modification of sharing rights	+	+	-	-	-
Add to a collection	+	+	-	-
Deletion	+	+	-	-	-
Publication	+	+	-	-	-

Public data	Manager	Administrator	Editor	Reader	Visitor (unauthenticated)
Consultation of the public presentation page	+	+	+	+	+
Consultation of the management page	+	+	+	-
View embargoed files	+	+	+	-
Download embargoed files	+	+	+	-
Modification of metadata and files	+	+	-	-
Modification of management rights	+	-	-	-	-
Modify sharing rights	+	+	-	-	-
Deletion	-	-	-	-	-

Private collection	Manager	Administrator	Editor	Reader	Visitor (unauthenticated)
Consultation of the public presentation page	+	+	+	+	-
Consultation of the management page	+	+	+	-
View complete list of data (public and private)	+	+	+	+	-
Modify metadata	+	+	-	-
Modify status	+	+	-	-	-
Modification of management rights	+	-	-	-	-
Change sharing rights	+	+	-	-	-
Add data	+	+	-	-
Deletion	+	+	-	-	-

Public collection	Manager	Administrator	Editor	Reader	Visitor (unauthenticated)
Consultation of the public presentation page	+	+	+	+	+
Consultation of the management page	+	+	+	-
Consult the complete list of public data	+	+	+	+	+
Modify metadata	+	+	-	-
Modify status	+	+	-	-	-
Modification of management rights	+	-	-	-	-
Change sharing rights	+	+	-	-	-
Add data	+	+	-	-
Deletion	+	+	-	-	-
Create a Nakala_Press site	+	+	-	-	-