Altova EBA Add-in for Excel, Version 2024 Enterprise Edition

Patch or Install a Taxonomy

Home Prev Top Next

Patch an installed taxonomy

Occasionally, XBRL taxonomies may receive patches (upgrades or revisions) from their issuers. When Taxonomy Manager detects that patches are available, these are indicated in the taxonomy listings of Taxonomy Manager and you can install the patches quickly.

 

In the GUI

Patches are indicated by the icTaxonomyPatch icon. (Also see the previous topic about status categories.) If patches are available, the Patch Selection button will be enabled. Click it to select and prepare all patches for installation. In the GUI, the icon of each taxonomy that will be patched changes from icTaxonomyPatch to icTaxonomyUpgrade, and the Messages pane at the bottom of the dialog lists the patches that will be applied. When you are ready to install the selected patches, click Apply. All patches will be applied together. Note that if you deselect a taxonomy marked for patching, you will actually be uninstalling that taxonomy.

 

On the CLI

To apply a patch at the command line interface:

 

1.Run the list -u command. This lists any taxonomies where patch upgrades are available.

2.Run the upgrade command to install all the patches.

 

Install an available taxonomy

You can install taxonomies using either the Taxonomy Manager GUI or by sending Taxonomy Manager the install instructions via the command line.

 

Note: If the current taxonomy references other taxonomies, the referenced taxonomies are also installed.

 

 

In the GUI

To install taxonomies using the Taxonomy Manager GUI, select the taxonomies you want to install and click Apply.

 

You can also select the taxonomies you want to install at the Altova website and generate a downloadable .altova_taxonomies file. When you double-click this file, it will open Taxonomy Manager with the taxonomies you wanted pre-selected. All you will now have to do is click Apply.

 

 

On the CLI

To install taxonomies via the command line, run the install command:

 

taxonomymanager.exe install [options] Taxonomy+

 

where Taxonomy is the taxonomy (or taxonomies) you want to install or a .altova_taxonomies file. A taxonomy is referenced by an identifier of format <name>-<version>. (The identifiers of taxonomies are displayed when you run the list command.) You can enter as many taxonomies as you like. For details, see the description of the install command.

 

Note:On Linux or macOS, use the sudo ./taxonomymanager command.

 

 

Installing a required taxonomy

When you run an XBRL-related command in EBA XBRL Add-in and EBA XBRL Add-in discovers that a taxonomy it needs for executing the command is not present or is incomplete, Taxonomy Manager will display information about the missing taxonomy. You can then directly install any missing taxonomy via Taxonomy Manager.

 

In the Taxonomy Manager GUI, you can view all previously installed taxonomies at any time by running Taxonomy Manager from Tools | Taxonomy Manager.

 

 

© 2017-2023 Altova GmbH