System requirements and download
The XBRL Tagger is a Windows Forms Desktop tool that is used on a local computer. It does not require any server or database.
- Minimum 8 GB RAM
- Microsoft Windows 64-bit Version 10 or higher with .NET Framework 4.7.2
- Optional: Internet connection for updates and license activation, see details below.
There are two installers available, The Click-Once installer can be used without administrative privileges and the software will be installed in the users AppData folder. The MSI installer is useful for software distribution and machine-wide installation and requires administrative privileges. The MSI installer does not support the inbuilt application updater.
Please contact email@example.com to get the download link.
Double click on the installer to start the installation. After the installation the XBRL Tagger can be started via the Windows start menu ("AMANA XBRL Tagger").
Depending on the installer type the default installation location is:
- C:\Users\user.name\AppData\Local\AMANA (AMANA.XBRL.Tagger.exe)
- C:\Program Files (x86)\AMANA XBRL Tagger Installer (Setup.msi)
Logs are stored in the installation directory in the subfolder "logs".
It is necessary to have a valid serial number to perform a successful installation. Please contact firstname.lastname@example.org if you need a license.
The Tagger uses an offline taxonomy cache to store the files and enable a faster access to them. Since XBRL taxonomies comprise hundreds of files it would take too long to fetch all these files from the internet for every use. After the successful AMANA XBRL Tagger installation, an XBRLCache folder is automatically created on your hard drive.
It can be found under: %appdata%\AMANAconsulting (corresponds to e.g. C:\Users\USERNAME\AppData\Roaming\AMANAconsulting). This folder contains all necessary taxonomy elements. The offline cache is ready for use by the application.
In order to convert a PDF document to XHTML and keeping all formats, AMANA recommends to use a third-party XHTML converter, called pdfToHTMLEx. This converter is published under GPL v3 and free to use. However, it can't be distributed with the XBRL Tagger, so users are requested to install it themselves. AMANA forked the converter and published a version under the GPL v3 version here:
See more information in FAQ item #26.
Furthermore, the Tagger needs to be allowed to execute the pdf2htmlEX.exe from that library and have write access to it, in order to convert PDF files.
Some of the default folders used by the application can be customized.
The offline taxonomy cache location can be changed by changing the following setting in Settings/XBRL Processor Settings:
The default location for the pdf-library is C:\Users\user.name\AppData\Roaming\AMANAconsulting\pdfToHTMLEx\0.14.8-win\. If for security reasons the loccation needs to be changed, it can be done in the app.config file of the Tagger, which can be found in the same location as the executable. In the appSettings section, the following to keys can be changed:
- PdfLibraryUri: If you don't want to fetch the PDF converter from our github site, you can define a path to a custom location. This path has to end with download/0.14.8-win/pdfToHtmlEx.zip.
- PdfLibraryLocalPath: The local location of the library files. Can be changed to any value on the local file system. The Tagger needs full access to the selected folder.
This setting needs to be updated every time a new version is installed.
The current version of the library can always be found on Github: https://github.com/amanaconsulting/pdf2htmlEX/releases
License and Activation
Activate the software license
To make full use of the Tagger a valid license is needed. Depending on the type of license, different steps are necessary.
Unverified (no internet check) or unlimited License File:
Simply copy the license file to the AMANA AppData folder or C:\ProgramData\IPManager and start the application (%appdata%\AMANAconsulting).
Open the "License" dialog (Info → License) and paste the provided serial number into the respective text box. Click “Activate” and confirm the following dialog. The field “Activation” should now state “Activated”.
License files will be stored in the folder C:\ProgramData\IPManager.
Activate the software license with file
Sometimes it is not possible to activate the license via serial number and internet. In those cases the user has to provide us with the Hardware Id as shown in the screenshot above. AMANA will then manually activate a license and send it to the user via Mail. The file can then be imported by clicking the "Add License File" button. This license does not have to be activated again! After adding the file just close the license window.
Internet Proxy Settings
When activating the Tagger, an internet connection to AMANA's license server at https://app.licensespot.com will be established to verify the license information. A proxy can be used for the contacting to the license server. To do so, click "Settings" on the menu bar at the top of the window and select "XBRL Processor Settings".
In the lower half of the window the proxy settings can be configured. The settings can be tested by clicking the "Test" button. During testing the application tries to establish a connection to xbrl.org.
The settings are stored in a XML file which is stored at %appdata%\AmanaConsulting\SmartXBRLSettings.xml. The password will be stored encrypted.
Failed calculations in XBRL are often just rounding errors, and thus ignored by most filers and regulators. Sometimes the actual delta between the calculated value and the tagged value is so too big to be a rounding error, so it would make more sense to be an error than a warning. This behavior can now be changed in the XBRL Processor settings:
You can enable or disable this functionality and also set the threshold for when a calculation warning should become an error.
Updating the application
An Auto Updater automatically downloads the latest version of the AMANA XBRL Tagger. Please click on Check for updates in the Tools menu to open the update dialog. For auto-updates, an internet connection to https://downloads.amana-consulting.de has to be established. If no direct internet connection is possible, a proxy server can be configured as described in the section above.
If the integrated update functionality is not working or the XBRL Tagger needs to be removed from the computer, uninstall the XBRL Tagger from the Apps & Features menu in the Windows settings. If required install the latest version again.
The status of the application will be displayed in a separate dialogue. If a new version is available, click on "Update". Please restart the application to run the new version.
Open Source Licenses
The Tagger uses some open source software components. A list of all components including their licenses can be found in the installation directory in the LICENSE text file.