...
| English us |
|---|
The AMANA XBRL Converter |
...
is a command line application that can be used to generate, validate and visualize XBRL instances based on CSV files. Installation |
Die aktuelle Version des XBRL Konverters muss über die mitgelieferte Setup-Datei installiert werden. Da es sich um eine Kommandozeilenanwendung handelt sollte das Installationsverzeichnis mit Bedacht gewählt werden, da es bei jedem Aufruf mit angegeben werden muss.
XBRL Taxonomie-Cache
Um die Funktionen des Konverters verwenden zu können, muss ein XBRL Taxonomie-Cache vorhanden sein, in dem die Schemadateien der Taxonomien vorliegen, die verwendet werden sollen. Standardmäßig werden die Cache-Dateien unter dem relativen Pfad "XBRLCache" gespeichert, dieser Pfad kann nach der Installation über die "XBRLSettings.xml"-Datei über die Einstellung "XBRLFileCachePath" konfiguriert werden.
...
The current version of the XBRL converter must be installed using the supplied setup file. Since this is a command line application, the installation directory should be chosen with care, as it must be specified with each call. XBRL taxonomy cacheIn order to be able to use the functions of the converter, an XBRL taxonomy cache must exist in which the schema files of the taxonomies to be used are present. By default the cache files are stored under the relative path "XBRLCache", this path can be configured after installation via the "XBRLSettings.xml" file via the "XBRLFileCachePath" setting. The taxonomy schema data can usually be downloaded from the website of the supervisory authority. The cache maps the URLs of the individual files, with the paths of the URL representing file paths in the cache directory, with the scheme (http or https) being omitted. The following COREP entry point is used: | Code Block |
|---|
http://www.eba.europa.eu/eu/fr/xbrl/crr/fws/corep/cir-680-2014/2019-04-30/mod/corep_of_ind_bbk.xsd |
|
...
The following file is searched for in the cache: | Code Block |
|---|
www.eba.europa.eu\eu\fr\xbrl\crr\fws\corep\cir-680-2014\2019-04-30\mod\corep_of_ind_bbk.xsd |
|
...
The schema files for the cache can usually be downloaded from the website of the relevant regulatory authority as a ZIP archive.  Image Modified
|
Funktionen
Folgende Kernfunktionen stehen zur Verfügung:
...
Format der Importdatei
Die Inputdatei nimmt eine zentrale Rolle ein, da Daten für die XBRL Instanz bzw. den Excel Report nur dann korrekt zugeordnet werden, wenn die Datei bzw. die darin enthaltenen Datensätze das richtige Format haben.
Dabei wird zwischen verschiedenen Tabellentypen unterschieden (Beispiele basierend auf der COREP Taxonomie):
...
FunctionsThe following core functions are available: - Validation and visualizationThe result of the call is an Excel workbook that contains all tables with the assigned data. The validation results are presented in the Excel file.
- XBRL Instance document generationThe result of the call is on the one hand an XBRL instance document (XML file) which contains the assigned data. On the other hand, this is a text file that contains the results of the XBRL validation.
- XBRL Instance visualizationThe result of the call is an Excel file generated from the XBRL instance passed by parameter. In this way, the content of an XBRL instance can be displayed and checked in human-readable form.
Import file format
The input file plays a central role, as data for the XBRL instance or the Excel report is only assigned correctly if the file or the data records it contains have the correct format. A distinction is made between different table types (examples based on the COREP taxonomy): - Static tables (fixed number of cells, e.g. C_01.01).
- Z-
|
...
- axis tables (fixed number of cells, but multiple execution of the table via different Z-axes/"combo boxes", e.g. C_07.00.a)
- Typed
|
...
- dimension table (fixed number of columns, open rows, e.g. C_06.00)
|
...
...
...
...
Jede Zeile der CSV Datei ist ein Datensatz, welcher einen Wert für eine bestimmte Zelle einer Tabelle in der XBRL Taxonomie enthält. Bei der XBRL Instanzengenerierung wird ein Zellwert in ein XBRL Fact konvertiert. Dabei werden die einzelnen Spalten des Datensatzes wie folgt zugeordnet:
...
Die Zeile entspricht bei den Tabellentypen 1. und 2. dem "RCCode", welcher für diese Zeile in der Taxonomie definiert ist. Falls kein "RCCode" definiert ist, wird der Index der Zeile ("Zeilennummer") erwartet.
Für Tabellentypen C und D enthält diese Spalte eine eindeutige, selbstdefinierte ID, welche alle Datensätze dieser XBRL Tabellenzeile gruppiert.
...
Die Spalte entspricht bei den Tabellentypen 1. und 2. dem "RCCode", welcher in der Taxonomie für die Spalte hinterlegt ist.. Ist kein "RCCode" hinterlegt, wird der Index der Spalte ("Spaltennummer") erwartet.
Bei Tabellen des Typs C und D enthält die Spalte den "RCCode" der Typed-Dimension Spalte, wenn vorhanden. Ansonsten wird der angezeigte Name (Englisch) verwendet.
...
Der Wert enthält den in der Tabelle zu übernehmenden Eintrag. Dieser kann, basierend auf dem erwarteten XML Schema Datentyp der Zelle folgende Ausprägungen annehmen:
...
- fixed columns, open rows, multiple execution of the table)
Each row of the CSV file is a record containing a value for a specific cell of a table in the XBRL taxonomy. During XBRL instance generation, a cell value is converted into an XBRL fact. The individual columns of the data record are assigned as follows: | Column | Meaning | Description |
|---|
| 1 | Table-ID | The table ID is given by the XBRL taxonomy and corresponds to the last part of the XBRL Role URI of the table. | | 2 | Row | For table types 1. and 2., the line corresponds to the "RCCode" which is defined for this line in the taxonomy.
If no "RCCode" is defined, the index of the line ("line number") is expected.
For table types C and D, this column contains a unique, self-defined ID that groups all data records of this XBRL table line. | | 3 | Column | For table types 1. and 2., the column corresponds to the "RCCode" that is stored in the taxonomy for the column. If no "RCCode" is stored, the index of the column ("column number") is expected.For tables of type C and D the column contains the "RCCode" of the Typed-Dimension column, if present. Otherwise, the displayed name (English) is used. The Z-axis is assigned by the "RCCode" or the "DpmId" stored in the XBRL taxonomy. If this is missing, the display name used for this Z-axis can be used (English). | | 4 | Z-Axis | The Z-axis is assigned by the "RCCode" or the "DpmId" stored in the XBRL taxonomy. If this is missing, the display name used for this Z-axis can be used (English). | | 5 | Value | The value contains the entry to be adopted in the table. Based on the expected XML schema data type of the cell, this can take on the following forms: - Monetary: Monetary value. Decimal value, in German format with comma as decimal separator and period as thousands separator.
- Integer: A number with no decimals.
- Percent: A decimal number that represents a percentage. The value 0 corresponds to 0%, 1 corresponds to 100%. So to report 94.33%, the value 0.9433 must be reported.
- Boolean: 0 (false)
|
|
...
...
...
- Other: Any character string is accepted without conversion.
| | 6 |
|
...
| Warning | If the data type of the cell is monetary, the currency in ISO 4723 format is expected here (e.g. "EUR", "USD"). |
|
...
If no value is included, the default currency will be used. The currency is converted into an XBRL unit in the XBRL instance. Percentages are automatically provided with the XBRL unit "pure". | | 7 |
|
...
| Precision | If the data type of the cell is "monetary", "integer" |
|
...
...
Die Genauigkeit wird als "decimals" Attribut für den Fact in der XBRL Instanz übernommen. Falls kein Wert enthalten ist, wird die Standardgenauigkeit für den Datentyp übernommen.
Einstellungen
Die Konfigurationsdatei (ConverterSettings.xml) befindet sich im Installationsverzeichnis der Anwendung und kann Standardwerte für folgende Einstellungen enthalten.
...
, the precision can be specified here in the form of an integer. The value "2" indicates that the value is reported to 2 decimal places. A value of "-3" indicates that the value is reported to the nearest thousand. The precision is taken as a "decimals" attribute for the fact in the XBRL instance. If no value is included, the default precision for the data type is used. |
Settings:The configuration file (ConverterSettings.xml) is located in the application installation directory and can contain default values for the following settings. | Name | Explanation | Example value |
|---|
| LogFile | Name of the log file in which all relevant messages from the application are written. | c:\xbrllogs.txt | | SWaehrung |
|
...
| Standard currency for monetary values in ISO 4723 |
|
...
| format. | EUR | | DecimalMonetary |
|
...
| Default precision for monetary values. | -3 | | DecimalPercent |
|
...
| Default precision for percentages. | 4 | | DecimalInteger |
|
...
| Default precision for integers. | 0 | | ContextIdentifierSchema | XBRL Context Entity Identifier Schema. |
|
...
...
| The identifier that uniquely identifies the reporting entity | ABC47114712 | | UseNumericCodes |
|
...
| Indicates whether code for columns and rows have leading zeros. Valid values are "0" for false and "1" for true. For example, if the line code "0050" is reported as 50 in the input file, the value 1 must be set. If the row code corresponds to the value with leading zeros, the value 0 must be reported. | 0 | | AddNegativeFilingIndicators |
|
...
| Indicates whether to add negative filing indicators to the instance. Negative filing indicators are added for table groups that have not been reported. The filing rules of the supervisory authority usually define whether negative filing indicators must be reported. | false | | AddPositiveFiledAttribute |
|
...
| Indicates whether the Filed attribute should be set to true for positive filing indicators. The filing rules of the supervisory authority usually define whether the field attribute for filing indicators must be reported with the value "true". | true | | DecimalSeparator |
|
...
| The decimal separator of the input file. | , | | GroupSeparator |
|
...
| The thousands separator of the input file. | . | | DisableAutomaticCurrencyDetection |
|
...
...
...
...
| the currency of the monetary report value is given via the z-axis. By default, the engine tries to set the currency automatically using the z-axis for these tables. This behavior can be prevented by setting the value "false" for this setting. | false | | DeactivatedRulesFilePath |
|
...
| The path to a file that contains the IDs of validation rules that should not be validated. The XBRL taxonomy defines various validation rules, but regulators can also publish files with rules that should not be validated, e.g. because they were defined incorrectly in the taxonomy. These rules can be saved in a file and then read out by the converter. | deactivatedRules.csv | | XbrlSettingsFilePath |
|
...
The path to the file that defines the XBRL engine settings (cache path, etc.). The installer stores the "XBRLSettings.xml" |
|
...
Anwendung
Die Anwendung kann über die im folgenden definierten Parametern gestartet werden. Dazu muss die Anwendung "XBRLConverter.exe" entweder per externem Aufruf oder über die Kommandozeile aufgerufen werden.
...
file in the installation directory. If no path to this file is specified, it is searched for in the following directory by default: %appdata%\AMANAconsulting\SmartXBRLSettings.xml | ConverterSettings.xml | | RenderOnlyTablesWithFilingIndicator |
|
...
Beim Aufrufen der Funktion zum Generieren einer Excel-Visualisierung kann hierüber gesteuert werden, welche Tabellen dargestellt werden sollen. Folgende Werte können gesetzt werden:
- false - Es werden alle Tabellen generiert.
- true - Es werden nur die Tabellen generiert, die laut Filing Indicator berichtet wurden.
...
When calling up the function for generating an Excel visualization, it can be used to control which tables are to be displayed. The following values can be set: - false - All tables are generated.
- true - Only the tables reported according to the Filing Indicator are generated.
| true |
Usage:The application can be started using the parameters defined below. To do this, the "XBRLConverter.exe" application must be called either externally or via the command line. The syntax of the call corresponds to: | Code Block |
|---|
XbrlConverter.exe [FUNKTION] [TAXONOMIE] [INPUT] [OUTPUT] PARAMETER 1 ... PARAMETER N |
|
Die Parameter in eckigen Klammern [] sind zwingend erforderlich, die Parameter ohne Klammern sind optional und überschreiben die Einträge der Konfigurationsdatei.
...
The parameters in square brackets [] are mandatory, the parameters without brackets are optional and overwrite the entries in the configuration file. The following parameters are mandatory: |
...
...
...
...
...
- Validation and Visualization
- "G"
|
|
...
...
...
...
...
...
...
...
| Path to the input CSV file. Can be an absolute or a relative path. | "c:\input.csv" oder "input123.csv" | | OUTPUT |
|
...
| Output file path. Can be an absolute or a relative path. | "c:\output.zip" oder "report.xlsx" |
|
...
The following parameters are optional: |
...
...
| Example |
|---|
| e= | XBRL Context Entity Identifier. |
|
...
| The identifier that uniquely identifies the reporting entity. | e=39120001LYGX6JEVCV44 | | es= | XBRL Context Entity Identifier Schema. |
|
...
...
| Standard currency for monetary values in ISO 4723 |
|
...
...
| Default precision for monetary values. | dm="-6" | | dp= |
|
...
| Default precision for percentages. | dp=4 | | di= |
|
...
| Default precision for integers. | di=0 | | l= |
|
...
| Path to log file. Can be an absolute or a relative path | l="c:\dev\templog.log", l="log.txt" | | rd= |
|
...
| End date of the reporting period. | rd="2019-12-31" | | pd= |
|
...
| Start date of the reporting period. | rd="2018-12-31" | sf= settingsfilepath= |
|
...
| Path to ConverterSettings.xml |
|
...
| file. The path can be absolute or relative. If no value is specified, the "ConverterSettings.xml" |
|
...
| file is searched for in the installation directory. | sf="C:\dev\ConverterSettings.xml" | | cache= |
|
...
| Path to XBRL taxonomy cache. The path can be absolute or relative. If no value is specified, the path from the XBRLSettings.xml file is used. | cache="C:\dev\cache" | | oldHeader= |
|
...
| The Bundesbank tables contain a header table which has no RC codes. Therefore, in this case, the index of the row and column must be used. The appearance of the table has changed with a previous version, increasing the index of the cells by 1. If the option is set to "true", the old indices are applied. | oldHeader=true | | deactivatedRules= |
|
...
| Path to file with IDs of rules not to be validated. Each rule to be disabled is expected on a separate line. | deactivatedRules="C:\dev\rules.csv" |
|
Allgemeine Hinweise
...
- The column order of the import file must correspond exactly to the order defined above.
- If parameters contain values with spaces (e.g. "C:\
|
...
- Documents and Settings\.."), the parameters must be enclosed in quotation marks.
- Files used for the conversion must not be open by another application (e.g. Excel) when the application is called.
- The "ConverterSettings.xml" file contains basic settings that can be overwritten by parameters passed when calling the command line
- The target directory used for the output files must have write permissions.
Releasing a new version of the XBRL Converter:- Build the AMANA.XBRL.Tool.Converter project in Release mode.
- Create a Zip (with a password) file with the contents of the C:\Users\user_name\source\repos\Engine\Tools\AMANA.XBRL.Tool.Converter\bin\Release folder
- Upload the zip file to upload.amana.de
- Generate a shared link (Link teilen → In den Zwischenablage kopieren)
- Copy the password
- Send an email to the customer with the following information:
- Shared link in Step 4 along with the link's password in Step 5.
- Password of the zip file.
|
| German |
|---|
Der AMANA XBRL Converter ist eine Kommandozeilenanwendung, die dazu verwendet werden kann XBRL-Instanzen auf Basis von CSV-Dateien zu generieren, validieren und visualisieren. InstallationDie aktuelle Version des XBRL Konverters muss über die mitgelieferte Setup-Datei installiert werden. Da es sich um eine Kommandozeilenanwendung handelt sollte das Installationsverzeichnis mit Bedacht gewählt werden, da es bei jedem Aufruf mit angegeben werden muss. XBRL Taxonomie-CacheUm die Funktionen des Konverters verwenden zu können, muss ein XBRL Taxonomie-Cache vorhanden sein, in dem die Schemadateien der Taxonomien vorliegen, die verwendet werden sollen. Standardmäßig werden die Cache-Dateien unter dem relativen Pfad "XBRLCache" gespeichert, dieser Pfad kann nach der Installation über die "XBRLSettings.xml"-Datei über die Einstellung "XBRLFileCachePath" konfiguriert werden. Die Schemadaten der Taxonomie können üblicherweise über die Webseite der Aufsichtsbehörde heruntergeladen werden. Der Cache bildet die URLs der einzelnen Dateien ab, wobei die Pfade der URL Dateipfaden im Cache-Verzeichnis darstellen, wobei das Schema (http bzw. https) ausgelassen wird. Es wird also folgender COREP Entry Point verwendet: | Code Block |
|---|
http://www.eba.europa.eu/eu/fr/xbrl/crr/fws/corep/cir-680-2014/2019-04-30/mod/corep_of_ind_bbk.xsd |
Im Cache wird nach folgender Datei gesucht: | Code Block |
|---|
www.eba.europa.eu\eu\fr\xbrl\crr\fws\corep\cir-680-2014\2019-04-30\mod\corep_of_ind_bbk.xsd |
Die Schemadateien für den Cache können in der Regel von der Webseite der entsprechenden Aufsichtsbehörde als ZIP-Archiv heruntergeladen werden. Image Added FunktionenFolgende Kernfunktionen stehen zur Verfügung: - Validierung und Visualisierung
Das Ergebnis des Aufrufs ist ein Excel-Workbook, welches alle Tabellen mit den zugeordneten Daten enthält. Die Validierungsergebnisse werden in der Exceldatei dargestellt.
- XBRL Instanzdokuemnt Generierung
Das Ergebnis des Aufrufs ist zum einen ein XBRL Instanzdokument (XML Datei), welche die zugeordneten Daten enthält. Zum anderen ist dies eine Textdatei, welche die Ergebnisse der XBRL Validierung enthält.
- XBRL Instanz Visualisierung
Das Ergebnis des Aufrufs ist eine aus der per Parameter übergebenen XBRL-Instanz erzeugte Excel-Datei. So können die Inhalte einer XBRL-Instanz menschenlesbar dargestellt und überprüft werden.
Die Inputdatei nimmt eine zentrale Rolle ein, da Daten für die XBRL Instanz bzw. den Excel Report nur dann korrekt zugeordnet werden, wenn die Datei bzw. die darin enthaltenen Datensätze das richtige Format haben. Dabei wird zwischen verschiedenen Tabellentypen unterschieden (Beispiele basierend auf der COREP Taxonomie): - Statische Tabellen (fixe Anzahl von Zellen, z.B. C_01.01).
- Z-Achsen Tabellen (fixe Anzahl von Zellen, aber multiple Ausführung der Tabelle über verschiedene Z-Achsen/"Comboboxen", z.B. C_07.00.a)
- Typed Dimension Tabelle (fixe Anzahl von Spalten, offene Zeilen, z.B. C_06.00)
- Kombinierte Z-Achsen und Typed Dimension Tabelle (fixe Spalten, offene Zeilen, multiple Ausführung der Tabelle)
Jede Zeile der CSV Datei ist ein Datensatz, welcher einen Wert für eine bestimmte Zelle einer Tabelle in der XBRL Taxonomie enthält. Bei der XBRL Instanzengenerierung wird ein Zellwert in ein XBRL Fact konvertiert. Dabei werden die einzelnen Spalten des Datensatzes wie folgt zugeordnet: | Spalte | Bedeutung | Beschreibung |
|---|
| 1 | Tabellen-ID | Die Tabellen-ID ist durch die XBRL Taxonomie vorgegeben und entspricht dem letzten Teil der XBRL Role URI der Tabelle. | | 2 | Zeile | Die Zeile entspricht bei den Tabellentypen 1. und 2. dem "RCCode", welcher für diese Zeile in der Taxonomie definiert ist. Falls kein "RCCode" definiert ist, wird der Index der Zeile ("Zeilennummer") erwartet. Für Tabellentypen C und D enthält diese Spalte eine eindeutige, selbstdefinierte ID, welche alle Datensätze dieser XBRL Tabellenzeile gruppiert. | | 3 | Spalte | Die Spalte entspricht bei den Tabellentypen 1. und 2. dem "RCCode", welcher in der Taxonomie für die Spalte hinterlegt ist.. Ist kein "RCCode" hinterlegt, wird der Index der Spalte ("Spaltennummer") erwartet. Bei Tabellen des Typs C und D enthält die Spalte den "RCCode" der Typed-Dimension Spalte, wenn vorhanden. Ansonsten wird der angezeigte Name (Englisch) verwendet. | | 4 | Z-Achse | Die Z-Achse wird durch den in der XBRL Taxonomie hinterlegten "RCCode" oder der "DpmId" zugeordnete. Fehlt dieser, kann der für diese Z-Achse verwendete Anzeigename verwendet weden (Englisch). | | 5 | Wert | Der Wert enthält den in der Tabelle zu übernehmenden Eintrag. Dieser kann, basierend auf dem erwarteten XML Schema Datentyp der Zelle folgende Ausprägungen annehmen: - Monetary: Monetärer Wert. Dezimalwert, im deutschen Format mit Komma als Dezimaltrennzeichen und Punkt als Tausendertrennzeichen.
- Integer: Eine Zahl ohne Dezimalstellen.
- Percent: Eine Dezimalzahl, die ein Prozentwert darstellt. Der Wert 0 entspricht 0%, 1 entspricht 100%. Um also 94,33% zu berichten, muss der Wert 0,9433 angegeben werden.
- Boolean: 0 (false) oder 1 (true) wird erwartet.
- String/Andere: Eine beliebige Zeichenkette wird ohne Konvertierung übernommen.
| | 6 | Währung | Falls der Datentyp der Zelle monetary entspricht, wird hier die Währung im ISO 4723 Format erwartet (z.B. "EUR", "USD"). Falls kein Wert enthalten ist, wird die Standard-Währung verwendet. Die Währung wird in der XBRL Instanz in eine XBRL Unit umgewandelt. Prozentwerte werden automatisch mit der XBRL Unit "pure" versehen. | | 7 | Genauigkeit | Falls der Datentyp der Zelle "monetary", "integer" oder "percent" entspricht, kann hier die Genauigkeit in Form einer Ganzzahl angegeben werden. Der Wert "2" gibt an, dass der Wert auf 2 Nachkommastellen genau berichtet wird. Der Wert "-3" gibt an, dass der Wert auf Tausend genau berichtet wird. Die Genauigkeit wird als "decimals" Attribut für den Fact in der XBRL Instanz übernommen. Falls kein Wert enthalten ist, wird die Standardgenauigkeit für den Datentyp übernommen. |
EinstellungenDie Konfigurationsdatei (ConverterSettings.xml) befindet sich im Installationsverzeichnis der Anwendung und kann Standardwerte für folgende Einstellungen enthalten. | Name | Erläuterung | Beispielwert |
|---|
| LogFile | Name der Log-Datei, in der alle relevanten Meldungen der Anwendung geschrieben werden. | c:\xbrllogs.txt | | SWaehrung | Standardwährung für monetäre Werte im ISO 4723 Format. | EUR | | DecimalMonetary | Standardgenauigkeit für monetäre Werte. | -3 | | DecimalPercent | Standardgenauigkeit für Prozentwerte. | 4 | | DecimalInteger | Standardgenauigkeit für Integerwerte. | 0 | | ContextIdentifierSchema | XBRL Context Entity Identifier Schema. Gibt die Art des verwendeten Identifiers an, über das das berichtende Unternehmen erkannt wird. Das zu verwendende Schema hängt von den Anforderungen der Aufsichtsbehörde ab und wird üblicherweise in sog. Filing Rules definiert. | http://www.bundesbank.de/ext/basis/identifiertyp/creditorNumber | | ContextIdentifier | XBRL Context Entity Identifier. Der Identifier, der das berichtende Unternehmen eindeutig Kennzeichnet | ABC47114712 | | UseNumericCodes | Gibt an, ob Code für Spalten und Zeilen führende Nullen aufweisen. Valide Werte sind "0" für falsch und "1" für Wahr. Wird z.B. der Zeilencode "0050" in der Inputdatei als 50 berichtet, muss der Wert 1 gesetzt werden. Entspricht der Zeilencode dem Wert mit führenden Nullen, muss der Wert 0 berichtet werden. | 0 | | AddNegativeFilingIndicators | Gibt an, ob negative Filing Indicators zur Instanz hinzugefügt werden sollen. Negative Filing Indicators werden für Tabellengruppen hinzugefügt, die nicht berichtet wurden. In den Filing Rules der Aufsichtsbehörde ist üblicherweise definiert, ob negative Filing Indicators berichtet werden müssen. | false | | AddPositiveFiledAttribute | Gibt an, ob für positive Filing Indicators das Filed-Attribut mit dem Wert "true" gesetzt werden soll. In den Filing Rules der Aufsichtsbehörde ist üüblicherweise definiert, ob das field Attribut für Filing Indikatoren mit dem Wert "true" berichtet werden müssen. | true | | DecimalSeparator | Das Dezimaltrennzeichen der Inputdatei. | , | | GroupSeparator | Das Tausendertrennzeichen der Inputdatei. | . | | DisableAutomaticCurrencyDetection | Bei einigen Tabellen, z.B. in der Solvency II Tabelle S.16.01.01.01, wird über die Z-Achse die Währung des monetären Berichtswerts angegeben. Standardmäßig versucht die Engine bei diesen Tabellen die Währung automatisch anhand der Z-Achse zu setzen. Dieses Verhalten kann unterbunden werden, indem für diese Einstellung der Wert "false" gesetzt wird. | false | | DeactivatedRulesFilePath | Der Pfad zu einer Datei, in der die IDs von Validierungsregeln hinterlegt sind, die nicht validiert werden sollen. Die XBRL-Taxonomie definiert diverse Validierungsregeln, Aufsichtsbehörden können jedoch auch Dateien mit Regeln veröffentlichen, die nicht validiert werden sollen, z.B. weil diese in der Taxonomie falsch definiert wurden. Diese Regeln können in einer Datei gespeichert und dann vom Konverter ausgelesen werden. | deactivatedRules.csv | | XbrlSettingsFilePath | Der Pfad zur Datei, die die Einstellungen der XBRL Engine definieren (Cache-Pfad usw.). Der Installer hinterlegt im Installationsverzeichnis die Datei "XBRLSettings.xml". Wird kein Pfad zu dieser Datei angegeben, wird diese Standardmäßig im folgenden Verzeichnis gesucht: %appdata%\AMANAconsulting\SmartXBRLSettings.xml | ConverterSettings.xml | | RenderOnlyTablesWithFilingIndicator | Beim Aufrufen der Funktion zum Generieren einer Excel-Visualisierung kann hierüber gesteuert werden, welche Tabellen dargestellt werden sollen. Folgende Werte können gesetzt werden: - false - Es werden alle Tabellen generiert.
- true - Es werden nur die Tabellen generiert, die laut Filing Indicator berichtet wurden.
| true |
AnwendungDie Anwendung kann über die im folgenden definierten Parametern gestartet werden. Dazu muss die Anwendung "XBRLConverter.exe" entweder per externem Aufruf oder über die Kommandozeile aufgerufen werden. Die Syntax des Aufrufs entspricht: | Code Block |
|---|
XbrlConverter.exe [FUNKTION] [TAXONOMIE] [INPUT] [OUTPUT] PARAMETER 1 ... PARAMETER N |
Die Parameter in eckigen Klammern [] sind zwingend erforderlich, die Parameter ohne Klammern sind optional und überschreiben die Einträge der Konfigurationsdatei. Folgende Parameter sind zwingend notwendig: | Parameter | Erläuterung | Beispiel |
|---|
| FUNKTION | - "V" für Funktion 1., Validierung und Visualisierung
- "G" für Funktion 2., Instanzgenerierung
- "E" für Funktion 3., Instanz-Visualisierung
| G | | TAXONOMIE | Entrypoint (Einstiegspunkt) der XBRL Taxonomie. | http://www.eba.europa.eu/eu/fr/xbrl/crr/fws/corep/cir-680-2014/2019-04-30/mod/corep_of_ind_bbk.xsd | | INPUT | Pfad zur Input-CSV-Datei. Kann ein absoluter order ein relativer Pfad sein. | "c:\input.csv" oder "input123.csv" | | OUTPUT | Pfad der Ausgabedatei. Kann ein absoluter oder ein relativer Pfad sein. | "c:\output.zip" oder "report.xlsx" |
Folgende Parameter sind optional: | Parameter | Erläuterung | Beispiel |
|---|
| e= | XBRL Context Entity Identifier. Der Identifier, der das berichtende Unternehmen eindeutig kennzeichnet. | e=39120001LYGX6JEVCV44 | | es= | XBRL Context Entity Identifier Schema. Der Typ des Entity Identifiers. | es=http://standards.iso.org/iso/17442 | | w= | Standardwährung für monetäre Werte im ISO 4723 Format. | w=USD | | dm= | Standardgenauigkeit für monetäre Werte. | dm="-6" | | dp= | Standardgenauigkeit für Prozentwerte. | dp=4 | | di= | Standardgenauigkeit für Integerwerte. | di=0 | | l= | Pfad zur Logdatei. Kann ein absoluter oder ein relativer Pfad sein | l="c:\dev\templog.log", l="log.txt" | | rd= | Enddatum des Berichtszeitraums. | rd="2019-12-31" | | pd= | Startdatum des Berichtszeitraums. | rd="2018-12-31" | sf= settingsfilepath= | Pfad zur ConverterSettings.xml Datei. Der Pfad kann absolut oder relativ sein. Wird kein Wert angegeben, wird die Datei "ConverterSettings.xml" im Installationsverzeichnis gesucht. | sf="C:\dev\ConverterSettings.xml" | | cache= | Pfad zum XBRL Taxonomie-Cache. Der Pfad kann absolut oder relativ sein. Wird kein Wert angegeben, wird der Pfad aus der XBRLSettings.xml Datei verwendet. | cache="C:\dev\cache" | | oldHeader= | Die Tabellen der Bundesbank beinhalten eine header-Tabelle, welche keine RC-Codes haben. Daher muss in diesem Fall der Index der Zeile und Spalte verwendet werden. Die Darstellung der Tabelle hat sich mit einer vorangegangenen Version geändert, wodurch sich der Index der Zellen um 1 erhöht hat. Ist die Option auf "true" gesetzt, werden die alten Indizes angewandt. | oldHeader=true | | deactivatedRules= | Pfad zur Datei mit IDs von Regeln, die nicht validiert werden sollen. Jede Regel, die deaktiviert werden soll, wird in einer separaten Zeile erwartet. | deactivatedRules="C:\dev\rules.csv" |
Allgemeine Hinweise- Die Spaltenreihenfolge der Importdatei muss exakt der oben definierten Reihenfolge entspechen.
- Enthalten Parameter Werte mit Leerzeichen (z.B. "C:\Dokumente und Einstellungen\.."), müssen die Parameter in Anführungszeichen gesetzt werden.
- Für die Konvertierung genutzte Dateien dürfen beim Aufruf der Anwendung nicht von einer andere Anwendung (z.B. Excel) geöffnet sein.
- In der Datei "ConverterSettings.xml" finden sich grundlegende Einstellungen, die durch übergebene Parameter beim Kommandozeilenaufruf überschrieben werden können
- Im für die Ausgabedateien genutzten Zielverzeichnis müssen Schreibrechte vorhanden sein.
Veröffentlichung einer neuen Version des XBRL-Konverters:- Erstellen Sie das AMANA.XBRL.Tool.Converter-Projekt im Release-Modus.
- Erstellen Sie eine Zip-Datei (mit Passwort) mit dem Inhalt des Ordners C:\Benutzer\Benutzername\Quelle\repos\Engine\Tools\AMANA.XBRL.Tool.Converter\bin\Release
- Laden Sie die Zip-Datei auf upload.amana.de hoch
- Einen geteilten Link generieren (Link teilen → In die Zwischenablage kopieren)
- Kopieren Sie das Passwort
- Senden Sie eine E-Mail mit den folgenden Informationen an den Kunden:
- Geteilter Link in Schritt 4 zusammen mit dem Passwort des Links in Schritt 5.
- Passwort der ZIP-Datei.
|