XBRL Taxonomy Packages

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  Data Sources and Targets > XBRL >

XBRL Taxonomy Packages

An XBRL Taxonomy Package is a ZIP archive that contains an offline copy of an XBRL taxonomy. The advantages of an XBRL taxonomy package (if one is available from the taxonomy provider) is that XBRL resources such as schemas are resolved from local (offline) taxonomy files rather than being retrieved from the Internet. The structure and format of XBRL taxonomy packages is laid out in the Taxonomy Packages 1.0 Recommendation (https://www.xbrl.org/Specification/taxonomy-package/REC-2016-04-19/taxonomy-package-REC-2016-04-19.html).

 

If your XBRL taxonomy provider offers for download XBRL taxonomy packages conforming to the Recommendation above, you can add such packages to MapForce. This affects XBRL validation and processing (in the sense that certain URLs such as XBRL schema references will be redirected to local files included in the taxonomy package). Taxonomy packages also enable you to view all entry points of the XBRL taxonomy directly from MapForce, and improve the performance of XBRL validation.

 

Note:The following Altova desktop applications support adding XBRL Taxonomy Packages: XMLSpy, MapForce, and StyleVision. The XBRL taxonomy package list is common to all these applications. If you edit the list in one application, then the modified list will be displayed (and XBRL validation and processing will be affected) in other applications as well.

 

How it works

Each XBRL taxonomy package contains an internal catalog file (catalog.xml). This catalog file defines the URIs that should be redirected (remapped) to local resources. Catalog files conform to a restricted subset of the XML Catalog specification (https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html). A similar mechanism also exists in MapForce to remap URIs to local resources (see Catalog Files).

 

After you add one or more XBRL taxonomy packages (see instructions below), they influence, with immediate effect, how MapForce resolves resources for XBRL validation. For example, if you add an XBRL instance to the mapping, its schema will be loaded from the local taxonomy package instead of being retrieved from the Internet (assuming that the taxonomy package is active and its catalog.xml file remaps the schema URI to a local resource). Consequently, this will affect all subsequent XBRL validation and processing.

 

Caution: Package catalogs might redirect to incompatible resources

A resource pointed to by the catalog file of an active package will be used for all MapForce operations that require that resource. An example of such a resource would be XML Schema, which is used for XML validation as well as XBRL validation. If the offline resource located by the package's catalog file is incompatible with your existing environment, then errors might result. In this case, deactivate the taxonomy package and contact the creators of the package with the error information.

 

Adding a taxonomy package

1.Download the XBRL taxonomy package (.zip archive) from the provider and save it to a local directory that is not likely to change frequently. Do not unzip the downloaded archive.

 

Note:The downloaded .zip archive must conform to the Taxonomy Packages 1.0 Recommendation (https://www.xbrl.org/Specification/taxonomy-package/REC-2016-04-19/taxonomy-package-REC-2016-04-19.html).

 

2.On the Tools menu, click Options | XBRL | Taxonomy Packages.

mf_xbrl_taxpack_01

3.Click Edit.
4.Click Add Taxonomy and browse for the .zip taxonomy package. To select multiple packages, hold the Shift key pressed.

 

The list of added XBRL taxonomy packages is displayed in the dialog box, as a tree of two levels. The first level indicates the taxonomy; the second level shows the packages of that taxonomy. When a taxonomy package is selected in the XBRL Taxonomy Packages dialog, its details (including its offline location) are displayed in the dialog's lower pane.

mf_xbrl_taxpack_02

The check box to the left of a taxonomy entry indicates whether that taxonomy is active. By default, a newly added taxonomy is active. To deactivate a taxonomy, uncheck its check box. Deactivation is useful if you encounter problems with the package or wish to switch between two versions of a taxonomy.

 

If you wish to add an additional package to an existing taxonomy, select the taxonomy entry, and then click Add Packages. The added package will be displayed at the second level of that taxonomy. To remove a package, select it and click Remove (note this does not delete the actual taxonomy files from the disk).


© 2019 Altova GmbH