Skip to content

Configuration files

jkaufhold edited this page Sep 15, 2017 · 31 revisions

Configuration files location

Assuming the metadata component of B2SAFE is deployed under the following path: /opt/eudat/b2safe-metadata, then a set of configuration files can be found at /opt/eudat/b2safe-metadata/conf.

Python scripts configuration

  • b2safe_neo4j.conf_template - is a template for the configuration file of the main script b2safe_neo4j_client.py prefilled with default values. So it needs to be duplicated and/or renamed to b2safe_neo4j.conf before filling it out with the setup specific information. It consists of 4 parts:

    • Logging - with 2 values needed to be specified: log level, default is log_level=DEBUG, and the file where to safe the logging information, dafault values is log_file=log/b2safe_neo4j.log, so in a file named b2safe_neo4j.log in folder log under the installatioin path.
    • GraphDB - connection information of the neo4j instance: http address of the neo4j browser address=localhost:7474 and the data of the connection user, so the username= and password=. The last configuration point path specifies the last part of the URI needed for the graph creation in the neo4j instance. The default suggested from the neo4j is /db/data, so the graph will be created under http://localhost:7474/db/data/.
    • MessageSystem - connection information of the messaging system like ARGO system: access token and the URL of the endpoint, as well as the size of the buffer and under which subscription of the messaging system to look for the messages for the metadata component of the B2SAFE, e.g. subscription=B2SAFE_NOTIFY.
    • iRODS - connection information of the iRODS instance: the name of the iRODS zone like zone_name=cinecaDMPZone and the endpoint consisting of the host_name:port information like zone_ep=dmp1.novalocal:1247 and the information about the iRODS resources to be used as well as the logical home directory in iRODS like irods_home_dir=/cinecaDMPZone/home.
  • mets_factory.conf_template - is a template for the configuration file of the mets manifest generating script mets_factory.py also prefilled with default values and needs to be duplicated and/or renamed to mets_factory.conf.

    • It also starts with the Logging and contains an iRODS part that are similar to the ones described.

    • But the important part is METS containing the information where to find the metadata relations description of the given colleciton, e.g. under md_jsonld_file=conf/metadata.json, out of what the METS manifest will be generated. For the case thare are collection parts that do not fit to this description there are two values type_default and format_default that defines what type of Node they will become, per default it is Data, as every file in iRODS is a kind of data, and in what format the data is stored in this file, that is unknown for the files not described explicitly. The Boolean flag abs_path indicates if the values in the metadata description file are written as absolute paths or relative to the location of the description file.

METS related configuration

  • EudatControlledVocabulary.jsonld – is a controlled vocabulary defined for the EUDAT project.
  • EudatControlledVocabulary.txt – is a list of allowed types in the METS div element of the METS structMap part.
  • metadata.json - is the actual description of the collection, what file is a data, what is or contains metadata and relations between the data and metadata, so what metadata describes what data. It is filled with an example but needs to be competlly rewritten to reflect your collection.

Clone this wiki locally