Altova RaptorXML+XBRL Server 2022

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Command Line Interface (CLI) > XSLT Commands

valxslt

Scroll Home Prev Top Next More

The valxslt command takes an XSLT file as its single argument and validates it.

raptorxmlxbrl valxslt [options] XSLT-File

•The XSLT-File argument is the path and name of the XSLT file to be validated.

•Validation can be according to the XSLT 1.0, 2.0, or 3.0 specification. By default XSLT 3.0 is the specification used.

Examples

Examples of the valxslt command:

•raptorxmlxbrl valxslt c:\Test.xslt

•raptorxmlxbrl valxslt --xslt-version=2 c:\Test.xslt

Casing and slashes on the command line

RaptorXMLXBRL (and RaptorXMLXBRLServer for administration commands) on Windows

raptorxmlxbrl (and raptorxmlxbrlserver for administration commands) on Windows and Unix (Linux, Mac)

* Note that lowercase (raptorxmlxbrl and raptorxmlxbrlserver) 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.

Backslashes, spaces, and special characters on Windows systems

On Windows systems: When spaces or special characters occur in strings (for example in file or folder names, or company, person or product names), use quotes: for example, "My File". Note, however, that a backslash followed by a double-quotation mark (for example, "C:\My directory\") might not be read correctly. This is because the backslash character is also used to indicate the start of an escape sequence, and the escape sequence \" stands for the double-quotation mark character. If you want to escape this sequence of characters, use a preceding backslash, like this: \\". To summarize: If you need to write a file path that contains spaces or an end backslash, write it like this: "C:\My Directory\\".

Options

Options are listed in short form (if available) and long form. You can use one or two dashes for both short and long forms. An option may or may not take a value. If it takes a value, it is written like this: --option=value. 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. If an option takes a Boolean value and no value is specified, then the option's default value is TRUE. Use the --h, --help option to display information about the command.

XSLT processing

initial-mode, template-mode

--initial-mode, --template-mode = VALUE

Specifies the template mode to use for the transformation.

initial-template, template-entry-point

--initial-template, --template-entry-point = VALUE

Gives the name of a named template in the XSLT stylesheet that is the entry point of the transformation.

xslt-version

--xslt-version = 1|1.0|2|2.0|3|3.0|3.1

Specifies whether the XSLT processor should use XSLT 1.0, XSLT 2.0, or XSLT 3.0. Default value is 3.

XML Schema and XML instance

load-xml-with-psvi

--load-xml-with-psvi = true|false

Enables validation of input XML files and generates post-schema-validation information for them. Default is: true.

schema-imports

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

schemalocation-hints

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

schema-mapping

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

xinclude

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

xml-mode

--xml-mode = wf|id|valid

Specifies the XML processing mode to use for the XML instance document: wf=wellformed check; id=wellformed with ID/IDREF checks; valid=validation. Default value is wf. Note that a value of valid requires that each instance document loaded during processing references a DTD. If no DTD exists, an error is reported.

xml-mode-for-schemas

--xml-mode-for-schemas = wf|id|valid

Specifies the XML processing mode to use for XML schema documents: wf=wellformed check; id=wellformed with ID/IDREF checks; valid=validation. Default value is wf. Note that a value of valid requires that each schema document loaded during processing references a DTD. If no DTD exists, an error is reported.

xpath-static-type-errors-as-warnings

--xpath-static-type-errors-as-warnings = true|false

If true, downgrades to warnings any type errors that are detected in the XPath static context. Whereas an error would cause the execution to fail, a warning would enable processing to continue. Default is false.

xsd-version

--xsd-version = 1.0|1.1|detect

Specifies the W3C Schema Definition Language (XSD) version to use. Default is 1.0. This option can also be useful to find out in what ways a schema which is 1.0-compatible is not 1.1-compatible. The detect option is an Altova-specific feature. It enables the version of the XML Schema document (1.0 or 1.1) to be detected by reading the value of the vc:minVersion attribute of the document's <xs:schema> element. If the value of the @vc:minVersion attribute is 1.1, the schema is detected as being version 1.1. For any other value, or if the @vc:minVersion attribute is absent, the schema is detected as being version 1.0.

Catalogs and global resources

catalog

--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\RaptorXMLXBRLServer2022\etc\RootCatalog.xml). See the section, XML Catalogs, for information about working with catalogs.

user-catalog

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

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

globalresourceconfig [gc]

--gc | --globalresourceconfig = VALUE

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

globalresourcefile [gr]

--gr | --globalresourcefile = FILE

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

Extensions

These options define the handling of special extension functions that are available in a number of Enterprise-level Altova products (such as XMLSpy Enterprise Edition). Their use is described in the user manuals of these products.

chartext-disable

--chartext-disable = true|false

Disables chart extensions. Default value is false.

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

dotnetext-disable

--dotnetext-disable = true|false

Disables .NET extensions. Default value is false.

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

jvm-location

--jvm-location = FILE

FILE specifies the location of the Java Virtual Machine (DLL on Windows, shared object on Linux). The JVM is needed if you use Java extension functions in your XSLT/XQuery code. Default is false.

javaext-barcode-location

--javaext-barcode-location = FILE

Specifies the path to the folder that contains the barcode extension file AltovaBarcodeExtension.jar. The path must be given in one of the following forms:

•A file URI, for example: --javaext-barcode-location="file:///C:/Program Files/Altova/RaptorXMLXBRLServer2022/etc/jar/"

•A Windows path with backslashes escaped, for example: --javaext-barcode-location="C:\\Program Files\\Altova\\RaptorXMLXBRLServer2022\\etc\\jar\\"

javaext-disable

--javaext-disable = true|false

Disables Java extensions. Default value is false.

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

Messages, errors, help, timeout, version

error-format

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

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

info-limit

--info-limit = N | unlimited

Specifies the information message limit in the range 1-65535 or unlimited. Processing continues if the specified info limit is reached, but further messages are not reported. The default value is 100.

help

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

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

--network-timeout = VALUE

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

verbose

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

--verbose-output = FILE

Writes verbose output to FILE.

version

--version

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

warning-limit

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

Please enable JavaScript to view this site.

Altova RaptorXML+XBRL Server 2022

Examples

Options