valxbrl (xbrl)

www.altova.com Expand/Collapse All Print this Topic Previous Page Up One Level Next page

Home >  Command Line Interface (CLI) > XBRL Validation Commands >

valxbrl (xbrl)

The valxbrl | xbrl command validates one or more XBRL instance documents according to the XBRL 2.1, Dimensions 1.0 and Formula 1.0 specifications.

 

Windows

RaptorXMLXBRL valxbrl | xbrl [options] InputFile  

Linux

raptorxmlxbrl valxbrl | xbrl [options] InputFile

Mac

raptorxmlxbrl valxbrl | xbrl [options] InputFile

 

 

The InputFile argument is the XBRL instance document to validate. To validate multiple documents, either: (i) list the files to be validated on the CLI, with each file separated from the next by a space; or (ii) list the files to be validated in a text file (.txt file), with one filename per line, and supply this text file as the InputFile argument together with the --listfile option set to true (see the Options list below).

 

Note:The XBRL instance document must not be nested in another XML document and must have the xbrl element as its root element.
<xbrl xmlns="http://www.xbrl.org/2003/instance"> ... </xbrl>

 

EDGAR validation

EDGAR (Electronic Data Gathering, Analysis, and Retrieval) is a system that performs automated collection, validation, and indexing of financial statements filed by companies to the United States SEC (Securities and Exchange Commission). raptorxmlxbrl supports EDGAR validation via Raptor's Python API. To run an EDGAR validation on an XBRL instance file, use the --script option to run the EDGAR validation Python script. In raptorxmlxbrl, this script, efm-validation.py, is located in the etc\scripts\sec-edgar-tools folder of the application folder:

 

valxbrl --script="C:\Program Files\Altova\RaptorXMLXBRLServer2019\etc\scripts\sec-edgar-tools\efm-validation.py" myinstance.xbrl

 

 

Examples

 

raptorxmlxbrl valxbrl c:\Test.xbrl
raptorxmlxbrl xbrl --formula-execution=true --formula-output=c:\FormulaOutput.xml c:\Test.xbrl
raptorxmlxbrl xbrl --formula-execution --assertions-output=c:\AssertionsOutput.xml c:\Test.xbrl
raptorxmlxbrl xbrl --formula-execution --formula-output=c:\FormulaOutput.xml --assertions-output=c:\AssertionsOutput.xml c:\Test.xbrl

 

Click to expand/collapseCasing and slashes on the command line

RaptorXMLXBRL on Windows

raptorxmlxbrl on Unix (Linux, Mac)

 

* Note that lowercase (raptorxmlxbrl) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXMLXBRL) works only on Windows and Mac.

* Use forward slashes on Linux and Mac, backslashes on Windows.

 

Options

The command's options are listed below, organized into groups. Values can be specified without quotes except in two cases: (i) when the value string contains spaces, or (ii) when explicitly stated in the description of the option that quotes are required.

 

Click to expand/collapseXBRL validation and processing

--additional-dts-entry-point = FILE

Forces the specified entry-point file to be included in the DTS discovery process. Add the option multiple times to specify more than one entry point.

 

--ct-restrict-mode = 1.0|1.1|default

Specifies how to check complex type restrictions. A value of 1.0 checks complex type restrictions as defined in the XSD 1.0 specification—even in XSD 1.1 validation mode. A value of 1.1 checks complex type restrictions as defined in the XSD 1.1 specification—even in XSD 1.0 validation mode. A value of default checks complex type restrictions as defined in the XSD specification of the current validation mode (1.0 or 1.1). The default value is default.

 

--deduplicate = true|false

Enables de-duplication according to the Handling Duplicate Facts in XBRL and Inline XBRL 1.0 specification. Removes facts that are (i) complete duplicates, (ii) consistent duplicates (by definition these are numeric facts; the most accurate of the duplicates is retained for processing). Inconsistent and multi-language duplicates are not affected by this option. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--dimensions = true|false

Enables XBRL Dimension 1.0 extensions. Default is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--dts = FILE

Preloads the DTS entry point given in FILE, and uses it for the validation of instance files. Add the option multiple times to specify more than one entry point. Entry points in instance files will be ignored. The command is used to batch validate multiple instance files that all refer to the same taxonomy. The --dts  option instructs the Raptor engine to load the DTS only a single time—and not for each instance in the file list. (A file list is given either on the CLI, or in a text file that is indicated as a file list by setting the --listfile option to true.) If an instance file in the file list references a different taxonomy, then a warning is issued. This command can greatly speed up validation time when validating many small instance files each that have a large supporting DTS; it provides no advantage when validating a single instance file.

 

