{# 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. #}
Records are the basic components of Kadi4Mat, as they contain data and connect it with metadata. The data of a record can either consist of a single file or of multiple files (e.g. a series of multiple images) all sharing the same metadata. Records can also be grouped into collections or linked to other records, as described later.
Creating a new record first requires entering its metadata. This includes basic information, like a title, a (unique) identifier and a description. Additional, arbitrary metadata can also be specified, specific for each different kind of record. This generic metadata consists of key-value pairs, where each entry has at least a unique key, a type and a corresponding value. It is also possible to create templates for the generic metadata, as described in Templates. The following types can be used:
Aside from the metadata, it is possible to set the visibility of the record to either private or public, the latter giving every logged in user the ability to search for the record and view its contents without requiring explicit permission to do so. Finally, the record can be linked to one or more collections while creating it, which of course may also be done later on instead.
Once the metadata of the record has been created, the actual data of the record can be uploaded and managed in a separate view, which the application will redirect to. This view is just one part of the record menu, the next section describes the purpose of the others.
The generic metadata of records can be searched for using the Search extras toggle of the search form in the record navigation menu. It is possible to search for keys, types and different kinds of values based on the selected types. Multiple such queries can be combined with an AND or an OR operation in the form of (Q1 AND Q2) OR (Q3 AND Q4). Exact matches for keys and string values can be required by using double quotes, e.g. "key". Keys inside of nested metadata entries are indexed in the form of <parent_key>.<parent_key>.<key>. In case of list entries, keys are replaced by the corresponding index in the list instead, starting at 1.
Aside from managing the files of a record there are also some other views, each of which can be accessed through the respective item in the navigation menu of a record. The menu items are briefly described below:
This view gives an overview of the whole record, divided into different tabs, including all of its metadata and files, linked resources and access permissions. On the main overview tab it is also possible to export, publish or copy a record. Publishing records is only available if at least one publication provider has been registered with the application.
Each file of a record also has another navigation menu similar to that of a record, accessed by clicking on the respective file. This menu provides the following two views: