valxbrlver

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

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

valxbrlver

The valxbrlver command validates one or more XBRL versioning reports according to the XBRL Versioning 1.0 specification.

 

Windows

RaptorXMLXBRL valxbrlver [options] InputFile  

Linux

raptorxmlxbrl valxbrlver [options] InputFile

Mac

raptorxmlxbrl valxbrlver [options] InputFile

 

 

The InputFile argument is the XBRL versioning report, which is an XML document (with a .xml extension). 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).

 

Examples

 

raptorxmlxbrl valxbrlver c:\MyXBRLVersioningReport.xml
raptorxmlxbrl valxbrlver c:\MyXBRLVersioningReports.txt

 

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

 

 

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/collapseXML Schema

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

 

 

Click to expand/collapseMiscellaneous

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

 

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

 

 

 


© 2019 Altova GmbH