The <global> element

The global input element of the configuration file contains properties defining global configuration options.

Attribute

Applies to

Values

Effect

allowExternalFunctions

HE PE EE

true|false

True if calls to external Java or .NET functions are allowed.

allowMultiThreading

EE

true|false

True if saxon:threads attribute on xsl:for-each causes multi-threading under Saxon-EE; false to disable multi-threading. Default is true (but multi-threading only happens if explicitly requested using saxon:threads).

allowOldJavaUriFormat

PE EE

true|false

True if reflexive calls to external Java functions are allowed to use the "liberal" syntax (for example "http://my.com/extensions/ java.util.Date"). The default is to allow only the "strict" form of URI such as "java:java.util.Date".

allowSyntaxExtensions

PE EE

true|false

Enables use of (experimental and non-conformant) extensions to XPath syntax.

collationUriResolver

HE PE EE

Name of a class implementing CollationURIResolver

User-supplied class used to interpret collation URIs.

collectionFinder

HE PE EE

Name of a class implementing CollectionFinder

User-supplied class used for retrieving the ResourceCollection to resolve the URI supplied to the collection() function.

collectionUriResolver

HE PE EE

Name of a class implementing CollectionURIResolver

User-supplied class used for resolving the URI supplied to the collection() function.

compileWithTracing

HE PE EE

true|false

Generates trace code in the expression tree, allowing a TraceListener to be used at run-time.

debugByteCode

EE

true|false

Causes bytecode generation to be run in debugging mode, for use when diagnosing a problem. Only to be used if requested by Saxonica support.

debugByteCodeDirectory

EE

A directory name

Identifies the directory for output files produced when displayByteCode is set to true.

defaultCollation

HE PE EE

Absolute URI (collation URI)

(Requires Saxon-PE.) The collation URI to be used when no explicit collation is requested.

defaultCollection

HE PE EE

Absolute URI (collection URI)

The collection URI to be used when no argument is passed to the collection() function.

defaultRegexEngine

HE PE EE

string ("S" for Saxon, "J" for Java, "N" for .NET)

Determines which regular expression engine should be used for evaluating regular expressions.

displayByteCode

EE

true|false

Causes files containing a human-readable print of the generated bytecode to be output, to the directory identified by the debugByteCodeDir option.

dtdValidation

HE PE EE

true|false

Controls whether DTD validation is applied to input files.

dtdValidationRecoverable

HE PE EE

true|false

Controls whether DTD validation errors are recoverable or fatal.

eagerEvaluation

HE PE EE

true|false

Forces Saxon to do eager evaluation of expressions in contexts where normally it would do lazy evaluation, for example when evaluating variables and function results. This can make for easier debugging.

entityResolver

HE PE EE

Name of a class implementing org.xml.sax.EntityResolver

The class used whenever Saxon creates an XMLReader for parsing source documents.

environmentVariableResolver

HE PE EE

Name of a class implementing EnvironmentVariableResolver

Defines the environment variable resolver for all queries and transforms using this configuration. This affects the result of the XPath functions available-environment-variables() and environment-variable().

errorListener

HE PE EE

Name of a class implementing org.xml.sax.ErrorListener

Defines the default ErrorListener for reporting both compile-time and run-time errors.

expandAttributeDefaults

HE PE EE

true|false

Controls whether attribute default values found in a DTD or schema are expanded or not.

generateByteCode

EE

true|false

By default, Saxon-EE attempts to generate Java bytecode for evaluation of certain parts of a query or stylesheet. Setting this option to false disables this.

ignoreSAXSourceParser

HE PE EE

true|false

Set to true to ignore the XMLReader supplied as a SAXSource as input to an XSLT transformation, to use one specified by the parser option instead.

lazyConstructionMode

HE PE EE

true|false

If true, causes temporary trees to be constructed lazily.

lineNumbering

HE PE EE

true|false

Controls whether line and column number information is maintained for input files.

markDefaultedAttributes

HE PE EE

true|false

Indicates that Saxon should retain the fact that attributes are derived from defaults defined in a schema or DTD where this information is available from the XML parser.

maxCompiledClasses

EE

integer

Places a limit on the number of classes for which Saxon will generate bytecode.

monitorHotSpotByteCode

EE

true|false

Enables monitoring of hot-spot byte-code generation.

optimizationLevel

HE PE EE

string of flags or 0

Defines the level of code optimization to be applied.

parser

HE PE EE

Name of a class that implements either the org.xml.sax.XMLReader or javax.xml.parsers. SAXParserFactory interface

XML parser used for source documents.

preEvaluateDoc

HE PE EE

true|false

If true, allows calls on doc() with a literal argument to be evaluated early, at compile time.

preferJaxpParser

