XF Rendering Server comes with a family of command line tools that can be used for high-speed rendering of XSL-FO into PDF, Postscript, AFP, and any other format supported by Ultrascale.

 

The tools are:

 

 

The Render tools use a unified command line that is presented below (the URender.NET version):

 

 

The parameters correspond to the members of the RenderingParameters class:

 

remoteserver - sets the Server rendering parameter

serverport - sets the ServerPort rendering parameter

merge - specifies whether this is a merge context

logfile - sets the log file

loglevel - sets the log level

retryfailedrequests - specifies whether or not to retry a request if the document failed processing

requesttimeout - sets the timeout for a request

resolution - sets both the XResolution and YResolution rendering parameters

pageidx - the page index to render; meaningful only for JPEG / GIF / PNG / SVG output

afpconverttograyscale - sets the ConvertColorsToGrayscale flag in the AFPOutputFlags rendering parameter

useresolverthread (obsolete) - sets the UseResolverThread rendering parameter

referenceresolvertype - specifies options for resolving references(page-number-citation, page-number etc.)

preloaddocument - preload the document before rendering. With this flag enabled, the whole document will be loaded in memory and the XSL-FO engine will be more permissive with static contents placement

imageerrors - sets the image errors handling mode (throw exception, ignore or show stock image)

encodercompressiontype - sets the compression type use by the encoder

smoothingmode - specifies the type of smoothing (antialiasing) that is applied to images

zoom - sets the zoom

username - sets the UserName rendering parameter

password - sets the Password rendering parameter

servertemplateid - when specified, it will cause the engine to run a server transformation. Input data must be XML.

template - when specified, it will cause the engine to run a local transformation. Input data must be XML. Equivalent with specifying -xsl <file_name>

xsltparameters - pairs of name and values that must be passed to the XSL transformation. It has the form (param1,value1)(param2,value2) and so on.

xsltengine - sets the XSL transformation engine to use for a local transformation. Can be MSXML, DOTNET20 or SAXON (all are case insensitive).

languageid - translation id (when using XFD templates with one or more translations specified)

pdfconformance - sets the conformance level as specified by the PDFOutputFlags rendering parameter (the valid values in command line are PDF1.4, PDF_X, PDFA_1A, PDFA_1B)

pdfpermissions - manually specify output PDF permissions via the PDFOutputPermissionFlags rendering parameter; use comma as separator when specifying multiple values (valid values are listed here). By default everything is allowed, but if you specify at least one value, only the permissions you give will be granted; note this does not have any effect if pdfuserpassword and pdfownerpassword are not set

pdfuserpassword - sets the PDFUserPassword rendering parameter

pdfownerpassword - sets the PDFOwnerPassword rendering parameter

pdfimagecompression - sets the type of image compression used by the PDF renderer (JPEG or FLAT)

pdfencryptionstrength - sets the PDFEncryptionStrength rendering parameter

printername - specifies the printer name and it applies only when direct printing

outputprintfile - specifies the name of a PCL output file

inputtray - specifies the input tray from which the printer selects the paper source

outputtray - specifies the printer output tray

copycount - specifies the copy count for a page to be multiplied when printing

duplex - specifies simplex/duplex printing

htmlpagewidth - sets the width of the page when converting from HTML to a paginated format

htmlpageheight - sets the height of the page when converting from HTML to a paginated format

htmlpagemargintop - sets the top margin of the page when converting from HTML to a paginated format

htmlpagemarginleft - sets the left margin of the page when converting from HTML to a paginated format

htmlpagemarginright - sets the right margin of the page when converting from HTML to a paginated format

htmlpagemarginbottom - sets the bottom margin of the page when converting from HTML to a paginated format

htmlpageheadermargin - sets the header extent of the page when converting from HTML to a paginated format

htmlpagefootermargin - sets the footer extent of the page when converting from HTML to a paginated format

htmlshowpagenumber - specifies whether to show page numbers when converting from HTML to a paginated format

htmlshowtitle - specifies whether to show the title when converting from HTML to a paginated format

htmlgeneratehtmltag - specifies to the HTML output engine whether to generate a HTML document or not

htmlusefixedbodywidth - specifies to the HTML output engine whether to preserve the width of the original XSL-FO page body or not

renderedimagesbaseurl - base URL for rasterized vector images saved in the renderedimagesoutputfolder folder; the URL is relative to this folder

renderedimagesoutputfolder - folder to save rasterized vector images

 

 

Simplified Command Line

 

Since Ultrascale version 4.5, the tools have been enhanced to support a simplified command line.

Now it's possible to write:

 

 

URender.NET.exe [-fo|-xml] inFile [-xsl file] [-pdf|-xps|-afp|-xap|-ps|-foout|-tiff|-jpeg|-gif|-png|-svg|-pptx|-wordml] <outFile> [-server] <server> [-port] <port>

 

 

Some usage examples:

 

 

URender.NET.exe -fo sample.fo -xps sample.xps

URender.NET.exe -xml sample.xml -xsl sample.xsl -pdf sample.pdf

URender.NET.exe -fo sample.fo -server 198.162.0.1 -port 2000

URender.NET.exe -xml HelloWorld.xml -xsl HelloWorld.xfd -pdf HelloWorld.pdf -parameters:"merge=true"

URender.NET.exe -xml HelloWorld.xml -xsl HelloWorld.xfd -pdf HelloWorld.pdf -parameters:"copycount=10;duplex=true;inputtray=1;outputtray=2"

URender.NET.exe -fo HelloWorld.fo -pdf HelloWorld.pdf -parameters:"username=user;password=pass"

URender.NET.exe -in SampleDoc.docx -out SampleDoc.ps -parameters:"server=198.162.0.1;serverport=2000"