|
A
complex data type that represents the environment options for the
invokeDDX operation
and
the
invokeDDXOneDocument operation
operations
of the Assembler service. The data items include the default font
to use, the logging level, and flags that specify how the operation
will behave when an error occurs.
For information about data that can be accessed using Xpath Expressions,
see
Data items
.
For information about configuring default properties, see
Datatype specific settings
.
Data items
The data items that
AssemblerOptionSpec
variables
contain.
defaultStyle
A
string
value
that represents the default font style to use when none is specified
in the DDX. The font style is the same format as the font attribute
for DDX rich text elements:
"font: <font-style> <font-weight> <font-size>/<line-height> <font-family-specifier>"
.
If the
<font-family-specifier>
contains any
spaces, it should be surrounded by single quotation marks. For example,
use
'Minion Pro'
. If no default is specified, a
default of
"font: normal normal 12pt 'Minion Pro'"
is used.
failOnError
A
boolean
value
that specifies whether the operation stops executing immediately
when an error occurs. A value of
true
means that
the job is canceled when an error occurs. A value of
False
means
that when an error occurs, the operation continues to execute.
firstBatesNumber
The
first
numeric
value for the first Bates number
pattern on the first page, if the start value is not specified.
The default for all other Bates number patterns is 1.
logLevel
A
string
value
that specifies the logging level. The value can be either an integer
or its equivalent string value. The default setting for the logging
level is INFO.
|
String value
|
Integer
|
Description
|
|
OFF
|
positive infinity
|
Turn off logging of messages on the server.
|
|
SEVERE
|
1000
|
Log only messages that indicate a serious
failure.
|
|
WARNING
|
900
|
Log only messages that indicate a potential
problem.
|
|
INFO
|
800
|
Log only informational messages.
|
|
CONFIG
|
700
|
Log only static configuration messages.
|
|
FINE
|
500
|
Log tracing information.
|
|
FINER
|
400
|
Log fairly detailed tracing information.
|
|
FINEST
|
300
|
Log highly detailed tracing information.
|
|
ALL
|
negative infinity
|
Log all information.
|
Note:
The FINE, FINER, and FINEST
settings should be used only when investigating specific problems
because of their negative effect on performance.
validateOnly
A
boolean
value
that specifies whether the operation is a validation-only test. In
a validation-only test, the Assembler service only validates the
DDX file but does not execute it. A value of
true
means
that the operation is a validation-only test. A value of
false
means
that the DDX file will be executed.
Datatype specific settings
Environment properties for the invokeDDX and invokeOneDocument
operations.
Job Log Level
A
string
value
that specifies the type of message logging. These are valid string
values:
-
OFF:
-
Messages are not logged.
-
SEVERE:
-
Only the messages that indicate a serious failure are logged.
-
WARNING:
-
Only the messages that indicate a potential problem are logged.
-
INFO:
-
Only the informational messages are logged.
-
CONFIG:
-
Only the static configuration messages are logged.
-
FINE:
-
Tracing information is logged.
-
FINER:
-
Fairly detailed tracing information is logged.
-
FINEST:
-
Highly detailed tracing information is logged.
The
default value is INFO.
Validate Only
Determines whether this is a validation-only operation.
When selected, the operation will only test the DDX file for validity,
not execute it.
Fail On Error
Determines whether the operation is cancelled
when an error occurs. When selected, the operation stops executing
when an error occurs.
This option is selected by default.
Default Style
The default font style to use when none is specified
in the DDX file.
First Bates Number
The first
numeric
value
for the first Bates number pattern on the first page, if the start
value is not specified.
|
|
|
