File System Structure

The file system structure is compatible with the following standards:

[OCFL]

Oxford Common File Layout Specification 0.3. Edited by Andrew Hankinson (Bodleian Libraries, University of Oxford), Neil Jefferies (Bodleian Libraries, University of Oxford), Rosalyn Metz (Emory University), Julian Morley (Stanford University), Simeon Warner (Cornell University), and Andrew Woods (DuraSpace).

[BagIt]

The BagIt File Packaging Format (V1.0). Edited by J. Kunze (California Digital Library), J. Littman (Stanford Libraries), E. Madden (Library of Congress), J. Scancella (Library of Congress), C. Adams (Library of Congress).

Contents

System Root Directory

Contains one or more repository root directories.

[root]
├── {repository}
├── {repository}
├── {repository}
│   ...

Repository Root Directory

Contains the 6 main subdirectories of a repository.

[root]
└── {repository}
    ├── cache/ 1
    ├── config/ 2
    ├── data/ 3
    ├── deposit/ 4
    ├── log/ 5
    └── staging/ 6

• 1 Cache Directory of the Media API where computed AV data (time segments, spectrum images, waveform images, thumbnails, etc.) are stored.
• 2 5 Directories of the Admin API where ingest configuration files and ingest log files are stored.
• 3 Directory where user data are stored according to the Oxford Common File Layout (OCFL).
• 4 6 Directories of the Deposit API. Uploaded file segments are saved in the staging directory at first. Complete file uploads are then transferred to the deposit directory.

Cache Directory

Contains media derivatives as produced and used by the Media API. Media derivatives can be managed with the WebDAV API.

Example:

[root]
└── {repository}
    ├── data
    │   └── myCollection
    │       └── myBundle
    │           └── v1
    │               └── content
    │                   └── Media
    │                       └── ZAG_EOI_20141009_1.wav 1
    └── cache
        └── myCollection
            └── myBundle
                └── v1
                    └── content
                        └── Media
                            └── ZAG_EOI_20141009_1.wav 2
                                └── full
                                    └── full
                                        └── 12000,150
                                            └── 0
                                                ├── spectrum
                                                │   └── default.png 3
                                                └── waveform
                                                    └── default.png 4

• 1 The original input audio file in wav format.
• 2 Cache directory for the input audio file created by the Media API.
• 3 Cached spectrum image in png format with 12000px of width and 150px of height.
• 4 Cached waveform image in png format with 12000px of width and 150px of height.

Config Directory

Contains configuration files needed by the Ingest API. Configuration files can be authored with the WebDAV API.

Example:

[root]
└── {repository}
    └── config
        ├── blam-cmdi2oai_dc.xsl 3
        ├── identity.xsl 2
        └── repository.xml 1

• 1 Each config directory MUST contain a configuration file called repository.xml.
• 2 3 Arbitrary XSLT files for OAI ingest referenced inside the repository.xml configuration file.

Data Directory

Contains the actual repository data according to the Oxford Common File Layout (OCFL) specification plus File System ACLs, an implementation specific OCFL extension. OCFL directories and ACLs can be managed with the WebDAV API.

Example:

[root]
└── {repository}
    └── data 1
        ├── 0=ocfl_1.0 2
        ├── acl.json 3
        ├── mol 4
        │   ├── altan_galab_qagan 5
        │   │   ├── 0=ocfl_object_1.0 6
        │   │   ├── acl.json 7
        │   │   ├── inventory.json 8
        │   │   ├── inventory.json.sha512 9
        │   │   └── v1 10
        │   │       ├── content 11
        │   │       │   ├── altan_galab_qagan.xml
        │   │       │   └── Resources
        │   │       │       ├── 2_Altan_Galab_Khan.pdf
        │   │       │       ├── 2_Altan_Galab_ Khan_Summary.pdf
        │   │       │       └── 2_Altan_Galab_Khan.wav
        │   │       ├── inventory.json 12
        │   │       └── inventory.json.sha512 13
        │   ├── arban_tabudugar_tang_ulus
        │   │   ├── 0=ocfl_object_1.0
        │   │   ├── inventory.json
        │   │   └── v1
        │   │       └── content
        │   │           ├── arban_tabudugar_tang_ulus.xml
        ...

• 1 OCFL storage root.
• 2 OCFL storage root declaration file.
• 3 The repositories default ACL. Defines permissions for all OCFL objects of a repository, if not overwritten by the ACL of an OCFL object.
• 4 5 Two directories forming a OCFL object path.
• 5 OCFL object directory.
• 6 OCFL object declaration file.
• 7 ACL of an OCFL object. Overwrites the default ACL.
• 8 OCFL object inventory file.
• 9 OCFL object inventory digest file.
• 10 OCFL version directory.
• 11 OCFL content directory.
• 12 OCFL version inventory file.
• 13 OCFL version inventory digest file.

Deposit Directory

Contains data uploaded with the Deposit API.

Example:

[root]
└── {repository}
    └── deposit
        ├── gtest@uni-koeln.de 1
        │   ├── 72bef2fb-fb87-4d1d-96e5-b904a54217fb 2
        │   │   ├── bagit.txt 3
        │   │   ├── data 4
        │   │   ├── manifest-sha-256.txt 5
        │   │   ├── tagmanifest-sha-256.txt 6
        │   │   └── metadata 7
        │   │       └── sword.json 8
        │   ├── 051391fa-8f40-4ea9-b7e3-905f0e854cf2
        │   │   ├── bagit.txt
        │   │   ├── data
        │   │   ├── ...
        ...
        ├── user@example.com
        ...

• 1 A user's deposit directory.
• 2 Directory of an individual deposit.
• 3 BagIt declaration file.
• 4 BagIt Payload Directory.
• 5 BagIt Payload Manifest.
• 6 BagIt Tag Manifest.
• 7 BagIt Tag metadata directory.
• 8 BagIt Tag metadata.

Log Directory

Contains log files of the Ingest API. Log files can be checked with the WebDAV API.

[root]
└── {repository}
    └── log
        ├── reindex.log
        ├── ...

Staging Directory

Contains temporary file segments uploaded with the Deposit API.

[root]
└── {repository}
    └── deposit
        ├── gtest@uni-koeln.de
        │   ├── 72bef2fb-fb87-4d1d-96e5-b904a54217fb
        │   │   ├── ...
        │   │   ├── ...