--essence-alias-checks = true|false

Enables reporting of essence-alias inconsistencies. Default value is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--extensible-enumerations = true|false

If true, enables the XBRL Extensible Enumerations 1.0 extension. Default is: true.

 

--generic-links = true|false

Enables the XBRL Generic Links 1.0 extension. Default value is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--generic-preferred-label = true|false

Enables the XBRL Generic Preferred Label 1.0 extension. Default value is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--inconsistencies-limit = VALUE | unlimited

Specifies the XBRL inconsistencies limit, with values being in the range 1-65535 or unlimited. Processing continues if the limit is reached, but further inconsistencies are not reported. The default value is 100.

 

--listfile = true|false

If true, treats the command's InputFile argument as a text file containing one filename per line. Default value is false. (An alternative is to list the files on the CLI with a space as separator. Note, however, that CLIs have a maximum-character limitation.) Note that the --listfile option applies only to arguments, and not to options.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--pa | --parallel-assessment = true|false

If set to true, schema validity assessment is carried out in parallel. This means that if there are more than 128 elements at any level, these elements are processed in parallel using multiple threads. Very large XML files can therefore be processed faster if this option is enabled. Parallel assessment takes place on one hierarchical level at a time, but can occur at multiple levels within a single infoset. Note that parallel assessment does not work in streaming mode. For this reason, the --streaming option is ignored if --parallel-assessment is set to true. Also, memory usage is higher when the --parallel-assessment option is used. The default setting is false. Short form for the option is --pa.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--preload-xbrl-schemas = true|false

Preloads schemas of the XBRL 2.1 specification. Default is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--recurse = true|false

Used to select files within sub-directories, including in ZIP archives. If true, the command's InputFile argument will select the specified file also in subdirectories. For example: test.zip|zip\test.xml will select files named test.xml at all folder levels of the zip folder. The wildcard characters * and ? may be used. So, *.xml will select all .xml files in the (zip) folder. The option's default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--report-duplicates = all|complete|consistent|inconsistent|inconsistent-numeric|inconsistent-non-numeric|multi-language

Enables the reporting of duplicate facts of the specified duplicate class. Add the option multiple times to specify more than one duplicate class. There is no default value. If no value is specified, then no check for duplicates is carried out.

 

--report-duplicates-severity = info|warning|inconsistency|error

Specifies whether the detected duplicate facts should be reported as errors or warnings. If they are reported as errors, then the XBRL validation of the instance will fail. The default is error.

 

--requires-element-checks = true|false

Enables reporting of requires-element inconsistencies. The default value is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--schema-imports = load-by-schemalocation | load-preferring-schemalocation | load-by-namespace | load-combining-both | license-namespace-only

Specifies the behaviour of xs:import elements, each of which has an optional namespace attribute and an optional schemaLocation attribute: <import namespace="someNS" schemaLocation="someURL">. The option specifies whether to load a schema document or just license a namespace, and, if a schema document is to be loaded, which information should be used to find it. Default: load-preferring-schemalocation.

The behavior is as follows:

 

load-by-schemalocation: The value of the schemaLocation attribute is used to locate the schema, taking account of catalog mappings. If the namespace attribute is present, the namespace is imported (licensed).
load-preferring-schemalocation: If the schemaLocation attribute is present, it is used, taking account of catalog mappings. If no schemaLocation attribute is present, then the value of the namespace attribute is used via a catalog mapping. This is the default value.
load-by-namespace: The value of the namespace attribute is used to locate the schema via a catalog mapping.
load-combining-both: If either the namespace or schemaLocation attribute has a catalog mapping, then the mapping is used. If both have catalog mappings, then the value of the --schema-mapping option (XBRL option and XML/XSD option) decides which mapping is used. If no catalog mapping is present, the schemaLocation attribute is used.
license-namespace-only: The namespace is imported. No schema document is imported.

 

--schema-mapping = prefer-schemalocation | prefer-namespace

