Installing CellStore with Docker, Part 6: Setup DTS cache

These instructions are meant for the first installation only of CellStore. For updates, refer to the update instruction.

• 1: Docker
• 2: Database
• 3: Creating CellStore container
• 4: Starting CellStore
• 5: Creating CellStore service
• 6: Setup DTS cache
• 7: Additional Configuration and Optimization

CellStore is able to not only import XBRL Instance data, but also linked Taxonomy and Linkbase information from the Discoverable Taxonomy Set (DTS). In most cases an XBRL Instance File is not shipped with all taxonomies and linkbases included. Therefore, this linked information needs to be discovered automatically.

Usally, a parser would download the missing and discovered files from the internet. CellStore is not doing this for 2 reasons:

1. DTS often consist of thousands of files and downloading all of them on demand would be too slow.
2. Most customers do not allow Software to directly access the internet for privacy reasons.

Instead, CellStore uses a local cache to lookup and load the files linked to Instance files. To import an XBRL DTS all linked taxonomies and linkbases need to be available in this local cache. On this page we describe how to setup this cache.

Additionally, XBRL DTSs are organized hierarchically making use of inheritance for modularization and re-use. In the same way CellStore can be configured to not import items contained in DTSs redundantly for each DTS. For example, the JP-GAAP taxonomies can be setup as core DTSs and hence, will be only imported once into the CellStore.

Local Cache Path

CellStore will look into %CELLSTORE_HOME%/cache as the cache root directory. The %CELLSTORE_HOME% is where you previously have created the reportix.properties in part 3.

Any valid Taxonomy Packages can be added to the local cache. Taxonomy Packages are zip archives containing taxonomy related files for resolution. You could think of these taxonomy packages for XBRL as what jars are for JAVA. In this case the order in the CACHE_PATH in the reportix.properties file will determine their resolution.

Add a Taxonomy Package

We have several common taxonomy packages ready to download, including:

• Core XBRL and Eurofiling Taxonomies v1.4.0
• EBA COREP/FINREP Taxonomies v0.2.0
• EIOPA Taxonomies v2.6.0
• IFRS Taxonomies v0.4.0
• Japanese Edinet Taxonomies v0.3.0
• Japanese Tdnet Taxonomies v0.3.0
• UK Companieshouse Taxonomies v0.2.0
• US Fasb Taxonomies v0.6.0
• European ESEF Taxonomies v0.4.0

To install them in your local cache, you can follow these commands (assuming your %CELLSTORE_HOME% is in /var/reportix/cellstore):

# create cache folder if missing 
mkdir -p /var/reportix/cellstore/cache

# add taxonomy package eba
wget -P /var/reportix/cellstore/cache https://download.reportix.com/taxonomyPackages/eba-taxonomy-package-v0.2.0.zip

# add taxonomy package core
wget -P /var/reportix/cellstore/cache https://download.reportix.com/taxonomyPackages/XBRL-and-Eurofiling-Core-taxonomy-package-v1.4.0.zip

Configure a Taxonomy Package

In order for CellStore to find a newly added taxonomy package, you need to add the taxonomy package to the caches property:

cellstore:
  ...
  caches:
    - IFRS-taxonomy-package-v0.4.0.zip
    - XBRL-and-Eurofiling-Core-taxonomy-package-v1.4.0.zip
  ...

After adding the zip file and changing the properties of CellStore you must restart CellStore in order of pick up the new taxonomy packages.

Create your own Taxonomy Package

Creating your own Taxonomy Package is simple. Please, just follow the instructions from the official Taxonomy Packages specification.

On to Part 7 »