String toString - Océ | Printing for Professionals

Transcription

Océ | Technical Description
Océ PRISMAtools
Document Designer V1.06 Layout for Advanced Data
...and Training?
For this product we also offer seminars at our
Training Centre in Poing
For information, please contact:
Phone: +49 81 21 72-39 40
Fax:
+49 81 21 72-39 50
Océ Printing Systems GmbH
Siemensallee 2
85581 Poing
Germany
April 2004 Edition
A29247-X89-X-3-7678
Copyright  Océ Printing Systems GmbH 2002, 2003, 2004
All rights reserved, including those of translation into other languages.
No part of this manual may be reproduced by photocopying, reprinting or any other method.
Offenders will be liable for damages. All rights, including rights created by patent grant or
registration of a utility model, are reserved.
Delivery subject to availability, subject to change for technical reasons.
All hardware and software names are trade names of their respective manufacturers.
Table Of Contents
Appendix: Scripting and Methods Syntax..................................................................... 13
Scripting Notes................................................................................................................. 14
Expressions...................................................................................................................... 15
Operators .......................................................................................................................... 16
Arithmetic Operators ....................................................................................................... 17
Boolean Operators........................................................................................................... 18
Comparison Operators.................................................................................................... 19
Assignment Statements .................................................................................................. 20
Functions .......................................................................................................................... 22
Flow Control Conditional Constructs ............................................................................ 23
If, If .. else Statements ..................................................................................................... 24
For Statement ................................................................................................................... 26
While Statement ............................................................................................................... 28
Do While Statement ......................................................................................................... 30
Break Statement............................................................................................................... 31
Continue Statement ......................................................................................................... 32
Goto Statement ................................................................................................................ 33
Return Statement ............................................................................................................. 34
Int ...................................................................................................................................... 35
Int - Int binaryNot ............................................................................................................. 36
A29247-X89-X-3-7678
i
Table Of Contents
Int - Void plus ................................................................................................................... 37
Int - Void minus ................................................................................................................ 38
Int - Void multiply ............................................................................................................. 39
Int - Void divide ................................................................................................................ 40
Int - Void remainder ......................................................................................................... 41
Int - Void binaryOr............................................................................................................ 42
Int - Void binaryXor .......................................................................................................... 43
Int - String toString .......................................................................................................... 44
Int64................................................................................................................................... 45
Int64 - Int64 binaryNot ..................................................................................................... 47
Int64 - Void plus ............................................................................................................... 48
Int64 - Void minus ............................................................................................................ 49
Int64 - Void multiply......................................................................................................... 50
Int64 - Void divide ............................................................................................................ 51
Int64 - Void remainder ..................................................................................................... 52
Int64 - Void binaryOr........................................................................................................ 53
Int64 - Void binaryAnd..................................................................................................... 54
Int64 - Void binaryXor ...................................................................................................... 55
Int64 - String toString ...................................................................................................... 56
Int64 - Void plus (Int) ....................................................................................................... 58
Int64 - Void minus (Int) .................................................................................................... 59
Int64 - Void multiply (Int) ................................................................................................. 60
ii
A29247-X89-X-3-7678
Table Of Contents
Int64 - Void divide (Int) .................................................................................................... 61
Int64 - Void remainder (Int) ............................................................................................. 62
Int64 - Void binaryOr (Int)................................................................................................ 63
Int64 - Void binaryXor (Int) .............................................................................................. 64
Int64 - Int toInt .................................................................................................................. 65
Currency ........................................................................................................................... 66
Currency - Void plus ........................................................................................................ 67
Currency - Void minus..................................................................................................... 68
Currency - Void multiply.................................................................................................. 69
Currency - String toString............................................................................................... 70
Currency - Void plus (Int) ................................................................................................ 72
Currency - Void minus (Int)............................................................................................. 73
Currency - Void multiply (Int).......................................................................................... 74
Currency - Int toInt ........................................................................................................... 75
Currency - Int64 toInt64................................................................................................... 76
Currency - Double toDouble ........................................................................................... 77
Bool ................................................................................................................................... 78
Bool - booleanNot ............................................................................................................ 79
Bool - boolean Or2 ........................................................................................................... 80
Bool - boolean And2 ........................................................................................................ 81
Bool - boolean Xor2 ......................................................................................................... 82
Bool - String toString....................................................................................................... 83
A29247-X89-X-3-7678
iii
Table Of Contents
Double ............................................................................................................................... 84
Double - Void plus............................................................................................................ 85
Double - Void minus ........................................................................................................ 86
Double - Void multiply ..................................................................................................... 87
Double - Void divide......................................................................................................... 88
Double - String toString .................................................................................................. 89
Double - Int toInt............................................................................................................... 91
Double - Int64 toInt64 ...................................................................................................... 92
String................................................................................................................................. 93
String - Int getLength....................................................................................................... 96
String - Char get ............................................................................................................... 97
String - Void set................................................................................................................ 98
String - Bool isEmpty....................................................................................................... 99
String - Void truncate .................................................................................................... 100
String - Void fill............................................................................................................... 101
String - String left........................................................................................................... 102
String - String right ........................................................................................................ 103
String - String mid.......................................................................................................... 104
String - Void replace ...................................................................................................... 106
String - Void leftJustify.................................................................................................. 107
String - Void rightJustify ............................................................................................... 108
String - Void makeEmpty() ............................................................................................ 109
iv
A29247-X89-X-3-7678
Table Of Contents
String - Void makeUpperCase ...................................................................................... 110
String - String toUpperCase.......................................................................................... 111
String - Void makeTitleCase ......................................................................................... 112
String - String toTitleCase............................................................................................. 113
String - Void makeLowerCase ...................................................................................... 114
String - String toLowerCase ......................................................................................... 115
String - Void trimWhiteSpace ....................................................................................... 116
String - String toWhiteSpaceTrimmed ......................................................................... 117
String - Void trimLeftWhiteSpace................................................................................. 118
String - String toWhiteSpaceLeftTrimmed .................................................................. 119
String - Void trimRightWhiteSpace .............................................................................. 120
String - String toWhiteSpaceRightTrimmed................................................................ 121
String - Void reduceWhiteSpace .................................................................................. 122
String - String toWhiteSpaceReduced ......................................................................... 123
String - Int compare ....................................................................................................... 124
String - Int compareCaseInsensitive............................................................................ 125
String - Void insert ......................................................................................................... 126
String - Void remove ...................................................................................................... 127
String - Void append ...................................................................................................... 128
String - Void prepend .................................................................................................... 129
String - Void setLength ................................................................................................. 130
String - Int find................................................................................................................ 131
A29247-X89-X-3-7678
v
Table Of Contents
String - Int findCaseInsensitive .................................................................................... 133
String - Int findBackwards ............................................................................................ 135
String - Int findBackwardsCaseInsensitive ................................................................. 137
String - Bool contains.................................................................................................... 139
String - Bool containsCaseInsensitive ........................................................................ 140
String - Int countOccurrences ...................................................................................... 141
String - Int countOccurrencesCaseInsensitive........................................................... 142
String - Bool beginWith ................................................................................................. 143
String - Bool beginWithCaseInsensitive...................................................................... 144
String - Bool endWith .................................................................................................... 145
String - Bool endWithCaseInsensitive ......................................................................... 146
String - String getPart.................................................................................................... 147
String - String getWord ................................................................................................. 148
String - Bool toBool ....................................................................................................... 149
String - Int toInt .............................................................................................................. 150
String - Int64 toInt64 ...................................................................................................... 151
String - Double toDouble............................................................................................... 152
String - Currency toCurrency ....................................................................................... 153
Char ................................................................................................................................. 154
Char - Int toInt................................................................................................................. 155
Char - String toString .................................................................................................... 156
DateTime ......................................................................................................................... 157
vi
A29247-X89-X-3-7678
Table Of Contents
DateTime - String toString ............................................................................................ 159
DateTime - Int getDays .................................................................................................. 160
DateTime - Void setDays ............................................................................................... 161
DateTime - Int getDay .................................................................................................... 162
DateTime - Void setDay ................................................................................................. 163
DateTime - Int getMonth ................................................................................................ 164
DateTime - Void setMonth............................................................................................. 165
DateTime - Int getYear ................................................................................................... 166
DateTime - Void setYear................................................................................................ 167
DateTime - Int getDayOfYear ........................................................................................ 168
DateTime - Void setDayOfYear ..................................................................................... 169
DateTime - Void getDMY ............................................................................................... 170
DateTime - Int getDayOfWeek....................................................................................... 173
DateTime - Void getHMS ............................................................................................... 174
DateTime - Int getHour .................................................................................................. 175
DateTime - Void setHour ............................................................................................... 176
DateTime - Int getMinute ............................................................................................... 177
DateTime - Void setMinute ............................................................................................ 178
DateTime - Int getSecond.............................................................................................. 179
DateTime - Void setSecond........................................................................................... 180
DateTime - Int getMillisecond ....................................................................................... 181
DateTime - Void setMillisecond .................................................................................... 182
A29247-X89-X-3-7678
vii
Table Of Contents
DateTime - Int getSecondOfDay ................................................................................... 183
DateTime - Void setSecondOfDay ................................................................................ 184
DateTime - getMilisecondOfDay ................................................................................... 185
DateTime - Void setMilisecondOfDay .......................................................................... 186
DateTime - DateTime Now ............................................................................................. 187
DateTime - DateTime NowGMT..................................................................................... 188
Log - Void logMessage.................................................................................................. 189
Log - Void logWarning................................................................................................... 190
Log - Void logError ........................................................................................................ 191
pauseAfterCurrentSheet ............................................................................................... 193
Appendix: Barcodes ...................................................................................................... 195
Barcodes Overview........................................................................................................ 196
Barcodes - Datalogic ..................................................................................................... 199
Barcodes - 2/5 IATA ....................................................................................................... 200
Barcodes - 2/5 Industrial ............................................................................................... 202
Barcodes - 2/5 Interleaved ............................................................................................ 204
Barcodes - 2/5 Matrix..................................................................................................... 207
Barcodes - Australia Post ............................................................................................. 209
Barcodes - Aztec ............................................................................................................ 211
Barcodes - CodaBar ...................................................................................................... 212
Barcodes - Code 128 ..................................................................................................... 214
Barcodes - Code 128 UPS ............................................................................................. 217
viii
A29247-X89-X-3-7678
Table Of Contents
Barcodes - Code 39 ....................................................................................................... 220
Barcodes - Code 39 (Full ASCII) ................................................................................... 222
Barcodes - Code 93 ....................................................................................................... 224
Barcodes - Data Matrix .................................................................................................. 226
Barcodes - Dutch Post .................................................................................................. 227
Barcodes - EAN 128 ....................................................................................................... 228
Barcodes - EAN 13 ......................................................................................................... 231
Barcodes - EAN8 ............................................................................................................ 234
Barcodes - Japan Post .................................................................................................. 236
Barcodes - Maxi Code ................................................................................................... 237
Barcodes - Micro PDF 417............................................................................................. 240
Barcodes - OMR ............................................................................................................. 242
Barcodes - PDF 417 ....................................................................................................... 243
Barcodes - QR ................................................................................................................ 245
Barcodes - Post Net ....................................................................................................... 247
Barcodes - Super Stealth-Dots ..................................................................................... 249
Barcodes - Royal Mail.................................................................................................... 251
Barcodes - UPC A .......................................................................................................... 253
Barcodes - UPC E........................................................................................................... 256
Appendix: Parameters and Environmental Variables ................................................ 259
General Commands ....................................................................................................... 260
Data Output Commands................................................................................................ 262
A29247-X89-X-3-7678
ix
Table Of Contents
Statistics Output Commands........................................................................................ 263
Output Commands......................................................................................................... 264
Engine Specific Commands.......................................................................................... 265
Commands for Workflow Modules XML Data Input, Data Input................................ 266
Commands for ParamInput Module ............................................................................. 267
Commands for RecordFilter Module............................................................................ 268
Multiple Output............................................................................................................... 269
TNGNetServer Description............................................................................................ 271
Simple / Advanced Production Mode........................................................................... 279
Simple Production Mode............................................................................................... 280
Advanced Production Mode ......................................................................................... 282
Specifying the Folder for Configuration and Cache Files ......................................... 283
Using the Current Folder for Configuration and Cache Files ................................... 284
Using Workflow File Name(s) as Parameter................................................................ 285
How to Create an Environmental Variable .................................................................. 286
PNETT_DIR Variable ...................................................................................................... 288
CX_DATA Variable ......................................................................................................... 289
CX_FONT_DIRECTORY Variable .................................................................................. 290
Language Codes ............................................................................................................ 291
Appendix: Full Color...................................................................................................... 297
Full Color Overview ....................................................................................................... 298
Color Management Functions ...................................................................................... 299
x
A29247-X89-X-3-7678
Table Of Contents
ICC Profiles..................................................................................................................... 300
Color Spaces .................................................................................................................. 301
RGB Color Space ........................................................................................................... 302
HSB Color Space............................................................................................................ 303
LAB Color Space............................................................................................................ 304
CMYK Color Space......................................................................................................... 305
Rendering Intents........................................................................................................... 306
Absolute Colorimetric (Match)...................................................................................... 307
Relative Colorimetric (Proof) ........................................................................................ 308
Perceptual (Picture) ....................................................................................................... 309
Saturation (Graphic) ...................................................................................................... 310
Importing PrintNet 3 Jobs ............................................................................................. 311
Overview ......................................................................................................................... 312
Importing PrintNet 3 Jobs - General Problems........................................................... 313
PrintNet 3 Jobs - Barcodes ........................................................................................... 315
PrintNet 3 Jobs - Other Differences ............................................................................. 317
PrintNet 3 Jobs - Not Existing Functionality............................................................... 319
PrintNet 3 Jobs - Problems in PTF ............................................................................... 320
Appendix: Objects XML Input....................................................................................... 321
XML - Layout................................................................................................................... 322
XML - List of FCVs ......................................................................................................... 377
XML - Modules................................................................................................................ 399
A29247-X89-X-3-7678
xi
Table Of Contents
IPDS Exceptions............................................................................................................. 426
Specification Check - General Exceptions.................................................................. 427
Specification Checks - Barcode Exceptions............................................................... 497
command.Specification Checks - Graphics Data Exceptions................................... 503
Specification Checks - IO-Image Exceptions.............................................................. 517
Intervention-Required Exceptions ............................................................................... 524
Equipment Check with Intervention Required Exceptions........................................ 535
Support: OptionalEquipment-Check Exceptions ....................................................... 539
Support: OptionalData - Check Exceptions ................................................................ 541
Command - Reject Exceptions ..................................................................................... 546
Conditions Requiring Host Notification ...................................................................... 548
xii
A29247-X89-X-3-7678
Appendix: Scripting and Methods Syntax
A29247-X89-X-3-7678
13
Scripting Notes
You can use non-alphanumerical characters (e.g., +, -, #) in a variable name. However, the variable
must be referenced in the scripts as follows:
!
Non-alphanumeric characters must be converted to an underline character. (e.g., the variable
named Business plan-summary 1.1 must be referenced as Business_plan_summary_1_1).
!
References to variables with a name that begins with a digit must have an underline character
as the first character of the name (e.g., the variable named 1.1-summary must be referenced
as _1_1_summary).
Note: Avoid using non-alphanumeric characters when converting names to "script form" if it would
result in non-unique names. For example, the following variable, Business_plan_summary, would be
used for any of the following:
14
!
Business plan summary
!
Business plan-summary
!
Business plan+summary
A29247-X89-X-3-7678
Expressions
An expression may be a numeric constant, a string constant, an array reference, a call to a typed
(function) procedure, or any combination of the above elements, in combination with one or more unary
or binary operators.
Every expression is characterized by a data type and a value. The data type is fixed at compile time,
but the value may be either fixed at compile time, or calculated at run time.
Parentheses may be used to force the compiler to evaluate the parts of an expression in a certain
order. In the absence of parenthesis, the precedence of an operator determines the order of evaluation
of an expression. The highest precedence operators are evaluated first. The precedence of the
operators is defined by the order in which the operators appear in the table. Function call has the
highest precedence.
Symbols and operators precedence (from highest to lowest)
•
function calls
•
brackets ( )
•
unary minus, !, not
•
*, /, %
•
+, -
•
&, ^
•
|
•
< > <= >=
•
== != is
•
and, xor
•
or
A29247-X89-X-3-7678
15
Operators
The script language supports the usual arithmetic operators which take operands of any numeric data
type.
In addition there are the usual comparison operators which take operands of any data type with the
data type of the result always boolean.
Finally, there are boolean operators taking boolean operands and also resulting in a boolean.
16
A29247-X89-X-3-7678
Arithmetic Operators
Operator
Operand
Result
Operation
+
Numeric
Numeric
Add
-
Numeric
Numeric
Substract, negate
*
Numeric
Numeric
Multiply
/
Numeric
Numeric
Divide
%
Numeric
Numeric
Modulus of a number
with respect to a base
value. The modulus is
the remainder from
dividing the number by
the base value.
~
Numeric
Numeric
Binary not
&
Numeric
Numeric
Binary and
^
Numeric
Numeric
Binary xor
|
Numeric
Numeric
Binary or
A29247-X89-X-3-7678
17
Boolean Operators
Operator
Operand
Result
Operation
not
Boolean
Boolean
Logical not
and
Boolean
Boolean
Logical and
xor
Boolean
Boolean
Logical xor
or
Boolean
Boolean
Logical or
18
A29247-X89-X-3-7678
Comparison Operators
Operator
Operand
Result
Operation
==
Numeric
Boolean
Is equal to
!=
Numeric
Boolean
Not equal to
<
Numeric
Boolean
Less than
>
Numeric
Boolean
Greater than
<=
Numeric
Boolean
Less than or equal to
>=
Numeric
Boolean
Greater than or equal to
A29247-X89-X-3-7678
19
Assignment Statements
The assignment statement assigns the value of the general expression on the right side to the variable
or array element given on the left side.
Statement
Description
=
Assigns the value of the general expression on the right side to the variable
or array element given on the left side.
+=
Adds the value of the general expression on the right side to the variable or
array element given on the left side. I.e. the same is:
i=i+2 and i+=2
-=
Substracts the value of the general expression on the right side from the
variable or array element given on the left side. I.e. the same is:
i=i-2 and i-=2
*=
Multiplies the value of the general expression on the right side with the
value of the variable or array element given on the left side. I.e. the same
is:
r=r*2.5 and r*=2.5
/=
Divides the value of the variable or array element given on the left side by
value of the general expression on the right side. I.e. the same is:
r=r/3.14 and r/=3.14
%=
Calculates value of modulus of a number with respect to a base value. The
modulus is the remainder from dividing the number by the base value. I.e.
the same is:
year=year%400 and year%=400
|=
Performs OR operation. The same is:
a=a|b and a|=b
&=
Performs AND operation. The same is:
a=a&b and a&=b
^=
Performs XOR operation. The same is:
a=a^b and a^=b
20
A29247-X89-X-3-7678
A29247-X89-X-3-7678
21
Functions
The Function keyword defines a piece of code that returns a value.
function name(String Parameter1):Int
{
return 0;
}
See also Declaring functions.
22
A29247-X89-X-3-7678
Flow Control Conditional Constructs
Built-in scripting language provides a full set of control flow constructs found in most modern languages
such as conditional execution and repetition. Control flow construct executes a statement either
conditionally or repetitively.
The simplest constructs is while, which tests at the top of the loop
The do construct is convenient for simple sequential operations on arrays.
The most general repetitive construct is the for statement.
Conditional Constructs
if
if...else
Repetitive Constructs
for
while
do while
Branching
Three statements are provided to interrupt the flow of control through one of the repetitive constructs.
break
continue
goto
A29247-X89-X-3-7678
23
If, If .. else Statements
The if and if else constructs are shown below.
The expr part may be any boolean expression. The statement(s) will be executed if the expression
resolves to true. Otherwise, it will fall through to the next block consisting of an else or else if.
if (expr)
{else if (expr)
statement}
{else (expr)
statement}
The control flow constructs may be nested indefinitely.
There may be an if clause without an else or else if. There is no end if.
Examples
Int n=300;
if(n < 0) // IF construction WITHOUT else;
//condition: n has to be greater or equal than 0
{
logWarning("Value of n has to be greater than 0.");
return n.toString();
}
Int n=300;
if(n < 0) // IF construction WITH else;
24
A29247-X89-X-3-7678
//condition: n has to be greater or equal than 0
{
logWarning("Value of n has to be greater than 0.");
return n.toString();
}
else
{
logMessage("Value of n is in the correct range.");
}
A29247-X89-X-3-7678
25
For Statement
The for construct consists of an initialization part, a test part, a loop control part, and a statement to be
executed.
The initialization part consists of a statement which is executed once before entering the loop.
The test part is a boolean expression, which is tested before each iteration of the loop.
The loop control statement is executed after the last statement in the body of the for, before branching
to the test at the beginning of the loop.
When used in a for statement, continue causes a branch to the loop control statement.
for (init; test; control)
{
statement
}
Example
Int n=300;
// summary in FOR cycle
Int f=0;
for (Int i=1;i<=n;i++)
// i is name of the variable that depends on "number of passes" in the
current for-loop
// i=1 determines its start value
// i<=n means: continue with incrementing of i until i reaches value of n
// i++ incrementation of i of value of 1
{
f=f+i;
//variable f is incremented
}
26
A29247-X89-X-3-7678
return "Summary in FOR cycle is: "+ f.toString();
A29247-X89-X-3-7678
27
While Statement
The while statement repetitively executes a statement or a block of statements as long as the specified
condition expression is true. The condition is tested at the beginning of the loop, so it is possible for the
statement not to be executed at all (see also a do while statement for comparison)
while (expr)
{
statement
}
or
while (expr)
{
statement1
}
else
{
statement2
}
Example
Int n=300;
//summary in WHILE cycle
Int i=1;
Int f=0;
while(i<=n)
{
28
A29247-X89-X-3-7678
f=f+i;
i++;
//variable f is incremented
// i++ means incrementation of i of value of 1
}
A29247-X89-X-3-7678
29
Do While Statement
The do while statement is similar to while but the condition is tested at the end of the loop, so the
statement is to be executed at least once.
do
{
statement
}
while (expr);
30
A29247-X89-X-3-7678
Break Statement
The break statement causes an immediate exit from the loop, by jumping to the statement following the
loop.
A29247-X89-X-3-7678
31
Continue Statement
The continue statement shifts control to the next iteration of a loop without executing remainder of the
current loop.
32
A29247-X89-X-3-7678
Goto Statement
The goto statement unconditionally branches to another point in a procedure. The target statement is
specified by a label followed by :
A29247-X89-X-3-7678
33
Return Statement
The return statement assigns a value to a function or returns control to the calling procedure. This
value is passed back to the calling procedure as the function value. The returned value is an
expression which resolves to the declared data type of the function.
34
A29247-X89-X-3-7678
Int
An integer type represents a subset of the whole numbers.
Type: Int
Format: signed 32-bit
Range: -2147483648..2147483647
See also Int64 description
Int methods
Int binaryNot ()
Void plus( Int aP1 )
Void minus( Int aP1 )
Void multiply( Int aP1 )
Void divide( Int aP1 )
Void remainder( Int aP1 )
Void binaryOr( Int aP1 )
Void binaryAnd( Int aP1 )
Void binaryXor( Int aP1 )
String toString()
String toString( Int aLength )
String toString( Int aLength, Bool aZeroFill )
String toString( Int aLength, Bool aZeroFill, Int aBase )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate, Bool aLeftJustified )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate, Bool aLeftJustified, Bool
aBigLetters )
A29247-X89-X-3-7678
35
Int - Int binaryNot
Syntax
binaryNot()
Return value
Int. This function returns bitwise negation on the given integer operand.
Example
Int i = 25; //11001
i=i.binaryNot();
return i; //result is -26
36
A29247-X89-X-3-7678
Int - Void plus
Syntax
plus ( Int aP1 )
Return value
Void. Increases the value of the given integer value by value aP1.
Example
Int i1 = 3;
i1.plus(5);
return i1; //result is 8
A29247-X89-X-3-7678
37
Int - Void minus
Syntax
minus ( Int aP1 )
Return value
Void. Decreases the value of the given integer value by value aP1.
Example
Int i1 = 3;
i1.minus();
38
A29247-X89-X-3-7678
Int - Void multiply
Syntax
multiply ( Int aP1 )
Return value
Void. Multiplies the value of the given integer value by value aP1.
Example
Int i = 3;
i.multiply(5);
return i; //result is 15
A29247-X89-X-3-7678
39
Int - Void divide
Syntax
divide ( Int aP1 )
Return value
Void. Divides the value of the given integer value by value aP1.
Example
Int i = 24;
i.divide(8);
40
A29247-X89-X-3-7678
Int - Void remainder
Syntax
remainder ( Int aP1 )
Return value
Void. Assigns the remainder obtained by dividing the given integer value by value aP1.
Example
Int i=26;
i.remainder(8);
return i; //result is (2) is the remainder obtained by dividing 26/8
A29247-X89-X-3-7678
41
Int - Void binaryOr
Syntax
binaryOr ( Int aP1 )
Return value
Void. This function returns a result of bitwise or operation on given integer operands.
Example
Int i = 25; //11001
i.binaryOr(13); //01101
return i; //result is 29 (11101)
Int - Void binaryAnd
Syntax
binaryAnd ( Int aP1 )
Return value
Void. This function returns a result of bitwise and operation on the given integer operands.
Example
Int i = 25; //11001
i.binaryOr(13); //01101
42
A29247-X89-X-3-7678
Int - Void binaryXor
Syntax
binaryXor ( Int aP1 )
Return value
Void. This function returns the result of bitwise xor operation on a given integer operands.
Example
Int i = 25; //11001
i.binaryXor(13); //01101
A29247-X89-X-3-7678
43
Int - String toString
Syntax
toString ()
Return value
String. Converts an integer into a string that represents the number.
Example
Int i = 25;
String s=i.toString();
s.append("th of October");
return s; //result is 25th of October
44
A29247-X89-X-3-7678
Int64
An integer type represents a subset of the whole numbers.
Type: Int
Format: signed 64-bit
Range: -263..263-1
See also Int description
Int64 methods
Int64 binaryNot()
Void plus( Int64 aP1 )
Void minus( Int64 aP1 )
Void multiply( Int64 aP1 )
Void divide( Int64 aP1 )
Void remainder( Int64 aP1 )
Void binaryOr( Int64 aP1 )
Void binaryAnd( Int64 aP1 )
Void binaryXor( Int64 aP1 )
String toString()
String toString( Int aP1 )
Void remainder( Int aP1 )
Void binaryOr( Int aP1 )
Void binaryAnd( Int aP1 )
Void binaryXor( Int aP1 )
A29247-X89-X-3-7678
45
Int toInt()
String toString( Int aLength, Bool aZeroFill )
String toString( Int aLength, Bool aZeroFill, Int aBase )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate, Bool aLeftJustified )
String toString( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate, Bool aLeftJustified, Bool
aBigLetters )
46
A29247-X89-X-3-7678
Int64 - Int64 binaryNot
Syntax
binaryNot()
Return value
Int64. This function returns bitwise negation on a given 64 bit integer operand.
Example
Int64 i = 25; //11001
i=i.binaryNot();
A29247-X89-X-3-7678
47
Int64 - Void plus
Syntax
plus ( Int64 aP1 )
Return value
Void. Increases the value of a given 64 bit integer value by the value specified.
Example
Int64 i1 = 3;
i1.plus(5);
48
A29247-X89-X-3-7678
Int64 - Void minus
Syntax
minus ( Int64 aP1 )
Return value
Void. Decreases the value of a given 64 bit integer value by the value aP1.
Example
Int64 i1 = 3;
i1.minus();
A29247-X89-X-3-7678
49
Int64 - Void multiply
Syntax
multiply ( Int64 aP1 )
Return value
Void. Multiplies the value of a given 64 bit integer value by the value aP1.
Example
Int64 i = 3;
i.multiply(5);
50
A29247-X89-X-3-7678
Int64 - Void divide
Syntax
divide ( Int64 aP1 )
Return value
Void. Divides the value of a given 64 bit integer value by the value aP1.
Example
Int64 i = 24;
i.divide(8);
A29247-X89-X-3-7678
51
Int64 - Void remainder
Syntax
remainder ( Int64 aP1 )
Return value
Void. Assigns the remainder obtained by dividing a given 64 bit integer value by the value aP1.
Example
Int64 i=26;
i.remainder(8);
52
A29247-X89-X-3-7678
Int64 - Void binaryOr
Syntax
binaryOr ( Int64 aP1 )
Return value
Void. This function returns result of bitwise or operation on given 64 bit integer operands.
Example
Int64 i = 25; //11001
i.binaryOr(13); //01101
A29247-X89-X-3-7678
53
Int64 - Void binaryAnd
Syntax
binaryAnd ( Int64 aP1 )
Return value
Void. This function returns result of bitwise and operation on given 64 bit integer operands.
Example
Int64 i = 25; //11001
i.binaryOr(13); //01101
54
A29247-X89-X-3-7678
Int64 - Void binaryXor
Syntax
binaryXor ( Int64 aP1 )
Return value
Void. This function returns result of bitwise xor operation on given 64 bit integer operands.
Example
Int64 i = 25; //11001
A29247-X89-X-3-7678
55
Int64 - String toString
Syntax
toString ( Int aLength, Bool aZeroFill )
toString ( Int aLength, Bool aZeroFill, Int aBase )
toString ( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate )
toString ( Int aLength, Bool aZeroFill, Int aBase, Bool aTruncate, Bool
aLeftJustified )
Return value
String. Converts an integer into a string that represents the number.
Parameter aLength specifies maximum length of the string. Bool value of aZeroFill determines if the
resulting string will be leftpadded by zeroes.
Optional value aBase sets the number's base (e.g., base 16 for hexadecimal output) in which the 64 bit
integer value will be converted.
When the aTruncate parameter is set to true, the resulting string will be truncated when the string
representation of the given 64 bit integer value is shorter than the aLength value.
BigLetters parameter specifies whether capital letters should be used for letter representation of
number (e.g., used in hexadecimal representation).
Example
Int64 i=1234567;
String s=i.toString(10,true);
return s; //result is 0001234567
Int64 i=5;
String s=i.toString(5,true,2);
return s; //result is 00101 (binary representation of number 5)
Int64 i=5;
String s=i.toString(5,true,2,true);
56
A29247-X89-X-3-7678
return s; //result is 101 (truncated binary representation of number 5)
Int64 i=5;
String s=i.toString(5,false,2, true,true);
s.append("-");
return s; //result is 101 - (truncated and left justified binary
representation of number 5)
Int64 i=1550;
String s=i.toString(5,false,16, true,true,true);
return s; //result is 60E - (hexadecimal representation with big letters)
Int64 i=1550;
String s=i.toString(5,false,16, true,true,false);
return s; //result is 60e - (hexadecimal reprsentation with small letters)
A29247-X89-X-3-7678
57
Int64 - Void plus (Int)
Syntax
plus ( Int aP1 )
Return value
Void. Increases the value of a given 64 bit integer value by the value aP1.
Example
Int64 i1 = 3;
i1.plus(5);
58
A29247-X89-X-3-7678
Int64 - Void minus (Int)
Syntax
minus ( Int aP1 )
Return value
Void. Decreases the value of a given 64 bit integer value by the value aP1.
Example
Int64 i1 = 3;
i1.minus();
A29247-X89-X-3-7678
59
Int64 - Void multiply (Int)
Syntax
Return value
Void. Multiplies the value of a given 64 bit integer value by the value aP1.
Example
Int64 i = 3;
i.multiply(5);
60
A29247-X89-X-3-7678
Int64 - Void divide (Int)
Syntax
divide ( Int aP1 )
Return value
Void. Divides the value of a given 64 bit integer value by the value aP1.
Example
Int64 i = 24;
i.divide(8);
A29247-X89-X-3-7678
61
Int64 - Void remainder (Int)
Syntax
remainder ( Int aP1 )
Return value
Void. Assigns the remainder obtained by dividing a given 64 bit integer value by the value aP1.
Example
Int64 i=26;
i.remainder(8);
62
A29247-X89-X-3-7678
Int64 - Void binaryOr (Int)
Syntax
binaryOr ( Int aP1 )
Return value
Void. This function returns bitwise bitwise or operation on given 64 bit integer operands.
Example
Int64 i = 25; //11001
i.binaryOr(13); //01101
A29247-X89-X-3-7678
63
Int64 - Void binaryXor (Int)
Syntax
binaryXor ( Int aP1 )
Return value
Void. This function returns bitwise bitwise xor operation on given 64 bit integer operands.
Example
Int64 i = 25; //11001
64
A29247-X89-X-3-7678
Int64 - Int toInt
Syntax
toInt ()
Return value
Int. Converts a 64 bit value integer to an integer value.
Example
Int64 i1=12345;
Int i2 = i1.toInt();
A29247-X89-X-3-7678
65
Currency
Currency is one of real types. A real type defines a set of numbers that can be represented with
floating-point notation.
Currency is a fixed-point data type that minimizes rounding errors in monetary calculations. It is stored
as a scaled 64-bit integer with the four least significant digits implicitly representing decimal places.
When mixed with other real types in assignments and expressions, Currency values are automatically
divided or multiplied by 10000.
Type: Currency
Range: - 922337203685477.5808.. 922337203685477.5807
Significant digits: 19-20
Currency methods
Void plus( Currency aP1 )
Void minus( Currency aP1 )
Void multiply( Currency aP1 )
String toString()
String toString( Int aP1 )
String toString( Int aP1, Int aP2 )
Int toInt()
Int64 toInt64()
Double toDouble()
66
A29247-X89-X-3-7678
Currency - Void plus
Syntax
plus ( Currency aP1 )
Return value
Void. Increases the value of a given currency value by the value specified.
Example
Currency c = 300;
c.plus(5);
return c; //result is 305.0000
A29247-X89-X-3-7678
67
Currency - Void minus
Syntax
minus ( Currency aP1 )
Return value
Void. Decreases the value of a given currency value by the value specified.
Example
Currency c = 300;
c.minus(5);
68
A29247-X89-X-3-7678
Currency - Void multiply
Syntax
multiply ( Currency aP1 )
Return value
Void. Multiplies the value of a given currency value by the value aP1.
Example
Currency c = 300;
c.multiply(1.3);
return c; //return is 390.0000
A29247-X89-X-3-7678
69
Currency - String toString
Syntax
toString ()
toString ( Int aP1 )
toString ( Int aP2, Int aP1 )
Return value
String. Converts currency value into a string that represents the number.
Optional parameter aP1 specifies the minimum number of digits after the decimal point.
Optional parameter aP2 specifies the maximum number of digits after the decimal point.
Example
Currency c = 300;
String s = c.toString();
s.append("*");
s.prepend("*");
return s; //result is *300.0000*
Currency c = 300.1234;
String s = c.toString(2,1);
s.append("*");
s.prepend("*");
Currency c = 300;
String s = c.toString(2,1);
s.append("*");
s.prepend("*");
70
A29247-X89-X-3-7678
A29247-X89-X-3-7678
71
Currency - Void plus (Int)
Syntax
plus ( Int aP1 )
Return value
Void. Increases the value of a given currency value by the integer value specified.
Example
Currency c = 300;
c.plus(5);
72
A29247-X89-X-3-7678
Currency - Void minus (Int)
Syntax
minus ( Currency aP1 )
Return value
Void. Decreases the value of a given currency value by the integer value specified.
Example
Currency c = 300;
c.minus(5);
A29247-X89-X-3-7678
73
Currency - Void multiply (Int)
Syntax
Return value
Void. Multiplies the value of a given currency value by the integer value aP1.
Example
Currency c = 300;
c.multiply(2);
return c; //return is 600.0000
74
A29247-X89-X-3-7678
Currency - Int toInt
Syntax
toInt ()
Return value
Int. Converts a currency value to an integer value.
Example
Currency c = 300;
Int i= c.toInt();
A29247-X89-X-3-7678
75
Currency - Int64 toInt64
Syntax
toInt64 ()
Return value
Int64. Converts a currency value to a 64 bit integer value.
Example
Currency c = 300;
Int64 i= c.toInt();
76
A29247-X89-X-3-7678
Currency - Double toDouble
Syntax
toDouble ()
Return value
Double. Converts a currency value to a double value.
Example
Currency c = 300.1234;
Double d= c.toDouble();
return d; //result is 300.1234
A29247-X89-X-3-7678
77
Bool
Boolean value is denoted by the predefined constants True and False.
Bool methods
Bool booleanNot()
Bool booleanOr2( Bool aP1 )
Bool booleanAnd2( Bool aP1 )
Bool booleanXor2( Bool aP1 )
String toString()
78
A29247-X89-X-3-7678
Bool - booleanNot
Syntax
booleanNot()
Return value
Void. This function negates the given boolean value.
Example
Int i=100;
Currency c=100.00;
Bool b= i==c.toInt(); // value i is equivalent to c, so b is now true
return b.booleanNot(); //result is negated b, so now it is false
A29247-X89-X-3-7678
79
Bool - boolean Or2
Syntax
Bool booleanOr2 ( Bool aP1 )
Return value
Void. This function provides the boolean disjunction (OR) on the given, the given boolean and the aP1
value..
Example
Int i=100;
Currency c=100.00;
Bool b1= i==c.toInt(); // value i is equivalent to c, so b is now true
Bool b2=false;
return b1.booleanOr2(b2); //result is b1 OR-ed with b2, so now it is true
80
A29247-X89-X-3-7678
Bool - boolean And2
Syntax
Bool booleanAnd2 ( Bool aP1 )
Return value
Void. This function provides the boolean conjunction on the given, the given boolean and the aP1
value..
Example
Int i=100;
Currency c=100.00;
Bool b1= i==c.toInt(); // value i is equivalent to c, so b is now true
Bool b2=false;
return b1.booleanAnd2(b2); //result is b1 AND-ed with b2, so now it is false
A29247-X89-X-3-7678
81
Bool - boolean Xor2
Syntax
Bool booleanXor2 ( Bool aP1 )
Return value
Void. This function provides the boolean exclusive disjunction on the given, the given boolean and the
aP1 value..
Example
Int i=100;
Currency c=100.00;
Bool b1= i!=c.toInt(); // value i is equivalent to c, so b is now false
Bool b2=false;
return b1.booleanXor2(b2); //result is b1 XOR-ed with b2, so now it is true
82
A29247-X89-X-3-7678
Bool - String toString
Syntax
toString ()
Return value
String. Converts boolean value into a string that represents the value.
Example
Int i=100;
Currency c=100.00;
Bool b= i!=c.toInt(); // value i is equivalent to c, so b is now false
String s=b.toString();
return s; //result is (string) false
A29247-X89-X-3-7678
83
Double
Double is one of real types. A real type defines a set of numbers that can be represented with floatingpoint notation.
Type: Double
Range: 5.0 x 10-324 .. 1.7 x 10308
Significant digits: 15-16
Double methods
Void plus( Double aP1 )
Void minus( Double aP1 )
Void multiply( Double aP1 )
Void divide( Double aP1 )
String toString()
String toString( Int aPrecission )
String toString( Int aPrecission, Int aMinDecimalPlaces )
Int toInt()
Void plus( Int64 aP1 )
Void minus( Int64 aP1 )
Void multiply( Int64 aP1 )
Void divide( Int64 aP1 )
Int64 toInt64()
84
A29247-X89-X-3-7678
Double - Void plus
Syntax
plus ( Double aP1 )
plus ( Int aP1 )
plus ( Int64 aP1 )
Return value
Void. Increases the value of a given double value by the value specified.
Example
Double d = 100.12345;
d.plus(5);
A29247-X89-X-3-7678
85
Double - Void minus
Syntax
minus ( Double aP1 )
minus ( Int aP1 )
minus ( Int64 aP1 )
Return value
Void. Decreases the value of a given double value by the value specified.
Example
Double d = 100.12345;
d.minus(5);
86
A29247-X89-X-3-7678
Double - Void multiply
Syntax
multiply ( Double aP1 )
multiply ( Int64 aP1 )
Return value
Void. Multiplies the value of a given double value by the value specified.
Example
Double d = 100.12345;
d.multiply(5);
A29247-X89-X-3-7678
87
Double - Void divide
Syntax
divide ( Double aP1 )
divide ( Int aP1 )
divide ( Int64 aP1 )
Return value
Void. Divides the value of a given double value by the value specified.
Example
Double d = 100.12345;
d.divide(5);
88
A29247-X89-X-3-7678
Double - String toString
Syntax
toString ()
toString ( Int aPrecission )
toString ( Int aPrecission, Int aMinDecimalPlaces )
Return value
String. Converts a double value into a string that represents the number.
Optional parameter aPrecisionspecifies the precision of the given value.
Optional parameter aPMinDecimalPlaces specifies the minimum number of digits after the decimal
point.
Example
Double d = 100.12345;
String s=d.toString();
s.append("*");
s.prepend("*");
Double d = 100.12345;
String s=d.toString(4);
s.append("*");
s.prepend("*");
Double d = 100;
String s=d.toString(5,2);
s.append("*");
A29247-X89-X-3-7678
89
s.prepend("*");
90
A29247-X89-X-3-7678
Double - Int toInt
Syntax
toInt ()
Return value
Int. Converts a double value to an integer value.
Example
Double d = 300;
Int i= d.toInt();
Double d = 300.75;
Int i= d.toInt();
A29247-X89-X-3-7678
91
Double - Int64 toInt64
Syntax
toInt64 ()
Return value
Int64. Converts a double value to an integer value.
Example
Double d = 300;
Int64 i= d.toInt64();
Double d = 300.75;
Int64 i= d.toInt64();
92
A29247-X89-X-3-7678
String
A string represents a sequence of characters.
String methods
Int getLength()
Char get( Int aInt )
Void set( Int aInt, Char aChar )
Bool isEmpty()
Void truncate( Int aNewLength )
Void fill( Char aChar )
Void fill( Char aChar, Int aNewLength )
String left( Int aLength )
String right( Int aLength )
String mid( Int aInt )
String mid( Int aIndex, Int aLength )
Void replace( Int aFromIndex, Int aInt, String aString )
Void replace( String aToFind, String aReplaceWith )
Void replace( String aToFind, String aReplaceWith, Int aFromIndex )
Void replace( String aToFind, String aReplaceWith, Int aFromIndex, Int aTimes )
Void leftJustify( Int aWidth, Char aFill, Bool aTruncate )
Void rightJustify( Int aWidth, Char aFill, Bool aTruncate )
Void makeEmpty()
Void makeUpperCase()
String toUpperCase()
Void makeTitleCase()
String toTitleCase()
Void makeLowerCase()
String toLowerCase()
A29247-X89-X-3-7678
93
Void trimWhiteSpace()
String toWhiteSpaceTrimmed()
Void trimLeftWhiteSpace()
String toWhiteSpaceLeftTrimmed()
Void trimRightWhiteSpace()
String toWhiteSpaceRightTrimmed()
Void reduceWhiteSpace()
String toWhiteSpaceReduced()
Int compare( String aChar )
Int compareCaseInsensitive( String aChar )
Void insert( Int aIndex, String aString )
Void remove( Int aIndex, Int aInt )
Void append( String aString )
Void prepend( String aString )
Void setLength( Int aNewLength )
Int find( String aString )
Int find( Char aChar )
Int find( String aString, Int aIndex )
Int find( Char aChar, Int aIndex )
Int findCaseInsensitive( String aString )
Int findCaseInsensitive( Char aChar )
Int findCaseInsensitive( String aString, Int aIndex )
Int findCaseInsensitive( Char aChar, Int aIndex )
Int findBackwards( String aString )
Int findBackwards( Char aChar )
Int findBackwards( String aString, Int aIndex )
Int findBackwards( Char aChar, Int aIndex )
Int findBackwardsCaseInsensitive( String aString )
Int findBackwardsCaseInsensitive( Char aChar )
94
A29247-X89-X-3-7678
Int findBackwardsCaseInsensitive( String aString, Int aIndex )
Int findBackwardsCaseInsensitive( Char aChar, Int aIndex )
Bool contains( String aString )
Bool contains( Char aChar )
Bool containsCaseInsensitive( String aString )
Bool containsCaseInsensitive( Char aChar )
Int countOccurrences( Char aString )
Int countOccurrences( String aChar )
Int countOccurrencesCaseInsensitive( Char aString )
Int countOccurrencesCaseInsensitive( String aChar )
Bool beginWith( String aString )
Bool beginWithCaseInsensitive( String aString )
Bool endWith( String aString )
Bool endWithCaseInsensitive( String aString )
String getPart( Int aPartIdx, Char aSeparator )
String getWord( Int aPartIdx )
Bool toBool()
Int toInt()
Int64 toInt64()
Double toDouble()
Currency toCurrency()
A29247-X89-X-3-7678
95
String - Int getLength
Syntax
getLength (string)
Return value
Integer. The getLength function returns the length of string.
Example
String s="single ENVIRONMENT, all-in-one SOFTWARE";
Int i=s.getLength();
s= i.toString();
96
A29247-X89-X-3-7678
String - Char get
Syntax
get (Int aInt)
Return value
Char. The get function returns the character at aInt position. The first character in string is at position 0.
Example
Char c=s.get(3);
return c; //result is g
A29247-X89-X-3-7678
97
String - Void set
Syntax
set (Int aInt, char AChar)
Return value
Void. The set function sets (changes) the character AChar at the aInt position. The first character in
string is at position 0.
Example
s.set(3,"-");
return s; //result is sin-le ENVIRONMENT, all-in-one SOFTWARE
98
A29247-X89-X-3-7678
String - Bool isEmpty
Syntax
isEmpty (string)
Return value
Bool. The isEmpty function returns true when the string is empty, false when the string is not empty.
Example
Bool b=s.isEmpty();
s= b.toString();
return s; //result is false
A29247-X89-X-3-7678
99
String - Void truncate
Syntax
truncate (Int aNewLength)
Return value
Void. The truncate function truncates the string to the new length aNewLength.
Example
s.truncate(10);
return s; //result is single ENV
100
A29247-X89-X-3-7678
String - Void fill
Syntax
fill( Char aChar )
fill( Char aChar, Int aNewLength )
Return value
Void. The fill function fills string using given character truncates aChar. Alternatively, it is possible to
use it also with specified length aNewLength.
Example
String s= s.fill("*",30);
return s; //result is ******************************
A29247-X89-X-3-7678
101
String - String left
Syntax
left (Int aLength)
Return value
Integer. Returns string with the length alength from the string at the left side. If alength is greater than
the string length, it then returns the entire string.
Example
String s = "Hello world";
String z = s.left(5);
return z; //result is Hello
102
A29247-X89-X-3-7678
String - String right
Syntax
right (Int aLength)
Return value
Integer. Returns string with the length alength from the string at the right side. If alength is greater than
the string length, then it returns entire string.
Example
String z = s.right(5);
return z; //result is world
A29247-X89-X-3-7678
103
String - String mid
Syntax
mid ( Int aIndex )
mid ( Int aIndex, Int aLength )
Return value
String. Returns a substring containing aLength characters aIndex (zero based - first character of the
string has an index of 0).
When an optional aLength value is not specified or is larger than the remaining length of the string to
be returned, it returns only the characters from aIndex to the end of string.
If aIndex is larger than the length of S, mid returns an empty string.
Example
String z = s.mid(2);
return z; //result is llo world
String z = s.mid(2,5);
return z; //result is llo w
return z; //result is llo world
return z; //result is empty string
104
A29247-X89-X-3-7678
A29247-X89-X-3-7678
105
String - Void replace
Syntax
replace( String aToFind, String aReplaceWith )
replace( String aToFind, String aReplaceWith, Int aFromIndex )
replace( String aToFind, String aReplaceWith, Int aFromIndex, Int aTimes )
Return value
Void. Replaces string aToFind with string aReplaceWith. Optionally, you can specify the position
aFromIndex that determines the starting character from where the replacing will be executed. The
optional parameter aTimes specifies the maximum number of replacements.
Example
String s = "single environment, all-in-one software";
s.replace("e","E");
return s; //result is singlE EnvironmEnt, all-in-onE softwarE
s.replace("e","E",15);
return s; //result is single environmEnt, all-in-onE softwarE
s.replace("e","E",15,2);
return s; //result is single environmEnt, all-in-onE software
106
A29247-X89-X-3-7678
String - Void leftJustify
Syntax
leftJustify( Int aWidth, Char aFill, Bool aTruncate )
Return value
Void. leftJustify function justifies the number of characters in the given string by appending the
character(s) aFill to the right side of the string. When the string is longer than width aWidth, you can
determine whether it will be shortened to the specified length by setting the aTruncate parameter to
true..
Example
s.leftJustify(45,"*",true);
return s; //result is single environment, all-in-one software*****
s.leftJustify(35,"*",true);
return s; //result is single environment, all-in-one soft
s.leftJustify(35,"*",false);
return s; //result is single environment, all-in-one software
A29247-X89-X-3-7678
107
String - Void rightJustify
Syntax
rightJustify( Int aWidth, Char aFill, Bool aTruncate )
Return value
Void. rightJustify function justifies the number of characters in the given string by appending the
character(s) aFill to the left side of the string. When the string is longer than width aWidth, you can
determine whether it will be shortened to the specified length by setting the aTruncate parameter to
true..
Example
s.rightJustify(45,"*",true);
return s; //result is *****single environment, all-in-one software
s.rightJustify(35,"*",true);
return s; //result is single environment, all-in-one soft
s.rightJustify(35,"*",false);
108
A29247-X89-X-3-7678
String - Void makeEmpty()
Syntax
makeEmpty()
Return value
Void. Creates an empty string from the string given.
Example
s.makeEmpty();
return s; //result is empty string
A29247-X89-X-3-7678
109
String - Void makeUpperCase
Syntax
makeUpperCase()
Return value
Void. All the characters in the given string will be converted to their uppercase equivalents.
Example
s.makeUpperCase();
return s; //result is SINGLE ENVIRONMENT, ALL-IN-ONE SOFTWARE
110
A29247-X89-X-3-7678
String - String toUpperCase
Syntax
toUpperCase()
Return value
String. All the characters in the given string will be converted to their uppercase equivalents.
Example
s=s.toUpperCase();
return s; //result is SINGLE ENVIRONMENT, ALL-IN-ONE SOFTWARE
A29247-X89-X-3-7678
111
String - Void makeTitleCase
Syntax
makeTitleCase()
Return value
Void. First character in the given string will be converted to the uppercase equivalents. The remainder
of the string will be lowercased.
Example
String s = "single ENVIRONMENT, all-in-one software";
s.makeTitleCase();
return s; //result is Single environment, all-in-one software
112
A29247-X89-X-3-7678
String - String toTitleCase
Syntax
toTitleCase()
Return value
String. The first character in the given string will be converted to the uppercase equivalent. The
remainder of the string will be lowercased.
Example
String s = "single ENVIRONMENT, all-in-one software";
s=s.toTitleCase();
return s; //result is Single environment, all-in-one software
A29247-X89-X-3-7678
113
String - Void makeLowerCase
Syntax
makeLowerCase()
Return value
Void. All the characters in the given string will be converted to their lowercase equivalents.
Example
String s = "SINGLE ENVIRONMENT, ALL-IN-ONE SOFTWARE";
s.makeLowerCase();
114
A29247-X89-X-3-7678
String - String toLowerCase
Syntax
makeLowerCase()
Return value
String. All the characters in the given string will be converted to their lowercase equivalents.
Example
String s = "SINGLE ENVIRONMENT, ALL-IN-ONE SOFTWARE";
s=s.toLowerCase();
A29247-X89-X-3-7678
115
String - Void trimWhiteSpace
Syntax
trimWhiteSpace()
Return value
Void. Removes leading and trailing white space from the string. White space is defined as spaces,
tabs, carriage returns, and line feeds.
Example
String s1 = " single ";
String s2 = " environment ";
s1.trimWhiteSpace() ;
s2.trimWhiteSpace() ;
s1.plus(" ");
s1.plus(s2);
return s1; //result is single environment
116
A29247-X89-X-3-7678
String - String toWhiteSpaceTrimmed
Syntax
toWhiteSpaceTrimmed()
Return value
String. Returns string without removing leading and trailing white spaces. White space is defined as
spaces, tabs, carriage returns, and line feeds.
Example
s1=s1.toWhiteSpaceTrimmed() ;
s2=s2.toWhiteSpaceTrimmed() ;
s1.plus(" ");
s1.plus(s2);
A29247-X89-X-3-7678
117
String - Void trimLeftWhiteSpace
Syntax
trimLeftWhiteSpace()
Return value
Void. Removes leading and trailing white space from the left side of the string. White space is defined
as spaces, tabs, carriage returns, and line feeds.
Example
s1.trimLeftWhiteSpace() ;
s2.trimRightWhiteSpace() ;
s1.plus(s2);
118
A29247-X89-X-3-7678
String - String toWhiteSpaceLeftTrimmed
Syntax
toWhiteSpaceLeftTrimmed()
Return value
String. Returns string without removed leading and trailing white spaces from the left side of the string.
White space is defined as spaces, tabs, carriage returns, and line feeds.
Example
s1=s1.toWhiteSpaceLeftTrimmed() ;
s2=s2.toWhiteSpaceRightTrimmed() ;
s1.plus(" ");
s1.plus(s2);
A29247-X89-X-3-7678
119
String - Void trimRightWhiteSpace
Syntax
trimRightWhiteSpace()
Return value
Void. Removes leading and trailing white space from the right side of the string. White space is
defined as spaces, tabs, carriage returns, and line feeds.
Example
s1.trimLeftWhiteSpace() ;
s2.trimRightWhiteSpace() ;
s1.plus(s2);
120
A29247-X89-X-3-7678
String - String toWhiteSpaceRightTrimmed
Syntax
toWhiteSpaceRightTrimmed()
Return value
String. Returns string without removing leading and trailing white spaces from the right side of the
string. White space is defined as spaces, tabs, carriage returns, and line feeds.
Example
s1=s1.toWhiteSpaceLeftTrimmed() ;
s2=s2.toWhiteSpaceRightTrimmed() ;
s1.plus(" ");
s1.plus(s2);
return s1; // result is single environment
A29247-X89-X-3-7678
121
String - Void reduceWhiteSpace
Syntax
reduceWhiteSpace()
Return value
Void. Reduces leading and trailing white spaces of the string to only one space. White space is defined
as spaces, tabs, carriage returns, and line feeds.
Example
String s = " single ";
s.reduceWhiteSpace() ;
s.prepend("-");
s.append("-");
return s; //result is - single -
122
A29247-X89-X-3-7678
String - String toWhiteSpaceReduced
Syntax
toWhiteSpaceReduced()
Return value
String. Returns string with leading and trailing white spaces reduced to only one space. White space is
defined as spaces, tabs, carriage returns, and line feeds.
Example
String s = " single ";
s=s.toWhiteSpaceReduced() ;
s.plus("-");
s.prepend("-");
return s; //result is - single -
A29247-X89-X-3-7678
123
String - Int compare
Syntax
compare (String AString)
Return value
Int. This function is case-sensitive.
- Returns 0, when compared strings are equivalent.
- Returns the difference of the unicode value of the of the first non-equivalent characters when the
Unicode value of the first non-equivalent character in AString is smaller or larger than according
character of the compared string.
Example
String s1="Hello";
String s2="Hello";
Int i=s1.compare(s2);
return i; //result is 0 (equivalent)
String s1="Hello world";
String s2="Hello WORLD";
124
A29247-X89-X-3-7678
String - Int compareCaseInsensitive
Syntax
compareCaseInsensitive (String AChar)
Return value
Int. This function is case-insensitive.
- Returns 0, when compared strings are equivalent.
- Returns difference of the unicode value of the of the first non-equivalent characters when Unicode
value of the first non-equivalent character in AString is smaller or larger than according character of the
compared string.
Example
String s1="Hello";
String s2="Hello";
Int i=s1.compareCaseInsensitive(s2);
return i; //result is 0 (equivalent)
String s2="Hello Europe";
A29247-X89-X-3-7678
125
String - Void insert
Syntax
insert ( Int aIndex, String aString )
Return value
Void. The string aString is inserted at position aIndex of the given string.
Example
String s1="abcdef";
String s2="ghijk";
s1.insert(3,s2);
return s1; //result is abcghijkdef
126
A29247-X89-X-3-7678
String - Void remove
Syntax
remove ( Int aIndex, Int aInt )
Return value
Void. Removes a substring of aInt characters from the string starting at position aIndex.
If aIndex is larger than the length of the string, no characters are deleted. If aInt specifies more
characters than remain starting at the aIndex, the remove function removes the rest of the string.
Example
String s="abcdef";
s.remove(3,2);
return s; //result is abcf
A29247-X89-X-3-7678
127
String - Void append
Syntax
append ( String aString )
Return value
Void. Appends aString to the end of the given string.
Example
String s1="abcdef";
String s2="ghijk";
s1.append(s2);
return s1; //result is abcdefghijk
128
A29247-X89-X-3-7678
String - Void prepend
Syntax
prepend ( String aString )
Return value
Void. Inserts aString before the first character of the given string.
Example
String s1="abcdef";
String s2="ghijk";
s1.prepend(s2);
return s1; //result is ghijkabcdef
A29247-X89-X-3-7678
129
String - Void setLength
Syntax
setLength ( Int aNewLength )
Return value
Void. Truncates the given string to the new length aNewLength if the value is smaller than current
number of characters in the string, appends spaces when the aNewLength is larger than the current
length.
Example
String s="single environment, all-in-one software";
s.setLength(10);
return s; //result is single env
130
A29247-X89-X-3-7678
String - Int find
Syntax
find ( String aString )
find ( Char aChar )
find ( String aString, Int aIndex )
find ( Char aChar, Int aIndex )
Return value
Int. The find function return returns an integer value that is the index of the first character of aString (or
aChar) within given string, optionally with aIndex value determining starting position for searching.
This function is case-sensitive.
If aString (or aChar) is not found, find returns -1.
Example
Int i = s.find("e");
s= i.toString();
Int i = s.find("in");
s= i.toString();
Int i = s.find("e", 10);
s= i.toString();
A29247-X89-X-3-7678
131
Int i = s.find("in", 10);
s= i.toString();
Int i = s.find("q");
s= i.toString();
return s; //result is -1
132
A29247-X89-X-3-7678
String - Int findCaseInsensitive
Syntax
findCaseInsensitive ( String aString )
findCaseInsensitive ( Char aChar )
findCaseInsensitive ( String aString, Int aIndex )
findCaseInsensitive ( Char aChar, Int aIndex )
Return value
Int. The findCaseInsensitive function return returns an integer value that is the index of the first
character of aString (or aChar) within given string, optionally with aIndex value determining starting
position for searching.
This function is case-insensitive.
If aString (or aChar) is not found, findCaseInsensitive returns -1.
Example
Int i = s.findCaseInsensitive("E");
s= i.toString();
Int i = s.findCaseInsensitive("on");
s= i.toString();
Int i = s.findCaseInsensitive("e",10);
s= i.toString();
A29247-X89-X-3-7678
133
Int i = s.findCaseInsensitive("On",15);
s= i.toString();
134
A29247-X89-X-3-7678
String - Int findBackwards
Syntax
findBackwards ( String aString )
findBackwards ( Char aChar )
findBackwards ( String aString, Int aIndex )
findBackwards ( Char aChar, Int aIndex )
Return value
Int. The findBackwards function return returns an integer value that is the index of the first character
while searching backwards (from the last characters) of aString (or aChar) within given string,
optionally with aIndex value determining starting position for searching.
This function is case-sensitive.
If aString (or aChar) is not found, findBackwards returns -1.
Example
Int i = s.findBackwards("e");
s= i.toString();
Int i = s.findBackwards("in");
s= i.toString();
Int i = s.findBackwards("e", 10);
s= i.toString();
A29247-X89-X-3-7678
135
Int i = s.findBackwards("in", 10);
s= i.toString();
136
A29247-X89-X-3-7678
String - Int findBackwardsCaseInsensitive
Syntax
findBackwardsCaseInsensitive ( String aString )
findBackwardsCaseInsensitive( Char aChar )
findBackwardsCaseInsensitive( String aString, Int aIndex )
findBackwardsCaseInsensitive( Char aChar, Int aIndex )
Return value
Int. The findBackwardsCaseInsensitive function return returns an integer value that is the index of
the first character while searching backwards (from the last characters) of aString (or aChar) within
given string, optionally with aIndex value determining starting position for searching.
This function is case-insensitive.
If aString (or aChar) is not found, findBackwardsCaseInsensitive returns -1.
Example
Int i = s.findBackwardsCaseInsensitive("E");
s= i.toString();
Int i = s.findBackwardsCaseInsensitive("on");
s= i.toString();
Int i = s.findBackwardsCaseInsensitive("e",10);
s= i.toString();
return s; //result is -1
A29247-X89-X-3-7678
137
Int i = s.findBackwardsCaseInsensitive("On",15);
s= i.toString();
138
A29247-X89-X-3-7678
String - Bool contains
Syntax
contains ( String aString )
contains ( Char aChar )
Return value
Bool. Returns true when given string contains aString or aChar. This function is case-sensitive.
Example
Bool b=s.contains("SINGLE");
s= b.toString();
A29247-X89-X-3-7678
139
String - Bool containsCaseInsensitive
Syntax
containsCaseInsensitive ( String aString )
containsCaseInsensitive ( Char aChar )
Return value
Bool. Returns true when given string contains aString or aChar. This function is case-insensitive.
Example
Bool b=s.containsCaseInsensitive("SINGLE");
s= b.toString();
return s; //result is true
140
A29247-X89-X-3-7678
String - Int countOccurrences
Syntax
countOccurrences ( Char aChar )
countOccurrences ( String aString )
Return value
lnt. Returns number of repetitions of the aString or aChar in the given string. This function is casesensitive.
Example
String s="SINGLE ENVIRONMENT, all-in-one SOFTWARE";
Int i=s.countOccurrences("e");
s= i.toString();
Int i=s.countOccurrences("in");
s= i.toString();
A29247-X89-X-3-7678
141
String - Int countOccurrencesCaseInsensitive
Syntax
countOccurrencesCaseInsensitive ( Char aChar )
countOccurrencesCaseInsensitive ( String aString )
Return value
lnt. Returns number of repetitions of the aString or aChar in the given string. This function is caseinsensitive.
Example
Int i=s.countOccurrencesCaseInsensitive("e");
s= i.toString();
Int i=s.countOccurrencesCaseInsensitive("in");
s= i.toString();
142
A29247-X89-X-3-7678
String - Bool beginWith
Syntax
beginWith ( String aString )
Return value
Bool. Returns true when given string begins with aString. This function is case-sensitive.
Example
Bool b=s.beginWith("SINGLE");
s= b.toString();
A29247-X89-X-3-7678
143
String - Bool beginWithCaseInsensitive
Syntax
beginWithCaseInsensitive ( String aString )
Return value
Bool. Returns true when given string begins with aString. This function is case-insensitive.
Example
Bool b=s.beginWithCaseInsensitive("SINGLE");
s= b.toString();
144
A29247-X89-X-3-7678
String - Bool endWith
Syntax
endWith ( String aString )
Return value
Bool. Returns true when given string ends with aString. This function is case-sensitive.
Example
Bool b=s.endWith("software");
s= b.toString();
A29247-X89-X-3-7678
145
String - Bool endWithCaseInsensitive
Syntax
endWithCaseInsensitive ( String aString )
Return value
Bool. Returns true when given string ends with aString. This function is case-insensitive.
Example
Bool b=s.endWithCaseInsensitive("software");
s= b.toString();
146
A29247-X89-X-3-7678
String - String getPart
Syntax
String getPart ( Int aPartIdx, Char aSeparator )
Return value
String. Returns xth (where x is defined by aPartIdx) part of the input string separated by separators
aSeparator. The separators indexes are zero-based (the first separator has index 0, the second one
has index 1 etc.).
If the index aPartIdx is greater than number of available separators in the string then the result is an
empty string.
Example
String s= "single;environment;all;in;one;software";
s= s.getPart(1,";");
return s; //result is environment
return s; //result is single
return s; //result is empty string
A29247-X89-X-3-7678
147
String - String getWord
Syntax
String getWord ( Int aPartIdx )
Return value
String. Returns xth (where x is defined by aPartIdx) word of the input string separated by spaces.
I. e. word in this context has meaning of part of the string separated by spaces. The separators (i.e.
spaces) indexes are zero-based (the first separator has index 0, the second one has index 1 etc.).
Multiple spaces (" ", " " etc.) are treated as one separator only.
If the index aPartIdx is greater than number of available separators in the string then the result is an
emtpy string.
Example
String s= " single environment, all-in-one software ";
s= s.getWord(0);
return s; //result is single (without the leading spaces)
s= s.getWord(0);
return s; //result is environment,
s= s.getWord(0);
return s; //result is software (without the trailing spaces)
148
A29247-X89-X-3-7678
String - Bool toBool
Syntax
toBool ()
Return value
Bool. Converts a string that represents an boolean value (true or false) into a that value.
Example
String s="false";
Bool b=s.toBool();
return b; //result is false
A29247-X89-X-3-7678
149
String - Int toInt
Syntax
toInt ()
Return value
Int. Converts a string that represents an integer to a number.
Example
String s="12345";
Int i = s.toInt();
150
A29247-X89-X-3-7678
String - Int64 toInt64
Syntax
toInt64 ()
Return value
Int64. Converts a string that represents a 64bit integer to a number.
Example
String s="12345";
Int64 i = s.toInt64();
A29247-X89-X-3-7678
151
String - Double toDouble
Syntax
toDouble ()
Return value
Double. Converts a string that represents a double value to a number.
Example
String s="12345";
Int64 i = s.toDouble();
152
A29247-X89-X-3-7678
String - Currency toCurrency
Syntax
toCurrency ()
Return value
Currency. Converts a string that represents a currency value to a number.
A29247-X89-X-3-7678
153
Char
Char methods
Int toInt()
String toString()
154
A29247-X89-X-3-7678
Char - Int toInt
Syntax
toInt ()
Return value
Int. Converts a character that represents an integer to a number representing its value in ASCII code.
Example
Char c="1";
Int i = c.toInt();
A29247-X89-X-3-7678
155
Char - String toString
Syntax
toString ()
Return value
String. Converts a character into a string.
Example
Char c="a";
String s = c.toString();
return s; //result is c
156
A29247-X89-X-3-7678
DateTime
DateTime is a basically a real number of Double type, specifying the number of days passed since
December 30st, 1899, 00:00:00.
DateTime methods
String toString()
Double toDouble()
Int getDays()
Void setDays( Int aDays )
Int getDay()
Void setDay( Int aDay )
Int getMonth()
Void setMonth( Int aMonth )
Int getYear()
Void setYear( Int aYear )
Int getDayOfYear()
Void setDayOfYear( Int aDayOfYear )
Void getDMY( Int & aDay, Int & aMonth, Int & aYear )
Int getDayOfWeek()
Void getHMS( Int & aHour, Int & aMinute, Int & aSecond )
Int getHour()
Void setHour( Int aHour )
Int getMinute()
Void setMinute( Int aMinute )
Int getSecond()
Void setSecond( Int aSecond )
Int getMillisecond()
Void setMillisecond( Int aMillisecond )
Int getSecondOfDay()
A29247-X89-X-3-7678
157
Void setSecondOfDay( Int aSecondInDay )
Int getMilisecondOfDay()
Void setMilisecondOfDay( Int aMillisecondInDay )
DateTime Now()
DateTime NowGMT()
158
A29247-X89-X-3-7678
DateTime - String toString
Syntax
toString ()
Return value
String. Converts a DatTime value into a string.
Example
DateTime dt=0.5;
String s = dt.toString();
return s; //result is (String) 30.12.1899 12:00:00:000
DateTime - Double toDouble
Syntax
toDouble ()
Return value
Double. Converts a DateTime value to a double value.
Example
DateTime dt=36970.56;
Double d = dt.toDouble();
A29247-X89-X-3-7678
159
DateTime - Int getDays
Syntax
getDays ()
Return value
Int. Returns an integer value specifying the number of days passed since December 30st,
1899,00:00:00.
Example
DateTime dt;
dt.Day=2;
dt.Month=1;
dt.Year=1900;
Int i = dt.getDays();
160
A29247-X89-X-3-7678
DateTime - Void setDays
Syntax
setDays ( Int aDays )
Return value
Void. Sets the integer value of aDays specifying the number of days passed since December 30st,
1899.
Example
DateTime dt;
dt.setDays(36970.5);
DateTime dt;
dt.Days=36970.5;
A29247-X89-X-3-7678
161
DateTime - Int getDay
Syntax
getDay ()
Return value
Int. Returns an integer value specifying the number of the day in the month of the DateTime value
given.
Example
DateTime dt=1.5; //01/01/1900
Int i = dt.getDay();
162
A29247-X89-X-3-7678
DateTime - Void setDay
Syntax
setDay ( Int aDay )
Return value
Void. Sets an integer value of aDay specifying the number of the day in the month of the DateTime
value given.
Example
DateTime dt;
dt.setDay(31);
A29247-X89-X-3-7678
163
DateTime - Int getMonth
Syntax
getMonth ()
Return value
Int. Returns an integer value specifying the number of the month of the DateTime value given.
Example
DateTime dt=47.5; // 02/1900
Int i = dt.getMonth();
164
A29247-X89-X-3-7678
DateTime - Void setMonth
Syntax
setMonth ( Int aMonth )
Return value
Void. Sets an integer value of aMonth specifying the number the month of the DateTime value given.
Example
DateTime dt;
dt.setMonth(31);
A29247-X89-X-3-7678
165
DateTime - Int getYear
Syntax
getYear ()
Return value
Int. Returns an integer value specifying thee year of the DateTime value given.
Example
DateTime dt=47.5; // 02/1900
Int i = dt.getYear();
166
A29247-X89-X-3-7678
DateTime - Void setYear
Syntax
setYear ( Int aYear )
Return value
Void. Sets an integer value of aYear specifying the year of the DateTime value given.
Example
DateTime dt;
dt.setYear(2002);
A29247-X89-X-3-7678
167
DateTime - Int getDayOfYear
Syntax
getDayOfYear ()
Return value
Int. Returns an integer value specifying the number of the day in the year of the DateTime value given.
Example
DateTime dt=47.5; //15/02/1900
Int i = dt.getDayOfYear();
168
A29247-X89-X-3-7678
DateTime - Void setDayOfYear
Syntax
setDayOfYear ( Int aDayOfYear )
Return value
Void. Sets an integer value of aDay specifying the number of the day in the year of the DateTime value
given.
Example
DateTime dt;
dt.setDayOfYear(31);
A29247-X89-X-3-7678
169
DateTime - Void getDMY
Syntax
getDMY ( Int & aDay, Int & aMonth, Int & aYear )
Return value
Void. Fills the integer variables of aDay, aMonth, aYear by values received from DateTime value given.
Example
DateTime dt;
dt.Days=5;
Int d;
Int m;
Int y;
dt.getDMY(d,m,y);
String s= d.toString()+"/"+m.toString()+"/"+y.toString();
return s; //result is 4/1/1900
Example 2 - Counting days till next Christmas
//Declaration of string constants
String SPassedDate="Passed date is: ";
String SOnly="Only ";
String SDay=" day";
String SDays=" days";
String STillXmas=" till Christmas.";
DateTime dt=dt.Now;
logMessage("The given date is: "+dt.toString()); //we want to see the input
date in the log
//declaration of function counting days until next Christmas from the date
given
170
A29247-X89-X-3-7678
function CountTillXMas(DateTime date): Int
{
function IsLeapYear(Int year): Bool
{
if (year%4!=0) return false;
else if (year<1582) return true; //Adoption of the Gregorian Calendar
else if (year==4840) return false;
else if (year%400==0) return true;
else if (year%100==0) return false;
else return true;
}
DateTime cdt;
cdt=date;
cdt.Day=24;
cdt.Month=12;
if (cdt.Day==date.Day and cdt.Month==date.Month) return 0; //Christmas is
today
else if (cdt.Day<date.Day and cdt.Month==date.Month) //date from December
25th till 31st
{
Int i=358; //number of days from January 1st till December 24st
Bool Temp=IsLeapYear(date.Year+1); //if next year is a leap one than add one
day
if (Temp) i++;
return i + 7-(date.Day-cdt.Day);
}
else return cdt.Days-date.Days;
}
//Declaration of variables
Int d; //day
A29247-X89-X-3-7678
171
Int m; //month
Int y; //year
dt.getDMY(d, m, y);
String StringDate=
SPassedDate+d.toString()+"/"+m.toString()+"/"+y.toString();
String StringXMas;
Int DX=CountTillXMas(dt);
logMessage("The difference is: "+DX.toString());
if (DX==0) StringXMas="It's Chritmas!";
else if (DX==1) StringXMas = SOnly+DX.toString()+SDay+STillXmas;
else StringXMas= SOnly+DX.toString() + SDays+STillXmas;
return StringDate+". "+StringXMas;
172
A29247-X89-X-3-7678
DateTime - Int getDayOfWeek
Syntax
getDayOfWeek ()
Return value
Int. getDayOfWeek returns the day of the week of the specified date as an integer between 1 and 7,
where Sunday is the first day of the week and Saturday is the seventh.
Example
DateTime dt;
dt.Day=15;
dt.Month=10;
dt.Year=2002;
Int i = dt.getDayOfWeek();
return i; //result is 4 (Wednesday)
A29247-X89-X-3-7678
173
DateTime - Void getHMS
Syntax
getHMS ( Int & aHour, Int & aMinute, Int & aSecond )
Return value
Void. Fills the integer variables of aHour, aMinute, aSecond by values received from DateTime value
given.
Example
DateTime dt;
dt.Days=36970.5;
Int h;
Int m;
Int s;
dt.getHMS();
String z= h.toString()+"/"+m.toString()+"/"+s.toString();
return z; //result is 12/0/0
174
A29247-X89-X-3-7678
DateTime - Int getHour
Syntax
getHour ()
Return value
Int. Returns an integer value specifying the number of hour of the day of the DateTime value given.
Example
DateTime dt;
dt.Days=36970;
Int i = dt.getHour();
A29247-X89-X-3-7678
175
DateTime - Void setHour
Syntax
setHour ( Int aHour )
Return value
Void. Sets an integer value of aHour specifying the number of hour of the day of the DateTime value
given.
Example
DateTime dt;
dt.setHour(17);
176
A29247-X89-X-3-7678
DateTime - Int getMinute
Syntax
getMinute ()
Return value
Int. Returns an integer value specifying the number of the minute of hour of the DateTime value given.
Example
DateTime dt;
dt.Days=36970;
Int i = dt.getMinute();
A29247-X89-X-3-7678
177
DateTime - Void setMinute
Syntax
setMinute ( Int aMinute )
Return value
Void. Sets an integer value of aMinute specifying the number of the minute of hour of the DateTime
value given.
Example
DateTime dt;
dt.setMinute(45);
178
A29247-X89-X-3-7678
DateTime - Int getSecond
Syntax
getSecond ()
Return value
Int. Returns an integer value specifying the number of the second of minute of the DateTime value
given.
Example
DateTime dt;
dt.Days=36970;
Int i = dt.getSecond();
A29247-X89-X-3-7678
179
DateTime - Void setSecond
Syntax
setSecond ( Int aSecond )
Return value
Void. Sets an integer value of aSecond specifying the number of the second of minute of the DateTime
value given.
Example
DateTime dt;
dt.setSecond(54);
180
A29247-X89-X-3-7678
DateTime - Int getMillisecond
Syntax
getMillisecond ()
Return value
Int. Returns an integer value specifying the number of the milliseconds of second of the DateTime
value given.
Example
DateTime dt;
dt.Days=36970;
Int i = dt.getMillisecond();
A29247-X89-X-3-7678
181
DateTime - Void setMillisecond
Syntax
setMillisecond ( Int aMillisecond )
Return value
Void. Sets an integer value of aMillisecond specifying the number of the milliseconds of second of the
DateTime value given.
Example
DateTime dt;
dt.setMillisecond(500);
182
A29247-X89-X-3-7678
DateTime - Int getSecondOfDay
Syntax
getSecondOfDay ()
Return value
Int. Returns an integer value specifying the number total number of passed seconds of the day of the
DateTime value given.
Example
DateTime dt;
dt.Days=36970;
dt.Hour=1;
Int i = dt.getSecondOfDay();
A29247-X89-X-3-7678
183
DateTime - Void setSecondOfDay
Syntax
setSecondOfDay ( Int aSecondOfDay )
Return value
Void. Sets an integer value of aSecondOfDay specifying the total number of passed seconds of the day
of the DateTime value given.
Example
DateTime dt;
dt.setSecondOfDay(105654);
184
A29247-X89-X-3-7678
DateTime - getMilisecondOfDay
Syntax
getMillisecondOfDay ()
Return value
Int. Returns an integer value specifying the number total number of passed milliseconds of the day of
the DateTime value given.
Example
DateTime dt;
dt.Days=36970;
dt.Hour=1;
Int i = dt.getMillisecondOfDay();
A29247-X89-X-3-7678
185
DateTime - Void setMilisecondOfDay
Syntax
setMillisecondOfDay ( Int aMillisecondOfDay )
Return value
Void. Sets an integer value of aMillisecondOfDay specifying the total number of passed milliseconds of
the day of the DateTime value given.
Example
DateTime dt;
dt.setMillisecondOfDay(105654000);
186
A29247-X89-X-3-7678
DateTime - DateTime Now
Syntax
Now ()
Return value
DateTime. Returns the current date and time. The returned value is the local time. See also NowGMT
description. It is recommended to manipulate with the UTC (Universal Coordinated Time, aka GMT)
time internally in your application whenever possible since in many countries the local time may be
automatically adjusted when entering or leaving the daylight saving period, which may be confusing.
On the contrary, the UTC time never changes.
Example
DateTime dt;
dt=dt.Now; // September 17th, 2003; 00:40 local time; September 16th, 2003;
23:40 UTC time
Int i = dt.DayOfYear;
A29247-X89-X-3-7678
187
DateTime - DateTime NowGMT
Syntax
NowGMT ()
Return value
DateTime. Returns the current date and time. The returned value is the Universal Coordinated Time
(UTC, aka GMT). It is recommended to manipulate with the UTC time internally in your application
whenever possible since in many countries the local time may be automatically adjusted when entering
or leaving the daylight saving period, which may be confusing. On the contrary, the UTC time never
changes.
Example
DateTime dt;
dt=dt.NowGMT; // September 17th, 2003; 00:40 local time; September 16th,
2003; 23:40 UTC time
Int i = dt.DayOfYear;
188
A29247-X89-X-3-7678
Log - Void logMessage
Syntax
logMessage (String aString)
Return value
Void. Used in script to append an user-defined message aString to the log.
Example
DateTime dt;
dt=dt.Now;
Int h = dt.Hour;
if ((h >=20) or (h<5)) logError ("It's "+h.toString()+" o'clock. You are not
allowed to run this during the night.");
Int n=10;
Int f=0;
{
f=f+i;
if (i==1) logWarning ("This is the first loop");
logMessage("We are now in the loop #"+i.toString());
logMessage("Value of f is now: "+f.toString());
}
A29247-X89-X-3-7678
189
Log - Void logWarning
Syntax
logWarning (String aString)
Return value
Void. Used in script to append an user-defined warning message aString to the log.
Example
DateTime dt;
dt=dt.Now;
Int h = dt.Hour;
Int n=10;
Int f=0;
{
f=f+i;
}
190
A29247-X89-X-3-7678
Log - Void logError
Syntax
logError (String aString)
Return value
Void. Used in script to stop production and append an user-defined error message aString to the
log.
Example
DateTime dt;
dt=dt.Now;
Int h = dt.Hour;
Int n=10;
Int f=0;
{
f=f+i;
}
A29247-X89-X-3-7678
191
192
A29247-X89-X-3-7678
pauseAfterCurrentSheet
Syntax
pauseAfterCurrentSheet(String aString)
Return value
Void. Used in script to allowing to programmatically pause production from within a script. You can
also specify a string aString to show in the event log area.
Example
We want to pause production on each 100th sheet. Insert new calculated bool variable somewhere on
the layout page. The code is:
if(SYS.GlobalSheetCounter%100==0)
{
pauseAfterCurrentSheet('Paused. Current sheet is #' +
SYS.GlobalSheetCounter.toString());
}
When production is started, then on every 100th, 200th etc. sheet the production is paused and the
message indicating current sheet number is shown in the event log area.
A29247-X89-X-3-7678
193
Appendix: Barcodes
A29247-X89-X-3-7678
195
Appendix: Barcodes
Barcodes Overview
You can define the following common properties of all barcodes in the Barcode properties dialog.
Description of the common barcode parameters
Barcode fill Determines the fill style used for barcode.
Background fill Determines the fill style used for background of the barcode.
Variable
Select variable here - its value will be used for creating the barcode.
Data Using this edit field you can either set the value for the static (non-variable) barcode or you can
use it for preview purposes.
Then select the appropriate barcode type in the Select barcode combobox. For additional parameters
description please see the appropriate barcode type below.
196
A29247-X89-X-3-7678
Appendix: Barcodes
2/5 IATA
2/5 Industrial
2/5 Interleaved
2/5 Matrix
Australia Post
Aztec
Codabar
Code 128
Code 128 UPS
Code 39
Code 39 (Full ASCII)
Code 93
Data Matrix
Dutch Post
EAN 128
EAN13
EAN8
Japan Post
Maxi Code
Micro PDF 417
OMR
PDF 417
Post Net
QR
Royal Mail
Super Stealth-Dots
UPC A
UPC E
A29247-X89-X-3-7678
197
Appendix: Barcodes
198
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Datalogic
Description of the barcode parameters
Modul size Width of the narrowest code element (either bar or space) in selected units
Height
Height of the barcode in selected units
See also Barcodes overview for description of the common barcode parameters.
Advanced tab parameters
White space Empty area on each end of the barcode for optimum readability in selected units.
Ratio The larger the ratio value is the wider the barcode output.
Description of the barcode
It is a numeric code with variable length. It is a numeric code in which every decimal digit is
represented by 5 bars, of which 2 are large and 3 are narrow.
Features
•
Numeric code
•
Self-checking code
Advantages
•
High information density
Disadvantages
•
Low tolerance (+/- 10 %)
Set of Characters
•
10 digits
•
1 Start Character
1 Stop Character
A29247-X89-X-3-7678
199
Appendix: Barcodes
Barcodes - 2/5 IATA
Height
Use control check digit
purposes.
When checked then control check digit will be used for self-checking
This code is a discrete code: only bars are significant, spaces do not carry information and can vary, as
regards the width, within wide tolerances.
It is a numeric code in which every decimal digit is represented by 5 bars, of which 2 are large and 3
are narrow.
The nominal printing ratio is 3:1 but can vary from 2:1 to 3:1
The 2/5 5 Bars IATA code is different to the 2/5 5 Bars Industrial code only in the coding of the
Start/Stop characters which are the same of code 2/5 Interleaved.
Features
•
Numeric code
•
Discrete code
•
Self-checking code
Advantages
•
The spaces are not significant
•
High tolerance (+/-15%)
Disadvantages
•
200
Low information density
A29247-X89-X-3-7678
Appendix: Barcodes
Set of Characters
•
10 digits
•
1 Start Character
•
1 Stop Character
A29247-X89-X-3-7678
201
Appendix: Barcodes
Barcodes - 2/5 Industrial
Height
Inverted
The barcode fill style is used for spaces instead of bars while bars are not drawn.
purposes.
This code is a discrete code: only bars are significant, spaces do not carry information and can vary, as
regards the width, within wide tolerances.
It is a numeric code in which every decimal digit is represented by 5 bars, of which 2 are large and 3
are narrow.
The nominal printing ratio is 3:1 but can vary from 2:1 to 3:1
The 2/5 5 Bars Industrial code is different to the 2/5 5 Bars IATA code only in the coding of the
Start/Stop characters which are the same of code 2/5 Interleaved.
Features
•
Numeric code
•
Discrete code
•
Self-checking code
Advantages
•
The spaces are not significant
•
High tolerance (+/-15%)
Disadvantages
202
A29247-X89-X-3-7678
Appendix: Barcodes
•
Set of Characters
•
10 digits
•
1 Start Character
1 Stop Character
A29247-X89-X-3-7678
203
Appendix: Barcodes
Barcodes - 2/5 Interleaved
Height
Type
You can choose among three types:
•
Free format - the standard 2/5 Interleaved format
•
Deutsche Post - Leitcode
•
Deutsche Post - Identcode
purposes.
Another name for this code is ITF (Interleaved Two of Five). It is a continuous numeric code. It has the
same coding as the 2/5 5 bars code, but with the difference that bars and spaces, according to the
procedure hereafter described, represent the digits alternately:
Phase 1: Number from the right to the left the characters to be coded (this must be an even number)
Phase 2: Group the characters two by two with a character in even position to the left and a character
in odd position to the right
Phase 3: For each group:
204
•
consider that the left character is represented by 5 dark bars
•
consider that the right character is represented by 5 light spaces
•
put the 5 bars and 5 spaces of the two characters alternatively starting
A29247-X89-X-3-7678
Appendix: Barcodes
•
from the left with the first bar of the left character
The standard printing ratio is 3:1, but can vary within a field depending on the width X of the module. If
X > 0.5mm, you can use a ratio between 2:1 and 3:1. If X < 0.5mm the field is restricted to 2.25:1 to
3:1.
Features
•
Numeric code
•
Continuous code
•
Self-checking code
Advantages
•
Disadvantages
•
Even spaces are significant
•
Low tolerance (+/- 10 %)
•
Digits can be represented only in an even number of digits
Set of Characters
•
10 digits
•
1 Start Character
•
1 Stop Character
The DeutschePost variations
The DeutschePost barcode is the version of 2/5 Interleaved (Interleaved two of five) barcode. The
structure is described in the DIN EN801 standard.
The Leitcode consists of 14 digits.
Position 1 - 5 =
Post number
Position 6 - 8 =
Street number
Position 9 - 11 =
House number
Position 12 - 13 =
Product code
Position 14 - 14 =
Check digit
A29247-X89-X-3-7678
205
Appendix: Barcodes
The Identcode consists of 12 digits.
Position 1 - 2 =
Transport Post Centre
Position 3 - 5/6/7 =
Sender number 3, 4, or 5 characters
Position 6/7/8 - 11 =
Position 12 - 12 =
Admissions number 6,5 or 4 characters
Check digit
Deutsche Post AG controls the assignment of a Sender number with accordance of the package
volume. Value of the Admission number depends on the Sender number.
The Ratio (ratio the narrow Module to wide Module) has to be 1:2 as minimum and 1:3 as maximum.
The Width of narrow Module is in the scape 0.375-0.500 mm.
The barcode Length (including 5 mm blank zone on the both left and right barcode margin) has to be:
in case of Leitcode from 47.25mm to 77.5mm
in case of Identcode from 42mm to 68.5mm
Check digit
Check digit has to be computed before creating of the barcode. Computation is performed in
accordance of the DIN EN801 standard, however with the changed executed Factor. This way
prevents that another barcodes 2/5 Interleaved on parcels would be read and misinterpreted.
206
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - 2/5 Matrix
Height
purposes.
Start/Stop wide char koef This value determines the coefficient, that is used for computation of
width of the wide element of Start/Stop character. The wide element of Start/Stop character is from 1.5
up to 4 times wider than a wide element of another characters.
This discrete code is a numeric one with a variable width. Bars and spaces are significant. Every
decimal digit is represented by 5 elements (3 bars and 2 spaces), of which two are large and three are
narrow.
The nominal printing ratio is 3:1 but can vary from 2.25:1 to 3:1.
The 2/5 Matrix Code has one Start resp. one Stop character only. The wide element of Start/Stop
character is from 1.5 up to 4 times wider than a wide element of another characters.
Features
•
Numeric code
•
Discrete code
•
Self-checking code
Advantages
•
A29247-X89-X-3-7678
207
Appendix: Barcodes
Disadvantages
•
Low tolerance (+/-10%)
Set of Characters
•
10 digits
•
1 Start Character
1 Stop Character
208
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Australia Post
Height
Australia's Postal Bar-Code (Standard Customer Barcode 1) is a Reed-Solomon version
of 4-State symbology. This barcode comprises four types of bars (the four 'states'), each of which has a
distinct name, value and barcode symbol.
The values of the four states are defined in the following table:
Bar Elements Bar State Value
T Tracker: 3
D Tracker, Descender: 2
A Tracker, Ascender: 1
H Tracker, Ascender, Descender: 0
The generation of the barcode initially focuses on creating a string representation of the barcode
containing Bar State values. As a final step, the string of Bar State values are printed as their
associated barcode characters.
The main component of the barcode is the Delivery Point Identifier (DPID).
Around the encoding of the DPID, a number of other element are added to the customer barcode to
provide greater barcode robustness.
Each barcode contains the following bars and fields:
1. Start Bars
2. Format Control Code Field
3. Sorting Code Field (DPID)
4. Filler Bar
A29247-X89-X-3-7678
209
Appendix: Barcodes
5. Reed Solomon Error Correction Parity values
6. Stop Bars
Only the Sorting Code Field (DPID) is fulfilled by a Customer, the others are fulfilled automatically.
The Sorting Code Field identifies the Delivery Point Identifier, an eight-digit number that encodes the
destination of a piece of mail.
The Start Bars ensure that the beginning of the barcode can never be mistaken. Like the Start Bars,
the Stop Bars ensure that the bar is read the right way around. The Reed Solomon Error Correction
Bars perform a quality control check on the barcode.
The Format Control Code (FCC) Field identifies the barcode’s format; the particular configuration of
fields and bars that applies to the whole barcode.
This field always occupies bar positions 3 to 6 (inclusive) in every barcode.
210
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Aztec
Quiet zone Empty area on each side of the barcode for optimum readability in selected units.
Aztec Code is a two-dimensional matrix symbology containing dark and light square data modules. It
has a finder pattern of concentric square rings centered on a single dark module located in the center
of the symbol. A two-dimensional imaging device such as a CCD camera is necessary to scan the
symbology. Aztec Code is designed with user-selectable percentages of error correction. It supports
industry standard escape sequences to define international code pages and special encodation
schemes. Aztec Code is used for small item marking applications using a wide variety of printing and
marking technologies.
Aztec Code was invented by Andy Longacre of Welch Allyn Inc. in 1995 and is in the public domain.
Aztec Code was designed for ease-of-printing and ease-of-decoding. The symbols are square overall
on a square grid with a square central bullseye finder. The smallest Aztec Code symbol is 15x15
modules square, and the largest is 151x151. The smallest Aztec Code symbol encodes 13 numeric or
12 alphabetic characters, while the largest Aztec Code symbol encodes 3832 numeric or 3067
alphabetic characters or 1914 bytes of data. No quiet zone is required outside the bounds of the
symbol . There are 32 sizes in all with user-selected amounts of Reed-Solomon error encoding from
5% to 95% of data region. Recommended level is 23% of symbol capacity plus 3 codewords
All 8-bit values can be encoded. Values 0 - 127 are interpreted as the ASCII character set while values
128 - 255 are interpreted as ISO 8859-1, Latin Alphabet No. 1. Two non-data characters can be
encoded, FNC1 for compatibility with some existing applications and ECI escape sequences for the
standardized encoding of message interpretation information.
A29247-X89-X-3-7678
211
Appendix: Barcodes
Barcodes - CodaBar
Height
Use checksum
When checked then control check digit will be used for self-checking purposes.
Codabar Monarch
When checked then Codabar Monarch variation is used.
The Codabar has developed by Monarch Marking Systems, and hence this Codabar with two element
widths may be refered as 'NW7 Code'.
Each character is coded with seven elements, four bars and three spaces. The character are
separated by an intercharacter space. The symbol dimension depends upon the module width and on
the printing ratio.
Height
The height of the bars depends upon the application field. The minimum height for using optics wands
or contact readers in order to facilitate easy reading is 6.5 mm or 15% of the code length. When using
laser guns or scanners the bar height must be at least 20mm or 20% of the code length.
Ratio
The printing ratio can vary in the interval of 2:1 to 3:1, restricted from 2.25:1 to 3:1 if the module width
is less than 0.5mm.
Features
212
•
Numeric code with special characters
•
Discrete code
A29247-X89-X-3-7678
Appendix: Barcodes
•
Self-checking code
Advantages
•
•
High tolerance (+/- 25%)
Disadvantages
•
Spaces inside a character are significant
Set of Characters
•
10 digits
•
6 special characters
•
4 start/stop character
Check Digit Calculation
If used, the check character is placed immediately after the last data character and before the stop
character. For each Codabar character a numeric value is assigned and then these values are added,
including the start/stop characters.
Divide the result by 16, then subtract the remainder from 16 to get the check digit.
A29247-X89-X-3-7678
213
Appendix: Barcodes
Barcodes - Code 128
Height
purposes.
This barcode is able to code the complete set of 128 ASCII characters, plus four functional characters.
Moreover, numeric data is encoded in a double density compact form: i.e. two digits for each character.
Each character consists of 11 modules divided into three bars and three spaces (except for the stop
character). The bars inside the same character are always formed by an even number of modules
(even parity as a consequence the spaces occupy an odd number of modules. The elements (bars and
spaces) have complete width multiples (from 1 to 4) of the module.
The symbols in Code 128 have two in-built checks that minimize the possibility of errors during reading:
the self-checking of the characters (on parity) and a check digit modulus 103. A symbol consists of a
sequence of characters enclosed by two quiet zones. The sequence begins with a start character
followed by data and special characters, with the most significant character adjacent to the start
character, the check digit, and ends with a stop character.
Code 128 has three character subsets, called Code A, B and C. Each coded character of bars and
spaces correspondent to one of the three subsets A, B and C, according to the used start character or
previous subset selection character or shift character selected. If the symbol begins with the start
character A the subset Code A is selected.
In the same way, the subset Code B or C can be selected by starting the symbol with the
corresponding start character. The subset can be changed inside the symbol with the selection
characters A, B or C or with the shift characters. The same data can therefore be represented by
different symbols in Code 128 by the use of different combinations of start, code and shift characters.
Code 128 can be printed in several densities, depending upon the printing process and the reading
systems. The significant dimension is the element width X of the module, whose minimal nominal value
is 0.19mm.
The nominal width of bars and spaces is derived from the multiplication of the width X of the module by
the width in modules of the bars and spaces themselves (1,2,3 or 4).
214
A29247-X89-X-3-7678
Appendix: Barcodes
The minimum width of the quiet zone is 2.54mm, or ten times the module width, whichever is greater.
For most common applications the minimum height of the bars is 6.35mm, or 15% of the symbol
length, again, whichever is the greater.
Features
•
Alphanumeric code with special characters
•
Continuous code
•
Self-checking code
Advantages
•
Representation of the complete set of ASCII characters
•
High tolerance
Disadvantages
•
•
Spaces are significant
Set of Characters
•
128 alphanumeric and special characters (set ASCII)
•
4 functional characters
•
4 subset selection characters
•
3 start characters
•
1 stop character
The check character immediately precedes the stop character. The check character value is the sum
modulus 103 of the code as follows:
The code is read from the left to the right starting with the start character. All the characters are written
as their associated value number. Apart from the start character, these numbers are the multiplied by
their relative positions in the code (taking the start digit position as zero i.e. 0,1,2,3...) All the values are
then added together and then divided by 103. The remainder from this calculation is re-coded using the
coding table giving you the check digit that is placed in front of the stop character.
The decoder does not transmit the control characters, the start/stop function and subset selection
characters.
Function character FNC1
A29247-X89-X-3-7678
215
Appendix: Barcodes
This character is coded in the barcode when the hexadecimal value 0xF1 (decimal 241) appears in the
input data.
216
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Code 128 UPS
Height
purposes.
This barcode is able to code the complete set of 128 ASCII characters, plus four functional characters.
Each character consists of 11 modules divided into three bars and three spaces (except for the stop
(even parity); as a consequence the spaces occupy an odd number of modules. The elements (bars
and spaces) have complete width multiples (from 1 to 4) of the module.
The symbols in Code 128 have two in-built checks that minimize the possibility of errors during reading:
the self-checking of the characters (on parity) and a check digit modulus 103. A symbol consists of a
sequence of characters enclosed by two quiet zones. The sequence begins with a start character
followed by data and special characters, with the most significant character adjacent to the start
character, the check digit, and ends with a stop character.
Code 128 has three character subsets, called Code A, B and C. Each coded character of bars and
character A the subset Code A is selected.
correspondent start character. The subset can be changed inside the symbol with the selection
different symbols in Code 128 by the use of different combinations of start, code and shift characters.
Dimension and Tolerances
A29247-X89-X-3-7678
217
Appendix: Barcodes
Code 128 can be printed in several densities, depending upon the printing process and the reading
systems. The significant dimension is the element width X of the module, whose minimal nominal value
is 0.19mm. The nominal width of bars and spaces is derived from the multiplication of the width X of
the module by the width in modules of the bars and spaces themselves (1,2,3 or 4). The minimum
width of the quiet zone is 2.54mm, or ten times the module width, whichever is greater.
Features
•
•
Continuous code
•
Self-checking code
Advantages
•
•
High tolerance
Disadvantages
•
•
Set of Characters
•
•
•
•
3 start characters
•
1 stop character
modulus 103 of the code as follows: The code is read from the left to the right starting with the start
character. All the characters are written as their associated value number. Apart from the start
character, these numbers are the multiplied by their relative positions in the code (taking the start digit
position as zero i.e. 0,1,2,3...). All the values are then added together and then divided by 103. The
UPS has a special check digit calculation done before the normal check digit calculation.
218
A29247-X89-X-3-7678
Appendix: Barcodes
characters.
A29247-X89-X-3-7678
219
Appendix: Barcodes
Barcodes - Code 39
Height
purposes.
This Barcode allows the coding of 43 characters, all of which are represented by 9 elements, 5 bars
and 4 spaces; 3 elements are wide and 6 elements are narrow.
The inter-character space normally has the same width as a module, but can be up to three times
larger than this.
Height
Width
The smallest nominal width of of the module is 0.19mm, for printing high density codes. You can create
a smaller font, but a warning appears before creating.
Ratio
is less than 0.5mm.
Features
220
•
•
Discrete code
A29247-X89-X-3-7678
Appendix: Barcodes
•
Self-checking code
Advantages
•
Representation of alphabetic, numeric and special characters
Disadvantages
•
•
Space inside a character are significant
•
Low tolerance (+/- 10%)
Set of Characters
•
10 digits
•
26 alphabetic characters
•
7 special characters
•
1 start/stop character (special character '*’)
The check digit, which is added to the right of the data characters, is calculated using modulo 43.i.e.
each character is allocated an individual number which are added together. The resultant is then
divided by 43, and the remainder is converted back to its corresponding character and placed to the
right of the code.
A29247-X89-X-3-7678
221
Appendix: Barcodes
Barcodes - Code 39 (Full ASCII)
Height
purposes.
The enhanced Code 39 allows the coding of full ASCII table.
By combining of special characters ($, /,%, +) with the alphanumeric ones it is possible to cover
complete ASCII table.
Height
Width
a smaller font, but a warning appears before creating.
Ratio
is less than 0.5mm.
Features
222
•
Discrete code
•
Self-checking code
A29247-X89-X-3-7678
Appendix: Barcodes
Advantages
•
Representation of full ASCII table
Disadvantages
•
•
Space inside a character are significant
•
The check digit, which is added to the right of the data characters, is calculated using modulo 43.i.e.
each character is allocated an individual number which are added together. The resultant is then
divided by 43, and the remainder is converted back to its corresponding character and placed to the
right of the code.
A29247-X89-X-3-7678
223
Appendix: Barcodes
Barcodes - Code 93
Height
Extended mode When checked then the extended Code 93 (Full ASCII) is used that covers
complete ASCII table.
This Barcode allows the coding of 43 characters, all of which are represented by 6 elements, 3 bars
and 3 spaces.
The summary of elements length of the each character is always 9 basic modules X. Only stop
character consists of 4 bars and 3 spaces with summary length of 10 basic modules X.
The symbol dimension depends upon the module width.
Height
Width
a smaller font but a warning appears before creating.
Features
•
•
Discrete code
•
Self-checking code
Advantages
224
A29247-X89-X-3-7678
Appendix: Barcodes
•
Representation of alphabetic, numeric and special characters
•
Disadvantages
•
The space inside a character are significant
•
Set of characters
•
10 digits
•
26 alphabetic characters
•
7 special characters (-,.,SPACE,$,/,+,%)
•
1 start/stop character (START=( STOP=) )
The 2 check digits, which are added to the right of the data characters, are calculated using modulo
47.i.e. each character is allocated an individual number which are added together. The resultant is then
divided by 47, and the remainders are converted back to its corresponding character and placed to the
right of the code.
A29247-X89-X-3-7678
225
Appendix: Barcodes
Barcodes - Data Matrix
Quiet zone Empty area on each side of the barcode for optimum readability in multiples of the module
size.
DataMatrix is a two-dimensional matrix symbology that is made up of square modules arranged within
a perimeter finder pattern. It is primarily dark symbol on light background but DataMatrix symbols can
also be printed to appear as light on dark.
DataMatrix symbol is capable of encoding up to 2334 ASCII characters.
The width, height and error correction level are automatically chosen during production, depending on
the size of the data after conversion to codewords (unit of information coded in the barcode), according
to the AIM USA norm.
The conversion will fail if the dimensions given are too big to represent the data
Special characters
DataMatrix is able to represent any 8 Bit binary data.
226
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Dutch Post
Height
The KIX 4 State Customer Code (Dutch Post) is a barcode symbology based on the Royal Mail for use
in automated mail sortation processes. The character set includes both Alpha and Numeric characters
and enables a high data encoding density and processing speed with all types of printing systems.
A Complete KIX consists of a set of distinct bars and spaces for each character without any checksum
character. Each alphanumeric character consists of 4 bars of which 2 bars have ascenders and 2 bars
have descenders. The track element is present in all bars.
State Alphanumeric Character Equivalents
Using this form of coding there are 36 valid characters in the character set, these being numeric
characters 0-9 and alpha character A-Z.
Maximal length of the input data string is 18 characters!
Start and Stop Bars
Start and stop bars are not present.
Checksum Character
The checksum character is not present.
A29247-X89-X-3-7678
227
Appendix: Barcodes
Barcodes - EAN 128
Height
purposes.
Validate string
barcode.
When checked then typed string value is validated before actual drawing of the
This Barcode is able to code the complete set of 128 ASCII characters, plus four functional characters.
Each character consists of 11 modules divided into 3 bars and 3 spaces (except for the stop
(even parity); as a consequence the spaces occupy an odd number of modules. The elements (bars
and spaces) have complete width multiples (from 1 to 4) of the module.
The symbols in EAN 128 have two in-built checks which minimize the possibility of errors during
reading: the self checking of the characters (on parity) and a check digit modulus 103. A symbol
consists of a sequence of characters enclosed by two quiet zones. The sequence begins with a start
character followed by data and special characters, with the most significant character adjacent to the
start character, the check digit, and ends with a stop character.
EAN 128 has three character subsets, called Code A, B and C. Each coded character of bars and
character A then the subset Code A is selected.
corresponding start character. The subset can be changed inside the symbol with the selection
different symbols in EAN 128 by the use of different combinations of start, code and shift characters.
Dimension and Tolerances
228
A29247-X89-X-3-7678
Appendix: Barcodes
EAN 128 can be printed in several densities, depending upon the printing process and the reading
systems.
The significant dimension is the element width X of the module, whose minimal nominal value is
0.19mm.
The nominal width of bars and spaces is derived from the multiplication of the width X of the module by
the width in modules of the bars and spaces themselves (1,2,3 or 4).
The minimum width of the quiet zone is 2.54mm, or ten times the module width, whichever is greater.
Features
•
•
Continuous code
•
Self-checking code
Advantages
•
•
High tolerance
•
Disadvantages:
•
•
Set of Characters
•
•
•
•
3 start characters
•
1 stop character
modulus 103 of the code as follows:
The code is read from the left to the right starting with the start character. All the characters are written
as their associated value number. Apart from the start character, these numbers are the multiplied by
their relative positions in the code (taking the start digit position as zero i.e. 0,1,2,3...).
A29247-X89-X-3-7678
229
Appendix: Barcodes
All the values are then added together and then divided by 103. The remainder from this calculation is
re-coded using the coding table giving you the check digit which is placed in front of the stop character.
characters.
230
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - EAN 13
Override height
Height
When checked then you can manually control the height of the barcode.
EAN Coding is designed to represent the numeric code of each article submitted to the EAN
specifications (European Article Number) in a format automatically readable in both directions.
The EAN Code is completely compatible with the UPC code (Universal Product Code).
The elements can assume different widths, complete multiples of a module. Each character is coded
with 7 modules. The central check digit consists of 5 modules; the start/stop character of 3 modules.
The EAN symbols are placed symmetrically around a central check character and terminated by lateral
check character (start / stop).
Features
•
Numeric code
•
Continuous code
•
Self-checking code
Advantages
•
Disadvantages
•
Fixed number of digits
•
The spaces are significant
Set of Characters
•
10 digits
A29247-X89-X-3-7678
231
Appendix: Barcodes
•
•
1 central check character
Characters coding
The decimal digits are represented through three different codings, named A, B and C.
The codings A and B always begin with a space and end with a bar, the coding C always begin with a
bar and end with a space.
Structure of an EAN 13 symbol:
The symbol EAN 13 consists of the following sequence described from the right to the left:
•
lateral check character (start/stop)
•
6 characters representing according to the coding C forming the right half
•
central check character
•
6 characters with coding A or B forming the left half of the symbol
•
lateral check character
•
A 13th character is determined by which columns the 7th to 12th (left half) characters were
selected from.
Check Digit calculation
The character placed to the right assumes the check digit function and is calculated with modulo 10
weight 3. (Resp. 10 minus modulo 10, weight 3 )
Dimensions
The nominal width of the module is 0.33mm. The nominal dimensions of the label can be multiplied by
a magnification factor between 0.8 and 2.
The bars of the central and lateral check characters are extended for 5 modules below the bars
representing the useful characters.
The area of light margin around the printed area correspondents to:
7 modules to the right of the symbol
11 modules to the left of the symbol
1 module over the symbol
1 module between the bottom of the bars and the OCR B placed under them
The length of the symbol is therefore 95 modules plus 18 modules for the overflow areas.
232
A29247-X89-X-3-7678
Appendix: Barcodes
A29247-X89-X-3-7678
233
Appendix: Barcodes
Barcodes - EAN8
Override height
Height
When checked then you can manually control the height of the barcode.
EAN Coding is designed to represent the numeric code of each article submitted to the EAN
specifications (European Article Number) in a format automatically readable in both directions.
The EAN Code is completely compatible with the UPC code (Universal Product Code).
The elements can assume different widths, complete multiples of a module. Each character is coded
with 7 modules. The central check digit consists of 5 modules; the start/stop character of 3
modules.The EAN symbols are placed symmetrically around a central check character and terminated
by lateral check character (start/stop).
Features
•
Numeric code
•
Continuos code
•
Self-checking code
Advantages
•
Disadvantages
•
•
Set of Characters
234
•
10 digits
•
•
A29247-X89-X-3-7678
Appendix: Barcodes
Characters coding
The decimal digits are represented through two different codings, named A and C.
The codings A always begin with a space and end with a bar, the coding C always begin with a bar and
end with a space.
Structure of an EAN 8 symbol
The symbol EAN 8 consists of the following sequence described from the right to the left:
•
lateral check character (start/stop)
•
4 characters representing according to the coding C (numbered from 1 to 4) forming the right
half of the symbol
•
central check character
•
4 characters with coding A (numbered from 5 to 8) forming the left half of the symbol
•
lateral check character
The character placed to the right assumes the check digit function and is calculated with modulo 10
weight 3. (Resp. 10 minus modulo 10, weight 3 )
Dimensions
a magnification factor between 0.8 and 2.
The bars of the central and lateral check characters are extended for 5 modules below the bars
representing the useful characters.
The area of light margin around the printed area correspondents to:
•
7 modules to the right of the symbol
•
7 modules to the left of the symbol
•
1 module over the symbol
•
1 module between the bottom of the bars and the OCR B placed under them
The length of the symbol is therefore 67 modules plus 14 modules for the overflow areas.
A29247-X89-X-3-7678
235
Appendix: Barcodes
Barcodes - Japan Post
Japan's Postal Bar-Code is a non-Reed-Solomon version of 4-State symbology (like Royal Mail) which
encodes Numerals and a Hyphen in 3-bar sequences and the Latin Alphabet in 6-bar sequences, with
2-bar Start and Stop sequences and a single modulo 19 check character.
CPI definition
The CPI parameter represents the number of Codewords Per Inch. 2 densities are allowed.
236
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Maxi Code
Mode from data When checked then three modes of data input are recognized as described below.
Then the mode is controlled by the leading characters, for example: (4,0,42,0,1,1)MaxiCode TNG - Our
input type
MaxiCode is a fixed-size matrix symbology that is made up of offset rows of hexagonal modules
arranged around a unique finder pattern, also called a bull's eye.
The 33 rows in the symbol alternate between 30 and 29 modules in width. The symbol should be
surrounded on all four sides by a quiet zone border of approximately 1 mm (.04”).
A MaxiCode symbol contains 144 symbol characters in the primary and secondary messages.
The maximum of symbolic data codewords is 93. If the data to be encoded is all-numeric, 138 digits
can be encoded.
If the data contains only uppercase letters, digits and punctuation, 93 characters can be encoded. If the
data contains any character in a 256 character set, the encoding capacity is decreased.
MaxiCode symbology has features that make it suitable for high speed omni-directional scanning; with
an encoding capacity greater than a linear bar code symbology, but smaller than some other 2dimensional symbologies (e.g. PDF417, also available for PrintNet).
The implementation of MaxiCode is based on the United Parcel Service Maxicode encoding software
version 3.1. (The changes concerning the 31st element of 'tableA', 'tableB', 'tableC', 'tableD' and the
elements 36, 37 and 44 in 'dtableB' have been made).
Three modes of data input are recognized :
•
Structured Carrier Message beginning with '[)>(RS)01(GS)'
•
Structured Carrier Message NOT beginning with '[)>(RS)01(GS)'
A29247-X89-X-3-7678
237
Appendix: Barcodes
•
PrintNet-Specific Input format
Structured Carrier Message beginning with '[)>(RS)01(GS)':
[)>(RS)01(GS)<YY(Year)><Zip>(GS)<Country>(GS)<Service>(GS)<Secondary>(RS)(EOT)
Structured Carrier Message NOT beginning with '[)>(RS)01(GS)':
<Zip>(GS)<Country>(GS)<Service>(GS)<Secondary>(EOT)
For a full description of the Structured Carrier Message Format, refer to :
'International Symbology Specification - MaxiCode'
Ref. : ANSI/AIM BC10-1997;May 8, 1997 - Chap. B.2, B.3
Note
•
(RS) is ascii-code 0x1e
•
(GS) is ascii-code 0x1d
•
(EOT) is ascii-code 0x04
PrintNet-Specific Input format
The input format is the following:
(mode, Zip Code, Country Code, Service Class, Symbol Number, Number of Symbols) Secondary
message
You must enclose the parameters in parenthesis. All the parameters are optional. A default value is
used when they are omitted.
Mode: Default Value is 4
2, 3:
Structured Carrier Message
4:
Standard Symbol
6:
Reader Programming
Zip Code:
Default Value is <Empty>
when Numeric:
up to 9 digits (Zip+4 for USA)
when Alpha-Numeric:
Country Code:
238
up to 6 characters
3 digits (ISO country code). Default Value is 0
A29247-X89-X-3-7678
Appendix: Barcodes
Service Class:
3 digits. Default Value is 0
Symbol Number:
Number of symbols:
Range 1-8. Default Value is 1.
Range 1-8. Default Value is 1.
The conversion is, as above, based on UPS MaxiCode encoding software; therefore the same
restrictions apply.
Special characters
MaxiCode is able to represent any 8 Bit binary data (Mode 4). Since the use of special characters
under decimal 32 (0x20) is not possible in Windows, please use the following syntax in the data record
:
\\t to represent a Tabulation (0x09).
\\r to represent a Carriage-Return (0x0D)
\\n to represent a Line-Feed (0x0A)
\\xXX where XX represent an hexadecimal value (even 0)
\\oOOO where OOO represent an octal value (even 0)
Codeword coding / CPI definition
The MaxiCode is available in only one size : the size of the symbol is 1\x1\. As there may be 30
hexagons on one row the unique CPI is 30.
Character set
1 \Half Space\
2 Hexagons (Black/White)
90 characters to represent the finding pattern.
A29247-X89-X-3-7678
239
Appendix: Barcodes
Barcodes - Micro PDF 417
Module width Width of the narrowest code element (either bar or space) in selected units
Module height ratio
Multiple of module width: element height = module width * module height ratio
Quiet zone in modules Empty area on each side of the barcode for optimum readability in multiples of
the module size.
The MicroPDF417 is a multi-row, variable-length symbology offering high data capacity and errorcorrection capability.
MicroPDF417 can be scanned by linear scanners, rastering laser scanners, or two dimensional
imaging devices.
One MicroPDF417 symbol is capable of encoding 150 bytes or 250 ASCII characters or 366 digits.
Every MicroPDF417 symbol is composed of a stack of rows, from a minimum of 4 to a maximum of 44
rows. Each row within a MicroPDF417 symbol has the following structure:
1. leading Quiet Zone;
2. left MicroPDF417 Row Address Pattern;
3. one of the following:
a. for the one-column version, one PDF417 codeword, or
b. for the two-column version, two PDF417 codewords, or
c. for the three-column version, one PDF417 codewords, followed by a Center Row
Address Pattern and two more PDF417 codewords, or
d. for the four-column version, two PDF417 codewords, followed by a Center Row
Address Pattern and two more PDF417 codewords;
4. Right MicroPDF417 Row Address Pattern;
5. one-module stop bar;
6. trailing Quiet Zone.
240
A29247-X89-X-3-7678
Appendix: Barcodes
Characteristics
•
Encodable Character Set: 8-Bit Binary Data
•
Code Type: Continuous, Multi-Row, Self Checking
•
Symbol size: Variable
•
Bi-directional decoding: Yes
•
Error correction: Characters 7 to 50
Ratio
The basic ratio R1.00 is equal 3*Xelement. It means that the height of the one row is equal 3*narrowest
bar. When the user chooses another ratio, (e.g. R1.10), it means that new ratio is equal
1.10*3*Xelement.
Special parameters
However, if you need to define specific characteristics you can override the default values by adding
the necessary parameters at the start of each data field.
Codeword coding / CPI definition
Each codeword excepted Pattern Codewords are made of 4 Bars and 4 Spaces.
Each Bar/Space has a width of 1 to 6 base modules. Each Codeword has a total width of 17 modules.
The CPI parameter represent the number of Codewords Per Inch. 10 densities are allowed
corresponding to module width of 1 to 10 dots.
A29247-X89-X-3-7678
241
Appendix: Barcodes
Barcodes - OMR
Prepend str pattern
String that is added before the data
Modul width
Width of module in selected units
Modul height
Height of module in selected units
Modul shift
Adjustment of spacing of the modules
Begin and End quiet zone Empty area on each side of the barcode for optimum readability.
OMR is one-dimensional barcode consisting of only 0's and 1's.
The computation of placement of a module is as follows:
(Modul width + Modul shift) * Modul index + Quiet zone
Data can also contain characters P or N (case sensitive). P character is replaced by 1, when data
contains even number of 1's.
N = ! P.
242
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - PDF 417
Modul width Width of the narrowest code element (either bar or space) in selected units
Module height ratio
Multiple of module width: element height = module width * module height ratio
Quiet zone in modules Empty area on each side of the barcode for optimum readability in multiples of
the module size.
PDF417 is a multi-row, variable-length symbology offering high data capacity and error-correction
capability. PDF417 can be scanned by linear scanners, rastering laser scanners, or two dimensional
imaging devices. One PDF417 symbol is capable of encoding more than 1100 bytes, 1800 ASCII
characters, or 2700 digits.
Every PDF417 symbol is composed of a stack of rows, from a minimum of 3 to a maximum of 90 rows.
Each PDF417 row contains start and stop patterns, left and right row indicator, and from one to thirty
data symbol characters. Since both the number of rows and their length are selectable when printed,
the aspect ratio of a PDF417 symbol can be varied to suit spatial requirements for printing.
Characteristics
•
Encodable Character: Set8-Bit Binary Data
•
Code Type: Continuous, Multi-Row, Self Checking
•
Symbol size: Variable
•
Bidirectionnal decoding: Yes
•
Error correction: Characters 2 to 512
Additionnal features
•
Selectable levels of error corrections
•
Can utilize scans that cross rows
A29247-X89-X-3-7678
243
Appendix: Barcodes
Special parameters
However, if you need to define specific characteristics you can override the default values by adding
the necessary parameters at the start of each data field.
Character set
•
1 Start character
•
36 characters to represent the data
1 Stop character
244
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - QR
Quiet zone Empty area on each side of the barcode for optimum readability in selected units
Error level You can select among four levels of error correction allowing recovery of:
•
L
7%
•
M
15%
•
Q
25%
•
H
30%
QR Code is a matrix symbology consisting of an array of nominally square modules arranged in an
overall square pattern, including a unique finder pattern located at three corners of the symbol and
intended to assist in easy location of its position, size and inclination.
A wide range of sizes of symbol is provided for together with four levels of error correction.
Characteristics
Encodable Character Set:
1. numeric data (digits 0 - 9)
2. alphanumeric data (digits 0 - 9; upper case letters A -Z; nine other characters: space, $ % * + ./:)
3. 8-bit byte data (JIS 8-bit character set (Latin and Kana) in accordance with JIS X 0201)
4. Kanji characters (Shift JIS character set in accordance with JIS X 0208 Annex 1 Shift Coded
Representation.
Note that Kanji characters in QR Code can have values 8140HEX -9FFCHEX and E040HEX EBBFHEX , which can be compacted into 13 bits.)
Representation of data
A29247-X89-X-3-7678
245
Appendix: Barcodes
A dark module is a binary one and a light module is a binary zero.
Symbol size (not including quiet zone)
21 * 21 modules to 177 * 177 modules (Versions 1 to 40, increasing in steps of 4 modules per side)
Data characters per symbol (for maximum symbol size - Version 40-L)
1. numeric data: 7,089 characters
2. alphanumeric data:
4,296 characters
3. 8-bit byte data:
2,953 characters
4. Kanji data:
1,817 characters
Selectable error correction
Four levels of error correction allowing recovery of:
L
7%
M
15%
Q
25%
H
30%
246
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Post Net
Full bar height
Height of the tall bars in selected units
Half bar height
Height of the short bars in selected units
Bars pitch
units
The distance between end of bar and beginning of the next bar (space width) in selected
Planet Code When checked then PLANET symbology is used. PLANET symbology is the inverse of
PostNet. All PLANET barcodes include a five-bar checksum digit (or correction character). This digit is
always the number which, when added to the sum of the other digits in the barcode, results in a total
that is a multiple of 10.
The POSTNET (POSTal Numeric Encoding Technique) barcode was developed by the Postal Service
to encode ZIP Code information on letter mail for rapid and reliable sorting by barcode sorters.
The POSTNET barcode can represent a five-digit ZIP Code (32 bars), a nine-digit ZIP+4 code (52
bars), or eleven-digit delivery point code (62 bars).
POSTNET Format
Whether it represents five-, nine-, or eleven-digit ZIP Code information, the POSTNET barcode is
always printed in a format that begins and ends with a frame bar (full or tall bar). To ensure POSTNET
accuracy during mail processing, a correction character (five bars) must be included immediately
before the rightmost frame bar of all POSTNET barcodes.
The correction character is always the digit that, when added to the sum of the other digits in the
barcode, results in a total that is a multiple of 10.
For example, the sum of the ZIP+4 barcode 12345-6789 is 45. Adding a correction character of 5
results in the sum of the 10 digits being a multiple of 10.
Code Elements and Code Characters
The basic elements of the POSTNET barcode are binary digits, represented as full bars and half bars
(or tall bars and short bars). A full bar represents '1' (one) and a half bar represents '0' (zero).
A29247-X89-X-3-7678
247
Appendix: Barcodes
Each code character is made up of five bars, which together represent a single numeric digit. Specific
combinations of two full and three half bars represent the digits 0 through 9. Only the 10 combinations
are valid code characters - they represent all possible combinations of two full bars and three half bars.
These combinations are central to the error-recovery of POSTNET because the system interprets as
an error the combination of five bars containing other than two full and three half bars.
248
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Super Stealth-Dots
Modul Size
Width and height of the dot in selected units
White space Empty area on each side of the barcode for optimum readability in multiples of the
module size.
Super Stealth-Dots is a multi-row, variable-length symbology offering high data capacity and errorcorrection capability.
One Super Stealth-Dots symbol is capable of encoding from 1 up-to 70 ASCII characters into an MxN
dot matrix in two dimensions. The alphanumeric information is encoded and printed in a precise
location on the product that can be subsequently read by cameras and decoded by proprietary
software. It represents alphanumeric data in a base 64 numeric system.
The symbol uses the Hamming error correction method and check character to ensure reading
reliability.
Each Stealth-Dots symbol consists of a matrix of dots framed by clear space.
An element within the matrix is represented by the presence or absence of a digitally printed dot. The
presence of the dot is assigned a value '1' and the absence means '0'. The upper-leftmost dot and the
bottom-rightmost dot are always present in the matrix, which is a fixed dot-pattern used for frame
reference to define the upper left and bottom right corner for a rectangle or square frame for Super
Stealth-Dots matrices.
Characteristics
Encodable Character Set:All numeric characters
Code Type: Two dimensions
Symbol check character: One
Symbol size
A29247-X89-X-3-7678
249
Appendix: Barcodes
Height:
Width:
Error correction:
variable (>3rows)
variable (>3rows)
Hamming
Special parameters
The width, height and error correction byte are automatically computed and chosen during production,
depending on the size of the data after conversion to codewords (unit of information coded in the
barcode).
The size of the Super Stealth-Dots symbol can be varied in application depending on the size of the
character string you wish to encode. In general, a Super Stealth-Dots symbol is designed as an MxN
dot matrix.
The conversion will fail if the syntax used is not correct, or if the input string given is longer than 70.
Character set
64 characters to represent the data
250
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - Royal Mail
Modul width Width of the narrowest code element (either bar or space) in selected units
Modul asc./descendent Height of the ascender (the top part of the bar) or descendent (the bottom
part of the bar) in selected units.
Modul track
Height of the track (the middle part of the bar) in selected units
Check pattern validity
barcode.
If set to Yes, then typed string value is validated before actual drawing of the
The Royal Mail 4 State Customer Code (RM4SCC) is a barcode symbology developed by Royal Mail
for use in automated mail sortation processes. The character set includes both Alpha and Numeric
characters and enables a high data encoding density and processing speed with all types of printing
systems.
A Complete RM4SCC consists of a set of distinct bars and spaces for each character followed by a
checksum character and enclosed by a unique start bar, stop bar and a quiet zone.
Each alphanumeric character consists of 4 bars of which 2 bars have ascenders and 2 bars have
descendents. The track element is present in all bars. Unique start and stop bars at the extremities of a
full code enable the orientation of the code to be identified and thus assist omni directional reading.
State Alphanumeric Character Equivalents
Using this form of coding there are 36 valid characters in the character set, these being numeric
characters 0-9 and alpha character A-Z.
Start and Stop Bars
A29247-X89-X-3-7678
251
Appendix: Barcodes
Start and stop bars identify the beginning and end of the barcode and also the orientation of the
barcode. The start bar consists of a track and ascender; the stop bar consists of ascender, track and
descendent.
Checksum Character
The checksum character is a character printed on the normal right hand end of the data characters to
provide a means of error detection and correction. The checksum is a valid character that is formulated
using a simple algorithm.
Bar Type
252
•
Long Bar: 1
•
Semi Long Bar, Upper: 2
•
Semi Long Bar, Lower: 3
•
Timing Bar(Short Bar): 4
A29247-X89-X-3-7678
Appendix: Barcodes
Barcodes - UPC A
Height
UPC is completely compatible with EAN code and represents the numeric code of each article
submitted to the UPC rules (Universal Product Code) in use in the United States.
As for EAN code, the elements can assume different widths (from 1 to 4) in the module. Each character
is coded with two bars and two spaces with a total width of seven modules.
The UPC codes have two basic formats with some variants.
The first format consists of start character, 'number system', left data field, central check character,
right data field, check digit and stop character.
The second format is supplied only with a single data field (therefore without a central check
character).
The 'number system' character identifies the numbering system and is the application field of the code.
The standard use of the UPC code is associated with the number system 0.
There are five versions of UPC bar codes. The coding is always the same; the difference consists
essentially of the data field configuration. Among these, the most used are version A and E, i.e.:
A - Basic version for coding of 10 numeric characters. The first 5 code the manufacturer, the remaining
5 code the article.
Features
•
Numeric code
A29247-X89-X-3-7678
253
Appendix: Barcodes
•
Continuos code
•
Self-checking code
Advantages
•
Disadvantages
•
•
Set of Characters
•
10 digits
•
•
Characters coding
The decimal digits are coded in two different ways ( O and E). The first provides the coding of each
digit containing an odd number of dark modules thus called 'coding O' (Odd parity). The second coding
represents the digits containing an even number of dark modules, thus being called 'coding E' (Even
parity). In the odd coding each character begins with a space and ends with a bar and vice versa in the
even coding.
The auxiliary check characters are coded the same way as in EAN.
Structure of an UPC A symbol:
The symbol UPC A consists of the following sequence described from the left to the right:
lateral control character (start)
1 character representing the number system (in position 1)
5 characters represented according to the odd coding (in positions from 2 to 6) which form the left half
of the data field
central control character
5 characters represented according to the even coding (in positions from 7 to 11) which form the right
half of the data field
check digit (in position 12)
lateral control character (stop)
254
A29247-X89-X-3-7678
Appendix: Barcodes
The character is calculated on the base of the 10 characters of the data field and of the number
system. The algorithm is modulo 10 weight 3 (resp. say 10 minus modulo 10, weight 3), beginning with
weight 3 at the number system.
Dimensions
a magnification factor between 0.8 and 2. The symbol in version A consists of 95 modules, plus 10 light
modules to form the overflow areas.
Printing this Barcode
Because there is an OCR B font under the Symbol the symbol has to be printed with two lines. (The
OCR B font is included in the lower Barcode font characters.)
The height you can enter is the height of a bar in the left or the right field of the symbol. This height will
be divided by 2 and so the font has an other height as entered. There is a choice to create a font with
the nominal sizes SC0 to SC9, then the entered height will be ignored.
A29247-X89-X-3-7678
255
Appendix: Barcodes
Barcodes - UPC E
Height
UPC is completely compatible with EAN code and represents the numeric code of each article
submitted to the UPC rules (Universal Product Code) in use in the United States.
As for EAN code, the elements can assume different widths (from 1 to 4) in the module.
Each character is coded with two bars and two spaces with a total width of seven modules.
The UPC codes have two basic formats with some variants. The first format consists of start character,
'number system', left data field, central check character, right data field, check digit and stop character.
The second format is supplied only with a single data field (therefore without a central check
character).
The 'number system' character identifies the numbering system and is the application field of the code.
The standard use of the UPC code is associated with the number system 0.
There are five versions of UPC bar codes. The coding is always the same; the difference consists
essentially of the data field configuration. Among these, the most used are version A and E, i.e.:
E - 'zero suppressing' version. It is used for marking packages physically too small to be printed with
version A.
Features
•
Numeric code
•
Continuos code
•
Self-checking code
Advantages
•
256
A29247-X89-X-3-7678
Appendix: Barcodes
Disadvantages
•
•
Set of Characters
•
10 digits
•
Characters coding
The UPC E coding table is different from the UPC A because of the even parity coding which is
'reversed' with respect to the coding of the UPC A itself.
Structure of an UPC E symbol
Version E of the UPC symbol is used on products whose packages are too small to accept a standard
symbol.
This version is called 'zero suppressing' and is obtained from version A by omitting some zeros from
the code. Only the number systems 0 and 1 are available, of which the first is currently in use.
The data field consists of six characters: three with even coding and three with odd coding. The
number system and the check digit are not explicitly present in the symbol but derived from the
particular combination of the parities in the coding of the six useful characters according to a coding
table.
The character is calculated on the base of the 6 characters of the data field and of the number system.
The algorithm is modulo 10 weight 3 (resp. 10 minus modulo 10, weight 3), beginning with weight 3 at
the number system.
Dimensions
a magnification factor between 0.8 and 2. The symbol in version E consists of 48 modules, plus 14 light
modules to form the overflow areas.
Printing this Barcode
A29247-X89-X-3-7678
257
Appendix: Barcodes
Because there is an OCR B font under the Symbol the symbol has to be printed with two lines. (The
OCR B font is included in the lower Barcode font characters.)
The height you can enter is the height of a bar in the left or the right field of the symbol. This height will
be divided by 2 and so the font has an other height as entered. There is a choice to create a font with
the nominal sizes SC0 to SC9, then the entered height will be ignored.
258
A29247-X89-X-3-7678
Appendix: Parameters and Environmental Variables
A29247-X89-X-3-7678
259
General Commands
You can run the console version of Océ Document Designer using the following syntax:
PnetTC.exe [workflow_path/]workflow_filename [parameter_1] [parameter_2] ...
[parameter_x]
See also:
!
Data Output Commands
!
Statistics Output Commands
!
Output Commands
!
Engine Specific Commands
!
Commands for Workflow Modules XML Data Input, Data Input
!
Commands for ParamInput Module
!
Command for RecordFilter Module
!
Multiple Output
Example:
pnettc MySample.wfd -f TestOutput.pdf -e PDF -a1 "My Sample Variable"
Important notes:
!
for Linux version of the PNetTC: The character of "\" in data will not be replaced
automatically, correct way to have a path in data is "../..", that way it works on all platforms (the
Océ Document Designer internal path specification), similar to vcs:folder/filename.wfd
!
when there is a character of % used in command line (or in *.bat file), it is necessary to
duplicate the % character.
Example 1) - incorrect usage (only one % used):
pnettc XXX.wfd -c stet_xml.job -difDataInput FLAT.out -f
1_10FLAT_%g.ps
Example 2) - correct usage (two % used):
- pnettc XXX.wfd -c stet_xml.job -difDataInput FLAT.out -f
1_10FLAT_%%g.ps
!
260
Note for *.job files:
A29247-X89-X-3-7678
! if some parameter is defined in both job file and in command line, then only commandline parameter is used
! command-line parameter is more relevant than the settings in GUI
-c filename.job
job/production configuration filename
-f outputfilename.pdf output filename
-o MyOutput1
select output workflow module
-l logfilename.log
select log file - overwrite existing
-la logfilename
select log file - append existing
-autoskipmissing
skip missing files during opening workflow
-nowarnings
do not log warnings to console, only to logfile
-server
hostname
-username
username
-password
password
-vcspreferredbranches preferred VCS branches separated by comma
-vcslabel
label specifying files to get from VCS
-vcscache
path to VCS cache location
-tempdir
directory for temporary files
-messagedonotlog
codes of messages separated by comma, messages will not be logged
-messageignoreabort
codes of messages separated by comma, messages will not abort job
-warningconfig
warning config filename (*.wpr)
A29247-X89-X-3-7678
261
-datacodec UTF-8
select codec
-dataoutputtype CSV output type (CSV,XML,FLAT,TSD)
See also:
!
General Commands
!
!
Output Commands
!
!
!
!
Multiple Output
262
A29247-X89-X-3-7678
-datacodec String
select codec (UTF-8 etc.)
See also:
!
General Commands
!
!
Output Commands
!
!
!
!
!
Multiple Output
A29247-X89-X-3-7678
263
Output Commands
-e EngineName
select engine
-shbeg 1
starting sheet (default 1)
-shend 1
end sheet
-toend true
print to end (default true)
-cc 1
copy count
-pug1 true
print user group 1 (default true)
-pug2 true
-pug3 true
-col false
collate (default true)
-ec engineconfigname
loads engine configuration from config file
-dc driverconfigname
loads driver configuration from config file
-pc printerconfigname
loads printer configuration from config file
-offsetx
horizontal offset (x) in meters
-offsety
vertical offset (y) in meters
-scalex
horizontal scaling
-scaley
vertical scaling
See also:
!
General Commands
!
!
!
!
!
!
Multiple Output
264
A29247-X89-X-3-7678
Image Engine
-imagepalette
image depth in bits (1,8,24) or gray for 8-bit gray scale
-imageformat
png, jpeg, bmp etc.
-imagedpi
image dpi
PDF Engine
-pdfcompress pdf compression on
See also:
!
General Commands
!
!
!
Output Commands
!
!
!
Multiple Output
A29247-X89-X-3-7678
265
Commands for Workflow Modules XML Data Input,
Data Input
-difModuleName filename
data input file e. g. -difXMLDataInput1 data.xml
Note: If a module has a space in its name (e.g., "My Data"), you must enclose it in quotation marks:
"-difMy Data" filename.csv
See also:
!
General Commands
!
!
!
Output Commands
!
!
!
Multiple Output
266
A29247-X89-X-3-7678
-Param_input_variable_nameParam_input_module_name variable_value
specifies value of the variable used in ParamInput module in the layout
Example:
pnettc ParamInput.wfd -f ParamInput.pdf -e PDF -a1ParamInput1 Peter
If you use spaces, you must place the parameters inside quotation marks.
Example:
pnettc ParamInput.wfd -f ParamInput.pdf -e PDF "-my name of ParamInput1"
"Peter O'Toole"
See also:
!
General Commands
!
!
!
Output Commands
!
!
!
Multiple Output
A29247-X89-X-3-7678
267
Commands for RecordFilter Module
-rfifModuleName filename
record filter filename with records for filtering
-rfpsModuleName
string pattern with records which pass through everytime
-useerrorrecoveringModuleName
use error recovering
-errorfilenameModuleName
error file name
See also:
268
!
General Commands
!
!
!
Output Commands
!
!
!
!
Multiple Output
A29247-X89-X-3-7678
Multiple Output
The Multiple Output feature enables you to request batch production of workflows from the Océ
Document Designer console (PnetTC.exe).
The first command line call specifies the file where the set of parameters for command lines are stored.
As each of the command line is processed, the next command line is executed.
See also:
!
General Commands
!
!
!
Output Commands
!
!
!
!
Syntax
The first command line (called the ‘master’ command line) should contain only the parameter –multiple
and the path to the file containing the parameters of command lines. The only optional parameter is –l
(-l logfilename.log, for selecting log file).
Note:
When the same workflow (.wfd file) and the same output module (specified by the –o parameter) is
used in several consecutive lines of the file specified by the –multiple parameter, the file is loaded and
preprocessed only once, which can significantly decrease spooling time.
Example of the 1st command line:
pnettc.exe –multiple multi.txt
Example of the called multi.txt file:
c:\Workflows\gm.wfd -e PDF -f d:\gm\Local.pdf -o Local -warningconfig
d:\testignore.wpr -l d:\gm\Local.txt
c:\Workflows\gm.wfd -e PCL -f d:\gm\PCL -o PCL -warningconfig
d:\testignore.wpr -l d:\gm\PCL.txt
A29247-X89-X-3-7678
269
c:\Workflows\gm.wfd -e PDF -f d:\gm\PostScript -o PostScript -warningconfig
d:\testignore.wpr -l d:\gm\PostScript.txt
c:\Workflows\gm.wfd -e PDF -f d:\gm\PDF.pdf -o "PDF" -warningconfig
d:\testignore.wpr -l d:\gm\PDF.txt
c:\Workflows\gm.wfd -e PDF -f d:\gm\PDF_TEST.pdf -o "PDF_TEST" warningconfig d:\testignore.wpr -l d:\gm\PDF_TEST.txt
c:\Workflows\gm.wfd -e AFP -f d:\gm\AFP -o "AFP Output" -warningconfig
d:\testignore.wpr -l d:\gm\AFPOutput.txt
c:\Workflows\gm.wfd -e Scitex -f d:\gm\Scitex2up -o Scitex -warningconfig
d:\testignore.wpr -l d:\gm\Scitex.txt
c:\Workflows\gm.wfd -f d:\gm\DataOutput.dat -o DataOutput -warningconfig
d:\testignore.wpr -l d:\gm\DataOutput.txt
c:\Workflows\gm.wfd -f d:\gm\PDF_Index.pdf -o PDF_Index -warningconfig
d:\testignore.wpr d:\gm\PDF_Index.txt
270
A29247-X89-X-3-7678
TNGNetServer Description
TNGNetServer is "remote web console", it runs on server (determined by IP address) and listens to
some port.
You can connect to the server (via telnet for instance) and send there commands, execute the
production etc.
Starting TNGNetServer
The server file name is TNGNetServer2.exe. By default, it is located in the Océ Document Designer
directory.
Running the exe file starts the server. By default (when no –p parameter is specified), the server starts
listening to (i.e., monitoring) port 30354 and waits for connections.
Command line parameters
-p
30355)
PortNumber Specifies the port number to be monitored. (TNGNetServer2.exe -p
-h
Displays the Help screen.
Restrictions
Note that there is similar limitation as in Océ Document Designer production. Each workflow you may
be running only once. So if you run same workflow with same ID for second time, second job will be
scheduled until the first run is finished regardless of how many threads on server are idle. But this is
not an issue since you can open same workflow more than once and for example spool to different
engines simultaneously if needed.
A29247-X89-X-3-7678
271
Connecting to TNGNetServer
No login is needed, so just simply connect to server address. Server is by default listening on port
30354, you can change port in commandline.
Easiest way is just to connect to server with telnet application and start sending commands to server.
telnet <server_IP_address> <port>
e. g. telnet localhost 30354
All commands return single string terminated by CR LF (carriage return + line feed characters).
If command was correct string begins with "ok;" and is followed by return value(s) separated by
semicolon.
If command was not correct server returns "error;" followed by description of error.
Checking if connection is alive with PING command
Command: ping
Parameters: none
Return: string "ok;"
272
A29247-X89-X-3-7678
Opening workflow
Command: open
Parameters: workflow name
Return values: jobID, workflowID
Workflow and all files used by workflow must be placed locally in place where running server can
access them.
"ok" value returned only means the command is correct, it does not mean workflow was opened. This
can be checked with query
commands described later.
Command is aded to server's job queue with identifier "jobID", job status is "Scheduled" and executed
later when server thread will free.
Opened workflow can be later accessed using identifier "workflowID"
Example:
open test.wfd
Example command: open test.wfd
Example response: ok;0,0
Running workflow
Command: run
Parameters: workflowID, console commandline
Return values: jobID
"workflowID" determines which workflow to run. It was retrieved earlier with open command.
"console commandline" is a common PNetTC commandline.
Example command: run 0 -e PDF
Example response: ok;1
Again command is added to job queue and executed later.
Query job
Command: qj
Parameters: jobID
A29247-X89-X-3-7678
273
Return values: jobId;workFlowId;workFlowName;command type;job status
This command is not added to queue it is executed immediately.
Example command: qj 0
Example response: ok;0;0;test.wfd;Open WorkFlow;Finished
meaning valid jobID was provided (ok), jobId is 0, job 0 operates with workflow 0,name of workflow is
test.wfd,command type is open workflow and job was executed without errors and is finished
While workflow run is in progress we receive some additional information: workflow
status;progress;error count;warning count
Example command: qj 1
Example response: ok;1;0;test.wfd;RunWorkFlow;Working;Preprocessing;17%;E0;W0
Again job is operating on workflow with ID 0, but this time job is still in progress (Working), currently
preprocessing, 17% and without any errors or warnings. These additional return values are same as
progress information in Océ Document Designer production.
Closing workflow
Command: close
Parameters: workFlowID
Return values: jobID
Example command: close 0
Closes the opened workflow.
Aborting job
Command: abort
Parameters: jobID
Return values: none
Returns error only in case invalid jobID is entered.
You can abort jobs waiting for execution (scheduled) and jobs currently running.
More complex job query
Command: qallj
274
A29247-X89-X-3-7678
Parameters: none
Return value: length of XML file followed by CRLF and XML File in UTF-8 encoding
Similar to "qj" command but returnes info for all jobs.
XML structure:
<JobsInfo>
<Job>
<JobId/>
<WorkFlowId/>
<JobType/>
<StartTime/>
<Progress/>
<ProgressInfo/>
<JobStatus/>
<User/>
</Job>
</JobsInfo>
Acknowledge job
Command: ackj
Parameters: jobID
Return value: none
All job parameters (including finished jobs) are stored on server. You can remove them from server and
thus save server memory.
Also XML query described above will be shorter/faster.
Query job messages
Command: qjm
Parameters: jobID
Return value: length of XML file followed by CRLF and XML File in UTF-8 encoding
A29247-X89-X-3-7678
275
PNeT engine logs messages during production. Running workflow with commandline may cause some
errors that are indicated by values error count and warning count in query job command. These
messages can be acquired with qjm command.
Query thread
Command: qt
Parameters: thread index (beginning from 0)
Returns status of server thread. It can be idle or running some job. In this case ID of running job is
returned.
Typical use of TNG Net Server
Let's assume we run server setup with two threads. Server is idle (no running jobs)
We have three jobs: long.wfd, short.wfd and short2.wfd
We subsequently send these commands to server (try it with telnet):
open long.wfd
ok;0;0 //job id is 0, workflow id is 0
run 0 -e PDF
ok;1 //server was idle so job 1 on workflow 0 can start immediately on thread 0 examine with qt
command
qt 0
ok;1;0;RunWorkFlow;Working //means thread 0 is running job 1, workflow 0 and is working
qt 1
ok;1;Idle. //thread 1 is idle; when sending commands to server, you don't have to worry about threads
but it is useful to determine what is server processing and what is it's load
open short.wfd
276
A29247-X89-X-3-7678
ok;2;1 //job id is 2, workflow id is 1
run 1 -e PDF
ok;3 //job 1 is still running but server has two threads so job 3 starts on thread 1 at once
open short2.wfd
ok;4;2
run 2 -e PDF
ok;5 //both threads are busy now, so job 5 will stay scheduled until thread 0 or 1 finishes it's job
(depends on job processing time); at any moment you can query jobs with qj or qallj commands and
track job processing; you can also abort jobs
abort 1
//this aborts job 1 (which is running workflow 0). thread 0 is idle now so server will
//check job queue and start processing scheduled jobs in our case job 5 on workflow 2
//now you can run workflows again or just close them
close 0
ok;6
close 1
ok;7
close 2
ok;8 //if you do not need any further info about jobs, you can free jobs using ackj commands
ackj 0
ok;
A29247-X89-X-3-7678
277
ackj 1
ok;
278
A29247-X89-X-3-7678
Simple / Advanced Production Mode
Using the following command line parameters you can open only Production window in one of the
following modes:
•
simple mode - using command PnetT.exe –sp
•
advanced mode - using command PnetT.exe –ap
A29247-X89-X-3-7678
279
Simple Production Mode
Using command-line parameter –sp Océ Document Designer runs in the simple production mode.
The window consists of Driver and Job toolbars, information area at the top of the window and
messages area in the bottom part of the window.
Driver Toolbar
Driver Toolbar contains buttons that can be used for:
280
•
Driver connection - Using this button you can connect to the previously defined driver with
specified connection type, format and printer configuration. When connected, button state is
changed to inactive.
•
Disconnecting of driver - You can disconnect the current driver (for example when you want to
change its configuration) by clicking this button.
•
Resetting a driver - When driver is reset, it reconnects – it means that connection is closed first
and then established again.
•
Configuring a driver - The [Configure driver] button is only enabled when driver is not
connected. Clicking this button launches driver configuration dialog where you can specify the
driver parameters.
A29247-X89-X-3-7678
•
View driver configuration - The same configuration dialog window as described in Configuring
a driver paragraph is shown, the only difference is that parameters are read only, you cannot
change them.
Job Toolbar
Job toolbar contains buttons that can be used for:
•
Opening a workflow file
•
Starting job
•
Stopping job
•
Unloading a workflow
When the [Open workflow file] button is clicked then Open File dialog is shown where you can select
file to be opened.
After clicking [Open] button the file is loaded and [Start job] and [Unload workflow] buttons are
enabled.
After clicking the [Start job] button the Configure Job window will be shown.
You can specify here:
•
the start page (the first page to be converted and printed)
•
end page
•
number of copies to be printed
•
output file name
When job is started you can stop it (using [Stop job] button) it and run it again later.
A29247-X89-X-3-7678
281
Advanced Production Mode
Using command-line parameter –ap Océ Document Designer runs in the advanced production mode.
The window is very similar to the default Production window, except it is not possible to run Layout or
Proof in this mode.
282
A29247-X89-X-3-7678
Specifying the Folder for Configuration and Cache
Files
The command format is:
PnetT.exe –c directory
where directory specifies the directory containing:
!
the PnetT.cfg file (configuration file)
!
fontcache.dat file
!
cache files (*.tsd files) saved from Océ Document Designer
Examples:
PnetT.exe –c C:\PNetTCFG
PnetT.exe –c “C:\PnetT Configuration”
Note: This command-line parameter overrides the PNETT_DIR environmental variable.
A29247-X89-X-3-7678
283
Using the Current Folder for Configuration and
Cache Files
PnetT.exe –cc
When this command-line parameter is used, the PnetT.cfg file (the configuration file),
fontcache.dat file and cache files (*.tsd files) saved from Océ Document Designer will be saved in
current directory (i.e., the directory that is current when Océ Document Designer starts).
Note: This command-line parameter overrides the PNETT_DIR environmental variable.
284
A29247-X89-X-3-7678
Using Workflow File Name(s) as Parameter
You can launch one or more workflow files (*.wfd) simultaneously with Océ Document Designer .
PnetT.exe [workflow_path/]workflow_filename
Note:
!
Enclose filenames containing spaces in quotes.
!
When you want to launch several workflow files at once, separate them by space:
PnetT.exe myworkflow.wfd nextworkflow.wfd
A29247-X89-X-3-7678
285
How to Create an Environmental Variable
Environment variables are strings that contain information about the environment for the system. Océ
Document Designer can use use the information to determine where to place files or for other
purposes.
How to set the environmental variable
In Windows XP:
•
Right-click My Computer
•
Choose Properties
•
Choose the Advanced tab
•
Click [Environmental Variables] button
•
Under User Variables, click [New]
•
Type the Variable Name (PNETT_DIR for instance)
•
Type the Variable Value (C:\MySharedPNTDir for instance)
•
Click [OK]
•
Click [OK]
•
Click [OK]
Example
286
A29247-X89-X-3-7678
A29247-X89-X-3-7678
287
PNETT_DIR Variable
Using the PNETT_DIR system (environmental) variable, you can define a directory containing:
!
the PnetT.cfg file (configuration file)
!
fontcache.dat file
!
cache files (*.tsd files) saved from Océ Document Designer
You can set the system variable using System Control Panel or using the set command.
This system variable will not be used when –c or –cc command-line parameter is specified.
288
A29247-X89-X-3-7678
CX_DATA Variable
Using the CX_DATA system (environmental) variable, you can define a directory containing the Image
Gear files, icudt*.dat file (conversion tables, locales etc.) and help files (*.chm and *.hif) .
When this variable is not specified, the folder containing PnetT.exe is used.
A29247-X89-X-3-7678
289
CX_FONT_DIRECTORY Variable
By default, Océ Document Designer looks for font in Windows Fonts directory.
Using the CX_FONT_DIRECTORY system (environmental) variable, you can change system font
directory (directory that Océ Document Designer looks for fonts in) using this variable.
In case there there is no font in this directory, Océ Document Designer DOES NOT run and log this
message: You don't have any system font in folder folder name into log file.
290
A29247-X89-X-3-7678
Language Codes
This table lists all the language codes used within the Océ Document Designer (for example for
hyphenation exception files).
aa
"Afar"
ab
"Abkhazian"
af
"Afrikaans"
am
"Amharic"
ar
"Arabic"
as
"Assamese"
ay
"Aymara"
az
"Azerbaijani"
ba
"Bashkir"
be
"Byelorussian"
bg
"Bulgarian"
bh
"Bihari"
bi
"Bislama"
bn
"Bengali" "Bangla"
bo
"Tibetan"
br
"Breton"
ca
"Catalan"
co
"Corsican"
cs
"Czech"
cy
"Welsh"
da
"Danish"
de
"German"
dz
"Bhutani"
el
"Greek"
en
"English" "American"
eo
"Esperanto"
A29247-X89-X-3-7678
291
es
"Spanish"
et
"Estonian"
eu
"Basque"
fa
"Persian"
fi
"Finnish"
fj
"Fiji"
fo
"Faeroese"
fr
"French"
fy
"Frisian"
ga
"Irish"
gd
"Gaelic" "Scots Gaelic"
gl
"Galician"
gn
"Guarani"
gu
"Gujarati"
ha
"Hausa"
hi
"Hindi"
hr
"Croatian"
hu
"Hungarian"
hy
"Armenian"
ia
"Interlingua"
ie
"Interlingue"
ik
"Inupiak"
in
"Indonesian"
is
"Icelandic"
it
"Italian"
iw
"Hebrew"
ja
"Japanese"
ji
"Yiddish"
jw
"Javanese"
292
A29247-X89-X-3-7678
ka
"Georgian"
kk
"Kazakh"
kl
"Greenlandic"
km
"Cambodian"
kn
"Kannada"
ko
"Korean"
ks
"Kashmiri"
ku
"Kurdish"
ky
"Kirghiz"
la
"Latin"
ln
"Lingala"
lo
"Laothian"
lt
"Lithuanian"
lv
"Latvian" "Lettish"
mg
"Malagasy"
mi
"Maori"
mk
"Macedonian"
ml
"Malayalam"
mn
"Mongolian"
mo
"Moldavian"
mr
"Marathi"
ms
"Malay"
mt
"Maltese"
my
"Burmese"
na
"Nauru"
ne
"Nepali"
nl
"Dutch"
no
"Norwegian"
oc
"Occitan"
A29247-X89-X-3-7678
293
om
"Oromo" "Afan"
or
"Oriya"
pa
"Punjabi"
pl
"Polish"
ps
"Pashto" "Pushto"
pt
"Portuguese"
qu
"Quechua"
rm
"Rhaeto-Romance"
rn
"Kirundi"
ro
"Romanian"
ru
"Russian"
rw
"Kinyarwanda"
sa
"Sanskrit"
sd
"Sindhi"
sg
"Sangro"
sh
"Serbo-Croatian"
si
"Singhalese"
sk
"Slovak"
sl
"Slovenian"
sm
"Samoan"
sn
"Shona"
so
"Somali"
sq
"Albanian"
sr
"Serbian"
ss
"Siswati"
st
"Sesotho"
su
"Sudanese"
sv
"Swedish"
sw
"Swahili"
294
A29247-X89-X-3-7678
ta
"Tamil"
te
"Tegulu"
tg
"Tajik"
th
"Thai"
ti
"Tigrinya"
tk
"Turkmen"
tl
"Tagalog"
tn
"Setswana"
to
"Tonga"
tr
"Turkish"
ts
"Tsonga"
tt
"Tatar"
tw
"Twi"
uk
"Ukrainian"
ur
"Urdu"
uz
"Uzbek"
vi
"Vietnamese"
vo
"Volapuk"
wo
"Wolof"
xh
"Xhosa"
yo
"Yoruba"
zh
"Chinese"
zu
"Zulu"
A29247-X89-X-3-7678
295
Appendix: Full Color
A29247-X89-X-3-7678
297
Full Color Overview
With color printing, consistent WYSIWYG results across scanners, monitors, applications, and printers
are often difficult, sometimes impossible, to achieve. Two reasons for this are:
!
Different illuminants and colorants
Monitors and scanners are based on the "additive" color system using RGB, starting with black
and then adding red, green, and blue to achieve color.
Printers are based on the "subtractive" color system, usually using the colors cyan, magenta,
yellow, and black (CMYK). Printed material creates images by reflecting light off of substances
such as ink, dye, wax, and toner.
Both RGB and CMYK are known as device-dependent color systems or "color spaces."
Monitors can look different from one another for a variety of reasons, such as variances in the
phosphors used to radiate the light and different bit depths. Printers can also give different
results depending on a number of factors, such as the media and inks used.
!
Different gamuts
Each device, whether a scanner, monitor, or printer, has a particular range of colors that it is
capable of producing. This is known as the device gamut. The gamut of a device is
determined by the physical characteristics of the device itself, as well as the ambient lighting
(for instance, the colors may appear rich in a dimly lit room and washed out in bright viewing
conditions).
Each color peripheral can differ on one or more of the following color characteristics:
!
Color space : RGB, CMYK, LAB, XYZ, and others
!
Gamut range
!
Gamma curve
!
White point, plus many more characteristics
These differences are unavoidable in most cases, because of the limitations of the devices or media in
question. However, these differences can be tested for and recorded in an International Color
Consortium (ICC) profile. These ICC profiles are then used to communicate through the rest of the
Integrated Color Management (ICM) system to ensure that colors are represented accurately to users,
regardless of the device they use.
298
A29247-X89-X-3-7678
Color Management Functions
!
Maps colors between devices that have different gamuts (e.g., monitors and printers)
!
Transforms colors from one color space to another (e.g., RGB to CMYK)
Provides accurate on-screen or print previews that allow for corrective action
A29247-X89-X-3-7678
299
ICC Profiles
The ICC profile specification is a cross-platform industry standard that accurately and consistently
characterizes devices including scanners, monitors, and printers.
ICC (ICM) profiles must be installed for all of the color devices on the user's system.
Important note: When you want to print the black color or black/white images defined in RGB color
space on a CMYK output device with the default ICC profile, the black color converted from the RGB
color space into CMYK does not necessarily print in the "full rich" black (full K component). To avoid
this, define the black color in the layout in CMYK.
300
A29247-X89-X-3-7678
Color Spaces
Color spaces are models for specifying colors. Stated another way, color space is a mapping of color
components onto a Cartesian coordinate system in three or more dimensions.
The reason these models are referred to as color spaces is that most of them can be mapped into a 2D, 3-D, or 4-D coordinate system similar to a Cartesian coordinate system. Hence colors can be said to
be composed of coordinates in a 2-D, 3-D, or 4-D space. The color components in a color space are
also referred to as color channels.
There are several types of color spaces used in Océ Document Designer. Some color spaces are
intended to be independent of any device that is used to produce color images. Some are very device
dependent. Both device-dependent and device-independent color spaces are discussed in the
following sections:
!
RGB Color Space
!
HSB Color Space
!
LAB Color Space
CYMK Color Space
A29247-X89-X-3-7678
301
RGB Color Space
An RGB color space is created by mapping the colors red, green, and blue onto a 3-D Cartesian
coordinate system. This results in a 3-D cube. This figure displays the same RGB cube from two
different angles. The origin of the coordinate system is black. This is where the red, green, and blue
(RGB) color components are all 0.0. The diagonally opposite corner of the cube is white, where the
RGB color components are at their maximum value.
Like most color spaces, the RGB color space is normalized. That is, all color values are restricted to
the range of zero to one inclusive. So black is (0.0, 0.0, 0.0), and white is (1.0, 1.0, 1.0).
In the RGB color space, the primary colors are red, green, and blue. The secondary colors are cyan,
yellow, and magenta.
RGB color spaces can be device dependent or device independent.
302
A29247-X89-X-3-7678
HSB Color Space
The HSB model is based on the human perception of color. In the HSB model, all colors are described
in terms of three fundamental characteristics:
Hue is the wavelength of light reflected from or transmitted through an object. More commonly, hue is
identified by the name of the color such as red, orange, or green. Hue is measured as a location on the
standard color wheel and is expressed as a degree between 0º and 360º.
Saturation, sometimes called chroma, is the strength or purity of the color. Saturation represents the
amount of gray in proportion to the hue and is measured as a percentage from 0% (gray) to 100% (fully
saturated). On the standard color wheel, saturation increases as one approaches the edge of the
wheel; saturation decreases as one approaches the center.
Brightness is the relative lightness or darkness of the color and is usually measured as a percentage
from 0% (black) to 100% (white).
A29247-X89-X-3-7678
303
LAB Color Space
The Lab color model is based on the original color model proposed by the Commission Internationale
d'Eclairage (CIE) in 1931 as an international standard for color measurement. In 1976, this model was
refined and named CIE Lab.
The Lab model addresses the problem of the variability of color reproduction that results from the use
of different monitors or different printing devices. Lab color is designed to be device independent; that
is, it creates consistent color regardless of the specific device, such as the monitor, printer, or
computer, that you use to create or output the image. Lab color consists of a luminance, or lightness
component (L) and two chromatic components: the a component, which ranges from green to red, and
the b component, which ranges from blue to yellow.
304
A29247-X89-X-3-7678
CMYK Color Space
The CMYK color space is often used in color printing. A CMY color space uses cyan, magenta, and
yellow (CMY) as its primary colors. Red, green, and blue are the secondary colors.
The CMYK color space is a variation on the CMY model. It adds black (Cyan, Magenta, Yellow, and
blacK). The CMYK color space closes the gap between theory and practice. In theory, the extra black
component is not needed. However, experience with various types of inks and papers has shown that
when equal components of cyan, magenta, and yellow inks are mixed, the result is usually a dark
brown, not black. Adding black ink to the mix solves this problem.
The CMY color space is subtractive. Therefore, white is at (0.0, 0.0, 0.0) and black is at (1.0, 1.0, 1.0).
If you start with white and subtract no colors, you get white. If you start with white and subtract all
colors equally, you get black.
The CMYK color spaces are normalized, can be device independent, but most often they are used in
reference to a specific device.
A29247-X89-X-3-7678
305
Rendering Intents
The colors that a device can produce are only some, but not all, of the colors that the human eye can
see.
In terms of the profile of a device, this means that all the coordinates of the device colors have
corresponding absolute coordinates, but not all absolute coordinates can have corresponding device
coordinates. And this has consequences in the conversion of colors between devices.
The method used to convert color coordinates from the origin device to the destination device consists
of two steps:
!
Finding the device color coordinates in the origin profile, and determining the corresponding
absolute coordinates.
!
Finding the absolute coordinates from in step 1 in the destination profile and determining the
corresponding device color coordinates.
The problem is that some of the colors we can see on a particular monitor can be printed on a
particular printer, while others cannot be printed as they do not exist in that printer.
It is possible to attempt to reproduce a reasonable approximation to the original color when no perfect
match can be found.
The effects, known as rendering intents, are used in typical situations.
306
A29247-X89-X-3-7678
Absolute Colorimetric (Match)
The simplest effect is the following: since some colors (of source gamut) are reproducible (in the
destination gamut) and others are not, we want to reproduce the former exactly as they are, while the
latter are replaced by the nearest reproducible color at the outer limit of the destination gamut. (Out of
gamut colors get clipped). This means that colors that were different in the original image can, after the
conversion, be the same.
For some types of image, this is an adequate rendering (e.g., when we know for sure that all the colors
in an image are printable). The typical example of this is the company logo or brand name.
It is therefore reasonable in this case to print the printable colors (probably the great majority) exactly
as they are, and print approximations to the rest (in an operation known as clipping). This type of
rendering is called colorimetric.
Normally, logo colors are included in the printers’ gamut and do not require any transformation. For this
type of image, the colorimetric rendering intent is suitable.
A29247-X89-X-3-7678
307
Relative Colorimetric (Proof)
The absolute colorimetric rendering does not expand or compress the whole gamut: each color is
transformed into itself, if it exists in the destination gamut. Otherwise, it is transformed into the closest
color at the gamut boundary.
The absolute colorimetric (where possible) does not modify the brightness.
The relative colorimetric rendering requires instead an exact color match in everything but brightness,
which may be modified so that all the brightness levels are within the range of brightness of the
destination gamut in use.
With relative colorimetric rendering, the source white is converted into the destination white (white point
compensation); all other colors are shifted accordingly. The resulting image may be lighter or darker
than the original, but the white areas will coincide.
It is up to the user to decide whether absolute or relative colorimetric rendering is more suitable for the
image he/she is working on.
If the destination gamut is wider than the source gamut, absolute colorimetric rendering is more
suitable because the origin white is included in the destination’s range of colors.
If the destination gamut is narrower than the source gamut, it is usually best to choose relative
colorimetric. If the two whites are not the same white (the source's one, perhaps monitor, is brighter
than the destination's one, perhaps printer) the source's white is made to correspond to the white of the
destination, which is normally the most sensible solution. Absolute rendering would produce a printed
white that is an approximation to the white on the monitor.
308
A29247-X89-X-3-7678
Perceptual (Picture)
For some situation, neither absolute nor relative colorimetric rendering is suitable. This is the case
when the destination gamut is narrower that that of the source (for example, when the source is a
monitor and the destination is a printer) and the image is a photographic or "realistic" one.
In this case the gamut is to be compressed, but the colors must keep their relative chromatic positions;
it is not acceptable that some of the colors might be exactly reproduced whilst others are only
approximate. All the colors, even those which could be reproduced as they are, are to be altered
(typical this rendering desaturates all colors), in such a way to maintain their overall relationships, and
the eye will be able to compensate for the difference between (for example) the image on the monitor
and the printed image.
This rendering always compresses the complete source gamut (not only the part which is not within the
destination gamut) but preserves the relationship between the colors, and is known as perceptual or
sometimes as "image", "photographic" or "photometric".
Perceptual rendering intent is suitable for photographs.
A29247-X89-X-3-7678
309
Saturation (Graphic)
There is the case in which the precise matching of colors is of little importance. The typical example is
that of statistical graphs, where it is more important that the colors are bright and saturated, than that
they are exactly the same as the original.
Saturation rendering, sometime also referred to as "graphics", requires, as the name suggests, that the
saturation of the colors be preserved in the transformation from gamut to gamut, perhaps at the cost of
brightness and hue.
With this type of rendering, the original colors are modified in order to exactly fill the destination gamut.
This means that some areas are compressed and others are expanded. This is the only rendering
which can expand a limited gamut to something wider.
Saturation rendering intent is suitable for statistical graphics.
310
A29247-X89-X-3-7678
Importing PrintNet 3 Jobs
A29247-X89-X-3-7678
311
Overview
In the following chapters the problems or inconsistencies between Océ Document Designer and PN3
functionality are mentioned.
It is necessary to have installed:
•
PrintLayout version at least 3.16.02 B08
•
condproc.fcv version at least 3.16.03
•
release version of Océ Document Designer 1.05 or higher.
For proper functionality of PN3 jobs import, it is necessary, that Playout.exe file is registered in
Windows registry that can be achieved in two ways:
- manually by running <path_to_Playout.exe>/Playout.exe /regserver
(example: C:\GMC\PNET3.16\PLAYOUT\PLayout.exe /regserver)
- or it is done automatically by the PN3 installer since version 3.16.02.03 (version of the installer exe
file)
For proper functionality is also necessary to have LayoutCOMCallerDll.dll version at least 1.0.2.0
in Océ Document Designer folder. This dll is installed with Océ Document Designer.
For customers with 3.15 installation it is necessary to have component PLCOM.EXE. This component is
called by Océ Document Designer program. It is not possible to run it separately. It has to be registered
(in windows directory optionally) by running plcom.exe /regserver
For condproc variables it is better to use condproc.fcv version at least 3.16.03 (some problems in
import fixed, compatible with 3.15) .
Optional settings in Océ Document Designer
Option dialog / PTF Import
- Large flow area (does not work by PTF created from Quark)
- Round font size
- Default Data File
•
Embedded pictures and textures are saved as .png files into user temp directory, for example:
"C:\Documents and Settings\user name\Local
Settings\Temp\.Shape00001.PNG".
Text encoding for variables is selected from “Option dialog | Default code page:”. Other
parts of job are in Unicode.
312
A29247-X89-X-3-7678
Importing PrintNet 3 Jobs - General Problems
•
Pictures – image filters (some of them should be implemented)
•
Printcommands (PrintVarFont, PrintVarDest, PrintVarCMYK)
•
Connected objects
•
Tables (= Dynamic Line Draw)
•
System functions: (Machine Name, Job Name, Data File Name, Layout Name, Current
Mailpiece, Last Page Number)
• Current Page Number works correctly, there should be differences only when there are
incorrect values in PN3 (example: text flowing jobs etc).
•
Converters:
•
Date - only Date from data file, actual date OK
•
Conditional text processing - only some settings
• ODBC converter
• Packed Number converter
• String/Barcode
•
It is not possible to use System variables in condproc.
•
Default data file: Limitations in field’s names in default data file – spaces etc. Spaces will be
changes into underscores in Océ Document Designer. It is not possible in Océ Document
Designer to use field names that have a number character in the beginning. The underscores
will be also added in front of this numbers
Example:
Field <convert> Field
Field9 <convert> Field9
Field 9 <convert> Field_9
9Field <convert> _9Field
^&* <convert> ___
Field$ <convert> Field_
Field# <convert> Field_
•
Problem with fields in default data file without field names (automatic created field names).
Numeration in PN3 starts from “FIELD1” and in Océ Document Designer starts from “Field0”.
A29247-X89-X-3-7678
313
Field names are case sensitive in Océ Document Designer. If field is not imported, and the
field uses font which is not used anywhere else; then the font is not imported at all.
•
Importing PN3 jobs using different code page than the current code page selected in Océ
Document Designer:
Since PN3 jobs are singlecode, there may occur font errors when code page of the PN3 job is
not equal to code page set in Options dialog | Default code page in Océ Document
Designer. So it is necessary, when the code page differ, set the Options dialog | Default
code page in Océ Document Designer according the PN3 job before import. If needed, it can
be changed back after import.
•
Problem with more fields on the same position in CSV data file.
•
Formatting Issues
• Ignore Empty Lines – in Océ Document Designer different (end-of-line characters)
• Spacing in PN3 is different. Standard / Variable formatting. Variable – row height is still
the same, independent on changes of font. Could not be imported identically into Océ
Document Designer.
• Bottom aligned formatting: different in PN3 and Océ Document Designer
• Line spacing exactly, in PN3 including first line, in Océ Document Designer not
including first line.
• Font handling – the way of getting parameters of certain font is different in PN3 and
Océ Document Designer, therefore there can be some minor differences in the
following: linespacing, font sizes and intercharacter distances. These differences are
cumulative so there can be more considerable difference mainly at the end of the
page.
• The amount of the difference in PN3 vs. Océ Document Designer depends on machine
resolution in PN3, font type, font size and type of paragraph formatting.
• Subscript and superscript should be formatted differently, depends on selected font and
resolution. Because lengths are calculated on different ways. Mostly only very small
differences.
Interdependent Multiple Paragraphs
Index file settings
Data Precise
314
A29247-X89-X-3-7678
PrintNet 3 Jobs - Barcodes
Because barcodes in Océ Document Designer are generated using different methods there can be
some inconsistencies in PN3 and Océ Document Designer barcodes (due to rounding problems,
another algorithm etc.)
Problems in import of the following barcodes
•
Code 39
•
Code 93
•
Code 128
•
Codabar
•
Micro PDF
•
JapanPost
•
S.Stealth-Dots
•
AustraliaPost
•
PostNet
•
RoyalMail
•
Deutsche Post AG
In the mentioned barcodes there are still either length or density problems (i.e. barcode in Océ
Document Designer is larger). depends on actual density, high, rows.
- EAN 13, EAN 8, UPC A, UPC E ….
Font size of numbers in the mentioned barcodes is independent on barcode size in Océ Document
Designer so it still the same. Font size of numbers in PN3 changes proportionally with barcode size.
- Codabar Monarch, EAN 128, ...
Algorithm for control digits calculating allows more ways for creating it, so it is possible that the same
barcode from PN3 can look different than the one from Océ Document Designer (the bars are different)
- but barcode reader gives the same results (the decoded string is the same).
Barcodes not existing in Océ Document Designer
•
EAN Add On 2/5
A29247-X89-X-3-7678
315
316
•
2/5 Interleaved CD
•
2/5 Int less Stop
•
2/5 Matrix-M
•
Code 128-A
•
Code 128-B
•
Code 128 HL
•
Code 128 UPS Berkem
•
Code 128 Empty
•
C128 UPS Empty
A29247-X89-X-3-7678
PrintNet 3 Jobs - Other Differences
•
First paragraph in Multiple paragraphs is always selected in Layout. In PN3 any of them can be
selected. It is possible to select this paragraph in Océ Document Designer Layout after import.
(Only displaying in Layout, in proof it is OK).
•
Multiple paragraphs (first fitting) should have longer frame in PN3 than the frame that is for
selection. In this case different paragraphs in Océ Document Designer are selected than in
PN3.
•
FontGraphics that are selected by the same variable are displayed in Layout the same way.
(Only displaying in Layout, in proof it is OK.) If this variable is used also somewhere else
(barcode, textbox,…) the same value will be displayed. (content in flow etc…)
•
Pictures – different origin of placement of the variable pictures
In case of image smaller than a surrounding frame: – origin in PN3 it is top left corner of the
surrounding frame, in Océ Document Designer it is center of the flow area
In case of image bigger than a surrounding frame in one direction (either in vertical or horizontal):
– image is centered in the direction in which is bigger than a frame, the origin in the second direction is
still on top resp. on left; in Océ Document Designer the origin is top left
A29247-X89-X-3-7678
317
In case of image bigger than a surrounding frame in both directions: – in PN3 it is center frame, in
Océ Document Designer it is top left corner of flow area
318
•
Monochrome pictures with colors different from B/W (for example 1 green and 0 pink), result in
PN3 B/W (because the printer limitations) and in Océ Document Designer green/pink.
•
B/W jobs that are created from colored jobs (machine changes etc…), should be imported in
Océ Document Designer with these colors.
•
Name of pictures from data file (custcode etc.) must have suffix. In PN3 it is not necessary.
•
Texture in shapes should have different dimensions, depends on size and resolution. The
same problem is with shapes filled by picture (embedded pictures in PN3).
•
Small flow areas – different understanding of height of the row in Océ Document Designer, are
smaller flows, possible to set in Option dialog enlargement of flows.
•
Difference between PTF from PN3 and PTF from World and PTF from Quark.
A29247-X89-X-3-7678
PrintNet 3 Jobs - Not Existing Functionality
•
Elements (only first of them is imported)
•
Various charts (only basic bar chart is imported)
•
Block ANSI / ANY formatting
•
Variable RTF
•
Enhanced CSV settings
•
DAO data file
A29247-X89-X-3-7678
319
PrintNet 3 Jobs - Problems in PTF
•
Scitex Heads
•
Variable positioning
These features are not implemented in PTF export, therefore it is not possible to import in Océ
Document Designer .
320
A29247-X89-X-3-7678
Appendix: Objects XML Input
A29247-X89-X-3-7678
321
XML - Layout
322
!
LABarcodeImpl - see also Barcodes chapter
!
LABorderStyleImpl - see also Border Style description
!
LACellImpl
!
LAChartImpl
!
LAColorImpl - see also Full Color overview
!
LADataImpl
!
ChartAxis
!
ChartContainer
!
ChartLegend
!
ChartSerie
!
ChartStripes
!
LAElementObjectImpl - see also Element Object description
!
LAFillStyleImpl - see also FillStyle description
!
LAFlowAreaImpl
!
LAFlowImpl - see also Flow description
!
LAFlowObjectImpl - see also FlowObject description
!
LAFontImpl
!
LAImageImpl - see also Images description
!
LAImageObjectImpl - see also Images description
!
LALayoutImpl
!
LALineStyleImpl - see also LineStyle description
!
LAMessageAreaImpl - see also White space management chapter
!
LAMessageGroupImpl - see also White space management chapter
!
LAMessageImpl - see also White space management chapter
!
LAMessageManagementImpl - see also White space management chapter
!
LANodeImpl
!
LAObjectDefaultImpl
A29247-X89-X-3-7678
!
LAObjectGroupImpl
!
LAPageImpl - see also Page description
!
LAPagesImpl - see also Pages description
!
LAParaStyleImpl - see also Paragraph Style description
!
LAPathObjectImpl
!
LARowSetImpl
!
LAScriptedObjectImpl
!
LATableImpl - see also Table description
!
LATableOfContentsImpl
!
LATextOnPathImpl
!
LATextStyleImpl - see also Text style description
!
LAVariableImpl - see also Variables description
!
OrdinalSortAndSearcher
!
StringSortAndSearcher
!
WorkFlowTreeDefinition
!
WSMMCAlways
!
WSMMCCampaignImpression
!
WSMMCCustomerImpression
!
WSMMCRandomImpression
!
WSMMCScript
!
WSMMCTotalImpression
!
WSMMessageRulesImpl
!
WSMMMIncCount
!
WSMMMIncPriority
!
WSMMMMulPriority
!
WSMMMResetCategory
!
WSMMMResetCount
!
WSMMMResetPriority
!
WSMMMResetType
A29247-X89-X-3-7678
323
!
WSMMMScript
!
WSMMMSetCategory
!
WSMMMSetCount
!
WSMMMSetPriority
!
WSMMMSetRandomPriority
!
WSMMMSetType
!
WSMTextMessageLogger
!
WSMXMLExternMessageSource
!
WSMXMLMessageTracker
ClassName:
ChartAxis
beginRepeatedOptionals
Axis_FillStyle
type:ttIface
FillStyle
Empty
Axis_GridFillStyle
type:ttIface
FillStyle
Empty
Axis_MinorGridFillStyle
type:ttIface
FillStyle
Empty
Axis_LabelTextStyle
type:ttIface
FillStyle
Axis_TitleStyle
type:ttIface
FillStyle
324
Axis_Min
type:ttDouble
Axis_Max
type:ttDouble
Axis_GridWidth
type:ttDouble
A29247-X89-X-3-7678
Axis_MinorGridWidth
type:ttDouble
Axis_Step
type:ttDouble
Axis_MinorStep
type:ttDouble
Axis_FirstLabelAt
type:ttDouble
Axis_ScaleUnit
type:ttDouble
Axis_LineWidth
type:ttDouble
Axis_TickMarkLength
type:ttDouble
MarkStyle
type:ttEnum
None
Outside
Inside
Cross
MinorMarkStyle
type:ttEnum
None
Outside
Inside
Cross
GridLineStyle
type:ttEnum
Solid
Dash
Dot
DashDot
DashDotDot
MinorGridLineStyle
type:ttEnum
Solid
Dash
Dot
DashDot
DashDotDot
A29247-X89-X-3-7678
325
DecimalCount
type:ttInt
ForceZero
type:ttBool
ShowGrid
type:ttBool
ShowMinorGrid
type:ttBool
AutoScale
type:ttBool
Visible
type:ttBool
UseAutoSizeMajor
type:ttBool
UseAutoSizeMinor
type:ttBool
LabelArrayVariable
type:ttIface
Variable
Empty
ArrayVariable
type:ttIface
Variable
Empty
AxisWallFillStyle
type:ttIface
Variable
Empty
beginOptional
Label
Name
type:ttString
LabelVariable
type:ttIface
Variable
Empty
KeyLabel
type:ttString
Value
type:ttDouble
endBegin
endBegin
ClassName:
326
ChartContainer
A29247-X89-X-3-7678
Chart_BackGroundFillStyle type:ttIface
FillStyle
Empty
Chart_HasBorder
type:ttBool
Chart_BorderFillStyle
type:ttIface
FillStyle
Empty
Chart_BorderWidth
type:ttDouble
Chart_BottomGap
type:ttDouble
Chart_TopGap
type:ttDouble
Chart_LeftGap
type:ttDouble
Chart_RightGap
type:ttDouble
Chart_Use3DView
type:ttBool
Chart_3DDepth
type:ttDouble
Chart_WallWidth
type:ttDouble
Chart_Volume
type:ttDouble
Chart_Type
type:ttEnum
Bar
Pie
Line
Stack
StackPercentual
LineStacked
LinePercStacked
CustomImage
XY
A29247-X89-X-3-7678
Chart_ShowPointLabels
type:ttBool
Chart_PointLabelsVAlign
type:ttEnum
327
Right
Left
Center
Chart_PointLabelsHAlign
type:ttEnum
Top
Bottom
BaseLine
Chart_PointLabelAngle
type:ttInt
Chart_PointLabelOffset
type:ttDouble
Chart_CircleFlatness
type:ttDouble
Chart_HeightOfBarrel
type:ttDouble
Chart_PointLabelFillStyle type:ttIface
TextStyle
Chart_TitleTextStyle
type:ttIface
TextStyle
Empty
Chart_Title
type:ttString
Chart_ShowGuideLines
type:ttBool
Chart_GuideLineWidth
type:ttDouble
Chart_GuideLineStyle
type:ttIface
LineStyle
Empty
Chart_GuideFillStyle
type:ttIface
FillStyle
Empty
Chart_GuideLinesFromEdge type:ttBool
328
Chart_GuideUnderline
type:ttBool
FillAreaBelowLine
type:ttBool
ShowLegendBox
type:ttBool
A29247-X89-X-3-7678
Legend
endBegin
AxisX
AxisY
Chart_PointLabelsProps
type:ttEnum
X
Y
Both
Chart_PointLabelsBefore
type:ttString
Chart_PointLabelsBeetween type:ttString
Chart_PointLabelsAfter
type:ttString
beginOptional
Serie
endBegin
StripesX
StripesY
ClassName:
ChartLegend
LegPos
type:ttEnum
Left
Right
Top
Bottom
Percentage
type:ttInt
TextStyle
type:ttIface
FillStyle
Empty
TextFillStyle
A29247-X89-X-3-7678
type:ttIface
329
FillStyle
Empty
endBegin
ClassName:
ChartSerie
BorderFillStyle
type:ttIface
FillStyle
Empty
LineFillStyle
type:ttIface
FillStyle
Empty
BorderWith
type:ttDouble
LineWidth
type:ttDouble
MarkerSize
type:ttDouble
MarkerStep
type:ttInt
Volume
type:ttDouble
DecimalsCount
type:ttInt
Array
type:ttIface
Variable
Empty
ValueVariable
type:ttIface
Variable
Empty
LabelVariable
type:ttIface
Variable
Empty
ValueFromVariable
type:ttIface
Variable
330
A29247-X89-X-3-7678
Empty
SerieLineStyle
type:ttIface
Line style
Empty
LineSpecialMark
type:ttEnum
Empty
Box
Circle
Cross
Diamond
Triangle
X
LegendText
type:ttString
beginOptional
SerieItem
Value
type:ttDouble
From
type:ttDouble
Label
type:ttString
LabelVariable
type:ttIface
Variable
Empty
ValueVariable
type:ttIface
Variable
Empty
ValueFromVariable
type:ttIface
Variable
Empty
FillStyle
type:ttIface
FillStyle
A29247-X89-X-3-7678
331
Empty
beginOptional
ShadeItem
ShadeFill
type:ttIface
FillStyle
Empty
endBegin
endBegin
endBegin
ValueAtImagePercentHeight type:ttDouble
SmoothLines
ClassName:
type:ttBool
ChartStripes
ArrStripes
type:ttIface
Variable
Empty
FromArr
type:ttIface
Variable
Empty
ToArr
type:ttIface
Variable
Empty
ArrStripeLines
type:ttIface
Variable
Empty
ValArr
type:ttIface
Variable
Empty
332
A29247-X89-X-3-7678
LabelArr
type:ttIface
Variable
Empty
beginOptional
Stripe
FromV
type:ttIface
Variable
Empty
ToV
type:ttIface
Variable
Empty
FillStyle
type:ttIface
FillStyle
Empty
From
type:ttDouble
To
type:ttDouble
endBegin
endBegin
beginOptional
StripeLine
ValueV
type:ttIface
Variable
Empty
LabelV
type:ttIface
Variable
Empty
FillStyle
type:ttIface
FillStyle
Empty
A29247-X89-X-3-7678
333
LineStyle
type:ttIface
LineStyle
Empty
TextStyle
type:ttIface
TextStyle
Empty
Value
type:ttDouble
Label
type:ttString
endBegin
ClassName:
LABarcodeImpl
BarcodeName
type:ttString
ConvertString
type:ttString
VariableId
type:ttIface
Variable
Empty
FillStyleId
type:ttIface
FillStyle
Empty
FillBackgroungStyleId
type:ttIface
FillStyle
Empty
UseCodec
type:ttBool
TextCodec
type:ttString
BarcodeGenerator
Type
type:ttString
endBegin
334
A29247-X89-X-3-7678
ClassName:
LABorderStyleImpl
FillStyleId
type:ttIface
FillStyle
Empty
ShadowStyleId
type:ttIface
FillStyle
Empty
Margin
UpperLeft
LowerRight
endBegin
ShadowOffset
X
type:ttDouble
Y
type:ttDouble
JoinType
type:ttEnum
Miter
Round
Bevel
Mitter
type:ttDouble
Miter
type:ttDouble
LeftLine
UpperLeftCorner
TopLine
RightTopCorner
RightLine
LowerRightCorner
BottomLine
LowerLeftCorner
A29247-X89-X-3-7678
335
LeftRightLine
RightLeftLine
UpperLeftCornerType
UpperRightCornerType
LowerRightCornerType
LowerLeftCornerType
ClassName:
LACellImpl
FlowId
type:ttIface
Flow
Empty
BorderId
type:ttIface
BorderStyle
Empty
WithFixedHeight
type:ttBool
AlwaysProcess
type:ttBool
MinWidth
type:ttDouble
MaxWidth
type:ttDouble
RatioWidth
type:ttDouble
MinHeight
type:ttDouble
MaxHeight
type:ttDouble
FlowToNextPage
type:ttBool
SpanLeft
type:ttBool
SpanUp
type:ttBool
DontWrap
type:ttBool
CellVerticalAlignment
type:ttEnum
Top
Bottom
336
A29247-X89-X-3-7678
Center
endBegin
ClassName:
LAChartImpl
ClassName:
LAColorImpl
beginOptional
RGB
type:ttMoreDoubles(3)
CMYK
HSB
LAB
SpotColor
type:ttInt
endBegin
endBegin
ClassName:
LADataImpl
RepeatedBy
type:ttIface
Variable
Empty
DataErrorVariable
type:ttIface
Variable
Empty
A29247-X89-X-3-7678
UseErrorRecovering
type:ttBool
ErrorFileName
type:ttString
ErrorDescription
type:ttIface
337
Variable
Empty
endBegin
ClassName:
LAElementObjectImpl
beginOptional
FlowObjectId
type:ttIface
FlowObject
Empty
CountX
type:ttInt
CountY
type:ttInt
GapX
type:ttDouble
GapY
type:ttDouble
endBegin
endBegin
ClassName:
LAFillStyleImpl
ColorId
type:ttIface
Color
ImageId
type:ttIface
Image
Offset
Rotation
type:ttDouble
Skew
type:ttDouble
FlipX
type:ttBool
Scale
ApplyObjectTransformation type:ttBool
338
A29247-X89-X-3-7678
TileImage
type:ttBool
AutoScale
type:ttBool
endBegin
ClassName:
LAFlowAreaImpl
FlowId
type:ttIface
Flow
Empty
PrevFlowAreaId
type:ttIface
FlowArea
Empty
NextFlowAreaId
type:ttIface
FlowArea
Empty
BorderStyleId
type:ttIface
BorderStyle
Empty
FlowingToNextPage
type:ttBool
BorderType
type:ttEnum
Content
ContentWithLineGap
FullArea
VerticalAligment
type:ttEnum
Top
Bottom
Center
WritingDirection
type:ttEnum
Horizontal
A29247-X89-X-3-7678
339
Vertical
MiddleEastSupport
type:ttBool
FittingType
type:ttEnum
Both
Horizontal
Vertical
BalancingGroup
type:ttInt
endBegin
ClassName:
LAFlowImpl
Type
type:ttEnum
Simple
Repeated
External
Integer
Interval
Condition
String
InlCond
FirstFitting
FirstFittingAuto
VariableFormatted
FlowContent
beginOptional
Width
type:ttMeters
endBegin
P
beginOptional
Id
340
type:ttIface
A29247-X89-X-3-7678
ParaStyle
endBegin
T
beginOptional
Id
type:ttIface
TextStyle
endBegin
O
Id
type:ttIface
Variable
FlowObject
Flow
Image
Table
endBegin
BR
Tab
Variable
type:ttIface
Variable
Empty
ExternalName
type:ttIface
Variable
Empty
Condition
VarId
type:ttIface
Variable
Empty
Value
A29247-X89-X-3-7678
type:ttString
341
Value
type:ttInt
Begin
type:ttInt
End
type:ttInt
endBegin
Flow
Empty
Default
type:ttIface
Flow
Empty
IDMGId
type:ttInt
endBegin
UsePercentDecent
type:ttBool
endBegin
PercentFontDecent
type:ttInt
endBegin
PointFontDecent
type:ttInt
endBegin
IterationCount
type:ttInt
endBegin
ClassName:
LAFlowObjectImpl
Size
342
A29247-X89-X-3-7678
Offset
type:ttDouble
VerticalObjectPosition
type:ttEnum
Top
Center
BaseLine
Bottom
endBegin
ClassName:
LAFontImpl
beginOptional
SystemFontName
Normal
type:ttBool
Bold
type:ttBool
Italic
type:ttBool
BoldItalic
type:ttBool
endBegin
endBegin
Normal
FontIndex
type:ttInt
FontLocation
type:ttLocation
endBegin
Bold
FontIndex
type:ttInt
FontLocation
type:ttLocation
Italic
A29247-X89-X-3-7678
FontIndex
type:ttInt
FontLocation
type:ttLocation
343
BoldItalic
ClassName:
FontIndex
type:ttInt
FontLocation
type:ttLocation
LAImageImpl
ImageType
type:ttEnum
Simple
Integer
Interval
Condition
Variable
String
InlCond
ImageLocation
type:ttLocation
ImageDPIX
type:ttDouble
ImageDPIY
type:ttDouble
VariablePageSelection
type:ttBool
PageSelectionVariableId
type:ttIface
PageSelectionVariable
Empty
SelectedPage
type:ttInt
PaletteEntry
ColorType
type:ttEnum
NoChange
Transparent
LAColor
beginOptional
AssignedColorId
344
type:ttIface
A29247-X89-X-3-7678
Color
Empty
endBegin
endBegin
ImageCondition
ImageId
type:ttIface
Image
Empty
VariableId
type:ttIface
Variable
Empty
RangeBegin
type:ttInt
RangeEnd
type:ttInt
Value
type:ttInt
Condition
type:ttString
endBegin
VariableImagePreviewId
type:ttIface
VariableImagePreview
Empty
VariableId
type:ttIface
Variable
Empty
DitheringMode
ClassName:
type:ttInt
LAImageObjectImpl
ImageId
type:ttIface
Image
A29247-X89-X-3-7678
345
Empty
endBegin
ClassName:
LALayoutImpl
ExternalLayout
Location
type:ttLocation
ExtNode
type:ttIface
Node
endBegin
endBegin
ClassName:
LALineStyleImpl
BeginOffset
type:ttDouble
DoubleVector
type:ttDouble
endBegin
ClassName:
LAMessageAreaImpl
beginOptional
346
Type
type:ttInt
MarginLeft
type:ttDouble
MarginTop
type:ttDouble
MarginRight
type:ttDouble
MarginBottom
type:ttDouble
Priority
type:ttDouble
HorizontalSpace
type:ttDouble
A29247-X89-X-3-7678
VerticalSpace
type:ttDouble
HorizontalAlignment
type:ttEnum
Left
Right
Center
JustifyLeft
JustifyRight
JustifyCenter
JustifyBlock
VerticalAligment
type:ttEnum
Top
Bottom
Center
Justify
IsDuplex
type:ttBool
PlacementType
type:ttEnum
Grid
Row
GridX
type:ttInt
GridY
type:ttInt
Category
type:ttInt
endBegin
endBegin
endBegin
ClassName:
LAMessageGroupImpl
beginOptional
A29247-X89-X-3-7678
347
MessageLimiter
type:ttInt
Rules
endBegin
MessageSourceClassId
type:ttString
MessageSource
endBegin
ClassName:
LAMessageImpl
beginOptional
Id
type:ttString
Type
type:ttEnum
Always
NoExtraPostage
FreeSpace
Never
Priority
type:ttDouble
FrontSide
type:ttIface
LANode
Empty
BackSide
type:ttIface
LANode
Empty
348
Category
type:ttDouble
FrontSideWidth
type:ttDouble
BackSideWidth
type:ttDouble
UseAllFrontSideWidth
type:ttBool
UseAllBackSideWidth
type:ttBool
SynchronizeIdWithName
type:ttBool
A29247-X89-X-3-7678
Rules
endBegin
endBegin
ClassName:
LAMessageManagementImpl
beginOptional
DatabaseClassName
type:ttString
Database
endBegin
CustomerId
type:ttIface
LANode
Empty
AddedPage
type:ttIface
LANode
Empty
LogbaseClassName
type:ttString
Logbase
endBegin
CommitPrintedMessages
type:ttBool
DebugMode
type:ttBool
BoundaryOutlineStyleId
type:ttIface
LANode
Empty
GridOutlineStyleId
type:ttIface
LANode
Empty
SpaceOutlineStyleId
type:ttIface
LANode
A29247-X89-X-3-7678
349
Empty
CustomerInfo
type:ttIface
LANode
Empty
endBegin
ClassName:
LANodeImpl
ClassName:
LAObjectDefaultImpl
Pos
Size
Rotation
type:ttDouble
Skew
type:ttDouble
FlipX
type:ttBool
Scale
PrintState
type:ttEnum
Always
Never
ProductionTimeSelectGroup1
Conditional
VariablePrintStateId
type:ttIface
IsVisible
type:ttBool
IsLocked
type:ttBool
Variable
Empty
VariablePosXId
350
type:ttIface
A29247-X89-X-3-7678
Variable
Empty
VariablePosYId
type:ttIface
Variable
Empty
VariableRotId
type:ttIface
Variable
Empty
ClassName:
SizeLocked
type:ttBool
ContentLocked
type:ttBool
StyleLocked
type:ttBool
RotationPointX
type:ttDouble
RotationPointY
type:ttDouble
RotationRound
type:ttDouble
PosLocked
type:ttBool
InfluencedMessages
type:ttBool
DitheringMode
type:ttInt
LAObjectGroupImpl
endBegin
ClassName:
LAPageImpl
ConditionType
type:ttEnum
Simple
Integer
Interval
Condition
String
A29247-X89-X-3-7678
351
InlCond
Width
type:ttMeters
Height
type:ttMeters
NextPageId
type:ttIface
NextPage
Empty
DefaultPageId
type:ttIface
DefaultPage
Empty
DefaultRollback
type:ttInt
VariableId
type:ttIface
Variable
Empty
PageCondition
ConditionId
type:ttIface
Page
Empty
RangeBegin
type:ttInt
RangeEnd
type:ttInt
Value
type:ttInt
Condition
type:ttString
Rollback
type:ttInt
PageId
type:ttIface
Page
Empty
endBegin
352
A29247-X89-X-3-7678
endBegin
endBegin
LogicalPageNameType
type:ttEnum
Simple
Variable
LogicalPageNameVariableId type:ttIface
PageNameVariable
Empty
LogicalPageName2VariableId type:ttIface
PageName2Variable
Empty
LogicalPageName
type:ttString
HGuideline
type:ttDouble
VGuideline
type:ttDouble
SheetNameVariableId
type:ttIface
SheetNameVariable
Empty
ClassName:
Weight
type:ttDouble
BackgroundColor
type:ttInt
LAPagesImpl
SelectionType
type:ttEnum
Simple
Variable
DataVariable
ConditionType
type:ttEnum
Simple
Integer
A29247-X89-X-3-7678
353
Interval
Condition
String
InlCond
RepeatedById
type:ttIface
RepeatedBy
Empty
FirstPageId
type:ttIface
FirstPage
Empty
DefaultPageId
type:ttIface
DefaultPage
Empty
VariableId
type:ttIface
Variable
Empty
PageCondition
RangeBegin
type:ttInt
RangeEnd
type:ttInt
Value
type:ttInt
Condition
type:ttString
PageId
type:ttIface
Page
Empty
ConditionId
type:ttIface
Page
Empty
354
A29247-X89-X-3-7678
endBegin
endBegin
endBegin
SequencePageId
type:ttIface
SequencePage
Empty
SheetNameVariableId
type:ttIface
SheetNameVariable
Empty
MainFlow
type:ttIface
Flow
Empty
PostagePrice
Weight
type:ttDouble
Price
type:ttDouble
endBegin
endBegin
ClassName:
LAParaStyleImpl
TabulatorProperties
Default
type:ttDouble
UseOutsideTabs
type:ttBool
Tabulator
Type
type:ttString
A29247-X89-X-3-7678
355
Pos
type:ttDouble
Leader
type:ttString
Separator
type:ttString
endBegin
endBegin
endBegin
LeftIndent
type:ttDouble
RightIndent
type:ttDouble
FirstLineLeftIndent
type:ttDouble
SpaceBefore
type:ttDouble
SpaceAfter
type:ttDouble
LineSpacing
type:ttDouble
AncestorId
type:ttIface
ParaStyle
Empty
DefaultTextStyleId
type:ttIface
TextStyle
NextParagraphStyleId
type:ttIface
ParaStyle
Empty
BorderStyleId
type:ttIface
BorderStyle
Empty
NewAreaPageAfter
type:ttEnum
None
FlowArea
Page
356
A29247-X89-X-3-7678
HAlign
type:ttEnum
Left
Right
Center
JustifyLeft
JustifyRight
JustifyCenter
JustifyBlock
IsVisible
type:ttBool
ConnectBorders
type:ttBool
WithLineGap
type:ttBool
BullettingId
type:ttIface
FlowStyle
Empty
IgnoreEmptyLines
type:ttBool
LineSpacing
type:ttEnum
Aditional
Additional
Exact
AtLeast
MultipleOf
LineSpacingType
type:ttEnum
Aditional
Additional
Exact
AtLeast
MultipleOf
A29247-X89-X-3-7678
SpaceBeforeFirst
type:ttBool
KeepTogether
type:ttBool
357
KeepWithNext
type:ttBool
DontWrap
type:ttBool
Hyphenation
Hyphenate
type:ttBool
MinLeft
type:ttInt
MinRight
type:ttInt
MaxConsecutive
type:ttInt
endBegin
Orphan
type:ttInt
Widow
type:ttInt
NumberingType
type:ttEnum
None
Increment
Reset
NumberingVariableId
type:ttIface
Variable
Empty
NumberingFrom
type:ttInt
InheritFlag
358
HorizontalAlignment
type:ttString
FirstLineLeftIndent
type:ttString
LeftIndent
type:ttString
RightIndent
type:ttString
Tabulators
type:ttString
DefaultTextStyle
type:ttString
NextParagraphStyle
type:ttString
BorderStyle
type:ttString
A29247-X89-X-3-7678
ConnectBorders
type:ttString
WithLineGap
type:ttString
SpaceBefore
type:ttString
SpaceAfter
type:ttString
LineSpacing
type:ttString
NewAreaPageAfter
type:ttString
Bulletting
type:ttString
IgnoreEmptyLines
type:ttString
psIgnoreEmptyLines
type:ttString
SpaceBeforeFirst
type:ttString
KeepTogether
type:ttString
KeepWithNext
type:ttString
DontWrap
type:ttString
Hyphenate
type:ttString
OrphanWidow
type:ttString
NumberingType
type:ttString
NumberingVariable
type:ttString
NumberingFrom
type:ttString
endBegin
ClassName:
LAPathObjectImpl
Path
MoveTo
LineTo
BezierTo
A29247-X89-X-3-7678
X1
type:ttDouble
Y1
type:ttDouble
359
X2
type:ttDouble
Y2
type:ttDouble
X
type:ttDouble
Y
type:ttDouble
endBegin
ConicTo
X1
type:ttDouble
Y1
type:ttDouble
X
type:ttDouble
Y
type:ttDouble
endBegin
FillStyleId
type:ttIface
FillStyle
Empty
OutlineStyleId
type:ttIface
FillStyle
Empty
CapType
type:ttEnum
Butt
Round
Square
JoinType
type:ttEnum
Miter
Round
Bevel
MiterLimit
type:ttDouble
LineWidth
type:ttDouble
LineStyleId
type:ttIface
LineStyle
360
A29247-X89-X-3-7678
Empty
ClassName:
LARowSetImpl
RowSetType
type:ttEnum
Row
RowSet
Repeated
Integer
Range
Condition
HeaderFooter
String
InlCond
SubRowId
type:ttIface
SubRow
Empty
VariableId
type:ttIface
Variable
Empty
endBegin
RowSetCondition
SubRowId
type:ttIface
SubRow
Empty
VariableId
type:ttIface
Variable
Empty
A29247-X89-X-3-7678
361
RangeBegin
type:ttInt
RangeEnd
type:ttInt
Value
type:ttInt
Condition
type:ttString
endBegin
VariableId
type:ttIface
Variable
Empty
VariableId
type:ttIface
Variable
Empty
VariableId
type:ttIface
Variable
Empty
VariableId
type:ttIface
Variable
Empty
VariableId
type:ttIface
Variable
Empty
ClassName:
LAScriptedObjectImpl
Script
type:ttString
Item
Alias
type:ttString
ObjectId
type:ttIface
SelectedObject
Empty
endBegin
362
A29247-X89-X-3-7678
ClassName:
LATableImpl
RowSetId
type:ttIface
RowSet
Empty
BorderId
type:ttIface
BorderStyle
Empty
HorizontalCellSpacing
type:ttDouble
VerticalCellSpacing
type:ttDouble
MinWidth
type:ttDouble
MaxWidth
type:ttDouble
PercentWidth
type:ttDouble
SpaceLeft
type:ttDouble
SpaceTop
type:ttDouble
SpaceRight
type:ttDouble
SpaceBottom
type:ttDouble
TableAlignment
type:ttEnum
Left
Right
Center
UseColumnWidths
type:ttBool
ColumnWidths
MinWidth
type:ttDouble
PercentWidth
type:ttDouble
endBegin
endBegin
A29247-X89-X-3-7678
363
ClassName:
LATableOfContentsImpl
beginOptional
PageId
type:ttIface
Page
Empty
Type
type:ttEnum
Front
BeforeWSM
AfterWSM
ConditionId
type:ttIface
Variable
Empty
ContentId
type:ttIface
Flow
Empty
ParaStyles
ParaStyleId1
type:ttIface
ParaStyle
Empty
ParaStyleId2
type:ttIface
ParaStyle
Empty
endBegin
endBegin
TextStyles
364
A29247-X89-X-3-7678
TextStyleId1
type:ttIface
TextStyle
Empty
TextStyleId2
type:ttIface
TextStyle
Empty
endBegin
endBegin
LocalNumbering
ClassName:
type:ttBool
LATextOnPathImpl
Path
MoveTo
LineTo
BezierTo
X1
type:ttDouble
Y1
type:ttDouble
X2
type:ttDouble
Y2
type:ttDouble
X
type:ttDouble
Y
type:ttDouble
endBegin
ConicTo
A29247-X89-X-3-7678
X1
type:ttDouble
Y1
type:ttDouble
X
type:ttDouble
Y
type:ttDouble
365
endBegin
FlowId
type:ttIface
Flow
ClassName:
LATextStyleImpl
FontSize
type:ttMeters
LineWidth
type:ttDouble
MiterLimit
type:ttDouble
BaselineShift
type:ttDouble
InterCharacterSpacing
type:ttDouble
OutlineStyleId
type:ttIface
FillStyle
Empty
FillStyleId
type:ttIface
FillStyle
Empty
CapType
type:ttEnum
Butt
Round
Square
JoinType
type:ttEnum
Miter
Round
Bevel
Kerning
type:ttBool
BorderStyleId
type:ttIface
BorderStyle
Empty
366
A29247-X89-X-3-7678
AncestorId
type:ttIface
TextStyle
Empty
IsVisible
type:ttBool
ConnectBorders
type:ttBool
WithLineGap
type:ttBool
FontId
type:ttIface
Font
Bold
type:ttBool
Italic
type:ttBool
Underline
type:ttBool
Strikethrough
type:ttBool
Language
type:ttString
InheritFlag
A29247-X89-X-3-7678
Font
type:ttString
FontSize
type:ttString
BaselineShift
type:ttString
InterCharacterSpacing
type:ttString
Bold
type:ttString
Italic
type:ttString
Underline
type:ttString
Strikethrough
type:ttString
Kerning
type:ttString
LineWidth
type:ttString
MiterLimit
type:ttString
CapType
type:ttString
JoinType
type:ttString
FillStyle
type:ttString
367
OutlineStyle
type:ttString
BorderStyle
type:ttString
ConnectBorders
type:ttString
WithLineGap
type:ttString
Language
type:ttString
endBegin
endBegin
ClassName:
LAVariableImpl
beginOptional
Type
type:ttEnum
Constant
DataVariable
RealVariable
Calculated
endBegin
beginOptional
VarType
type:ttEnum
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
Optional
Array
endBegin
368
A29247-X89-X-3-7678
beginOptional
Content
type:ttString
endBegin
Script
type:ttString
InsideFnc
type:ttInt
beginOptional
PresentationType
type:ttEnum
Simple
Uppercase
Lowercase
Titlecase
EachWordTitle
MinMaxDecimalPlaces
ConcatenateAll
ConcatenateAllExceptFirst
Prefix
type:ttString
Suffix
type:ttString
MinDecPlaces
type:ttInt
MaxDecPlaces
type:ttInt
FalseExp
type:ttString
TrueExp
type:ttString
InsertBetween
type:ttString
EmptyText
type:ttString
FalseText
type:ttString
endBegin
endBegin
beginOptional
DisplayConstant
A29247-X89-X-3-7678
type:ttString
369
endBegin
beginOptional
DisplayName
type:ttString
endBegin
beginOptional
FCVClassName
type:ttString
beginOptional
FCVProps
endBegin
endBegin
beginOptional
GlobalClearType
type:ttEnum
OnStart
EachRecord
EachPageRep
EachPage
endBegin
beginOptional
GlobalAutoAdd
type:ttIface
Variable
endBegin
beginOptional
PreviewContent
type:ttString
endBegin
beginOptional
NumberingParent
type:ttIface
Variable
Empty
endBegin
370
A29247-X89-X-3-7678
ClassName:
OrdinalSortAndSearcher
ClassName:
StringSortAndSearcher
LocaleProp
type:ttString
Normalization
type:ttBool
FrenchCol
type:ttBool
CaseLevel
type:ttBool
Strength
type:ttEnum
Primary
Secondary
Tertiary
Quaternary
Identical
endBegin
ClassName:
WorkFlowTreeDefinition
ClassName:
WSMMCAlways
ClassName:
WSMMCCampaignImpression
Limit
ClassName:
ClassName:
type:ttInt
WSMMCCustomerImpression
Limit
type:ttInt
NumberOfDays
type:ttInt
WSMMCRandomImpression
A29247-X89-X-3-7678
371
Probability
ClassName:
type:ttDouble
WSMMCScript
beginOptional
Script
type:ttString
endBegin
endBegin
ClassName:
ClassName:
WSMMCTotalImpression
Limit
type:ttInt
NumberOfDays
type:ttInt
WSMMessageRulesImpl
beginOptional
CondClassName
type:ttString
Condition
endBegin
ModClassName
type:ttString
Modificator
endBegin
ClassName:
WSMMMIncCount
beginOptional
IncCount
type:ttInt
endBegin
endBegin
372
A29247-X89-X-3-7678
ClassName:
WSMMMIncPriority
beginOptional
IncPriority
type:ttDouble
endBegin
endBegin
ClassName:
WSMMMMulPriority
beginOptional
Coef
type:ttDouble
endBegin
endBegin
ClassName:
WSMMMResetCategory
ClassName:
WSMMMResetCount
ClassName:
WSMMMResetPriority
ClassName:
WSMMMResetType
ClassName:
WSMMMScript
beginOptional
Script
type:ttString
endBegin
endBegin
A29247-X89-X-3-7678
373
ClassName:
WSMMMSetCategory
beginOptional
Category
type:ttInt
endBegin
endBegin
ClassName:
WSMMMSetCount
beginOptional
Count
type:ttInt
endBegin
endBegin
ClassName:
WSMMMSetPriority
beginOptional
Priority
type:ttDouble
endBegin
endBegin
ClassName:
WSMMMSetRandomPriority
beginOptional
RangeFrom
type:ttDouble
RangeTo
type:ttDouble
endBegin
endBegin
374
A29247-X89-X-3-7678
ClassName:
WSMMMSetType
beginOptional
Type
type:ttEnum
Always
NoExtraPostage
FreeSpace
Never
endBegin
endBegin
ClassName:
WSMTextMessageLogger
beginOptional
Location
type:ttLocation
Codec
type:ttString
endBegin
endBegin
ClassName:
WSMXMLExternMessageSource
beginOptional
Location
type:ttLocation
Codec
type:ttString
endBegin
endBegin
ClassName:
WSMXMLMessageTracker
A29247-X89-X-3-7678
375
DBLocation
376
type:ttLocation
A29247-X89-X-3-7678
XML - List of FCVs
See also DataTransformer module description for further info.
!
BT2BTFCV
!
CaseConvFCV
!
ConcatStrFCV
!
CondProcFCV
!
ConvNumFCV
!
CustInt2StrFCV
!
CustStr2StrFCV
!
DateTimeModifyFCV
!
DaTiToStringFCV
!
EuroFCV
!
FileContentFCV
!
IntDecrFCV
!
IntIncrFCV
!
LatinToRomeNumberFCV
!
LetterIndexFCV
!
NumberToSpellFCV
!
PageSelectConvFCV
!
PDFPageCountFCV
!
PrintNet3FCV
!
PrintNumbersFCV
!
ScriptFCV
!
StackFCV
!
ToDateTimeFCV
ClassName:
BT2BTFCV
A29247-X89-X-3-7678
377
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
SkipWarnings
type:ttBool
IgnoreCharacters
type:ttBool
IgnoreThese
type:ttString
NegativeFormat
type:ttEnum
SignAtBegin
RoundBracket
SignAtEnd
UserDefined
378
DecimalPoint
type:ttString
EmptyResult
type:ttDouble
A29247-X89-X-3-7678
ErrorResult
type:ttDouble
SkipErrors
type:ttBool
Length
type:ttInt
FillWithZeros
type:ttBool
Base
type:ttInt
Truncate
type:ttBool
LeftJustified
type:ttBool
BigLetters
type:ttBool
SeparateThousands
type:ttBool
SeparateThousandsWith
type:ttString
EnableCondition
type:ttBool
Condition
type:ttString
ConditionResult
type:ttString
UsePrecision
type:ttBool
Precision
type:ttInt
MaxDigitsAfterDecimal
type:ttInt
MinDigitsAfterDecimal
type:ttInt
DigitsBeforeDecimalPoint type:ttBool
NumberOfDigitsBeforeDec
type:ttInt
FillRemainingWith
type:ttEnum
Zeroes
Spaces
NegativeBeforeText
type:ttString
NegativeAfterText
type:ttString
PositiveBeforeText
type:ttString
PositiveAfterText
type:ttString
RoundDecimalPos
type:ttInt
endBegin
ClassName:
CaseConvFCV
A29247-X89-X-3-7678
379
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
BeforeText
type:ttString
AfterText
type:ttString
Type
type:ttEnum
LowerCase
UpperCase
FirstUpperCase
CodePage
type:ttString
endBegin
ClassName:
ConcatStrFCV
380
A29247-X89-X-3-7678
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
PreString
type:ttString
PostString
type:ttString
Type
type:ttEnum
Concatenation
TrimWhiteSpaces
TrimLeftWhiteSpaces
TrimRightWhiteSpaces
ReduceWhiteSpaces
TrimAndReduceWhiteSpaces
AdvancedConcatenation
MaskMerge
A29247-X89-X-3-7678
381
SimpleCaseConversion
ReplaceSpacesByHardspaces
Variable
PreString
type:ttString
PostString
type:ttString
VarIndex
type:ttInt
VarName
type:ttString
Type
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
endBegin
CaseType
type:ttEnum
LowerCase
UpperCase
TitleCase
TitleCaseEachWord
ClassName:
ConcatenationIfEmpty
type:ttBool
Mask
type:ttString
CondProcFCV
InputType
type:ttNodeType
String
Int
382
A29247-X89-X-3-7678
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
TextCodePage
type:ttString
Script
type:ttString
UsedVariableCount
type:ttInt
UsedVariable
NameUnicode
type:ttString
NameSingleCode
type:ttString
endBegin
ClassName:
ConvNumFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
A29247-X89-X-3-7678
383
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
InGroupSeparator
type:ttString
InDecimalSeparator
type:ttString
InUnit
type:ttEnum
1
1/10
1/100
1/1000
OutLeadingZeroes
type:ttEnum
No modification
Replace with blanks
Supress
OutPrintPlus
type:ttEnum
Always
Input dependent
Never
OutDigitsAfterDecimal
384
type:ttInt
A29247-X89-X-3-7678
OutDigitsBeforeDecimal
type:ttInt
OutGroupSeparator
type:ttString
OutDecimalSeparator
type:ttString
OutPadding
type:ttEnum
Blank
Zero
OutSignPosition
type:ttEnum
Sign before number
Sign on left
PrintZeroValue
type:ttEnum
Input Dependent
Always
Never
EmptyOutput
type:ttEnum
LikePrintNet3
Empty
endBegin
ClassName:
CustInt2StrFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
A29247-X89-X-3-7678
type:ttNodeType
385
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
DefaultValue
type:ttString
Field
Key
type:ttInt
Value
type:ttString
endBegin
ClassName:
CustStr2StrFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
386
A29247-X89-X-3-7678
Double
DateTime
Bool
SubTree
DefaultValue
type:ttString
Field
Key
type:ttString
Value
type:ttString
endBegin
ClassName:
DateTimeModifyFCV
AddToYear
type:ttInt
AddToMonth
type:ttInt
AddToDay
type:ttInt
AddToHours
type:ttInt
AddToMinutes
type:ttInt
AddToSeconds
type:ttInt
AddToMilliseconds
type:ttInt
endBegin
ClassName:
DaTiToStringFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
A29247-X89-X-3-7678
387
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
TimeOption
type:ttEnum
None
Full
Long
Medium
Short
DateOption
type:ttEnum
None
Full
Long
Medium
Short
DateOffset
DateTime
FormatMethod
type:ttEnum
TypeOfOutput
UserPattern
388
Locale
type:ttString
OutputPattern
type:ttString
A29247-X89-X-3-7678
UseDefaultValue
type:ttBool
DefaultValue
type:ttString
endBegin
ClassName:
EuroFCV
State
type:ttString
CustomRate
type:ttDouble
endBegin
ClassName:
FileContentFCV
ClassName:
IntDecrFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
A29247-X89-X-3-7678
389
endBegin
ClassName:
IntIncrFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
endBegin
ClassName:
LatinToRomeNumberFCV
ClassName:
LetterIndexFCV
LetterCase
type:ttEnum
UpperCase
LowerCase
IndexingMode
390
type:ttEnum
A29247-X89-X-3-7678
ModeAB
ModeAA
endBegin
ClassName:
NumberToSpellFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
Locale
type:ttString
Rules
type:ttString
UseSpaceReplacer
type:ttBool
SpaceReplacer
type:ttString
endBegin
ClassName:
PageSelectConvFCV
A29247-X89-X-3-7678
391
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
endBegin
ClassName:
PDFPageCountFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
392
A29247-X89-X-3-7678
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
endBegin
ClassName:
PrintNet3FCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
A29247-X89-X-3-7678
393
DateTime
Bool
SubTree
FCVDllName
type:ttString
HeaderSize
type:ttInt
FooterSize
type:ttInt
Header
type:ttString
Footer
type:ttString
CodePage
type:ttString
endBegin
ClassName:
PrintNumbersFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
394
A29247-X89-X-3-7678
SubTree
Method
type:ttEnum
Correction
type:ttInt
Divide
type:ttInt
Offset
type:ttInt
DigitCount
type:ttInt
Weight
type:ttString
ConversionTableSize
type:ttInt
ConvertedText
type:ttString
endBegin
ClassName:
ScriptFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
A29247-X89-X-3-7678
395
SubTree
Script
type:ttString
WorkFlowDefinition
endBegin
ClassName:
StackFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
FCVClassName
type:ttString
FCVProps
endBegin
endBegin
396
A29247-X89-X-3-7678
WorkFlowDefinition
ClassName:
ToDateTimeFCV
InputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
OutputType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
TimeOption
type:ttEnum
None
Full
Long
Medium
Short
DateOption
type:ttEnum
None
A29247-X89-X-3-7678
397
Full
Long
Medium
Short
DateOffset
DateTime
FormatMethod
type:ttEnum
TypeOfOutput
UserPattern
Locale
type:ttString
Pattern
type:ttString
BeLenient
type:ttBool
ErrorLevel
type:ttEnum
Warning
Error
IgnoreEmpty
type:ttBool
ShowMessageOnce
type:ttBool
endBegin
398
A29247-X89-X-3-7678
XML - Modules
!
RTWFMBookletter - see also BookletMaker description
!
RTWFMCustCode - see also CustomerCode description
!
RTWFMDataAdd - see also DataAdd description
!
RTWFMDataCacher - see also DataCacher description
!
RTWFMDataFilter - see also DataFilter description
!
RTWFMDataGroupBy - see also DataGroupBy description
!
RTWFMDataInput - see also DataInput description
!
RTWFMDataMerger - see also DataMerger description
!
RTWFMDataOutput - see also DataOutput description
!
RTWFMDataPrecise
!
RTWFMDataSorter - see also DataSorter description
!
RTWFMDataTransformer - see also DataTransformer description
!
RTWFMDataUnGroup - see also DataUngroup description
!
RTWFMExternalDataInput - see also ExternalDataInput description
!
RTWFMGroupFilter - see also GroupFilter description
!
RTWFMInternalDataInput - see also InternalDataInput description
!
RTWFMJobReporter - see also JobReporter description
!
RTWFMLayout
!
RTWFMMarksInserter - see also MarksInserter description
!
RTWFMMediaPatternFilter - see also Media Pattern Filter description
!
RTWFMMinMaxGenerator - see also MinMax Generator description
!
RTWFMODBCDataInput - see also ODBCDataInput description
!
RTWFMOutput
!
RTWFMParamInput - see also ParamInput description
!
RTWFMRecordMerger
!
RTWFMRegionBinder - see also RegionBinder description
!
RTWFMRotator - see also Transformer description
A29247-X89-X-3-7678
399
!
RTWFMSAPDataInput
!
RTWFMScriptDataInput - see also ScriptDataInput description
!
RTWFMScriptLibrary
!
RTWFMSheetDuplexer - see also SheetDuplexer description
!
RTWFMSheetDuplicator - see also SheetDuplicator description
!
RTWFMSheetFilter - see also SheetFilter description
!
RTWFMSheetInserter - see also SheetInserter description
!
RTWFMSheetNSSplitter - see also SheetNSSplitter description
!
RTWFMSheetPadder - see also SheetPadder description
!
RTWFMSheetRegrouper - see also SheetRegrouper description
!
RTWFMSheetSorter - see also SheetSorter description
!
RTWFMSimpleNUpper - see also SimpleNUpper description
!
RTWFMStatisticData - see also StatisticData description
!
RTWFMStatisticOutput - see also StatisticOutput description
!
RTWFMTextReplacer - see also TextReplacer description
!
RTWFMTNGNative
!
RTWFMXMLDataInput - see also XMLDataInput description
ClassName:
RTWFMBookletter
BookletDefinition
OutputSheetCount
type:ttInt
PageDefinition
OutputSheet
type:ttInt
Offset
Scale
400
A29247-X89-X-3-7678
Rotation
type:ttDouble
endBegin
endBegin
ClassName:
RTWFMCustCode
SelectedNodeA
FullPathName
type:ttString
NodeType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
NodeOptionality
type:ttNodeOptionality
Optional
MustExist
Array
endBegin
SelectedNodeB
FullPathName
type:ttString
NodeType
type:ttNodeType
String
Int
Int64
Currency
Double
A29247-X89-X-3-7678
401
DateTime
Bool
SubTree
NodeOptionality
Optional
MustExist
Array
SearcherClassName
type:ttString
SearcherProps
OptimalizedForLD
ClassName:
RTWFMDataAdd
ClassName:
RTWFMDataCacher
type:ttBool
ProofCacheIndex
type:ttInt
ProductionCacheIndex
type:ttInt
Location
type:ttLocation
endBegin
ClassName:
RTWFMDataFilter
beginOptional
Conditions
beginOptional
Condition
SearchName
type:ttString
ValueType
type:ttNodeType
402
A29247-X89-X-3-7678
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
InvertCondition
type:ttBool
ConditionType
type:ttString
Value
type:ttString
Value
type:ttBool
Value
type:ttInt
Value
type:ttDouble
endBegin
endBegin
endBegin
endBegin
ClassName:
RTWFMDataGroupBy
FieldName
type:ttString
Field
type:ttString
endBegin
A29247-X89-X-3-7678
403
ClassName:
RTWFMDataInput
beginOptional
WorkFlowDefinition
endBegin
Location
type:ttLocation
TextCodec
type:ttString
Reader
type:ttString
ReaderProps
endBegin
StructureElement
Name
type:ttString
Level
type:ttInt
Optionality
Optional
MustExist
Array
endBegin
ClassName:
UseFirstXRecordsForProof
type:ttBool
ProofRecordCount
type:ttInt
MaintainChildOrder
type:ttBool
SimpleRecordName
type:ttString
RTWFMDataMerger
SelectedNodeA
404
FullPathName
type:ttString
NodeType
type:ttNodeType
A29247-X89-X-3-7678
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
NodeOptionality
Optional
MustExist
Array
endBegin
SelectedNodeB
FullPathName
type:ttString
NodeType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
NodeOptionality
Optional
MustExist
Array
SearcherClassName
A29247-X89-X-3-7678
type:ttString
405
SearcherProps
OptimalizedForLD
ClassName:
type:ttBool
RTWFMDataOutput
FileName
type:ttString
TextCodec
type:ttString
FileType
type:ttEnum
CSV
TXT
XML
TSD
FLT
endBegin
ClassName:
RTWFMDataPrecise
ArrayIndex
type:ttInt
WorkFlowDefinition
WorkFlowDefinition
Script
type:ttString
EnhancedField
Type
type:ttEnum
Empty
Name
Street
City
JTtl
TNum
406
A29247-X89-X-3-7678
SourceVariableIndex
type:ttInt
SourceBinary
type:ttString
endBegin
endBegin
ClassName:
RTWFMDataSorter
beginOptional
SortParam
Name
type:ttString
FullPathName
type:ttString
NodeType
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
Ascending
type:ttBool
SortSearcherClassName
type:ttString
SearcherProps
endBegin
ClassName:
AddNonSorted
type:ttBool
AddNewSortedName
type:ttString
OptimalizedForLD
type:ttBool
RTWFMDataTransformer
A29247-X89-X-3-7678
407
beginOptional
WorkFlowDefinition
endBegin
beginOptional
CreatedNodes
beginOptional
CreatedNode
Type
type:ttNodeType
String
Int
Int64
Currency
Double
DateTime
Bool
SubTree
Optionality
Optional
MustExist
Array
Caption
type:ttString
FieldDotName
type:ttString
ParentDotName
type:ttString
LinkedToDotName
type:ttString
408
A29247-X89-X-3-7678
LinkedType
type:ttEnum
Input
Linked
StandAlone
Special
Operation
type:ttEnum
Sum
Average
Min
Max
StandartDeviation
CopyLevelUp
DefaultValue
type:ttString
endBegin
endBegin
endBegin
beginOptional
Transformations
beginOptional
Transformation
DotName
type:ttString
Propagate
type:ttBool
NodeType
type:ttNodeType
String
Int
Int64
A29247-X89-X-3-7678
409
Currency
Double
DateTime
Bool
SubTree
FCVClassName
type:ttString
FCVProps
endBegin
endBegin
endBegin
endBegin
beginOptional
beginOptional
SavedArray
FullPathName
type:ttString
endBegin
endBegin
beginOptional
beginOptional
ErrorVariable
FullPathName
type:ttString
endBegin
endBegin
ClassName:
RTWFMDataUnGroup
FieldName
type:ttString
endBegin
410
A29247-X89-X-3-7678
ClassName:
RTWFMExternalDataInput
beginOptional
PlugInCaption
type:ttString
PlugInProperties
type:ttString
Location
type:ttLocation
endBegin
ClassName:
RTWFMGroupFilter
RangeType
type:ttInt
Negate
type:ttBool
GroupOriented
type:ttBool
Start
type:ttInt
End
type:ttInt
Range
type:ttString
endBegin
ClassName:
RTWFMInternalDataInput
WorkFlowDefinition
endBegin
Location
ClassName:
type:ttLocation
RTWFMJobReporter
A29247-X89-X-3-7678
ReportFileName
type:ttString
Codec
type:ttString
Append
type:ttBool
411
ClassName:
RTWFMLayout
ClassName:
RTWFMMarksInserter
MarkModuleClassId
type:ttInt
Position
Size
PlacementType
type:ttEnum
onEveryPage
onEvenPage
endBegin
ClassName:
RTWFMMediaPatternFilter
IgnoreOrder
type:ttBool
PatternSequence
type:ttString
endBegin
ClassName:
RTWFMMinMaxGenerator
HideCharacters
type:ttBool
Enabled
type:ttBool
ReplacingChar
type:ttInt
endBegin
ClassName:
412
RTWFMODBCDataInput
ConnectString
type:ttString
CatalogName
type:ttString
SelectedTable
type:ttString
A29247-X89-X-3-7678
ExecuteCommand
type:ttString
WorkFlowDefinition
DefinitionName
ClassName:
type:ttString
RTWFMOutput
SplitRecordCount
type:ttBool
PhysicalPage
PageName
type:ttString
PageDim
DuplexType
type:ttEnum
Simplex
DuplexShortEdge
DuplexLongEdge
PageWeight
type:ttDouble
endBegin
PrinterMediaConfig
ConfigType
type:ttString
Name
type:ttString
PageMediaConfig
ClassName:
RTWFMParamInput
Param
FieldName
type:ttString
ParamLabel
type:ttString
ParamType
type:ttEnum
String
A29247-X89-X-3-7678
413
Bool
Double
Int
CommandLine
type:ttString
Default
type:ttString
endBegin
StructName
type:ttString
endBegin
ClassName:
RTWFMRecordMerger
ArrayDotName
type:ttString
AlternateParam
type:ttString
CodecName
type:ttString
Location
type:ttLocation
endBegin
ClassName:
RTWFMRegionBinder
CodecNameOut
type:ttString
LocationOut
type:ttString
LocationConfig
type:ttLocation
ReportCodec
type:ttString
ReportLocation
type:ttString
endBegin
ClassName:
RTWFMRotator
RotateAngle
414
type:ttDouble
A29247-X89-X-3-7678
Offset
Scale
Negate
type:ttBool
ConditionType
type:ttEnum
Always
BySheetName
BySheetName2
String
type:ttString
ComparisonType
type:ttEnum
EqualTo
BeginsWith
Contains
SheetNameIndex
type:ttInt
endBegin
ClassName:
RTWFMSAPDataInput
beginOptional
Location
type:ttLocation
endBegin
beginOptional
TextCodec
type:ttString
endBegin
beginOptional
RootName
type:ttString
endBegin
beginOptional
UseFirstXRecordsForProof type:ttBool
endBegin
beginOptional
A29247-X89-X-3-7678
415
ProofRecordCount
type:ttBool
endBegin
ClassName:
RTWFMScriptDataInput
beginOptional
Location
type:ttLocation
endBegin
beginOptional
TextCodec
type:ttString
endBegin
beginOptional
Script
type:ttString
endBegin
beginOptional
WorkFlowDefinition
endBegin
ClassName:
RTWFMScriptLibrary
beginOptional
Location
type:ttLocation
endBegin
beginOptional
Script
type:ttString
endBegin
beginOptional
AutoInclude
type:ttBool
endBegin
ClassName:
416
RTWFMSheetDuplexer
A29247-X89-X-3-7678
DuplexerType
type:ttEnum
Simple
RepeatFirst
RepeatSecond
RepeatAuto
ClassName:
RTWFMSheetDuplicator
DuplicatorType
type:ttEnum
Variable
Fixed
Count
type:ttInt
endBegin
ClassName:
RTWFMSheetFilter
FilterType
type:ttEnum
ByRange
BySheetName
BySheetName2
Negate
type:ttBool
Range
Min
type:ttInt
Max
type:ttInt
endBegin
String
type:ttString
ComparisonType
type:ttEnum
EqualTo
BeginsWith
A29247-X89-X-3-7678
417
Contains
SheetNameIndex
ClassName:
type:ttInt
RTWFMSheetInserter
InserterType
type:ttEnum
Groups
Sheets
PlacementType
type:ttEnum
Before
After
Count
ClassName:
type:ttInt
RTWFMSheetNSSplitter
Count
X
type:ttInt
Y
type:ttInt
endBegin
Offset
SplitByRecords
type:ttBool
DuplexType
type:ttEnum
Simplex
DuplexX2
DuplexY2
DuplexX1
DuplexY1
ClassName:
RTWFMSheetPadder
418
A29247-X89-X-3-7678
PadTo
type:ttInt
endBegin
ClassName:
RTWFMSheetRegrouper
RegrouperType
type:ttEnum
ByGroup
BySheet
Single
BySheetNameChange
BySheetNameCondition
Count
type:ttInt
SheetNameIndex
type:ttInt
ConditionValue
type:ttString
ConditionComparisonType
type:ttEnum
EqualTo
BeginsWith
Contains
ClassName:
ConditionSheetNameIndex
type:ttInt
ConditionInvert
type:ttBool
RTWFMSheetSorter
SorterType
type:ttEnum
SortSheets
SortGroups
ClassName:
SheetNameIndex
type:ttInt
ReverseOrder
type:ttBool
RTWFMSimpleNUpper
A29247-X89-X-3-7678
419
Count
X
type:ttInt
Y
type:ttInt
endBegin
Offset
DuplexType
type:ttEnum
Simplex
DuplexX
DuplexY
ClassName:
RTWFMStatisticData
beginOptional
WorkFlowDefinition
endBegin
ClassName:
RTWFMStatisticOutput
FileName
type:ttString
TextCodec
type:ttString
WhatToWrite
type:ttEnum
Begin of group
All Sheets
420
WritePageCount
type:ttBool
WriteSheetName1
type:ttBool
WriteSheetName2
type:ttBool
WriteGroupBegin
type:ttBool
WriteSheetCount
type:ttBool
WriteSeparator
type:ttString
WriteAlignPageCount
type:ttBool
A29247-X89-X-3-7678
WriteAlignSheetCount
type:ttBool
WritePageCountW
type:ttInt
SheetCountW
type:ttInt
endBegin
ClassName:
RTWFMTextReplacer
ModulName
type:ttString
Field
Key
type:ttString
Value
type:ttString
endBegin
ClassName:
RTWFMTNGNative
Type
type:ttEnum
All
SheetRange
Sheet
GroupRange
Group
SelectedInput
type:ttEnum
Data
GUI
UploadAllFonts
type:ttBool
GUIJob
A29247-X89-X-3-7678
Location
type:ttString
Param1
type:ttInt
Param2
type:ttInt
421
ClassName:
RTWFMXMLDataInput
Location
type:ttLocation
TextCodec
type:ttString
XMLNode
Type
type:ttEnum
Element
Attribute
PCData
OneOf
Sequence
Level
type:ttInt
Optionality
type:ttEnum
One
ZeroOrOne
ZeroOrMore
OneOrMore
Change
type:ttEnum
None
Ignore
Flatten
ErrorRecover
Name
type:ttString
XMLName
type:ttString
DefaultValue
type:ttString
endBegin
endBegin
NotDefSevAttr
422
type:ttEnum
A29247-X89-X-3-7678
Ignore
WarnOnce
WarnAll
Error
NotDefSevElem
type:ttEnum
Ignore
WarnOnce
WarnAll
Error
A29247-X89-X-3-7678
AllowAnyOrderOfElements
type:ttBool
IgnoreNamespaces
type:ttBool
423
A29247-X89-X-3-7678
425
IPDS Exceptions
IPDS Exceptions
426
A29247-X89-X-3-7678
IPDS Exceptions
Specification Check - General Exceptions
A specification check-general exception indicates that the printer has received a command with an
invalid or unsupported parameter or value. This exception class contains specification checks which
are common to all IPDS data types.
Some general specification checks are also specified by the PTOCA architecture, and are identified
accordingly.
Format 0 is used for all general specification check exceptions, except for exception ID X'020A..05',
which uses either format 1 or format 7.
0200..01 Text control-sequence code exception
Action Code: X'01' or X'1F'
Explanation: An undefined or unsupported control-sequence code was found in the data of a Write Text
command.
Alternate Exception Action: None
Page Continuation Action: Skip to the next IO, IPS, LFE, WGC, WIC, WIC2, WBCC, or EP command.
Support: Mandatory
Note: This corresponds to a PTOCA exception.
0202..01 End Suppression (ESU) control-sequence exception
Explanation: One or more of the following conditions occurred:
The active Begin Suppression (BSU) ID within the current page, page segment, or overlay is not the
same as that specified in the ESU control sequence.
There is no active suppression ID when an ESU control sequence is received.
Page Continuation Action: Ignore the Write Text control sequence.
Support: Mandatory
A29247-X89-X-3-7678
427
IPDS Exceptions
0202..02 Invalid or unsupported IPDS command length
Action Code: X'01'
The length value of a command is less than X'05' (or less than X'07' if a correlation ID is included).
The length of a command is greater than X'05' (or greater than X'07' if a correlation ID is included), but
the length is not valid or is unsupported for the particular command.
The length of the data within a WGC, WIC2, or WBCC command is not equal to the sum of the lengths
of the self-defining fields within it.
Page Continuation Action: None
Support: Mandatory
Note: Some printers report this exception as X'0203..02' or X'80E0..00'. The preferred Exception ID is
X'0203..02' when the IPDS command header length is too small and X'0202..02' for other IPDS
command length exceptions.
0202..05 Invalid self-defining-field length
Explanation: A self-defining field that is less than the minimum allowable length has been received in a
WGC, WIC2, or WBCC command.
Page Continuation Action: Skip to END command.
Support: Mandatory
0203..02 IPDS command header length too small
Action Code: X'01'
Explanation: The length value of a command is less than X'05' (or less than X'07' if a correlation ID is
included).
428
A29247-X89-X-3-7678
IPDS Exceptions
Support: Optional
Note: Some printers report this exception as X'0202..02' or X'80E0..00'. The preferred Exception ID is
X'0203..02' when the IPDS command header length is too small and X'0202..02' for other IPDS
command length exceptions.
0203..05 Invalid or unsupported object area orientation
Explanation: An object area orientation value specified in a self-defining field of a WGC, WIC2, or
WBCC command is invalid or unsupported.
Support: Mandatory
0204..01 EP command encountered before suppression ended
Explanation: An EP command was encountered before a text suppression ended.
Alternate Exception Action: Terminate suppression as if an End Suppression had been received.
Page Continuation Action: Terminate suppression as if an End Suppression had been received.
Support: Mandatory
0204..02 Invalid use of Acknowledgment-Continuation Bit
The Acknowledgment-Continuation bit in the flag byte of a command was on when the printer had no
continuation data available.
A29247-X89-X-3-7678
429
IPDS Exceptions
The Acknowledgment-Continuation bit in the flag byte of a command was B'1', but the ARQ bit was
B'0'.
Support: Mandatory
0204..05 Invalid or unsupported value for area-position reference system
Explanation: The reference system specified in the area-position self-defining field for a WGC, WIC2,
or WBCC command is invalid or unsupported.
Support: Mandatory
0205..01 Invalid spanning sequence
A WT command is required to complete a partial control sequence, or two-byte code point. A command
other than a WT or an Anystate command was received.
A WI2 command is required to complete a partial IO-image self-defining field. A command other than
WI2 or an Anystate command was received.
A WG command is required to complete a partial graphics Begin Segment Introducer or drawing order.
A command other that a WG or an Anystate command was received.
Page Continuation Action: Skip to END or END PAGE command.
Support: Mandatory
0205..02 Invalid setting of the LPD ordered page flag
430
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The LPD ordered page flag indicated an ordered page, but the page data required a print
mechanism movement not in accordance with the ordered page definition.
Support: Mandatory
Note: Some printers report this exception as X'0214..03'. The preferred exception is X'0205..02'.
0205..05 Invalid or unsupported self-defining-field unit base
Explanation: The measurement units specified in the output-control or the data-descriptor self-defining
field of a WGC, WIC2, or WBCC command is an invalid or unsupported value.
Support: Mandatory
0206..01 Invalid Begin Suppression (BSU)
Explanation: A text BSU control sequence has been encountered in a page, page segment, or overlay
before a previous suppression ended.
Page Continuation Action: Ignore the Write Text control sequence
Support: Mandatory
0206..05 Invalid or unsupported units per unit base
A29247-X89-X-3-7678
431
IPDS Exceptions
The units per unit base value specified in either the output-control or the data-descriptor self-defining
field of a WGC, WIC2, or WBCC command is invalid or unsupported.
The units per unit base specified for the Y coordinate in the data-descriptor self-defining field of a WGC
or WBCC command is not equal to the units per unit base specified for the X coordinate.
Support: Mandatory
Note: Some printers report this exception as X'0860..00'. The preferred exception ID is X'0206..05'.
0207..05 Invalid or unsupported self-defining-field extents
Explanation: The extents (X[g] and Y[g] limits for WGC-GDD) specified in either the output-control or
the data-descriptor self-defining field of a WGC, WIC2, or WBCC command are invalid or unsupported.
Support: Mandatory
0208..05 Invalid or unsupported mapping option
Explanation: A mapping option value specified in the output-control self-defining field of a WGC, WIC2,
or WBCC command is invalid or unsupported.
Support: Mandatory
0209..05 Invalid or unsupported axis offsets
432
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The axis offset values specified in the output-control self-defining field of a WGC, WBCC,
or WIC2 command are invalid or unsupported.
Support: Mandatory
020A..05 Data within an object area might be outside the VPA
A portion of the graphics presentation space window, the image presentation space, or the bar code
presentation space, as mapped to the respective object area, falls outside the VPA.
A portion of the graphics, IO-image, or bar code object area falls outside the VPA.
Alternate Exception Action: Continues processing, but suppress printing outside of the valid printable
area. Note that only complete bar code symbols can be printed; a partial bar code symbol will not be
printed.
Page Continuation Action: Continue processing, but suppress printing outside of the valid printable
area. If a partial bar code symbol is printed, a pattern is printed over the symbol to destroy readability.
Support: Optional
Notes:
1. This exception is used by printers that cannot detect an attempt to print outside the VPA, but can
detect that one of the conditions above apply. Printers that can detect an attempt to print outside the
VPA, report this exception as X'08C1..00' or X'0411..00'. The preferred Exception ID is X'0411..00' for
bar code VPA errors and X'08C1..00' for VPA errors in all other data types.
2. Reporting of this exception is controlled by the Report Page Position Check bit in the XOA
Exception-Handling Control command.
020A..05 Data within an object area might be outside the VPA (asynchronously detected)
Action Code: X'19'
Explanation: This exception was detected after the page passed the Received Page Counter station.
One or more of the following conditions occurred:
A29247-X89-X-3-7678
433
IPDS Exceptions
A portion of the graphics presentation space window, the image presentation space, or the bar code
presentation space, as mapped to the respective object area, falls outside the VPA.
A portion of the graphics, IO-image, or bar code object area falls outside the VPA.
Alternate Exception Action: Continues processing, but suppress printing outside of the valid printable
area. Note that only complete bar code symbols can be printed; a partial bar code symbol will not be
printed.
Page Continuation Action: Continue processing, but suppress printing outside of the valid printable
area. If a partial bar code symbol is printed, a pattern is printed over the symbol to destroy readability.
Support: Optional
Notes:
a. This exception is used by printers that cannot detect an attempt to print outside the VPA, but
can detect that one of the conditions above apply. Printers that can detect an attempt to print
outside the VPA, report this exception as X'08C1..00' or X'0411..00'. The preferred Exception
ID is X'0411..00' for bar code VPA errors and X'08C1..00' for VPA errors in all other data types.
b. Reporting of this exception is controlled by the Report Page Position Check bit in the XOA
020B..05 Invalid or missing self-defining-field identifier
A two-byte self-defining-field identifier in a WGC, WIC2, or WBCC command is invalid or out of
sequence.
A required self-defining-field identifier in a WGC, WBCC, or WIC2 command is missing.
Support: Mandatory
020C..01 Invalid or unsupported font local ID
Explanation: A font local ID in a text Set Coded-Font Local (SCFL) control sequence or in a LPD
command is invalid or unsupported.
434
A29247-X89-X-3-7678
IPDS Exceptions
Support: Refer to Presentation Text Object Content Architecture Reference.
020F..01 Invalid or unsupported Set Text Orientation (STO)
The inline or baseline orientation specified in a text STO control sequence is an invalid or unsupported
value.
The combination of the baseline and inline orientations is invalid or unsupported.
Alternate Exception Action: Use an inline orientation of 0° and a baseline orientation of 90°.
Page Continuation Action: Use an inline orientation of 0° and a baseline orientation of 90°.
Support: Mandatory
0210..01 Invalid or unsupported Set Inline Margin (SIM)
Explanation: The inline margin value specified in a text Set Inline Margin control sequence or in a LPD
Page Continuation Action: Ignore the Write Text control sequence. LPD errors have no PCA.
Support: Mandatory
0211..01 Invalid or unsupported Set Baseline Increment (SBI)
A29247-X89-X-3-7678
435
IPDS Exceptions
Explanation: The baseline increment value specified in a text Set Baseline Increment control sequence
or in a LPD command is invalid or unsupported.
Support: Mandatory
0212..01 Invalid or unsupported intercharacter adjustment
Explanation: The intercharacter adjustment value specified in a text Set Intercharacter Adjustment
control sequence or in a LPD command is invalid or unsupported.
Alternate Exception Action: If the intercharacter adjustment value is invalid, none. If the intercharacter
adjustment value is valid but not supported, the printer uses the next smallest supported value. If the
direction value is invalid or not supported, the printer uses X'00' (increment).
Support: Mandatory
0212..02 Font storage is full
Action Code: X'0C'
Either pattern storage or auxiliary storage is insufficient to store the font transmitted with a LF
command.
Insufficient storage exists to load the data transmitted with a LSS command.
Insufficient storage exists to activate the font specified in a LFE command.
Support: Optional
Note: Some printers report this exception as X'023A..02' or X'02AF..01'. The preferred exception ID is
X'02AF..01'.
436
A29247-X89-X-3-7678
IPDS Exceptions
0213..01 Invalid or unsupported Absolute Move Baseline (AMB)
Explanation: The position value specified in a text Absolute Move Baseline control sequence is invalid
or unsupported.
Support: Mandatory
0214..01 Invalid or unsupported Absolute Move Inline (AMI)
Explanation: The position value specified in a text Absolute Move Inline control sequence is invalid or
unsupported.
Support: Mandatory
0214..02 The font resource to be deactivated was not found
Action Code: X'01'
Explanation: The coded font, double-byte coded-font section, font index, code page, or font character
set specified by a DF command has not been previously activated via a LFC, LSS, LFI, LFCSC, LCPC,
LFE, or AR command.
Support: Mandatory
0214..03 Unsupported baseline move
A29247-X89-X-3-7678
437
IPDS Exceptions
Explanation: Unsupported advancement of the baseline coordinate toward the I-axis.
Notes:
a. Some printers report this exception as X'0205..02'. The preferred exception is X'0205..02'.
b. This corresponds to a PTOCA exception.
0215..01 Invalid or unsupported Relative Move Inline (RMI)
Explanation: The displacement value specified in a text Relative Move Inline control sequence is invalid
or unsupported.
Notes:
1. Some printers report this exception as X'0860..00'. The preferred exception ID is X'0860..00'.
2. This corresponds to a PTOCA exception.
0215..02 Invalid or unsupported DF command font or font-section ID
Action Code: X'01'
The font Host-Assigned ID field is required in the DF command; however, it is not present or has an
invalid or unsupported value.
The double-byte coded font-section-ID field is required in the DF command; however, it is not present
or has an invalid or unsupported value.
The font-inline-sequence field is required; but is not present in the DF command.
438
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0216..01 Invalid or unsupported Relative Move Baseline (RMB)
Explanation: The displacement value specified in a text Relative Move Baseline control sequence is
invalid or unsupported.
Notes:
a. Some printers report this exception as X'0860..00'. The preferred exception ID is X'0860..00'.
0217..01 Invalid or unsupported Set Variable-Space Character Increment (SVI)
Explanation: The increment value specified in a text Set Variable-Space Character Increment control
sequence is invalid or unsupported.
Alternate Exception Action: If invalid, none. If unsupported, the printer uses the next-smallest
supported value.
Support: Mandatory
0217..02 Invalid or unsupported value for DF command deactivation type
Action Code: X'01'
A29247-X89-X-3-7678
439
IPDS Exceptions
The deactivation type in a DF command is invalid or unsupported.
The font Host-Assigned ID value identifies a double-byte coded font, but the font-deactivation type
specifies a single-byte coded font.
The font Host-Assigned ID value identifies a single-byte coded font, but the font-deactivation type
specifies a double-byte coded font.
Support: Mandatory
0218..02 Invalid, unsupported, or unavailable font ID
The font Host-Assigned ID in a LSS, LFC, LFI, or LFE command is invalid or unsupported.
The font Host-Assigned ID in a LFI command does not match that of any previously received LFC.
The font local ID in a LFE command is invalid or unsupported.
A font is referenced in a Set Coded-Font Local (SCFL) control sequence or in a LPD, a LSS, or a
WBCC command, but the font has not been previously identified by the LFE command.
The font referenced in a LPD, a WT, or a WBCC command is defined within the current LFE command
but is not activated.
Alternate Exception Action: If the exception occurs because a font defined within the current LFE
command is not activated in the printer when needed, the printer can try to make an appropriate font
substitution that preserves as many characteristics as possible of the originally requested font while still
preserving the original code page. If an appropriate font substitution cannot be made or if the exception
occurs for any other reason, there is no AEA.
Page Continuation Action: If the exception occurs because a coded font defined within the current LFE
command is not activated in the printer when needed or because the local ID is not present in the
current LFE command, the printer can substitute a printer default coded font if one exists. If the desired
coded font was double-byte and the printer default coded font is single byte, the data will not print
correctly. If a font substitution is not made or if the exception occurs for any other reason, there is no
PCA.
Support: Mandatory
Notes:
440
A29247-X89-X-3-7678
IPDS Exceptions
1. Some printers report this exception as X'0404..00' when a font to be used with bar code data is
unavailable. The preferred exception in this case is X'0404..00'.
2. This corresponds to a PTOCA exception.
0219..01 Invalid or unsupported value for Repeat String (RPS) repeat length
Explanation: A text Repeat String control sequence target count is invalid or unsupported.
Support: Mandatory
0219..02 Multiple occurrences of the same LFE font local ID
Explanation: The font local ID in a LFE command has been used more than once, making the font
Host-Assigned ID ambiguous.
Support: Mandatory
021A..01 Repeat String (RPS) or Transparent Data (TRN) exception
Explanation: The source-string length for a text TRN or RPS control sequence must be an even
number for double-byte coded fonts.
Support: Mandatory
A29247-X89-X-3-7678
441
IPDS Exceptions
021B..01 Repeat String (RPS) target-string length exception
Explanation: The target-string length for a text Repeat String control sequence must be an even
number for double-byte coded fonts.
Support: Mandatory
021B..02 Invalid or unsupported unit base for L-units value in Load Font Control
Action Code: X'01'
Explanation: The unit base for L-units value in a LFC command is invalid or unsupported.
Support: Mandatory
021C..01 Invalid escape sequence
Explanation: In a WT command, the second byte of what should be an escape sequence (X'2BD3') is
not X'D3'.
Support: Mandatory
021C..02 Invalid LFC command byte-count value
442
A29247-X89-X-3-7678
IPDS Exceptions
Action Code: X'01'
Explanation: An invalid value was specified in the byte-count field (bytes 18-20) of a Load Font Control
command.
Support: Optional
021D..02 Invalid or unsupported value for the Load Font Equivalence GRID
Explanation: One or more of the parameters in the GRID field (bytes 5-12) of the LFE command are
invalid, unsupported, or inconsistent.
Support: Optional
021E..01 Invalid text control-sequence length
Explanation: The length of a text control sequence in a Write Text command is invalid.
Support: Mandatory
021E..02 Mismatch between coded font and the XOA Print Quality Control (PQC) command
Action Code: X'01'
A29247-X89-X-3-7678
443
IPDS Exceptions
The combination of parameters specified in the LFE command are unsupported when used with the
quality level indicated by the XOA PQC command.
The FGID value specified in the LFE command is invalid or unsupported or is invalid with the other font
parameters.
Alternate Exception Action: Use the "best fit" font that is available in the requested quality. This means
that a font with at minimum, the requested code page and a quality level as close to the requested
quality level as possible is used. In addition, the printer should preserve as many other of the
requested font characteristics as possible.
Page Continuation Action: Use the "best fit" font that is available in the requested quality. This means
that a font is used that has at least the requested code page and the closest quality level to the one
requested. In addition, the printer should preserve as many other of the requested font characteristics
as possible.
Support: Mandatory
021F..01 Repeat String (RPS) length exception
Explanation: A text Repeat String control sequence in a WT command has a nonzero fill count, but a
zero string length.
Support: Mandatory
021F..02 LFE command font Host-Assigned ID already assigned
Explanation: The HAID in a LFE command has already been assigned to a GRID that differs from the
GRID in the current LFE command.
Support: Mandatory
444
A29247-X89-X-3-7678
IPDS Exceptions
0220..01 Double-byte MICR font section mismatch
Action Code: X'01'
Explanation: MICR printing was specified for one section of a double-byte coded font, but not for all
sections of that coded font. If the intended-use flags for one section of a double-byte coded font specify
MICR printing, all sections of that coded font must specify MICR printing.
Support: Mandatory
0220..02 Invalid LFC reserved byte
Action Code: X'01'
Explanation: The value of reserved byte 36 in a Load Font Control command is not X'01'.
Support: Mandatory
0221..02 Invalid or unsupported value for Load Font Control font-index format
Action Code: X'01'
Explanation: The font-control record and font-index table-format value (byte 3) in a LFC command is
Support: Optional
0222..02 Invalid or unsupported Load Font Control data pattern format
Action Code: X'01'
A29247-X89-X-3-7678
445
IPDS Exceptions
Explanation: The pattern-data format value (byte 4) specified in a LFC command is invalid or
unsupported.
Support: Mandatory
0223..02 Invalid or unsupported value for Load Font Control font-type bits
Action Code: X'01'
Explanation: The font-type bits in a LFC command are invalid or unsupported.
Support: Mandatory
0226..02 Invalid or unsupported LSS or LFC X-box size
Action Code: X'01'
The character X-box size (specified in byte 6 in a LSS command, in bytes 6 and 7 in a LFC command,
or in bytes 0 and 1 of a character-pattern descriptor in a LFC command) is invalid or unsupported, or is
incompatible with the specified font.
The character X-box size (specified in bytes 6 and 7 in a LFC command, or in bytes 0 and 1 of a
character-pattern descriptor in a LFC command) is greater than the maximum X-box size.
Support: Mandatory
0227..02 Invalid or unsupported LSS or LFC Y-box size
Action Code: X'01'
446
A29247-X89-X-3-7678
IPDS Exceptions
The character Y-box size (specified in byte 7 in a LSS command, in bytes 8 and 9 in a LFC command,
or in bytes 2 and 3 of a character-pattern descriptor in a LFC command) is invalid or unsupported, or is
incompatible with the specified font.
The character Y-box size (specified in bytes 8 and 9 in a LFC command, or in bytes 2 and 3 of a
character-pattern descriptor in a LFC command) is greater than the maximum Y-box size.
Support: Mandatory
0228..02 The LSS pattern download format is either reserved or unsupported
Action Code: X'01'
Explanation: The specified pattern download format in a LSS command is either reserved or
unsupported.
Support: Mandatory
0229..02 Invalid or unsupported value for LSS additional parameter byte length
Action Code: X'01'
Explanation: The additional parameter byte length specified in a LSS command is outside the range
X'0D' through X'FF' or is unsupported.
Support: Mandatory
022A..02 Invalid or unsupported value for Load Font Control units per unit base in the X
direction
Action Code: X'01'
A29247-X89-X-3-7678
447
IPDS Exceptions
Explanation: The units per unit base for L-units in the X direction value in a LFC command is invalid or
unsupported.
Support: Mandatory
022B..02 Invalid or unsupported value for Load Font Control units per unit base in the Y
direction
Action Code: X'01'
Explanation: The units per unit base for L-units in the Y direction value in a LFC command is invalid or
unsupported.
Support: Mandatory
022D..02 Invalid or unsupported value for Load Font Control pattern-data alignment
Action Code: X'01'
Explanation: The pattern-data alignment value in a LFC command is invalid or unsupported.
Support: Mandatory
022E..02 Insufficient font data received
Action Code: X'01'
Explanation: The font data received is less than that specified in the byte-count field in a LFC or
LFCSC command.
448
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0231..01 Invalid or unsupported value for Load Copy Control number of copies
Action Code: X'01'
Explanation: The number of copies specified in a LCC command is invalid or unsupported.
Alternate Exception Action: Proceed as though the number-of-copies field was set to 1.
Support: Mandatory
0232..01 Invalid or unsupported Load Copy Control Keyword in copy-subgroup entry
Action Code: X'01'
A LCC command keyword control ID is invalid or unsupported.
A LCC command suppression keyword is invalid or unsupported.
A LCC command overlay keyword is invalid or unsupported.
Support: Mandatory
Note: Some printers report X'0232..01' when a LCC command simplex/duplex keyword is invalid or
unsupported. The preferred Exception ID in this case is X'0236..01'.
0232..02 Excess font data received
Action Code: X'01'
Explanation: The font data received exceeds that specified in the byte-count field in a LFC or LFCSC
command.
A29247-X89-X-3-7678
449
IPDS Exceptions
Support: Mandatory
0233..02 Invalid or unsupported value for Load Font Index maximum baseline extent
Action Code: X'01'
Explanation: A maximum baseline extent value in a LFI command is invalid or unsupported.
Support: Optional
Note: Some printers report this exception as X'023C..02'. The preferred exception ID is X'023C..02'.
0234..01 Invalid or unsupported value for Load Copy Control entry-byte count
Action Code: X'01'
The number of bytes in the LCC command copy subgroup is not a multiple of two-byte pairs or is
The number of bytes in the LCC command copy subgroup causes the copy subgroup to extend beyond
the total length of the LCC command.
Support: Mandatory
Note: If a printer limits the number of overlay keywords in a copy subgroup and this number is
exceeded, exception ID X'0238..01' exists. If a printer limits the number of suppression keywords in a
copy subgroup and this number is exceeded, exception ID X'0239..01' exists.
0236..01 Invalid or unsupported Load Copy Control simplex/duplex parameter
Action Code: X'01'
Explanation: The LCC command simplex/duplex parameter is invalid or unsupported.
Alternate Exception Action: If invalid, none. If unsupported, the printer prints simplex.
450
A29247-X89-X-3-7678
IPDS Exceptions
An even number of copy subgroups must be specified for a duplex operation. When the AEA causes
the printer to substitute simplex printing for duplex printing, each input page is processed against both
the frontside page specification and the backside page specification. This yields twice as many sheets
for each input page as would be printed if the printer could print duplex.
Support: Mandatory
Note: Some printers report this exception as X'0232..01' when a LCC command simplex/duplex
keyword is invalid or unsupported. The preferred exception ID in this case is X'0236..01'.
0237..01 Invalid or unsupported Load Copy Control N-up parameter
Action Code: X'01'
Explanation: An N-up modification keyword parameter in a Load Copy Control command is invalid or
unsupported.
Alternate Exception Action: Print as if 1-up had been specified.
Support: Mandatory
0237..03 Invalid or unsupported Load Copy Control media-destination parameter
Action Code: X'01'
Explanation: The printer supports selection of a media destination in the Load Copy Control command,
but the value specified is invalid or unsupported.
Alternate Exception Action: Use the printer-default media destination.
Support: Mandatory
0237..04 Incompatible media source and media destination
Action Code: X'09'
A29247-X89-X-3-7678
451
IPDS Exceptions
Explanation: The media source specified in a Load Copy Control command or a XOH-Select Input
Media Source command cannot be used with the media destination specified in a Load Copy Control
command.
Support: Optional
Note: For exception ID X'0237..04', sense data bytes 12-13 contain the command code for a LCC
command, byte 14 is reserved and should contain X'00', byte 15 contains a media-source ID, and
bytes 16-17 contain the media-destination ID that is incompatible with the media-source ID.
0237..05 Mixture of media-source IDs or media-destination IDs in a duplex copy-subgroup pair
Action Code: X'01'
In a Load Copy Control command, duplex was specified, but the media-source ID specified in the first
LCC entry of a copy-subgroup pair does not match the media-source ID specified in the second LCC
entry.
In a Load Copy Control command, duplex was specified, but the media-destination ID specified in the
first LCC entry of a copy-subgroup pair does not match the media-destination ID specified in the
second LCC entry.
Support: Mandatory
0238..01 Maximum supported number of overlays per LCC copy subgroup exceeded
Action Code: X'01'
Explanation: The number of overlays specified for inclusion in a LCC command copy subgroup
exceeds the maximum number supported.
Support: Mandatory
452
A29247-X89-X-3-7678
IPDS Exceptions
0239..01 Maximum supported number of suppressions per LCC copy subgroup exceeded
Action Code: X'01'
Explanation: The number of suppressions specified for inclusion in a LCC command copy subgroup
exceeds the maximum number supported.
Support: Mandatory
0239..02 LFC font Host-Assigned Resource ID already assigned
Action Code: X'01'
Explanation: One or more of the following conditions occurred in a Load Font Control command:
The single-byte fully described font HAID specified in the LFC command has already been used in a
previously received AR, LFE, or LFC command to activate a coded font.
The section ID specified in the LFC command for this HAID has already been used in a previously
received AR, LFE, or LFC command to activate a coded font.
Support: Mandatory
023A..02 Maximum number of activated font components exceeded
Action Code: X'01'
Explanation: An attempt was made to activate more coded-font components than the printer can
support. Some printers limit the number of resident and downloaded coded-font components that can
be activated at a time. This exception can be detected while processing an AR, LFE, LCPC, LFCSC,
LFC, or LSS command.
Support: Optional
A29247-X89-X-3-7678
453
IPDS Exceptions
Note: Some printers report this exception as X'0212..02' or X'02AF..01'. In the case where font storage
has been exceeded, the preferred exception ID is X'02AF..01'.
023B..01 IPDS command sequence interrupted
Action Code: X'01'
Explanation: A sequence of IPDS spanning commands, such as WT, WI, WI2, WG, WBC, and LF, that
is normally ended with and END command, and that should only be interrupted by Anystate
commands, was interrupted by a carrying communications protocol function that required the printer to
return data to the host. This is an error at the carrying communications protocol level.
For example, a Read CCW or Sense Extended CCW was issued between LF commands while the
IPDS data was being carried in a System/390 CCW chain.
Support: Optional--023B..02 Invalid LFI command double-byte character flags
Action Code: X'01'
Explanation: A character with a character-flag-bits entry of B'001' (defined, printing, nonincrementing),
B'100' (undefined, printing, incrementing), or B'101' (undefined, printing, nonincrementing) was
received within a font index for sections X'45' through X'FE' of a double-byte coded font.
Support: Mandatory
023C..02 Invalid or unsupported value in a Load Font Index command
Action Code: X'01'
The uniform or maximum baseline offset value in a LFI command is invalid or unsupported.
The uniform or maximum character increment value in a LFI command is invalid or unsupported.
The maximum baseline extent value in a LFI command is invalid or unsupported.
454
A29247-X89-X-3-7678
IPDS Exceptions
The uniform or minimum A-space value in a LFI command is invalid or unsupported.
The variable-space increment value in a LFI command is invalid or unsupported.
A pattern-index value in a LFI command refers to a nonexistent pattern.
A character-increment value in a LFI command is invalid or unsupported.
An A-space value in a LFI command is invalid or unsupported.
A baseline-offset value in a LFI command is invalid or unsupported.
A parameter value specified for an individual character is greater than or less than the respective
maximum or minimum value specified for that parameter.
The combination of baseline offset and pattern size for a character is incompatible with the baselineextent value specified.
The underscore width value in a LFI command is invalid.
Support: Mandatory
Notes:
a. Some printers generate exception X'0233..02' for an invalid or unsupported maximum baseline
extent. The preferred exception ID in this case is X'023C..02'.
b. Some printers do not issue this exception ID when the maximum baseline extent value is less
than the maximum baseline offset value because many double-byte LF1-type font objects were
built containing this error, and the printer can properly present the data while ignoring the
incorrect maximum baseline extent value.
023E..02 Invalid LFC character-pattern address
Action Code: X'01'
The character-pattern addresses in the Character Pattern-Descriptor List of a LFC command are not
ascending.
A character-pattern address in the Character Pattern-Descriptor List of a LFC command points past the
end of the raster data.
A character-pattern address in the Character Pattern-Descriptor List of a LFC command points into a
previously defined character pattern.
A29247-X89-X-3-7678
455
IPDS Exceptions
Support: Mandatory
023F..02 STO-SCFL-LFE mismatch
A fully described font or font index required as a result of combining a Set Coded-Font Local (SCFL)
control sequence or a LPD command with a Set Text Orientation (STO) control sequence and a LFE
command does not exist within the printer when needed.
The printer does not support the requested combination of Set Text Orientation and Font Inline
Sequence for the requested symbol set coded font.
The font-inline-sequence field of a LFE command is invalid, unsupported, or is unsupported within the
current text orientation.
Support: Mandatory
Notes:
a. Some printers report X'023F..02' when an invalid or unsupported font-inline-sequence value is
specified in a LFE command. The preferred exception ID for this situation is X'0247..02'.
0240..02 Invalid or unsupported value for font inline sequence
Action Code: X'01'
Explanation: A font-inline sequence specified in a LFI or DF command is invalid or unsupported.
Support: Mandatory
456
A29247-X89-X-3-7678
IPDS Exceptions
0242..01 WIC command pel count is less than the minimum required
Explanation: The pels-per-scan-line value in a Write Image Control command for either the input or
output image is less than X'0001'.
Support: Mandatory
0243..01 WIC command pel count is greater than the maximum supported value
Explanation: The pels-per-scan-line value in a Write Image Control command for either the input or
output image is greater than the valid or supported maximum.
Support: Mandatory
0243..02 Invalid double-byte coded font section identifier
Action Code: X'01'
The section-identifier value in a LFC or LFI command is nonzero for a single-byte coded font.
The section-identifier value in a LFC or LFI command is not in the range X'41' through X'FE' for a
double-byte coded font.
The section-identifier value in a LFI command does not match that of any previously received LFC
command for that font.
Support: Mandatory
A29247-X89-X-3-7678
457
IPDS Exceptions
0244..01 WIC command scan-line count is less than the minimum required
Explanation: The number-of-scan-lines value in a Write Image Control command for either the input or
the output image is less than X'0001'.
Support: Mandatory
0244..02 Nonmatching double-byte coded font sections
Action Code: X'01'
Explanation: LFC and LFI command fields are not the same for all sections as required by the printer.
Support: Mandatory
0245..01 WIC command scan-line count is greater than the maximum supported value
Explanation: The number-of-scan-lines value in a Write Image Control command for either the input or
the output image is greater than the valid or supported maximum.
Support: Mandatory
0246..01 Invalid WIC input image format
458
A29247-X89-X-3-7678
IPDS Exceptions
Byte 8 of a WIC command is not X'00'.
The image-format value (byte 9) of a WIC command is not X'00'.
Support: Mandatory
0246..02 Invalid parameter in a LFI command
Action Code: X'01'
A short-form LFI was loaded when a long-form LFI was expected.
A long-form LFI was loaded when a short-form LFI was expected.
The font-inline sequence (bytes 4 and 5) matches that of a currently loaded font index for the fully
described font or section.
Support: Mandatory
0247..01 Invalid or unsupported value for Write Image Control magnification factor
The pel-magnification factor in a WIC command is invalid or unsupported.
The scan-line magnification factor in a WIC command does not equal the pel-magnification factor.
Support: Mandatory
0247..02 Invalid or unsupported value for Load Font Equivalence font-inline sequence
A29247-X89-X-3-7678
459
IPDS Exceptions
Explanation: The font-inline-sequence parameter in a LFE command is invalid or unsupported.
Page Continuation Action: LFE when not in home state: ignore remainder of command; entries
received prior to error take effect.
Support: Mandatory
Note: Some printers report X'023F..02' when an invalid or unsupported font-inline-sequence value is
specified in a LFE command. The preferred exception ID for this situation is X'0247..02'.
0248..01 Invalid or unsupported value for Write Image Control scan-line direction
Explanation: The scan-line-direction parameter (bytes 12-13) in a Write Image Control command is
Support: Mandatory
0248..02 Invalid or unsupported value for Load Symbol Set section identifier
Action Code: X'01'
Explanation: The section ID value specified in the LSS command is invalid or unsupported.
Support: Mandatory
0249..01 Invalid scan-line-sequence direction in a WIC command
Explanation: The scan-line sequence-direction value (bytes 14-15) specified in a Write Image Control
command is not +90° from the scan-line-direction value.
460
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0249..02 Invalid or unsupported value for Load Symbol Set starting code point
Action Code: X'01'
Explanation: The starting code point in the LSS command is invalid or unsupported.
Support: Mandatory
024A..01 Invalid or unsupported value for Write Image Control output image location
The reference coordinate system (byte 16) in a WIC command is invalid or unsupported.
The first pel location X[p] or I value (bytes 17-19) in a WIC command is invalid or unsupported.
The first pel location Y[p] or B value (bytes 21-23) in a WIC command is invalid or unsupported.
Support: Mandatory
024A..02 Invalid or unsupported value for Load Symbol Set ending code point
Action Code: X'01'
Explanation: The ending code point specified in the LSS command is invalid or unsupported.
Support: Mandatory
A29247-X89-X-3-7678
461
IPDS Exceptions
024B..02 Invalid or unsupported bit value for Load Symbol Set flag bytes
Action Code: X'01'
Explanation: One or more of the bits in the two flag bytes of the LSS command are invalid or
unsupported.
Support: Mandatory
024C..02 Invalid or unsupported value for Load Symbol Set data length
Action Code: X'01'
The length of the LSS additional parameter byte does not correlate with the length of the LSS data.
The LSS self-identifying field length is an invalid or unsupported value, or it does not correlate with the
LSS data length.
The amount of raster data in the LSS command does not correspond with the number of code points,
the box size, and the pattern-download format.
Support: Mandatory
024D..02 Insufficient storage for font-control and font-index records
Action Code: X'0C'
Explanation: Insufficient storage to load the data transmitted with the LFI and LFC commands.
Support: Optional
Note: Some printers report this exception as X'02AF..01'. The preferred exception ID is X'02AF..01'.
462
A29247-X89-X-3-7678
IPDS Exceptions
0253..01 Invalid or unsupported value for Write Image Control image color
Explanation: The image color in a WIC command is invalid or unsupported.
Alternate Exception Action: Use the printer default color.
Page Continuation Action: Set Image color to printer default.
Support: Mandatory
0258..03 Invalid or unsupported value for text color
The color field in the Set Text Color (STC) control sequence is invalid or is unsupported.
The text-color field in a LPD command is invalid or unsupported.
The precision field in the Set Text Color (STC) control sequence is invalid or is unsupported.
Page Continuation Action: Use the printer default color.
Support: Mandatory
025B..01 Invalid type value in a MID command
Action Code: X'01'
Explanation: The type parameter in a Manage IPDS Dialog command contained an invalid value.
Support: Mandatory
025C..02 Invalid or unsupported parameter in a DUA command
A29247-X89-X-3-7678
463
IPDS Exceptions
Action Code: X'01'
The Reset parameter or the X[m] or Y[m] extent of the UPA parameter is invalid.
The Unit Base parameter, the Units per Unit Base parameter, or the X[m] or Y[m] coordinate of the
UPA Origin parameter is invalid or unsupported.
Support: Mandatory
0260..02 Invalid or unsupported value for Logical Page Descriptor units per unit base (X[p] and
I)
Action Code: X'01'
Explanation: In a LPD command, the units-per-unit base value (X[p] or I direction) is invalid or
unsupported.
Support: Mandatory
0261..02 Invalid or unsupported value for Logical Page Descriptor units per unit base (Y[p] and
B)
Action Code: X'01'
Explanation: In a LPD command, the units-per-unit base value (Y[p] or B direction) does not match the
value in the X direction.
Support: Mandatory
464
A29247-X89-X-3-7678
IPDS Exceptions
0262..02 Invalid or unsupported value for LPD X[p] extent or XOH-SMS X[m] extent
Action Code: X'01'
The X[p] extent in a Logical Page Descriptor command is invalid or unsupported.
The X[m] extent in a XOH-Set Media Size command is invalid or unsupported.
Support: Mandatory
Note: X'0272..02' is used by some printers for this exception in a XOH-SMS command. The preferred
Exception ID in this case is X'0272..02'.
0263..01 Insufficient pattern storage
Action Code: X'0C'
Explanation: There was insufficient pattern storage to hold the data transmitted with a WI, WI2, or WG
command.
Support: Optional
0263..02 Invalid or unsupported value for LPD Y[p] extent or XOH-SMS Y[m] extent
Action Code: X'01'
The Y[p] extent in a Logical Page Descriptor command is invalid or unsupported.
The Y[m] extent in a XOH Set Media Size command is invalid or unsupported.
A29247-X89-X-3-7678
465
IPDS Exceptions
Support: Mandatory
Note: X'0273..02' is used by some printers for this exception in a XOH-SMS command. The preferred
Exception ID in this case is X'0273..02'.
0264..01 Insufficient control storage
Action Code: X'0C'
Explanation: Insufficient control storage to hold the data transmitted with a WI, WI2, WG, or WGC
command.
Support: Optional
0264..02 Invalid or unsupported value for Logical Page Descriptor unit base
Action Code: X'01'
Explanation: The unit-base field in a LPD command is invalid or unsupported.
Support: Mandatory
0268..02 Invalid or unsupported value for Logical Page Descriptor inline-sequence direction
Action Code: X'01'
Explanation: The inline-sequence-direction value in a LPD command is invalid or unsupported.
Alternate Exception Action: An inline-sequence direction of 0° (X'0000') and a baseline-sequence
direction of 90° (X'2D00') are used.
466
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0269..02 Invalid baseline-sequence direction in the LPD command
Action Code: X'01'
Explanation: The baseline-sequence-direction value in a LPD command is not valid when taken in
combination with the inline-sequence-direction value.
Alternate Exception Action: An inline-sequence direction of 0° (X'0000') and a baseline-sequence
direction of 90° (X'2D00') are used.
Support: Mandatory
026A..01 Insufficient input image data
Explanation: The number of input image bytes received is less than the number implied in a WIC
command.
Page Continuation Action: Continue processing; print all of the image that was received; bit fill the rest
with zeros.
Support: Mandatory
026A..02 Invalid or unsupported value for Logical Page Descriptor initial I print coordinate
Action Code: X'01'
Explanation: The initial inline-coordinate value in a LPD command is invalid or unsupported.
Support: Mandatory
A29247-X89-X-3-7678
467
IPDS Exceptions
026B..01 Excess input image data received
Explanation: The number of input image bytes received is greater than the number implied in a WIC
command.
Support: Mandatory
026B..02 Invalid or unsupported value for Logical Page Descriptor initial B print coordinate
Action Code: X'01'
Explanation: The initial baseline-coordinate value in a LPD command is invalid or unsupported.
Support: Mandatory
026E..01 Invalid or unsupported value in a XOH-SMM command
Action Code: X'01'
An entry length value specified in a XOH-SMM command is invalid or unsupported.
An entry type value specified in a XOH-SMM command is invalid.
A medium modification ID value specified in a XOH-SMM command is invalid or unsupported.
Support: Mandatory
468
A29247-X89-X-3-7678
IPDS Exceptions
026F..02 Invalid media-origin parameter specified in a XOH-SMO command
Action Code: X'01'
Explanation: The media-origin parameter specified in a XOH-SMO command is invalid.
Support: Mandatory
0270..02 Invalid or unsupported value for XOH Set Media Size units per unit base
Action Code: X'01'
Explanation: The units-per-unit-base value in a XOH SMS command is invalid or unsupported.
Support: Mandatory
0272..02 Invalid or unsupported value for XOH Set Media Size X[m] extent
Action Code: X'01'
Explanation: In a XOH-SMS command, the X[m] extent is invalid or unsupported.
Support: Mandatory
Note: X'0262..02' is used by some printers for this exception. The preferred Exception ID is X'0272..02'.
0273..02 Invalid or unsupported value for XOH Set Media Size Y[m] extent
Action Code: X'01'
Explanation: In a XOH-SMS command, the Y[m] extent is invalid or unsupported.
A29247-X89-X-3-7678
469
IPDS Exceptions
Support: Mandatory
Note: X'0263..02' is used by some printers for this exception. The preferred Exception ID is X'0273..02'.
0274..02 Invalid or unsupported value for XOH Set Media Size unit base
Action Code: X'01'
Explanation: In a XOH-SMS command, the unit-base value is invalid or unsupported.
Support: Mandatory
0277..01 Group termination exception
Action Code: X'01'
Explanation: A XOH-DGB command was received that attempts to terminate a group that is not yet
initiated.
Support: Mandatory
0278..01 Invalid or unsupported order type
Action Code: X'01'
Explanation: The order type (byte 2) specified in a XOH-DGB command is invalid or unsupported.
Support: Mandatory
027A..01 Invalid XOH-DGB triplet length value
470
A29247-X89-X-3-7678
IPDS Exceptions
Action Code: X'01'
Explanation: The length specified in a XOH-DGB triplet is less than X'02'.
Support: Mandatory
027B..01 Incorrect number of XOH-DGB triplet data bytes
Action Code: X'01'
Explanation: The number of data bytes specified in a XOH-DGB triplet length field is greater than the
number of bytes remaining in the command.
Support: Mandatory
0280..02 Invalid or unsupported rule width
Explanation: The rule width for a text Draw I-Axis Rule (DIR) or Draw B-Axis Rule (DBR) control
sequence is an invalid or unsupported value.
Alternate Exception Action: Use the closest supported nonzero rule-width value.
Page Continuation Action: Use the closest supported nonzero rule-width value.
0281..01 Insufficient storage for a page segment or overlay
Action Code: X'0C'
Explanation: The existing page buffer space is insufficient to process a page segment or an overlay.
A29247-X89-X-3-7678
471
IPDS Exceptions
Support: Optional
0282..02 Invalid or unsupported rule length
Explanation: The rule length for a text Draw Inline Rule (DIR) or Draw Baseline Rule (DBR) control
sequence is invalid or unsupported.
Alternate Exception Action: Use the closest supported nonzero rule-length value.
Page Continuation Action: Use the closest supported nonzero rule-length value.
0285..01 Invalid or unsupported value for Deactivate Overlay command overlay ID
Action Code: X'01'
Explanation: The overlay identifier in a DO command is invalid or unsupported.
Support: Mandatory
0287..02 Invalid or unsupported value for Load Font Control unit base for Pel-units
Action Code: X'01'
Explanation: The unit base for Pel-units value in a LFC command is invalid or unsupported.
Support: Mandatory
472
A29247-X89-X-3-7678
IPDS Exceptions
0288..02 Invalid or unsupported value for Load Font Control Pel-units per unit base in the X
direction
Action Code: X'01'
Explanation: The Pel-units per unit base in the X-direction value in a LFC command is invalid or
unsupported.
Support: Mandatory
0289..02 Invalid or unsupported value for Load Font Control Pel-units per unit base in the Y
direction
Action Code: X'01'
Explanation: The Pel-units per unit base in the Y-direction value in a LFC command is invalid or
unsupported.
Support: Mandatory
028A..01 Invalid or unsupported value for Deactivate Page Segment command page segment
Host-Assigned ID
Action Code: X'01'
Explanation: The page segment Host-Assigned ID in a DPS command is invalid or unsupported.
Support: Mandatory
028A..02 Invalid or unsupported value for Load Font Control Relative-Metric Multiplying Factor
A29247-X89-X-3-7678
473
IPDS Exceptions
Action Code: X'01'
Explanation: The Relative-Metric Multiplying Factor value in a LFC command is invalid or unsupported.
Support: Mandatory
028F..01 Invalid or unsupported AR command parameter value
Action Code: X'01'
•
The length of an AR entry is invalid or unsupported.
•
The Host-Assigned ID in an AR entry is invalid.
•
The section ID in an AR entry is invalid.
•
The font inline sequence in an AR entry is invalid.
•
The resource type in an AR entry is invalid.
•
The resource ID format in an AR entry is invalid.
•
The resource type in an AR entry is not valid with or is unsupported with the resource ID format
specified.
•
The resource ID in an AR entry is invalid.
Support: Optional
0290..01 Invalid or unsupported overlay ID
Explanation: The overlay identifier in a BO, an IO, or a LCC command is invalid or unsupported.
Page Continuation Action: IO--ignore the command. BO and LCC have no PCA.
474
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0291..01 BO overlay ID already activated
Action Code: X'01'
Explanation: The host attempted to download an overlay whose overlay ID has already been activated.
Support: Mandatory
0291..02 Invalid or unsupported value for XOA Request Resource List entry
Action Code: X'01'
•
The length of a Request Resource List entry is invalid or unsupported.
•
A nonzero value was specified in the entry-continuation indicator field (bytes 3-4), but there
was no XOA-RRL information to return, or there was no previous XOA-RRL command with a
X'0000' in the entry-continuation indicator field.
•
A Request Resource List command has multiple entries and this function is either not
supported for the query type or is supported for the query type but is not supported by the
printer.
•
The query type parameter of a Request Resource List order is invalid or unsupported.
•
The resource type in a Request Resource List entry is invalid.
•
A Request Resource List entry of query type X'05', activation query, has requested a list of
resources.
•
The resource ID format in a Request Resource List entry is invalid.
Page Continuation Action: XOA RRL command when not in home or font state--ignore command.
Support: Optional
0292..01 Overlay not activated
A29247-X89-X-3-7678
475
IPDS Exceptions
•
An overlay identified by the overlay identifier in an IO, a DO, or a LCC command was not
activated or was deactivated prior to its attempted use.
•
The overlay identified by the overlay identifier was used on the first side of a duplex sheet and
is being deactivated before the pages for the second side of the duplex sheet have been
received. The overlay has been deactivated.
Page Continuation Action: Ignore IO command. DO and LCC have no PCA.
Support: Mandatory
0292..02 Invalid XOA Print-Quality Control (PQC) parameter
Action Code: X'01'
Explanation: In a XOA-PQC command, the quality-level value was X'00', which is an invalid value.
Support: Mandatory
0293..01 Recursive overlay invocation
Explanation: A recursive nesting loop has occurred with an IO command (for example, an overlay has
included itself).
Page Continuation Action: None ignore the command.
Support: Mandatory
0294..01 Invalid or unsupported value for page segment Host-Assigned ID
476
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The page segment Host-Assigned ID in a BPS or an IPS command is invalid or
unsupported.
Page Continuation Action: IPS--ignore the command. BPS has no PCA.
Support: Mandatory
0295..01 Page segment Host-Assigned ID already activated
Action Code: X'01'
Explanation: The host has attempted to download a page segment whose HAID has already been
activated.
Support: Mandatory
0295..02 Invalid or unsupported value for XOH-Page Counters Control command page-counter
update
Action Code: X'01'
Explanation: The value specified in the page-counter-update field of a XOH-Page Counters Control
Support: Mandatory
0296..01 Page segment not activated
A29247-X89-X-3-7678
477
IPDS Exceptions
The page segment identified by the page segment Host-Assigned ID in an IPS or DPS command has
not been activated or was deactivated before its attempted use.
The page segment identified by the page segment Host-Assigned ID was used on the first side of a
duplex sheet and is being deactivated before the pages for the second side of the duplex sheet have
been received. The page segment has been deactivated.
Page Continuation Action: IPS--ignore the command. DPS has no PCA.
Support: Mandatory
0297..01 Overlay nesting limit exceeded
•
While processing an overlay the printer was unable to include a nested overlay because the
nesting limit of the printer was exceeded.
•
While processing an overlay, the printer was unable to include a page segment because the
nesting limit of the printer was exceeded.
Page Continuation Action: Ignore the Include command.
Support: Mandatory
0298..01 Invalid or unsupported suppression number
•
The suppression number in a LCC command is invalid or unsupported.
•
The Begin Suppression (BSU) number in a WT command is invalid or unsupported.
Page Continuation Action: WT--ignore the control sequence. LCC has no PCA.
Support: Mandatory
478
A29247-X89-X-3-7678
IPDS Exceptions
0298..03 Invalid or unsupported value for Temporary Baseline Move control sequence
The TBM increment, move direction, or precision value is invalid or unsupported.
•
Unsupported multiple-offset TBM.
•
Unsupported substitution character in the TBM field.
•
Unable to support TBM by printing full-size characters.
Alternate Exception Action: For the exception described by the last bullet, print device-defined
characters to simulate the function. For the other exceptions, there is no AEA.
Page Continuation Action: Ignore the control sequence.
Support: Mandatory
0299..02 Invalid Edge Mark Parameter
Action Code: X'01'
Explanation: An invalid edge-mark value (byte 2) was specified in a XOA-Control Edge Marks
command.
Support: Mandatory
029A..01 Invalid overstrike character increment
Explanation: One or more of the following conditions occurred in a text Overstrike control sequence
within a Write Text command:
•
The character increment of the selected overstrike character is less than or equal to zero.
A29247-X89-X-3-7678
479
IPDS Exceptions
•
The character increment of the selected overstrike character is less than the character-box X
size.
•
The overstrike character is not a printable character.
Page Continuation Action: Ignore the OVS control sequence in the Write Text command.
Support: Mandatory
02A4..01 Logical-page boundary in the X-direction cannot be represented in the printer
Explanation: The sum of the X[p]-extent value in the LPD command or the X[p]-coordinate value of an
IO command and the X[m]-coordinate value in the LPP command exceed the maximum supported
value.
Support: Optional
02A4..02 User printable area boundary in the X-direction cannot be represented in the printer
Action Code: X'01'
Explanation: The sum of the X[m]-coordinate of the user printable area origin and the X[m]-extent of
the user printable area specified in a Define User Area command exceeded the maximum value that
can be represented in the printer.
Support: Mandatory
Note: Checking for this condition can be done when a Begin Page command is processed rather than
when the DUA command is received. Therefore, when this exception is found, the user printable area
in effect is the last one that was received, that is, the one containing the exception, and the exception
can recur for every subsequent page. Also, the page might not be printed until a valid DUA command
is received or the printer is restarted.
480
A29247-X89-X-3-7678
IPDS Exceptions
02A5..01 Logical-page boundary in the Y-direction cannot be represented in the printer
Explanation: The sum of the Y[p]-extent value in the LPD command or the Y[p]-coordinate value of an
IO command and the Y[m]-coordinate value in the LPP command exceed the maximum supported
value.
Support: Optional
02A5..02 User printable area boundary in the Y-direction cannot be represented in the printer
Action Code: X'01'
Explanation: The sum of the Y[m]-coordinate of the user printable area origin and the Y[m]-extent of
the user printable area specified in a Define User Area command exceeded the maximum value that
can be represented in the printer.
Support: Mandatory
Note: Checking for this condition can be done when a Begin Page command is processed rather than
when the DUA command is received. Therefore, when this exception is found, the user printable area
in effect is the last one that was received, that is, the one containing the exception, and the exception
can recur for every subsequent page. Also, the page might not be printed until a valid DUA command
is received or the printer is restarted.
02AB..01 Insufficient page-buffer storage to print the sheet
Action Code: X'0C'
Explanation: Either the page is too large for page-buffer space or both sides of a duplexed sheet are
collectively too large for available page-buffer space. Deactivating unused resources and retransmitting
the page might correct the problem.
A29247-X89-X-3-7678
481
IPDS Exceptions
Support: Optional
02AC..01 Insufficient main storage to print the sheet
Action Code: X'09'
Explanation: Either the page is too large for main storage or both sides of a duplexed sheet are
collectively too large for available main storage. Deactivating unused resources will not affect the
situation.
Support: Optional
02AC..01 Insufficient main storage to print the sheet
Action Code: X'0C'
Explanation: Either the page is too large for main storage or both sides of a duplexed sheet are
collectively too large for available main storage.
Support: Optional
02AD..01 Invalid or unsupported offset value in a LPP command
Action Code: X'01'
Explanation: The X[m] coordinate or Y[m] coordinate in a LPP command is invalid or unsupported.
Support: Mandatory
482
A29247-X89-X-3-7678
IPDS Exceptions
02AD..02 Invalid or unsupported page-placement value in a LPP command
Action Code: X'01'
Explanation: The page-placement value specified in a Logical Page Position command is invalid or
unsupported. The page-placement value in the LPP command must be valid for the simplex/duplex
value and N-up value specified in the most recently received LCC command.
Support: Mandatory when explicit page placement and orientation is supported
02AD..03 Invalid or unsupported orientation value in a LPP command
Action Code: X'01'
Explanation: The orientation value specified in a Logical Page Position command is invalid or
unsupported.
Support: Mandatory when explicit page placement and orientation is supported
02AE..01 Invalid or unsupported parameter in an IO command
The X[p] coordinate or Y[p] coordinate in an IO command is invalid or unsupported.
The Overlay Type parameter in an IO command is invalid or unsupported.
Support: Mandatory
02AF..01 Insufficient storage to continue processing
A29247-X89-X-3-7678
483
IPDS Exceptions
Action Code: X'0C'
Explanation: There is insufficient storage to continue processing. Deactivating unused fonts, overlays,
and page segments might correct the problem.
Support: Mandatory
Note: Some printers report this exception as X'0212..02', X'023A..02', X'024D..02', X'0263..01',
X'0264..01', X'0281..01', X'02AB..01', or X'02AC..01'. The preferred exception ID is X'02AF..01'.
02AF..01 Asynchronously detected insufficient storage to continue processing
Action Code: X'1E'
Explanation: There is insufficient storage to continue processing. This exception was detected after the
page passed the Received Page Counter station. Deactivating unused fonts, overlays, and page
segments might correct the problem.
Support: Optional
02B0..00 Code page Host-Assigned ID already assigned
Action Code: X'01'
Explanation: The code page HAID specified in a Load Code Page Control command has already been
used in a previously received AR or LCPC command.
Support: Mandatory
02B0..01 Invalid code page Host-Assigned ID in a LCPC command
Action Code: X'01'
484
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The code page HAID specified in a Load Code Page Control command is invalid.
Support: Mandatory
02B0..02 Invalid or unsupported encoding-scheme value in a code page
Explanation: The encoding-scheme value specified in a Load Code Page Control command or in a
resident code page is invalid or unsupported.
This exception ID can be reported either when the resource is being activated, or when a printer default
font is selected.
Support: Mandatory
02B0..04 Too much or too little code page data
The amount of code page data received in a series of Load Code Page commands or in a resident
code page did not match the value in the byte-count field of the Load Code Page Control command.
The last entry in a code page was incomplete.
font is selected.
Support: Mandatory
02B0..05 Invalid or unsupported byte-count value in a code page
A29247-X89-X-3-7678
485
IPDS Exceptions
Explanation: The byte-count value specified in a Load Code Page Control command or in a resident
code page is invalid or unsupported.
font is selected.
Support: Mandatory
02B0..07 Code points out of order in a code page
Explanation: The entries in a series of LCP commands or in a resident code page were not specified in
ascending code-point order.
font is selected.
Support: Mandatory
02B0..0A Font character set Host-Assigned ID already assigned
Action Code: X'01'
Explanation: The font-character-set HAID specified in a Load Font Character Set Control command
has already been used in a previously received AR or LFCSC command.
Support: Mandatory
02B0..0B Invalid Host-Assigned ID in a LFCSC command
486
A29247-X89-X-3-7678
IPDS Exceptions
Action Code: X'01'
Explanation: The font character set HAID specified in a Load Font Character Set Control command is
invalid.
Support: Mandatory
02B0..0C Invalid or unsupported pattern-technology ID in a font character set
Explanation: The pattern-technology ID value specified in a Load Font Character Set Control command
or in a resident font character set is invalid or unsupported.
font is selected.
Support: Mandatory
02B0..0E Invalid or unsupported Load-Font count value in a font character set
Explanation: The Load-Font count value specified in a Load Font Character Set Control command or in
a resident font character set is invalid or unsupported.
font is selected.
Support: Mandatory
02B0..0F Invalid or unsupported map-size value in a font character set
A29247-X89-X-3-7678
487
IPDS Exceptions
Explanation: An invalid or unsupported map-size value was specified in a Load Font Character Set
command or in a resident font character set.
font is selected.
Support: Mandatory
02B1..01 Invalid or unsupported character ID format in a font character set
Explanation: An invalid or unsupported character-ID-format value was specified in the IBM-format field
or in the technology-specific-format field in a character ID map. The character ID map was either in a
LF3-type Load Font command or in a resident font character set.
font is selected.
Support: Mandatory
02B1..02 Invalid technology-specific ID offset in a font character set
Explanation: An invalid technology-specific ID offset value was specified in the character ID map in a
font is selected.
Support: Mandatory
488
A29247-X89-X-3-7678
IPDS Exceptions
02B1..03 Invalid technology-specific ID length in a font character set
Explanation: An invalid technology-specific ID length value was specified in the character ID map in a
font is selected.
Support: Mandatory
02B1..04 GCGIDs out of order in a font character set
Explanation: One or more of the GCGIDs in the character ID map in a LF3-type Load Font command or
in a resident font character set is out of order. The GCGIDs must occur in ascending-EBCDIC order.
font is selected.
Support: Mandatory
02B1..08 Invalid technology-specific object length in a font character set
Explanation: An invalid length value was specified in a technology-specific object found either in a LF3type Load Font command or in a resident font character set.
font is selected.
Support: Mandatory
A29247-X89-X-3-7678
489
IPDS Exceptions
02B1..09 Checksum mismatch in a font character set
Explanation: The checksum specified in a technology-specific object within a LF3-type Load Font
command or within a resident font character set does not match the checksum calculated by the
printer.
font is selected.
Support: Mandatory
02B1..0A Invalid technology-specific-object-identifier length value in a font character set
Explanation: The object-identifier length specified in a technology-specific object within a LF3-type
Load Font command or within a resident font character set is invalid.
font is selected.
Support: Mandatory
02B1..0B Invalid data within a LF3-type technology-specific object
Explanation: One or more of the technology-specific objects in a LF3-type font character set contains
invalid data. The font character set is unusable. This exception ID can be reported either when the
coded font is being activated or when a character within the font is selected for printing.
490
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
02C0..01 Mixture of X[m]-axis duplex and Y[m]-axis duplex copy subgroups
Action Code: X'01'
Explanation: A copy-subgroup pair in a LCC command contains a mixture of X[m]-axis duplex and
Y[m]-axis duplex copy subgroups.
Support: Mandatory
02C0..02 Mixture of N-up copy subgroups in a LCC command
Action Code: X'01'
Explanation: Two different N-up keywords were specified in two copy subgroups of a Load Copy
Control command. When an N-up keyword is specified in a copy subgroup, all other copy subgroups
must specify the same N-up keyword.
Support: Mandatory
02C0..03 More than one N-up keyword specified in a copy subgroup
Action Code: X'01'
Explanation: In a Load Copy Control command, more than one N-up keyword was specified in a copy
subgroup.
Support: Mandatory
02C0..04 Duplexing and N-up not supported together
A29247-X89-X-3-7678
491
IPDS Exceptions
Action Code: X'01'
Explanation: In a Load Copy Control command, both an N-up keyword and a duplex keyword were
specified, but the printer only supports N-up when simplexing.
Support: Mandatory
02C0..05 N-up partitioning not supported with envelope media
Action Code: X'01'
Explanation: In a Load Copy Control command, an N-up keyword was specified while envelope media
was selected. N-up partitioning is not used with envelope media.
Alternate Exception Action: Print as if the N-up keyword had not been specified.
Support: Mandatory
02C1..01 Multiple simplex/duplex keywords in a LCC command
Action Code: X'01'
Explanation: More than one simplex or duplex operation keyword has been specified in a LCC
command copy subgroup.
Support: Mandatory
02C1..02 Internal value not unique in a LE command
Action Code: X'01'
Explanation: The internal-suppression number of two or more list entries in a LE command is not
unique.
492
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
02C2..01 Odd number of duplex copy subgroups in a LCC command
Action Code: X'01'
Explanation: A LCC command has an odd number of copy subgroups when duplex is specified.
Support: Mandatory
02C2..02 More than one media-source or media-destination keyword specified in a copy
subgroup
Action Code: X'01'
In a Load Copy Control command, more than one media-source keyword was specified in a copy
subgroup.
In a Load Copy Control command, more than one media-destination keyword was specified in a copy
subgroup. Either more than one X'90' keyword or more than one X'91' keyword was specified.
Support: Mandatory
02C3..01 Mixture of simplex and duplex parameters in a LCC command
Action Code: X'01'
Explanation: A mixture of simplex and duplex copy subgroups is specified in a LCC command.
A29247-X89-X-3-7678
493
IPDS Exceptions
Support: Mandatory
02C4..01 Unequal copy counts in a LCC command
Action Code: X'01'
Explanation: Unequal copy counts are specified for a copy-subgroup pair in a Load Copy Control
command.
Support: Mandatory
02C5..01 Unable to deactivate resource
Action Code: X'01'
Explanation: A coded font, fully described font section, or font index for which a deactivation is
requested has not been deactivated because it is needed to print a page on an incomplete sheet; not
all of the pages to be printed on the sheet have yet been received.
Support: Mandatory
02C6..01 Unable to deactivate a component of an activated coded font
Action Code: X'01'
Explanation: A Deactivate Font command attempted to deactivate a font character set or code page
that is currently being used in an activated coded font. Before deactivating a font character set or code
page, all coded fonts that use these components must first be deactivated.
Support: Mandatory
494
A29247-X89-X-3-7678
IPDS Exceptions
02C6..02 Invalid mapping type in a LE command
Action Code: X'01'
Explanation: The mapping type in a LE command is not valid.
Support: Mandatory
02C8..01 An unsupported media-source ID was specified
Action Code: X'01'
Explanation: An unsupported media-source ID was specified in a XOH-Select Input Media Source
command or in a Load Copy Control command.
Alternate Exception Action: Select an installed and available media source.
Support: Mandatory
02C8..02 Invalid or unsupported internal value or external value in a Load Equivalence
command
Action Code: X'01'
Explanation: The internal or external value in a LE command is invalid or unsupported.
Support: Mandatory
02FF..02 Synchronous exceptions detected but not queued
Action Code: X'01'
Explanation: So many synchronous exceptions have been detected that the printer has run out of
storage space to save and return all of them to the host.
A29247-X89-X-3-7678
495
IPDS Exceptions
Support: Optional
496
A29247-X89-X-3-7678
IPDS Exceptions
Specification Checks - Barcode Exceptions
A specification check--bar code exception indicates the printer has received a bar code command with
an invalid or unsupported data parameter or value.
Format 0 is used for all bar code specification check exceptions, except for exception ID X'0411..00',
which uses either format 1 or format 7.
0403..00 Invalid or unsupported bar code type
Explanation: The bar code type specified in the bar code data-descriptor self-defining field is invalid or
unsupported.
Support: Refer to Bar Code Object Content Architecture Reference.
0404..00 Unsupported font local ID or font not available
A font local ID specified in the bar code data descriptor self-defining field is unsupported.
A font local ID specified in the bar code data descriptor self-defining field has not been mapped to a
font using the LFE command.
A font local ID specified in the bar code data descriptor self-defining field has been mapped in the
current LFE, but the coded font is not activated.
For those symbologies that require a specific type style or code page for HRI, the BCOCA receiver
cannot determine the type style or code page of the specified coded font.
Alternate Exception Action: If the exception occurs because a font defined within the current LFE
command is not activated in the printer when needed, the printer can try to make an appropriate font
preserving the original code page. Some bar code symbologies specify a set of type styles to be used
for HRI data; font substitution for HRI data must follow the bar code symbology being used. If an
A29247-X89-X-3-7678
497
IPDS Exceptions
appropriate font substitution cannot be made or if the exception occurs for any other reason, there is no
AEA.
Page Continuation Action: If the exception occurs because a font defined within the current LFE
command is not activated in the printer when needed, the printer tries to make an appropriate font
substitution that preserves as many characteristics as possible of the font originally requested while still
preserving the original code page. Some bar code symbologies specify a set of type styles to be used
for HRI data; font substitution for HRI data must follow the bar code symbology being used. If the
exception occurs for any other reason, there is no PCA.
Note: Some printers report this exception as X'0218..02'. The preferred Exception ID is X'0404..00'
when a font to be used with bar code data is unavailable.
0405..00 Invalid or unsupported bar code color
Explanation: The color specified in the bar code data-descriptor self-defining field is invalid or
unsupported.
Page Continuation Action: Use the printer default color.
0406..00 Invalid or unsupported module width
Explanation: The module width specified in the bar code data-descriptor self-defining field is invalid or
unsupported.
Alternate Exception Action: The printer uses the closest smaller width, but if this smaller value is less
than the smallest supported width or zero, the printer uses the smallest supported value. For those
printers having only a single (printer default) width, use the printer default value.
Page Continuation Action: The printer uses the closest smaller width, but, if this smaller value is less
than the smallest supported width or zero, the printer uses the smallest supported value. For those
printers having only a single (printer default) width, use the printer default value.
498
A29247-X89-X-3-7678
IPDS Exceptions
0407..00 Invalid or unsupported element height
Explanation: The element height specified in the bar code data-descriptor self-defining field is invalid or
unsupported.
Alternate Exception Action: The printer uses the closest smaller height, but if this smaller value is less
than the smallest supported element height or zero, the printer uses the smallest supported value. For
those printers having only a single (printer default) height, use the printer default value.
Page Continuation Action: The printer uses the closest smaller height, but, if this smaller value is less
than the smallest supported element height or zero, the printer uses the smallest supported value. For
those printers having only a single (printer default) height, use the printer default value.
0408..00 Invalid or unsupported height multiplier
Explanation: The height multiplier specified in the bar code data-descriptor self-defining field is invalid
or unsupported.
Alternate Exception Action: The printer uses a multiplier of X'01'.
Page Continuation Action: The printer uses a multiplier of X'01'.
0409..00 Invalid or unsupported wide-to-narrow ratio
Explanation: The wide-to-narrow ratio specified in the bar code data-descriptor self-defining field is
Alternate Exception Action: The printer uses the default wide-to-narrow ratio. The default ratio must be
in the range of 2.25 through 3.00. For the MSI code only, however, the default wide-to-narrow ratio
should be 2.00.
Page Continuation Action: The printer uses the default wide-to-narrow ratio. The default ratio must be
in the range of 2.25 through 3.00.
A29247-X89-X-3-7678
499
IPDS Exceptions
040A..00 Invalid or unsupported symbol origin
Explanation: The symbol origin given in a WBC command is invalid or unsupported.
Page Continuation Action: Ignore the command and continue with the next command.
040B..00 Invalid or unsupported bar code modifier
Explanation: The bar code modifier in byte 17 of the bar code data-descriptor self-defining field is
invalid or unsupported for the bar code type specified in byte 16 of the same self-defining field.
040C..00 Invalid or unsupported bar code data length
Explanation: The length of the variable data (as given in bytes 5-end of a WBC command) to be
processed, plus any printer-generated check digits to be processed, is invalid or unsupported.
040E..00 Check-digit calculation exception
500
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The first check-digit calculation resulting in a value of 10 is defined as an exception in
some of the modifier options (byte 17 of the bar code data-descriptor self-defining field) for an MSI bar
code.
0410..00 Invalid or unsupported human-readable interpretation location
Explanation: The human-readable interpretation location specified in the flags byte of a WBC command
is invalid or unsupported.
0411..00 Attempt to print portion of bar code symbol outside object area or VPA
A portion of the bar code symbol or HRI extends beyond the bar code presentation space.
A portion of a bar code symbol or HRI extends outside the VPA.
A portion of a bar code symbol or HRI extends beyond the intersection of the mapped presentation
space and the bar code object area.
For printers that cannot detect bar code symbol position with respect to bar code object area
boundaries, a portion of the bar code presentation space, as mapped into the object area, extends
outside the bar code object area boundaries.
Page Continuation Action: Print partial bar code. Overprint a pattern to destroy readability of a partial
bar code. Continue with next command.
Support: Mandatory
Notes:
A29247-X89-X-3-7678
501
IPDS Exceptions
a. When the data to be printed outside of the VPA is blank (no toned pels), some printers
suppress this exception ID, and other printers generate it. The preferred action is to suppress
the exception ID.
b. Some printers report this as exception ID X'020A..05', the preferred exeption ID is X'0411..00'.
c.
Reporting of this exception is controlled by the Report Page Position Check bit in the XOA
0411..00 Asynchronous attempt to print portion of bar code symbol outside object area or VPA
Action Code: X'19'
Explanation: This exception was discovered after the page containing the bar code object had passed
the Received Page Counter station. One or more of the following conditions occurred:
A portion of the bar code symbol or HRI extends beyond the bar code presentation space.
A portion of a bar code symbol or HRI extends outside the VPA.
A portion of a bar code symbol or HRI extends beyond the intersection of the mapped presentation
space and the bar code object area.
For printers that cannot detect bar code symbol position with respect to bar code object area
boundaries, a portion of the bar code presentation space, as mapped into the object area, extends
outside the bar code object area boundaries.
Page Continuation Action: Print partial bar code. Overprint a pattern to destroy readability of a partial
bar code. Continue with next command.
Support: Optional
Notes:
the exception ID.
b. Some printers report this as exception ID X'020A..05', the preferred exeption ID is X'0411..00'.
Exception-Handling Control
502
A29247-X89-X-3-7678
IPDS Exceptions
command.Specification Checks - Graphics Data
Exceptions
A specification check--graphics exception indicates the printer has received a graphics command with
an invalid or unsupported data parameter or value.
Format 0 is used for all graphics specification check exceptions.
0300..01 Unallocated or unsupported graphics order or command code
Action Code
An attempt was made to process an unallocated or unsupported order code or command code that is
reserved for future use.
In a Write Graphics command, a Begin Segment Introducer identifier was expected but was not
encountered.
A Self-Describing Instruction identifier in a Graphics Data Descriptor was not X'21'.
Page Continuation Action: If a set Current Defaults identifier is not X'21' or a Begin Segment Introducer
identifier is not X'70', skip to END command. If a drawing order identifier is unallocated or unsupported,
the drawing order is ignored--skip to next drawing order.
Support: Refer to Graphics Object Content Architecture Reference.
0300..02 Reserved byte exception or invalid attribute set
A reserved byte in a graphics drawing order is not set to zero.
The Set Current Defaults instruction in the data-descriptor self-defining field of a WGC command
attempts to set an invalid or unsupported attribute in byte 2.
The Set Current Defaults instruction has a length of X'04' and the default byte is not X'0F'.
A29247-X89-X-3-7678
503
IPDS Exceptions
The Set Current Defaults instruction has a length greater than X'04' and the default byte is not X'8F'.
The Set Current Defaults instruction attempts to set an invalid or unsupported mask attribute in bytes 3
and 4.
Page Continuation Action: If the error occurs in the Set Current Defaults instruction, skip to END
command. If the error occurs in a drawing order, the nonzero reserved bytes are ignored.
0300..03 Incorrect drawing order length
The Default field (byte 5) of the Set Current Defaults instruction contains X'8F' but the Length field
(byte 1) does not contain the value implied by the Mask field (bytes 3-4).
The segment length (bytes 8, 9) in a Begin Segment Introducer is X'0000' for a new segment (segment
flags set to B'00').
An invalid length was specified in a drawing order.
The Default field (byte 5) of the Set Current Defaults instruction contains X'0F' but the Length field
(byte 2) is not X'04'.
The Default field (byte 5) of the Set Current Defaults instruction contains X'8F' and the Length field
(byte 1) contains the value implied by the Mask field (bytes 3-4) but the amount of immediate data
(bytes 6-n) does not match that specified in the Length field.
Page Continuation Action: If the number of bytes in a self-defining instruction is not equal to that
requested by the mask byte, skip to END command; else processing continues with the next new
segment.
0300..04 Invalid attribute value
Explanation: An attribute value for a graphics drawing order is invalid.
Alternate Exception Action: Use the standard default value.
504
A29247-X89-X-3-7678
IPDS Exceptions
Page Continuation Action: Use the standard default value.
0300..08 Truncated order exception
A drawing order has been requested that is not complete. This order is either:
•
A fixed two-byte order, and the second byte is not in the segment.
•
A self-identifying order, and the length byte is not in the segment.
•
A self-identifying order, and the number of bytes following the byte containing the length count
to the end of the segment is less than the value of the length count.
Page Continuation Action: Any remaining data in the segment is ignored, processing continues with the
next new segment.
0300..0C Segment prolog exception
A supported order has been encountered that is not valid in a prolog.
The end of a segment has been reached without an End Prolog drawing order.
Page Continuation Action: If an end segment is reached without an END PROLOG, processing
continues with the next new segment. If an order is not valid in a prolog, it is ignored.
0300..0D Virtual graphics presentation space overflow
A29247-X89-X-3-7678
505
IPDS Exceptions
Explanation: A drawing order was received that attempts to draw outside the graphics presentation
space. For DR2/V0, this can only occur with the Full Arc or Full Arc at Current Position drawing orders.
Alternate Exception Action: All drawing outside the graphics presentation space is suppressed. The
printer continues to draw within the graphics presentation space.
Page Continuation Action: Trim to the graphics presentation space.
0300..0E Unsupported attribute value
Explanation: An attribute value for a graphics order is not supported.
Alternate Exception Action: For an unsupported color exception, a simulated color is used for area fill
operations on printers that support simulated color as an AEA for area fill. Otherwise, the standard
default attribute value is used.
Page Continuation Action: Use the standard default attribute value.
0300..21 Invalid or unsupported default
Explanation: The Set Current Defaults instruction in the data-descriptor self-defining field of a WGC
command has set an invalid or unsupported default for an attribute.
Page Continuation Action: If attempting to set the current default for character angle, the current default
is set to the closest supported angle. In all other cases, the current default is set to the printer default
value.
0304..00 Invalid Segment Characteristics drawing order
506
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The Segment Characteristics drawing order was detected outside of a segment prolog.
0334..00 Character angle value not supported
Explanation: The character angle specified in the Set Character Angle drawing order is not supported.
Alternate Exception Action: Use the closest supported angle.
Page Continuation Action: Use the closest supported angle.
033E..00 Invalid End Prolog
Explanation: An End Prolog drawing order has occurred outside the prolog section of a segment.
Page Continuation Action: The END PROLOG is ignored.
0360..00 Area bracket exception
Explanation: An End Area drawing order has been received without a Begin Area drawing order.
Page Continuation Action: The END AREA is ignored.
A29247-X89-X-3-7678
507
IPDS Exceptions
0368..00 Begin Area received incorrectly
Explanation: A Begin Area drawing order has been received while another Begin Area drawing order is
already in progress.
Page Continuation Action: The present area is closed and filled. Any following drawing orders until
END AREA are used to define a new area.
0368..01 Area truncated exception
Explanation: A Begin Area drawing order has been processed in a segment and the end of the
segment has been reached without an End Area drawing order having been received. The results of
area-fill implementation are printer dependent.
Page Continuation Action: The area is closed and filled. Processing continues with the next segment.
0368..02 Supported order invalid in area
Explanation: A supported drawing order that is not valid within an area has been detected in an area.
Page Continuation Action: The drawing order is ignored. Processing continues with the next drawing
order.
0368..03 Pattern Set not supported
508
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: A Begin Area drawing order was encountered but the pattern set requested by the Set
Pattern Set drawing order is not supported.
Alternate Exception Action: Use the standard default pattern symbol.
Page Continuation Action: Use the standard default pattern symbol.
0368..04 Undefined pattern symbol
Explanation: A Begin Area drawing order was encountered but the current pattern symbol is undefined
in the current pattern set.
Alternate Exception Action: Use the standard default pattern symbol.
Page Continuation Action: Use the standard default pattern symbol.
0368..05 Temporary-storage overflow while drawing an area
Explanation: For an area within a graphics segment, temporary storage is sometimes required. The
drawing orders within the area have required more temporary storage than is available.
Alternate Exception Action: Draw and fill as much of the area as possible.
Page Continuation Action: Draw and fill as much of the area as possible.
0370..01 Unsupported Begin Segment Introducer segment flag
Explanation: The segment flag (byte 7, bits 5, 6) in the Begin Segment Introducer has a value of B'10'.
A29247-X89-X-3-7678
509
IPDS Exceptions
Page Continuation Action: Any data in the segment is ignored. Processing continues with the next new
segment.
0370..82 Invalid Begin Segment Introducer segment flag
Explanation: The segment flag (byte 7, bits 5, 6) in the Begin Segment Introducer has a value of B'01'.
Page Continuation Action: Any data in the segment is ignored. Processing continues with the next new
segment.
0370..C1 Invalid Begin Segment Introducer length
Explanation: The Begin Segment Introducer length parameter (byte 1) is invalid.
0370..C5 Insufficient segment data
Explanation: The amount of data received with a segment is less than that specified in the begin
segment SEGLENGTH field.
Page Continuation Action: Processing continues with the next segment, or IPDS command if the END
command is received.
510
A29247-X89-X-3-7678
IPDS Exceptions
0392..00 Graphics image order sequence exception
Explanation: A Begin Image drawing order was not processed before the Image Data drawing order in
the segment.
Page Continuation Action: The drawing order is ignored--the image data is discarded.
0392..01 Image data discrepancy
Explanation: The Image Data drawing order contains either not enough or too many bytes of data.
Page Continuation Action: The Image Data order is ignored.
0393..00 Graphics image bracket exception
Explanation: An End Image drawing order has been received without a Begin Image drawing order
having been received.
Page Continuation Action: The END Image order is ignored.
0393..01 Incorrect number of Image Data drawing orders
A29247-X89-X-3-7678
511
IPDS Exceptions
Explanation: The number of drawing orders between the Begin Image and End Image drawing orders
is not equal to the number of rows in the image (as given by the height value in the Begin Image
drawing order).
Page Continuation Action: If not enough data, pad remaining bytes with X'00'; else ignore the extra
orders.
03C2..00 Marker Set not supported
Explanation: A Marker or Marker at Current Position drawing order was encountered but the marker set
requested by the Set Marker Set drawing order is not supported.
Alternate Exception Action: Use the standard default marker symbol.
Page Continuation Action: Use the standard default marker symbol.
03C2..01 Undefined marker code
Explanation: A Marker or Marker at Current Position drawing order was encountered, but the current
marker symbol is undefined in the current marker set.
Alternate Exception Action: Use the standard default marker symbol.
Page Continuation Action: Use the standard default marker symbol.
03C2..02 Mismatched marker set exception
Explanation: The current marker-set-attribute value identifies a marker set that cannot support the
functions implied by the current marker attribute.
512
A29247-X89-X-3-7678
IPDS Exceptions
Alternate Exception Action: Use the marker set identified by the current marker set attribute, with the
lowest value of precision the marker set can support.
Page Continuation Action: Use the marker set identified by the current marker set attribute, with the
lowest value of precision the marker set can support.
03C3..00 Font not available
A Character String, or Character String at Current Position drawing order was encountered, but the
specified font local ID was not mapped to a font using the LFE command.
A character set specified in a Set Character Set drawing order or specified as a current default and
used by a Character String or Character String at Current Position drawing order is mapped in the
current LFE, but the font is not loaded in the printer.
A character set specified in a Set Character Set drawing order or specified as a current default and
used by a Character String or Character String at Current Position drawing order is mapped in the
current LFE and is loaded in the printer, but the quality level of the font (established by a XOA-PQC
command) is not supported.
Alternate Exception Action: Use the standard default character set.
Page Continuation Action: If the exception occurs because a coded font (defined within the current LFE
command) is not present in the printer when needed, the printer tries to make an appropriate font
preserving the original code page. If the exception occurs for any other reason, there is no PCA.
03C3..01 Undefined graphics character
Explanation: A code in a character string identified in the current Set Character Set drawing order is
undefined or points to an unavailable character pattern.
Alternate Exception Action: Use the standard default character symbol.
Page Continuation Action: Use the standard default character symbol.
A29247-X89-X-3-7678
513
IPDS Exceptions
Note: Reporting of this exception is controlled by the Report Undefined Character Check bit in the XOA
03C3..01 Asynchronously detected undefined graphics character
Action Code: X'19'
Explanation: This exception was detected after the page had passed the Received Page Counter
station.
A code in a character string identified in the current Set Character Set drawing order is undefined or
points to an unavailable character pattern.
Alternate Exception Action: Use the standard default character symbol.
Page Continuation Action: Use the standard default character symbol.
Support: Optional
03C3..02 Mismatched character set exception
Explanation: The current character-set-attribute value identifies a character set that cannot support the
functions implied by the current character attribute.
Alternate Exception Action: Use the character set identified by the current character set attribute, with
the lowest value of precision the character set can support.
Page Continuation Action: Use the character set identified by the current character set attribute, with
the lowest value of precision the character set can support.
03C6..01 Arc drawing check
514
A29247-X89-X-3-7678
IPDS Exceptions
Explanation: The drawing processor has detected an exception which might prevent the drawing of the
arc within the normal limits of pel accuracy.
Alternate Exception Action: Draw the arc with possible reduced accuracy, which might result in straight
lines.
Page Continuation Action: Draw the arc with possible reduced accuracy, which might result in straight
lines.
03D1..00 Truncated graphics image exception
Explanation: A Begin Image drawing order has been received in a segment and the end of the segment
has been reached without an End Image drawing order having been processed.
Page Continuation Action: The received image data is printed. Processing continues with the next
segment.
03D1..01 Invalid order in graphics image
Explanation: A Begin Image drawing order has been processed in a segment, and an order other than
Comment, Image Data, No Operation, or End Image has been encountered.
next 'NEW' segment.
03D1..02 Graphics image format not supported
Explanation: The value specified for the graphics image FORMAT parameter is not supported.
A29247-X89-X-3-7678
515
IPDS Exceptions
next 'NEW' segment.
03D1..03 Image width greater than maximum supported
Explanation: The width value specified in the Begin Image drawing order exceeds the maximum
supported image width.
Alternate Exception Action: Truncate the image width at the maximum width supported.
Page Continuation Action: Truncate the image width at the maximum width supported.
03D1..04 Image height greater than maximum supported
Explanation: The height value specified in a Begin Image drawing order exceeds the maximum
supported image height.
Alternate Exception Action: Truncate the image height at the maximum height supported.
Page Continuation Action: Truncate the image height at the maximum height supported.
03E1..00 Relative line outside coordinate space
Explanation: A relative line starts inside the drawing order coordinate space, but then goes outside the
space.
Page Continuation Action: The movement that would cause the error is ignored.
516
A29247-X89-X-3-7678
IPDS Exceptions
Specification Checks - IO-Image Exceptions
A specification check--IO-image exception indicates the printer has received an IO-image command
with an invalid or unsupported data parameter or value.
Format 0 is used for all IO-image specification check exceptions.
0500..01 Invalid or unsupported IO-image self-defining field code
Explanation: An invalid or unsupported self-defining field code was encountered within an IO-image
segment.
Support: Refer to Image Object Content Architecture Reference.
0500..03 Invalid or unsupported IO-image self-defining field length
Explanation: The length field of one of the following is invalid or unsupported: a Begin Segment selfdefining field, a Begin Image Content self-defining field, an Image Size Parameter, an Image Encoding
Parameter, an Image Data Element Size Parameter, an Image Look Up Table ID Parameter, an Image
Data self-defining field, an End Image Content self-defining field, or an End Segment self-defining field.
0500..04 Invalid IO-image self-defining field value
Explanation: A field value of one of the following is invalid: a Begin Image Content self-defining field, an
Image Size Parameter, or an Image Data Element Size Parameter.
A29247-X89-X-3-7678
517
IPDS Exceptions
0570..0F IO-image Begin Segment out of sequence
Explanation: The sequence of self-defining fields within a series of WI2 commands is invalid. Either a
Begin Segment was missing, was encountered out of sequence, or appeared more than once. A Begin
Segment must be the first self-defining field in the series of WI2 commands.
0571..0F IO-image End Segment out of sequence
Explanation: The sequence of self-defining fields within a series of WI2 commands is invalid. Either an
End Segment was missing or was encountered out of sequence. An End Segment must follow an End
Image Content.
0591..0F IO-image Begin Image Content out of sequence
Explanation: The sequence of self-defining fields within a series of WI2 commands is invalid. Either a
Begin Image Content was missing, was encountered out of sequence, or appeared more than once. A
Begin Image Content must follow a Begin Segment.
518
A29247-X89-X-3-7678
IPDS Exceptions
0592..0F IO-image Image Data self-defining field out of sequence
Explanation: The sequence of self-defining fields within a series of WI2 commands is invalid. An Image
Data self-defining field was encountered out of sequence. Image Data self-defining fields must appear
after image data parameters and before End Image Content.
0593..0F IO-image End Image Content out of sequence
End Image Content was missing, was encountered out of sequence, or appeared more than once. An
End Image Content must follow an Image Data self-defining field.
0594..01 Inconsistent Image Size Parameter value and Image Data
Explanation: The size detected from the image data is different from the horizontal or vertical size in
the Image Size Parameter.
Alternate Exception Action: Use the detected horizontal or vertical size as the source image size and
not the value(s) of the Image Size Parameter.
Page Continuation Action: Use the detected horizontal or vertical size as the source image size and not
the value(s) of the Image Size parameter.
A29247-X89-X-3-7678
519
IPDS Exceptions
0594..0F IO-image Image Size Parameter missing or out of sequence
Image Size Parameter did not appear after a Begin Image Content and before the image data, or it
appeared more than once between the two self-defining fields.
0594..10 IO-image Image Size Parameter value unsupported
Explanation: A value within an Image Size Parameter is unsupported. An unsupported unit base value
was specified.
0594..11 IO-image Image Size cannot be determined
Explanation: The horizontal size (bytes 7,8) or vertical size (bytes 9,10) of the Image Size Parameter is
zero, but the size of the image in that direction is not detectable from the image data.
0595..0F IO-image Image Encoding Parameter out of sequence
520
A29247-X89-X-3-7678
IPDS Exceptions
Encoding Parameter was encountered out of sequence or appeared more than once. Image Encoding
Parameter must appear after a Begin Image Content and before the image data.
0595..10 IO-image Image Encoding Parameter value unsupported
Explanation: A value within an Image Encoding Parameter is unsupported. An unsupported
compression algorithm, recording algorithm, or bit ordering was specified.
0595..11 IO-image decompression error
Explanation: An error was encountered while decompressing IO-image data under the following
conditions:
The image data was not encoded according to the compression or recording algorithm specified in the
Image Encoding Parameter.
The image data could not be decoded successfully using the size values specified in the Image Size
Parameter. This condition applies to compression or recording algorithms which do not permit the
image size to be encoded in the image data.
The image data was not in complete accordance with the compression algorithm specified in the Image
Encoding Parameter.
Alternate Exception Action: Printers should attempt to present or make use of all successfully
decompressed image data. The resulting partial image might differ from the original image.
A29247-X89-X-3-7678
521
IPDS Exceptions
0596..0F IO-image Image Data Element Size Parameter out of sequence
Data Element Size Parameter was encountered out of sequence or appeared more than once. An
Image Data Element Size Parameter must appear after a Begin Image Content and before the image
data.
0596..10 IO-image Image Data Element Size Parameter value unsupported
Explanation: A value within an Image Data Element Size Parameter is unsupported. An unsupported
Number of Bits per Image Point value was specified.
0596..11 IO-image Image Data Element Size Parameter and Image Encoding Parameter
inconsistent
Explanation: An image compression algorithm was specified in the Image Encoding Parameter (byte 2
contained a value other than X'03'), but the Image Data Element Size Parameter specified a value
other than X'01' bits per image point.
522
A29247-X89-X-3-7678
IPDS Exceptions
0597..0F IO-image Image Look Up Table ID Parameter out of sequence
Look Up Table ID Parameter was encountered out of sequence or appeared more than once. Image
Look Up Table ID Parameter must appear after a Begin Image Content and before the image data.
0597..10 IO-image Image Look Up Table ID Parameter value unsupported
Explanation: A value in an Image Look Up Table ID Parameter is unsupported. An unsupported Look
Up Table ID value was specified.
05A9..02 IO-image data outside of the Image Presentation Space
Explanation: A portion of the IO-image data was specified outside of the Image Presentation Space.
Alternate Exception Action: The part of the IO image extending outside of the Image Presentation
Space is discarded. Portions of the Image Presentation Space that contain no image data are filled
with zeros, then the image is mapped to the Image object area.
Page Continuation Action: The part of the IO image extending outside of the Image Presentation Space
is discarded. Portions of the Image Presentation Space that contain no image data are filled with zeros,
then the image is mapped to the Image object area.
A29247-X89-X-3-7678
523
IPDS Exceptions
Intervention-Required Exceptions
An intervention-required exception indicates that the printer has detected a condition that requires
manual intervention. There are no AEAs for this class of exception.
Format 2 is used for intervention-required exceptions.
4000..00 Printer not ready
Action Code: X'1A'
Explanation: The printer is in a not-ready state.
Support: Optional
4000..00 Printer not ready
Action Code: X'22'
The printer has been not ready for a specified amount of time.
A printer door is open and has not been closed by the operator after a specified amount of time.
Support: Optional
4001..00 Out of paper
Action Code: X'1A'
Explanation: The printer is out of paper or the bin cover is open and buffered pages have been deleted.
524
A29247-X89-X-3-7678
IPDS Exceptions
Support: Optional
4001..00 Out of paper
Action Code: X'22'
Explanation: The printer is out of paper or the bin cover is open, and no paper has been added by the
operator after a specified amount of time.
Support: Optional
4002..00 Media destination is full
Action Code: X'1A'
Explanation: The media destination (stacker) is full.
Support: Optional
4002..00 Media destination is full
Action Code: X'22'
Explanation: The media destination (stacker) is full and has not been emptied by the operator after a
specified amount of time.
Support: Optional
4004..00 Out of toner
A29247-X89-X-3-7678
525
IPDS Exceptions
Action Code: X'1A'
Explanation: The printer is out of toner.
Support: Optional
4004..00 Out of toner
Action Code: X'22'
Explanation: The printer is out of toner, and no toner has been added by the operator after a specified
amount of time.
Support: Optional
4005..00 Empty fuser oil supply
Action Code: X'22'
Explanation: The fuser oil supply is empty, and no fuser oil has been added by the operator after a
Support: Optional
4006..00 Invalid physical media
Action Code: X'22'
Explanation: An invalid physical media specification was received. Nonduplexable media was selected
for duplex printing, and the operator has not corrected this problem after a specified amount of time.
526
A29247-X89-X-3-7678
IPDS Exceptions
Support: Optional
4010..00 Paper adjustment check
Action Code: X'1A'
Explanation: A paper adjustment check occurred.
Support: Optional
4011..00 Supressed jam recovery
Action Code: X'22'
Explanation: Host recovery for physical media jams has been disabled at the printer, a jam has
occurred, and it has not been corrected by the operator after a specified amount of time.
Support: Optional
4012..00 An attempt to print an undefined character or to print outside sheet boundaries has
occurred that requires operator intervention
Action Code: X'22'
An operator intervention condition has occurred because of an attempt to print outside sheet
boundaries, and it has not been corrected by the operator after a specified amount of time.
An operator intervention condition has occurred because of an attempt to print an undefined character,
and it has not been corrected by the operator after a specified amount of time.
The operator intervention condition might have been caused by a pre-processing or post-processing
device attached to the printer.
A29247-X89-X-3-7678
527
IPDS Exceptions
Support: Optional
4020..00 Incorrect Form Module selection
Action Code: X'1A'
Explanation: An incorrect form module selection was detected.
Support: Optional
4031..00 Paper-Length Check
Action Code: X'1A'
Explanation: The printer has detected a paper-length check.
Support: Optional
4031..00 Paper-Length Check
Action Code: X'22'
Explanation: The printer has detected a paper-length check, and it has not been corrected by the
Support: Optional
4033..00 Paper-Width Check
528
A29247-X89-X-3-7678
IPDS Exceptions
Action Code: X'22'
Explanation: The printer has detected a paper-width check, and it has not been corrected by the
Support: Optional
4050..00 Fuser oil supply empty
Action Code: X'22'
Explanation: The fuser oil supply is empty, and no fuser oil has been added by the operator after a
Support: Optional
4051..00 Developer mix needs changing
Action Code: X'22'
Explanation: The developer mix needs to be changed, and the operator has not responded after a
Support: Optional
4052..00 Oiler felt needs changing
Action Code: X'22'
Explanation: The oiler felt needs to be changed, and the operator has not responded after a specified
amount of time.
A29247-X89-X-3-7678
529
IPDS Exceptions
Support: Optional
4053..00 Toner collector full
Action Code: X'22'
Explanation: The toner collector is full and needs to be replaced, and the operator has not responded
after a specified amount of time.
Support: Optional
4054..00 Fine filter needs changing
Action Code: X'22'
Explanation: The fine filter needs to be changed, and the operator has not responded after a specified
amount of time.
Support: Optional
40C0..00 Continuous Forms Separator Jam
Action Code: X'08'
Explanation: A hardware failure occurred in the printer's continuous-forms separator mechanism. The
continuous forms might not have been completely separated. The printer will not resume printing until
the jam has been cleared.
Support: Optional
530
A29247-X89-X-3-7678
IPDS Exceptions
40C0..00 Continuous Forms Separator Jam
Action Code: X'22'
Explanation: A hardware failure occurred in the printer's continuous-forms separator mechanism, and it
has not been corrected by the operator within a specified time. The continuous forms might not have
been completely separated. The printer will not resume printing until the jam has been cleared.
Support: Optional
40E0..00 Physical media jam not cleared
Action Code: X'22'
Explanation: A physical media jam has occurred and has not been cleared by the operator after a
Support: Optional
40E1..00 Out of paper (secondary input)
Action Code: X'22'
Explanation: The secondary paper supply is out of paper and no paper has been added by the operator
after a specified amount of time.
Support: Optional
40E2..00 Transport requires corrective action
Action Code: X'22'
A29247-X89-X-3-7678
531
IPDS Exceptions
Explanation: The transport mechanism requires corrective action and no action has been taken by the
Support: Optional
40E3..00 Fuser requires corrective action
Action Code: X'22'
Explanation: The fuser requires corrective action and no action has been taken by the operator after a
Support: Optional
40E4..00 Cancel key pressed
Action Code: X'09'
Explanation: The Cancel key on the printer operator panel was pressed while the printer was receiving
data.
Support: Optional
Note: Some printers report this exception as X'01E4..00'. The preferred Exception ID is X'01E4..00'.
Action Code: X'15'
data.
532
A29247-X89-X-3-7678
IPDS Exceptions
Support: Optional
Note: Some printers report this exception as X'01E4..00'. The preferred Exception ID is X'01E4..00'.
40E5..00 Jam recovery needed
Action Code: X'08'
Explanation: A physical media jam has occurred, and the lost pages must be resent.
Support: Optional
Note: Some printers report this error as exception ID X'40E0..00'. The preferred exception ID is
X'40E5..00'.
40E5..00 Jam recovery needed
Action Code: X'22'
Explanation: A physical media jam has occurred. This problem has not been corrected by the operator
within a specified time.
Support: Optional
40E6..00 Door open
Action Code: X'22'
Explanation: The printer has detected a door-open condition, and it has not been corrected by the
A29247-X89-X-3-7678
533
IPDS Exceptions
Support: Optional
40E7..00 Paper-specification check
Action Code: X'22'
Explanation: The printer has detected a paper-specification check, and it has not been corrected by the
Support: Optional
40E8..nn Supported but not installed Media Source ID specified
Action Code: X'1A'
Explanation: A supported media source ID of X'nn' was specified, but the input media source
associated with that ID is not currently installed.
Support: Optional
534
A29247-X89-X-3-7678
IPDS Exceptions
Equipment Check with Intervention Required
Exceptions
An Equipment Check with Intervention Required exception indicates that the printer has detected a
condition that was caused by hardware failure or by hardware limitations, and manual intervention at
the printer is required. There are no AEAs for this class of exception.
Format 2 is used for equipment-check-with-intervention-required exceptions.
5010..00 Printer-Hardware Exception
Action Code: X'16'
Explanation: A printer-hardware exception was detected.
Support: Optional
5010..00 Printer-Hardware Exception
Action Code: X'22'
Explanation: The printer has detected a printer-hardware error condition, and it has not been corrected
by the operator after a specified amount of time.
Support: Optional
50F2..00 Print Overrun
Action Code: X'09'
Explanation: A print request attempted to position print data on the physical medium after the print
position had passed the point in the printer where this print position can no longer be changed. This
exception can occur because the processing of the data in the printer takes too long.
A29247-X89-X-3-7678
535
IPDS Exceptions
Support: Optional
50F2..00 Print Overrun
Action Code: X'22'
position had passed the point in the printer where this print position can no longer be changed. This
problem has not been corrected by the operator within a specified time. This exception can occur
because the processing of the data in the printer takes too long.
Support: Optional
50F5..00 Image Generator Exception
Action Code: X'16'
Explanation: A hardware failure has occurred with the Image Generator.
Support: Optional
50F5..00 Image Generator Exception
Action Code: X'22'
Explanation: A hardware failure has occurred with the Image Generator, and it has not been corrected
by the operator within a specified time.
Support: Optional
536
A29247-X89-X-3-7678
IPDS Exceptions
50F6..00 Offset Stacker Exception
Action Code: X'17'
Explanation: The Offset Stacker is not available (has been disabled).
Support: Optional
50F7..00 Duplex Media Path Exception
Action Code: X'17'
Explanation: Duplex capability is not available (has been disabled).
Support: Optional
50F8..nn Media-Source Exception
Action Code: X'17'
Explanation: Media Source X'nn' is not available (has been disabled).
Support: Optional
50F9..00 MICR printing exception
Action Code: X'17'
Explanation: MICR printing is not available (has been disabled).
A29247-X89-X-3-7678
537
IPDS Exceptions
538
A29247-X89-X-3-7678
IPDS Exceptions
Support: OptionalEquipment-Check Exceptions
An equipment-check exception indicates that the printer has detected an equipment malfunction or a
hardware failure. There are no AEAs for this class of exception.
Format 2 is used for equipment-check exceptions.
10F1..00 Permanent hardware exception
Action Code: X'22'
A permanent hardware failure exists.
The printer detected either a logic exception from which the printer could not recover or a condition that
should not have occurred. The session and conversation should be terminated.
Support: Optional
10F2..00 Print overrun
Action Code: X'09'
position had passed the point in the printer where this print position can no longer be changed. The
committed page-counter station is the place in the printer where pages can no longer be discarded by
the XOA Discard Buffered Data command. For some printers, this is the print mechanism. This
exception can occur because processing of the data in the printer takes too long.
Support: Optional
10F3..00 Magnet setting changed
A29247-X89-X-3-7678
539
IPDS Exceptions
Action Code: X'23'
Explanation: The magnet setting on the media cassette changed after a page was processed but
before the page was printed.
Support: Optional
10F4..00 Serializer parity exception
Action Code: X'23'
Explanation: A parity exception has occurred within the image generator (first occurrence).
Support: Optional
10F5..00 Image generator exception
Action Code: X'23'
Explanation: A hardware failure has occurred within the image generator.
540
A29247-X89-X-3-7678
IPDS Exceptions
Support: OptionalData - Check Exceptions
A data-check exception indicates that the printer has detected an undefined character or position
check.
Format 0 is used for all data-check exceptions, except for exception ID X'08C1..00', which uses either
format 1 or format 7.
0821..00 Undefined character
•
An undefined character has been detected in WBC command bar code data.
•
An undefined character has been detected in the font specified for text, bar code HRI, or
graphics character-string data.
•
A character has been detected in Write Text command data which is undefined at the quality
level specified by the XOA PQC command.
Alternate Exception Action: For an undefined character in bar code data, there is no alternate
exception action. For an undefined character within a LF1-type or LF3-type coded font, the character is
processed as if it had been a defined character; for a double-byte code point in a LF1-type restricted
section (sections X'45' through X'FE'), the print position is incremented using the default variable space
increment. For an undefined character within a symbol-set coded font, a printer-defined default
character is used; there may be a different default character for each data type.
Page Continuation Action: For an undefined character in bar code data, ignore the command and
continue with the next command. For an undefined character within a LF1-type or LF3-type coded font,
the character is processed as if it had been a defined character; for a double-byte code point in a LF1type restricted section (sections X'45' through X'FE'), the print position is incremented using the default
variable space increment. For an undefined character within a symbol-set coded font, a printer-defined
default character is used; there may be a different default character for each data type.
Support: Mandatory
Notes:
a. Reporting of this exception for an undefined character within a font is controlled by the Report
Undefined Character Check bit in the XOA Exception-Handling Control command.
A29247-X89-X-3-7678
541
IPDS Exceptions
0821..00 Asynchronous undefined character
Action Code: X'19'
Explanation: This exception was discovered after the page had passed the Received Page Counter
station. One or more of the following conditions occurred:
•
An undefined character has been detected in WBC command bar code data.
•
An undefined character has been detected in the font specified for text, bar code HRI, or
graphics character-string data.
•
A character has been detected in Write Text command data which is undefined at the quality
level specified by the XOA PQC command.
Alternate Exception Action: For an undefined character in bar code data, there is no alternate
exception action. For an undefined character within a LF1-type or LF3-type coded font, the character is
processed as if it had been a defined character; for a double-byte code point in a LF1-type restricted
section (sections X'45' through X'FE'), the print position is incremented using the default variable space
increment. For an
undefined character within a symbol-set coded font, a printer-defined default character is used; there
may be a different default character for each data type.
Page Continuation Action: For an undefined character in bar code data, ignore the command and
continue with the next command. For an undefined character within a LF1-type or LF3-type coded font,
the character is processed as if it had been a defined character; for a double-byte code point in a LF1type restricted section (sections X'45' through X'FE'), the print position is incremented using the default
variable space increment. For an undefined character within a symbol-set coded font, a printer-defined
default character is used; there may be a different default character for each data type.
Support: Optional
Notes:
a. Reporting of this exception for an undefined character within a font is controlled by the Report
Undefined Character Check bit in the XOA Exception-Handling Control command.
0829..00 Double-byte coded font section is not activated or is invalid
The double-byte coded font section specified in a code point is not activated.
542
A29247-X89-X-3-7678
IPDS Exceptions
The double-byte coded font section ID specified in a code point is invalid.
Alternate Exception Action: The print position is incremented using the default variable space
increment.
Page Continuation Action: The print position is incremented using the default variable space increment.
Support: Mandatory
0860..00 Numeric representation precision check
Explanation: The print position cannot be represented by the printer.
Page Continuation Action: Ignore the command and skip to the next END command.
Support: Mandatory
Notes:
a. Some printers report this exception as X'0215..01' or X'0216..01'. The preferred exception is
X'0860..00'.
b. Some printers report this exception when an invalid units per unit base value (X'0000') is found
in a BCDD structure. The preferred exception, in this case, is X'0206..05'.
08C1..00 Position check
Explanation: An attempt was made to print outside the valid printable area.
Alternate Exception Action: All printing outside the valid printable area is suppressed. All data and
controls continue processing. The printer continues to print within the valid printable area to the
greatest possible extent. For text, this may mean truncating text lines at the character boundary closest
to the edge of intersection or, alternatively, printing part of a graphic character. For graphics, this may
mean truncating
graphics pictures at the pel closest to the boundary. For image, this may mean truncating image scan
lines at the pel closest to the boundary or, alternatively, not printing any of the image if any part of the
image falls outside the valid printable area.
A29247-X89-X-3-7678
543
IPDS Exceptions
Page Continuation Action: All printing outside the valid printable area is suppressed. All data and
greatest possible extent. If there is not enough valid printable area for the printer to highlight the
exception ID on the logical page, the highlighted exception ID is not printed.
Support: Mandatory
Notes:
the exception ID.
b. Some printers report this exception as X'0411..00' for bar code VPA errors and X'020A..05' for
VPA errors in other data types; other printers report this exception as X'020A..05' for VPA
errors in all data types. The preferred Exception ID is X'0411..00' for bar code VPA errors and
X'08C1..00' for VPA errors in all other data types.
c.
d. This corresponds to a PTOCA exception.
08C1..00 Asynchronous Position check
Action Code: X'19'
Explanation: An attempt was made to print outside the valid printable area. This exception was
discovered after the page had passed the Received Page Counter station.
Alternate Exception Action: All printing outside the valid printable area is suppressed. All data and
greatest possible extent. For text, this may mean truncating text lines at the character boundary closest
to the edge of intersection or, alternatively, printing part of a graphic character. For graphics, this may
mean truncating graphics pictures at the pel closest to the boundary. For image, this may mean
truncating image scan lines at the pel closest to the boundary or, alternatively, not printing any of the
image if any part of the image falls outside the valid printable area.
Page Continuation Action: All printing outside the valid printable area is suppressed. All data and
greatest possible extent. If there is not enough valid printable area for the printer to highlight the
exception ID on the logical page, the highlighted exception ID is not printed.
Support: Optional
Notes:
544
A29247-X89-X-3-7678
IPDS Exceptions
the exception ID.
b. Some printers report this exception as X'0411..00' for bar code VPA errors and X'020A..05' for
VPA errors in other data types; other printers report this exception as X'020A..05' for VPA
errors in all data types. The preferred Exception ID is X'0411..00' for bar code VPA errors and
X'08C1..00' for VPA errors in all other data types.
c.
This corresponds to a PTOCA exception
A29247-X89-X-3-7678
545
IPDS Exceptions
Command - Reject Exceptions
A command-reject exception indicates that an IPDS command was rejected at the printer without the
data within the command being examined. There are no AEAs for this class of exception.
Format 0 is used for command-reject exceptions.
8001..00 Invalid or unsupported IPDS command code
Action Code: X'01'
Explanation: The command code is not a valid or supported value. An invalid length on a previous
command might have caused the current data to be mistaken for a command.
Page Continuation Action: If X'D6' is the first byte of the command code received, ignore the command.
Otherwise there is no Page Continuation Action.
Support: Mandatory
8002..00 Invalid or unsupported IPDS command sequence
Action Code: X'01'
Explanation: The printer state is invalid or is unsupported for the received command.
Support: Mandatory
8004..00 Data received after ARQ
Action Code: X'01'
Explanation: IPDS commands were received after an acknowledgment was requested, but before it
was sent.
546
A29247-X89-X-3-7678
IPDS Exceptions
Support: Optional
80E0..00 Invalid IPDS command length
Action Code: X'01'
The length of an IPDS command is not within the allowed range.
The length of the data within a WGC, WIC2, or WBCC command is not equal to the sum of the lengths
of the self-defining fields which are in the command.
Support: Optional
Note: Some printers report this exception as X'0202..02' or X'0203..02'. The preferred
Exception ID is X'0203..02' when the IPDS command header length is too small and
X'0202..02' for other IPDS command length exceptions.
A29247-X89-X-3-7678
547
IPDS Exceptions
Conditions Requiring Host Notification
A condition requiring host notification indicates that the printer has detected a condition which, while
not an error, should be reported to the host. There are no AEAs for this class of exception.
Format 2 is used for all conditions-requiring-host-notification exceptions.
0100..00 Normal Printer Restart
Action Code: X'0D'
• The printer was IMLed in a normal manner
•
•
•
•
The printer was switched from Offline to Online State.
The channel issued a System_Reset (applies only to channel-attached printers).
The channel issued a Selective_Reset (applies only to channel-attached printers).
An IPDS dialog ended and the printer reset the IPDS state machine and deleted all resources.
This occurs when an IPDS dialog ends and the printer needs to use some of the resources,
such as storage, that had been allocated to the IPDS dialog.
Support: Optional
0101..00 Media-source characteristics changed
Action Code: X'1D'
Explanation: One or more of the following conditions occurred, that change the printable-area selfdefining field within a XOH-OPC reply:
• The media source ID of one or more of the installed media sources was changed.
• The size of the medium presentation space in one or more of the installed media sources was
changed.
• The size or offset of the physical printable area in one or more of the installed media sources
was changed.
•
One or more of the media-source-characteristics flags for one or more of the installed media
sources was changed.
•
The media identification of one or more of the installed media sources was changed.
548
A29247-X89-X-3-7678
IPDS Exceptions
Support: Mandatory
0102..00 MICR printing status changed
Action Code: X'1D'
Explanation: MICR printing is now available.
Support: Mandatory
0103..00 BTS/CTS status changed
Action Code: X'1D'
Explanation: Burster-trimmer-stacker or cutter-trimmer-stacker status has changed.
Support: Mandatory
0104..00 Medium modification availability has changed
Action Code: X'1D'
Explanation: The availability of one or more medium modification functions has changed, and all
medium modifications have been inhibited.
Support: Mandatory
0105..00 Media-destination status changed
Action Code: X'1D'
Explanation: The status of at least one media-destination has changed. Either a media-destination ID
has become available (supported) or has become unavailable (not supported).
Support: Mandatory
A29247-X89-X-3-7678
549
IPDS Exceptions
0110..00 Print Position Adjustment
Action Code: X'1A'
Explanation: An operator adjustment is taking place or has just taken place.
Support: Mandatory
0180..00 Request to end IPDS dialog
Action Code: X'05'
Explanation: The printer has received a request to print from another session and asks the
presentation services program to end the current IPDS dialog as soon as possible, such as at the end
of the current print unit.
Support: Optional
018F..00 Error Printer Restart
Action Code: X'0D'
Explanation: The printer was just IMLed as a result of a printer-detected error.
Support: Optional
Action Code: X'15'
data.
Support: Mandatory
550
A29247-X89-X-3-7678
Index
Index
Absolute Colorimetric 306
AChar 97, 132, 138, 139, 140
ADays
value 160
ADays 160
add 297
AString
String 123, 127, 132, 138, 139, 140, 143,
144
AString 123, 127, 132, 138, 139, 140, 143,
144
ATimes 105
Advanced Production Mode 281
AToFind
String 105
AFromIndex 105
AToFind 105
AHour 175
ATruncate
setting 107
AIndex value 132
AInt 97
Alength 102
All 27, 302, 306
All-in-onE 105
All-in-onE softwarE 105, 113, 114
AMillisecond 181
AP1 36, 37, 48, 49, 60, 69, 80
AP2 69
APMinDecimalPlaces 88
Appends aString
end 127
Appends aString 127
ATruncate 107
Australia Post 208
AWidth 107
AYear
value 166
AYear 166
Aztec 210
B 80, 82, 148
B.toString 82, 138, 139, 143, 144
B1 AND-ed 80
B1.booleanAnd2 80
B2 80
AReplaceWith
string 105
barcodes 195, 198, 199, 201, 203, 206, 208,
210, 211, 213, 216, 219, 221, 223, 225, 226,
227, 230, 233, 235, 236, 239, 241, 242, 244,
246, 248, 250, 252, 255
AReplaceWith 105
Barcodes Overview 195
Arithmetic Operators 16
Based 302
ASecond 179
Begin 27
Assignment Statements 19
BeginWithCaseInsensitive 143
APrecisionspecifies 88
A29247-X89-X-3-7678
551
Index
BinaryAnd 42, 53
Boolean Or2 79
BinaryNot 35, 46
Boolean Xor2 81
BinaryXor 42, 63
Break Statement 30
Bitwise
result 53
C 67, 72, 80, 82, 155
Bitwise 35, 42, 46, 53
Bitwise bitwise xor 63
Bitwise xor 42
Black 302
bool
bool syntax and examples 78, 79, 80, 81,
82
bool 77, 78, 79, 80, 81, 82, 98, 107, 138,
139, 142, 143, 144, 145, 148
Bool aP1 80
Bool aTruncate 107
Bool b 82, 138, 139, 143, 144, 148
Bool b1 80
Bool b2 80
Bool beginWith 142
Bool beginWithCaseInsensitive 143
Bool booleanAnd2 80
Bool contains 138
Bool containsCaseInsensitive 139
Bool endWith 144
Bool endWithCaseInsensitive 145
Bool isEmpty 98
Bool toBool 148
Boolean And2 80
Boolean Not 78
Boolean operators 17
552
C filename.job 259
C.minus 67, 72
C.toInt 80
C.toString 69, 155
cache 282, 283, 287
Case-insensitive 132, 139, 143
Center 302
change 97
Char 96, 97, 132, 140, 153, 154, 155
Char aChar 132, 138, 139, 140
Char aFill 107
Char c 155
Characteristics 297, 302
Chroma 302
CMYK 297, 298, 304
Codabar 211
Code 128 213
Code 128 UPS 216
Code 39 219, 221
Code 93 223
Codec 261, 262
Col 263
Color
absolute colorimetric (match) 306
color management 298
color spaces 300, 301, 302, 303, 304
full color overview 297, 306, 307, 308, 309
A29247-X89-X-3-7678
Index
relative colorimetric (proof) 307
Color 297, 298, 300, 301, 302, 303, 304,
306, 308
Color Management 298
Color Management Functions 298
Color printing 297
Color Spaces 300, 301, 303, 304
Colorimetric 306, 307, 308
commands 259, 261, 262, 263, 264, 265,
266, 267, 278, 283, 287
Comparison Operators 18
Conditional Constructs 22
Config file 263
Configuration 283
configuration files 282, 283, 287
Contains 138
ContainsCaseInsensitive 139
Continue Statement 31
conversion 306
CountOccurrences 140
create 108, 297
CSV,XML,FLAT,TSD 261
currency
currency syntax and examples 66, 67, 68,
69, 71, 72, 73, 74, 75, 76
currency 65, 66, 67, 68, 69, 71, 72, 73, 74,
75, 76, 80, 82, 152
Currency aP1 67, 72
Currency c 67, 69, 72, 80, 82
Currency toCurrency 152
Current Folder
A29247-X89-X-3-7678
Using 283
Current Folder 283
CX_DATA Variable 288
D 84, 85, 86, 87, 159
D.divide 87
D.minus 85
D.multiply 86
D.plus 84
D.toInt 90
D.toString 88
Data 225, 261, 265
Data Input 265
Data Matrix 225
Data Output Commands 261
Datacodec String 262
Datacodec UTF-8 261
Datalogic 198
Dataoutputtype CSV 261
date/time
date/time syntax and examples 158, 159,
160, 161, 162, 163, 164, 165, 166, 167, 168,
169, 172, 173, 174, 175, 176, 177, 178, 179,
180, 181, 182, 183, 184, 185
DateTime
second 180
DateTime 156, 158, 159, 160, 161, 162, 163,
164, 165, 166, 167, 168, 169, 172, 173, 174,
175, 176, 177, 178, 179, 180, 181, 182, 183,
184, 185
DateTime dt 159, 160, 161, 163, 165, 166,
172, 175, 176, 179, 180, 181, 182
December 31st 159, 160
553
Index
Defines 122
Dt.getSecondOfDay 182
Desaturates
rendering 308
Dt.getYear 165
Desaturates 308
Device-dependent color 297
Different illuminants 297
DifModuleName 265
DifMy Data 265
DifXMLDataInput1 data.xml 265
Directory 283
Dividing
26/8 40
Dividing 40
double
double syntax and examples 84, 85, 86, 87,
88, 90, 91
double 76, 83, 84, 85, 86, 87, 88, 90, 91,
151, 159
Double aP1 84, 85, 86, 87
Double d 84, 85, 86, 87, 88, 90, 159
Double toDouble 76, 151, 159
driver configuration 263
Driverconfigname 263
Dt.Day 172
Dt.Days 160, 176, 180, 182
Dt.getDay 161
Dt.getDayOfWeek 172
Dt.getDays 159
Dt.getMillisecond 180
Dt.Month 172
Dt.setDays 160
Dt.setHour 175
Dt.setMillisecond 181
Dt.setSecond 179
Dt.setYear 166
Dt.toDouble 159
Dt.Year 172
Dutch Post 226
E 105, 132
E 132, 140, 255, 265
E EngineName 263
E PDF 259
E.g 265, 298, 306
EAN 128 227
EAN13 230
EAN8 233
Ec engineconfigname 263
Else Statements 23
End
Appends aString 127
End 127
EndWith 144
Engine 264
engine configuration 263
Engine Specific Commands 264
Dt.getMinute 176
Dt.getMonth 163
554
A29247-X89-X-3-7678
Index
environment 95, 97, 105, 107, 108, 111, 113,
114, 115, 118, 119, 120, 132, 138, 139, 143,
144
Environmental Variables 283
Example 27, 38, 40, 42, 57, 58, 59, 82, 85,
86, 87, 97, 122, 127, 132, 140, 148, 159, 165,
175, 179, 181, 306
Expr 23, 27
Expressions 14
F 27
F outputfilename.pdf 259
F TestOutput.pdf 259
F+i 27
False 82, 148
File 283
Filename.csv 265
FindCaseInsensitive 132
Flow Control Conditional Constructs 22
flows 22, 23
Fontcache.dat file 283, 287
From 283, 302
Full 221, 297
Full ASCII 221
Full Color 297
Full Color Overview 297
Functions 298
G 265
gamut 297, 298, 306, 307, 308
General 259
General Commands 259
GetDay 161
GetDayOfWeek 172
GetDays 159
GetLength 95
GetMilisecondOfDay 184
GetMillisecond 180
GetMinute 176
GetMonth 163
GetSecondOfDay 182
GetYear 165
Ghijk 127
Goto Statement 32
Hello WORLD 123
HSB 302
HSB color space 302
I!c.toInt 82
I.binaryNot 35, 46
I.binaryOr 42, 53
I.binaryXor 42, 63
I.divide 60
I.e 283
I.multiply 38, 49, 59
I.remainder 40
I.toString 95, 132, 140
I1 36, 37, 48, 57, 58
I1.minus 37, 48, 58
I1.plus 36, 57
IATA 199
ICC 297, 299
Get 96, 306
A29247-X89-X-3-7678
555
Index
ICC profiles 299
Int binaryNot 35
ICM 297
Int compare 123
Identify 302
Int compareCaseInsensitive 124
IF 23
Int countOccurrences 140
images 297, 306, 308
Int countOccurrencesCaseInsensitive 141
Incrementation 27
Int f 27
Index 132
Int find 130
Industrial 201
Int findBackwards 134
insert 125
Int findBackwardsCaseInsensitive 136
Int 27, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43,
57, 58, 59, 60, 61, 62, 63, 64, 71, 72, 73, 74,
80, 82, 85, 86, 87, 90, 95, 97, 123, 124, 130,
132, 134, 136, 140, 141, 149, 154, 159, 161,
163, 165, 167, 172, 174, 175, 176, 178, 179,
180, 181, 182
Int findCaseInsensitive 132
Int aDays 160
Int aFromIndex 105
Int aHour 175
Int aIndex 132
Int aInt 97
Int aLength 102
Int aMillisecond 181
Int aMinDecimalPlaces 88
Int aP1 36, 37, 38, 40, 42, 57, 58, 59, 60, 63,
69, 84, 85, 86, 87
Int getDay 161
Int getDayOfWeek 172
Int getDayOfYear 167
Int getDays 159
Int getHour 174
Int getLength 95
Int getMillisecond 180
Int getMinute 176
Int getMonth 163
Int getSecond 178
Int getSecondOfDay 182
Int getYear 165
Int i1 36, 37
Int aP2 69
Int n 23, 27
Int aPrecission 88
Int toInt 64, 74, 90, 149, 154
Int aSecond 179
Int64 44, 46, 47, 48, 49, 50, 51, 52, 53, 54,
55, 57, 58, 59, 60, 61, 62, 63, 64, 75, 85, 86,
87, 91, 150, 151
Int aTimes 105
Int aWidth 107
Int aYear 166
556
Int64 aP1 48, 49, 53, 84, 85, 86, 87
Int64 binaryNot 46
A29247-X89-X-3-7678
Index
Int64 i1 48, 57, 58
Maxi Code 236
Int64 toInt64 75, 91, 150
Micro PDF 417#Ratio 239
integer syntax and examples 35, 36, 37, 38,
39, 40, 41, 42
modules 259, 265, 266, 267
integer64 syntax and examples 46, 47, 48,
49, 50, 51, 52, 53, 54, 55, 57, 58, 59, 60, 61,
62, 63, 64
Integrated
rest 297
Multiple 268
Multiple Output 268
My Data 265
My Sample Variable 259
Integrated 297
N
Value 23
Intents 305
N 23, 27
Interleaved#Leitcode 203
N.toString 23
International Color Consortium 297
Name 284, 302, 306
Japan Post 235
New 29
Job/production 259
New Topic 29
L logfilename.log 259
Notes 283
LAB 297, 303
O MyOutput1 259
Lightness 302
OMR 241
Line Parameters 278
On 132
Lines 122, 278
Operators 15
Lnt 140
Output 261, 262, 263
Log 188, 189, 190
output commands 261, 263
Logfilename 259
param input module 266
LogMessage 23
Parameter 284
LogWarning 23
Parameter_1 259
MakeEmpty 108
Parameter_2 259
MakeLowerCase 113, 114
Parameter_x 259
MakeTitleCase 111
ParamInput Module 266
Management 297
Pc printerconfigname 263
Match 306
PDF 242
Matrix 206
Perceptual 308
A29247-X89-X-3-7678
557
Index
PnetT.cfg file 283, 287
PnetT.exe 278, 283
PNETT_DIR 287
PNETT_DIR Variable 287
Pnettc MySample.wfd 259
PnetTC.exe 259
Post Net 246
printer configuration 263
Printers’ gamut 306
PrintNet™ Transactional 259, 283, 287
production 279, 281
Production Mode 279
proof 307
Pug1 263
Pug2 263
Pug3 263
QR 244
RecordFilter 267
Reflect 302
Relative Colorimetric 307
remove 115, 118, 119, 120, 126
Removes leading 115, 118, 119, 120
Rendering
desaturates 308
Rendering 308
rendering intent 305, 306, 308
Repetitive Constructs 22
Rest
Integrated 297
Rest 297, 306
558
Result
bitwise 53
Result 38, 40, 42, 53, 57, 58, 59, 82, 85, 86,
87, 97, 122, 127, 132, 140, 148, 159, 165
Return Statement 33
RGB 297, 298, 301
RightJustify 107
Royal Mail 250
S.append 69, 88
S.beginWithCaseInsensitive 143
S.contains 138
S.containsCaseInsensitive 139
S.countOccurrences 140
S.endWith 144
S.findCaseInsensitive 132
S.getLength 95
S.makeEmpty 108
S.makeLowerCase 113
S.makeTitleCase 111
S.plus 122
S.prepend 69, 88, 122
S.replace 105
S.right 102
S.rightJustify 107
S.set 97
S.toBool 148
S.toDouble 151
S.toLowerCase 114
S.toWhiteSpaceReduced 122
S1
A29247-X89-X-3-7678
Index
String 115, 118, 119, 120, 123
S1 115, 118, 119, 120, 123, 127
128, 129, 130, 132, 134, 136, 138, 139,
140, 141, 142, 143, 144, 145, 146, 147,
148, 149, 150, 151, 152
S1.append 127
S1.compare 123
S1.plus 115, 118, 119, 120
S1.toWhiteSpaceLeftTrimmed 118, 120
S1.trimLeftWhiteSpace 119
S1.trimWhiteSpace 115
S2
String 115, 118, 119, 120, 123
S2 115, 118, 119, 120, 123, 127
S2.compare 123
S2.toWhiteSpaceRightTrimmed 118, 120
S2.trimRightWhiteSpace 119
S2.trimWhiteSpace 115
Saturation 309
scripting
syntax and examples
bool 78, 79, 80, 81, 82
Second
DateTime 180
Second 179, 180, 181
Select 262
Set
aTruncate 107
Set 97, 107, 175, 179, 181
SetDays 160
SetHour 175
SetMillisecond 181
SetSecond 179
SetYear 166
Shbeg 263
Simple 279
SINGLE 138, 139, 140, 143
Single environment 105, 111, 113, 114, 140
currency 66, 67, 68, 69, 71, 72, 73, 74,
75, 76
Specify 27, 85, 86, 87, 159, 165, 175, 179,
181
date/time 158, 159, 160, 161, 162, 163,
164, 165, 166, 167, 168, 169, 172, 173,
174, 175, 176, 177, 178, 179, 180, 181,
182, 183, 184, 185
Specifying thee 165
double 84, 85, 86, 87, 88, 90, 91
Int 35, 36, 37, 38, 39, 40, 41, 42
Int64 46, 47, 48, 49, 50, 51, 52, 53, 54,
55, 57, 58, 59, 60, 61, 62, 63, 64
string 95, 96, 97, 98, 99, 100, 101, 102,
103, 105, 106, 107, 108, 109, 110, 111,
112, 113, 114, 115, 116, 117, 118, 119,
120, 121, 122, 123, 124, 125, 126, 127,
A29247-X89-X-3-7678
Specifying_the_Folder_for_Configuration_an
d_Cache_Files 282
Statement 19, 23, 25, 27, 30, 31, 32
Statistics 262
String aReplaceWith 105
String getPart 146
String getWord 147
String left 101
String mid 103
559
Index
String right 102
True 27, 148
string syntax and examples 95, 96, 97, 98,
99, 100, 101, 102, 103, 105, 106, 107, 108,
109, 110, 111, 112, 113, 114, 115, 116, 117,
118, 119, 120, 121, 122, 123, 124, 125, 126,
127, 128, 129, 130, 132, 134, 136, 138, 139,
140, 141, 142, 143, 144, 145, 146, 147, 148,
149, 150, 151, 152
TSD 287
String toLowerCase 114
user groups 263
String toString 43, 55, 69, 82, 88, 155, 158
Using
Current Folder 283
String toTitleCase 112
String toUpperCase 110
String toWhiteSpaceLeftTrimmed 118
String toWhiteSpaceReduced 122
String toWhiteSpaceRightTrimmed 120
String toWhiteSpaceTrimmed 116
Super Stealth-Dots 248
System Control Panel 287
tabs 115, 118, 119, 120, 122
Test 27
ToBool 148
ToDouble 151, 159
Toend 263
ToInt 90
ToString 69, 82, 88, 155
ToWhiteSpaceLeftTrimmed 118
ToWhiteSpaceReduced 122
ToWhiteSpaceRightTrimmed 120
transformations 306
TrimRightWhiteSpace 119
TrimWhiteSpace 115
Tsd files 283
Unicode 123
UPC 252
UPCE E 255
Using 283, 284
Value aP1 38, 40, 57, 58, 59
variables 27, 259, 287, 288
view 297
Void append 127
Void binaryAnd 42, 53
Void binaryOr 41, 52, 62
Void binaryXor 42, 54, 63
Void divide 39, 50, 60, 87
Void fill 100
Void getDMY 169
Void getHMS 173
Void insert 125
Void leftJustify 106
Void logError 190
Void logMessage 188
Void logWarning 189
Void makeEmpty 108
Void makeLowerCase 113
Void makeTitleCase 111
Void makeUpperCase 109
560
A29247-X89-X-3-7678
Index
Void minus 37, 48, 58, 67, 72, 85
Void setSecondOfDay 183
Void multiply 38, 49, 59, 68, 73, 86
Void setYear 166
Void plus 36, 47, 57, 66, 71, 84
Void trimLeftWhiteSpace 117
Void prepend 128
Void trimRightWhiteSpace 119
Void reduceWhiteSpace 121
Void trimWhiteSpace 115
Void remainder 40, 51, 61
Void truncate 99
Void remove 126
WHILE 27
Void replace 105
White 122, 302
Void rightJustify 107
WITH 23
Void set 97
WITHOUT 23
Void setDay 162
Workflow 265, 284
Void setDayOfYear 168
Workflow file 284
Void setDays 160
Workflow module 259
Void setHour 175
Workflow_filename 259
Void setLength 129
Workflow_path 259
Void setMilisecondOfDay 185
WYSIWYG 297
Void setMillisecond 181
XML
XML data input module 265
Void setMinute 177
Void setMonth 164
Void setSecond 179
A29247-X89-X-3-7678
XML 265
XML Data Input 265
561

String toString - Océ | Printing for Professionals

Transcription

Similar documents

Flemish String Board Attachment

gruffalo`s child

Nesting Structure Design by Toronto Region Conservation Authority

Making String Heddles for the Gilmore Inkle Loom

sponsorship package

Knotted Friendship Bracelet

P15/S1546/FUL - 1 Coopers Close, Littleworth

Outbound

Scout Skills – Camp Gadgets

the ultimate guitarist`s upgrade manual