If  schema location and  namespace are both used to find a  schema document, specifies which  of them should  be preferred during catalog lookup. (If either the --schemalocation-hints or the --schema-imports option has a value of load-combining-both, and if the namespace and URL parts involved both have catalog mappings, then the value of this option specifies which of the two mappings to use (namespace mapping or URL mapping; the prefer-schemalocation value refers to the URL mapping).) Default is prefer-schemalocation.

 

--schemalocation-hints = load-by-schemalocation | load-by-namespace | load-combining-both | ignore

Specifies the behavior of the xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes: Whether to load a schema document, and, if yes, which information should be used to find it. Default: load-by-schemalocation.

 

The load-by-schemalocation value uses the URL of the schema location in the xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes in XML or XBRL instance documents. This is the default value.
The load-by-namespace value takes the namespace part of xsi:schemaLocation and an empty string in the case of xsi:noNamespaceSchemaLocation and locates the schema via a catalog mapping.
If load-combining-both is used and if either the namespace part or the URL part has a catalog mapping, then the catalog mapping is used. If both have catalog mappings, then the value of the --schema-mapping option (XBRL option and XML/XSD option) decides which mapping is used. If neither the namespace nor URL has a catalog mapping, the URL is used.
If the option's value is ignore, then the xsi:schemaLocation and xsi:noNamespaceSchemaLocation attributes are both ignored.

 

--script = FILE

Executes the Python script in the submitted file after validation has been completed. Add the option multiple times to specify more than one script.

 

--api, --script-api-version = 1|2|2.1|2.2|2.3|2.4|2.4.1|2.5|2.6|2.7

Specifies the Python API version to be used for the script. The default value is the latest version, currently 2.7. Instead of the values 1 and 2, you can also use the values 1.0 and 2.0, respectively.

 

--script-output = FILE

Writes the script's standard output to the file named in FILE.

 

--script-param = KEY:VALUE

Additional user-specified parameters that can be accessed during the execution of Python scripts. Add the option multiple times to specify more than one script parameter.

 

--summation-item-checks = true|false

Enables reporting of summation-item inconsistencies. The default value is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--taxonomy-package = FILE

Specifies the absolute path to an additional taxonomy package as described in the Taxonomy Package 1.0 and Taxonomy Packages 1.0 working drafts. The value of FILE gives the location of the taxonomy package. Add the option multiple times to specify more than one taxonomy package.

 

--taxonomy-packages-config-file = FILE

Specifies the path to the TaxonomyPackagesConfig.json file, which is used to load XBRL taxonomy packages. The file's convenience is that it serves as a catalog of taxonomy packages. The structure of the JSON file is as in the example listing below. The value of the uri key gives the location of the package. The active key (of a set of packages) switches on usage of those packages.

 

{"taxonomies":

  {"EIOPA Solvency II XBRL Taxonomy 2.1.0":

    {"packages":[

      {"uri":"C:\\test\\XBRL\\EIOPA_SolvencyII_XBRL_Taxonomy_2.1.0.zip"},

      {"uri":"C:\\test\\XBRL\\AdditionalTestPkg.zip"}

      ],"active":true

    },"Test Taxonomy":

      {"packages":[{"uri":"C:\\test\\XBRL\\test.zip"}],"active":true

      }

  }

}

 

--treat-inconsistencies-as-errors = true|false

Causes XBRL validation to fail if the file contains any inconsistency as defined by the XBRL 2.1 specification. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--utr = true|false

If true, enables the XBRL Unit Registry 1.0 extension. Default is: false.

 

--utr-file = FILE

Specifies the path to the Units Registry file. The default is: http://www.xbrl.org/utr/utr.xml.

 

--utr-status = PWD|CR|REC|NIE|PROPOSED|IWD|ACK|RR

Enables support of unit definitions with the given status in the Units Registry. Add the option multiple times to specify more than one unit status. Default is REC.

 

--validate-dts-only = true|false

The DTS is discovered by starting from the XBRL instance document. All referenced taxonomy schemas and linkbases are discovered and validated. The rest of the XBRL instance document is ignored. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--xinclude = true|false

Enables XML Inclusions (XInclude) support. Default value is false. When false, XInclude's include elements are ignored.

Note:   Boolean option values are set to true if the option is specified without a value.

 

 

Click to expand/collapseXBRL formulas and assertions

--assertion-severity = true|false

Enables the Assertion Severity 1.0 extension. Default is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--assertions-output = FILE

