Skip to content

Property file

Rene Ranzinger edited this page Mar 18, 2022 · 2 revisions

The properties file contains some general configurations that are needed to build the TSV files. This includes all information related to the data coordination center (DCC), the CFDE agreed namespace, and the information for the projects. The file format is a properties file with key-value-pairs line by line with the key and values separated by "=".

DCC Properties

These properties are used to build the [https://github.com/nih-cfde/published-documentation/wiki/TableInfo:-dcc.tsv](DCC.tsv file).

dcc.id
The identifier for this DCC, issued by the CFDE-CC.

dcc.dcc_name
A short, human-readable, machine-read-friendly label for this contact's program or DCC.

dcc.dcc_abbreviation
A very short display label for this contact's program or DCC.

dcc.dcc_description
A human-readable description of this contact's program or DCC.

dcc.contact_email
Email address of this contact.

dcc.contact_name
The name of a person who can answer any questions CFDE staff have during submission processing.

dcc.dcc_url
URL of the front page of the website for this contact's program or DCC.

Project properties

The project properties are used to fill the top level projects with information. There are two sets of this information, master and glygen. master refers to the top level project entry that combines all project and data together. glygen referes to the project representing the GlyGen portal and all associated data. For each project the following information is required (were xxx is replaced with master or glygen):

project.xxx.local_id
An identifier representing this project, unique within this id_namespace.

project.xxx.persistent_id
A persistent, resolvable (not necessarily retrievable) URI or compact ID permanently attached to this project.

project.xxx.creation_time
A timestamp documenting this project's creation time.

project.xxx.abbreviation
A very short display label for this project. Should not exceed 10 characters; can only contain 0-9, a-z, A-Z and underscore ("_").

project.xxx.name A short, human-readable, machine-read-friendly label for this project. Must be unique to each project.

project.xxx.description
A human-readable description of this project.

Namespace properties

namespace.id
A CFDE-cleared identifier representing the top-level data space.

namespace.abbreviation
A very short display label for this namespace. Should not exceed 10 characters and can only contain 0-9, a-z, A-Z and underscore ("_").

namespace.name
A short, human-readable, machine-read-friendly label for this namespace.

namespace.description
A human-readable description of this namespace.

Clone this wiki locally