Altova StyleVision Server 2024

If you will be running multiple transformations to PDF, especially of large documents, you might want to use AltovaFOPServer to carry out the job faster. The increase in job speed occurs because AltovaFOPServer keeps the Java VM and FOP jar files loaded, thus saving the time required to load these files for each transformation. AltovaFOPServer will be installed with your StyleVision package. To use it for transformations, you must first start AltovaFOPServer via the command line.

Start AltovaFOPServer

The syntax of the command to start AltovaFOPServer is:

java -cp "{classPath}" {className} --pid "{pidFile} --port {portNumbers}

An example CLI command to start AltovaFOPServer:

java -cp "C:\Program Files\Altova\Common2024\jar\gson\gson.jar;C:\Program Files\Altova\Common2024\jar\AltovaFOPServer.jar" com.altova.stylevision.fopserver.Main --pid "C:\Users\user\AppData\Local\Temp\AltovaFopServer.pid" --port 9090-9103,9999

The classPath argument must contain the paths to the gson.jar and AltovaFOPServer.jar files. Enter the correct locations of these files.

Call AltovaFOPServer in StyleVision Server

After the AltovaFOPServer has been started, you can call it from StyleVision Server by using the generate command with either the altova-fopserver-pid-file or altova-fopserver-port option (see Options below).

StyleVisionServer on Windows

stylevisionserver on Windows and Unix (Linux, Mac)

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

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

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

--xml, --inputxml = PathToXMLFile

This option is mandatory. It specifies the path to the XML file to process. The XML file can be located inside or outside the PXF file. To target XML files inside a PXF file, use the |zip locator (see the highlighted part in the examples above). The --inputxml option is ignored if the main schema source of the input PXF is a DB or DB-XML.

--dbw, --dbwhere = WHEREClause

An SQL WHERE clause that determines what rows of a DB-XML source to process.

--p, --param = \$ParamName:ParamValue

Assigns a value to a parameter defined in the PXF file. The --param switch must be used before each parameter. Use quotes if ParamName or ParamValue contains a space. Example: --p=\$company:"Nanonull Inc"

--prohibit-output-outside-target-folder = true|false

Values are true|false. If true, does not allow the creation of output in any folder other than that in which the main output file (HTML, PDF, RTF, DOCX, FO) is created. This provides protection for other folders if needed. Default is false.

--html, --outhtml = FilePath

Path to the HTML file to generate.

--pdf, --outpdf = FilePath

Path to the PDF file to generate.

--rtf, --outrtf = FilePath

Path to the RTF file to generate.

--docx, --outdocx = FilePath

Path to the DOCX  file to generate.

--text, --outtext = FilePath

Path to the Text  file to generate.

--fo, --outfo = FilePath

Path to the FO file to generate.

--generate-html-output-as-mime = true|false

Values are true|false. If the option is not specified, default is false, if specified with no value, then true. If true, HTML output is generated as a mime stream.

--altova-fopserver-pid-file = PathToFile

The path to the PID file to use for connecting to a running AltovaFOPServer. You can connect to AltovaFOPServer via either the server's PID file or a port. This PID option is an alternative to the port option (see next option). For more information about using AltovaFOPServer, see the general description of the generate command above.

--altova-fopserver-port = Value

A port number or a list of port numbers to use for connecting to a running AltovaFOPServer. The port numbers in a list are separated by commas. Instead of a single number in the list, you can use a range. So you can submit 9090-9100,9999 as the value of this option. Note that you can connect to AltovaFOPServer via either the AltovaFOPServer's PID file or a port. This port option is an alternative to the PID option (see previous option). For more information about using AltovaFOPServer, see the general description of the generate command above.

--taxonomy-package = FilePath

Path to an additional taxonomy package. Add the option multiple times to specify more than one taxonomy package.

--taxonomy-packages-config-file = FilePath

Path to the TaxonomyPackagesConfig.json file, which is a common file used by the Altova products XMLSpy, MapForce, and StyleVision to configure XBRL taxonomies for use across these products.

--v, --verbose = true|false

Values are true|false. Turns the display of all messages, respectively, on or off. Default is false if the option is not provided, true if provided without a value.

--l, --lang = en|de|es|fr|ja

The language used for displaying messages.