{# Copyright 2020 Karlsruhe Institute of Technology # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. #}

{% trans %}Records{% endtrans %}

{% trans trimmed %} Records are the basic components of Kadi4Mat and can represent any kind of digital or digitalized object, e.g. arbitrary research data, samples, experimental devices or even individual processing steps. {% endtrans %} {% trans trimmed %} Records consist of metadata that can either stand alone or be linked to any number of corresponding data. {% endtrans %} {% trans %}They can also be grouped into collections or linked to other records, as described later.{% endtrans %}

{% trans %}Creating new records{% endtrans %}

{% trans a_open='' | safe, a_close="" | safe, trimmed %} Creating a new record first requires entering its metadata. This includes basic information, such as title, (unique) identifier and description. Additionally, generic extra metadata can be specified, specific for each different kind of record. This metadata consists of key-value pairs, where each entry has at least a unique key, a type and a corresponding value. Optionally, an additional term IRI (Internationalized Resource Identifier) and validation instructions can be specified. It is also possible to create templates for the generic metadata, as described in {{ a_open }}Templates{{ a_close }}. The following values types can be used for this metadata: {% endtrans %}

String
{% trans %}A single text value.{% endtrans %}
Integer
{% trans %}A single integer value. Integer values can optionally have a unit further describing them.{% endtrans %}
Float
{% trans trimmed %} A single floating point value. Float values can optionally have a unit further describing them. {% endtrans %}
Boolean
{% trans em_open="" | safe, em_close="" | safe, trimmed %} A single boolean value which can either be {{ em_open }}true{{ em_close }} or {{ em_open }}false{{ em_close }}. {% endtrans %}
Date
{% trans %}A date and time value which can be selected from a date picker.{% endtrans %}
Dictionary
{% trans %}A nested value which can be used to combine multiple metadata entries under a single key.{% endtrans %}
List
{% trans trimmed %} A nested value which is similar to dictionaries with the difference that none of the values in a list have a key. {% endtrans %}

{% trans em_open="" | safe, em_close="" | safe, trimmed %} Aside from the metadata, it is possible to set the visibility of a record to either {{ em_open }}private{{ em_close }} or {{ em_open }}public{{ em_close }}, the latter giving every logged-in user the ability to search for the record and view its contents without requiring explicit read permissions to do so. Finally, a record can be linked to one or more collections while creating it, which of course may also be done later. {% endtrans %}

{% trans trimmed %} Once the metadata of a record has been created, the actual data of the record can be added in a separate view, which the application will redirect to automatically. This is just one part of the various views to manage records, the next section describes the purpose of the others, which can be selected after going back to the record overview page. {% endtrans %}

{% trans %}Managing existing records{% endtrans %}

{% trans trimmed %} On the record overview page, different views are available, each of which can be accessed through the respective tab in the navigation menu of a record. The individual tabs and their contents are briefly described below. {% endtrans %}

{% trans %}Overview{% endtrans %}

{% trans a_open='' | safe, a_close="" | safe, trimmed %} This tab provides an overview of a record, mainly related to its metadata. Here, it is possible to edit or copy a record, if the corresponding permissions are fulfilled, where editing a record also allows deleting it. Note that this will move the record to the trash first, see also {{ a_open }}Users{{ a_close }}. Furthermore, records can be exported in various formats, published or favorited. Note that the publishing functionality is only available if at least one publication provider has been registered with the application. {% endtrans %}

{% trans %}Files{% endtrans %}

{% trans trimmed %} This tab provides an overview of the files associated with a record. Given the corresponding permissions, new files can be added, which is usually done by uploading locally stored files. However, certain types of files may also be created directly via the web interface. Existing files can either be downloaded in bulk or individually using the quick navigation menu of each file. Depending on permissions, this navigation also shows additional actions to quickly manage files. {% endtrans %}

{% trans trimmed %} Clicking on a file leads to a separate overview page of the corresponding file, which shows all additional file metadata. Furthermore, many file types include a built-in preview functionality. Here, it is also possible to edit a file's metadata or content, where editing the metadata also allows deleting the file. Some file types may offer direct editing of the actual file content, otherwise the regular upload functionality can be used. {% endtrans %}
{% trans %}Links{% endtrans %}

{% trans trimmed %} This tab provides an overview of the resources a record is linked with, which includes other records as well as collections. Collections represent logical groupings of multiple records, while links between records can specify their relationship and also contain additional metadata. Furthermore, record links can be visualized in an interactive graph. Clicking on a record link leads to a separate view, which provides a more detailed overview of the link and the associated records. {% endtrans %}

{% trans trimmed %} Linking resources requires link permission in both resources that should be linked together. Note that users still won't be able to view any linked resources if they have no explicit permission to do so. However, a limited subset of information about record links (the ID of the linked record and the name and term IRI of the link) will always be shown as part of the record revisions. {% endtrans %}
{% trans %}Permissions{% endtrans %}

{% trans em_open="" | safe, em_close="" | safe, trimmed %} This tab provides an overview of the access permissions granted to individual users or groups of multiple users for a specific record. New permissions can be granted if the corresponding permissions to do so are fulfilled, which currently works by using predefined roles. Details about the specific permissions and actions each role provides can be found by clicking on the {{ em_open }}Roles{{ em_close }} popover. {% endtrans %}

{% trans trimmed %} Note that group roles are always shown to users being able to manage permissions, even if the group would normally not be visible. This way, existing group roles can always be changed and/or removed. Such group roles only contain very limited information about the group itself (its ID, title, identifier and visibility). {% endtrans %}
{% trans %}Revisions{% endtrans %}
{% trans em_open="" | safe, em_close="" | safe, trimmed %} This tab provides a history of changes to a record's metadata, file metadata and links to other records. By clicking on {{ em_open }}View revision{{ em_close }} of a revision item, a separate view will open, providing a more detailed overview of the respective revision and corresponding changes. {% endtrans %}