Logo Reporting Standard S.L. Skip to content English | Espaņol

December 2008

Tool for the management of the XBRL Catalog

XBRL Catalog management tool

Reporting Standard announces the availability of a new tool to facilitate the management of the XBRL Catalog.

Q: What is the XBRL local Catalog?

A: The local Catalog is a local copy on the hard drive of the files of a taxonomy. The local catalog provides local files to the required tool as if the file where located on the Internet.

Q: What is the Catalog used for?

A: The Catalog is used to improve performance of the XBRL tools, that is, to reduce the amount of time required to open the whole DTS. The time is reduced because the access speed to the local hard drive is faster than the access speed over the Internet.

Q: What happens if there are changes to the taxonomy files?

A: Web pages change very often, but this is not happening to XBRL taxonomies and is a bad practice if the taxonomy author do it. Normally, when a new taxonomy is released it contains some key differences. One of them is the Official Location and the other are the schema namespaces. The Official locations change because they normally incorporate the publication dates. Using local copies of the taxonomies is a very common and safe practice in order to accelerate the taxonomy loading process.

Q: What shall I do to start using the Catalog?

A: The Catalog Manager is a very simple tool easy to use that allows you to review, add and delete taxonomies to the Catalog.

The simplest way to store a taxonomy in the Catalog is to follow the steps indicated below:

1. Download the ZIP file with the taxonomy files from the Official Location.

2. Write down the Official URL of the taxonomy. This is normally indicated in the taxonomy documentation.

3. Start the Catalog Manager tool and press the Add taxonomy from a ZIP file button.

4. Locate the ZIP file you have just downloaded.

5. Follow instructions in the screen. The tool will automatically uncompress the content of the taxonomy ZIP file.

6. Remember to press "Save" once you finish.

In order to start the tool you should double click the icon of the CatalogManager

Catalog Manager Icon

Once the tool is started it shows you the following user interface:

Catalog Manager GUI

The list on the left holds one entry per taxonomy in the catalog. The name on the list corresponds to the field Taxonomy name on the right hand side of the window.

The Taxonomy cache catalog file indicates the XML file where the Catalog will be stored. This file must exist with that name in order to allow Reporting Standard tool to share the Catalog content between all the tools.

The Taxonomy Name is the name assigned to the taxonomy context. Reporting Standard XBRL API allows each taxonomy context to have a name. This feature serves in order to load multiple taxonomies in separate taxonomy contexts. The taxonomy name is an optional feature.

Official location part this corresponds to the Official Taxonomy location. This is the URL or the address on the Internet where the taxonomy files are published. The Official location should be part of the taxonomy documentation. If you have problems with the value of the official location for a taxonomy don't hesitate to send an email to us. We will help you locating the right value and we will eventually publish a page with that information in order to help other users.

Taxonomy location This is the local path on the hard disk relative to the directory where the Catalog file is located. If you need to change the value of this field you can use the "..." Button.

Delete Entry Delete the selected entry in the list. This option does not delete the files on the hard drive.

New Entry Manually adds a new entry to the Taxonomy Catalog. You can provide all the values and manually obtain the taxonomy content from a zip file or any other container.

New from taxonomy zip file This is a wizard to help you installing a taxonomy in the Catalog from a ZIP file. Normally you can download a ZIP file from the Official Taxonomy Location. The wizard will ask you for the values of the required parameters. When the process ends, a new entry will be created in the list and the content of the ZIP file will be extracted for you automatically.

Save Saves the content of the Catalog file. Don't forget to press Save each time to make changes to the Catalog content.