HE PE EE

true|false

Relevant only on .NET, determines whether the Java Classpath parser is used in preference to the Microsoft .NET parser.

recognizeUriQueryParameters

HE PE EE

true|false

If true, and the standard URIResolver is in use, query parameters such as val=strict will be recognized on URIs supplied to the doc() or document() functions.

regexBacktrackingLimit

HE PE EE

integer

Sets a limit on the amount of backtracking performed during regular expression evaluation.

schemaValidation

EE

strict|lax|preserve|strip

Controls whether schema validation is applied to input files.

serializerFactory

HE PE EE

Name of a class that implements SerializerFactory

Allows the serialization pipeline to be customized, for example to handle user-defined serialization parameters.

sourceResolver

HE PE EE

Name of a class implementing the SourceResolver interface

Name of a user-supplied class that resolves unknown implementations of the JAXP Source class into a known implementation.

stableCollectionUri

HE PE EE

true|false

Indicates that collections read using the fn:collection() function are to be stable, that is, repeated calls with the same collection URI return identical results.

stableUnparsedText

HE PE EE

true|false

Indicates that unparsed text files read using functions such as fn:unparsed-text(), function are to be stable, that is, repeated calls with the same URI return identical results.

standardErrorOutputFile

HE PE EE

A file name

Redirects output which would otherwise go to the stardard error output stream System.err, to this file.

streamability

EE

off|standard

Determines the test applied to see if constructs are streamable (if streaming is requested).

streamingFallback

HE PE EE

true|false

If true, then constructs for which streaming is requested will be exectued in non-streaming mode if the code is not actually streamable.

stripSpace

HE PE EE

all|none|ignorable

Controls what whitespace is removed from input documents (all inter-element whitespace, no inter-element whitespace, or all inter-element whitespace in elements having element-only content models).

styleParser

HE PE EE

Name of a class implementing the org.xml.sax.XMLReader interface

XML parser used for stylesheets and schema documents.

suppressEvaluationExpiryWarning

PE EE

true|false

Suppresses the warning issued to indicate that an evaluation license in use is due to expire.

suppressXPathWarnings

HE PE EE

true|false

Suppresses all warnings issued by the XPath and XQuery parsers.

suppressXsltNamespaceCheck

HE PE EE

true|false

Suppresses the warning when there is no commonality between the namespaces used in stylesheet match patterns and the namespaces used in the source document.

timing

HE PE EE

true|false

Outputs progress messages to System.err. Equivalent to the -t option on the command line.

traceExternalFunctions

PE EE

true|false

Provides diagnostics when external functions are dynamically loaded.

traceListener

HE PE EE

Name of a class implementing TraceListener

User-defined class to be used for handling run-time trace output.

traceListenerOutputFile

HE PE EE

string (file name)

Supplies a file as destination for trace listener output.

traceOptimizerDecisions

PE EE

true|false

Causes tracing of decisions made by the optimizer.

treeModel

HE PE EE

linkedTree|tinyTree| tinyTreeCondensed

Determines the tree model implementation used for input files: TinyTree, LinkedTree, or TinyTree(condensed).

unparsedTextURIResolver

HE PE EE

Name of a class implementing the UnparsedTextURIResolver interface

The class name of the UnparsedTextURIResolver to be used for deferencing URIs used in calls on fn:unparsed-text() and related functions.

uriResolver

HE PE EE

Name of a class implementing the JAXP javax.xml.transform.URIResolver interface

The URIResolver to be used for deferencing URIs used in xsl:include, xsl:import, doc(), and document().

usePiDisableOutputEscaping

HE PE EE

true|false

When sending output to a user-defined content handler, indicates whether JAXP-defined processing instructions are used to signal the start and end of text in which output escaping is disabled.

useTypedValueCache

EE

true|false

If true, typed values of element and attribute nodes are cached in the TinyTree. Uses extra memory, may make execution faster.

validationComments

EE

true|false

Only relevant when validationWarnings=true, indicates that validation error messages should where possible be added as comments in the document instance being validated rather than fatal errors.

validationWarnings

EE

true|false

For result trees subjected to schema validation, indicates whether validation failures should be treated as warnings rather than fatal errors.

versionOfXml

HE PE EE

1.0|1.1

Determines whether XML 1.0 or XML 1.1 rules are used for names. (1.0 means the rules before Edition 5.)

xInclude

HE PE EE

true|false

Controls whether XInclude processing is applied to input files.

xpathVersionForXsd

EE

integer

Defines what version of the XPath language may be used in XML Schema 1.1 assertions and type alternatives.

xpathVersionForXslt

HE PE EE

integer

Defines what version of the XPath language may be used in XSLT 3.0 stylesheets.