valavrojson (avrojson)

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

Home >  Command Line Interface (CLI) > JSON/Avro Commands >

valavrojson (avrojson)

The valavrojson | avrojson command validates a JSON document against an Avro schema.

 

Windows

RaptorXMLXBRL valavrojson | avrojson [options] --avroschema=AvroSchema JSONFile

Linux

raptorxmlxbrl valavrojson | avrojson [options] --avroschema=AvroSchema JSONFile

Mac

raptorxmlxbrl valavrojson | avrojson [options] --avroschema=AvroSchema JSONFile

 

 

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

 

 

Examples

 

raptorxmlxbrl valavrojson --avroschema=c:\MyAvroSchema.avsc c:\MyJSONDataFile.json
raptorxmlxbrl avrojson --avroschema=c:\MyAvroSchema.avsc c:\MyJSONDataFile.json

 

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

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

 

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

 

 

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