Apache UIMA Ruta Guide and Reference - Apache UIMA - The ...

Ruta Engine
1.5.1.2. Configuration Parameters
The configuration parameters of the UIMA Ruta Analysis Engine can be subdivided
into three different groups: parameters for the setup of the environment (mainScript to
additionalExtensions), parameters that change the behavior of the analysis engine (reloadScript to
simpleGreedyForComposed) and parameters for creating additional information how the rules were
executed (debug to createdBy). First, a short overview of the configuration parameters is given in
Table 1.1, “Configuration parameters of the UIMA Ruta Analysis Engine ” [11]. Afterwards,
all parameters are described in detail with examples.
To change the value of any configuration parameter within a UIMA Ruta script, the
CONFIGURE action (see Section 2.7.8, “CONFIGURE” [42]) can be used. For changing
behaviour of dynamicAnchoring the DYNAMICANCHORING action (see Section 2.7.11,
“DYNAMICANCHORING” [43]) is recommended.
Table 1.1. Configuration parameters of the UIMA Ruta Analysis Engine
Name Short description Type
mainScript Name with complete namespace of the script
which will be interpreted and executed by the
analysis engine.
Single String
scriptEncoding Encoding of all UIMA Ruta script files. Single String
scriptPaths List of absolute locations, which contain the
necessary script files like the main script.
descriptorPaths List of absolute locations, which contain the
necessary descriptor files like type systems.
resourcePaths List of absolute locations, which contain the
necessary resource files like word lists.
additionalScripts List of names with complete namespace of
additional scripts, which can be referred to.
additionalEngines List of names with complete namespace of
additional analysis engines, which can be
called by UIMA Ruta rules.
additionalEngineLoaders List of class names of implementations that are
able to perform additional task when loading
external analysis engines.
additionalExtensions List of factory classes for additional extensions
of the UIMA Ruta language like proprietary
conditions.
reloadScript Option to initialize the rule script each time the
analysis engine processes a CAS.
seeders List of class names that provide additional
annotations before the rules are executed.
defaultFilteredTypes List of complete type names of annotations that
are invisible by default.
Multi String
Multi String
Multi String
Multi String
Multi String
Multi String
Multi String
Single Boolean
Multi String
Multi String
UIMA Ruta Version 2.0.1 Apache UIMA Ruta Overview 11