Page tree
Skip to end of metadata
Go to start of metadata

Der AMANA XBRL Converter ist eine Kommandozeilenanwendung die dazu verwendet werden kann um XBRL-Instanzen auf Basis von CSV-Dateien zu generieren, validieren und zu visualisieren.

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.

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. Wird also folgender COREP Entry Point verwendet:

http://www.eba.europa.eu/eu/fr/xbrl/crr/fws/corep/cir-680-2014/2019-04-30/mod/corep_of_ind_bbk.xsd

Wird im Cache nach folgender Datei gesucht:

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.

Beispielhafter Cache-Ordner

Funktionen

Folgende Kernfunktionen stehen zur Verfügung:

  1. 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.

  2. 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.

  3. 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.

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):

  1. Statische Tabellen (fixe Anzahl von Zellen, z.B. C_01.01).
  2. Z-Achsen Tabellen (fixe Anzahl von Zellen, aber multiple Ausführung der Tabelle über verschiedene Z-Axhcen/"Comboboxen", z.B. C_07.00.a)
  3. Typed Dimension Tabelle (fixe Anzahl von Spalten, offene Zeilen, z.B. C_06.00)
  4. 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 Instanzgenerierung wird ein Zellwert in ein XBRL Fact konvertiert. Dabei werden die einzelnen Spalten des Datensatzes wie folgt zugeordnet:

SpalteBedeutungBeschreibung
1Tabellen-IDDie Tabellen-ID ist durch die XBRL Taxonomie vorgegeben und entspricht dem letzten Teil der XBRL Role URI der Tabelle.
2Zeile

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.

3Spalte

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.

4Z-AchseDie 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).
5Wert

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.
6Wä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.

7Genauigkeit

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.

Einstellungen

Die Konfigurationsdatei (ConverterSettings.xml) befindet sich im Installationsverzeichnis der Anwendung und kann Standardwerte für folgende Einstellungen enthalten.

NameErläuterungBeispielwert
LogFileName der Log-Datei, in der alle relevanten Meldungen der Anwendung geschrieben werden.c:\xbrllogs.txt
SWaehrungStandardwährung für monetäre Werte im ISO 4723 Format.EUR
DecimalMonetaryStandardgenauigkeit für monetäre Werte.-3
DecimalPercentStandardgenauigkeit für Prozentwerte.4
DecimalIntegerStandardgenauigkeit für Integerwerte.0
ContextIdentifierSchemaXBRL 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
ContextIdentifierXBRL Context Entity Identifier. Der Identifier, der das berichtende Unternehmen eindeutig KennzeichnetABC47114712
UseNumericCodesGibt 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
AddNegativeFilingIndicatorsGibt 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
AddPositiveFiledAttributeGibt 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
DecimalSeparatorDas Dezimaltrennzeichen der Inputdatei.,
GroupSeparatorDas Tausendertrennzeichen der Inputdatei..
DisableAutomaticCurrencyDetectionBei 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
DeactivatedRulesFilePathDer 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

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.

Die Syntax des Aufrufs entspricht:

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:

ParameterErläuterungBeispiel
FUNKTION
  • "V" für Funktion 1., Validierung und Visualisierung
  • "G" für Funktion 2., Instanzgenerierung
  • "E" für Funktion 3., Instanz-Visualisierung
G
TAXONOMIEEntrypoint (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
INPUTPfad zur Input-CSV-Datei. Kann ein absoluter order ein relativer Pfad sein."c:\input.csv" oder "input123.csv"
OUTPUTPfad der Ausgabedatei. Kann ein absoluter oder ein relativer Pfad sein."c:\output.zip" oder "report.xlsx"

Folgende Parameter sind optional:

ParameterErläuterungBeispiel
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 seinl="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.
  • No labels