Writes the output of the assertion evaluation to the specified FILE. If set, automatically specifies --formula-execution=true.

 

--assertions-output-format = json|xml

Specifies the output format of the assertion evaluation. Default is json.

 

--evaluate-referenced-parameters-only = true|false

If false, forces evaluation of all parameters even if they are not referenced by any formulas/assertions/tables. Default is: true.

 

--formula = true|false

Enables the XBRL Formula 1.0 extension. Default is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--formula-assertion-set = VALUE

Limits formula execution to the given assertion set only. Add the option multiple times to specify more than one assertion set. Short form is --as. The VALUE is either the value of the @id attribute, or a URI with an XPointer fragment that identifies the resource. The special values ##none and ##all can also be used.

 

--formula-execution = true|false

Enables evaluation of XBRL formulas. Default is true. If true, automatically specifies --formula=true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--formula-output = FILE

Writes the output of formula evaluation to the specified FILE. If set, automatically specifies --formula-execution=true.

 

--formula-parameters = JSON-ARRAY

Specifies parameters for XBRL formula evaluation as array of JSON maps directly on the CLI. See the section Formula Parameters for details.

 

--formula-parameters-file = FILE

Specifies a FILE containing the parameters for XBRL formula evaluation. The file can be either an XML file or JSON file. See the section, Formula Parameters.

--ignore-assertion = VALUE

Excludes the given assertion from the execution. Add this option

multiple times to specify more than one assertion.

 

--ignore-assertions-file = FILE

Specifies a path to a file that contains a list of IDs/XPointers of assertions to exclude from processing. In the file, enter one assertion per line.

 

--ignore-formula = VALUE

Excludes the given formula from the execution. Add this option

multiple times to specify more than one formula.

 

--ignore-formulas-file = FILE

Specifies a path to a file that contains a list of formula IDs/XPointers to exclude from processing. In the file, enter one formula per line.

 

--message-lang = VALUE

Specifies the language to use when displaying validation messages. Default is: en. Other accepted values are de, es, fr, ja, for, respectively, German, Spanish, French, and Japanese.

 

--message-role = VALUE

Specifies the preferred message role to use when displaying validation messages. Default is: http://www.xbrl.org/2010/role/message.

 

--preload-formula-schemas = true|false

Preloads schemas of the XBRL Formula 1.0 specification. Default is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--a | --process-assertion = VALUE

Limits formula execution to the given assertion only. Add the option multiple times to specify more than one assertion. Short form is --a. The VALUE is either the value of the @id attribute, or a URI with an XPointer fragment that identifies the resource. The special values ##none and ##all can also be used.

 

--as | --process-assertion-set = VALUE

Limits formula execution to the given assertion set only. Add the option multiple times to specify more than one assertion set. Short form is --as. The VALUE is either the value of the @id attribute, or a URI with an XPointer fragment that identifies the resource. The special values ##none and ##all can also be used.

 

--process-assertions-file = FILE

Specifies a path to a file that contains a list of IDs/XPointers of assertions to execute. In the file, enter one assertion per line.

 

--f | --process-formula = VALUE

Limits formula execution to the given formula only. Add the option multiple times to specify more than one formula. Short form is --f. The VALUE is either the value of the @id attribute, or a URI with an XPointer fragment that identifies the resource. The special values ##none and ##all can also be used.

 

--process-formulas-file = FILE

Specifies a path to a file that contains a list of IDs/XPointers of formulas to execute. In the file, enter one formula per line.

 

--report-unsatisfied-assertion-evaluations = true|false

Reports the evaluation of unsatisfied assertion as errors or warnings depending on the assigned assertion severity level. The default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--validate-formula-output = true|false

Enables XBRL validation of Formula output instance. The default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--variableset-execution-timeout = VALUE

Applied when executing formulas (--formula-execution=true). Specifies the maximum time allowed for executing a single variable set (a formula or a value, or an existence or consistency assertion). The time is specified in minutes and must be a positive number. The default is 30min. If a particular variable set doesn’t finish execution before the timeout is reached, then it is aborted. An error message is displayed (and entered in the a verbose log). Note, however, that the timeout check is carried out only after every variable set evaluation—and not during execution of individual XPath expressions. So, if a single XPath expression takes long to execute, the timeout limit might be crossed. Execution of a variable set is aborted only once a complete variable set evaluation has been executed.

 

 

Click to expand/collapseXBRL tables

--aspect-node-order = lexical|instance

Specifies the layout order of an open aspectNode. The default is lexical.

 

--concept-label-linkrole = VALUE

Specifies the preferred extended link role to use when rendering concept labels.

 

--cconcept-label-role = VALUE

Specifies the preferred label role to use when rendering concept labels. Default is: http://www.xbrl.org/2003/role/label.

 

--generic-label-linkrole = VALUE

Specifies the preferred extended link role to use when rendering generic labels.

 

--generic-label-role = VALUE

Specifies the preferred label role to use when rendering generic labels. Default is: http://www.xbrl.org/2003/role/label.

 

--label-lang = VALUE

Specifies the preferred language to use when rendering labels. Default is: en.

 

--preload-table-schemas = true|false

Preloads schemas of the XBRL Table 1.0 specification. Default is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--t | --process-table = VALUE

Limits formula execution to the given table only. Add the option multiple times to specify more than one table. Short form is --t. The VALUE is either the value of the @id attribute, or a URI with an XPointer fragment that identifies the resource. The special values ##none and ##all can also be used.

 

--table = true|false

Enables the XBRL Table 1.0 extension. Default value is true. If true, automatically specifies --formula=true and --dimensions=true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--table-elimination = true|false

Enables elimination of empty table rows/columns in HTML output. Default is true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--table-execution = true|false

Enables evaluation of XBRL tables. Default is false. Will be set to true if --table-output is specified. If true, automatically specifies --table=true.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--table-linkbase-namespace = 
  ##detect 
  http://xbrl.org/PWD/2013-05-17/table | 

  http://xbrl.org/PWD/2013-08-28/table 
  http://xbrl.org/CR/2013-11-13/table |

  http://xbrl.org/PR/2013-12-18/table |

  http://xbrl.org/2014/table

 

Enables  loading of table linkbases written  with a previous draft specification. Table linkbase validation, resolution, and layout is, however, always performed according to the Table Linkbase 1.0 Recommendation of 18 March 2014. Use ##detect to enable auto-detection.

 

--table-output = FILE

Writes the table output to the specified FILE. If set, automatically specifies --table-execution=true.

 

--table-output-format = xml|html

Specifies the format of the table output. Default is xml.

 

 

Click to expand/collapseCatalogs and global resources

--catalog = FILE

Specifies the absolute path to a root catalog file that is not the installed root catalog file. The default value is the absolute path to the installed root catalog file (<installation-folder>\Altova\RaptorXMLXBRLServer2019\etc\RootCatalog.xml). See the section, XML Catalogs, for information about working with catalogs.

 

--user-catalog = FILE

Specifies the absolute path to an XML catalog to be used in addition to the root catalog. See the section, XML Catalogs, for information about working with catalogs.

 

--enable-globalresources = true|false

Enables global resources. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--gc | --globalresourceconfig = VALUE

Specifies the active configuration of the global resource (and enables global resources).

 

--gr | --globalresourcefile = FILE

Specifies the global resource file (and enables global resources).

 

 

Click to expand/collapseMessages, errors, help, timeout, version

--error-format = text|shortxml|longxml

Specifies the format of the error output. Default value is text. The other options generate XML formats, with longxml generating more detail.

 

--error-limit = N | unlimited

Specifies the error limit with a value range of 1 to 9999 or unlimited. The default value is 100. Processing stops when the error limit is reached. Useful for limiting processor use during validation/transformation.

 

--help

Displays help text for the command. For example, valany --h. (Alternatively the help command can be used with an argument. For example: help valany.)

 

--log-output = FILE

Writes the log output to the specified file URL. Ensure that the CLI has write permission to the output location.

 

--network-timeout = VALUE

Specifies the timeout in seconds for remote I/O operations. Default is: 40.

 

--verbose = true|false

A value of true enables output of additional information during validation. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

--verbose-output = FILE

Writes verbose output to FILE.

 

--version

Displays the version of RaptorXML+XBRL Server. If used with a command, place --version before the command.

 

--warning-limit = N | unlimited

Specifies the warning limit in the range 1-65535 or unlimited. Processing continues if this limit is reached, but further warnings are not reported. The default value is 100.

 

 

 

 


© 2019 Altova GmbH