Inspire Designer 8.

1
User Manual

GMC Software AG
2011 GMC Software AG. All rights reserved.
Inspire Designer 8.1
User Manual
Release date: December 2011
Document version: 8.1.0.2

GMC Software AG
www.gmc.net

Should you have any queries, suggestions or comments concerning these materials, please do
not hesitate to contact us at [email protected].

This document contains information classified as Public.

The GMC Software Group of companies are ISO 9001:2008 certified.

Copyright
Information contained within this document may contain technical inaccuracies or typograph-
ical errors. Changes will be added periodically and modifications will be made thereto without
prior notification. GMC Software AG does not enter into any obligations or responsibilities re-
garding the content of this document and does not assume any legal liability neither expressed
or implied for its accuracy, completeness and/or usefulness.

Copying of the software or manual on to any data storage medium or in any other way, except
for explicit company internal use, is strictly forbidden without the prior written authorization
of GMC Software AG. Failure to comply with these restrictions is liable to prosecution.

Trademarks
GMC Software Technology and its logo are trademarks and service
marks of GMC Software AG registered in Switzerland, the US and
numerous other countries.

Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems
Inc. in the US and other countries. The names of other companies, products and services are
the property of their respective owners.

2011 GMC Software AG. All rights reserved.

Table of Contents

1 Welcome to Inspire Designer 1

1.1 Inspire Designer Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 What's New 5
2.1 8.1 Highlights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1.1 Personalized Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1.2 Advanced Campaign Control with Approval States . . . . . . . . . . . 8
2.2 Further New 8.1 Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3 Changes in Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Enhancements in Documentation . . . . . . . . . . . . . . . . . . . . . . . 18

3 Starting the Application 19

3.1 Startup Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.2 Opening Existing WFD Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.2.1 Version Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.2.2 Used Files Update Dialog . . . . . . . . . . . . . . . . . . . . . . . . 22

4 Workflow 25
4.1 Workflow Window Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.1.1 Workflow Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.1.2 Workflow Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4.2 Workflow Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.2.1 File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.2.2 Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.2.3 Workflow Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.2.4 Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
4.2.5 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.3 Workflow Window Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.3.1 Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
4.3.2 Zoom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.3.3 Alignment Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4.4 Module Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.5 Workflow Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table of Contents

4.5.1 General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

4.5.2 General Workflow Options . . . . . . . . . . . . . . . . . . . . . . . 63
4.5.3 Current Workflow Options . . . . . . . . . . . . . . . . . . . . . . . 65
4.6 Debug Data Window-Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
4.7 Label Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
4.7.1 Label Context Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 94
4.7.2 Edit Label Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
4.8 Profile Data Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
4.9 Templates Window-Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
4.10 Verify Window-Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
4.11 Compare Workflows Window-Pane . . . . . . . . . . . . . . . . . . . . . 99
4.11.1 Compare Workflows Context Menu . . . . . . . . . . . . . . . . . 99
4.12 Cross Reference Browser . . . . . . . . . . . . . . . . . . . . . . . . . . 100
4.13 Used Files Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
4.13.1 Used Files Context Menu . . . . . . . . . . . . . . . . . . . . . . 104
4.14 How to Create a Workflow . . . . . . . . . . . . . . . . . . . . . . . . . 105
4.14.1 Manual Workflow Construction . . . . . . . . . . . . . . . . . . . 106
4.14.2 New Workflow Dialog . . . . . . . . . . . . . . . . . . . . . . . . 107
4.14.3 Workflow Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . 109

5 Data Input Modules 111

5.1 Data Input Modules Overview . . . . . . . . . . . . . . . . . . . . . . . . . 112
5.2 Data Generator Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.3 Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.3.1 Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.3.2 Multiple Record Type Files . . . . . . . . . . . . . . . . . . . . . . 135
5.4 External Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.5 Internal Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
5.6 Line Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
5.6.1 Line Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . 146
5.6.2 Line Data Input Objects . . . . . . . . . . . . . . . . . . . . . . . . 153
5.6.3 First Steps in the Line Data Input Module . . . . . . . . . . . . . . . 176
5.7 ODBC Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.7.1 How to Connect to an ODBC / Native Oracle Source . . . . . . . . . 185
5.7.2 How to Define Variable Substitutions . . . . . . . . . . . . . . . . . 186
5.8 Param Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.9 Data Center Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.10 SAP Data Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
5.10.1 Input File Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.10.2 Data Structure Tab . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.10.3 Data Mapping Tab . . . . . . . . . . . . . . . . . . . . . . . . . . 198
5.11 Script Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . 199
5.12 XML Data Input Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
5.12.1 XML Data Input Module . . . . . . . . . . . . . . . . . . . . . . . 203
5.12.2 XML Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

iv
 Table of Contents

6 Data Processing Modules 215

6.1 Data Processing Modules Overview . . . . . . . . . . . . . . . . . . . . . . 216
6.2 1-Many Merger Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
6.3 1-1 Merger Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
6.4 AFP Index Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
6.4.1 Index Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
6.4.2 Medium Maps Tab . . . . . . . . . . . . . . . . . . . . . . . . . . 228
6.5 Check21 Reader Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
6.6 Data Add Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
6.7 Data Cacher Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
6.8 Data Combiner Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
6.9 Data Concatenator Module . . . . . . . . . . . . . . . . . . . . . . . . . . 233
6.10 Data Field Renamer Module . . . . . . . . . . . . . . . . . . . . . . . . . 235
6.11 Data Filter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
6.12 Data Group By Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
6.13 Data Histogram Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
6.14 Data Pass Through Module . . . . . . . . . . . . . . . . . . . . . . . . . 241
6.15 Data Precise Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
6.15.1 Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
6.15.2 Script Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
6.15.3 Metric Shortening Tab . . . . . . . . . . . . . . . . . . . . . . . . 252
6.15.4 Knowledge Files Tab . . . . . . . . . . . . . . . . . . . . . . . . . 253
6.16 Data Remapper Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
6.17 Data Repeater Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
6.18 Data Sorter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
6.19 Data Caser Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
6.20 Data Transformer Module . . . . . . . . . . . . . . . . . . . . . . . . . . 262
6.20.1 Data Transformer Module . . . . . . . . . . . . . . . . . . . . . . 262
6.20.2 Field Converters . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
6.21 Data UnGroup Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
6.22 Email Gateway Data Module . . . . . . . . . . . . . . . . . . . . . . . . 310
6.23 MinMax Generator Module . . . . . . . . . . . . . . . . . . . . . . . . . 312
6.24 PDF Data Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
6.24.1 Input File Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
6.24.2 Bookmarks Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
6.24.3 Page Boundaries Tab . . . . . . . . . . . . . . . . . . . . . . . . 317
6.25 PCL Data Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
6.25.1 Input File Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
6.25.2 Data Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
6.25.3 How to Use PCL Data Module . . . . . . . . . . . . . . . . . . . . 321
6.26 Personalized URL Module . . . . . . . . . . . . . . . . . . . . . . . . . . 322
6.26.1 General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
6.26.2 Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
6.27 Record Filter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
6.28 Data Center Merger Module . . . . . . . . . . . . . . . . . . . . . . . . . 327
6.29 Social Data Connector Module . . . . . . . . . . . . . . . . . . . . . . . 329

v
Table of Contents

6.30 Text Replacer Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

6.31 Data Merging Modules Comparison . . . . . . . . . . . . . . . . . . . . . 336

7 Layout Module 343

7.1 Layout Window Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
7.2 Layout Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
7.2.1 File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
7.2.2 Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
7.2.3 Page Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
7.2.4 View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
7.2.5 Insert Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
7.2.6 Format Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
7.2.7 Table Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
7.2.8 Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
7.2.9 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
7.3 Layout Window Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
7.3.1 Tools Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
7.3.2 Object Order Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . 364
7.3.3 Object Grouping Toolbar . . . . . . . . . . . . . . . . . . . . . . . 365
7.3.4 Object Alignment Toolbar . . . . . . . . . . . . . . . . . . . . . . . 366
7.3.5 Text Format Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . 366
7.3.6 Paragraph Style Toolbar . . . . . . . . . . . . . . . . . . . . . . . . 368
7.3.7 Zooming Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
7.3.8 Page Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
7.3.9 Vertical Alignment Toolbar . . . . . . . . . . . . . . . . . . . . . . 371
7.3.10 Multiple Flow Toolbar . . . . . . . . . . . . . . . . . . . . . . . . 371
7.3.11 Debug Variables Toolbar . . . . . . . . . . . . . . . . . . . . . . . 371
7.3.12 Path Object Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . 372
7.4 Layout Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
7.4.1 Layout Tree Context Menus . . . . . . . . . . . . . . . . . . . . . . 375
7.5 Layout Properties Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
7.6 Layout Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
7.6.1 Layout Objects Overview . . . . . . . . . . . . . . . . . . . . . . . 378
7.6.2 Common Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
7.6.3 Anchors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
7.6.4 Barcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
7.6.5 Border Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
7.6.6 Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
7.6.7 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
7.6.8 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
7.6.9 Data Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
7.6.10 Effect Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
7.6.11 Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
7.6.12 Element Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
7.6.13 Embedded Object Areas . . . . . . . . . . . . . . . . . . . . . . . 554
7.6.14 External Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
7.6.15 Fill Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563

vi
 Table of Contents

7.6.16 Flows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566

7.6.17 Flow Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
7.6.18 Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
7.6.19 Glyph Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
7.6.20 Gradients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
7.6.21 Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
7.6.22 Image Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
7.6.23 Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
7.6.24 Line Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
7.6.25 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
7.6.26 Message Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
7.6.27 Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
7.6.28 Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
7.6.29 Paragraph Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
7.6.30 Plugin Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
7.6.31 Scripted Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
7.6.32 Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
7.6.33 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
7.6.34 Text On Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
7.6.35 Text Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
7.7 Layout Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
7.7.1 General Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
7.7.2 Global Layout Modules Options . . . . . . . . . . . . . . . . . . . 837
7.7.3 Current Layout Module Options . . . . . . . . . . . . . . . . . . . 853
7.7.4 Current Workflow Options . . . . . . . . . . . . . . . . . . . . . . 856
7.8 Other Helpful Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
7.8.1 Arabic, Hebrew, Indic Languages Support . . . . . . . . . . . . . . 856
7.8.2 Bullets and Numbering . . . . . . . . . . . . . . . . . . . . . . . . 859
7.8.3 Clone Selected Objects . . . . . . . . . . . . . . . . . . . . . . . . 865
7.8.4 Copy and Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
7.8.5 Find Object Uses . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
7.8.6 Find/Replace Text Palette . . . . . . . . . . . . . . . . . . . . . . . 876
7.8.7 Find Unused Objects . . . . . . . . . . . . . . . . . . . . . . . . . 877
7.8.8 Insert Character Palette . . . . . . . . . . . . . . . . . . . . . . . . 879
7.8.9 Navigation in Layout . . . . . . . . . . . . . . . . . . . . . . . . . 880
7.8.10 Quick Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . 883
7.8.11 Spell Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
7.8.12 Transform Selected Objects . . . . . . . . . . . . . . . . . . . . . 887
7.8.13 Undo/Redo Palette . . . . . . . . . . . . . . . . . . . . . . . . . . 889

8 Impositioning Modules 893

8.1 Impositioning Modules Overview . . . . . . . . . . . . . . . . . . . . . . . 894
8.2 Booklet Maker Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
8.2.1 Booklet Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
8.3 Group Filter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
8.4 Imposition Script Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 907

vii
Table of Contents

8.4.1 Imposition Script Module . . . . . . . . . . . . . . . . . . . . . . . 907

8.4.2 Impositioning Script Types and Methods . . . . . . . . . . . . . . . 913
8.5 Marks Inserter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
8.6 Media Pattern Filter Module . . . . . . . . . . . . . . . . . . . . . . . . . 937
8.7 Region Binder Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
8.7.1 How to Create the Configuration File . . . . . . . . . . . . . . . . . 940
8.8 Saddle Stitch Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
8.9 Select N Groups Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
8.10 Sheet Aligner Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
8.11 Sheet Backgrounder Module . . . . . . . . . . . . . . . . . . . . . . . . 948
8.12 Sheet Concatenator Module . . . . . . . . . . . . . . . . . . . . . . . . . 949
8.13 Sheet Content Modifier Module . . . . . . . . . . . . . . . . . . . . . . . 949
8.14 Sheet Duplexer Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
8.15 Sheet Duplicator Module . . . . . . . . . . . . . . . . . . . . . . . . . . 957
8.16 Sheet Filter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
8.17 Sheet Inserter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
8.18 Sheet Mixer Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
8.19 Sheet Multiplexer Module . . . . . . . . . . . . . . . . . . . . . . . . . . 964
8.20 Sheet NS Splitter Module . . . . . . . . . . . . . . . . . . . . . . . . . . 965
8.21 Sheet Padder Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
8.22 Sheet Regrouper Module . . . . . . . . . . . . . . . . . . . . . . . . . . 970
8.22.1 By Group Count . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
8.22.2 By Sheet Count . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
8.22.3 Single Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
8.22.4 By Sheet Name Change . . . . . . . . . . . . . . . . . . . . . . . 973
8.22.5 By Sheet Name Condition . . . . . . . . . . . . . . . . . . . . . . 974
8.23 Sheet Sorter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
8.24 Sheet Transformer Module . . . . . . . . . . . . . . . . . . . . . . . . . 978
8.25 Simple N-Upper Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
8.26 Text in Rect Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
8.26.1 Scripting Methods in Text in Rect Module . . . . . . . . . . . . . . 986
8.26.2 How to Set a Cross-Rectangle Condition . . . . . . . . . . . . . . 987
8.26.3 Reading Barcodes . . . . . . . . . . . . . . . . . . . . . . . . . . 987
8.26.4 Calculating the Bounding Box . . . . . . . . . . . . . . . . . . . . 988

9 Output Modules 991

9.1 Output Modules Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 992
9.2 Advanced Data Output Module . . . . . . . . . . . . . . . . . . . . . . . . 993
9.3 Data Output Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
9.4 Job Reporter Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
9.4.1 How to Input Page Weights from a CSV File . . . . . . . . . . . . 1007
9.5 Output Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
9.5.1 Output Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
9.5.2 AFP Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
9.5.3 HTML Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . 1027
9.5.4 HTML Simple Device Profiles . . . . . . . . . . . . . . . . . . . . . 1029
9.5.5 IJPDS Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1031

viii
 Table of Contents

9.5.6 IPDS Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1034

9.5.7 Metacode Device Profiles . . . . . . . . . . . . . . . . . . . . . . 1036
9.5.8 MIBF Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1037
9.5.9 NexPress VDX Device Profiles . . . . . . . . . . . . . . . . . . . . 1038
9.5.10 PCL Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1039
9.5.11 PDF Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1045
9.5.12 PostScript Device Profiles . . . . . . . . . . . . . . . . . . . . . . 1054
9.5.13 PPML Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . 1056
9.5.14 VIPP Device Profiles . . . . . . . . . . . . . . . . . . . . . . . . . 1061
9.5.15 Finishing Operations Illustration . . . . . . . . . . . . . . . . . . 1066
9.5.16 Rotation Samples . . . . . . . . . . . . . . . . . . . . . . . . . . 1067
9.6 Data Center Output Module . . . . . . . . . . . . . . . . . . . . . . . . . 1069
9.7 Sheet Statistic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
9.8 Statistic Data Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076
9.8.1 Sheet Names Tab . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
9.8.2 Basic Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079

10 Other Modules 1085

10.1 Authentication Library Module . . . . . . . . . . . . . . . . . . . . . . . 1086
10.1.1 Twitter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
10.1.2 Facebook Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087
10.2 Event Script Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
10.2.1 How to Use the Event Script Module . . . . . . . . . . . . . . . . 1089
10.3 Inspire Native Module . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
10.3.1 Inspire Native Module . . . . . . . . . . . . . . . . . . . . . . . 1090
10.3.2 How to Use Inspire Native . . . . . . . . . . . . . . . . . . . . . 1095
10.4 Data Center Config Module . . . . . . . . . . . . . . . . . . . . . . . . 1099
10.5 Script Library Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
10.6 Template Merger Module . . . . . . . . . . . . . . . . . . . . . . . . . 1102
10.6.1 Template Merger Module . . . . . . . . . . . . . . . . . . . . . 1102
10.6.2 Template Merger Options Dialog . . . . . . . . . . . . . . . . . 1109
10.6.3 How to Add Variables to HTML . . . . . . . . . . . . . . . . . . 1110
10.7 Workflow Gate and External Workflow Modules . . . . . . . . . . . . . 1113
10.7.1 Introduction to Workflow Gate and External Workflow . . . . . . 1113
10.7.2 Workflow Gate Module . . . . . . . . . . . . . . . . . . . . . . 1117
10.7.3 External Workflow Module . . . . . . . . . . . . . . . . . . . . . 1118
10.8 XSLFO Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123
10.8.1 Known Limitations . . . . . . . . . . . . . . . . . . . . . . . . . 1124

11 Proof 1127
11.1 Proof Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
11.1.1 Sheet Proof Window . . . . . . . . . . . . . . . . . . . . . . . . 1129
11.2 Sheet Proof Window Menu . . . . . . . . . . . . . . . . . . . . . . . . 1130
11.2.1 Proof Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
11.2.2 Document Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
11.2.3 View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
11.2.4 Profile Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133

ix
Table of Contents

11.2.5 Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133

11.2.6 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
11.3 Sheet Proof Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
11.3.1 Tools Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
11.3.2 User Print Groups Toolbar . . . . . . . . . . . . . . . . . . . . . 1136
11.3.3 Print Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
11.3.4 Find Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
11.3.5 Module Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
11.3.6 Page Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
11.3.7 Zoom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
11.3.8 Proof Profiles Toolbar . . . . . . . . . . . . . . . . . . . . . . . . 1142
11.4 Data Proof Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
11.4.1 Data Proof Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
11.4.2 Data Proof Toolbars . . . . . . . . . . . . . . . . . . . . . . . . 1143
11.5 Proof Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
11.5.1 General Options . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
11.5.2 General Proof Options . . . . . . . . . . . . . . . . . . . . . . . 1146
11.6 Proof Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
11.6.1 Proof Profile Toolbar . . . . . . . . . . . . . . . . . . . . . . . . 1149
11.6.2 Vector Proof Profile Dialog . . . . . . . . . . . . . . . . . . . . . 1150
11.6.3 Raster Proof Profile Dialog . . . . . . . . . . . . . . . . . . . . . 1153
11.6.4 HTML and HTML Simple Proof Profiles . . . . . . . . . . . . . . . 1156
11.7 Sheet Info Window-Pane . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
11.8 Print from Proof Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157

12 Production 1161
12.1 Production Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1162
12.1.1 Opening the Production Environment . . . . . . . . . . . . . . . 1162
12.1.2 Production Environment Structure . . . . . . . . . . . . . . . . . 1163
12.2 Main Production Window . . . . . . . . . . . . . . . . . . . . . . . . . 1163
12.3 Production Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . 1169
12.3.1 Production Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
12.3.2 Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
12.3.3 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
12.4 Engine Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
12.4.1 Engine Configuration Overview . . . . . . . . . . . . . . . . . . 1174
12.4.2 Adobe PostScript2 Engine Configuration . . . . . . . . . . . . . 1175
12.4.3 Adobe PostScript3 Engine Configuration . . . . . . . . . . . . . 1188
12.4.4 AFP Engine Configuration . . . . . . . . . . . . . . . . . . . . . 1188
12.4.5 Creo VPS Engine Configuration . . . . . . . . . . . . . . . . . . 1219
12.4.6 Desktop Printer Engine Configuration . . . . . . . . . . . . . . . 1231
12.4.7 Docx Engine Configuration . . . . . . . . . . . . . . . . . . . . . 1232
12.4.8 HP PPML Engine Configuration . . . . . . . . . . . . . . . . . . 1240
12.4.9 HTML Engine Configuration . . . . . . . . . . . . . . . . . . . . 1242
12.4.10 HTML Simple Engine Configuration . . . . . . . . . . . . . . . 1255
12.4.11 IJPDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
12.4.12 Image Engine Configuration . . . . . . . . . . . . . . . . . . . 1289

x
 Table of Contents

12.4.13 IPDS Engine Configuration . . . . . . . . . . . . . . . . . . . . 1292

12.4.14 Metacode Engine Configuration . . . . . . . . . . . . . . . . . 1309
12.4.15 MIBF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1321
12.4.16 Multi Engine Configuration . . . . . . . . . . . . . . . . . . . . 1331
12.4.17 NexPress VDX Engine Configuration . . . . . . . . . . . . . . . 1333
12.4.18 PCL Engine Configuration . . . . . . . . . . . . . . . . . . . . 1336
12.4.19 PDF Fixed Resolution Engine Configuration . . . . . . . . . . . 1343
12.4.20 PDF Engine Configuration . . . . . . . . . . . . . . . . . . . . 1349
12.4.21 Inspire Native Engine Configuration . . . . . . . . . . . . . . . 1376
12.4.22 Podi PPML Engine Configuration . . . . . . . . . . . . . . . . . 1379
12.4.23 Raster Engine Configuration . . . . . . . . . . . . . . . . . . . 1395
12.4.24 SWF Engine Configuration . . . . . . . . . . . . . . . . . . . . 1404
12.4.25 SX/AP Engine Configuration . . . . . . . . . . . . . . . . . . . 1409
12.4.26 Text Engine Configuration . . . . . . . . . . . . . . . . . . . . 1411
12.4.27 VIPP Engine Configuration . . . . . . . . . . . . . . . . . . . . 1415
12.5 Printer Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
12.5.1 Printer Configuration Overview . . . . . . . . . . . . . . . . . . 1426
12.5.2 AFP Printer Configuration . . . . . . . . . . . . . . . . . . . . . 1427
12.5.3 IPDS Printer Configuration . . . . . . . . . . . . . . . . . . . . . 1430
12.5.4 Metacode Printer Configuration . . . . . . . . . . . . . . . . . . 1432
12.5.5 PCL Printer Configuration . . . . . . . . . . . . . . . . . . . . . 1435
12.5.6 PDF Printer Configuration . . . . . . . . . . . . . . . . . . . . . 1440
12.5.7 PostScript Printer Configuration . . . . . . . . . . . . . . . . . . 1452
12.5.8 PPML Printer Configuration . . . . . . . . . . . . . . . . . . . . 1460
12.6 Driver Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
12.6.1 Driver Configuration Overview . . . . . . . . . . . . . . . . . . . 1463
12.7 Jobs Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
12.7.1 Workflow Section . . . . . . . . . . . . . . . . . . . . . . . . . 1477
12.7.2 Selected Job Status . . . . . . . . . . . . . . . . . . . . . . . . . 1477
12.8 Drivers Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
12.8.1 Selected Driver Status . . . . . . . . . . . . . . . . . . . . . . . 1479
12.9 Multiple Jobs Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 1479
12.9.1 Running Multiple Jobs . . . . . . . . . . . . . . . . . . . . . . . 1480
12.10 Workflow Parameters Window-Pane . . . . . . . . . . . . . . . . . . . 1481
12.11 Report File Config Dialog . . . . . . . . . . . . . . . . . . . . . . . . . 1482
12.12 Production Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . 1484
12.12.1 Production Options . . . . . . . . . . . . . . . . . . . . . . . . 1485
12.12.2 Simple Production Options . . . . . . . . . . . . . . . . . . . . 1488
12.12.3 Run on Remote Server Options . . . . . . . . . . . . . . . . . . 1489
12.12.4 PostScript RIP Speed Estimation . . . . . . . . . . . . . . . . . . 1490
12.13 Secure Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
12.13.1 Designing and Proofing . . . . . . . . . . . . . . . . . . . . . . 1492
12.13.2 Creating a Secure JOB File . . . . . . . . . . . . . . . . . . . . 1492
12.13.3 Printing a Secure Job . . . . . . . . . . . . . . . . . . . . . . . 1495
12.13.4 Additional Information on PGP . . . . . . . . . . . . . . . . . . 1495
12.14 Encrypted TNO Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496

xi
Table of Contents

13 Simple Production 1499

13.1 Driver Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
13.2 Job Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502
13.3 ICM Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1503

14 Global Features 1505

14.1 Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
14.1.1 Access Rights for All Workflow Modules . . . . . . . . . . . . . . 1506
14.1.2 Access Rights for Single Workflow Modules . . . . . . . . . . . . 1507
14.1.3 Access Rights for Layout Tree Objects . . . . . . . . . . . . . . . 1507
14.1.4 Edit Access Rights Dialog . . . . . . . . . . . . . . . . . . . . . . 1508
14.2 Customizable Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
14.3 Dithering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
14.3.1 Dithering Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
14.3.2 Edit Dithering Dialog . . . . . . . . . . . . . . . . . . . . . . . . 1517
14.3.3 Dithering Type Examples . . . . . . . . . . . . . . . . . . . . . . 1522
14.3.4 LUT Curve Examples . . . . . . . . . . . . . . . . . . . . . . . . 1523
14.3.5 Dithering Recommendations . . . . . . . . . . . . . . . . . . . . 1523
14.4 Docking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1524
14.5 File Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1526
14.5.1 File Import Overview . . . . . . . . . . . . . . . . . . . . . . . . 1526
14.5.2 Native Import to Layout . . . . . . . . . . . . . . . . . . . . . . 1531
14.5.3 Layout Objects from Imported Files . . . . . . . . . . . . . . . . 1535
14.5.4 RTF and DOC Import . . . . . . . . . . . . . . . . . . . . . . . . 1537
14.5.5 HTML Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1542
14.6 Find & Replace Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
14.7 ICC Profile Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1546
14.8 Language Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
14.8.1 Language Codes for Styles . . . . . . . . . . . . . . . . . . . . . 1547
14.8.2 Language Codes for Scripting . . . . . . . . . . . . . . . . . . . 1549
14.9 Log Window-Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
14.9.1 Log Window-Pane Context Menu . . . . . . . . . . . . . . . . . 1551
14.10 Open File Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
14.10.1 File Opening . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1553
14.10.2 View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
14.10.3 Favorite Folders . . . . . . . . . . . . . . . . . . . . . . . . . . 1555
14.11 Resize Barcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
14.12 Sheet Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
14.12.1 Sheet Names Tab . . . . . . . . . . . . . . . . . . . . . . . . . 1560
14.13 Text Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
14.13.1 Editing Single-byte Encoding Types . . . . . . . . . . . . . . . . 1563
14.13.2 Editing Double-byte or Mixed-byte Encoding Types . . . . . . . 1564
14.13.3 Setting Up Custom Text Encoding For Data Input . . . . . . . . 1565
14.13.4 File Structure of an Exported Codec . . . . . . . . . . . . . . . 1566
14.14 Title Bar Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1567
14.15 Video Capture Feature . . . . . . . . . . . . . . . . . . . . . . . . . . 1568

xii
 Table of Contents

14.15.1 Recording Your Work . . . . . . . . . . . . . . . . . . . . . . . 1569

14.15.2 Playing a Recording . . . . . . . . . . . . . . . . . . . . . . . . 1569
14.15.3 Player Description . . . . . . . . . . . . . . . . . . . . . . . . . 1570
14.16 Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1572
14.16.1 Warnings Config Dialog . . . . . . . . . . . . . . . . . . . . . 1572
14.16.2 Warnings/Errors Behavior . . . . . . . . . . . . . . . . . . . . . 1575
14.17 White Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
14.18 Workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1577
14.18.1 Manage Workspaces Dialog . . . . . . . . . . . . . . . . . . . 1578
14.18.2 Select Workspace Dialog . . . . . . . . . . . . . . . . . . . . . 1580
14.18.3 Mapped Directories . . . . . . . . . . . . . . . . . . . . . . . . 1580

15 Projects 1585
15.1 Projects Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
15.1.1 Working with a Project . . . . . . . . . . . . . . . . . . . . . . . 1586
15.1.2 Project Browser Window Overview . . . . . . . . . . . . . . . . . 1587
15.1.3 Project Browser Window Menu . . . . . . . . . . . . . . . . . . 1588
15.1.4 Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
15.2 Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1591
15.2.1 Working with Workflows . . . . . . . . . . . . . . . . . . . . . . 1591
15.2.2 Files Tab Context Menu . . . . . . . . . . . . . . . . . . . . . . 1592
15.2.3 File History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
15.2.4 Inspire Content Manager . . . . . . . . . . . . . . . . . . . . . . 1593
15.3 Public Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594
15.3.1 Creating Public Objects . . . . . . . . . . . . . . . . . . . . . . . 1594
15.3.2 Public Objects Tab . . . . . . . . . . . . . . . . . . . . . . . . . 1596
15.4 Resolving Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1597

16 Related Applications 1599

16.1 Inspire Content Manager . . . . . . . . . . . . . . . . . . . . . . . . . . 1600
16.1.1 Inspire Content Manager Overview . . . . . . . . . . . . . . . . 1600
16.1.2 Inspire Content Manager Window Menu . . . . . . . . . . . . . 1603
16.1.3 Basic Use of Inspire Content Manager . . . . . . . . . . . . . . . 1615
16.1.4 Inspire Content Manager Server Management . . . . . . . . . . 1621
16.1.5 Inspire Content Manager Administration . . . . . . . . . . . . . 1624
16.1.6 Approval States . . . . . . . . . . . . . . . . . . . . . . . . . . . 1645
16.1.7 Database Link . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647
16.1.8 Dependency Browser . . . . . . . . . . . . . . . . . . . . . . . . 1650
16.1.9 EMC Documentum . . . . . . . . . . . . . . . . . . . . . . . . . 1651
16.1.10 Enhanced Open Dialog . . . . . . . . . . . . . . . . . . . . . . 1654
16.1.11 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1655
16.1.12 History Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
16.1.13 Paths to Files in Content Manager . . . . . . . . . . . . . . . . 1657
16.1.14 Inspire Data Centers . . . . . . . . . . . . . . . . . . . . . . . 1659
16.1.15 MediaBin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
16.1.16 SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
16.1.17 How to Create and Use Branches . . . . . . . . . . . . . . . . . 1690

xiii
Table of Contents

16.1.18 How to Create and Use Labels . . . . . . . . . . . . . . . . . . 1693

16.1.19 Inspire Content Manager Web . . . . . . . . . . . . . . . . . . 1700
16.2 Inspire Production Server and Inspire Production Server Client . . . . . . 1707
16.2.1 Inspire Production Server Description . . . . . . . . . . . . . . . 1707
16.2.2 Inspire Production Server Console Client Description . . . . . . . 1713
16.2.3 Inspire Production Server Client Description . . . . . . . . . . . . 1716
16.2.4 Inspire Production Server Commands . . . . . . . . . . . . . . . 1724
16.3 PNetT.exe Command Line Parameters . . . . . . . . . . . . . . . . . . . 1741
16.3.1 Parameters Overview . . . . . . . . . . . . . . . . . . . . . . . . 1741
16.3.2 Specifying the Folder for Configuration and Cache Files . . . . . . 1743
16.3.3 Specifying the Language for the GUI . . . . . . . . . . . . . . . . 1743
16.3.4 Using Workflow File Name(s) as Parameter . . . . . . . . . . . . 1743
16.4 PNetTC.exe Console Application . . . . . . . . . . . . . . . . . . . . . . 1744
16.4.1 Inspire Production Console . . . . . . . . . . . . . . . . . . . . . 1744
16.4.2 Multiple Output . . . . . . . . . . . . . . . . . . . . . . . . . . 1769
16.5 Dithering Picker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1770
16.5.1 Image Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1771
16.5.2 Presets Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1772
16.5.3 Add Dithering Tab . . . . . . . . . . . . . . . . . . . . . . . . . 1773
16.6 Flow Translator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1774
16.6.1 Working Environment . . . . . . . . . . . . . . . . . . . . . . . 1775
16.6.2 Flow Translator Menu . . . . . . . . . . . . . . . . . . . . . . . 1775
16.6.3 How to Translate in Flow Translator . . . . . . . . . . . . . . . . 1777
16.7 Inspire Native Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1779
16.8 TNO Writer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1779
16.8.1 Adjusting TNO Writer Settings . . . . . . . . . . . . . . . . . . . 1779
16.8.2 Using TNO Writer . . . . . . . . . . . . . . . . . . . . . . . . . . 1780

17 Scripting 1783
17.1 Scripting Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1784
17.1.1 Script Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . 1784
17.1.2 Script Editor Dialog . . . . . . . . . . . . . . . . . . . . . . . . . 1790
17.1.3 Scripting Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . 1794
17.1.4 How to Use Script Wizard . . . . . . . . . . . . . . . . . . . . . 1795
17.2 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
17.2.1 Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
17.2.2 Assignment Statements . . . . . . . . . . . . . . . . . . . . . . 1797
17.2.3 Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
17.2.4 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
17.2.5 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
17.2.6 Running Script Within Another Script . . . . . . . . . . . . . . . 1801
17.2.7 Static Variables in Scripting . . . . . . . . . . . . . . . . . . . . . 1802
17.2.8 Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1803
17.2.9 Flow Control Conditional Constructs . . . . . . . . . . . . . . . 1806
17.2.10 Scripting Notes . . . . . . . . . . . . . . . . . . . . . . . . . . 1811
17.2.11 Substitute Characters . . . . . . . . . . . . . . . . . . . . . . . 1812

xiv
 Table of Contents

17.2.12 How to Declare Script Functions . . . . . . . . . . . . . . . . . 1814

17.2.13 How to Reference a Current Variable . . . . . . . . . . . . . . . 1816
17.3 General Content Model . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
17.3.1 Binary Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 1816
17.3.2 Bool Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 1820
17.3.3 Currency Methods . . . . . . . . . . . . . . . . . . . . . . . . . 1823
17.3.4 Data Input Methods . . . . . . . . . . . . . . . . . . . . . . . . 1827
17.3.5 DateTime Methods . . . . . . . . . . . . . . . . . . . . . . . . . 1830
17.3.6 Double Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1839
17.3.7 File Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1843
17.3.8 Char Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 1926
17.3.9 Int Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1928
17.3.10 Int64 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1934
17.3.11 logError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1940
17.3.12 logMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1940
17.3.13 logWarning . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1940
17.3.14 Math Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1941
17.3.15 ODBC Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1949
17.3.16 pauseAfterCurrentSheet . . . . . . . . . . . . . . . . . . . . . 1968
17.3.17 RRect Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
17.3.18 String Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
17.3.19 TypeKeeper . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2011
17.3.20 Util Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 2011
17.3.21 Workflow Methods . . . . . . . . . . . . . . . . . . . . . . . . 2081

18 Examples of Use 2087

18.1 Workflow Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2088
18.1.1 How to Apply Transformations . . . . . . . . . . . . . . . . . . . 2088
18.1.2 How to Create an Image Page Counter . . . . . . . . . . . . . . 2091
18.1.3 How to Make a Booklet of Groups with Variable Size . . . . . . . 2099
18.1.4 How to Print Pages in Reversed Order . . . . . . . . . . . . . . . 2100
18.1.5 How to Set NS Splitting . . . . . . . . . . . . . . . . . . . . . . 2103
18.1.6 How to Use the AFP Index Module . . . . . . . . . . . . . . . . . 2108
18.1.7 How to Use Error Recovery . . . . . . . . . . . . . . . . . . . . . 2113
18.1.8 How to Use File Content as a Variable . . . . . . . . . . . . . . . 2117
18.1.9 How to Use the Statistic Data Module . . . . . . . . . . . . . . . 2119
18.2 Layout Module Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 2122
18.2.1 How to Use First Fitting . . . . . . . . . . . . . . . . . . . . . . 2122
18.2.2 How to Code Conditional Flow in XML . . . . . . . . . . . . . . 2128
18.2.3 How to Create Custom Image Charts . . . . . . . . . . . . . . . 2136
18.2.4 How to Create Element Areas . . . . . . . . . . . . . . . . . . . 2139
18.2.5 How to Create Flow Areas Selected by Condition . . . . . . . . . 2141
18.2.6 How to Create Flow Content GroupedBy . . . . . . . . . . . . . 2142
18.2.7 How to Create Numbering Style in Imported RTF and DOC Files . 2143
18.2.8 How to Create or Modify a Border Style . . . . . . . . . . . . . . 2144
18.2.9 How to Create or Modify Text Styles and Paragraph Styles . . . . 2148
18.2.10 How to Create Scripted Areas . . . . . . . . . . . . . . . . . . 2150

xv
Table of Contents

18.2.11 How to Create a Simple Chart . . . . . . . . . . . . . . . . . . 2154

18.2.12 How to Create a Table Based on a CSV File . . . . . . . . . . . 2159
18.2.13 How to Export Design Parts for Usage on Web . . . . . . . . . . 2160
18.2.14 How to Generate a Table of Contents . . . . . . . . . . . . . . 2163
18.2.15 How to Make Conditional Flow . . . . . . . . . . . . . . . . . . 2169
18.2.16 How to Mark Script for HTML Simple . . . . . . . . . . . . . . . 2170
18.2.17 How to Repeat Layout Objects by Integer Variables . . . . . . . 2172
18.2.18 How to Use Superscript in Date Format . . . . . . . . . . . . . 2177
18.2.19 How to Use System Variables . . . . . . . . . . . . . . . . . . . 2179
18.3 Production Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2180
18.3.1 How to Assign TLE Indexes . . . . . . . . . . . . . . . . . . . . . 2180
18.3.2 How to Configure HP PPML for Indigo Devices . . . . . . . . . . 2182
18.3.3 How to Configure RIPs for IJPDS . . . . . . . . . . . . . . . . . . 2186
18.3.4 How to Handle Overlapping Heads . . . . . . . . . . . . . . . . 2193
18.3.5 How to Produce PS Hybrid Spool Files . . . . . . . . . . . . . . . 2194
18.3.6 How to Set IJPDS Overlapping Heads . . . . . . . . . . . . . . . 2197
18.3.7 How to Set IJPDS Cue Intervals from Size of Medium . . . . . . . 2201
18.3.8 How to Split PDF and Insert Bookmarks . . . . . . . . . . . . . . 2203
18.3.9 How to Use the Jog Option . . . . . . . . . . . . . . . . . . . . 2205
18.3.10 How to Use RIP Splitting . . . . . . . . . . . . . . . . . . . . . 2206
18.3.11 How to Use RIP Stitching . . . . . . . . . . . . . . . . . . . . . 2211
18.4 Complete Solution Examples . . . . . . . . . . . . . . . . . . . . . . . . 2214
18.4.1 How to Auto-Follow On Twitter . . . . . . . . . . . . . . . . . . 2214
18.4.2 How to Create and Send Personalized HTML Emails . . . . . . . . 2219
18.4.3 How To Spool Many PDFs to IJPDS . . . . . . . . . . . . . . . . . 2227

19 Appendices 2233
19.1 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
19.1.1 Mac Specific Information . . . . . . . . . . . . . . . . . . . . . . 2234
19.1.2 Processing in Inspire Designer . . . . . . . . . . . . . . . . . . . 2235
19.1.3 Substitution Characters . . . . . . . . . . . . . . . . . . . . . . 2242
19.1.4 Installation Directory Content . . . . . . . . . . . . . . . . . . . 2244
19.1.5 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
19.1.6 Tips and Tricks . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
19.2 Barcodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
19.2.1 2/5 Datalogic Barcode . . . . . . . . . . . . . . . . . . . . . . . 2253
19.2.2 2/5 IATA Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2255
19.2.3 2/5 Industrial Barcode . . . . . . . . . . . . . . . . . . . . . . . 2258
19.2.4 2/5 Interleaved Barcode . . . . . . . . . . . . . . . . . . . . . . 2260
19.2.5 2/5 Matrix Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2264
19.2.6 Australia Post Barcode . . . . . . . . . . . . . . . . . . . . . . . 2267
19.2.7 Aztec Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
19.2.8 Codabar Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
19.2.9 Code 128 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2274
19.2.10 Code 128 UPS Barcode . . . . . . . . . . . . . . . . . . . . . . 2278
19.2.11 Code 39 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2281
19.2.12 Code 39 (Full Ascii) Barcode . . . . . . . . . . . . . . . . . . . 2284

xvi
 Table of Contents

19.2.13 Code 93 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2287

19.2.14 Data Matrix Barcode . . . . . . . . . . . . . . . . . . . . . . . 2289
19.2.15 Dutch Post Barcode . . . . . . . . . . . . . . . . . . . . . . . . 2292
19.2.16 EAN 128 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2293
19.2.17 EAN 13 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2296
19.2.18 EAN 8 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2300
19.2.19 EAN / UCC Application Identifiers . . . . . . . . . . . . . . . . 2304
19.2.20 GS1 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308
19.2.21 Intelligent Mail (4-CB) Barcode . . . . . . . . . . . . . . . . . . 2311
19.2.22 Japan Post Barcode . . . . . . . . . . . . . . . . . . . . . . . . 2313
19.2.23 MaxiCode Barcode . . . . . . . . . . . . . . . . . . . . . . . . 2314
19.2.24 MicroPDF 417 Barcode . . . . . . . . . . . . . . . . . . . . . . 2317
19.2.25 OMR Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . 2320
19.2.26 PDF 417 Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2321
19.2.27 Planet Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
19.2.28 PostNet Barcode . . . . . . . . . . . . . . . . . . . . . . . . . 2325
19.2.29 QR Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328
19.2.30 Royal Mail Barcode . . . . . . . . . . . . . . . . . . . . . . . . 2330
19.2.31 Super Stealth-Dots Barcode . . . . . . . . . . . . . . . . . . . . 2332
19.2.32 UPC A Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2334
19.2.33 UPC E Barcode . . . . . . . . . . . . . . . . . . . . . . . . . . 2336
19.3 Color Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2339
19.3.1 Color Management Overview . . . . . . . . . . . . . . . . . . . 2339
19.3.2 ICC Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2340
19.3.3 Color Space Transformation Examples . . . . . . . . . . . . . . . 2362
19.3.4 Color Spaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2368
19.3.5 Rendering Intents . . . . . . . . . . . . . . . . . . . . . . . . . . 2370
19.4 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2372
19.4.1 CONFIG File Customizations . . . . . . . . . . . . . . . . . . . . 2372
19.4.2 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . 2385
19.4.3 How to Set System Defaults . . . . . . . . . . . . . . . . . . . . 2387
19.4.4 Operating System Customizations . . . . . . . . . . . . . . . . . 2388
19.4.5 JOB File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2389
19.5 Importing PrintNet 3 Jobs . . . . . . . . . . . . . . . . . . . . . . . . . 2608
19.5.1 Importing PrintNet 3 Jobs Overview . . . . . . . . . . . . . . . . 2608
19.5.2 Importing Barcodes from PrintNet 3 . . . . . . . . . . . . . . . . 2610
19.5.3 Functionality Missing in PrintNet 3 . . . . . . . . . . . . . . . . . 2611
19.5.4 Possible Issues when Importing from PrintNet 3 . . . . . . . . . . 2612
19.5.5 PTF Import Warnings . . . . . . . . . . . . . . . . . . . . . . . . 2613
19.5.6 Other Differences between PrintNet 3 and Inspire Designer . . . . 2614
19.6 IPDS Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2616
19.6.1 IPDS Exceptions Summary . . . . . . . . . . . . . . . . . . . . . 2616
19.6.2 Command - Reject Exceptions . . . . . . . . . . . . . . . . . . . 2616
19.6.3 Conditions Requiring Host Notification . . . . . . . . . . . . . . 2618
19.6.4 Data - Check Exceptions . . . . . . . . . . . . . . . . . . . . . . 2621
19.6.5 Equipment-Check Exceptions . . . . . . . . . . . . . . . . . . . 2625
19.6.6 Equipment Check with Intervention Required Exceptions . . . . . 2626

xvii
Table of Contents

19.6.7 Intervention-Required Exceptions . . . . . . . . . . . . . . . . . 2629

19.6.8 IPDS Exceptions Level Configuration Dialog . . . . . . . . . . . . 2638
19.6.9 Specification Check - Barcode Exceptions . . . . . . . . . . . . . 2639
19.6.10 Specification Check - General Exceptions . . . . . . . . . . . . . 2645
19.6.11 Specification Check - Graphics Data Exceptions . . . . . . . . . 2704
19.6.12 Specification Check - IO-Image Exceptions . . . . . . . . . . . . 2716
19.7 Tested Configurations for Printers . . . . . . . . . . . . . . . . . . . . . 2722
19.7.1 Tested Configurations in Version 8.1 . . . . . . . . . . . . . . . 2722
19.7.2 Tested Configurations in Version 8.0 . . . . . . . . . . . . . . . 2731
19.7.3 Tested Configurations in Version 7.0 . . . . . . . . . . . . . . . 2738
19.7.4 Recommendations and Special Settings . . . . . . . . . . . . . . 2751

Index 2759

xviii
1 Welcome to Inspire Designer

1.1 Inspire Designer Integration

1 Welcome to Inspire Designer

Inspire Designer is an all-in-one software application for the creation and production of variable-
data communications.

Based on an operating-system-independent architecture, Inspire Designer offers ease-of-use

combined with comprehensive design, data handling and production functionality.

Features

Single application for design, composition and production.

Multiple data formats (input and output) for integrity with many data storage systems.

Data integration with document composition for personalized communication.

Multiple electronic and print output formats to interact with customers via preferred
channels.

Instant electronic proofing for better quality control.

GUI interface to empower users and reduce required resources.

Broad-based operating system support including Windows, Mac, Linux, Solaris and AIX.

Ease of implementation to improve time-to-market and conversion from legacy applic-

ations.

Integration with the GMC products Inspire Email Gateway (Email Gateway), Inspire In-
teractive (PrintNet Interactive), Inspire Automation (PrintNet PA), Inspire Storefront
(PortalBuilder), Inspire Tracker (Click-Through Server) and Inspire Campaign Manager
(Campaign Manager) for complete solutions to personalized communication.

Inspire Designer is based in part on the FreeType Project.

This help file is designed to provide details about all of the individual features and options that
can be found throughout the GUI and is structured according the structure of the GUI environ-
ments. It is possible to access this information about individual features directly by using the
context help.

For another, more practical, approach that introduces the basic features of Inspire Designer,
there is also the separate Getting Started document. For release information about the current
version see the Release Notes document. For information on installation and licensing see the
Installation Guide.

2
 1.1 Inspire Designer Integration

1.1 Inspire Designer Integration

This section is intended to provide an overview of how Inspire Designer, including its command-
line production version (Inspire Production Console) and remote server version (Inspire Production
Server), can be integrated with further applications:

Optional

WFD templates
Inspire
Connect / Interactive

CSV, HTMLs,
attachments
Inspire Email
Gateway

WFDs, Data and

spool files
Inspire Automation

AFPs
Inspire Designer AFP2IPDS

WFD and spool

files
Inspire Approval

WFD, Data, font,

spool, image files
Inspire Content
Manager

TNO, AFP, PDF

and CSV
Inspire Consolidate

WFD
Inspire Storefront

Integration of Inspire Designer with further applications typically includes:

Inspire Connect uses Inspire Production Server (PNetTNetServer) to provide document

production services which are based on WFD templates created in Inspire Designer.

Inspire Interactive uses master templates (in the WFD format) designed in Inspire De-
signer. The documents which can be filled in Inspire Interactive are based on these
templates. The production of documents is ensured by Inspire Connect (PrintNet Connect)
and thus Inspire Production Server (PNetTNetServer).

Inspire Email Gateway can be used to send TXT/HTML email content created in Inspire
Designer; other output formats can be sent as an attachment. Further relevant data
can be provided in a CSV data file (e.g. recipients address, name, subject, etc.).

Inspire Automation automates production processes which includes the usage of Inspire
Production Console (PNetTC.exe) for processing data based on WFDs designed in Inspire
Designer.

AFP2IPDS converts and prints AFP files from Inspire Designer using the IPDS protocol.

3
1 Welcome to Inspire Designer

Inspire Approval can be used for proofing and approving files produced by Inspire
Designer. It supports the following file formats natively: WFD, PDF, TNO, AFP or EPS.
Proof images are generated using Inspire Connect (PrintNet Connect) and thus Inspire
Production Server (PNetTNetServer).

Inspire Content Manager stores and versions WFD files, data, fonts, spool files and
images used in Inspire Designer.

Inspire Consolidate used to sort documents in input files produced by Inspire Designer
(in the TNO, AFP, PDF or CSV format) to print runs according to the requirements of
the existing production environment (printers and enveloping machines).

Inspire Storefront employs WFD files created in Inspire Designer as a backbone for
the product wizards accessed by customers.

4
2 What's New

2.1 8.1 Highlights

2.2 Further New 8.1 Functionality
2.3 Changes in Default Settings
2.4 Enhancements in Documentation
2 What's New

2.1 8.1 Highlights

2.1.1 Personalized Catalogue
Imagine your customers receive newsletters and catalogues offering them only those products
that they are really interested in and which will thus immediately catch their attention. This is
now possible thanks to our sophisticated solution: online personalized catalogues, which allows
creating customized offers to users based on consumer information you have available in your
customer databases.

E.g., you can communicate offers concerning electronic devices to those customers that have
a record of purchasing this kind of goods, consumers predominantly interested in wines from
a certain region can be specifically addressed etc.

Your customers will enjoy reading these catalogues because they will be targeted directly to-
wards their needs and consumer habits.

What does it bring to enterprise customers

Relevant, highly targeted content

Optimized for a wide choice of viewing devices

What does it bring to enterprises

New communication/sales channel as an alternative to web sites

Engagement of customers via personalized targeting

Real-time targeting

Tracking of customer activity for evaluation and to make your future campaigns even
more successful

6
 2.1 8.1 Highlights

How it Works
Your customers receive an email with the link to their personal catalogue customized to their
interests. They can:

1. Click on the link and take a virtual tour of the personalized offers in the catalogue.

2. Check details of offers in pop-up windows.

3. Click on Buy in a pop-up which leads them to your web page where they can read
even more details about the offered products and order them directly.

You can then view the response tracking information (e.g. what products/links were clicked
on or whether the offer fits the customer's needs) and use it to improve the targeting of the
catalogue.

How it is Deployed
Technically, the solution is ensured by Inspire Designer where the HTML catalogue is designed,
Inspire Campaign Manager where audience is targeted with relevant marketing messages for
the catalogue and Inspire Tracker for tracking customer activity.

If the source information used for personalization and the handling of responses based on
tracking are supplied by third party applications, you only need Inspire Designer and Inspire
Tracker to employ this solution.

Inspire Designer's Role in This Solution

Inspire Designer serves as the tool where:

the HTML catalogue template is designed

customer data is mapped to the HTML catalogue and personalized catalogues are
generated

7
2 What's New

2.1.2 Advanced Campaign Control with

Approval States
We all know that sending the right message at the right time can make all the difference to
whether a campaign is successful. And so now you can apply validity periods to your campaign
resources so that they are only used at the targeted time. This further allows for better planning
of your campaign, for instance you could have the same workflow calling on different advertising
images as the seasons change.

What does it bring to enterprise customers

Relevance of the message on the day they receive it

What does it bring to enterprises

Validity added to resources giving better control over their relevance

Multiple states for managing multiple channels or user roles

Process control over which resources are ready for production and which are not

8
 2.2 Further New 8.1 Functionality

How it Works
1. Create your approval states. These should suit your company's designing, testing and
approval processes.

2. Different people in the process apply states as they work on the resource and give that
state a validity period, e.g. once finally approved and if production is planned for
December the state Production is applied with the period 01/12/2011 to 23/12/2011.

3. Only workflows, native files and resources (images) with a given and valid state will be
used for production.

How it is Deployed
The wider picture sees this functionality integrated with Inspire Approval and Inspire Automation,
where partner features have also been added: Approval allows different users to apply differing
states with validity periods; and Automation can be configured to only deploy resources with
valid states.

In Inspire Content Manager you must first define approval states and the users that can apply
them to files. Later, versions of files can be retrieved according to their approval state when
opening a file in Inspire Designer.

Other features help the integration of a wider solution: Export Package exports file versions
and their resources between ICM servers according to their approval state (see the Context
Menus in Inspire Content Manager) and corresponding ICM Methods for scripting approval
state manipulations.

2.2 Further New 8.1 Functionality

Data Processing

PCL Data reading You can use the data extracted from a PCL file in your workflow, e.g. to
add an image on each front page or add an advertisement page behind each back page

9
2 What's New

when printing a duplex PCL file imported natively. Information that can be read from the
PCL file contains page side, duplex type, page size or input/output tray.

Converting spelled numbers into numbers A new field converter in the Data Transformer
module ensures converting spelled numbers into numbers. This feature can be useful in
e.g. the financial industry.

Line data formatting to variable formatted flow A new field converter in the Data
Transformer module facilitates finding certain strings in the line data defined by their start
and end and changing them to text for variable formatted flow. This feature can be useful
for an easier transformation of line data commands to HTML tags than by using scripting.

Advanced option for converting data You can decide according to your preferences
whether the yen sign () or the backslash will be used when converting the input data
from Unicode into Single Japan encoding and vice versa in the Data Transformer module.
Both characters have a very similar usage in computing, e.g. as a path separator.

More information from Facebook Improved feedback on your Facebook campaigns can
be obtained using the Query: Get post info by id in the Social Data Connector module,
which will read information about who has commented and liked any posts and when
they did it.

Quicker combination of fields The operation of adding fields to arrays on the same level
has been made easier. Simply connect two data inputs to the Data Combiner module.

More efficient filtering data You can now filter the data more effectively and quickly by
entering more conditions in one step. Typing multiple text or numerical values is allowed
in Data Filter module.

Layout

Neat look of the charts with areas filled with color You can display and print the area
below or between the lines filled with color for an enhanced visual effect. The series option
is available for the line and radar chart types.

HTML content import A new possibility of importing HTML has been added. It is tailored
for the case that you have existing HTML content (mainly text, basic elements used) that
you want to easily include as variable-selected paragraphs into your designs, you can import
them via external flows to Inspire Designer.

A typical usage scenario can be a bank or an insurance company composing the content
of a contract out of already pre-defined paragraphs. As a progressive enterprise they have
their contract content stored in HTML (as an alternative to RTF) to avoid conversion and
formatting problems as well as enabling direct accessibility of the contracts on their web-
sites.

Additionally, the HTML content import feature enables personalizing the HTML, i.e. mapping
of variables coming from the data to the HTML content via placeholders.

10
 2.2 Further New 8.1 Functionality

More layout objects from RTF designs To increase the possibilities of design documents
outside Inspire Designer, positions of images and other layout objects can be defined in
RTF, DOC and DOCX document templates and then imported into Layout (e.g. via File |
Import | RTF) where the object will be inserted to the design on the page.

Additionally, images that will change according to the values returned by a variable can
be defined and the corresponding variable image will be created when importing. See the
section Layout Objects from Imported Files.

Easy setting of access rights You can now quickly set different access rights for all objects
and their children and links in one step in the Layout Tree context menu. The rights set in
this easy-to-use menu can also be applied to web editing in Inspire Storefront.

Enhanced security of DOCX files You can now secure your produced DOCX files by locking
the flows and thus limit the changes made by users to only selected areas. You can also
set a password to further improve the security of the document.

Simple posting of already designed parts to the web For GMC solutions including web
products such as Inspire Interactive, the functionality of exporting parts of the design from
Inspire Designer is newly available. It brings the opportunity to transfer the already created
design quickly to the web and the possibility to edit these single parts just once in separate
WFD files and see the changes in all related documents.

Quick editing of image properties You can now save time when editing properties of
simple and variable images. Some properties can be edited for multi-selected images so
you do not have to go through each image and set a property individually.

This applies to the Handling group and Use image DPI properties of simple and variable
images.

More user-friendly ruler For your convenience, you can now set the number of sections
the ruler units will be divided in. This better suits conventions of measuring standards.

The feature applies to Layout and Proof rulers.

Colors of your choice for displaying heads To enhance the visual representation of
printing heads displayed in Layout, the possibility to set the colors you like for them has
been added to Layout Options dialog.

Easier working with paragraphs In addition to Flow break after, you can now use the
Flow break before functionality, which affects the paragraph you are applying it to, which
simplifies the work for non-technical users.

Australia Post barcode fitted to use case Improved FCC and CI fields in the Australian
Post barcode ensure fitting the barcode to the wide range of data formats that are being

11
2 What's New

employed by our customers. See the options For customer information use and Use
FCC 00 for zero-valued barcode.

Impositioning

Wider scripting possibilities in Text in Rect module The Script condition offers various
possibilities of using methods related to sheet names and groups. Then the functions can
be based on such conditions, which enhances the Text in Rect module usability.

Extended barcode support The text in Rect module now provides you with an option to
read and handle the PDF 417 barcode type. This two dimensional barcode is used in many
applications as it can encode a high amount of data (incl. e.g. graphics).

Better grouping of splits in Sheet NS Splitter module Another option for grouping sheets
(so that differing sheets can be handled in different ways) has been added into the Sheet
NS Splitter module in order to improve handling of split packages of sheets, e.g. to create
separate spool files for each split.

The option to split the sheets By group with limit now allows sheets to be regrouped so
that: One group is equal to one split. See the option Regroup by new sheet count.

Improved detection of characters in Text in Rect To be more true to the original content
of documents, all characters inside a rectangle are now read by the Text in Rect module.
I.e. this includes characters which cannot be seen because they have outlines and fill styles
set as empty.

Also, any similarly invisible characters used or imported into glyph areas will be printed to
PDF as characters just with empty outlines and fill styles.

Other Modules

Reducing ink costs by differentiating sheets by color saturation You can now save
printing costs by separating black and white and grayscale sheets from the color ones
even within one document and by sending them to different printers. The black and white
and grayscale sheets do not have to be printed on a color printer and thus the ink costs
are reduced. This is possible thanks to new script methods, which have been added in the
Imposition Script module.

Quick update of external workflow You can now easily update the data structure in an
external workflow in one step. This is useful after the master workflow has been changed.

Output Modules

Special character codes support Entering invisible ASCII characters is much easier now.
You can type special character codes to define field separators in the Data Output module.

Advanced access of Inspire Data Centers Safe appending of data as well as removal of
records is enabled by the new Data center modes.

Proof

Colors of your choice for displaying heads To enhance the visual representation of
printing heads displayed in Raster Proof, the possibility to set the colors you like for them
has been added to Proof Options dialog.

12
 2.2 Further New 8.1 Functionality

Production Miscellaneous

Protection of fraud-sensitive information Security documents such as coupons, tickets,

invitations and invoices can now be better protected from unauthorised duplication using

special imaging text effects; MicroText marks, Correlation marks and Glossmark text.
Such text can be read only under special conditions: MicroText marks are readable with
a loupe or magnifying glass; Correlation marks are readable when superimposed by a

"key" overlay; and Glossmark text is readable when illumination is inclined.

These imaging text effects require special fonts that can be purchased separately from the
Xerox company. With these fonts available, you can design and produce documents with
such protection in Inspire Designer in NexPress VDX, PDF, PS2, PS3, VIPP and PPML formats.

Automation for Hotfolders Printing via Hotfolders is now fully automated. No manual
steps are needed. This is ensured by defining a separated location for JDF files.

JDF files can be generated for printer configurations of the following engines: AdobePost-
Script2, AdobePostScript3, CreoVPS, HP PPML, PodiPPML or PDF. See the section PDF
Printer Configuration for details.

CID fonts support for PS3 and CreoVPS You can now use CID (character identifier) fonts
in Inspire Designer that make the work with fonts that have a high number of glyphs more
effective. In addition, characters that belong to that encoding are now searchable in the
generated files.

The fonts are supported for PostScript 3 and CreoVPS engines and are automatically used
when Japan1, Japan2, CNS1, GB1 or Korea1 encoding is selected in Predefined encoding
on the Fonts tab.

Enlarged file size limit The size limit of individual files split from the output file has been
increased from 4 GB to approx. 9 petabytes. You can set your own limit up to this maximum
when configuring a driver for production.

Support of bigger output files Now you are not limited by the size of your output file
when working in Inspire Designer. Output files and ZIP output files bigger than 4 GB are
supported and the number of files in a single ZIP file can be over 65,536.

Improvements by Engine

AFP

AFP file size optimizations Less corrections in space calculation are ensured by finding
and then using the size of the most commonly used space in the text. Graphical
commands are optimized by grouping more of them into one AFP command.

IJPDS

Read and print support for duplex printing The creation and usage of RPX files is
now enabled for example for the scenario of having two independent printers (no
communication set up between them) and duplex printing: Front pages are printed

13
2 What's New

on the first printer (including the index information, e.g. a barcode), then a barcode
reader or a camera is employed to read the information and the created RPX file is
used to match that index to the correct back page that should be printed for each
front page on the second printer.

Available RIPs amount increased It is now possible to use up to 32 RIPs, e.g. for a
configuration using one head per RIP.

Quick configuration of IJPDS heads Now you do not have to configure the resolution,
number of jets and other settings manually for the Versa Line 4000/4200 and Prosper
S20 heads, because they were added to the list of pre-defined heads.

IPDS

Effective processing Your IPDS outputs can now look even better with the usage of
vector/outline fonts. Font parameters are loaded into printers just once and printers
handle further settings in their memory which results in more effective processing
and great-looking outputs.

PDF

Native support for grayscale colors To speed up generating and make PDF outputs
smaller, it is possible to "switch" CMYK and RGB graphics and text into grayscale.

In addition, whenever you need to generate a grayscaled PDF file from a colored layout
(e.g. for preview or archiving purposes), you can now set it up for graphics, text and/or
images.

Text

URL links displayed in text output You can now send SMS messages including links,
thanks to which you can access the referenced web pages directly from mobile phones.
When generating Text output from a design containing URL links, the text for which
the link was set can be accompanied by the link path or replaced by it.

Inspire Production Console

More effective record data reading You can now also use a new command to ensure that
only those record items and subitems needed for processing are used. It prevents the system
from running out of memory if the record data is too large without a need to open the
application GUI or to set this option in the config file. You can disable reading the whole
data record into memory by entering the -allowrecordatonce Bool command.

The same command can be used in Inspire Production Server.

Script file for Script Library as a workflow parameter When having scripts related to
one workflow in separate files split e.g. according to clients, you can change the script
file easily in the Workflow Parameters dialog in Proof and Production as well as by a
command-line parameter during batch processing.

Inspire Content Manager

Standardized access rights The variety of permissions for Content Manager users has been
brought in line with Windows security settings, allowing a more consistent security policy

14
 2.2 Further New 8.1 Functionality

for file and folder access. In particular, the permission Add has been split into Add File
and Add Folder and the permission List has been added.

Faster setting of user permissions You can now apply user permissions to whole groups
of users at a time, allowing for more speedy implementation when large groups of users
have been given the same defined user role.

Permissions can further be inherited so that it is possible for any particular user in a group
to have different settings. See the option Edit Group Permissions on the Group Admin
dialog.

Scripting

Significantly improved versioning methods for Inspire Content Manager There has
been a great increase in the amount of data about files that can be read from and written
to those files (and different versions of those files) which are stored in Inspire Content
Manager via scripting. Many file methods have been added to manipulate approval states,
history and metadata, in order to keep a better track of the version history of files and
their resources.

The methods are ApprovalState, DataValue, DataValueList, DataValueType,

getReferencedBy, getReferences, HistoryInfo, HistoryInfoList,
Metadata, MetadataValue, MetadataValueList, Preview, readFileHistory,
readMetadata, setPreview, setVersionApprovalState and writeUser
Metadata.

Automation of image page count reading You can now calculate the pages count for
multi-page images via script. It has the same functionality as applying the existing field
converter, only the script can be faster to apply if many variables are involved.

More control over failed web requests The web-calling status 590 can now be returned
by scripts if connection to a web location fails. This allows the script to continue being
parsed in such an event. See the Web Request Methods section.

Native Import

AFP

Extended support of NOP reading More content can be imported from AFP files as
Inspire Designer now also supports the import of NOP comments that are outside of
the Document definition in AFP files.

MICR font support When importing an AFP with MICR font usage, you can make further
use of the MICR font information: First you set the color and colorant for the MICR
font in the Options dialog. Then the color will be used for the text visible in Layout
and Proof and the colorant (if assigned to MICR in the Engine Config) will be used
for printing the text using MICR ink on your printer.

PCL

Full support of macros invocation When importing a PCL with a macro, it is now
possible to use any of the macro invocation types and it will be processed correctly

15
2 What's New

by Inspire Designer. In addition to the macro invocation types 'execute' and 'call', the
support of the 'automatic overlays' type has been added.

Better quality import The recovery possibilities applicable when loading a PCL file with
malformed commands have been enhanced to get import results closer to the original
even though the PCL commands have wrong syntax. Also, an additional command
for selecting the primary and secondary pitch that determine the font size has been
added among the supported PCL commands.

Miscellaneous

Secure command line data Your command line data can now be more secure from the
view of a third party. This is achieved by encryption of command lines.

Command lines that are required to be used on the start-up of an application and/or are
also required to be encrypted (e.g. password entry for UNIX-based systems) can also be
placed in the CONFIG file.

Effective usage of Net license You can make work of your designers more effective by
setting a timeout limit in Inspire Designer. This way, the license is released after the defined
time of inactivity to be available for another user.

This applies to the Workflow window, Layout window and Line Data Input module in Inspire
Designer with the Net license.

2.3 Changes in Default Settings

This section lists differences in the applications default settings with the previous version (applied
to Beta and GA versions).

The HP PPML and PodiPPML config dialogs have had the following default settings
changed:

Images tab: The Generate images into same directory as spool file option is
now selected instead of Do not generate images (Use images created before)

PPML Settings 1 tab: The Use internal data (from PPML 2.1) option is now un-
checked

Engine tab: The Zip all files that have been generated in same directory as
spool option is now checked

Using the default settings you can now directly generate files.

Postscript2, Postscript3 When the option Reuse generated background images is

used together with the CCITT compression for transparent images, hash files may slightly
differ as the CCITT compression is newly applied to transparent images (specifically, to
the mask of such images). Originally, it was applied to black-and-white images only.

Now, when importing PS files (either natively or non-natively) that contain PJL commands,
the information about page size is also loaded. Originally, this information was not
loaded which possibly resulted in the incorrect size of such files.

16
 2.3 Changes in Default Settings

MS Word documents with the DOC/DOCX extension are now detected by the file ex-
tension to ensure that these types of documents are identified correctly. Originally, they
were detected by the content stream.

When natively imported PDF files have no font replacement set for the Times-Roman
font, originally, the font defined in Inspire Designer as the "Variable width font" was
used instead. Now, because Times-Roman belongs to the standard group of fonts,
Times-Roman is automatically detected in such cases.

The path to the executable defined by the first parameter of the file method execute
is newly taken as relative to the working directory. Originally, the path to the directory
containing WFD file, in which it was used, was added as a prefix to the executable. To
achieve this behavior prior to the 8.1 version use "map://wfd/" in the parameter before
the executable name, which adds the path to the WFD.

Now, the content of the Mail parameter of the sendMail method is not changed, i.e.
the parameter is not reset. Check your scripts that use this method to ensure correct
behavior.

The internal structure of emails sent by Inspire Designer (using the Send and saveToEML
methods) has been changed. Due to this change, the text part of emails that contains
both text and HTML parts might be displayed differently in email clients (after switching
on the option 'Show plain text only' in an email client) than in previous versions. The
exact way of displaying is handled by the used mailing server and email client. See the
influence (Mail Methods and Mail Server Methods) of single server and clients after the
internal change.

HTML and HTML Simple engine image resource naming For unsupported formats of
images (e.g. any format that is not checked on the Images tab of the HTML Engine
Config dialog), names of image files are now generated as hashes (ab1c). In previous
versions, names were generated with the original names of the images.

Thus, keep in mind that if upgrading to this version of Inspire Designer and regenerating
resources, you will have both variants of unsupported images in the folder; those re-
maining from previous versions with the original names and those named with hashes.

Group begin for saddle stitching When using the Saddle Stitch module and the option
Print in reverse order is checked, it is now possible to identify the beginning of each
group (GroupBegin is set correctly), e.g. if there are 4 PDFs, each with 2 pages = 1
sheet, each PDF is a group and the beginning of the sheet is 1, 3, 5, 7. Originally,
GroupBegin was at the end of each group.

DPM variables in PDF The name for a DPM variable has to satisfy the XML naming
convention now. The XML naming convention is validated, so keep in mind that any
DPM variable names containing unsupported characters (either created in this or previous
versions of Inspire Designer) will not work now and output generation will not be per-
formed.

HTML, Catalogue templates Newly, all design elements (e.g. lines) are scaled in percent
in relation to the size of the page. This ensures that the design can now be adjusted to
the size of the page. Originally, the elements were in pixels.

Thus, keep in mind that if upgrading to this version of Inspire Designer, it is necessary
to create a new Engine config because the one created in an older version of Inspire
Designer keeps the pixel values.

17
2 What's New

IPDS related messages in Inspire Production Server Inspire Production Server returns
enhanced messages when printing via IPDS engine to provide users with more inform-
ation about the printed pages. The new format is 'EerrorCount;WWarning
Count;SCurrentSheet;SCSheetCount;PPPreparedPage;SPSentPage;STP
StackedPage;USIUserSheetIndex;CICopyIndex'. In previous versions only
'EerrorCount;WWarningCount;SCurrentSheet;SCSheetCount' values were
reported.

Mapping variables in the Email Gateway Data module If no Parent Array is selected,
data from root can now be used in the Variable column and their values will override
the constants set in the Constant Value column. In previous versions it was necessary
to fill in the Parent Array and select only variables from it, otherwise the constants were
used.

Intelligent Mail (4-CB) barcode The default data of this barcode has been changed.
I.e. the value of the option Data on the Content tab, which is used to create a barcode
if there is no data being read from any variable, has been changed from
5078965412301236545613827399801 to zero values.

2.4 Enhancements in
Documentation
Integration section The new Integration section has been added to introduce applica-
tions that Inspire Designer can work with.

Resizing barcodes Examples and improvements have been added to the Resize Barcodes
section.

More details about ICM branches A more instructive description of branches and
preferred branches for version control has been added. See the section How to Create
and Use Branches.

18
3 Starting the Application

3.1 Startup Dialog

3.2 Opening Existing WFD Files
3 Starting the Application

This section contains information on actions performed directly after starting Inspire Designer
such as:

Starting the application, opening recently used workflow files or accessing the different
environments of Inspire Designer using the Startup Dialog.

Handling possible issues occurring when opening existing WFD files.

3.1 Startup Dialog

When the GUI version of Inspire Designer is first started, the Startup dialog opens and offers
recently used files as well as a selection of environments to work in:

Options Description

Work with Existing Workflow To open an existing workflow either choose one from the
list of recently opened WFD files and click on Open, or double-click on More files... which
opens an Open dialog where you can browse for further WFD files. See the Opening Ex-
isting WFD Files section for details on possible issues when doing so.

You can set the number of recently opened WFD files offered in this list in the Workflow
Options dialog.

New Workflow Opens the Workflow Window allowing you to start building a
new workflow file.

See the separate section Workflow Window Overview for further details.

Layout Window in New Workflow Opens a new workflow with a Layout

module placed in the Workflow Area and with the Layout environment directly opened.
This allows you to directly start the design of the document that the workflow will create.

20
 3.2 Opening Existing WFD Files

See the separate section Layout Window Overview for further details.

Workflow Wizard Opens the Workflow Wizard, which guides you through the
first steps of constructing a simple workflow.

For more information see the separate How to Create a Workflow section.

Production Environment Opens the Production environment, where completed

workflows can be loaded and printer parameters can be set in order to run a print job.

See the separate section Production Overview for further details.

Simple Production Environment Opens the Simple Production environment,

which can be used for printing workflows one at a time, offering a less diverse set of job
parameters than the standard production environment.

See the separate section Simple Production for further details.

Proof Environment Opens the Proof environment where complete and incomplete
workflow files can be loaded in order to run a virtual print job.

See the separate section Proof Overview for further details.

Do not show this dialog next time When checked, the Startup dialog will not appear
anymore when Inspire Designer is started. Instead, an empty workflow will be opened
directly.

If you wish to reset this option in order to see the Startup dialog again when starting In-
spire Designer, this can be done by checking the Show startup dialog option in the
General Options section of the Workflow Options Dialog.

3.2 Opening Existing WFD Files

WFD files can be associated with Inspire Designer:

either by selecting the option Association of workflow files during installation,

or by right-clicking on the WFD file in a file manager and in the properties selecting In-
spire Designer application in the Opens with option.

21
3 Starting the Application

For the associated files you can then select, what happens if you double-click on them:

All WFD files will be opened in one instance of Inspire Designer (default from version
6.2),

or a new instance of Inspire Designer will be run for each of the WFDs.

To set this, go to the Workflow Options dialog and check the Open associated files
in new window option.

When opening existing WFD files the following issues can occur:

There can be a conflict between the version of Inspire Designer a WFD file was created
with and the version with which it is now being opened.

External files used by the WFD file (e.g. data files, fonts, images etc.) can have changed
or be missing.

See the sections below for details on the above described issues.

In the Warnings Config you can activate a warning (by default set to being displayed
Never) that would appear when any resources checked out from the Inspire Content
Manager are used for the WFD being currently opened.

3.2.1 Version Conflicts

If you try to open a WFD file which has been saved/created in a higher version of Inspire De-
signer than the one currently in use, a warning dialog will appear. This dialog indicates that
the WFD you intend to open may use features that are not available in the version of Inspire De-
signer you are currently using.

Note This message will appear only in Inspire Designer version 5.0 and higher.

3.2.2 Used Files Update Dialog

See also:
Used Files Conditions
Used Files Dialog

The Used Files Update dialog appears when opening a workflow which uses other files (e.g.
data, images, fonts...) that have been modified, renamed, moved or deleted since the workflow
was last opened. The message and options displayed in the dialog are based on either the ex-

22
 3.2 Opening Existing WFD Files

isting state identified by Inspire Designer or on browsing performed by the user. See an example
of the dialog:

The below described items represent a complete list of possible options. Through them the
user can decide how to proceed with different situations stated in the dialog. The options appear
variably upon opening a workflow with modified or missing used files.

Options Description

Apply to all files with type...? If checked, the action represented by the subsequently se-
lected button will be repeatedly performed automatically for the given type of file (e.g.
for all font files).

This saves time when opening a workflow containing many modified/missing used files.
The action only applies to the current opening of the workflow.

The default behavior of a workflow with different or missing used files can be set in the
Used Files Conditions section in the Workflow Options dialog.

This check-box is present in every Used Files Update dialog shown.

Browse Browses for a file to substitute a non-identical or missing file assigned to the workflow.

After selecting the browsed file, a dialog that names the found file and with appropriate
buttons from this list appears, so that the user can proceed with one of the below described
options.

Use Uses the file stated in the dialog instead of the original file that, before opening the
workflow, had been modified or had changed location.

This function only applies to the current opening of the workflow, i.e. the file is assigned
to the workflow temporarily. When the workflow is opened next time, the dialog appears
again.

Replace Replaces the original file in the workflow with the modified/newly located file stated
in the dialog, i.e. the replacement file is assigned to the workflow permanently.

When the workflow is opened next time, the dialog will not appear.

Note The Replace button is not available when opening a workflow as read-only.

Skip Skips the loading of the file, stated in the dialog, that has been modified, deleted or
has changed its location before opening the workflow.

The workflow opens so the user can work with its modules not affected by the skipped
file and the whole workflow can be saved. However, because there is a file that has not
been loaded, you will receive an error message if the workflow is processed, for example
in Proof or Production.

23
3 Starting the Application

Cancel Cancels the loading of the workflow. The workflow will not open at all.

Use Included Uses the file that was originally included in the workflow instead of the modified
file currently found on the disk.

This function only applies to the current opening of the workflow. When the workflow is
opened next time, the dialog will appear again. E.g.:

This dialog appears if the file used in the workflow has been set to Include in the Used
Files dialog.

24
4 Workflow

4.1 Workflow Window Overview

4.2 Workflow Window Menu
4.3 Workflow Window Toolbars
4.4 Module Tree
4.5 Workflow Options Dialog
4.6 Debug Data Window-Pane
4.7 Label Tool
4.8 Profile Data Tool
4.9 Templates Window-Pane
4.10 Verify Window-Pane
4.11 Compare Workflows Window-Pane
4.12 Cross Reference Browser
4.13 Used Files Dialog
4.14 How to Create a Workflow
4 Workflow

4.1 Workflow Window Overview

In this section: See also:
Workflow Window Workflow Options Dialog
Workflow Area Workflow Window Toolbars
How to Create a Workflow

4.1.1 Workflow Window

The Workflow window is a Graphical User Interface to aid you build and configure a workflow
with differing inputs being combined and manipulated to create a design with a range of
possible outputs.

The Workflow window provides an overview all of the component modules of a WFD file as
they are brought together. From this hub you can access each component to configure how
it handles its individual process and quickly navigate to the other modules to adjust them also.
Finally you can test your workflow and its inputs or check your design by one-click commands
from here.

Legend

1. The Workflow Window menu. Click on the link for a description of the options that
can be found there.

2. The Workflow Window toolbars. These toolbars are detachable from the menu frame
of the window and can be placed in your preferred position.

3. The Modules window-pane with the Module Tree inside.

This can be opened or closed by going to menu: Window | Show Module Tree.

4. The Workflow Area with an example workflow built inside.

26
 4.1 Workflow Window Overview

Tip Workflows containing data display the record count (available in the root array)
above each connection line passing data records. This is applied after the workflow is
once proofed.

5. The Templates window-pane showing previously saved workflow templates.

This can be opened or closed by going to menu: Window | Show Templates.

6. The Verify window-pane showing the results of a workflow test run performed by the
Verify option.

This can be opened or closed by going to menu: Window | Show Verify.

7. The tabs at the bottom of the screen help to switch among the open windows of In-
spire Designer. Each tab represents one window, clicking on that tab brings it to the
front so that it replaces the previously displayed one and is active for working with.

Note

A WFD file name which is marked red on the tab indicates that file is in read-only
mode. If you need to modify such document, you should save it under a different
name.

If you close all workflows, automatically an empty New Workflow 1 is created. The
empty New Workflow 1 is closed automatically, as soon as another workflow is
open or created.

This feature proves useful for example, when working with Inspire Content Manager
Explorer (VCS Explorer) and many workflows. In cases, when only the VCS Explorer
tab remains open, you can always access File menu without closing the Inspire
Content Manager Explorer (VCS Explorer).

8. The field refers to the Inspire Content Manager (VCS). If you are logged in, the field
displays your login. If no one is logged in, it displays Not logged.

27
4 Workflow

4.1.2 Workflow Area

1. In the left upper corner of the Workflow Area, there is information about the currently
opened WFD file.

You can find here the path to the file, number of modules used for this job, creation
date and time, date and time of the last change and Inspire Designer version number
identifying the last version used to modify the workflow.

To change the date and time format and the font color, go to Workflow Options Dialog.

Note In versions 4.5 or higher, the local time of the user is displayed. In versions before
4.5 the GMT time is displayed.

2. The context menu option Show Module Names displays a module type name above
each module. It is useful if you need to find out the type of a module if it is no longer
recognizable because of a name change.

For the Show Custom Module Icons option see the point 4. For the Insert Public
Module option see Projects.

28
 4.1 Workflow Window Overview

3. Once you have built your workflow you can keep track of the functions of its component
modules, at a glance, by using labels.

Right-clicking on the label, once it is drawn, reveals a context menu. For details see the
separate Label Tool section.

4. You can right-click on any module placed in the Workflow area to reveal a context
menu:

Edit Module Opens the modules configuration whether it be a simple panel or

an entire window.

Choose Module Icon Opens the Choose Module Icon dialog allowing you to
upload an image (in the format supported by Inspire Designer) for the selected
module. The image can also be set as a default for the selected module type.

Tip Images can also be uploaded using drag and drop or copy/paste functional-
ity.

The recommended size of the image (corresponding to the size of original Inspire De-
signer icons) is 5268 px.

The custom icons can be hidden/shown by (un)checking the option Show Custom
Module Icons in the context menu.

Rename Module Opens the Rename Module dialog allowing you to enter a
name for that module.

This name will be used throughout Inspire Designer when the module is referred
to or used and when you change the name most references to the module will be
updated automatically. However, if you have scripted some functionality that uses
the module yourself, then the name will have to be changed correspondingly there
too.

Delete Module Opens a confirmation dialog asking whether you really want to
delete the module. Clicking on OK will remove the module from the workflow
and the workflow area and all configuration will be lost.

Make Module Public / Make Module Private For details see Projects.

Access Rights Opens the Edit Access Rights dialog where you can determine
access rights for the selected workflow module.

You must be logged into the Inspire Content Manager (Version Control System)
to use this feature.

Lock/Unlock Locks/unlocks the selected module.

The lock protects modules from unintentional edition and it is also used in combin-
ation with Public Objects feature of Projects. Public objects are automatically locked
when they are created or added.

A locked module has a little lock displayed in its top-left corner.

Lock Module with Password / Unlock Module Protected with Password

Locks/unlocks any selected modules with a password.

29
4 Workflow

The lock protects modules from having their content edited, being copied to the
clipboard and from being exported as XML. A locked module has a little lock with
a 'P' displayed in its top-right corner. In comparison to the Lock option above,
you have to enter a password to protect the module and you can also lock several
modules with one password using multi-selection.

Tip If you have several modules protected by various passwords and use the
multi-selection to unlock, typing one of those passwords will unlock the according
module(s), the other modules protected by different passwords will stay locked.

Workflows with modules protected by a password cannot be opened in earlier

versions of Inspire Designer.

5. You can right-click on any of the links that you have made between modules in the
Workflow Area to reveal a context menu:

Show Debug Data Appears in the menu if the link carries only data and not a
page description. It opens the Debug Data window-pane where you can see how
the data is configured at that point in the workflow.

Disconnect Deletes the link between modules so that no data can pass between
them.

6. In multiple output workflows it is possible to determine the module used for Proof
/Production when running the workflow. The Layout, Output and Data Output modules,
when placed at the end of a workflow, have the options Use for Proof and Use for
Production in their context menu. The Sheet Statisitc module has the Use for Produc-
tion option. The module designated for Proof/Production is marked with the Proof
/ Production icons.

If you only have one possible Output then it will be selected automatically when running
a job.

7. Holding down the left mouse button allows you to draw a selection area inside which
all modules will be selected. Also you can pick and select several individual modules
and labels by clicking on them one by one while pressing and holding down the <Ctrl>
key. You can then move the selected objects (drag and drop or use the arrow keys),
copy them or delete them simultaneously.

It is possible to move objects beyond the currently visible Workflow Area. The Workflow
Area expands accordingly.

Note When there are duplicate field names defined on the same level, an exclamation mark
displays next to the module.

This is to warn you that at least one field name should be changed, because each field is assigned
to the subsequent operations by its name. Inspire Designer only finds the first occurrence and,
therefore, the other field of the same name would not be found and not assigned. As soon as
there is an exclamation mark shown, rename the fields so that they are not identical.

30
 4.2 Workflow Window Menu

4.2 Workflow Window Menu

In this section: See also:
File Menu Workflow Options Dialog
Edit Menu Workflow Window Toolbars
Workflow Menu Workflow Window Overview
Window Menu
Help Menu

A description of the functionality accessible from the main menu of the Workflow window
(see below screenshot) is given in this section.

4.2.1 File Menu

New Workflow Opens the New Workflow dialog which offers a selection of basic
workflow templates or the option to create your own custom workflow from scratch.

Shortcut: <Ctrl>+<N>

New with Wizard Opens the Workflow wizard to aid the construction of a basic workflow.

Open Workflow Opens a standard Open dialog to allow you to locate, select and open
an already existing workflow file (WFD).

Shortcut: <Ctrl>+<O>

Close Workflow Closes the currently selected active workflow file. This includes unloading
it from Production and Proof if either has been run.

An open workflow is selected using the main Inspire Designer tabs at the bottom of the
application window. The selected workflow is the one visible in the Workflow area.

Save Workflow Saves the currently selected active workflow file.

Shortcut: <Ctrl>+<S>

If the workflow file is open in read-only mode, a warning message appears and a Save As
dialog pops up, when you try to save it.

Save Workflow As Displays a standard Save As explorer dialog in order for you to enter a
new name and location for the currently selected active workflow file.

Export with All Included Opens a standard Save As explorer dialog in order for you to enter
a new name and location for the currently selected active workflow file and includes all
external files that have been used in the workflows construction (e.g. Data files, images)
so that they are part of the WFD file.

31
4 Workflow

However, the original path to those external files will be maintained in the file and checked
every time that the workflow is opened. Therefore, if the file in the original location is
updated then this is detected and a dialog will ask whether you would like to update the
included file as well.

If the original external file is deleted or is not accessible from the new WFD files location
then the workflow simply continues to use the files that were included at the time of this
export.

For information, see the List of Used Files dialog description.

Compress or Send to Mail Recipient See the Production Window Menu section for the
description of this option.

Inspire Approval Upload/Update Enables you to upload a new job to Inspire Approval
(WebProof) or update an existing one already stored on the server. In the dialog that opens
you can enter the file and login details. For information on Inspire Approval (WebProof,
a web-based proofing and approval system) see the separate Inspire Approval User
Manual.

Job

Upload Select this option if you want to upload a new WFD file to Inspire Ap-
proval (WebProof).

Update Select this option if you intend to update a reworked WFD file which
is already stored on the Inspire Approval (WebProof) server. This action will
save the changes and change the state of the job.

Details After clicking on the Select Job button, the Inspire Approval (WebProof)
database is queried for jobs which can be reworked (their attribute is set to
"change file"). Select the job you want to update from the list which appears.

This option is available when the Update job option is selected.

Inspire Approval alias Enables you to enter the name under which the job is saved in
Inspire Approval (WebProof).

Output Selects the desired output if there is more than one output module in the
workflow.

32
 4.2 Workflow Window Menu

ICM label Enters a Inspire Content Manager (VCS) label for the uploaded file. The editable
combo-box offers all existing labels in the Inspire Content Manager (VCS). This option
is available only if you are logged to the Inspire Content Manager (VCS) and the
opened file is stored in the Inspire Content Manager (VCS).

Note For a successful upload a label has to be always defined.

Send only link to ICM If checked, only a link to the Inspire Content Manager (VCS)
location, where the current file is stored, is sent to the Inspire Approval server. This
option is available only if you are logged to the Inspire Content Manager (VCS) and
the opened file is stored in the Inspire Content Manager (VCS).

User name Enables you to enter the user name. The application remembers the entered
user name details (as well as password and URL) for next login.

Password Enables you to enter the password.

Service base URL Enables you to enter the URL of the server where the service is running.

Note The upload function is supported by Inspire Approval version 5.0 and higher, the
update function by version 5.1 and higher.

Import

PLS Opens a standard Open File explorer dialog to enable you to locate and open Print-
Net 3 Print Layout Source files (PLS) into Inspire Designer.

See also the separate section: Importing PrintNet 3 Jobs Overview

Note This feature is not supported by the Mac version of Inspire Designer.

PTF Opens a standard Open File explorer dialog to enable you to locate and open PrintNet
3 Text Format files (PTF) into Inspire Designer.

Note This feature is not supported by the Mac version of Inspire Designer.

XML Opens a standard Open File explorer dialog to enable you to locate and open
workflows coded in XML format into Inspire Designer. It is possible to import only
XML workflows created in Inspire Designer and exported from Inspire Designer as
XML files (see XML Export). The imported XML workflow is added into the currently
open WFD workflow.

If the imported XML file includes modules with the same names as the currently open
WFD file, these imported modules are automatically renamed to avoid any confusion
caused by duplicate names. A warning that the modules have been renamed displays
in Results dialog.

Note You cannot import or export XML files, and it is not advised to work with
them, if you are operating Inspire Designer with only a demo license. This will cause
problems, especially if you are using QuarkXpress or InDesign plugins.

XSLFO Opens the XSL-FO dialog to enable you to locate and open XML format definition
files (FO or XML files) into Inspire Designer.

Export

XML Opens a standard Save As explorer dialog in order for you to enter a new name
and location to create version of your workflow fully described in the XML format. If

33
4 Workflow

the option Export with resources is checked in that dialog, all used files are also
exported to the same directory as the XML file.

Note You cannot import or export XML files, and it is not advised to work with
them, if you are operating Inspire Designer with only a demo license. This will cause
problems, especially if you are using QuarkXpress or InDesign plugins.

Workflow Snapshot Opens a standard Save As explorer dialog in order for you to enter
a new name and location to save a screenshot of your current workflow as a PNG
image.

Used Files... Opens the list of Used Files which lists all of the external files currently being
used by the selected workflow.

Cross Reference Browser Opens the Cross Reference Browser dialog that enables you to
find out which files a particular file refers to; or which files refer to that file. This is useful
for revealing references between WFD files and used files (e.g. pictures, fonts, data files,
external workflows).

Workflow Access Rights Opens the Edit Access Rights dialog that enables you to define
rights controlling the degree of modifications to the workflow that will be allowed for
specified users.

Show Production Opens the Production window from where you can control Inspire Designer
output.

The selected workflow is not loaded to Production.

Show Proof Opens the Proof window from where you can preview Inspire Designer output
in different formats.

The selected workflow is not loaded to Proof.

Show Simple Production Opens the Simple Production window from where you can from
where you can control Inspire Designer output with a more

The selected workflow is not loaded to Simple Production.

Options Dialog Displays the workflows Options dialog which allows the altering of some
general parameters of the Inspire Designer configuration and the set-up of some Workflow
window shortcuts.

Inspire Content Manager The Inspire Content Manager (Version Control System) allows
you to manage different versions of a workflow, keeping a track of all changes and con-
tributors.

The Inspire Content Manager options in this menu extension are explained at length in
the separate Inspire Content Manager sections. They become active according to the
current status of the Inspire Content Manager (VCS) and the workflows managed by it.

Login to ICM Opens the User Login dialog which asks for Username and Password
in order to log into the Inspire Content Manager (VCS).

Logout of ICM Logs the user out of Inspire Content Manager (VCS) so that version
controlled documents can no longer be accessed.

34
 4.2 Workflow Window Menu

ICM Explorer Launches the Inspire Content Manager Explorer (VCS Explorer) window
from where you can manage version controlled documents.

Check In Checks in the selected workflow to the Inspire Content Manager (VCS).

Check Out Checks out the selected workflow from the Inspire Content Manager (VCS).

Undo Check Out Cancels the check out status on an Inspire Content Manager (VCS)
file without recording its details.

History Opens a History dialog which shows a chronological list of the activities on the
selected workflow.

History Tree Opens a History dialog which shows the activities on the selected workflow
in a tree type schema allowing easier tracking of version branches.

Label Opens the Label dialog which allows you to add labels to file versions for easier
identification when viewing its history.

Branch Opens the Branch dialog which allows you to add branches to file versions for
more complex versioning needs.

Select Workspace Opens the Select Workspace dialog, to select a specific workspace from
those that have been setup via Manage Workspace.

Manage Workspace Opens the Manage Workspace dialog, to define default directories for
the different types of files that are used by Inspire Designer.

Show Project Browser Opens the Project Browser window.

Shortcut: <Ctrl>+<Shift>+<O>

Recent Files Lists WFD files and projects most recently worked on.

Exit Exits Inspire Designer. If there are any unsaved workflows, you will be prompted to save
them before exiting.

4.2.2 Edit Menu

Undo Reverts the last action taken.

An abbreviated description of the action that would be undone will appear here in the
menu to help ascertain what that action was, e.g. this option name could appear as Undo
Remove Connection.

Shortcut: <Ctrl>+<Z>

Redo Performs the action, that was last undone, once again.

An abbreviated description of the action that would be redone will appear here in the
menu to help ascertain what that action was, e.g. this option name could appear as Redo
Add Label.

Shortcut: <Ctrl>+<Y>

35
4 Workflow

Delete Deletes the selected module(s) from the Workflow area. By default, you will be
prompted to verify the action before the module is deleted.

Shortcut: <Delete>

Cut Cuts the selected module(s) and places it to the clipboard.

Shortcut: <Ctrl>+<X>

Copy Copies the selected module(s) and places the copy on the clipboard.

All values from the copied module are maintained but can be modified.

Shortcut: <Ctrl>+<X>

Paste Pastes the workflow(s) items that are on the clipboard to the current Workflow area.

Shortcut: <Ctrl>+<V>

Select All Selects all of the modules that are in the selected Workflow area.

Shortcut: <Ctrl>+<A>

Invert Selection Selects modules that are not currently selected and de-selects modules that
are selected.

Select None De-selects any currently selected modules.

Find All Script Errors Finds all scripts that cannot be compiled and lists modules that contain
them in the Script Errors window-pane that appears. When an item in the list is selected,
the module where the error in script occurs is highlighted. Double-clicking on the item
opens the module.

Object alignment Displays a menu extension that offers alignment options for selected
modules and labels in the Workflow area.

4.2.3 Workflow Menu

Refresh Used Files Reloads all used files. Used, for example, if data files may have been
updated with new data that needs to be included in your workflow.

Update External Objects When selected (icon shows as depressed); then each time a
workflow file containing external objects is opened those external objects are reloaded to
ensure that their content is current within the workflow.

If not checked, then content of the external objects is not updated in the workflow.

Tip Consider switching the updating off when a large number of external objects (tens
or hundreds) is in the workflow file and it would take a long time to update the objects
on every opening of the file.

Show Images as Full Resolution See the section Layout Window Menu for the description
of this option.

36
 4.2 Workflow Window Menu

Intelligent Connections Turns the intelligent (bendy) connections on and off. If the option
is enabled, all connections have to be recalculated every time a module is moved in the
workflow.

Verify Verifies whether the workflow objects are correctly connected and their parameters
are properly defined.

If there is an error it will be detailed in the Verify window-pane.

Compare Workflows Opens the Compare Workflows window-pane for comparing earlier
and later versions of the same workflow.

Master Workflow

Set Master Workflow Selects the workflow that will be used as the master workflow,
so that functions from any Script Library module in that workflow can be used while
creating this current workflow.

If the External Workflow module will be employed to set up a master-slave relationship

between workflows and it is also required to share scripts between these workflows,
a Script Library module should be placed in the master workflow (the one with the
External Workflow module) and the functions to be shared should be scripted there.
Then, those functions can be used in all of the slave workflows (with Workflow Gate
modules) at the time when the master workflow is processed. However, at the time
of workflow creation, any master workflow is not being processed and so scripts
cannot normally be read.

Selecting a workflow here allows you to edit scripts using functions from that work-
flow, i.e. it reads the Script Library module in that workflow and the Script Assistant
will offer you functions from that workflow.

But remember, those functions are not stored in this workflow. Therefore, if you
process this current workflow those functions will not work at the time of processing,
i.e. Workflow Gates have to be in this workflow and a corresponding External
Workflow module used in the master workflow. It is the master workflow that has
to be processed for all of the scripted functions to work.

Clear Master Workflow Releases the master workflow so that this workflow cannot
read scripts from it.

In the screenshot above, notice that: If there is a master workflow set, it is listed in the
top-left corner of the Workflow area.

Open Layout(s) Opens the Layout module or switches to the Layout view if it is already
open.

Shortcut: <F4>

Run Production Opens the Production window with the selected workflow loaded to it.
From there you can control Inspire Designer output.

37
4 Workflow

Alternatively, if you are using the Data Output Module module the Production window
will not open and the output will simply be saved to the file selected there-in.

The workflow is pre-processed here, therefore if, for example, a data input file is missing
then an Error dialog will appear and brief details of the problem will be shown in the
Verify window at the bottom of the Workflow area.

Production will not run without a Layout or an Output module in the workflow. If there
is more that one output possibility it will run the one that is selected as Use for proof.

Shortcut: <F5>

Run Proof Executes the workflow and opens the Proof window with a view of the current
output of the workflow displayed.

Production will not run without a Layout or an Output module in the workflow. If there
is more that one output possibility it will run the one that is selected as Use for proof.

<F6>

Selection Tool When selected (icon shows as depressed) the mouse pointer is a selection
tool. It can be used to select objects (modules, links etc.) in the Workflow area.

Label Tool When selected (icon shows as depressed) the mouse pointer is the Label Tool,
enabling you to label the Workflow area.

This tool is useful for writing notes in the Workflow area to help identify what various
sections of a workflow do at a glance.

Profile Data Tool When selected (icon shows as depressed) the Profile Data tool is activated
and when the workflow is run in Production or Proof, then the time that each data module
took to process its data related tasks will be displayed graphically on the face of the
module in the workflow.

This helps you to identify, at a glance, areas in which to try and optimize your workflow.
Those modules which have longer processing times may be able to be configured better.

Example The screenshot below is of the data processing section of a workflow

that has been proofed with the Profile Data tool active.

38
 4.2 Workflow Window Menu

4.2.4 Window Menu

Show Module Tree When checked, the Modules Tree window, listing all of the available
modules, is displayed.

Show Verify When checked, the Verify window-pane is displayed.

Show Templates When checked, the Templates window-pane, listing all of the available
templates, is displayed.

Show Script Errors When checked, the Script Errors window-pane, listing all errors in all
scripts throughout the workflow, is displayed. The list gets populated after clicking on the
option Edit | Find All Script Errors.

Show Script Find/Replace When checked, the Script Find/Replace window-pane is displayed.
It enables you to search for text in all scripts in the workflow and to replace the found
text with another text. Its functionality is similar to the Find/Replace Text Palette in Layout.

If you make a search when the Find edit-box is empty, you get a list of all scripts used in
the workflow.

Double-clicking on an item in the list of found occurrences opens the appropriate module.

Show Debug Workflow Opens the Debug Data window-pane which provides detailed in-
formation about variables.

Load Environment Loads the last saved environment settings for the Workflow window.

Useful for resetting the Workflow environment to the last saved one.

Save Environment Saves the current size, position and visibility of the menu, toolbars,
modules tree, verify window-pane and Workflow area etc.

Whenever you start Inspire Designer, the last saved settings will be applied to the Workflow
Window. You can make adjustments as you work, but those modifications will not be
maintained unless you save them.

Reset Environment Sets the size, position and visibility of the menu, modules tree, verify
and workflow areas etc. back to their original default values, i.e. ignoring the last saved
environment.

Customize Toolbars Opens a dialog enabling you to create new toolbars or customize the
existing ones. For more information see the How to Customize Toolbars section.

Select Language Lists all of the languages currently available for the program interface en-
abling you to select the language that you wish to use for the program interface.

The list of fully supported language versions can be found in the Inspire Designer release
notes in the Localization chapter.

39
4 Workflow

4.2.5 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

Getting Started Opens the Getting Started guide, which offers a step-by-step introduction
to Inspire Designer.

About Displays the version number of Inspire Designer (including 32-bit/64-bit information),
copyright and licensing related information: IP address of the server where Inspire Content
Manager (VCS) license manager is running (in case of Net licensing), computer License IDs
and dongle ID (in case a dongle is used for licensing).

See the document Public Licensing Guide for details on licensing and guidelines on how
this information can be used.

4.3 Workflow Window Toolbars

In this section: See also:
Standard Toolbar Workflow Window Menu
Zoom Toolbar Workflow Window Overview
Alignment Toolbar Workflow Options Dialog

The tables below briefly describe the functions of the tools available on the toolbar in the
Workflow window. By default these icons are included in the toolbar below the menu at the
top of the window but that can be clicked on, selected and moved to your preferred location.

If you need to add new functions to the existing toolbars or even create a new toolbar, right-
click on the grey toolbar area and select the displayed Customize option. For more information
see the section Customizable Toolbars.

4.3.1 Standard Toolbar

This toolbar activates tools that relate to options that can also be found in the Workflow Window
Menu.

Options Description

Delete Deletes the selected module(s) from the Workflow Area. You will be prompted to
verify the action before the module is deleted. This action cannot be undone.

Shortcut: <Delete>

40
 4.3 Workflow Window Toolbars

Refresh Reloads all used files. Used, for example, if data files may have been updated
with new data that needs to be included in your workflow.

Update External Objects When selected (icon shows as depressed); then each time a
workflow file containing external objects is opened those external objects are reloaded to
ensure that their content is current within the workflow.

If not checked, then content of the external objects is not updated in the workflow.

Tip Consider switching the updating off when a large number of external objects (tens
or hundreds) is in the workflow file and it would take a long time to update the objects
on every opening of the file.

Show Images as Full Resolution See the section Layout Window Menu for the description
of this option.

Intelligent Connections Turns the intelligent (bendy) connections on and off.

For more complex workflows turning off the intelligent connections reduces the data
processing time.

Run Production Opens the Production window with the selected workflow loaded to it.
From there you can control Inspire Designer output.

Alternatively, if you are using the Data Output Module module the Production window
will not open and the output will simply be saved to the file selected there-in.

The workflow is pre-processed here, therefore if, for example, a data input file is missing
then an Error dialog will appear and brief details of the problem will be shown in the
Verify window-pane.

Production will not run without a Layout or an Output module in the workflow. If there
is more that one output possibility it will run the one that is selected as Use for production.

Shortcut: <F5>

Run Proof Executes the workflow and opens the Proof window with a view of the current
output of the workflow displayed.

Production will not run without a Layout or an Output module in the workflow. If there
is more that one output possibility it will run the one that is selected as Use for proof.

Shortcut: <F6>

Selection Tool When selected (icon shows as depressed) the mouse pointer is a selection
tool. It can be used to select objects (modules, links etc.) in the Workflow Area.

Label Tool When selected (icon shows as depressed) the mouse pointer is the Label Tool,
enabling you to label the Workflow Area.

This tool is useful for writing notes in the Workflow Area to help identify what various
sections of a workflow do at a glance.

Profile Data Tool When selected (icon shows as depressed) and when the workflow is
run in Production or Proof, then the time that each module took to process its tasks will
be displayed graphically on the face of the module in the workflow.

41
4 Workflow

This helps you to identify, at a glance, areas in which to try and optimize your workflow.
Those modules which have longer processing times could possibly be configured better.

Example The screenshot below is of the data processing section of a workflow

that has been proofed with the Profile Data tool active.

For more details see the separate section Profile Data Tool.

4.3.2 Zoom Toolbar

This toolbar activates tools that aid the viewing of workflows in the Workflow Area.

Options Description

Zoom in Zooms in. Magnifies the workflow so that you can take a closer look.

Shortcut: <Ctrl>+<+> (+ from the number keypad).

Zoom out Zooms out. Shrinks the appearance of the workflow so that you can take an
overview.

Shortcut: <Ctrl>+<-> (- from the number keypad).

Center Centers the view so that the middle of the workflow appears in the middle of the
Workflow Area.

Shortcut: <Ctrl>+<*> (* from the number keypad).

4.3.3 Alignment Toolbar

This toolbar activates tools that line up selected objects (modules and/or labels) within the
Workflow area. This feature helps organizing more complex workflows.

42
 4.3 Workflow Window Toolbars

Example The two screenshots below show a part of a disorderly workflow that has
been reorganized/optimized using the Center selected objects horizontally option of
the Alignment toolbar.

Before:

After:

Options Description

Align selected objects left Positions the selected objects in line with the furthest left
object that is selected.

Align selected objects right Positions the selected objects in line with the furthest right
object that is selected.

Align selected objects top Positions the selected objects in line with the uppermost object
that is selected.

Align selected objects bottom Positions the selected objects in line with the lowermost
object that is selected.

Center selected objects horizontally Centers the selected objects horizontally (along
the X-coordinate).

Center selected objects vertically Centers the selected objects vertically (along the Y-
coordinate).

43
4 Workflow

4.4 Module Tree

Workflow building involves selecting required modules from the Module Tree and placing them
in their logical order across the Workflow Area, connecting each module to the previous
modules as they are added.

The Module Tree is located in a separate window-pane of the Workflow window. This is dis-
played by default but it can be opened and closed by going to: Window | Show Module
Tree.

It is an expandable explorer-type tree that lists every module that can be used in the workflow.
From here each of the listed modules can be selected and placed onto the main workspace
either by double-clicking on them or by dragging and dropping, aiding a more rapid construction
of workflows.

Right-clicking in the window-pane offers a context menu which has two options (available also
in the Workflow Editor tab of the Workflow Options dialog):

Sort Modules If checked, modules are sorted alphabetically within each module
group.

Show Small Icons Enables you to switch between smaller and larger module icons.

A brief description of the module groups appears below. For further details about the function
of each of the individual modules follow the links.

Data Inputs Read data from data files to create data variables.

See the separate section Data Input Modules Overview for a list of these modules.

Data Processing Modules Manipulate the data variables in order to achieve a suitable
set of variables for a design.

44
 4.5 Workflow Options Dialog

See the separate section Data Processing Modules Overview for a list of these modules.

Layouts Arrange variables and other objects in a document design.

The are the following layout type modules available:

Layout A document design window that offers many editing tools.

See the separate section Layout Window Overview for an introduction to this
module.

Inspire Native A module that allows the import and collation of previously prepared
document design files in the Inspire Designer, PostScript or other native formats.

See the separate section Inspire Native Module for details about this module.

XSLFO A module that allows the import and FO format definition files for XML
documents.

See the separate section XSLFO Module for details about this module.

Impositioning Modules Collate the designs for the document in preparation for a print
medium.

See the separate section Impositioning Modules Overview for a list of these modules.

Outputs Define parameters for medium selection and the intended printing device or
method.

See the separate section Output Modules Overview for a list of these modules.

External Workflow Modules Allow the building of complex workflows by connecting

two or more workflows together.

4.5 Workflow Options Dialog

See also:
Layout Options Dialog
Proof Options Dialog
Production Options Dialog

The Workflow Options dialog (File | Options) in the Workflow window enables you to adjust
your environment and other parameters. On the left of the dialog there is a tree, it has the
following groups of options:

General Options

General Workflow Options

Current Workflow Options

45
4 Workflow

4.5.1 General Options

Besides the General Options section itself there are also the following sub-sections available
where further settings can be made:

Auto Save

Fonts

Color Management

Scripting

PTF Import

Used Files Conditions

Secure Data

Message Colors

Inspire Content Manager

Media Bin Retrieval Tasks

File Open Dialog

Caching

Workflow Editor

Recent Files

Personalized URL

Data Input Module Properties

Default Hyphenator

46
 4.5 Workflow Options Dialog

Options Description

Load environment on startup If checked, loads the workflow environment (i.e. a space
organization of window-panes and their presence or absence in Inspire Designer GUI) on
startup.

If you change the default window-panes organization, it is necessary to save it in the

window menu select Window | Save Environment. The box is checked by default.

Auto open layout after load If checked, the Layout module (if it is included in the workflow)
automatically opens after the load. The box is not checked by default.

Show splash screen If checked, every time you start Inspire Designer a splash screen shows.

Note If you use Force Login option, a splash screen always shows.

Show startup dialog If checked, every time you start Inspire Designer a startup dialog shows.
It allows you to open an existing file, start a new job, go straight into the Production or
Proof window.

Open associated files in new window If you have WFD files associated with Inspire De-
signer and this option is checked, a new instance of Inspire Designer will be run for each
of the WFDs you double-click on.

Note This feature is not supported by the Mac version of Inspire Designer.

Theme The drop-down menu enables you to set a Inspire Designer GUI theme (also called
skin); the Classic, Windows XP (set by default for the Windows XP system with the XP

47
4 Workflow

theme selected) or Windows 7 (set by default for Windows Vista and 7 systems) skins are
available.

Note Mac OS X users can switch between Original skin (equivalent to Classic skin) and
Aqua skin (i.e. Mac skin).

Theme font size factor (%) Values of the font size factor are set by default and change
automatically as the GUI skin is changed. The default font size of the GUI skin can be
overwritten and customized within the range of 50 and 130%. Various font types can be
set in Fonts in the Workflow Options Dialog.

Default encoding From the drop-down menu you can select a default encoding. UTF-8 en-
coding is selected by default.

For more details, see the separate section Text Encoding.

Enable external objects logging If checked, updates concerning variables used as external
objects are logged to a file called updateExtObjects.log which is automatically created in
the application directory. See the Logging of External Object Updates section for details.
This check-box is not selected by default.

Defragment workflow during save Organizes and combines data for better disk utilization.

This also includes used files (only the files that are actually being used, not necessarily all
of those referenced in the Used Files dialog). The option is checked by default.

Temporary directory Enables you to choose the folder where temporary files (preprocessing,
production) will be saved.

Worldwide support If checked, an enhanced support for languages with right-to-left

reading order (Arabic, Hebrew, Indic, etc.) is available. This means every new flow area
will have its Worldwide support property set according to this setting.

See Arabic, Hebrew, Indic Languages Support

Supplementary characters support If checked, supplementary characters are supported

in any newly created flow area, i.e. the Supplementary characters support option in
the Layout Properties will be enabled for them. This option will be enabled also in Charts,
Text On Curve, Scripted Areas Layout Properties and Text Engine Configuration.

The surrogate pairs will be correctly displayed as one character in all controls, including
CSV Data Input preview. However, for correct parsing of a fixed length data file, you need
to use the Supplementary character support option there.

Supplementary characters are the ones that are defined in Unicode on top of the original
65,536 that were definable within the 16-bit starting limit.

Date time format Sets the date and time format for the DateTime type.

DPI for pixel units Sets DPI for pixel units. This is important for a correct conversion of values
when pixels are used as the measurement units in Layout.

The value set here is applied also for rasterized objects in PDF files imported natively into
Layout.

Note It is necessary to set here the resolution requested for your output if you want to
print barcodes using the Align to pixels functionality.

48
 4.5 Workflow Options Dialog

Measurement units Sets default units used in Layout and in the Output module.

License timeout (in minutes) Sets after how long inactivity of the user the license is released
to be available for another user. If the inactive user is getting back to his/her work, the
availability of the license is checked first and if not available, the user is forced to save the
work and has to wait till the license is available. This feature is especially useful when you
have less licenses than users.

This applies to Workflow window, Layout window and Line Data Input module in Inspire
Designer with the Net license.

No need to have any special settings in License Manager.

4.5.1.1 Auto Save

Options Description

Save before run or proof workflow If checked, the save operation will be automatically
done before you run or proof your workflow.

Save periodically in n minutes If checked, you can set the frequency of the auto save op-
eration.

Make backup file on save If checked, the backup file will be automatically generated on
the save operation.

4.5.1.2 Fonts

Options Description

Proportional system font From the drop-down menu the required proportional font can
be selected. The Arial proportional font is set by default. The font selected here determines

49
4 Workflow

the content of the Insert Character Palette displayed after pressing <F2> while editing a
field.

Linked proportional system font Enables you to link the font selected from the drop-down
menu to the main proportional font and append characters of the linked font that are
missing in the main font. The drop-down menu selection list can vary according to the
wide range of fonts installed in the system of each user, e.g. the special font type of a
Chinese corporation, a cosmetic company font, etc.

Non-proportional system font From the drop-down menu the required non-proportional
font can be selected. The Courier New non-proportional font is set by default.

Linked non-proportional system font Enables to link the font selected from the drop-
down menu to the main non-proportional font and append characters of the linked font
that are missing in the main font. The drop-down menu selection list can vary according
to the wide range of fonts installed in the system of each user.

Font antialiasing The drop-down menu contains the list of options concerning the font
antialiasing (i.e. the technique for eliminating jagged edges of text). The Always Hinted
option is selected by default.

Note Font hinting (also called grid-fitting) is the process of adjusting a vector font to
make it line up with the grid into which it is rasterized. It is important mainly for fonts in-
tended to be legible at small size on low resolution output device.

National font names From the drop-down menu the required national font can be selected.
The None option is selected by default.

4.5.1.3 Color Management

The color management functionality enables you to see images in the Layout more realistically.
To be able to see them in the way they will look when printed on a specific printing device, it
is necessary to apply printer specific CMYK color profile for layout environment (not proof en-
vironment) via the Proofing profile option.

Your screen as RGB device may require also some color reductions for more precise color
viewing. This can be done via the Monitor profile option.

50
 4.5 Workflow Options Dialog

See the different configurations of ICC Profiles with their explanation and the influence on a
sample image below. All settings are related to how you see the sample image in the Layout.
To learn more about ICC Profiles settings for proofing and production see ICC Profiles section.

1. This is a default state. The Enable color management option is not checked. See an
image sample below.

2. If you check the Enable color management option, the colors of the monitor will be
converted according to the set Monitor profile, so you see more exact and real colors.
The point is that when you design RGB colors, your monitor has different properties
(e.g. gamma, etc.) and you do not see exact and real colors. However, the changes are
very slight, practically invisible.

3. If you check the Enable proofing option, the colors will be converted from the Layout
RGB profile to the printer profile and then from the printer profile (e.g. CMYK) to the
monitor profile. So you see the colors the way they will look when printed. See an image
sample below.

51
4 Workflow

Note This option means displaying the colors in the Layout in the way they will look
when printed, not in the Proof.

4. If you check the Gamut check option, the colors of the image which your printer
cannot print (the closest printable color will be used for printing) will be marked with
the defined color. See an image sample below.

Example An image with different settings:

Enable color management is Enable proofing is Gamut check is

not checked. checked. checked.

52
 4.5 Workflow Options Dialog

Options Description

Enable color management Defines whether Color Management functionality will be used.
By checking this option, further options will be enabled.

Monitor profile Lists all monitor profiles (ICM files) that were previously added using the
Add Profile button (the profiles can be found on C:\Program Files\Inspire De
signer\Normalizer7\ICCProfiles).

Rendering intent Enables you to select the rendering intent applied to color objects within
the layout window, i.e. you select your priority (e.g. Saturation) because all color properties
cannot be kept. The other color qualities will be slightly modified.

Enable proofing Enables you to select real-time proofing, i.e. in the Layout you will see the
colors the same way as they will look when printed.

Note This option requires significant processing time.

Proofing profile Lists all output profiles (*ICM files) that were previously added using the
Add Profile button.

Proofing intent Enables you to select the proofing intent applied to the color objects within
the layout window, i.e. you select your priority (e.g. Saturation) because all color properties
cannot be kept. The other color qualities will be slightly modified.

Gamut check Checks whether a particular range of colors can be produced on a specific
printer. When the intended color is out of target device color range, it is shown in the
defined color.

Gamut warning color Selects a warning color for not printable ranges of colors.

See also ICC Profiles and ICC Profiles Layout Properties sections.

4.5.1.4 Scripting

53
4 Workflow

Options Description

Auto show hints after dot If checked, shows scripting hints after you type a dot.

Show getters If checked, it shows so called getters (getter is a method that returns inform-
ation about the state of an object or a class, it does not alter their status) in the scripting
dialogs, e.g. getField0, etc.

Note It is recommended to keep this option unchecked.

Highlight code If checked, the key code words are highlighted in color.

Use Simple Expression dialog If checked, the Simple Expression dialog (instead of the Script
Editor) opens whenever the code is simple enough to fit this dialog window. Simple Ex-
pression dialog enables you to edit simple conditions which return Boolean value.

Suggest also byte mode and surrogate functions If checked, it shows methods in the
scripting dialogs for strings that use double-byte characters and surrogate pairs (a coded
character representation for a single abstract character that consists of a sequence of two
code points).

Font size Selects the font size of the code in the script edit field.

Indent type If set to Indent bracket, the code is indented according to the context. If set to
None, no indentation is applied and the code is inserted at the point where the cursor
stands.

Text color Selects the color of texts.

Key word color Selects the color of keywords.

Type color Selects the color of types.

Comment color Selects the color of comments.

Operator color Selects the color of operators.

String color Selects the color of strings.

Correct brackets color Selects the color of correct brackets.

Wrong brackets color Selects the color of incorrect brackets.

54
 4.5 Workflow Options Dialog

Scripting Shortcuts
This panel enables you to customize shortcuts for scripting and the Script Debugger function.
Simply click into the field representing the desired action and press the key(s) making your new
shortcut.

4.5.1.5 PTF Import

Note This feature is not supported by Mac version of Inspire Designer.

This feature enables you to import jobs from PrintNet 3 and modify the import parameters.

Options Description

Add flow area height Enables you to make a flow area larger to be able to cope with the
font size adjustments during import.

Round font size If checked, font size gets rounded to the nearest integer number.

Use default data file If this option is checked AND the PTF file contains the default datafile
name, the datafile defined in PrintNet 3 job will be set as default in Inspire Designer.

Import barcode as GSR font If checked, barcodes from PrintNet 3 are imported as GSR
font and you can compose/modify them in Layout using this font.

55
4 Workflow

If unchecked, barcodes from PrintNet 3 are replaced by the same kind in Inspire Designer.

4.5.1.6 Used Files Conditions

By setting conditions for files used in a workflow, it is possible to define the default behavior
when opening a workflow with modified or missing used files. A sample setting can be seen
below.

This is useful when you want to open a job simply to work with some of its content, for example
data, and therefore don't need the modified or missing files of a different type, e.g. images.
The dialog covers three scenarios:

If files on disk and included are different

If file is different

If file does not exist

For each scenario you set the File Type and the Answer Type.

Options Description

File Type Corresponds to the groups of files that can be used in a workflow. A file is assigned
to a group automatically by Inspire Designer but it is possible to change the assignment
or to define a new group in the Used Files dialog.

If the group of files selected in the File Type does not have any file(s) assigned, the beha-
vior selected from the combo-box under Answer Type option will have no effect. The
behavior applies to any files of the given type (group of files).

You can enter your own type name or select one of the predefined options.

56
 4.5 Workflow Options Dialog

The predefined options are:

Image

Font

Data

ICC profile

External Layout

Others

Answer Type Sets the behavior that applies to the selected File Type for any workflow being
opened.

Show dialog Shows the Used Files Update dialog when the condition in the
scenario is met.

This is the default behavior when opening any workflow which uses modified/miss-
ing files, if no conditions have been set here.

Browse Browses for a file to substitute any non-identical or missing file assigned
to the workflow.

After selecting the browsed file, a dialog that names the found file appears together
with relevant buttons allowing the user to select a subsequent action as explained
in the Used Files Update dialog.

Use Uses the modified file for this session only, i.e. the file is assigned to the
workflow temporarily.

Replace Replaces the original file in the workflow with the modified file, i.e. the
replacement file is assigned to the workflow permanently.

Note The replace action cannot not take place if the workflow is opened as read-
only, instead the replacement file opens temporarily.

Skip Skips the loading of the file that has been modified, deleted or changed its
location before opening the workflow.

The workflow opens so the user can work with its modules not affected by the
skipped file and the whole workflow can be saved. However, because there is a
file that has not loaded, you will receive an error message if the workflow is pro-
cessed, for example in Proof or Production.

Use included Uses the file that was originally included in the workflow instead
of the modified file currently found on the disk.

Such a situation can only happen if the file used in the workflow has been set to
Include in the Used Files dialog.

57
4 Workflow

4.5.1.7 Secure Data

These options enable you to design a job with an encrypted data file and proof it, i.e. the data
are legible (decrypted) in the data input and Proof. For more details see the section Secure
Printing.

Options Description

Use this security context in design If checked, the below defined keys will be used for
designing a job with encrypted data. The data will be legible (decrypted) in the data input.

Use this security context in proof If checked, below defined keys will be used for proofing
a job with encrypted data. The data will be legible (decrypted) in Proof in both the Sheet
as well as Data tabs.

Public key ring Enables you to browse for a public part of the key installed on your computer.
Public key ring is needed for encrypting the data.

Secure key ring Enables you to browse for a secure part of the key installed on your com-
puter. Secure key ring is needed for decrypting the data.

Key ID After you click on the Create New icon, a new key item is created in this field.
Using its combo box you can select from keys installed on your computer.

Passphrase Here you need to enter the matching pass phrase for the given key, which was
set during installation of PGP for the key. If you enter an incorrect pass phrase, you get
no warning and the data remains unreadable.

Create New Adds a new key and a pass phrase.

Delete Removes the selected key and pass phrase.

4.5.1.8 Message Colors

58
 4.5 Workflow Options Dialog

This panel enables you to change the colors used of each of the types of messages and warnings
that appear in the Log window-pane when the workflow is processed in Proof and Production.

Message categories are internal and cannot be tracked in the GUI.

4.5.1.9 Inspire Content Manager

You must be logged in to Inspire Content Manager to adjust these settings, which are applied
to that ICM server which you are logged in to.

Options Description

Preferred branches / Branches Determines which branches should be used (in order of
preference) for each file opened from Inspire Content Manager.

This is an alternative place to set preferred branches to the Preferred Branches dialog found
in ICM explorer. See the separate section Preferred Branches.

Cache size (MB) Sets the size of cache (in MB) where that temporary files that are downloaded
from the server are stored.

This way users can control their hard disk space usage. The default cache size is set to
2000 MB (i.e. 2 GB), however there is no explicit recommendation for the size.

Default Layout task / Default Proof task / Default Production task Select default retrieval
tasks for MediaBin files (used in Layout / Proof or Production) for all files stored on the
ICM server.

See Retrieval Tasks for MediaBin files in the MediaBin section.

59
4 Workflow

4.5.1.10 Media Bin Retrieval Tasks

Options Description

Layout task / Proof task / Production task Select retrieval tasks for Layout / Proof / Pro-
duction for the currently opened workflow only. See Retrieval Tasks for MediaBin files in
the MediaBin section.

4.5.1.11 File Open Dialog

You can set here the default application's behavior when opening versioned files.

Option Description

Default enhanced ICM open If checked, the Enhanced ICM Open dialog always opens
when opening versioned files.

4.5.1.12 Caching

Options Description

Use PDF/EPS raster cache for layout If checked, enables caching images and increases
speed for Layout opening.

Cache size (MB) Enables to set the required cache size.

PDF/EPS cache directory By clicking on the Browse icon select the location where images
will be cached.

60
 4.5 Workflow Options Dialog

4.5.1.13 Workflow Editor

Options Description

Use touch selection Changes the way of selecting modules in the Workflow Area. If checked,
it is not necessary to include the whole module in the selection area to select it, any section
of the module will do.

Sort modules alphabetically If checked, modules within the module groups will be sorted
in alphabetical order. The option is also available in the context menu of the Module Tree.

Show small icons If checked, modules in the Module Tree will be shown as small icons in
the group color. This option is also available in the context menu of the Module Tree.

Show New Workflow dialog If checked, the New Workflow dialog will open when File |
New Workflow is selected from the Workflow Window menu.

Workflow description Allows you to select the font color used in the information about
currently opened file in the Workflow.

Show templates thumbnails If checked, templates are displayed as thumbnails in the

Templates window-pane in the Workflow window.

Templates directory Specifies the directory where templates are stored.

4.5.1.14 Recent Files

Options Description

Recent files count Specifies the number of recently opened WFD files offered in the Startup
dialog.

61
4 Workflow

4.5.1.15 Personalized URL

This panel enables you to define settings for the Personalized URL module. The settings will be
automatically pre-filled in the edit fields of the modules Settings tab when the module is
connected to the workflow. See the Personalized URL Module section for options explanation.

4.5.1.16 Data Input Module Properties

Fixed Length Colors Enables you to set the colors used in the Preview area on the Properties
tab of the Data Input module when working with Fixed Length data files.

Selected field color Defines the background color of the selected field.

Field color 1 Defines the background color of the odd fields (the selected field is disreg-
arded in this count).

Field color 2 Defines the background color of the even fields (the selected field is dis-
regarded in this count).

Key color Defines the background color of the default key field (defined using the Key
field position and Key field size options), see the Multiple Record Type Files section
for details.

Field left separator color Defines the color of the line that marks the beginning of a
field.

Field right separator color Defines the color of the line that marks the end of a field.

CSV Options Enables you to set default values for options available on the Properties tab of
the Data Input module when working with CSV data files.

62
 4.5 Workflow Options Dialog

Changing the values influences only settings in the Data Input modules inserted into a
workflow following the change.

Default field separator Sets the value (a single character or a string) pre-filled in the
Field separators edit-field on the Properties tab. To define a string as a default field
separator, precede it with double number sign/hash mark (##).

Default text qualifier Sets the value pre-filled in the Text qualifiers edit-field on the
Properties tab.

Note When loading a new file to the Data Input module or clicking on the Auto Detect
button available on the Properties tab, a notification dialog will be displayed if Inspire De-
signer detects field separators or text qualifiers which differ from the default values defined
here.

4.5.1.17 Default Hyphenator

Use Talo hyphenator as default in new workflows If checked, Talo hyphenation is used
for all newly created workflows.

4.5.2 General Workflow Options

The General Workflow Options section consists of the following sub-section:

Shortcuts

63
4 Workflow

4.5.2.1 Shortcuts

This options dialog panel lists shortcuts assigned to the current workflow. It also allows you to
add new shortcuts and edit or remove the existing ones.

Options Description

Active shortcut set Choose here between the option Default (the set intended for Windows
users) and Mac.

Action, Shortcuts Lists the available actions of the application and the shortcuts assigned
to them.

New Adds a new shortcut for the selected action. When the Edit Shortcut Keys dialog appears,
just press the keys of which the new shortcut should consist of. If the new shortcut is
already assigned to some other action, a warning with the name of this action will be
displayed.

Edit Enables you to edit an existing shortcut.

Remove Removes the selected shortcut.

Note Using single characters as shortcuts is not possible.

64
 4.5 Workflow Options Dialog

4.5.3 Current Workflow Options

Options Description

Read complete record data into memory If checked, the whole record is read into the
application memory and is stored there while that record is being processed.

If unchecked, only those records' values that are needed for processing are stored in the
memory. This is useful if your records are particularly large and could cause the system to
run out of memory.

Force CMYK to CMYK ICC transformation If checked, Layout colors defined in CMYK are
recalculated (just like colors defined in other color spaces) into the required CMYK ICC
profiles in Production.

See also ICC Profile Setting and Color Space Transformation Examples.

Preserve black in ICC transformations If checked, black colors are recalculated to become
pure black, i.e. defined in CMYK as C: 0, M:0, Y:0, K:100.

This ensures that pure black ink is used for printing black color, instead of a mix which
unnecessarily includes all colors.

If K = 100 for a color in Layout, any other values will be replaced with 0, e.g. C: 15, M:50,
Y:0, K:100 becomes C: 0, M:0, Y:0, K:100. Also some ICC profiles have black defined as
a mix of colors with black not quite at 100, (e.g. C: 95, M:90, Y:90, K:99.7) these would
also be recalculated as C: 0, M:0, Y:0, K:100. Pure black is applied to other color spaces
(e.g. R: 0, G:0, B:0 ) that may be applied by an engine configuration in Production.

Read image resolution from Exif data This feature applies to JPEG images used in a
workflow. If enabled (by default for WFD files saved in PrintNet T version 6.1 and later),
the DPI of JPEG images is taken from their Exif data.

This option is by default disabled for workflows saved in PrintNet T version 6.0 and earlier.
For JPEG images loaded with the Read image resolution from Exif data option disabled,
the DPI value is searched for in the following order:

1. in the images' basic definition,

2. in the resource tag attached to JPEG images created in Photoshop,

3. in the Exif data.

If no DPI data are available, then Inspire Designer applies DPI 96,96.

See also the Images section.

65
4 Workflow

Use Talo hyphenator If checked, extended hyphenation (provided by Talo) is available in

the workflow currently opened in Inspire Designer (it can also be switched on by default
for all new workflows). Due to this extension, also deviant hyphenations and special cases
can be used.

Example Examples of special hyphenation:

German (old): Schiffahrt -> Schiff-fahrt

Hungarian: sszes -> sz-szes

The Talo hyphenation is not a part of Inspire Designer installer, it is provided on request.
When provided, the Talo directory with appropriate resources has to be placed to the redist
directory that is currently in use.

If the Talo directory is not available and this option is checked, the Layout contains nonhy-
phenated text and the Proof reports a fatal error.

The Talo directory also contains the talomap.xml which provides a list of languages sup-
ported by Inspire Designer.

<talomap>
<oem number="xxxxxxxxx" code="@xxxx-xxxx-xxxx-xxxx-xxxx"/>
<lang t="en" talo="69"/>
<lang t="en_us" talo="65"/>
<lang t="cs" talo="84"/>
<lang t="de" talo="68"/>
...
<lang t="el" talo="76"/>
<lang t="tr" talo="116"/>
</talomap>

Languages in this file are mapped (via the code numbers) to the list of languages supported
by Talo (available in languages.h).

Tip To achieve best speed results, ensure that you always use the newest Talo hyphen-
ator version.

Decimal tabulator grouping symbol Specifies the symbol used as a decimal tabulator in
DOC file imported into Inspire Designer to keep the number alignment.

The Current Workflow Module Options section has also the following sub-sections:

AFP Native Import

DOC/RTF Native Import

PCL Native Import

PDF/PS Native Import

66
 4.5 Workflow Options Dialog

4.5.3.1 AFP Native Import

The AFP import settings are divided into four sections:

AFP Import

MODCA

Linedata

Colors

The settings made in these sections are applied when you:

Import an AFP file using the Inspire Native workflow module.

Use the native import menu option to import an AFP file into Layout.

Import an AFP file into Inspire Designer as an image.

Use AFP Index module.

If you open an AFP file to Proof or Production, default settings are used. If you set your
preferences in the AFP Import dialog and click on the Save as Default button, then
your preferences will be used (as default) also when opening a file of this type in Proof
or Production.

Any settings for the AFP import are applied and kept only within the respective workflow.
Make sure to select the required AFP import settings for each workflow you intend to use for
AFP files import.

The imported AFP files are checked for validity. Files not compliant with AFP specification can
be refused.

Please remember that correct AFP import functionality has to be verified both in proof and in
the output file.

Note When using the Proof environment as an AFP-viewer (by dropping an AFP file into the
Sheet Proof window or by opening it with the Open menu option available in the Sheet Proof
window), the default settings from all AFP import dialogs are applied.

See the AFP Engine Configuration section for information about the AFP output format.

67
4 Workflow

Options Descriptions

Resources

Resource Directory Resources of AFP files are normally located within the AFP file itself
or in the same directory as the AFP file. In these cases, it is not necessary to specify
a directory in this field. Directories set here are used if resources are located in locations
other than the two mentioned.

Displays the path to the resource directory. Use the Add New icon to add more
directories and the Move Up and Move Down icons to set the order in which
the directories will be searched.

Recursive Sets if also the subdirectories of the selected resource directory will be
searched. The options are: Non-recursive (only that directory is searched) and Recursive
(all subdirectories are also searched).

Formdef Sets the default AFP formdef (form definition) file, which defines for each page
a media definition (simplex/duplex, used tray and media size definitions). This formdef
is used if the imported AFP file does not contain an included formdef file or when
the Override included formdef option is enabled (see below).

When determining the form definition file to be used, Inspire Designer proceeds the
following way:

Override included formdef If checked, the formdef file included in the imported
AFP file is overridden with the one indicated in the Formdef edit-box.

68
 4.5 Workflow Options Dialog

When determining the form definition file to be used, Inspire Designer searches
for a formdef that will be employed in the following order:

1. The formdef can be set in the AFP form definition file in Inspire Production
Console using the -wsmafpfd filename parameter.

2. The formdef specified in the Workflow/Layout Options is used if the

Override included formdef is enabled.

3. The formdef included in the in the AFP is employed if Override included

formdef is disabled.

4. The default formdef set in the GUI is used, if no formdef is included in

the AFP.

If the specified default formdef is not found, a warning is generated while loading
the AFP file. When the formdef is not found and the Override included formdef
option is enabled, the import will end with an error.

Preferred font DPI If there are more fonts of the same type that differ only in DPI, you
can determine which font will be used by setting its DPI in this edit field.

Terminate import if resource is not found Sets the behavior if resources belonging
to the AFP file being imported cannot be found. When this option is checked, the
import procedure will only be performed if all resources can be found. If not selected,
the import procedure will be performed even if some of the resources cannot be
found.

Select this option if you only want to import complete AFP files (i.e. AFP files without
any missing resources).

Media

Medium mode If checked, N-up or duplex are represented if they have been applied
in the AFP file.

Example A 2-up arrangement from the AFP file will result in the contents of
two AFP pages being placed onto a single page in Layout.

Apply medium orientation If checked, then the orientation of the AFP pages will also
be applied in the workflow, e.g. to the page in Layout.

This option is only active if Medium mode has been checked.

Font Substitution

Default font encoding If the imported AFP file uses font encoding that cannot be re-
cognized from glyph names, it is possible to define here a default font encoding that
will be used in such cases. Typically it is not necessary to specify the encoding. It is

69
4 Workflow

needed only if you intend to work with the text in the imported AFP file, e.g. using
the Text in Rect module. See also the section Text Encoding.

Font definition directory Sets the directory containing font definitions (in the form
determined by the IBM AFP Workbench).

Save as Default Saves the inserted settings as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default settings.

Note In order to optimize the processing of the imported files, limits of file size and number
are set. See the table below for the default values and the customization strings, that inserted
into the CONFIG file, allow to edit the limits values.

32-bit 64-bit

Default cached files limit Size 500MB 2GB

Count 20 20
CONFIG file customization Size [B] NativeImportImageCacheSize
string
Count NativeImportMaxCachedImageCount

MODCA
Settings defined in the MODCA (Mixed Object: Document Content Architecture) section are
applied when document architecture settings are not found within the imported AFP file.

Options Description

Default Medium Size Sets the default page size. This may be needed for importing page
segments (containing objects with undefined size), as they do not carry information about
their own size. For details about Size, Width and Height options and the related icons
see the Output module.

Maximum DPI Sets the maximum DPI of the intended printer. This setting influences mainly
DPI of the AFP patterns, that should be printed in the printer's DPI.

Note It is necessary to set the Maximum DPI option to the same resolution value that
is intended for the spool file.

70
 4.5 Workflow Options Dialog

Show parse warnings If checked, all warnings, including those about minor parsing problems
(e.g. constant data mismatch, wrong size of elements), will be listed while the AFP file is
importing.

Warnings show either in the Native Import dialog or in the Log window-pane depending
on where the AFP file is imported.

If unchecked (by default), only major and fatal errors will show and a general warning in
the log will inform about undisplayed detailed warnings.

Save as Default Saves the inserted settings as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default settings.

Linedata
AFP Linedata is an AFP type, where the actual data are distinguished from the intended docu-
ment form definition. That form is defined in pagedef.

This section allows you to define settings for processing all data used as linedata. As a wide
range of data can be used as linedata, its detection is not automatic. Certain level of expertise
and knowledge of the processed data files is necessary to apply the required settings for a
successful import. Wrongly specified settings will result with an error while processing the file.

Options Description

Treat unrecognized files as linedata Files of many formats (e.g. PDF) are imported into
Inspire Designer the same way as linedata. Inspire Designer detects the way of displaying
the data from the imported files and needs to know, what kind of data they are. As linedata
can be of virtually any format, Inspire Designer has not got an efficient way of detecting
them. To treat as linedata simply anything that Inspire Designer can not process otherwise,
could lead to confusing results. For example, an attempt to import an AVI file (a file format
that Inspire Designer can not import) into Layout, would result in a warning of unexpected
data in AFP instead of warning of an unknown file format. For that reason this option

71
4 Workflow

should be enabled (it is disabled by default) only if the user knows, that they import
linedata, and only then the warnings are valid.

Data Format

Line/record separation Specifies the form of delimiting particular records/lines of the

data file. The options are:

Stream (with line separator) Basic data stream divided into lines. Selecting
this option enables the Line separator check-box described below.

Record (2B length prefix) Each record starts with a prefix defining the respect-
ive record's length.

Fixed length record All records are equally long. Selecting this option enables
the Record length edit-box described below.

Line separator Specifies the line separator used for data stream with line separator.
The options are:

EBCDIC LF (0x25) (default)

ASCII LF (0x0A)

ASCII CRLF (0x0D0A)

UTF-16BE LF (0x000A)

UTF-16BE CRLF (0x000D000A)

UTF-16LE LF (9x0A00)

UTF-16LE CRLF (0x0D000A00)

The combo-box is active only when the Stream (with line separator) option of the
File format is selected.

Record length Specifies the length of individual records (in bytes).

The edit-box is active only when the Fixed length record option of the File format is
selected.

Data Interpretation

Carriage control Specifies whether carriage control characters are used and what kind.

The options are:

None

Machine

ANSI-ASCII

ANSI-EBCDIC (default)

Table Reference Characters If checked, indicates that Table Reference Characters (TRC)
are used in the imported AFP file. The TRCs are placed right after the carriage control

72
 4.5 Workflow Options Dialog

byte (or at the very beginning of each line, if carriage control characters are not used)
and define the fonts that need to be used for each line.

Data Presentation

Pagedef Pagedef determines the way the input data are displayed/printed (position,
size, font).

Click on the Browse icon to define pagedef that you want to use if there is no
valid pagedef within the imported AFP file. If the AFP file contains a valid pagedef, it
can be still overridden by a pagedef of your choice. See the description below.

Override included pagedef If checked, the pagedef in the imported AFP file is substi-
tuted with the one defined in the edit-box above. The option is useful for AFP files
that are built of mixed linedata and MODCA. Typically, in such cases the included
pagedef might need to be overridden. To Override included pagedef apply the
same rules as to overriding formdef; the console command is: -wsmafppd file
name.

Shift-out/Shift-in mode Shift-out (SO-X'0E') and shift-in (SI-X'0F') controls indicate

switching on and off the double-byte font characters usage. As the two control
characters are not valid printing characters, they are either not displayed or they are
substituted with spaces according to the selection of SOSI processing mode:

SOSI 1 The control characters are substituted with a space.

SOSI 2 The control characters are not displayed without any substitution
(default).

SOSI 3 The SO character is not displayed, SI is substituted with two spaces.

SOSI 4 The control characters are not displayed and they are omitted when
calculating offsets for the printed data.

Save as Default Saves the inserted settings as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default settings.

Colors
This dialog enables you to map highlight colors indexes used in AFP files to specific colors.
Useful when an AFP file uses highlight color indexes, because the information what color belongs
to the index is not known.

Note If no color mapping is set for an AFP file with highlight color indexes, the default color
(black) is used for each undefined index. A warning then specifies the unassigned highlight
color index(es) that you might want to change.

73
4 Workflow

Options Description

Highlight color mapping To add a mapping pair click on the Add New icon. In the
Highlight Color Index column select the color index as it comes from the AFP file. In the
Mapped Color column set the color you want to assign to the index. The setting is done
in the Color dialog that pops up after clicking on the 3 Dots icon at the end of the
row. If you use colorants, spot colors or dithered spot colors, it is also possible to make
appropriate settings in that dialog.

Note The only difference from the same Color dialog accessible from the Layout window
is that multiple colorants cannot be set. The reason behind this is that there are typically
not enough highlight colors with indexes in the imported AFP file to make colorant mixing
meaningful.

You can remove any mapping pair by selecting it and clicking on the Delete icon.

Name of black colorant If you work with colorants, it is necessary for correct performance
of shading operations to define the name of the black colorant.

Color for MICR font Set the color and/or colorant for the text in the imported AFP file for
which MICR font is applied in the Color dialog that opens after clicking on the 3 Dots
icon. The color will be used for the text and visible in Proof. Or, if you want to use the
MICR ink on your printer, specify the colorant name here and then assign the colorant
name to MICR AFP Color in the Assign AFP Color to Index dialog.

Save as Default Saves the inserted settings as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default settings.

AFP Import Known Limitations

AFP Features

LND Fully supported

Supported except for Graphics Descriptor
Supported with AFP
RCD (X'75E') Triplet ignored when detected and
limitations pagedef
a warning is displayed
XMD Not supported

74
 4.5 Workflow Options Dialog

AFP Features

Not supported barcodes:

MSI (modified Plessey code)

UPC Two-digit Supplemental (Period-

icals)
BCOCA
UPC Five-digit Supplemental (Paper-
backs)

USPS Four-State

Non-presentation object containers linked/collection True Type fonts,

PDF resources
ACMA (AFP Color Management Architecture)

Not supported IPG (Include Page)

Character precision of GOCA text
Resources inside page
Medium maps before page

Note If you get the following warning message: "The OID format of Fully Qualified Name
triplet is not supported." it means that a part of a Structured Field cannot be parsed and read,
but as it is not used during the import, it does not have any influence on it and the AFP will
be imported correctly.

4.5.3.2 DOC/RTF Native Import

Options Description

Conversion method Selects the medium via which any DOC, DOCX or RTF files will be im-
ported if they are imported natively:

Use TNO as intermediate format Converts DOC and DOCX format first to RTF
and then to TNO (Inspire Designer's own format) before being used in the workflow.

It allows for much faster processing, but please see the DOC and RTF Files Import
Known Limitations, because only basic DOC and RTF features are supported.

When importing a DOC file using this method, MS Word (version 2000 or later) is
used for conversion to RTF and that application must be installed on the same

75
4 Workflow

computer. This method is recommended for RTF import, because for RTF conversion
to TNO no external application is needed.

Use PDF as intermediate format Converts DOC, DOCX and RTF to PDF before it
is imported into the workflow. The conversion is done by the MS Word with no
Inspire Designer influence. Then the PDF is loaded natively to the workflow and so
the 'DOC and RTF files import known limitations' do not apply when this option
is used.

This method maintains the format of the original document and is recommended
to be used when formatting is used in a DOC or DOCX file, e.g. text-boxes or auto-
shapes. For this method, MS Word (version 2007 or later) is used for the conversion
to PDF and that application must be installed on the same computer. The creation
of PDF can take much longer depending on the size of document.

Note Native import of DOC/RTF is different to the direct import of these formats, which
is described in the RTF and DOC Import section.

4.5.3.3 PCL Native Import

The PCL native import settings are divided into two sections:

PCL Native Import

Highlight Colors / Colorants

The settings made in this section are applied when you:

Import a PCL file using the Inspire Native workflow module.

Use the native import menu option to import a PCL file into Layout.

Import a PCL file into Inspire Designer as an image.

Any settings for the PCL import are applied and kept only within the respective workflow.
Make sure to select the required PCL Import settings for each workflow you intend to use for
PCL files import.

Note

When using the Proof environment as a PCL-viewer (by dropping a PCL file into the
Sheet Proof window or by opening it with the Open menu option, available in the
Sheet Proof window), the settings made in this dialog are not applied.

When importing a PCL file natively and all required fonts are not embedded in the PCL
file (resulting in a warning in Inspire Designer), it is possible to find the names of the
missing fonts in the PCL Native Font Replacement dialog under the Import icon.

76
 4.5 Workflow Options Dialog

Options Description

Paper Size This default value is used in case the value is missing in the file itself. In the PCL
file format, ID numbers indicate to the printer the specific paper size. The Default paper
size options are:

Executive (1)

Letter (2) (default)

Legal (3)

Ledger (6)

A4 (26)

A3 (27)

Configure Sizes Opens the PCL Native Paper Sizes dialog that enables to add customized
paper size settings.

Default Text Encoding The text encoding (in the PCL Specification referred to as Symbol
Set) selected here is used when there is no encoding set in the imported PCL file. There
are two options:

Predefined encoding Enables to choose one of the PCL symbol sets. By default it is set
to PCL Roman-8.

Other encoding Enables to specify an ISO symbol set. By default it is set to US-ASCII.
See the Text Encoding section for more information.

Force default for all (for use in Text in Rect) If enabled, forces the encoding specified
in one of the encoding options above for all symbol sets of the imported PCL file. It
is disabled by default.

77
4 Workflow

This option needs to be enabled, if the imported PCL file is intended for editing in
the Text in Rect module; otherwise the document's text would be illegible in the Text
in Rect module. The imported file has to be generated with some text encoding em-
ployed. See also the Text Options tab section of the PCL Engine Configuration chapter.

Font replacement Replaces fonts used in the imported PCL file with fonts of your choice.

Click on the Configure button to open the PCL Native Font Replacement dialog.

Optimize fonts in PCL macro Use this option only when importing PCLs where fonts are
defined by macros.

When importing a PCL with fonts defined by macros, for each macro a new font is created
(even if that font has been already created), which may become memory-intensive.
Checking this option enables memory usage optimization by re-using the already created
(same) font. It is recommended to check the import thoroughly, if all glyphs were imported
correctly.

Recovery setting Specify how to handle errors in PCL command syntax. The options are:

Stop if malformed command (default) If wrong syntax of a command is detected,

the native import will be stopped.

Start after unknown command character If wrong syntax of a command is detec-

ted, i.e. the command is not valid, it is skipped, a warning is displayed and the
import continues. The remaining characters behind the error are displayed including
the text behind the command if there is any.

Start on next escape If wrong syntax of a command is detected, i.e. the command
is not valid, it is skipped, a warning is displayed and the import continues. The re-
maining characters behind the error, including the text behind the command if
there is any, are skipped and the import continues from the next escape character
('1B') which signalizes the start of the next PCL command.

Keep page order for duplex printing If enabled, empty pages are added (inserted) if you
print duplex and have only single pages.

PCL Native Paper Sizes Dialog

This dialog is opened by clicking on the Configure Sizes button in the PCL Import section of
the Workflow Options dialog.

78
 4.5 Workflow Options Dialog

The left-hand side panel of the dialog displays all defined paper formats, i.e., lists their name
and the PCL paper size ID number in brackets. Edit-boxes in the right-hand side panel display
and allow to edit the precise measures of the respective paper size option.

Options Description

Name Displays the name of the selected paper size option. Click in the edit-box to type or
double-click to select the existing name and replace it. Press <F2> to open the Insert
Character Palette.

PCL paper size ID Displays the selected PCL paper size ID number. Click in the edit-box and
type the selected number or use the arrows to change the number. If given number has
already been assigned to a size, a warning appears and the edition is not processed.

Size Displays the name of the defined paper size.

The options in the drop-down menu are:

Custom Appears when at least one of the size values has been edited.

A4 (210mm/297mm)

A3 (297mm/420mm)

A5 (148mm/210mm)

B5 (176mm/250mm)

Letter (215.9mm/279.4mm)

Legal (215.9mm/355.6mm)

Tabloid (279.4mm/431.8mm)

Compact Disc (119.944mm/120.65mm)

Manage Opens the Page Sizes dialog, where you can add new page sizes.

The list displays all page sizes defined within the workflow.

79
4 Workflow

The Landscape and Portrait orientation icons allow instant page orientation change.

Width Displays and allows editing the paper size width. Click on the measurement units to
change them (mm in the screenshot above; default setting for this option).

Height Displays and allows editing the paper size height.

Logical Page Margins The Portrait and Landscape edit-boxes display and allow editing
the logical margins for the chosen paper size. Click on the measurement units to change
them (px in the screenshot; default setting for this option).

Print area margin Displays and allows editing the print area margin. By default set to 0.1667
in.

Create New Inserts a new item.

Delete Deletes the selected item.

Load Loads previously saved settings.

Save Saves the defined settings to a file.

Page Sizes Dialog

Clicking on the Manage option in the Size drop-down menu opens the Page Size dialog. It
allows to create, view or edit customized paper sizes.

Options Description

Name Click in the edit box and type to enter a name for a new page size.

Width Click in the edit box and type to enter the width of the new page (specified in the
measurement units selected in the PCL Native Paper Sizes dialog).

Height Click in the edit box and type to enter the height of the new page (specified in the
measurement units selected in the PCL Native Paper Sizes dialog).

Move Up / Move Down Move the selected item up/down the list.

Create New Inserts a new item.

Delete Deletes the selected item.

80
 4.5 Workflow Options Dialog

PCL Native Import Font Replacement Dialog

This dialog is opened by clicking on the Configure button in the Font Replacement sub-section
of the PCL Import dialog. Here you can specify the characteristics of fonts that font replacement
concerns. Click on the Create new icon to insert a new editable item.

The first five columns (with PCL in the title) refer to the characteristics of the font in the imported
document(s). The remaining three columns describe the characteristics of the replacement font.

Note For a specified PCL font it is possible to enter more replacement fonts, but only one of
the them is used and a suitable warning is generated.

Options Description

PCL Font Type The drop-down menu in this column offers two options:

Fixed width (default)

Variable width

They refer to characters width, that can either depend on the shape of a character or have
a fixed value for all characters.

PCL Typeface Family Click in the edit-box to insert the required value. The default value in
this field is 0 [Line Printer].

PCL Stroke Weight Select here the thickness of the characters in the defined PCL font. The
drop-down menu in this column offers 15 options with values from -7 [Ultra Thin] to +7
[Ultra Black] with 0 [Medium, Book, or Text] being the default one.

PCL Font Style Click in the edit-box to insert the required font style value. Hover your mouse
pointer over the edit-box to see the tool-tip with more information on PCL font styles.

The default value in this field is 0 [Upright, solid].

PCL Font Symbol Set Specifies the symbol set used in the imported PCL file.

This is useful when an imported font contains several symbol sets and you want to replace
each symbol set with a different font. If you do not want to distinguish between symbol
sets within one imported font, use * in this column.

Font Sets the replacement font. Open the drop-down menu, that displays fonts available
locally.

Style Sets the replacement font's style. The options are:

Normal (default setting)

Bold

81
4 Workflow

Italic

BoldItalic

Create new Inserts a new entry.

Delete Deletes the selected entry.

Delete All Deletes all entries.

Load Loads previously saved settings.

Save Saves the defined settings to a file.

Import Imports fonts used in the PCL file.

Tip This can also be helpful if you need to find names of fonts that missing in a PCL file
when importing it natively.

Highlight Colors / Colorants

This tab allows to map highlight colors used in the imported PCL file. The highlight colors
other than black should be indexed starting from 1, as 0 is most commonly used for black.

Options Description

Highlight Colors / Colorants Mapping Maps any colorants used in the imported PCL file
to colors that will be used by the workflow.

HL Color Index / Colorant Name Identifies the highlight color / colorant, as it is found
in the PCL file.

Enter the index/name (e.g. OCT20A01 for black color) of the colorant that is used in
the syntax of the PCL file.

Mapped Color Creates the color that will be used in the workflow in replacement to
the PCL colorant.

Clicking on the 3 dots icon opens the Color dialog where you can set its colorspace
and particular values.

Create New Adds a new highlight color / colorant to the list.

Delete Deletes the selected highlight color / colorant.

82
 4.5 Workflow Options Dialog

PCL Native Import Known Limitations

The following list of limitations contains features currently not supported when imported into
Inspire Designer.

Note It may happen that you find an unsupported feature which is not listed below. The
reason why there cannot be a complete list is that PCL commands can be enhanced in custom
ways by printer manufacturers. However, the implementation of new commands into the import
functionality in Inspire Designer does not occur in parallel to this process and new variants of
PCL commands are not enabled in the import automatically. In case you find a feature that is
neither implemented nor listed among these known limitations, please report the issue you
have found, so that it can be either fixed (implemented) or included in this known list.

Objects For PCL documents' objects, i.e.: areas, images and fonts, it is possible to apply
patterns and Logical Operations Command parameters. Native import of PCL documents
into Inspire Designer supports them with minor limitations (see the table below).

Type Feature Images Areas Fonts

Pat- solid Full sup- Full sup- Opacity in Source Transparent Mode not
terns white port for port supported.
mono-
chromat- Some patterns used as fill styles might have
ic images a different appearance.
only
solid Full sup-
black port
shading Full sup-
port for
cross-
mono-
hatch
chromat-
user ic images
defined only
ROP 252 T OR Full sup- Full sup-
S (de- port for port
fault) mono-
chromat-
240 S
ic images
(source
only
only)
204 T
(texture
only)

Fonts and Encodings Double-byte encodings are not supported. Double-byte fonts are
supported if used without encoding or with single-byte encodings.

Text Format The underline feature is not supported for commands that execute absolute or
relative positive horizontal movements (screenshot 1). However, the typical usage a line
starting with an underlined text is supported (screenshot 2).

83
4 Workflow

Colors

Configure Image Data (CID) only the short form is supported.

The Luminance-Chrominance color space is not supported.

Transfer of information about colors from/to HP-GL/2 is not supported.

HP-GL/2 (vector extension to PCL)

Text is not supported.

Only non-vector patterns defined inside HP-GL/2 are supported. Patterns referenced
from PCL are not supported, solid color fill styles are used instead.

HP-GL/2 content is not scaled in case that scaling is prescribed from outside from
PCL parts (Plot Size command).

HP-GL/2 content is not clipped (InputWindow command).

Transfer of information about colors from/to PCL is not supported.

4.5.3.4 PDF/PS Native Import

The settings in this section apply to PDF, PS and EPS files that are imported:

Streamed via the Inspire Native workflow module.

Imported via native import menu option to import a file into Layout.

Loaded to Proof or Production.

If you load a PDF/PS/EPS file to Proof or Production, default settings are used. If you set
your preferences in the PDF&PS Import dialog and click on the Save as Default button,

84
 4.5 Workflow Options Dialog

then your preferences will be used (as default) also when opening a file of this type in
Proof or Production.

Inserted as a native image into Layout using Image Page Counter (the option Load
natively has to be checked on the Advanced tab of the image Layout Properties).

See also the pros and cons of Native Loading of Images.

Note The way of loading a PDF as an image using Image Page Counter can be also
used if you do not want to load the PDF natively (then you leave the option Load nat-
ively unchecked), or if you want to use some of the options available only for images
on the Advanced tab of the image Layout Properties:

Font replacement, Embedded profile usage These two features are available also
for images that are not loaded natively.

If the PDF is loaded natively via Inspire Native or native import in Layout, the value
CMYK to RGB only for Embedded profile usage is used and Font replacement
cannot be set at all.

Place native image in overlay, Use dynamic variables These features are available
only for PDFs loaded natively, i.e. after the option Load natively has been checked.

They are not available for the other ways of PDF native import, only for loading as
an image.

The selected setting in the PDF&PS dialog is applied and kept only within the respective work-
flow. The value last saved as default is applied in the workflows created subsequently.

Options Description

Optional Content
Optional content refers to PDF layers that might be marked as visible or invisible in the
default view of the imported PDF. This pane allows to select the required display of the
imported document, that is the default view, view with all layers visible or view, where
you can switch on and off the display of the visible/invisible content.

Note PS files are converted into the PDF format before the actual import into Inspire De-
signer. All content of the converted file is marked as visible content.

Invisible content Defines the handling of the content that is labelled as invisible for
the PDF file's default display:

Do not import The invisible content is omitted when importing the file; only
content marked in the input PDF file's default view as visible is imported.

Import All the content is imported regardless of its status and the PDF is
treated as a non-layered file. WFD files created in PrintNet T 6.0 and earlier
are by default processed using this option (all PDF files were imported this

85
4 Workflow

way then). To change the setting, resave the WFD in PrintNet T 6.1 or later.
See also the limitation of this feature when Flatten transparency is checked.

Import separated Using this setting can have two main scenarios:

1. When using the Inspire Native module or applying native import, objects
of the imported file's visible and invisible content are assigned two separ-
ate handling groups:

the visible content objects are assigned handling group 1,

the invisible content objects are assigned handling group 2.

2. When inserting a PDF file as an image into Layout, the image will appear
in Layout showing the visible content. Only when you enable the Load
natively option in the Advanced tab of that image's Layout Properties,
all the content is displayed.

By default the image is assigned handling group 1, and the invisible con-
tent layer is assigned handling group 2. The invisible content is automat-
ically assigned a handling group with a number incremented by 1 in rela-
tion to the visible content's handling group. This rule is kept, even if the
handling group of the image is reassigned.

The invisible content is not an independent object in Layout. To view both

layers independently, toggle the appropriate handling group icons in
Proof, as required.

Note If the handling group 8 is selected for a natively loaded image

with invisible content, there will not be a free handling group that the
invisible content could be assigned, so it would not be possible to display
it separately in Proof. In such case a warning is generated in the Log
window-pane.

See also the limitation of this feature when Flatten transparency is

checked.

Transparent Content

Flatten transparency If checked, transparent objects are converted to non-transparent,

i.e. they are merged into a non-transparent bitmap. This functionality is ensured by
a PDF library plugin, which is, however, available just for the 32-bit Windows, Linux
and Solaris operating systems. See also the limitations and recommendations for this
feature at the end of this section.

Note If this option is checked and the following conditions are met:

The imported PDF file contains semi-transparency together with invisible con-
tent.

And in the Invisible content combo-box, the Import or Import separated

option is selected.

Then, the PDF cannot be imported and a warning message is displayed when starting
import.

The following options set the way of transparency flattening.

86
 4.5 Workflow Options Dialog

Raster/vector balance The position of the slider determines the level of rasterizing
vector objects. 0 means that all objects on pages with at least one transparent object
will be converted to images. The value 100 means that all vector objects will be pre-
served in their vector form.

For complex documents, flattening in vector form requires more time and memory
than rasterization.

Line art and text resolution [DPI] Sets the resolution for vector art and text that will
be rasterized during flattening.

Gradient and mesh resolution [DPI] Sets the resolution of gradients and meshes in-
volved in transparency.

Convert all text to outlines If checked, glyphs are turned to paths (vector objects). As
a result, it is not possible to search in the text.

Convert all strokes to outlines If checked, lines with set width become filled areas.

Clip complex regions If checked, this option creates clipping paths around complexity
regions. Complexity regions are typically made up of a large number of objects that
interact with transparency. The objects are rasterized except at the highest Raster/vec-
tor balance setting.

Preserve overprint If checked, overprint settings are preserved in the file. Bear in mind
that the resulting effect cannot be defined in Inspire Designer the actual blend of
colors depends on the printer.

Reset to Either of the three buttons resets the settings to values suitable for a specific
level of resolution low, medium and high. Generally, higher resolution requires more
processing time. The default settings of the dialog corresponds to the medium resol-
ution (it is applied after the Reset button is clicked).

Convert DeviceGray colorspace to Converts the colors of DeviceGray to the colorspace

selected. This option applies to graphics and text (not to images).

If DeviceGray has been used as a colorspace, in an imported PS or PDF file, it is necessary

to convert it to another colorspace. Select from RGB or CMYK in the combo-box to the
right.

Use legacy method for thin line rendering Render thin lines (around 1 px) as done in
previous versions of PrintNet T (specifically in versions where PDF Library 8 and earlier were
used PrintNet T up to v6.1) for PostScript and PDF files that are not loaded natively.

If unchecked, thin lines are rendered in accordance with the versions of PrintNet T that
use PDF Library 9.

Note WFD files created in versions of PrintNet T older than 8.0 take the default settings
from the Configuration file. After saving these WFD files in the version 8.0, the settings
used in the workflow will be applied.

Save as Default Saves the selected setting as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default setting.

87
4 Workflow

PDF/PS/EPS Native Import Known Limitations

Due to the high complexity of the PDF document format, the implementation of the native
import of PDF/PS/EPS files is still being enhanced.

Therefore, before running the production of a workflow file using the native import function-
ality, it is highly recommended to proof the workflow thoroughly.

This chapter lists the features of all PDF, PS and EPS files that are not usable in the current In-
spire Designer version after native import of these document types.

1. PDF transparent model (from 1.4 version of PDF). Transparency is not fully supported.
It can be rasterized by using the Flatten transparency option. See the Transparency
Flattening Limitations and Recommendations below.

To have an overview when the Flatten transparency feature is used, switch on

(Warning: Always or Once) the warning with the code 7512 in the Warnings config.

2. If a font is not embedded and belongs to the 14 standard fonts defined in the PDF
specification (refer to the section 5.5.1 in the PDF Reference), it is replaced automatically
because those fonts are contained in the PDF library directory. For other un-embedded
fonts, a message created during Production is displayed in the log file. The font replace-
ment rules can be set using the Font Replacement functionality in the Others node of
the Layout Tree.

3. All Type 3 font glyphs are supported. However, only sufficiently simple glyphs (simple
shapes without any color specification) will be imported as fonts, complex glyphs are
not considered to be fonts by Inspire Designer, so the Unicode values associated with
these glyphs are lost.

4. All patterns are rasterized (the vector information is lost), i.e. they are transformed to
an image fill style in Inspire Designer.

5. The import of the visual appearance of annotations is not supported.

6. External resources, except for non-embedded fonts, are not supported. Unsupported
external resources are e.g. external font streams, image streams and so called external
XObjects.

7. The Convert DeviceGray colorspace to option applies only to graphics and text (not
to images).

Transparency Flattening Limitations and Recommendations

The transparency flattener is a third party software component that should be taken as
a rough-and-ready tool, that might not be free from faults or limitations. In the interest
of trouble-free processing it is recommended to import to Inspire Designer PDF files
without transparency. Alternatively, you can solve the transparency situation e.g. by
means of Adobe tools that allow to preview documents while flattening.

If the transparency is used only in images, disabling the PDF flattener may help. Otherwise
try to use the option Convert all text to outline in the Workflow Options dialog. This
option may help in cases when original glyphs are not displayed correctly.

88
 4.5 Workflow Options Dialog

The feature requires a lot of memory and processing time. For larger PDF documents
(100+ pages) with transparency used on all pages, the system might easily run out of
memory and the processing may be impossible.

When processing flattened PDF files, single threaded processing is recommended.

It is not possible to execute flattening of one document using parallel processing. Even
with the Parallel processing check-box in Production enabled, the internal settings
allow the document to be still processed (single-threaded) but the processing time in-
creases in comparison to processing with the Parallel processing check-box disabled.

4.5.3.5 HTML Native Import

The settings made in this section are applied when you:

Import an HTML file using the Inspire Native workflow module.

Use the native import menu option to import an HTML file into Layout.

Import an HTML file into Inspire Designer as an image.

If you open an HTML file to Proof or Production, default settings are used. If you set your
preferences in the HTML Native Import dialog and click on the Save as Default button, then
your preferences will be used (as default) also when opening a file of this type in Proof or Pro-
duction.

89
4 Workflow

Options Description
Unlike other files that can be loaded natively, HTML does not contain any page definition.
When loading an HTML file you can set the dimensions the same way as for pages in Layout
module.

Load as multi-page document If selected, the HTML is imported as a multi-page image

(just like it is possible for multi-page PDF or TIFF files). Use this options if you want to get
a page-based output.

Load as single-page document If selected, the HTML will be imported as one (long) page.
Use this options if you want to get just one output without page definition (e.g. an email).

Save as Default Saves the selected setting as default for the current workflow and the
workflows created subsequently. Clicking on the Reset button restores the last saved
default setting.

HTML Native Import Known Limitations

As it is a new feature, there are currently only two known limitations:

Local links pointing to the same HTML file or web page are not supported, i.e. if there
are such links in the imported HTML, they will not work in the output.

The main HTML file does not have to be locally on the disk, it is enough to be referenced
in the Used Files. However, this does not apply to the files referenced from the main
HTML file, i.e. all referenced files need to be locally on the disk, it is not enough to have
them only in the Include status in the Used Files. You have to export them first to a disk
location.

The command line parameter -runbyrecord cannot be used for natively imported
HTML files in Inspire Production Console.

Note In case that you find a feature that is not implemented nor listed here, please report
the issue you have found, so that it can be either fixed (implemented) or included in this known
list.

4.6 Debug Data Window-Pane

The Debug Data window-pane shows the data structure at a selected point in the workflow
and indicates where these data come from and how they have been modified until that point.
This gives you a comprehensive overview about all data fields in the workflow, which can help
you to remedy possible problems with data.

The panel can be opened as a window-pane by right-clicking on the links between modules
and selecting the option Show Debug Data in the context menu. It can also be opened using

90
 4.6 Debug Data Window-Pane

the menu option Window | Show Debug Data or in the Layout Tree via the context menu
of fields.

The panel is divided into two parts. The upper part shows the current data structure, while the
lower part displays information about the selected field.

Note The upper part shows only Structure and Type parts, if Proof has not been run yet or
the Proof window has been closed again. The message "To see values, run proof." indicates
that you have to run proof to see the third column with the actual values.

You can also trace back the selected field thanks to highlighted connections between modules
through which the field passes.

91
4 Workflow

Legend

1. Selected module or a connection between modules is highlighted blue.

2. A blue dot marks the spot in the workflow, where the given data displayed in the Debug
Data window-pane come from in their respective form. This allows an easy identification
and evaluation of changes in the data structure.

3. Connections highlighted olive track the way of the field in the item currently selected
in the Debug Data window-pane.

Options Description

Structure Displays the tree structure of how the data fields are related.

A direct one-to-one relationship is indicated by fields on the same level (branch of the
tree) and an array (with one-many relationship with other fields on the same level) is indic-
ated by a collapsible branch underneath a single field name.

Type Indicates the data-type of the field.

Value Displays the value of the field for the current record.

Only available after proofing the workflow. You can navigate through records using the
navigation arrows.

Highlight Unused Variables After clicking on this icon, red stripes mark those fields that
are not used behind the spot or connection you right-clicked on in the workflow (blue
spot or blue connection in the image above).

Such variables could be deleted in a Data Transformer connected behind the spot or added
between the two modules the connection links. But please note, that those fields can be
used before the spot or connection you have selected.

Navigation Options Navigates through records. Available only after the

workflow has been proofed (preprocessed).

Origin Lists the module where the field was created or read into the workflow.

Double-clicking on an item opens the appropriate module. If the Show All icon is en-
abled, all modules the field passes through are listed, even if there were no modifications
made.

Usage Lists all uses of the selected field in the workflow.

Double-clicking on an item opens the appropriate module. In the case of Layout, the ap-
propriate page or flow is displayed.

92
 4.7 Label Tool

4.7 Label Tool

In this section: See also:
Label Context Menu Workflow Window Menu
Edit Label Dialog Workflow Window Toolbars

The Label Tool can be used for marking parts of the workflow in the Workflow Area.

To create a label:

1. Click on the Label Tool .

2. Position the mouse pointer close to the module(s) that you wish to label.

3. Hold down the left mouse button and drag the pointer around the module(s) to be
labeled.

Note As soon as you have finished creating a label, i.e. released the left mouse button,
the Selection Tool reactivates. To create additional labels, you will need to repeat
steps 13.

4. Modify the label using the label context menu, opened by right-clicking on the label.
E.g.:

5. To resize or reposition the label, hold down the left mouse button and drag the
pointer (the Selection Tool activated) to the desired position.

93
4 Workflow

4.7.1 Label Context Menu

Options Description

Edit Label Opens the Edit Label dialog, enabling you to:

Change the text

Set the background color or image

Align the text

Delete Label Deletes the selected label only. The underlying modules will not be deleted.

Select Label and Modules Selects both the label and any modules that are completely
within the label boundaries.

Move Label Backward Moves the selected label to the bottom layer in the Workflow Area,
i.e. behind other labels. This is useful if labels are overlapping and one is preferred to be
more visible than another.

Move Label Forward Moves the selected label to the foremost layer in the Workflow Area,
i.e. in front of other labels. This is useful if labels are overlapping and one is preferred to
be more visible than another.

4.7.2 Edit Label Dialog

94
 4.8 Profile Data Tool

Options Description

Text Enter the text that will appear on the label and select the alignment of the label text
within the label.

Select from: Top, Center or Bottom.

Background Define the label background by selecting one of the following options:

Color Select the color of the label. The combo-box menu provides some pre-
defined colors to select from. Alternatively, select Custom to open the Color dialog,
enabling you to determine your own color in the RGB or HSB colorspace.

Image Upload an image (in a format supported by Inspire Designer) to be used

as a label background. The label takes over the proportions of the image.

Tip Images can also be uploaded using drag and drop or copy/paste functional-
ity.

4.8 Profile Data Tool

See also:
Workflow Window Menu
Workflow Window Toolbars

Profile Data provides the possibility to measure the time consumed in each data processing
module of the workflow graphically, as opposed to the view of the processing times that can
be found in the Log window-pane in Production and Proof.

If you have a complex workflow with many data manipulating modules then data processing
can take a long time. The configuration of each module and how it processes this data contrib-
utes to this spooling time and so it is useful to know which modules are taking what time to
do their job. Then, you can focus on those modules that are taking the longest time and try
to optimize their configurations to reduce the total time spent in the running of a job.

95
4 Workflow

Example In the screenshot here you can see a workflow shown after proof has been
run successfully. A key to the marked points can be found below:

Legend

1. In the Workflow Summary in the top left corner of the Workflow Area you can
see the elapsed time of the complete processing of all data.

2. The coloring of the pie charts relates to the proportion of the whole processing
time that the individual module has taken: above 75% = Red; 50-75% = Orange;
25-50% = Yellow; below 25% = Green.

3. Layout, impositioning and output modules are not subject to profiling.

To activate, click on the Profile Data icon on the Workflow toolbar.

Alternatively go to: Workflow | Data Profile.

Then you must run the workflow through Proof or Production, successfully, in order to see the
results.

During processing, pie-charts shown on the modules will change as their relative proportion
of total processing time changes. Therefore, you can watch the progress of spooling graphically
in the Workflow window but should wait until the workflow has finished processing to decide
which module requires attention.

When the processing of all of the modules has finished, the duration is displayed on each of
the data processing modules (in seconds). You can also see the completed pie charts that rep-
resent the proportion of the whole processing time that an individual module has taken.

Profile Data can also be activated by the command line parameter -profdata in Inspire Pro-
duction Console.

96
 4.9 Templates Window-Pane

Note Profiling should be de-activated when a workflow is used for actual printing production
as it can significantly slow down processing of data.

4.9 Templates Window-Pane

See also:
Workflow Window Menu

The Templates window-pane displays any modules that have been specifically saved as templates.
By default it appears at the bottom of the Workflow window.

Example

To open and close this window-pane go to the Workflow Window menu: Window | Show
Templates.

Templates can be displayed either as a list or as thumbnails. You can switch between these
two options via a context menu - check or uncheck the option Show thumbnails. By default,
templates are displayed as thumbnails. They can then be dragged and dropped from the
Templates window-pane into the Workflow Area so that they become part of the current
workflow. It can be any number of modules that have been previously configured as part of a
workflow and then saved as a template (WFT) file. This can help avoid having to configure
similar sets of modules repeatedly for workflows which perform similar functions.

To save a template: Select the modules that you want to be part of that template (by holding
the mouse-button and dragging across them), then drag the selection into the Templates
window-pane.

The templates are stored in the Templates folder, which is created in the application's own
directory (i.e. where the PNetT.exe file is kept) when a template is saved. All templates in this
folder are shown in the Templates window-pane whenever it is open and they also appear in
the New Workflow dialog for selection when creating a new workflow.

The default settings can be changed in the Workflow Editor section of the Workflow Options
dialog.

97
4 Workflow

4.10 Verify Window-Pane

See also:
Workflow Window Menu

The Verify window-pane displays warning about any errors that have been detected in the
workflow, i.e. whether the workflow objects are correctly connected and their parameters are
properly defined.

Any errors found in the workflow are listed in tree form.

Select Window | Show Verify to display/hide the Verify window-pane. By default it appears
at the bottom of the workflow window.

To activate the verify process, select Workflow | Verify from the workflow menu.

Example

98
 4.11 Compare Workflows Window-Pane

4.11 Compare Workflows

Window-Pane
See also:
Workflow Window Menu

The Compare Workflows window-pane shows the differences that exist between two workflows.
It can be opened if two or more workflows open in a single application window by using the
Workflow Window menu option Workflow | Compare Workflows. If more than two work-
flows are open, the Compare Workflows dialog appears to allow the selection of just two of
them.

The intention of this feature is for comparison of versions of the same workflow (i.e. an earlier
and later version) but, in fact, any two workflows can be compared if required.

The window-pane appears in the Workflow window (by default to the right) of each of the
workflows being compared and it lists any differences found in that workflow, as compared
to the other, in tree form.

4.11.1 Compare Workflows Context Menu

Right-clicking on the items listed in the tree reveals a context menu that lists options that are
relative to that item.

Options Description

Show Differences Opens the Module Compare Info dialog which lists the differences
within the module.

This option only appears for modifications (e.g. modified modules) as opposed to new or
missing items. For Layout modules, this option opens another Compare Modules window-

99
4 Workflow

pane instead of the Module Compare Info dialog. That window-pane appears in the Layout
window and also lists differences in tree form and has the same context menu. These
differences relate only to that Layout, e.g. the addition of text to flows that would appear
as a modified flow.

Most differences will be described to the level of which option or object inside an individual
module that they occur in, however there are some differences that may occur which are
only listed to module level.

Save As Opens a Save As dialog so that the complete list of differences can be saved as an
XML or TXT file.

Refresh Re-compares the workflows so that any new changes can be listed.

4.12 Cross Reference Browser

The Cross Reference Browser dialog enables you to find out which files a particular file refers
to; or which files refer to that file. This is useful for revealing references between WFD files
and Used files (e.g. pictures, fonts, data files, external workflows).

Options Description

Directory The first field (1) selects a directory containing files for which you want to display
references. Disable the Show unreferenced files check-box to filter out those files in
the selected folder which do not refer to any file or are not referred to by any file, so that
the list is easier to understand.

The second field (2) displays the path to the file that you have clicked on in the Files field.
Use the arrows to move forward or backward in the sequence of files that you have
recently clicked on. If you open the drop-down menu, the selection history will be displayed.

List recursively If enabled, all referenced files are displayed, including the files located in all
sub-folders of the one specified in the Directory edit-box. By default, this option is disabled.

Show unreferenced files If disabled, the unreferenced files are not displayed. By default
this option is enabled.

100
 4.12 Cross Reference Browser

Referenced By Displays a list of files which refer to the file selected in the Files field.

Files Displays a list of files that are contained in the directory specified in the Directory field
plus all of the files (located on any drive) referred to by any WFD file in this directory.
Clicking on a file from this list shows to which files this file refers (Reference field) or by
which files this file is referred to (Referenced By field).

Tip If you double-click on a WFD file from the list, it will be opened.

Reference Displays a list of files to which the file selected in the Files field refers.

Save Saves the reference structure as a DOT file. This file can be used by AT&Ts Dot tool
for drawing a graphical representation of the reference structure.

Besides the Dot tools GUI, you can also use the following command line to create the
output graph: dot file.dot -Tpng -o file.png

Example In the screenshot above, you can see that a folder called temp has been selec-
ted. In the Files field, all of the files contained in the selected directory plus all of the related
files located on any drive are displayed. The processes.wfd file has been clicked on so that
its references are displayed. You can see five files (fonts, images, data files) that the pro-
cesses.wfd file refers to. You can see that there are no files referring to the processes.wfd
file in the Referenced By field.

If the arial.ttf file is clicked on, then the processes.wfd file is displayed in the Referenced
By field, which indicates that the processes.wfd file refers to the arial.ttf file:

101
4 Workflow

If the Show unreferenced files check-box is disabled, the atheros_installer.log file dis-
appears from the Files field, because it neither refers to any file nor is referred to by any
file:

4.13 Used Files Dialog

The Used Files dialog lists all of the files that are being used by the workflow.

To display this dialog, select File | Used Files from either the Workflow or Layout windows.
The dialog provides the information on individual files and allows, via the context menu or the
icons in the bottom right corner of the dialog, to perform several actions.

The user can:

set/unset the file as a binary part of the workflow

export the file

change the link of the file or the file itself

add/remove a file

change the file type (i.e. an assignment into a group of files)

change the Relative To directory

102
 4.13 Used Files Dialog

Options Description

File Displays the file name and its assigned type.

Location Displays the location of the file relative to the directory specified in the Relative To
column.

To edit the location, press the <F2> button or apply two clicks to the required location
path, and type in a new one. As distinct from two clicks, a double-click (on any File Uses
list item) displays the File Uses dialog.

Size The size of the file.

Load Status Identifies the status of the file being used in the workflow. Possible states are:

OK from HD if the file is loaded from the hard disk.

OK included if the file is loaded from within the workflow.

OK external if the loaded file is an external layout object linked from another
workflow. For more details see the External Objects section.

Temporary if the file is only loaded for this session.

Replaced if the file is permanently replaced by a modified/newly located file.

Missing if the file is not loaded.

State Determines whether or not the file needs to be present on the "production computer".
Options are:

Exclude The file will be referenced using the "Relative to" and "Location" folders.
The file is not a binary part of the workflow file: only a link is provided.

Note The size of your workflow file will be smaller when a file is excluded, but
the excluded file must be present on the "production computer" in the location
specified.

Include The file is a binary part of the workflow file. This makes the workflow
very portable since the file does not need to be present on the production com-
puter.

Both The file is included both as a binary part of the workflow files and defined
in "Relative to" and "Location" folders.

103
4 Workflow

It is possible to change the state of the file using either Include or Exclude option in the
context menu or the relevant icons in the bottom right corner of the dialog.

Relative To Displays the base directory for the file. The path can be either set relative to the
font or workflow directory; relative to workspaces; or absolute.

The icons in the bottom right corner of the dialog represent the same options that appear in
the context menu and can be used in the same way.

4.13.1 Used Files Context Menu

Right-clicking on any file listed in the Used Files dialog reveals a context menu:

The options on this menu are also displayed as icons on the bottom-right of the dialog.

Options Description

Include Enables you to include a file that was previously excluded. Upon saving the
workflow file, the State changes to "Both".

Active only when a file is excluded.

Exclude Enables you to exclude a file that was previously included. You will be prompted
to complete information for the "Relative to" and "Location" folders. Upon saving the
workflow file, the State changes to "Exclude".

Active only when a file is included.

Export Enables you to define the location to which the file should be exported. When
selected, you are prompted to define the location to which you want to export the file.
The reference to the file will not change, and the file remains a part of the workflow file.
The State changes to "Both".

Active only when file is included.

Change Link Enables you to change the location of the file. You will be prompted for the
new location. The file remains part of the workflow file, but the reference changes to the
location you entered. The State changes to Both.

Change Type Enables to assign the file to a different type (group of files) from the pre-
defined options below or to define your own type. This is useful when you want to set
the behavior for the specific group of files under File Type in Used Files Conditions.

104
 4.14 How to Create a Workflow

The predefined options are:

Data

Image

Font

ICC profile

External layout

Others

Copy and Change Link Copies an existing file from another folder and places it into your
document or workflow.

Change File Enables you to change the used file. You will be prompted for the location
of the new file. The file becomes part of the workflow file instead of the original one.

Add Adds a new file into your document or workflow.

Remove Removes the file added into your document or workflow via the Add option.

File Uses Opens a dialog that lists the modules of the workflow in which the selected file
is used. Some further detail is also listed where possible, e.g. object family and name in
Layout.

This dialog is also opened after double-clicking on an item in the Used Files list.

4.14 How to Create a Workflow

In this section: See also:
Manual Workflow Construction Workflow Options Dialog
New Workflow Dialog Workflow Window Toolbars
Workflow Wizard Workflow Window Overview
Module Tree

The workflow is your print job. Its components make up the input, configuration, design and
output of the WFD file that you are creating. These components are units called modules, each
of which performs a specific function between the import of data and the output to a print
engine.

105
4 Workflow

Each module is represented graphically to aid quick identification and navigation between
them, also allowing for a fast manipulation by adding double-click and drag and drop function-
alities.

Construction of a workflow can be approached with little planning, as you can jump back and
forth between modules, improving design and including extra modules when needed, with
ease.

The general aim of any workflow is to include elements that import your data file, process its
content so that it is formatted correctly, design the layout of the pages to be printed and direct
your output to a printing medium.

Workflows can be created using:

Manual workflow construction.

Workflow templates chosen from the New Workflow dialog.

The Workflow wizard.

4.14.1 Manual Workflow Construction

Inspire Designer provides a flexible, visual approach to building dynamic data and document
processing workflows. This is quite a straightforward process of:

1. Inserting modules into the Workflow Area by:

double-clicking on the required module in the Module Tree or

selecting a module and hitting the <Enter> key or

dragging-and-dropping the module.

Once in the Workflow Area, the modules can be dragged and dropped into another
place or moved around with the arrow keys. The arrow keys move all the selected
modules as long as the Workflow Area is not zoomed out so that there are no scroll
bars.

Tip Double-click functionality places the modules in a line and every new module is
added at the end of the line, no matter of the logical workflow modules order. The
order of modules can be changed by using drag and drop functionality.

2. Connecting the modules in the appropriate logical order.

Step A: Click on a module exit point and hold the left mouse button down.

106
 4.14 How to Create a Workflow

Step B: Drag the link to an entry point of another module.

Step C: Release. You will be connected unless the module is not compatible.

3. Configuring each module.

Double-clicking on most modules will open the correct panel allowing you to edit the
attributes of its configuration. However, some modules (e.g. Sheet Concatenator) require
no further configuration and so will not open.

Tip If you are using multiple modules of the same type, consider completing all information
in the first module, then copying and pasting the module and making appropriate modifica-
tions.

4.14.2 New Workflow Dialog

Each time that you select File | New Workflow from the Workflow Window menu, the New
Workflow dialog is displayed.

It has two tabs:

Default Templates

Custom Templates

Checking the option Do not show this dialog next time determines that the New Workflow
dialog will not be shown the next time that File | New Workflow is selected. Once this option

107
4 Workflow

has been checked and you require to show this dialog once again, check the option Show
New Workflow dialog that can be found in the Workflow Options dialog.

4.14.2.1 Default Templates

The Default Templates tab offers a few simple workflow templates for basic uses. Select the
type of flow that most closely matches your needs:

Custom workflow Opens a simple blank unsaved workflow file for you to create your
own workflow by double-clicking, dragging, dropping and configuring the modules as
described in the Manual Workflow Construction section above.

One data file, paper output Opens a workflow as shown below. These are three
modules for the typical basic function of Inspire Designer: importing data, designing
the layout of a page to present it and sending it to a printer.

One data file, data output Opens a workflow as shown below. These are two modules
for a most basic function of Inspire Designer: importing data and creating a data file.

Two data files, paper output Opens a workflow as shown below. It allows for details
of a combination of two differing data files arranged on pages of a document for
printing.

108
 4.14 How to Create a Workflow

Two data files, data output Opens a workflow as shown below. It allows for details
of a combination of two differing data files to be merged into one data file.

4.14.2.2 Custom Templates

You can also create your own templates from currently opened workflows by selecting and
dragging workflow modules to the Templates window-pane in the Workflow window. Those
templates will then also be displayed here for selection when creating a new workflow.

4.14.3 Workflow Wizard

The Workflow wizard is designed to help construct a variety of basic workflows in a step by
step manner. It asks questions about your requirements in dialogs and adds modules to a new
workflow file.

Once the wizard has laid out your workflow, you can continue to build yourself using additional
modules, restructuring the workflow, etc., using the methods described in the Manual Workflow
Construction section above.

To create a workflow using the wizard, do the following:

1. Select File | New with Wizard to display the Workflow Wizard panel.

2. Select the number of data files that will be called upon by your project.

The maximum count of data files is 20. If you enter a number over 20, only 20 data
files will be added.

109
4 Workflow

3. Click on Next.

4. Select either:

Layout with output which creates a workflow that includes a Layout and an
Output module.

Or

Output data plugin which creates a workflow that includes only data input and
data output.

5. Click on Finish and your basic workflow file will open with the appropriate modules
connected in the Workflow Area.

110
5 Data Input Modules

5.1 Data Input Modules Overview

5.2 Data Generator Module
5.3 Data Input Module
5.4 External Input Module
5.5 Internal Input Module
5.6 Line Data Input Module
5.7 ODBC Data Input Module
5.8 Param Input Module
5.9 Data Center Input Module
5.10 SAP Data Input
5.11 Script Data Input Module
5.12 XML Data Input Module
5 Data Input Modules

5.1 Data Input Modules Overview

Data input modules read data files of differing formats into the workflow to create variables
that can be used in the workflow design.

The various types of data input module are listed in the table below, follow the links or click
on the screenshot to read more about each module.

Data Center Input Module Reads data from Inspire Data Centers.

See the section Data Center Input Module.

Data Generator Module Generates integers within a selected range.

See the section Data Generator Module.

Data Input Module Reads flat-data files, i.e. CSV, fixed length fields, DBV and
Custcode.

See the section Data Input Module.

External Data Input Module Connects with external plugins (DLLs) with a defined
interface in the workflow.

See the section External Input Module.

Internal Data Input Module Reads data files that have already been stored in the
Inspire Designer data format (TSD files).

See the section Internal Input Module.

Line Data Input Module Reads data from files which have been formatted for
linefeed printing, i.e. they have a basic page structure.

See the section Line Data Input Module.

112
 5.1 Data Input Modules Overview

ODBC Data Input Module Connects the data from an ODBC source, e.g. Microsoft
SQL or Oracle.

See the section ODBC Data Input Module.

Note This is a Windows only feature.

Param Input Module Creates a variable which has a default value that can be
changed during production, i.e. via command line or in the production environment.

See the section Param Input Module.

SAP Data Input Module Reads Raw Data Interface (.RDI) and Intermediate Document
(.IDO, IDOC) files from SAP systems.

See the section SAP Data Input Module.

Script Data Input Module Defines a script for reading and processing user defined
input files.

See the section Script Data Input Module.

XML Data Input Module Reads an XML file with definable text encoding and op-
tional reading of the XML structure definition from external TSD files.

See the section XML Data Input Module.

113
5 Data Input Modules

5.2 Data Generator Module

See also:
Data Generator Module Command Line
Parameters

The Data Generator module generates data file containing numbers (Integers) within a selected
range.

Output of Data Generator can be used whenever you need a number row or an array with a
certain number of items. This can be useful e.g. in sample jobs instead of Script Data Input
with for cycle you can use Data Generator to simulate having a certain number of records.

Options Description

Array Enables you to enter the name of the array.

From Sets the starting value of the number range.

To Sets the ending value of the number range.

Tip The data range can also be changed once the workflow has been loaded to Production
using the Workflow Parameters window-pane.

When you connect the Data Generator module to the Layout module, the new array generated
from Data Generator is inserted in the Layout Tree in the Data node:

114
 5.3 Data Input Module

5.3 Data Input Module

5.3.1 Data Input Module
In this section: See also:
Input File Tab Multiple Record Type Files
Properties Tab Setting Up Custom Text Encoding For
Data Structure Tab Data Input
Arabic, Hebrew, Indic Languages Support
XML Data Input, Data Input and Script
Modules Commands
Data Input Module Command Line
Parameters

The Data Input module enables you to establish basic information about variable data that will
be used in the document. For example, you can enter or view:

the path to the data file

individual records and their values

the number of records that will be taken to generate a proof preview

the type of data file encoding

field separators and text qualifiers

This module is divided into the following tabs.

Input File

Properties

Data Structure

You may also want to refer to Multiple Record Type Files if you are working with such files.

5.3.1.1 Input File Tab

The Input File tab enables you to identify basic information about the data file. Also, you can
set the number of records to be used for proofing and in production.

115
5 Data Input Modules

Options Description

Root array name The name of the array (containing variables) that will appear in the layout
tree. This is important especially for multiple files or multi-line input.

Input file The exact location of the data file. You can type the full path name or use the
Browse icon to navigate to the location.

File type The format in which data are stored in the data file. Supported formats of the Data
Input module are:

CSV

Fixed length fields

DBF

Customer code

Auto Detect Detects the file type by checking the file, the separators used and use of new
lines.

Fixed Length Fields files are very similar to CSV file in this respect and so when using a
Fixed Length Fields file this option will typically select CSV.

Use only first records in Proof If checked, you can limit the number of records that will be
used during proofing. When you have large input files, selecting this option significantly
decreases preprocessing time.

Record count The number of records to be proofed when the Use only first records in
Proof option is checked.

Range for production If checked, you can limit the number of records that will be used for
Production. When you have large input files, selecting this option decreases preprocessing
time, even compared to using the Data Filter because Production can start at specified
record without having to go through all the records.

Start record Starting record for Production when the Range for production option is
checked.

End record Last record for Production when the Range for production option is checked.

116
 5.3 Data Input Module

5.3.1.2 Properties Tab

The appearance of this tab varies depending upon the File type selected on the Input File tab,
i.e.:

CSV

Fixed Length Fields

DBF

Customer Code

Properties Tab for CSV File Types

Options Description

Text encoding Selects the codec to be used to read the characters in the data file.

See the separate chapter on Text Encoding.

Check unassigned If checked and the chosen Text encoding cannot encode characters
(particularly double-byte characters) to Unicode (when the workflow is processed), a
warning will be displayed in the Log window-pane.

117
5 Data Input Modules

Field separators You can enter the character(s) used as a delimiter between fields in the
data file. If the default value is changed automatically (either when loading a data file or
after clicking on the Auto Detect button) a notification message is displayed.

To define a sequence of characters (string) as a separator, precede it with double number

sign/hash mark (##); e.g. to define the three following characters ~!@ as a separator,
enter ##~!@.

It is possible to customize the default value for this option in the Data Input Module
Properties section of the Workflow Option dialog.

Note For special characters use these codes:

Any single-byte \x** E.g.: \xA9 for Backslash followed by x and hexadecimal
character character value.
Tabulator \t Tabulator. Equals \x09.
Backslash \\ Since backslash character is used for denot-
ing special characters, it is necessary to use
two backslashes for specifying the back-
slash itself as a delimiter.

See also the Substitute characters chapter.

Text qualifiers Sets an additional character (e.g. a quotation mark) that can be inserted in
a field. This can be useful when importing CSV files (created by exporting data from MS
Excel). Text qualifier characters are replaced by imported data. If the default value is
changed automatically (either when loading a data file or after clicking on the Auto Detect
button) a notification message is displayed.

It is possible to customize the default value for this option in the Data Input Module
Properties section of the Workflow Option dialog.

Note Fields must be delimited.

Line separator Indicates whether the field separator is for Mac/Windows or UNIX.

Note

Windows requires a carriage return and a line feed.

UNIX requires a carriage return.

Mac requires a line feed.

There is a limit of 5 milion of characters per one line.

Auto Detect Detects text qualifiers, field separators and line separator from the first line of
the data file.

Note If the detected field separators or text qualifiers differ from the default values
defined in the Data Input Module Properties section of the Workflow Option dialog, a
notification message will be displayed.

118
 5.3 Data Input Module

Checking fields If you are using a new CSV file in an existing workflow and you want to
check whether the columns and field names of this new file match those of the previously
used CSV file, you can choose from the following options:

No Checking Checks neither columns or field names.

Check only number of fields Checks whether the number of columns in the newly
uploaded CSV file matches the number of columns in the previously used one. If
the numbers are not the same, a warning in Proof/Production appears.

Check also field names Checks whether the field names in the newly uploaded
CSV file match the field names in the previously used one. If the field names do
not match, a warning will appear in Proof/Production.

Preview Records are displayed, line by line. Use the scroll bars to scroll through the data.

Record Definition

Multiple record types If checked, enables reading data that has its records structured
in differing ways, e.g. if the fields within one record should have different field names
than in another.

It is subsequently possible to structure each and every record independently. The

bottom part of the tab will change its appearance and offer more features allowing
you to define keys in order to identify the different types of records. For more details
see the section CSV Working with Multiple Record Types.

Skip first line Disregards the first row of data. The values in that row will be used only
as field names, but will not be returned by the created variables. The effect of this
setting is visible in the Preview area. This option is selected by default.

Deselect this value if your data file does not contain appropriate field names in the
first data row, but starts directly with data. In this case the values in the first row will
be used as field names, but will also appear as data. This then allows you to rename
the fields appropriately (in the Record Definition table) without losing the first row
of data.

Example The data file used in the below examples contains field names
(CustID, CustName etc.) in the first row, the actual data only begins in the second
row of the data file.

Skip first line is selected:

Skip first line is deselected:

119
5 Data Input Modules

Note This option is not available for Multiple record type files.

Name Lists all the fields of the data input file and enables you to edit them using the
icons available just below.

To rename a field, select it in the column and enter a new name. The icons below
this table allow you to perform further actions:

Create New Creates a new field.

Move Up / Move Down Moves the selected field up/down.

Unindent Changes the dependency of the field, i.e. removes a dependency level
from the selected field.

Indent Changes the dependency of the field, i.e. makes it dependent on the
field above.

This is useful for data input files with a complex structure to create a nested sub-
tree or array. To make a field dependent on another field it must first be below
the intended parent, then click on the Indent icon.

Delete Removes the selected field.

Refresh If you have changed name fields or imported a new data input file you
can reset the field names according to the first line of the data file here. If you
press this icon, the data structure of the new data file will be loaded. If not, the
data structure will remain the same.

Note This option is not available for Multiple record type files.

Open Enables you to open a field and record definition file and use it for the
selected CSV file.

Save Saves a field and record definition file (CSS file).

Repeated Count For data input files with a more complex structure (e.g. nested arrays),
you can define the number of times that defined dependent fields are to be read.
You can define it by:

1. Entering the exact number of repetitions.

2. Selecting a field from the drop-down menu (a field which returns the number
of repetitions).

Note When using a field in the Repeated Count column, this field has to
be located above the array being repeated in the data structure. If you select

120
 5.3 Data Input Module

a field which is located below the array, the line displaying the array in the
Record Definition table will change its color to red.

To correct this, either select a different field in the drop-down menu or move
the field above the array that uses it.

See also the description of this option for the Fixed Length Fields file below.

Use last field as array Converts the last data field listed in the Record Definition table
into an array, allowing access to values located at the end of CSV files which do not
have any according data field defined.

Further options are available at the bottom of this tab when Multiple record types has been
selected here. For more details on these options see the Multiple Record Type Files section.

Properties Tab for Fixed Length Fields File Types

121
5 Data Input Modules

When the Multiple record types option is selected, the appearance of this tab will change
in parts. See the Fixed Length Fields Working with Multiple Record Types section for details.

Options Description

Text encoding Selects the codec that should be used to read the characters in the data file.

See the separate section on Text Encoding.

Note When UTF-8 text encoding is used and Byte mode is unchecked, the BOM (byte
order mark), if present at the beginning of the data file, is removed in data input module.
To keep it, read your data with Script Data Input module, using the readLine method.

When UTF-16 text encoding is used, the BOM character used for indicating the endianness
(byte order) is not present in the read data. To keep it, select either UTF-16BE or UTF-16LE
text encoding.

Check unassigned If checked and the chosen Text encoding cannot encode characters
(particularly double-byte characters) to Unicode (when the workflow is processed), a
warning will be displayed in the Log window-pane.

Use byte mode If checked, differing data-types can be read from the data file.

Example A Packed Decimal field in the data file should be handled in byte mode.
You may need to identify and set the encoding to handle the data correctly.

The Byte Mode, Encoding and ... columns then become available in the Record Definition
table for determining which data-type is in which field.

Alternatively, clicking on the 3 Dots icon opens the Choose Record Converter dialog:

Use record converter If checked, a DLL plugin will be used to convert the data-type of
the records.

DLL Locates the DLL plugin file.

A custom DLL is required here, i.e. only DLLs with a specific interface, which exports
the following methods, can be used: hasProperties, editProperties, setProperties,
getPropertiesSize, getProperties, processData, getNameLength, getName;.

Trim right whitespace If checked, removes all space after the value in the field.

Since the length of the field is the same for every variable but the values of variables can
be different in length, it is useful to trim the spaces from the right side of the value.

122
 5.3 Data Input Module

Example

If this option is left unchecked, the value in the first field for the first record returns
the string Maria followed by 25 spaces and for the second record it returns the string
Mark followed by 26 spaces.

Fixed record length If checked, determines that the record is always the length entered in
the Record size edit-box.

If left unchecked, you must define the Line separator.

Record size Determines the size of all of the individual records in the file, in bytes.

Only available if Fixed record length is checked.

Supplementary character support If the input file contains surrogate pairs (consisting of
two characters), use this option to read the pair as one character.

Note The correct displaying of the surrogate pairs is controlled by the Supplementary
characters support option in the Workflow Options dialog. This option ensures correctly
displayed characters for CSV data file type, but for fixed length type this option needs to
be checked additionally, because it is necessary for correct data definition (not only display-
ing).

Tip The same functionality for reading strings containing surrogate pairs is available in
scripting, after the Suggest also byte mode and surrogate functions check-box is
checked in Workflow Options Dialog.

Line separator Indicates the field separator as it is used in the incoming data. The options
are:

Windows/Mac The character 13 serves as the line separator; 10 is ignored.

Unix The character 10 serves as the line separator; 13 is ignored.

Auto Both the characters 13 and 10 are considered a line separator, however, if
13 is immediately followed by 10 it is considered a single separator.

Windows only The only separator is the sequence 1310.

Not available if Fixed record length is checked.

Preview Displays the first 256 kB of the data file characters line by line.

Use the scroll bars to scroll through the data. When data fields have been created in the
Record Definition table, any data field selected either in the Preview area or the Record
Definition table will be highlighted by a special background color, this color can be set in
the Data Input Module Properties section of the Workflow Options dialog.

Note If the Use byte mode option is checked, the preview displays the first 512 kB of
the data file characters.

123
5 Data Input Modules

Field name Displays the name of the field selected in the Record Definition table at the
bottom of the tab.

You can change the field name here, any change made here will also be applied to the
Record Definition table.

Offset Displays the offset of the Field name selected in the Record Definition table.

It is possible to change the value here, the change will also be applied to the Record
Definition table.

Size Displays the size of the Field name selected in the Record Definition table.

It is possible to change the value here, the change will also be applied to the Record
Definition table.

Multiple record types If checked, enables reading data that has its records structured in
differing ways, e.g. if the fields within one record should have different field names than
in another.

It is subsequently possible to structure each and every record independently. The bottom
part of the tab changes its appearance and offers more features allowing you to define
keys in order to identify the different types of records. For more details see the section
Fixed Length Fields Working with Multiple Record Types.

Ln. /Col. Refers to the number of the data lines/columns above which the
cursor is hovering.

The numbers within the square brackets refer to a selection that can be made by clicking
and dragging your cursor over the columns the first number is Offset, the second is Size.

Open Loads definition

The definition files define the structure of the fixed length fields file. There are three possible
formats available for loading the definition files:

FLS file: the default format for storing the definition of the fixed length fields file,
the only format into which you can also save the definition

PLR file: PrintLayout (part of PrintNet 3 suite) format Description of record length,
conversion and usage and Variable Field Descriptions (name, position, length and
conversion)

COB file: COBOL Copybooks file definition COBOL Copybooks called working
storage definitions, fixed positional with alphanumeric data left justified and blank
padded formats.

Once you select a definition file, the following dialog opens:

If you select No, the definition file will be used just once for the given job.

124
 5.3 Data Input Module

If you select Yes, the definition file will be linked to the job permanently, i.e. every time
you change the file it updates automatically when opening the job. The update occurs
only in design time, not in runtime.

Save Saves a definition file.

Link / Unlink Links/Unlinks the definition file, i.e. possible changes in the definition file
will not apply the next time you open the job.

Record Definition Defines the fields of data that will be read from the data input file.

Name Shows the names of the fields that are defined in the input file.

To add a new row and define it as a field, click on the Create new icon located
below the table.

The dependency of the fields is also shown here in tree form and can be changed
using the icons available below the table. Click on the column header to sort the
fields alphabetically by their names.

Offset Defines the location of the starting byte of the field relative start of the complete
record.

Click on the column header to sort the fields in ascending order by the offset value.

Example The screenshot below shows an example of data in the Preview

area of the Data Input dialog:

The numbers along the top (in sets of ten) are designed to help identifying the
Offset location. You can see that in the example above that the figures 21.03
are highlighted. The Offset of 21.03 would be 11 as the first figure (2) is in the
11th byte position (i.e. under the first 1 of the second set of ten).

Size Defines the length of the field in bytes.

Referring to the example in the Offset description above the Size of 21.03 would
be set to 5.

Setting '0' in this field will set the Size of the field to the end of line value.

Byte Mode If Use byte mode is checked, determines the data-type of the field:

Raw Reads the field without identifying its data-type so that one byte will
represent one Unicode value.

For example, if there are 2 bytes making one Unicode character when encoded,
then those 2 bytes will be 2 Unicode characters in a field with Raw selected.

String Interprets the field as a string with the text encoding selected for Text
encoding at the top of the tab.

Encoding Interprets the field as a string with a different encoding to that

selected for Text encoding at the top of the tab.

125
5 Data Input Modules

The Choose Encoding dialog can be opened by clicking on the 3 Dots icon
displayed in the ... column and an Encoding can be selected.

Tip Once you select an encoding, you can copy and paste it into other cells
of this column.

IEEEDouble Interprets the field as a double value according to IEEE Standards.

The IEEE Double Bytes dialog can be opened by clicking on the 3 Dots icon
displayed in the ... column.

Int Interprets the field as an integer.

The Int Bytes dialog can be opened by clicking on the 3 Dots icon displayed
in the ... column and further settings can be made there.

PackedDecimal Reads numbers saved in Packed Decimal format.

126
 5.3 Data Input Module

The Packed Decimal Bytes dialog can be opened by clicking on the 3 Dots
icon displayed in the ... column and further settings can be made there.

Binary Reads the bytes of the field in binary format.

Number in string Reads strings as numbers without the need for conversion.

The String to Number Bytes dialog can be opened by clicking on the 3 Dots
icon displayed in the ... column and further settings can be made there.

The string is read from left to right and any number characters are recognized
as part of the number. However, if there is a break in the number (e.g. another
text character or a space) then only the integers up until that break point will
be read. Also, when a string contains non-numerical characters, a warning
will be seen when the workflow is processed.

Example If string value in the field is: 0968.25 then the whole number
will be read as 968.25, but if the string value was 09S8 then it will be
only 9.

If a text character is first (B6) then this will be read as 0.

This option is also intended for compatibility with COBOL Copybook record
definitions that can be uploaded using the Open icon. Number fields in
such definitions can be strings and so will be read as Number in string.

This column is only available if Use byte mode has been checked.

Encoding If Encoding is selected in the Byte Mode column, displays the name of the
selected encoding.

It is possible to copy the selected encoding and paste it in other cells of this column.

127
5 Data Input Modules

This column is only available if Use byte mode has been checked.

... Contains the 3 Dots icon which can be used to open the according dialogs when
Encoding, IEEEDouble, Int, PackedDecimal or Number to string has been selected in
the Byte Mode column.

This column is only available if Use byte mode has been checked.

Repeated Count Defines the number of times that defined dependant fields (data
groups of the same category and size) are to be read. This enables you to define your
data structure using arrays or sub-trees as building components.

There are 3 possible ways of making an entry:

1. Entering the exact number of repetitions

2. Selecting a variable from the drop-down menu which returns the number of
repetitions

3. Selecting SubTree from the drop-down menu

The option you should choose depends on the format of your data and how you
want to structure it. See the descriptions below for details on each method.

Note It is only possible to enter a value in the Repeated Count column for a certain
data field if dependant fields have been created in the rows below that field.

See the Level down icon description for a description of how to make fields de-
pendant.

1. Entering the number of repetitions

This method would be used in case the data is of a repetitive nature, using
groups of data of the same format and categories that are repeated several
times in the same record. In this case you should enter the amount of times
that the repetition occurs here.

Example The screenshot below shows a record containing a bank ac-

count where the master part of the record is a bank account number
(which must be unique for each case and exists in every case) and the
slave parts are values displaying the monthly interest and charges on the
account.

The screenshot shows a fixed length fields data file which contains an
ID (bank account number) of 10 characters, followed by repeated sets
of 5 characters (4 digits separated by a decimal point) that represent
currency values. The first set of 5 are the Charges for one month and
the second set is Interest for that month. Then Charges and In-
terest are repeated to represent a second month and then repeated
again to represent a third month, etc.

128
 5.3 Data Input Module

In the screenshot only 4 months are shown, but imagine that the variables
Interest and Charges are repeated a total of 12 times to represent
the months of the year (i.e., 24 currency values of 5 characters each).

In such a case, the Data Input could be arranged as a master array (the
account number and details) and a sub-array with 12 slave records; one
for each month of the year. Each of the slave parts would contain an
entry for the charges to the account and an entry for the interest on the
account.

To set this up you need to:

a. Create the master record definition field using the Create New
icon. In this case we will call it Account Number. Set appropriate
values for Offset and Size.

b. Create an additional field (call it "Month") to describe the starting

position (Offset) and Size of each slave part. Month will be the
sub-array containing the smaller data fields.

c. Create a first field for the slave part (Charges) and click on the
Level Down icon to define it as a dependant part of the sub-
array under Month. Create another field (Interest), which should
automatically appear on the same sub-array dependency level. Set
appropriate values for Offset and Size for both.

d. Now go back up one level to Month and click in the Repeated

Count column and set the value to '12' to define how many times
the slave sequence of Charges and Interest will be read from
the record to the sub-array.

The Record Definition table for this example should look like this:

In summary the Record Definition table shows:

Account Number The master record field.

Month An additional field defining the starting offset and size

of the whole slave part. This field is an array structure type. The
number entered in Repeated Count defines the number of times
that the dependant variable data segments (Charges and "In-
terest) will be read from the data file.

Charges and Interest These are the data field definitions for
the slave part.

129
5 Data Input Modules

Note The master part of the record does not have to exist. It is only
used in our example for clearer illustration of the parts of a record. You
could simply have the data fields (Charges and Interest) being read
from the data file without a record identifier. Important to note is the
definition of what is being repeatedly counted i.e. the slave part
("Month") consisting of two data sets: Charges and "Interest.

2. Selecting a variable from the drop-down menu

This method allows the value for Repeated Count to be defined by a variable.
This is especially useful when you have records of differing lengths.

All data fields created in the Record Definition table are available for selection
in the drop-down menu, with the exception of those variables for which de-
pendencies have been set up. To be able to use this option the input data
must contain a value where the number of necessary repetitions for each re-
cord has already been counted and this value must be used in a field defined
in the Record Definition table.

Note When using a variable in the Repeated Count column, be aware that
this variable has to be located above the array being repeated in the data
structure. If you select a variable which is located below the array, the line
displaying the array in the Record Definition table will change its color to red:

Additionally, in case a variable is selected which is below the array in the data
structure, you will not be able to close the Data Input module by clicking on
the OK button, instead an error message with the information "Problem with
the field that is used for Repeated Count. Correct the field definition (problem
array is red)" will be displayed.

The structure of the data when entering a number or selecting a variable in

the Repeated Count column is an array which will be shown in the Layout
Tree as in the screenshot below:

130
 5.3 Data Input Module

You can see that the additional field Month has become an array.

3. Selecting 'SubTree' from the drop-down menu

This method should be used when repeated groups are not defined in the
input data and therefore an array is not needed. This gives a more direct
structure as in the below screenshot of the Layout Tree:

You can see here that the relationship of Month to both Charges and
Interest is a simple one to one sub-tree. Referring to our example above,
this could be used for a bank account statement where only one months
charges and interest are in the slave data groups for one account number
(master).

Recalculate offset If you enable this function and change the size of a field, offsets
of the following fields are automatically recalculated. If this function is disabled, ap-
plying changes to the selected field(s) has no effect on the other fields.

Example
If the Recalculate offset option is enabled, expect the following behavior:

A deleted field makes the following fields move to the left by the size of
the deleted field.

A field moved (drag-and-drop) in the Preview pane makes the following

fields (to the right) move along with the selected one.

Move Up / Move Down Moves the position of the field up and down the table
in relation to the other fields. This is especially useful if you want to move a field into
a position below another field that you would like it to be dependant on.

Level Up / Level Down Moves the selected field through the data structure. This
is an important tool when creating relationships between fields, i.e. in the creation
of sub-tree or array structures:

131
5 Data Input Modules

Clicking on the Level Down arrow makes the selected field dependant upon the
next field above it that is currently on the same dependency level.

Clicking on the Level Up arrow removes a direct dependency.

The arrows only move a field one step up or down the dependency tree at a time.
Use the tree marked in the Name column to help you navigate.

Create New Creates a new field. The field appears as an item in the Record Definition
area and as a selection of bytes (a field in the data file) in the Preview area. To edit
the fields offset and size, click into the field in the Preview area or on the variable
in the Record Definition area and adjust the offset and size by mouse in the Preview
area. Alternatively, you can set the values in the respective columns in the Record
Definition area.

In the Preview area, each field is bordered by color lines marking its beginning and
end. The color of the field changes, when it is highlighted. You can customize the
colors in the Data Input Module Properties section of the Workflow Options dialog.

The field name must be unique and if Fixed record length has been checked, here
on the Properties tab, then the field size must fit within that length. If not, an error
dialog will display after clicking on OK.

When another field is created, the selection moves to the following bytes keeping
the same size, e.g. if you have created a field with offset 25 and size 5, the new se-
lection will cover a field with offset 30 and size 5.

Delete Removes the selected variable.

Further options are available at the bottom of this tab when Multiple record types has been
selected here. For more details on these options see the Multiple Record Type Files section.

Properties Tab for DBF File Types

132
 5.3 Data Input Module

Options Description

Text encoding Selects the codec to be used to read the characters in the data file.

See the separate chapter on Text Encoding.

Check unassigned If checked and the chosen Text encoding cannot encode characters
(particularly double-byte characters) to Unicode (when the workflow is processed), a
warning will be displayed in the Log window-pane.

Ignore deleted records Records deleted from the DBF file will not be processed.

Adjust left Imported records will be left aligned.

Checking fields If you are using a new DBF file in an existing workflow and you want to
check whether the columns and field names of this new file match those of the previously
used DBF file, you can choose from the following options:

No Checking Checks neither columns nor field names.

Check only number of fields Checks whether the number of columns in the newly
uploaded DBF file matches the number of columns in the previously used one. If
the numbers are not the same, a warning in Proof/Production appears.

Check also field names Checks whether the field names in the newly uploaded
DBF file match the field names in the previously used one. If the field names do
not match, a warning will appear in Proof/Production.

Note MEMO fields are not supported.

Properties Tab for Customer Code File Types

Options Description

Text encoding See the separate chapter on Text Encoding.

Check unassigned If checked, a warning will be displayed in Proof and Production if it is

not possible to convert an input data string (particularly double-byte characters) to Unicode
according to the chosen text encoding and its ICU.

133
5 Data Input Modules

5.3.1.3 Data Structure Tab

The Data Structure tab displays the structure of the data as it will pass out of this module.
When working with a single record type, this simply means which fields will be within a record,
but when working with records of multiple types (i.e. when the Multiple record types option
is activated when using CSV or Fixed Length Field files) you must further define the relationship
between the different types of record. For an example of working with multiple record types
see the Multiple Record Type Files section.

Options Description

Record Definition Displays the record definitions that have been defined via the Properties
tab of this module. There will only be one record definition unless Multiple record types
has been selected on that tab and different record types have been defined.

Structure Lists the record definitions and the fields that are part of them.

Type Lists the data-type of the corresponding fields.

Data Structure Structures the relationship between the different record types.

This area only appears when Multiple record types has been selected on the Properties
tab of this module. For multiple record types, add record definitions to this area and edit
the relationship between them using the icons at the bottom of the tab. Any record types
that are not added to this area will not appear in the data structure that is passed out of
this module.

Structure Shows the records types that are part of the data structure and the relationship
between them, using a dependency tree.

Optionality Selects the data-type of the record. The options are:

Array Determines that the record will be of the array data-type. This array
can then be used in the Records by combo-box if it is at the top level of the
structure (i.e. not indented).

Must exist Determines that the record will be of sub-tree data-type, for values
appearing exactly once for all records.

Optional Determines that the record will be of optional data-type, for values
appearing once or not at all.

134
 5.3 Data Input Module

For a description of the data-types used in Inspire Designer, go to the separate section
about Data.

Create New Adds the record definition selected in the Record Definition area to
the data structure.

Unindent / Indent Changes the dependency of the record.

To make a record dependent on another record it must first be below the intended
parent, then click on the Indent icon.

The Unindent icon removes a dependency level from the selected record.

Move Up / Move Down Changes the order of the records in the data structure.

This order is also the order in which the records will be processed.

Delete Removes the selected record type from the data structure.

Maintain child order If checked, the created data structure must match the order of
the records in the data file.

The order in which the records are read from the data file (i.e. from start to end) be-
comes important.

Example If records of type A appear before records of Type B in the file, then
A must be placed before B in the data structure that you have defined here. If
B is placed before A, then B is read before A and when the structure asks for A
it cannot read it.

This should be left unchecked if you are defining a structure that has a different
reading order than the file.

5.3.2 Multiple Record Type Files

In this section: See also:
CSV Working with Multiple Record Data Input Module
Types
Fixed Length Fields Working with
Multiple Record Types

Sequential, fixed-format data files can contain more than one type of record. When they do,
they will be structured in one of two ways:

A logical relationship may exist between the various record types, with a record of one
type being followed by one or more records containing detailed information about the
first record. If a logical relationship exists between the various record types, with a
parent record of one type followed by one or more child records containing detail in-

135
5 Data Input Modules

formation about the parent, you can describe the structure by defining the parent as
the root and the detail segments as descendants.

A file may also contain multiple record types, but have no relationship between them.

Example A file contains these record types: Header, Detail and Footer. To distin-
guish between them, each line contains a key (identifier of the record type). The
key can be:

'H' for the Header record

'D' for the Detail records

'F' for the Footer record

By defining these keys in the Data Input module (as described in this section) you
can organize multiple record types correctly.

When a file contains multiple record types, there must be a field in the records themselves
(sometimes called a "flag" or "key field") that can be used to differentiate between them.
(You can find information on this field in your description of the file.) This field must appear
in the same physical location in each record.

Example The columns 79 and 80 of a fixed-length-field data file could contain a different
two-digit code for each unique record type. Thus, this two-digit code could be defined
as the key on the Properties tab and used to distinguish the record types.

Working with multiple record types depends on the input file type. Below there is a description
of multiple-record-type options for:

CSV data input files

Fixed Length Fields data input files

Note To be able to work with multiple record types, you must check the option Multiple
record types available on the Properties tab when employing CSV and Fixed Length data
files.

5.3.2.1 CSV Working with Multiple Record Types

If you select the Multiple record types option when using a CSV file, it becomes necessary
to define the key field. A key is the identifier of a record type. You need to specify the index
of the field containing the keys so that the Data Input module knows how to distinguish the
different record types used in the file. Then, for each record type identified by a key, it is neces-
sary to define data fields and a data structure. See the Setting Multiple Records Types for CSV
Files for a description of this procedure.

136
 5.3 Data Input Module

Options Description

Key field index Determines from which field in the Preview area the keys listed in the Key
table are taken. By default the setting is 1, which means the keys are taken from the first
field.

Key Lists all different values contained in the field defined using the Key field index option.
These different values identify the differing types of field.

Create New Inserts a new key to the list.

Delete Deletes the selected key from the list.

Name Defines fields for the record type determined by the key selected in the table to the
left. Use the icons below the table.

Repeated Count For data input files with more complex structure (e.g. nested records), you
can define the number of times that defined dependent fields are to be read. You can
define it by:

1. Entering the exact number of repetitions.

2. Selecting a field from the drop-down menu (a field which returns the number of
repetitions).

For details see the description of this option for CSV File type.

137
5 Data Input Modules

For a description of all other fields located on the Properties tab refer to the Data Input module
section.

Example Setting Multiple Record Types for CSV Files

1. Select the appropriate number in the Key field index edit-box. The Data Input
module will look for keys in the selected field and will list all found keys in the
Record Type table at the bottom of the tab. In the screenshot above two keys
have been identified ('Families' and 'Balances') in the first field.

2. Select a key and create fields for this key in the Record Definition table. Click on
the Create New icon below the Record Definition table once for each field
that needs to be defined and rename the new field(s) appropriately. The order of
fields must correspond with the order in the Preview area. In the above screen-
shot, the following fields have been created for the key 'Families': 'FamilyName',
'Members' and 'MembersCount'.

3. Go to Data Structure tab and define the data structure: select a key in the Record
Definition table and click on the Insert Record Type icon or drag and drop
the key to create a new item in the Data Structure table. It is also possible to select
several keys (by pressing and holding <Ctrl>) and move them simultaneously. For
each item it is necessary to select an appropriate value in the Optionality column.

To change the hierarchy and order use the icons available below the Data Structure
table (see the Data structure tab description for details). The multi-select function-
ality also works in this part of the Data Structure tab, i.e. you can change the
hierarchy or order of several items which you have selected simultaneously.

4. The structure resulting from the settings in the above screenshot looks like this in
the Layout Tree:

138
 5.3 Data Input Module

5.3.2.2 Fixed Length Fields Working with Multiple Record

Types
If you select the Multiple record types option when using Fixed Length Field types of files,
you must define the position and size of the key field. A key is the identifier of a record type.
You need to define its size and position so that the Data Input module knows how to distinguish
the different record types used in the file. Use the Key field position and Key field size edit-
boxes to do so. Then, for each record type identified by a key, it is necessary to define data
fields and a data structure. See the Defining Record Types Using Keys and Defining the Field
Structure for Individual Record Types sections for a description of this procedure.

139
5 Data Input Modules

Options Description

Use encoding on key Applies the encoding set in the Text encoding combo-box at the
top of the tab to the keys contained in the data file.

This check-box is only available if Use byte mode and Multiple record types have also
been selected.

Key field position Defines the starting position of the key field by the number of bytes from
the beginning of the line.

See the Defining Record Types Using Keys example for details.

Key field size Defines the default length of the key field starting from the value set in the
Key field position edit-field.

See the Defining Record Types Using Keys example for details.

Default key Determines the key used, if none of the existing key values match.

140
 5.3 Data Input Module

In the combo-box you can select any of the existing record types or Error. Selecting Error
means, that running the workflow will throw an error, if none of the existing key values
match.

Record Type This table lists all defined record types with the keys which are used to identify
them in the data file.

Name Displays the name of the record type.

Type Allows you to set the way the value set in the Key Value column will be matched
with the values contained at the defined Key field position in the data file. The
following options are available:

Exact Use this option when the value entered in the Key Value column ex-
actly matches the key in the data file.

Mask Use this option when the value entered in the Key Value column
contains a wildcard(s).

Example If you want to use the same record definition for all 3-byte
records beginning with the character '6', set the value to '6??'.

Script Use this option if you want to write your own script. The Key Value
column then contains the content of the script and the 3 dots icon which
opens the Script Editor dialog.

Length Allows you to specify the length of the record. The following options are available:

Select Auto The automatically assigned value is the default value (e.g., 80
bytes for the fixed length file type).

Enter a value in bytes determining the length of the record.

Select a variable from the data file defined in the right panel.

This column is available only if the Use byte mode option is checked.

Key Value Enter the value of the key, i.e. the string that will be searched in each line
starting from the position set in the Key field position edit-box. The handling of
the value set here depends on the setting made in the Type combo-box.

Move Up / Move Down Moves the key up/down one position in the list.

Create New Key Inserts a new key to the list. After clicking on this icon the New
Key dialog will be opened:

The value set in the Key Name edit-box will be set in the Name and Key Value
columns of the Record Type table after clicking on OK. You should then also define

141
5 Data Input Modules

the Type for newly created keys. If the Use byte mode option is checked, you should
also define a value in the Length column.

Saves Position and Size into Key Field Inserts the size and position (offset) of a
variable selected either in the Preview area or in the Record Definition table into the
Key field position and Key field size edit-boxes. New keys/record types are defined
in the Record Type table according to these inserted values.

Note All keys/record types already defined in the Record Type table will be overwrit-
ten when using this icon.

Delete Deletes the selected key from the list.

For a description of all other fields available on this tab refer to the Data Input module section.

Example Defining Record Types Using Keys

In the example file used here the keys used for identifying the different record types are
located at the beginning of the line. The longest of the keys is 5 bytes long. Thus it makes
sense to set Key field position to 1 and Key field size to 5. The turquoise stripe indicates
the position and size of the defined default key field (the color of the stripe can be set in
the Data Input Module Properties section of the Workflow Options dialog):

Once you have defined the default key field size in the Key field position and Key field
size edit -boxes, all keys will be listed in the Record Type table. In this sample the available
record types are 'ID123', 'NameJ', 'Calls' and 'Price' (which use keys of the same name):

Although the Record Type table is filled automatically depending on the settings made
in the Key field position and Key field size edit-boxes, this does not mean that all keys
must have the size set in the Key field size edit-box (although they all do share the same
Key field position). E.g., in this case, you would want to change the size of two of the
keys, namely 'ID123' and 'NameJ', because '123' and 'J' are already a part of the value
and do not belong to the keys. To do so:

1. Click into the Key Value column and change the appropriate values (i.e. in this
case 'ID123' to 'ID' and 'NameJ' to 'Name').

2. In the Name column you can then rename these keys if necessary.

142
 5.3 Data Input Module

Tip Alternatively, you can also create completely new keys. First, insert a new
record type (a new key) by clicking the Create New icon and then enter a
value for the key in the Key Name field of the New Key dialog which is displayed.
Delete the old keys ('ID123' and 'NameJ') which are no longer needed.

3. Finish the definition of the record types by specifying an appropriate value in the
Type and (when the Use byte mode option is checked) Length columns.

Now all records beginning with 'Calls', 'Price', 'ID' and 'Name' at the determined Key
field position will be recognized correctly and the field structure defined for these record
types will be applied.

Example Defining the Field Structure for Individual Record Types

For each record type defined using a key in the Record Type table, a specific field structure
(variable structure) must be defined. This structure can be defined in the Record Definition
table on the bottom right of the tab. To do so perform the steps described below:

1. Select (highlight) the record type for which you wish to define a field structure.
Then, click on the Create New icon located below the Record Definition table.
Create as many variables as necessary, this depends on the record type you are
defining. As you can see below, 3 variables have been created for the 'Name' re-
cord type, as there are three values in this line (defined in the Record Definition
table and named 'FName', 'MName' and 'SName'). For the 'ID', 'Calls' and 'Price'
record types only one variable needs to be created in each case.

143
5 Data Input Modules

Keep in mind that the fields displayed in the Record Definition table depend on
the record type selected in the Record Type table.

2. For each variable you add, you need to define the Offset and Size. To do so enter
appropriate values either in the Offset and Size edit-boxes just below the Preview
area or in the according columns of the Record Definition table. The defined fields
are indicated by background colors in the Preview area and by the red and green
lines representing the beginning and the end of each field (the color of these lines
can be set in the Data Input Module Properties section of the Workflow Options
dialog).

3. As a final step, it is necessary to define the data structure so that the created
variables will be available for use in the Layout module. Make the appropriate
settings on the Data Structure tab of the Data Input module (also see the final
step of the Setting Multiple Record Types for CSV Files example for more details).

5.4 External Input Module

See also:
External Input Module Command Line
Parameters

Note This module is not supported by Mac version of Inspire Designer.

The External Data Input module enables users to use an external DLL file to read in data formats
that cannot be read by any other data input module or via COM methods. The DLL file must
be programmed in an external development tool.

To be able to use this module, do the following:

1. First an external DLL (plug-in) must be created.

Send your request for API specification and examples for programming the DLL in C
or C# languages or for creation of the DLL according to your needs to GMC support.

As the specification and examples are confidential, your request must be approved by
GMC CTO and the delivery of information or DLL will be registered.

2. The DLL file extension has to be renamed to PTD.

144
 5.5 Internal Input Module

3. Then the plug-in should be placed in the same directory where the main Inspire Designer
executable file (PNetT.exe) is, or where the CX_DATA system variable redirects to. It is
not necessary to register the DLL.

4. If you then place the External Data Input module into the workflow, it will automatically
look for the plug-in (without further modification) and use it to read data into the
workflow. The data may be processed as if using any other data input module.

5.5 Internal Input Module

See also:
Internal Input Module Command Line
Parameters

The Internal Input module reads data files stored in Inspire Designer's Transactional data format
(TSD).

You can pre-process data using other workflows and save it to a single TSD file via the Data
Output module, then read that file into a new workflow using the Internal Input module. Pre-
processing data in this way can speed up production spooling time, however once the data
has been pre-processed to the TSD file it cannot be updated.

Locate and select the TSD file in the Input file edit-box.

145
5 Data Input Modules

5.6 Line Data Input Module

5.6.1 Line Data Input Module
See also:
First Steps in the Line Data Input Module
Pages Family for Line Data
Pages for Line Data
Sequences for Line Data
Anchors for Line Data
Data Areas for Line Data
Line Data Formatting field converter

The Line Data Input module reads data from data files into a workflow. In particular, data files
that were originally formatted as multiple pages for simple line-feed printers, e.g. a plain text
(TXT) file that also has line-break and page-break characters.

A file may contain a set of differently formatted pages which are repeated for many records,
e.g. 25 customers with different data: Each with a Page 1 and Last Page; but some also have
an Overdata Page inserted between the other two pages if they did not have enough space.
In order to read data correctly from such files, this module creates regular expressions using
different objects that represent expected features of the file's format. Pages need to be identified
using anchors and a page sequence needs to be set up. Then, data areas should be drawn to
determine which data is required to be read.

The task is to fill the default array Records: By identifying which data from the file belongs to
which record; and creating the structure of the repeated fields so that the data can be read
into them. A typical working procedure is described in the separate section First Steps in the
Line Data Input Module.

146
 5.6 Line Data Input Module

The module is represented as a window, which has its own sub-tab in the workflow tab. This
window is split into the following GUI components:

Line Data area Views any text file in the format which it was designed and, in that
view, different data can be marked and corresponding objects created.

Object Tree Determines the relationship between objects that are created in the process
of defining the data from the data file; and allows navigation between those objects.

Object Properties Adjusts the properties of any object selected in the Object Tree.

Menu Offers options relating to the module and its features.

Toolbars Offer tools that help the process of identifying the data in the data file.

147
5 Data Input Modules

5.6.1.1 Line Data Area

The Line Data area is where most of the task of identifying data is done. It is a view of the data
file that represents how the pages have been defined in that file, if Page break on the General
tab of the Pages family include has been set correctly.

In the area, the task is to identify which page from the data file belongs to which page in the
Object Tree (using anchors) and which text from the file is which variable in the data structure
(using datas). This is done by drawing an area over the lines of data and selecting whether it
is a data area or anchor via the context menu of that area:

The context menu in the screenshot above appears when drawing an area inside another data
area to create dependent data areas. When drawing directly on the page you can only select
Add Anchor, Add Data Area etc. Follow these links for a description of the types of data
areas and anchors.

In order to draw inside a data area and create child data areas, the parent data area must be
selected at the moment you start drawing. Selected objects can be: Resized by pressing <Ctrl>
a dragging with the mouse pointer; or moved with the cursor keys of a keypad.

148
 5.6 Line Data Input Module

5.6.1.2 Object Tree

The Object Tree lists every object that is currently defined in the Line Data Input module, in a
dependency tree format. It can be used to navigate through the created objects and the objects
can be clicked on to open their Object Properties and to select the object in the Line Data area
for viewing and editing.

Two object families are represented on the first-level of the tree:

Data Contains all variables that will be the structure of the data read from the data
file.

The structure of the tree under the data family represents the actual relationship of the
variables within it, to each other. Variables have no properties that can be altered: They
are either array or string data-type that can be added to build a data structure for the
data contained in the data file.

By default, there is an array named Records that must exist in order to allow the repeti-
tion of data, if there is more than one record in the data file. Variables and other de-
pendent arrays should be added inside this array to determine the relationship of data
for each record.

Variables can be created while drawing data areas in the Line Data area, so that they
are automatically assigned to the actual data area that will read data to them. However,

149
5 Data Input Modules

there are also Add Variable and Add Array in the context menu that appears when
right-clicking on the Data family or any array:

When a variable has been assigned to a data area, the Assigned icon is shown in
the tree.

Pages Contains all objects that have been marked on the page in order to read data;
and sequences of pages.

The available object types are: page, sequence, anchor and data areas. Sequences and
data areas can be assigned to variables that have been created in the data family, if
they are the names of these object are followed by the names of those variables (in
brackets) in the tree.

The structure of the tree under the pages family represents the processing order of the
data when the workflow is processed; and this can be important to remember when
trying to read repeated lines of data to an array. The pages family also has Object
Properties which control how the page definition in the data file is recognized. See the
separate section Pages Family for Line Data for details.

Objects can be dragged and dropped in the tree in order to correct the structure: In the Data
family this can correct the data structure; in the Pages family this can correct the sequence of
pages and the order that the data areas are read.

5.6.1.3 Object Properties

The Object Properties adjust the object for its intended purpose. Many object types have their
own set of properties that can be accessed by clicking on the object in the Object Tree.

150
 5.6 Line Data Input Module

The object types with properties are:

Pages family

Pages

Sequences

Anchors

Data Areas

5.6.1.4 Menu

Options Description
All of the menu options are described in the separate section Layout Window Menu except for
the following.

File

Use Data File Selects the data file that will be read by the workflow when it is pro-
cessed.

Window

Show Object Tree If selected, displays the Object Tree window-pane which can be
moved and placed where required.

Show Object Properties If selected, displays the Object Properties window-pane which
can be moved and placed where required.

5.6.1.5 Toolbars
Page Toolbar

Options Description

Use Data File Selects the data file that will be read by the workflow when it is processed.

Page Object Selects the page in the Object Tree (so that its properties are
shown in the Object Properties) and tries to match it with the page currently being viewed
in the Line Data area.

The combo-box list all pages that have been created in the object tree. If the selection is
highlighted red, it is reminding you that the page shown in the Line Data area is not cur-

151
5 Data Input Modules

rently recognized as the page which you have selected here. I.e., the page does not match
the sequence and some editing may be required.

Page from File Selects which page will be shown in the page-view area.

These are the pages as they were defined in the data file, i.e. not pages that have been
created in the Object Tree that identify the different page formats.

Previous / Next Display the previous / next page defined in the data file, i.e. the next
page defined by the Page break on the on the General tab of the Pages family.

Previous Record / Next Record Navigate through the records that have been defined
by the sequence of pages, one record at a time.

Once the page order has been defined and an anchor recognizes the first page in the se-
quence for each record, then it is possible to navigate through the pages of the data file
using these icons.

First / Last Display the first / last page defined in the data file, e.g. if there are 10000
pages than it goes to page 1/10000.

Error Displays the first page from the data file that does not conform to the current se-
quence of pages that has been set.

Page sequences are checked (to determine how the page order should be) using anchors
(which identify the page actual pages being read from the text file). If there is a mismatch
this tool becomes active: Both in order to warn you that there is a problem; and allow you
to navigate to the first occurrence of that problem so that it can be resolved.

A mismatch would involve a page is read from the data file and the condition of an anchor
on that page.

Example An anchor is drawn on page B which has the Condition that it is an

Empty line, instead of an address like one that appears on Page A.

A page is read from the data file. According to the sequence, that page should be
page B. However, the anchor reads that it is not an empty line and the Error tool
is activated.

Zooming Toolbar

All of the tools here are described in the separate section Layout Window Menu.

152
 5.6 Line Data Input Module

5.6.2 Line Data Input Objects

5.6.2.1 Pages Family for Line Data
In this section: See also:
Pages Family Object Properties Line Data Input Module

The Pages family sets how the pages have been defined in any data file so that those pages
can be properly displayed in the Line Data area. The family is found in the Object Tree grouping
together any pages and sequences that are defined, clicking on the family opens the Pages
family's Object Properties.

Pages Family Object Properties

The Object Properties tabs are:

General

Script

General Tab

Options Description

Text file Locates the data file that will be read by the workflow.

This path can also be defined via the Use Data file tool or option.

Text encoding Selects the codec to be used to read the characters in the data file.

See the separate chapter on Text Encoding.

Page break Selects how pages have been defined in the data file.

In the Line Data area, this determines how the pages will be displayed, i.e. which data
appears on which page. Select from:

Control characters Searches for the character entered in the Value edit-box and,
if it is found, that point in the data file is the end of the page.

153
5 Data Input Modules

The Value edit-box appears when this option is selected, the control character
must be entered here as a hexadecimal value.

Number of lines Counts the lines of data in the data file and when the number
entered in the Lines edit-box is reached, that point is the end of the page.

The Lines edit-box appears when this option is selected.

AFP line data Searches for the characters entered in the AFP Line Data Advanced
Settings dialog and treats them as page-formatting code.

The 3 Dots icon opens the dialog:

Channel Skip Codes

Channel Determines the character position (on a line) where skip codes may
be found.

Typically it is the first character on any given line and so 1 is the default
value.

Overprint code Enters the hexadecimal code for the character which de-
scribes an overprint.

Overprinting is where one line on a page has characters that are intended
to be placed on the same line as another. If an overprint code is found
in the Channel position of any line, then the characters on that line will
be printed on the preceding line in the corresponding character position.
However, this can only be done if there is a space character in that position
on the preceding line.

Double spacing code Enters the hexadecimal code for the character which
(if found on the Channel position) determines that an empty line should
be inserted in front of it.

154
 5.6 Line Data Input Module

Triple spacing code Enters the hexadecimal code for the character which
(if found on the Channel position) determines that two empty lines should
be inserted in front of it.

Skip Code Enters the hexadecimal code for the character which determines
that lines on a page will be skipped.

Skipping is when some empty lines are required on a page or even when
it is required to move to the next page, i.e. it can act as a page break.
When a skip character is found in the Channel position of any line, then
the characters on that line will appear on the corresponding Destination
Line of the page.

Example If Channel is 1, Skip Code is 0039 and Destination

Line is 25, an invoice might look like this:

Notice how before item 9 there are empty lines and item 9 appears
on line 25. This is because 0039 is hexadecimal for the character 9
and when a 9 was found in the first position on a line (channel 1)
the subsequent content was moved to line 25 (the Destination
Line).

Skipping is only done down a page and, if the destination line is not below
the skip-code line on the current page, the content will be moved to the
corresponding destination line on the next page. For example, if a skip
code is found on line 40 and the Destination Line is 4 then this is a page
break and the subsequent content will appear on the following page
(starting on line 4).

Unwanted Characters Enters hexadecimal codes for characters which should

be ignored.

It can happen that some characters appear in the line data that have no
meaning for the purpose of this module (e.g. a formatting command that
cannot be used) and these characters are not wanted to appear on the page
or to be read as data. If you are aware of such characters (or find them), enter
them into this list and they will not appear on the page.

Line break Selects how lines of data have been defined in the data file:

Control characters Searches for the character entered in the Value edit-box and,
if it is found, that point in the data file is the end of the line.

155
5 Data Input Modules

The Value of the control character must be entered as the character's hexadecimal
value.

Number of characters Counts the text characters in the data file and when the
number entered in the Characters edit-box is reached, that point is the end of the
line.

2-byte length prefix Takes the length of the line from a record descriptor word
(rdw), in cases that they have been used in the first two bytes of each line.

Rdws are typically used as line breaks for AFP line data, where break characters
are in the first column of the data file.

4-bytes length prefix (RDW) Takes the length of the line from a record descriptor
word (rdw), in cases that they have been used in the first four bytes of each line.

Rdws are typically used as line breaks for AFP line data, where break characters
are in the first column of the data file.

In the Line Data area, the line break determines how the lines of data will be seen, i.e.
which data appears on which line.

Script Tab

Options Description

Use script Determines that a script will be used to manipulate the data from the file, e.g.
add data to pages in order to help viewing.

Edit Script Opens the Script Editor dialog where any script should be written.

156
 5.6 Line Data Input Module

Example A script might be used to add page numbers and line numbers to help
you count:

Lines.insert(0,PageCounter.toString());
for(Int i=1 ;i<Lines.Size;i++)
Lines[i]+=(i+1).toString();

In the screenshot, notice the page number (7) at the top-left of the page and the
line numbers down the right-hand side.

5.6.2.2 Pages for Line Data

In this section: See also:
Page Object Properties Line Data Input Module

Pages are objects that define the different formats of the pages that are read from the data
file.

It is typical that a set of page formats is repeated in a data file of many records, e.g. there are
more than 2000 pages defined in a data file, which consist of 1000 customer records with 2
page formats used by each record (Page 1 and Last Page) and some records also using another
page format (Overflow Page). In order to identify these different page formats, anchors are
used to read data at specific positions on each page from the data file and a condition is applied
to each anchor. If the conditions of all anchors are met for any particular page from the data
file, then that page is matched to the page created here in the Line Data module.

The most important purpose of this matching process is to identify when a new record starts
in the data file.

157
5 Data Input Modules

Page Object Properties

Options Description

Anchor Selects which anchor will be used to identify the page.

Anchors must first be created to be available in this combo-box. Multiple anchors can be
created in order to have many conditions that must be met for the data to match the
page. To add a new anchor to the list, click on the Create New icon.

Invert If Yes is selected, inverts the condition of the Anchor.

Example If the Condition of an anchor is Contains and it has a Value of Invoice.

Then, the page will be matched when the anchor does not contain the text Invoice.

5.6.2.3 Sequences for Line Data

In this section: See also:
Sequence Object Properties Line Data Input Module

Sequences are objects that determine the order that dependent objects should be read. They
have arrays assigned to them and interpret any repetition of that object order as a repetition
of the records in that array, e.g. when a page order starts again, a new record is started.

Sequences are added to the Object Tree by right-clicking on the Pages family or a sequence
that will be parent to the new sequence:

Their position in the Object Tree is important. There must be a sequence as a parent to each
set of objects that will be repeated the same number of times.

For pages, the use of sequences must follow the actual order that pages from the data file are
being read for each record.

158
 5.6 Line Data Input Module

Example

1. If the page order is ABC-ABC-ABC, then the sequence should directly parent pages
A,B and C:

With such a sequence, the order of the pages must always be ABC-ABC-ABC, i.e.
every fourth page starts a new record.

2. If the page order varies AC-ABBBC-ABC, then the sequence should directly parent
pages A and C and inside that sequence another sequence needs to be nested
for page B:

With such a sequence, the order of the pages must always begin with A then B
but page B can then appear any number of times and finally page C must appear.
Then the repetition and a new record starts again with page A.

Also, anchors would have to be used (on page B) in order to identify when the
repetition of page B ends.

It is similar for repeated data areas, where the relationship is often a single nested sequence
on a page.

Example Here there is one repeated data area that reads data values (that all need to
be in the same sub-array) using nested child data areas:

Here a repeated data area, called Data Area Line, is parent to five child data areas that
read the data.

159
5 Data Input Modules

The corresponding data structure is required to be:

Notice that the array Items is parent to five variables.

And so a sequence must parent the repeated data area in order to relay the repetitions
of data to the array:

Notice how Sequence 1 contains the repeated data area and has the Items array assigned
to it.

Sequence Object Properties

The Object Properties tabs are:

Repetition

Content

Repetition Tab

Options Description

Min repetition / Max repetition Sets the minimum/maximum number of repetitions that
can occur in the sequence.

By having a Min repetition of 0 any object in the sequence is optional. When the Max
repetition is exceeded the sequence will end. For example, as an alternative to using an-

160
 5.6 Line Data Input Module

chors on pages in order to identify the start and end of a repetition, you might know how
many repetitions occur for a particular sequence of pages and so you can define that here.

If repetition is used in combination with anchors, it can be used to find unexpected amounts
of page repetition for a record.

Example It was only expected that page C would repeat twelve times so Max re-
petition is 12. However an anchor is recognizing that page C is read more times
from the data file and the Error tool is activated.

Greedy If checked, the sequence will repeat as many times as it can.

If unchecked, the sequence will repeat as few times as possible.

When there are many sequences, keeping Greedy checked for only one sequence can be
used to determine that this sequence will be used to read data in preference to other se-
quences (which do not have Greedy checked) if the sequences are found to be equal in
any circumstances. This could be useful in cases when there are only slight variations in
page formats: Where it is not wanted to create separate pages; but still it is required to
differentiate between data so that it is not read into the same variable. See the example
of use at the end of this section.

However, it is possible (and preferable) in most cases to avoid the use of this option by
using a complete set of pages and anchors.

Content Tab

Options Description

Array Selects which array the repetition of the sequence will control.

An array must have been created first in the Data family in order to be able to select it
here. Every time the sequence returns to the beginning (e.g. if the page order is ABC-ABC-
ABC then each time page A is read) then a new set of values (a new record) is started in
the array.

Example Sequences, Repetition and Greedy Sequences

Three successive pages from a data file have the following simple data on them:

Page X x area A

Page Y x area B

Page Z xx area B

161
5 Data Input Modules

It is required to read either area A or area B depending on which page is currently being
read from the data file.

1. Draw a single parent data area around the whole line of data, on the first page
shown in the Line Data area. Inside that area draw: Two anchors (A & B) around
the different character spaces where x may appear; and two data areas (A & B)
in the different positions where the data is expected.

The resulting order in the Object Tree could look like this:

2. Set Condition for both anchors (A & B) to Not empty line via the anchors' Content
tab.

3. Assign Anchor A to data area A (via the data area's Anchors tab) and anchor B
to data area B.

The intention of this is that: If anchor A is matched, data will be read by data area
A (as required for page X); and if anchor B is matched data area B will read the
data (as required for page Y).

However, because they are both on the same page (Page 1) that has been defined
in the module, this would result in an error for both page X (because anchor B
does not match) and page Y (because anchor A does not match), e.g.:

The above screenshot is of the error for page X.

4. Add two sequences (A & B) to the page via the Object Tree and move the data
areas inside those respective sequences.

162
 5.6 Line Data Input Module

Because, by default, the Min repetition is set to 0 on the Repetition tab then
the data areas are optional and don't have to exist. Therefore, if child data areas
can't read data (because their anchor does not match) it is just interpreted as zero
repetitions. And if one sequence has zero repetitions, then the next sequence is
read instead. This solves the problem of page X and page Y, but not Page Z:

Page X is reading area A.

Page Y is reading area B.

Page Z is reading empty data.

Page Z is a match for both anchors (A & B) and so both data areas would read
data. However, only data area A reads data from Page Z, because it is first in the
processing order (determined by position in the Object Tree), i.e. data area A reads
an empty value (because there is not any character in that position) and data area
B is not read.

5. Uncheck Greedy on the Repetition tab of sequence A.

Now sequence B is the only greedy sequence and, if both sequences are equal (in
this case both have anchors that match), the sequence B will be the one reading
the data. Solving the problem of Page Z:

Page Z is now reading area B.

5.6.2.4 Anchors for Line Data

In this section: See also:
Anchor Object Properties Line Data Input Module

Anchors are objects that identify pages, data areas or other anchors in order to determine
which one of those objects should be used to read data at a given position. Additionally, they
can be used to confirm that the data being read from them is the data that is expected or to
set a relative position for other objects.

Anchors read all data in the position where it is placed and have a condition attached, i.e. if
the data meets the condition set then the anchor is also met. In practice, an object can use
anchors in order to set the conditions for when that object should be used to read data.
Therefore, if all anchors used by an object are met, then that object will be used.

Anchors can be created by drawing in the Line Data area.

163
5 Data Input Modules

They can also be added to data areas via their context menu in the Object Tree.

After being created and defined, an anchor should be assigned to a page, data area or anchor
via their Object Properties.

Anchor Object Properties

The Object Properties tabs of anchors are:

Position

Content

Position Tab
The options on the Position tab are described in the separate section Position Tab for Line Data.

Content Tab

Options Description

Condition Selects which condition the anchor applies:

Contains If the anchor reads all of the characters entered in Value, the condition
is met.

If the anchor is being used as a reference point for position (via Relative to on an
objects Position tab), then the position of that object is relative to the position
which the Value is found.

Empty If the anchor contains no characters or just spaces, the condition is met.

If the anchor is being used as a reference point for position (via Relative to on an
object's Position tab), then the position of that object is relative to the anchor's
origin.

164
 5.6 Line Data Input Module

Empty line If the anchor contains at least one line with no characters or just
spaces, the condition is met.

The intention is to use this condition if the anchor contains more that one line,
then the condition is met if any one of the lines within that anchor is empty. Altern-
atively, if the anchor is being used as a reference point for position (via Relative
to on an object's Position tab), then the position of that object is relative to the
first empty line that is found.

Not empty line If the anchor contains at least one character (not including space
characters) on all lines, the condition is met.

The intention is to use this condition if the anchor contains more that one line,
then the condition is met if any one of the lines within that anchor is not empty.
Alternatively, if the anchor is being used as a reference point for position (via Rel-
ative to on an object's Position tab), then the position of that object is relative to
the first line with characters that is found.

On change If any characters contained in the anchor have changed (from last
page to current page), the condition is met.

If the anchor is being used as a reference point for position (via Relative to on an
object's Position tab), then the position of that object is relative to the anchor's
origin.

On change, not empty If any characters contained in the anchor have changes
(from last page to current page) AND the anchor contains at least one character
(not including space characters), the condition is met.

If the anchor is being used as a reference point for position (via Relative to on an
object's Position tab), then the position of that object is relative to the anchor's
origin.

A purpose of an anchor is to identify pages or data areas and, in this case, they must be
assigned to those objects via their Object Properties. Therefore, pages or data areas use
this condition to identify whether the data from the data file is as it was expected by the
currently defined sequence.

Anchors can also be used for the option Relative to on the Position tab. In such cases,
this condition determines whether or not an object will be used to read data from those
relative positions.

Value If Contains has been selected, determines the value that must be read by the anchor
in order for the Condition to be met.

Leaving this field empty determines that the value can be anything and the condition
Contains is always met, i.e. it does not matter what the anchor reads. In effect, this is the
same as ignoring the Condition. Also, if any line of a multiple-line entry in this edit-field
is left empty, then that line is ignored.

165
5 Data Input Modules

Example If the anchor is drawn on the page over three lines:

And it is required to match the text Fred Bloggs Limited and Northampton but the
address on the line in-between changes. Then enter Fred Bloggs Limited on the first
line and Northampton on the third line and leave a line gap, in order to ignore the
second line:

5.6.2.5 Data Areas for Line Data

In this section: See also:
Data Area Object Properties Line Data Input Module

Data areas are objects that read data from pages and return it to an assigned variable, giving
a value for that variable for the current record, i.e. they read all data (in the position where
they are placed on a page) into the workflow.

There are the following uses for data areas:

Drawing them directly on a page in the Line Data area.

166
 5.6 Line Data Input Module

Here data areas can either: Read the value to an assigned variable; or group together
other data areas, e.g.:

Drawing repeated data areas inside other data areas, e.g.:

If drawn, they will be repeated from top to bottom of the parent data area, e.g.:

And a corresponding sequence is created automatically in the Object Tree.

And they should have an array assigned to them, e.g.:

The intention is that the array will be a parent to a set of repeated variables, with the
values of the repeated variables provided by child data areas drawn inside the parent
repeated data area.

Drawing child data areas inside parent data areas, e.g.:

167
5 Data Input Modules

If they are drawn inside repeated data areas, they will be part of that repetition sequence:

Data areas read values to an assigned variable. If it is inside a repeated data area, then
the variable should be in the array assigned to the sequence which is parent to that
repeated data area, e.g.:

When drawing data areas in the Line Data area, assigned variables or arrays can be created in
parallel via the Add Variable dialog that opens after right-clicking and selecting Add Data
Area or Add Repeated Data Area.

Entering a Variable name and clicking on Create will create a variable in the current context
of the data structure (i.e. inside the array that has been assigned to the sequence which is the
immediate parent of the data area) and that variable is automatically assigned to the new data
area.

Example

1. If creating a data area on a page which has its page order determined by Docu-
mentSequence (the default sequence which has the default array Records assigned
to it), the variable will be created inside the array Records.

168
 5.6 Line Data Input Module

Notice how in the screenshot, Data Area 1 has the variable Postcode assigned to
it. Postcode was the Variable name name entered in the Add Variable dialog at
the time the data area was drawn in the Line Data area.

2. If creating a data area inside a repeated data area, the variable will be created
inside the array that is assigned to the sequence which controls the repetition of
that repeated data area.

Notice how in the screenshot, Data Area 1 has no variable assigned to it because
it is just being used to determine the area in which the repeated data area can
be repeated.

Some data areas will not require a variable (e.g. parent data areas inside which child data areas
will be nested) and so you can click on Skip so that a variable is not created. Also, data areas
that are drawn with more than one line, do not open the Add Variable dialog while drawing
but variables can be assigned to them if required.

Data Area Object Properties

The Object Properties tabs of data areas are:

Position

Anchors

Content

Position Tab
The options on the Position tab are described in the separate section Position Tab for Line Data.

169
5 Data Input Modules

Anchors Tab

Options Description

Anchor Selects an anchor to be used to identify the data area.

Anchors must first be drawn inside the data area in the Line Data area to be available in
this combo-box.

Example If employing repeated data areas (to read lines of data with the same
format but differing data), the parent data area usually determines the number of
times the child area is repeated by its height. However, different pages might have
differing numbers of lines of data being repeated. In such a case, draw the parent
data area big enough for the highest number of repetitions and expect that in some
cases there will be empty lines.

The problem at this point is that: For every empty line there are empty values being
sent to the variables in the assigned array, which is useless data.

To resolve this we need a condition to check whether there is anything in the indi-
vidual lines of the parent data area:

1. Draw an anchor in the repeated data area (before drawing any dependent
data areas inside it).

2. Set that anchor's Condition to Not empty line on its Content tab.

170
 5.6 Line Data Input Module

3. Assign that new anchor to the repeated data area, here on the Anchors tab.

At this point, if you are currently viewing a page that does not meet this Not
empty line condition (i.e. there are empty repeated data areas), you will see
an error indicated in the Line Data area.

And the same error also indicated in the Object Tree.

The error is saying that: A repeated data area must be repeated throughout
its parent data area but the condition assigned to the repeated area is not
met, so the properties of one of those data areas do not match the actual
data on the page. This issue must be resolved.

4. Go to the parent data area and on its Content tab (see below) and uncheck
Parse to end.

Now that data area does not have to read every line of data within it, and
the repeated data area within it does not have to be there.

Multiple anchors can be created to give many conditions that must be met to confirm a
match for the data area. To add a new anchor to the list, click on the Create New
icon.

Invert If Yes is selected, inverts the condition of the Anchor.

171
5 Data Input Modules

Example If the Condition of an anchor is:

Not empty line, then a data area will be matched when the anchor is com-
pletely empty.

Contains with Value set to 3, then a data area will be matched whenever the
anchor does not read the character 3.

Content

Options Description

Variable Selects which variable the data area will read its data to.

All previously created variables are available from the combo-box menu. Alternatively select
Create variable in order to add a new variable in the corresponding array in the Data
family of the Object Tree.

The selected variable should be a member of its corresponding array, e.g.

Example If the data area is directly on the page, then it should be a variable which
is directly in the array which is assigned to the page's sequence.

Notice how the variable Postcode is assigned to Data Area 1, which is correct. Data
Area 1 is on Page 1, which is in DocumentSequence. Records is the array assigned
to DocumentSequence and so Postcode must be a child of Records.

Trim type Selects the type of trim to be applied to any values read by the data area: None,
Both, Left or Right.

The values being read to variables are strings and often strings will not be the same length.
This would lead to empty characters (spaces) at either end of the string existing in the data
values coming from this module. By trimming, empty characters will be removed from the
selected end of the string.

172
 5.6 Line Data Input Module

Example A data area is drawn with a Width of 14 characters, but one page the
string LT6 9GG is read, which uses only seven characters.

By selecting Right here, the seven unused character spaces at the end of the string
will not be read into the variable; and the value of that variable (for that record) will
contain only seven characters.

Parse to end If checked, every line of the data area will be read.

This may cause errors in cases when data areas are just being used to group together
other data areas, if child data areas drawn inside this data area do not fill all of the lines.
In these cases, it is best to uncheck this option. See the option Anchor on the Anchors
tab (above) for an example of such an error.

This option is only available for data areas drawn directly on a page.

5.6.2.6 Position Tab for Line Data

See also:
Line Data Input Module

The Position tab is used by anchors and data areas to position them over different data in the
Line Data area.

Options Description

Position

Position X / Position Y Set the position of the origin of the object, on the page.

The measurement units are characters (X) and lines (Y). The origin (coordinate 0,0)
of an object is its top left hand corner.

Width / Height Set the size of the object.

The measurement units are characters (X) and lines (Y). Sizing of the object can also
be performed by pressing <Ctrl> and dragging the boundaries of the object with a
mouse in the Line Data area.

173
5 Data Input Modules

Relative to Selects an anchor which this object's position will be both dependent on and
relative to.

If the Condition of that anchor is met, this object will be used to read data in a Position
that is relative to the position of that anchor.

Example If Anchor 1 has Position X: 15 and Position Y: 30. Then:

If Data Area 1 has Position X: 10 and the corresponding Relative to set to

Anchor 1, then its actual X-value will be 25.

If Data Area 2 has Position X: 20 (but no corresponding anchor selected for

Relative to) and Width: 20 with a corresponding Relative to set to Anchor
1, then the actual X-value of the top right-hand corner of Data Area 2 the
will be 35.

If the Condition of that anchor is not met, the object will not be used. This is true even
if other Relative to anchors' conditions have been met, i.e. all Relative to anchors must
be met for an object to be used.

Example If Data Area 1 has: Position X with corresponding Relative to set to

Anchor 1; and Width with corresponding Relative to set to Anchor 2; but Anchor
2 does not have the Condition on its Content tab met.

Example Use of Relative to

The text Invoice Total might appear anywhere between lines 12-30 (always between
characters 40 and 55) on a page called OverflowPage. This is because it is the last
page in a sequence and there are an unknown number of repeated data areas

174
 5.6 Line Data Input Module

(transactions) that overflow onto this page, i.e. an unknown number of lines until
the last line of transactions appears.

1. Anchor 1 is drawn between characters 40 and 55 and from lines 12-30.

Notice how Invoice Total appears on line 19 in the example screenshot.

2. It is given the Condition of Contains the Value: Invoice Total.

3. Data Area 1 is drawn on the same line as Invoice Total on the current page
(at character position 67 to 76) to read the value of the total.

Now we want this data area to always read data on the same line that the
text Invoice Total appears on other pages (e.g. if Invoice Total appears on
line 28 then the data area should be on line 28), but nowhere else.

4. On the data area's Position tab, set Position Y to be Relative to: Anchor
1.

Notice how the Position Y value is now set to 0, indicating that Data Area 1 will
be on the same line as the object that it is relative to, Anchor 1. Further, this means

175
5 Data Input Modules

that the position is relative to the position in the anchor on which the condition is
met, not just the origin of the anchor as it is drawn on the page.

5.6.3 First Steps in the Line Data Input Module

See also:
Line Data Input Module

This example recreates the first steps we have consistently followed when using the Line Data
Input module to read data to a workflow.

The task is to fill the default array Records: By identifying which data from the data file belongs
to which record; and by creating the structure of the repeated fields so that the data can be
read into it.

1. Click on the Use Data File icon and select the data file that should be read.

2. Identify the pages as they have been determined in the data file.

The settings on the General tab of the Pages family include Page break and Value,
which must match the method that has been used to identify pages in the data file.
There are default settings (Control characters and 000C) and if these are not found in
the file Inspire Designer will attempt to identify which system has been used and adjust
the settings accordingly. However, this attempt is only based on typical formats, so
check that all pages have been recognized correctly and make any required adjustments:

Do you have the number of pages that were expected in the file? E.g. 10000:

Is the Page break value correct for your file?

3. Create pages and page sequences for the other page formats.

The order in which the pages from the data file are read, must be matched by the order
that pages appear in the Object Tree and sequences that control their repetition. There

176
 5.6 Line Data Input Module

is already one sequence created (DocumentSequence) by default, because it is expected

that all files will have at least one repetition of data.

DocumentSequence defines the repetition of the default array Records and, because
in Step 2 we identified that there are many pages, one record is currently one page. If
there are more pages to one record, we must determine the repetition of pages per
record.

Clicking on the Invalid icon will go to the first page that is not recognized, but you
should check other pages:

Is there always the same repetition of pages, e.g. ABC-ABC-ABC-ABC-ABC?

If so: Right-click on DocumentSequence and select Add Page, in order to add

more pages to DocumentSequence, e.g.:

For this sequence, all created pages must exist for each repetition.

Is there a differing repetition of pages, e.g. AC-ABBC-AC-ABBBC-ABC?

If so: Right-click on DocumentSequence and select Add Sequence; and then right-
click on that new sequence and select Add Page, in order to add those pages
which have differing repetition, e.g.:

In the sequence in the above screenshot, it is Overflow Page which has a differing
repetition. Similar to page B in AC-ABBC-AC-ABBBC-ABC, Overflow Page does
not have to exist or it can be repeated many times.

4. Identify Page 1 as the first page format in the sequence using an anchor.

If there is always the same repetition of pages (e.g. ABC-ABC-ABC), this step is not
necessary. But if you are uncertain of this repetition, or know that there is a differing
repetition of pages (e.g. AC-ABBC-ABC), then this step is necessary.

There is already one page created (Page 1) by default, because all data files have at
least one format for presenting data on a page.

177
5 Data Input Modules

But, if the file contains differing formats (e.g. Page 1, Overflow Page and Last Page)
we need to recognize which page is currently being read. This is done by creating an
anchor:

An anchor identifies some data on a page that is unique to that format of page. The
Content tab of the anchor determines the condition. By default the Condition says:
If it Contains the value around which the Anchor was drawn (e.g. 1), then it is the
correct page (e.g. Page 1):

The anchor must also be selected in the properties of the page itself:

For our example Page 1, we have now determined that Anchor 1 MUST contain 1 else
it is not Page 1.

Note If the Invalid icon is active on the Page toolbar, then there is an error in the
page order as it is currently defined.

From our example Page 1, this would mean that the sequence was expecting Page 1
but Anchor 1 does not contain value 1 for the page read from the data file.

5. Repeat step 4 for each page added to the Object Tree.

This step might not be necessary if there are only two page formats, because if one
page is identified with an anchor any format that is not identified must be the other
page. However, if there are many page in the data file, identifying each page with an-
chors as you find them helps to ensure that no pages are unrecognized. If there are
any unrecognized formats then the Invalid icon will activate.

178
 5.6 Line Data Input Module

6. Mark the data to be read from the pages using data areas.

For 1record-1value data, draw a data area around the value, e.g.:

Which creates a variable directly inside the Records array, e.g.:

Notice how each variable displays the Assigned icon to show that a data
area is assigned to it. The assigned data area will read data to that variable.

For 1record-many values data, draw a data area around the many values, e.g.:

Then, inside that data area, draw a repeated data area around one set of values,
e.g.:

Which creates an array inside the Records array, e.g.:

And fills the data area with the sequence of the repeated data area, e.g.:

179
5 Data Input Modules

Then separate the repeated data area into variables by drawing more data areas,
e.g.:

Which creates variables inside the new array, e.g.:

And the data area is drawn in all repetitions of the repeated data area, e.g.:

For our example Page 1, the structure of the page in the Object Tree would now be:

Notice how the names of data areas are followed by the names of the variables (in
brackets) that they will read values to.

7. Continue to build a workflow by connecting other modules to the data output connector
of this module.

The above steps outline the basic principle of determining which data should be read from the
data file. However, because of common irregular formatting that can be found in data files
(differing page lengths, differing amounts of repeated data etc.) there will probably be many
extra adjustments needed in order to read data successfully from a file which contains many
pages, e.g. more anchors needed on both pages and in data areas. The solution for such files
has to be dealt with on a case-by-case basis using the GUI available.

180
 5.7 ODBC Data Input Module

5.7 ODBC Data Input Module

In this section: See also:
How to Connect to an ODBC/Native Arabic, Hebrew, Indic Languages Support
Oracle Source ODBC Data Input Module Command Line
How to Define Variable Substitutions Parameters

The ODBC Data Input module enables you to:

Read data from an ODBC source (e.g. Microsoft SQL, Oracle, My SQL, Excel, etc.) into
a workflow via an SQL command that determines how variables should be created from
the available data.

ODBC (Open DataBase Connectivity) is a programming interface that enables an applic-

ation to access data in databases that use Structured Query Language (SQL). An ODBC
driver is necessary for ODBC-enabled programs to get information from ODBC data
sources.

Installation of ODBC and maintenance of the ODBC interface should be conducted using
an ODBC Control Panel, e.g. the standard Windows ODBC Control Panel.

Connect natively to Oracle databases using OCI (Oracle Call Interfaces) and read data
into a workflow via an SQL command that determines how variables should be created
from the available data.

181
5 Data Input Modules

Options Description

Create Connect String Opens the Select Data Source dialog where the data source can be
specified either on the File Data Source tab or on the Machine Data Source tab.

Click on the Help button at the bottom of the Select Data Source dialog for further in-
formation on the options available here.

Note

This feature is not supported by the Mac version of Inspire Designer.

Connection string to DB2 cannot be created using this button. However, if the
connection string is created once manually (via some external application) it can
be further used in Inspire Designer.

Create Oracle Connect String Opens the Oracle Connection dialog where you can specify
values used in the OCI connect string:

Enter the login credentials (user name and password) to the User and Password fields.
Then specify the location of the server in the Server, Port and Instance fields. Set an
appropriate value in the Prefetch row count field to optimize the performance when
executing a query; by default the value 50 is set here.

The values specified in this dialog will be formed into an OCI connect string after clicking
on OK. The connect string begins with the "OCI:" prefix.

Example The values entered in the above screenshot result in the following OCI
connect string:

OCI:UID=oracleuser;PWD=pass;SERVER=AC15:1521/orcl;PREFETCH_ROW_COUNT=50;

OCI Configuration Files

sqlnet.ora Specifies the net service names (e.g. tnsnames.ora or ldap.ora, see
below).

Example
NAMES.DIRECTORY_PATH= (LDAP)

tnsnames.ora Defines the connection to databases.

182
 5.7 ODBC Data Input Module

Example
MY_ORACLE = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST =
ac15.cz.gmc.net)(PORT = 1521)) (CONNECT_DATA = (SERVER = DEDIC
ATED) (SERVICE_NAME = orcl) ) )

ldap.ora Defines the connection to LDAP.

Example
DIRECTORY_SERVERS = (ldap_server.mycompany.com:389:636) DIRECT
ORY_SERVER_TYPE = OID

Files *.ORA must be placed in folder $ORACLE_HOME/network/admin (ORACLE_HOME

is an environment variable).

Note The following limitations apply to connecting natively to Oracle databases:

An Oracle client has to be installed on the workstation on which Inspire Designer

is running.

Oracle ODBC drivers and OCI cannot be used simultaneously by the same instance
of Inspire Designer.

Substitution Table Opens the ODBC Substitution Table dialog which allows the specification
of variables that should be replaced by other variables that already exist in the workflow.
This functionality can be used regardless if connecting via ODBC or natively to Oracle (OCI).

Any variable in a Connection string or an SQL command can be replaced with the value
that is returned by another variable (of string data-type) that exists in any other module
in the workflow. The replacement variable can be selected via the Insert Param Variable
dialog that opens when the 3 Dots icon here is clicked on. The value of the variable is
concatenated with the module's name.

If the replacement variable cannot be found when the workflow is processed a recoverable
error occurs. If this error is ignored the values entered in Default Value in Design is used.

This feature can be most simply used in conjunction with the Param Input module, where
'workflow parameter' strings can be entered. Any string entered there can then be used
as the replacement value. See the example How to Define Variable Substitutions below,
for more details.

183
5 Data Input Modules

Connect String Displays the connection string after the data source has been specified via
Create Connect String.

Connect When clicked on, connects to the data source.

Tables Displays the tables of the ODBC database in dependency tree format.

Fields Lists all of the fields of any table that is selected in the Tables area.

Name Shows the name of the field category.

Type Shows the data-type of the field category.

Alias Defines an alias name for the field category. This alias name will be used by In-
spire Designer during further processing.

Sort Sorts the field category in either an ascending or descending order.

If None is selected, no sorting is applied.

Visible Sets if the field category column will be visible in the final table created by the
SQL command.

Criterion Adds a condition to the field category, that determines when it will be displayed.

The condition consists of an operator (e.g. =, >, <) and a specified item. If the
specified item is a string, it is necessary to set it into single quotes (e.g. 'Anne').

Example The criterion for the ZipCode field category is set to >1478. If no
other field (Alias, Sort, Visible) is set, the SQL command will display all records
with a ZipCode value higher than 1478.

The criterion for the Town field category is set to ='London'. If no other field
(Alias, Sort, Visible) is set, the SQL command will display all records where the
Town field includes London.

Note For SQL Server and SQL Native Client drivers, columns' names starting with
a digit are quoted in square brackets, e.g. [01_BILLING_PERIOD]. Although, this is not
a valid syntax for all DB; e.g. MySQL does not accept this syntax, it accepts such
columns' names as they are, without any special characters.

Move Up / Move Down Change the order of the rows.

Create Command Creates an SQL command according to the criteria specified in the Fields
area.

SQL Command Displays the SQL command created using the Create Command button.

184
 5.7 ODBC Data Input Module

Execute Command for Test When clicked on the command is run and the SQL Command
Test dialog opens displaying the tables with the values that have been read from the
database, e.g:

Definition Name Names the data set that has resulted from the SQL command. This name
will be used by Inspire Designer during further processing.

Tip SQL commands can also be edited further, once the workflow has been loaded to the
processing environments of Proof or Production.

In Proof this is done via the Proof menu: Proof | Edit Workflow Parameters.

In Production this is done via the Workflow Parameters window-pane. Go to Production menu:
Window | Show Workflow Parameters.

5.7.1 How to Connect to an ODBC / Native

Oracle Source
To connect data from an ODBC/native Oracle source, do the following:

1. Click on the Create Connect String (for ODBC) or Create Oracle Connect String
(for native Oracle) buttons and specify the data source.

2. Click on the Connect button to connect to the data source and to display the tables
and their field definition. E.g.:

185
5 Data Input Modules

3. Specify the parameters (Alias, Sort, Visible, Criterion) for the SQL command.

4. Click on the Create Command button. E.g.:

Due to the setting Yes in the Visible column, only Name (Alias CustomerName) and
Surname (Alias CustomerSurname) are selected from Sheet1 by the SQL command.

The SQL command will sort the data retrieved from List1 alphabetically by Surname,
due to the setting Ascending in the corresponding Sort column.

5. Click on the Execute Command for TEST button for a preview of the result of the
SQL command (in the above case a list of names and surnames sorted in an ascending
order by Surname). E.g.:

6. Enter a name for the data in the Definition name edit-box.

5.7.2 How to Define Variable Substitutions

For this example, the following ODBC connection string is used (a native Oracle connection
string could also be used):

186
 5.7 ODBC Data Input Module

DBQ={1};DefaultDir=U:m.morc!!WP;Driver={Driver do Microsoft Access (*.mdb)};

DriverId=25;FIL=MS Access;FILEDSN={1}.dsn;MaxBufferSize=2048;MaxScanRows=8;
PageTimeout=5;SafeTransactions=0;Threads=3;UID=admin;UserCommitSync=Yes;

In the string there is the variable string {1} which is supposed to identify a location for the
database. After that a default location has been entered U:m.morc!!WP for cases where the
variable does not return a value.

Then, in the substitution table you could identify a variable that will return an alternative location
for the database:

1. Create a variable of string data-type in the Param Input module that describes the dir-
ectory, e.g.:

In this example screenshot, we have set Parameter2 will return a location on the C:
drive.

2. Return to the ODBC Data Input module and click on Substitution Table to open the
ODBC Substitution Table dialog.

3. In the Find Variable column enter {1} as the variable that should be replaced.

4. Click on the 3 Dots icon to open the Insert Param Variable dialog.

5. Select the Param Input module (e.g. ParamInput1) in the Module combo-box and the
variable name (e.g. Parameter2) in the Parameter combo-box.

6. Click on OK to close the Insert Param Variable dialog.

7. In the Default Value in Design column enter the path to a database which can be
used, e.g.:

187
5 Data Input Modules

5.8 Param Input Module

See also:
How to Create an Image Page Counter
How to Use File Content as a Variable
ParamInput Module Command Line
Parameters

Param Input creates fields that are propagated to Production as workflow parameters, with a
default value that can be changed immediately before the workflow is processed. It can be
used, for example, to change the resources used by a workflow without editing the workflow
itself.

The values of the resulting workflow parameters can be altered as part of a job configuration:

Using the Edit Workflow Parameters option from the Sheet Proof or Data Proof
window menus.

In the Workflow Parameters window-pane in Production.

By setting the value with a command line when using the console version.

Example Param input can be placed before the Inspire Native module, so that the files
that the workflow will process can be changed once the workflow is loaded to Production:

1. Create a new field of Param Type: File with a Default value which describes the
path to a native file.

2. Attach the Inspire Native module after this module and set Files as Run from input
data.

3. Once the workflow is complete and loaded to production, change the native file
in the Workflow Parameters window-pane.

188
 5.8 Param Input Module

Options Description

Name Sets the name of the array which will contain the parameters, as it will be shown in
the Layout Tree.

Field Name Sets the name of the field, as it will be shown in the Layout Tree.

Param Label Sets the name of the workflow parameter as it will be shown in Proof or Pro-
duction.

Example In the Workflow Parameters window-pane that can be opened in the

Main Production window the Param Label appears in the Parameter column:

Param Type Defines the data-type: String, Bool, Double, Int, File, Label and With unit or
Directory.

Out of these options, the following are specific applications for the string or double data-
type:

File Sets a path to an individual file in string data-type. A 3 Dots icon appears
for this type (also in the Workflow Parameters window-pane) which aids the locating
of a file.

Label Adds a string for description only. Any value entered in the Default column
cannot be changed in Proof or Production.

The intention of this parameter is simply to pass on some extra description of the
workflow so that it is visible in Proof or Production when that workflow is loaded.

With unit Sets dimensions in double data-type. The value is combined with
measurement units (mm by default) which can be changed both here in this
module and Workflow Parameters window-pane.

Directory Sets a path to a directory in string data-type. A 3 Dots icon appears

for this type (also in the Workflow Parameters window-pane) which aids the locating
of a directory.

Command Line The parameter name used in the command line when you start the console
version. This name has to be followed by the name of the Param Input module, without
a space, e.g. -dirparaminput1 C:\Documents and Settings or -linewidth
paraminput1 0.3mm.

Default Sets the default field value. For the File and Directory Param Types you can use the
3 Dots icon to specify the path.

189
5 Data Input Modules

Create New Adds a field to the list.

Delete Removes a field from the list.

Copy Copies the selected field to the clipboard in a format that is adjusted to scripting
needs, e.g. WorkFlow.Parameter["ParamInput1","NewCommandLine0"]. This is useful
for inserting parameter into a script.

Move Up / Move Down Moves the selected field up or down in the list.

5.9 Data Center Input Module

See also:
Inspire Data Center

The Data Center Input module reads data from Inspire Data Centers.

Data Centers are managed by the related application Inspire Content Manager and you must
be logged in to Inspire Content Manager to be able to use the data from any data center that
has been created there. In addition, you must add the Data Center Config module to the
workflow and create some data center configs before you can use this module.

190
 5.9 Data Center Input Module

Options Description

Data Center config Selects which data center config will be read into the workflow.

The combo-box lists all configs that have been set-up in the Data Center Config module.
Click on the Data Definition icon to read the data structure from that set so that it is
shown here in the module.

Data from Data Center Lists the fields that are part of the record definition.

The fields can be edited using the icons at the bottom of the module:

Create New Creates a new field of the selected data-type.

This is particularly useful when content is stored in a data center as binary data-type.
See the Type description below.

Import Imports a previously saved structure for a data set from an RD file, e.g.
structure.rd.

Export Saves the current definition of the data set's structure to a separate RD file,
e.g. structure.rd

Show Menu Shows the context menu for the selected field.

Move Up / Move Down Move the selected data field up / down the data structure.

Changing the order of fields has no effect on data processing, it is just for presentation
purposes.

Delete Deletes the selected data field.

Type Determines the data-type of the corresponding fields.

The data-type can be altered by selecting one of the other standard types from the combo-
box. It is also possible to select Content if there is a specific binary definition of data in
the selected Data Center config.

Content is a binary description of fields and their content that is specifically for data centers,
so that all data (except Id) can be in one field and save memory. For writing to a data
center config (data set, not a split) via a Data Output module or Data Center Output
module, you can create a field (that must be named Content) which has binary data-type.
The intention is that this field contains the values of a record for many fields, it could
contain some or all fields on the same level and any dependent fields.

In a workflow, it is possible to create or modify such a field using script.

191
5 Data Input Modules

Example The script in this screenshot of the Imposition Script module illustrates
how a Content field can be created to contain two fields (Age and Height):

Notice how the data after this module (see Data output table) will have just two
fields Content and Id. An Id field must always be in data set.

Subsequently, this field can be sent to a data center config (data set, not a split) via the
Data Output module or Data Center Output module.

Then, here in the Data Center Input module, you can create a field by clicking on Create
New icon and select Content as its Type. The field can now be given any name but it
will read the binary code from the data center when the workflow is processed:

Example

1. After the previous example Content and Id were sent to data set GrowthRate.

2. Another workflow is configured with the Data Center Config module, where
GrowthRate is selected in the Data Set column and Config has the name
GrowthRate.

3. The Data Center Input module is added to the workflow and GrowthRate is
selected for Data Center config.

4. Create New icon is clicked on to create a field names AgeHeight.

5. Content is selected in the Type column:

192
 5.10 SAP Data Input

The Debug Data window-pane would show that the actual data-type of AgeHeight
is binary.

Also notice how the Id field exists, but is not visible in the Data Center Input module.

Alternatively, if a data set containing the binary is selected here (in the Data Center Input
module) for Data Center config. Clicking on the Data Definition icon, automatically
reads the fields from the binary format as if they were in their original state:

Example Alternatively to steps 4 and 5 in the previous example, the Data Defini-
tion icon is clicked on:

Notice how the two fields Age and Height are in their original structure even though
in the data set they only exist as one binary field called Content.

5.10 SAP Data Input

See also:
SAP Data Input Module Command Line
Parameters

The SAP Data Input module reads Raw Data Interface (RDI) and Intermediate Document (IDO,
IDOC) files from SAP systems into the workflow. These files contain all R/3 forms data.

Note When the input file is loaded, the length of its header is checked. If it is not correct,
the file is not read. You can switch off this behavior in the PNetT.config file.

193
5 Data Input Modules

This module has the following tabs:

Input File

Data Structure

Data Mapping

5.10.1 Input File Tab

Options Description

Root array name Names the array that will contain the data from SAP once it has been read
into the workflow.

Input file Describes the full path and name to the IDO, IDOC or RDI file which contains the
data.

Use the Browse icon to navigate to the file location.

Read Definition Loads the data structure from the Input file into the workflow.

If selecting another file with a different structure to any previously loaded file then
the previous structure is replaced with the new one.

Read & Merge Definition Loads the data structure from the Input file into the
workflow and merges it with any previously loaded structure.

194
 5.10 SAP Data Input

Example

File Form1.ido has the data struc- File Form2.ido has the data struc-
ture: ture:

If Form1.ido and Form2.ido are merged using the Read & Merge Definition
icon , the resulting structure is:

Notice how those elements that have the same name are merged to become
the same field and those that have differing names are added to the structure.

Text encoding Selects a codec for the text characters in the Input file.

See a separate chapter Text Encoding for more details.

Use only first records in Proof If checked, limits the number of records that will be used
during proofing.

If you have large input files, selecting this option significantly decreases pre-processing
time.

Record count Determines the number of records to be proofed if the Use only first records
in Proof box has been checked.

195
5 Data Input Modules

Report missing array as Sets how any missing array in the input data structure will be indic-
ated in the Log window-pane of Proof or Production:

Error Reports an error message and terminates the proofing/production process.

Warn once Shows the warning message once for one field and leaves the process
running.

Warn everytime Shows the warning message each time the missing field occurs
and leaves the process running.

Ignore Does not display any message and leaves the process running.

Report missing field as Sets how any missing field in the output data structure will be in-
dicated in the Log window-pane of Proof or Production:

Error Reports an error message and terminates the proofing/production process.

Warn once Shows the warning message one time for one field and leaves the
process running.

Warn everytime Shows the warning message each time the missing field occurs
and leaves the process running.

Ignore Does not display any message and leaves the process running.

Trim spaces in data If checked, spaces in the input data are trimmed.

This removes all spaces in the beginning and at the end of the string, not those in between
its parts.

Add unknown fields If checked, the data fields without a label in the source file will be also
added to the data structure and will be automatically labeled:

_UnknownField_X, e.g. _UnknownField_O:

Header Displays the header details of the file.

After the input file has been specified, information about file version, client and other
details from the input file are listed here.

196
 5.10 SAP Data Input

5.10.2 Data Structure Tab

Options Description

Input Structure

Structure Lists the fields and arrays in the structure provided by the Input file.

Type Shows the data-type of the corresponding field or array.

Output Structure Edits the data structure that will be passed out of this module using the
following tools:

Read & Merge Definition Fills the output structure with all of the fields from the
Input structure.

If there is already a defined output data structure and a different Input file with dif-
ferent fields has been loaded to the module, this new structure will be merged with
existing one. See the example for Read & Merge Definition on the Input File tab
above.

Create New Inserts a new array to the already defined data structure.

Select the required element from the structure in the Input structure and click on
the icon or drag and drop.

Unindent Moves the element one level up.

Indent Makes the element dependent on the element that is right above in the list.

Move Up / Move Down Move the element one position up/down on the same
level.

Delete Removes the selected element.

Load Definition Loads a previously saved data structure from an SDE file.

Save Definition Saves the edited data structure in XML format to a new SDE file.

Optionality Determines the data-type of fields, relating to whether they must be present
in the input data:

Array Sets that the field is actually an array that organizes sets of dependent
fields.

197
5 Data Input Modules

Arrays can be then used in the Records by option.

Optional Sets that the field can either contain a value or not.

MustExist Sets that the field must contain a value.

This should be set according to the expected content of the fields in the input data.

Example

1. A workflow is processed and an Array is recognized in the data for which

the option Optional or MustExist is selected.

2. The following error is displayed in the Log window-pane, indicating the

line number in the original source file.

Maintain child order If checked, the order of the incoming data fields must match the
created structure otherwise an error message will be displayed in the Proof or Produc-
tion.

Example This is useful when an array or field is preset in the target structure
several times.

If this is not checked (default setting), the order of the incoming fields is not
important, but you are not able to use the same element/field in the Output
structure more than once.

5.10.3 Data Mapping Tab

In case you have more input data files, where fields or arrays with the same type of data have
different names, you can map them on this tab. These data are then merged when the workflow
is processed.

Click on the Create New icon to add a pair of fields or arrays. In the Name column, type
the name of the field or array as it comes from the input data. In the Map to column, type
the name of the field or array, with which you want to merge the data.

To delete any pair, select it and click on the Delete icon.

198
 5.11 Script Data Input Module

5.11 Script Data Input Module

See also:
Scripting
Data Input Methods
XML Reader Methods

Script Data Input either uses a script to read data from a file into the workflow; or can be used
to script data inside the workflow.

You can:

Build a data structure of fields.

Read a data file via the Input file edit-box.

Script which data from the file should be read to which field.

Script additional fields.

Script the complete set of data.

Options Description

Input file Locates a data file to be read into the module.

Use the Browse icon to browse for a file.

Preview Displays a preview of the Input file.

199
5 Data Input Modules

Right-clicking in the preview area reveals a menu with the options Insert Size and Position
and Insert Selection:

Insert Size and Position Adds the size and position of any selected data from the Input
file into the Script.

Insert Selection Adds any selected data from the Input file into the Script.

If no specific data is selected, then the whole record that the mouse pointer is pointing
to is added.

Line /Column Refer to the number of line/column above which the

mouse pointer is hovering.

The numbers in brackets refer to a selection done by mouse dragging over the columns
the first number is offset, the second is size.

Text encoding Selects the codec to be used to read the characters in the data file.

See the separate chapter on Text Encoding.

Check unassigned If checked and the chosen Text encoding cannot encode characters
(particularly double-byte characters) to Unicode (when the workflow is processed), a
warning will be displayed in the Log window-pane.

Structure Lists the fields and shows their relationship to each other.

Any selected field can be inserted into the Script by right-clicking and choosing Insert in
script.

Create New Adds a new field to the structure.

Move Up / Move Down Adjust the field order in the structure.

Delete Deletes the selected field from the structure.

Tip Using this icon for the Root node will remove the whole structure.

Open Opens a previously saved structure from a WD file.

Save Saves the data structure to a WD file.

Tip Press <F2> to rename variables.

Type Selects the data-type of the fields in the Structure column: String, Int, Int64, Currency,
Double, DateTime, Bool, Binary, Subtree, Array or Optional.

Script Determines the script that will be used to define or read the data.

Open Script Editor Allows you to edit the script in a detached Script Editor dialog.

See the section Script Editor Dialog for details and explanation of the other icons in
the same line.

Notice how, in the following examples, the commit() Data Input method is used to return
the set of values to a repetition of an array.

200
 5.11 Script Data Input Module

Example Data Creation by Script

The following script reads the data for three records from the script to these fields
which have been created in the Structure table of this module:

Customers.Id="1";
Customers.FirstName="Jorg";
Customers.LastName="Schneider";
Customers.OfficeId=1;
Customers.commit(); // first customer record

Customers.Id="2";
Customers.FirstName="Marcin";
Customers.LastName="Grodka";
Customers.OfficeId=1;
Customers.commit(); // second customer record

Customers.Id="3";
Customers.FirstName="Simona";
Customers.LastName="Kazinski";
Customers.OfficeId=2;
Customers.commit(); // third customer record

Example Reading Lines from a File

The following script uses isEOF and readLine Data Input methods to read the
data from the Windows configuiration file win.ini to fields in the workflow, e.g. Input
file is C:\Windows\win.ini. These fields have been created in the Structure table of
this module:

while (not isEOF()) // while reading the file

{
String line = readLine();

if (line.beginWith(";") ) // if first character of

line is a semi-colon ignore
{
continue;
}

if (line.beginWith("[")) // if first character of

201
5 Data Input Modules

line is a semi-colon read the line to section name field

{
Sections.commit();
Sections.Name = line;
continue;
}

Sections.Keys.commit(); // reads the lines in the

above named section to the Keys array
Sections.Keys.Name = line.Part[0,"="];
Sections.Keys.Value = line.Part[1,"="];
}

Example Reading Elements from XML File

The following script uses XML Reader methods to read the data from an XML file
(which is not selected in the Input file edit-box) to these fields which have been
created in the Structure table of this module:

File.XMLReader xmlRead;
File.Stream xmlStream = File.open("Clients.xml", File.Mode.ReadOnly);
xmlRead.initInputStream(xmlStream,"UTF-8",true);
while (xmlRead.read())
{
if (xmlRead.NodeType==File.XMLNodeType.Element) // identi
fies an element
{
String element = xmlRead.Name; // reads
name of element
if (element=="CustNo")
{
Clients.CustomerNumber = xmlRead.readString();
} // if name
of element is "CustNo" returns value of element to CustomerNumber field
else if (element=="CustStmntNam1")
{
Clients.CustomerName = xmlRead.readString();
}
else if (element=="CustStmntZipCod")
{
Clients.CustomerZIP = xmlRead.readString();
}
else if (element=="PaymentMethod")
{
Clients.PaymentMethod = xmlRead.readString().toInt();
} // Payment
Method field is integer
else if (element=="AccAmt")
{
Double val=0;
if (xmlRead.readString().isNumeric(val))
Clients.Amount = val; // Amount

202
 5.12 XML Data Input Module

field is double
}
else if (element=="Clients")
{
Clients.commit(); // if name
of element is "Clients" then it is the array and so new record started
}
}
}

Example Random Values by Script

The following script uses the random Math method to write the data for one hundred
records with random double values to these fields which have been created in the
Structure table of this module:

for (Int i=0;i<100;i++)

{
Array0.Field0 = Int(Math.random()*1000); // random gives double
values 0-1, Int x 1000 gives random whole numbers 0-1000
Array0.Field1 = Int(Math.random()*1000);
Array0.Field2 = Int(Math.random()*1000);
Array0.commit();
}

5.12 XML Data Input Module

5.12.1 XML Data Input Module
In this section: See also:
Properties Tab XML Overview
Script Tab XML Data Input Module Command Line
Parameters

The XML Data Input module allows you to import data from an XML file or any other data file
whose content you can convert to XML format. This module also allows you to modify the data
structure either by using the features on the Properties tab or by scripting.

203
5 Data Input Modules

5.12.1.1 Properties Tab

The Properties tab allows you to select an XML data file and build or modify its structure by
creating new elements and sub-elements and changing their properties.

Options Description

Input file Specifies the location of the XML data input file.

The Browse icon aids locating and opening a file. Once an XML file is located a dialog
appears asking whether you want to generate and read an XML schema. Clicking on Yes
is the equivalent of clicking on the Generate and Read button (see below) in the XML
Schema part of this tab.

To block this dialog, enable the Do not show this dialog again before clicking on Yes
or No. To re-enable the dialog, delete the PNetT.cfg file (in the directory, where Inspire De-
signer is installed). Remember, that by deleting this file you will loose all other user settings
made in the application.

Text encoding Defines the text codec for the data input file. See the section Text Encoding
for details.

When the XML file is loaded, users do not need to specify the text codec for decoding the
document. It is possible to choose AutoDetect in the Text encoding combo-box.

Codec auto detection can also be used in scripting. See the section initInputStream.

Check unassigned If checked and the chosen Text encoding cannot encode characters
(particularly double-byte characters) to Unicode (when the workflow is processed), a
warning will be displayed in the Log window-pane.

204
 5.12 XML Data Input Module

DTD

Read This function reads the already existing DTD file describing the structure of the
XML file specified in the Input file field.

You can specify the document root and maximum recursive nesting properties in the
DTD parser dialog:

Document root Specifies the root element (or the base element). If the
XML file has more than one element, a drop-down menu lists all of them al-
lowing the user to select which element they consider the root element.

This might be useful when the XML file and the DTD file do not match exactly.
We may have a DTD file describing another XML ('parent' of our XML) that
has several elements but we use only one of them in our XML file.

Max recursive nesting Defines the number of possible recursive steps in

which the element can be nested. When set to 0, no recursion is done.

This is useful when the same elements are nested in each other, e.g. a table
that contains several other tables. It is then not clear from the DTD file how
many levels should be considered and the settings need to be made by the
user.

Example A sample DTD file where T stands for a table and R for a row:

Maximum recursive nesting set to 0:

205
5 Data Input Modules

Maximum recursive nesting set to 1:

Export Reads the structure defined in the structure window and saves the DTD file in
the specified location.

Generate and Read After clicking on this button, the parser will:

parse the XML file specified in the Input file field

generate a DTD file according to the XML content

load the DTD file content (the structure) into the structure window

Note This is the same DTD parser dialog as the one for the Read button.

Generate After clicking on this button, the parser will:

parse the XML file specified in the Input file field

generate a DTD file according to the XML content

save the resulting DTD file in the location specified in the Save As dialog

XML Schema XML Schema definition files (XSD) are an XML based alternative to DTDs, they
describe the structure of an XML document, written in XML itself.

Note Attribute substitutionGroup is not supported for XSD elements.

Read Reads an already existing XSD file describing the structure of the XML file specified
in the Input file field.

If the selected XSD file includes other XSD files, they are all automatically merged into
one XML schema. All XSD files have to be stored locally and in the same directory.

You can specify the document root and maximum recursive nesting properties in the
parser dialog.

Export Reads the structure defined in the structure window and saves it as a XSD file
in the specified location.

Generate and Read After clicking on this button, the parser will:

parse the XML file specified in the Input file field

generate an XSD file according to the XML content

load the XSD file content (the structure) into the structure window

206
 5.12 XML Data Input Module

Ignore types If checked, field conversions to the type defined in the XSD file (date time,
integer, etc.) are not performed.

Name Shows the name of the node that is used later in workflow processing for this node.

In some cases an element with the Name 'Virtual' (which is not a part of the XML file)
will be generated after using the Generate and Read button in the XML Schema area.
This happens when an XML file with an unclear structure is used, i.e. the data structure
does not correspond with the tree structure of data used in Inspire Designer.

Example When using an XML data file with the structure:

<A>
<B>first record</B>
<C>second record</C>
<B>third record</B>
</A>

an array with the name 'Virtual' will be created. Its Type will be set to One Of and
Optionality to Zero or more. This 'Virtual' array will contain 3 records, each contain-
ing the variables 'B' and 'C'. The variable 'B' will only have a value in the first and
third records, whereas the variable 'C' will only have a value in the second record.

Type Shows the type of the node and allows to change it into a different type.

Element

Attribute

PCData

One Of One of the enumerated elements one level below the current node is
used.

Sequence All of the enumerated elements one level below the current node (in
the defined order) are used.

Element + PCData A combination of these two types.

Optionality Defines if the element is required and repeatable. Values are set according to
the XML data input file they reflect its structure and occurrence of each element. The
options are:

One The value has to come from the input data and must be just one.

In Layout this item is String.

Example Customers last name there is just one and it must exist.

Zero or one Optional: can occur 0 or 1 time.

In Layout this item is Optional String.

207
5 Data Input Modules

Example Nickname of a person there can be one but it is not necessary

and its existence has no effect for further processing.

Zero or more Optional and repeatable: can occur zero or more times.

In Layout this item is Array.

Example Phone number it is optional, there can be none or one or more.

One or more Required and repeatable: must occur one or more times

In Layout this item is Array.

Example Phone number it is required (the field must not be empty); at

the same there can be more numbers.

If needed, the optionality can be changed here to better suit your needs. For example, in
your XML file there is only one phone number listed for all customers but you know that
there can be more, so you set the item to Zero or more.

Change Change can be of the type:

None No change is applied (the default value).

Ignore The node is ignored during further processing of the workflow.

Flatten When selected for an element, the element is skipped in further processing
and its sub-nodes are moved one level up. This simplifies the data structure.

Note For the Optionality Zero or more the option Flatten cannot be used.

Error Recover Creates a new Boolean variable, named Error Recovery. If an error
occurs during reading (e. g. element is missing), it returns true.

This is for use with the option Data error var. in the Data Layout Properties in the
Layout module. See also How to Use Error Recovery.

XML Name Shows the exact node name (the parsed name) as it appears in the XML file.

Field Converter Performs the selected filed conversion. The field conversions available are
the same as in the Data Transformer module. If the imported XML Schema contains
definitions of e.g. variable type or date format the appropriate conversion is automatically
set.

Creates new element Creates a new element in the current level (i.e. in the same level
where the node is selected).

In the XML new element dialog that appears you have to specify the Type and Optionality
parameters. Other parameters can be edited in the XML structure window later.

208
 5.12 XML Data Input Module

Creates new subelement Creates a new sub-element below the current level (i.e. below
the level where the node is selected).

Move up Move down Moves the selected item up or down accordingly. The arrows
become active when a movable node is selected. Moving is possible among nodes of the
same type and within one level.

Remove Removes selected element.

Not defined elements Defines the action taken in the situation when the parser identifies
an element not defined in the structure. The options are:

Ignore No action is taken when a not defined element is found.

Warn once Warns only once on the first occurrence of a not defined element.

Warn every time Warns every time a not defined element is found.

Error Reports an error when a not defined element is found.

Not defined attributes Defines the action taken in the situation when the parser identifies
an attribute not defined in the structure. The options are:

Ignore Takes no action when a not defined attribute is found.

Warn once Warns only once on the first occurrence of a not defined attribute.

Warn every time Warns every time a not defined attribute is found.

Error Reports an error when a not defined attribute is found.

Allow any order of elements If set to Yes it is not necessary to maintain the same order
of elements in the XML file as it is defined in the structure.

Ignore namespaces If set to Yes, namespaces are ignored.

Note Name space is an XML syntax that prevents name collisions in documents by
qualifying the name of an element or attribute with a namespace URI and prefix. The
prefix xmlns is associated with XML name spaces.

Force preserve spaces in all leaf elements If checked, all white characters (spaces, enters,
etc.) within all leaf elements (those elements that have no subelements) are preserved in
the data.

209
5 Data Input Modules

5.12.1.2 Script Tab

The Script tab is useful if you want to make changes to the data file structure or convert a non-
XML data file to the XML format.

Options Description

Create by script When checked, the module does not read the input file defined on the
Properties tab but runs the script entered to the edit field instead. Using the script you
can modify the structure of an existing XML data file or convert any file to the XML format.

Example We have a TXT file that contains the customers name, surname and
phone number. We want to have these data in an XML file with the following
structure:
<phoneList>
<person>
<name>Name</name>
<surname>Surname</surname>
<phone>PhoneNumber</phone>
</person>
</phoneList>

To achieve this result the following script is used:

File.TextStream ts = File.openText("c:\mytext
file.txt", File.Mode.ReadOnly, "UTF-8");
elementBegin("phoneList");
while(not ts.isEOF())
{
String line=ts.readLine(); //name,surname,phone
elementBegin("person");
String val=line.Part[0,','];

elementBegin("name");
unparsed(val);
elementEnd();

val=line.Part[1,','];

210
 5.12 XML Data Input Module

elementBegin("surname");
unparsed(val);
elementEnd();

val=line.Part[2,','];
elementBegin("phone");
unparsed(val);
elementEnd();

elementEnd(); //person
}
elementEnd(); //phoneLIst

Template Inserts a script template to the edit field. The template itself only reads the input
XML file and copies it to the output. You can adapt the script to get data modification
you need.

Example Your input data structure has the field names as attributes and the field
value is in an extra element:
<Field Id="2" name="document_code">
<value>"80"</value>
</Field>

However, you need to have the field name as the elements name and the value
should be the content of the element:
<document_code>80</document_code>

To get this result, the inserted script template needs to be modified in the following
way:
File.XMLReader reader;
File.XMLWriter w;
reader.initInputStream(getStream(), getCodec(), getIgnoreNamespaces());
while(reader.read())
{
is(reader.NodeType)
{
File.XMLNodeType.Element:
{
if(reader.Name=="Field")
{
elementBegin(reader.Attribute["name"]);
reader.read();
reader.read(); //value
unparsed(reader.Value);
reader.read(); // /value
reader.read(); // /Field
elementEnd();
}
else
{
elementBegin(reader.Name);
for(Int i=0; i<reader.AttributeCount; i++)
attribute(reader.AttributeName[i], reader.Attribute[i]);
}
}
File.XMLNodeType.EndElement:

211
5 Data Input Modules

elementEnd();

File.XMLNodeType.Text:
unparsed(reader.Value);

File.XMLNodeType.CDATA:
;
}
}

SAP XSF Inserts a template for reading SAP XSF files and converting them to XML format.
The template always needs to be modified.

View Result Generates and displays a preview of the XML document created by the script.

Save Result Generates a preview of the XML document created by the script and saves it in
the specified location.

5.12.2 XML Overview

XML documents are made up by the following building blocks:

Elements

Tags

Attributes

PCDATA

5.12.2.1 Elements
Elements are the main building blocks of both XML and HTML documents.

Elements can contain text, other elements, or be empty.

Example Examples of HTML elements are:

body

table

Examples of XML elements could be:

note

message

212
 5.12 XML Data Input Module

Examples of empty HTML elements are:

hr

br

img

5.12.2.2 Tags
Tags are used to markup elements.

Example Examples of markup elements:

A starting tag like:

<element_name> marks the beginning of an element

An ending tag like:

</element_name> marks the end of an element.

A body element:

<body>body text in between</body>.

A message element:

<message>some message in between</message>

5.12.2.3 Attributes
Attributes provide extra information about elements.

Attributes are placed inside the start tag of an element.

Attributes come in name/value pairs.

Example Example of the element img:

The following "img" element contains additional information about thesource file:

<img src="computer.gif" />

213
5 Data Input Modules

Explanation:

"img" - is the name of the element

"src" - is the name of the attribute

"computer.gif" - is the value of the attribute

"/" - Since the element itself is empty it is closed by "/".

5.12.2.4 PCDATA
PCDATA means parsed character data.

Think of character data as the text found between the start tag and the end tag of an XML
element.

PCDATA is text that will be parsed by a parser.

Tags inside the text will be treated as markup and entities will be expanded.

DTD
The purpose of a DTD is to define the legal building blocks of an XML document.

It defines the document structure with a list of legal elements.

A DTD can be declared inline in your XML document, or as an external reference.

For more information regarding XML/DTD grammar see http://www.w3.org/TR/REC-xml.

214
6 Data Processing Modules

6.1 Data Processing Modules Overview

6.2 1-Many Merger Module
6.3 1-1 Merger Module
6.4 AFP Index Module
6.5 Check21 Reader Module
6.6 Data Add Module
6.7 Data Cacher Module
6.8 Data Combiner Module
6.9 Data Concatenator Module
6.10 Data Field Renamer Module
6.11 Data Filter Module
6.12 Data Group By Module
6.13 Data Histogram Module
6.14 Data Pass Through Module
6.15 Data Precise Module
6.16 Data Remapper Module
6.17 Data Repeater Module
6.18 Data Sorter Module
6.19 Data Caser Module
6.20 Data Transformer Module
6.21 Data UnGroup Module
6.22 Email Gateway Data Module
6.23 MinMax Generator Module
6.24 PDF Data Module
6.25 PCL Data Module
6.26 Personalized URL Module
6.27 Record Filter Module
6.28 Data Center Merger Module
6.29 Social Data Connector Module
6.30 Text Replacer Module
6.31 Data Merging Modules Comparison
6 Data Processing Modules

6.1 Data Processing Modules

Overview
Data processing modules manipulate data that has been read into the workflow by data input
modules. Click on the respective link for details on each module.

1-1 Merger Merges two data files that have a one to one relationship.

Similar to the 1-Many Merger module (below), except that it appends all the fields of the
second data file rather than creating a sub-array.

See the section 1-1 Merger Module.

1-Many Merger Merges two data files that have a one to many relationship.

This combines two data sources. The merged output of the two input files is passed to
the next module in the workflow. You can even use more 1-Many Merger modules to
combine more data input sources.

See the section 1-Many Merger Module.

AFP Index Reads indexes from AFP files into a workflow.

See the section AFP Index module.

Check21 Reader Parses data containing information about bank checks saved in
COF images files.

See the section Check21 Reader Module.

Data Add Combines files sequentially but does not merge the data in the files.

See the section Data Add Module.

Data Cacher Shortens the processing time by saving data that is repeatedly used
to a unique location on the disk, this data is then reused as needed.

See the section Data Cacher Module.

216
 6.1 Data Processing Modules Overview

Data Center Merger Combines data in a workflow with data from Inspire Data Cen-
ters.

See the section Data Center Merger Module.

Data Combiner Combines the fields of two inputs into one set of records without
matching records like the 1-1 Merger.

See the section Data Combiner Module.

Data Concatenator Places contents of data sources together one directly after
the other.

See the section Data Concatenator Module.

Data Field Renamer Renames data fields.

See the section Data Field Renamer Module.

Data Filter Filters data from fields matching a given criteria.

See the section Data Filter Module.

Data Group By Groups data according to a selected data field.

See the section Data Group By Module.

Data Histogram Provides statistics about usage of selected fields.

See the section Data Histogram Module.

Data Pass Through Enables Inspire Interactive to use data input types as Form,
Data and XML DataRaw (defined in Inspire Interactive) also for Data Input module.

217
6 Data Processing Modules

See the section Data Pass Through Module.

Data Precise Transforms raw data into a grammatically correct, presentable form.
It can translate data to upper and lower case, add punctuation even add gender-appro-
priate titles of respect to names.

See the section Data Precise Module.

Data Sorter Sorts the sequence of records.

See the section Data Sorter Module.

Data Repeater Runs all modules connected before this module repeatedly, as
many times as it is needed.

See the section Data Repeater Module.

Data Transformer Performs various conversions of the input data.

See the section Data Transformer Module.

Data Ungroup Ungroups previously grouped data.

See the section Data Ungroup Module.

Email Gateway Data Reorganizes data to a form that is suitable for In-
spire Email Gateway.

See the section Email Gateway Data Module.

Min Max Generator Determines the minimum and maximum values of used
variables.

See the section Min Max Generator Module.

218
 6.1 Data Processing Modules Overview

PCL Data Reads information such as page side, duplex type, page size and tray
information from the PCL file and the values can be used further in the workflow.

See the section PCL Data Module.

PDF Data Reads the active contents table of a PDF file and creates a corresponding
array-type variable.

See the section PDF Data Module.

Personalized URL Creates personalized URLs for your records using the MindFire
web service.

See the section Personalized URL Module.

Record Filter Selects a sub-range of all the data according to the set records in-
dexes.

See the section Record Filter Module.

Social Data Connector Reads data from (and sends data to) Facebook or Twitter.

See the section Social Data Connector Module.

Text Replacer Replaces text from the source data before further processing. It is
usually used for smaller changes (for example, to ).

See the section Text Replacer Module.

219
6 Data Processing Modules

6.2 1-Many Merger Module

See also:
Data Merging Modules Comparison

The 1-Many Merger module merges two data sources that share at least one common field so
that the data subsequently has a one-to-many relationship.

This results in an array being made that is dependent upon the common field in input A. That
array contains all of the records from input B that return matching values with input A for the
common fields.

Example Structure of the data being read in through input A (top connector):

Structure of the data being read in through input B (bottom connector):

220
 6.3 1-1 Merger Module

Resulting structure of data:

All of the options on this module are described in the section 1-1 Merger Module.

6.3 1-1 Merger Module

See also:
Data Merging Modules Comparison

The 1-1 Merger module merges two data sources that share at least one common field so that
the data subsequently has a one-to-one relationship.

221
6 Data Processing Modules

Records from input A (upper) are combined with records from input B (lower) if the values of
a specified field match. For successful merging, the common field in both data inputs must
contain exactly the same values (but it may have a different field name).

Example One data file contains names of customers and their ZIP codes. Another data
file contains the same list of ZIP codes and their matching cities. Both of these are read
into the workflow by separate Data Input modules.

To merge the two sets of data, select the ZIP code field in the 1-1 Merger module. As a
result you receive one set of data containing customer name, ZIP code and the appropriate
city.

Options Description

Data from A / Data from B Shows the record structure of the data as it is being read into
the module, i.e. all of the fields that make up the records.

Select here which field is common to both sets of data.

Input A is the top input connection of the module. Input B is the bottom one.

Type Shows the data-type of each of the fields.

Allow unmatched from A If checked, determines that it is correct behavior if there are re-
cords from input A that are not matched to any record from input B.

The unmatched fields from A are then passed to further modules.

Example If there is a specific ZIP code missing in the Data Input B and this option
is checked, Inspire Designer will process the workflow without any problems, only
that the ZIP code from the Data Input A will not have any corresponding city assigned
in the merged file.

However, if this option was not checked, then processing would fail.

222
 6.3 1-1 Merger Module

Create unmatched output from B If checked, a second output connector appears on the
module and any records from input B that are not matched (to records from input A) will
be sent to that output.

One intention of this option is that the unmatched data can be passed to a data output
module in order to analyze the data to establish why it was unmatched. But it also could
be used, for example, to set alternative matching criteria in another merger module.

Memory usage Selects what data will be stored within Inspire Designer while it is processing
the workflow. The options are:

On disk The data will be read directly from the files and merged, record by record,
without using any application memory.

This is recommended if a very large data file is being read via input B and there
would be insufficient processing memory on the computer being used.

Indexed in memory Determines that an index of the data from input B will be
loaded to the application memory when the workflow is processed.

This provides faster processing providing that the data file being read through input
B is not very large. Although efficiency with larger files is better than that with Fully
in memory.

Fully in memory Determines that all of the data from input B will be loaded to
the application memory when the workflow is processed.

This provides the fastest, most efficient processing providing that the data file being
read through input B is not large.

Binary compare If checked, the values (strings) in the two common fields must exactly match,
by the Unicode values of the characters, in order to merge.

The result is the same as selecting Identical for the option Strength if Normalization
mode is unchecked, however this is a much faster method. The memory allocation of this
type of merging is just double the size of the chain of characters.

Locale Specifies the language that will be used for applying rules about matching the content
of the two common fields.

Strength Selects the level to which comparison of the two common fields should take place.
The options are:

Primary Only considers the differences between all base characters, e.g. matches
alphabet characters.

This is the fastest matching method and the memory allocation is about the same
as for Binary compare.

Secondary Diacritics are also considered.

Other differences may also be considered, depending on the locale used. The
memory allocation is about three times the size of the chain of characters.

Tertiary Upper and lower-case differences are also considered. The memory alloc-
ation is about four times the size of the chain of characters.

223
6 Data Processing Modules

Quaternary Punctuation differences are also considered. The memory allocation

is about five times the size of the chain of characters.

Identical Unicode code point values of the NFD form of each string are also con-
sidered.

Code point value differences between two strings are rare, but are found in some
languages, e.g. Hebrew.

This is the slowest matching method. The memory allocation is about six times the
size of the chain of characters.

French collation Matches the French preferred ordering of characters with diacritics.

Case level Casing of characters in the common fields is considered for matching.

This is an alternative to selecting Tertiary for Strength, that could be used if Primary is
selected there and no consideration for diacritics is needed.

Can also be used for Japanese in order to recognize the difference between small and
large Kana.

Normalization mode If checked, differences in Unicode strings are standardized.

Standard characters will be recognized if they are described slightly differently in the Uni-
code.

Example The two described characters ' and e when they appear together as 'e
will be recognized and matched with .

6.4 AFP Index Module

See also:
How to Use the AFP Index Module

224
 6.4 AFP Index Module

The AFP Index module can read the TLE (Tag Logical Element) index, NOP (No Operation Per-
formed) comments and Medium Maps from an AFP file and use them to create an array in the
data so that their values can be used in the Layout design.

Example If the field that contains the AFP file name is called AFPfile (as in the screenshot
at the start of this section), then a new array will be created as shown here:

The above screenshot shows a view of the data structure immediately after the AFP Index
module. You can see that the following arrays were created:

AFPfileIndex named according to the value AFPfileIndex in the Generated array

edit-box

AFPfileOther named according to the value AFPfileOther in the Generated node

edit-box

225
6 Data Processing Modules

An example of use for this module can be found in the section How to Use the AFP Index
Module.

Options Description

Input Data

Structure Displays the current structure of the data received into the module.

Selecting a field here determines that it is the field that contains the AFP file name
from which the index should be read.

The above screenshot shows just one possible selection of field (AFPfile) but there
may be many to choose from depending on the data input. You can only select one
field at a time.

Type Displays the current data-type of each of the listed fields.

Only fields of string or binary data-type can be selected.

Example The Param Input module can be used to create a field of string data-type
that identifies the path to an AFP file.

Then, that file name could be used in both this module and the Inspire Native module
in order to import both the AFP index and the AFP pages together.

Generated array Names the array that will be created in the data.

The field becomes editable, when a string or binary type variable is selected. A suggested
name based on the field location will appear by default.

The array generated from the AFP information is repeated by the pages of the AFP file
(i.e. one record = one page) and contains a set of fields that correspond to its structure.
Of these fields, two are always present on the first level:

Page Returns the page number from the AFP file.

PageGroupBegin Indicates whether the page is the first of any group defined in
the AFP file by returning a Boolean value.

Generated node Names the array that will contain all non-document NOP comments (those
that are outside the Document definition in an AFP file).

The array will contain:

the Data variable containing the content of the non-document NOPs,

the Document variable containing a number defining the position of the non-
document NOPs in relation to Document definitions:

0 the NOP comment is before the first Document definition,

1 the NOP comment is after the first Document definition,

226
 6.4 AFP Index Module

2 the NOP comment is after the second Document definition,

etc.

The following tabs determine what else should be read in to the workflow from the AFP file:

Index tab

Medium Maps tab

6.4.1 Index Tab

Options Description

TLEs The options here relate to any TLE index that can be read from an AFP file.

The Tagged Logical Element (TLE) index is a feature of the AFP file format that can also
be displayed in an AFP viewer, identifying and allowing navigation through its pages and
different groupings of those pages. It can be helpful to import this data for use in a
workflow. For example, if the pages of an AFP file are indexed by different account numbers
you could use those account numbers in a new layout design.

Examine TLEs If checked, TLEs that are in the AFP file structure will be read into the
workflow to appear in the data structure.

Overwrite encoding of TLEs with If checked, the original encoding of the TLE index
will be decoded with the codec selected in the Encoding combo-box. If left unchecked,
the original encoding (which is defined in the AFP file) will be used.

See the separate section Text Encoding for a description of the Encoding combo-
box.

227
6 Data Processing Modules

A new dependent array is generated from the TLEs and contains two fields:

TLE / AttributeName Returns the title of any indexing attribute for the AFP page,
e.g. Client Surname.

TLE / AttributeValue Returns the index value for the AFP page, e.g. Smith.

NOPs The options here relate to NOP comments that can also be read from an AFP file.

Examine NOPs If checked, NOP comments that are in the AFP file structure (and relate
to a particular page) will also be read into the workflow to appear in the data structure.

A NOP comment is regarded as being related to a page if it is immediately before or

within the page definition.

Further select the correct encoding for the NOPs (that one which was used originally
for the comments) in the Encoding combo-box. See the separate section Text Encod-
ing for a description of the Encoding combo-box.

A new dependant array is generated from the NOPs containing the field NOP / Data
which returns any NOP comment added to AFP pages.

Note Because NOPs are often encoded in differing ways (their values can be text or
data), not all values have to be readable.

6.4.2 Medium Maps Tab

Medium Maps are AFP data that describe how the pages are arranged in an AFP file.

Options Description

Show Medium Map name If checked, reads the Medium Map name of each page into the
workflow to create a corresponding data field.

A separate Boolean field MediumMapBegin is also created which returns true (1) if the
invoke command of the Medium Map is read on a particular page. If the invoke command
is present it indicates that the Medium Map is different from the previous page.

Alternate Medium Map name If checked, appends the MediumMapBegin value to the
Medium Map name, therefore creating only one field as opposed to the two fields that
are created when only Show Medium Map name is checked.

228
 6.5 Check21 Reader Module

Enable Medium Map info Enables the options described below.

Medium Map Info

Duplex / N-Up / Output Tray / Medium Source / Finishing If checked, the corres-
ponding types of Medium Map info will be read into the workflow to create data
fields in the generated array.

Exceptions are: Output Tray corresponds to MediaDestination and Medium Source

corresponds to MediaSource.

6.5 Check21 Reader Module

The Check21 Reader module is used for parsing data containing information about bank checks
(scanned images and other data) saved in Common Output Format (COF) images files. See the
Federal Reserve website for detailed specification of this file format.

In the module's GUI, select from your input data a variable that contains the path to the COF
image file (a string variable) or a binary variable containing a COF file.

Options Description

Generated array Names the array that will contain variables extracted from the image file.
The field becomes editable, when a string or binary type variable is selected. Automatically,
a name composed of the input variable's names appended with the string "Image" is
suggested.

The module extracts data from the file, recognizes and creates the following variables:

ItemData Contains the database information for the database row corresponding to
a given record.

Image Contains the image itself in binary format.

229
6 Data Processing Modules

ViewSide Indicates the front or back face of the item (bank check). The possible values
are Front and Back.

ViewType Indicates the type of the image format. The possible values are IOCAGray,
IOCABinary, TIFFJPEG, TIFFG4. Other image types are not supported.

These variables are available in the workflow after this module.

6.6 Data Add Module

See also:
Data Merging Modules Comparison

The Data Add module combines two or more data files. It differs from 1-Many Merger inasmuch
that the added data is not merged with the other data. Data are just placed one under the
other: there is no connection between the sets of data.

This module can also be used when you need to connect a Param Input in the workflow.

Options Description

Input count Sets the the number of connectable data inputs. The maximum count is 100.

6.7 Data Cacher Module

The Data Cacher module shortens processing time by saving data that are repeatedly used to
a unique (TSD) file so they can be reused as needed.

230
 6.7 Data Cacher Module

You can create a cache for Proof or for Production. To do this:

1. Place the Data Cacher module in the Workflow and double-click on the module's icon
to display the Data Cacher panel.

2. Right-click on the Default cache field to display the context menu.

3. (optional) Select Add Cache if you want to specify the name and location of a previously
created TSD file. The path can be edited after pressing the <F2> key.

Note A TSD file is always created when output is generated. If you place a Data
Output module within the workflow (after Data Input, Data Transformers, etc.), that
TSD file can be added to the Data Cacher module.

4. Select Cache for Proof or Cache for Production from the context menu.

The default cache is stored in the Cache subdirectory in Inspire Designer folder.

Hover the mouse pointer over a cache's name to display its location in a tool-tip.

Options Description

Creates a new cache.

Removes a cache.

Clears a cache.

Marks cache for Proof.

Marks cache for Production.

The three question marks in the Size column are replaced by the cache size value (in kB) after
the job is run, and the TSD file is created.

231
6 Data Processing Modules

Note If you make changes in the workflow before the Data Cacher module, you will need
to clear the cache and create it again.

6.8 Data Combiner Module

See also:
Data Merging Modules Comparison

Data Combiner combines the fields of two inputs into the same array without matching records,
i.e. the first record from input A (top connector) will be combined with the first record from
input B (bottom connector) and the second with second etc.

The intentions is to combine sets of data with the same number of records when it is known
that both sets are in the desired order. If the number of records differs, the resulting number
of records is that of the input with the highest number of records, i.e. no records are lost. The
fields from the input with less records are left empty for the remaining combined records.

If there are fields that have the same name in both inputs they will be merged into one field
of that name. In that one field, the values in the field from input B will overwrite the values
from input A, unless there are less records in input B in which case the values for the first records
of input B will be used and the last records will have values from input A. If you know that it
is OK to overwrite a field from A because the values are the same in both inputs, you should
also make sure that the records are in the same order, e.g. sort the fields using the Data Sorter
module. If you don't want fields of the same name to be merged and overwritten, use the
Data Field Renamer module first to rename them.

Example If input A has 12 records with the following fields:

And input B has 5 records, with the following fields:

232
 6.9 Data Concatenator Module

The resulting data will have 12 records, with the following fields:

Notice how the field Id was in both inputs, but in the output there is only one Id field.
The values in this field have not been matched (in the way they can be with the 1-1
Merger module), the first 5 records will contain values from input B and the remaining 7
records will contain values from input A.

6.9 Data Concatenator Module

See also:
Data Merging Modules Comparison

Data Concatenator places contents of input data sources together one directly after the other.
Data may come from different input modules or from the same one. The output is passed to
the next module in the workflow.

This module is typically used when we have the input data split in more files that have the same
structure. Data Concatenator then joins the contents of the fields with the same name.

233
6 Data Processing Modules

Example The sample input data 1 contain these four records.

Input data file 2 has got the same structure but contains other records. We would like to
join the content of these two input files together.

In Data Concatenator the files get displayed in the following way.

We only need to select what records should be concatenated (see the blue, resp. gray
selection).

The outcome in the Layout is following:

The array is named Records1 and its fields contain all data from both Input modules.

234
 6.10 Data Field Renamer Module

6.10 Data Field Renamer Module

The Data Field Renamer module is used for renaming data fields. The module has two panels
the left hand panel displays the input data structure. In the right hand panel you can rename
data fields, which are then colored in blue. New names will be used in the workflow after this
module.

Options Description

Auto configure If duplicate data field names occur, they are highlighted in red color in
the right hand panel of the Data Field Renamer module. Using this function you can rename
the duplicate names automatically (i.e. the underscore character and a sequence number
is added to the field name, e.g. Field_0).

6.11 Data Filter Module

235
6 Data Processing Modules

The Data Filter module passes (or keeps from passing) data matching criteria you specify in the
module's properties dialog. This provides the capability to select only the input data you want
to process.

To filter data, do the following:

1. Highlight the field in the structure that will be used to select the data.

2. From the Condition drop-down box on the right, select one of the following options
(the availability of options depends on the data type):

None No condition is set.

Equal to The condition is met, if the captured text is identical with the text entered
in the Value edit-field.

Contains The condition is met, if the captured text contains the character (or
characters) entered in the Value edit-field.

Begins with The condition is met, if the first character (or characters) of the
captured text is identical with that entered in the Value edit-field.

Smaller than The condition is met, if the captured number is smaller than the
value set in the Value edit-field.

Bigger than The condition is met, if the captured number is larger than the value
set in the Value edit-field.

3. Enter the value by which you want to filter the data. For Equal to, Contains and Begins
with conditions, you can enable Allow multiple values check-box. You can enter
texts, numbers or ranges of numbers separated by commas then.

4. Indicate whether you want to invert the condition. (An inverted condition passes
everything but the value you enter.)

5. Repeat steps 1 to 4 if you have additional fields you wish to filter.

Enabling the Create else output check-box adds the second output link to the module. This
output link allows the data that do not fulfill the defined condition(s) to pass through and be
used without employing another data filter.

In a large data structure use the Find Previous / Find Next icons to quickly locate fields
for which a filtering condition is set.

Note If selecting records from large databases, it is recommended that you use a combination
of Data Filter and Data Cacher.

236
 6.12 Data Group By Module

6.12 Data Group By Module

The Data Group By module enables you to make groups of data according to the content of
a specific field. It splits the data into groups using a new array which returns one set of records
for each value that exists in that selected field, allowing you to manipulate the data and corres-
ponding design according to those values.

Example If data has the fields Name (name of a person) and Town (town or city in
which the person lives) then you could group the data by the Town field so that all people
from the same town are returned in the same set of records.

You could then count how many people are in each town (using the Count variable which
appears for each array) and repeat the pages of the design according to the town (using
the Repeated by combo-box on the General tab of the Pages family layout properties).

Additionally, you can sort and copy fields one level upwards in the data structure which are
manipulations that are also commonly required when grouping data.

Options Description

Data Section The tree here shows the structure of the data as it is being read into the
module. Selecting a field from the tree and clicking on the Create New icon adds it

237
6 Data Processing Modules

to the Group Fields area on the right of the module, which means that the field has been
selected as one that will be manipulated according to the parameters of this module.

You can only select fields that belong to the same level of the same array and each field
can only be selected once.

Group Fields Section The options here determine how the data being read by the module
will be handled and how the selected fields will be manipulated. Many of them relate
directly to the sorting of records and a description can be found in the Data Sorter Module
chapter.

Rename parent array to Renames the original array (the direct parent to the selected
fields before they were read into this module), if required.

By default the suggested name entered here is taken from the first field that was se-
lected in this module.

Grouped array name Names the child array that will be created as a result of the
grouping.

By default the suggested name entered here is taken from the original array.

Field Name Lists all fields from which the values will be manipulated.

Sort Type Selects whether a sort is required for the corresponding field. Options are:

Ascending Sorts from A to Z, 1-9 etc.

Descending Sorts from Z to A, 9-1 etc.

None No sorting will occur.

For most cases, sorting is required when grouping will occur, i.e. when a field also
has Yes selected for Group By. This is done to make sure that all similar values are
together in consecutive records before the records are divided into groups.

Example You have records for many people and 6 of them have the surname
Smith. You then want to group the records by the surname, but if you do not
sort the data it is quite likely you will receive 6 separate groups of Smith (each
with only one person) because there is no guarantee that the Smiths were in
consecutive records.

Group By Selects whether the field will be grouping the records together.

It is not necessary to use multiple fields selected in this module for grouping the data,
other fields can be used for simply sorting and copying up a level. The intention is to
allow for secondary manipulations to be performed according to other fields within
the group, e.g. some records are grouped by a clients surname and are also sorted
by the first name to put them in alphabetical order within the group.

Move Level Up Selects whether the field will be moved up to the same level as the
grouped array.

Moving up allows you to read the field in a different context, e.g. use the field for
calculations that could not be performed while the field was at the lower level inside
the array.

238
 6.13 Data Histogram Module

Delete Removes the selected field from the list.

Move Up / Move Down Moves the selected field up or down in the list and
therefore in order of importance, e.g. for sorting the field nearest the top of the list
will be the primary sorting field.

6.13 Data Histogram Module

The Data Histogram module counts the occurrence of values in selected fields.

When the workflow is processed, the values of the selected fields are compared and all
matching values are counted. The count value is returned by a count field that exists in a new
array. This field can then be used as a variable in the Layout design or simply as a data output
to provide statistics about which records have been processed.

Example From the records of many clients, you will produce letters to send to their
addresses. Here you can create fields that will return values for how many letters were
produced for each address.

Below is the resulting data structure of selecting the Address field in the Data Histogram
module.

The highlighted fields in the data structure are the matched Address fields. It can be seen
that a new Address array has been created based on the originally selected field. Inside
that array there are fields which return the value of each matched address and the count
for that address.

239
6 Data Processing Modules

Options Description
The options on this module that are not described in this section are described in the section
1-1 Merger Module.

Field Name Shows the current structure of the data, i.e. which fields are a part of each record.

The selected histogram fields will be highlighted here with an arrow.

Field Type Shows the data-type of each field.

Array name Names the array that will be created.

Create New Determines that the field that is selected in the data structure will be repres-
ented in the new array.

The first field you select will be marked with zero in brackets (0) and will be nested at the
lowest level of the array and be the one that is counted. You can add other fields to be
matched and they will serve as parent fields in the data structure.

It is advised to select the field with the least common values first and, it follows, select the
field with the most common values as the last of the histogram fields. If not, then the
total count for one of the values being counted could be split between two or more parent
values.

Delete Deselects any selected histogram field.

240
 6.14 Data Pass Through Module

Example Wanting to count letters that go to the same address, you decide that you
would like to know how many went to the same town and actually went to the same
area in that town, i.e. have the same ZIP code?

Because it is less likely that addresses will have the same ZIP code than the same town
(many people could live in the same town but less people have the same ZIP code) you
would choose ZIP code first in Data Histogram module, e.g.:

The resulting data structure being passed out of the module would look like this:

In the resulting data structure, the count for each unique ZIP code is returned with the
value of that unique ZIP code. These ZIP code counts are then grouped together by the
town that the ZIP codes belong to.

6.14 Data Pass Through Module

See also:
Data Pass Through Module Command
Line Parameters

This module enables Inspire Interactive (a web-based application for template and content
definition, document composition and generation) to also use data input types as Form, Data

241
6 Data Processing Modules

and XML DataRaw (defined in Inspire Interactive) with input from the Data Input module. Pre-
viously, these data input types could be only used with the XML Data Input module. For more
information see the Inspire Interactive User Manual.

The module is connected in the workflow after a data input module and does not open to offer
a user interface. You make the setting by specifying the XML Location parameter in the
Workflow Parameters window-pane of the Production window, which selects a XML data input
file. The data structure of the file has to be the same as in the connected input module. If no
file is specified, the module simply passes through data from the connected data input module.

6.15 Data Precise Module

DataPrecise can transform your raw data into a grammatically correct, presentable form. For
example, it can translate data to upper and lower case, add punctuation - and it can even add
gender-appropriate titles with respect to names.

Note

This module is not supported by the Mac version of Inspire Designer.

This module can be used for English texts only. Data with characters outside of the
Latin1 charset may be damaged if it is processed by this module.

The initial line of data that is fed into the Data Precise module appears in the upper left area.
Enhanced fields defined in the Data Precise module appear in the lower left area. The output
is then sent to the module connected to the right of the Data Precise module.

242
 6.15 Data Precise Module

To add a new enhanced field:

1. Click on the Create New icon. The new enhanced field will show in the lower-left
area.

2. Highlight the new enhanced field and begin typing to rename it. Select the field type
in the Enhance combo-box on the Properties tab.

3. Select the appropriate values, for each listed property, that are suitable for the use of
the new enhanced field.

4. Select the source field, in the upper-left area, which is to be the linked source for the
enhanced field you have just created in the lower-left area. Click on the Link Field
icon to link the two variables.

To delete an enhanced field select it in the lower-left area and click on the Delete icon.

To change the enhanced field properties select the field type in the Enhance combo-box on
the Properties tab and select the values for each listed property as appropriate for the use of
the new enhanced field.

To change enhanced field link select the enhanced field for which the field link is to be changed.
Select the new source field you want to link with the enhanced field and click on the Link
Field icon.

The module has the following tabs:

Properties

Script

Metric Shortening

Knowledge Files

6.15.1 Properties Tab

243
6 Data Processing Modules

The Properties tab enables you to select the field type and to define its enhancement options.

Options Description

Enhance Selects the type of the field. Based on the variable type, different enhancement
options are available. The options are:

Name

Street

City

JobTitle

PhoneNumber

Date

Auto

Option Lists the available enhancement options for the field type selected in the Enhance
combo-box.

Value Enables you to choose from the values available for the selected enhancement option.

6.15.1.1 Name Properties

Select this type, if the variable contains the name of an individual, the name of a business or
any single component of an individuals name.

CasingFlag

None No casing changes will be made.

Upper All characters will be changed to uppercase.

Lower All characters will be changed to lowercase.

UpperLower Characters will be changed to uppercase and lowercase as appropri-

ate, based upon algorithms and the Knowledge Base.

PunctuationFlag

None No punctuation changes will be made.

AddPunctuation Punctuation will be added based upon the rules of grammar

and the Knowledge Base.

RemPunctuation All punctuation characters (. and ,) will be removed.

244
 6.15 Data Precise Module

DiacriticFlag

None No diacritic (accent marks) changes will be made.

AddDiacritics Diacritics will be added to the words for which there is a matching
Knowledge Base entry and removed from words for which there is none.

RemDiacritics Diacritics will be removed from all words (the letter portion of the
character will remain).

FormatFlag

None No special formatting will be performed.

MatchKey The variable will be formatted for use as a matchkey.

Plural The plural form of name (last name, first name) will be formatted (Smiths,
Joneses).

Plural First Name The plural form of the first name will be formatted (Johns).

Plural Last Name The plural form of the last name will be formatted (Smiths).

Possessive The possessive form of name (last name, first name) will be used
(Smiths, Jones).

Possessive First Name The possessive form of the first name will be formatted
(Johns).

Possessive Last Name The possessive form of the last name will be formatted
(Smiths).

Formal The formal form of a salutation will be used (Mr Smith, Ms Jones, Pat
Smith, IBM Corporation).

Informal The informal form of a salutation will be used when a nickname is spe-
cified in the matching Knowledge Base entry. Otherwise the first name will be used
(Bill, Pat, Reginald).

Initials The initials form of a name will be formatted consisting of the first letter
of the first name, the first letter of the middle name and the first letter of the last
name.

TitleFlag

None No changes will be made to the title of respect.

AddTitle A title of respect, specified in the Knowledge Base, will be added to in-
dividual names when a title of respect does not already exist and gender can be
determined.

RemoveTitle Title of respect will be removed from the name.

245
6 Data Processing Modules

SpacesFlag

Remove None Leading and trailing spaces will remain unchanged.

Remove All Extraneous Leading and trailing spaces will be removed.

Remove Leading Only leading spaces will be removed.

ParseFlag

Parse The DataPrecise Parser will be used to identify all Name components con-
tained in the variable. This option should only be used for multi-component vari-
ables.

NoParse The variable will be considered as a single component variable.

NameType

NoType Name type is unknown.

Business The variable will contain only Business Names.

Individual The variable will contain only Individual Names.

BusinessAndIndividual The variable will contain both Business Names and Indi-
vidual Names.

OffensiveScreening Searches for offensive words contained in arguments. "Offensive"

means a word rated as Flippant, PG, R or X.

NoOffensiveScreening Offensive Screening will not be performed.

NoParse The argument will not be parsed in to its elementary components and
will be flagged as "Unparsed".

Parse An attempt will be made to parse the argument in to its elementary com-
ponents and will be flagged as "Parsed" or "Unparsed" based upon parsing result.

DeleteOffensiveWords Same as Parse except all words determined to be offensive

will be replaced with a string of asterisks (*).

DesiredComponent

All All name components will be presented.

TitleofRespect Only the Title of Respect component will be presented.

FirstName Only the First Name component will be presented.

MiddleName Only the Middle Name component will be presented.

LastName Only the Last Name component will be presented.

MaturitySuffix Only the Maturity Suffix component will be presented.

ProfessionalSuffix Only the Professional Suffix component will be presented.

246
 6.15 Data Precise Module

Country Code The variable will be processed using a Knowledge Base according to the se-
lected country.

Language Code The variable will be processed using a Knowledge Base according to the
selected language.

Input Component Sequence Indicates the order in which components are located within
the input variable. The default order is: 0 1 2 3 4 5 6 7 8 9, and can be overridden by an-
other setting entered after clicking on the 3 Dots icon. There must be as many digits
as there are components in the input variable and each digit can be used just once. The
valid sequences are: 012345 natural sequence, 312450 last name sequence. The
components codes are: 0 Title of Respect (Mr, MS, Dr, etc.), 1 First Name, 2 Middle
Name, 3 Last Name, 4 Maturity Suffix (Jr, Sr, etc.), 5 Professional Suffix (PhD, MD,
etc.).

Output Component Sequence Specifies the order in which components will be placed in
the output variable. The default order and components are the same as for the Input
Component Sequence option above.

Shortening Component Sequence Specifies the order in which components will be elimin-
ated when the data to be stored in a variable exceeds the capacity (length) of the variable.
The default order is: 5 0 2 4 1 3. For explanation of the components codes see the Input
Component Sequence option above.

6.15.1.2 Street Properties

Select this type, if the variable contains any type of a street address line.

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / ParseFlag / OffensiveScreen-

ing / Country Code / Language Code See Name Properties for these option descrip-
tions.

FormatFlag

None No special formatting will be performed.

MatchKey The variable will be formatted for use as a matchkey.

AbrevAddress USPS standard address abbreviations will be used to format the

street address.

DesiredComponent

All All street address components will be presented.

PrimaryAddressNumber Only the House Number component will be presented.

PreDirectional Only the Pre Directional component will be presented.

StreetPrefix Only the Street Prefix component will be presented.

StreetName Only the Street Name component will be presented.

StreetName Only the Street Suffix component will be presented.

PostDirectional Only the Post Directional component will be presented.

247
6 Data Processing Modules

SecondaryAddressIdentifier Only the Secondary Address component identifier

will be presented.

SecondaryAddressNumber Only the Secondary Address Number component will

be presented.

Urbanization Urbanization name component will be presented.

6.15.1.3 City Properties

The variable contains a city state zip address line or any single component of a city line (City,
State/Province, ZipCode/PostalCode, Country)

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / ParseFlag / OffensiveScreen-

ing / Country Code / Language Code See Name Properties for these option descrip-
tions.

FormatFlag

None No special formatting will be performed.

FullStateName State Code/Province Code will be expanded to full State

Name/Province Name.

DesiredComponent

All All city address components will be presented.

City (0) Only the City component will be presented.

State (1) Only the State Code/Province Code component will be presented.

Zip (2) Only the Zip Code/Postal Code component will be presented.

Country (3) Only the Country component will be presented.

Output Component Sequence Contains a series of four non-repeating digits (0, 1, 2, 3)

which indicate the order of city address components in the formatted output.

Shortening Component Sequence Contains a series of four non-repeating digits (0, 1, 2,

3) which indicate the order in which city address components will be eliminated to perform
intelligent shortening.

6.15.1.4 JobTitle Properties

Select this type, if the variable contains a job title or job description.

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / ParseFlag / OffensiveScreen-

ing / Country Code / Language Code See Name Properties for these option descrip-
tions.

DesiredComponent

All All components will be formatted.

248
 6.15 Data Precise Module

6.15.1.5 PhoneNumber Properties

Select this type, if the variable contains a telephone number.

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / ParseFlag / OffensiveScreen-

ing / Country Code / Language Code See Name Properties for these option descrip-
tions.

FormatFlag

MatchKey The variable will be formatted for use as a matchkey

PhoneParens Area code will be enclosed in parenthesis, e.g. (203)

PhoneDashes Area code will be enclosed in dashes, e.g. -202-

PhoneDots Area code will be enclosed in dots, e.g. .203.

DesiredComponent

All All components will be formatted.

PhoneCountryCode (0) Phone Country Code component will be presented.

PhoneAreaCode (1) Phone Area Code component will be presented.

PhonePrefix (2) Phone Prefix component will be presented.

PhoneNumber (3) Phone Number component will be presented.

Output Component Sequence Contains a series of four non-repeating digits (0, 1, 2, 3)

which indicate the order of phone number components in the formatted output.

Shortening Component Sequence Contains a series of four non-repeating digits (0, 1, 2,

3) which indicate the order in which phone number components will be eliminated to
perform intelligent shortening.

6.15.1.6 Date Properties

Select this type, if the variable contains a date (YYYYMMDD format).

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / ParseFlag / OffensiveScreen-

ing / Country Code / Language Code See Name Properties for these option descrip-
tions.

FormatFlag

None No special formatting will be performed.

MatchKey The variable will be formatted for use as a matchkey.

Various options to format the corresponding date data: e.g. MMDDYY will produce
041309.

249
6 Data Processing Modules

Desired Component

All All Date components will be presented.

Year (0) Date Year component will be presented.

Month (1) Date Month component will be presented.

Day (2) Date Day component will be presented.

Output Component Sequence Contains a series of three non-repeating digits (0, 1, 2)

which indicate the order of date components in the formatted output.

Shortening Component Sequence Contains a series of three non-repeating digits (0, 1,

2) which indicate the order in which date components will be eliminated to perform intel-
ligent shortening.

6.15.1.7 Auto Properties

The variable may contain Name, Street or City type data. The type will be determined by the
DataPrecise module.

CasingFlag / PunctuationFlag / DiacriticFlag / SpacesFlag / OffensiveScreening /

Country Code / Language Code / TitleFlag See Name Properties for these option
descriptions.

DiacriticFlag See the Name Properties section for available options and their explanation.

FormatFlag Applies only to Name Type data.

None No special formatting will be performed.

MatchKey The variable will be formatted for use as a matchkey

6.15.2 Script Tab

The Script tab allows you to create scripts which call DataPrecise functions and DataPrecise
control parameters. DataPrecise single components of certain types of multi-component variables
are available after the function call.

The options here are standard to the Script Editor dialog. See that dialog's section for more
details.

6.15.2.1 DataPrecise Functions

enhanceAuto
enhanceCity
enhanceDate
enhanceJTtl
enhanceName
enhanceStreet
enhanceTNum

250
 6.15 Data Precise Module

6.15.2.2 DataPrecise Control Parameters

CompDelimIn
CompDelimOut
CompSeqIn
CompSeqOut
DPAnclParamPar
DPCasingFlagPar
DPCountryCodePar
DPComponentType
DPDiacriticFlagPar
DPFormatFlagPar
DPLanguageCodePar
DPLanguageCountryCombinationPar
DPNameTypePar
DPOffensiveScreeningFlagPar
DPParseFlagPar
DPPunctuationFlagPar
DPSpacesFlagPar
DPTitleFlagPar

6.15.2.3 DataPrecise Single Components

After enhanceName

FName
LName
MName
MSuffix
PSuffix
Title

After enhanceStreet

HouseNum
PreDir
PostDir
SecID
SecNum
StName
StPrefix
StSuffix

After enhanceCity

City
State
Zip
Country

251
6 Data Processing Modules

After enhanceTNum

CountryCode
AreaCode
Prefix
Number

After enhanceDate

Year
Month
Date

Example The following script extends the state code (WI) to a full state name (Wisconsin):

DPAddressFormatFlagPar=DPAddressFormatFlag.fmtFullStateName;
String CityStateZip="WI53821";
String City=enhanceCity(CityStateZip);

6.15.3 Metric Shortening Tab

Metric shortening, as it pertains to DataPrecise, is the intelligent shortening of variable data
(by elimination of components in order of least importance) based upon the amount of hori-
zontal space that the contents of the variable will occupy when printed, using the font associated
with it in the document.

The Metric Shortening tab allows you to define all fonts which will be used to print any Data-
Precise variable for which metric shortening is to be performed.

Options Description

Index Displays the index of the font.

Font Name Selects the font by its name.

Size Defines the size of the font.

Style Defines the font style. The options available are Normal and Bold.

Create new Adds a new font to the list. Select the appropriate font name, size and style
values using the corresponding drop-downs.

Delete Deletes the selected font from the list.

252
 6.15 Data Precise Module

The Index value determined and maintained by Inspire Designer will be used in the script defined
on the Script tab.

The unit of specification for the Result Length is always in inches.

Example As an example consider the following partial script:

Name25 = enhanceName(StaticName,(2.5),0);

Where:

Name25 Is the variable which will contain the enhanced shortened data.
enhanceName Is the DataPrecise function to enhance names.
StaticName Is the source variable containing the data to be enhanced.
2.5 Specifies that the enhanced result cannot have more than 2.5 inches.
0 Is the index of the font to be used for metric shortening.

6.15.4 Knowledge Files Tab

The Knowledge Files tab allows you to override one or more of the default Knowledge Base
files used by DataPrecise for this workflow. You can select BIN files containing translation rules
for the Data Precise module.

These database files are distributed along with the DataPrecise.dll and they are of various ver-
sions. They are predefined, thus the user cannot change them. The user only needs to set the
path to them. Several Data Precise modules can be employed in a Layout, each using a different
version of the database files.

If no selection is made, the database files from the folder defined by the CX_DATA system
(environment) variable will be used automatically.

Options Description

Country Code, Language Code Selects the combination of language and country codes,
for which the Knowledge Base file will be used.

File Selects the Knowledge Base file.

253
6 Data Processing Modules

6.16 Data Remapper Module

The Data Remapper module allows the redefinition of data so that it can be read using a new
structure that is defined by a previously-prepared XSD file (XML data definition) or a workflow
definition (WD) file.

To re-map data:

1. Connect the module to the workflow at the position which has the data structure that
should be redefined.

The current data structure should now be listed in the Input Structure column.

2. Open the XSD or WD file which defines the data structure that you want to map
to, i.e. the structure that will define the data after this module.

The new data structure should now be listed in the Output Structure column so that
there are two data structures.

3. Click on any data field in the Input Structure and drag the connector that appears to
its corresponding data field in the Output Structure.

This can also be done Output Structure to Input Structure. It is also possible to map
one field from the input to many fields in the output structure, but not vice versa.

254
 6.16 Data Remapper Module

The mapping connection must be between fields of the same dependency level and
of the same data-type. If you attempt to mismatch your field with another level or type
the connector will show red and will not connect.

4. Repeat step 3 until all the data fields that you require further in the workflow are
mapped to the Output Structure.

Only mapped fields will contain any data.

Options Description

Input Structure Lists the structure of the data being read in to the module.

Output Structure Lists the structure of the data that will be read out of the module.

You can load a data structure using the Open icon.

Synchronize Scroll Bars If selected, one scroll bar is used to navigate the data structures
together.

If deselected, separate scroll bars will appear for each of the data structures. This allows
them to be scrolled to different positions so that data fields of differing positions can be
brought level to each other in the view.

Scroll bars only appear if the data structure is long enough to require a scroll bar.

Toggle Connection Assistant If selected, then when selecting parent arrays all dependent
fields in that array will be automatically connected if there are corresponding valid fields
in the Output Structure.

Show All Connectors If selected, all connectors between data fields are displayed.

If deselected, only any connection to a selected field is displayed. The intention of this is
to simplify the view if there are many connections that cross paths.

Connect Connects data fields.

If a data field is selected in the view, this icon opens the Connect to Field dialog which
shows all valid fields that the field can be connected to. In the dialog, select a field in order
to connect it.

Valid fields are those of the same data-type and on the same level of dependency. Optional
fields appear to have two levels of dependency, however the 'parent' (marked with the
Optional icon) and is not counted as a dependency level but as a gate that allows the
field to exist or not.

This option is also available by right-clicking on a field.

Disconnect Disconnects selected data fields.

This option is also available by right-clicking on a field.

Open Loads a data definition from an external file (XSD or WD).

WD (workflow definition) files can be saved in other places in the workflow or in another
workflow, e.g. in the Script Data Input module.

255
6 Data Processing Modules

XSD files can be exported from the XML Data Input module or can be created externally.
While loading, you will have to fill in the XML Schema Parser dialog, where it is required
to select an array that should be the highest-level of the structure (Document root) and
how many dependent levels will be used (Max recursive nesting).

Example This XSD schema was loaded to the module in the screenshot (at the
start of this section) and defines the Output Structure that can be seen there:

<?xml version="1.0" encoding="utf-8" ?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="Array-Accounts">
<xsd:complexType>
<xsd:sequence minOccurs="1" maxOccurs="1">
<xsd:element minOccurs="1" maxOccurs="unbounded" name="Accounts">
<xsd:complexType>
<xsd:sequence minOccurs="1" maxOccurs="1">
<xsd:element minOccurs="1" maxOccurs="1" name="Id"
type="xsd:string"/>
<xsd:element minOccurs="0" maxOccurs="1" name="Account"
type="xsd:string"/>
<xsd:element minOccurs="0" maxOccurs="1" name="Finishing
Balance" type="xsd:string"/>
<xsd:element minOccurs="1" maxOccurs="unbounded"
name="Transactions">
<xsd:complexType>
<xsd:sequence minOccurs="1" maxOccurs="1">
<xsd:element minOccurs="0" maxOccurs="1" name="Ac
count Number" type="xsd:string"/>
<xsd:element minOccurs="0" maxOccurs="1"
name="Value" type="xsd:string"/>
<xsd:element minOccurs="0" maxOccurs="1" name="Date"
type="xsd:string"/>
<xsd:element minOccurs="0" maxOccurs="1" name="De
tails" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

256
 6.17 Data Repeater Module

6.17 Data Repeater Module

The Data Repeater module repeats running of the modules connected before this one as many
times as it is set. Each run is launched by the run() scripting method. The greatest advantage
of this module is that you can change the settings for each run using, for example, workflow
parameters, File or ODBC scripting methods. The data from each run is concatenated in the
output.

The module's GUI is identical to the Script Editor dialog.

Example The Data Repeater module can be used for reading several data files in one
Inspire Designer run. This example shows a situation when in a Data Input module a
number of files is read in a row.

In the Data Input module leave the Input file combo-box empty. Connect the Data Re-
peater module to a place in the workflow that suits your purpose, open it and write a
script similar to this one:
File.FileInfoList fil;
File.list(fil,File.ListParam.Files,"map://wfd/data");

for (Int i=0; i<fil.Size;i++)

{
WorkFlow.Parameter["DataInput1","dif"] = fil[i].Location;
run();
}

As a result, all the files in the defined directory are read one by one and its data is concat-
enated together.

Note The parameters used for Workflow.Parameter, i.e. ["DataInput1","dif"],

are described in Data Input Module Parameters chapter as -dif<ModuleName> file
Path. You can use the other Inspire Production Console Workflow modules parameters
similarly, i.e. ["<ModuleName>","parameter"], the parameter without the dash.

257
6 Data Processing Modules

6.18 Data Sorter Module

The Data Sorter Module can re-organize records of data into ascending or descending order
according to the values of a selected field.

In order to perform this task, fields must be chosen which will be used as the key by which the
rest of the record will be given its position.

Options Description

Memory usage Selects what data will be stored within Inspire Designer while it is processing
the workflow. The options are:

On disc - the data will be read directly from the files and sorted, record by record,
without using any application memory.

This is recommended if a very large data file is being read and there would be in-
sufficient processing memory on the computer being used.

Indexed in memory - determines that an index of the data will be loaded to the
application memory when the workflow is processed.

258
 6.18 Data Sorter Module

This provides faster processing providing that the data file is not very large. Although
efficiency with larger files is better than that with Fully in memory.

Fully in memory - determines that all of the data will be loaded to the application
memory when the workflow is processed.

This provides the fastest, most efficient processing providing that the data file is
not large.

Add sorted to new copy If checked, a new set of data is created by the sorting.

This results in two sets of data being present, sorted and unsorted. The sorted data appears
in an independent array.

Example

It is therefore possible (by having data sorter modules in series) to have many sets of the
same data, simply sorted by different criteria.

Sorted name Names the array that is created if Add sorted to new copy is checked.

Remove duplicate records If checked, any records that return duplicate values in the fields
that have been selected for sorting will not be passed out of the module when the workflow
is processed.

Field Name Lists all fields from which the values will be used to sort the records.

To add a sorting field, select the field from the data structure in the left area and click on
the Create New icon.

Sort Type Selects the sort order. Options are: Ascending (e.g. A to Z) or Descending (e.g. Z
to A).

Binary compare If checked, the sorting field values (strings) are compared lexicographically
by the Unicode values of their characters.

The result is similar to selecting Identical for the option Strength except it does not recog-
nize any particular linguistic rules. However, for numbers and English text it works well
and is much faster.

Locale Specifies the language that will be used for applying sorting rules.

259
6 Data Processing Modules

Strength Selects the level to which sorting should take place. The options are:

Primary - Only considers the differences between all base characters, e.g. sorts in
alphabetical order.

This is the fastest sorting method.

Secondary - Diacritics are also considered.

Other differences may also be considered, depending on the locale used.

Tertiary - Upper and lower-case differences are also considered.

Quaternary - Punctuation differences are also considered.

Identical - Unicode code point values of the NFD form of each string are also con-
sidered.

Code point value differences between two strings are rare, but are found in some
languages, e.g. Hebrew.

This is the slowest sorting method.

French collation Uses the French preferred sorting of characters with diacritics.

Case level Casing of characters in the common fields is considered for matching.

This is an alternative to selecting Tertiary for Strength, that could be used if Primary is
selected there and no consideration for diacritics is needed.

Can also be used for Japanese in order to recognize the difference between small and
large Kana.

Normalization mode If checked, differences in Unicode strings are standardized.

Standard characters will be recognized if they are described slightly differently in the Uni-
code.

Example The two described characters ' and e when they appear together as 'e
will be recognized and sorted as .

Create New Adds the field selected from the data structure in the left area to the list of
sorting fields.

Delete Removes the selected sorting field from the list.

Move Up / Move Down Moves the selected sorting field for sorting up or down in
the list and therefore in order of importance.

260
 6.19 Data Caser Module

6.19 Data Caser Module

The Data Caser Module is an advanced Data Filter. The module has N+1 output links, where
N is the number of defined conditions. For example, if you define 3 conditions in a Data Caser
module, there will be 4 output links (like in the screenshot below). The extra link (bottom-most)
allows the data that do not fulfill any of the defined condition(s) to pass through.

Double-clicking on the module icon displays the module's dialog. Opening the Condition field
array combo-box displays the available arrays of the data coming from a connected data input
module.

To define the filtering conditions do the following:

1. Select the array in the Condition field array.

2. Click on the Create New icon, that inserts a new line in the Inline Script column.

3. In the new line, click on the 3 Dots icon. This opens the Simple Expression dialog.

4. Define the expression(s) for your condition(s) by selecting the required values from the
combo-boxes. Click on the Add Condition icon to define more conditions.

5. Click on the Go To Script Editor button to open the Script Editor.

261
6 Data Processing Modules

Note To always open Script Editor directly, disable the Open the Simple Expression
check-box in the Workflow Options dialog.

6.20 Data Transformer Module

6.20.1 Data Transformer Module
In this section See also:
Multi-Selection of Fields Field Converters
Field Order Area
Orphans Area

The Data Transformer module enables you to convert the data-type of input data and other
manipulations.

You can, for example:

Transform the initial input data into other types of data, e.g. string data-type into an-
other data-type (integer, Boolean, currency, date etc.).

Concatenate strings (e.g. prefix+string+suffix).

Stack field conversions (), i.e. several transformations can be done in series.

For example, Input Data -> [CustomerCode -> Concatenation ->Integer] ->Output Data
in just one conversion.

Use some CustomerCode. This provides a conversion table to convert an alphanumeric

input string to another alphanumeric output string.

Each CustomerCode has one default value (the output string) that is applied if no pre-
defined input strings match the actual data. If an input string matches the actual data,
then that string is passed to the output.

Write script that performs some data manipulation.

262
 6.20 Data Transformer Module

When the Data Transformer module is connected to the workflow, the data structure at that
point in the workflow becomes visible in the Field conversions area, e.g.:

In this area, you should:

1. Select the field to be transformed (multi-selection is also possible).

2. Select the conversion in the Field Converter column.

See the separate section Field Converters for a description of all conversion types.

3. If necessary, complete the conversion specific dialogs associated to that particular

conversion.

Options Description

Input Data Shows the fields that will read into the module in tree structure form.

The tree structure represents the fields' relationship to each other.

Type Shows the data-type of the field as it is coming into the module.

Field Converter Determines what type of conversion will be performed on the data.

263
6 Data Processing Modules

Select the conversion from the drop-down menu. Possible conversions are:

BC-String
BC-Int
BC-Int64
BC-Bool
BC-Currency
BC-Double
BiDi - Visual to Logical
Case Converter
Check Digits Converter
Conditional Text Processing
Convert pg. sel.
CustCode
Date Time Modifier Date Time
Decrement-Int (Int64)
Encode Binary
Euro Converter
File Content
Force Visual Order
Format
From Base64
From Hex
Image Page Counter
Increment-Int (Int64)
Max Image Color Saturation
Number Formatting
Numerical Formatting
Parse Date Time
PrintNet 3 FCVs
Script
Stack FCVs
String Manipulation
To Base64
To Binary with Codec
To Hex
To Latin1

Follow the links above to a description of the conversion in the separate section Field
Converters.

Alternatively, values can be set to:

Delete The field will be removed at this point from the workflow and will not
proceed further.

None No conversion will be performed in this module and the field will remain
the same data-type, i.e. as seen in the Type column.

You can also set these values by hitting the <Delete> key. When the key is hit for the first
time, the field conversion changes to None, with the second hit to Delete.

If further configuration of a conversion is required, this button will appear in this column.
Click on it to open the individual configuration dialog for that conversion.

These conversion dependent dialogs are described in the separate section Field Converters.

264
 6.20 Data Transformer Module

Default This column is for entering a default value when creating a new unlinked field.

Toolbars

Mark Array for Save / Mark Root for Save These icons allow you to determine
that fields can be used within scripts on a different dependency levels than its current
one. You can only use one of these marks at a time:

Mark Array for Save If an array is marked, it can be used as a field in a

scripted conversion that is at any level dependent on the current one, i.e.
when defining sub-array fields.

Select a field of array data-type, click on the icon to mark it. Only one field
can be marked at a time.

The advantage of selecting only the specific array that is required is that less
data values (being read from the data input) have to be saved and so they are
saved as part of the data transformer module. This results in a faster processing
time than using Mark Root for Save.

See also an example below.

Mark Root for Save When selected (the icon appears as depressed) the
whole root of the data will be saved in a separate, automatically created
temporary file as the workflow is processed. Then all of the data fields can be
used to return values for any scripted conversion within the Data Transformer
module.

Because of the extra memory required for storing and retrieving all values, it
is recommended that this option is only used if it is really necessary.

See also an example below.

If neither of the options Mark Array for Save or Mark Root for Save are set then,
when converting using a script, you can only access only fields of the same
level/context.

Mark for Error Marks an unlinked Boolean field so that it will contain TRUE if a
conversion error occurs in a related field.

To set this, an array must first be marked for save (see the Mark Array for Save
/Mark Root for Save description above) and a new unlinked Boolean field must be
created (use the Create Unlinked icon and select type Bool). Then select this new
field in the tree and click on the icon .

This field is used for error recovery, i.e. set as the Data error var. on the Data Layout
Properties in the Layout module.

Mark for Logic Tracking Marks a selected field for logic tracking store.

See the separate Logic Tracking section for more information.

Trim Spaces Trims the spaces in string fields.

When selected (shows as depressed) all spaces at the beginning and end of string-
type fields, within the whole root, will be removed. Spaces within the string will remain.

265
6 Data Processing Modules

Delete All Sets the Field Converter value of all selected fields to Delete.

This icon is only available when multiple fields are selected. See the section Multi-Se-
lection of Fields.

Remove Conversions Sets the Field Converter value of all selected fields back to
None.

This icon is only available when multiple fields are selected. See the section Multi-Se-
lection of Fields.

New Array Index Adds a new index field of integer data-type on the same level as
any selected array.

This field can be used to index the values in the array so that they can be used in
scripting or Layout. The following conversions can be applied to the values:

New Linked Creates a new field on the same level as and linked to the selected field
(not array).

A linked field is a duplicate of the original. It can be used to perform two different
conversions with the same set of values.

Example You need to keep a field that contains the cash transaction amounts
of a customer (e.g. Amount) as an integer, but you also need a field that only
contains these values if the value is negative (e.g. a withdrawal of - $ 25.00).

In such a case, you would use the Data Transformer to convert the original to a
numerical value (e.g. Double) and could create a linked field and convert this
version of the field to double via a script which only returns values to the field
if the amount is less than zero (e.g. if (Amount.toDouble()<0) return
Amount.toDouble();).

If you select a linked field, its parent is highlighted, for better orientation.

266
 6.20 Data Transformer Module

The name of new fields has to be unique, if not a warning dialog will show to ask
you to choose another name.

New Unlinked Creates a new and unlinked field on the level of the currently selected
field.

This newly created field does not inherit any content and can be used to add new
values to the records being read through this module. Usually this is done by a script
which uses some of the other fields to calculate the values for this unlinked one.

The Default column of this field can be used to enter a value that will be passed
along the workflow should no other value be calculated, i.e. if this field is empty.

New Special Field Opens the Select Data Operation dialog allowing you to select a
type for a new field that will be related to the currently selected field.

The available types are:

Sum Sums and contains the total of the values contained in the parent field.

Average Calculates and contains the average of the values contained in the
parent field.

Min Contains the lowest value contained in the parent field.

Max Contains the highest value contained in the parent field.

Standard deviation Calculates and contains the standard deviation (average

squared deviation) of the values contained in the parent field.

Copy level up Copies the selected field to create a duplicate that is one level
higher in the dependency tree.

The intention is to copy fields up from a sub tree (as opposed to an array) so
that they can be used in the same context as the fields in the new level, e.g.
on the same page when Page order is set to Variable selection and the Re-
peated by variable is the parent array for the fields of the new level. If a field
within an array is copied up, then the copy will only contain the last value in
that field which might be useful in cases where the value is the same for
each record.

Example If data is grouped by family name (using the Data Group By

module), consequently a new array is created and all the entries for a
field (e.g. called FamilyName) are the same within a single group, e.g.
Smith. In this case, the last record's value is representative of all values
and the field could be copied up a level in order to identify the individual
groups.

Count Contains the number of records in the array. Available for arrays only.

If you click on a special field, its parent field is highlighted.

267
6 Data Processing Modules

Note

Sum, Average, Min, Max and Standard deviation type special fields can only
be created for fields of numerical data-type (Int, Double etc.).

For DateTime data-type the available options are Sum, Min and Max.

Deletes the selected field.

Find Previous / Find Next Goes up/down the data structure to the previous/next
field for which a transformation is set (i.e. skips all fields for which conversion is set
to None).

Loads pre-defined conversion properties from a separately saved FCV file so that they
can be applied to the selected field.

Saves the conversion properties of the selected field to an external FCV file.

Removes orphans.

Show Field Sorting Opens the Field order area on the right of the module where the fields
can be sorted into a different order.

See the section Field Order Area below.

Note If you change the data-type of a field, after it has already been used in Layout, the
reference in Layout will be kept for only the one field with this name and if no subsequent
conversions have been applied to it in Layout (via the Conversion tab).

If there are conversions or the name differs, the field with the new type is used in the Layout
as a constant and the original field remains as it was.

Example Mark Array for Save Option

We have an array of customers containing an array of their transactions and we would
like to know the total amount of each customer's transactions.

To write a script that will be able to calculate the sum of each customers transactions
values (e.g. a new unlinked field SumAmount), we need to put the calculation in a level
directly dependent on each customer so that the relationship between the customer and
the calculation is one to one, i.e. for each customer there is one transaction sum.

Then, because the customer's transactions are an array for each customer (one to many:
for one customer there are many transaction amounts), to use the values in the array-type
field Transactions we must read all of those many values before the calculation can be
performed by SumAmount. Therefore, we must mark the Customers array by clicking on
the Mark Array for Save icon , because this is the array that governs all of the fields
that we are working with, i.e. the array above the field that we require to use the data.

268
 6.20 Data Transformer Module

Now, the Transactions array can be called by pressing <Ctrl>+<Space>, when defining
the script for SumAmount. E.g.:

The script in the screenshot determines that for every new customer record, the transactions
for that customer will be added together to create a total which is in the field SumAmount.
SumAmount can then be used further in the workflow, e.g. in Layout.

Example Mark Root for Save Option

We have an array of customers containing an array of their transactions including a sum
of each individual customer's transactions. We would like to know the total value of all
of the transactions for all of the customers.

To write a script that will be able to calculate the sum of all customers transactions values
(the sum of all SumAmount fields), we need to put a new calculation (e.g. a new unlinked
field CompleteAmount) on the same level as the array of customers so that the relationship
between the calculation and the customer is one to many, i.e. for each sum there are
many customers.

269
6 Data Processing Modules

Then, we must read all of those many customer values before the calculation can be
performed by CompleteAmount and, because there is no array above both of these fields
(CompleteAmount and Customers), the whole root of the data must be saved. To do this
click on the Mark Root as Save icon.

6.20.1.1 Multi-Selection of Fields

It is possible to select more than one field at a time using the usual combination of keys (e.g.
<Shift> + <Arrow Up/Down>).

After selecting more than one field, additional functional icons Remove nodes and Remove
conversions become available. You can also remove selected fields or their conversions in the
Field Converter by choosing the required option (Delete for removing fields, None for removing
conversions) in the Field Converter combo-box.

If you wish to apply one type of conversion to a number of fields, select a field with the desired
conversion type, copy it to the clipboard (<Ctrl> + <C>), select the fields you want to convert
and paste the copied type of conversion (<Ctrl> + <V>).

Note Pasted conversions will only be applied to fields where the selected conversion is pos-
sible.

270
 6.20 Data Transformer Module

6.20.1.2 Field Order Area

Clicking on the Show Field Sorting button opens the Field order area of the module.

This feature changes the order of the fields. This is for cases where fields are required to be in
a different order to that determined by a data file that has been read into the workflow.

Options Description

Move Up / Move Down Move the selected field up/down the order in the data
structure. Alternatively, you can use <Alt>+<up arrow>/<Alt>+<down arrow> shortcuts.

Sorted fields are highlighted in a bold font. Fields can only be moved within the same level
of the data structure.

Find Previous / Find Next Find the previous / next field which has been sorted.

This is for faster navigation through large data structures where fields have already been
sorted.

Restore Field Order Reverts all changes to the fields order.

6.20.1.3 Orphans Panel

Whenever a field, on which some other field depends, is changed (or renamed, or deleted),
the dependent orphaned field is displayed in the Orphans panel. This panel provides you with
the possibility to either relink the orphan or delete it.

The Orphans panel also displays field conversions that were lost in case a field had been deleted
or renamed in a module before Data Transformer. In such a situation the Orphans panel lists
the original fields and their field conversions.

Also, a warning about a wrongly connected filed or a disconnected field conversion appears
in the Verify window-pane, when the workflow is run.

271
6 Data Processing Modules

To re-link a field, select the orphan field in the Orphans panel and, in the data structure, a field,
to which you want to re-link the orphan. Afterwards, click on the Relink icon.

To restore a field conversion, choose one of the following methods:

1. Go back to the module where the field has been renamed and rename it to its original
name.

2. Or, in the current module, select the renamed field in the data structure and the orphan
in the Orphans panel and click on the Relink icon. If the field has been deleted,
create a new one of the same data-type and relink it with the orphan. After successful
re-linking, the field conversion is applied to the selected field in the data structure and
the orphan is automatically deleted.

3. Or, in the current module, right-click on the orphan and select Copy (or use the
shortcut <Ctrl>+<C>). Then right-click on the field and click on Paste (or use the
shortcut <Ctrl>+<V>). The field conversion will be applied to the field. Afterwards,
remove the orphan from the panel by clicking on the Delete icon. If you want to
remove all orphans, use the Delete All icon.

272
 6.20 Data Transformer Module

6.20.2 Field Converters

In this section: See also:
Arabic to Roman Number Data Transformer Module
BC-String
BC-Int
BC-Int64
BC-Bool
BC-Currency
BC-Double
BiDi - Visual to Logical
Case Converter
Check Digits Converter
Conditional Text Processing
Confidential
Convert pg. sel.
CustCode
Date Time Modifier Date Time
Decrement-Int (Int64)
DirectSmile
Encode Binary
Euro Converter
File Content
Force Visual Order
Format
From Base64
From Hex
Image Page Counter
Increment-Int (Int64)
Letter Indexing
Line Data Formatting
Max Image Color Saturation
Number Formatting
Number to Spell
Numerical Formatting
Parse Date Time
PrintNet 3 FCVs
Script
Spell to Number
Stack FCVs
String Manipulation
To Base64
To Binary with Codec
To Hex
To Latin1

273
6 Data Processing Modules

There are multiple options available from the combo-box of the Field Converter column of
the Data Transformer module.

The options that appear depend upon the type of data that arrived to that field and so not all
option will be visible for any one type. See a description of each field converter below.

Field conversion types can be copied and pasted. See the section Copy and Paste for details.

6.20.2.1 Delete
Field will be deleted. That is, it will not be passed to the next modules in the workflow.

6.20.2.2 None
No transformation is done; the field will be present in the output.

Result type: the same as input data type.

6.20.2.3 Number Formatting

This field conversion type is useful for changes in formatting of numbers that come from the
input data as a string value. It automatically converts string to double and double back to string
using the settings made in the Number Formatting dialog.

Clicking on the 3 Dots icon opens the Number Formatting dialog, which has the same options
as the BC. - String dialog for double data-type input.

6.20.2.4 BC-String
Input data is converted to a string value.

For input data of integer type, clicking on the 3 Dots icon opens this BC String Properties
dialog.

274
 6.20 Data Transformer Module

Options Description

Length Specifies how long the string will be (total number of characters).

Base Selects the base (decimal, hexadecimal etc.). You can enter here numbers from 2 to
36, e. g. 10 stands for decimal, 16 for hexadecimal base etc.

Fill with Empty spaces get filled with the selected character. E. g. if input data is 25, Length
is set to 5 and we want to fill remaining spaces with zeros, this option will make the data
display this way: 00025.

Truncate If checked, the specified Length is a maximum value and all longer strings will be
truncated from the end (for example, when Length is set to 5, then string document will
be shortened to docum).

Left Justified If the option Truncate is checked, you can choose here to have the strings
truncated from the left side.

Big Letters If Base is higher than 10 (e.g. for hexadecimal), you can select if capital letters
will appear in strings.

Example If the value is 15, settings for hexadecimal (Base:16), you can choose if
f or F should be displayed.

Negative format Enables you to select how the negative number will display:

Sign at begin: -2.16

Round bracket: (2.16)

Sign at end: 2.16-

Separate thousands If checked, thousands will be separated, by default with a comma.

Separate thousands with Enables you to set character used for separating the thousands.

Enable condition If checked, you can enter a simple condition in the following fields.

If input is Selects the input data in condition.

Set output to Enables you to enter a text that should be displayed if the input data matches
the value you have entered.

This value will be displayed as you enter it here, the length, truncate etc. will not affect
it.

Preview Shows a sample number for you to check what the result will look like, as for length,
negative format etc.

For input data of double type, clicking on the 3 Dots icon opens this BC String Properties
dialog.

275
6 Data Processing Modules

Options Description

Use precision If checked, you can select below the number of significant digits.

Min. digits after decimal / Max. digits after decimal If Use Precision is not checked,
you can set the number of digits after decimal point the maximum and minimum value.

Note If the number of decimal places after decimal is smaller than the minimum, it is
padded with zeros. If the number of decimal places is greater than the maximum, it is
rounded.

Precision If the option Use Precision is checked, you can select the number of significant
digits. For data-type double the maximum is 18. A higher number of significant digits can
be entered but only 18 is calculated and displayed.

Without e This checkbox appears when the option Use Precision is selected. If checked the
conversion output will use an ordinary number format (e.g. 1000000000) instead of a
scientific one (e.g. 1e+10). This option is also available in scripting.

Digits before decimal If checked, you can select the number of digits before decimal.

Number of digits If the option Digits before decimal is checked, select the number of digits
before decimal.

Fill remaining with Selects how space for a number (determined by the number of digits
before decimals) will be filled. Options are:

Zeroes

Spaces

Example If Zero is selected and the number of digits before decimals is 5, number
12 will display as 00012.

276
 6.20 Data Transformer Module

Negative format Enables you to select how the negative number will display:

Sign at begin: -2.16

Round bracket: (2.16)

Sign at end: 2.16-

Negative Enables you to enter what will display before and after every negative number.

Positive Enables you to enter what will display before and after every positive number.

Decimal point Selects the type of decimal point: most common are a dot (.) or a comma (,)
depending on how you want the number to be displayed.

Example If the incoming double value is 0.761 you can select comma as the
decimal point and it will be displayed as 0,761 in Proof/ Production.

Separate thousands If checked, thousands will be separated, by default with a comma.

Separate thousands with Enables you to set character used for separating the thousands.

Enable condition If checked, you can enter a simple condition in the following fields.

If input is Selects the input data in condition.

Set output to Enables you to enter a text that should be displayed if the input data matches
the value you have entered.

This value will be displayed as you enter it here, the length, truncate etc. will not affect
it.

Preview Shows a sample number for you to check what the result will look like, as for length,
negative format etc.

6.20.2.5 BC-Int
Input data type is converted into Integer (32 bits) value.

Result type: Int.

This is Basic Conversion (no other settings are required in Data Transformer).

Example String 23 needs to be converted into integer before it can be used for
mathematical operations.

6.20.2.6 BC-Int64
Input data type is converted into Integer (64 bits) value.

Result type: Int64.

277
6 Data Processing Modules

This is Basic Conversion (no other settings are required in Data Transformer).

6.20.2.7 BC-Currency
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.

Clicking on the 3 Dots icon opens the BC. - Currency dialog, which has the same options
as the BC. - Double dialog.

6.20.2.8 BC-Double
A real number that can be represented with floating-point notation. 64 bits. It has up to 16
digits after the comma. When counting with it, the result might be rounded, that is why it is
not recommended for accountancy (use currency format instead).

Clicking on the 3 Dots icon opens the BC. - Double dialog.

Options Description

Ignore characters Enables you to ignore characters mixed with numbers.

Ignore these If previous option is checked, enables you to select what characters will be ig-
nored.

Example If you have numbers in this format aaa9.52bA and wish to ignore these
characters, you type in this field: abA.

Negative format Enables you to select how the negative number will display:

Sign at begin: -2.16

Round bracket: (2.16)

Sign at end: 2.16-

278
 6.20 Data Transformer Module

Decimal point Selects the type of decimal point: a dot (.) or a comma (,) this must be set
according to what comes from the data, so that the data is read and converted correctly.

Empty input result Enables you to set what number will be considered as empty input result.

Skip warnings with empty data Enables you to skip warnings with empty data set in the
previous option.

Wrong input results Enables you to set what number will be considered as wrong input
result.

Skip warnings with error data Enables you to skip warnings with error data set in the
previous option.

6.20.2.9 BC-Bool
Boolean value denoted by the predefined constants 1 for true, 0 for false.

This sort of variable is used for easy conditioning in Layout (flows/rows selected by condition
etc.). It is also suitable as a switch in scripting.

This is Basic Conversion (no other settings are required in Data Transformer).

6.20.2.10 CustCode
Customer Code provides a conversion table to convert an alphanumeric string to an alphanu-
meric output string. It is an easy way to work with an if-then-else query.

Each CustCode has a default value that is applied as the output string if no predefined input
strings match the actual data. If an input string matches the actual data, then that string is
passed to the output.

First, click on the Add Converter icon to add a new conversion line and then press <F2>
to define the string conversion. Click on the 3 Dots icon if you want to enter a multi-line
string as an Output string.

279
6 Data Processing Modules

Options Description

Move Up / Move Down Moves the selected input string up or down.

Add Converter Creates a new condition.

Remove Converter Deletes the selected condition.

Import Saved Condition Imports previously saved conditions from structured text file.

Export to TXT File Exports the set conditions to structured text file.

Example Key variable has values 1, 2 or 3 and you can set the conversion:

1 = Dear Mr,

2 = Dear Mrs,

default = Hello.

The default option would apply for the key variable 3.

6.20.2.11 String Manipulation

Clicking on the 3 Dots icon opens the String manipulation dialogs that are described below.
Selecting different manipulations in the Type combo-box will show different options:

280
 6.20 Data Transformer Module

Type: Concatenation
This type adds a string before or after the incoming string.

Options Description

Append if empty If Yes is selected, PreString or PostString will be added even if the in-
coming string is empty.

PreString Sets what will appear before the incoming string.

PostString Sets what will appear behind the incoming string.

Type: *White Spaces*

This type removes white spaces at selected positions.

Options Description

Type The following options are available:

Trim white spaces Removes white spaces, i.e. signs from 0 to 32 (enters, tabs
etc.) which are placed at the beginning or at the end of text. No settings are re-
quired.

Trimleft white spaces Removes white spaces, i.e. signs from 0 to 32 (enters, tabs
etc.) which are placed at the beginning of the text. No settings are required.

Trimright white spaces Removes white spaces, i.e. signs from 0 to 32 (enters,
tabs etc.) which are placed at the end of the text. No settings are required.

Reduce white spaces Reduces multiple white spaces. No settings are required.

Trim and reduce white spaces Removes white spaces at the beginning or at the
end of text and reduces multiple white spaces. No settings are required.

281
6 Data Processing Modules

Type: Advanced Concatenation

This type enables you to set up concatenation of more variables and/or prefixes/suffixes to
them.

Example The example captured in the screenshot below will display the following result,
if the value for CustName is Anne, for CustMid A. and for CustSur Bolliger:

Anne A. and the surname is Bolliger

Type: Mask Merge

This type determines how characters will be displayed. The substitution character is hash mark
(#).

Example To display a phone number split into three parts, you would type hash marks
in the format like in the screenshot. Input number 222156111 will then be displayed this
way: 222 156 111.

Type: Simple Case Conversion

This type converts text cases.

282
 6.20 Data Transformer Module

For the input string one of the four types of case conversion can be used:

lower case

UPPER CASE

Title case

Title Case for Each Word

Type: Replace Spaces by Hardspaces

This type replaces spaces with hard spaces in the input string to which it is applied.

Type: *Unicode Single Japan*

This type replaces fullwidth character values with halfwidth character values (Unicode -> single
Japan) or vice versa (single Japan -> Unicode).

Note A suitable font (e.g. MS Mincho) has to be used to apply this converter.

Options Description

*Convert 0xFFE5 0x5C* If checked, converts a yen sign (0xFFE5 code point, a fullwidth
character) into a backslash (0x5C code point, a halfwidth character reverse solidus). If
not checked, a yen sign (0xFFE5 code point, a fullwidth character) is converted into a yen
sign (0xA5 code point, a halfwidth character). Vice versa options are valid when a single
Japan encoding is converted into Unicode encoding.

283
6 Data Processing Modules

The yen sign in Japanese character encoding has the same byte value as the backslash in
Unicode character encoding. Both characters have very similar usage in computing, e.g.
as a path separator. By checking this option you can decide whether the yen sign or the
backslash will be used.

Type: Smart Advanced Concatenation

This type inserts a separator between defined variables. The separator is inserted only if the
variable for the current record contains a string (i.e. is not empty).

Type: Replace String

This type replaces a text in the input string with another text.

Options Description

Find what Sets text that will be found and replaced in the string.

Replace with Sets what the above text will be replaced with.

Match case If checked, searching and replacement are case sensitive.

Note Both Find what and Replace with edit-boxes may contain multiline text (separated
with <Enter>). However, when more individual items are to be replaced, Stack FCVs option
must be used.

284
 6.20 Data Transformer Module

6.20.2.12 Stack FCVs

Clicking on the 3 Dots icon opens the Stack FCVs dialog.

Several transformations (field converters FCVs) mentioned above can be chained (e.g., Input
Data -> [CustomerCode -> Concatenation ->Integer] ->Output Data). You can save the conver-
sions configuration to FCV file for later use.

They are processed one after another from the top to the bottom. You can delete them from
the bottom only.

Options Description

Add Converter Adds a new row with a converter, which you set in the Select type of
new converter dialog that appears.

Remove Converter Deletes the last row with the converter.

Load Saved FCV File Loads converters previously saved into an FCV file.

Save to FCV File Saves the defined converters into an FCV file.

6.20.2.13 Increment-Int (Int64)

Adds 1 to the input Int/Int64 data. This option can be useful when you need to adjust variable
of index type (starting with 0) to variable of counter type (starting with 1).

6.20.2.14 Decrement-Int (Int64)

Subtracts 1 from the input Int/Int64 data. This option can be useful when you need to adjust
variable of counter type (starting with 1) to variable of index type (starting with 0).

6.20.2.15 Script
Clicking on the 3 Dots icon opens the Stack Script dialog.

285
6 Data Processing Modules

The output string is determined as a result of the script. It is often used after you create a new
unlinked field (a new variable) in Data Transformer and you already wish to write a script for
it here. There are the same scripting options in Script Data Input or in Layout.

The code must be written in a language based on C++ conventions. You type the code in the
edit area or choose to use the Script Wizard.

Options Description

Open Script Editor Allows you to edit the script in a detached Script Editor dialog. See
the section Script Editor Dialog for details and explanation of the other icons in the same
line.

In the Script window you specify output type (String, Int, Int64, Currency, Double, DateTime,
Bool). In the edit area, you type the code or choose to use the Script Wizard.

Example
String s=Input; //assigning Input data to local variable s
s.replace("December","January"); // replaces all occurrences of December
with January
s.makeUpperCase(); // makes all characters uppercase
return s; //returns content of the s variable

6.20.2.16 Euro Converter

Enables you to convert Currency or Double to Euro.

Clicking on the 3 Dots icon opens the Euro Converter dialog

286
 6.20 Data Transformer Module

Options Description

Country Allows you to select Custom setting or one of 12 European countries using Euro.

One Euro is equal to If a country is selected in the field above, displays the official conversion
rate from national currency to Euro at the time of Euro release.

If Custom is selected in the field above, you can enter your own value for conversion.

6.20.2.17 Format
Clicking on the 3 Dots icon opens the Format dialog.

Options Description

Locale Selects a language and national convention for date and time format.

Formatting method Allows you to choose from:

Type of output You can select from predefined date and time formats.

User pattern You can define your own date and time format in Output pattern
field. See hint for the syntax in the Parse Date Time section.

Time option Allows you to select from: None, Full, Long, Medium, Short.

You can see the format of each option in the Example field.

Date option Allows you to select from: None, Full, Long, Medium, Short, Date Offset, Date
Time.

You can see the format of each option in the Example field.

Default value Enables you to set your own default value for unspecified dates (e.g. empty
in input data). By default it is 30.12.1899.

Example Shows a sample date and time according to your settings.

6.20.2.18 Date Time Modifier Date Time

Enables you to modify date and time by adding years, months, days, hours, minutes, seconds
and milliseconds.

Clicking on the 3 Dots icon opens the ParseDateTime dialog.

287
6 Data Processing Modules

Also negative values can be entered to subtract the value.

6.20.2.19 Parse Date Time

Options Description

Locale Selects a language and national convention for date and time format.

Parsing method You specify here precisely in what format your data come, so that they can
be correctly converted to Date Time type.

You can select from:

Type of input for which you then set Time option (None, Full, Long, Medium, Short)
and Date option (None, Full, Long, Medium, Short, Date Offset, Date Time). You
can see the format of each option in the Example field.

User pattern for which you can define in Recognize pattern field your own date
and time format. There is a tool tip available to help you with abbreviations. The
content of the tool tip is explained in the following table:

288
 6.20 Data Transformer Module

Symbol Description

d Displays a day.
M Displays a month.
y Displays a year.
Y Displays a year (week of year) - the year displayed depends on
the sequence number of the week to which the processed date
belongs. (The first week of a year is defined as the first week
that has at least four days in the year. Thus the date 30. 12.
2003, which was Tuesday, transformed with pattern "MMddYY
w" returns "123004 1", i.e., a day of the first week of the year
2004. It is because this week has four days belonging already
to the year 2004).
u Displays an extended year (a number designating the year of a
calendar system, encompassing all supra-year fields, e.g., BC).
G Displays an era designator.
g Displays a Julian day (number of days that have elapsed since
the initial epoch at noon Universal Time (UT) Monday, January
1, 4713 BC).
<space> Displays a space.
h Displays an hour in am/pm (1~12) (one-based 12-hour clock;
11:59 followed by 12:00).
H Displays an hour in day (0~23) (zero-based 24-hour clock; 23:59
followed by 0:00).
m Displays a minute.
s Displays a second in minute.
S Displays a millisecond.
E Displays a day in week (text format).
e Displays a day of week (number format).
D Displays a day in year (number of days that have elapsed since
the beginning of the year).
F Displays a day of week in month (e.g., 2nd Tuesday in January).
w Displays a week in year (number of weeks that have elapsed
since the beginning of the year).
W Displays a week in month (number of weeks that have elapsed
since the beginning of the month).
a Displays an am/pm marker.
k Displays an hour in day (1~24) (one-based 24-hour clock; 23:59
followed by 24:00).
K Displays an hour in am/pm (0~11) (zero-based 12-hour clock;
11:59 followed by 0:00).
z Displays a time zone (e.g., CET).

289
6 Data Processing Modules

Symbol Description

Z Displays a time zone (offset from the GMT, e.g., +1:00 for
Central European Time).
t Displays the two letter suffix (st, nd, rd, th) of the date number.
Works only for the Format field conversion.
'any text' Between quotation marks you can enter any text to be displayed.
" Displays a single quote.

Example Conversion Examples

Value coming from the input data file: 09012007 18:25:55.865 +1:00

Used pattern: dd.MM. yyyy HH:mm:ss.SSS z

Result after conversion: 09.01. 2007 18:25:55.865 CET

Used pattern: h:mm a 'on' EEEE, MMMM d, yyyy G

Result after conversion: 6:25 PM on Tuesday, January 9, 2007 AD

Lenient When set to Yes, accepts small input errors or corrects them.

Example February 30 would be changed to March 1

Error level Selects how an error will be reported: as an error or only warning will be produced.

Ignore empty string If set to Yes, data with no string will be ignored.

Show message only once If set to Yes, warning message will display only once.

Test string When you type here a sample date or time, you can see the results in the Example
field.

6.20.2.20 Convert pg. sel.

This option is only for compatibility with PrintNet 3. It converts the page selection format used
in PrintNet 3 to format used in Inspire Designer.

6.20.2.21 Case Converter

Clicking on the 3 Dots icon opens the Case Converter dialog.

The case converter dialog has two tabs:

Input Format tab

Exceptions tab

290
 6.20 Data Transformer Module

Input Format Tab

On the Input Format tab it is possible to set rules for case conversion.

Options Description

Select Conversion

Lowercase conversion If selected, all letters contained in the selected variable will be
converted to lowercase format.

Uppercase conversion If selected, all letters contained in the selected variable will be
converted to uppercase format.

Begin word Uppers If selected, the first letter of the word contained in the selected
variable will be capitalized and the rest of the letters of the word will be converted
to lowercase format.

Additionally, words following separators defined in the Select separator field will
be converted in the same way.

Select separator

Uppercase after hyphens This setting allows the user to enter custom separators for
the setting Begin word Uppers. Space and hyphen are the default settings.

Example The default setting will result in the following conversions:

joe-max richardson will be converted to Joe-Max Richardson

JOE-MAX RICHARDSON will be converted to Joe-Max Richardson

291
6 Data Processing Modules

Note Settings made here are only applied when Begin word Uppers has been
selected in the Select Conversion field.

Uppercase after special characters When you select this option you can define a
language in the combo-box below. The languages available for selection here are
generated from the library icudtxx.dat which is a part of Inspire Designer. This setting
has two functions:

1. When Begin word Uppers is set in the Select Conversion field, characters
defined as special characters in the selected language are set as separators.
Special characters common to all languages are space, characters and punc-
tuation marks such as / * - + - _ ! $ % & ; , etc.

Example

smith&sons will be converted to Smith&Sons

old/new furnishing will be converted to Old/New Furnishing
crazy!jeans will be converted to Crazy!Jeans

Note There are a few marks which will not invoke capitalization of the first
letter of the following word because they are not defined as special characters
and thus will not work as separators.

Example

john.smith will be converted to John.smith

inside:OUT will be converted to Inside:out
andrew darcy will be converted to Andrew Darcy

2. Selecting the appropriate language can help ensure correct conversion for all
three conversion types available in the Select Conversion field.

Example In Turkish i is capitalized as and as I. To ensure the correct

conversion of these Turkish characters you must specify Turkish in the
Uppercase after special characters combo-box.

Fixed Text

Before variable Enables you to enter some text that will appear before the selected
variable.

After variable Enables you to enter some text that will appear after the selected variable.

Test

Input text Enables you to enter a sample text.

Output text Enables you to see the result of the conversion selected in the above fields.

292
 6.20 Data Transformer Module

Exceptions Tab
In the Exceptions tab you can handle exceptions to your case converting rules.

Load an exception file (.EXC) and select the appropriate encoding. The exception file can be
edited directly by clicking on the Edit Exception File button. If you have not created an excep-
tion file before, follow these steps to do so:

1. Open the Notepad program on your computer.

2. Now define your exceptions in the following way:

It is possible to define four different types of exceptions. Their functions are described
below; the examples correspond with the above screenshot.

[No conversion] Conversion is never applied to exceptions defined here.

Example Although a conversion option for a variable has been selected,

some specific words need to keep their original case. In this example Ltd. will
always stay Ltd., regardless of the case conversion settings applied.

[Following character uppercase] The character following the exception entered

here will be converted to uppercase.

Example Mc will always be followed by an uppercase character; Mcmichael

will be converted to McMichael.

293
6 Data Processing Modules

Note Case conversion settings apply here. For this example this means the excep-
tion will only function if the variable returns exactly Mc (not mc or MC) at the be-
ginning of the word after case conversion has been applied, thus Begin word
Uppers must be selected for the example to work.

[Always print like this] Converts the selected word to the format of the exception
you define.

Example Policeman, policeman, POLICEMAN etc. will all be converted to

PoliceMan, regardless of the case conversion settings.

[No conversion structural] Input following the structure defined will not be
converted. N represents digits, A represents letters.

Example HN85 8KN will stay unconverted, even if lowercase conversion is

set.

3. Now name the document and save it as an EXC file and with ANSI encoding applied.

Tip The functionality of the defined exceptions can be tested in the Test area of the Input
Format tab.

6.20.2.22 Numerical Formatting

This option is for compatibility with PrintNet 3. For number formatting, use the Number
Formatting conversion.

Clicking on the 3 Dots icon opens the Numerical Formatting dialog.

There are three tabs to edit Numerical Formatting: Input Format, Output Format and Test.

294
 6.20 Data Transformer Module

Options Description

Thousand separator Enables you to set how thousands should be separated.

Decimal separator Enables you to choose the decimal point between , and ..

Unit is If set to 100, all numbers get divided by 100. Only applicable if no Decimal sep-
arator is selected.

This tab is mainly for compatibility with PrintNet 3.

Options Description

Zero values Determines how zero values will be handled:

Input Dependent Leaves zeros as they are in input data.

Always Always displays zeros.

Never Never displays zeros.

Leading zeroes Determines how zero before numbers will be handled:

No modification Leaves the number as it is in the input data.

Replace with blanks Replaces all zeros before a number with spaces (as many
spaces as there were zeros).

Suppress Removes all zeros before a number or replaces them with spaces up to
the number of digits before decimal (set below).

Print plus sign Determines whether a plus sign will be printed. Options are: Input Dependent,
Always and Never.

Empty output Determines how empty output will be handled. If the option Like PrintNet 3
is selected, empty output is converted to a space.

295
6 Data Processing Modules

Number of digits

Before decimal Selects the number of digits before decimal.

After decimal Selects the number of digits after decimal.

Pad with Selects how space for a number (determined by the number of digits before
decimals) will be filled. Options are:

Zero

Blank

Example If Zero is selected and the number of digits before decimals is 5,

number 12 will display as 00012.

Sign position Enables you to select where a sign will be placed. Options are:

Sign before number

Sign on left (that is before the possible padding).

Separators

Thousand grouping Enables you to set how thousands will be separated or marked.

Example If you enter here x, number 123456789 will display as

123x456x789.

Decimal Enables you to choose the decimal point between , and ..

Once you type a sample number into the Input string field, you can see the results in the Output
string field.

6.20.2.23 Conditional Text Processing

This option is obsolete. It is only for compatibility with PrintNet 3 text encoding.

6.20.2.24 Check Digits Converter

Check digits converter calculates check digits out of the input number. You can select the al-
gorithm, test it on any number and look at the parameters or the conversion table.

Clicking on the 3 Dots icon opens the Check Digits Converter dialog.

There are three tabs to edit for the Check Digit Converter: Algorithm Parameters, Conversion
Table and Test.

296
 6.20 Data Transformer Module

Options Description

Method / Divisor There are three types of methods of algorithms; to define an algorithm,
it is necessary to set the parameters of the method. Each method requires different para-
meters.

Only modulo

Modulo with weighting - digits

Modulo with weighting - products

Only modulo has only two specific parameters:

Divisor

Offset

Modulo is an operation in which one integer (dividend - input number) is divided by an-
other (divisor) and the result is the remainder. The Offset is subtracted from the remainder
finally.

Digits in conversion Specifies number of digits on the output.

Weights / Correction Modulo with weighting has two additional parameters:

Weights

Correction

As a first step, the input number is taken digit by digit and multiplied with single groups
of digits (between dots - like 2.3.4.5 for example) of weighting.

The weights are multiplied with input number - the first digit in weights is multiplied with
the last digit in the input number, the second digit in weights is multiplied with the digit
that is second from right in the input number etc.). When the number of digits in weights
is lower than the number of digits in the input number, then a weight of 1 is used for any
remaining digit in the input number.

297
6 Data Processing Modules

Differences for products and digits:

products - when multiplying, all digits of single results are added together and
then all summarized

digits - all results are summarized without any previous changes

Import PNA file Loads a PrintNumbers (member of the PrintNet 3 software suite) algorithm
from external file.

Example Modulo with weighting digits

For instance, when weights are 2.3.4.5 and the input number is 456789, then the following
computation is made:

SumRestDevided( 9 * 2, 10) = 9 // first digit in the weights x last digit

in input, i. e. 2x9=18, 1+8=9
SumRestDevided( 8 * 3, 10) = 6 // second digit in the weights x second di
git from the right in input, i. e. 3x8=24, 2+4=6
SumRestDevided( 7 * 4, 10) = 10 // ... etc.
SumRestDevided( 6 * 5, 10) = 3 // ... etc.
SumRestDevided( 5 * 1, 10) = 5 // no remaining number in weights is avail
able, so 1 is used for weight
SumRestDevided( 4 * 1, 10) = 4 // no remaining number in weights is avail
able, so 1 is used for weight
ABS ((37 + 0 ) MOD 10 - 0) = 7 //then sums of all intermediate results is
computed and modulo is computed, i.e. 9+6+10+3+5+4=37; 37 mod 10 is 7

These results are summarized and correction is added. The rest is done in the same way
as in Only modulo.

Conversion table is a table that defines values into which all the possible results of selected al-
gorithm will be converted.

In other words: the conversion table is a table of all possible calculation results and their con-
verted obverses.

Example Calculation of Only modulo

Divisor is 10, Offset set to is 3.

Input number = 12345

298
 6.20 Data Transformer Module

12345 MOD 10 = 5

5-3=2

According to the set Conversion table:

2 will be converted to 6....

the result of the whole operation is 6.

In the Test window you can test how the algorithm calculates check digit number.

6.20.2.25 PrintNet 3 FCVs

This option is obsolete. It is only for compatibility with PrintNet 3.

6.20.2.26 Number to Spell

Number to spell feature enables you to express numbers in words in all main world languages,
i.e. convert an integer number into a string expression.

This function can be useful in financial environment, for instance, where you need to express
a number both in digits and words to achieve preciseness. You can also define your own rules
for converting numbers into words.

Clicking on the 3 Dots icon opens the Number to spell dialog.

The dialog can have two tabs: Settings and User rules; the second only if the User rules option
has been selected.

299
6 Data Processing Modules

Settings Tab

Options Description

Rules

Predefined Uses default language rules for the language selected in the combo-
box below. The list of languages is taken from the ICU (International Components
for Unicode) locales and not all of them are supported, the supported languages
are listed in the language codes section.

User rules When checked, a new tab opens and enables you to set your own
rules or edit the predefined rules. For more details see User rules tab.

Spaces

No change Leaves the words as they are set by default.

Remove spaces Removes spaces between words constituting the number.

Replace by hard space Places hard spaces between the words constituting the
number.

Replace by When checked, enables you to enter any sign into the edit-box below,
which will be inserted instead of spaces.

Test Enables you to enter a testing number and see the result of the conversion.

300
 6.20 Data Transformer Module

User Rules Tab

To set your own rules you need to check the User rules option on the Settings tab and then
go to the tab User rules, which appears.

Options Description

Use Language Rules Displays the default rules for converting numbers into the selected
language and enables you to edit them.

Load User Rules Enables you to load an external file (.NMB file) containing rules for
conversion (needs to be in the same format like the predefined rules).

See also the example in the section How to Create Numbering Style in Imported RTF and
DOC Files.

Save User Rules Saves the selected language rules.

Check User Rules Checks the syntax of the language rules.

Use Predefined Rules Enables you to select from these predefined rules:

Arabic to Roman Number Selects conversion of the Arabic numerals into Roman.

English Ordinal Selects conversion of cardinal numbers into ordinal.

Czech Ordinal Selects conversion of basic Czech numbers into ordinals.

6.20.2.27 Spell to Number

Spell to number feature enables you to express words in numbers in all main world languages,
i.e. to convert a string expression into an integer number.

301
6 Data Processing Modules

You can use this option to convert the spelled number parsed in the Text In Rect module into
a number in a formatted document. It can be useful in financial environment.

Options Description

Output Type Enables you to specify the required output data type.

Locale Enables you to select a language and national convention for a number format. The
list of languages is taken from the ICU (International Components for Unicode) locales
and not all of them are supported, the supported languages are listed in the language
codes section.

6.20.2.28 Arabic to Roman Number

Changes the Arabic numbers into Roman numbers, e.g. number 4 into IV. This could be handy
in distinguishing between more rows of numbers, e.g. for charts, pictures, appendixes etc. No
settings are required.

See also the Bullets and Numbering section for details on how to create a numbered list, the
numbers of which you can later change to Roman style.

6.20.2.29 Letter Indexing

Letter indexing converts numbering (numbers of integer type) into letters in the following way:

See also the Bullets and Numbering section for details on how to create a numbered list, the
numbers of which you can later convert to letters.

Clicking on the 3 Dots icon opens the Letter indexing dialog.

302
 6.20 Data Transformer Module

Options Description

Letters Enables you to select Uppercase or Lowercase style for the letters.

Indexing mode Enables you to select one of these two indexing modes:

A, B AA, AB This mode will give the following results: 28 = AB, 29 = AC, 30
= AD ... 53 = BA, 54 = BB, 55 = BC etc.

A, B AA, BB This mode will give the following results: 28 = BB, 29 = CC, 30
= DD ... 53 = AAA, 54 = BBB, 55 = CCC etc.

Test Enables you to enter a testing number and see the result of the conversion.

6.20.2.30 Line Data Formatting

Line Data Formatting field converter enables finding certain strings in the line data defined by
their start and end and changing them to text for variable formatted flow.

Options Description

Prefix Enables you to enter tags (commands) in front of the ones processed by the converter,
e.g. <font name=Arial>.

New line replace with Enables you to enter the line break tag, <br> by default.

Replacement table Enables you to define the strings for which the start and end should be
replaced by the tags.

Find Start Specify by what character begins the string that you want to modify.

Find End Specify by what character ends the string that you want to modify.

Note If there have been the same characters entered to the Find Start and Find
End fields, the odd occurrences will be interpreted as the beginnings and the even
occurrences as the ends.

Replace Start Specify by what tag the beginning of the string should be replaced.

Replace End Specify by what tag the end of the string should be replaced.

Auto Close If set to Yes, it closes all opened tags (the modification is applied) at the
end of the line or before the "\n" line break, if it appears in the line.

303
6 Data Processing Modules

If set to No, it disregards all opened tags (the modification is not applied) at the end
of the line or before the "\n" line break, if it appears in the line.

The replacement can continue anew on the new line provided that the Find Start
character appears there.

Example An address is coming from the line data as two strings:

!Pelucca Gerald
Auwisstrasse 30\n9630 Wattwil !CH!

The Line Data Formatting settings are as follows:

When an exclamation mark is found it means that the string behind will be in
bold.

Auto Close set to Yes:

The result will look as follows:

<b>Pelucca Gerald</b>
Auwisstrasse 30<br>9630 Wattwil <b>CH</b>

Auto Close set to No (other settings same as above):

The result will look as follows:

<b>Pelucca Gerald
Auwisstrasse 30<br>9630 Wattwil <b>CH</b>

6.20.2.31 Image Page Counter Int

Image Page Counter is used for retrieving information about how many pages a multi-page
image file contains.

It supports not only PDF but also other image file formats such as TIFF or PS. The variable in
which you apply this converter has to contain the name of the image file and the path to it,
i.e. it can be applied to a String variable only. As an output you will obtain the total number
of pages, the return value is an Integer.

Clicking on the 3 Dots icon opens a dialog with the Try PS files first check-box. This
functionality is useful for .PS files. As Inspire Designer is unable to distinguish between EPS and
PS formats and EPS files can have only one page, the Image Page Counter always returns the
value 1, even in case of multipage PS files. If the option is checked, the file is first read as PS
file and the Page Counter returns a correct value.

This functionality can be useful in scripting. For an example of use see the section How to
Create an Image Page Counter.

The same functionality can be achieved by the scripting method ImagePageCount.

304
 6.20 Data Transformer Module

6.20.2.32 File Content

Returns content of a file in a variable. As input you set the name of the file, as output you get
a string with the file content. See the File Content Example.

6.20.2.33 Max Image Color Saturation

Returns the maximum image color saturation in a variable. It can be used for all image docu-
ments supported by Inspire Designer (e.g. PDF, AFP) except for TNO (Inspire Designer's own
output file). The value is counted as the maximum difference between individual RGB color
components. The result is zero for grayscale and black and white images and up to 255 for
color images and is therefore suitable for differentiating between grayscale and color pages.

By adding a colon with a page index to the end of the file path you can get maximum image
color saturation value for a particular page. For example, if the input variable contains file-
name.pdf:3 the maximum image color saturation value for the third page of the document
will be returned.

6.20.2.34 Force Visual Order

Useful for text strings in languages with right-to-left writing order. If applied, the text string
will be marked as being in visual order (i.e. running visually correctly from right to left) and the
sequence of characters will not be changed by the BiDi algorithm (used for correct displaying
of bi-directional text) further in the workflow.

6.20.2.35 BiDi - Visual to Logical

Useful for text strings in languages with right-to-left writing order. If applied, the inverse BiDi
algorithm is used to transfer the data in the variable from visual order (data in right-to-left
reading order) to logical order (data in processable order).

Note The specification of the inverse BiDi algorithm is not exact enough to guarantee a
flawless conversion in all cases.

6.20.2.36 From Base64

Converts input data encoded in Base64 to binary type.

6.20.2.37 From Hex

Converts input data in hexadecimal encoding to binary type.

6.20.2.38 To Binary with Codec

Converts input data to binary type. Select the data encoding type from the dialog that opens
after clicking on the 3 Dots icon.

305
6 Data Processing Modules

6.20.2.39 To Base64
Input data is converted from binary type to string using the Base64 encoding.

6.20.2.40 To Hex
Input data is converted from binary type to string using the hexadecimal encoding.

6.20.2.41 To Latin1
Input data is converted from binary type to string using the ISO 8859-1 encoding.

6.20.2.42 Encode Binary

Input data is converted from binary type to string using the codec selected in the dialog that
opens after clicking on the 3 Dots icon.

6.20.2.43 Confidential
Enables you to display data as confidential (hide data), i.e. replace them with defined characters
in the final output. This can be useful for sensitive data that should not be visible, e.g. PINs can
be displayed as ****.

Clicking on the 3 Dots icon opens the Confidential dialog:

Options Description

Usage Select when the conversion will be applied:

Never The defined character will never replace data in Proof or Production.

Always The defined character will always be displayed instead of data in Proof
and Production.

Proof only The defined character will be displayed instead of data in Proof only.
This is the default option.

Tip This option can be suppressed by the Keep data confidential option in Pro-
duction.

Replace character Enables you to define a character (only one type) that will be used instead
of data.

Note When data is set as confidential and this data is used in graphs, data in graphs is not
confidential, i.e. it is always visible.

306
 6.21 Data UnGroup Module

6.20.2.44 DirectSmile
This field conversion enables you to add personalized images to your layout. The service is
provided by DirectSmile.

In the DirectSmile dialog you fill in the connection details provided by DirectSmile and select
the image set you want to use. The variable is then used in a variable image in Layout. Inspire De-
signer connects to the server and downloads a personalized image for each record.

Options Description

URL Sets the URL of the server from which the images are downloaded.

User Enables you to enter the provided user name.

Password Enables you to enter the provided password.

Used set Select an image set from the combo-box. Previews are available in the drop-down
menu next to the set name and when hovering the mouse cursor over the combo-box.

6.21 Data UnGroup Module

The Data UnGroup module removes any grouping performed with either the DataGroupBy
Module module or the 1-Many Merger Module module. It moves fields in a child array up to
the parent array and creates a complete record of parent-and-child array for each record in
the child array.

You apply the Data Ungroup by adding the module to the workflow and connecting it to your
data source. In the parameters of the module, select the array you wish to ungroup.

Note If the amount of data you process is too large for the available memory, it is recommen-
ded to uncheck the Read complete record data into memory check-box in the Current

307
6 Data Processing Modules

Workflow Options dialog. The Data UnGroup module will then use disk space for storing the
data.

To display the Data UnGroup panel where you can change the parameters of the Data UnGroup
module, either double-click on the module or right-click and select Edit Module.

Example Consider the following example. Your workflow consists of 2 Data Inputs: a
list of clients and a list of stocks owned by each client.

When your data structure is merged, it becomes an array of clients, with each client in-
cluding an array of stocks, as shown below.

308
 6.21 Data UnGroup Module

1. Client A

Stock 1
Stock 2

2. Client B

Stock 1
Stock 2
Stock 3

After placing the Data UnGroup in your workflow path and selecting the Stocks array to
ungroup, your data appears as follows. Notice that the CustOption, Code, StockName,
Volume, Price, and Weight fields are in the Clients array.

309
6 Data Processing Modules

1 Client A Stock 1
1 Client A Stock 2
2 Client B Stock 1
2 Client B Stock 2
2 Client B Stock 3

6.22 Email Gateway Data Module

The Email Gateway Data module is a link between Inspire Designer and Inspire Email Gateway.
Data used in the Inspire Designer workflow are reorganized here and generated as a CSV file
ready to be fed to Inspire Email Gateway.

The module takes data from the data input module(s) used in the workflow and the output
CSV file is generated using a Data Output module (which is automatically added with the Email
Gateway Data Module).

Note Make sure the field separators and the text qualifiers defined in the Inspire Designer
data output and Inspire Email Gateway (on the Sources tab) are the same.

310
 6.22 Email Gateway Data Module

Options Description

Parent Array Specifies the data array used. Open the combo-box menu and select the ap-
propriate array from the drop-down menu.

EG Field Name Lists all fields' names that constitute the output CSV files header. The ToMail
field (containing the target email addresses) is mandatory. All the fields are in detail de-
scribed in the Inspire Email Gateway user manual.

Constant Value Defines non-variable values for each field. Clicking on the 3 Dots icon,
or selecting a row and pressing the <F2> key, allows you to edit the field.

If there need to be multiple constant items in one row, each has to be entered in single
quotation marks (') and separated with a semicolon (;), e.g.:
'[email protected]';'[email protected]'.

Variable Defines variable values for each field. Open the drop-down menu and select a
variable.

Note If both, a constant value and a variable, are defined for a single EG Field, the
variable value is used. If the defined variable returns no value for the given record(s), no
value is used.

311
6 Data Processing Modules

6.23 MinMax Generator Module

See also:
MinMax Generator Module Command
Line Parameters

Using this module you can get the minimum and maximum lengths (in characters) of the fields
used in input data. This information can be useful for example for dimensioning the address
fields, tables column's widths etc.

How it works:

Insert the MinMax Generator between the DataInput and Layout modules.

Specify the MinMax Generator parameters.

Options Description

Enable Generator MinMax generator only works when this check-box is checked. When
unchecked, the workflow will not use the MinMax Generator. The disabled status is indic-
ated by the connection line drawn over the module.

Hide Text When checked, all the real characters will be replaced by the selected Replacement
character, an asterisk in our example.

Numeric Evaluation If checked, the content of a number will be compared.

312
 6.23 MinMax Generator Module

Example

Numbers 15 and 20 are different as for the content because 20>15. If the
option is not checked, the string length of a number will be compared.

Numbers 15 and 20 are equal as for the string length. Both consist of two
characters.

Note This function is intended only for variables of number type only. Variables of String
type are not affected by this option, i.e. they are always compared by their length.

Example We have several variables: Name, Surname, Street, Zip and Town coming from
data file. We use them in Layout in the address flow area:

When the MinMax generator is enabled (inserted before the Layout module in the work-
flow), the output will be as follows:

Sheet 1 - Minimum lengths

The address flow on the first sheet consists of the minimum lengths for each variable
combined in one address field i.e. shortest Name, shortest Surname etc.

Sheet 2 - Maximum lengths

The address flow on the second sheet consists of the maximum lengths for each variable
combined in one address field i.e. longest Name, longest Surname etc.

Note The address displayed on these two sheets will likely be invalid since its components
(Name, Surname...) may not come from the same records!

313
6 Data Processing Modules

6.24 PDF Data Module

In this section: See also:
Input File Tab How to Split PDFs and Insert Bookmarks
Bookmarks Tab
Page Boundaries Tab

The PDF Data module is useful for:

Reading the document outline of a PDF file and creating a corresponding array as part
of the input data variables,

and/or

Reading page boundaries data contained in an imported PDF file. The page boundaries
in PDF files are defined as page boxes, e.g. Media box or Crop box. Individual page
boxes specified on the page serve to define, for example, the part of the page that
would be displayed on a screen, or the boundary, where a printed page would be
trimmed.

The PDF Data module takes the data from a PDF file content defined as a variable, typically via
the Param Input module. The extracted data can be used directly in Layout, Inspire Native
module and/or in impositioning. You can also proof/generate the data via the Data Output
module.

314
 6.24 PDF Data Module

You can view the data in Proof (the screenshot below shows the top and the bottom of the
Data Proof view; the dashed line indicates the page boxes data not shown):

Legend

1. The document outline (bookmarks) data and the page boundaries data are grouped
in two separate arrays.

2. Media box values are obligatorily defined for every page.

3. Crop box either has its own values or it inherits values of the Media box. Art box, Trim
box and Bleed box either have their own values or they inherit values of the Crop box.

4. Page rotation keeps the original values (0, 90, 180 or 270) if the PDF coordinate system
and measures are used. In the Inspire Designer coordinates system, the rotation value
is 0, as rotated pages are then imported with the rotation already applied.

The PDF Data module has three tabs:

Input File

Bookmarks

Page Boundaries

315
6 Data Processing Modules

6.24.1 Input File Tab

The PDF Data module filters either the string type variables or binary type variables. The below
screenshot shows just one possible selection of a string type field (PDFFile) but there may be
many to choose from, depending on the data input file. You can only select one field to be
used at a time.

Click on a variable to select (highlight) it.

6.24.2 Bookmarks Tab

The document outline (in Inspire Designer called 'bookmarks') is a PDF file feature that can be
displayed alongside the pages in a PDF viewer and allows quick interactive navigation through
the pages and chapters.

Options Description

Read from PDF Check to enable the document outline reading (from the PDF file defined
in the Input File tab) and create, in the generated data file or directly in Layout, the docu-
ment outline data array named in the edit-box below.

Bookmarks in array Names the array that will contain the document outline. The field be-
comes editable, when a string or binary type variable is selected; a suggested name based
on the field location will appear as default.

The bookmarks sub-array created by the PDF Data module is displayed within the array for your
Data Input, under the Data node, in the Layout Tree.

316
 6.24 PDF Data Module

This array contains variables that correspond to the imported PDF bookmarks format:

Title Represents the name of the Bookmark in the PDF file.

Level Indicates its level on the Bookmark structure tree (e.g. Level 0 as Section 1 and
Level 1 as Sub-Section 1.1 of a document).

Action Type It is the command executed when a user clicks on a bookmark in a PDF
file in a PDF viewer. Usually it is the PDF format GoTo command (meaning 'go to page
number xx') working as a link.

Page Represents the number of the page, in the PDF document, that the command
is linked to. The number is zero based, i.e. starts 0,1,2, in case the bookmark points
to an existing page. If the bookmark points to an nonexistent page, it references the
page -1.

These variables can be used as you require them: for charts, reports, statistics, data outputs,
etc.

6.24.3 Page Boundaries Tab

In this tab you can define the positioning and clipping of page boxes.

Options Description

Read from PDF Check to enable the page boundaries reading (from the PDF file defined in
the Input File tab) and create the page boundaries data array.

Boundaries in array Define the array that the page boundaries will be written to.

Coordinate System and Units

Choose between two coordinate systems:

Recalculated The vertical (Y) coordinate values increase from the top of the page to
the bottom. The horizontal (X) coordinate values increase to the right. The Inspire De-

317
6 Data Processing Modules

signer reference point (at the top-left corner of the page) will be used for determining
the objects' positions on the PDF page in Layout. This system is selected by default.

The reference point can be:

Based on crop box

or

Based on media box.

Note Make sure, that the reference point setting selected above matches the one
in Layout, when employing the values in a new document. If not matching, the objects'
positions might not be applied correctly.

This system's unit is metre [m].

Original If selected, the PDF standard coordinates system is used (with the reference
point at the bottom-left corner of the page).

The vertical (Y) coordinate values increase from the bottom of the page to the top.
The horizontal (X) coordinate values increase to the right.

This system's unit is the default PDF unit [pt].

Example
The differences in defining objects' positions on a page are shown in the two
images just above. On two identical pages the same point's position would be
described differently:

1. In the Recalculated (Inspire Designer) system the blue point's Y coordinate

value is '1'

318
 6.25 PCL Data Module

while

2. In the Original (PDF) system the blue point's Y coordinate value is '4'.

Clip boxes by media box If selected (by default), any page objects (boxes) reaching
beyond the media box, will be clipped. Uncheck to ensure the full original data.

6.25 PCL Data Module

In this section: See also:
Input File Tab Native Files Import
Data Tab PCL Native Import and its Known
How to Use PCL Data Module Limitations

The PCL Data module is useful for parsing PCL commands and PJL commands of the 'SET' type.
The values, i.e. page side, duplex type, page size and tray information, can be used in the
workflow, e.g. to add a logo on each front page or add an advertisement page behind each
back page when printing a duplex PCL file imported natively.

The PCL Data module has two tabs:

Input File

Data

6.25.1 Input File Tab

The PCL Data module can receive string type variables, the value must be the name of the PCL
file (with the path). The screenshot below shows just one possible selection of a string type
field (from a Param Input module) but there may be many to choose from, depending on the
data input file. However, you can only select one field to be used at a time.

Click on a variable to select (highlight) it, then the PCL Data in array is pre-filled on the Data
tab.

319
6 Data Processing Modules

6.25.2 Data Tab

On the data tab you can select, what information should be extracted from the PCL specified
on the Input File tab.

Options Description

PCL Data in array The name of the array will be pre-filled based on the selection on the Input
File tab, but you can change it to any other name that suits your needs.

Page side and duplex type Check the option, if you want to get the information about
page side (front, back) and duplex type (simplex, duplex short/long edge) from the PCL
file.

PageSide returns the Front or Back value.

DuplexType returns the Simplex, DuplexLongEdge or DuplexShortEdge values.

Page size Check the option, if you want to get the information about page size.

PCLPageSize returns the ID of the page size as defined by the PCL specification.
It is also defined as paper size in the Workflow Options dialog.

PCLRotation returns the value according to the portrait/landscape orientation,

including their reverse forms.

TranslatedPageSize is available only if the PCLPageSize is recognized (page sizes

defined in the PCL specification are recognized). The x and y dimensions are then
displayed.

Trays information Check the option, if you want to get the information about input and
output trays. If no information is available, no value is displayed.

320
 6.25 PCL Data Module

6.25.3 How to Use PCL Data Module

One of the use cases can be that you want to add an image (e.g. a logo) on each front page
when printing a duplex PCL file. In such a case you can use a workflow like the one in the
screenshot below to load the PCL natively and at the same time parse the PCL data.

1. The PCL Data module takes the data from a PCL file specified typically via the Param
Input module.

2. Configure the PCL Data module, i.e. select the NewField0 on the Input tab and check
the options on the Data tab (at least the Page side and duplex type option).

3. Add the Layout module to your workflow and add the logo at the desired position.

The page logic in Layout is based on the values of the PageSide and DuplexType variables
created by the PCL data. If it is duplex and front page at the same time, the page with
the logo will be displayed (and later mixed with the PCL content imported natively),
otherwise a blank page is displayed.

321
6 Data Processing Modules

4. Add an Inspire Native module to your workflow and configure it to load your PCL file.

5. Add a Sheet Mixer module to your workflow to mix the content coming from the inputs
together, i.e. to put the page with the logo from Layout together with the pages of
the PCL imported natively.

6. Add an Output module to your workflow and proof the workflow and check the result
in Proof.

Tip You can view the data created by the PCL Data module in Data Proof.

6.26 Personalized URL Module

See also:
Personalized URL Module Command Line
Parameters

With the Personalized URL module, the information from input data file can be used for creating
a personalized URL for each record with the help of the service provided by MindFireInc. For
more information on this service see the MindFireIncs web site.

This module links your input data with variables available in MindFire and sends them to the
MindFire web service. The web service creates a personalized web page for each record (based

322
 6.26 Personalized URL Module

on the data entered) and returns their URLs together with access passwords. The URL and
password variables are added to the data structure when the module is connected to a workflow.

The URL pattern is based on the mapped variables and MindFire tries to find the best looking
pattern possible. If you, for example, map first name and surname the pattern will look as fol-
lows: name.surname.campaignname.com.

For configuration the following tabs are available:

General tab

Settings tab

6.26.1 General Tab

The purpose of the General tab is to link the variables from your input data, that you want to
use for creating a personalized URL, to the variables available in MindFire. When the workflow
is run, the MindFire variables are filled with your data and on the basis of this data personalized
web pages are created.

The tab has two main areas: the left-hand area shows the structure of the input data; the right-
hand area displays variables available in MindFire.

323
6 Data Processing Modules

Options Description

Running Mode Selects the modules running mode. The options are:

Offline demo This mode does not call the MindFire web service when the workflow
is run; the URL suffix defined on the Settings tab is used. The generated URLs and
passwords are not valid in MindFire, they are purely for testing purposes.

Run Runs the module, consults the content of the cache file and, if there are
new contacts in the input data, they are added to the selected MindFire campaigns
list. The MindFire web service generates and returns new URLs and passwords for
them.

Clear and run Clears the local cache and also the MindFire campaigns list and
creates new URLs and passwords for all records in the input data.

Set Creates a link between the selected variables.

Unset Breaks the link for the variable selected in the Variables area.

6.26.2 Settings Tab

The Settings tab defines the necessary settings that make the module work: web service settings,
campaign definitions, data file location, etc. If you will repeatedly use the same values it is
possible to set them in the Workflow Options dialog and they will be filled-in automatically
when the module is connected to the workflow

324
 6.27 Record Filter Module

Options Description

Web Service Section

URL Defines the URL of the MindFire web service.

Client key Enters the client key for the web service provided by MindFire.

Campaign Section

Reload Campaigns Refreshes the list of campaigns that you have created in MindFire.

Campaign Selects the campaign to which you want to add your contacts.

Reload Lists Refreshes the list of your MindFire campaigns - lists can be imagined as
directories inside the selected campaign.

Lists Selects the preferred list.

Local Cache Section

Location Defines the location of the local cache file. The response from MindFire (URLs,
passwords) is stored in this cache file - if you proof the workflow and the input data
has not changed, the cache content is used instead of calling the web service.

Upload File Section

Local Defines the location of the data file locally.

URL Defines the URL address of the data file (on ftp or htp). The data file must be access-
ible from the Internet.

Name Defines the username used for access to the ftp or htp.

Password Defines the password used for access to the ftp or htp.

Demo Mode Section

URL suffix If the module is run in the offline demo mode, the URL suffix defined in this
edit field is used for creating personalized URLs for the records.

6.27 Record Filter Module

See also:
Record Filter Module Command Line
Parameters

325
6 Data Processing Modules

The Record Filter Module enables you to select records, based on their index number, so they
can be passed through the filter. To display the panel where you can set the parameters for
this module; either double-click the module or right-click and select Edit Module.

Options Description

Input file Enables you to upload an input file containing a record filter by entering its full
path name or by using the Browse icon to navigate to its location. The content of such
a text file has the index number of each record you want to pass the filter, each number
on a new line.

Example The second, the third and the sixth record would pass the filter in the
below mentioned example.

326
 6.28 Data Center Merger Module

Refer to the topic How to Use Error Recovery for an example of how you can generate
the input file.

Don't pass through records which are in file If checked, all records except those identified
in the input file will pass through the filter.

Text encoding Selects the codec to be used to read the characters in the input file.

See the separate chapter on Text Encoding.

Filter Enables you to set a record filter by typing the index numbers you want to pass the
filter. Separate the values or range of values by a semicolon. E.g. entering "0-2;4" will
make the first three records and the fifth one to pass the filter.

Note The first record in your database has the index number "0".

6.28 Data Center Merger Module

See also:
Data Centers

The Data Center Merger module combines any data in a workflow with data from a data
center in a one to one relationship.

Records from the input connector to the module are matched with records from a data center
config using an Id field (that must exist in a data center config) and the field structure is com-
bined, so that one record contains all fields. This is the same type of merging as is done by the
1-1 Merger Module, see the section Data Merging Modules Comparison to contrast the different
types of data merging.

Inspire Data Centers are managed by the related application Inspire Content Manager and you
must be logged in to Inspire Content Manager (VCS) to be able to use the data from any data
center that has been created there. In addition, you must create data center configs in the Data
Center Config module to the workflow and configure it before you can use this merger module.

327
6 Data Processing Modules

Options Description

Data from Input Selects the field from the input data which returns strings that are
identical to those in the Id field from the data center config.

In any data center config, a field named Id exists, even though it is not shown in Data
from Data Center table in this module. It is a field with unique values for each record
and is used to identify each record. Therefore, the input data must have a field with values
that match those values in that Id field.

Only one field is required, click on a field it so that the Key icon shows. This indicates
that it is the Id field.

Type Lists the data-type of each of the fields from the input.

Data Center config / Data from Data Center / Type Selects the data center config and
fields from it so that they can be edited. This part of the module is the same as in the Data
Center Input module, see that section for a description.

Allow unmatched ids If checked, determines that it is correct behavior if there are records
from the data input that were not matched to any record from the data center config.

The unmatched fields from the input are then passed to further modules. Any unmatched
fields from the data center do not pass further.

328
 6.29 Social Data Connector Module

6.29 Social Data Connector

Module
See also:
Authentication Library Module
How to Auto-Follow on Twitter

Social Data Connector reads data from and sends data to Facebook or Twitter.

A basic function is to send personalized messages as tweets or status updates. But a further
intention is to read data from your account (and connections to it) so that it can be analyzed,
then profile-targeted, personalized messages be sent back via that account or others. Codes
for Inspire Designer to access different user accounts must be entered and stored in the separate
Authentication Library module and then each of those accounts can be communicated with
by using different Social Data Connector modules. You can build up a structure of data retrieved
from those accounts and manipulate it, e.g. using other data processing modules or splits in
data centers.

There are two types of query to social networks that this module performs:

1. Those that send data from a workflow to an account, e.g. Tweet or Update status.

In return, an id for the communication is read from the account and is added to data
structure that is passed out of this module.

2. Those that read data via an account to the workflow, e.g. Get my friends or Get tweets.

This adds many fields to the data structure that is passed out of this module. The fields
are filled with the data retrieved if the account has the information available, i.e. fields
may be empty.

Note

In order for this module to work, you must be connected to the internet.

Facebook and Twitter impose limitations on access to their APIs. This includes numbers
of API calls and messages that can be sent in any given period. These limits are subject
to change.

If you send or download a high volume of information or messages, it is likely that you
will encounter these limits and action may be taken to restrict further access via your
account. Therefore, please research the current limitations via the developer's websites
of these social sites before using this module, e.g. read the API related info at either
http://developers.facebook.com/docs/reference/api/ or http://dev.twitter.com/docs.

329
6 Data Processing Modules

Options Description

Social Network Selects whether the module will connect to Facebook or Twitter when the
workflow is processed.

Authentication Selects which account will be used to connect to Facebook or Twitter, from
the accounts that have been authorized in the Authentication Library module.

Alternatively, selecting Variable selection determines that the account will be chosen by
the Query Parameter OAuthName, i.e. it can be variable according the values returned
by a field read into this module.

If Facebook is selected for Social network, only accounts from the Facebook tab will be
available; and if Twitter is selected, only accounts from the Twitter tab will be available.

Query Selects which action the module will perform when it connects to the Facebook or
Twitter.

If Twitter is selected for Social network, select from: Follow, Follow by id, Get favorites,
Get followers, Get followers by id, Get friends, Get friends by id, Get mentions, Get
retweets, Get retweets by messageid, Get tweets, Get tweets by id, Get user info, Get
user info by id, Send direct message, Send direct message by id, Tweet.

If Facebook is selected for Social network, select from: Create my post, Create post on
id, Get activities by id, Get albums by id, Get events by id, Get events info by id, Get feed
by id, Get friends by id, Get group members, Get interests by id, Get likes by id, Get likes
count by id, Get my activities, Get my albums, Get my events, Get my feed, Get my friends,
Get my interests, Get my likes, Get my photos, Get my user info, Get photos by id, Get
post info by id, Get user info by id, Update my status, Update status by id.

These query names have been derived from the terminology used by either Facebook or
Twitter and you should be familiar with those social sites in order to know which queries
you want to perform. Some queries send data (e.g. posts) to the site and others retrieve
information about account holders. Once a query is selected, related properties can be
added to that query via the table in the Data Definition section below.

330
 6.29 Social Data Connector Module

Data Definition

Array Selects which array will be used to select fields from (in the Field column) and/or
add new fields (created by this module) to.

Query Parameter Lists the parameters of the query selected for Query that are used
to complete that query.

For Twitter possible parameters are:

count the number of records returned by the query, e.g. if 5 is entered for
Get retweets, information about the latest 5 retweets is read into the workflow.

If no value is added then all occurrences are listed, but this also depends on
the corresponding value given for the page parameter.

display_coordinates a Boolean value (either true or false) for determining

whether to display coordinates.

The account selected for Authentication has to have the Tweet location
feature activated in its settings.

id the user name or user id of the account to get data from for Query: Get
favorites. The message id for Query: Get retweets by messageid.

in_reply_to_status_id the id of the tweet that you are replying to.

lat / long the latitude / longitude of the place (co-ordinates) that the tweet
refers to.

These parameters will be ignored unless they is inside the range -90.0 to +90.0
(North is positive) inclusive. It will also be ignored if either lat or long parameters
are not present.

page the number of the results page which you would like to retrieve the
results from.

The number of records returned by a query (e.g. number of favorites) is divided

into pages. The size of a page is determined by the count parameter, but is
20 if count is left empty. This parameter determines which page of those results
you require. Page 1 is the most recent.

This can be an important parameter because each page of information in

treated as a single API request and there is an hourly limit on the number of
API requests you can make to Twitter.

Example A user has favorited 357 tweets and the Query: Get favorites
is used.

Leaving page parameter empty will return data about all 357 favorited
tweets, but entering 2 for page and 50 for count will return data on the
51st to 100th most recent favorited tweets.

If both page and count are specified, the query retrieves the specified page
with that number of records on it, but the max per page count is defined by
Twitter, i.e. 200 records.

331
6 Data Processing Modules

place_id an identification number for a place in the world.

These IDs can be retrieved via Twitter from the database geo/reverse_geocode.

screen_name the user name of the account which you want to take the data
from.

status the text of the tweet that you want to send. Maximum of 140 char-
acters.

text the text of the message that you want to send. Maximum of 140 char-
acters.

user_id the id of the user account which you want to take data from or send
a message to.

For up-to-date info on Twitter API properties and parameters, try: http://dev.twit-
ter.com/docs.

For Facebook possible parameters are:

actions a list of available actions that can be performed on the post, com-
menting, liking etc. A JSON object (JavaScript Object Notation) containing the
'name' and 'link'.

You need to know how to write JSONs in order to use this parameter.

Example A JSON for the actions parameter, with two different actions
included: Comment and Like.

[{ "name": "Comment", "link": "http://www.face

book.com/100000011057850/posts/116802665064160" }, { "name":
"Like", "link": "http://www.face
book.com/100000011057850/posts/116802665064160" }]

caption the text for the subtitle of a post, e.g. Caption of the link in the ex-
ample screenshot below.

description the text of the post, e.g. Cool description of the link in the ex-
ample screenshot below.

id the account id that you want to communicate with, e.g. make a post on
their wall or retrieve data from.

link a link that is contained in the post. The link is activated when clicking
on the name of the post.

message the text of a status update or a message that comments on the

post, e.g Check out this coll post in the example screenshot below.

name the text for the title of a post. It will be highlighted blue and can
contain a link, e.g. Name of the link in the example screenshot below.

picture the web address (URL) for a picture for the link, e.g. the Google logo
in the example screenshot below.

332
 6.29 Social Data Connector Module

privacy the privacy settings of a post.

The value entered here may be: EVERYONE, ALL_FRIENDS, or

FRIENDS_OF_FRIENDS.

Also JSON objects can be used containing the value field with CUSTOM or
NETWORK_FRIENDS as the value, and optionally friends, networks, allow
and deny fields.

The friends field must be specified if value is set to CUSTOM and contain
one of the following JSON strings: EVERYONE, NETWORKS_FRIENDS (when
the object can be seen by networks and friends), FRIENDS_OF_FRIENDS,
ALL_FRIENDS, SOME_FRIENDS, SELF, or NO_FRIENDS (when the object can be
seen by a network only).

The networks field may contain a comma-separated list of network IDs that
can see the object, or 1 for all of a user's networks.

The allow field must be specified when the friends field is set to
SOME_FRIENDS and must specify a comma-separated list of user IDs and friend
list IDs that 'can' see the post.

The deny field may be specified if the friends field is set to SOME_FRIENDS
and must specify a comma-separated list of user IDs and friend list IDs that
'cannot' see the post.

source a URL to a Flash movie or video file to be embedded within the post.

targeting the location and language restrictions for page posts only. A JSON
object containing comma separated lists with fields country, city, region
and locale.

Example

This is a post made using Rodrigo Jimenez's Facebook account as the Authen-
tication and the Query as Create my post. This post appears on Rodrigo's own
wall, but all his friends can see it providing they are permitted to see his wall.

For up-to-date info on Facebook API properties and parameters, try: http://de-
velopers.facebook.com/docs/reference/api/.

Optionality Describes whether the Query Parameter is Required or Optional.

Field Selects the field that contains the value of the Query Parameter.

Any field from the array selected in the Array combo-box can be used, they are
automatically converted to string data-type, as is required for queries to social net-
works.

333
6 Data Processing Modules

Example For the Twitter Query: Get tweets by id, there is a parameter user_id
which is the id of somebody else's account. In a CSV file (which you are reading
into the workflow with a Data Input module) there are the records of many ac-
counts. In it there is a field called Account ID which lists all of their user ids.

By selecting Account ID for Field (for the user_id Query Parameter), all of the
tweets made by the different accounts will be read into the workflow and added
to the records of each corresponding account.

The resulting data structure after the module will be:

Notice how the Account ID field and the Tweets array (which contains details
of all of the many tweets for an account) are on the same level, i.e. there is one
account to one set of tweets.

Default Value Enters a default value that will be used in case a value is not returned
by any field selected in the Field column.

For an example of a workflow which employs the Social Data Connector module, see How to
Auto-Follow on Twitter.

334
 6.30 Text Replacer Module

6.30 Text Replacer Module

The Text Replacer module scans the entire content coming to it from the data input modules
for a specified text string (set in the Input text column) and replaces it with the provided text
(set in the Output text column).

Note Text Replacer is case sensitive.

Example If you replace (c) by , (C) would not be replaced.

Be aware that Text Replacer may cause global changes by replacing all occurrences of the given
string, regardless of which data field it is found in.

Options Description

Input text Enables you to enter a text string to be replaced.

Output text Enables you to enter a text string that should replace the Input text.

Adds a new line for Input and Output text.

Moves the selected pair of Input and Output text up or down.

Deletes the selected item.

Sorts the input text alphabetically. Note that capital letters are listed first and Unicode is
used for sorting (as national alphabets have different sets of characters).

335
6 Data Processing Modules

6.31 Data Merging Modules

Comparison
See also:
1-1 Merger Module
1-Many Merger Module
Data Add Module
Data Combiner Module
Data Concatenator Module

Here is an example set of data and we will compare how it would be handled by the different
types of data merging (or data combining) modules.

Data input A (Clients) has this structure:

Looking at 2 of its fields and 3 of its records, it contains this data:

Surname Id

Novak 852702
Shield 279053
Mirkwood 705404

Table 6.1 Input A

Data input B (Transactions) has this structure:

Looking at 2 of its fields and 5 of its records, it contains this data:

336
 6.31 Data Merging Modules Comparison

Account Id

37146745 852702
23493309 279053
03665759 705404
87959899 426351
80390911 705404

Table 6.2 Input B

1-1 Merger
1-1 Merger would result this structure:

In the module, Id was selected for both inputs as the matching field. The fields from input B
are added to the array from input A. There is only one Id field in the output, so if there is more
than one matching record, only the first matching record will be in the output. Unmatched Ids
from B result in unmatched records that will be lost.

The resulting output from the input data described at the beginning of this section:

Id Surname Account

852702 Novak 37146745

279053 Shield 23493309
705404 Mirkwood 03665759

Table 6.3 Output from 1-1 Merger

Notice how the output data: There are 3 fields which match up one Account to one Surname,
i.e. Id 705404 has two Accounts but only the first appears in the output; Id 426351 is not
matched in A so does not appear in the output.

337
6 Data Processing Modules

1-Many Merger
1-Many Merger would result in this structure:

In the module, Id was selected for both inputs as the matching field. The array from input B is
added inside input A. An Id field appears in both arrays, so more than one Id of the same value
can be input from B. Unmatched Ids from B result in unmatched records will be lost.

The resulting output from the input data described at the beginning of this section:

Id Surname Account

852702 Novak 37146745

279053 Shield 23493309
705404 Mirkwood 03665759, 80390911

Table 6.4 Output from 1 to Many Merger

Notice how the output data: There are 3 fields which can match up multiple Accounts to one
Surname, i.e. Id 705404 has two Accounts and both appear in the output; Id 426351 is not
matched in A so does not appear in the output.

338
 6.31 Data Merging Modules Comparison

Data Add
Data Add would result in this structure:

In the module, there is no need to select matching fields. The array from input B is added next
to input A. All data is in both arrays.

The resulting output from the input data described at the beginning of this section:

Surname Id

Novak 852702
Shield 279053
Mirkwood 705404

Account Id

37146745 852702
23493309 279053
03665759 705404
87959899 426351
80390911 705404

Table 6.5 Output from Data Add

Notice how the output data: Contains all the input data, no matching has been done and
neither set of data is dependent on each other.

Tip In the Layout module you cannot use both sets of data on pages, you can decide which
array the pages will be repeated by option Records by of the Data family or option Repeated
by in the Pages family.

339
6 Data Processing Modules

Data Combiner
Data Combiner would result in this structure:

In the module, there is no need to select matching fields. The fields from input B are added to
the array from input A. Any fields of the same name (i.e. Id for our example) are merged, with
the records from Input B overwriting those from input A.

The resulting output from the input data described at the beginning of this section:

Id Surname Account

852702 Novak 37146745

279053 Shield 23493309
705404 Mirkwood 03665759
426351 87959899
705404 80390911

Table 6.6 Output from Data

Notice how the output data: Contains all the input data from B. The Ids of A has been overwrit-
ten by the Ids of B. The surname The total number of records is the number of records from
the input with the largest number of records.

340
 6.31 Data Merging Modules Comparison

Data Concatenator
Data Concatenator would result in this structure:

In the module, the arrays Records and Accounts were selected for concatenation. The fields
from input B are added to the array from input A. Any fields of the same name (i.e. Id for our
example) are merged, with the records from Input B added after those from input A.

The resulting output from the input data described at the beginning of this section:

Id Surname Account

852702 Novak
279053 Shield
705404 Mirkwood
852702 37146745
279053 23493309
705404 03665759
426351 87959899
705404 80390911

Table 6.7 Output from Data Concatenator

Notice how the output data: Contains all the input data, but no merging has been done and
the total number of records is the total of the records from both inputs.

341
7 Layout Module

7.1 Layout Window Overview

7.2 Layout Window Menu
7.3 Layout Window Toolbars
7.4 Layout Tree
7.5 Layout Properties Toolbar
7.6 Layout Objects
7.7 Layout Options Dialog
7.8 Other Helpful Features
7 Layout Module

7.1 Layout Window Overview

See also:
Layout Window Menu
Layout Options Dialog
Layout Toolbars

The Layout module uses data in order to repeat page designs and create sheets.

When the Layout module is opened from the Workflow Area within the Workflow Window,
by simply clicking on it, the Layout Window is opened. Layout is only one module of a workflow
but is a powerful graphic design center of its own within Inspire Designer.

The Layout Window provides a wide variety of tools to allow you to write, draw, paste, style,
position, insert imported data, declare variables, define relationships between objects etc., all
in order for you to be able to design the pages.

The screenshot of the Layout window below is marked with numbers to help explain the fea-
tures. The key can be found below it.

344
 7.1 Layout Window Overview

Legend

1. The Layout Window Menu drop-down menu to control many of the features of Layout.
Click on the link for a description of the options that can be found there.

2. The Layout Toolbars. These toolbars (above, below and to the side) relate to the many
tools of Layout. They are detachable from the menu frame of the window and can be
placed in your preferred position.

3. The Layout Tree window-pane with the Layout Tree inside. The nodes of the tree are
the contents of the design.

This can be opened or closed by going to: Window | Show Layout Tree.

4. The Layout Properties panel is the configuration of whichever object is currently selected
(either having been selected in the Layout Area or in the Layout Tree). You can use this
to edit or view the attributes of the object.

By default the panel appears underneath the Layout Tree, but it can be dragged and
dropped to another position.

5. The Layout Area with an example layout designed inside.

You can navigate around the Layout Area using the Zooming Toolbar, using the
standard Windows scroll bars (below and to the right hand side of the Layout Area)
and using your mouse with the middle button depressed.

Pressing the mouses middle button grabs the page and moving the mouse will scroll
the page accordingly.

6. If the Flow Area Tool is selected, a right-click within a Flow Area reveals a context
menu. Its options are also included in the Edit menu, the Insert menu and the Format
menu. When other tools are enabled, right-clicking on an object within the Layout
Area opens a context-menu with options included in the Edit menu.

7. The tabs at the bottom of the screen are to aid navigation through the open windows
of Inspire Designer.

Each tab relates to a different environment within Inspire Designer, for example the
Workflow tab is for windows that relate to configuring the modules of a workflow and
the Production tab is for windows that relate to producing some output from workflows.

The tabs are divided, each sub-tab represents one window, clicking on that tab brings
it to the front so that it replaces the previously displayed one and is active for working
with.

8. At the very bottom right of the Layout Window is a useful navigation panel.

345
7 Layout Module

From left to right it shows:

Chars The number of characters remaining between the current cursor po-
sition and the end of the line within the selected flow area. The width of the
character is set in the Layout View section of the Layout Options dialog.

Lines The number of lines between the currently selected line (where the
cursor is placed) and the end of the selected flow area.

Example means that there are 56 characters (or spaces for

the characters) between the cursor and the end of the current line and there
are 3 lines to the end of the selected flow area.

The status of the WFD file in relation to Inspire Content Manager

(VCS) (not logged means that this is not a Version Controlled document).

O The name of the selected object (multi-select means more than one is selected).
If a flow is selected and it contains nested flows it also indicates the count of nested
flows and which of them is selected.

Char If text has been entered and selected in a flow then Char will show to
identify the selected character.

Example means that object Flow1 is selected and

nested flow 4 of 6 is displaying in the Flow Area and the cursor is presently
on text character identity 0x006c.

X and Y Show the coordinates of the mouse pointer measured from an origin
at the top left corner of the page displayed in the Layout Area.

W and H Show the width and height of the object as selected in the Layout Area.

The units displayed to the right (mm in the Layout window screenshot ) relate to the
X and Y coordinates and to the width and height of objects. Clicking on the unit symbol
reveals the measurements menu, where you can choose from: pt, m, cm, mm, in, di,
and px.

Tip The measurements units set in the Layout module are the default media sizes
units in the Output module.

346
 7.2 Layout Window Menu

7.2 Layout Window Menu

In this section: See also:
File Menu Layout Window Overview
Edit Menu Layout Options Dialog
Page menu Layout Toolbars
View Menu
Insert Menu
Format Menu
Table Menu
Window Menu
Help Menu

This section describes the features and functionality of the Layout Window that can be accessed
via the Layout Window's main menu:

7.2.1 File Menu

New Workflow Opens the New Workflow Dialog that offers a choice of templates for
starting a completely new WFD file.

Open Workflow Opens the standard open dialog for you to locate and open an existing
workflow file (WFD).

Close Workflow Closes the active workflow file (that the currently open Layout Window is
a part of) and all windows associated with it.

Close Window Closes the currently selected Layout Window.

Save Workflow Saves the workflow file that the currently open Layout Window is a part
of. You can also use the shortcut <Ctrl>+<S>.

If the workflow file is open in read-only mode, a warning message appears and a Save As
dialog pops up, when you try to save it.

Save Workflow As Opens the standard Save As dialog where you can specify a new location
and name for the workflow file that the currently open Layout Window is a part of.

Export with All Included Opens a standard Save As explorer dialog in order for you to enter
a new name and location for the currently selected active workflow file and includes all
external files that have been used in the workflows construction (e.g. Data files, images)
so that they are part of the WFD file.

However, the original path to those external files will be maintained in the file and checked
every time that the workflow is opened. Therefore, if the file in the original location is
updated then this is detected and a dialog will ask whether you would like to update the
included file as well.

347
7 Layout Module

If the original external file is deleted, or is not accessible from the new WFD files location,
then the workflow simply continues to use the files that were included at the time of this
export.

For more information, see Used Files Dialog.

Import

RTF Imports formatted text files stored in the Rich Text Format (RTF).

The imported file may be split into pages or set up text flowing. See the separate
section RTF and DOC Import.

XML Imports layouts coded in XML format into Inspire Designer.

It is only possible to import XML layouts created in Inspire Designer and exported
from Inspire Designer as XML files (via File | Export | XML). All objects from the im-
ported XML layout are added into the currently open WFD layout.

Note If you are operating Inspire Designer with only a demo license, XML import/ex-
port will cause problems, especially if you are using QuarkXpress or InDesign plugins.

DOC Imports formatted text files stored in the MS Word formats DOC or DOCX.

You can select if page breaks should be inserted automatically or if the complete
document should be imported into one flow. See the separate section RTF and DOC
Import.

Note This feature is not supported by the Mac version of Inspire Designer.

Native Imports native files into layout so that their content can be edited.

If the option Show advanced options is checked in the Open dialog, the Native
Import Advanced Options dialog is displayed.

For a detailed description, see the section Native Import to Layout.

Export

XML Creates a version of your workflow, fully described in the XML format.

If the option Export with resources is checked in the Save As dialog that opens, all
used files are also exported to the same directory as the XML file.

Note If you are operating Inspire Designer with only a demo license, XML import/ex-
port will cause problems, especially if you are using QuarkXpress or InDesign plugins.

Used Files Opens the List of Used Files dialog which lists all of the external files currently
being used by the selected workflow.

Show Production Opens the Production window from where you can control Inspire Designer
output.

The selected workflow is not loaded to Production.

Show Proof Opens the Proof window from where you can preview Inspire Designer output
in different formats.

348
 7.2 Layout Window Menu

The selected workflow is not loaded to Proof.

Options Dialog Displays the Layout Windows Options dialog which allows the altering of
some general parameters of the Inspire Designer configuration and Layout tools and adjust
many job design related settings.

Inspire Content Manager The Inspire Content Manager (VCS) allows you to manage different
versions of a workflow, keeping track of all changes and contributors.

The Version Control options in this menu extension are explained at length in the separate
Inspire Content Manager (VCS) sections. They become active according to the current
status of Inspire Content Manager and the workflows managed by it:

Login to ICM Opens the User Login dialog which asks for Username and Password in
order to log into the Inspire Content Manager (VCS).

Logout of ICM Logs the user out of Inspire Content Manager (VCS) so that version
controlled documents can no longer be accessed.

ICM Explorer Launches the ICM Explorer window from where you can manage version
controlled documents.

Check In Checks in the selected workflow to the Inspire Content Manager (VCS).

Check Out Checks out the selected workflow from the Inspire Content Manager (VCS).

Undo Check Out Cancels the check out status on an Inspire Content Manager (VCS)
file without recording its details.

History Opens a History dialog which shows a chronological list of the activities on the
selected workflow.

History Tree Opens a History dialog which shows the activities on the selected workflow
in a tree type schema allowing easier tracking of version branches.

Label Opens the Label dialog which allows you to add labels to file versions for easier
identification when viewing its history.

Branch Opens the Branch dialog which allows you to add branches to file versions for
more complex versioning needs.

Select Workspace Opens the Select Workspace dialog, to select a specific workspace from
those that have been set-up via Manage Workspace.

Manage Workspace Opens the Manage Workspace dialog, to define default directories for
the different types of files that are used by Inspire Designer.

Exit Quits Inspire Designer.

If there are any unsaved workflows, you will be prompted to save them before exiting.

349
7 Layout Module

7.2.2 Edit Menu

Undo Undoes the last action made.

Redo Redoes the action previously undone.

Delete Deletes selected object(s) from the layout.

Cut Removes selected object(s) and adds them to the clipboard, replacing the previous clip-
board contents.

Copy Copies selected object(s) to the clipboard, replacing the previous clipboard contents.

Paste If a flow has been copied to the clipboard, the flow is pasted to the active page of the
layout.

If the contents of a flow have been copied to the clipboard, they are placed into the active
flow of the layout.

Also pastes content that has been copied in other applications.

An explanation of how pasting works can be found in the separate Copy and Paste section.

Enhanced Paste Opens the Enhanced Paste dialog to allow for specific adjustments over
whether an object should be copied or cloned.

Paste Multiple Opens the Insert Object dialog that allows you to specify positions and amount
of times that you want the item on the clipboard to be pasted.

Find Opens the Find & Replace dialog that enables you to find and replace texts.

This option is active only if the Flow Area Tool is selected and can be applied only to
the currently selected flow.

For global find/replace functionality, use Find/Replace Text palette.

Spell Check Current Flow Spell checks the selected flow.

Note This option is active only if the Flow Area Tool is selected.

Spell Check All Flows Spell checks all of the flows on all of the pages in the current layout.

Arrange This sub-menu offers the same set of tools that can be found on the Object Order
toolbar, which position the layered objects in a front to back relationship to one another.

Grouping This sub-menu offers the same set of tools that can be found on the Object
Grouping toolbar that groups/un-group objects.

Align This sub-menu offers the same set of tools that can be found on the Object Alignment
toolbar, which align selected objects in relation to one another.

Optimize Enables you to optimize the layout object order in two ways:

Flowing Order Corrects possible flowing order errors by changing the Z-order (order
in the Layout Tree) of flow areas so that it follows the order of flowing. For the flow
order to work, the flow areas in the Layout Tree must be listed in the same order as

350
 7.2 Layout Window Menu

the flow between them runs. This is because the flow areas that are listed first are
processed first when the workflow is run.

Static Objects Order Optimizes and orders static objects within the Layout Tree. All
objects that are static are moved to the background, then put into one overlay and
are processed together. This is better than multiple overlays interleaved between
variable objects.

In the Layout Properties, if you have e.g. the name "FlowArea6 (s)", then (s) means
that this object is static (text only, no variables). Moving this text to an element can
help, even if it is in a variable object. It is considered static and is printed as one
overlay.

Tip Your spool file becomes smaller and processing is more efficient when everything
that is common text is defined in an element.

Select All Selects the entire contents of the active layout.

This is especially useful when the layout content exceeds the visible Layout Area and you
want to manipulate it all.

Shortcut: <Ctrl> + <A>

Invert Selection Inverts the selection of items in layout.

Example Your current layout contains several items, some of which are selected
and some of which are unselected. Using Invert Selection will unselect the previously
selected items and vice versa.

Select None Deselects all of the selected items in the Layout Area.

Clone Selected Objects Opens the Clone Selected Objects dialog that allows you to specify
positions of where and the amount of times that you want the item on the clipboard to
be cloned.

An explanation of how cloning works can be found in the separate Copy and Paste section.

Transform Selected Objects Opens the Transform Selected Objects dialog that allows you
to set changes in position and scaling of the objects. If no objects are selected or they
cannot be transformed, the option is inactive.

Dont Place in Overlay Determines that the selected object will not be placed into an
overlay.

This can also be determined on the Position tab of the Layout Properties Panel, for any
object, where it can be seen if the object is not presently part of an overlay if the icon
is depressed.

Parameters for placement in an overlay can be set globally for different types of objects
in Layout Options dialog.

Find Unused Objects Opens the Find Unused Objects dialog which lists nodes that are not
currently being used in the design of the layout and offers the possibility to remove them.

Remove Constants Opens the Remove Constants dialog that allows you to remove all (or
selected) constant variables.

351
7 Layout Module

Remove Disconnected Opens the Remove Disconnected dialog that allows you to remove
all (or selected) disconnected variables.

Find Object Uses Opens the Find Object Uses dialog which enables you to see all of the
different instances where a selected node is being used in the Layout design and replace
them if desired.

Reload Fonts Reloads all of the available fonts to Inspire Designer and thus updates them.

7.2.3 Page Menu

The Page menu offers several methods of manipulating whole pages at a time.

The options in this menu that are not listed here, are also available in the context menu of
pages in the Layout Tree. See the description Individual Page Context Menu in the Pages section.

Delete Page Deletes the current page from Layout.

First Page Displays the first page of the layout, i.e. the page at the top of the Pages node
branch.

Previous Page Displays the previous page in the page sequence, i.e. one node further up
the Pages node branch.

Next Page Displays the next page in the page sequence, i.e. one node further up the Pages
node branch.

Last Page Displays the last page, i.e. the page at the bottom of the Pages node branch.

Auto Page Flowing Setup Automatically manages overflow for the biggest flow area on
the page. It means that the content of the flow in this flow area is too big to be displayed
in it on one page and so it is desired to generate this page multiple times to print the
whole flow content (e.g. all phone calls for one phone bill).

352
 7.2 Layout Window Menu

You need to have at least one page with a flow area. When you select this flow area in
the Layout Tree and click on Auto Page Flowing Setup in the Page menu, the following
actions are done:

1. In the Pages family, General tab, the Page order field is set to Variable selection.
Start page is set to the page in Layout, e.g. Page 1.

2. In the Layout Properties of Page 1 a new tab Next Page is added. The following
settings are changed on this tab:

Type is set to Select by condition.

A new condition line is added and set in the following way: If the system
variable Overflow returns true, i.e. the content of the flow is bigger than the
flow area and overflow needs to be managed, Page 1 will be repeated.

3. In the flow area Layout Properties on the Content tab the option Flowing to next
page is checked.

Add New Element Adds a new element to the Layout.

In the dialog that opens you can set the width and height of the element.

Delete Element Deletes the selected element.

7.2.4 View Menu

By PrintState Enables you to view which elements will print for a specified printing group,
which can be assigned to an object on the Position tab. The following selections are pos-
sible:

Always When selected, displays the items that will always print.

Never When selected, displays the items that will never print.

Print Group 1 (2, 3) When selected, displays objects associated with Print
Group(s) 1 (2 and/or 3).

By Handling Group Enables you to display just the desired handling groups in the Layout.

Show Grid When selected, displays a grid that assists in the placement of objects. The grid
spacing, color and measurement are set from Options Dialog.

353
7 Layout Module

Snap to Grid When selected, snaps objects to the closest grid line when they come within
one quarter of the distance between two grid lines, both vertically and horizontally.

This applies to moving as well as resizing objects.

The grid does not have to be visible for the object to snap to the grid.

By holding the <Ctrl> key it is possible to maintain the aspect ratio of an object that is
being resized.

Snap to Grid Only When selected, objects will always snap to the next grid line. This applies
to moving as well as resizing objects.

Note The option Snap to Grid Only is available only when the option Snap to Grid
has already been selected.

Show Rulers When selected, rulers are displayed along the sides of the Layout Area, in
whichever unit that you set in the Options Dialog.

Show Bounding Box When selected, the boundaries of objects are displayed.

Example

Show Tabulators When selected, shows the tab settings for the active flow.

Example

Show Hidden Characters When selected, it shows non-printable characters such as spaces
as dots, or line breaks as pilcrow symbols.

Show Flow Order Arrows Permanently When selected, displays flow order arrows per-
manently for all the objects where flowing is set.

For more details, see the separate Overflow Management description.

Show Object Print State When selected, shows the object print state if there is any assigned.

For more details, see the separate Print Menu description.

354
 7.2 Layout Window Menu

Show Heads When selected, shows heads set in the Layout.

For more details, see the separate description of the Heads Display tab.

Show Clipping Paths When selected, clipping paths of objects are marked with a dashed
line. The color of the line can be changed in the Layout Options dialog.

Show Images as Full Resolution When selected, images are displayed in full resolution in
Layout. If your workflow contains larger images, it might be helpful to deselect this option
as then only lower resolution previews of images are displayed.

Show Long Mouse Cursor When selected, two lines parallel to the X and Y axes and inter-
secting the coordinates of the current position of the mouse cursor are displayed. This is
helpful for better alignment of objects that are inserted into the Layout Area.

Highlight Flows When selected, each flow is highlighted by an individually colored frame
in the Layout Area. The colors are automatically assigned.

Example

The color assigned to each flow is indicated just in front of the according node in the
Layout Tree:

Highlight Selected Object When selected, objects such as flows, tables, row sets and cells
are highlighted by a colored frame in the Layout Area when the corresponding node has
been selected in the Layout Tree.

Sort Layout Tree Nodes A-Z When selected, the Layout Tree nodes are sorted alphabetically.

Elements and objects within pages and variables are kept in their original order. The order
of elements and page objects remains in its original state, as it is crucial for the design.
Variables can be included in the alphabetical ordering by enabling the Include variables
when sorting nodes option in the Layout Options Dialog.

Find In Family Finds and highlights the node of an object, that has been selected on the
Layout Tree, in its respective family.

355
7 Layout Module

Example Page1 contains Image1 which appears as a node on the Page1 branch.
If the Image1 node on the Page1 branch is selected and the option Find In Family
is used, then the Image1 node on the Images node branch will be shown and high-
lighted in the Layout Tree Window.

Fit to Page Width Fills the view in the Layout Area with the whole width of the displayed
page, i.e. so that the width of the page equals the width of the Layout Area.

Fit to Page Displays the whole of the current page in the Layout Area.

Shortcut: <Ctrl>+<*> (* from the number keypad).

7.2.5 Insert Menu

Insert Image Locates images and inserts them into Layout for use in image areas and fill
styles.

Insert Font Opens a standard Open dialog that enables you to locate and add different fonts
into the layout. In the first instance it is only visible as a node on the Fonts node branch
of the Layout Tree.

For more information see the separate Fonts section.

Insert External Object Opens a standard Open dialog that enables you to locate and insert
a layout objects from another workflow file (external objects).

For more details see the External Objects section.

Used External Objects Displays the Used layouts dialog that lists all of the external Layouts
from which objects are being used in the current Layout.

For more details see the External Objects section.

Insert Flow Inserts a new flow into a selected position in the text within a flow area.

This option is active only if the Flow Area Tool is selected.

See the separate Flows section for more details.

Insert Table Inserts a new table into a selected position in the text within a flow area,
opening the Insert Table dialog to allow you to define its parameters.

This option is active only if the Flow Area Tool is selected.

Insert Object Inserts an existing object into a selected position in the text within a flow area,
opening the Insert Object dialog which shows the complete Layout Tree to allow you to
select an object.

This option is active only if the Flow Area Tool is selected.

Insert Section Inserts a defining marker for a section into a selected position in the text
within a flow area.

356
 7.2 Layout Window Menu

Sections are useful for multi-column composition of the text flows. For more details, see
the separate description of Insert Section in the Others Node section.

This option is active only if the Flow Area Tool is selected.

Insert Anchor Inserts an anchor into a selected position in the text within a flow area. An
anchor attaches an object to the text and if the point in the text is moved, as the text is
edited, the object will move as well.

For more details, see the separate description in the section Anchors.

This option is active only if the Flow Area Tool is selected.

Insert Special Character Opens a dialog from which you can insert a special character (e.g.,
non-breaking space, soft hyphen) to the selected flow area.

Insert URL Target Inserts a hypertext link as it is specified in the Insert Hypertext Link dialog
that is opened by this option. To add a hypertext link select a portion of text and click on
this option.

Alternatively, you can select the Insert URL target option from the context menu displayed
after a right-click within a flow area.

The selected text will be pre-typed in the Text and URL edit fields. If no text is selected
you can type your own text into the field and it will be inserted to the current position of
the cursor in the flow area. Type the appropriate URL target to the URL edit field. If the
Underline check-box is enabled, the text with hypertext link will be underlined; if the
Blue color check-box is enabled, the text with link will be displayed in blue color.

You can check the inserted URL link in Proof. A click on the link opens the defined web
site.

For the PDF and HTML output files a wider functionality of the URL links can be used.

7.2.6 Format Menu

Bullets and Numbering Opens the Bullets and numbering dialog where you can set bullets
or numbering directly for the selected text. This option is also available if you right click
on the selected text.

Active only if a part of a flow is selected.

Paragraph Style Opens the Paragraph style properties dialog where you can edit paragraph
style properties directly for the selected text.

357
7 Layout Module

All properties that are modified in the Paragraph style properties dialog get marked with
a grey dot to notify users what properties were changed and will be applied if you
confirm the dialog. Clicking on this grey dot , will return it to grey and the modified
value will not be used.

All of the attributes are the same as described in the separate section Paragraph Styles.

This option is also available if you right click on the selected text and is only active if a part
of a flow is selected.

Text Style Opens the Text style properties dialog, where you can edit text style properties
directly for the selected text.

All properties that are modified in the Text style properties dialog get marked with a grey
dot to notify users what properties were changed and will be applied if you confirm
the dialog. Clicking on this grey dot , will return it to grey and the modified value will
not be used.

All of the attributes are the same as described in the separate section Text Styles.

This option is also available if you right click on the selected text and is only active if a part
of a flow is selected.

Select Language Switches between language flows in Layout. For more details see the section
Language Flows and Texts.

Add Language Opens a dialog where it is possible to add a new language. Within each
language flow a new flow for the added language appears. For more details see the section
Language Flows and Texts.

Remove Language Deletes the selected language and related flows. For more details see
the section Language Flows and Texts.

Change Current Flow into Language Flow Converts a selected standard flow into a flow
selected by language, making all the language options available. For more details see the
section Language Flows and Texts.

Change All Flows into Language Flows Converts all flows in the layout into flows selected
by language, making all the language options available. For more details see the section
Language Flows and Texts.

358
 7.2 Layout Window Menu

Export All Language Flows Exports all language flows into XML format. For more details
see the section Language Flows and Texts.

Export Current Language Flow Exports a selected language flow into XML format. For
more details see the section Language Flows and Texts.

Import Language Flows Imports a translated XML file back into Inspire Designer on condition
that the document is well formed. For more details see the section Language Flows and
Texts.

7.2.7 Table Menu

The options available here allow you to create a table or modify the appearance and formatting
of an already existing table. All options available here are also available in the according context
menu.

See the section Table Context Menu for details.

7.2.8 Window Menu

Show Layout Tree When selected, displays the Layout Tree window-pane which can be
moved and placed where required.

Show Layout Properties When selected, displays the Layout Properties panel which can be
moved and placed where required.

Show Insert Char Palette When selected, it displays the Insert Character Palette as a window-
pane which can be moved and placed where required.

Show Undo/Redo Palette When selected, displays the Undo/Redo Palette as a window-
pane which can be moved and placed where required.

Show PTF Import Warnings When selected, displays the PTF Warning panel as a window-
pane which can be moved and placed where required.

Show Find/Replace Text Palette When selected, displays the Find/Replace Text Palette as
a window-pane which can be moved and placed where required.

Show Commented Nodes Palette When selected, displays the Commented Nodes text
palette as a window-pane which can be moved and placed where required.

This enables viewing of the list of nodes upon which comments have been made. You
can display, edit or add a comment. You can save the comments and export a TXT file
containing the names of the nodes and the related comments.

359
7 Layout Module

The following actions are possible:

To display a comment on a node, click on the node from the list in the upper field
of the window. The comment is displayed in the lower field where you can also
edit it.

To add a comment to a node, click on the related node in the Layout Tree and
then click on the Create New icon. The node name will be listed in the upper
field and you can add your comment into the lower field.

To save the comments into a TXT file, click on the Save icon.

Load Environment Loads the last saved environment settings for the Layout window.

Useful for resetting the Layout environment to the last saved one

Save Environment Saves the current size, position and visibility of the menu, toolbars, Layout
Tree, Layout Properties and Layout Area, etc.

Whenever you start Inspire Designer, the last saved settings will be applied to the Layout
Window. You can make adjustments as you work, but those modifications will not be
maintained unless you save them.

Reset Environment Sets the size, position and visibility of the menu, Layout tree, Layout
Properties and Layout Areas etc. back to their original default values, i.e. ignoring the last
saved environment.

However, should you close and open Inspire Designer again then the last saved environment
will be restored.

Select Language Lists all of the languages currently available for the software interface en-
abling you to select the language that you wish to use for the program interface.

Language is preset to English.

360
 7.3 Layout Window Toolbars

7.2.9 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

Getting Started Opens the Getting Started guide, which offers a step-by-step introduction
to Inspire Designer.

About Displays the version number of Inspire Designer, copyright information and licensing
related information: IP address of the server where GMC License Manager is running (in
case of Net licensing), computer License IDs and dongle ID (in case a dongle is used for li-
censing). See the document Public Licensing Guide for details on licensing and guidelines
how this information can be used.

7.3 Layout Window Toolbars

In this section: See also:
Tools Toolbar Layout Window Overview
Object Order Toolbar Layout Window Menu
Object Grouping Toolbar Layout Tree
Object Alignment Toolbar
Text Format Toolbar
Paragraph Style Toolbar
Zooming Toolbar
Page Toolbar
Vertical Alignment Toolbar
Multiple Flow Toolbar
Debug Variables Toolbar
Path Object Toolbar

The toolbars that relate to designing a print page can by default be found around the perimeter
of the Layout Window but can be moved and placed wherever you prefer. Each toolbar relates
to a group of functions and contains several icons that activate a tool when clicked on.

If you need to add new functions to the existing toolbars or even create a new toolbar, right-
click on the grey toolbar area and select the displayed Customize option. For more information
see the section Customizable Toolbars.

Note If there is not enough space to display all of the options of a toolbar, the space saver
icon will be shown. Click on it to display the rest of the options.

7.3.1 Tools Toolbar

361
7 Layout Module

The tools here give your mouse pointer a specific function when they are selected.

Options Description

Selection Tool The mouse pointer becomes a tool with which to pint at and select objects
in the Layout Area by clicking on them.

This is the default tool.

Shortcut: <Esc>

Flow Area Tool The mouse pointer becomes a tool to draw flow areas and select text
within them.

Shortcut: <Ctrl>+<F>

Zoom Tool Use the mouse pointer to indicate the area you want to zoom in on:

Left-clicking on the Layout Area will zoom in.

Left-clicking and holding the mouse button down will allow you to draw a box
that you want to have as a full window view.

Holding down <Ctrl> while left-clicking will decrease size.

Grab Tool The mouse pointer becomes hand-shaped and, on left-clicking and holding
down the mouse button over the Layout Area, allows the scrolling of the page by moving
the mouse.

This can also be done by holding down the middle button of the mouse alone.

Shortcut: middle mouse button

Rotation Tool The mouse pointer becomes a tool that allows you to rotate the selected
object around the rotation point . Click on the Rotation Tool and then select the
object you would like to rotate. By default the rotation point will appear in the upper left
corner of the selected object, but it can be moved to any desired position.

Shortcut: <Ctrl>+<R>

Shape Tool The mouse pointer becomes a tool to draw shapes in the Layout Area.

The little arrow in the bottom-right corner of the icon indicates that there is a context
menu available when right clicking on it:

Select the shape you would like to draw from this menu. See the separate Shapes section
for more details.

Line Tool The mouse pointer becomes a tool to draw straight lines in the Layout Area.

362
 7.3 Layout Window Toolbars

Barcode Tool The mouse pointer becomes a tool to draw areas in which barcodes will
be automatically drawn according to the selected barcode type and properties.

See the separate Barcodes section for more details.

Flow Order Tool The mouse pointer becomes a tool to designate which flows will be
used for overflowing text and in which order.

See the separate Overflow Management section for more details.

Chart Tool The mouse pointer becomes a tool to draw areas in which charts will be
automatically drawn according to the selected chart type and properties.

See the separate Charts section for more details.

Element Area Tool The mouse pointer becomes a tool to draw areas that can be defined
as Element Area.

See the separate Element Area section for more details.

Text on Curve Tool The mouse pointer becomes a tool with which you can draw an ellipse
upon which you can add text.

See the separate Text on Curve section for more details.

Change Shape Tool The mouse pointer becomes a tool to select points on shapes and
drag and drop to deform the shape how you like.

See the separate Shapes section for more details.

This tool can be also used for modifying objects placed in effect areas created using the
Effect Area Tool, listed below.

Freehand Draw Tool The mouse pointer becomes a tool to draw lines and shapes in the
Layout Area without structured form or Bezier curves.

The little arrow in the bottom-right corner of the icon indicates that there is a context
menu available when right clicking on it:

Select, from this menu, the style you would like to use for drawing.

See the separate Shapes section for more details.

Scripted Area Tool The mouse pointer becomes a tool to draw areas that will display a
scripted area.

See the separate Scripted Area section for more details.

Message Area Tool The mouse pointer becomes a tool to draw message areas in which
messages or advertisements can be placed, for example, in unused spaces on a document.

See the separate Message Areas section for more details.

363
7 Layout Module

Effect Area Tool The mouse pointer becomes a tool to draw areas in which effects
modifying objects, such as perspective or warping, can be applied.

See the separate Effect Areas section for more details.

Gradient Tool The mouse pointer becomes a tool that allows you to insert gradient fill
styles into selected flow areas and shapes.

See the separate Gradients section for more details.

Plugin Area Tool The mouse pointer becomes a tool that allows you to insert a new
plugin area into the Layout Area.

See the separate Plugin Areas section for more details.

Embedded Object Area Tool The mouse pointer becomes a tool that draws Embedded
Object areas in the Layout Area.

Pan Tool The mouse pointer becomes a tool that allows to position the image contained
in the currently selected image area, also beyond the image area's borders. You can further
decide, whether to clip or not the parts of image beyond the image area borders. Press
and hold the left mouse button within the image area and move the image to the desired
position. You can use the Pan tool for fill styles, too.

7.3.2 Object Order Toolbar

Layouts can be comprised of multiple layers. This means that the sequence of the objects, the
Z-order, determines which object lies on top of the other objects. Using the Object Order
toolbar you can place an object in the layer you desire. These options are accessible on a right-
click above an object in the Layout Tree or in the Layout Area.

For moving objects in layers you can also use a context menu in the Layout Tree or the Arrange
sub-menu in the Layout Area or in the Edit menu; see the Edit Menu section.

Options Description

Bottom Moves the selected object to be the back most layer.

Move Back / Move Forward Moves the selected object backward/forward one layer.

Top Moves the selected object to the front/top layer.

Note All content/objects on pages in the Layout Area are positioned in layers. The first object
placed in the Layout Area is in the furthest back layer. An object's position can be read from
the Layout Tree. The objects nearer to the top of a page node's branch, are in the back most
layer of that page.

Therefore, moving one layer at a time with the Move Back / Move Forward icons will
move the object up one node along the branch. This will not necessarily place the selected
object behind (or in front) of an object that it appears to be directly on top of (or underneath)

364
 7.3 Layout Window Toolbars

in the Layout Area. You should navigate using the Layout Tree to count how many times you
must click on the icon to get behind (or in front) of the object.

This layer order also represents the processing order in Inspire Designer when the job goes to
print, i.e. the bottom most layer is processed first and then along the branch. Thus these tools
also change the order in which objects will be printed.

7.3.3 Object Grouping Toolbar

Grouping objects makes it easier to manipulate objects while maintaining their relative position.

To select objects for a group, do one of the following:

Hold the <Ctrl> key while clicking each object

Drag the cursor around the objects you want grouped

Tip You can make a single group from multiple groups.

Options Description

Group Groups all objects that are selected in the Layout Area so that they can be manip-
ulated together.

A new node is created (named ObjectGroup# by default) that contains all objects as sep-
arate nodes.

Ungroup Ungroups the objects that are contained in a grouped object so that they become
independent again.

Activated only when a single grouped object is selected.

Redo Group Recreates the group that the selected object was previously part of, collecting
all of the other group members. Previously applied clipping is also restored.

Activated only when a single object is selected that has been part of a group.

Tip The Group option is also available in the context menu, if you select two or more objects
in the Layout Tree. Also any object group can be ungrouped using the Ungroup option in the
context menu.

Group Editing
The object group can be displayed on its own in the Layout Area by double-clicking on the
object group in the Layout Tree or clicking the View Group option in the node's contextual
menu or selecting the object group in the Page toolbar.

In this view you can also edit each of the grouped objects separately or add new objects to the
group or delete the existing ones. For convenient editing the object group is always displayed
without any rotation etc. here.

365
7 Layout Module

7.3.4 Object Alignment Toolbar

Options Description

Align Left / Align Right Aligns all of the selected objects to the furthest left/right po-
sition of the furthest left/right object that is selected.

Align Top / Align Bottom Aligns all of the selected objects to the position of the up-
permost/lowest object that is selected.

Align Horizontally / Align Vertically Centers all of the selected objects horizontally
(X direction)/vertically (Y direction) in relation to each other.

The position of objects in relation to the page may alter.

Tip When pressing <Ctrl> while using the object alignment icons buttons, objects will not
be aligned to each other but to the page borders.

7.3.5 Text Format Toolbar

The Text Format Toolbar is very similar to text toolbars found in other applications and allows
you to change text and style properties of the text within flows in your layout.

When entering or modifying text in a flow area, you have the option of either using style sheets
or selecting text specifications "on the fly". To maintain a consistent look throughout your
document, it is highly recommended that you use styles. However, you can select and modify
characters to achieve the look you want, using the tools.

Note If you enter text into a flow area without identifying a style:

The text will use the settings displayed in the Text Format Toolbar.

An "invisible style" will be generated for any text / paragraph style created while you
are writing and until the style is saved.

Invisible styles work the same way as styles you intentionally create. When you create styles
intentionally, however, you cannot control the name of the new style or reuse it for a different
text.

366
 7.3 Layout Window Toolbars

Options Description

Font You can select here the font type, font sub-
family, and size using the drop-down menus or by typing.

Units Click here to change the measurement units of the font. You can select from:

points (pt)

meter (m)

centimeter (cm)

millimeter (mm)

inch (in)

decimal inch (di)

pixel (px)

Bold Makes the selected font face bold.

Italic Sets the selected font face as Italic.

Underline Underlines the selected text.

Strike-through Draws a line through the selected text.

Superscript / Subscript Sizes the selected text so that it appears as superscript/subscript.

Small Caps Alters the selected text's casing and size so that it appears in small capital
letters.

Tip You can set these faces even for fonts which support only regular face because In-
spire Designer can create them itself.

Hidden Characters When selected, it shows non-printable characters, such as spaces as

dots or line breaks as pilcrow symbols.

Select the text style you want from the combo-box menu.

Click on the Go To icon to view the Layout Properties for the text style of the selected
text and highlight the corresponding node in the Layout Tree.

Fill Style and Line Fill Style Select the fill and outline color and pattern of the selected
text; this function also works for shapes.

The left-hand icon selects the fill color or pattern of the text/shape and the right-hand
icon selects the line fill color or pattern of the text/shape's outline. To set or change colors
and patterns, click on the icon. The drop-down menu that appears is described in the
separate section Fill Styles.

367
7 Layout Module

The icons indicate whether there is any fill style or line fill style applied to any selected text
and also display its color or pattern.

Example

7.3.6 Paragraph Style Toolbar

The Paragraph Style toolbar aids the quick manipulation of the properties of paragraphs.

Options Description

Paragraph Style Select the paragraph style you want from

the drop-down list of paragraphs.

Click on the Find Node icon to view the Layout Properties for the paragraph style of
the selected text and highlight the corresponding node in the Layout Tree.

Align Left / Align Center / Align Right Aligns the paragraph to the left/center/right
of the flow area.

Justify Left / Justify Center / Justify Right Justifies the paragraph across the flow
area with last line of that paragraph aligned to its left/center/right.

Note If you apply the justify options to text read into Inspire Designer, please note that
0x0D (carriage return) and 0x0A (line feed) used in the text are interpreted differently:

Line feed is interpreted as hard enter and the last line before 0x0A will be aligned
to its left/center/right.

Carriage return is interpreted as soft enter and the last line before 0x0D will be
justified, i.e. will not be aligned to its left/center/right.

If the combination 0x0D0A is used, the last line before it will be justified and fol-
lowed by an empty line.

Example

368
 7.3 Layout Window Toolbars

Justify Block Justifies the paragraph across the flow area.

Justify With Margins Justifies the paragraph (or selected line(s)) across the flow area
leaving margins. They are half the width of spaces between words in a given line or
between individual letters (for single-word lines). The example below illustrates the differ-
ences between Justify Block (1) and Justify With Margins (2).

The default Paragraph Style toolbar does not contain this option. Right-click on any toolbar
to customize.

Bulleted List Adds or removes a bullet at or from the beginning of the selected paragraph.

Numbered List Adds or removes numbers, incrementally, at or from the beginning of

the selected paragraph.

Decrease Indent Decreases the indent used for the selected paragraph.

Increase Indent Increases the indent of the selected paragraph (up to 20 levels).

7.3.7 Zooming Toolbar

369
7 Layout Module

Options Description

Fit Width Fits the width of the page to the width of the Layout Area.

Fit Page Fits the page to the size of the Layout Area so that it can be viewed all at once.

Shortcut: <Ctrl>+<*> (* from the number keypad).

Zoom Zooms the Layout Area view by the percentage entered. 100% is actual
design size, i.e. 1:1

7.3.8 Page Toolbar

Options Description

Page by Name Selects the page/flow/element to be displayed in the Layout

Area using the name that it has been given.

All other created pages, flows and object groups are listed in the combo-box menu in
Layout-Tree form for you to select from.

There are also options in this combo-box to: Create new page, Create new flow and Create
new element.

Go To Highlights the node for any object selected in combo-box next to it and shows that
object's Layout Properties panel.

Back / Forward Goes one step back/forward in the history of views displayed in the
Layout Area, where pages, flows, elements or object groups can be displayed.

For example, when you display the content of a flow by double-clicking on the flow's
node in the Layout Tree, you can return to the whole page view by clicking on this icon.

Page by Order Selects a page using a number that relates to the page order below
the Pages node in the Layout Tree. When you have selected an element or a flow in the
combo-box this edit-box is greyed out.

Note The value set here is independent of any page name given.

Example If you had pages called Page1, Page2 etc... to Page7 but moved
Page7 to the first position below the Pages node (i.e. above Page1) the index in this
box for Page7 would be 1.

Create New Creates a new blank page at the end of the list of pages listed below the
Pages node in the Layout Tree and displays it in the Layout Area.

370
 7.3 Layout Window Toolbars

First Displays the first page of the layout, i.e. the first page listed under the Pages node.

Previous / Next Displays the previous/next page in the page sequence, i.e. the page
located one node further up/down in the list under the Pages node than the selected
page.

Last Displays the last page, i.e. the last page listed under the Pages node.

7.3.9 Vertical Alignment Toolbar

The Vertical Alignment allows quick alignment of the text in relation to the borders of a flow
area.

Options Description

Align Top / Align Center / Align Bottom Aligns text to the top/center/bottom of
the selected flow area.

7.3.10 Multiple Flow Toolbar

This toolbar is for navigating through conditionally selected flows that are nested within another
flow. It is activated only if one of these types of flows is selected. Conditional selection of flows
is designated in the Layout Properties Panel for flows.

Options Description

Previous / Next Moves to the previous/next nested flow, in respect of its order in the
Layout Tree, and shows it in the Layout Area.

Create New Creates a new nested flow to be selected conditionally within the currently
selected flow.

7.3.11 Debug Variables Toolbar

Using this toolbar you can display the values of variables used in the Layout and navigate
through records. Note, that it works only for the first level of variables in the data tree structure

371
7 Layout Module

and only after the workflow has been proofed. See the section Debug Data Window-Pane for
information on how to display details about variables in the workflow.

Debug Variables Enables or disables the functionality.

Previous / Next Moves to the previous/next record.

Displays the number of the current record and allows to directly select a particular
record.

7.3.12 Path Object Toolbar

This toolbar is for setting attributes of lines and outlines of shapes which are selected in the
Layout Area. The options set here can also be set on the Content tab of the Layout Properties
of the shape or line being modified.

Options Description

Cap Right-clicking this icon opens a context menu allowing you to select from three options
determining the appearance of line ends:

Join Right-clicking this icon opens a context menu allowing you to select from three options
determining the appearance of corners:

Allows you to select a line style for the line or outline of a shape that is being
modified from a list of already existing line styles or to create a new line style by selecting
the command Create New LineStyle which is available in the drop-down menu as well.

Go To Clicking this icon will display the layout properties of the line style selected in the
combo-box to the left.

Sets the width of the selected line or shape's outline.

Note All lines thinner than 0.5 pixels will be rounded to 1 pixel in raster output.

372
 7.4 Layout Tree

7.4 Layout Tree

In this section: See also:
Layout Tree Context Menu Layout Window Overview
Layout Objects Overview

The Layout Tree represents every object that currently exists in Layout, in a dependency tree
format. It can be used to navigate through the content of your design and the objects listed
there can be clicked on to open their properties panel and to open the object in the Layout
Area for viewing and editing.

Many objects have a family on the tree, where they are listed once they have been created.
The families of objects are represented on the first-level of the tree. For the most part, they
simply provide a method of grouping together similar objects, however a few families have a
set of properties that control how the objects in that family are handled when the workflow
is processed. The most important families to consider are:

Data The properties of the Data family determine how the data in that family is read into
Layout.

The structure of the tree under the data family represents the actual relationship of the
objects within it (the variables), to each other.

373
7 Layout Module

See the separate section Data for more details.

Pages The properties of the Pages family determine the behavior of all of the pages as a
group, including page order and how the complete set of pages is repeated.

The structure of the tree under the pages family represents the processing order of all of
the used objects when the workflow is processed.

See the separate section Pages for more details.

Many objects which have a family on the tree will also be listed below individual page nodes
when used in the Layout Area, see e.g. 'Flow 2' and 'Table 1' in the screenshot. Note that
these objects are displayed as links when grouped under the page they have been placed on.
However, handling is not influenced by this, the links only serve to show that these objects can
also be accessed from their position within their family, which is the main point they are stored
at. Thus, if you choose to delete an object represented by a link, it will only be deleted from
the page it is placed on, the object itself will still be available under its according family. An
object available only in a family, i.e. not used anywhere in a layout, is considered as an 'unused
object'. See the Find Unused Objects section for details on this kind of object.

To learn more about the different objects, see the separate section Layout Objects Overview.

To aid recognition, moving your mouse pointer over an object in the Layout Tree opens a tool
tip that shows what it looks like:

When designing your pages, objects can be dragged and dropped directly from their family in
the Layout Tree, into the Layout Area in order to place them onto a page, element or whichever
object is currently displayed there.

Note Deleting objects from the Layout Area will not delete their nodes from the Layout Tree.
They will remain in the Tree for future use or until you delete them here.

374
 7.4 Layout Tree

7.4.1 Layout Tree Context Menus

Layout Tree Nodes Context Menu
Right-clicking on nodes in the Layout Tree will open a context menu, e.g.:

This menu offers options that relate to the selected object and so different nodes have differing
context menus, however there are some common options:

Options Description

Find Object Uses Opens the Find Object Uses dialog, enabling you to find where the object
has been used in the layout design (e.g. on which pages).

Access Rights Opens the Edit Access Rights dialog, allowing you to set user permissions to
the object.

Quick Access Rights Opens the Quick Access Rights context menu, allowing you to quickly
set the access permissions for individual objects.

Cut Removes the object and saves it to the clipboard.

When cutting the object represented under the page, only this instance is removed. The
object remains in any other place where it has been used and is still represented under its
family.

When cutting the object represented under its family, all instances of the object throughout
the design are removed.

Copy Copies the object to the clipboard.

Paste Pastes the object on the clipboard to the currently selected position.

This option is primarily for pasting to other positions in the design (e.g to other pages).
Objects cannot be pasted into families they do not belong to. However, objects can be
pasted between different layout modules and between workflow files.

See the section Copy and Paste for more details.

Delete Deletes the selected object.

375
7 Layout Module

Remember that when you delete objects from the design (e.g. the page that they are on)
they can still be found in their family for re-use. However, there is no recycle bin for deleted
objects so be careful when deleting objects from their family.

Make Node Public/Insert Public Node Enables you to make the selected object public or
insert a public object into layout. See the section Public Objects.

Move Object to Back Moves the selected object to be the back most layer. It has the same
function as the icon in the Object Order toolbar.

Move Object Backward/Forward Moves the selected object backward/forward one layer.
They have the same function as the icons in the Object Order toolbar.

Move Object to Front Moves the selected object to the front/top layer. It has the same
function as the icon in the Object Order toolbar.

Insert... Creates a new object of the same family.

Only available when the family is selected.

Insert Family Creates a new family of objects within the current one.

This is to help organize groups of objects with similar properties.

Only available when the family is selected.

Clone Creates a clone of the selected object.

A clone is a new and independent object, that initially has the same properties as the ori-
ginal one.

Only available when an individual object is selected.

See the section Copy and Paste for a description of clones in comparison to copies.

Layout Tree Panel Context Menu

Right-clicking anywhere within the Layout Tree panel (not on the objects) will open the following
context menu.

Options Description

Sort Nodes A-Z Sorts the Layout Tree nodes alphabetically. The option is also available in
the Layout View Menu.

376
 7.5 Layout Properties Toolbar

7.5 Layout Properties Toolbar

The Layout Properties toolbar aids navigation through the objects in the Layout Tree.

Options Description

Go Back/ Go Forward Moves you back to the previously selected object or forward
again (only if you have previously used the Go Back icon).

The newly selected object's properties panel is displayed.

Note Please note that these icons do not perform any undo or redo actions. For undo
and redo functionality description see sections Edit Menu in Layout and Undo/Redo
Palette.

Show Object's Family Shows the parent of the object, i.e. moves you to the group
(family) of the currently selected object.

Example If Flow1 is selected on the page, after clicking on this icon you move to
Flows family.

Go Up Go Down Moves you up or down one object (on the same level) in the Layout
Tree.

The newly selected object's properties panel opens.

Example If the Flows group is selected, by clicking the up arrow you move to Pages
group (even if it is currently expanded) and then, with one more click, to Data group.

On the Data group the arrow up is not active any more because it is no longer possible
to move up the tree.

Rename Opens the Rename dialog to allow the editing of the object's name.

Delete Deletes selected object.

Configure Shows the selected object's context menu.

The context menu for individual objects can also be displayed by right-clicking on the object
in the Layout Tree. For more information refer to individual object's description.

Comments Opens the Comment dialog to allow the editing of additional comments for
the selected object.

An object's comments can be viewed by selecting that object and hovering the mouse
pointer over this Comments icon and can be edited when you click on the Comments
icon.

377
7 Layout Module

Mark as Used Marks the object as used.

An object that has been created in Layout Tree but is not employed anywhere in Layout
(e.g. used or referred to) can be marked as used. The object is then no more listed as unused
in the Find Unused Objects dialog but as used in Layout in the Find Object Uses dialog.

Lock/Unlock Allows to lock the node so that its settings cannot be changed. Unlock the
node by clicking on the icon again.

Nodes that have been made public are locked automatically.

Lock/Unlock in Web Editing Allows to lock an object for editing in online editor. This
feature is used in connection with Inspire Storefront; see the separate document Inspire
Storefront User Guide for details about the web editing.

You can also use Web Editing quick access right to apply the same setting.

7.6 Layout Objects

7.6.1 Layout Objects Overview
See also:
Layout Tree

Objects are the components of the sheets of the layout design and each object has a set of
properties that contributes to the look of the document that the workflow will create when
processed.

Each object that is created is represented in the Layout Tree. Many objects have a family on
the tree, where they are listed once they have been created. Such objects can be used in multiple
places (on many pages) throughout a design and changing the properties of such an object
will change the properties of that object in every place where it appears.

A few objects do not have families because they are areas, i.e. they define a position and a
path on a page (or element). Related objects then use these areas in order to appear on pages.
It follows that these areas are unique to an individual page and cannot exist without that page.

378
 7.6 Layout Objects

In this help file, areas are described in context to objects which are related to them and have
families in the Layout Tree. The objects with families in the tree are:

Data Data is handled as objects called variables, there are three kinds of variable:

Record variables which have been read into the workflow via data input modules
or subsequently created via a data processing module. These are grouped together
with the Records array (by default).

System variables are variables that provide data about the layout design and are
calculated to return values as a workflow is processed. They can be useful additions
to a design, providing counters and indexes.

User defined variables can be additionally created in Layout for use in a design.
These can be positioned in any place suitable to their function within the Data
family.

Pages Pages represent the intended printing media and other objects are placed on them
to build up a design.

When a workflow is processed, the properties of the individual pages play an important
role: The tree structure under each individual page is the Z-order of any objects that have
been placed on that page. That Z-order is the order in which those objects will be processed
when the workflow is processed.

Elements Elements can be described as 'small pages' that can be positioned on one or
many pages and have their own design. They can contain all of the same content as a
page and therefore has the same dependency tree structure as a page.

Elements can be positioned in the design (e.g. on a page) using element areas.

Flows Flows are the basic object for passages of text.

Other objects can also be added inside a flow and, similar to with pages, they can sub-
sequently be found listed under that flow in the Layout Tree.

Flows can be positioned in the design (e.g. on a page) using flow areas.

Paragraph Styles Paragraph styles define a set of properties for paragraphs, e.g. alignment
and wrapping.

There is a family here called Invisible Paragraph Styles. These are variations of styles that
have been created while writing (i.e. using tools from the Paragraph Style toolbar) and
have not yet been classified as a proper paragraph style.

Text Styles Text Styles define a set of properties for text, e.g. size and fill style.

There is a family here called Invisible Text Styles. These are variations of styles that have
been created while writing (i.e. using tools from the Text Format toolbar) and have not
yet been classified as a proper text style.

Fonts Fonts are external objects. Those fonts that have been used within the pages of
your layout design or those that you have inserted using the Insert Font option.

Border Styles Border styles set properties for borders around objects such as the cells of
tables, e.g. fill style and line style.

379
7 Layout Module

Line Styles Line styles set properties for lines, e.g. fill style and weight.

Fill Styles Fill Styles contain colored objects (e.g. color or image) so that they can be used
as a fill for areas, other styles or text, e.g. shapes or border styles.

Colors Colors can be defined from different pallettes and then be used in fill styles.

Images Images are external objects. Those that you have inserted using the Insert Image
option or patterns that have been employed as part of a fill style.

Images can be positioned in the design (e.g. on a page) using image areas.

Tables Tables set properies that govern the look and content of a table as a whole, e.g.
border style and which row set is used.

Row Sets Row sets bring together the cells of a table and govern how they will behave,
e.g. with variable data.

Cells Cells are the basic building blocks of tables and govern the look and content of each
cell, e.g which flow and border style are used .

Cells are most often grouped together in row sets because any variable-data conditions,
for whether cells should appear, are determined at that level.

Anchors Anchors can be placed in flows and are used to attach objects to that point so
that an object (e.g. an image) remains attached to a specific word or phrase and moves
as that word does.

Messages Messages manage smaller designed content (e.g. elements) so that they can
be displayed according to some condition.

Messages are positioned in the larger design (e.g. on a page) using message areas. The
intention of these objects, when used together, is to display advertisements in space that
is left unfilled by other objects.

Data Output Data Output defines a data structure that can be outputted via the data
connector of the Layout module.

Others Others are extras that are not categorized by the other existing families. They in-
clude: Tables of Contents, Business Rules, Sections, Font Replacement and Wrapping Rules.

Orphans Orphans is where objects are moved if a directly superior object, which previously
contained them, has been removed. It is used for variables above all.

If an object is still in use, it will remain in Orphans. If not, it will be deleted. Checking if
an object is in use or not happens every 10 seconds.

380
 7.6 Layout Objects

7.6.2 Common Settings

7.6.2.1 Position Tab
In this section:
How to Position Multiple Objects
Simultaneously

The Position tab can be found on the properties panel of any position defining object, i.e. objects
which attach content to the mapped points of a page (flow areas, image areas, barcodes etc.).

Options Description

Position

Position X / Position Y Set a precise position of the object on the page.

By default, the origin (coordinate 0,0) of an object is its top left hand corner. This is
the point that will be placed at these coordinates.

The position can also be determined by a variable. Any variable of double data-type
can be assigned using the combo-boxes to the right. The values that they return will
be added to the values entered in the Position X and Position Y edit-boxes when
the workflow is processed.

Example In the screenshot below, the values 18.84 and 11.81 will be used
for positioning an object on the page as it is seen in the Layout Area. These also
represent the origin of the object.

381
7 Layout Module

So, if variable X returns the values 3.00, 6.00 and 10.00 for three consecutive
records, the position X will be:

1. 18.84 + 3.00 = 21.84

2. 18.84 + 6.00 = 24.84

3. 18.84 + 10.00 = 28.84

Measurement units can be changed by clicking on the unit symbol. Placement of an

object can also be performed in the Layout Area by using the Selection Tool to
drag it to the desired position.

Note Avoid positioning objects on negative margins or increasing the size of objects so
that a portion of them is in a negative position. It can dramatically increase processing
time and spool file size when a workflow is produced using an AFP like engine, e.g. AFP
or IJPDS.

For example, you reset a line width from 2 to 3 pixels and the object reaches outside the
page as marked on this image:

Size

Width / Height Set the precise size of the object.

Measurement units can be changed by clicking on the unit symbol. Sizing of the object
can also be performed in the Layout Area by using the Selection Tool to drag the
boundaries of the object.

Rotation and Skew

Rotation Rotates the object by the value entered. The units are degrees.

Rotation can also be determined by a variable. Any variable of double data-type can
be assigned in the combo-box below this option and the value it returns will be added
to the value in the Rotation combo-box.

Rotation point X / Rotation point Y Determines the coordinates of the center

of rotation.

382
 7.6 Layout Objects

The rotation point (both in default or modified position) is used for all transforma-
tions (skewing, scaling etc.) as a base point.

The center of rotation is in the origin of an object. By default this is in the top left
corner when the object is left unrotated.

When the Rotation Tool is selected, you can also move this point by dragging it
to the desired position.

Rotation round Determines how any rotation value, that has been determined by a
variable, should be rounded-up.

If the rotation has been determined by a variable that is assigned in the combo-box
above, the value that the variable returns will be rounded up to the nearest multiple
of the value entered here.

Example If Rotation is set to 12.00, the value returned by the double

variable 9.00 and the value entered for Rotation round is 5.00, then the
total rotation will be 25.

I.e.: 12 + 9 = 21 and then rounded up to the nearest multiple of 5 = 25.

The units are degrees. It is recommended that only whole numbers are entered for
faster processing, e.g. 3.00, 5.00, 10.00 etc.

Skew Determines the skew (shear) of the object.

Skew is a distortion of the object that is performed by rotating the Y-plane of the
object. The X-plane of the object (where Y = 0) is left in its original position.

The units are degrees.

Example This object is a rectangle that has been skewed to 45. The origin
of the object is the top-left corner.

Tip The Skew icon changes to if the object is flipped.

383
7 Layout Module

Scale

Scale X / Scale Y Enlarges (or reduces) the size of the object both horizontally and
vertically.

Units are ratio of original size, e.g. 1 is the original object size and setting of 1.25 =
125%.

Note A warning dialog will show if you try to change the scaling for barcodes, be-
cause a barcode modified in this way would not be in compliance with barcode
standards. If the barcode is rescaled anyway, a warning is generated in the Log win-
dow-pane in Proof and Production.

Flip X / Flip Y Flips the object in its X / Y plane.

The flip axis is the axis of the origin of the object.

Visibility and Groups

Variable visibility Shows/hides the object depending on the value returned by a

Boolean variable.

Select a Boolean variable from the combo-box.

Variable visibility is evaluated in pre-processing if set for an overflowing flow area.

Also, it is evaluated for all objects on the page in a special pre-processing mode if:

runaround is applied to any overflowing flow area in the Layout module,

dynamic height is applied to any page in the Layout module,

there is a message area on the page,

there is a duplex message area on the previous page,

first fitting is used in an overflowing flow area on the page (overflow between
pages),

a scripted area with the Run also in preprocessing check-box checked.

As a result of evaluation in pre-processing, you cannot use e.g. the PrintingFace system
variable for variable visibility, as its value is not known yet.

Handling group Selects the handling group for the selected object.

Select a group number from 1 to 8.

These groups can be used in proof or production to apply different methods of

handling different objects, e.g. dithering settings. See the Dithering section for more
information.

Handling groups allow to manage the optional visible and invisible content of imported
PDF files. See the PDF&PS Import section for details.

Go To Finds any object, selected in the combo-box next to the icon, in the Layout Tree.

Show Object Shows / Hides the object on the page in the Layout design.

384
 7.6 Layout Objects

Lock Object Locks the object.

If an object is locked, you cannot change its position properties.

To unlock an object, click on the Lock Object icon again.

Note If you use this lock on a barcode, you cannot edit any properties of the barcode.

Print Menu Opens the Print Menu:

Print Always If selected, the object will always be printed.

Print Never If selected, the object will never be printed.

Print User Group Assigns the object to a specific print group, e.g. User Group 1.

Influence Messages If selected, the object will have any unused space made available
for messages.

If the object has space that has been left unfilled by its content, and this area is also covered
by an overlapping message area, then that message area will be able to place messages
into this free space.

The properties of the message area and messages it uses also determine whether messages
will fit into the free space. This option must be set in combination with the Influence
type option on the Content tab of the message area. If either option is not set, and the
object overlaps with a message area, then the content of both objects will clash, i.e. lay
over the top of each other.

Note If setting this option for a message area then further conditions apply. See the
separate section Message areas.

Keep out of overlay If selected, the object will not be placed in an overlay even if it only
contains static objects.

This can be useful when you need to search for specific words in the file content or when
you use the option Partial overlapping heads for IJPDS.

How to Position Multiple Objects Simultaneously

Multiple objects can be selected (e.g. by holding down <Ctrl> and using the Selection Tool
) and have their position adjusted simultaneously using the Position tab.

The Position tab of any one of the selected objects can be used and, when viewed, all attribute
values which currently differ between the objects are highlighted in a light-blue color. Setting
a new value for any attribute on that tab will apply that value to all of the objects.

385
7 Layout Module

Example The below screenshot shows three objects that have been selected in the
Layout Area:

Looking at the Position tab it can be seen that Position X, Position Y, Width and Height
have differing values for each of those shapes because those values are highlighted:

This would be expected because the objects are different sizes and have different X and
Y coordinates. However, all the other attributes (e.g. Rotation) have the same values
for these objects.

If we change the value of Position X, the value is no longer highlighted:

This is because Position X is now the same for all of the objects, i.e. all of the objects are
aligned in the X-plane:

386
 7.6 Layout Objects

7.6.2.2 Clipping Path Tab

On the Clipping Path tab it is possible to set path points to clip any content of an object group.
This functionality helps speed up printing of native files as the clipping is made in the output
(PDF reading/displaying application or printer).

The function can only be used if the objects that you want to clip are grouped, you can even
group just one object. Grouping is done by clicking on the Group selected objects icon
in the Object Grouping toolbar. The tab is then accessible after selecting the group in the Layout
Tree.

The Path Points table displays the coordinates of the points used in clipping. It is possible to
edit, add and remove items or modify the path points in scripting. The default values represent
the rectangular boundary around the whole object group.

Example This example shows the effect of clipping on a simple object group.

The same object group modified by clipping.

Example Clipping function applied to some text.

387
7 Layout Module

Options Description

Use clipping path Checking this option makes the clipping path functionality available and
the Path Points table editable.

If it is unchecked after editing the table content, all modifications are reset.

Temporarily show unclipped If checked, the object group will be displayed in the Layout
Area without clipping.

This option has no effect on the final printed output.

Path Points See the section Path Description Tab for a full description of this table.

7.6.2.3 Types of Variable Selection

In this section:
Simple
Select by Integer
Select by Interval
Select by Condition
Select by Text
Select by Inline condition
Select by Content
Select by Language
Repeated

The section describes the options selectable from the Type combo-box which is found in the
properties of the following objects: pages, flows, row sets, variable images, fill styles and texts
for the Template Merger module.

Simple
Uses the current object and it will not change, i.e. the object is static.

Select by Integer
Uses one of many objects, selected by the value returned by a variable of integer data-type.

Specify the variable in the Variable combo-box and then assign objects that will be displayed
according to the value returned by the selected variable.

One of the options Default or Default-Error is used for values other than those specified in the
condition lines above it. When the Default option is selected, the assigned object is displayed
if values other than the ones specified above are returned by the variable. If you choose the
Default-Error option and none of the specified conditions is matched, the production will end
with an error when evaluating this line. This option is useful in cases where you need to stop
printing whenever a value other than the specified ones occurs to prevent misprints caused by
an incorrect data input.

388
 7.6 Layout Objects

There is also the possibility of assigning a object to this option and change the severity of the
error. If the error is set to be ignored in the Warnings Config dialog, the assigned object will
be displayed. An example is given in the Select by interval type description.

Note The conditions are always evaluated from the top to the bottom. Always check the
sequence and if necessary use the arrow icons to modify it according to your needs. The
Default or Default-Error will always be presented in the last line and thus be evaluated at the
end.

Example The settings made in the screenshot will cause the following behavior:

If the IntVariable returns 1, Flow 2 will be displayed.

If the IntVariable returns 2, Flow 3 will be displayed.

If a value other than 1 or 2 is returned, Flow 4 will be displayed.

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the text content of the flow in the
produced DOCX file. This option is general for all types of flows; see the detailed description
in Flow Layout Properties section.

Variable Specifies the variable used for selecting the content of the object.

Value Enables you to enter an integer value.

Page / Flow / Image / Row Set / Fill Style Assigns the object that will be displayed when
the specified value is returned by the selected variable.

Add images from Layout Selects an image that has been already added to Layout. Using
this icon you create a new line for entering the condition and assign an image to it.

Note This option is available for variable images only.

389
7 Layout Module

Add images from disk Selects an image from hard-disk. This may be useful when you
want to directly load an image that has not been used in the Layout yet.

Using this icon you create a new line for entering the condition and assign an image to
it.

Note This option is available for variable images only.

Go to object Finds the selected node of the object that is selected, in the Layout Tree.
For description of this icon functionality and other related features see the section Navig-
ation in Layout.

Move up Moves the selected condition line up.

Move down Moves the selected condition line down.

Create new Creates a new object condition line.

Remove selected item Removes the selected object condition line.

Sample Selects a sample image for Layout previews.

Note This option is available for images only.

Select by Interval
Uses one of many objects, selected by the value returned by a variable (of integer data-type)
if it falls inside a range of values.

Specify a variable in the Variable combo-box and then assign a specific object that will be
displayed for the specified range(s) of the selected variable.

One of the options Default or Default-Error is used for other values than those specified in the
condition lines above it. For more details on these two options and on all icons see the Type:
Select by Integer section above.

Example The settings made in the screenshot will cause the following behavior:

If a value between 1 and 10 is returned by IntVariable, Image_02 will be displayed.

390
 7.6 Layout Objects

If a value outside of this range is returned and Default-Error has been set in the Begin
combo-box, the job will be stopped and an error will be displayed.

The Image_03 assigned here will only be used if you set this error to be ignored. This can
be done by setting the message 0712 to Ignore in the Warnings Config dialog.

Options Description

Variable Specifies the variable used for selecting the content of the object.

Begin Enables you to enter the starting integer value of the range.

End Enables you to enter the ending integer value of the range.

Page / Flow / Image / Row Set / Fill Style Assigns the object that will be displayed if a
value within the specified range is returned.

Sample Enables you to select a sample image for Layout previews.

Note This option is available for images only.

Select by Condition
Uses one of many objects, selected by a variable of Boolean data-type.

Specify the variable in the Variable combo-box after you create a new line using the Create
new icon and then assign a specific object that will be displayed if the value returned by
the selected variable is True. One of the options Default or Default-Error is used for the False
value.

For more details on these two options and on all icons see the Type: Select by Integer section
above.

See also the section How to Make Conditional Flow for a simple way to create 'select by con-
dition flows using the option Make conditional flow.

Example The settings made in the screenshot will cause the following behavior:

If the system variable Printing Face returns True, Flow 2 will be displayed.

391
7 Layout Module

If this condition is not met and Default is set in the Variable combo-box, Flow 3 will be
displayed.

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the text content of the flow in the
produced DOCX file. This option is general for all types of flows; see the detailed description
in Flow Layout Properties section.

Variable Enables you to select a Boolean variable for selecting the object. There are only
variables of Boolean data type listed in the combo-box.

Page / Flow / Image / RowSet / FillStyle Assigns the object that will be displayed if the
Boolean variable is True.

Sample Enables you to select a sample image for Layout previews.

Note This option is available for images only.

Select by Text
Uses one of many objects, selected if the value returned by variable matches the text entered
here.

The object is chosen when the selected variable value matches the text specified in Value field.
Specify a string variable in the Variable combo-box, enter the possible values and assign a
specific object that will be displayed for the specified values of the selected variable.

One of the options Default or Default-Error is used for other values than those specified in the
condition lines above it. For more details on these two options and on all icons see the Type:
Select by Integer section above.

392
 7.6 Layout Objects

Example The settings made in the screenshot will cause the following behavior:

If the variable returns the value Male, Page 1 will be displayed.

If the variable returns the value Female, Page 2 will be displayed.

If the variable does not return either of these two values, Page 3 will be displayed.

Options Description
The Page order, Repeated by and Main flow combo-boxes are available only for Pages and
their description can be found in the Pages Layout Properties section.

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the text content of the flow in the
produced DOCX file. This option is general for all types of flows; see the detailed description
in Flow Layout Properties section.

Variable Enables you to select a string variable for selecting the object. There are only variables
of string data type listed in the combo-box.

Value Enables you to enter a text value.

Page / Flow / Image / Row Set / Fill Style Assigns the object that will be displayed if the
text entered in the Value field matches the value the variable returns.

Sample Enables you to select a sample image for Layout previews.

Note This option is available for images only.

Select by Inline Condition

Uses one of many objects, selected by conditions that are defined here.

This type is similar to Select by condition in that a Boolean expression is used, but condition is
scripted here with the aid of the Simple Expression dialog.

One of the options Default or Default-Error is used for other values than those specified in the
condition lines above it. For more details on these two options and on all icons see the Type:
Select by Integer section above.

393
7 Layout Module

Example The settings made in the screenshot will cause the following behavior:

The inline condition is specified using the System variable Page Index. When the page index
is an even number, this condition returns True and Image_2 is displayed. When the page
index is an odd number, the condition returns False and Image_3 is displayed.

Options Description

Base context Selects the context of the variables to be used in the script. For example, it
can be the array in which the variable is located. Then you do not have to specify the
whole path, but only a part of it relative to the point of Base context. The Script Assistant
then also offers options relevant to the context.

Script After you click on the 3 Dots icon, the Simple Expression dialog opens and you can
enter the condition here.

Page / Flow / Image / Row Set / Fill Style Assigns the object that will be displayed if the
Boolean variable returns True.

Sample Enables you to select a sample image for Layout previews.

Note This option is available for images only.

Select by Content
Uses one of many objects, selected if the value returned by a variable matches the name of
the object.

Specify the variable in the Variable combo-box and then assign a specific object that will be
displayed according to the value returned by the variable. The name has to be the same as the
actual value of the variable.

394
 7.6 Layout Objects

Example To be able to use this type of variable selection you first have to convert a
simple flow to a flow selected by content. In the Layout Tree select the flow you want to
convert and choose the option Select by content in the Type field in the Flow Layout
Properties. Then specify a variable the content of which will be used as a condition for
flow selection.

The next step is to create simple flows and rename them according to the actual value of
the selected variable. These flows become nested flows that will be conditionally selected
within the flow selected by content.

If you choose a variable called SecondName as a determining variable you can display
flows depending on the value of this variable. For each record only that flow will be dis-
played the name of which matches the value of the SecondName variable for that record.

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the text content of the flow in the
produced DOCX file. This option is general for all types of flows; see the detailed description
in Flow Layout Properties section.

Variable Enables you to select a variable for selecting the object.

Treat default as error If this option is checked, every record for which there is no object
with a name matching the value of the selected variable (i.e. default condition is applied),
will be treated as an error and will not be printed. If the option is unchecked, then the
object selected by content will not be displayed for such a record. For pages the page set
as Start page in the Pages Layout Properties will be displayed in such situation.

For easier issue solving the error message displays the value of the variable which caused
that the condition matched the default object.

Select by Language
Uses one of many objects, selected according to their pre-determined language.

This type is similar to the Select by text but is specially designed for language flows in Layout
or language texts in the Template Merger module. A flow or text is chosen if the value returned
by the Language variable matches the value specified in the Language field in the flow's Layout
Properties panel.

395
7 Layout Module

Language flows are suitable for creating various translated versions of documents. There are
also several language related options available in the Format menu in Layout, enabling exporting
and importing language flows, adding and removing languages, etc.

For more information on language flows consult the section Language Flows and Texts.

Repeated
Repeats the current object by the count returned by a variable.

Select an array or integer variable from the Variable combo-box that appears. The object will
then be repeated the number of time determined by the value returned by that variable, i.e.
the count of repetitions of an array or the integer value.

One intention is for transactional documents, e.g. a bank statement where customers (records)
have made differing amounts of transactions and, therefore, the number of times some passage
of text containing the transaction amount variable must be printed is different for each of those
customers.

Tip For flows in Layout: Text will be repeated according to the paragraph style, e.g. left to
right across the flow area. Therefore, to repeat down the page, follow each sentence to be
repeated with a carriage return so that each repetition is a new paragraph. E.g:

Will result in something like:

This selection is only available for Type for flows and rowsets in the Layout module and texts
in the Template Merger module, but it is the same method of object repetition as Repeated
by for pages.

See the following sections for ideas on some types of variables that objects can be repeated
by: System Variable: Index, System Variable: Exists and How to Repeat Layout Objects by Integer
Variables.

7.6.3 Anchors
In this section: See also:
Anchors Layout Properties Panel Elements
Images

396
 7.6 Layout Objects

Objects can be attached to text with the help of anchors. Then, if the point in the text is moved,
as the text is edited, then the object will move as well.

Anchors are also helpful when setting text to runaround objects in different ways, allowing
different text wrapping settings.

The Anchors group can be found in the Layout Tree and, using its right-click menu, you can
create a new anchor node here, attach an image or element to it in the anchor's properties
panel and then drag and drop it to a position in a flow in the Layout Area.

Alternatively, anchors can be created by selecting a point in a flow (so that the cursor is in the
desired position) and choosing the Insert Anchor option (go to: Insert Insert Anchor or use
the right-click menu with the Flow Area Tool active over the text).

Once an anchor is inserted in a position within a flow it is visible as an anchor icon if the
Show Hidden Characters tool has been activated.

7.6.3.1 Anchor Layout Properties Panel

An anchors properties panel is available for each anchor created (not the Anchors category
node) and has two tabs in which you can set its attributes:

General

Runaround

General Tab

Options Description

Anchor Selects the object that will be attached to the anchor.

The combo-box menu reveals a list of already created images or elements in a truncated
layout tree form.

397
7 Layout Module

There is the additional menu item Create New Element. Selecting this will create a new
Element node. You can subsequently click on the Go To icon to move to that node in
order to set its properties.

Reference Point Selects the point of the object that will be attached to the selected point
in the flow area.

In the combo-box menu there are object-relative positions listed:

Upper Left (object corner)

Top (middle of object edge)

Upper Right (object corner)

Left (middle of object edge)

Centre (mid-point of the object)

Right (middle of object edge)

Lower Left (object corner)

Bottom (middle of object edge)

Lower Right (object corner)

Note The point of the object that the anchor is attached to can affect whether it is
possible to view the object at all due to flow size and proximity to other paragraphs or
objects.

Offset X The value entered here is the offset on the x-axis from the reference point.

The Relative to combo-box allows you to set the position in the flow area that you would
like the object to be positioned in relation to:

Char - in relation to Character next to which the anchor has been placed.

Column-Left, Column-Center, Column-Right - are in relation to the text column

which the cursor position is a part of. If columns have not been set then this means
the paragraph width.

FlowArea-Left, FlowArea-Center, FlowArea-Right - are in relation to the boundaries

of the flow area in which the anchor is placed.

Offset Y The value entered here is the offset on the y-axis from the reference point.

The Relative to combo-box allows you to set the position in the flow area that you would
like the object to be positioned in relation to:

Char-Top, Char-Center, Char-Baseline and Char-Bottom - are in relation to the

character next to which the anchor has been placed.

Paragraph-Top, Paragraph-Center, Paragraph-Baseline and Paragraph-Bottom - are

in relation to the characters of the first line of a paragraph.

FlowArea-Top, FlowArea-Centre, FlowArea-Bottom - are in relation to the bound-

aries of the flow area in which the anchor is placed.

398
 7.6 Layout Objects

Note All positions are relative to the maximum extent of the ascenders and descenders
of the whole line. Top is above ascender level, Bottom is beneath descender level, Baseline
is under the main body of the character.

Must be inside Ensures that the whole of the anchored object stays inside the boundaries
of the flow area where the text, to which the anchor is attached, appears.

This fitting is done by adjusting its position taking account of the other position parameters
entered, i.e. the object will not overhang the borders of the flow area.

Other text in the flow area will be adjusted accordingly.

If the anchored object is too big for the flow area then it cannot be inside it.

Overflow Selecting Overflow will ensure that if the anchored object does not fit in the
present flow area that you are typing in, then it will be moved with the text that it is
anchored to.

Example A flow area has been set to overflow to another and an inserted image
(FigA.gif) does not fit in to that first flow. We have a label for the image (Figure A)
and we do not want it separated from the image in such a case.

Normally, if you wrote Figure A and then inserted FigA.gif, by drag and drop, into
the text after the character A then Figure A would be written in the first flow
(which is big enough for more text but not big enough for the image) and FigA.gif
would not be shown at all.

If an anchor is set in the word and the image FigA is selected as the anchors
property Anchor, then FigA.gif will stay with the label and will appear where ever
it does according to the positioning settings that are set. We can determine that the
anchored FigA.gif will Overflow and it will appear in the next flow area that is big
enough to show it and the label will be there with it.

Any text before the anchor will move according to the settings of the corresponding
paragraph style, but all of the text after the anchor will move with the image.

Runaround Tab
The Runaround tab allows the setting of the attributes of the text runaround feature, around
the anchored object.

In order to set runaround correctly for anchors you have to consider both the properties of the
anchor and the object that is anchored. See especially the option: Runaround Children Only
for Elements which defers the runaround properties to be set by the objects within the element.

399
7 Layout Module

Note The setting made in the Type combo-box determines which other options will be
available on this tab. Thus the options you see may differ from the above screenshot.

Options Description

Type Determines the kind of runaround that will be employed. The combo-box menu offers:

None - No runaround settings will be applied and the text will write across the face
of the object.

Selecting None also means that none of the runaround properties that have been
set for the object itself will be applied either.

Square - Text will runaround the outer boundaries of the object in a neat square
box.

Example If an image is triangle, then the text will not wrap close to the
edges of the triangle but squarely clear of the vertices.

The screenshot above shows Runaround Type: Square, Wrap Type: Both.

Note Reference Point of the above anchor has been set to: UpperLeft,
Relative to: (X) Char and (Y) Char-Top.

The paragraph style is aligned: Left and the shape shown has first been placed
in an element which has Runaround Children Only set..

Square should also be selected for any shape or image that is being runaround
as well, because if None is set at that level then no runaround will occur at
all. I.e., both anchor and object must have runaround enabled.

Tight - Text will run close to the outside borders of any shaped object.

Example

The screenshot above shows Runaround Type: Tight, Wrap Type: Both.

Note The shape above has first been placed in a element which has Run-
around Children Only set.

400
 7.6 Layout Objects

Tight should also be selected for any shape or image that is being runaround
as well, because if None is set at that level then no runaround will occur at
all. I.e., both anchor and object must have runaround enabled.

Closer wrapping to an object can be achieved by using the Alignment option

of the paragraph style being used for the text.

Through - Text will run close to the borders of any object and, if there are vacant
spaces within outer solid borders, text is able to run there as well, i.e. all free space
is filled with text.

Example Shapes such as donuts will have text in the centre too.

The screenshot above shows Runaround Type: Through.

Note The image used above has been made transparent and has Runaround
transparency set on the Advanced tab of the images layout properties
panel.

Top and Bottom - Text will run above and below the object, not around.

Also look to set the appropriate Reference Point and Relative to.

Top - Only the text above the object will be shown in the current flow.

Text that follows the objects position will be overflowed. Therefore, to see it the
overflow must be set to the next page or flow area.

Wrap Type Sets on what side of the object the text will be wrapped.

This complements the anchor settings Reference Point. Select from the combo-box menu:

Both - The text will wrap on both sides of the object.

Left - All text associated with the anchor will remain on the left of the object.

Right - All text associated with the anchor will remain on the right of the object.

Largest - All text associated with the anchor will appear on the side of the anchored
object which has the largest space inside the flow area.

401
7 Layout Module

Margin Sets the amount of clearance between the text and the object on all sides. Enter a
measurement.

Left Sets the amount of clearance between the text and the object on the left side. Enter a
measurement.

Top Sets the amount of clearance between the text and the object, above the object. Enter
a measurement.

Right Sets the amount of clearance between the text and the object on the right side. Enter
a measurement.

Bottom Sets the amount of clearance between the text and the object, below the object.
Enter a measurement.

Invert Determines that the text will wrap within the boundaries of the object, instead of
wrapping around the outside of the object.

Example

When the object is filled with text, the flow will continue below the object.

Note The shape in the screenshot above has first been placed in an element which
has Runaround Children Only set.

The same Type of runaround should also be selected for any shape or image that is
being runaround as well, because if None is set at that level then no runaround will
occur at all. I.e., both anchor and object must have runaround enabled.

402
 7.6 Layout Objects

7.6.4 Barcodes
7.6.4.1 Barcodes
In this section: See also:
Barcode Layout Properties How to Align Barcodes to Pixels
Barcode Types

To insert a barcode into the layout design, do the following:

1. Click on the Barcode Tool .

2. In the Layout Area, drag the cursor to define the area where the barcode will be placed.

A default barcode and its accompanying properties panel appears.

3. If necessary, adjust the position of the barcode with the Selection Tool active.

Alternatively, this can be adjusted precisely from the Position tab.

4. Complete the barcode layout properties as necessary.

Note The barcodes are visible only if the settings are correct.

Barcode Layout Properties

See below for a description of the attributes of the available tabs:

Position

Content

Text and Align

Direct Metric

Other tabs appear depending on barcode type. Follow the links in the Barcode Types section
to read about those tabs.

Position Tab
Refer to the separate section Position Tab for a description of options on this tab.

Note If the option Lock Object is used on a barcode, none of the properties of that barcode
can be edited on any of its tabs.

403
7 Layout Module

Content Tab

Options Description

Barcode fill Sets the fill style (i.e. color) of the barcode.

Background fill Sets the fill style behind the barcode.

Variable Identifies the variable to be used for creating the barcode.

Data Sets a static barcode value.

Data uses the data entered in the edit-box to create a barcode if there is no data being
read from any variable. This can be used for cases where either no variable has been as-
signed in the Variable combo-box or if the variable fails to return a value (e.g. a record
has no entry for this variable).

The data that has to be entered is dependent on barcode type and is also used to create
the preview that appears on the page of the design in the Layout Area. If data of the
wrong format is entered a warning dialog will show explaining that an error has been
made.

Note For some barcodes, alphabetic characters (A, B, C, etc.) entered here should be
capitalized.

Settings file Specifies an external file defining the settings of the barcode (the size of bars
and spaces).

You can save and load barcode settings as a XML file, which is used by the workflow. By
each opening the WFD file is updated from this XML file.

Once an XML file with settings has been loaded, all barcode settings are linked to it and
cannot be edited. The Unlink settings icon unlocks the settings but keeps the values
from the XML file.

Barcode type Determines the type of barcode.

See the section Barcode Types below.

You can further lock the barcode's settings by clicking on the Lock icon.

If the settings are locked, all barcodes of the same type that are inserted in the Layout,
will be given the current values. Only users with permissions to add/remove files to/from
the directory where Inspire Designer EXE file is placed are able to lock or unlock barcodes.
Locking a barcode creates a BARCODELOCK file in that directory, in which the information
about the settings for the specific barcode is kept. When the designated users delete the

404
 7.6 Layout Objects

file from that directory, the barcode is unlocked and the barcode settings can be edited
again.

The Refresh icon should be clicked on when the settings of a locked barcode have
been changed (by a designated user).

Example It is necessary to make changes in the barcode setting, so the designated

user unlocks it and edits the properties. Once the barcode with new settings is locked
again, the BARCODELOCK file is updated.

Other users that are using the same barcode type should then click on the Refresh
icon to update the properties to the new settings.

Use encoding Selects the encoding of the data for the barcode.

See a separate chapter Text Encoding.

Text and Align Tab

Options Description

Align The options here relate to the alignment of the barcode in relation to its bounding
area, if it changes size according to changing amounts of data in the code.

Horizontal Selects the alignment in the horizontal (X) plane. The options are: Left,
Center or Right.

Vertical Selects the alignment in the vertical (Y) plane. The options are: Top, Center or
Bottom.

Data Text Position The options here relate to the alignment of the data characters.

Position Selects where the data of the code will be placed in relation to the barcode.
The options are:

None Shows no data characters.

Top left Shows the data characters above the barcode and aligned to the
left.

405
7 Layout Module

Top center Shows the data characters above the barcode and aligned to the
center.

Top right Shows the data characters above the barcode and aligned to the
right.

Bottom left Shows the data characters below the barcode and aligned to
the left.

Bottom center Shows the data characters below the barcode and aligned
to the center.

Bottom right Shows the data characters below the barcode and aligned to
the right.

Delta X Determines the offset of the data characters in the X plane. This is in relation
to the position chosen in the Position combo-box.

Delta Y Determines the offset of the data characters in the Y plane. This is in relation
to the position chosen in the Position combo-box.

Text style Selects the text style that will be used for the data of the code.

The combo-box menu lists all of the text styles that are currently created in Layout.

Conversion Converts the variable (selected in the Variables combo-box on the Content
tab) for the purpose of its presentation in the design.

The conversions that can be selected from the combo-box menu are described in the
section Field Converters and are standard to variables of string data-type in Inspire De-
signer. The 3 Dots icon opens the relevant dialog in which to define the conversion.

Show processed data If checked, the text data are displayed in the processed (coded)
form. The difference between the form of input data and the data written in the
barcode occurs if the characters available in given barcode are restricted and missing
characters are expressed by sequences of the available characters. The check-box is
by default unchecked and is available when the position of the data has a value other
than None.

Direct Metric Tab

The Direct Metric tab enables the creation of customized barcodes. The default structure is
defined by the symbology of the selected barcode, you can edit the width of bars and spaces.

406
 7.6 Layout Objects

Note This setting is not affected by the Align to Pixels feature.

This tab is available for the following barcode types: 2/5 Interleaved, Codabar, Code 128, Code
128 Empty, Code 128 UPS, Code 39, EAN 128, EAN13, EAN8, GS1 and Intelligent Mail (4-CB)
Barcode code.

Options Description

Use direct metric If this option is checked, the settings made in this tab are applied to the
barcode.

Bar width Defines the size of bars.

Note that only those fields applying to the types of bars available for the selected barcode
are editable.

Bar space Defines the size of spaces.

Note that only those fields applying to the types of spaces available for the selected barcode
are editable.

Barcode Types
Click on the appropriate barcode type to view a description of that barcode's individual para-
meters:

2/5 Datalogic

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

407
7 Layout Module

EAN13

EAN8

GS1

Intelligent Mail (4-CB) Barcode

Japan Post

Maxi Code

Micro PDF 417

OMR

PDF 417

Post Net

QR

Royal Mail

Super Stealth-Dots

UPC A

UPC E

7.6.4.2 How to Align Barcodes to Pixels

Align to Pixels adjusts a barcode's position so that it is positioned in-line with the pixel make-
up of a page. This helps avoid imperfections due to DPI resolution when printing.

408
 7.6 Layout Objects

Right-click on the barcode in the Layout Tree and select Align to Pixels, e.g.:

You can verify the results in the barcode's properties panel, e.g.:

Before

After

Aligning to Pixels When Using Different Print DPIs

In Layout it is important to set the same resolution for pixel units as is set on the printer that
will be used to print the workflow. If you are going to use printer heads with a different DPI,
it is necessary to set the DPI to the value which is the highest common divisor.

409
7 Layout Module

Example If you use the resolution 240 and 600, set 120 in Layout. Then, if the barcode
is aligned to 240 DPI, it will be aligned to pixels for resolution 600 as well.

Likewise, to print in resolutions 240, 300 and 600, you should set DPI for pixel units to
60 DPI (the highest common divisor).

240 240 240 240 300 300 300 300 300

DPI DPI DPI DPI DPI
DPI DPI DPI DPI
Size of pixel Size of pixel
300 300 300 300 300
with 120 DPI with 120 DPI 240 240 240 240 DPI DPI DPI DPI DPI
DPI DPI DPI DPI 300 300 300 300 300
Size of pixel with 60 DPI DPI DPI DPI DPI DPI
240 240 240 240
Size of pixel Size of pixel DPI DPI DPI DPI 300 300 300 300 300
DPI DPI DPI DPI DPI
with 120 DPI with 120 DPI
240 240 240 240 300 300 300 300 300
DPI DPI DPI DPI DPI DPI DPI DPI DPI

410
 7.6 Layout Objects

The image above shows the size of the highest common divisor 60 DPI. Each square
shows the size of pixel for defined DPI.

1. Go to File | Options and set the DPI for Pixel Units in the General Options section
of the Workflow Options dialog or Layout Options dialog:

2. Find your barcode in the Layout Tree and right-click on it to select the Align to
Pixels option.

411
7 Layout Module

3. In the Production environment go to the engine configuration of the engine that

you have selected and using the Resize Barcodes set of options, modify the size
of barcodes.

For example, if the ink feathers on the paper, you can then narrow down the line
by percentage or by absolute size. If both values are set, at first Relative in %
resizing is applied and then it is added/subtracted the size which is set in Absolute
edit-box. It is recommended to set the Absolute value in pixels in order to keep
control over the resolution.

Aligning to pixels can also be done in the Resize Barcodes part of engine configs for raster
engines (e.g. AFP engine config) which can also be simulated (for quick viewing of the affects)
in Proof using a raster proof profile.

7.6.5 Border Styles

In this section: See also:
Border Styles Layout Properties Border Properties Dialog
Variable Border Style How to Create or Modify a Border Style

Border styles can be used to specify:

Borders that employ line styles and fill styles and whose corners can be designed indi-
vidually.

Fill styles for backgrounds and shadow effects.

Margins and offsets to control the placement of border styles.

Border styles which have been designed here can be used with a number of layout objects:

Paragraph styles on the Borders tab.

Text styles on the Border tab.

Flow areas on the Border tab.

Cells

412
 7.6 Layout Objects

Complete tables on the General tab.

Selected cells of tables

To create a new border style, do the following:

1. Right-click on the Border Styles family in the Layout Tree and select Insert Border
Style from the context menu.

2. Click on the newly created border style (e.g. BorderStyle1) to display the Layout Prop-
erties panel and define its attributes.

3. Click on the Rename icon and give the style an appropriate name.

See the How to Create or Modify Border Style section for a more detailed description and a
step-by-step example.

7.6.5.1 Border Styles Layout Properties

Note When you want to generate your design employing border styles via HTML engines,
see the respective HTML and HTML Simple engine configuration section for a description of
supported border style features.

The Border Styles layout properties feature a preview area located above the tabs. Here, the
visual effect of the settings being made in the tabs is displayed. This allows you to directly view
the results of the modifications being made for borders.

The following four tabs are available for modifying border styles:

Lines/Corners

Shading

Margins

Offsets

Preview Area
The preview area is very helpful when creating new border styles as it displays the border style
being created allowing you to directly see the effect of the settings you are making.

Grouped around this preview area are icons allowing you to vary the zoom level of the preview
and to set which part of the border the settings being made will be applied to, e.g. the left
border, the upper right corner or all borders and corners together. To select several of the icons
in order to be able to modify several parts of the border simultaneously, press <Ctrl> while

413
7 Layout Module

selecting the desired icons. Additionally, the three icons placed in the left corner above the
preview area facilitate multiple selections of border elements. For details on the exact function-
ality of each icon see the list below the screenshot.

When selecting several parts of a border for modification which have different values set for
a certain option, that option will be highlighted by a blue background.

Example Imagine you have selected the Left Line icon and specified 1 mm in the
Line width edit-box and have then selected the Top Line icon and specified 0.5 mm
for the same option.

If you then select both of these icons (using the <Ctrl> button), the value 0.5 mm will be
displayed as this was the last setting you made in this edit-box. However, as the values
for the two selected icons are not identical, the value will be displayed with a blue back-
ground to indicate this fact:

To apply this displayed value to all of the parts of the border whose icons are selected,
there are two possibilities:

If the cursor is placed inside the edit-box simply press <Return> and the value will
be applied to all selected parts of the border; the blue background will disappear.

If you change the value in the edit-box this change will be applied to all selected
parts of the border; the blue background will disappear.

Options Description

Group Border Icons These icons allow you to quickly select the most common groups of
border line/corner icons for modification.

All Borders Selects all outside border line and corner icons located below the preview
area for modification. Any modifications made on the Lines/Corners tab will be applied
to all four outside borders and to all four corners.

This is the default setting (see the screenshot above for reference).

All Lines Selects all four border line icons located below the preview area for modi-
fication. Any modifications made on the Lines/Corners tab will be applied to all four
outside borders.

All Corners Selects all four corner icons located below the preview area for modific-
ation. Any modifications made on the Lines/Corners tab will be applied to all four
corners.

414
 7.6 Layout Objects

Zoom Icons

Zoom Out Zooms out of the preview.

Zoom 1:1 Sets the zoom back to the standard (default) zoom value.

Zoom In Zooms in to the preview.

Individual Border Icons These icons allow you to select individual parts of the border for
modification. Any modifications made will only be applied to the parts of the border for
which the according icons listed below have been selected. These icons only affect the
way modifications made on the Lines/Corners tab will be applied, all other tabs work in
the same way regardless of which of these icons are selected or not.

Tip To select several of these icons simultaneously, press and hold <Ctrl> while selecting
the desired icons.

Left Line Selects the left border line for modification.

Top Line Selects the top border line for modification.

Right Line Selects the right border line for modification.

Bottom Line Selects the bottom border line for modification.

Left Right Line Selects the diagonal line going from the top left corner to the bottom
right corner for modification.

Right Left Line Selects the diagonal line going from the bottom left corner to the
top right corner for modification.

Upper Left Corner Selects the upper left corner for modification.

Note Any settings made for corners are only applied when the setting for Corner
on the Lines/Corners tab is not Standard.

Upper Right Corner Selects the upper right corner for modification.

Note Any settings made for corners are only applied when the setting for Corner
on the Lines/Corners tab is not Standard.

Lower Left Corner Selects the lower left corner for modification.

Note Any settings made for corners are only applied when the setting for Corner
on the Lines/Corners tab is not Standard.

Lower Right Corner Selects the lower right corner for modification.

Note Any settings made for corners are only applied when the setting for Corner
on the Lines/Corners tab is not Standard.

415
7 Layout Module

Lines/Corners Tab

Options Description

Line fill style Selects a fill style for the lines of the border style.

Fill styles can be colors, gradients, patterns, images or variable. See the section Fill Styles
for a description of the menu of this combo-box.

Line width Sets the width of the outline in specified units.

Cap Selects the appearance of the line ends. Available options are Butt, Round or Square.

Note Caps are not supported by the AFP engine config if Graphic support is set to Full
with outlines on its General tab.

Line style Enables you to select an existing line style that will be applied on the outline or
to create a new line style.

Corner Selects the shape of the corner. Available options are: Standard, Round, Round Out,
Cut Out, or Line Corner.

Values other than Standard allow you to set values for Radius X and Radius Y.

Example All examples below have Radius X and Radius Y set to 10mm.

Round is selected:

Round Out is selected:

Cut Out is selected:

416
 7.6 Layout Objects

Note The visual effect of corner settings depends on the size of the cell it is applied
to.

Radius X Sets the horizontal radius value for the selected corner(s), i.e. sets the position
where the selected Corner effect starts. By default, the value 5 mm is set.

See the example screenshot included with the explanation of Radius Y just below for a
closer explanation.

This option is only available when Round, Round Out, Cut Out, or Line Corner has been
selected in the Corner combo-box.

Radius Y Sets the vertical radius value for the selected corner(s), i.e. sets the position where
the selected Corner effect starts. By default, the value 5 mm is set.

Example For this border style, Corner has been set to Round and Radius X and
Radius Y have each been set to 10 mm:

Legend

1 The length of the yellow line corresponds with the value set in the Radius X
combo-box. In this case it is 10 mm from the left border of the border style to
the point where the corner effect begins.

2 The length of the yellow line corresponds with the value set in the Radius Y
combo-box. In this case it is 10 mm from the top border of the border style to
the point where the corner effect begins.

This option is only available when Round, Round Out, Cut Out, or Line Corner has been
selected in the Corner combo-box.

417
7 Layout Module

Shading Tab

Options Description

Join Selects the shape of the corners. The following options are available:

Miter pointed corners

Round rounded corners

Bevel flattened corners

Miter Sets the degree of mitering.

Note Setting Miter to a value below the square root of 2 (approximately 1,414) will
have an effect on the corners resembling the Bevel option in Join. The effect of the value
set for Miter depends on the angle in which lines join at a corner (in this case 90 degrees).

Fill Selects a fill style for the interior of the border style.

Fill styles can be colors, gradients, patterns, images or variable. See the section Fill Styles
for a description of the menu of this combo-box.

Shadow Selects the fill for the shadow. It is possible to select either an existing fill style or
create a custom fill style.

Note The fill style set here will only be visible if settings for Sh. Offset X and/or Sh.
Offset Y are made.

Sh. offset X Sets the horizontal offset of the shadow in relation to the border.

Note Setting a positive value will place the shadow to the right, a negative value will
place the shadow on the left.

Sh. offset Y Sets the vertical offset of the shadow in relation to the border.

Note Setting a positive value will place the shadow below, a negative value will result
in the shadow being placed above.

418
 7.6 Layout Objects

Margins Tab

This tab is used for setting the size of the margins. Left, Right, Top and Bottom margins can
be set individually.

Handling of margins differs depending on the context in which the border style is later used.
Normally, the values set here control the amount of space between the content of the flow
area (e.g. a text flow or tables/cells) and the flow area boundary. See the example Offsets and
Margins in Tables, Flow Areas and Cells for details.

But, when border styles are employed with paragraph styles and text styles, the effect of the
setting made here depends on the settings made on the Offsets tab. See the Offsets and
Margins in Text and Paragraph Styles example for details.

Tip If you want to change the unit of measurement, you can do this by clicking on the icon
.

Offsets Tab

This tab is used for setting the offset values. Left, Right, Top and Bottom offsets can be set
individually.

Handling of offsets differs depending on the context in which the border style is later used.
Normally, the values set here control the amount of space between the border line/fill style
(visible when a fill style has been set in the Line fill style combo-box on the Lines/Corners tab
or a Fill has been set on the Shading tab) and the flow area boundary. See the example Offsets
and Margins in Tables, Flow Areas and Cells for details.

But, when border styles are employed with paragraph styles and text styles, the effect of the
setting made here depends on the settings made on the Margins tab. See the Offsets and
Margins in Text and Paragraph Styles example for details.

Tip If you want to change the unit of measurement, you can do this by clicking on the icon
.

419
7 Layout Module

Example Offsets and Margins in Tables, Flow Areas and Cells

See this sample screenshot showing the effect of setting values on the Margins and Offsets
tabs of a border style which is then used in a flow area. For the used border style, all
margins have been set to 8 mm and all offsets to 4 mm. Border styles applied to tables
via the layout properties or the Border properties dialog as well as border styles applied
using the layout properties of cells work in the same way.

Legend

1 The border; the fill style used for displaying it is set in the Line fill style combo-box
on the Lines/Corners tab.

2 The flow area boundary

3 The margin (set to the value 8 mm in this example) determining the distance between
the flow area boundary and the content (in this case text) within the flow area.

4 The offset (set to the value 4 mm) determining the distance between the flow area
boundary and the border which has been set.

Example Offsets and Margins in Text and Paragraph Styles

When border styles are used with text styles or paragraph styles the application of the
values set on the Offsets and Margins tabs differs from the functionality described in the
example just above. Settings for margins and offsets are now used only to control the
position of the border in relation to the text whose position does not change. The
screenshots below show the effect on a paragraph style, the handling of text styles is
identical.

If the values set for margins and offsets are the same, there is no change in the position
of the border; i.e. the border overlaps the flow area boundary as by default:

420
 7.6 Layout Objects

If, however, the value set for a margin is higher than the according value set for the offset,
the border extends beyond the flow area boundary by the difference between the margin
and the offset values. In the screenshot just below, the Left combo-box on the Margins
tab is set to 2 mm while the Left combo-box on the Offsets tab is set to 0 mm. This makes
the left border extend 2 mm beyond the flow area boundary:

If, on the other hand, the value set for a margin is lower than the according value set for
the offset, the border is moved inside of the flow area boundary by the difference between
the margin and the offset values. In the screenshot just below, the Left combo-box on
the Margins tab is set to 0 mm while the Left combo-box on the Offsets tab is set to 2
mm. This makes the left border move 2 mm inside of the flow area boundary:

7.6.5.2 Variable Border Style

It is possible to have the same Layout object displayed with various border styles according to
specific conditions that are set. To create a variable border style, do the following:

1. Right-click on the BorderStyles node in the Layout Tree and select the option Insert
Variable Border Style. A new node representing a variable border style will be inserted.

Alternatively, select an existing border style in the Layout Tree and select the option
Promote to Variable Border Style from its context menu. This action creates a new
node under the BorderStyles family in the Layout Tree, which represents the newly
created variable border style. This node has a nested border style a copy of the original
promoted border style. To the name of the original border style the digit "1" is appen-
ded, as it cannot have the same name as the variable border style.

2. In the Layout Properties panel, set the condition type and assign other border styles to
each of the created conditions. These border styles will appear under the node of the
variable border style.

3. The variable border style is ready to be used with a Layout object of your choice.

Example Your task is to create a table with a repeated row with alternating green and
red background color.

421
7 Layout Module

1. Create two new border styles: one with green fill, the other one with red fill (you
can find the Fill combo-box on the Shading tab).

2. Create a calculated Bool variable and name it Color. On the Script tab, set a con-
dition that returns true, if the index of the cell is even. In that case, the green
border style is used. If the index is odd, the red border style is applied. The script
will look as follows: ROWSETS.RowSet_1.Index%2 == 0

3. Create a variable border style. Set Type to Select by condition and assign the red
border style as Default. Create a new condition, set Color as the variable and the
green border style as the assigned border style.

4. Create a table with repeated body. Highlight the repeated cell in the Layout Tree
and in its Properties panel select the variable border style in the Border style
combo-box.

7.6.6 Charts
7.6.6.1 Charts
In this section See also:
Charts Layout Properties Chart Properties Dialog
Description of Individual Chart Features Chart Examples
Using Variables in Charts How to Create a Simple Chart
How to Create Custom Image Charts

Charts are an effective way to format and display information. Inspire Designer provides a wide
range of options for creating charts, which can be based on either on static or variable data.
For a list and visual overview of the chart types available see the description of the Chart Type
tab.

To create a chart, do the following:

1. Click on the Chart tool in the Tools toolbar.

2. Hold down the left mouse button and, in the Layout Window, draw a rectangle to
contain the chart.

422
 7.6 Layout Objects

3. Complete the Chart Layout Properties.

4. Make the appropriate settings in the Chart Properties dialog.

Tip You can complete the Layout and Chart Properties panels in any order you wish. Only
very basic attributes for the chart can be set in the Charts Layout Properties panel; to make
advanced settings, click on the Advanced Properties button located there to open the Chart
Properties dialog or double-click on the created chart.

Charts Layout Properties

There are two panels of properties associated with charts:

Position

General

Position Tab
Refer to Position Tab section for details.

General Tab

Options Description

Series count Sets the number of iterations contained in each value category.

Values count Sets the number of value categories the chart will have. Each value category
will be made up of the number of iterations set in the Series count edit-box.

Fill with Random Values Fills the chart with random dummy values.

A graph cannot be shown unless some values are entered. Most commonly, charts are
used to display variable-data and so the values of that data are not known at the time of
designing the graph.

Click on this button repeatedly to see how the chart will look with different sets of values,
especially if you change the Values count because new values are not automatically added
to the preview. The values are added to the Values tab tab of the Chart Properties dialog,
so if you have already added other values there yourself they will be overwritten.

Advanced Properties Opens the Chart Properties dialog where you can specify the custom
appearance of the chart.

423
7 Layout Module

Description of Individual Chart Features

All charts have a set of features that can be adjusted individually using the Chart Properties
dialog.

Legend

1. The background fill style can be set on the Placement tab.

2. The title and the text style in which it will be displayed can be set on the Point Label
tab.

3. You can specify the position, color, line width and a text label (not used in the above
example) on the Line tab.

4. You can set the color and line width of this series border on the Series General tab.

5. You can set vertical and horizontal (as in the above example) stripes, define their exact
position and color on the Stripes tab.

6. You can set the color, line style and width of the axis grid for both the X and Y axis on
the Axis Grid tab.

7. Apply a border to the chart and determine the color and width of the line on the Border
tab.

424
 7.6 Layout Objects

8. A legend can be created on the Chart Type tab and many attributes determining its
appearance can then be specified on the Legend tab.

9. Have point labels displayed and determine their appearance on the Point Labels tab.

10. This chart has 3 series. You can set the number of series you need for your chart on
the Chart Type tab.

11. This chart has 3 values. The number of values needed for your chart can be set on the
Chart Type tab. The labels for these values can be set on the Labels tab.

12. It is possible to enter custom margins between the chart and the border (number (7))
on the Placement tab.

13. Use the Tick Marks tab to specify the occurrence of axis labels displaying chart values
or use the Labels tab to enter custom values for your axis labels.

14. Create a space between the various series of your chart using the Volume option on
the Border tab.

See also: How to Create a Simple Chart.

Using Variables in Charts

As you will see below, you can use variables to control many aspects of the appearance of
charts you create. Keep the followings facts in mind:

1. Variables containing values which are used to determine the appearance of the chart
must be converted to BC.-Double, BC.-Int, BC.-Int64 or Currency using the Data
Transformer module so that they can be used in charts (see an example of this proced-
ure). This applies to the options using variables on the following tabs:

Axis General tab:

Min. Value

Max. Value

Tick Marks tab:

Major size variable

Minor size variable

Stripes tab:

From

To

From Variable

To Variable

425
7 Layout Module

Lines tab:

Value

Value Var.

Values tab:

Value Variable

Value From Variable

Value Var.

Value Form Var.

Note Variables used for determining labels do not need to be converted in this way.

2. The effect of the values entered via variables will not be visible in the preview area of
the Charts Properties dialog or in the chart you have created in the Layout area. Only
when proofing your job (by pressing <F6>) will you see the chart created by using the
variables that have been specified in the according tabs.

7.6.6.2 Chart Properties Dialog

In this section: See also:
Note on the Z-order in Charts Charts
Chart Examples
How to Create a Simple Chart
How to Create Custom Image Charts

To access the Chart Properties dialog, do one of the following:

In the Layout, double-click on the chart entry (node) in the Layout Tree.

Double-click on the chart itself in the Layout Area with the Selection tool or the
Chart tool active from the Tools toolbar.

On the General Tab of the Chart Layout Properties panel, click on the Advanced
Properties button.

426
 7.6 Layout Objects

The major tabs are those that appear uppermost. They are:

General

Axis

Series

Legend

As you enter values into the panels, the preview at the top of the dialog reflects the changes
made. It is recommended that you go through the options and use the Preview image to help
decide the effect that is most suited to your graph. To implement the settings to the chart in
the Layout window click on Apply or OK.

General Tab
The following sub-tabs can appear within the General tab depending upon the Chart Type
selected on the Chart Type tab:

Chart Type

Line Properties

427
7 Layout Module

Placement

Border

Point Labels

Guide Lines

Render Options

Chart Type Tab

Here you set the most basic chart properties such as the type of chart you want to use and the
number of series and values the chart will have. The options vary according to which Chart
Type is chosen. If Pie chart in 3D, Doughnut chart in 2D or Doughnut chart in 3D has been
selected, the Chart Properties has a considerably different appearance. See the Variant for
3D Pie Charts and Doughnut Charts section for details.

Options Description

Chart Type Selects the type of chart:

Row 1: Bar chart in 2D, Bar chart in 2D landscape, Bar chart in 3D and Bar chart
in 2D landscape.

Row 2: Stack bar chart in 2D, Stack bar chart in 2D landscape, Stack bar chart in
3D, Stack bar chart in 3D landscape, Percentual stack bar chart in 2D, Percentual
stack bar chart in 2D landscape, Percentual stack bar chart in 3D and Percentual
stack bar chart in 3D landscape.

428
 7.6 Layout Objects

Row 3: Line chart in 2D, Line chart in 3D, Line stack chart in 2D, Line stack chart
in 3D, Percentual line stack chart in 2D, Percentual line stack chart in 3D and XY
line chart in 2D only.

Row 4: Pyramid chart in 2D, Pyramid chart in 3D, Pyramid stack chart in 2D, Pyramid
stack chart in 3D, Pyramid percentual stack chart in 2D and Pyramid percentual
stack chart in 3D.

Row 5: Cylinder chart in 2D, Cylinder chart in 3D, Cylinder stack chart in 2D, Cylinder
stack chart in 3D, Cylinder percentual stack chart in 2D and Cylinder percentual
stack chart in 3D.

Row 6: Cone chart in 2D, Cone chart in 3D, Cone stack chart in 2D, Cone stack
chart in 3D, Cone percentual stack chart in 2D and Cone percentual stack chart in
3D.

Row 7: Pie chart in 2D, Pie chart in 3D, Doughnut chart in 2D, Doughnut chart in
3D, Rendered pie chart in 3D, Rendered doughnut chart in 3D, Bar line chart in
2D, Bar line chart in 3D, Radar chart in 2D only and Custom image chart in 2D
only.

Row 8: Funnel chart in 2D, Funnel chart in 3D.

Chart Properties

Series count Sets how many series of values will be displayed.

How series are shown is dependent on Chart Type, e.g. for pies and funnels one
series is one chart but, for bars, a series is a set of bars that relate to the same value.
See number (10) in the Description of Individual Chart Features or see How to Create
a Simple Chart.

Line series count Specifies how many of the series will be displayed as lines.

This option is only available when Bar/Line charts are selected. The maximum value
is the value set in Series count 1, i.e. Bar/Line charts will always have at least one
series displayed as a bar.

Values count Sets the number of value categories the chart will have.

Each value category will be made up of the number of iterations set in the Series
count edit-box.

See number (11) in the Description of Individual Chart Features or see How to Create
a Simple Chart.

Fill with Random Values Fills the chart preview on the dialog with random dummy
values.

A graph cannot be shown unless some values are entered. Most commonly, charts
are used to display variable-data and so the values of that data are not known at the
time of designing the graph.

Click on this repeatedly to see how the chart will look with different sets of values,
especially if you change the Values count because new values are not automatically
added to the preview. The values are added to the Values tab, overwriting any other
values that may have been entered there.

429
7 Layout Module

Bar 3D depth Changes the angle and depth of 3D charts.

This option is available for all 3D charts except pies and doughnuts.

Gaps between values / Gaps between series Determines the distance between the
different values/series in the chart.

For bars, cylinders, pyramids and cones: If a value higher than 1 is set for Values
count, Gaps between values controls the distance between the value sets that are
composed of the different series. This is done as a percentage of the Bar width.

For pies, doughnuts and funnels: If a value higher than 1 is set for Series count,
Gaps between series controls the distance between the different charts. The value
is proportional to the size of the chart.

Edit Bar Width Opens the Edit Bar Width dialog which sets Bar width and Gap width
separately. If editing size in this way, the Gaps between values value will be recal-
culated accordingly.

Bar width Determines the width of all bars.

Gap width Determines the width of all gaps between series.

Fit fills to shapes If checked, any image used as a fill style on the Values tab will be
scaled in order to fit individual series indicators.

If unchecked, the image will be spread across all series for which this image has been
selected.

This option cannot be set if Rendered pie chart in 3D or Rendered doughnut chart in
3D are selected for Chart Type.

Example This is the image used in the fill style applied to the charts below:

When Fit fills to shapes is enabled the fill style will appear like this:

430
 7.6 Layout Objects

When Fit fills to shapes is disabled the chart will appear like this:

Worldwide support If checked, languages with right-to-left reading order (Arabic,

Hebrew, Indic, etc.) are supported for the charts.

See the Arabic, Hebrew, Indic Languages Support section for further details.

Supplementary character support If checked, supports the supplementary characters

within the selected chart flow area.

If Supplementary character support is checked in the General Options section of

the Workflow or Layout Options dialog, every new chart will have the supplementary
characters support enabled by default.

Categories in reverse order Changes the order of the categories on the X-axis (for
landscape oriented bar charts on the Y-axis) from ascending to descending when se-
lected.

This option works with bar and pie charts. When employing this option with bar
charts the series which are used in the chart are also reordered within the chart and
accordingly on the Values tab, i.e. the last series becomes the first etc.

Example Normally, charts are displayed with categories in ascending order:

431
7 Layout Module

But if Categories in reverse order has been selected for a chart, it will appear
with the categories on the X-axis displayed in descending order and the order
of the series within the categories will also be changed:

For pie charts, the drawing of categories starts on the right side of the chart
(with the blue-colored pie slice) and proceeds clock-wise:

When Categories in reverse order is selected, drawing will begin with the last
category (the green-colored pie slice) and proceed in reverse order:

Scale to fit If checked, the chart is adjusted (shrunk) to fit within the chart borders with
all point labels.

For WFD files created in PrintNet T 6.1 and earlier opened in version 6.2 and later,
this check-box is disabled.

Show legend Displays a legend with the chart.

The position and content of the legend can be adjusted on the Legend tab which is
only available when this option is checked.

Variant for 3D Pie Charts and Doughnut Charts

If Pie chart in 3D, Doughnut chart in 2D and Doughnut chart in 3D have been selected as a
chart type, the Chart Properties field of the Chart Type tab has the following extra options

432
 7.6 Layout Objects

(availability depends on the exact chart type selected, see the notes in the options descriptions
for details):

Options Description

Chart Properties

Pie 3D flatness Changes the angle from which the pie chart/doughnut chart is viewed.

Note This option is available only when Pie chart in 3D or Doughnut chart in 3D
has been selected.

Pie 3D bar height Alters the height of the pie chart/doughnut chart.

Note This option is available only when Pie chart in 3D or Doughnut chart in 3D
has been selected.

Inner/outer ratio(%) Sets the size of the inner circle of a doughnut chart in comparison
to the outer circle in %.

Note This option is available only when Doughnut chart in 2D or Doughnut chart
in 3D has been selected.

Note When Rendered pie chart in 3D and Rendered doughnut chart in 3D has been selected,
the Chart Properties field is not available. See the Render options tab which is available for
this type of chart for related settings.

Line Properties Tab

This tab is available only for the following chart types:

Line charts

Bar/line charts

Radar charts

Options Description

Fill areas below lines If checked, the space below the lines is filled with solid color.

Line chart one-based with offset If checked, the lines do not start at 0 but at 1. This
option is enabled by default.

433
7 Layout Module

Example Line chart with Line chart - one-based with offset disabled:

Line chart with Line chart - one-based with offset enabled:

Note This option is available only for Line charts.

Placement Tab
This tab enables you to set the charts position within the chart object created in the Layout
Area and to set fill styles for the background of the whole chart and for the area occupied by
the series.

Options Description

Top, Bottom, Left, Right margin: Sets a value for the according margin between the chart
objects border and the chart itself. See number (12) in the Description of Individual Chart
Features above.

Background fill Specifies the fill style for the complete chart object.

Series fill Specifies the fill style for the area behind the series.

Note This option is not available for pie charts and doughnut charts.

434
 7.6 Layout Objects

Border Tab
If the Use border option is checked, a border will be drawn around the chart object and it is
possible to set properties for it.

Tip When using a border around a chart it can be helpful to set margins on the Placement
tab to improve the overall appearance of the chart.

Options Description

Border

Use border If checked, a border will be drawn around the chart object.

Note Values for Border fill style and Border width must be specified for the
border to be visible.

Border fill style Sets the color/fill of the border.

Border width Sets the width of the border.

Others

Volume Sets the margin to the left and right of the values displayed on the X-axis (or
Y-axis when charts with landscape orientation are used). The default value is 5.

Example A chart with the default setting for Volume looks like this:

435
7 Layout Module

The same chart with Volume set to 25 (5x the default value) looks like this:

Note This setting has no effect when using Line charts, XY line charts and Radar
charts.

Point Labels Tab

When the Use point labels option is checked, point labels will be displayed and you can specify
their properties. Additionally it is possible to enter the chart title on this tab. For XY line chart
in 2D only you can make further specifications in the Point label content field.

Note Point labels are not available when Rendered pie chart in 3D or Rendered doughnut
chart in 3D have been selected on the Chart Type tab.

Options Description

Point Label Common

Use point labels If checked, point values will be displayed. The exact position of the
point labels can be specified in the combo-boxes below. By default, the actual values
of the points will be displayed in the point labels. Alternatively, you can set custom
point labels or specify a variable containing the point labels on the Values tab.

Vert. align Sets the vertical alignment of the point labels. Options are: Top, Bottom,
Center, Bar Center and Outside.

436
 7.6 Layout Objects

The Outside option is useful when employing point labels to positive as well as neg-
ative values and you want to have them displayed outside the bar in both cases to
increase readability.

Example See the three screenshots below to see the different effect of Vert.
align settings (the Horiz. align has been set to Right):

Top

Center

Outside

Additionally, the Additional offset has been set to - 0.5 so that the
negative value is not written over the axis X.

Horiz. align Sets the horizontal alignment of the point labels. Options are: Right, Left,
Center, Left outside, Right outside and Nearest point.

The Nearest point option is useful when employing point labels which are rotated by
a value specified in the Rotation edit-box available just below this option.

Example See the two screenshots below to see the different effect of setting
Center and Nearest point when point labels are rotated (vertical axis grid lines
in red have been set to indicate the center of the bars).

Center has been set:

437
7 Layout Module

Nearest point has been set:

When Nearest point is selected the point label is centered according to the point
of the point label closest to the bar and not according to the overall width of
the point label as when Center is selected.

Rotation Determines the degree of rotation of the point labels.

Additional offset as This option is available only for the following chart types: Line
charts, XY line charts, Bar/line charts and Radar charts.

Sets the position of the label relative to the line. You can choose from the following
options:

relative Y value Sets the point label above the point being labeled.

Example The option relative Y value is selected:

distance from tangent Sets the point labels either above or below the line
depending on the tangent of the lines dynamic over 3 points on the graph,
i.e. outside of the curve if you consider the curve to be made of 3 consecutive
points on the same line and the labeled point is the middle of the 3.

It is, perhaps, easier to imagine 3 X-values A, B and C and the lines between
them forming an angle at point B. The point label for point B will be placed
on the side of the angle which is greater than 180 degrees.

438
 7.6 Layout Objects

Example The option distance from tangent is selected:

Note When distance from tangent is selected the Vert. align and Horiz.
align combo-boxes are disabled.

Additional offset Allows you to set a custom vertical offset between the point label
and the point being labeled.

Note When using charts in landscape orientation this option will set the horizontal
offset.

Paragraph style Sets the paragraph style controlling the appearance of the point labels.

Label text style Sets the text style of the point label.

Format width Sets the maximum width a point label can have. Point labels which need
more space will wrap to a new line.

Note The maximum width set here is only applied to custom point labels specified
on the Values tab in the Point Label column or by a variable on the same tab.

Tip You can also insert line breaks into point labels to control the point where the
text should wrap to a new line. See the section Point Labels with Line Breaks for de-
tails.

Hide point labels If checked, point labels up to the value specified in the Limit in (%)
edit-box will not be displayed.

Note This option will only hide point labels if an appropriate value has been specified
in the Limit in (%) edit-box.

Limit in (%) This edit-box is only available when Hide point labels has been enabled.
All point labels whose values are below the limit specified in % will not be displayed.
The limit is calculated from the largest value present in the chart.

Example If you have a pie chart with the values 10, 8, 6, 4 and 2 and then
enable Hide point values and set the value for Limit in (%) to 50, only the
labels for the values 6, 8 and 10 will be displayed. The limit is calculated using
the largest value in the chart (in this case 10) and the setting for Limit in (%)
(in this case 50), thus, for this example, the limit below which point labels will
be hidden is 5.

Do not overlap point labels When this option is checked, the position of point labels
which overlap each other will be adjusted in order to keep them readable.

439
7 Layout Module

Title Properties

Title Specifies the title of the chart. The title will be displayed above the chart.

Title text style Sets the text style of the title of the chart.

Point Label Content

Note The options below are available only when XY line chart in 2D only is selected on
the Chart Type tab.

Content of Specifies the values which will be displayed in the point labels. Options are:
X value, Y value and Both values. When Both values is selected, you can additionally
specify values for the three edit-boxes below.

Insert before Specifies text which will be displayed in the point labels before the first
(= X) value.

Insert between Specifies text which will be displayed in the point labels between the
X and Y values. A comma , is set as default.

Insert after Specifies text which will be displayed in the point labels after the second
(= Y) value.

Guide Lines Tab

This tab is available only for the following chart types:

Pie chart in 2D

Pie chart in 3D

Doughnut chart in 2D

Doughnut chart in 3D

Funnel chart in 2D

Funnel chart in 3D

For the settings made here to be applied the Use point labels option on the Point Labels tab
must be enabled.

440
 7.6 Layout Objects

Options Description

Show guide lines If checked, guidelines are displayed which connect each slice of a pie
chart, part of a doughnut or funnel chart with the according point label.

Guide line width Sets the width of the guidelines.

Guide line style Sets the line style of the guidelines.

Guide fill style Sets the color/fill style of the guideline.

Guide lines from edge If checked, the guidelines start from the edge of the pie/dough-
nut/funnel chart, not from the middle of the according slice of a pie chart, part of a
doughnut or funnel chart.

Underline labels If checked, the guidelines are lengthened and additionally underline the
point label.

Advanced label positioning If enabled, point labels are repositioned so that their position
better corresponds to the according chart part. This option applies only to the pie and
doughnut chart types. For WFD files created in the PrintNet T 6.1 and earlier opened in
version 6.2 and later this option is disabled.

Render Options Tab

This tab is available only when one of the following chart types have been selected:

Rendered pie chart in 3D

Rendered doughnut chart in 3D

441
7 Layout Module

Options Description

Pie Chart Render Options

Render DPI Sets the DPI of the rendered chart. When the Use proportion to PDF DPI
option is checked these edit-boxes become unavailable.

Use proportion to PDF DPI When you select this option it is possible to set a value in
the Proportion to PDF DPI edit-box. Additionally, the Render DPI edit-boxes become
unavailable.

Proportion to PDF DPI Sets a value specifying the DPI of the rendered chart in compar-
ison to the PDF DPI which is set in the Engine Configuration dialog of the Output
engine you are using.

Example If you have set the DPI to 480 in the Engine Configuration dialog
and specify 2 in this option, the chart will be rendered to 240 DPI.

Note This option is only available when Use proportion to PDF DPI has been se-
lected.

Antialiasing Checking this option will lead to a smoother appearance of borders and
lines in the pie chart/doughnut chart. It is selected by default.

Shadows Enabling this option will create shadows on pie slices/doughnut pieces expan-
ded from a rendered pie chart.

Example Shadows is enabled:

Shadows is disabled:

Tip Expand values for pie slices/doughnut pieces can be set using the Expand
column on the Values tab.

442
 7.6 Layout Objects

Radius Specifies the radius of the pie chart/doughnut chart.

Side radius Specifies the side radius of the pie chart/doughnut chart.

Camera Settings The settings in this section allow you to determine the position of the vir-
tual camera which in turn sets the way the chart is displayed.

Use setup with angles Activates the Rotation angle, Vertical angle and Distance
edit-boxes which allow you to determine the position of the virtual camera. This option
is selected by default.

If you disable this option, the Camera Settings area changes and the following options
are available for setting the camera:

Position Allows you to specify the camera position. You can specify the X, Y and
Z positions individually.

Heading Allows you to specify the point the camera is aimed at. You can specify
the X, Y and Z positions individually.

Rotation angle Sets the rotation angle of the virtual camera, i.e. the displayed chart
will be rotated. The default value is 0.

Vertical angle Sets the vertical angle of the virtual camera in respect to the chart, i.e.
the tilt of the chart is set. The default value is 45.

If you e.g. set the value 90, the chart will appear flat as this equals viewing the chart
from the top. On the other hand, setting the value 0 means the chart will be seen
from the side.

Distance Sets the distance between the virtual camera and the chart in relation to the
viewport in use, i.e. this setting alters the size of the chart within its container. The
default value is 5.

Pie Chart Lights Two pie chart/doughnut chart lights are set by default (see the screenshot
of the Render options tab above). You can modify these pie chart lights or add further
lights to change the appearance of the rendered pie chart.

Color Sets a color for the selected pie chart/doughnut chart light.

X Sets the X-position of the selected pie chart/doughnut chart light.

Y Sets the Y-position of the selected pie chart/doughnut chart light.

Z Sets the Z-position of the selected pie chart/doughnut chart light.

Create New Creates a new row in the pie chart/doughnut chart lights list.

Delete Deletes the selected row from the pie chart/doughnut chart lights list.

443
7 Layout Module

Axis Tab
There are six different sub-tabs that can appear within the Axis tab. What appears depends
upon the type of chart you have created. These sub-tabs are:

Axis General

Tick Marks

Axis Grid

Labels

Stripes

Lines

Note The Axis tab with all sub-tabs is not available for pie charts, doughnut and funnel
charts.

Axis General Tab

Here you can set basic properties for the X and Y axis of the selected chart.

444
 7.6 Layout Objects

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Axis Common

Force zero This option is only available for the Y axis. Selecting Force zero sets the
value in the Min. value edit-box to 0 if Autofit has also been enabled. Force zero
is enabled by default.

Note When Autofit is disabled, enabling or disabling Force zero will have no ef-
fect.

Time based If checked, the Min. value and Max. value combo-boxes are time based.
Instead of a value, you can now enter dates. Opening the combo-box opens the fol-
lowing dialog which enables you to easily select the desired date value:

Clicking Now enters the current date, pressing OK confirms the entered value.

Decimals Sets the number of places that will appear to the right of the decimal point
when displaying axis values.

Note This option is not available when Time based is enabled.

Scale unit Scales the space between each value label on the selected axis. Setting Scale
unit to a value above 1 makes the space larger, values below 1 make the space
smaller. When appropriate, the values of the axis labels will be adjusted. If you have
enabled point labels on the Point Label tab, the values displayed in them will also be
adjusted accordingly.

Note This option is not available when Time based is enabled.

Min. value Sets the minimum value for the selected axis. The second combo-box allows
you to select a variable to control this value.

Note This option is not available if Axis X is selected in the Axis combo-box (except
for XY line charts). If Axis Y is selected it is only available when Autofit has been
disabled.

Max. value Sets the maximum value for the selected axis. The second combo-box allows
you to select a variable to control this value.

445
7 Layout Module

Note This option is not available if Axis X is selected in the Axis combo-box (except
for XY line charts). If Axis Y is selected it is only available when Autofit has been
disabled.

Conversion Following conversion types are available for transforming the axis values
displayed for the selected axis:

BC.-String

BC.-Int

BC.-Int64

BC.-Currency

BC.-Bool

StackFCVs

Script

Format

Euro Converter

Numerical formatting

Number to Spell

Nice rounded maximum If checked, this option rounds the values in the Min. value
and Max. value combo-boxes to integers (e.g. -3, -2, -1, 0, 1, 2, 3 etc.).

Note This option is not available when Axis X has been selected in the Axis combo-
box (except for XY line charts) or when Autofit has been enabled.

Autofit When selected, the value in the Max. value combo- box is automatically adjusted
to the highest value set for the chart in the Values tab. The value in the Min. value
combo-box is always set to:

0 when Force zero has been selected.

To the lowest value set for the chart in the Values tab when Force zero has
been disabled.

Note This option is not available when Axis X has been selected in the Axis combo-
box (except for XY line charts).

Visible If checked (as it is by default), the axis line, tick marks (if set on the Tick Marks
tab) and axis labels are visible.

Default If selected, the objects mentioned above are visible at the default place for
the chart type.

In foreground If selected, the objects mentioned above are visible in the foreground
of the chart.

In background If selected, the objects mentioned above are visible in the back-
ground of the chart.

446
 7.6 Layout Objects

Axis line width Sets the width of the axis line.

Axis fill style Sets the color/fill of the axis line.

Axis 3D style Sets the color/fill of the depth of the axis line (this setting only takes effect
when 3D charts are used).

Align axis Aligns the selected axis with the border of the container in which the chart
is located, i.e. the axis labels will be displayed outside of the container instead of inside.
Because of this, the size of the chart is slighter larger when this option is activated.

Example A chart with Align axis not selected for both axes would look like
this:

The same chart with Align axis selected for both axes would look like this:

Note The blue frame around the charts indicates the borders of the container
in which the chart is located.

Tick Marks Tab

Here you can set properties for the tick marks on the X and Y axis.

447
7 Layout Module

Note The appearance of this tab is slightly different if the Time based check-box on the
Axis General tab is enabled. See the Time Based Variant for Tick Marks section for details.

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Tick Marks Major

Style major Sets the appearance of major tick marks. Options are:

None No tick marks will be drawn on the axis, only the according label will
be displayed.

Outside The tick marks will be drawn on the outside of the axis.

Inside The tick marks will be drawn on the inside of the axis.

Cross The tick marks will be drawn on the inside and outside of the axis.

Note Major tick marks are always labeled. By default, values are used for labeling.
However, you can set custom labels for major tick marks on the Labels tab.

Auto size If checked, Inspire Designer automatically places the tick marks using an ap-
propriate increment depending on the values set in the chart. This check-box is enabled
by default.

Note When both Auto size check boxes are enabled, only major tick marks will
be created (as Inspire Designer sets minor and major ticks to the same position, only
the major ticks will be visible).

Major size Sets the increment used for major tick marks.

Example If Major size is set to 10, tick marks would be 0, 10, 20, 30...

448
 7.6 Layout Objects

Note Auto size must be unchecked for the setting made here to take effect.

Major size variable Enables you to select a variable which controls the increment of
major tick marks.

See the description of the Major size edit-box just above for more details on setting
major tick marks.

Tick Marks Minor

Style minor Sets the appearance of minor tick marks. Options are: None; Outside; Inside;
Cross. See the description of Style major just above for details on these options.

Note Minor tick marks are not labeled.

Auto size If checked, Inspire Designer automatically places the tick marks using an ap-
propriate increment depending on the values set in the chart. This check-box is enabled
by default.

Note When both Auto size check boxes are enabled, only major tick marks will
be created (as Inspire Designer sets minor and major ticks to the same position, only
the major ticks will be visible).

Minor size Sets the increment used for minor tick marks.

Example If Minor size is set to 5, minor tick marks would be at 0, 5, 10, 15...

Note Auto size must be unchecked and a value other than None be selected for
Style minor for the setting made here to take effect. When the positions of major
and minor tick marks overlap, the settings for major tick marks are given priority.

Minor size variable Enables you to select a variable which controls the increment of
minor tick marks.

See the description of the Minor size edit-box just above for more details on setting
minor tick marks.

Time Based Variant for Tick Marks

The appearance of the Tick Marks tab is slightly different when the Time based check-box on
the Axis General tab has been enabled for the axis being modified. The options available in
this case allow a better and more exact adaptation of tick marks to the time based scale being
used on the according axis.

449
7 Layout Module

The options not described in the below list are described in the explanation of the standard
Tick Marks tab which can be found just above.

Options Description

Tick Marks Major

Major time step Sets the increment used for major tick marks using a time based scale.
Available preset options determining when a tick mark will be set are:

1y each year

1M each month

1W each week

1d each day

1H each hour

1m each minute

1s each second

You can also enter a custom value. If you enter this custom value without specifying
a time symbol after the numeric value (y, d, M etc.), the default value 1 day will always
be used.

Major time step variable Enables you to select a variable which controls the increment
of major tick marks.

See the description of the Major time step edit-box just above for more details on
setting major tick marks.

450
 7.6 Layout Objects

Note If the value 1M is selected, the correct ending date of the month (i.e., 28, 29,
30 or 31) is displayed. For example, the tick mark is 31/08/10 for the end of July but
30/09/10 for the end of September 2010.

Tick Marks Minor

Minor time step Sets the increment used for minor tick marks. The available preset
options are the same as for the Major time step option described just above.

You can also enter a custom value. If you enter this custom value without specifying
a time symbol after the numeric value (y, d, M etc.), the default value 1 day will always
be used.

Minor time step variable Enables you to select a variable which controls the increment
of minor tick marks.

See the description of the Minor time step edit-box just above for more details on
setting minor tick marks.

Axis Grid Tab

This tab enables you to display a grid for the X and Y axis and set its properties. The grid makes
reading and comparing chart values easier. The grid is extended to the Z-dimension when 3D
charts are used. You can also specify details concerning the axis labels.

Note Stripes and lines set in the according tabs described below are placed higher in the Z-
order than the axis grid; i.e. if you have set stripes or lines for your chart, the grid will be covered
by them where they overlap. See the Note on the Z-order in Charts for an example.

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Axis Grid

Use grid If checked, lines which begin at the major tick marks of the selected axis are
displayed in the charts background.

Note Grid lines depend on major tick marks whose properties can be set in the Tick
Marks tab

451
7 Layout Module

Grid style Sets the line style for major grid lines. The following pre-defined line styles
are available: Solid, Dash, Dot, Dash Dot and Dash Dot Dot.

Alternatively, you can select Custom to use a line style created in Inspire Designer.
When Custom is selected, a further combo-box becomes available where you can
select an existing line style or create a new one.

Grid width Sets the width of the major grid line.

Grid fill style Sets the color/fill of major the grid line.

Use minor grid If checked, lines which begin at the minor tick marks of the selected
axis are displayed in the charts background. Use the settings below to specify the
character of the minor grid.

Note Minor grid lines depend on minor tick marks whose properties can be set in
the Tick Marks tab

Grid minor style Sets the line style for minor grid lines. Following options are available:
Solid, Dash, Dot, Dash Dot and Dash Dot Dot.

Alternatively, you can select Custom to use a line style created in Inspire Designer.
When Custom is selected, a further combo-box becomes available where you can
select an existing line style or create a new one.

Grid minor width Sets the width of the minor grid line.

Grid minor fill style Sets the color/fill of the minor grid line.

Axis Labels

Label text style Sets the text style of the label.

Label start Sets the point at which the labeling of the selected axis starts. Labels at
values above the value set here will be displayed; labels below this value will not be
shown.

Note The setting made here only takes effect if the Autofit option on the Axis
General tab has been disabled. The Labels start option is not available for the X axis
of most chart types.

Labels rotation Sets the rotation of the labels of the Axis selected in the Axis combo-
box.

Label alignment Sets the alignment of the axis labels in use, the following options are
available: Center and Nearest point.

The Nearest point option is useful when employing rotated axis labels (using the Labels
rotation edit-box described just above). For an example showing the difference
between setting Center and Nearest point see the description of the Horiz. align
combo-box in the Point Labels tab section.

Format width Sets the maximum width an axis label can have. Axis labels which need
more space will wrap to a new line.

Paragraph style Sets the paragraph style controlling the appearance of the labels of
the selected axis.

452
 7.6 Layout Objects

Note Borders set in paragraph styles are not supported in charts.

Labels Tab
You might want to set your own custom labels for the X and Y axis. Defining labels allows you
to specify the content of labels for the X and Y axis.

Note If labels are not specified on this tab, they are automatically created with the following
content:

On the X axis the series are numbered beginning with 1 up to the number of values
the chart contains (can be specified in the Values Count edit-box on the Chart Type
tab).

On the Y axis the labels display the according values of your chart entries.

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Labels

Labels array Sets the array from which the Label variable can be selected.

Note If an array is selected here, only the top (Labels array and Label variable)
of the Labels panel will be used for creating labels when the job is printed or proofed,
settings made in the Label and Label Var. columns will be disregarded (even if they
are displayed in Layout).

Label variable Selects which data field contains the label variables.

Note This option is only available when an array has been selected in the Labels
combo-box.

Label Enables you to manually enter fixed values for the labels on the selected axis. Labels
set here will overwrite the labels automatically created by Inspire Designer (but will
keep the original position). Labels are replaced starting from the point where the X
and Y axis intersect.

Note Settings made here will be displayed directly in Layout, but will be overwritten
when proofing or printing the job if you have also selected a variable to determine
the label in Label Var. or in Labels array and Label variable above.

453
7 Layout Module

Label Var. Enables you to select a variable that contains labels for the chart.

Note This option is not available when an array has been specified in the Labels
array combo-box. In this case the value for Label var. is automatically set to the array
selected in Labels array.

Move Up / Move Down Moves the selected label up or down in the list.

Create New Adds a new label to the list.

Delete Deletes the selected label from the list.

Delete All Deletes all labels from the list.

Stripes Tab
Here you can add stripes and set properties for them on the X and Y axis.

See also Stripe and Line Examples for further details.

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Stripes

Stripes array Enables you to select an array containing variables that define the individual
stripes.

From Defines the starting point of the stripe according to the selected variable.

Note This option is only available when an array has been selected in Stripes Ar-
ray.

To Defines the end point of the stripe according to the selected variable.

Note This option is only available when an array has been selected in Stripes Ar-
ray.

454
 7.6 Layout Objects

Note For stripes created using the variables specified above it is necessary to add
a new stripe to the list by clicking on the Add Stripe icon and then specify a fill
style in the Fill combo-box. Otherwise the stripes will not be visible.

From Sets the starting point of the stripe on the selected axis.

From variable Enables you to select a starting point variable for the stripe.

To Sets the ending point of the stripe on the selected axis.

To variable Enables you to select an ending point variable for the stripe.

Note Settings made in the four options described directly above can be disregarded
when printing or proofing a workflow, although they are visible in Layout. This occurs
when values for Stripes array, From and To have been set.

Fill Selects the color of the stripe.

Create New Adds a new stripe to the list.

Delete Deletes the selected stripe from the list.

Lines Tab
Here you can set properties for lines on the X and Y axis which enable you to highlight a certain
value of a chart.

See also Stripe and Line Examples for further details.

Options Description

Axis Allows you to select Axis X or Axis Y and thus determine which axis of the graph the
settings you make will be applied to.

Lines

Lines array Enables you to select an array containing variables that define the individual
lines.

Value Selects a variable which defines the position of the line.

Note This option is only available when an array has been specified in Lines array.

455
7 Layout Module

Label Selects a variable which defines the label of the line.

Note This option is only available when an array has been specified in Lines array.

Note For lines created using variables specified above it is necessary to add a new
line to the list by clicking on the Add line icon and then specifying a fill style in
the Fill combo-box. Otherwise the lines will not be visible. Additionally, the Line,
Line width and Text style combo-boxes can be used to specify these features with
values other than the default values.

Value Sets the point on the selected axis where the line is placed.

Note The value set here will be displayed in Layout but not when proofing or
printing if a variable has been specified in the upper Value combo-box.

Value var. Enables you to select a variable that determines the value of the position of
the line.

Note This option is not available when an array has been specified in Lines array.

Label Sets a label for the line.

Note The label name set here will be displayed in Layout but not when proofing or
printing if a variable has been specified in the upper Label combo-box.

Label var. Enables you to select a label variable for the line.

Note This option is not available when an array has been specified in Lines array.

Fill Selects the fill style of the line.

Line Selects the line style.

Line width Sets the width of the line (in meters). The default value is 0.0010.

Text style Selects a text style for the label.

Para style Sets the paragraph style controlling the appearance of the label of the selected
line.

Note Borders set in paragraph styles are not supported in charts.

Format width Sets the maximum width a line label can have. Line labels which need
more space will wrap to a new line.

Create New Adds a new line to the list.

Delete Deletes the selected line from the list.

Series Tab
There are four different panels that can appear within the Series tab grouping. What appears
depends upon the type of chart you are using. These sub-tabs are:

Series general

Values

456
 7.6 Layout Objects

Shades

Series line setting

At the top of the Series tab there is the Series combo-box which selects the series to which
the other options on the sub-tabs apply.

If you have entered more than 1 for Series count on the Chart Type tab, switch between the
different series here and select different values for the options below. Series-0 is the first series,
Series-1 the second etc.

Series General Tab

This tab allows you to make assorted settings concerning the appearance of each individual
series.

Note The Borders/Lines field has a different appearance when Line charts are used, see the
Variants for Line Charts section for details.

Options Description

Series

Don't recalculate shades This option is relevant in situations where you set custom
colors (i.e. in the Fill column on the Values tab or in the shades column on the Shades
tab) for a chart and then change the chart type on the Chart Type tab.

If this option is left unchecked (as it is by default) all settings for custom colors will
be reset when you change the chart type and the default colors will be applied. To
keep the custom color settings when changing the chart type enable this option.

Note Avoid enabling this option before switching from a 2D to a 3D chart. If you
do this, you will have to set the fill styles for shades manually in the Shades tab in
order for the 3D effect to be created.

Is visible If checked, the series appears in the chart. This option is checked by default.

457
7 Layout Module

Is filled area If checked, the series is not displayed only as a line, but as a filled area as
in the example images for Radar chart in 2D only or below the line of the selected
series for the line chart types.

Note This option can be altered only when Line chart in 2D, Line chart in 3D, Line
stack chart in 2D, Line stack chart in 3D, Percentual line stack chart in 2D, Percentual
line stack chart in 3D and Radar chart in 2D only has been selected on the Chart Type
tab.

Additionally, you can use the Move fill area to background check-box, in case that
the filled area covers another series line and you would like the line to be visible.

Note This option can be altered only when Radar chart in 2D only has been selected
on the Chart Type tab.

Example The check-box Is filled area was used for one of the series.

The Move fill area to background check-box was applied additionally.

Legend Sets the name of the series that will be used in the legend when a legend is
used with the chart.

Tip You can also set the series name on the Legend tab in the User Text column.
To use a legend with a chart, Show legend must be checked on the Chart type tab.

Numbers after dec. point Sets the number of decimal places for the values of the se-
lected series. The setting made here influences the amount of decimal places you can
enter in the Values column of the Values tab.

458
 7.6 Layout Objects

Example If you have specified 2 in the Numbers after dec. point edit-box
but enter a value with 3 decimal places in the Values column of the Values tab,
this value will be rounded and displayed with only 2 decimal places.

Note When point labels are used (the Use point labels option on the Point
labels tab must be enabled) the values in them are by default taken from the
Values column on the Values tab. I.e. the appearance of the point labels ( the
amount of decimal places shown in them) also depends on the setting made
here.

Pie chart rotation Allows you to set a value determining the rotation of a pie
chart/doughnut chart.

Note This option is only available when a pie chart or doughnut chart has been
selected on the Chart Type tab.

Borders/Lines

Has border Determines if the series objects (i.e. bars, pyramids, cones, cylinders, pie
slices etc.) will have borders. Borders are only visible when values are set in Border
fill style and Border line width and Has border is enabled.

Note This option is not available for 2D Line charts, XY Line charts and 2D bar/line
charts for which the option Fill areas below lines (located on the Line Properties
tab) is disabled.

Border fill style Sets the color/fill of the border.

Border line width Sets the width of the line used for the border.

Custom Image Properties

Image control point Custom image charts consist of three images in all. This setting
allows you to adjust the position of the top image by entering a percent value con-
trolling the offset of the upper image in relation to its length. See also How to Create
Custom Image Charts for details on the logic of custom charts.

Note This option is available only when Custom image chart in 2D has been selected
on the Chart Type tab.

Variants for Line Charts

The Borders/Lines field has a different appearance and function when 2D Line charts, XY Line
charts and series containing lines in 2D bar/line charts are selected.

Note The Borders/Lines field will only look like this if above mentioned chart types are used
and the option Fill areas below lines (located on the Line Properties tab) is disabled.

459
7 Layout Module

Options Description

Borders/Lines

Has border This option is not available when 2D Line charts have been selected.

Border fill style This option is not available when 2D Line charts have been selected.

Line width Sets the width of the line in the chart representing the selected series.

Values Tab

On this tab, you can enter values for the series of your chart or you can determine variables
which will control the values. Three types of charts can be distinguished according to how the
values are entered:

1. Static charts Set the values manually in the Value column.

2. Charts with variable data and with a fixed number of values, e.g. a bank statement
has a balance for a each month of the year, so differing amounts for 12 months Set
the value variable in the Value Var. column.

3. Charts with a variable number of values, e.g. a bank statement has an unknown
number of transaction types in a single month Select the array containing the values
in the Values array and then set the appropriate variables which will return values in
the combo-boxes below it.

Also see the example Chart with a Variable Number of Values below.

This tab has differing options depending on which Chart Type has been selected on the Chart
Type tab, see the following sub-sections:

Values Tab for Bar and Line Charts

Values Tab for Pie Charts and Doughnut Charts

Values Tab for Funnel Charts

Note If the chart is static (i.e. uses no variables), it is placed in overlay.

460
 7.6 Layout Objects

Values Tab for Bar and Line Charts

See the screenshot above.

This version of the Values tab appears if any chart of Bar, Line, Cone, Cylinder, Pyramid or Bar-
Line type are selected for Chart Type on the Chart Type tab.

Options Description

Values

Values array Selects an array which contains variables that provide data for the chart.

In cases where you have an unknown number of values being returned by an array,
this option allows there to be any amount of values in the chart and the chart is then
resized accordingly. Also see the example Chart with a Variable Number of Values
below.

Value variable Selects the variable from the Values array that contains the values for
the chart.

This option is only available if the chart has a variable number of values, i.e. an array
has been selected in the Values array combo-box.

Lowest value variable Selects a variable which will return a value at which the chart
objects will be drawn either upwards or downwards.

See the explanation for the Lowest Value option below for a short example or Using
the Lowest Value option.

This option is only available for bar/line charts if it has a variable number of values,
i.e. an array has been selected in the Values array combo-box.

Point label variable Sets the variable that contains point labels for the chart.

This option is only available if the chart has a variable number of values, i.e. an array
has been selected in the Values array combo-box.

Note Point labels are only displayed on the chart if the Use Point Labels option
on the Point Labels tab has been enabled.

Value Enters chart values.

If a variable has been selected in the Value variable or Value Var. then this value
is overwritten.

Note

By default, the value has two decimal places. If you enter a value with more
than 2 decimal places it will be rounded. You can allow more (or less) decimal
places using the option Numbers after dec. point on the Series General tab.

This column is also filled by the Fill with Random Values button on the Chart
Type tab or General tab of the chart's Layout Properties. Therefore, if you have
entered individual values here, do not click on the Fill with Random Values
button because it will overwrite them.

Value var. Selects a variable that returns the value.

461
7 Layout Module

If a variable has been selected in the Value variable then this column is invalid.

Lowest Value Sets the value at which the chart objects will be drawn either upwards
or downwards.

The value 0 is used by default. If a variable has been selected in the Lowest value
variable or Lowest Value Var. then this value is overwritten.

Example For this chart Lowest Value has been set to 4 for all series and val-
ues, thus values above 4 are drawn upwards, whereas values below 4 are drawn
downwards:

See also Using the Lowest Value option.

Lowest Value Var. Selects a variable that returns the value at which the chart objects
will be drawn either upwards or downwards.

If a variable has been selected in the Lowest value variable then this column is in-
valid.

Point Label Enters a custom point label for each value.

To have the point label displayed, enable the check-box Use Point Labels on the
Point Labels tab.

In your labels you can also use the following substitution characters:

%p The percentage value will be used as a point label.

Example In a pie chart:

%v The value itself will be used as a point label (as it is by default or when
the Point Label column is left empty).

%f The starting point (i.e. the value set in the Lowest Value column) will
be used as a the point label.

462
 7.6 Layout Objects

Tip You can also insert line breaks into point labels to control the point where the
text should wrap to a new line. See the section Point Labels with Line Breaks for de-
tails.

Point Label Var. Enables you to select a variable that provides the point labels for the
chart.

If a variable has been selected in the Point label variable then this column is invalid.

Fill Selects a fill style for each value.

If the chart has a variable number of values, the styles selected here will still be em-
ployed until there are no more fill styles listed. At which point, default fill styles are
used to fill the values, e.g. if you have five values in the table here and set five corres-
ponding fill styles, but the array returns six values then the sixth value will have a fill
style generated for it.

When changing a fill style that is used for more values, a dialog appears asking
whether you would like to change the fill style for those values too. Selecting Yes
applies the changes to all values in the same series. If the same fill style is used in
another series, the change does not affect it. You can also select a variable fill style,
see the Variable Chart Fill example.

Note This column is called Top Picture if Custom chart has been selected for Chart
Type. For details see: How to Create a Custom Image Charts.

Values Tab for Pie and Doughnut Charts

This version of the Values tab appears if any chart of pie or doughnut type are selected for
Chart Type on the Chart Type tab. All of the options on it are described in Values Tab for Bar
and Line Charts except for:

Options Description

Values If you require some of the values to be more visible than others, you can give them
differing expansions so that they appear as separated pie slices. These expansions can also
be returned by a variable. The expansion is measured in percent of the radius of the pie,
e.g. if value A has an expansion of 100 it will appear fully removed from the pie.

463
7 Layout Module

Example The blue pie slice has been expanded from the pie chart by the value of
30:

Expand variable Selects a variable which will return the extents to which the slices of
the pie will be expanded.

This option is only available for pie/doughnut charts if it has a variable number of
values, i.e. an array has been selected in the Values array combo-box.

Expand Sets a value by which the according pie slice/doughnut piece will be expanded
from the pie chart.

If a variable has been selected in the Expand variable or Expand var. then this value
is overwritten.

Expand var. Selects a variable which will return the extents to which the according pie
slice will be expanded.

If a variable has been selected in the Expand variable then this column is invalid.

See also Pie Chart Features.

Values Tab for Funnel Charts

This version of the Values tab appears if Funnel chart in 2D or Funnel chart in 3D are selected
for Chart Type on the Chart Type tab. All of the options on it are described in Values Tab for
Bar and Line Charts except for:

464
 7.6 Layout Objects

Options Description

Values If you require some of the values to be more visible than others, you can give them
differing heights. These heights can also be returned by a variable. The height is measured
in proportion to the other values, e.g. if value A has a height of 10 and value B has a
height of 5 then A will always be twice as thick as B. The actual height of the segment is
controlled by the overall size of the chart on the Position tab of the chart's Layout Properties.

Value thickness variable Selects a variable that returns the height of each segment
that represents values.

This option is only available for funnel charts if it has a variable number of values, i.e.
an array has been selected in the Values array combo-box.

Value Thickness Sets the thickness of the corresponding value's segment.

If a variable has been selected in the Value thickness variable or Value Thickness
Var. then this value is overwritten.

Value Thickness Var. Selects a variable that returns the height of the corresponding
value's segment.

If a variable has been selected in the Value thickness variable then this column is
invalid.

465
7 Layout Module

Example Chart with a Variable Number of Values

Scenario: Imagine you have a Data Array named ChartArray containing the 3 variables:

Value contains the values for the chart: 1, 2, 3, 4, 5.

Lowest value contains the value from which the bar should begin: 1 for all five
values.

Label contains names which will be used as point labels in the chart: S. Peck, L.
Green, T. Smith, P. Penn, A. Mill.

Notice how the value for the first bar (S. Peck) is 1, but since the Lowest value variable
was set to 1, no bar is drawn.

For details on how to create an array and use variables in a chart also see How to Create
a Simple Chart.

Shades Tab
This tab is visible only for 3D charts.

It allows you to specify the shades used to create the 3D effect when using 3D charts. You can
pick the shades of fill styles for each series from the drop-down boxes in the table.

When you select a 3D chart on the Chart Type tab Inspire Designer automatically creates ap-
propriate shades to give the chart a 3D look based on the color set in the Fill column of the
Values tab. Anytime you set a new value in the Fill column of the Values tab the values on the
Shade tab will be automatically recalculated.

Note The automatic (re)calculation of shades only occurs if the Dont recalculate shades
option on the Series General tab is disabled.

This tab has a different appearance and usage when Custom image charts are used. See the
section on How to Create a Custom Image Charts for details.

466
 7.6 Layout Objects

Options Description

Shade 1 The color specified in this column will be used for shading 3D objects, its exact place
of use depends on the chart type it is used with:

3D Pyramid and 3D Bar charts The color is applied to the side of the pyramid/bar.

3D Pie charts The color is applied to the outer ring of the pie chart.

3D Cylinder charts The color is applied to the top and bottom of the cylinder.

3D Cone charts The color is applied to the bottom of the cone.

3D Line charts The color is applied to the top of the line.

3D Doughnut charts The color is applied to the outer ring of the doughnut chart.

3D Funnel charts The color is applied to the top of the funnel part.

For all other charts types the color set here has no effect.

Shade 2 The color specified in this column will be used for shading 3D objects, its exact place
of use depends on the chart type it is used with:

3D Pyramid charts The color is applied to the bottom of the pyramid.

3D Bar charts The color is applied to the top and bottom of the bar.

3D Pie charts The color is applied to the inner sides of pie slices.

Note The color set here is only visible when pie slices are expanded. See the
Values Tab for Pie Charts and Doughnut Charts for details on expanding pie slices.

3D Doughnut charts The color is applied to the inner ring of the doughnut chart.

3D Funnel charts The color is applied to the bottom of the funnel part.

For all other charts types the color set here has no effect.

Series Line Settings Tab

This tab is available only for Line charts, XY line charts, Bar line charts and Radar charts.

Note When Line chart in 3D is selected only the Show trend changes only option will have
an effect on the appearance of the chart. Settings made concerning the line style and the marks
will not be applied.

467
7 Layout Module

Options Description

Series Allows you to select the series for which you would like to view and/or change the
attributes.

Note The fields of this panel should be completed for each series.

Line style Sets the line style of the series line.

Special mark Sets the special mark that will be used to mark the point values on the line:

Example A simple Line chart with Cross set in the Special mark combo-box will
look like this:

Note If you have selected Custom, the Custom mark combo-box appears where you
can specify which element to use as a special mark.

Mark size Sets the size of the special mark selected above.

Note This option is not available if Custom has been selected in the Special mark combo-
box.

468
 7.6 Layout Objects

Custom mark Allows you to select an element used in your current document as the special
mark for the selected series.

Note This option is only available if you have selected Custom in the Special mark
combo-box.

The Mark size edit-box is not available when using custom marks, so it is necessary to
design the element you want to use as the special mark in your chart in the appropriate
size.

Smooth lines If checked, the points of the line chart will be inlaid with Bezier curves making
the curves look round and smooth.

Example Smooth lines is disabled:

Smooth lines is enabled:

Note This option is available only for XY line charts.

Show trend changes only When using point labels you can limit the point labels to be
displayed. If this option is enabled, only the first and last point label and point labels
marking a trend change will be displayed.

Example Show trend changes only is not enabled for this chart:

469
7 Layout Module

Show trend changes only has been enabled for the chart below:

Enable skip values When enabled, the value set in the Skip value edit-box will be skipped.
See below for a closer description.

Skip value Determines a value on the Y-axis which will be skipped when drawing the chart.

Example Following settings have been made for the chart displayed in the
screenshot below:

Enable skip values has been checked.

Skip value has been set to 1.

As the value "4" on the X-axis has the corresponding Y-axis value "1" in this
chart, the chart has no line in this area, i.e. no line is drawn to or from the Y-
axis value "1" and no point label is displayed.

Note The value set in this edit-box will only be skipped if the Enable skip values check-
box has been checked.

Draw line over skipped values If enabled, the chart line continues omitting the skipped
values point(s).

Example The same settings as in the example just above, with the Draw line over
skipped values option enabled, result in the following chart form:

470
 7.6 Layout Objects

Legend Tab
The Legend tab appears only if you have selected Show Legend on the Chart Type tab.

Note When using 3D charts the legend will also appear in 3D. If you prefer a legend in 2D
with 3D charts, select the option Show 2D legend.

Options Description

Legend position Sets the place where the legend appears in relationship to the chart. Options
are: Left, Right, Top and Bottom.

Use manual offset Enable Use manual offset in order to be able to customize the legend
position using the Legend offset option.

Legend offset The effect of the value you specify for Legend offset depends on the setting
made in the Legend Position combo-box:

If you have selected Right or Left the higher the value set in Legend offset the
further the legend will be moved downwards.

If you have selected Top or Bottom the higher the value set in Legend offset the
further the legend will be moved to the right.

Note This option is only available when Use manual offset has been enabled.

Legend takes % Sets the size of the legend in relationship to the chart.

471
7 Layout Module

Example A chart with the Legend takes % option set to 30 (default setting):

A chart with the Legend takes % option set to 75:

Border fill Sets the color/fill of the border around the legend.

Paragraph style Sets the paragraph style controlling the appearance of the legend entries
set in the User entry column or specified by a variable.

Note Borders set in paragraph styles are not supported in charts.

Text style Sets the text style used in the legend.

Format width Sets the maximum width a legend entry can have. Legend entries which need
more space will wrap to a new line.

User array Enables you to select an array from your data that will provide chart legend vari-
ables.

This array is usually the same as the one from which the other values (X and Y) used to
make the chart are from.

User variable Selects a variable from the array selected in User array to create names for
the series categories.

The values of a variable data set will be used for the legend label as opposed to the name
of the variable. If the variable has multiple values then all of the values will be displayed
in the legend as if they were signifying multiple series. This is useful if you already have
an input variable that is made up of series names that correspond to the series categories
in the chart.

472
 7.6 Layout Objects

Format Determines the orientation of the entries within the legend. Available options are:

Auto The orientation is determined by Inspire Designer. If space allows, horizontal

orientation will be used, otherwise the legend entries will be ordered vertically. If
necessary and possible, both orientations will be employed in the legend.

One column Orders the legend entries in vertical orientation.

One line Orders the legend entries in horizontal orientation.

Tip As displaying legend entries in horizontal orientation is especially space consuming,

it is recommended to use the One line setting only when you are sure there is enough
space within the box in which the chart is placed, as otherwise not all legend entries will
be displayed. For charts containing a larger amount of series, using the One column setting
is recommended.

It is possible to make more/less space for the legend by using the Legend takes % option
also available on this tab.

Example Selecting One column will result in a legend looking like this:

Selecting One line will result in a legend looking like this:

Show 2D legend When charts in 3D are employed, the according legend will automatically
also appear in 3D. To use a 2D legend with a 3D chart, activate this option.

Example A 2D legend looks like this:

A 3D legend looks like this:

Right to left order Changes the order of the series names and their colored identifiers in
the legend.

Example Normally, a legend looks like this (Right to left order is not selected):

473
7 Layout Module

When Right to left order is selected, the legend will appear like this:

User text Clicking on the Create New icon creates a new field row, in the white text
area, that defines the properties of the series categories of your legend. Each row represents
a different series.

The first column, User text, allows you to type the name for the series categories in the
legend by clicking on the cell and entering the desired text. The entered text will show in
the legend beside its respective fill color/style indicator. This series name which will appear
in the legend can also be set on the Series General tab in the Legend edit-box.

If you want to use the User text defined name then make sure that Empty is selected in
the User variable text column.

Note When you manually create legend entries, all created entries are added to the le-
gend. However, if you specify a variable for the creation of legend entries in the User array
and User variable fields, the creation of user legend items is dynamic, i.e. only the number
of legend entries corresponding with the count of values coming from the defined variable
will be created. User legend items exceeding this count will be ignored.

User variable text Using the drop down menu (that shows all of the possible variables
defined in the Layout tree) you are able to select here a variable that will be used for
naming the series category. This is an alternative method of setting the legend variable to
using the User array and User variable. User array should be set to Empty, otherwise
this field is inactive.

The first value of a variable data set will be used for the legend label as opposed to the
name of the variable. This should be remembered especially if the variable chosen has
multiple values.

If this method is used for selecting a name then any name entered in the User text column
is overwritten with the name or value from the variable selected, i.e. User variable text
has a higher priority than User text. If you want to use the User text defined name then
make sure that Empty is selected here.

Fill style Selects a fill style which will be used for the squares (or the mark selected for 2D
line charts, XY line charts and Radar charts in the Marks column; see below) displayed to
the left of the legend title in the legend.

Mark Specifies the mark which will be used in the legend. The drop-down box offers the
following variations:

474
 7.6 Layout Objects

Note If you have specified a special mark in the Special mark combo-box on the Series
Line Settings tab, then this special mark will be set by default for the legend.

If you select Custom, you can specify an element to use as a mark in the Custom object
column.

This column is available only for 2D line charts, XY line charts and Radar charts.

Custom object Allows you to select an element used in your current document as the mark
for the selected series in the legend.

Note The element will be scaled appropriately in order to fit into the legend.

The Custom object combo-box is only available if Custom has been selected in the Mark
column.

Create New Adds a new legend entry to the list.

Delete Deletes the selected legend entry from the list.

Note on the Z-Order in Charts

The Z-order sequence of objects drawn in charts is as follows (from back to front):

Vertical axis grid

Vertical stripes

Horizontal axis grid

Horizontal stripes

Objects used to represent the series and values of the chart (lines, bars, cylinders, cones,
pyramids etc.)

Vertical lines

Horizontal lines

X and Y axis of the chart including tick marks

Example

475
7 Layout Module

7.6.6.3 Chart Examples and Helpful Hints

In this section: See also:
Pie Chart Features Charts
Using the "Lowest Value" Option Chart Properties Dialog
Stripe and Line Examples How to Create a Simple Chart
Variable Chart Fill How to Create Custom Image Charts
Point Labels with Line Breaks

Pie Chart Features

Pie charts offer several unique settings which can greatly improve charts' design and clarity.
Some of the most frequently used options are described below. First of all it is necessary to
create a basic pie chart similar to the one below:

To create this chart, follow the steps described below:

1. Select the chart tool from the toolbar and create a chart object in the Layout Area.

2. Double-click on the chart object to open the Chart Properties dialog. Select Pie chart
in 3D from the list on the Chart Type tab.

476
 7.6 Layout Objects

On the same tab, in the Global Series/Value Count field set Series count to 1 (to
have just one pie chart) and Values count to 6 (so that you will have six pie slices in
the pie chart as in the example above). To see the result of these settings click the Fill
with Random Values button. The settings you have made will now be reflected in
the chart shown in the preview area at the top of the Chart Properties dialog.

3. As the chart is only filled with random values, you might want to set the values visible
in the above example. Go to the Values tab and enter the values in the six lines there
in the Values column.

4. You can adjust the rotation of the Pie chart on the Series General tab using the Pie
chart rotation edit-box.

5. Finally, you must go to the Point Labels tab and check the Use point labels option.
Point labels displaying the values of the pie chart will then automatically be displayed
as in the example above.

Tip Alternatively, you can decide to have the values of the chart displayed in a legend
instead of by point labels. To use a legend, go to the Chart Type tab and check the
Show legend option at the bottom. The values will then automatically be displayed
in the legend. Go to the Legend tab to specify the position of the legend. Here you
can also make custom entries if would like the legend to display something else than
the chart values. A chart using a legend will look like this.

See the descriptions below for details on adding further features to pie charts (the chart using
point labels will be used as a basis).

Highlighting/Expanding Pie Slices in Pie Charts

Pie charts offer a special possibility of highlighting certain values. E.g., imagine you would like
to highlight the value "7.43". To do this, double-click on the chart to open the Chart Properties
dialog and go to the Values tab. Here you will find the Expand column where you can set a

477
7 Layout Module

value determining the distance (specified in percent of the pie chart's radius) that the pie slice
will be expanded. In this case the value for Expand is set to 50:

This setting will result in the following appearance of the pie chart:

Note Expanding a pie slice, as can be seen in this example, decreases the size of the pie chart
itself as extra space is needed for the expanded pie slice (the size of the chart object in Layout
does not change). Also, the higher the value entered in the Expand field is, the smaller the
chart (and the expanded) pie slice become (as the space between the two is increased). Keep
this in mind when expanding pie slices.

Using Guidelines
A further possibility unique to pie charts is using guidelines to make the connection between
the point labels used and the according pie slices clearer. Guidelines can be set up on the Guide
Lines tab. For guidelines to be visible the Show guide lines option must be checked and a fill
style must be selected in the Guide fill style combo-box. Additionally, as in this example, you

478
 7.6 Layout Objects

can extend the guidelines (by using the Underline labels option) so that they not only lead
to the point labels but actually underline them:

The settings in the above screenshot will modify the pie chart to look like this:

Note For the settings made on the Guide Lines tab to be applied to the pie chart, the Use
point labels option on the Point Labels tab must be enabled.

Using Borders for Pie Slices

A further possibility to enhance the look of pie charts is to create a border for each of the slices
giving them a more distinct look. This setting can be made on the Series General tab. For borders
to be visible, check the Has border option and select a fill style in the Border fill style combo-

479
7 Layout Module

box. Furthermore, you can adjust the width of the border line in the Border line width edit-
box.

The settings in the above screenshot will modify the pie chart to look like this:

Using the "Lowest Value" Option

The Lowest Value option (located on the Values tab) can be used to highlight a certain value
of a chart, as it marks the point from which the values will be drawn either upwards or
downwards. The value for Lowest Value can be controlled by using static values or by employ-

480
 7.6 Layout Objects

ing a variable value. By default, Lowest Value is set to 0 as can be seen in this example below
(positive values are drawn upwards, negative values are drawn downwards):

To start drawing from the value 2 instead of the default value 0 simply set Lowest Value to
2 for all values and series on the Values tab. The chart will then look like this:

It is also possible to make a different setting in Lowest Value for each series and even for
each value of a chart (e.g. in the screenshot below Lowest Value has been set to 2 and 4 for
the blue series and to -2 and 0 for the yellow series.):

481
7 Layout Module

Note The examples above have been created using 3D cylinder charts, but the Lowest Value
option can also be used with:

all 2D and 3D bar charts

all 2D and 3D cone charts

all 2D and 3D pyramid charts

Stripe and Line Examples

Stripes and lines can be created using static values or variables. They can be useful to mark a
certain value (lines) or range of values (stripes) in a chart. They can be used in vertical and ho-
rizontal orientation. See the descriptions below for details on the usage of stripes and lines.

482
 7.6 Layout Objects

Lines
Use lines to highlight a certain value in a chart. In the example below there is an overview of
summer temperatures and a line has been used to mark the average of the temperatures dis-
played:

The settings for lines are made on the Lines tab. The settings in the screenshot below created
the line in the above screenshot:

When creating lines, you have following options:

In the Axis combo-box select the Axis you would like to create a line for, selecting Axis
X will create a vertical line, selecting Axis Y will create a horizontal line.

Use the Add line icon in the bottom right corner of the dialog to add a new line row
to the list. Delete lines by selecting the appropriate row and clicking the Remove line
icon.

In the Value column set the position of the line.

In the Label column you can enter a label for the line when necessary. In the Text Style
column you can set a text style controlling the appearance of the label.

In the Fill column select a fill style for the line.

Note If no fill style is selected, the line will not be visible.

In the Line Width column determine the line width of the line which has been inserted.

483
7 Layout Module

Stripes
Use stripes to highlight ranges of values in a chart. In the example below vertical stripes have
been used to highlight the months May and September:

The settings for stripes are made on the Stripes tab. The settings in the screenshot below created
the two stripes in the above screenshot:

When creating stripes, you have following options:

In the Axis combo-box select the axis you would like to create a stripe for, selecting
Axis X will create a vertical stripe, selecting Axis Y will create a horizontal stripe.

Use the Add stripe icon in the bottom right corner of the dialog to add a new stripe
row to the list. Delete a stripe by selecting the appropriate row and clicking the Remove
stripe icon.

In the From column set the starting point of the stripe and in the To column set the
ending point of the stripe.

Note When entering values with decimals (e.g 1.5) you need to allow the appropriate
number of decimals in the Decimals edit-box on the Axis General tab, otherwise values
with decimals will be rounded when displayed on this tab (although the stripes will be
displayed correctly in the chart).

In the Fill column select a fill style for the stripe.

Note If no fill style is selected, the stripe will not be visible.

484
 7.6 Layout Objects

Variable Chart Fill

This example shows how to use variable fill styles in charts. Imagine you would like to create
a chart which automatically assigns colors to bars depending on the value that these bars rep-
resent. Using different colors for different value ranges will help simplifying the assessment of
the chart.

This method functions only for charts whose values are specified using variables, as the fill
styles will be variable controlled. In this case there is one variable for each month of the year.
These variables have two functions:

1. They control the value displayed in the chart.

2. They are used in the variable fill style and will determine the color used to display the
value in the chart.

It is necessary to create and define variable fill styles for each month and to specify the ranges
and matching colors in them. Create a new fill style by right clicking the Fill Styles family and
selecting Insert Fill Style from the context menu and set Type to Select by interval:

For this example MidnightBlueFillStyle is selected for values 5000 and lower, OrangeFillStyle
for values in the range from 5001 6000 and for all values above 6001 BrickFillStyle. In the
Variable field the variable that provides the value for the given month (Jan for January in the
screenshot above) must be selected.

Similar fill styles for all other months have to be created, too the color ranges will stay the
same as in the example above, only the variable specified in the Variable field needs to be
adjusted.

485
7 Layout Module

In the Chart Properties dialog it is then necessary to select the variables containing the values
in the Value Var. column and the appropriate fill styles in the Fill column of the Values tab:

After making these settings, press <F6> to proof the job and see the result of the settings
made:

Values surpassing 6000 are clearly marked by the red-colored BrickFill, values below 5000 by
the MidnightBlueFill. "Normal" values between 5001 and 6000 are marked by the OrangeFill.

486
 7.6 Layout Objects

Point Labels with Line Breaks

Creating multiline point labels is easy to do with Inspire Designer: you can specify the Format
width on the Point Labels tab and any point label exceeding the width defined there will wrap
to a new line. A chart could look like this:

But, imagine you would like to define where the line breaks occur in order to create a chart
with point labels looking like this:

To create point labels with specified line breaks, it is necessary to set the line breaks directly in
the data file used for setting the point label content. The character forcing Inspire Designer to
insert a line break is 0x10 (in hexadecimal). Inserting this character is not always possible directly,
but it can also be done by following the steps described below:

1. In your data, indicate the line break using one or several characters (e.g. in this example
"**").

Example The three entries in the data used to create the above screenshot
would look like this:

Manager 1**London office**Results for region 1

Manager 2**Paris office**Results for region 2

Manager 3**Madrid office**Results for region 3

487
7 Layout Module

2. Use the Data Input module to insert your data file into Inspire Designer. Check your
data on the Properties tab of this module, it should look like this:

3. Now connect a Data Transformer module to the Data Input module. This module will
be used to transform the characters entered into the data (i.e. "**") into line break
characters. For the field "Description" (which contains the point labels) select Script in
the Field Converter column to create a Script-String and click the 3 Dots icon to
open the Script dialog and enter the script shown in the below screenshot:

488
 7.6 Layout Objects

4. Now create a chart in the Layout Area and make the following settings in the Chart
Properties dialog:

On the Chart Type tab set Series count to 1 and Values count to 3.

On the Values tab, in the Values array combo-box select the array containing the
variable with your point labels (in this case named "Records") and then in the
Point label variable combo-box select the variable named "Description":

Create a new paragraph style with Alignment set to Center.

On the Point labels tab enable the Use point labels check-box and select the
paragraph style you just created in the Paragraph style combo-box.

5. Press <F6> to proof your document. The point labels should be displayed as in the ex-
ample screenshot at the beginning of this section.

7.6.7 Colors
7.6.7.1 Colors
In this section: See also:
Color Layout Properties How to Create Colors
Color Dialog Color Management Overview
Color Spaces
ICC Profiles
Viewing Colors in Raster Proof

Colors can be created in several ways for use in the Layout design (see the section How to
Create Colors). Once created, they can be found in the Colors family in the Layout Tree. The
icons there show the defined shade of color and indicate if that color has been defined as a
colorant or multiple colorant, i.e.:

Indicates that a color is defined but no corresponding colorant has been set.

Indicates that a colorant has been set.

Indicates that a multiple colorant has been set.

489
7 Layout Module

In the workflow, colors can be assigned as spot colors and colorants in parallel, these are simply
different color mapping systems that are used so that printing devices can reproduce colors
when the workflow is processed. In production, different engine configurations can employ
differing systems to define the colors that will be printed.

Example A color is defined as CMYK: 52, 40, 0, 20. It is assigned as Spot color 3 and
given colorant name Bluebell and the workflow is saved.

The workflow is later printed via:

The AFP Engine which has Output colors set to Dithered colorants and colorant
name Bluebell mapped to AFP Color Blue.

The IJPDS Engine which has Output colors set to Spot colors and Spot color index
3 being printed on RIP 2.

The PostScript 3 Engine which uses the Layout CMYK profile as its CMYK profile.

Notice how the workflow can be printed using three different color mapping systems
using the definition created here.

Color Layout Properties

Options Description

Color space Displays information on the color space selected for Use in the Color dialog
and on the values of that color in all four standard color spaces (RGB, HSB, Lab, CMYK).

If you have defined the color as a colorant, there will be a further row of information dis-
playing the name of the colorant ("Green" in this case):

490
 7.6 Layout Objects

If you have defined the color as a multiple colorant (which is calibrated against the DeviceN
color space), the bottom line displays DeviceN and the names of the colorants of which
the multiple colorant consists ("Red" and "Blue" in this case):

Change Opens the Color dialog.

Alternatively, this dialog can be opened by double-clicking on the color box on the left of
the Layout Properties panel or on a color's node in the Layout Tree.

Spot color Assigns a spot color index.

See the Spot Colors section below for more information.

Mix spot color If checked, allows the selected spot color to be printed over another spot
color.

See the Spot Colors section below for more information.

Color Dialog
To access the Color dialog for any color either:

Click on the Change button or the colored box on a color's Layout Properties panel.

Double-click on a color's node in the Layout Tree.

The color dialog is also used in the Workflow Options dialog for mapping colors from imported
native files. See the sections AFP Import and PCL Import.

491
7 Layout Module

The Color dialog is divided into four sections, each section relates to a different system of color
mapping:

1. Color space RGB, HSB, LAB, CMYK or HTML.

2. Spot color.

3. Dithered spot color.

4. Colorant or multiple colorant Separation or DeviceN color space.

492
 7.6 Layout Objects

Color space

Options Description

Color space Selects the color from the map of a chosen color space.

First choose a color space from the right-hand groups of edit-boxes (R G B, C M Y K etc.)
by clicking on a radio button of the colorspace you would like. You can then edit values
directly in the edit-boxes there, or you can slide the pointers along the progression bar in
the middle (C M Y K has two bars, one is for the black channel) and select the color in
the Color space box on the left.

The equivalent color spaces are automatically calculated. Subsequently, you can select
which color space will be used when processing the workflow, e.g via an engine configur-
ation in Production.

New/Current Display the actual colors being used.

Current displays the color that is currently employed in the design and New shows the
color you have selected here in the Color dialog.

Note If a color you chose is outside the gamut determined by the ICC Profile defined in
the General Workflow Options, a warning icon is displayed in the New pane. It will display
the chosen color on the left and the closest color within the gamut on the right.

Click in the New field to select the closest color within gamut.

HTML Determines the color space using hexadecimal HTML values.

This is slightly different to the other color spaces because selecting this option does not
display an HTML related Color space, however entering a number will show the color in
the color space currently being edited there.

Use Determines the primary color space of the Layout module. It is the one that appears as
the nominated colorspace on the first line of the Color Layout Properties panel.

493
7 Layout Module

Select from: RGB, HSB, LAB or CMYK.

This color space is the one from which the other color spaces are calculated if a conversion
is used, e.g. in production or with a profile change. There are other features where the
color selected here does matter, such as Force CMYK to CMYK ICC transformation
from the Current Workflow Options on the Workflow Options dialog.

Simple Hides the Spot Color and Dithered Spot Color sections of the Color dialog.

When these sections are hidden, the button's name changes to Spot Color and can be
used to make the sections reappear.

Edit RGB in percent If checked, RGB values can be entered on a scale from 0 to 100.

If unchecked, the standard scale from 0 to 255 is employed.

Note When using the RGB or CMYK color space, go to the Current Layout Module options
section of the Layout Options Dialog to specify the CMYK and RGB color profiles which are to
be used when transforming the color space selected for a color value is necessary (this depends
on the output/proof type used).

Spot Colors
Spot colors are a way of mapping the colors used in a workflow to the colors (inks/toners)
available on the printer.

Several production engines can use spot colors to map colors: AFP, IJPDS, IPDS, Metacode,
MIBF, PCL and PDF Fixed Resolution.

When using spot colors, each color used in the layout design should be assigned one of 16
numbers (a spot color index) and then, when processing the workflow, the corresponding
device color is linked by using that same number in the engine configuration which is edited
from the Production environment.

Example For the AFP Engine Config dialog, this is done on the General tab:

1. In Output Colors select Spot Color.

2. Click on the Assign button to assign the same Spot Color Indexes that you have
assigned in Layout to corresponding AFP or Highlight colors depending on which
color scheme the printer is using.

Spot colors can also be mapped in Proof for a Raster Proof profile.

Options Description

Spot color Assigns a spot color index.

Mix spot color If checked, allows the selected spot color to be printed over another spot
color.

494
 7.6 Layout Objects

This is the equivalent of setting the option White processing to Never, for a single color,
in the configuration of a raster engine, i.e. white processing is not applied for this color.
Therefore, if Mix spot color is checked then both any color behind AND this color will
be printed. This can be used when you want to mix colors at the printing device by
painting one over another.

Only the color used on the top layer (highest in the Z-order) of any two colors, is required
to have Mix spot color checked in order to allow it to be printed over the other color.

Dithered Spot Colors

Dithered spot colors employ from two to seven different spot colors and use dithering in order
to create the appearance of another color.

The dithering pattern that will be used when the workflow is processed is determined by settings
on the Dithering tab of the engine configuration. This tab is also available in Proof for a Raster
Proof profile.

If Use dithered spot color is checked, you can define the quantity of each color composing
the dithered spot color by dragging the sliders for channels 0-6.

The quantity of each color is shown in the edit-boxes at the bottom of each channel. The Sum
of the component spot colors is shown to the right. The recommended sum is 255, if it is
higher then the number is highlighted red and the result may not be as you expect (e.g. a color
may be superimposed with another one), but it will still be possible to run the job.

If Edit in percent is checked, you can edit the values in percent. Sums higher than 100% are
shown in red.

Example In a Raster Proof profile Dithered spot colors has been chosen for Output
colors and; spot color 0 is mapped to black, spot color 2 is mapped to yellow and spot
color 3 is mapped to orange. A dithered spot color employs 40% of spot color 2 and
60% of spot color 3.

In the screenshot below, spot color 0 is used as fill style for the text style and the dithered
spot color is used by the fill style for the background:

A dithering type of Clustered Dot (Round) has been set on the Dithering tab for the spot
colors of the profile.

495
7 Layout Module

In the screenshot below, we see a magnified view of the dithered spot color:

Notice how the two spot colors (2 and 3) have been dithered to create the color shade
of the background.

Colorants
Colors can be further defined as colorants if a workflow is produced with some engines. Col-
orants work as another method for identifying colors for processing in Production, i.e. a colorant
gives a specific color a unique name which will be used for mapping that color.

For example, with the PDF and PostScript engines the names should correspond with assigned
Separation color spaces and in the PCL engine they should correspond with any colorants as-
signed at the printing device.

To define a color as a colorant:

1. Select Colorant in the combo-box on the left.

2. Enter a unique name in the edit-box (marked in the screenshot above as 1).

It should be considered that in Production the colorant names must match corresponding
names used by the printing device. If there is no colorant name entered or if the name
has no corresponding value at the device, then the color is treated as usual (e.g. as an
RGB value).

3. In Production, enable the corresponding color option in the engine's configuration

dialog.

For PDF and Postscript engines the option is Use Separation and DeviceN color
spaces. See the sections PDF, NexPress VDX, PPML (HP PPML or PodiPPML) and Post-
Script (Adobe PostScript2, Adobe PostScript3 or Creo VPS). A definition of the color
spaces can be found in the PDF Reference manual at http://partners.adobe.com/pub-
lic/developer/pdf/index_reference.html.

For AFP or PCL the option is Output colors with the appropriate colorant selection,
e.g. Device colorants for PCL.

Alternatively to the procedure described in step 2, you can define a colorant using Pantone
color palettes.

The Pantone Matching System is a proprietary color space used in a variety of industries, espe-
cially printing. Further information on the Pantone Matching System can be found at ht-
tp://www.pantone.com.

496
 7.6 Layout Objects

To define a Pantone colorant, first select a library from the Pantone library combo-box menu,
then select the desired color shade from the edit-box right above it. The selected tone's name
will display in the edit-box, where you can edit it further.

Example The screenshot below shows the colorant edit-box with the Pantone 300 C
color selected from the Pantone Formula Guide Solid Coated LAB library.

If you need to look up a specific Pantone color knowing its number or name, open the drop-
down list and type the beginning of the phrase you search for, e.g. a color number.

Note Density is a feature of versions of PrintNet T prior to 5.0.

When creating new colors Density is set to 100 and cannot be modified. When using workflows
created prior to PrintNet T 5.0 (and a density other than 100 has been specified) this edit-box
will be available.

Employing colorants in gradients will not work (at the time of processing the workflow) if the
density is set to a value other than 100.

If you need to create a new colorant with a density other than 100 you have to create it as a
multiple colorant (see the section just below).

If there are two colorants with the same name and the same density but there is a different
color assigned to them in the Color dialog, the color first used in Layout takes priority.

Multiple Colorants
Multiple colorants correspond with the DeviceN color space that can be used by the AFP, PDF
and PostScript engines.

To use multiple colorants when processing a workflow, the option Use Separation and
DeviceN color spaces in the according PDF/PostScript Engine Configuration dialog must be
enabled.

When selecting Multiple colorants from the drop-down menu, you can combine any previously
created colorants.

497
7 Layout Module

Create New adds a new colorant row for setting a colorant. You can move the colorants
up and down in the list by using the Move Up and Move Down icons. To delete a col-
orant use the Delete icon or the Delete All icon to delete all colorants.

Precalc DeviceN calculates a resulting DeviceN color from the combination of individual color-
ants. It is necessary to define this DeviceN color because a printing device might not recognize
the individual colorants used.

You can set the density for each colorant (from 0 to 100 %) in the field next to the selected
colorant.

Tip Colorants and multiple colorants can be used for palette images. To do this, set all of the
colors used in the images palette as colorants:

1. Go to the image's Palette tab.

2. Create each color in the Color column as a color in the Colors family of the Layout
Tree.

3. Assign each color, that is used in the image, as a colorant here in the Color dialog.

7.6.7.2 How to Create Colors

In this section: See also:
Color Scanning with X-Rite Eye-One Colors

Adding a new color to the Layout can be done in one of the following ways:

You can create a new color directly in the Layout Tree.

To create and name a color do the following:

1. Right-click on the Colors node in the Layout Tree and select Insert Color.

2. Click on the new color (e.g., Color1) to display its Layout Properties panel.

3. Click on the Rename object icon and enter an appropriate name for the new
color.

4. Click on the Change button or double-click on the color itself to display the Color
dialog where you can specify the color.

You can select a pre-defined color from the Color Selection Box when entering or
modifying the fill/outline of an object or text using the buttons in the Text Format

498
 7.6 Layout Objects

toolbar or when using the Fill Style combo-boxes within the Text and Border style
layout properties panel. E.g.:

Legend

1. Color Selection box (offering a selection of standard pre-determined colors)

2. To help you avoid inconsistencies when creating documents, colors already added
to the Layout Tree of the current document appear in the lower part of the Color
Selection box.

Color Scanning with X-Rite Eye-One

Apart from defining colors through the Color dialog, Inspire Designer provides the option of
obtaining colors directly off any solid object, e.g. a print, a piece of fabric or any other colored
surface that is scannable with the X-Rite One-Eye spectrophotometer.

Before using the scanner, drivers need to be installed in compliance with the instructions
provided by the scanner's manufacturer. Once these drivers have been installed, the scanner
needs to be plugged into the computer via a USB port.

Note For the best results, calibrate your monitor(s) and profile your printer(s) following the
spectrophotometer manufacturer's guidelines.

Now the following steps need to be taken:

1. Right-click on the Colors family in the Layout Tree. The following menu will appear:

2. Choose X-Rite Eye-One | Connect.

499
7 Layout Module

If the connection succeeds, all spectrophotometer menu options will become active,
otherwise an error message will appear.

3. The scanner needs to be calibrated before use.

Right-click on the Colors family once again and select X-Rite Eye-One| Calibrate.
Within a moment there will be a message confirming successful calibration or a message
of failure. A common reason for calibration failure is exposing the spetrophotometer
to a surface other than the white point on the device's base plate. If the calibration
fails it should be repeated until it succeeds.

4. Yet again, right-click on the Colors family and choose X-Rite Eye-One | Mode. There
will be a choice between the Single scan and Strip scan modes.

Single scan Captures a single color. To do this, choose that option, place the device
directly onto the media and scan the needed color. You can use any color from
the Scan Target (a chart of colors used primarily for profiling printers) that comes
with the spectrophotometer or acquire any color that interests you.

Strip scan Allows the capture of many colors. To do this, expose the spectrophoto-
meter to a multicolored surface allowing the device to read (measure) the colors.

Note In this mode the scanner does not read the first and the last color of the
color strip.

When Configure is selected, the user can choose their own settings for the color scanning.
See the description of Layout Options dialog for more information.

Tip All the options for the X-Rite Eye-One scanner, available in the Layout Tree, can be
displayed as a toolbar. The spectrophotometer options toolbar needs to be made visible by
enabling the Toolbar visible check-box in the Customize Toolbars dialog (to open it, right-
click anywhere on the gray space of the toolbar and select Customize). Each of the options
can also be incorporated into any other existing toolbar.

7.6.8 Data
7.6.8.1 Data
In this section: See also:
Data Family Properties Template Merger module
Variable Properties Global Variables
Variable Context Menu System Variables
Populating Variables with Favorite Data How to Use the Insert Param Variable
in Layout Wizard
Processing in Inspire Designer

In the Data family you can find variables that were read into the module and any additional
variables that have been added here.

Variables return values that can be used as text in flows; as conditions that determine when
other objects appear; or in scripts to perform calculations. The tree structure in this family and
the indicators enable you to locate variables (in order to drag and drop them to the design)

500
 7.6 Layout Objects

and to understand relationship between them. To see the complete data structure, expand all
nodes:

In addition to variables that are read in via data input modules, there are System Variables
which return values that are always calculated when the module is processed. It is also possible
to create new variables in the data structure.

To add a variable to the data structure:

1. Right-click on the Data family (or another node in the data structure) and select Insert
Variable.

2. You can rename the variable that was created:

Click and enter a meaningful name.

Press <F2> and enter the new name.

3. Complete the Layout Properties tabs.

Data Family Properties

The Data family properties are divided between the following tabs:

Data tab

Initialize tab

501
7 Layout Module

Data Tab

Options Description

Records by Defines the repetition of the data and, therefore, the whole layout design.

Selecting a variable in this combo-box defines which data will be read when this Layout
module is processed. And, because by default the layout design is repeated for each set
of data that is read into Layout, this variable also determines the repetition of the design,
i.e. there will be one document design printed for each value returned by this variable.

Any array on the first level of data can be chosen. Arrays control sets of data (records) and
each value they return is the complete set of values of the next record. Therefore, this
option can determine one document for each record. The practical advantage of this is
that each record can have the same design and just the values returned by each record
will be individual.

By default, if the workflow is reading from either single or merged data files, then the
Records variable is automatically selected here. This will result in the amount of repetitions
being equal to the amount of records in the data file.

Alternative settings might be:

Empty the data will not repeat, i.e. the design will be printed only once.

Alternatively, Empty can be selected if it is only required to read data and control
the repetition of the pages via the Repeated by option for the Pages family.

Another variable of array data-type the data can be repeated by any array on the
first level of data.

Example

502
 7.6 Layout Objects

If you have two arrays on the same level under the Data family, you need to
select one of them in Records by repetition can occur according to either
Clients or Transactions.

If selecting Clients, you would not be able to use the variables within the
Transactions array within the design because they are not being read with
the sets of values of the clients array (they are on a non-dependent level).
You could, however, use the Count variable of Transactions because it is on
the same level as Clients.

Note Repetition of the pages of a design can also be controlled at sub-set levels by the
Repeated by option of the Pages family and the Repeated by option of individual pages.

Use logic tracking If checked, logic tracking is enabled and you can proof only sample records
for each branch in Layout.

For more details see Logic Tracking section.

Data logic tracking var. Selects a variable (Int 64) that will allow you to perform logic
tracking in Data Transformer.

For more details see Logic Tracking section.

Use error recovering If checked, it enables error recovery, i.e. an additional evaluation of
Layout during preprocessing.

The error recovery functionality is used in case that you want to forbid printing records
for which a warning (or an error) is issued, fix these issues later and print only these records
again. The records that are subject to a warning (or an error) can be logged into an external
TXT error file using the Error file name field below. The first record's index is 0, the second
is 1 etc.

503
7 Layout Module

To select which warnings (or errors) should be "recovered", i.e. not printed but logged
into the file for later fix and reprint, go to the Warnings Config Dialog and there make
the following settings:

For warnings (Severity in the Proof/Production Log window-pane is Warning) set

the value in the Abort combo-box to Recoverable.

For errors (Severity in the Proof/Production Log window-pane is Fatal/Critical error)

set the value in the Abort combo-box to Ignore.

Note

The error recovery functionality is typically used for warnings (e.g. overflow in flows)
leaving the errors at their default settings to abort the job.

For the complete list of Severity and Abort values and the resulting behavior see
the Warnings/Errors Behavior section.

For more information about how the fixed records can be reprinted and in what other
modules except for Layout the error recovery can be used see the section How to Use Error
Recovery.

This option is propagated to the Workflow Parameters window-pane so that it can be

switched on in the Proof or Production environments at the time of processing.

This option slows processing speed. See Processing in Inspire Designer for more info on
the additional processing involved.

Error file name Sets the name and path to the error recovering TXT file.

The file is created when the workflow is processed for error recovery and is overwritten
each subsequent time, producing an empty file when no errors occur.

Data error var. Selects a variable, of Boolean data-type, which indicates an error has occurred
in the conversion of data.

This is for logging errors in the data that occurred before the Layout module to the error
recovering TXT file. It must be set-up in conjunction with either the Mark for Error
option in the Data Transformer module or setting Change to Error recovery in the XML
Data Input module, both of which use a Boolean variable that returns true if an error occurs
in that module: Select that Boolean variable here.

See an example of how to create this Boolean error variable in the section How To Use
Error Recovery.

Error description Selects a variable (usually of string data-type) that should be used to return
a description for each of the errors in the log file.

The description is inserted in the TXT file alongside the corresponding record number.

Example A script for this Error description variable could be:

if (DataError) return Surname+" - was error in data processing";
return Surname+" - was error in layout processing";

504
 7.6 Layout Objects

Remember that this script is only executed if there is an error. It returns the string in
first line if that error is caused in the data before Layout (DataError is the name
of the Mark for Error variable). But if there is no error in the previous data and still
an error has occurred then it must be in Layout, therefore it returns the string in the
second line.

Surname is an identifying variable for each record.

Evaluation statistics If checked, statistics are generated in the Log window-pane in Proof
or in Production when the workflow is processed. These statistics cover usage of flows,
rows, fills, images, pages and variables in the given job and bring detailed information
about conditional objects usage. The statistics for each proofing or job run can be used
for workflow optimization.

The given count is in fact the number of cases the object was processed, so you can get
a higher number for usage than you would expect (e.g. a variable can be used not only
as a field in Layout to display its content, but also as a variable on which a condition is
based, in a barcode etc.).

Note Final count numbers are received only in Production after processing the whole
job. In Proof the numbers depend on how many pages were viewed.

For each type of the objects you get a separate log message:

Example

Log message Meaning

ES: Var: Data.Cli- ES: Var: Data. ArrayName. Value .VariableName:

ents.Value.CustName: 13: count : processing time
0.019755
ES: Var: Page: Pages.Intro- ES: Page: Pages. master page name: preprocessing
ductionPage: 28: 1.502442: pages count: preprocessing time: error recovery
28: 1.570366: 0: 0: pages count: error recovery time: run pages count:
run time
ES: Flow: Flows.Row- ES: Flow: Flows .flow name: count
Set8.Cell15Flow: 13
ES: FlowC: Flows.Flow1: 8 ES: FlowC: Flows. conditional / first fitting flow name:
count (performance counter the higher number
ES: Flow-c: 1: 0 the less optimized the flow usage is)

ES: Flow-c: 2: 2 ES: Flow-c: selected conditional flow for FlowC

number in sequence according to which condition
ES: Flow-c: (Default): 6 is met (1, 2, ...): count

The last line for conditional flows displays the usage

of the Default flow; for first fitting flows it gives in-

505
7 Layout Module

Log message Meaning

formation how many times the flow was called (in

pre-processing etc.).
ES: FlowFFA: Flows.Flow5: ES: FlowFFA: Flows.first fitting auto flow name: count
36 (performance counter the higher number the less
ES: Flow: Iter. index: 0: 0 optimized the flow usage is)

ES: Flow: Iter. index: 1: 0 In this example the Max. iteration count has been
set to 4 for Flow5, so 4 additional rows are displayed
ES: Flow: Iter. index: 2: 1 below the FlowFFA line.

ES: Flow: Iter. index: 3: 0 The statistics provide an overview of the iterations
and the usage of their results, i.e. 0 means that the
result of the iteration was not used, 1 means used
once (one page using the Flow5 once in a flow area
was displayed in Proof).

In this example the result of the third iteration (at-

tempt to resize the flow content) fitted and was
used.

Note

Syntax of ES messages for other types of objects is the same.

The processing time is always total for all object occurrences.

The status of these messages (IDs 0617-0636) can be modified in the Warnings
config dialog (in Menu Proof | Edit Warning Config or Warnings button in Produc-
tion window).

Language Used for language flows. Selects a variable determining the language of each record
and filling the system variable Language with data. For more details see the section Lan-
guage Flows and Texts.

Initialize Tab

The Initialize tab is designed to be used mainly for setting initial non zero values for global
variables. The initial value and the variable to which it is assigned are defined by a script.

506
 7.6 Layout Objects

Options Description

Run Determines at what point, during the processing of the workflow, the below written
script is run. The options are:

On start Runs the script only at the start of processing (once for any given job).

Each record Runs the script on beginning of each new record.

Each page repetition Runs the script whenever a new pages sequence starts. It
is related to repetition defined in the Pages Layout Properties.

Each page Runs the script for each new page.

On URL Runs the script for links in Layout. The purpose of this feature is to
automatically convert web links into click-through links or to perform any other
conversion.

Note When you want to convert/change links in some TNO file, it has to be
processed in Layout where the conversion is specified.

Example This sample script replaces all links that begin with http://store.com/
to http:/clickthrough/personalizedpart.

if (not Input.beginWith("http://store.com/")) return Input;

return "http:/clickthrough/"+WorkFlow.clickThroughUrl(Input);

Options related to the Script Editor are described in the Script Editor Dialog section.

Variable Properties
There are up to four groups of properties associated with a variable. The tabs are:

Type

Conversion

Text Presentation

Script

507
7 Layout Module

Type Tab

Options Description

Kind Sets how the value of the variable will be handled.

Options are:

Input data variable A read only variable coming from the input modules.

Constant A read only variable where the value never changes. A constant is a
name that represents a value that can be used in your code in place of that actual
value. The purpose of constants is to make the layout code more readable.

Calculated The value of the variable is calculated using a script. It is read only
variable.

Global variable A read/write variable that can be applied to the complete docu-
ment, not just a single page . Its value can be changed within one layout page or
through a whole job, when specific conditions are fulfilled. See also Global Variables.

Numbering A numbering variable (for Int numbers only). It gets created automat-
ically when Numbering feature is used or it can be created directly in this dialog.
It has no colored background as other variables because it gets performed directly
in Layout (i. e. you can see the actual value of the variable right in Layout). It is
read only variable.

Disconnected A variable that is used in Layout but cannot be read from Data Input.
Either the Data Input and the Layout modules are disconnected in workflow, or
the variable does not exist in Data Input. If a variable used to exist in Data Input
and has been deleted or renamed, its kind is set to Disconnected in Layout. If a
variable is created in Layout and its kind set to Disconnected, it is possible to connect
the variable with Data Input later. Disconnected variables can be removed in Layout
via the Remove Disconnected option in Edit menu.

Overflow message A variable that is connected to a flow area. If the content of

the flow area overflows, the variable returns information on the objects (with the
overflown content) in such a flow area (e.g. Flows.Flow 1[138]).

Data-type Sets the type of data to the variable.

See also the Data Types section where value ranges are specified.

508
 7.6 Layout Objects

Options are:

String A sequence of text characters.

Int Integer value (32 bits).

Int64 Integer value (64 bits).

Currency 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.

Double A real number that can be represented with a floating-point notation.

64 bits (15 16 significant digits).

DateTime A variable containing date and time values. Can be selected using
"calendar" dialog when you click on the arrow opening the combo-box.

Bool A Boolean value denoted by the predefined constants True and False.

SubTree Part of a structure, the variables in it have one value. This type is applic-
able only for Constant variable kind.

Optional Part of a structure. The variables in it can have zero or one value. This
type is applicable only for Constant variable kind. See also System Variable: Exists.

Array Part of a structure. The variables in it can have zero, one or more values.
This type is applicable only for Constant variable kind. See also System Variable:
Count.

Value Determines the value to be used for Constant variable kind.

This edit-field is not available for Calculated, Global Variable, Numbering Kinds.

Display Determines whether the Name of the variable or its actual Content should be used
when showing the variable's reference in the layout. It is ignored for Numbering Kind.

Auto clear Resets the value of a global variable so that it has the same value as on the job
processing start. So it will be 0 or empty string.

509
7 Layout Module

You can choose from these four options:

On start Resets the variable only in the beginning of a job, which means it never
gets cleared during job processing.

Each record Resets the global variable on beginning of each new record.

Each page repetition Resets the global variable whenever new pages sequence
starts. It is related to Pages | Repeated by Array definition.

Each page Clears the global variable for each new page. It is useful to select this
option if you do not need the global variable's value to be remembered across
pages as it saves memory and increases processing speed.

Note This option is available only when Kind is set to Global Variable.

Auto add Whenever the variable selected in this field is used in Flow (in text presentation,
not in scripts), Global variable gets incremented by the value of this Auto add variable.

There are two conditions for the Auto add option to work correctly:

1. If you expect the content of a page to overflow, the option Flowing to next page
must be checked on the Content tab in Layout Properties of the flow area where
the variable is used in Layout.

2. If the Auto add variable is in a table row with fixed height, the option Always
process must be checked in Table Properties | Cell properties tab.

Example For Variable1 the Kind is set to Global Variable.

As Auto add variable there is selected Field0.

Field0 is part of e.g. Array0.

Field0 contains number 0 on first record, 1 or second record number 9 on 10th

record of the Array0.

In Layout we create a simple table. We place Field0 to body Rowset, which is repeated
by the Array0.

Variable1 is incremented by Field0 value every time, when Field0 is displayed. If we

place Variable 1 then to the table footer it shows final summary of all shown Field0
values.

510
 7.6 Layout Objects

In Proof we get the following results:

Variable1 got incremented by the value of Field0 every time Field0 was used.

That is, the total of Variable1 is even to 0+1+2+3+4+5+6+7+8+9.

Note This option is available only when Kind is set to Global Variable.

Conversion Tab

Enables you to convert the input variable to a different type in the output. When None is selec-
ted, no conversion will be made. All these conversion types are also available in Data Transformer
module.

For the description of Output types see the section Field Converters.

Text Presentation Tab

511
7 Layout Module

Used for String, Bool, Struct and Array types only. Determines how the text will be presented.

Options Description

Operation Available Operations for String type are:

Simple No change.

Uppercase Each character of the string will be uppercased.

Lowercase Each character of the string will be lowercased.

Titlecase The first character of the string will be uppercased.

EachWordTitle The first character of each "word" of the string will be uppercased.

Prefix The optional string that will be added before input string.

Suffix The optional string that will be appended to the end of the input string.

Script Tab

Only available when Kind is set to Calculated on the Type tab. It is for writing a script that
calculates of the value of the variable.

The options available here are the same as for the Script Editor dialog.

Variable Context Menu

The following right-click options are available for variables.

Options Description

Insert Variable Inserts a new variable. By default it is a string constant variable and its kind
and other properties can be changed in the appropriate Layout Properties panel.

Presentation Config Enables you to save, import and manage text presentation configuration.

Insert Param Variable Inserts a parameter variable using a wizard.

Copy Variable Path Using this option you can copy the full variable's path into the clipboard
and use it in a script.

To insert the path to a script editing field use the <Ctrl>+<V> shortcut or the Paste option
from the context menu.

512
 7.6 Layout Objects

Show Variable Stack Switches to the Workflow window and opens the Debug Data window-
pane where you can check detailed information about the selected variable.

Reconnect Variables Reconnects original unconnected variables with any modified ones.

If you change your data structure or rename a variable in a module before the current
one, the effected variables used in Layout no longer represent any data, become constants
and this option becomes available. Reconnecting can be done in the two following steps:

1. In the Layout Tree, right-click on any variable that needs to be reconnected and
select the option Reconnect Variables from the menu.

2. In the Reconnect Variables dialog that appears, select the variable to which the
original variable will be reconnected. This variable will replace the original variable
and its children in all their occurrences in Layout.

Note Any variable name used in scripts is not replaced. This has to be done manually or
using the Find/Replace Text palette.

Populating Variables with Favorite Data in Layout

This feature allows you to preview the appearance of the content of variables directly in Layout.
Follow the steps below to do so:

1. Right-click on the Data family in the Layout Tree and select Populate with Data.

2. Browse for the TSD file containing your favorite record, i.e. the record you want to
display in Layout instead of the variable names. This record has been saved into the
TSD file using the Set/unset as favorite item icon and Save favorite items in
Proof.

3. The result is that the variable names used in Layout are replaced by the values contained
in the particular record that has been marked as favorite and saved into the TSD file.
These record values correspond with the values displayed in the Preview field on the
Type tab of the Variable Layout Properties when you select to display Content in the
Display option.

513
7 Layout Module

Example Before populating with data:

Example After populating with data:

To display the variable name again instead of the content of variables in Layout, use the right-
click menu option Reset To Name.

Note For information about the other context menu options see:

Find Object Uses

Access Rights - For each object in the Layout Tree, for the modules in the workflow and
the workflow itself, it is possible to define rights controlling the degree of modifications
that will be allowed for specified users. Right click the according object or the appropriate
module and select Access Rights to open the according dialog. For access rights con-
cerning the workflow go to File | Workflow Access Rights in the Workflow menu.

Insert Variable

7.6.8.2 Global Variables

In this section: See also:
Methods of Updating Global Variables Adding New Variables
Conditions for Correct Functioning of Variables Layout Properties Panel
Global Variables Processing in Inspire Designer
Overflow Between Pages
Data Group Layout Properties Panel
Cells

A global variable serves for cumulation of values and for remembering a variables value through
Layout within one page, one repeated page, one record or the whole document.

514
 7.6 Layout Objects

The value of a global variable gets modified (updated) by the value of another variable as many
times as that variable is processed in Layout. Each modification (update) of the global variable
value serves as a base for calculation of its new value.

This section describes methods of updating a global variable and the conditions that have to
be met for the global variables to work properly. For the description of the Layout Properties
options for global variables see the Data section.

Methods of Updating Global Variables

You can use different approaches according to your needs: Auto add for simple cumulation
of values, writing to global variable for more complex update conditions or updating via the
Next Page tab for transferring the global variable's value from page to page.

A GUI option for auto initializing a global variable (i.e. start global variable cumulating with a
non-zero value) is also available. See the Data section.

Auto Add
This method serves for simple cumulation of values of a variable into the global variable. The
values of updating a variable are added to the global variable, which is empty at the beginning.

The variable (e.g. Price) that updates the global variable (e.g. CumulativePrice) is specified in
Layout Properties option Auto add of the global variable.

Note The global variable and the other variable must be of the same type, i.e. in Layout
Properties option Data-type, the setting for both variables has to be the same.

Writing to Global Variable

This method is suitable for updating a global variable using complex scripted conditions. For
example, you have a starting balance to which the value of each of the transactions is added
step by step. This is achieved by creating a special auxiliary variable (named e.g. WriteToGlobal)
that will contain a scripted condition specifying the process of writing into the global variable.
This auxiliary variable needs to be present in the Layout as many times as the variable which
updates the global variable and always in the same flow. However, this auxiliary variable is not
displayed in Proof and the spool file.

515
7 Layout Module

In the Layout Properties of the auxiliary variable, the option Kind has to be set to Calculated.
The Data-type has to be set to String so that this auxiliary variable is not displayed in Proof
and the spool file (it returns just an empty string).

The update condition is entered in the Script tab. For example (see also the following screenshot),
the value of the global variable Cumulative is in the first record filled with the value of the
variable Balance and updated by the value of the variable Amount, for all other records, the
global variable is updated just by the value of the variable Amount.

Note Pay attention to the processing order of the three variables: WriteToGlobal has to be
processed after Amount but before Cumulative. If the variables are placed in different objects,
check the order of the objects in Layout Tree, if they are placed in the same object, check the
position of the variables within the object in Layout.

Make sure the variable WriteToGlobal gets processed as many times as the variable Price. If,
for example, Price is repeated in a table, then WriteToGlobal has to be repeated in the table
too.

If a global variable is edited from an element, the change affects the element content only and
will not apply to the global variable anywhere else. By default a warning is displayed in the
Proof/Production log, when editing global variables from elements.

Updating Global Variable via Next Page Tab

This method serves for remembering a global variable value from page to page. A global variable
is updated using an auxiliary variable that is placed in the Next Page tab condition and writes
to the global variable when the page is processed. The value of the global variable is then
known only after the page has been processed.

The update condition is scripted in the auxiliary variable and the variable itself is used only in
the Next Page tab of Page 1, it is not used anywhere in the Layout (on the actual page).

516
 7.6 Layout Objects

The auxiliary variable (WriteToGlobal in the screenshot below) has the option Kind in its Layout
Properties set to Calculated and the option Data-type set to Bool.

In the Script tab of the auxiliary variable (WriteToGlobal) the following update condition is
entered:

The variable never returns true and so the condition that will be used for the variable page se-
lection is never executed; only the variable is processed.

In the Pages Layout Properties, the option Page order is set to Variable selection and in Layout
Properties of Page 1, Type is set to Select by condition and the condition is set as on the fol-
lowing screenshot:

Conditions for Correct Functioning of Global Variables

There are many possibilities of where and how a global variable can be used. Therefore, the
setting of a global variable and of objects related to it, which is described in the following
sections, needs to be considered.

517
7 Layout Module

Order of Processed Objects

Objects are processed according to their position in the Layout Tree: the processing goes from
the top of the tree downwards. Therefore, it is important that the object containing the variable
which updates the value of the global variable is placed in the Layout Tree above the object
containing the global variable. Position of the two objects (e.g. flow areas) in Layout is irrelevant.
For details of the order of processed objects see Processing in Inspire Designer.

If the two variables are placed within one object, the order of variables in the Layout Tree does
not matter, decisive is their position in the Layout, within the object.

If you use an auxiliary variable writing to the global variable, this auxiliary variable has to be
placed in the same flow as the variable whose value updates the global variable.

518
 7.6 Layout Objects

Example Incorrect Order of Objects with Global Variable

In this example concerning cells, the cell containing the variable Price is placed in
the Layout Tree below the cell containing the global variable CumulativePrice.

Therefore, Price gets processed too late to be able to update the value of Cumu-
lativePrice in the first row and the update takes effect from the second row.

In case of flow areas, the flow area containing the variable Price (FlowArea_Table)
is placed in the Layout Tree below the flow area containing the global variable
TotalPrice.

The whole content of FlowArea_Table (there are four items of the variable Price)
gets processed after TotalPrice, and the global variable therefore cannot reflect
any of the changes. In Layout, the position of flow areas does not matter.

Page Overflowing
If you expect the content of a page to overflow (e.g. the variable Price that updates the global
variable contains many items), the option Flowing to next page must be checked on the
Content tab in Layout Properties of the flow area where the variable Price is used in Layout.

519
7 Layout Module

Note Make sure that also other settings concerning overflowing and repetition are done ac-
cording to the document's needs. For details see the section Overflow Between Pages.

Global Variable in Tables

If a global variable is updated by a variable used in a table (e.g. by the variable Price), you have
to be careful about the Type settings. If it is set to Fixed height, the cell is not processed during
preprocessing and the value of the variable in the cell will not be added to the global variable
cumulative value. Therefore, if you use this option for cells that contain a variable updating a
global variable, you need to check the option Always process to ensure correct functioning
of global variables.

In case the Custom option is selected, the cell is always processed and global variables work
correctly.

Note In tables, it is recommended not to use a global variable in a condition for row selection
if the global variable gets changed in this condition. When such table overflows, some rows
might not be printed even in case the condition of the row set is evaluated.

520
 7.6 Layout Objects

Using Global Variables After Layout

If you want to use global variables values after Layout, the only possible way is to add the
global variable into a sheet name (in the Pages Family properties) and then use the Statistic
Data module to add the sheet name value (i.e. the global variables value at the end of the re-
cord) as a new variable to your data structure.

The individual pages sheet names or the Data Output node in Layout cannot be used as you
always get the value from the beginning of the page and the final value is never obtained.

7.6.8.3 How to Use the Insert Param Variable Wizard

You can use the Insert Param Variable Wizard to simplify the process of creating a variable re-
turning the value of a workflow parameter.

In the SystemVariables Layout Tree node, right-click and choose Insert Param Variable.

In the dialog, there is a list of available modules and appropriate parameters available for the
currently selected module.

After clicking OK, a new calculated string variable is inserted automatically (in this case the
variable's name will be Branches-dif). On the Script tab in the Layout Properties, there is already
a defined script that returns the value of the workflow parameter.

521
7 Layout Module

7.6.8.4 How to Work with Data and System Variables

See also:
Processing in Inspire Designer

Inspire Designer provides maximum control over the way data will be handled in your document.

Example You can:

Add data elements.

Use the system variables:

Page Counter, Job Name etc. that are always captured by Inspire Designer.

Insert Param Variable Wizard to get the name of the Input Data File or para-
meter specified in the ParamInput module etc. and process it.

Transform (i.e., convert) data.

Each data element resides as a node in the Layout Tree. For example, you may have a structure
entitled "Value" with a list of variables associated with it. The structure appears as a parent
branch, and each of the variables appear as children. Additional visual clues are provided to
enable you to quickly assess the type of data that is (or can be) used in the document.

Once a data node is added to the Layout Tree, you further modify how the data will be handled,
using the Data Layout Property panels.

System Variables
System variables are data that Inspire Designer always creates. If you choose, you can drag and
drop any of these variable nodes into your document. Some indicated variables cannot be used
in preprocessing as their value is not known yet.

PageCounter Returns current layout page number within the current record defined in the
Data node (Records by option). It starts from 1 again on the next record. See an example.

Overflow Indicates whether any object in the layout flows into another page (true/false).

JobName Returns the name of the workflow.

PageIndex The page index that reflects the order of pages in the Layout Tree, e.g. the first
page from the top will have PageIndex 0, the second page will have PageIndex 1 etc. See
an example.

PreviousPageIndex An index of the previous page in production.

PageName The name of the current page in production. Inspire Designer takes the PageName
from Layout tree the values of this variable would be Page1, Page2 etc. unless you rename
them.

PreviousPageName The name of the previous page in production.

522
 7.6 Layout Objects

RecordIndex Starts at 0 and keeps tracking during printing on which record you currently
are in your data file. See an example.

PagesPerRecord The number of pages that will be built for a record. This variable cannot
be used in preprocessing.

GlobalPageCounter Returns current layout page index within all records. See an example.

PageArrayIndex Starts at 0 and keeps tracking which subrecord you are on. See an example.

GlobalSheetCounter Returns current sheet number within the whole job (after impositioning).
This variable cannot be used in preprocessing.

GlobalSheetCount The total number of sheets that the job has (after impositioning). This
variable cannot be used in preprocessing.

GlobalPageCount The total number of pages that the job has after Layout. See an example.
This variable cannot be used in preprocessing.

JobStarted The time when the job production was started.

True An auxiliary "variable" (actually, a constant). Use this when you want a certain condition
to be always true.

PagesPerSubRecord The number of pages that will be built for a subrecord. See an example.
This variable cannot be used in preprocessing.

PageSubCounter The current layout page number (i.e., the number of the page for the
subrecord currently being printed). See an example.

GroupSheetCounter Variable returns current sheet number within current group. It starts
from 1 again for the next group. If no regrouping in Sheet Regrouper is set, returns the
same values as PageCounter. This variable cannot be used in preprocessing.

PrintingFace This Boolean variable returns the real production printing face. True (1) is re-
turned for front page, false (0) back page.

Setting Simplex or one of the Duplex options in the Duplex type combo-box in the Output
module influences the result, i.e. if you have set Simplex, the PrintingFace variable always
returns true.

However, the variable is not reset with media change:

Example Three pages are designed in Layout and three different media defined
for them in Output:

Page 1 contains an introduction, always one page; Medium 1 is assigned

to it with Simplex setting.

Page 2 overflow is set to display the page again if the content does not fit
on one page; Medium 2 is assigned to it with Duplex long edge setting.

Page 3 overflow is set to display the page again if the content does not fit
on one page; Medium 3 is assigned to it with Duplex long edge setting.

523
7 Layout Module

See the PrintingFace value if the number of pages that match the duplex medium
setting is odd:

Page 1 Medium 1 PrintingFace = 1 (i.e. PrintingFace is always 1 = front

page for simplex medium setting).

Page 2 Medium 2 PrintingFace = 1 (i.e. First page = front page for duplex
medium setting).

The content for Page 2 all fits on just one page, so there is an odd number
of pages for a duplex medium.

Therefore then: Page 3 Medium 3 PrintingFace = 0 (i.e. First page = front

page for duplex medium setting, but as the PrintingFace is not reset with
media change, it returns false = back page).

Note This variable can also be used in setting Variable visibility.

This variable cannot be used in preprocessing.

Group Index Starts at 0 and keeps tracking during printing on which group you are on in
your data file. If no regrouping in Sheet Regrouper is set, returns the same values as Re-
cordIndex. This variable cannot be used in preprocessing.

Serie Index Only for usage in Charts. Returns the index of the currently processed series
used in a chart. Starts at 0 and can be used for e. g. variable chart fill.

Value Index Only for usage in Charts. Returns the index of the currently processed value
used in a chart. Starts at 0 and can be used for e. g. variable chart fill.

Example We would like to display results of tests that students have taken. The
chart should display the result in percents (1-100) and also the bars should change
color according to the fact if they passed or failed.

In the data there is an array of students and within it an array of subjects they have
taken tests in (including the information about the result (in percents) and the pass
entry (Yes/No)).

The array of subjects will be selected in the Values array, the result variable (contain-
ing the percentage) in the Value variable on the Series tab | Values tab. The Fill in
this tab will be variable, selected by inline condition:
DATA.Student.Current.Subject[SYS.ValueIndex].Pass=="Yes"

524
 7.6 Layout Objects

Then different color fill styles will be selected for the cases when the student passed
the test (e.g. green) and when he/she failed (e.g. red).

Language Used for language flows. String variable containing values that determine the
language for each record. The values are retrieved from a variable set in the Language
option of the Data Layout Properties panel. For detailed information see the section Lan-
guage Flows and Texts.

GroupSheetCount Returns the total number of sheets within each specific group (after im-
positioning). This variable cannot be used in preprocessing.

Note If there is index in the name of a system variable it means that it starts from 0.

If there is counter in the name of a system variable it means that it starts from 1.

If there is count in the name of a system variable it means that it displays the total number.

There is also another group of system variables which are always placed by relevant object:

Count (for more information see Array description section)

Exists (for more information see optional Array, Flow, Rowset sections)

Index (for more information see repeated Flow, Rowset sections).

Variable Type and Kind Indicators

Inspire Designer provides visual clues in the Layout Tree to enable you to determine the type
and kind of variables used in the workflow. These symbols are used both for System variables
and for variables you add to the Layout Tree:

String (constant)

Integer (constant)

Integer64 (constant)

Currency (constant)

Double (constant)

DateTime (constant)

Boolean (constant)

525
7 Layout Module

Structure (constant)

Optional (constant)

Value

Exists

Array (constant)

Value

Count

String (calculated)

String (global variable)

The list above names the codes that Inspire Designer uses to indicate the Kind and Type of
variables. The gray symbol relates to the Type; the colored symbol to the Kind. For example,
the icon stands for Type set to String and Kind set to Calculated.

Note Most examples above are for the Kind set to Constant. Samples of the Calculated and
Global Variable kinds are at the bottom of the list.

System Variable: Count

For each array there is a system variable Count which returns the current number of array fields.
You can refer to this variable in e.g. scripting.

526
 7.6 Layout Objects

System Variable: Exists

There is a system variable Exists if the Type in data is defined as Optional. (Optional means
that a value can appear there 0 or 1 times.) It returns true in case that there is a value coming
to the data.

This variable can be useful for e.g. scripting and also for flows and rowsets selected by condition
i.e. if Exists (if there is a value for the Optional part of the data), display an appropriate flow
or rowset (typically containing the data from the Optional part of the data).

Example You can see the data type Optional in Proof:

Here is the corresponding Layout Tree structure:

527
7 Layout Module

System Variable: Index

If you set a flow or rowset to be repeated by an array coming from the data there is a system
variable Index created. The variable Index displays the index (begins from 0) of the current
variable field coming from the array by which the flow or rowset is repeated when such field
is used within the repeated rowset or flow.

528
 7.6 Layout Objects

Example It can be used to mark each row in a table:

7.6.8.5 Logic Tracking

Logic tracking enables effective proofing or printing of large jobs. When it is enabled, only
those pages representing different branches in Layout are sent for proofing. The feature
works in Production the same way. Branches are created as a result of evaluating conditions
in Layout or Data Transformer (e.g. overflow, conditional flow, used if in scripts).

Example If you have 10 000 records and you design several pages in Layout depending
on the age (under 30 or above 30) and gender of the customers, with the help of Logic
tracking you can see in Proof only those pages that cover all combinations of these con-
ditions:

You will see in Proof:

one record for the first woman under 30 (others will be ignored)

one record for the first man under 30 (others will be ignored)

one record for the first woman above 30 (others will be ignored)

one record for the first man above 30 (others will be ignored)

In this way Logic tracking can go through all conditions applied in Layout or Data Trans-
former and create branches. For each branch there will be only one record in the Proof.

You may get some pages in Proof that appear the same but the logic behind them is dif-
ferent (e. g. a page with static paragraph is not the same like the following page with the
same content where this paragraph is already placed into an overlay).

Logic Tracking in Layout

To use this feature for all conditions in Layout, check the Use Logic Tracking option in Data
Layout Properties. As you do this, Use error recovering becomes enabled too it is necessary

529
7 Layout Module

for evaluating duplicate records. All duplicate records are ignored for proofing and they get
saved in txt file for which you need to enter a file name and path into the Error file name
field.

After you run proof, you will see only records for all different branches in Layout.

Logic Tracking in Data Transformer

To be able to track conditions in Data Transformer where Script is used as Field converter, you
need to do the following steps:

1. In the Data Transformer mark the array for save (Clients in the screenshot below).

2. While having the array selected create a new unlinked field of type Int 64 (in the
screenshot below named LogicTrackingStore).

3. Mark this new field as logic tracking store using the icon . This variable will save
a control sum of conditions within one record in Data Transformer.

4. In Data Layout Properties check the Use logic tracking option, select the variable
marked for logic tracking store and fill in the Error file name field:

530
 7.6 Layout Objects

If you select a variable in the Data logic tracking var., it means that you add the logic
behind this variable to the Use logic tracking functionality. It does not mean that logic
tracking would be based only on this variable.

5. Run proof. By default the warning about having found a duplicate record has fatal error
status and proofing cannot continue.

The first time you try to run proof with logic tracking, you need to open the Warnings
Config dialog (Menu Proof | Edit Warning Config or right-click on the message line)
and set the Abort status of message 0616 Logic tracking: Duplicate record found to
Recoverable or Ignore.

After you confirm this setting, proofing will continue and will display all records repres-
enting branches in Layout and Data Transformer.

In Log in Proof or Production you will have a message displayed for each duplicate re-
cord:

Logic tracking: Duplicate record found [8/3]

531
7 Layout Module

[8/3] means that record 8 is a duplicate of record 3.

Note Numbers of records are 1-based (first record has number 1).

Tip To double check the identity of displayed records, you can go to the Data Proof sub-tab
and compare the value of logic tracking store variable it contains randomly generated numbers,
different for each record evaluated by logic tracking as a branch. If the number was the same,
it would mean it is the same record in terms of logic tracking.

Tracking Other Data

There are also logic tracking methods available in scripting which enable you to add more
branches in logic tracking based on any variable even without conditions. See an example in
Workflow methods.

7.6.9 Data Output

In this section:
Creating a Data Output Structure
Data Output Layout Properties Panel

Data Output allows you to create a data structure directly in Layout. The data structured here
(which can consist of user created variables, system variables as well as variables that are read
into a workflow from external data file(s) using the Data Input module) can then be further
used in your workflow using the Data Output connector.

Note Data Output cannot be used for global variables as their value is not known at the
moment when the data output is created.

The Layout module has two output connectors:

Legend

1. Data Output connector

2. Sheet Output connector

532
 7.6 Layout Objects

Whereas you can connect modules such as Impositioning modules and the Output
module to the Sheet Output connector (2), the Data Output connector (1) allows you
to connect modules such as:

Data Processing modules - which can be used to process the data that is output
from the Layout module for further use in another Layout etc.

The Data Output module - which can be used to create a data file from the data
that is output from the Layout module.

A second Layout module - which can use the data from the original Layout module
as data input.

7.6.9.1 Creating a Data Output Structure

The data structure that you would like to use via the Data Output connector has to be created
using the Data Output family located near the bottom of the Layout Tree.

To create a new Data node, right-click on Data Output in the Layout Tree and select Insert
Data Node from the context menu; a new data node (named "DataNode 1" by default) will
be created.

To create a nested node, right-click on the node that you would like to nest the node below
and select Insert Data Node from the context menu.

The last step is defining the data output by completing the properties panel for each data node
that has been created. Selecting the nodes you have created ("PageRepetitions" in the example
screenshot below) will display the according properties panel:

Note The variable will be referred to by the name of the node, when you create a data file
or connect a further Layout to this Layout module to use the data you output via these settings.
Thus, for a better overview, it is helpful to rename a newly created node by selecting it and
clicking on the Rename icon.

533
7 Layout Module

7.6.9.2 Data Output Layout Properties Panel

For each node that you create it is necessary to define its type in the Type combo-box and,
depending on the type, selected it could also be possible to specify a variable in the Variable
combo-box.

Example A typical structure would be to create a Data node and use one of the "Re-
peated by" options to specify how the nested nodes (which will usually be set to Variable
in the Type combo-box) created below this node will be repeated.

Of course, you can nest further data structures below the first and also control their
structure using the "Repeated by" options (see the screenshot above for an example of
a structure created for Data Output).

Options Description

Type Following data node types can be selected from this combo-box:

Repeated by records - All subnodes will be repeated by the array specified in

the Records by combo-box available on the Data Layout Properties.

Repeated by pages repeated by - This option can work in two ways depending
on the context it is used in:

All subnodes will be repeated by the variable specified in the Repeated by

combo-box on the General tab of the Pages' properties panel (available when
Variable selection has been selected in the Page order combo-box on the
same tab) except for the following case:

If the node defined by the Repeated by pages repeated by option is itself

nested under a node defined by the Repeated by records option, then its
subnodes will be repeated only by the subdocuments of the current record/doc-
ument.

Repeated by pages - The functionality of this option is context dependent and

thus works differently under the following circumstances:

If the root node is defined by this option, then its subnodes are repeated by
all pages generated in this layout (whose usage is defined on the Pages nodes
and the respective layout properties panels).

If nested under a node defined by the Repeated by records option, then its
subnodes will be repeated by the pages of the current record/document.

If nested under a node defined by the Repeated by pages repeated by option,

then its subnodes will be repeated by the pages of the current subdocument.

534
 7.6 Layout Objects

Repeated by - When selected, the Variable combo-box is available where you

can specify the variable by which all nested nodes will be repeated by.

Optional - All data nodes nested below this node are optional.

The Variable combo-box is available where a variable of the Boolean type can be
selected to control if the nested data will appear in the data output. The selected
variable will be evaluated at the time data output is generated and its subnodes
will only be processed if the variable returns the value True. If the value False is
returned the subnodes will not contain any data in output.

The most typical usage would be to select a variable of the type "Exists" to control
whether data will be generated in the output or not.

See the sections Variable Type and Kind Indicators and System Variable: Exists for
details.

Note A System Variable "Exists" is only available if data of the type Optional is
being used in the workflow.

Sub tree - Use this to define the tree structure only. This works the same way
as in Script Data Input.

Variable - When selected, you can specify a variable, that will take the position in
the data structure, in the Variable combo-box.

Note The icon displayed for data nodes set to Variable differs depending on the
type of variable specified. See the Variable Type and Kind Indicators section for
details on these icons.

Variable The availability of this combo-box depends on the selection made in the Type
combo-box. It is available when the following selections are made in the Type combo-
box:

Repeated by

Optional

Variable

See the above description of the appropriate data node type in the description of the Type
combo-box for details.

7.6.10 Effect Areas

In this section: See also:
Effect Area Layout Properties Elements
How to Change Text Shape Modifying Shapes
How to Transform Raster Images

Effect areas define spaces on a page where object modifying effects can be used. Typically,
effects would be employed to adjust the shape of text, especially text in variables, used as part

535
7 Layout Module

of an image, which is described in the How to Change Text Shape section. However, text is
not the limit other objects, e.g. shapes and images can be modified too. Raster images can
be transformed using custom effects using the convolution matrix and other effects. See the
How to Transform Raster Images section for instructions on how to emulate embossed print
on a credit card.

To create an effect area:

1. Click on the Effect Area Tool .

2. In the Layout Area, drag the mouse pointer to create the effect area.

3. Edit the effect area's layout properties.

7.6.10.1 Effect Area Layout Properties

The following tabs are available:

Position Tab

Content Tab

Variables Tab

Note The Effect Area is an environment where modulation effects can be applied. However,
for the effects to work, more Layout objects must be used. Any object an effect is applied to
has to be inserted in an Element which is associated with the Effect Area. The shapes are
changed using the Change Shape tool. The instructions for using the effects are detailed in
the How to Change Text Shape and How to Transform Raster Images section.

Position tab
The options available are described in the separate section Position Tab.

Content Tab

536
 7.6 Layout Objects

Options Description

Element Displays the element that is contained in the effect area.

A new element is automatically created when an effect area is inserted in the layout. If
you wish to use another element, select one from the combo-box or create a new one
using a combo-box option.

Note If an effect area is created on an existing layout object (flow area, image area, effect
area etc.), the element created within the effect area is not empty but includes the objects
on which it is placed. However, effects are applied only to the parts of such objects which
are within the effect area's coordinates.

Modifier type Select here the modifier type that will be applied. The available options are:

Raster Glyphs are represented by bitmap arrays; one effect behaves like one raster
image. This modifier is suitable especially for images as it offers more deforming
capacity compared to the vector modification.

Note If raster modifier has been selected, shapes are limited by the area of the
respective element.

Vector Glyphs are represented by paths. This modifier is useful for changing the
perspective of text because characters' outlines are smooth even if their shape has
been changed.

Note The vector modifier is of limited use with images as only 2D transformation
can be applied on images in vector output. This affects both perspective and warp
effects.

The vector modifier does not support gradients.

Layout DPI Sets the DPI used in the Layout, the default value is set to 96.

Production DPI Sets the DPI used for production, the default value is set to 300.

Effect After adding an effect using the Create New icon, select here from the combo-
box the type of effect that you wish to apply.

Note This section contains the options description of the Effect Area Layout Properties
dialog. Step-by-step instructions on using the effects are detailed in the How to Change
Text Shape section.
The available effects are:

Perspective Enables to change the perspective of objects contained in the effect

area. This effect may be useful if you wish to make a text or image part of another
image, e.g. to "write" something on a building in a photo.

537
7 Layout Module

If you choose the Raster modifier, you can define its properties by clicking on the
3 dots button, which opens a dialog allowing to select the Filtering mode.
You can choose between two options:

Point The fastest and crudest filtering method. Use it if you prefer speed,
however, you may experience drops in quality, e.g. texture blockiness, aliasing
or shimmering.

Bilinear Select this method if you prefer higher quality to the best available
speed.

Warp Enables to deform the objects contained in an effect area. This effect may
be useful if you wish to make a text or image part of another image, e.g. to "write"
something on a round object in a photo.

If you click on the 3 dots button, a tab will open allowing to set the effect's
properties.

X-snap point count Sets the number of snap points on the horizontal axis of
the warp grid. The points are warp grid intersections and can be mouse-
dragged in order to deform the area.

Y-snap point count Sets the number of snap points on the vertical axis of the
warp grid.

Spline mode Check this box to turn straight grid lines connecting the snap points
from into splines. This mode allows for making smoother shape deformations.

Show subsplines Checking this box will display subsplines that help visualize
the shape deformations created using the warp effect.

X-interpolated point count Sets the number of vertical subsplines (X-axis inter-
polations).

Y-interpolated point count Sets the number of horizontal subsplines (Y-axis

interpolations).

Apply clipping on rectangles This option is available only if the Vector modifier
type has been selected.

If this check-box is selected, shapes will be limited to the area inside the warp
grid. The advantage of this setting is exact positioning, slower processing is
the drawback.

538
 7.6 Layout Objects

Example This screenshot shows a warp effect applied on text. The blue
warp grid is visible as the Change Shape Tool is active. This means that
modifications can be done now. The Spline mode is turned on, so subsplines
(yellow lines) are visible.

The following properties have been set:

X-snap point count set to 8 and Y-snap point count set to 4 see the
blue grid.

X-interpolated point count set to 4 and Y-interpolated point count

set to 2 see the yellow lines inside each of the grid sections.

Convolution Filter Enables to create custom filters using a matrix (kernel) to treat
raster images. This effect is only available if the Raster modifier has been selected.

539
7 Layout Module

If you click on the 3 dots button, a dialog will open allowing to set the effect's
properties.

Convolution matrix Enter the values directly in the boxes. You can use 5x5 or
3x3 matrices. If all border values of the matrix are set to zero, the system will
consider it as a 3x3 matrix.

Design of kernels is based on advanced mathematics, however, you can find

some matrix examples on the Internet.

Division factor Divides the result of a previous calculation.

Bias This value can be added to each element in a convolution result. Since with
some convolutions it is possible to get negative numbers (which are not rep-
resentable in a 0255 format), bias prevents the signal from getting out of
range.

Channel selection Select here what RGBA channels the transformation will be
applied to. By default, all four channels are checked.

Highlighted Emboss Creates an impression of embossed surface by enhancing

an emboss effect applied using the convolution matrix. See the example of use in
How to Transform Raster Images section.

Gaussian Blur Enables to blur raster objects using the Gaussian function. Typically,
it is used for reducing image noise and detail.

If you click on the 3 dots button, a dialog will open allowing to set the radius
of the blur using a slider control. The default value is 2 pixels.

Move Up / Move Down Moves the selected effect up/down.

Create New Adds a new effect.

Remove Removes the selected effect.

Remove All Removes all effects.

Tip The effects are not limited to static objects they can be applied on variables as well.
Simply insert variables into the elements contained in effect areas.

540
 7.6 Layout Objects

Variables Tab
This tab is accessible only if the Raster modifier type has been selected on the Content tab.

The purpose of this functionality is to control the variables used in elements contained in effect
areas in order to increase processing speed. Normally, if variables are used with raster effects,
every variable value is generated as a new raster image. Adding a variable to this tab has the
following effect if Inspire Designer detects a variable value that is identical to a value already
used, it will be inserted into an overlay.

Options Description

Variable Lists the selected variables.

Create New Adds a new variable.

Remove Removes the selected variable.

Remove All Removes all variables.

7.6.10.2 How to Change Text Shape

In this section, you will learn how to insert a text into an image using the perspective and warp
effects.

541
7 Layout Module

Perspective
The objective of this example is to create an image similar to this one:

Tip The examples here use static text, however, the effects can be applied also on variables.

1. Insert the image where you wish to add the text with the Perspective effect in Layout
and place it on a page.

2. From the Tools toolbar, select the Effect Area Tool . Then drag the mouse pointer
across the page to create the effect area.

Tip Place the effect area outside of any existing image or flow area on the page.
Later, you can drag the area with the mouse or edit its position using the options on
the Position tab of the area's Layout Properties dialog.

If you place the area on a layout object, the object is included in the effect area's ele-
ment.

When you have created an effect area, a new element is automatically created and in-
cluded into it.

3. Double-click on the element in the Layout Tree to display it, draw a flow area on it and
add the text you wish to use in an image, e.g. "Hello World!", to the flow.

The Layout Tree structure you have just created may look the following way:

542
 7.6 Layout Objects

The actual element may look like this:

Note In this example, white text will appear on a black computer screen, so the font
color needs to be changed correspondingly.

4. Move the effect area to the desired position on the page.

5. Edit the effect area's Layout Properties:

a. Set the Modifier type combo-box to Vector. This setting will help you retain
smooth character outlines when changing the size and shape of the text.

b. Using the Create New icon, add an effect. The Perspective effect type is selected
by default.

c. From the Tools toolbar, select the Change Shape Tool and left-click with the
mouse on the effect area. The area will be highlighted and drag-points will appear
at its corners. See the image in the left part of the screenshot below.

Using the mouse, drag the corners to create the desired view. The result may look
similar to the image in the right part of the screenshot below.

d. Press <F6> to proof the job and check the result.

Warp
The objective of this example is to create an image similar to this one:

543
7 Layout Module

1. Insert the image where you wish to add the text with the Warp effect in Layout and
place it on a page.

2. From the Tools toolbar, select the Effect Area Tool . Then drag the mouse pointer
across the page to create the effect area.

Tip Place the effect area outside of any existing image or flow area on the page.
Later, you can drag the area with the mouse or edit its position using the options on
the Position tab of the area's Layout Properties dialog.

If you place the area on a layout object, the object is included in the effect area's ele-
ment.

When you have created an effect area, a new element is automatically created and in-
cluded into it.

3. Double-click on the element in the Layout Tree to display it, draw a flow area on it and
add the text you wish to use in the image, e.g. "Hello World!", to the flow.

The Layout Tree structure you have just created may look the following way:

544
 7.6 Layout Objects

The actual element may look like this:

4. Move the effect area to the desired position on the page.

5. Edit the effect area's Layout Properties:

a. Set the Modifier type combo-box to Vector. This setting will help you retain
smooth character outlines when changing the size and shape of the text.

b. Using the Create New icon, add an effect. Select the Warp effect type from
the combo box.

c. Click on the 3 dots button to open the Warp dialog where you can edit the
properties of the effect.

Tip The number of grid intersections (drag-points) you choose depends on the
size and shape of the object you wish to deform and, naturally, on the "shape"
of the object in the image. The spline mode is useful for round objects, e.g. the
balloon in this example. If you work with straight lines and sharp corners, e.g.
buildings, leave the spline mode inactive.

When in the spline mode, displaying subsplines will make it easier to follow the
object's shape.

See the setting example below:

Selecting the Spline mode is useful for round surfaces, the Show subsplines
option will make it easier to create a "3D" impression as the grid will be more
dense.

d. From the Tools toolbar, select the Change Shape Tool and left-click with the
mouse on the effect area. The grid will be highlighted and drag-points will appear
at grid intersections. See the image below:

545
7 Layout Module

Using the mouse, drag the points to create the desired view. The result may look
similar to the following image:

e. Press <F6> to proof the job and check the result.

7.6.10.3 How to Transform Raster Images

This section contains an example of treating raster images using effects available in Inspire De-
signer effect areas.

Credit Card with Embossed Text

The objective of this example is to create a credit card image with embossed print simulation.
The result should look similar to the image below:

546
 7.6 Layout Objects

1. Insert a credit card image (without text) on a page.

2. From the Tools toolbar, select the Effect Area Tool . Then drag the mouse pointer
across the page to create the effect area.

Tip Place the effect area on the card image, exactly where you wish to add the text.

When you create the effect area on the credit card image, a copy of the image will be
automatically included in the element created with the effect area. Remove the image,
e.g. from the Layout Tree.

3. Go to the Layout Tree and double-click on the element included in the effect area to
display it, draw a flow area on it and add the text you wish to use in an image, e.g.
credit card number, expiration date and card holder's name, to the flow.

The font used in this example was OCR A Extended, font color light gray (RGB: 227,
227, 227).

4. Apply the effects to emulate embossed print using the options on the effect area's
Layout Properties tab:

a. Set the Modifier type to Raster and the change the Layout DPI value to 300
pixels for a better detail.

b. Using the Create New icon, add an effect. Select the Convolution Filter effect
type from the combo box.

c. Click on the 3 dots button to open the Convolution Filter dialog where you
can edit the properties of the effect.

547
7 Layout Module

Edit the dialog options to get the setting shown in the screenshot below:

At this stage, the text on the credit card should look like this:

d. Using the Create New icon, add one more effect. Select the Highlighted Emboss
effect type from the combo box.

This effect further enhances the emboss effect calculated using the convolution
matrix, so the text should resemble the following example:

5. Press <F6> to proof the job and check the result.

7.6.11 Elements
In this section: See also:
Element Layout Properties Element Areas
How to Create Element Areas
Flow Areas

548
 7.6 Layout Objects

An element can be compared to a page; it is an area in which you can place any object (flow
areas, shapes etc.) and use it to create a layout design. Where it differs is that one element
can be placed in a flow or on pages multiple times, making it a very useful tool for designing
repetitive features.

To create an element, right-click the Elements node and select Insert Element from the
context menu. A new Element node (e.g. "Element 1") will be added to the Layout Tree.

Elements are commonly used in association with Element Areas which are created when you
drag and drop a element into the Layout Area of a page. Element areas contain the element,
control its position and allow other manipulations.

7.6.11.1 Element Layout Properties

The properties of an element can be adjusted in the properties panel that appears when it is
selected in the Layout Area or Layout Tree.

Options Description

Width Sets the width of the element.

Height Sets the height of the element.

Formatting Aligns the bottom of the element relative to the characters of the text, when
an element is placed in a flow.

The following options are available in the combo-box: Top, Center, Baseline or Bottom.

Example

Offset Specifies the setting made in the Formatting combo-box.

Positive values will move the character position upwards, negative values downwards.

549
7 Layout Module

Runaround children only If checked, and if the element is placed in a flow using an anchor,
text will wrap around any objects that are placed inside the element and not around the
borders of the element itself.

The runaround properties of both the anchor and those child objects further affect how
the objects are wrapped by the text. See the Runaround tab for Flow Areas, Image Areas
or Shapes.

Dynamic size by runaround If checked, the size of the element will be determined by any
runaround that has been set for child objects that are placed in it.

When inserting an element into a flow, then setting the Type option on the Runaround
tab of the child objects (i.e. Flow Areas, Image Areas or Shapes) to any value other than
None, determines that the size of the element will be reduced so that its borders wrap
close to the content of those child objects. If an anchor is used, its runaround Type must
also be set.

If this option is checked and Type is set to None for all child objects (and any anchor used),
then the element is reduced to a size of nothing (Width 0, Height 0).

There are similarities in the text wrapping that result from the options Runaround children
only and Dynamic size by runaround, but remember that Dynamic size by runaround
changes the actual size of the element.

Example For the creation of all of the screenshots below, runaround Type has been
set to Square for the anchor and the child objects - FlowArea 1 (which contains Flow1)
and FlowArea 2 (which contains Flow2):

In this screenshot neither Runaround children only or Dynamic size by run-

around have been checked:

Here the text of Flow1 wraps around the whole element.

In this screenshot only Runaround children only has been checked:

550
 7.6 Layout Objects

Here the text of Flow1 wraps around the child objects in the element.

In this screenshot only Dynamic size by runaround has been checked:

Here the size of the element has been reduced (according to the runaround Type
of the child objects) and the text of Flow1 wraps around the whole element.

The Reference point of the anchor used to make all of the above screenshots was Upper
left. By changing the Reference point, greater differences can be seen between the
wrapping effects of Runaround children only and Dynamic size by runaround.

7.6.12 Element Areas

In this section: See also:
Element Area Layout Properties Panel Elements
Element Area Types How to Create Element Areas
How to Repeat Layout Objects By Integer
Variables

Element areas are used to position elements on a page. Furthermore, using an element area,
an element can be repeated as often as necessary in order to make multiple copies of similar
information on the same page (e.g. address labels).

First you need to design an element, then you can specify how many times it will be repeated
using the element area.

551
7 Layout Module

Example An element area with an element (containing address labels controlled by

variables) which is repeated 9 times, i.e. Count X and Count Y are both set to 3, will
look like this:

The element used in the element area will be listed under the node of the element area
in the Layout Tree.

For an example of how to create element areas and the elements which reside in them, see
the section How to Create Element Areas.

7.6.12.1 Element Area Layout Properties Panel

In the Layout Tree, click on an element area that you have created to display the according
properties panel. With the help of this panel you can specify details for the selected element
area. Settings can be made on the following tabs:

Position Tab

Content Tab

Position Tab
Refer to Position Tab for details.

552
 7.6 Layout Objects

Content Tab

Objects Description

Element Selects an element to be displayed inside the element area.

All previously created elements are listed in the combo-box menu or select Create new
element to add a new element to the area. This new element must be opened via the
Layout Tree in order to be edited.

The selected element should be smaller than the page otherwise it will not fit on the page
and element areas cannot be made to overflow. It follows that the element should also
be able to fit on the page when it is repeated across and down the page by the options
Count X and Count Y.

Variable Enables you to select an array or integer variable to control the appearance of the
element area.

The number of elements to be shown will equal the number of records in any specified
array or any number defined by an integer variable.

Example If there are 20 records in the Array0 but only 12 element cells have been
defined (Count X= 4, Count Y= 3) in the Content tab of the element area's properties
panel, then the element area type Row By Row Upper Left will show the element
just 12 times. This means that only 12 out of 20 records will be used.

If, on the other hand, you have defined 24 element cells (Count X= 4, Count Y= 6)
then only these 20 elements will be shown. This works the same way when an integer
variable has been used in the Variable combo-box.

See also the example in the How to Repeat Layout Objects by Integer Variables section.

Type Determines the order in which the elements will be printed.

This combo-box is only available when elements are specified using an array or integer
variable set in the Variable combo-box. See the section Element Area Types for details
on the options available here.

Count X Determines how often the element specified in the Element combo-box will appear
across the page.

Count Y Determines how often the element specified in the Element combo-box will appear
down the page.

553
7 Layout Module

Gap X Sets the space between the resulting columns.

Gap Y Sets the space between the resulting rows.

Element Area Types

When using variables to define the content of the element used in the element area, you can
define the arrangement of the records in the Type combo-box. The following options are
available and will lead to the described result:

7.6.13 Embedded Object Areas

In this section See also:
Embedded Object Area Layout Properties HTML Import

Embedded Object areas contain embedded objects on a page or in an element.

Embedded objects are objects external to the workflow which are called for display at the time
that any resulting document is viewed. One intention is to be able to embed short videos that
are located on the internet, but embedded objects can be any HTML object or Flash file.
Workflows using embedded objects should only be produced using the HTML engine or the
SWF engine.

To add an embedded object area to a page, click on the Embedded Object Area Tool in
the Tools toolbar and draw in any position on that page. Then determine which embedded
objects you want to be displayed via the Layout Properties.

554
 7.6 Layout Objects

7.6.13.1 Embedded Object Area Layout Properties

There are the following tabs:

Position

Runaround

Content

Position Tab
Refer to the Position Tab section for details about the options here.

Runaround Tab
The options on this tab are the same as for shapes.

Content Tab
Select the Object type:

Flash Determines that the object will be a flash file.

HTML Determines that the object will be HTML coded.

Content Tab for Flash Objects

Options Descriptions

Select by Selects whether the Flash (SWF) file location will be determined by a variable from
the workflow.

If Simple URL is selected, enter the path which will always be used to the file location in
the URL edit box which appears.

URL can be a web location or a location on a disk.

555
7 Layout Module

If Variable is selected, select the Variable (of string data-type) which will return differing
paths to the file location when the workflow is processed.

Parameters Match flash variables to variables from the workflow.

Flash variables are common to flash animations, allowing some value (e.g. text or image)
to be changed without editing the flash file itself, e.g. in order to create and additional
element of personalization for different clients. Changing the value can be done via
parameters in the URL path (URL queries). If you know that your flash file employs flash
variables and you know their key strings, you can assign the corresponding parameters
here.

Key Enters the key string for the flash variable which should change value.

Value Selects the workflow variable that will return a value via the corresponding Key.

All variables found in the Data family are available for selection here.

Note

Flash type embedded objects are not supported if your are producing HTML files via
the Email Generation mode of the HTML engine, because most e-mail environments
will not allow flash to run within a mail.

If using Flash files produced by Inspire Designer and having the flash navigation panel
as an embedded object, it is necessary to copy the file with navigation panel (called by
default NavigationPanel.swf) to the location where the SWF file with the embed-
ded object is spooled.

Content Tab for HTML Objects

Options Descriptions

Code Selects whether the HTML describing the object will be determined by a variable.

If Simple is selected, enter the HTML that describes the object in the Value area, e.g. a
video from a video-hosting website.

Example Here is an HTML embedded object copied from its Embed box on YouTube:
<object>
<param name="movie" value="http://www.you
tube.com/v/k0-a17rxy2w?fs=1&amp;hl=en_US"></param>
<param name="allowFullScreen" value="true"></param>
<param name="allowscriptaccess" value="always"></param>

556
 7.6 Layout Objects

<embed src="http://www.you
tube.com/v/k0-a17rxy2w?fs=1&amp;hl=en_US" type="application/x-shock
wave-flash" allowscriptaccess="always" allowfull
screen="true" width="640" height="385"></embed>
</object>

If Variable is selected, select the variable which will return differing object codes (when
the workflow is processed) in the Variable combo-box.

Note

Size of the embedded object is determined by <embed> attributes width and

height (e.g. width="640" height="385"). So ensure that the Size set on
the Position tab is large enough to feature the whole size of the object.

HTML object types will not be displayed when producing SWF files via the SWF
engine.

7.6.14 External Objects

In this section:
External Object Dialog
Used Layouts Dialog
Logging of External Object Updates

Utilizing external objects in workflows allows you to keep the design of layout objects used in
many workflow files consistent without having to alter the object in each single workflow when
making a change is necessary (e.g. altering a text style used in many documents).

An external object is a layout object originally created in one workflow file (referred to as the
source file). This layout object is then inserted into and used in another workflow file or several
workflow files (referred to as the target workflow(s)). When using the same external object in
many target workflows it is quick to alter the object's appearance in all of its occurrences in
target workflows. To do so, simply modify the object in the source workflow. Any changes
made to an object in the source workflow will be applied to the target workflow(s) at the
moment when it is opened.

Note In the Workflow environment there is the option Update External Objects, which
can either be accessed from the Workflow menu or by clicking on the Update External Objects
icon available in the Standard toolbar. This option is selected by default. If it is deselected,
target workflows will not be updated when a source workflow from which external objects
are taken has been modified.

To avoid inconsistencies, parameters of external objects cannot be changed in target workflows.

All changes to external objects (content and parameters) can only be performed directly in the
source workflow.

557
7 Layout Module

7.6.14.1 External Object Dialog

To insert external objects into a currently opened workflow go to the Insert | Insert External
Object menu.

In the Open dialog that appears, browse for a source workflow file that contains the desired
object(s) that you would like to use as external objects in the currently opened workflow.

After selecting the source workflow file, the External Object dialog is shown displaying the
Layout Trees of the source and the target workflows as well as a table showing objects being
shared between the source and the target workflow:

Options Description

External Layout Tree Displays the source workflows complete Layout Tree.

Current Layout Tree Displays the target workflows complete Layout Tree. To add a new
object here, select a source object from the External Layout Tree area and drag and
drop it to the appropriate place in the Current Layout Tree area.

The mouse pointer indicates if it is possible to drop a source object in the Current Layout
Tree area at the selected position:

558
 7.6 Layout Objects

Where it is not possible to drop the selected source object the mouse pointer will appear
like this:

External node, New owner Objects added to the Current Layout Tree area are listed
here. This area displays the name and location of the object in the source workflow and
its new owner in the target workflow.

Delete Removes the external objects selected in the External node, New owner area.
You can also delete the object directly from the Layout Tree in the Layout window. Both
methods result in automatic unlink of selected external objects.

OK Closes the External Object dialog and adds the object(s) which were moved to the Current
Layout Tree area to the currently opened workflow as external objects. See the Working
with External Objects in the Target Workflow section for details on working with external
objects.

This button is active only after objects have been moved to the Current Layout Tree
area.

Cancel Cancels the performed operations and closes the dialog.

Working with External Objects in the Target Workflow

Working with external objects differs in some aspects from working with objects created directly
within a workflow. Thus, distinguishing external objects from "normal" objects created directly
in the target workflow is facilitated by color-coding within the Layout Tree.

The Layout Tree of your target workflow could look like the below screenshot after inserting
some external objects to it (in this case 'Chart 2' and 'Element 1' have been inserted). See the
text below the screenshot for details on the functionality of different types of external objects.

559
7 Layout Module

Legend

1. Data from source workflows After inserting any external object into a target
workflow, the whole Data structure of the source workflow file will also be visible in
the target workflow. Just like all other external objects, they are, by default, marked
in blue in the Layout Tree of the target workflow. The color of external objects in the
Layout Tree can be modified in the Layout Tree section of the Layout Options dialog.

Be aware that these variables will not return any values in the target workflow unless
you connect the same data file or a data file using the same names for variables to the
target workflow. In case no corresponding data file is connected to the target workflow,
the variables from the source workflow will be marked as 'disconnected' (represented
by the icon displayed before the variable in the Layout Tree, for more details see the
How to Work with Data and System Variables section).

Note It is not possible to directly move single variables or any group of variables via
drag and drop to the Current Layout Tree area in the External Object dialog. Rather,
the Data structure of a source workflow appears automatically in a target workflow as
a 'side-product' as soon as any other object of a workflow is moved there.

For further information on working with variables used as external objects, refer to the
Logging of External Object Updates section just below.

2. Position-defining external objects 'Chart 2' is, as can be seen by its color, also an
external object. The color of external objects can be modified in the Layout Tree section
of the Layout Options dialog.

Charts belong to the group of position-defining objects. Other position-defining objects

are objects such as images areas, flow areas, element areas etc. Objects of this type
do not have their own family nodes in the Layout Tree. They can only be found in the
Pages family when used in the Layout Area, in this case they are grouped under the
node of the page on which they were placed.

When using position-defining objects as external objects note that these objects are
placed to the same position on the page as in the source workflow and cannot be
moved. External objects of this kind are marked by a special color used for their
bounding-box when placed to the Layout Area. The color of the bounding-box can be
modified in the Colors section of the Layout Options dialog.

Tip If you want to use position-defining objects as external objects, but require that
their position can be altered in the target workflow, place the position-defining object
into an element in the source workflow and insert this element into the target workflow
instead of the position-defining object itself.

3. Links to external objects In the target workflow, the external object 'Element 1'
has been used in the Layout Area, which requires the usage of an element area (a po-
sition-defining object) to specify its position. As 'Element 1' is stored under the Elements
family, it is only represented by a link here (as are all content-defining objects grouped
under the Pages family). The color of links to external objects differs from the color of
links to 'normal' objects. These colors can be modified in the Layout Tree section of
the Layout Options dialog.

See the Layout Tree section for further details on links used in the Layout Tree.

4. Content- and style-defining external objects 'Element 1' is, as marked by its
color, also an external object. The color of external objects can be modified in the

560
 7.6 Layout Objects

Layout Tree section of the Layout Options dialog. It belongs to the group of content-
and style-defining objects.

Content-defining objects are objects such as flows, tables, elements, images, tables
etc. and style-defining objects are objects such as text styles, paragraph styles, fill styles
etc. These types of objects have their own family nodes in the Layout Tree. Additionally,
when content-defining objects are used in the Layout Area they can also be found in
the Pages family, grouped under the node of the page on which they were placed and
there under the node of the position-defining object they are placed in (see point 3
just above, where the content-defining object 'Element 1' is also available grouped
under the position-defining object is it used with when placed in the Layout Area).

Note When using external objects also be aware of the following facts:

As already mentioned, properties of external objects are 'read only' in the target
workflow. They can be redefined only in the source workflow.

To be able to redefine external objects even in target workflows, you can select the
Run in admin mode check-box available in the Global Layout Modules Options section
of the Layout Options dialog. However, running Inspire Designer in the admin mode is
considered as unsafe and is thus not recommended.

It is not possible to insert an external object from a workflow file that is currently opened
to another workflow file. Already existing external objects will be fine, but if you open
a target workflow and its source workflow is also opened, any changes made in the
source workflow will not be reflected in the target workflow, i.e. updating external
objects in target workflows is only possible if the according source workflow is not in
use.

It is not recommended to use cross-referenced external objects e.g. wf1.wfd links any
external object from the file wf2.wfd while file wf2.wfd links another external object
from wf1.wfd.

External objects can be nested. For example, a workflow containing an external object
may be used as an external object for a third workflow.

7.6.14.2 Used Layouts Dialog

This dialog provides an overview of all workflow files which are being used as sources for ex-
ternal objects by the currently opened WFD. Also, the total amount of external objects being
used from each source workflow is listed.

To open this dialog go to the Insert | Used External Objects menu. The Used Layouts dialog
is opened:

561
7 Layout Module

Options Description

External Layout Displays the path to and name of the source workflow file.

Count of Nodes Displays the number of external objects which have been inserted from the
according source WFD file. Use the Edit Properties button to find out for more details
about these external objects (the standard External Object dialog will be opened).

Close Closes the dialog.

Edit Opens the External Object dialog for the selected source workflow file where you
can see what kind of objects are being used and which allows you to add/delete external
objects from this Layout. See the External Objects Dialog section for more details.

Create new Displays the Open dialog where you can browse for a source workflow file
and after selecting it the External Object dialog is shown.

Delete Deletes all external objects taken from the selected source workflow.

7.6.14.3 Logging of External Object Updates

As described above, as soon as any layout object is inserted into a target workflow as an ex-
ternal object the data structure of the source workflow from which this inserted object comes
is also available in the target workflow (see the Working with External Objects in the Target
Workflow section). To be able to actively use the variables in the target workflow it is necessary
to connect an appropriate data file to this target workflow. After doing so, it is possible to access
the Conversion and Text Presentation tabs of the variables' layout properties and alter the
settings there.

But, be aware that any settings made on these tabs in the target workflow will only be applied
to the document if the Update External Objects option is deactivated. In case this option is not
deactivated, proofing, producing or saving the document will invoke the update external objects
action which will result in any settings made on the Conversion and Text Presentation tabs
being set back to the values set in the original source workflow.

It is possible to log changes of this kind (i.e. the setting back of values on the Conversion and
Text Presentation tabs according to settings used in the source workflow file) in a file called
updateExtObjects.log. This file is automatically created in the application directory when
the Enable external objects logging option available on the General Options panel of the
Layout and Workflow Options dialogs has been checked. This option is deselected by default.

562
 7.6 Layout Objects

7.6.15 Fill Styles

In this section:
Gradient Layout Properties

Fill styles are used to color other objects such as shapes, border styles and text styles.

To create a new fill style, right-click on the Fill Styles family in the Layout Tree and select Insert
Fill Style.

Alternatively, fill styles are created when adding fills to other objects (via combo boxes or
toolbars) using the fill style drop-down menu:

Legend

1. Colors Applies colors, that have not yet been created as colors in the layout, to the
selected object.

Selecting one of these creates a fill style and its parent color object.

2. Patterns Applies patterns that have not yet been created as images in the layout, to
the selected object.

Selecting one of these creates a fill style and its parent image object. Because the pattern
is an image you can change its color via the Palette tab of the image's Layout Properties.
You can also use the Pan tool to adjust the fill style pattern/image position.

Alternatively, if a colored pattern is required, first select a full color and then return to
the menu and select a pattern. It should be the same as that previous color.

3. Colors from Layout Applies colors, that have been already created as colors in the
layout, to the selected object.

563
7 Layout Module

Selecting one of these creates a fill style based on that color.

4. Fill styles and images from layout Applies fill styles and images, that have already
been created in the layout, to the selected object.

Selecting an image here creates a fill style based on that a image.

5. Custom Opens the Color dialog in order to create a new color in the layout.

Once the color is created the corresponding fill style will also be created and applied
to the selected object.

6. Blank No fill will be used.

7.6.15.1 Fill Style Layout Properties

Initially fill styles only have one combo-box, Type. Select from:

None The fill style is left undefined.

Color Reveals the Color combo-box where you can select any previously created color
to be the color of the fill style. Alternatively you can select Create new color to open
the Color dialog and define a new color.

Image Reveals the Image combo-box where you can select a previously inserted image
to be the fill style. Alternatively you can select Insert new image to open the Open dialog
and insert a new image into the layout.

There are further options here which are described below in Image Fill Style Properties.

Gradient Reveals properties for blending two or more colors as a gradient fill style.

These properties are described in the separate section Gradients.

Select by integer, Select by interval, Select by condition, Select by text, Select by inline
condition, Select by content Selects which fill style to use from the other fill styles in
the family using a variable.

See the separate section Types of Variable Selection for details on which further options
appear.

564
 7.6 Layout Objects

Image Fill Style Properties

Options Description

Offset X / Offset Y Determines the distance of the origin of the image from the origin of
the object.

Rotation Sets the angle that the image should be rotated.

Shear X Shears the image by the angle entered.

Shear (skew) is a distortion of the object that is performed by rotating the Y-plane of the
object. The X-plane of the object (where Y = 0) is left in its original position.

Units are degrees.

Example This is a rectangle that has been skewed to 45. The origin is the top-left
corner.

Scale Enlarges (or reduces) the size of the image both horizontally and vertically.

There are two edit boxes, the top one is for the X plane and the bottom for Y.

Units are ratio of original size, e.g. 1 is the original object size and setting of 1.25 = 125%.

Flip X / Flip Y Flips the image horizontally/vertically.

Flip axis is the axis of the origin.

Apply objects transformation If checked, any object transformations (e.g. shear, scale,
rotate done via its Position tab) will be also applied to the image used in the fill style.

565
7 Layout Module

Example An image is used as a fill style for a rotated rectangle shape.

Apply object transformation checked:

Apply object transformation unchecked:

The options Autofit and Tile image have been enabled in both above cases.

Autofit If checked, the image will be resized to fit the area of the object that the fill style is
being applied to.

Tile image If checked, the image will be repeated in both directions to fill the area of the
object that the fill style is being applied to.

7.6.16 Flows
7.6.16.1 Flows
In this section: See also:
External Language Flows and Texts
First Fitting Variable Formatted Flows
First Fitting Auto

Flows are passages of text. Within these passages of text it is possible to insert other objects
(e.g. variables, images, tables) even other flows.

566
 7.6 Layout Objects

Example A flow can consist of many nested objects including flows:

Notice in the screenshot how Flow 1 contains variables and other flows.

Flows are named automatically with a sequence number added. However, we encourage you
to rename each flow to help identification.

Flow Layout Properties

A flow has no tabs for its properties, the options that appear on the panel depend upon the
Type selected.

Options Description

Type Selects how the flow will be formatted, or which flow will be shown instead of this
one when the workflow is processed:

Simple Determines that the current flow will be used when the workflow is pro-
cessed, i.e. it is a static object.

Select by integer, Select by interval, Select by condition, Select by text, Select by

inline condition, Select by content, Select by language, Repeated Select which
flow will be used (from the flows in the Flows family) using a variable.

See the separate section Types of Variable Selection for details on which further
options appear if any of these types are selected.

External Imports a flow from an XML, RTF, HTML or another WFD file.

See the External section below for a description of the options that appear.

First fitting Tries a sequence of flows that have been defined, until one of those
flows is short enough to fit inside the flow area in which this flow has been placed.

567
7 Layout Module

The length of a flow can be affected by the text style applied and the number of
characters. See the First Fitting section below for a description of the options that
appear.

First fitting auto If this flow is too large for the flow area in which it has been
placed, its text style is adjusted (i.e. its font size is reduced) until its fits inside that
flow area.

See the First Fitting Auto section below for a description of the options that appear.

Variable formatted Controls the content and formatting of the flow via variables.

See the section Variable Formatted and Overflowable Variable Formatted Flows
for more information.

Overflowable variable formatted Selects a variable formatted flow that can

overflow.

The same rules apply as for variable formatted flows. See the section Variable
Formatted and Overflowable Variable Formatted Flows for more information.

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
You can use it to adjust the editing area to e.g. fit the size of the flow area and to see the
flow in the final layout. This setting does not influence the size of the flow area in the
Layout Area and Proof.

The default visible width is 200 mm.

Lock for Docx Enables to set the lock for editing the flow content in MS Word 2007 or later.
This setting is used when a WFD file is produced into DOCX file; the flow with this option
enabled can be edited in the Layout Area.

You have to select protecting the document when producing a DOCX file to have this
function take effect. The flow content will always be editable in the produced DOCX file
without selecting this option.

Three setting options are available:

Inherit Applies the same lock setting for MS Word as the parent uses. The flow
with this setting will be uneditable in MS Word only if the parent will have Locked
option set (see the description below).

Locked Locks the flow content for editing in MS Word. Modifying the text will
always be denied with no regard to the setting of the parent.

Editable Enables editing the flow content in MS Word. Modifying the text will
always be allowed with no regard to the setting of the parent.

After the DOCX file is produced, you can use standard MS Word features for working
with the locked text. In MS Word 2010, you can go to the Review tab, click on the Restrict
Editing menu and enable the Highlight the regions I can edit check-box in the Restrict
Formatting and Editing window. Only the editable text will be highlighted then. To
unlock all the protected areas, click on the Stop protection button at the bottom of the
window and enter the password you have set when producing the DOCX file. To lock the
previously locked areas again, click on the Yes, Start Enforcing Protection button in
the Restrict Formatting and Editing window.

568
 7.6 Layout Objects

External

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the flow content in the produced DOCX
file. This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Location Selects a variable of string data-type with the path to a WFD, XML, RTF or HTML
file, including the file name.

Alternatively, assign here a string variable with the XML syntax or HTML code as its value
which will define the external flow.

Any files described by a path are external and will not be included or listed as used files
in the Used Files dialog. The paths can be absolute (e.g. Z:\Resources\Images) or relative
to the workflow (e.g. Images\), however remember that the workflow may change location
and the file will not be read unless it is accessible via that path when the workflow is
processed.

Flow name If reading a XML of WFD file via Location, selects the variable that will return
the name of the particular flow you want to insert.

The value that is returned by the variable must match the name of the flow as it is named
in the external file. If there is no flow name and no default flow defined, the first flow of
the external file is used.

In the case of a RTF file, the whole document will always be used as the flow and this
combo-box can be left as Empty.

Font replacement Selects a font replacement (that has been previously created) if required.

If importing HTML content, the default font will be Times New Roman, 12pt. To change
it, create a new font replacement where the Name column is left empty, the font defined
in the Font column will be used as the default font for the HTML text. The other columns
of the font replacement will have no effect.

569
7 Layout Module

Note If a RTF file is processed and a font is missing (i.e. a font replacement is not defined),
a warning is issued specifying by which font the missing font has been replaced. You can
add the missing font before running production.

Default flow Selects a flow from the current Layout which will be displayed in case the
search for both the location and the name of the external workflow is not successful.

When a default flow is used, no warning is displayed in Proof or Production. If you however
require to be informed about this fact, you can place a calculated variable inside the default
flow which will return a warning (logWarning) when this flow is used.

Example

1. Create flows in a workflow and export them as an XML file (File | Export | XML).

This XML file can now be used as an external flow in another workflow.

2. In another workflow, create a flow where you would like to use the external flows:

In the Location field select a variable that contains the path to the exported
XML file and the file name. In our example, the variable XML can contain just
the file name as it is located in the same directory as Inspire Designer:

In the Flow name field select a variable that will determine what flow will
display. In our example, the variable VariableFlowSelection will display Flow1
for customer with CustomerId value 1, Flow2 for customer with value 2 etc.):

Alternatively, if you need variably formatted text to flow from page to page. In this case,
the exported XML file contains the formatting information that is used to create the
content of the external flow in another workflow.

Tip If using RTF or HTML files as external flows, you can define layout objects (e.g. variables
and images) to be inserted into the flow using placeholders (e.g. <<Clients.Account>>) in the
text of the file.

570
 7.6 Layout Objects

See the separate section Layout Objects from Imported Files.

Note If the selected external flow contains variables that have the same name as variables
in the current Layout and both sets of variables have had conversions applied (via the Conversion
tab of variables in Layout) then:

If they are different conversions, the conversion from the external variable is used.

If no conversion is set in the external flow, the conversion from the current Layout's
variable is used.

First Fitting

For more information see First Fitting Overview and How to Use First Fitting.

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables to set the lock for editing the flow content in the produced DOCX
file. This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

IDFF Group Defines the IDFF group to which the flow belongs.

Flow Defines the flows and the order of flows that will be tried for size, until one of them
fits into the flow area.

Tip You can use the evaluation statistics feature to see which flow was actually used.

Create New Creates a new row where a flow can be selected.

Delete Deletes the selected row.

Move Up / Move Down Moves the row up / down the order of flows to be tried.

Go To Goes to the flow in the Layout Tree.

571
7 Layout Module

First Fitting Auto

Note When making settings for scaling the flow contents horizontally and for resizing fonts,
these actions are performed after each other and not concurrently. See the How to Use First
Fitting Auto section for a closer explanation of combining these two methods.

Options Description

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables to set the lock for editing the flow content in the produced DOCX
file. This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

IDFF Group Defines the IDFF group to which the flow belongs.

Horizontal scale % Specifies the percentage value by which the content of the flow will be
horizontally scaled.

Horizontal scale iter. Specifies the maximum number of horizontal scale iterations. By default
the value in this edit-box is set to '0' which determines that no horizontal scaling will be
performed.

Use % value If checked, the proportional change defined in the % font descent is applied
to the font of the flow. If unchecked, the font size is decreased in absolute steps, whose
value is defined in the Point font decent edit-box.

% font descent Specifies the percentage value by which the font in the flow will be reduced
at each iteration.

Point font descent Specifies the absolute value by which the font size will be reduced at
each iteration.

Max. iter. count Specifies the maximum number of iterations that will be computed when
the system tries to find the appropriate change in the flow's size.

572
 7.6 Layout Objects

Entering the value '0' sets the number of possible iterations to unlimited. If '1' has been
set no iteration will be performed. Set the value '2' or higher to set an exact amount of
maximum iterations (the number of iterations will be: 'entered value - 1'). I.e. if you set
'7' for this option, 6 iterations of resizing the font will be performed.

Tip You can use the evaluation statistics feature to see the result of which iteration was
actually used.

Note When First fitting auto is selected for a flow, the size of the fonts within the flow is al-
ways rounded to the nearest half point value in Proof/Production (even in the case that no
resizing of the font is necessary), e.g. a font with the size 10.3 will be displayed with the size
10.5, a font with the size 9.1 will be displayed with the size 9.

However, when resizing of fonts is necessary, the values are computed using the original font
size values, e.g. if you are using a font with the size 10.3 and this font must be resized in order
for the flow to fit into a flow area and % font descent has been set to 10, then the new font
size used in the first iteration will be computed in the following way: 10.3*0.9 = 9.27; this
value would then again be rounded, thus the font will be displayed with the size 9.5 in this
case.

For more information see First Fitting Overview and an example of use.

7.6.16.2 Variable Formatted Flows

In this section: See also:
Comparison of Variable Formatted and Line Data Formatting field converter
Overflowable Variable Formatted Flows
Syntax
Commands Overview
Commands Reference
Examples of Variable Formatted Tagged
Data

Variable formatted flow has its content and formatting controlled by a variable.

The assigned variable will contain a combination of:

commands (similar to tags used in HTML or XML) and

the content (the text to be presented)

To use variable formatting:

1. Select the flow you want to control.

2. From the Flows Layout Properties, select Variable formatted or Overflowable variable
formatted as the flow type.

3. Assign a (string) variable to the flow that will control the formatting.

573
7 Layout Module

Comparison of Variable Formatted and Overflowable Variable

Formatted Flows
Variable formatted flow cannot flow from page to page; for that purpose you can select the
overflowable variable formatted flow.

It is recommended to use the overflowable variable formatted flow for relatively few combina-
tions of different flow contents because the whole flow content is kept in memory, which
means that:

for more complex flows you may run out of memory before the job is printed

on the other hand, it can be faster than Variable formatted flow in case of relatively
few combinations of flow contents

Both overflowable variable formatted and variable formatted flows have the following Layout
Properties window:

Options Description

Type Selected Variable Formatted.

Visible flow width Defines the width of the visible space of the flow in the Layout Area.
This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Lock for Docx Enables you to set the lock for editing the flow content in the produced DOCX
file. This option is general for all types of flows; see the detailed description in Flow Layout
Properties section.

Variable Allows you to select a variable controlling the content and formatting. In other
words, the variable delivers text enriched with formatting tags.

Inherit para/text styles If this option is not checked or the variable flow is the first flow in
flow area, Normal style is used.

If checked, the paragraph and text style can be inherited from the previous flow if there
is any. For more details see also Paragraph Styles section.

Syntax
The content and formatting of the flow is defined by a markup language similar to HTML or
XML. Commands (tags, markups) are enclosed in angle brackets (e.g. <b> for bold) and they
are intermixed with the text content.

574
 7.6 Layout Objects

Example Example: flow defined as

Hello <b>world</b>!

will be printed as

Hello world!

Note

Special characters, like angle brackets, have to be defined with special keywords:

&amp; for ampersand &

&lt; for left angle bracket <

&gt; for right angle bracket >

&apos; for apostrophe '

&quot; for double quotes "

Boolean parameters can have the following values: 0, 1, F, T, FALSE, TRUE,

N, Y, NO, YES. They are not case sensitive.

See Commands Overview for the list of available commands and the Commands Reference
section for a comprehensive description of commands and their parameters.

Commands Overview

Paragraphs

<p> Starts a new paragraph

Text styles

<t> Changes the active text style

<font> Changes the active font

<b> Applies bold face

<i> Applies italics

<u> Underlines the text

<s>, <strike> Uses strike-through

<sup> Uses superscript

<sub> Uses subscript

<smallcap> Uses small caps

575
7 Layout Module

Tables

<table> Creates a table

<row> Creates a row

<cell> Creates a cell

<headerfooter> Creates header and footer rowsets

<rowset> Creates a rowset

Other objects

<image> Inserts an image object

<flowobject> Inserts an element

<flow> Inserts another flow

<variable> Inserts a variable

<br> Inserts a line-break

Conditionals

<if> Conditionally selects the flow content

<else> Conditionally selects the flow content

<elseif> Conditionally selects the flow content

Example Using Conditional Flow

The following example explains the use of conditional flows:
<if inline="SYS.PageIndex==0">First condition
<elseif inline="SystemVariable.PageIndex==1">Second condition
<else>Third condition</if>common text

This is an example of using an inline condition. If the page index equals zero, "First con-
dition common text" will be printed. If the page index equals one, "Second condition
common text" will be printed. Otherwise "Third condition common text" will be printed.

Note A code cannot be written as follows:

<if inline="[condition]"><fontsize=10pt>
<else><font size=12pt><var DATA.Value>

because <var DATA.Value> must come after each <if> or <else> statement. Thus
the correct code is:
<if inline="[condition]"><fontsize=10pt><var DATA.Value>
<else><font size=12pt><var DATA.Value>

576
 7.6 Layout Objects

Commands Reference
<p>
This command starts a new paragraph and defines its properties. See also Paragraph Style
Layout Properties panel.

Example

You can use an existing paragraph style:

<p name=HeaderParaStyle>Hello world!

You can use an existing paragraph style and override some attributes:
<p name=MyStyle leftindent=10mm>Hello world!

You can override the previous paragraph style:

<p ignoreemptylines=true>Hello world!

Parameters

name (node name with a path)

The name of the paragraph style that will be used for this paragraph, e.g. MyParaStyle1
or ParaFamily1.Style2.

usedefaultts (bool)

To be used in combination with the name parameter. If set to YES, the default text style
of the paragraph style is used. Otherwise, the text style of the previous paragraph is kept.

alignment (keyword)

Text alignment (optional). The permitted values are left, right, center, justifyleft,
justifyright, justifycenter, justifyblock.

leftindent (double with unit specified)

Determines the space on the left side of the paragraph. This setting applies to all lines of
the paragraph.

rightindent (double with unit specified)

Determines the space on the right side of the paragraph. This setting applies to all lines
of the paragraph.

firstlineleftindent (double with unit specified)

Determines the space on the left side of the first line of the paragraph.

spacebeforeonfirst (bool)

577
7 Layout Module

Determines, if the value set in the spacebefore parameter will be applied when the
current paragraph is the first paragraph in a flow area. When set to the default setting
NO, the paragraph always starts at the top of the flow area regardless of the setting made
by the spacebefore parameter. When YES is set, the value set by the spacebefore
parameter is always applied.

Note When a paragraph overflows into a new flow area, this setting will also determine
the position of the first line of the paragraph in the new flow area.

spacebefore (double with unit specified)

Sets the vertical space before the paragraph.

spaceafter (double with unit specified)

Sets the vertical space after the paragraph.

linespacingtype (keyword)

Sets the space between the lines of the text. Permitted values are additional,
atleast, exact, multipleof.

linespacing (double with unit specified)

Specifies the value for line spacing (see the linespacingtype parameter above).

ignoreemptylines (bool)

Determines whether empty lines will be printed or not.

flowbreakbefore (keyword)

Sets the position of the paragraph to which it is applied. Permitted values are no,
flowarea, page, column.

flowbreakafter (keyword)

Sets the position of the following paragraph. Permitted values are no, flowarea,
page, column.

keeplinestogether (bool)

Determines whether a paragraph may overflow from one flow area to another.

keepwithnextparagraph (bool)

If set to YES, the last line of the paragraph will always be displayed in the same flow area
as the first line of the following paragraph.

donotwrap (bool)

Determines whether or not the text will be wrapped. If set to YES, text will not wrap when
reaching the border of the flow area in which it is contained.

border (node with path)

578
 7.6 Layout Objects

The name of the border style to be used for this paragraph, e.g. MyBorderStyle or
BorderFamily1.Style4

connectborders (bool)

Determines whether borders will be connected.

borderwithlinegap (bool)

Determines if a space between lines (line gap) will be used.

defaulttab (double with unit specified)

Sets the default distance between tabs.

hyphenate (bool)

Sets whether hyphenation within the text of the paragraph will or will not be permitted.

hyphminleft (int)

Sets the minimum number of characters that will remain before the hyphen.

hyphminright (int)

Sets the minimum number of characters you want to carry over to a new line after the
hyphen.

hyphmaxconsecutive (int)

Defines the maximum number of consecutively following lines ending with hyphens.

<t>
This command applies a text style on the text content. See also Text Style Layout Properties
panel.

Example

You can use an existing text style:

<t name=HeaderTextStyle>Hello world!

You can use an existing text style and override some attributes:
<t name=MyStyle fontsize=14>Hello world!

You can override the previous text style:

<t fill=RedFill>Hello world!

579
7 Layout Module

Parameters

name (node name with a path)

The name of the text style that will be used, e.g. MyTextStyle or MyTextFam
ily.Style2.

fontname (node with path)

Name of the font you wish to use.

fontlocation (location)

Location of the font file.

afpcodec (string)

Name of the codec for the AFP font.

afpcodepage (location)

Location of an AFP code page for the AFP font.

fontsize (double with unit)

The size of the font you wish to use, e.g. 12.0pt.

color (RGB)

The fill color for glyphs.

bold (bool)

If set to YES, the text will be bold.

italic (bool)

If set to YES, the text will be italicized.

underline (bool)

If set to YES, the text will be underlined.

strikethrough (bool)

If set to YES, the text will be struck through.

baselineshift (double with unit)

Determines the space between the characters and the baseline.

intercharspacing (double with unit)

Determines the space between individual characters.

kerning (bool)

If set to YES, kerning is applied to the text style.

580
 7.6 Layout Objects

language (string)

Determines the alphabet/characters that will be used in the document. This needs to be
set in order to hyphenate the text.

border (node with path)

The name of the border style that will be used for the text, e.g. MyBorderStyle or
BorderFamily1.Style4

connectborders (bool)

Determines whether the borders will be connected.

borderwithlinegap (bool)

Determines whether the border will be extended slightly below the text.

fill (node with path)

The name of the fill style that will be used for the text, e.g. MyFillStyle or MyFill
Family.Style2

outline (node with path)

The name of the fill style that will be used for outlines of this text, e.g. MyFillStyle or
MyFillFamily.Style2

outlinewidth (double with unit)

Determines the width of the outline of the text, if the fill color is different from the outline
color.

miter (double)

Controls the effect of the Join setting when the Mitter outline join is selected.

cap (keyword)

Controls the corners of the outline when two line segments intersect. Permitted values
are butt, round, square.

join (keyword)

Controls the shape of the intersection points of the outline. Permitted values are mit
ter, round, bevel.

superScript (bool)

If set to YES, the text will be written as superscript.

subScript (bool)

If set to YES, the text will be written as subscript.

smallCap (bool)

581
7 Layout Module

If set to YES, the text will be written in small caps. Small caps means that lowercase letters
are capitalized, but are slightly smaller than uppercase letters.

superScriptOffset (percent)

Sets the superscript offset from the baseline.

subScriptOffset (percent)

Sets the subscript offset from the baseline.

superSubScriptSize (percent)

Sets the size of superscript/subscript.

affectSuperSubScriptUnderline (bool)

If set to YES, superscript/subscript will be underlined independently from the remaining

text (discontinuous underline). If set to NO, superscript/subscript will be will be underlined
as if it was a normal text (continuous underline).

affectSuperSubScriptStrikethrough (bool)

If set to YES, superscript/subscript will be struck through independently from the remaining
text (discontinuous underline). If set to NO, superscript/subscript will be will be struck
through as if it was a normal text (continuous underline).

smallCapSize (percent)

Sets the small cap size.

underlineOffset (percent)

Sets the underline offset from the baseline.

underlineWidth (percent)

Sets the underline width.

strikethroughOffset (percent)

Sets the strikethrough offset from the baseline.

strikethroughWidth (percent)

Sets the strikethrough width.

urltarget (string)

Sets an URL link, which will be active in the output files in PDF, TNO, HTML, and HTML
Simple format.

Note For HTML and HTML Simple outputs the URL link has to contain the http:// prefix,
otherwise the link may not work.

582
 7.6 Layout Objects

<font>
This command controls which font will be used for the text content. It overrides font settings
from the active text style.

Example
Normal and <font name=Arial>Arial</font>.
<font fontlocation=font.240 afpcodepage=d:\\fonts\font240cp afpco
dec="UTF-8">AFP font 240

Parameters

name (node name with a path)

The name of the font that will be used, e.g. Arial or MyFonts.BoldFont.

fontlocation (location)

Location of the font file.

afpcodec (string)

Name of the codec for the AFP font.

afpcodepage (location)

Location of an AFP code page for the AFP font.

size (double with unit)

The size of the font you wish to use, e.g. 12.0pt.

color (RGB)

The fill color for glyphs.

<b>
This command overrides the active text style and turns on the Bold option.

Example
Normal and <b>bold</b>.

<i>
This command overrides the active text style and turns on the Italic option.

<u>
This command overrides the active text style and turns on the Underline option.

583
7 Layout Module

<s>, <strike>
These commands overrides the active text style and turns on the Strikethrough option.

<sup>
This command overrides the active text style and turns on the Superscript option.

<sub>
This command overrides the active text style and turns on the Subscript option.

<smallcap>
This command overrides the active text style and turns on the Smallcap option.

<if>
This command begins a conditional block, defines the condition and also the content, which
will be used, if the condition is true.

Example
<if inline="SYS.PageIndex==0">Title Page</if>

Parameters

cond (node with path)

Name of the boolean variable which will be evaluated as the condition, e.g. SYS.Over
flow

inline (string)

String with a script that evaluates to boolean condition, e.g. SYS.PageIndex==0.

base (node with path)

Base context which will be used for evaluating inline condition.

flow (node with path)

Defines a flow, the content of which will be inserted into the active flow, if the condition
is true.

Example
<if inline="SYS.PageIndex==0" flow="TitlePageFlow">

584
 7.6 Layout Objects

<else>
This command contains a conditional block and defines the content, which will be used, if the
condition was not true.

Example
<else>Print something else.

Parameters

flow (node with path)

Defines a flow, the content of which will be inserted into the active flow.

Example
<else flow="PageFlow">

<elseif>
This command is a shortcut for <else><if>.

Example
<elseif inline="SYS.PageIndex==1">The Second Page</if>

Parameters

cond (node with path)

Name of the boolean variable which will be evaluated as the condition, e.g. SYS.Over
flow

inline (string)

String with a script that evaluates to boolean condition, e.g. SYS.PageIndex==0.

flow (node with path)

Defines a flow, the content of which will be inserted into the active flow, if the condition
is true.

Example
<elseif inline="SYS.PageIndex==1" flow="SecondPageFlow">

585
7 Layout Module

<table>
This command inserts a table into the flow. See also Tables Layout Properties.

Example

You can use an existing table:

<table name=Table1>

You can create a new table:

<table><row name=RowSet1><row name=RowSet2>

Parameters

name (node with path)

Name of an existing table that will be included.

border (node with path)

Name of the specific border style that you want to apply on the selected table.

alignment (keyword)

Selects the horizontal alignment of the table within the flow area where it is inserted.
Permitted values are left, right, center.

Note The effect of this setting is only visible when you set percentwidth to a value
below 100%.

percentwidth (double)

The relationship between the width of the table and the width of the flow area in which
it is inserted.

minwidth (double with unit)

Sets the minimum width of the table. This will override the percent width, if there is a
conflict.

horizontalspacing (double with unit)

Sets the spacing between columns.

verticalspacing (double with unit)

Sets the spacing between rows.

spaceleft (double with unit)

Sets the minimum space between the table and the left border of the flow area.

spacetop (double with unit)

586
 7.6 Layout Objects

Sets the minimum space between the table and the top border of the flow area.

spaceright (double with unit)

Sets the minimum space between the table and the right border of the flow area.

spacebottom (double with unit)

Sets the minimum space between the table and the bottom border of the flow area.

percentcolumnwidths (list of doubles)

Sets the size ratio of the columns in the table. When a table is created, all columns have
the same width, so the values will always be the same for each column. Default settings
are calculated in the following way: 1 is divided by the number of columns.

Example
<table percentcolumnwidths="0.4,0.2,0.4">

mincolumnwidths (list of doubles with units)

Sets the minimum widths of the columns. These will override the percent widths if there
is a conflict. The default setting is 1mm.

Example
<table mincolumnwidths="10mm,2.0cm">

<row>
This command inserts a row into the table. See also Row Set Layout Properties Orphan/Widow
Tab.

Example

You can use an existing row:

<row name=Row1>

You can create a new row:

<row><cell name=RowSet1.Cell1><cell name=RowSet1.Cell2>

Parameters

name (node with path)

Name of an existing row that will be included.

keepwithprevious (node with path)

587
7 Layout Module

Name of the variable which controls whether the row set is kept with the previous one,
i.e. these row sets are not separated.

keepwithnext (node with path)

Name of the variable which controls whether the row set is kept with the following one,
i.e. these row sets are not separated.

breakbefore (node with path)

Name of the variable which controls whether the table is broken (i.e. continues in the next
flow area) before the selected row set.

breakafter (node with path)

Name of the variable which controls whether the table is broken (i.e. continues in the next
flow area) after the selected row set.

<cell>
This command inserts a cell into the row. See also Cells.

Example

You can use an existing cell:

<cell name=Row1>

You can create a new cell:

<cell alignment=center>new cell

Parameters

name (node with path)

Name of an existing cell that will be included.

border (node with path)

Name of the specific border style that you want to apply to the cell.

alignment (keyword)

Selects the vertical alignment of the cell content. Permitted values are top, bottom,
center.

minwidth (double with unit)

Sets the minimum width of the cell. This will override the percent width if there is a conflict.

fixedheight (double with unit)

Forces a constant height for the cell. Use this option to increase the speed of table pro-
cessing.

588
 7.6 Layout Objects

minheight (double with unit)

Sets the minimum height of the cell.

maxheight (double with unit)

Sets the maximum height of the cell.

spanleft (bool)

Select this option to merge this cell with the cell to the left.

spanup (bool)

Select this option to merge this cell with the cell above.

alwaysprocess (bool)

Allows you to determine whether or not will the cell be formatted for wrapping text. If
the text in the cell will not wrap, it is recommended to leave the default setting NO for
optimal production speed.

flowtonextpage (bool)

When set, the content of the cell will be allowed to overflow to another flow area.

<headerfooter>
This command allows you to create complex tables with header and footer rows.

Example
<table>
<headerfooter><rowset type=header><row><cell>header
<rowset type=body><row><cell>body

<rowset>
This command allows you to create a set of rows (e.g. header or footer).

Example
<table>
<headerfooter><rowset type=header><row><cell>header
<rowset type=body><row><cell>body

Parameters

type (keyword)

Sets the type of the rowset; permitted values are header, firstheader, conthead
er, body, contfooter, lastfooter, footer.

589
7 Layout Module

<image>
This command inserts an image into the flow.

Example

You can use an existing image:

<image name=Image1>

You can create a new image:

<image path="c:/image.png">

Parameters

name (node with path)

Name of an existing image that will be included.

path (string)

Path and filename of the image to include.

pageIndex (int)

Selects the page of the image that you want to be shown. This is intended for multi page
images, such as PDF documents.

colortype (keyword)

Permitted values: blackandwhite, grayscale, rgb, cmyk.

dpi (double or a pair of doubles)

Sets the image resolution, e.g. dpi=300 or dpi=600,300

size (double or a pair of doubles with unit)

Sets the size of the image, e.g. size="10cm,5cm" or size="0.1m".

native (Boolean)

Enables native loading if set to true, e.g. <image path=ImagePath native=true>.

variable (node with path)

Sets a variable that controls the variable image, e.g. variable=Customers.Value.Id.

Tip If loaded natively, you can use an image file with its own variables, in the same way
as if the Use dynamic variables option of the Image Layout Properties panel was applied.
This feature may be of use, e.g. if you insert a PDF file containing variables.

To do so, use the following script: <image variable=ImageName dynamic=true>,

where the ImageName variable contains the path to the image file.

590
 7.6 Layout Objects

<flowobject>
This command inserts an element into the flow.

Example
<flowobject name="Element1">

Parameters

name (node with path)

Name of an element that will be included, e.g. Element1 or MyElemFamily.Pictur

eElement.

<flow>
This command inserts a flow into the current flow.

Example
<flow name="Flow1">

Parameters

name (node with path)

Name of a flow that will be included, e.g. Flow1 or MyFlowFamily.BottomLineFlow.

location (string)

Path to the flow to include.

Example
<flow name="Flow1" location="c:/workflow1.wfd">

<variable>
This command inserts the content of a variable into the flow.

Example
Hello <var name="Customers.Value.Title"> <var name="Customers.Value.Sur
name>"!

<br>
This command inserts a line break into the flow.

591
7 Layout Module

Example
Line1<br>Line2

Examples of Variable Formatted Tagged Data

Simple text

This is a variable formatted flow.

Returns the result:

This is a variable formatted flow.

Bold, italic, underline

This is normal. <b>This is bold <i>This is bold

italic</b> This is italic. <u>This is underlined italic.

Returns the result:

Color changes

This is black. <font color=#FF0000>This is red. <font color=#0000FF>This

is blue.

Returns the result:

Font changes

This is normal. <font name=Impact size=12>This is Impact font, size 12

Returns the result:

Paragraph styles

This is first paragraph style.

<p>This is second paragraph style.
<p name=MyParaStyle>This is third existing paragraph style.

592
 7.6 Layout Objects

<p firstlineleftindent=10mm>This is the fourth paragraph with first

line left indent.

Returns the result:

Text style

This is normal.
<t fill=RedFill border=BlueBorderStyle>This is another text style.
<t name=MyTextStyle>This is an existing text style

Returns the result:

Table

<table><row><cell>aaa<cell>bbb<row><cell>ccc<cell>ddd

Returns the result:

Table

<table>
<row> <cell border=TableBorder>aaa<cell border=TableBorder>bbb
<row> <cell border=TableBorder>
<table>
<row><cell>xxx<cell>yyy
<row><cell>zzz
</table>
<cell border=TableBorder>ddd

Returns the result:

593
7 Layout Module

Variable formatted flow

We invite you, as one of our most honored customers,

dear <b> <var name=Records.Value.ADDRESS> <var name=Records.Value.FIRST
NAME>
<var name=Records.Value.NAME></b>, to join us on a special event in the
Swiss Mountains,
<b> free of any cost for you.</b> This will become an unforgettable....

Returns the result:

We invite you, as one of our most honored customers, dear Mr. David Smith, to join us
on a special event in the Swiss Mountains, free of any cost for you. This will become
an unforgettable...

Conditional flow

<if cond=SystemVariable.True>This text will be printed

<else>non printable text.

Returns the result (if the condition "True" is met ):

This text will be printed

Conditional flow

<if inline="SYS.PageIndex==0">First condition

<elseif inline="SystemVariable.PageIndex==1">Second condition
<else>Third condition</if> common text

Returns the result (if the condition "PageIndex equals 0" is met ):

First condition common text

Special characters

This is &lt;inside greater than, less than signs&gt; and <b>it works</b>
like this.

Returns the result:

This is <inside greater than, less than signs> and it works like this.

7.6.16.3 Language Flows and Texts

See also:
Flows
Template Merger Module

Language flows and Language texts are for creating versions documents or electronic messages
in different languages, allowing for switches to be made between prepared translations of a

594
 7.6 Layout Objects

document's content. The language that is to be used can be determined by any variable that
is suitable for this purpose, e.g. a country code from an address that is read from an input data
file.

Example The below screenshot represents a new flow area which comprises Flow 1
with some text content.

After converting the flow to a language flow, the user added two new languages included
it the data file - FR for French and ES for Spanish. Flow 1 which is selected by language
now contains three simple flows: Flow 1_ for Default language, Flow 1FR for language
FR (will be displayed if the Language variable returns value FR) and Flow 1ES for language
ES (will be displayed if the Language variable returns value ES).

To create language flows or language texts (for texts replace the word 'flow' with 'text'):

1. Relate an existing variable to the language functionality.

A variable must exist that will return a different value when, and only when, the lan-
guage is required to be different, e.g. a field in the input data file that indicates the
language of each record.

Go to the Data family node and select that variable in the Language option to ensure
that values for the system variable 'Language' are provided.

One reason that the variable is assigned to a system variable, is so that it is always ref-
erenced by the same name ('Language') and is not subject to any modifications caused
by side effects, allowing it to also be used safely in advanced operations like scripting.

The values of the variable are evaluated once for each record, not for each flow.

2. Convert the flows for which you have multilingual content to 'language flows'.

This can be performed by selecting the menu option: Format | Change All Flows into
Language Flows or Format | Change Current Flow into Language Flow. The flow
type changes automatically from simple to Select by language, it is now accompanied

595
7 Layout Module

by a new icon in the Layout Tree and a new flow (of simple type) is created inside
it. This flow is the Default flow, representing the default Language.

3. Add the different languages.

Select the menu option: Format | Add Language. In the Add Language dialog that
appears, enter a name or code of the language you wish to add. This code must match
the language defining value coming from the variable.

If you check the Copy content from default option, the content of the language
flows assigned to the Default language will be copied to the added language flows. If
you leave it unchecked, the flow will be empty.

After you click on OK, the addition of the new language to all language flows will be
confirmed. In each language flow, a new flow (of simple type) belonging to this lan-
guage will be created.

The language flow now contains a flow for the Default language and flows for each
of the languages you have added.

4. Add the different language content to each of the created flows.

If required, you can remove any added language by means of the Remove language option
in the Format menu. The corresponding simple flows will be removed as well.

If you want to display flows belonging to a specific language, go to menu Format | Select
Language and choose the desired language in the Languages dialog that opens. You can also
switch among languages in the selected flow in its Layout Properties panel by clicking on them.

Exporting Language Flows

For the purpose of translation it is also possible to export language flows to XML format. Go
to menu: Format | Export All Language Flows or Format | Export Current Language Flow
option if you need to export just one flow.

The exported XML document contains all flows with translatable content (i.e. all language
flows) assigned to the selected language or languages. The root element of the document is
called Translation. Each language flow is represented by an element called Flow, its attrib-
ute contains the name of the flow as it is displayed in the Layout Tree. The Flow element in-
cludes a Language element with the text for translation for each exported language. The at-
tribute of the Language element defines to which language the element belongs.

Apart from the actual text for translation the Language element contains also paragraph and
text style specifications and may also include objects. It is crucial that this part of the element
retains correct form (i.e. dividing characters, valid style specification names) during editing your
XML document, otherwise it would return an error when importing the flows back to Inspire De-
signer.

596
 7.6 Layout Objects

Example Shown below is an export to an XML file with all translatable flows. There is
only one language flow (Flow 1) with three language versions (ES and FR, the last element
has no language name and it represents the Default language). The translatable text is
inside the Language element, the text that comes before the character | is paragraph
and text style specification. While objects inserted in flows (Image01) have their full path
from root displayed, text and paragraph styles paths are only relative to the TextStyles
and ParagraphStyles nodes. Then follows the actual text for translation.

<Translation>
<Flow name="Flow 1">
<Language name="ES">\PGroup 1/ParagraphStyle 2\TTextStyle 1\|Text to
be translated.
\P\OImages/Group 1/Image01\|</Language>

<Language name="FR">\PParagraphStyle 1\TTextStyle 1\|Text to be trans

lated.
\P\OImages/Group 1/Image01\P\P\|</Language>

<Language>\PNormal\TNormal\|Text to be translated.
\P\OImages/Group 1/Image01\|</Language>

</Flow>
</Translation>

An application for easy translation and editing of XML documents exported from Inspire De-
signer is available. See the section Flow Translator for details.

Importing Language Flows

Once the content has been translated it can be easily imported back to Inspire Designer. Go
to menu Format | Import Language Flows. In the Open dialog, that opens, browse for the
file you want to import. In the Languages Dialog that then follows, choose the language or
languages to be imported. Each language which is not yet present in the layout is added and
new flows are automatically created.

If invalid language flows (i.e. having properties incompatible with the Layout to which they are
imported - like, for example, flow or text style names not present in the Layout) are detected
during import, they are ignored (i.e. not imported into Layout) and listed in the Import Error
dialog that pops up after the import has been finished.

597
7 Layout Module

7.6.16.4 Overflow Management

In this section: See also:
Overflow Between Flow Areas Flows
Overflow Between Pages Flow Areas
Auto Page Flowing Setup

When creating your layout, you create flow areas of a defined size, which contain flows as
their content. Into flow areas, more specifically into the flows, you can add text, tables, images
and other objects. If the flow is too big for the flow area, it will be indicated by the vertical
or horizontal overflow icons, or in other cases, e.g. when data is coming from a data input,
you may find out about the overflow in Proof reading the warning that the content of a flow
is too big to fit a flow area. Then you can either enlarge the flow area, or you can manage the
overflow by setting another flow area to receive the content of the flow.

The overflow can be managed either just between flow areas within one page, or even between
pages (flow areas that are placed on different pages or a page to be shown repeatedly to display
the whole content of the flow).

To manage the overflow, you can use either the Flow Order tool or a set of options in the
Layout Properties of the flow area (and page), or in the case of a simple overflow between
pages, also the Auto Page Flowing Setup.

Note If you receive a warning like this in Proof: Content of Flows.Flow1 is too big
(Flow:Flows.Flow1[163]). (Layout), the number in the bracket, i.e. [163], specifies the position
of cursor in the particular flow where the issue occurs. Each character, variable, element, image,
nested flow or table is counted as one position.

Overflow Between Flow Areas

This section handles the case when flow order is set between flow areas within one page. If
you want to set the flow order between multiple pages, see the section Overflow Between
Pages.

If the content of a flow is too big to fit into the flow area, you can create another flow area
and manage overflow by passing the content into it. There are two ways to set it:

using the Flow Order tool from Layout Toolbar or

using a set of options in the flow area Layout Properties Content tab.

See the examples below for a description of these two methods.

Example Managing Overflow Between Flow Areas Using Flow Order Tool
To demonstrate the simplest overflow case, there has been a flow area created in the
Layout module, in which the flow has been set to be repeated by the Numbers array
coming from Data Generator module (e.g. generating numbers 1-20) and the Number
variable has been added into the flow. See also the example section Repeating a Flow by
an Integer Variable.

598
 7.6 Layout Objects

If you proof your workflow set this way, you will receive a warning that the content of
the flow is too big to fit into the flow area. To display more numbers and so manage the
overflow, do the following:

1. Create an empty flow area.

2. Select the Flow Order tool in the Layout toolbar. The cursor will change and
look as follows .

3. Click on the flow area where the flow starts, i.e. the flow area with the Number
variable displayed.

4. If you hover the mouse over the second flow area the cursor will change again
and show that the flow order can be set (that the two flow areas can be linked):
. Click on the newly created flow area where the flow with numbers should
continue. A blue arrow indicating the flow order is created in Layout (and is visible
when the Flow Order tool is selected). Proof displays all 20 numbers in two flow
areas:

The color of the arrow can be changed in the Layout Options dialog.

Example Managing Overflow Between Flow Areas Using Flow Area Layout
Properties
Having the sample workflow from the previous example, the aim is again to pass the
overflowing content into a new flow area, this time without usage of the Flow Order tool,
but setting certain options in flow area Layout Properties Content tab.

1. After creating a new flow area the Layout Tree structure will look like this:

FlowArea 1 contains the repeated flow with the Number variable from the Data
Generator (Flow 1), FlowArea 2 contains an empty Flow 2.

2. In the flow area Layout Properties on the Content tab the Previous, Content
and Next fields reflect the flow order that you can set with the help of the Flow

599
7 Layout Module

Order tool, i.e. the values in these fields correspond with the blue arrows indicating
the flow order in Layout.

For FlowArea 1 set the Next field to contain FlowArea 2. This way the overflowing
content will be displayed in it:

3. If you check the Content tab of FlowArea 2 now (or check the Layout Tree struc-
ture), you will see that the content of FlowArea 2 is now also Flow 1.

If you select the Flow Order tool, you will see the blue arrow the same way as in
the example above, which proves that the Flow Order tool and the Content tab
settings are linked. You can also select the option Show Flow Order Arrows
Permanently from the Layout View menu to see the arrow also when other tools
are selected.

Note

Selecting Empty for Previous or Next fields would cancel the flow order you have
set up.

Do not forget to select the content for the unlinked flow area, as by default the
flow with the overflowing flow will be used.

For example, if you set Next back to Empty for FlowArea 1 in this example, the
content for FlowArea 2 will remain Flow 1 (same as for FlowArea 1), but you may
prefer to set it back to the original Flow 2 with which it has been created.

Note If the next flow area is too small for the word overflowing from the previous flow area,
it will display like this in Layout (blue arrows indicate how overflowing has been set):

It could be expected that the second word (long) would overflow to the last flow area, but
because a flow area must contain at least one word when overflowing (i.e. it cannot stay

600
 7.6 Layout Objects

empty), the second word will be printed in the second flow area and a warning about horizontal
overflow will be shown.

Overflow Between Pages

If a content of a flow is too big to fit into a flow area and you do not want to create another
flow area on the same page, there are the following two possibilities of overflow management
between pages:

1. Flow order set up between two flow areas that are on two different pages The pro-
cedure is similar to managing overflow between two flow areas on one page, again
the Flow Order tool or a set of flow area options can be used.

2. One flow area on one page that is repeated to display the whole content of the flow
In a simple case a Layout feature called Auto Page Flowing Setup can be used, other-
wise multiple flow area and page related options must be set.

See the examples below for a description of these two cases.

Example Managing Overflow Between Flow Areas on Two Different Pages

Having the same sample workflow as in Managing Overflow Between Flow Areas examples
with one page and a flow area with overflowing content on it, it is desired this time that
the content should be passed to a flow area located on another page.

To set it using the Flow Order tool, follow these steps:

1. Add a new page and create a new flow area on it.

2. Select the Flow Order tool in the toolbar.

3. On Page 1 click on the flow area where the flow starts, i.e. the flow area with the
Number variable displayed.

4. Go to Page 2 and click on the newly created flow area. A pink arrow indicating
the created flow order is shown (on Page 2 as well as Page 1). Proof will display
the first e.g. 10 numbers on the first page, the rest on the second page.

The color of the arrow can be changed in the Layout Options dialog.

Note If you want to display just the two pages with 10 numbers each, set the option
Records by in Data family in the Layout Tree to Empty.

601
7 Layout Module

To set the same functionality without the Flow Order tool, using just the Layout Properties
of the flow area, follow these steps:

1. Add a new page and create a new flow area on it. The Layout Tree structure will
look like this:

FlowArea 1 on Page 1 contains the repeated flow with the Number variable from
the Data Generator (Flow 1), FlowArea 2 on Page 2 contains an empty Flow 2.

2. Go to the Layout Properties of FlowArea 1 and select Content tab. Check the
Flowing to next page check-box here.

3. Go to Page 2 and to the Layout Properties of the newly created FlowArea 2. Check
the Flowing to next page check-box also here and select Flow 1 in the Content
drop-down menu.

4. If you select the Flow Order tool, you will see the pink arrow the same way as
described above, which proves that the Flow Order tool and the Content tab set-
tings are linked. You can also select the option Show Flow Order Arrows Per-
manently from the Layout View menu to see the arrow also when other tools
are selected.

Example Managing Overflow Between Pages

If the content of a flow does not fit the flow area on a page, the overflow can be managed
by repeating the page to display the whole content of the flow.

In the simplest case of just one page and one flow area it can be handled automatically
by the option Auto Page Flowing Setup from the Layout Page menu.

602
 7.6 Layout Objects

However, the most typical case would be to print the flow content (e.g. phone calls) in
one flow area on the first page (e.g. of a phone bill) where the name and address could
be placed as well and then print the rest of the content on the second page, which would
be repeated as many times as needed for all the data to be printed.

To set flow order between pages, follow these steps:

1. In the Pages family, General tab, set the Page order field to Variable selection.
Set Start page to the first page, e.g. Page 1.

2. In the Layout Properties of Page 1 a new tab Next Page is added. Make the follow-
ing settings on this tab:

Set Type to Select by condition.

Create a new condition line by clicking on the Create New icon and set
it in the following way: If the system variable Overflow returns true, i.e. the
content of the flow is bigger than the flow area and overflow needs to be
managed, Page 2 will be displayed.

3. Check the option Flowing to next page in the flow area Layout Properties on
the Content tab, or alternatively double-click on the flow area with the Flow Order
tool selected and the pink arrow will appear.

4. In the Layout Properties of Page 2 go to the tab Next Page and make the following
settings on this tab:

Set Type to Select by condition.

Create a new condition line by clicking on the Create New icon and set
it in the following way: If the system variable Overflow returns true, Page 2
will be displayed again.

Check the option Flowing to next page also for the flow area on Page 2,
or alternatively double-click on the flow area with the Flow Order tool selected
and the pink arrow will appear.

603
7 Layout Module

7.6.17 Flow Areas

In this section: See also:
Creating a Flow Area Flows
Flow Area Layout Properties Panel Overflow Management
Anchors

Flow Areas are areas of a defined size within Layout, that are specifically intended to contain
text flows and objects related to that flow. In flow areas, you can add text, create tables, anchor
images, and then connect it to other flow areas so that, if the written content is too big for
one flow area, it will overflow to another.

Example Imagine a newspaper where on the front page you have seven different
stories, each with differing pictures and graphs. Each story is designated an area of just
a few columns on the first page and so not all of a story fits onto the front page and must
continue to other pages. We decide that story A will continue on page 2.

In the Layout Area you can design your front page with seven accurately sized flow areas,
one for each story including FlowArea6 for story A, and then create a page 2 with more
flow areas, one of which (FlowArea21) that you want to contain the rest of story A.

We can now simply link the two specific flow areas (FlowArea6 and FlowArea21) using
the Flow Order Tool and when we add the story to FlowArea 6, it will not matter how
much of it fits on the front page because anything that does not fit there will be overflowed
to FlowArea21 on page 2.

7.6.17.1 Creating a Flow Area

1. Click on the Flow Area Tool icon.

This makes your mouse pointer the flow area tool.

2. Click within the Layout Area, where you want to place your text, and hold down the
left mouse button and drag the mouse to create a box.

604
 7.6 Layout Objects

This box is a flow area and has a FlowArea node, under the node of the place (e.g.
page) where you have created it, in the Layout Tree.

3. The new flow area is highlighted (by default in pink) to show that it is selected.

A cursor will be flashing in the position where text is to be entered. The position of the
cursor depends on the paragraph style selected, but in the screen shot here it can be
seen in the top left of the flow area.

Simply type to enter text.

When you enter text you are actually editing a Flow that has been created within the
flow area. Each flow, like all objects, has its own node. See the separate section Flows
for more details.

Treating flows as separate objects becomes very useful if it is needed to swap the text
of a placed flow area with another quickly or even conditionally in accordance with a
variable.

Tip Flows and other objects (images, etc.) can also be entered directly into a flow
area, by dragging and dropping to the cursor position, but remember that there are
more flexible methods for manipulating such content, e.g. anchors, elements and image
areas.

4. The flow area will remain selected until you select another item in the Layout Tree or
Layout Area, or activate a tool (from the Tools toolbar) that creates a new object in the
Layout Area.

The navigation panel at the bottom of the Layout Window shows, in its first field, the
estimated amount of characters left till the end of the line and the number of lines left

605
7 Layout Module

in the flow area (counted from the cursor's position). That estimation is based on the
width of characters specified in the Layout View section of the Layout Options dialog.

To quickly select required elements of a flow area, it is possible to use multi-clicks:

double-click selects the current word,

triple-click selects the current line,

quadruple-click selects the content of the whole flow area.

See also Tips and Tricks.

You can also use the Selection Tool to click on the flow area to modify the size of it
(by dragging the borders) or its location (by dragging whilst the pointer is inside the
flow area).

5. When you have added content to your flow and manipulated the size you might dis-
cover that your content does not fit into the flow area. When a flow area is not large
enough for its content then the content is kept and a mark appears just outside the
flow area to indicate that there is more, but un-shown text:

for vertical overflow

for horizontal overflow

To resolve this you can increase the size of the flow area or set up the overflow feature
using the Flow Order Tool .

See the separate section Overflow Management for details on how to set up overflow
links between flow areas.

606
 7.6 Layout Objects

7.6.17.2 Flow Area Layout Properties Panels

A flow area's properties panel appears for each flow area when it is selected in the Layout Area
or Layout Tree. It has different tabs relating to its attributes:

Position

Runaround

Border

Content

Runaround Path

Position Tab
Refer to the separate section Position Tab for details.

Runaround Tab

The Runaround tab allows to set the attributes of the text runaround feature, around the flow
area, if it was placed inside or over another flow area.

In order to set runaround correctly, you have to consider the properties of the this flow area
and the properties of the flow area, that contains the text that you want to wrap around this
flow area, together. The property Runaround on the Content tab of the flow area that contains
the wrapping text must be set to a value other than None.

The arrangement of the runaround layers on the page is also important. You can simply alter
which is on top by changing their order in the Layout Tree; objects further down the branch
are in more forefront layers.

Note The setting made in the Type combo-box determines which other options will be
available on this tab. Thus the selection of options may differ from the above screenshot.

607
7 Layout Module

Options Description

Type Determines the kind of runaround that will be employed. The combo-box menu offers:

None No runaround settings will be applied and the text will write across the
face of the flow area (or behind it, depending on Layout Tree order).

Square Text will wrap around the rectangular outer boundaries of the flow area.

Tight Text will run close to the outside borders of any shape of flow area. Since
the flow areas are always rectangular, this applies to when a flow area has a Run-
around Path set.

Example In the screenshot below, the created runaround path can be seen
drawn in a light blue-green color. See the Runaround Path Tab description
below for details on how to set a runaround path.

Note Closer wrapping to a flow area can be achieved by using the Alignment
option of the paragraph style that is being used for the text.

608
 7.6 Layout Objects

Through Text will run close to the borders of any shaped flow area and, if there
are any free spaces within the outer borders, the text will run there as well.

This is particularly relevant when the Runaround Paths settings create a "hole"
in the flow area.

Example The created runaround path can be seen drawn in a light blue-
green color. See the Runaround Path Tab description below for details on
how to set a runaround path.

Top and Bottom Text will run above and below the flow area, not around.

Top Only the text above the flow area will be shown in the current flow.

Text that follows the flow area's position will be overflowed. Therefore, in order
to see it, the overflow must be set to the next page or flow area.

Wrap Type Sets on what side of the flow area the text will be wrapped.

Select from the combo-box menu:

Both The text will wrap on both sides of the flow area.

Left/Right All text will remain on the left/right of the flow area.

Largest All text will appear on the side of the flow area, which has the largest
space.

609
7 Layout Module

Left/Top/Right/Bottom Sets the margin between the text and the flow area boundaries.
Click on the measurement unit symbol (mm by default) to change the unit.

Invert Determines that the text will wrap within the boundaries of the selected flow area,
instead of wrapping around the outside of the flow area.

Once the text gets through the selected flow area, the flow inside the overlapped flow
area will continue below the object, as normal.

Border Tab

Options Description

Border Style Selects a border style to be used around a flow area or a selection of flow
areas.

See also the How to Position Multiple Objects Simultaneously section for a description of
setting common parameters to many objects.

The combo-box menu offers all currently available border types in the Layout Tree and
two additional options:

Create new border style Opens the Create Border Style dialog, where you can
define a new border style.

Empty Leaves the flow area(s) with no border.

Type Sets the area the border will surround.

610
 7.6 Layout Objects

Select from the combo-box menu:

Content only The border will be drawn only around the content of the flow area,
i.e. right next to the text.

Content with line gap The border will be drawn around the content of the flow
area, but with a line gap between the last line of the content and the border.

The line gap is the maximum size of line gap of the font that has been used in the
last line.

Full Area The border will be drawn along the boundaries of the flow area.

Content Tab

611
7 Layout Module

Options Description

Previous Identifies the previous flow area from where the content of this flow area feeds.

This is a part of setting up the overflow management feature. Select one of the already
existing flows from the combo-box menu, if the flow area is not the beginning of the
chain of flow areas.

However, flow order is easier to set using the Flow Order Tool. The combo-box will list
the previous flow that has been selected using it.

Empty is set by default and means, that this is the beginning of the chain of flow areas.

Content Selects the flow that will fill the flow area.

The flow that is shown here by default is any text that has been typed directly into the
flow area. If you change the flow, the text that you have typed will not be lost but will
remain as a created flow under the Flows node of the Layout Tree.

See the separate section Flows for more details.

Next Identifies the next flow area, to where the content of this flow area will flow, if the
space in the original flow area runs out.

This is a part of setting up the overflow management feature. Select one of the already
existing flows from the combo-box menu, if the flow area is not the end of the chain of
flow areas.

However, flow order is easier to set using the Flow Order Tool. The combo-box will list
the next flow that has been selected using it.

Empty is set by default and means that the content will not overflow if it does not fit in
the flow area.

Flowing to next page Check this option to allow the content of this flow area to flow to
the next page, where a flow area can be set to receive the overflowing content of this
flow area.

Note If this option is checked, only the Horizontal and None options are available in the
Fitting combo-box.

This is a part of setting up the overflow feature. For more details see Overflow Management
description.

Vertical alignment Select Top, Bottom or Center to align the content of the flow area.

Note The Runaround option in combination with flow areas vertical alignment works
correctly only if the vertical alignment is set to Top.

Writing direction Enables you to write text in a Horizontal or Vertical direction.

Note By default, characters higher than 65,536 (Unicode) that are written vertically are
not rotated in the vertical direction so that they are easily readable (e.g. Chinese or Japanese
characters).

Worldwide support If checked, allows to write in directions different from the western style
(left-to-right or top-to-bottom).

612
 7.6 Layout Objects

See the separate section Arabic, Hebrew, Indic Languages Support for more details.

Supplementary characters support When checked, enables employing supplementary

characters within the selected flow area.

The correct displaying of the surrogate pairs is controlled by the Supplementary charac-
ters support option in the Workflow Options dialog. If it has been selected there, all
newly created flow areas have this option checked in their Layout Properties.

Regardless of this setting, the supplementary characters are displayed in the Insert Char-
acter Palette when the currently selected font includes them.

Fitting Adapts the content of the flow area so that available space is used effectively either
in the Horizontal or Vertical directions; or Both horizontally and vertically.

This is a part of the First Fitting functionality. Read the separate First Fitting Overview
section to learn more.

Use balancing Balances the content between multiple flow areas where the text overflows
from one area to another.

Tip

The option must be checked in all flow areas among which the text flows.

The result can be seen in Proof only; no change is visible after using this option in
Layout.

See the separate section on Overflow Management for more details.

Note The combination of balancing and First fitting can significantly decrease the speed
of proofing and production.

Example Text flowing from one flow area to another with the option Use balan-
cing unchecked:

613
7 Layout Module

Text flowing from one flow area to another with the option Use balancing checked:

Runaround Sets the way the content of the flow area will run around any object placed in
or over the flow area.

In order to set runaround correctly you have to consider the properties of the currently
selected flow area and the properties of the object that you want to wrap around, together.

Select from:

None The text content of the flow area will not wrap around any object place in
or over the flow area (even if that object has its own runaround set).

Standard Allows runaround to take place according to the runaround settings

of any objects.

Shapes only Will runaround shapes only (not image objects or other flow areas).

Dynamic height Adjusts the height of the flow area to the content, i.e. the bottom border
of a flow area moves depending on the content.

This changing height is visible directly in Layout and will be adjusted according to any
variable content when the workflow is processed, i.e. in Proof or Production.

This option can be used in combination with the Dynamic height for pages in emails
(produced using the HTML engines) to avoid white spaces.

Runaround Path Tab

The Runaround Path tab allows you to draw shapes within the flow area, within which text
will wrap when it is written. This tab is the same, practically, as the Path Desc. tab on the
properties panel for any shape, curve or drawn line in Layout.

614
 7.6 Layout Objects

Since flow areas are simply rectangular, this allows for the creation of irregular shaped text
areas for a more advanced design, e.g.:

Options Description

Use runaround path If checked, the Path Points area is activated and allows the definition
of the runaround paths.

Path Points For the Type, X and Y options description see the Shapes section.

When Use runaround path is checked you will see that the boundaries or the flow area
are described as items in the Path Points area. The flow boundaries (runaround path) of
the flow area can be edited by altering the values of the items.

Line-describing items can be added using the icons at the bottom of the tab. See below
for a description of the icons.

You can then define lines accurately by entering X and Y values for the point positions of
each line type that you want to draw.

Example It is far more simple to alter the shape of the existing runaround path by
using the Change Shape tool or draw the shape of your desired runaround path
using the Shape tool, Line tool, Draw Freehand tool, etc. somewhere else
in your Layout Area and then:

1. Open the script of the shape by clicking on the Edit Script icon;

2. Copy the script using <Ctrl> and <C>;

3. Go to the Runaround Path tab of the flow area;

4. Open the script of the runaround path by clicking on the Edit Script icon;

5. Paste the script of the shape into the script area (<Ctrl>+<V>) and close it.

The content of the Path Points area will now be automatically filled and the runaround
path will be the same size and shape as the object that was drawn.

Edit Script Opens the script editor so you can see the scripted description of any currently
described line and edit it, or copy and paste some already scripted shape to be a runaround
path.

615
7 Layout Module

Fill path from border Loads the runaround path of the border style defined on the Border
tab. It is a quick solution when the position of the text in the flow area has to be adapted
so that the text fits into the defined border style (round corners, offset, etc.).

New MoveTo item Creates a new MoveTo item in the Path Points area.

New LineTo item Creates a new LineTo item in the Path Points area.

New ConicTo item Creates two new ConicTo items in the Path Points area.

New BezierTo item Creates three new BezierTo items in the Path Points area.

Make Curve Closed Joins two ends of a line to create a shape.

If a shape has been drawn freehand and the lines do not actually meet, then a flow cannot
be placed inside as the shape is incomplete. This can easily be done in error and so this
tool makes sure that the boundaries of the shape are complete.

Delete Deletes the currently selected item from the Path Points area.

Delete all Deletes all of the items in the Path Points area.

All of the runaround paths in this flow area are deleted.

Units Displays a context menu of different measurement units in which the X and Y points
can be described.

Select a preferred unit from the menu.

7.6.18 Fonts
In this section: See also:
Font Layout Properties Setting Default Font
Inserting Fonts
Special Imaging Text Effects Support
Mac Font's Limitations
Transferring Fonts from Mac to PC

The Fonts family lists the fonts that have been inserted into your WFD file for use within your
document. Using the Layout Properties you can load font faces or assign another font to the
current font to add any missing characters. Attributes such as size and color are specified
within the text styles.

616
 7.6 Layout Objects

Fonts can be added to the Layout Tree in one of the two following ways:

1. Right-click on the Fonts node and select the option Insert Font or go to the menu
Insert | Insert Font. Fonts can come from a central font file folder or from the local
computer's installed font list. See the Inserting Fonts section for details on the Open
dialog.

2. Select a new font in the combo-box that lists the available fonts in the Text Format
Toolbar of the Layout window, when entering text to a flow area.

Note To help you avoid inconsistencies, fonts already added to the Layout Tree appear at
the top of the list.

7.6.18.1 Font Layout Properties

Options Description

Linked font Enables you to select another font that will be linked to the main font. All the
characters of the main font will be replaced by corresponding characters of the linked font
(if they exist).

To check the resulting font set, select the Show Insert Char Palette option in the Window
menu.

Add letters Enabled only if Linked Font is selected. If this option is checked, only those
characters that are missing in the main font will be used from the linked font.

Subfamily Displays the name of the font subfamily.

Style Displays the font style other than Regular:

B Bold

I Italic

BI Bold Italic

Preview Shows either preview of the used/loaded font face or gives information that the
face was not used/loaded. The font preview appears whenever the font face is used in
Layout.

Unload font Unloads the selected face of the font, i.e. removes the link between Inspire De-
signer and the specific font face file on the disk but only in case the face is not used in
Layout any more.

617
7 Layout Module

Load font Enables you to assign any font to the selected font style. This can be useful for
correcting corrupted fonts, e.g. if the bold face of some font does not display correctly,
you can reload the bold face of this font or a similar one.

Set codec Sets the coding for the selected font style. See the section Text Encoding.

Assign code page Creates a link to a code page for the selected AFP font. The code page
is needed to assign glyph bitmaps to appropriate Unicode values. You can use your own
code page (and re-assign the glyphs as you wish). If no code page is selected, the default
one is used but it may not cover all the glyphs in the selected font and those are then
not displayed in Layout.

The code page is also needed if the font is to be used natively in the output. It is also
possible to set a global code page for all AFP fonts in AFP Engine configuration.

Supported fonts are: Raster fonts (both single byte and double byte fonts, both fixed and
relative metric) and outline fonts (Adobe Type 1 fonts). Adobe CID fonts are not supported.

Clear code page Enables you to cancel the assignment of the code page for the selected
AFP font.

Preserve font encoding for IJPDS output If selected, the font is encoded using the text
encoding file selected on the Font Options tab of the IJPDS Engine Config dialog.

Note

If you receive an error message "Used font <its name> was not correctly loaded" when
trying to proof a job, use the option Unload font and then select for the specific
font another one using the option Load font .

If you use Type1 Fonts, it is necessary to install PFB and INF files of the font to the
Windows/Fonts directory. If the INF file is not there, only the family name of the font
is displayed.

Note If a font used in Layout is missing, the font name is displayed with the icon in the
Layout Tree.

7.6.18.2 Inserting Fonts

Fonts can be added by right-clicking on the Fonts node and selecting Insert Font or via the
menu Insert | Insert font. Either way, a standard Open dialog is displayed:

618
 7.6 Layout Objects

Options Description

File Name Shows the name of any file selected in the explorer area above.

Files of type Select the type of font file you are looking for from the combo-box menu.

The following types of fonts are supported:

TrueType fonts (OpenType fonts) An OpenType font file contains data, in table format,
that comprises either a TrueType or a PostScript outline font. Rasterizers use combin-
ations of data from the tables contained in the font to render the TrueType or Post-
Script glyph outlines. Some of this supporting data is used no matter which outline
format is used; some of the supporting data is specific to either TrueType or PostScript.

Windows Raster fonts A raster font represents each character glyph using a bitmap
array. They need separate bitmap sets for each and every font size. However, the
quality of glyphs is typically much better than that produced by scaling algorithms
especially with small point sizes.

Type1 fonts Standard PostScript (vector) fonts.

GSR fonts, AFP fonts

GSR fonts are bitmap fonts generated as a part of resources created by Print-
Layout program (a part of PrintNet 3 suite). This font is machine specific. A
device font can also be generated with PrintFont or created and modified with
PrintImage applications (also contained in the PrintNet 3 suite).

AFP Fonts can be either bitmap or outline (vector) fonts that can be used for
AFP output without conversion (it is possible to use them in other outputs but
then they will be converted).
It is also possible to insert fonts from ATM (Adobe Type Manager) and Extensis SuitCase
font manager applications.

Use font full name Inserts the fonts full name in the Layout Tree.

619
7 Layout Module

The long font name is taken from the INF file (VPMenuName section) if there is any placed
in Fonts directory. If there is only the font (without the appropriate INF file) available, then
the name is taken from the font file.

Load complete font family When checked then, after clicking on Open, all faces of the
selected font are loaded.

This means that Inspire Designer loads the selected font and then also finds and loads all
of its available faces (bold, italic, bold italic ) into the directory as well.

Example When ARIALN.TTF font is selected (ArialNarrow) it will also load ARIAL-
NB.TTF (bold face of ArialNarrow), ARIALNBI.TTF (bold italic face) and ARIALNI.TTF
(italic face) if they are present in the same directory as ARIALN.TTF font.

For a description of Open file dialog advanced options, see Open File Dialog section.

7.6.18.3 Special Imaging Text Effects Support

Security documents such as coupons, tickets, invitations and invoices, can be better protected
from unauthorised duplication using special imaging text effects; MicroText marks, Correlation

marks and Glossmark text. Such text can only be read under special conditions: MicroText
marks with a loupe or magnifying glass; Correlation marks when superimposed by a "key"

overlay; and Glossmark text under inclined illumination.

These imaging text effects require special fonts that can be purchased separately from the
Xerox company. With these fonts available, you can design and produce documents with such
protection in Inspire Designer in NexPress VDX, PDF, PS2, PS3, VIPP, HP PPML and Podi PPML
formats.

620
 7.6 Layout Objects

Working with Special Imaging Text Effects

When you have the special font available:

1. Insert the font (the FNT format) into Inspire Designer.

2. Design your layout using this font (on the screenshot below MicroText marks font is
used). The fonts are visible in Layout in the same way as they will be visible in the final
output, i.e. the text is not readable by a human eye.

Tip To see what you have already written either use the Text in Rect module or change
font temporarily. You can also see the interpretation of single characters in the Insert

Character Palette table, e.g. interpretation of the "A" letter in the Glossmark font:

The font glyphs are bitmaps that are defined for a specific font size, i.e. the fonts are
not scalable. The recommended value for the font size is 10 (set it in Text Format
toolbar) for an optimal output. For rotated text, only multiples of 90 are recommended.
With this fonts it is not recommended to use:

Scaling in the Sheet Transformer module and in the Flow Area Layout Properties
panel.

Skewing in the Flow Area Layout Properties Panel.

621
7 Layout Module

Tip Instead of scaling, design the document directly in the desired size.

3. Generate one of the supported output formats.

7.6.18.4 Mac Fonts Limitations

Unsupported fonts:

Mac Bitmap fonts

Supported fonts:

PostScript TYPE1

TrueType fonts

If you import a job with unsupported Mac fonts in Inspire Designer, the Font replacement dialog
enables you to replace them.

7.6.18.5 Transferring Fonts from Mac to PC

Transferring fonts between Macintosh and PC raises two kinds of problems. First, the file format
is not exactly the same (in particular for Type 1 fonts). This means that a conversion must occur.
Secondly, on Macintosh, fonts are stored in the resource fork of the file.

Note Under the Macintosh file system, files are not monolithic and do not consist of one
single segment. They may be composed of two pieces, called forks, i.e. a data fork and a re-
source fork. Only one of the two forks may be empty.

When files are transferred through a network or by email, you often get an empty file, the
data fork. Transferring fonts between Macintosh and PC must be done using real Macintosh
media (HFS volumes) or "Macintosh-like" media (MS-DOS volumes handled by File Exchange
on Macintosh, NTFS volumes handled on a NT Server with SFM, ISO 9660 CD-ROM with Apple
Extensions).

Note The data fork contains what we generally call a file on the PC, that is the text created
by a word processor, the pixels building a picture, etc. When transferring data files between
Macintosh and PC, the data fork is generally the only part of interest, i.e. the resource fork
containing font data will be lost.

There are two possibilities for transferring fonts from Mac to PC:

1. You can buy fonts, which is the recommended way to obtain them without breaking
copyright. Producers make fonts in two versions because Mac and PC require different
formats.

2. You can download conversion tools which will transform Mac font formats to PC font
formats. There are several links below; some of the tools are free. They can do conver-
sions between various formats:

All conversions between all formats (Type 1, TrueType, OpenType; PC, UNIX and
Mac):

http://www.asy.com/

622
 7.6 Layout Objects

http://homepage.mac.com/mdouma46/dfont/dfont.html

http://fondu.sourceforge.net/

http://fontforge.sourceforge.net/

Commercial software for Mac/PC conversions in general. It also converts TrueType

fonts between Mac and PC, and Type 1 fonts from Mac to PC.

http://www.macdisk.com/fontsen.php3

Conversions between seven outline formats: Type 1 fonts for the Mac, PC, and
NeXT; Type 3 fonts for the Mac and PC; and TrueType for the Mac and PC.

http://www.tidbits.com/tb-issues/TidBITS-066.html

For more conversion tools see:

http://cgm.cs.mcgill.ca/~luc/conversion.html

For more information about transferring fonts from Mac to PC see: ht-
tp://www.macdisk.com/fontsen.php3

7.6.19 Glyph Areas

In this section: See also:
Glyph Area Layout Properties Panel Native Import to Layout
Glyph Area Context Menu

A glyph area is an object that is created in Layout when importing native files to contain an
object that has been defined as text. It could be also be described as a map of glyphs. A glyph
is the information that provides the shape and type-face of a text character.

Example If a PDF file, that contains both images and text, is imported to Layout via File
| Import | Native and each page of that file is created as a page in Layout. Then, each
page will already have a number of image areas (containing images) and a number of
glyph areas. These are created according to how the content of the PDF file has been di-
vided in the page description language, e.g.:

A glyph area from an imported PDF is selected (dark-blue border) here

623
7 Layout Module

The images are those parts of the file that have been defined as images and the glyph
areas are those parts that were defined as text. In the Layout Tree this can be seen more
clearly, e.g:

The glyphs in the glyph area can be modified like standard flows in a flow area, when the Flow
Area Tool is activated.

The content of a glyph area can also be dragged and dropped within or outside the boundaries
of a glyph area. If glyphs have been placed outside of the boundaries of a glyph area, you must
adjust the boundaries of the glyph area to include those glyphs in order to edit them.

The parameters of single glyphs can also be set on the Glyphs tab on the Layout Properties
panel. The content of a selected glyph area can be formatted in parts. See the Font tab for a
detailed description.

7.6.19.1 Glyph Area Layout Properties Panel

A glyph areas properties panel appears for each glyph area when it is selected in the Layout
Area or Layout Tree. It has different tabs relating to its attributes:

Position

Glyphs

Font

Position Tab
For a description of this tab, see the Position Tab section.

624
 7.6 Layout Objects

Glyphs Tab

The Glyphs tab enables you to set the position and content of single glyphs in the selected
glyph area.

Options Description

Nr. Displays the sequence of glyphs in the selected glyph area.

X Displays the horizontal position of a glyph in relation to the top left corner of the selected
glyph area.

The up /down control enables you to set the position of the selected glyph in the X
field. You can also directly enter the position into the selected field in the X column.

Y Displays the vertical position of a glyph in relation to the top left corner of the selected
glyph area.

The up /down control enables you to set the position of the selected glyph in the Y
field. You can also directly enter the position into the selected field in the Y column.

Char Displays the character that the selected glyph contains.

The 3 dots icon makes the character field editable. You can also directly enter a character
into the selected field in the Char column.

In the case that information about the used font for the glyphs is not included in the im-
ported file, the Char column will contain only the square symbols instead of the char-
acters displayed in the glyph area in the Layout Area, e.g.:

625
7 Layout Module

The text in the corresponding glyph area in the Layout Area is displayed correctly. However,
formatting of the selected glyph area and entering glyphs in there will not work correctly.

To correctly display the text coming from a native file in the Char column, it is necessary
to know the glyph number within the used font and set it in the Glyph column.

Glyph Displays the order number of the character within the used font.

The up / down control enables you to change it. You can also directly enter a character
order number into the selected field in the Glyph column.

Note If you enter an order number of a character that is not included in the used font,
a glyph with the zero index number will be displayed.

Sort Enables you to sort glyphs in relation to their position within the selected glyph area
in case the glyphs are not in an appropriate order.

An inappropriate order of glyphs can be an issue of the original imported file which can
cause an incorrect editing of these glyphs (e.g. selecting, pasting) in Inspire Designer layout.

Note When a file containing a glyph area with glyphs in an improper order is imported
into Inspire Designer, the improper order of glyphs will be displayed in the Glyphs tab
only. The resulting view of this glyph area will be correct in the Layout Area, Proof and
Production.

Example

Glyphs in the wrong order

Glyphs after sorting has been done.

The resulting view of a glyph area in the Layout Area is the same for arranged and
not arranged glyphs.

In addition, duplicate characters are not displayed. Duplicate characters are those that are
at the same position.

Fit To Enlarges the glyph area so that the glyph whole glyph is inside the glyph area.

For cases when a glyph is partially outside of the glyph area,

626
 7.6 Layout Objects

Delete Removes a selected glyph from the list of glyphs.

Delete All Removes all glyphs of the selected glyph area.

Font Tab
The Font tab enables you to set attributes related to the formatting of the selected glyph area.
The selected option is applied to the whole glyph area even if only a part of the glyph area is
selected. For a detailed description of the Font tab options (except the Rotated check-box),
see the section Text Styles.

The Rotated check-box is applicable for glyph areas containing characters that can be read
horizontally or vertically (e.g. Japanese and Chinese characters). If the Rotated check-box is
checked, the characters in the selected glyph area are rotated to the left (counter-clockwise)
by 90 degrees.

Example

On the left, Rotated is not checked. On the right, Rotated is checked.

Notice how, although the Rotated option has been applied to the whole glyph area, only
the Chinese characters have been affected.

7.6.19.2 Glyph Area Context Menu

When right-clicking on a glyph area in the Layout Tree or in the Layout Area, the following
specific option is available:

627
7 Layout Module

Options Description

Convert to FlowArea Creates a flow area from the selected glyph area. A single flow area
will also be created when several glyph areas are selected.

The newly created flow area will be added to the Layout and the original glyph area will
be deleted. The flow area takes format and position from the original glyph area, however,
some complex glyph areas may not be converted correctly, i.e. they may differ from the
formatting of the original glyph area.

If you convert several glyph areas, the size and position of the created flow area will be
the result of the merger of all selected glyph areas. The formatting of each of the glyph
areas is maintained within the single flow area.

See the Flow Areas section for more information about working with flow areas.

Tip The context menu for Pages (individual and family) has the option Convert All Glyph
Areas for converting all glyph areas in one go after a native import.

7.6.20 Gradients
In this section: See also:
Gradient Layout Properties Fill Styles

Gradients are fill styles that consist of two or more colors which blend together.

There are two ways to create a gradient fill style:

1. Right-click on the Fill Styles family in the Layout Tree and select Insert Fill Style from
the context menu.

Then select the newly created fill style in the Layout Tree and in its Layout Properties
select Gradient in the Type combo-box.

2. Select or create a flow area, line or shape in the Layout Area. Then select the Gradient
Tool from the Tools toolbar, return to the selected object, hold the mouse button
and drag across it. A line appears that defines the dimension and direction of the
gradient across the object.

When you let go of the mouse button the gradient will be applied to the object, the
new fill style is created in the FillStyles family of the Layout Tree and it can be edited.

628
 7.6 Layout Objects

7.6.20.1 Gradient Layout Properties

The Gradient Layout Properties panel allows you to customize the way colors will blend, which
colors will blend and other details concerning the appearance of the gradient. The following
tabs are available:

Transformation tab

Gradient tab

Color tab

Transformation Tab

Options Description

Offset X / Offset Y Sets the distance between the origin and the start of the gradient in
the X / Y plane.

Negative values can be used.

Note The origin is determined by Apply object's transformation. See option description
below.

Rotation Sets the rotation of the gradient, using the Offset as the rotation point.

Shear X Shears the gradient along the X-axis by the value inserted.

The allowed value range is from -90 to 90. Positive values shear the gradient clockwise,
negative values anti-clockwise.

Scale X / Scale Y Scales the gradient in the X / Y plane.

1 = original dimension, 0.5 = half the dimension and 2 = double the dimension etc.

Flip X / Flip Y Flips the gradient 180 around the origin in the X / Y direction.

The values of the other options on this tab will be adjusted accordingly.

Example If Offset Y = 10 and Rotation = 10 the result of Flip Y would be Offset

Y = -10 and Rotation = 170.

629
7 Layout Module

Apply object's transformation If checked, the gradient will be aligned to each object that
uses it as a fill style, e.g. the origin of the gradient is the origin of the object.

In this case, settings made in the Position tab of each objects layout properties will also
be applied to the gradient.

If unchecked, a single transformation is used for all objects that use the gradient. This
transformation has the origin of the page, i.e. its top left-hand corner.

Example The following screenshots are of shapes using the same gradient as a fill
style. In both cases Autofit is unchecked and Linear is chosen as Gradient type:

1. If Apply object's transformation is unchecked the same gradient is used

across all shapes.

2. If Apply object's transformation is checked the gradient is applied to each

shape's position individually.

This option is checked by default.

Autofit If checked, the gradient is fitted across each of the transformations used.

In this case, the gradient start (end 0) is at the Offset and the second extent (end 1) is
determined by the furthest point (from the origin) of each object (using the gradient) +
the Offset.

If unchecked, the gradient is measured in absolute terms from the Offset. The dimensions
of the gradient are then controlled by the options X0, Y0, X1 and Y1 on the Gradient
tab.

This option is checked by default. The intention is that this option should only be checked
when Apply object's transformation is also checked, in which case the gradient is fitted
to the size of the object.

630
 7.6 Layout Objects

Note The origin (and therefore Offset) of the gradient is affected by Apply object's
transformation. See option description above.

Note The options X0, X1, Y0 and Y1 on the Gradient tab also affect the position and size
of the gradient, i.e. they affect the Offset, Shear, Scale and Flip options.

Gradient Tab

Options Description

Gradient Selects the type of gradient. Select from:

Linear

Radial

Rectangle

Each selection reveals further options relevant to the gradient type. Click on the links above
to go to the relevant option descriptions.

Linear Gradient
Linear gradient fill styles have the following appearance (check the screenshots of the Trans-
formation tab and Color tab and the screenshot of the Gradient tab below to view the settings
resulting in this example):

When Linear is selected for Gradient the tab has the following appearance:

Options Description

X0 / Y0 Set the distance from the Offset that the gradient will start in the X / Y plane.

The default value is 0, i.e. the gradient will start at the Offset.

X1 / Y1 Set the distance from the Offset that the gradient will end in the X / Y plane.

Setting 0 for these options determines that no color blend will occur in the X / Y plane
and that the gradient (as a fill style) will have a limitless dimension in that plane, i.e. it will
completely fill any object in the plane set to 0 without any blending of colors.

631
7 Layout Module

The default value for X1 1000 mm, i.e. the gradient will end one meter from the Offset.
The default value for Y1 is 0, i.e. the gradient will end at the Offset and, because Y0 is
also set to 0, no color blending will occur in the Y plane.

Note

The origin (and therefore Offset) of the gradient is affected by Apply object's
transformation on the Transformation tab.

When Autofit is enabled on the Transformation tab (as it is by default) and the
Offset = 0 in either plane, the value 0 in this option represents Position X or Po-
sition Y of the object's Position tab and 1000 represents the object's Width or
Height. However, the gradient is shifted separately from the object when its Offset
is altered.

If X0 = 0 and X1 = 0 then settings for the X plane on the Transformation tab (e.g.
Scale X) appear to have no effect and vice versa for the Y plane.

Example The following screenshots are of a line (drawn with the Line Tool )
that has Line width set as 20 mm and uses a linear gradient as its fill style. Both
Apply object's transformation and Autofit are checked so that the values of X0,
Y0, X1 and Y1 are relative to the object being filled:

1. If X0 = 0, X1 = 1000, Y0 = 0 and Y1 = 0 then the gradient will fill the object's

area in the X plane:

2. If X0 = 0, X1 = 500, Y0 = 0 and Y1 = 0 then the object will be filled half way

along its area in the X plane:

632
 7.6 Layout Objects

3. If X0 = 0, X1 = 0, Y0 = 0 and Y1 = 1000 then the gradient will fill the object's

area in the Y plane:

Notice the difference between the direction of the color blend that results from setting
values in the Y plane (example 3) and in the X plane (examples 1 and 2). In example
3, the color blend is at 90 in comparison to examples 1 and 2. Differing non-zero
values can be entered in both the X and Y planes to alter the angle of the color blend,
e.g. X0 = 0, X1 = 1000, Y0 = 0 and Y1 = 1000 would give a 45 color blend.

Also notice how, in examples 1 and 2, the gradient does not fill the object outside
of the area in the X plane and in example 3 it does not fill outside of the area in the
Y plane. This is because the gradient has been made the same size as the area by
Autofit. If the line required filling outside of the area negative values would have to
be used.

Radial Gradient
Radial gradient fill styles have the following appearance (check the screenshots of the Trans-
formation tab and Color tab and the screenshot of the Gradient tab below to view the settings
resulting in this example):

It consists of two ellipses that are connected by the gradient fill style. When Radial is selected
for Gradient the tab has the following appearance:

Options Description

Sx0/ Sy0 Set the distance between the center of the first ellipse and the Offset in the X / Y
plane.

The default value is 500 mm, i.e. the ellipse is centered 500 mm from the Offset.

633
7 Layout Module

Sx1 / Sy1 Set the distance between the center of the second ellipse and the Offset in the
X / Y plane.

The default value is 500 mm, i.e. the ellipse is centered 500 mm from the Offset.

Note

The origin (and therefore Offset) of the gradient is affected by Apply object's
transformation on the Transformation tab.

When Autofit is enabled on the Transformation tab (as it is by default) and the
Offset = 0 in either plane, the value 0 in this option represents Position X or Po-
sition Y of the object's Position tab and 1000 represents the object's Width or
Height. However, the gradient is shifted separately from the object when its Offset
is altered.

Example While Autofit is enabled on the Transformation tab and Offset, Shear
and Rotation options are all set to 0 then:

For Sx0 and Sx1 Setting both to 500 mm centers both ellipses to the hori-
zontal center of the object's area.

Setting both values to 0 will center the ellipses on the left border, whereas
setting both values to 1000 mm will center them on the right border.

For Sy0 and Sy1 Setting both to 500 mm centers both ellipses to the vertical
center of the object's area.

Setting both values to 0 will center the ellipses on the upper border, whereas
setting both values to 1000 mm will center them on the bottom border.

R0 Sets the radius of the first ellipse.

The default value is 0 mm, i.e. there will be no first ellipse.

R1 Sets the radius of the second ellipse.

The default value is 500 mm, i.e. the radius of the second ellipse is 500 mm and the
gradient will fill one meter in diameter.

Example By setting the first ellipse value R above zero and by giving each ellipse an
individual position using you can create a radial gradient fill style with a 3-dimensional
appearance. See the screenshot below for an example of possible settings:

634
 7.6 Layout Objects

The settings above will result in the following appearance of the radial gradient fill style:

Rectangle Gradient
Rectangle gradient fill styles have the following appearance (check the screenshots of the
Transformation tab and Color tab and the screenshot of the Gradient tab below to view the
settings resulting in this example):

When Rectangle is selected for Gradient the tab has the following appearance:

Options Description

Sx0 / Sy0 Set the distance between the center of the gradient and the Offset in the X / Y
plane.

The default value is 500 mm, i.e. the gradient is centered 500 mm from the Offset.

Note

The origin (and therefore Offset) of the gradient is affected by Apply object's
transformation on the Transformation tab.

When Autofit is enabled on the Transformation tab (as it is by default) and the
Offset = 0 in either plane, the value 0 in this option represents Position X or Po-
sition Y of the object's Position tab and 1000 represents the object's Width or
Height. However, the gradient is shifted separately from the object when its Offset
is altered.

Sx1, Sy1 and R1 are not used for rectangle gradients.

635
7 Layout Module

Example While Autofit is enabled on the Transformation tab and Offset, Shear
and Rotation options are all set to 0 then:

Setting Sx0 to 500 mm centers the gradient the horizontal center of the ob-
ject's area.

Setting a value of 0 will center the gradient on the left border, whereas a
setting of 1000 mm will center it on the right border.

Setting Sy0 to 500 mm centers the gradient to the vertical center of the ob-
ject's area.

Setting a value of 0 will center the gradient on the upper border, whereas a
setting of 1000 mm will center it on the bottom border.

R0 Sets the radius of the gradient.

The default value is 500 mm, i.e. the radius is 500 mm and the gradient will fill one meter
in diameter.

Color Tab
The Color tab allows you to select the colors that will appear in the gradient fill style. Addition-
ally, you can set the exact way they will blend into each other. This can be done either in the
menu by modifying the values or with the mouse by moving the position markers and degree
markers. By default, each newly created gradient fill style consists of the colors black and white.
In the screenshot below, the green color has been added manually.

Legend

1. Degree marker

2. Position marker

Options Description

Position Displays the position of the corresponding color between end 0 and end 1 of the
gradient.

At this position the color is pure, i.e. it is not blended with any other color.

636
 7.6 Layout Objects

With just two colors, one color must have value 0 and the other 1. However, if there are
more colors, the position of the middle colors can be modified by entering a new value
(between 0 and 1) or dragging the Position marker with the mouse.

Color Selects the color of the gradient at the position.

Degree Sets the position where the color is equally blended with the next color in the list.

It is represented by the Degree marker to the right of the corresponding colors Position
marker.

The value can be modified by entering a new value or dragging the Degree marker with
the mouse. Setting the value to 1 (so that the degree marker is exactly in the middle of
two position markers) determines that the blend of colors is 50 / 50 % at the halfway
position between the two colors.

Extent 0 / Extent 1 Select from the combo-box the color that will appear outside the extents
(end 0 / end 1) of the gradient if there is space remaining to fill, e.g. when the gradient
has been reduced in size so that it does not fill the object completely.

Link / Unlink Allow to link up/unlink the colors used for the Extents (the spaces outside
the area covered by the gradient) to the ones assigned to Position 0/1 of the gradient.
Toggling the Link/ Unlink icons changes the setting. Linking the colors deactivates
independent Extents' color selection.

If a color of the Extent 0/1 is linked to the color selected for the gradient's Position 0/1,
then the color of the extent will be automatically changed along with changing the respect-
ive Position 0 and 1 color. Selecting identical colors for the Position 0/1 of the gradient
and for the Extent 0/1 allows to create an imperceptible borderline between the solid
color of the extents and the gradient.

Example These two identical objects are filled with the same gradient. The only
difference is, that in the gradient used as a fill style for the rectangle number one,
the colors of the extents are identical to the colors specified for Position 0 and 1 of
the gradient, whereas in the rectangle number two, the colors of the extents are
different.

Background Sets the color that will appear in any remaining space, i.e. area not covered by
the gradient or Extent 0/1.

Tip Check the Apply object's transformation and Autofit options in the Transform-
ations tab as they affect the way the gradients, extents and background fill objects. See
also examples in the Linear, Radial and the Rectangle sections.

Go To Moves you to the node of the selected color in the Layout Tree.

637
7 Layout Module

Move Up / Move Down Move the color in the selected row up/down one position in
the list.

Create New Creates a new row in the list.

Delete Removes the selected row from the list.

7.6.21 Images
7.6.21.1 Images
In this section: See also:
Image Layout Properties Variable Images
Native Loading of Images Image Areas
Inserting Images and Using Them in Anchors
Layout

Images often make up a major part of any document's layout design. Inspire Designer allows
you to manipulate images in your design pages, elements and flows; use them as fill styles or
make them variable so that they appear according to certain data criteria. Further to that, you
can adjust the colors or make them transparent to write across them, under them or through
them.

Images can be inserted or imported into Layout (see Inserting Images and Using Them in Layout)
into the Images family and then employed in multiple places in a design.

The Images family can be found in the Layout Tree. Under it, all of the images currently inserted
in to the WFD file are listed. The listing of an image as a node does not mean that it has been
used in the layout design, it simply means that it is ready for use in your design.

Currently supported image types are: BMP, CXRI, GIF, ICB, IMG (IMG files must contain LABEL
block), JIF, JPG, PCX, PNG, TGA, TIF, VDA, VST and all native files. Some of these types may
have multiple pages and you can further select the page you want to use via the Page tab.

638
 7.6 Layout Objects

Image Layout Properties

An image's properties panel appears for each image when it is selected in the Layout Area or
Layout Tree. It has different tabs relating to its attributes:

Image

Page

Palette

Transparency

Advanced

Image Tab

Options Description

File Displays the file name of the image and (in brackets) whether the image file is still in the
location where it was when it was inserted into Layout.

A tool tip, that describes the complete path to the file, is revealed when a mouse pointer
is hovered over the file name.

Open Locates a new image file to replace the existing one.

Import Imports an image file so that it becomes part of the workflow (WFD) file.

Export Saves the image to a directory as a separate file.

The exported image is not subsequently used by the workflow. If the image is only
inserted into Layout, the original image file (named here) is not altered and is still the
one used by the workflow. If the image has been imported it remains as part of the
workflow.

Format Displays the file format of the image.

639
7 Layout Module

Width/Height Display the size of the original image in pixels, i.e. size properties of the image
file.

Pages Displays how many pages are component to the image file.

Type Displays information about the colorspace of the image (as it has been set for the option
Color space on the Advanced tab) and the bit depth.

Image DPI Displays the DPI of the image where possible.

This is the horizontal and vertical resolution as read from the file properties. If no value
has been read from the file (e.g. because it is not included in the file properties), a default
value of 96, 96 is given so that resizing can be performed if required and the note (not
read from file) appears here.

Tip It is possible to read and employ DPI of JPEG images defined in Exif data see the
Current Workflow Options section for more details.

Preview Shows the image, as it appears in Layout, for easier identification of which image
the properties belong to.

Promote to Variable Image Changes the image from being a static one to being a designated
place where images will appear according to the criteria of a variable.

The original non-variable image will also be kept. A new node for the variable image is
created on the Layout Tree with the same name plus a number.

Variable images have different properties, see the separate section Variable Images for
more details.

Handling Group Assigns the image to one of eight possible handling groups.

Handling groups can also be assigned to any position defining object (on the Position Tab).
By default the handling group for all applicable objects is 1. If set to 0, the handling group
of the object in which this image is placed is adopted.

Assigning handling groups allows different images to have different properties, e.g. the
image handling and dithering properties that can be set for some engines in Production.
See the separate Dithering sections for more details.

Use Image DPI If checked, the DPI (resolution in Dots per Inch) of the image when used in
the Layout design will be the image's own value.

DPI X / DPI Y If Use Image DPI is unchecked, these edit boxes determine the DPI of the
image.

Tip Handling Group, Use Image DPI and DPI X/ DPI Y can be edited for multi-selected
simple and variable images so you do not have to go through each image and set the option
individually.

640
 7.6 Layout Objects

Page Tab

Options Description

Page Selects the page of the image that you want to be shown.

This is intended for multi-paged images, such as PDF documents, and you will only be able
to enter a page number that exists in the edit-box.

Variable page selection (zero based) If checked, you can further assign a variable that will
determine which page of the image will be selected and shown, when it is used in the
Layout design.

This is intended for multi-paged images, but can be used with single-page images to allocate
a variable that decides if the image should be used at all.

The combo-box menu lists all of the available variables under the Data node of the Layout
Tree. If you want to create a new variable to decide the conditions for image appearance,
use the Data node.

See an example of usage in importing a PDF as an image in the section How to Create an
Image Page Counter.

Palette Tab

The Palette tab allows you to modify the colors used in the image.

This tab only appears for palettized images. This includes image types GIF, TIF and PNG or when
Grayscale or Black and white is selected for Color space on the Advanced tab.

Options Description

Color Lists the colors that are in the current palette, giving them an index number.

The color thumbnail to the left is a representation of the original palette color. It does not
change if a modification is made.

Modification Selects a modification to be made to the corresponding color. Select from:

No change Sets the color to its original state (in which the image was inserted,
if there are no further changes on the Advanced tab).

Transparent Makes the color transparent.

641
7 Layout Module

Calculate Converts the color to be a gradient of another color.

Between two or more selected colors, the remaining colors in between will be re-
calculated to create a gradient.

Example In the screenshot below a varied colored palette is set to Calculate

in order to produce a gradient between black and violet.

The image with the new palette looks like this:

Notice that the colored thumbnails on the left stay the same, so that you can
compare the new settings with the original colors.

Colors Converts the color to any of the listed colors that already exist in Layout.

Create new color Opens the Colors dialog in order to create a new color.

642
 7.6 Layout Objects

Spot colors can be assigned to the image once the color has been selected or a new color
created.

Example While the color is selected, click on the Go To icon to find the new
color in the Layout Tree. In Layout Properties of this color you can now assign the
appropriate spot color as shown in the screenshot below.

Go To Finds the color's node in the Layout Tree and shows its properties.

Restore Restores the whole palette to its initial values.

This option can be useful after you have used the Calculate function or set any color to
Transparent in order to reset the palette.

Calculate Sets all colors that are currently assigned as No Change to Calculate so that a
gradient is created between all of the other set colors.

You should ensure that colors at the ends of the spectrum are set to definite colors (not
No Change) because a gradient must be between two colors. If an end color is set to
Calculate then a warning will show.

Verify palette Tests if the settings for calculating the new palette are correct.

If the palette is correct, the icon is disabled and looks like this: . If a palette error occurs,
the icon changes into and is enabled for clicking.

If you click on the icon, a warning will display.

Example You receive a warning if colors are set to Calculate and if:

the start color is missing

the end color is missing

the start and end colors are different (different color space or dithered spot
color setting)

the start and end colors have different colorants

Copy / Paste Copies/Pastes the settings made in the palette via the clipboard.

Pasting can only be made to another image with the same number of colors in its palette.

643
7 Layout Module

Transparency Tab

By checking Make transparent the image becomes transparent for the colors selected in the
range entered in the color models tables below.

Transparent here means that the exact color is deleted and the object has holes where pixels
of that color were. This means that you can see what ever is behind the image through the
image.

You can use the RGB or CMYK model to fill in the min, max edit-boxes that determine which
colors are to be made transparent.

Each color that falls somewhere in the range selected for all of the color components will be
made completely transparent. By default only the color with RGB 255, 255, 255 (i.e. pure
white) will be made transparent.

By broadening the ranges you include more colors.

Example Below is an image without transparency:

Below is an image with transparency set for values R, G and B 200-255 (shades of white):

644
 7.6 Layout Objects

You want the white background of an image to be made invisible but when you check
Make Transparent you notice that some white color still remains. This is probably because
it is not pure white but has shades of other colors mixed in.

To ensure that all of the near white shades are made completely transparent you can
broaden the range by entering the values R: 200, G: 200, B: 200 in the min edit-boxes
(the left ones) as below:

If, however, you want to only have the greenish mixed color that is represented by R:
100, G:130 and B: 70 made transparent then you must enter these values in both the
min and max edit-boxes:

But, it is not possible to get rid of all green shades by this method because if you entered
G min: 0 and G max: 255 then only the pure green colored pixels will be made transparent,
any mixed green pixels left will only be made transparent if the range of the R and B mins
and maxs combined covers the actual mix ratio of the pixel. Yet broadening the ranges
of R and B will start to include all color mixes within that range, red and blue shades in-
cluded.

The best you could do to get rid of as much green as possible is enter a low range for R
and B knowing that; the higher the number the more intense the color, and so intense
red and blue mixes will remain intact. Also, to ensure you keep your black shades, the
lowest numbers for each color should be kept out of the range. E.g.:

But even with the above values many greens (e.g. R: 15, G: 200, B: 17) would still be
visible.

Note For palletized images, palette colors can be set to be transparent on the Palette tab.

645
7 Layout Module

Tip Transparency range can be also set for all new images (or for all new native files) in Layout
Options Dialog.

Advanced Tab

Options Description

Color space Sets the highest level of color space model for the image.

There are four possible color types:

Black and white All images are shown and processed as black and white. Selecting
this color type activates the Dithering button. Clicking on it opens the Edit
Dithering dialog.

Note Black-and-white images with dithering set here are generated in the form
set in the Edit Dithering dialog without further conversion in Production. However,
when generating JPEG images via the PDF Engine, you additionally need to
check/adjust the JPEG compression settings in the Handling Group tab.

The output image is RGB (even for the input CMYK image).

Grayscale All images, except black and white ones, are shown and processed as
grayscale.

The output image is RGB (even for the input CMYK image).

RGB CMYK images are shown and processed as RGB.

CMYK All images, including CMYK ones, are shown and processed as they are.

Note An image cannot use a color space model which consists of more colors than its
current model.

646
 7.6 Layout Objects

Embedded profile usage: Selects how any ICC color profile embedded in the image will
be used from the drop-down menu:

Never use profile If the image has a profile it will not be employed.

Always use profile If the image has a profile it will be employed when needed
and passed on with the image (to the output).

CMYK to RGB only Any profile will only be used when changing from CMYK to
RGB color space models.

Use on change color space Any profile will be used when the color spaces are
changed but will not be used in the output.

See the separate section ICC color profiles for more details.

Font replacement If you import PDF or AFP resources (inserted into layout as images) con-
taining fonts that Inspire Designer does not support, this option enables you to replace
them by fonts that Inspire Designer supports.

First you must create a Font Replacement item under the Others node and then assign
the created Font Replacement from the Font replacement combo-box menu.

Example After proofing or running a production you receive error: Font

my_not_existing_font is not embedded. Define substitution in font replacement set-
tings.

For natively imported images, where the Use dynamic variables option is applied, any un-
supported characters with no Font replacement defined, are substituted with the default
font (Arial) and a warning is generated.

Alternative text Selects a variable which will return the alternative text for HTML, Simple
HTML, tagged PDF and TNO outputs.

Alternative text is displayed instead of the image in the case they cannot be displayed,
e.g. due to slow internet connection.

This option works also when using the image as a fill style. For images as line fill styles,
alternative text is not supported.

Note For tagged PDFs, alternative content can be also set via URL target. However, if
both ways are used (via Alternative text and via URL target), setting in Alternative text
is always preferred.

Use image alpha channel If checked, image transparency (alpha channel) will be used.

Any clipping paths in JPEG images are also included in the alpha channel and so unchecking
this option ignores clipping paths as well. For transparent images this option changes the
type shown on the Image tab from RGBA to RGB and disables/enables the Load with
transparency option below.

Use media box If checked, the media box view is used for PDF files that have a media box
defined.

A media box is like an extra margin around the standard crop box that you usually see
when viewing a PDF file, so that the page you see is bigger than needed for the content.

647
7 Layout Module

This extra margin can be defined to whatever size when a PDF is created and it allows
easier manipulation of a page, especially when printing.

If unchecked, the standard crop box is used.

Note

When employing page boundaries definition extracted from a PDF file through the
PDF Data module, make sure, that the reference setting (media box or crop box)
matches the one defined here.

PDF images inserted in versions of PrintNet T prior to 4.2 automatically used media
boxes and will have Use media box checked.

See the overview of the behavior of this option for the PPML output.

Multi-page PS If checked, multiple-paged PostScript files are read correctly allowing you to
select which page will be used for the image via the Page tab.

Runaround transparency Allows the text of a flow to run around and through an image,
filling any spaces where the image's colors have been made transparent.

This results in a wrapping of the text around non-transparent colors in the image, wherever
there is space for the text to fit:

The runaround type Through has to be set either in the properties panels for the Image
Area or any Anchors which hold the image position in the text.

Load with transparency If checked, any transparent color that has been created in images
is detected and used.

This option is disabled if the Use image alpha channel option is unchecked.

Load natively If checked and the image is a native file, it will be loaded as vector objects
with its own coding not as bitmaps (raster images).

As a result, the color space, palette and transparency of the native image are used and,
therefore, the options Color space, Use image alpha channel and Load with transpar-
ency are ignored. Also ignored are the Palette tab and the Transparency tab.

This option may improve color adherence and processing speed. The pros and cons of this
option are described below in the section Native Loading of Images. See also the sections
on Handling of PDF/EPS Images and on Handling of AFP Images for more details.

648
 7.6 Layout Objects

Enable this option to display the optional content of layered PDF images. See the PDF&PS
Import section for details.

Note When this option is enabled, gradients are only imported correctly as gradient fill
styles if the following conditions are fulfilled:

1. The gradient type is linear (referred to as 'axial' in PDF terminology) or radial.

2. The color space is one of the following: DeviceGray, DeviceRGB, DeviceCMYK,

CalGray, CalRGB or ICC-based.

DeviceN and Separation color spaces are not supported and any ICC profiles used
will be disregarded.

3. An exponential function is used (this is only one of the four possibilities in PDF).

Gradients are rasterized and imported as image fill styles for all other combinations.
Gradient types other than linear (axial in PDF) and radial (i.e. function-based shadings,
free-form Gouraud-shaded triangle meshes, lattice-form Gouraud-shaded triangle meshes,
Coons patch meshes and tensor-product patch meshes gradient types which are also used
in PDF) are not supported by Inspire Designer.

Place native image in overlay If Load natively has been employed then you can further
check the Place native image in overlay option to create a separate overlay for the image
to be processed in. It can speed up processing of the job and decrease the size of the
spool file. It is intended to be used when a page is being printed several times, because
then the page will be processed only once.

The pros and cons of this option are described below in the section Native Loading of
Images.

Note If a PDF file is imported natively, check this option only in case that the file contains
pages that will be reused many times (e.g. as background) in the output. In other cases it
is advisable to leave this option unchecked. Inspire Designer does not support overlays
within overlays and by putting this PDF into an overlay the possibility to take the advantage
of overlays within the original PDF would be lost.

Use dynamic variables If checked, text that has been marked as variables in native files will
be matched to variables in Layout.

Text in the native file should be marked in the format <<VariableName>> to indicate that
it is a variable. See the section Variables in Imported Files for more info.

When native files are used as images, the matching of variables is done when the workflow
is processed and so the variable placeholders are not seen as variables in the Layout Area.

To save file processing time, disable the option. This option is also available for native files
imported via Native Import.

This option is available only if the option Load natively (above) is checked.

Note In the ICC Profiles section there is a complex description of how the images with different
settings are handled in Inspire Designer.

649
7 Layout Module

Native Loading of Images

This section summarizes the pros and cons of using the check-boxes Load natively and Place
native image in overlay which are available on the image's Advanced tab.

1. When both options are unchecked:

Pros

The image is rasterized by the PDF library there are no limitations in terms of PDF
functionality.

Images are reused they are only once in the spool file and are placed in the
overlay.

Cons

The image is large encompasses the whole page including borders.

Image format does not enable searching.

Note For variable images, which have no sample image set, these options are not
available and the behavior is the same as if both options were unchecked.

2. When Load natively is checked and Place native image in overlay unchecked:

Pros

Searching for text within the image is possible.

The size of the spool file is smaller, if the image is printed once or just a few times.

Cons

If the image is printed many times, the spool file is larger and the processing slower.

3. When both options are checked:

Pros

The image is always processed only once.

Searching is possible in vector outputs.

The bitmap is smaller, does not include white borders.

Cons

If the image is printed only once, the output file is larger and processing is slower.

If spooled with an engine that does not support text in overlay (e.g. IJPDS, PCL),
searching for text is not possible.

650
 7.6 Layout Objects

Inserting Images and Using Them in Layout

There are several ways to insert images into Layout. You can add them into the Layout Tree,
paste from the clipboard or use the drag-and-drop method. Once added, you can rename the
images, if appropriate. To do so, select in the Layout Tree the image name you wish to change
and press <F2>. Alternatively, click on the Rename icon in the Layout Properties and type
in the new file name.

Adding a Static Image into the Layout Tree Images can be inserted into Layout using the
Insert Image option from the Layout menu (Insert | Insert Image) or the context menu
of the Images family in the Layout Tree. This option opens the Open dialog, where you
can browse through the available drives and view metadata.

Inserting an image means that the image is kept as a separate file and used by the workflow
when it is processed. For this reason it is important to keep track of the location of images
and always keep the path to used images valid. However, there are methods to keep the
image files as part of the workflow (WFD) file:

Include the image files in the WFD file using the Used Files dialog.

Import the images, using the Import icon on the Image tab of the image's
properties, so that they become a built-in component of the Layout module.

Once an image is in the Images family, it can be used throughout the Layout design. Here
are some possible uses:

Place it directly on a page.

Drag the image from Layout Tree and drop it on a page in the Layout Area. For
dragging the image the Selection Tool must be selected. An image used this
way will have its own image area which controls position related properties, e.g.
size, aspect ratio, alignment.

Place it in a flow.

Drag the image from Layout Tree and drop it into a flow area. For dragging the
image the Flow Area Tool must be selected and the image will be attached to
the flow in between existing characters, i.e. at the point of the cursor when the
image is dropped. An image used this way will be part of a flow and flow properties
will apply to it. An image in a flow cannot be resized in Layout but it is possible to
change its DPI (see Use image DPI option on the Image tab).

Place it in an element.

Create an element and drag the image to it. For dragging the image the Selection
Tool must be selected. An image used this way will have its own image area.
The element can then be placed on a page. For more details see the section Ele-
ments.

Use it as a fill style.

For more details see the section Fill Styles.

651
7 Layout Module

Pasting an Image from the Clipboard

1. Right-click on an image you would like to copy to Layout.

2. Select Copy in the context menu.

3. Go to an open WFD file and right-click directly where you want the image on the
page or in a flow area. A context menu will appear.

4. Click on Insert Image from clipboard. The image will appear on the page and
an appropriate node for the image in the Layout Tree will be created.
This method works for images copied from most widely used internet browsers, text and
picture editors or designing tools, e.g. MS Office applications or Adobe InDesign.

For images in PDF documents select the image with a click, then carry on the way described
above.

Tip

To enable copying PDF built-in images from Adobe InDesign select Edit | Prefer-
ences | Clipboard Handling | Copy to Clipboard as PDF in the Adobe InDesign
application.

You can also paste an image from the clipboard into the Layout Tree and then, if
you need to, proceed in the ways specified in the section Adding a Static Image
into the Layout Tree above.

Drag-and-Drop Click on an image and hold the mouse button, then drag it over into the
Layout and release (drop) the image directly where you need it. The appropriate node will
be created in the Layout Tree.

This method works for images coming from various applications, e.g. internet browsers
or picture and text editors.

Note PDF files with the Adobe security feature No Content Copying or Extraction applied
can be inserted into Inspire Designer as images or natively.

For the natively loaded PDF files a warning is displayed in Log Window-Pane informing a user
that copying of the PDF file was forbidden by the author of the original PDF document. Any
further action with such a PDF file is at the user's discretion.

Tip AFP overlays and page segments can also be inserted in layout as images. Note that only
images get displayed, not texts and/or vector graphics in the AFP resources. If you wish to include
these resources into AFP output directly, you need to make them variable by clicking the
Don't place in overlay icon on the Position tab.

652
 7.6 Layout Objects

7.6.21.2 Variable Images

In this section: See also:
Variable Image Layout Properties Images
Image Area
Anchors

Variable images are place holders that are defined to show images only when a specific condition
is met. A number of different images can be assigned to one location in your design, and any
one of them can be shown depending upon the occurrence of an event. This is especially useful
for variable-data printing where many slightly different versions of a design are required to be
printed as one job.

Standard images that have been inserted into Layout can be converted to variable images by
clicking on the Promote to Variable Image button on the Image tab of the Layout Properties
of any non-variable image. This action also creates a copy of the original image in the Images
family in the Layout Tree.

Example If you insert image MyImage and click on Promote to Variable Image,
you will get two images in the Layout Tree:

Variable image MyImage

Clone of the original image MyImage 1"

Also, MyImage 1 will now be selected as the default image for option Sample of the
Image tab of MyImage.

Alternatively, variable images can be created by:

Selecting Insert Variable Image option on the context menu of the Images family.

Defining them in an RTF, DOC or DOCX document template and importing it. See the
separate section Layout Objects from Imported Files.

Variable images can also be used for importing images in binary format. The binary variable
that comes from the input data already contains the image, which therefore does not need to
be stored on the computer. To import an image in binary format, create a variable that will

653
7 Layout Module

return that image's binary data and select it in the Variable combo-box on the Image tab of
the variable image's Layout Properties panel.

Variable Image Layout Properties

The properties of a variable image can be defined on the following tabs:

Image

Page

Transparency

Advanced

The Page, Transparency and Advanced tabs are the same as for non-variable images.

Image Tab

Options Description

Type The type of variable that will be used to select an image.

Select from the combo-box menu:

Select by integer

Select by interval

Select by condition

Select by text

Select by inline condition

Select by content

Variable image

654
 7.6 Layout Objects

For each of the above, the options on the tab will alter. The options that appear for each
of the Select by types are described in the separate section Select by. The options that
appear for Variable Image are described here below:

Variable Selects the variable that controls which image will be used when the workflow is
processed.

The combo-box lists variables that have already been created in your WFD file, in Layout
Tree form.

The variable should return paths to the images that will be used. These are external images
that will not be included or listed as used files in the Used Files dialog. Paths can be absolute
(e.g. Z:\Resources\Images) or relative to the workflow (e.g. Images\), however remember
that the workflow may change location and the images will not show unless they are ac-
cessible via that path. If no path is specified, then the workflow looks for the images in
the same directory as WFDs directory.

Some methods for using a variable to returning paths are: Paths can be read into the
workflow via a data input module; or paths can be created when processing the workflow
using a variable of Kind: Calculated which has a Script tab composed of:

1. A variable of Kind: Constant with a Value describing the path to the directory
with all of the images to be used, e.g. Z:\images.

2. A variable of Kind: Input data variable (read into the workflow via a data input
module) which returns the image name.

3. A variable of Kind: Constant with a Value of the file extension, e.g. .gif. Providing
that all images are the same format.

Example

1. In the Data family of the Layout tree there are the variables:

2. On the Script tab of the variable selected for Variable (here named Variable-
PathToImages), enter the script: return: Path + ImageName + Exten
sion;

Warning If no variable is selected here, no image will appear when this image is used
in a design and it cannot be processed, i.e. a critical error will be shown in the Log window-
pane when the workflow is processed.

Task Selects the variable in which a Media Bin retrieval task is used.

The combo-box lists variables that have already been created in your WFD file, in Layout
Tree form.

For more details see the separate section MediaBin.

655
7 Layout Module

Default image Selects an image that will be displayed if the controlling variable (set for
Variable) does not return an image for the current record.

Sample Selects a sample image so that you can preview the image in the Layout Area and
adjust the other properties of the image as required.

You should insert a sample image of the same file type (with similar size and other prop-
erties) as those images that will be returned by the variable selected for Variable. In this
way you can be sure that all images returned will have a similar appearance. The properties
of the sample image will be adopted by all images that appear as this variable image.

If you created the variable image via Promote to Variable Image button for Image, a
copy of the image that has been promoted will be used as the default for Sample. If

Empty is selected for Sample the place-holder image is used, but this image is
not affected by any properties.

Handling Group Assigns the image to one of 8 possible handling groups.

If set to 0, the image adopts the handling group of the area in which it is placed.

Assigning groups allows different images to be handled in different ways when the
workflow is processed in Production, e.g. dithering properties can be applied differently.

Use image DPI If checked, the DPI (size by Dots per Inch) of any image which is shown in
the variable image will be the images own. I.e., the DPI will be as shown by the Image
DPI property on this tab.

DPI X, DPI Y If Use Image DPI is unchecked, you can alter the DPI of any image shown as
the variable image, by entering values in the DPI edit boxes.

Note When a variable image is placed directly in the Layout Area it is automatically
placed in an image area. The image area has the properties: Preserve aspect ratio;
Stretch and Shrink selected by default. These effect how the image appears in relation
to the size of the image area.

See the separate Image Area section for more details.

Tip Handling Group, Use image DPI and DPI X/DPI Y can be edited for multi-selected
simple and variable images, so you do not have to go through each image and set the option
individually.

656
 7.6 Layout Objects

7.6.22 Image Areas

In this section: See also:
Image Area Layout Properties Images
Variable Images

An Image Area is created when an image is dragged and dropped into the Layout Area to
contain it, control its position and allow other manipulation.

The image area is apparent in the Layout Area because it also has the bounding box like a
FlowArea and it has its own corresponding node in the Layout Tree. Under the ImageAreas
node, the image that it contains will be listed. The purpose of an image area is that it has extra
properties that allow an image to be manipulated on a page.

Note If an image is inserted directly into the text of a flow with the Flow Area Tool switched
on, no image area will be created to contain it.

7.6.22.1 Image Area Layout Properties

The properties of an image area can be adjusted in the properties panel that appears when
the image area is selected in the Layout Area or Layout Tree. It has the following tabs relating
to its attributes:

Position

Runaround

Content

Position Tab
Refer to the separate section Position Tab for details.

657
7 Layout Module

Runaround Tab

The Runaround tab allows the setting of the attributes of the text runaround feature, around
the image area.

Text will actually run around the image itself, whatever properties it has, and not the borders
of the image area. In order to set runaround correctly you have to consider the properties of
the image, the image area and the properties of the FlowArea that contains the text together.
The property Runaround on the content tab of a Flow Area must be set to a value other than
None.

Also important is the position of the image area on the page, i.e. Do you want the text over
the image or the image over the text? You can simply alter which is on top by changing their
order in the Layout Tree; objects further down the branch are in more forefront layers.

Options Description

Note The options available on this tab depend on the setting made in the Type combo-box
at the top of the tab. Therefore, some of the options visible on the screenshot above may not
be available when certain types have been selected.

Type Determines the kind of runaround that will be employed. The combo-box menu offers:

None No runaround settings will be applied and the text will write across the
face of the image.

Selecting None also means that none of the runaround properties that have been
set for the image itself will be applied either.

Example

658
 7.6 Layout Objects

Square Text will runaround the square outer boundaries of the image in a neat
square box.

Example

Tight Text will run close to the outside borders of any shaped image.

Example

Note The screenshot above shows Runaround Type: Tight, Wrap Type:
Both.

Through Text will run close to the borders of any image and, if there are vacant
spaces within outer solid borders, text is able to run there as well, i.e. all free space
is filled with text.

659
7 Layout Module

Example Transparent images with Runaround transparency set will have

text in their transparent holes:

Top and Bottom Text will run above and below the image, not around.

Top Only the text above the image will be shown in the current flow.

Text that follows the images position will be overflowed. Therefore, to see it the
overflow must be set to the next page or flow area.

Note The image used in all of the examples above has been made transparent for 'white'
color range values (RG and B colors: 200-255) and has Runaround transparency set. It
is added to the image area and the image area is placed over the flow.

If a solid border of an image extends over the boundaries of the flow area it is no longer
a solid border to the text. E.g, if one side of an unfilled square is not inside the flow area
then the square will only have 3 lines and not therefore act as a shape and text will fill the
parts of the square that are inside the flow area.

Closer wrapping to an image can be achieved by using the Alignment option of the
paragraph style being used for the text.

Wrap Type Sets on what side of the image the text will be wrapped.

Select from the combo-box menu:

Both The text will wrap on both sides of the image.

Left All text will remain on the left of the image.

Right All text will remain on the right of the image.

Largest All text will appear on the side of the image which has the largest space
inside the flow area.

Margin Sets the amount of clearance between the text and the image on all sides. Enter a
measurement.

Left Sets the amount of clearance between the text and the image on the left side. Enter a
measurement.

660
 7.6 Layout Objects

Top Sets the amount of clearance between the text and the image, above the object. Enter
a measurement.

Right Sets the amount of clearance between the text and the image on the right side. Enter
a measurement.

Bottom Sets the amount of clearance between the text and the image, below the object.
Enter a measurement.

Invert Determines that the text will wrap within the boundaries of the image, instead of
wrapping around the outside of the image.

When the image is filled with text the flow will continue below the image.

Example

Content Tab

The Content Tab options allow you to set behavior of images inside the image area. This feature
is suitable especially for variable images delivered to the image area with different resolution/size.
Each image size/ratio is changed according to options set in the Image Area Content tab.

661
7 Layout Module

Options Description

Preserve Aspect Ratio Preserves the size ratio of the image inserted into the image area.
Width and height values set on the Image Area Position tab are the input values for the
aspect ratio calculation.

The option is checked by default.

Example Below is the original image size.

Below is the changed image area size with the Preserve Aspect Ratio option
checked. The image size has been changed in the direction X.

And below is the changed image size in the direction X with the Preserve Aspect
Ratio option unchecked.

You can see that the original image proportions no longer apply.

Stretch If the image is smaller than the image area, it is stretched to fill the whole space of
the image area.

662
 7.6 Layout Objects

Example The Stretch option is left unchecked for the image area shown below.

You can see that, when we enlarge the image area beyond the size of the image,
then the image area size is larger than the image size.

But the below image area has the Stretch option is checked. If the original image is
smaller than the image area, it stretches to the image area size and original image
proportions no longer apply.

Shrink If the image is bigger than the image area, it is shrunk to fit the size of the image
area.

Example The image area here has been made smaller without the Shrink option
checked.

You can see that the image area size is smaller than the original image size. Overlap-
ping image parts are not cut out and the whole image is printed.

663
7 Layout Module

But for the below image; the Shrink option is checked. If the original image is larger
than the image area, it shrinks to the image area size.

Horizontal align Aligns the image to left, center or right in the image area.

The option is set to Center by default.

Vertical align Aligns the image to top, center and bottom in the image area.

The option is set to Center by default.

Example The option Horizontal align is set to Left, Vertical align to Bottom.

URL target Enables you to select a variable containing an Internet URL. When you print the
document to an output that supports URL links (PDF, HTML, Docx, TNO), clicking on the
object will open the specified URL in a web browser.

Note When you proof a job with a shape that has a URL target set, hover the mouse
pointer over that object in proof to have the URL target displayed.

Clip Image If checked, any parts of the image beyond the image area (number 1 in the
screenshot below) are clipped (number 2 in the screenshot below). You can set the clipped

664
 7.6 Layout Objects

parts (offset) manually using the Pan tool, or define the offset size in the edit-fields just
below.

Offset X / Offset Y Defines the horizontal/vertical offset, measured from the Center, Top,
Right, etc. of the image area, depending on the align settings (in the same tab, above).

7.6.23 Lines
See also:
Shapes

Lines can be drawn in the Layout Area using the Line Tool on the Tools toolbar, click and
drag the mouse pointer to draw the line and use the line's Layout Properties to define the line
style, fill style etc.

However, lines are the same type of Layout object as shapes, i.e. they are shapes that have the
description of a straight and diagonal line on their Path Description tab.

Example The line as drawn:

The path description of that line:

665
7 Layout Module

A line's properties are the same as described in the section Shape Layout Properties

Tip Using the border properties of flow areas as lines instead of Line Tool lines uses less
memory when processing the workflow.

7.6.24 Line Styles

In this section:
Line Style Layout Properties

Line styles are useful when you want something other than a standard simple line. Line styles
allow you to define dash styles, stripes and line beginnings and endings. Line styles are not
only used with lines, but also within shapes, in charts and with border styles.

There are several ways to create line styles for usage with a variety of objects in Layout:

By right-clicking on the Line Styles node in the Layout Tree and selecting Insert Line
Style from the context menu.

For all objects for which you can select a line style in the Line style combo-box you
can also select Create new line style and create a new line style according to your needs.

Select Create new line style from the drop-down menu available in the Path Object
toolbar located just below the Layout Area.

Tip The width and color of lines is not an attribute which can be defined using line styles.
These attributes are defined individually for the objects using lines (e.g. for lines and shapes
on the Content tab of the according properties panel in the Line fill style combo-box and
Line width edit-box).

7.6.24.1 Line Style Layout Properties

The following tabs are available where you can define the properties of line styles:

Dash Tab

Stripe Tab

Endings Tab

666
 7.6 Layout Objects

Dash Tab

On this tab you can define a dash style for the line style you are creating.

Options Description

Begin offset Sets the offset with which the line will begin. The default value is 5 mm.

Example The settings in the above screenshot have been applied to the line dis-
played below (i.e. the visible part of the line is 10 mm wide and then followed by a
gap of 5 mm). Due to the value 5 set in the Begin offset edit-box, the first 5 mm
of the line are not visible, this is why the first visible part of the line is only 5 mm long
instead of 10 mm as all the following parts:

Note The screenshot just above shows how the line style will look when applied
to a line in the Layout Area. The appearance there differs (the first visible part of the
line is shorter) from the preview of the line style in Dash style, as the preview there
does not take the setting made in the Begin offset edit-box into account.

On the contrary, the same line style with Begin offset set to 0 mm would look like
this (all drawn parts of the line have the same length, 10 mm):

Dash style Selects a predefined dash style from the drop-down menu:

If you create a customized dash style by entering values in the Line-gap values area, the
appearance of the dashes set there will be previewed in this field.

Note The setting made in the Begin offset edit-box is not reflected in the preview dis-
played here.

Line-gap values Defines the size of the drawn (solid) part of the line and the size of the gap
which follows it. The line-gap pattern thus created will be repeated when necessary (i.e.
when the line the line style is applied to is longer than the defined line-gap pattern).

667
7 Layout Module

The values in the list define the appearance of the line in the following way:

The first value defines the length of the first solid part of the line.

The second value defines the length of the first gap in the line

A third value (which must be manually added to the list using the Create new
value icon) defines the length of the second solid part of the line.

A fourth value (again, this value must be manually added) defines the length of
the second gap of the line.

You can add as many further values as you wish, they will affect the appearance
of the line in the same pattern as the third and fourth values.

Note If you define only one value, it will specify the length of the solid parts of the line
as well as the length of the gaps.

If you select a predefined dash style from the combo-box just above, the line/gap values
of which this predefined dash style consists will automatically be entered here.

Create new value Creates a new line/gap value in the list.

Delete selected value Deletes the selected line/gap value from the list

Delete all values Deletes all line/gap values from the list, i.e. after using this icon the line
will have no gaps.

Stripe Tab

On this tab you can define a stripe style.

668
 7.6 Layout Objects

Options Description

Stripe style Selects a predefined stripe style:

If you create a customized stripe style by entering values in the Position and Width
columns, the appearance of the stripes set there will be previewed in this field.

Position Defines the position of the stripe. Values from -1 to 1 can be entered. The number
of rows in this list equals the number of stripes the line style will have.

The value 0 means that the middle of the stripe will be positioned on the line/shape position
defined in the Position tab of the line/shape object.

Otherwise, the position is calculated in the following way: the Y position of the line/shape
object + Line width (defined on the Content tab of the line/shape object). For positive
values the line stripe moves upwards / outside of the shape, for negative values it moves
downwards / inside of the shape. On the calculated position there will be the middle of
the line stripe.

669
7 Layout Module

Example This example shows how the line and the line stripe settings influence
the resulting look of the line with stripes.

The settings for the line are as follows:

Line Position tab: X, Y position is 10 mm, 10 mm.

Line Content tab: Line width is set to 10 mm.

The settings for the line style, Stripe tab, are as follows:

Position: 0 for the first stripe, -1 for the second one

Width: 0.5 for the first stripe, 0.25 for the second one

670
 7.6 Layout Objects

The resulting line has two stripes:

The first one with the middle at the line Y position (10), its width is the half
of the whole line width (10 mm * 0.5 = 5 mm).

The second stripe has its middle at the position [10,20]. The Y value 20 is
calculated as: the Y position of the line object + Line width, i.e. 10 + 10. Its
width is one quarter of the line width (10 mm * 0.25 = 2.5 mm).

Width Defines the width of the stripe. Values from 0 to 1 can be entered. The width is related
to Line width set on the Content tab of the line/shape object and is calculated as: Line
width value * Width value, i.e. the Width field sets the ratio of the stripe width to the
whole line width.

Create new value Creates a new stripe value in the list.

Delete selected value Deletes the selected stripe value from the list.

Delete all values Deletes all values from the list, i.e. after using this icon the line will not
be visible at all.

Endings Tab

On this tab you can define styles for the beginning and ending of lines.

671
7 Layout Module

Options Description

Start Selects a style for the beginning of the line. The options are:

End Selects a style for the end of the line.

The line endings available from the combo-box menu are the same as for the Start option.

Size Determines the size of both of the endings that have been selected in the Start and
End combo-boxes.

7.6.25 Messages
7.6.25.1 Messages
In this section: See also:
Message Layout Properties Message Areas
Message Group Layout Properties How to Create Messages
Messages Family Layout Properties

Messages can control elements or flows so that they appear according to a set of conditions.
The intention is that the elements or flows are advertisements and that these advertisements
can be made to appear in any previously unused space on a page.

Messages can also be printed according to conditions such as:

Specify how many times a message can be printed for a certain customer.

Include as many messages as possible to be printed on a limited number of pages with

no extra costs.

Define which messages must be displayed and which may be displayed if there is enough
space.

Create duplexed messages, which can be used, for example, for "cut out" coupons
with related information on both sides.

672
 7.6 Layout Objects

There are three levels of Layout Properties that together control the content and behavior of
the messages:

Message Determines the content of the message and properties that affect the indi-
vidual message.

Message group Assigns properties and rules to two or more similar messages.

Messages family Assigns properties that manage messages as a whole.

The appearance of the messages on a page is controlled by the properties of message areas.

Message Layout Properties

The properties of individual messages have the following tabs:

General

Content

Rules

The properties of multiple messages can be changed simultaneously by selecting them in the
Layout Tree, e.g.:

When doing this, a light-blue color highlighting any option (e.g. Type) indicates that the values
set for the selected messages are currently differing, e.g.

But changing the value now for one message will change that option to the same value for all
selected messages.

General Tab

673
7 Layout Module

Options Description

Id Gives a unique identifier to the message.

When a message is created it is given the same ID as its name in the Layout Tree, e.g.
Message 1, Message 2 etc.

Synchronize id with name If checked, the Id is kept the same as the name given in the
Layout Tree, even if that name is changed.

If unchecked, the ID of the message is independent and will not change if the message is
renamed in the Layout Tree.

Category Assigns the message to a category.

The message can then be printed only in those message areas which also have the same
category value set in the Categories tab in its Layout Properties.

Type Selects the type of the message. Message types are:

Always Prints the message every time that the workflow is processed.

If there will not be enough free space in the message areas of the design then the
workflow will not process, therefore another page must be selected in the Added
page combo-box on the General tab of the Messages family. Then, if messages
do not fit in the usual page order, they will be printed to the added page.

No extra postage Prints the message every time that the workflow is processed,
unless it causes an increase in postage price.

As with Always, this type also requires an Added page to be selected. Postage
price is calculated by the Weight set on the page's General tab and the correspond-
ing prices listed on the Postage Prices tab of the Pages family. Therefore, if the
weight increase caused by printing these messages to an added page results in a
higher postage price then they will not be printed.

Free space Prints the message only if there is space available in the message areas
of the design.

These messages will not be printed to an added page, unless an extra page has
already been added because it was needed for at least one message of Type Always
or No extra postage.

Never The message will not be used.

Priority Sets the priority of the message in comparison to any other messages.

The higher the number entered here, the higher the priority over other messages.

Count Specifies how many times the message will be printed for each record.

Whether a message must be printed the full amount of times is dependant on the Type
selection.

674
 7.6 Layout Objects

Content Tab

Options Description

Front side Selects the element or flow that will be used for the design of the message on
the front side of the page, i.e. in message areas as they are seen on the page in the Layout
Area.
The following two options appear if a flow is chosen:

Front side width Sets a maximum wrapping width for any flow selected in the Front
side combo-box, e.g. entering 40 mm will start a new line when the text is 40 mm
wide.

The flow will wrap at smaller widths, if needed, in order to fit the message area unless
Use all front side width is checked.

Use all front side width If checked, the flow must be the width that is set for Front
side width.

If the value is too wide for the message area then the flow will not be displayed there.

Back side Selects the element or flow that will be used for the reverse side of a message.

Message areas can be designated as duplex so that related messages will be printed on
both sides of a medium. When setting up duplex messages this option must be used in
combination with the Is duplex message area on the Content tab of the message area.

If Is duplex message area is not checked for a message area then this option is ignored.

The options Back side width and Use all back side width appear if a flow is chosen,
they work in the same way here as they do for Front side.

Rules Tab

Rules allow the properties of messages to be modified if certain conditions are met when the
workflow is processed. They can be created in the following way:

1. Click on the Create New icon to create a new rule.

2. Select whether the condition should be positive or negative by selecting either is or not
in the first column.

675
7 Layout Module

3. Click on the 3 Dots icon in the Condition column in order to select when a modi-
fication should occur.

4. Click on the 3 Dots icon in the Modifier column in order to select what kind of
modification will occur if the condition is met.

Options Description

Condition Determines the condition under which the message will be modified.

Clicking on the 3 Dots icon opens the Message Condition dialog. Select from the fol-
lowing conditions in the Type combo-box:

Always Modifies the message according to the action selected in the Modifier
column every time that the message is printed.

If not is set, the message is never modified.

Script Allows a scripted condition to determine the criteria for modification.

The options that then appear in the dialog are the same as for the Script Editor
dialog.

Example MessageTracker.LastCustomerImpression (DT)

If not is set, the condition of the script is inverted.

See the separate section Message Scripting for a list of message related functions.

Campaign impressions Modifies the message every time that it is printed, up

until a certain count, during each processing of the workflow, i.e. the count of
messages is restarted from zero for each job.

Enter the count of prints that should be modified in the Printed at least combo-
box that appears when this option is selected. After the count, the properties of
the message will return to the values set in its Layout Properties.

Example If 3 is entered for Printed at least then on the first, second and
third time that the message is printed (for any job), it will be modified. The
fourth, fifth etc. will not be modified.

If not is set, modifies all messages printed after the count has been reached.

Random Modifies the message at random intervals that are determined by a

probability that is set.

The units of the Probability edit-box are %, e.g. if 25 is entered then the modific-
ation will occur randomly but, on average, one of every four messages will be
modified.

If not is set, the probability is inverted.

676
 7.6 Layout Objects

Total impressions Modifies the message every time that it is printed, up until a
certain total count, i.e. a count that includes every print throughout the message's
history.

This option uses the message tracker (see option Tracker on the General tab of
the Messages family) to check the history and count how many times the message
has been printed, throughout the times that the workflow has been processed.
Enter the count of prints that should be modified in the Impression count combo-
box that appears when this option is selected.

The option Number of days also appears which, if checked, allows you to enter
how far back into the history you want to go.

Example Entering 5 means that the Tracker is read in order to count how
many times the message has been printed during the previous five days from
the current date, e.g. if today's date was 25th of the month then the impres-
sions of 21st-25th would be counted.

Then, if the amount entered for Impression count has not been exceeded
in that period then the message can be printed again.

If not is set, modifies after the count has been reached.

Customer impressions Modifies the message every time that it is printed for any
given customer, up until a certain total count for that customer.

This option uses the message tracker to check the history to count how many times
the message has been printed for each customer. Enter the count of prints that
should be modified in the Impression count combo-box that appears when this
option is selected.

The option Number of days also appears which, if checked, allows you to enter
how far back into the history you want to go. See the example for the option Total
impressions above.

If not is set, modifies after the count has been reached.

Job started range Modifies the message if the job is started within a specified
period.

The options From and To appear in order to set the start date and end date of
this period.

If not is set, modifies at times outside of the defined period.

Listed customer IDs Modifies the message if the entered customer ID corresponds
with the values returned by the variable selected in the Customer id combo-box
on the General tab of the Messages family layout properties.

Modifier Determines the type of modification that will occur to the properties of the message
(as set on the General tab) when the Condition is met. Select from:

Set priority Sets a new Priority for the message.

677
7 Layout Module

Enter the new priority in the New priority edit-box which appears.

Script Allows a scripted modification to be written.

The options that then appear in the dialog are the same as for the Script Editor
dialog. See the separate section Message Scripting for a list of message functions.

Set type Sets a new Type for the message.

Select the new type in the New type combo-box which appears.

Increase priority Increases the Priority of the message by a set amount.

Enter the increment of the increase in the Increase priority by edit-box which
appears.

Multiply priority Multiplies the Priority of the message.

Enter the value of the multiple in the New priority edit-box which appears.

Reset priority Sets the Priority to its original value.

Reset type Sets the message Type to its the original value.

Set random priority Assigns a random value for Priority.

Enter a range of values between which the random value may be generated from
in the From and To edit-boxes which appear.

Set count Sets a new Count of the message.

Enter the value of the count in the New count edit-box which appears.

Reset count Sets Count to its original value.

Increase count Increases the Count of the message by a set amount.

Enter the increment of the increase in the Increase count by edit-box which ap-
pears.

Set category Sets a new Category for the message.

Enter the value of the count in the Category edit-box which appears.

Reset category Sets Category to its original value.

Message Group Layout Properties

A Message Group is for assigning similar properties and rules to two or more messages.

Message groups can be created in the Layout Tree by right-clicking on the node of the Messages
family and selecting Insert Message Group. Once the group is created then messages can
be dragged and dropped into the group or inserted by the context menu option Insert Mes-
sage.

678
 7.6 Layout Objects

The following tabs are available:

General tab

Rules tab

General Tab

Options Description

Limiter If checked, a maximum number of messages to be printed from the group can be
entered in the edit-box to the right.

Message group Selects a source of pre-designed messages that can be read into the workflow
as it is processed.

XML message source Allows you to set the location of an XML file in which
messages are defined their design and Layout properties. The message group
then reads in these XML messages and uses them in the same way as any other
message in the layout design.

A directory and file name must be defined by clicking on the Edit icon.

Note It is not recommended to mix XML source messages and messages that
have been designed in the Layout together in one group, i.e. do not use this option
if there are messages grouped together in the Layout Tree using this group.

Script message source Allows you to script XML messages directly in Inspire De-
signer instead of loading an XML file with defined messages. Use the Edit icon
to script a message source.

The structure of the message source can be loaded using either the Simple Mes-
sage Template (a basic structure) or Read from File Template (a structure allow-
ing you to load an XML file) buttons.

Rules Tab
The options are the same as on the Rules tab for individual messages, but remember that
conditions set for the message group are applied to all messages in the group.

Messages Family Layout Properties

The Messages family is for assigning properties that manage all messages when the workflow
is processed. Clicking on the node of the Messages family opens its Layout Properties.

679
7 Layout Module

The Messages family has two tabs:

General tab

Customer Info tab

General Tab

Options Description

Tracker Selects a message-tracking method. Select from:

XML message tracker Lists all printed messages in an XML file. This file can then
be used as a history of which messages have been printed with which record.

A directory and file name must be defined. Clicking on the Edit icon defines
the path to the message-tracking file. If you do not have an XML file from previous
jobs then entering a name for a new file in the File name edit-box of the Open
dialog determines that the XML file will be created when the workflow is processed.

The XML file is structured using <Person> elements that are created for each cus-
tomer. A customer is identified by the value returned by the variable selected for
Customer id, e.g. any two records that return the same value are counted as the
same customer.

Each <Person> element contains <Message> elements that detail the time at
which that message was printed for that record. If the workflow is processed again
then the additional messages printed will be listed in those same <Person> ele-
ments.

Example

<XMLMessageTracker>
<Person Name="1">
<Message Name="Message 1">
<PrintedTimeMark>2009-06-05T11:01:08+02:00</PrintedTimeMark>
<PrintedTimeMark>2009-06-05T11:29:25+02:00</PrintedTimeMark>
</Message>
<Message Name="Message 10">

680
 7.6 Layout Objects

<PrintedTimeMark>2009-06-05T11:01:08+02:00</PrintedTimeMark>
<PrintedTimeMark>2009-06-05T11:29:25+02:00</PrintedTimeMark>
</Message>
</Person>
<Person Name="2">
<Message Name="Message 6">
...
</Message>
</Person>
</XMLMessageTracker>

The XML message tracking file can then be used by rules created for messages,
e.g. in order to ensure that some messages are only printed a certain number of
times by changing their Type to Never after a certain number have been printed.
See the Rules tab of individual messages.

Script Message Tracker Reads message details from a database and commits
details of printed messages back to the database. The whole process is defined by
a script.

Clicking on the Edit Properties icon opens the Message Tracker dialog where
scripts for retrieving and committing messages from and to a database are to be
written.

The intention is that a script can be used to integrate with an ODBC database that
tracks the complete history of the messages.

Pre-designed initial and commit scripts can be loaded by clicking on the Load De-
fault Script icon in the bottom right corner of the dialog. The initial script reads
messages from a database, the commit script commits only those messages to the
database, which have been printed in the current run (using the getMessage
method). The files from which the scripts are retrieved (DefaultMTInitScript.txt and
DefaultMTCommitScript.txt) are stored in the installation folder and are customiz-
able.

Note Messages will only be committed to the tracker if Commit printed messages is
checked.

Logging Determines whether a log of printed messages will be produced.

Selecting Text message logger from the combo-box will produce a TXT log file when the
workflow is processed.

Logging lists the messages that were printed for each customer (the customer is identified
by the variable selected for Customer id). For each message there is a brief summary of
the settings (i.e. Id, Type, Priority and Count from the message's General tab) and a
count of how many times the message has been printed for that customer (titled custom
er impressions in the log) and how many times the message has been printed in total
(titled impressions).

A directory and file name must be defined. Clicking on the Edit icon defines the path
to the message-logging file. If you do not have an TXT file from previous jobs then entering

681
7 Layout Module

a name for a new file in the File name edit-box of the Open dialog determines that the
TXT file will be created when the workflow is processed.

The log is only intended for logging a single production job. If the same file is used when
the workflow is processed more than once, then the previous content of the log is over-
written.

Customer id Selects the variable that will be used to identify the customer records in the
Tracker and the Logging file.

Added page Adds a page for each record that has messages that should be printed, but
were unable to be printed because of a lack of space message areas of the design.

An added page must be chosen here if there will not be enough space and the message
Type is set to Always or No extra postage on the General tab of any individual message.
If no page is chosen for these messages, then the workflow will not process.

Duplex type Selects the duplex method for the added pages:

Horizontal

Vertical

Commit printed messages If checked, all messages that are printed will be listed in the
Tracker when the workflow is processed.

The intention of this option is that it should be checked only when using the workflow
for production so that messages are tracked properly. But also that it can be switched off
while designing so that, for example, proofing the workflow does not add anything to
the log.

Debug mode Previews the positioning of messages inside message areas when the workflow
is processed.

The intention is that this option is used for proofing the workflow. When the workflow
is processed the unused space in message areas is clearly marked on the resulting sheets
and this information can be used for assigning better messages to this area so that less
space on the page is wasted.

When checked, the following options are made available:

Boundary outline Selects are color to mark the boundaries of the message areas after
they have been resized because of the Influence messages option being set for
other objects on the page.

Grid outline Selects a color to mark how the message area has been divided up into a
grid for messages display.

682
 7.6 Layout Objects

This only makes marks when Grid has been chosen for Placement type on the on
the Content tab of the message areas used.

Space outline Selects a color to mark any space that is left over in the message areas
which could be used if different size messages were used.

In cases where there are still messages that could be fitted to the page if there was
enough space, it outlines where those remaining messages would have been placed.

Customer Info Tab

This tab is for linking the variables in different Layouts to a common expression that can be
used in the scripts that define message rules. For more details on rules see the Rules tab for
individual messages.

Example There are three different Layout modules that are using variables to read the
value of a ZIP code:

1. The first has the ZIP returned by variable "Post".

2. The second has the ZIP returned by variable "Zip".

3. The third has the ZIP returned by variable "Code".

But all three variables are assigned to customer info Index 1 in their respective modules.
Then CustomerInfo1 can be used in any scripts created in the Message Condition
dialog that can be opened via the Rules tab of messages or message groups.

Options Description

Index Assigns an index number to the corresponding Variable, e.g. 1 creates expression
CustomerInfo1 for use in script.

Variable Selects the variable that will be referred to by the created CustomerInfo expres-
sion.

Move Up / Move Down Moves the row up or down.

Create New Adds a new customer info row.

Delete Removes the selected row.

683
7 Layout Module

7.6.25.2 How to Create Messages

In this section:
Creating a Duplex Message
Assigning Message Categories

There are different types of message available: Always, No extra postage and Free space. Of
these, free-space messages are the most commonly used and are the default type. One method
to create a free-space message is as follows:

1. Design an element in Layout, e.g. draw a flow area on it, add some text to the flow,
e.g.:

For the purpose of this example, the above element looks like this:

2. Right-click on the Messages family in the Layout Tree and select Insert Message.

3. Select the message that is created and, on its General tab ensure that Free space is
selected in the Type combo-box.

4. On the message's Content tab, select the element that you created in step 1 in the
Front side combo-box.

You have now created a message. In order to place messages on the page you must
use a message area.

5. From the Tools toolbar, select the Message Area Tool . Then drag the mouse
pointer across the page in the Layout Area to create the message area. The area should
be larger than the message, i.e. larger than the element that you created in step 1.

You have now created a message that will appear in a message area when the workflow
is processed. Because you only have one message then it will be that message that
appears.

However, one purpose of messages is to only appear if some free space is left on the
page by another object, typically a flow area that has not been completely filled by its
flow. To see this demonstrated properly you need to position the message area over a
flow area which contains a flow of variable length, e.g. pages repeated for different
customers with different amounts of text being printed for them.

684
 7.6 Layout Objects

If you have such a flow area, redraw the message area so that it overlaps that flow
area, e.g.:

6. Select the flow area and on its Position tab set Influence messages.

7. Process the workflow (Proof or Production) in order to see the message appear, e.g.:

Notice that the message is not placed in the top-left of the message area (which is its
default position) because the flow has already filled this part of the page. Instead it has
been moved to the first possible point to fit after the flow.

In fact, if you make the message area the same size as the flow area, then no messages
would appear at all if the flow area is filled by text from the flow.

Creating a Duplex Message

A duplex message is one that will appear on both sides of a medium when the layout design
is printed. To create a duplex version of the message created in the previous example, follow
the steps above with the following additional selections:

In step 4: On the message's Content tab, also select an element in the Back side combo-
box.

In step 5: When the message area is drawn, go to its Content tab and check Is duplex
message area.

Only one message area is required on the front side of the page. The page that is to be printed
on the reverse side of the duplex should also have unfilled space in the position that corresponds
to the message area on the front side.

685
7 Layout Module

Assigning Message Categories

Message categories enable you to identify which messages should be shown in which specific
places in the design. Each message is given a category number and when you draw a message
area you assign which categories of message are allowed to be shown in that area. This can
be used, for example, to distinguish between messages of different prices (a message on Page
1 is charged more than others) or perhaps messages of different sizes or subject matter.

To assign categories when creating messages of the type in the previous example, follow the
steps above with the following additional selections:

In step 1: Repeat that step to create differently designed elements, e.g. three elements.

In step 2: Repeat that step to create a the same number of messages as you have ele-
ments.

In step 3: Also assign differing numbers in the Category edit-box on the General tab,
e.g. 1 to the first message, 2 to the second message and 3 to the third message.

In step 5: Repeat that step to create more than one message area, e.g. two message
areas.

Then go to one of the message areas' Categories tab and add rows by clicking on the
Create New icon. In those rows assign some of those same numbers that you as-
signed to the messages, e.g. 1 and 3.

Then go to the other message areas and assign the remaining message category numbers
to them, e.g. assign 2 on the Categories tab of the second message area.

Notice that, when the workflow has been processed, any single message design will only appear
if that message's Category number is assigned to a particular message area's Categories tab.

7.6.25.3 Message Scripting

See also:
Messages

Here are listed some specific message related functions that can be used in any script that is
written in the Message Condition dialog, which can be opened via the Rules tab of messages
or message groups.

686
 7.6 Layout Objects

Message Condition Type Script Methods Description

Syntax Return Description

value

Category String Assigns a Category to the message.

CustomerId String Returns the value of the variable assigned to Customer id.
CustomerInfo1 String Returns the value of any variable assigned to Index value 1
on the messages family Customer Info tab.

CustomerInfo2, CustomerInfo3 etc. can also exist if

set on that tab.
DefaultCat String Returns the Category value as set in Message Layout Prop-
egory erties.
DefaultCount Int Returns the Count value as set in Message Layout Properties.
DefaultMes Mes- Returns the message Type as set in Message Layout Proper-
sageType sage- ties.
Type
DefaultPrior Double Returns the Priority value as set in Message Layout Proper-
ity ties.
MessageLogger Calls the Logger if it has been selected General tab for the
Message family.

This is used with logMessage method, e.g. MessageLog

ger.logMessage() in order to commit an additional entry
about the message to the logger.
MessageTrack Calls any tracking method set up for the Tracker option on
er the General tab for the Message family.

See also the MessageTracker methods below, which lists the

methods to be used with this, e.g. MessageTracker.Las
tImpression.
MessageType Mes- Sets message Type (Always, NoExtraPostage, FreeSpace,
sage- Never).
Type
Message Mes- Lists message types.
TypeEnum sage-
Type
Priority Double Sets Priority.

Most of the options mentioned in the Description column are described in the section for the
individual message's General tab.

687
7 Layout Module

MessageTracker Methods

Syntax Return Description

value

AllCustomerImpressionCount Int Returns how many impressions a client

has received.
AllImpressionCount Int Returns how many impressions all cli-
ents received.
CampaignImpressionCount Int Returns the number of impressions for
a campaign.
CustomerImpressionCount Int Returns how many times a client has
received a specific message.
CustomerImpressionCountin Int Returns how many times a client has
TimePeriod [DateTime aS received a specific message within a
tartDate] defined time period.
LastCustomerImpression DateTime Returns when is the last time a client
has received a specific message.
LastImpression DateTime Returns when is the last time a specific
message has been sent.
TotalImpressionCount Int Returns the total count of specific
message.
TotalImpressionCountin Int Returns the total count of specific
TimePeriod [DateTime aS message within a defined time period.
tartDate]

The following special methods can be used with the script message tracker feature for reading
and writing messages from and to a database. An example script using these two methods
can be loaded in the script definition dialog.

Syntax Return Description

value

Void Reads a message from a database. The

addMessage (String aPer
parameters define record sets from
sonId, String aMessageId,
DateTime aPrintedTime) which the values are taken.

Bool Returns true for messages which have

getMessage (Int aMessageIn
been printed in the current run. These
dex, String & aPersonId,
String & MessageId, Date messages can, for example, be later
Time & aPrintedTime) written to a database to keep track of
what messages were printed for which
customer.

688
 7.6 Layout Objects

7.6.26 Message Areas

In this section: See also:
Message Area Layout Properties Messages
How to Create Messages

Message areas define spaces on a page where messages can be shown. Whether a single
message or many messages will appear in a particular message area depends on the properties
of the messages themselves or the properties of other overlapping objects (e.g. flow areas) on
the page.

To create a message area:

1. Click on the Message Area Tool .

2. In the Layout Area, drag the mouse pointer to create the message area.

Note The message area is rectangular but the shape and size of any message used
in the area is dependent upon the content of the message itself.

3. Edit the Message area's layout properties.

7.6.26.1 Message Area Layout Properties

The following tabs are available:

Position Tab

Content Tab

Margins Tab

Categories Tab

Position tab

Options Description

Influence messages If selected, the message area will have any unused space made
available for messages from other message areas.

If this message area has space left unfilled by its messages, and this space is also covered
by another overlapping message area, then that other message area will be able to place
messages into this free space.

Further to this option, this message area (the one with Influence messages set) must
have the Hor. alignment set to Left and Ver. alignment set to Top on the Content tab.
Also, the messages that will be displayed in the area must be lower in the Z-order within
the Messages family of the Layout Tree, so that they will be processed before those in the
other message area.

689
7 Layout Module

Refer to the separate section Position Tab for details of all other options.

Content Tab

Options Description

Priority Sets the priority of the message area.

The priority is evaluated when a workflow is preprocessed. This ranks the message area,
so that one message area can be defined as more important than others, therefore allowing
the most important messages to be shown in a particular area first, wherever that message
area is in the Layout design.

Influence type Selects the sides ( Left, Top, Right, Bottom) from which the message
area can be influenced.

If an object has Influence messages set on its Position tab, then the message area
can be influenced by that object, i.e. if that object has content that overlaps the message
area then messages will not be shown over that content.

Example

1. For this screenshot of the Layout Area, there is a flow area containing Flow1
(top) and a message area that overlaps it (below):

690
 7.6 Layout Objects

The flow area has Influence messages set on its Position tab and the
messages that are assigned to the message area are much smaller than the
area itself.

2. If only Left is chosen for Influence type, the result in Proof would be:

3. If the all sides are chosen for Influence type the result in Proof would be:

Notice that when only Left is chosen (screenshot 2) then the message is placed to
the right of Flow1. This is the first available space for a message from the message
area's left border.

However, when all sides are chosen (screenshot 3), two messages are placed to the
bottom of Flow1, i.e. even though Left is also chosen here, the messages are
placed as if the message area was being influenced from the top. This is because
when an area is influenced from two or more sides then it uses the influence that
enables it to show the most messages.

Placement type Sets the formation of messages within the message area. Select from:

Grid Divides the message area into equally sized cells so that one message can
be placed in each cell.

The size of the cells is calculated to accommodate the messages with some space
between them. The grid cells are filled until all assigned messages are displayed.

Row Fills the message area row-by-row with messages.

The messages are placed side-by-side across the width of the message area. How
many messages fit into one row depends on the width of the messages themselves.
If the size of the message does not allow an exact fit to the area width then the
next message will be shown on the next row. The number of rows in an area,
again, depends on the height of the message.

691
7 Layout Module

The rows are filled until all assigned messages are displayed.

If the message area is not large enough for all of the messages then only those that fit
will be shown.

Grid X / Grid Y Define how many cells the message area will contain in the X / Y direction.

These options are only available if Grid is selected for Placement type.

Hor. alignment / Ver. alignment Align the messages to the selected border of the message
area.

In effect, this manages the space left over from messages that do not fit the area perfectly,
e.g. if Center is selected for either option, equally sized spaces will occur between the
messages and the opposing borders.

Is duplex message area If checked, the message area will be duplex.

The intention is that the same messages will be shown in the same position on the reverse
side of a medium. Messages can also have two sides so the actual content can be different
on either side of the medium.

For this to work, two pages must be created and arranged as duplex by impositioning
(e.g. Duplex type in the Output module) and the messages to be displayed inside the
area should also be duplexed by setting content for both the Front side and Back side
on the messages' Content tab.

Margins Tab

Options Description

Left / Top / Right / Bottom Set distance between the messages and the content of other
objects that influence the message area.

692
 7.6 Layout Objects

Example

1. The screenshot below is part of a design in the Layout Area. It shows a flow
area with Flow1 as content (top) and a message area (below):

The flow area has Influence messages set on its Position tab and the
message area has the Top margin set to 10 mm.

2. When the design is proofed, the following screenshot results:

Notice how a 10 mm margin has been placed between the content of the flow area
and the messages, even though the two areas overlap in the design.

Hor. space / Ver. space Set distance in between individual messages (to the right / bottom
of each message) if more than one message appears in the area.

These options are only available when Row is selected for Placement type.

Categories Tab

693
7 Layout Module

Categories determine which messages will appear in the message area. They are especially
useful when multiple messages are to be printed.

Example Two different types of messages are to be printed on a document:

1. One set of messages is smaller and pertains to a particular topic.

2. The second is larger and relate to an entirely different topic.

By creating two categories (1 and 2) and assigning them to the different messages, you
can identify which messages should be displayed in which message area.

Options Description

Create New Adds a new category row to the table.

Once a row has been created, it can be selected and a category value can be entered.
Each value should correspond to a value given for the Category option that is assigned
to a message on its General tab.

Delete Deletes the selected category.

7.6.27 Others
Others family node enables you to insert additional Layout objects. Like the other layout objects
that represent the components of the sheets of the layout design, each object from the Others
node has also a set of properties that define its functionality. Right-click on Others and select
the object you want to insert.

For a description of each of these objects click on the link below:

Table of Contents

Business Rules

Sections

Font Replacement

Wrapping Rules

Information on the other right-click options can be found in the Layout Tree Context Menus
section.

7.6.27.1 Table of Contents

A table of contents can be generated automatically from the text in your layout by using pre-
defined paragraph styles as markers of chapters and sections. It can be placed before or after
the document depending on what you set for Placement and can have separate page num-
bering and its own text style.

See also: How to Generate a Table of Contents.

694
 7.6 Layout Objects

After selecting the added Table of Contents in the Layout Tree the Layout Properties panel
appears and you can edit the Table of Contents using the three tabs:

General

Content

Text Styles

General Tab

Options Description

Placement Selects where the table of contents are using the combo-box menu. Options are:

Front Placed at the beginning of a document.

Before white space Placed before the white space used for message management.

After white space Placed after the white space used for message management.

Condition Selects when the table of contents will appear using the combo-box menu which
shows conditional variables (Boolean variables) from the Layout Tree. Selecting a variable
defines that the content table will show when that variable returns True.

Page Selects which page the table of contents will be placed on using the combo-box menu
which lists all existing pages or enables you to create a new page for it.

Content Selects which flow the table of contents will be placed in using the combo-box
menu which lists all existing flows or enables you to create a new flow.

Use local numbering If checked, the pages containing the table of contents are not included
into the page numbering displayed in the table of contents. This means that if a job has
a total number of 10 pages of which 2 pages are the table of contents then:

System variable PagesPerRecord will consider only 8 pages of the job excluding the
Table of Contents pages.

System variable PageCounter will count the job pages from 1. Table of Contents
will be counted e.g. from 1 to 0.

695
7 Layout Module

For separate content counting it is also recommended to use System variables:

PageSubCounter

PagesPerSubRecord

With links If checked, entries in the table of contents will be linked to the according headers
in the text. When the document is proofed or a PDF is created out of it, clicking on an
entry in the table of contents will take you to the page where the according header is
displayed in the document.

Content Tab

The Content tab defines which paragraph styles will be used as markers for the creation of the
table of contents.

Options Description

Reference Para Style Lists the paragraph style(s) from which the table of contents is gener-
ated, i.e. those styles which, when they are detected in any flow, will be read into the
table of contents. All of the text in one instance of that style will become an entry in the
table of contents.

Select a style from the existing styles displayed in the drop-down menu or select to create
a new paragraph style.

Presentation Defines the target paragraph style how (in which paragraph style) the text
of the chosen (reference) paragraph style will be actually presented in the table of contents.

Note Do not select the same paragraph style for both Reference Para Style and
Presentation it can cause problems, e.g. with numbering.

Go To Takes you to the actual style and displays its properties panel. This allows you to
edit the properties of that style.

To return back to this Table of Contents properties panel after editing the paragraph style
you must navigate using the Layout Tree.

Create New Creates a new row for the definition of a paragraph style to be used for
generating the table of contents.

Delete Removes the selected definition row.

696
 7.6 Layout Objects

Text Styles Tab

The Text Styles tab defines which text styles will be used for the creation of the table of contents.

Options Description

Reference Listed in this column are text style(s) that are used in the paragraph styles based
on which the table of contents is generated and that should be changed to the presentation
text style(s) for displaying in the table of contents.

Example If a Reference Para Style is found and the text style (Reference) in which
it is written contains font size 20 and blue color, you will set a new text style in
Presentation text style if you want your table of contents be written in font size 16
and black color.

Presentation Defines the target text style how (in which text style) the text of the chosen
(reference) text style will be actually presented in the table of contents.

Go To Takes you to the selected style and displays its properties panel.

This allows you to edit the properties of that style. To return back to this Table of Contents
properties panel after editing the paragraph style you must navigate using the Layout Tree.

Create New Creates a new row for the definition of a text style.

Delete Removes the selected definition row.

7.6.27.2 Business Rules

Business rules are imported from the external Rule Editor, the application in which they are
defined. When the rules are re-imported, the content of condition variables is updated instead
of creating new variables.

See the Rule Editor documentation for information about using Business Rules.

7.6.27.3 Sections
Sections are for multi-column composition. They display the flow in columns of a determined
width so that, for example, you can have three columns of text inside a single flow area.

To add a section to the Layout, do either of the following:

Right-click on the Others family and select Insert Section from the context menu. A
new section will be displayed in the Layout Tree.

697
7 Layout Module

With the Flow Area Tool and Show hidden characters selected, drag and drop
the new section from the Layout Tree into the flow.

The section must be the first character in the paragraph.

With the Flow Area Tool and Show hidden characters selected, select the
point just before the first character of a paragraph. Then go to the Layout Window
menu and select Insert | Insert Section or right-click and select Insert Section.

The following tabs are available for a section's Layout Properties:

Columns tab

Advanced Tab

Columns Tab

Options Description

Type

Custom Enables you to set the column and gap width.

Automatic column width Sets the column width automatically.

Automatic gutter width Sets the gap width between individual columns automat-
ically.

Equal columns If checked, all the columns will have the same properties (width, gap, border
style)

Gutter Sets the gap width between individual columns.

Border Style Sets the border style for each column of the section.

Go To Finds the selected border style in the Layout Tree.

Create New Creates a new column.

Move Up / Move Down Changes the column sequence.

Delete Deletes a column.

698
 7.6 Layout Objects

Balancing Determines whether the columns should have their lengths automatically balanced.
Select from:

Balanced The lengths of all columns will be made the same number of lines.

First column biggest The length of the first column will be allowed to be longer
and any others will be balanced.

Unbalanced No balancing will be performed, i.e. columns will be filled as they

been written.

Line width Sets the width of the line in between columns.

Fill Sets the fill of the line in between columns.

Go To Finds the selected fill style in the Layout Tree.

Force first column biggest Makes the first column the biggest in the case of multi-column
composition.

Example
This example shows that it is possible to combine a double-column section with a single-
column section in one flow. The text contained in the sections (also in individual columns)
is balanced. You can allow the flow to overflow into another flow. The sections' layout
will be kept.

Legend

1. Section 1

2. Column 1 of the Section 1

3. Gutter in between the columns with a line

4. Column 2 of the Section 1

5. Section 2

699
7 Layout Module

Advanced Tab

Options Description

Border style Sets the border style for the section.

First header Selects an anchor that will be inserted in the "first header" position of a section.

The combo-box menu reveals a list of already created anchors in a truncated layout tree
form. The menu also contains the Create Anchor item. Selecting this will create a new
Anchor node. You can subsequently click on the Go To icon to move to that node in
order to set its properties. The same procedure applies to the three following options.

First footer Selects an anchor that will be inserted in the "first footer" position of a section.

Header Selects an anchor that will be inserted in the "header" position of a section.

Footer Selects an anchor that will be inserted in the "footer" position of a section.

Example This example shows how to use anchors in a section for managing
headers and footers of a text overflowing to more pages.

1. Create a flow area on a page.

2. Create a section and drag it to the flow area. Enter the desired text in the
section.

3. Perform the settings necessary for overflow; i.e. variable page selection, page
overflow.

4. Using the options on the Advanced tab of the Sections Layout Properties
dialog create anchors for the first header, first footer, header and footer po-
sitions.

On the anchors' Layout Properties panels, set the position and runaround
values and attach (create) elements containing the desired text.

Your layout may look this way (Flow Order tool activated):

700
 7.6 Layout Objects

5. When you proof the job, multiple pages will be generated. See below the
Sheet Proof view of the job. Note the difference between the first sheet and
the second sheet (overflow).

Page break If checked, the whole section's content will move to the next page in the event
of overflow.

Go To Finds the selected border style or anchor and displays its properties panel.

7.6.27.4 Font Replacement

If you import files or images containing fonts that Inspire Designer does not support, this option
enables you to replace them with supported fonts.

701
7 Layout Module

To add a font replacement item, do the following:

1. Right-click on the Others node in the Layout Tree and select Insert Font Replacement
from the context menu. A new sub-node (FontReplacement 1) will be displayed under
the Others node in the Layout Tree.

2. In the Font Replacement Layout Properties panel click on the Create new icon to
insert a new item.

You can define as many pairs (font to be replaced replacement font) as required. You can
copy and paste values within the current column.

Note

If the Name field is left empty, the set compatible font will replace all unsupported
fonts for which there is no dedicated font replacement pair defined. If such a font re-
placement with the empty Name field is used for HTML content import via external
flow, the default font will be replaced by the one selected in Font and the rest of the
columns will have no effect.

When defining font replacement for natively imported AFP files, set the Encoding to
ibm-500 or a similar encoding from the EBCDIC family.

When importing PS or EPS files natively, the fonts not embedded in them are embedded
or replaced in Normalizer (during the internal conversion to the PDF format) and any
font replacement set here to be done by Inspire Designer has no effect.

After setting the font replacement it is necessary to assign it in the Font replacement combo-
box in the Layout Properties of the appropriate external flow or image.

7.6.27.5 Wrapping Rules

Wrapping Rules allow to organize and save customized settings for text wrapping. It is meant
mainly for those Asian languages, where spaces are not used. Individual characters are prevented
or allowed at the beginning or the end of lines. There can be as many wrapping rules as needed.
Once created, it is possible to switch between the wrapping rules in the Text Styles Layout
Properties, in the Rules tab.

Note The Enable wrap anywhere option for paragraphs has a priority over any wrapping
rule. If you want to apply a defined wrapping rule, be sure to set this option to No.

702
 7.6 Layout Objects

Layout Properties Panel Wrapping Rules

To create a wrapping rule, right-click on the Others node in the Layout Tree, select Insert
Wrapping Rule from the context menu. When a Wrapping Rule node is selected, the appropriate
Layout Properties panel shows:

Options Description
Icons at the top of the panel are described in the Layout Properties Toolbar section.

Edit Rules Clicking on this buttons opens the Wrapping Rules Editor.

Character(s) prevented at line beginning This field displays characters prevented at the
line beginning within the Wrapping Rule selected in the Layout Tree.

703
7 Layout Module

Wrapping Rules Editor

After clicking on the Edit Rules button on the Wrapping Rules Layout Properties panel, the
following dialog opens:

Options Description

Select plane The 17 numbered planes (number 1 in the screenshot above) mirror the Unicode
mapping of characters. When you hover the mouse pointer over a plane, a tool-tip displays
the range of characters included in the indicated plane. The currently selected character
plane is marked white. Clicking on a selected rectangle displays two panels below the
planes. Code subsections are on the left, individual characters on the right.

Select code subsection When a character plane is selected, the appropriate plane subsection
is displayed (number 2 in the screenshot). Each rectangle (number 3 in the screenshot) in
that panel represents a page (number 5 in the screenshot). Blue, red and/or green bars in
each rectangle indicate roughly the amount of characters prevented at the beginning of
a line, at the end and both, accordingly (see the Key at the bottom of the dialog; number
4 in the screenshot). A clear rectangle means that all characters within that page are allowed
in any position.

704
 7.6 Layout Objects

Right-click on a page to edit the prevention type for all characters in that page. The options
are:

Prevent characters at line beginning Disallows all characters within the selected page
at the beginning of lines.

Prevent characters at line end Disallows all characters within the selected page at the
end of lines.

Allow characters Allows all characters within the selected page both at the beginning
and at the end of lines. This option is here because there are some characters disal-
lowed by default.

For easier orientation in the subsections, a tool-tip appears when you hover the mouse
pointer over a rectangle. It displays the range of characters that the page includes, the
number of characters prevented at the beginning and/or the end of lines.

Set prevention type This pane shows individual characters included in a character page
(number 5 in the screenshot).

Right-click on the required character (or multiselected characters; number 6 in the

screenshot) in the Set prevention type panel and choose one of the available options
from the context-menu.

Prevent characters at line beginning Disallows to place the selected character(s) at

the beginning of lines.

Prevent characters at line end Disallows character(s) at the end of lines.

Prevent characters at line beginning and end Disallows character(s) both at the be-
ginning and at the end of lines.

Allow characters Allows character(s) both at the beginning and at the end of lines.

Open Imports a wrapping rule from a previously saved file.

Save Saves the wrapping rule into a file in the XML format.

For easier orientation among the characters, a tool-tip appears when you hover the mouse
pointer over a character. It displays the indicated character, its hexadecimal value and its name
with a short description.

7.6.28 Pages
In this section:
Pages Family Layout Properties
Pages Family Context Menu
Individual Page Layout Properties
Individual Page Context Menu

Pages provide the space on which objects are placed to create the design of a document. The
Pages family is the second node from the top in the Layout Tree.

705
7 Layout Module

Each individual page also has its own node which appears in the Pages family. Thus, always
keep in mind that there are two levels of Layout Properties associated with pages:

1. One for the Pages family that controls all pages as a group.

2. One for each individual page that sets the parameters of that single page.

The structure of the Layout Tree under the Pages family plays an important role in determining
how the layout design will be processed:

The order of the individual pages under the family is the order in which the pages will
be processed, unless otherwise selected in the Page order combo-box in the Pages
family properties.

Once objects are placed on a page, they are also represented under that page in the
Layout Tree, e.g.:

This is the same instance of the object, just also made visible here to represent the
contents of each page. The order in which objects are displayed is the Z-order, i.e. the
order in which those objects will be processed.

The Z-order can play an important role in optimizing a workflow for smaller size and
faster production.

You can create new pages by the following methods:

Go to the Layout menu: Page | Insert Page.

Right-clicking in the Layout Tree and selecting Add New Page from the Page Family
context menu or Insert New Page from the Individual Page context menu.

Clicking on the Create New icon on the Page toolbar.

When creating pages, you should rename them as the default names (e.g. Page1, Page2, etc.)
do not reflect page order.

Example If you create three pages without renaming them and then delete the middle
one, the Layout Tree will display Page1 and Page3.

706
 7.6 Layout Objects

7.6.28.1 Pages Family Layout Properties

The Pages Family Layout Properties has the following tabs:

General Tab

Viewing Sequence Tab

Sheet Names Tab

Postage Prices Tab

General Tab

The appearance of the General tab varies according to the selection made in the Page order
combo-box which specifies the method of page selection.

Both the Main flow and the Main object combo-boxes (described separately below the de-
scription of the Page order variants) are common to all selections possible in the Page order
combo-box, for descriptions of the other options see the appropriate description of the Page
order option.

Options Description

Page order Determines the order in which the pages will be processed.

There are the following types:

Simple Processes the pages in the order that they appear in the Layout Tree.

Variable selection Processes the pages in an order that is determined by a variable.

Repeated by Selects which variable will be used to repeat the whole set of pages.

By default, Empty is selected and the page repetition is controlled by the array-
type variable that is controlling reading of the data (selected for the option
Records by on the Data tab of the Data family). However, it might be required
to have an alternative repetition to the complete set of data, e.g. when there
are arrays within that set of data.

Select an array or an integer variable from the combo-box menu. Every time
a new value is returned by that variable, the page order will start again.

707
7 Layout Module

Example A single customer of a bank can have many accounts. When

designing a bank statement you want to use all of the customer data
(Name, Address etc.) but you want to repeat the pages of the design for
each account (if there is one bank statement design for every account)
and not just each customer.

In this example the data structure could look like this:

In the above screenshot the data has been combined in a one to many
relationship (one customer to many accounts) and there is an array called
Accounts. To repeat the set of pages for each account, select Accounts
in the Repeated by combo-box.

See the sections How to Use System Variables (where this field is shown for
each sub-record), How to Create Image Page Counter (where an integer vari-
able is used in the Repeated by combo-box) and How to Repeat Layout Ob-
jects by Integer Variables.

Type Selects the method by which the first page in the page order will be selected.

If Simple is selected, select the page in the Start page combo-box which ap-
pears. The other selections here are types of variable selection which allow
the page to be selected by condition. If one of these methods is selected,
other options will appear. See the Types of Variable Selection section for details.

Data variable selection

Orders the pages according to the value returned by a variable of string data-type.

Variable Selects the variable.

The variable should return the page order as a list of indexes for the pages.
The index of pages is zero-based, i.e. the first page in the Pages family of the
Layout Tree is 0, the second page is 1 etc.

A value of -1 inserts an empty page.

708
 7.6 Layout Objects

Example If the variable returns 0,1,2,-1,0,1,3, the page order will be:
1st page in the Layout Tree, 2nd page, 3rd page, an empty page, 1st
page, 2nd page and then 4th page.

Note It is not recommended to use Data variable selection in combination

with pages containing flow areas with Flowing to next page selected (on
the Content tab of the Flow Area layout properties), as flow order may not
be well defined.

Main flow Defines the flow that will be used if producing the workflow with the HTML
Simple engine or the Text engine.

With those engines, only the main flow is printed and all other objects on the page are
ignored.

Main object Defines the object (flow or element) in an external workflow that should be
used when the workflow is referenced from a master workflow. See the How to Export
Design Parts for Usage on Web section for more information.

Viewing Sequence Tab

The Viewing Sequence tab is used for reordering the sequence of pages contained in a layout.
The sequence defined here applies only to Layout, not to the actual page order that will be
printed when processing the workflow.

This tab is available only when Variable Selection or Data Variable Selection is selected on the
General tab.

Example You have a page with an overflowing flow area and you want to see how this
overflowing is set in the Layout. You can define a page sequence for Layout on this tab
and then use the arrows on the Page toolbar at the bottom of the Layout window
to see the next page. This viewing sequence is independent from Proof or
Production - it displays only in Layout. Thus, you can define a page sequence in Layout
that is completely different than the real page sequence used when printing or proofing.

Options Description

Move Up / Move Down Moves the selected row up/down.

Create New Creates a new row in the list of pages.

Delete Deletes the selected row in the list of a pages.

709
7 Layout Module

Add Page Into Sequence Dialog

The Add Page Into Sequence dialog is displayed when editing a flow on a page and the cursor
gets outside of the range of the flow area (e.g. you select a long text which does not fit into
the flow area by pressing <Ctrl> + <A>). It selects a page into the viewing sequence instead
of having to set it manually in the Viewing Sequence tab.

Sheet Names Tab

This tab can be used to define common sheet names for all of the pages in this Layout module.
See the separate chapter on Sheet Names for a description of the options here.

Note You can only set sheet names 3 and higher on this tab. The sheet names 1 and 2 can
only be set for individual pages.

Keep in mind that sheet names for individual pages are processed after the sheet names defined
for all pages on this tab and, therefore, always have priority, i.e. if you define sheet name 3
on this tab and also for an individual page, the sheet name 3 defined for that individual page
will be used and the sheet name 3 defined here will be disregarded for that page.

When using global variables to define sheet to define sheet names, it is recommended to use
them only on this tab and not on individual pages, as the processing of sheet names for indi-
vidual pages takes place at the beginning of each new page. This could lead to unexpected
results, as the processing of any consecutive pages will not have yet been taken into account.

Postage Prices Tab

This tab is used in combination with the option Weight on the General tab of individual pages
in order to calculate the cost of mailing the documents that the workflow will produce. Postage
prices can then be used in Messages where you can set the condition No extra postage for
adding messages (marketing messages will only be added if it does not increase the total
postage price).

Options Description

Weight Sets a weight limit for the given price.

This number represents the total weight of the media that the pages will be printed on.
When the workflow is processed, if the total weight of the printed media does not exceed
this value then the corresponding price will be used in the calculation of postage cost. The

710
 7.6 Layout Objects

weight of a single medium is obtained from the option Weight which can be set on the
General tab of individual pages.

Units are not used so it should be ensured that the intended units are consistent where
used.

Price Sets a postage cost for the given weight.

The number does not have to be exact, it is only used for comparison - if the printed sheets
fit into the first price range or not.

Create New Creates a new row in the list.

Delete Deletes the selected row from the list.

Example It costs 15 GBP to send 1 Kg of direct mail via the postal service so we set 15
to Price and 1 to Weight.

The Weight of individual pages is set to 0.005. Therefore, it is calculated that up to 200
pages can be sent without increasing the cost of postage to more than 15 GBP.

7.6.28.2 Pages Family Context Menu

Right-clicking on the Pages family in the Layout Tree reveals a context menu. Some of the options
are global to all object families on the tree and so, for a description of those global options,
see the section Layout Tree.

Options Description

Add New Page Creates a new blank page, adding it after any other already created pages,
i.e. last in the default processing order.

Convert All Glyph Areas Creates flow areas from any glyph areas on any of the pages.

In effect, the action Convert to Flow Area is applied to all glyph areas. See the section
Glyph Area Context Menu.

711
7 Layout Module

7.6.28.3 Individual Page Layout Properties

A Page's Layout Properties has the following tabs:

General Tab

Start Tab

Next Page Tab

Continue Tab

Guidelines Tab

Sheet Names Tab

Heads Display Tab

General Tab

Options Description

Size Sets the page size.

For details about Size, Width and Height options and the related icons see the Output
module.

Width Determines the width of the page in the specified units.

Height Determines the height (length) of the page in the specified units.

For this option and the one above you can choose the units from a list that opens when
you click on the unit symbol to the right.

Tip The page size can be set up globally for all new pages in the Layout Options dialog.

You can also set dynamic height to a page, see the option Dynamic height below.

Weight Assigns a weight to the page.

This can be used to calculate how much it will cost to mail any produced document. It is
used in combination with the Postage Prices tab of the Pages family.

712
 7.6 Layout Objects

Units are not used so it should be ensured that the intended units are consistent where
used.

Background color Selects the background color of the page.

Repeated by Selects a variable that will control the repetition of a sub-set page order.

This sub-set is an additional part of the page order that can be set via the General tab of
the Pages family. It allows individual pages to be repeated according to lower-level array
that is within the array that is controlling the overall page order, i.e. that has been selected
in the Repeated by option of the Pages family or Records by on the Data tab of the
Data family.

Once a variable is selected here, the page order will be continued from this individual page
according to the settings made on the Start tab, the Next Page tab and then the Continue
tab.

This option only appears when Variable selection has been selected for Page order on
the General tab of the Pages family.

See the example How to Print a Job with Repeated Pages (at the end of this section).

Repeated index Selects any global variable of integer data-type in order to return an index
value for the current repetition.

Example Refer to the example How to Print a Job with Repeated Pages. If we add
a global variable to the data structure (Data-type: Int, Auto clear: Each record) and
place it in a flow on each page, the returned values would be as follows:

The first Repeated1 page will have the index of 0, the Repeated2 pages that follow
will have indexes from 0 to 4, the second Repeated1 page will have the index of 1,
the Repeated2 pages will again have indexes from 0 to 4 and so on.

This option only appears when a variable has been selected for Repeated by.

Dynamic height Adjusts the height of the page to the content, i.e. the bottom border of a
page moves depending on the content.

This changing height is visible directly in Layout and will be adjusted according to any
variable content when the workflow is processed, i.e. in Proof or Production.

This option can be used in combination with the Dynamic height for flow areas in emails
(produced using the HTML engines) to avoid white spaces.

Add height to page Sets the bottom margin of the page with dynamic height, i.e. the space
between the page border and the bottom of the object displayed as the last one on the
page. This also works for variable-positioned objects.

713
7 Layout Module

Start Tab

The Start tab is available when a variable is set in the Repeated by field on the General tab
of this same individual page.

The options here are the same as for the Next Page tab except this tab selects the first page in
the sub-set page order that starts when this page is reached as part of the overall page order.
This sub-set page order is then repeated by the array selected by that Repeated by option.

Example If there are Pages A and B and the Start page on the General tab of the Pages
family is set as A. And on this Start tab, Type is set to Simple and Page is B. Then the
actual start page will be Page B.

Next Page Tab

This tab is only available if Variable selection has been selected in the Page order combo-box
on the General tab of the Pages family Layout Properties.

In most cases it selects the page that will be processed after this one (to which this tab belongs).
However, if Repeated by has been used on the General tab of this individual page, then this
tab only selects the page that will follow if this individual page has been selected by its own
Start tab.

Example There are two pages: A and B.

If page A has A selected for Page on the Start tab, then the Next Page tab of A will be
processed after the rest of page A.

But, if page A has B selected for Page on the Start tab, then the Next Page tab of Page
A will not be processed.

Options Description

Type Selects the method by which the page will be selected.

If Simple is selected, select the page in the Page combo-box which appears. The other
selections here are types of variable selection which allow the page to be selected by
condition. If one of these methods is selected, other options will appear. See the Types of
Variable Selection section for details.

714
 7.6 Layout Objects

Rollback Removes the specified number of pages from the page order before continuing to
the one selected for Page.

This option is available for all selections in the Type combo-box except for Simple.

Example Two pages (A and B) have a flow order set up between them and the
flow is of variable length. A conditional page order is set up if there is an overflow
on page A: A to B.

It is then decided that, if the flow is too long to fit into the areas on A and B (i.e. it
still needs to overflow after B has been processed) then page A should be used instead
of B as the middle pages, i.e. page order should be A-A-B or A-A-A-B etc.

In this case the following page order should be set on the Next Page tab of B:

Type: Select by condition, Variable: Overflow, Page: A and Rollback: 1.

These settings are effectively saying: If there is an overflow from this page then do
not use this page, instead rollback one page to A.

Notice that there is no concern here for the content of the flow used in the flow order.
This is because, when the removed page had flow areas that were included as part
of the flow order, the content of the flow that would have appeared on the removed
page is not lost. Instead, the flow continues through any flow area (in that flow order)
which appears on any page.

Page Determines the page that will be selected by the method in Type.

Continue Tab

The Continue tab is available when a variable is set in the Repeated by field on the General
tab of this individual page.

The options here are the same as for the Next Page tab except this tab selects the page that
will follow after the repetition of the array selected for Repeated by is complete, i.e. the page
that will follow when the sub-set page order, defined via the Start tab and Next Page tab, has
finished. The page selected here will also follow in cases where no page has been selected by
either of those tabs.

715
7 Layout Module

Example There are pages A, B, C and D:

On Page A, the Start Tab selects A, the Next Page tab selects B and the Continue
tab selects D.

On Page B, the Start Tab selects B, the Next Page tab selects C and the Continue
tab is not set.

The arrays selected by the Repeated by combo-box for both A and B return three
sets of values (records).

Repeated by is not set (Empty) for page C.

The resulting page order would be: A-(B-C-B-C-B-C)-A-(B-C-B-C-B-C)-A-(B-C-B-C-B-C)-D.

Notice how the sub-set page order continues according to the properties of each individual
page that is in the order.

Another page order is presented in the example How to Print a Job with Repeated Pages at
the end of this section.

Guidelines Tab

On this tab, you can create or modify the positions of special non-printable guidelines that fa-
cilitate layout creation.

Tip You can also create or alter the positions of guidelines directly in Layout either by: clicking
on the ruler and dragging the cursor to the position where you would like to have a guideline;
or by directly clicking on an existing guideline and moving it to a new position. If you move a
guideline back under the ruler, it is deleted.

Options Description

Horizontal Displays the positions of horizontal guidelines.

The position of horizontal guidelines is calculated from the top page border.

Vertical Displays the positions of vertical guidelines.

The position of vertical guidelines is calculated from the left page border.

Create New Creates a new vertical/horizontal guideline in the respective list for which
you can enter a value. Clicking on the unit symbol at the bottom of the tab opens a menu
with the choice of measurement units available.

Note Alternatively, you can create a new guideline by clicking on the horizontal or ver-
tical ruler and dragging it to the position where you wish to have a guideline.

716
 7.6 Layout Objects

Guidelines created this way will also be displayed on the Guidelines tab.

Delete Deletes the selected guideline from the list.

The order of drawing guidelines and other objects on the page can be set in the Layout Options
Dialog.

Sheet Names Tab

Sets the sheet names for the individual page. See the separate chapter on Sheet Names for a
description of the options here.

Typically you need to assign sheet name 1 if you intend to have different media defined in the
Output module (i.e. media can be assigned to pages via sheet name 1) and other sheet names
if you want to use Impositioning modules (where sheet names are often used for sorting,
grouping etc.).

Tip It is also possible to assign a variable for returning sheet names 3 and higher on the Sheet
Names tab of the Pages Family properties panel in Layout.

Note Because individual pages are processed after the attributes of the Pages family, if there
are sheet names with identical index numbers assigned on both this tab and the Sheet Names
tab of the Pages family, the sheet names specified here for individual pages will be given priority
over the sheet names set there.

It is not recommended to use global variables to determine sheet names of individual pages.
See the Sheet Names tab for the Pages family for details.

Heads Display Tab

On this tab you can define head positions for Layout, load head definitions created in Proof or
save them for usage with the IJPDS or PDF engines, Proof or in other workflows. This is useful
for designing jobs that will be printed on Scitex printers.

Options Description

Position Determines the position of the head.

Width Determines the width of the head.

Create New Adds a new head.

Edit Head Properties Opens the Head Data Configuration dialog for the selected head
definition allowing you to set custom notes for selected head definitions.

See the Head Data Configuration section for details.

717
7 Layout Module

Delete Deletes the selected head.

Open Enables you to load a head definition saved in the XML format saved in Proof. When
you load a head definition the Select Media Index Setting dialog will be displayed:

Setting Head definitions created in Proof can be grouped in Media index settings. If the
Head definition you are loading contains several Media index settings select the ap-
propriate one from the combo-box.

DPI When loading a head definition saved in Proof it is necessary to specify the DPI used
in that proof profile so that the width and position values (measured in dots in Proof)
can be converted correctly to the units you are using in Layout.

See the example for the Save option below for an illustration of the problems that
can occur if a wrong DPI is specified.

Save Head definitions can be saved in a XML file and re-used in Proof, in the IJPDS engine
or in another workflow. When you save a head definition, the Select DPI dialog is displayed
where you can set DPI.

When saving a head definition you must specify DPI as the values you specified in mm (or
another unit) will be converted into dots based on the DPI value.

This is important if you want to use the saved head definition in Proof; so make sure the
DPI for the raster proof profile is set to the same value as the DPI you have saved your
heads definition in (or vice versa), or the head size in Proof will differ from the size you
specified in Layout.

Example If you save your head definition with Head position 10 and Head width
100 (which means that the head will begin 10 mm from the left border and is a 100
mm wide) and set the DPI to 150 and then load this definition in a raster proof profile
with DPI set to 300, the result will be that the head begins 5 mm from the left border
and is 50 mm wide.

This is because raster proof measures head sizes in dots and when saving a head
specified in mm these values will be converted to DPI according to the DPI value you
have set in this option.

Note To be able to see heads in Layout, enable the option Show heads in the View menu.

Head settings made in Layout are saved as part of the workflow and are independent from
any that may be set in Proof.

718
 7.6 Layout Objects

7.6.28.4 Individual Page Context Menu

Right-clicking on a page in the Layout Tree reveals a context menu. Some of the options in the
menu are global to most objects in the tree and so, for a description of those global options,
see the section Layout Tree.

Options Description

View Page Opens the page so that it is displayed in the Layout Area.

Add New Page Creates a new blank page, adding it after any other already created pages,
i.e. last in the default processing order.

Insert New Page Creates a new blank page and places it before the currently selected
one, i.e. one place in front in the default processing order.

Move Page to Front Moves the current page to the first position in the set of pages, i.e. to
the top of the Pages branch and the start of the default processing order.

Move Page Forward Moves the current page forward by one position along the pages
branch, i.e. one place in front in the default processing order.

Move Page Backward Moves the current page backward by one position along the pages
branch, i.e. one place behind in the default processing order.

Move Page to Back Moves the current page to the last position in the set of pages, i.e. to
the bottom of the Pages branch and the end of the default processing order.

Convert All Glyph Areas Creates flow areas from any glyph areas on the page.

In effect, the Convert to Flow Area action is applied to all glyph areas. See the section
Glyph Area Context Menu.

Example How to Print a Job with Repeated Pages

This example shows the settings necessary for getting the following result:

719
7 Layout Module

An introductory page followed by pages that are repeated by an array. Each of the pages
of this first repetition is then followed by a further, dependent repetition. The record ends
with a simple final page.

1. First it is necessary to go to the Pages node in the Layout Tree and select the option
Variable selection in the Page order combo-box. Then define the starting page
(Introduction page).

2. The Introduction page is not repeated, the only setting to do is on the Next page
tab, where it is necessary to define the Page, that will be printed next (Repeated1
- Rep1 in the diagram).

3. For the Repeated1 page you need to define the array by which the page will be
repeated.

This setting is done on the General tab in the Repeated by combo-box. The Start
tab selects the starting page (Repeated1) of the repetition, the Next page tab
specifies which page will be inserted after each page of the sub-record (Repeated2
- Rep2 in the diagram). On the Continue tab the final page is selected in the Page
combo-box. This page will be printed after the repetition of the Repeated1 page
is complete.

4. The Repeated2 page requires similar settings. On the General tab select the appro-
priate array in the Repeated by combo-box and on the Start tab define the
starting page (Repeated2). No settings are required for the Final page.

There are only two repetitions in this example but it is possible to have virtually any
number of nested repetitions within one record. You can also easily create variable intro-
ductory and final pages.

720
 7.6 Layout Objects

7.6.29 Paragraph Styles

In this section: See also:
Paragraph Style Layout Properties How to Create or Modify Text Styles and
Setting a Default Paragraph Style Paragraph Styles
Examples for Flow Break Before/After Text Styles
Option Fill Styles
Border Styles

Paragraph styles define multiple aspects of text for an entire paragraph and can employ other
styles, i.e. text styles and border styles. It is recommended that you create those other styles
before creating paragraph styles.

Example You might create a "Title" style that would define titles as center-aligned,
with a certain amount of space above and below and with a border style applied. The
body text of a paragraph could have another Body style, for instance: left-aligned with
certain rules for hyphenation and specific settings for orphans/widows.

For several different methods of creating and managing paragraph styles, see the separate
section How to Create or Modify Text Styles and Paragraph Styles.

7.6.29.1 Paragraph Style Layout Properties

The Paragraph Style Layout Properties panel has the following tabs:

General

Advanced

Borders

Orphan Widow

Tabs

Hyphenation

There are some additional options at the top of the panel:

721
7 Layout Module

Options Description

Parent Creates a link to another paragraph style from which the current style inherits all of
that style's properties.

You can then set which properties will remain as inherited (i.e. linked), by clicking on the
Parameter linked to parent / Unlinked parameter icons next to the appropriate
combo-boxes.

Visible paragraph style Indicates the visibility of the currently selected style.

This check-box is not editable.

General Tab

Options Description

Alignment Sets the text alignment for the paragraph style.

Options here and for the corresponding icons in the toolbar are: Left, Right, Center, Justi-
fyLeft, JustifyRight, JustifyCenter, JustifyBlock, JustifyWithMargins.

Note If you use the icons from the toolbar to set the alignment of your text, only the
currently selected paragraph will be adjusted, but not the applied paragraph style.

Left Indent / Right Indent Determines the space on the left side / right side of the paragraph.
This setting applies to all lines of the paragraph.

First line left indent Determines the space on the left side of the first line of the paragraph.

Space before on first Determines whether the value set in the Space before option will
be applied to the first paragraph in a flow area.

When set to the default No, the first paragraph always starts at the top of the flow area
regardless of the setting made in the Space before option. When Yes is set, the value
defined in the Space before option is applied to all paragraphs.

Note When a paragraph overflows into a new flow area, this setting will also determine
the position of the first line of the paragraph in the new flow area.

722
 7.6 Layout Objects

Space before Sets the vertical space before each paragraph's beginning.

Space after Sets the vertical space after each paragraph's end.

Take maximum from space before/after Set to Yes automatically during RTF/DOC import
to achieve the same design as in the imported file. The maximum from the values Spacing
After set for a paragraph and Spacing Before set for a subsequent paragraph in MS Word
is taken.

In case that you use it for paragraphs created in Inspire Designer, the values set in the
Space before and Space after are considered.

If set to No, the two values (Space after set for a paragraph 1 + Space before set for a
subsequent paragraph 2) are added and the result is used.

Line spacing Sets the space between the lines of the text.

Additional Adds under each line the amount of space defined in the Line spacing
value option.

Exact Spaces the lines precisely at the measurement set in the Line spacing
value option, placing the potential extra space (difference between the height of
the glyphs and the line spacing value) below the lines.

The default setting in Line spacing value is 5mm.

Note If the font size is too big or the setting for line spacing too small, characters
may overlap and be illegible.

At least Spaces the lines at the measurement you set, but more space will be
given if characters would otherwise overlap. The default setting in Line spacing
value is 5mm.

Multiple of Spaces the lines according to a multiple of a line. A space and a half
(1.5 lines) is the default setting.

Exact from previous Spaces the lines according to the value set in the Line spacing
value option placing the potential extra spacing above the line. The first line at
the top of the flow area is not affected by this setting.

Note If the font size is too big or the setting for line spacing too small, characters
may overlap and be illegible.

Exact from previous with adjust (old) / Exact from previous with adjust Both options
space the lines according to the value set in the Line spacing value option placing
the potential extra space above the line, including the first line in the flow area.

723
7 Layout Module

The difference between the two similar options (illustrated below) lies in the spacing
of the first line in the flow area.

Legend

1. Exact from previous with adjust (old) The distance between the first baseline
and the top border of the flow area depends on the defined line spacing and
the line maximum (i.e., given line's largest character's font), and is counted
according to the following formula: a = b (c + d), where:

a = the distance between the first baseline and the top border of the flow
area,

b = line spacing value,

c = the value of the line maximum descender,

d = the value of line maximum line gap.

2. Exact from previous with adjust The distance between the first baseline and
the top border of flow area will be 80% of the defined line spacing. This option
mirrors settings typical for most standard word processors.

Note If the font size is too big or the setting for line spacing too small, characters
may overlap and be illegible.

Tip For HTML output: Select Exact or Multiple of and consider using the Distribute line
spacing option that emulates HTML line spacing, i.e. half of the size above and half below
the paragraph.

Line spacing value Specifies a size for line spacing.

See Line spacing, above.

Distribute line spacing Determines that the line spacing set by the Line spacing and Line
spacing value fields above will emulate HTML line spacing, i.e. half of the size above and
half below the paragraph.

If it is used, the Exact from previous with adjust (old), Exact from previous and Exact from
previous with adjust options of Line spacing will work the same way as Exact.

724
 7.6 Layout Objects

Advanced Tab

Options Description

Default text style Sets which text style will be employed by the paragraph style.

This is the text style that will be applied to a paragraph when this paragraph style is applied.

If modifications have been made to the text style used in a paragraph (e.g. one word has
been made italic using the Text Format toolbar) then these modifications will be kept and
applied to the newly applied text style. In practice, this means that another invisible text
style is created for the modified version of the newly applied text

Tip This is default behaviour determined by the option Change text style together
with paragraph style on the Layout Options dialog.

That option can be unchecked, so that the text style is not applied when a paragraph style
is.

Next paragraph style Determines the paragraph style that will be used after pressing
<Enter>.

Example You may want "Normal" to appear after "Heading_1".

Note Remember that the text style chosen as the Default text style for the paragraph
style selected here will also be applied with that paragraph style.

725
7 Layout Module

Ignore empty lines Determines whether empty lines will be printed or not.

Lines containing only tabulators and/or spaces are also treated as empty.

Example In proof or when printing you have a result like this:

Setting Ignore empty lines to Yes for the applied paragraph style will change the
appearance of the paragraph in proof and when printing in the following way:

Bullets/Numbering flow Selects a bullet flow or numbering flow that will be used for the
paragraph.

Bullet/Numbering flows get created once you use the Bullets and Numbering icons on the
right side of the Paragraph Style toolbar in the Layout or they can be created directly in
the Bullets and Numbering dialog (Format | Bullets and Numbering).

Numbering variable Selects a variable of numbering kind that will be used to return the
numbers.

The combo-box lists all previously created variables which have their Kind selected as
Numbering.

Numbering type Selects how numbering will be counted:

Increment Creates a row of successive numbering.

Reset Creates a new row of successive numbering within another numbering.

This option only appears if a variable has been selected for Numbering variable.

Reading order Determines the writing direction Left or Right. For correct formatting of
Arabic or Hebrew text Right needs to be selected and Worldwide Support enabled.

Reversed If set to Yes, the text is displayed in reverse order. This feature is useful for Hebrew
language documents, if you have your input data in visual order (i.e. the order in which
text is read).

The data first needs to be mirrored in the Data Transformer module to be possible to
process it. Using this feature, the data can be reverted to visual order in Layout.

If you want to use this feature, the Worldwide Support function has to be enabled.

726
 7.6 Layout Objects

Borders Tab

Options Description

Border style Enables you to select a previously defined border style or create a new one that
will be applied to the paragraph.

Connect borders Determines whether the borders will be connected.

With line gap Determines if a space between lines (LineGap) will be used.

Orphan/Widow Tab

Options Description

Flow break before Sets the position of the paragraph to which this option is set, i.e. the
'breaking' is done before the paragraph, so it is placed in the next column, flow area or
page.

There are the following options:

No The paragraph immediately follows the previous one, i.e. the spacing of the
break is only affected by the settings on the General tab.

This is the default setting.

Column The paragraph is displayed in the next column.

The Column option is useful when there are columns defined through inserting
sections into the flow and selecting options on the Columns tab. In case there are
no sections inserted into the flow with defined columns, selecting this option has
the same effect as the Flow area option.

727
7 Layout Module

Flow area The paragraph is displayed in the next flow area.

Page The paragraph is displayed on the next page.

Tip Make sure that flowing between flow areas and/or pages is set, if the options Flow
area or Page are used.

Note

Flow break before has priority over Keep with next paragraph, i.e. instead of
displaying the last line of the paragraph together with the first line of the following
paragraph, the two paragraphs will be split.

If Flow break before is applied also to the first paragraph of a sequence, it will
be ignored and the paragraph will be displayed as designed, i.e. such usage will
not result in an empty column, flow area or page.

See Examples for Flow Break Before/After Option below for further details.

Flow break after Sets the position of the paragraph following the one to which this option
is set, i.e. the 'breaking' is done after the paragraph, so the following paragraph is placed
in the next column, flow area or page.

There are the following options:

No The next paragraph immediately follows the previous one, i.e. the spacing of
the break is only affected by the settings on the General tab.

This is the default setting.

Column The next paragraph is displayed in the next column.

The Column option is useful when there are columns defined through inserting
sections into the flow and selecting options on the Columns tab. In case there are
no sections inserted into the flow with defined columns, selecting this option has
the same effect as the Flow area option.

Flow area The next paragraph is displayed in the next flow area.

Page The next paragraph is displayed on the next page.

Tip Make sure that flowing between flow areas and/or pages is set, if the options Flow
area or Page are used.

See Examples for Flow Break Before/After Option below for further details.

Keep lines together Determines whether a paragraph may overflow from one flow area to
another.

This is allowed by the default setting No. If Yes is set, the paragraph will be displayed in
the flow area only if the flow area is big enough for the whole paragraph.

Keep with next paragraph If set to Yes, the last line of the paragraph will always be dis-
played in the same flow area as the first line of the following paragraph.

The number of lines to be kept with the next paragraph can be increased by modifying
the settings for Orphan.

728
 7.6 Layout Objects

Note If Flow break before is applied to the next paragraph, it has priority. Keep with
next paragraph is overridden and a warning displayed.

Do not wrap Determines whether or not the text will be wrapped.

If set to Yes, text will not wrap when reaching the border of the flow area in which it is
contained.

If set to No, breaks are inserted between words (not within them) or after the punctuation
that immediately follows whole words. However, single words longer than the line are
not wrapped and exceed the flow area border.

In order to hyphenate the text, set the Hyphenate option to Yes on the Hyphenation
tab. If you do not want to split two adjacent words into two lines, insert a non-breaking
space between them (0x00A0 code).

Note If the text is wrapped, spaces (0x0020 code) and double-byte spaces (0x3000 code)
in the end of lines are ignored and may exceed the flow area border. However, all spaces
in the beginning of a new paragraph are preserved as they may create a left indent.

If you want to insert a blank space in the end of line in the body of a paragraph, type a
non-breaking space (0x00A0 code) which is handled as a special character. The above
mentioned rule is not valid for this type of the space.

Orphan Specifies the minimum amount of lines overflowing into the next flow area when
a paragraph overflows into another flow area.

Only applies when Keep lines together is set to No.

Note If text is flowing between flow areas of different widths, especially when the second
flow is wider than the first one, the actual number of lines remaining in the second flow
(after the flow break) may be smaller, because the number of orphan lines is calculated
according to the width of the first flow area.

Widow Specifies the minimum amount of lines remaining in the original flow area when the
paragraph overflows into another flow area.

Only applies when Keep lines together is set to No.

Enable wrap anywhere If set to Yes, text is always wrapped at the end of flow area, regard-
less of spaces or hyphenation (i.e. wrap can be in the middle of a word). For Asian lan-
guages it is recommended to set it to Yes, otherwise use wrapping rules.

Note The Enable wrap anywhere option has a priority over any wrapping rule. If you
want to apply a defined wrapping rule, be sure to set this option to No.

729
7 Layout Module

Truncate to one line If set to Yes, the paragraph is always cut at the boundary of the flow
area. The paragraph ends with the last word of the first line that fits to the flow area and
only the first line of the paragraph is displayed.

Example In combination with the function Enable wrap anywhere, the text is
cut in the middle of the word at the boundary of the flow area and only the first line
is displayed. This is useful when you have limited space for some information, e.g. a
field for city name, when long names are cut but still identifiable.

Tabs Tab

This tab sets the distances between each tab position (moved between using the tabulator key
of a keyboard) within a paragraph. Each tab added to the table will be the next tab across the
width of the flow area. Tabs can also be defined, for the currently selected paragraph style, in
the Layout Area using the context menu of the Ruler above flow areas.

Example

A different ruler appears for each paragraph style and the tabs marked on it are the values
found on this tab.

Options Description

Default Sets the default distance between tabs.

This value is used as the distance between tabs when no other tab has been set, or if the
width of the flow area is greater than the total width covered by the tabs set below.

730
 7.6 Layout Objects

Position The position of the tab setting, measured from the left border of the flow area
where the paragraph style is used.

Example If one tab is added to the table and 60.00 mm is entered here, but 12.50
is entered for Default, then the first four default tabs would be removed (60 / 12.50
= 4.8 => there would be four default tabs within the first 60mm) and the first tab
position would be at 60mm from the left of the flow area. The next tab, which is still
a default tab, would be at 62.5 mm.

Type Selects the tab type:

Right Text is aligned on the right side of the tab.

Left Text is aligned on the left side of the tab.

Center Text is in the center of the tab.

Decimal word Numeric values are aligned to a decimal point, non-numeric strings
are aligned on the left side of the tab.

Decimal Text is aligned according to a selected point, e.g. decimal point in

numbers or any other specified character in text.

Point Specifies the character to use for "decimal" tabs.

For example, to use a decimal tab for $99.95, enter a "." in this block.

Leader Specifies a character to use as a leader between the text and the tab setting.

Use outside tabs Enables you to use tabs reaching outside of a flow area.

When No is selected, an overlapping tab is not used and the text after the tab starts on
the next line.

Create New Adds a new tab setting.

Delete Deletes any selected tab setting.

Delete All Deletes all tab settings.

Hyphenation Tab

731
7 Layout Module

Options Description

Hyphenate Sets whether or not you will permit hyphenation within the text of the paragraph.

Left Chars Min Sets the minimum number of characters you want to display before a hyphen.

Right Chars Min Sets the minimum number of characters you want to carry over to a new
line after the hyphen.

Max Consec Hyphens Defines the maximum number of consecutively following lines ending
with hyphens.

Hyphenation Setting
In order to hyphenate the text, its Text style property of Language has to be set to the appro-
priate language.

You can define your own exceptions for words that you want to hyphenate according
to separate rules.

You have to place an UNICODE coded plain text file, into the PNETT_DIR folder.

The filename syntax is uhyphexc_XX.dat, where XX stands for language (en English, de
German, etc.)

Each word should be on one line. It has to match exactly, i.e. when 'ma-nu-script' is in the ex-
ception file, then neither 'Manuscript', nor 'manuscripts' are handled as exceptions.

See the Language codes appendix for the supported language codes.

Example of the exception file for English language uhyphexc_en.dat:

uni-ver-sity

uni-ver-sit-ies

how-ever

ma-nu-script

ma-nu-scripts

re-ci-pro-city

through-out

some-thing

Soft Hyphenation
You can determine the exact place where a word will be hyphenated by inserting a soft hyphen-
ation character.

To insert the character go to menu Insert | Insert Special Character and choose the Soft hy-
phen option.

732
 7.6 Layout Objects

Alternatively, click on the Show Insert Char Palette option in the Window menu and select
the soft hyphenation character (code 173 or 0x00ad) in the palette. The character can also be
inserted with the keyboard shortcut <Ctrl> + <Shift> + <->.

The soft hyphenation character behaves differently depending on the settings made in the
Hyphenate combo-box on the Hyphenation tab. If hyphenation is enabled, the special character
is not visible when the word, where it is inserted, is not broken. Then, whenever it is useful to
break the line, a hyphen is displayed in the character's place and the rest of the word is moved
to a new line. If the hyphenation function is disabled, the special character will always be dis-
played as a hyphen.

Using this character will disable automatic hyphenation, i.e. the word will only be broken at
the indicated place.

Static Paragraph
The property Static may apply to Paragraph Styles too. It indicates whether there is a variable
used in the paragraph style settings. If a paragraph style is static there is the sign (s) next to
the paragraph style name in the Layout Properties window.

Paragraph style is dynamic if you use, for instance, a variable for defining the border style or
bullets/numbering variable. In these cases (s) will not appear.

7.6.29.2 Setting a Default Paragraph Style

It is possible to set any paragraph style created in Layout as your default paragraph style. To
do this, in the Layout Tree right-click on the name of the paragraph style, which you want to
make your default paragraph style and select the Set as Default option.

The change is saved in the PNetT.cfg file and the paragraph style becomes the new Normal
paragraph style (i.e. the default paragraph style for new layouts; it has no effect on the current
Layout).

Tip To restore the original Normal paragraph style settings, delete the PNetT.cfg file (in the
directory, where Inspire Designer is installed). Remember, that by deleting this file you will loose
all other user settings made in the application.

7.6.29.3 Examples for Flow Break Before/After Option

Either Flow break before or Flow break after option can be used. The effect depends on
the paragraph to which you apply it.

In the examples below, the paragraph styles can be applied to both paragraphs. The 'break
before' for the first paragraph or 'break after' for the last are ignored, as there are no other
preceding or following paragraphs.

733
7 Layout Module

Flow Break Before/After 'Flow Area' or 'Pages'

To present the behavior of the Flow area and Pages options, a layout has been created with
two paragraphs with different color each. They are both part of one flow (Flow 1) and flowing
is set up between three flow areas and also between pages, i.e. the page is displayed again if
there was an overflow:

734
 7.6 Layout Objects

Follow these steps to set the Flow break before or Flow break after option:

1. Double-click on Flow 1, check what paragraph style is applied to the paragraphs and:

either click on the Find Node icon and alter the paragraph style,

or go to the Paragraph Styles family and create new paragraph styles and rename
them.

2. The Flow break before or Flow break after settings are located on the
Orphan/Widow tab.

735
7 Layout Module

3. If creating a new paragraph style, apply it to the paragraphs.

Blue lines appear between the paragraphs to which paragraphs styles with a 'flow
break' are applied.

4. Proof your workflow and see the results:

Original situation with Flow break before and Flow break after options set to
No.

Flow break after option set to Flow area.

736
 7.6 Layout Objects

Flow break before option set to Page:

First page in Proof

Second page in Proof

Flow Break Before/After 'Column'

To present the behavior of the Column option a layout has been created with two paragraphs
with different color each. They are both part of one flow (Flow 1) and a section with three
columns has been created and added at the beginning of the flow. Flowing is set up between
the two flow areas:

Follow the same steps as in the example above to set the Flow break before or Flow break
after option to Column.

737
7 Layout Module

Proof your workflow and see the results:

Original situation with Flow break before and Flow break after options set to No.

Flow break before option set to Column.

7.6.30 Plugin Areas

In this section
Plugin Areas Layout Properties Panel
DirecType Plugin

A Plugin Area contains a plugin object that generates personalised images based on a template
from another application. This template consists of an image which contains data supplied by
a variable from your data file.

To add a plugin area to the Layout, click on the Plugin Area Tool icon on the Tools toolbar
and draw a rectangle. Choose from available plugins that are listed on the Object tab of the
Plugin Area's Layout Properties panel.

738
 7.6 Layout Objects

7.6.30.1 Plugin Area Layout Properties Panel

In the Plugin Area's Layout Properties panel you can specify the plugin type, the dynamic content
and other plugin area settings. The settings can be made on the following tabs:

Position

Runaround

Object

Position Tab
Refer to the Position Tab section for details.

Runaround Tab
The options on this tab are the same as for shapes.

Object Tab
On this tab, first select the plugin type you want to use from the first combo-box from the top.
This combo-box lists all available plugins, i.e. plugins that are installed and licensed.

The options available on this tab depend on the chosen plugin type. See the appropriate section
for options description:

DirecType Plugin

TrustCopy Plugin

7.6.30.2 DirecType Plugin

DirecType is an application for creating dynamic personalized images. Using the plugin area
you can insert images with variable text generated by DirecType application into Layout. See
the DirecType web site for more information about the application and a gallery of sample
images.

The DirecType plugin is part of Inspire Designer installer: the DirecType directory (inside the
directory where Inspire Designer is installed) contains also sample definition files (with the DTM
extension) and a demo license file (dtlicense.ini). With this demo license, the image will be
displayed with a watermark reading DirecType. The full license can be obtained from Direc-
Type.

DirecType Object Tab

On the DirecType Object tab set the variable that defines the text content, and the template
definition file.

739
7 Layout Module

Options Descriptions

Variable Selects a variable that controls the text content inside the image.

Input file Selects the definition file (defining the template) created and saved in the respective
application.

How to Use DirecType Plugin

To use a DirecType template in Inspire Designer follow these steps:

1. Click on the Plugin Area Tool icon on the Tools toolbar and draw a plugin area in
the Layout.

2. Choose DirecType from the plugin type selecting combo-box on the Object tab.

3. Open a template created in DirecType (DTM format) in the Input file edit field.

4. In the Variable combo-box, select a variable containing the text that will be inserted
into the image.

5. After running the workflow, for each record a personalized image is created.

7.6.30.3 TrustCopy Plugin

TrustCopy provides an interface where it is possible to incorporate watermarks into your docu-
ments. Watermarks are used to embed critical information (e.g. personal details, serial numbers)

740
 7.6 Layout Objects

to have them secured in documents. When documents are printed, watermarks can only be
read using optical decoder keys.

The TrustCopy plugin is not a part of Inspire Designer installer, it is provided on request. When
provided, the libwm.dll file has to be placed to the redist directory that is currently in use.

TrustCopy Object Tab

On the TrustCopy Object tab set the variable that defines the content, size and other settings
of the watermark.

Options Descriptions

Variable Selects a string variable that controls the content, size and other settings (resolution,
darkness, ...) of the watermark. The variable has to contain the following structure:

<watermark>
<layer1>CX245479700001</layer1>
<layer2>9999999900</layer2>
<layer3>10081108</layer3>
<layer4>AB0123456789</layer4>
<width>2031</width>
<height>472</height>
<resolution>1200</resolution>
<reversed>no</reversed>
<darkness>20</darkness>
<output>memory</output>
</watermark>

Layer Defines the text content (e.g. number, date) of each layer, in the UTF-8
encoding. The maximum is 4 layers.

Width Defines the width of the output watermark in pixels.

Height Defines the height of the output watermark in pixels.

Resolution Defines the resolution of the output watermark in DPI. 600 and
higher DPI is recommended.

Reversed If set to "yes", the watermark colors are reversed, i.e. white to black.
Default option is "no".

Darkness Defines the darkness value. This option enables you to adjust the
watermark if it is too bright or to dark, text borders are revealed or nothing is visible.

Output Defines where the watermark will be saved. This variable must always
be set to "memory" (memory of the computer) for use in Inspire Designer.

741
7 Layout Module

Tip If borders around hidden text are embossed, do not use similar text for all layers.

How to Use TrustCopy Plugin

To use the TrustCopy plugin in Inspire Designer follow these steps:

1. Click on the Plugin Area Tool icon on the Tools toolbar and draw a plugin area in
the Layout.

2. Choose TrustCopy from the plugin type selecting combo-box on the Object tab.

3. In the Variable combo-box, select the string variable that controls the content and
other settings.

4. The watermark will be displayed in the Layout:

7.6.31 Scripted Areas

7.6.31.1 Scripted Areas
See also:
Scripted Area Example
Scripted Area Types and Methods

Scripted areas enable you to apply transformations (copying, moving, dimensioning, transpos-
ition) to existing layout objects and to create new objects from within the script.

742
 7.6 Layout Objects

See the following screenshot where the steps necessary to create a scripted area are shown:

Legend

1. Click the Scripted Area icon located on the Tools toolbar.

2. In the Layout Area, press the left mouse button and drag the cursor to create a holding
space for the scripted area.

3. Complete the Scripted Area Layout Properties.

4. Use the available tools for assistance when creating a script on the Content tab.

For a more detailed description see the section How to Create a Scripted Area.

743
7 Layout Module

Scripted Area Layout Properties Panel

Position Tab

Refer to Position Tab for details.

Content Tab

Options Description

Run also in preprocessing If checked, the script is run also in the preprocessing phase.
Running the script in preprocessing extends the possibilities of scripted area use, e.g. enables
to create scripted areas with overflow.

Script Type the script in the space provided.

Example FlowAreaDim[FlowArea2].X - to get the X dimension of FlowArea2.

Tip Press <Ctrl>+<Space> to obtain the objects and methods you can use.

Open Script Editor Allows you to edit the script in a detached Script Editor dialog. See
the section Script Editor Dialog for details and explanation of the other icons in the same
line.

744
 7.6 Layout Objects

Used Objects Tab

The Used Objects tab enables you to define objects you want to use in the script. You can
specify an alias, which will be used for referencing them in the script.

Options Description

Alias Enter an alias for the selected object. This alias can be used when referencing the object
in a script entered on the Content tab.

Object Select an object from the drop-down menu. All objects (such as fill styles, shapes,
flow areas, flows, images etc.) contained in the current workflow will be listed and can
be selected

Finds the selected object's node and displays the according layout properties.

Creates a new object row.

Removes the selected object row.

Removes all object rows.

Object and Methods Access

As you write the script, you can display a list of objects and methods.

745
7 Layout Module

For the complete list of types and methods, please see the separate chapter Scripted Area -
Types and Methods.

To see the selected group:

1. Click and highlight a word.

2. Press <Ctrl>+<Space> to access the objects and methods.

To see all objects and methods:

1. Click in a white space.

2. Press <Ctrl>+<Space> to access the objects and methods.

746
 7.6 Layout Objects

7.6.31.2 Scripted Areas Types and Methods

In this section:
Barcode Methods
CapType Methods
Flow Methods
FillStyle Methods
Image Methods
JoinType Methods
Normal Transformation Methods
Path Methods
Path Object Methods
Rect Methods
RRect Methods
RVector Methods
Transformation Methods
TransformationType Methods

The first part of this section lists all types and their methods that are available for scripted area.
The following part presents an overview of what methods can be used for Layout objects like
barcodes, flows, images, paths etc.

Barcode Methods
assign Assigns a barcode defined in Layout (can be used this way: a=b)

Syntax:

assign (Barcode aP1)

Return value:

Void

CapType Methods
CapType Sets the appearance at the end of a line: Butt, Round or Square.

Syntax:

CapType.Butt
CapType.Round
CapType.Square

Return value:

Void

747
7 Layout Module

Example

Path p;
p.moveTo(RVector(0, 0));
p.lineTo(RVector(0.0809625, 0.03042708));

CapType cap1 = CapType.Round;

setCurCapType(cap1);
strokePath(Transformation (),BlackFill,p);

FillStyle Methods
assign Assigns a fill style defined in Layout (can be used this way: a=b).

Syntax:

assign (FillStyle aP1)

Return value:

Void

Flow Methods
assign Assigns a flow defined in Layout (can be used this way: a=b).

Syntax:

assign (Flow aP1)

Return value:

Void

Image Methods
assign Assigns an image defined in Layout (can be used this way: a=b).

Syntax:

assign (Image aP1)

Return value:

Void

748
 7.6 Layout Objects

JoinType Methods
JoinType Sets what shape of corners will be used: Miter - pointed corners; Round - rounded
corners; Bevel - flattened corners.

Syntax:

JoinType.Miter
JoinType.Round
JoinType.Bevel

Return value:

Void

Example

Path p;
p.addRect(RRect ((0),(0.09),(0.06),(0)));
fillPath(Transformation (), RedFill,p);
JoinType join1 = JoinType.Round;
setCurJoinType(join1);
strokePath(Transformation (),RedFill,p);

Normal Transformation Methods

In Normal Transformation individual items of the transformation matrix are not influenced by
each other.

assign Assigns transformation (can be used this way: a=b)

Syntax:

assign (NormalTransformation aFlip)

assign (NormalTransformation aTr)

Return value:

Void

FlipX Gets flip value for X.

Syntax:

FlipX
getFlipX ()

Return value:

Bool

Rotation Returns the rotation value.

749
7 Layout Module

Syntax:

Rotation
getRotation ()

Return value:

Double

ScaleX Gets scale value for X.

Syntax:

ScaleX
getScaleX ()

Return value:

Double

ScaleY Gets scale value for Y.

Syntax:

ScaleY
getScaleY ()

Return value:

Double

ShearX Gets scale value for X.

Syntax:

ShearX
getShearX ()

Return value:

Double

Transposition Gets Transposition.

Syntax:

Transposition
getTransposition ()

Return value:

RVector

setFlipX Sets flip value for X.

Syntax:

setFlipX (Bool aFlip)

750
 7.6 Layout Objects

Return value:

Void

setRotation Sets rotation.

Syntax:

setRotation (Double aRotation)

Return value:

Void

setScaleX Sets scale value for X.

Syntax:

setScaleX (Double aScaleX)

Return value:

Void

Example

NormalTransformation nt;
nt.setRotation(90);
nt.setScaleX(0.5);
Transformation t;
t.assign(nt);
drawImage(t,Image01);

setScaleY Sets scale value for Y.

Syntax:

setScaleY (Double aScaleY)

Return value:

Void

setShearX Sets shear value for X.

Syntax:

setShearX (Double aShearX)

Return value:

Void

setTransposition Sets transposition.

751
7 Layout Module

Syntax:

setTransposition (RVector aRV)

Return value:

Void

Path Methods
addArc Adds an arc according to selected parameters.

Syntax:

addArc (RVector Center, Double Radius, Double StartAngle, Double

EndAngle)

Return value:

Void

addCircle Draws a circle according to selected parameters.

Syntax:

addArc (RVector Center, Double Radius)

Return value:

Void

Example

Path p;
p.addCircle(RVector (0, 0),(0.006));
fillPath(Transformation (), RedFillStyle,p);

addNgon Adds a polygon according to selected parameters.

Syntax:

addNgon (RVector Center, Int AnglesCount, Double Radius, Double

StartAngle)

Return value:

Void

Example

752
 7.6 Layout Objects

Path p;
p.addNgon(RVector (0, 0),(8),(0.009),(1));
fillPath(Transformation (), RedFillStyle,p); //draws a red octangle

addNgon2 Adds a polygon of a star type according to selected parameters.

Syntax:

addNgon2 (RVector Center, Int AnglesCount, Double RadiusMajor,

Double RadiusMinor, Double StartAngle)

Return value:

Void

addNgon3 Adds a polygon according to selected parameters.

Syntax:

addNgon3 (RVector Center, Int AnglesCount, Double Radius, Double

StartAngle)

Return value:

Void

addPath Adds a path.

Syntax:

addPath (Path aP1)

Return value:

Void

addRect Adds a rectangle according to selected parameters.

Syntax:

addRect (RRect aP1)

Return value:

Void

Example

Path p;
p.addRect(RRect ((0),(0.09),(0.06),(0)));
fillPath(Transformation (), RedFillStyle,p);

addRoundRect Adds a rectangular with a Bezier curve using the specified point (parameter
Corner).

753
7 Layout Module

Syntax:

addRoundRect (RRect Rect, RVector Corner)

Return value:

Void

Example

Path p;
p.addRoundRect(RRect(0,0.09,0.06,0),RVector(0.01,0.01));
fillPath(Transformation (), BlackFill,p);

addTriangle Adds a triangle according to selected parameters.

Syntax:

addTriangle (RVector aP1, RVector aP2, RVector aP3)

Return value:

Void

Example

Path p;
p.addTriangle(RVector(0.01,0.01),RVector(0.005,0.02),
RVector(0.015,0.02));
strokePath(Transformation (), RedFill, p);

assign Assigns a path (can be used this way: a=b).

Syntax:

assign (Path aP1)

Return value:

Void

bezierTo Appends Bezier curve according to selected points.

Syntax:

bezierTo (RVector ControlPoint1, RVector ControlPoint2, RVector

EndPoint)

Return value:

Void

754
 7.6 Layout Objects

Example

Path p;
p.moveTo(RVector(0.00264583, 0.00052917));
p.bezierTo(RVector(0.0555625, 0.00635), RVector(0.053975, 0.02028472),
RVector(0.0809625, 0.03042708));
strokePath(Transformation (), BlackFill,LineStyle1,p);

binaryXor Returns result of bitwise xor operation on a given path.

Syntax:

binaryXor (Path aP1)

Return value:

Void

clear Deletes the whole path.

Syntax:

clear ()

Return value:

Void

close Closes the path (makes the last segment of path connected to the starting point of the
last segment).

Syntax:

close ()

Return value:

Void

Example

Path p;
p.moveTo(RVector(0, 0));
p.lineTo(RVector(0.05423958, 0));
p.lineTo(RVector(0.05423958, 0.022225));
p.close(); //draws a right-angled triangle
fillPath(Transformation (),RedFill,p);

conicTo Appends conic curve according to selected points.

Syntax:

conicTo (RVector ControlPoint1, RVector EndPoint)

755
7 Layout Module

Return value:

Void

Example

Path p;
p.moveTo(RVector(0, 0));
p.conicTo(RVector(0.0635, 0.01296458), RVector(0.0968375, 0.03915833));
strokePath(Transformation (),BlackFill,LineStyle1,p);

Count Returns the number of points for path.

Syntax:

Count
getCount ()

Return value:

Int

Example

Path p;
p.moveTo(RVector(0.00264583, 0.00052917));
p.lineTo(RVector(0.0809625, 0.03042708));
Int i=p.getCount();
logMessage(i.toString());
//a status message with the number of points is logged

createParallelPath Creates a path parallel to the original path in the specified distance.

Syntax:

createParallelPath (Double Distance, JoinType aP2, Double Miter

Limit)

Return value:

Path

Example

Path p;
p.addRect(RRect(0,0.09,0.06,0));
Transformation tr;
p.addPath(p.createParallelPath(-0.05,JoinType.Miter,10));
//Positive distance value draws an parallel object inside the origin

756
 7.6 Layout Objects

al one, while negative outside

strokePath(tr,BlackFill,p);

get Gets the coordinates of a point with the specified segment ID (index).

Syntax:

get (Int SegmentIdx)

Return value:

RVector

Example

Path p;
p.moveTo(RVector(0, 0));
p.lineTo(RVector(0.064, 0));
p.lineTo(RVector(0.064, 0.035));
p.lineTo(RVector(0, 0.035));
p.lineTo(RVector(0, 0));
fillPath(Transformation (), BlackFill,p);
logMessage(p.get(2).toString());
//returns the coordinates of the point in the segment with index 2:
0.64,0.35

isLineOnly If True is returned, the path is created only from straight lines.

Syntax:

isLineOnly ()

Return value:

Bool

LastMove Returns the coordinates of last Move to point.

Syntax:

LastMove
getLastMove ()

Return value:

RVector

lineTo Makes a line to selected point.

Syntax:

lineTo (RVector aP1)

757
7 Layout Module

Return value:

Void

Example

Path p;
p.moveTo(RVector(0, 0));
p.lineTo(RVector(0.0809625, 0.03042708));

minus Subtracts the selected paths.

Syntax:

minus (Path aP1)

Return value:

Void

Example

Path a;
a.addCircle(RVector (0, 0),(0.01));
Path b;
b.addCircle(RVector (0.015, 0),(0.01));
a.minus(b);
strokePath(Transformation (), BlackFill,LineStyle,a);

moveTo Moves the drawing pen to selected point.

Syntax:

moveTo (RVector aP1)

Return value:

Void

Example

Path p;
p.moveTo(RVector(0, 0));

multiply Returns the intersection of the given paths.

758
 7.6 Layout Objects

Syntax:

multiply (Path aP1)

Return value:

Void

Example

Path p;
p.addCircle(RVector (0, 0),(0.01));
Path a;
a.addCircle(RVector (0.015, 0),(0.01));
a.multiply(p);
strokePath(Transformation (), BlackFill,LineStyle,a);

plus Adds the selected path.

Syntax:

plus (Path aP1)

Return value:

Void

Example

Path p;
p.addCircle(RVector (0, 0),(0.01));
Path a;
a.addCircle(RVector (0.015, 0),(0.01));
a.plus(p);
strokePath(Transformation (), BlackFill,LineStyle,a);

toSimple Simplifies the given path. This has no effect on path appearance but it makes the
path processing faster.

Syntax:

toSimple ()

759
7 Layout Module

Return value:

Path

toString Converts the path into a string representation.

Syntax:

toString ()

Return value:

String

transform Applies the selected transformation.

Syntax:

transform ()

Return value:

Void

Type Gets segment type.

Syntax:

Type [Int SegmentIdx]

getType (SegmentIdx)

Return value:

Int

Segment type values:

pMove=0

pLine=1

pBezier1=2 (Bezier curve with 1 leading point)

pBezier2=3 (Bezier curve with 2 leading points)

pBezier3=4 (Bezier curve with 3 leading points)

pConic1=5 (conic curve with 1 leading point)

pConic2=6 (conic curve with 2 leading points)

Example

Path p;
p.moveTo(RVector(0, 0));
p.bezierTo(RVector(0.025, 0), RVector(0.062, -0.02), RVector(0.076, 0));
p.lineTo(RVector(0.076, 0.052));

760
 7.6 Layout Objects

p.lineTo(RVector(0, 0.052));
p.lineTo(RVector(0, 0));
strokePath(Transformation(),BlackFill,p);
logMessage(p.Type[1].toString());
//returns "2" as the second segment (index: 1) is a Bezier curve with
one leading point

Path Object Methods

assign Assigns a path object defined in Layout (can be used this way: a=b).

Syntax:

assign (PathObject aP1)

Return value:

Void

Rect Methods
assign Assigns a rectangle defined by four points.

Syntax:

assign (Int aP1, Int aP2, Int aP3, Int aP4)

Assigns a path object defined in Layout (can be used this way: a=b).

Syntax:

assign (Rect aP1)

Return value:

Void

RRect Methods
See the section RRect Methods for methods listing.

761
7 Layout Module

RVector Methods
RVector is defined in Double, Vector in Int coordinates.

AngleInDegrees Gets the vector angle in degrees.

Syntax:

AngleInDegrees

Return value:

Double

AngleInRadians Gets the vector angle in radians.

Syntax:

AngleInRadians

Return value:

Double

Area Multiplies X and Y.

Syntax:

Area

Return value:

Double

Example

RVector r;
r.assign(0.5,1.0);
logMessage(r.Area.toString());

assign Assigns values to a vector.

Syntax:

assign (Double aP1, Double aP2)

assign (RVector aP1)

assign (Vector aP1)

Return value:

Void

ceilToVector Rounds up to Int numbers (RVector changes to Vector).

762
 7.6 Layout Objects

Syntax:

ceilToVector

Return value:

Vector

Example

RVector r;
r.assign(0.6,1.4);
r.ceilToVector(); //rounds to 1,2

divide Divides by selected values (can be used as a/b).

Syntax:

divide (Double aP1)

divide (RVector aP1)

Return value:

Void

equal If True is returned, RVector equals to selected value (== can be used).

Syntax:

equal (RVector aP1)

Return value:

Bool

floorToVector Rounds down to Int numbers (RVector changes to Vector).

Syntax:

floorToVector

Return value:

Vector

Example

RVector r;
r.assign(0.6,1.4);
r.floorToVector(); //rounds to 0,1

isNull If True is returned, RVector is not initialized (does not overwrite memory).

763
7 Layout Module

Syntax:

isNull ()

Return value:

Bool

Length Gets the vector length.

Syntax:

Length ()
getLength ()

Return value:

Double

ManhattanLength Gets Manhattan length (X+Y).

Syntax:

ManhattanLength
getManhattanLength ()

Return value:

Double

minus

Unary minus.

Syntax:

minus ()

Return value:

RVector

Subtracts selected values (can be used as a-b).

Syntax:

minus (Double aP1)

minus (RVector aP1)

Return value:

Void

multiply Multiplies by selected values (can be used as a*b).

Syntax:

multiply (Double aP1)

multiply (RVector aP1)

764
 7.6 Layout Objects

Return value:

Void

normalize Makes the vector length equal to 1.

Syntax:

normalize ()

Return value:

RVector

plus

Unary plus.

Syntax:

plus ()

Return value:

RVector

Adds selected values (can be used as a+b).

Syntax:

plus (Double aP1)

plus (RVector aP1)

Return value:

Void

roundToVector Rounds to Int numbers (RVector changes to Vector).

Syntax:

roundToVector ()

Return value:

Vector

setX Sets X value.

Syntax:

setX (Double aP1)

Return value:

Void

setY Sets Y value.

765
7 Layout Module

Syntax:

setY (Double aP1)

Return value:

Void

SquareLength Gets square vector length.

Syntax:

SquareLength (Double aP1)

getSquareLength ()

Return value:

Double

toString Converts RVector into a string representation.

Syntax:

toString ()

Return value:

String

transform Applies a transformation on RVector.

Syntax:

transform (Transformation aP1)

Return value:

RVector

X Gets X value.

Syntax:

X
getX ()

Return value:

Double

Y Gets Y value.

Syntax:

Y
getY ()

766
 7.6 Layout Objects

Return value:

Double

Transformation Methods
apply Applies transformation

Syntax:

apply (RVector aP1)

Return value:

RVector

assign

Assigns coordinates of transformation matrix.

Syntax:

assign (Double aC0, Double aC1, Double aC2, Double aC3,

Double aC3, Double aC3)

Initializes transformation with the defined scale.

Syntax:

assign (Double aScale)

Assigns normal transformation (can be used this way: a=b).

Syntax:

assign (NormalTransformation aNT)

Initializes Transformation with transposition defined by RVector.

Syntax:

assign (RVector aVector)

Assigns transformation (can be used this way: a=b)

Syntax:

assign (Transformation aT)

Return value:

Void

Epsilon Gets epsilon (number so small that it is considered zero).

767
7 Layout Module

Syntax:

Epsilon
getEpsilon ()

Return value:

Double

equal Compares transformations for equality (== can be used).

Syntax:

equal (Transformation aT)

Return value:

Bool

Expansion Returns the scale value, from which you can find out whether an object is smal-
ler/larger than before transformation.

Syntax:

Expansion
getExpansion ()

Return value:

Double

flipX Flips on the X axis.

Syntax:

flipX ()

Return value:

Void

flipY Flips on the Y axis.

Syntax:

flipY ()

Return value:

Void

Example

Transformation t;
t.flipY();
drawImage(t,Image01);

768
 7.6 Layout Objects

get Returns the value of the specified point in the transformation matrix.

Syntax:

get (Int aP1)

Return value:

Double

invert Inverts transformation.

Syntax:

invert ()

Return value:

Void

isRectilinear If True is returned, transformation may take place for X independently on Y.

Syntax:

isRectilinear ()

Return value:

Bool

less Compares two transformations; returns true if the transformation produces a smaller
object that the one to which it is compared.

Syntax:

less (Transformation aT)

Return value:

Bool

Example

Transformation t;
t.scale(0.3);
Transformation r;
r.scale(0.45);
Bool b=t.less(r);
logMessage (b.toString());

minus Inverts transformation.

769
7 Layout Module

Syntax:

minus ()

Return value:

Transformation

multiply

Multiplies the specified transformation and saves the result.

Syntax:

multiply (Transformation aT)

Return value:

Void

Multiplies the specified transformation and returns the result.

Syntax:

multiply (Transformation aT)

Return value:

Transformation

Example

Transformation t;
t.scale(0.30);
t.multiply(t); //doubles the scale ratio
drawImage(t,Image01);

OnlyTransposition Creates transformation with the selected transposition.

Syntax:

OnlyTransposition
getOnlyTransposition ()

Return value:

RVector

reset Resets the performed transformation.

Syntax:

reset ()

770
 7.6 Layout Objects

Return value:

Void

Example Draws four images on a page (2x2) with 5mm space between each other.

Transformation move;
for (Int i= 0; i<2; i++)
{
for (Int j= 0; j<2; j++)
{
move.translate(i*0.005,j*0.005);
drawImage(move,picture1);
move.reset();
//move has to be reset, else it would continue from the last point
where the object was moved to
}
}

rotate Rotates object by the specified angle.

Syntax:

rotate (Double aR)

Return value:

Void

Example

Transformation t;
t.rotate(-45);
drawImage(t,Image01);

scale

Changes scale.

Syntax:

scale (Double aScale)

Example

Transformation t;
t.scale(0.3); //decreases the size to 30% of the original size
drawImage(t,Image01);

Changes scale separately for X and Y.

771
7 Layout Module

Syntax:

scale (Double aScaleX, Double aScaleY)

Example

Transformation t;
t.scale(0.3,0.6);
drawImage(t,Image01);

Changes scale separately for X and Y according to 2 parameters.

Syntax:

scale (RVector aVector)

Return value:

Void

set Sets the specified point in the transformation matrix.

Syntax:

set (Int aP1, Double aVector)

Return value:

Void

shearX Sets shear value for X.

Syntax:

shearX (Double aR)

Return value:

Void

Example

Transformation t;
t.shearX(10);
drawImage(t,Image);

shearY Sets shear value for Y.

Syntax:

shearY (Double aR)

772
 7.6 Layout Objects

Return value:

Void

toString Converts Transformation into a string representation.

Syntax:

toString ()

Return value:

String

translate Set translation [x,y] to the transformation.

Syntax:

translate (Double aP1, Double aVector)

translate (RVector aVector)

Return value:

Void

Example

Transformation center;
RVector flowSize=formatFlowTo(Size,Flow1); //size of flow from e.g
script data input module
RVector startPosition=(Size/2)-(flowSize/2); //starting position, the
center of the scripted object
center.translate(startPosition); //moves to the starting
position
drawFlow(center,Size,Flow1); //places the flow to the
starting position

Type Gets transformation type (Identity, Scaling, Transposition, General, ScaleTrans).

Syntax:

Type
getType ()

Return value:

TransformationType

WithoutTransposition Creates copy of transformation without transposition.

Syntax:

WithoutTransposition
getWithoutTransposition ()

773
7 Layout Module

Return value:

Transformation

x Applies transformation on X only.

Syntax:

x (Double aX)

Return value:

Double

y Applies transformation on Y only.

Syntax:

y (Double aY)

Return value:

Double

TransformationType Methods
General Transformation type General (can combine more types).

Syntax:

TransformationType.General

Identity No transformation.

Syntax:

TransformationType.Identity

ScaleTrans Transformation type Scaling and Transposition.

Syntax:

TransformationType.ScaleTrans

Scaling Transformation type Scaling.

Syntax:

TransformationType.Scaling

Transposition Transformation type Transposition.

Syntax:

TransformationType.Transposition

774
 7.6 Layout Objects

Overview of Conversions and Methods for Layout Objects

Barcodes
drawBarcode Draws a barcode with given transformation into the scripted area. Returns
True, if drawing was successful.

Syntax:

drawBarcode (Transformation aP1, Barcode aP2)

Return value:

Bool

BarcodeSize Returns the size of barcode.

Syntax:

BarcodeSize [Barcode aP1]

getBarcodeSize (Barcode aP1)

Return value:

RVector

Conversions
fromin Converts from inches to meters.

Syntax:

fromin (Double aP1)

Return value:

Double

frommm Converts from millimeter to meters.

Syntax:

frommm (Double aP1)

Return value:

Double

frompt Converts from points to meters.

Syntax:

frompt (Double aP1)

Return value:

Double

775
7 Layout Module

toin Converts from meters to inches.

Syntax:

toin (Double aP1)

Return value:

Double

tomm Converts from meters to millimeter.

Syntax:

tomm (Double aP1)

Return value:

Double

topt Converts from meters to points.

Syntax:

topt (Double aP1)

Return value:

Double

Flow
drawFlow Draws a flow with given transformation and size into the scripted area. Returns
True, if the flow fitted the flow area.

Syntax:

drawFlow(Transformation aP1, Rvector aP2, Flow aP3)

Return value:

Bool

drawFlowOnPath Draws a flow on path with given transformation into the scripted area.
Returns True, if drawing was successful.

Syntax:

drawFlowOnPath (Transformation aP1, Path aP2, Flow aP3)

Return value:

Bool

formatFlowTo

Formats a flow into the scripted area. Returns True, if flow formatting was success-
ful.

776
 7.6 Layout Objects

Syntax:

formatFlowTo (Path aP1, Flow aP2)

Return value:

Bool

Flow gets formatted and returns its real size.

Syntax:

formatFlowTo (RVector aP1, Flow aP2)

Return value:

RVector

Formats a flow into the scripted area. Returns the baseline position of the first line
of the text inside the formatted flow.

Syntax:

formatFlowTo (RVector aP1, Flow aP2, Double & aFirst

BaseLine)

Return value:

RVector

Example This script places the first line 5cm from the baseline.
Double baseLine;
formatFlowTo(RVector(0.15,0.1), Flow_1, baseLine);
drawFlow(Transforma
tion(RVector(0,0.05-baseLine)),RVector(0.15,0.1),Flow_1);

wasError Flag set after calling formatFlowTo method if error occurred.

Syntax:

wasError ()

Return value:

Bool

wasHorizontalOverflow Flag set after calling formatFlowTo method if horizontal overflow

occurred.

Syntax:

wasHorizontalOverflow ()

Return value:

Bool

777
7 Layout Module

wasVerticalOverflow Flag set after calling formatFlowTo method if vertical overflow occurred.

Syntax:

wasVerticalOverflow ()

Return value:

Bool

WorldWideSupport Enables enhanced support for languages with right-to-left reading order
(Arabic, Hebrew, Indic, etc.). See the section Arabic, Hebrew, Indic Languages Support for
details.

Syntax:

WorldWideSupport

Return value:

Bool

SupplementaryCharSupport Enables support of the supplementary characters. See the

Workflow/Layout General Options section for more details.

Syntax:

SupplementaryCharSupport

Return value:

Bool

Flow Area
FlowAreaDim Gets the real size of the specified flow area.

Syntax:

FlowAreaDim [FlowArea aP1]

getFlowAreaDim (FlowArea aP1)

Return value:

RVector

Image
drawImage Draws an image with given transformation into the scripted area. Returns True,
if drawing was successful.

Syntax:

drawImage (Transformation aP1, Image aP2)

778
 7.6 Layout Objects

Return value:

Bool

ImageSize Returns the size of the image in points.

Syntax:

ImageSize [Image aP1]

getImageSize (Image aP1)

Return value:

RVector

RealImageSize Returns the size of the image according to DPI.

Syntax:

RealImageSize [Image aP1]

getRealImageSize (Image aP1)

Return value:

RVector

Path
setCurCapType Sets CapType (But, Round, Square); default is But.

Syntax:

setCurCapType ()

Return value:

Void

setCurJoinType Sets JoinType (Bevel, Miter, Round); default is Bevel.

Syntax:

setCurJoinType ()

Return value:

Void

fillPath Fills a path with given transformation and fill style into the scripted area. Returns
True, if filling was successful.

Syntax:

fillPath (Transformation aP1, FillStyle aP2, Path aP3)

Return value:

Bool

779
7 Layout Module

LineWidth Gets line width.

Syntax:

LineWidth
getLineWidth ()

Return value:

Double

setLineWidth Sets line width; default is 0.0005 m.

Syntax:

setLineWidth (Double aP1)

Return value:

Void

setMiter Sets miter; default is 1.

Syntax:

setMiter (Double aP1)

Return value:

Void

strokePath Draws the path outlines with given transformation and fill style into the scripted
area. Returns True, if drawing was successful.

Syntax:

strokePath (Transformation aP1, FillStyle aP2, LineStyle aP3,

Path aP4)
strokePath(Transformation aP1, FillStyle aP2, Path aP3)

Return value:

Bool

Path Object
drawPathObject Draws a path object with given transformation into the scripted area. Returns
True, if drawing was successful.

Syntax:

drawPathObject (Transformation aP1, PathObject aP2)

Return value:

Bool

780
 7.6 Layout Objects

Scripted Area
queryObjectTransformationAndSize Returns True, if an area with given transformation
and size was found.

Syntax:

queryObjectTransformationAndSize (String aP1, Transformation &

aP2, RVector & aP3)

Return value:

Bool

Example To achieve this result, the method queryObjectTransformationAndSize

was used as indicated below the image.

Transformation tr;
RVector size;
Bool ret=queryObjectTransformationAndSize("Pages.Page1.Shape1", tr,
size);
Transformation tmp;
RVector bsize;
ret=queryObjectTransformationAndSize("Pages.Page1.Barcode1", tmp, bsize);
tr.scale(size/bsize);
drawBarcode(tr, Barcode1);

removeFromWhiteSpace Intended to be used with message areas. Removes the extent of

the scripted area from the available white space.

The method with the RRect parameter enables you to use your own defined rectangle,
while the method with the String parameter requires entering the coordinates in string
format, typically taken from a sheet name. See also the section Text in Rect Module.

Syntax:

removeFromWhiteSpace (RRect aP1)

removeFromWhiteSpace (String aP1)

781
7 Layout Module

Return value:

Void

Size Returns size of the scripted area.

Syntax:

Size

Return value:

RVector

Preprocessing Returns true, if the script is currently run in preprocessing. It is meaningful

to use only if the check-box Run also in preprocessing is enabled.

Syntax:

Preprocessing

Return value:

Bool

BeforePage Returns true, if the script is currently run in before-page preprocessing. It is

meaningful to use only if the check-box Run also in preprocessing is enabled.

Syntax:

BeforePage

Return value:

Bool

setOverflow Allows to set the value of the SYS.Overflow variable to true. An attempt to set
the value to false using this script will not change the value of the SYS.Overflow variable.

Syntax:

setOverflow (Bool aP1)

Return value:

Bool

782
 7.6 Layout Objects

7.6.32 Shapes
In this section: See also:
Creating Shapes Text on Curve
Shape Layout Properties Panel
Modifying Shapes

The Layout toolbar contains several tools that you may use for creating and modifying shapes
that you can insert into your document. Their usage is described in the following sections.

7.6.32.1 Creating Shapes

Shapes can be created using predefined templates for basic geometric shapes or by using the
Freehand and Bezier tools for custom objects.

Creating Predefined Shapes

To create a predefined shape, do the following:

1. Click on the Shape Tool .

Tip If you want another shape, right-click on the Shape Tool and select the icon
you want from the menu:

2. Drag the cursor within the Layout Area to create the selected predefined shape. By
default, the shapes (i.e. rectangles, triangles, ellipses, stars and polygons) will look like
this:

Note The fill and outline colors have been added on the Content tab of the Shape
Layout Properties.

783
7 Layout Module

3. When using stars and polygons it is possible to alter the default attributes (rotation,
points etc.) to achieve a more customized appearance. To access the according dialogs
(called Insert Star and Insert Polygon) do the following:

Select the star/polygon you want to modify (it can also be any other type of shape
that you would like to convert to a star or a polygon).

Go to the Content tab of that object's Layout Properties panel and select the Star
or Polygon icon located at the bottom of this tab. The according "Insert"
dialog will be opened:

When you click the Star icon, the following dialog is displayed allowing
you to specify its appearance:

Options Description

Points Sets the number of inner and outer points the star will have.

Stars consist of inner and outer points. This is important to know so that
you can understand the way the settings in the Insert Star dialog work.
The settings in the above screenshot will create a star looking like this
(the fill and outline colors have been added on the Content tab of the
Shape Layout Properties):

Legend

a. Outer point

b. Inner point

As visible in the above screenshot, setting 10 in the Points edit-box creates

ten inner points and ten outer points.

Point offset The inner points of the star will be rotated to the right by the
number of points specified. The outer points of the star will not be moved.
The maximum value of Point offset is the value set in Points 1.

784
 7.6 Layout Objects

Example Setting Point offset to 1 for the star above will move
the position of each inner point to the right to the position of the
next inner point and will look like this:

Start angle Sets the rotation of the star.

Offset angle The inner points of the star will be rotated to the right by the
value set for Offset angle. The outer points of the star will not be moved
(i.e. this option changes the appearance of a star in the same way as the
Point offset option above, only here the offset is not specified by the
number of points but by the rotation angle).

By default, the value for Offset angle is 180 divided by the value set in
the Points edit-box to give the star a standard appearance (values are
rounded when necessary).

Example Setting a value of 56 in Offset angle in the above

screenshot of the Insert Star dialog will produce the same result as
setting Point offset to 1 (see the description of the Point offset
option for the screenshot).

Radius ratio Sets the radius ratio of the circle at the center of the star
(comprised of the inner points) in comparison to the radius of the whole
star.

Example The setting in the screenshot above sets the radius of

the inner circle of the star to 20% of the radius of the whole star.

When you click on the Polygon icon, the following dialog is displayed al-
lowing you to specify its appearance:

The settings in the above screenshot will create a polygon looking like this
(the fill and outline colors have been added on the Content tab of the Shape
Layout Properties):

785
7 Layout Module

Options Description

Points Sets the number of corners the polygon will have.

Point offset This setting is not available for polygons.

Start angle Sets the rotation of the polygon.

Offset angle This setting is not available for polygons.

Radius ratio This setting is not available for polygons.

4. If necessary, you can further modify the newly created shape. See the section Modifying
Shapes for details.

5. Complete the Layout Properties panels to apply attributes to the shapes.

Creating Shapes Using the Draw Freehand and the Draw

Bezier Tools
The Draw Freehand and Draw Bezier tools allow you to create custom objects.

Using the Draw Freehand Tool

Use the Draw Freehand tool to create custom shapes.

1. Select the Draw Freehand Tool icon from the Layout toolbar.

2. Left click into the layout and hold the mouse button while you draw the desired shape.

3. When you let go of the left mouse button a new shape node will be created in the
Layout Tree.

4. If necessary, you can modify the newly created shape. See the section Modifying Shapes
for details.

5. Select the newly created shape in the Layout Tree and go to the Layout Properties to
apply attributes to the shape.

Tip Use the Make curve closed, enable it to fill icon located on the Path Description
tab to ensure that the beginning and end of the object are joined. No fill style can be applied
to newly created shapes whose ends dont meet and thus close the shape (this can be difficult
to achieve manually).

786
 7.6 Layout Objects

Using the Draw Bezier Tool

Use the Draw Bezier tool to create custom shapes with smooth rounded borders or shapes
composed of multiple straight lines.

1. Select the Draw Bezier Tool icon in the Layout toolbar.

2. As mentioned above, there are two possibilities of using the Bezier tool:

For straight lines: Go to the layout, press and release the left mouse button. A
point is created. Move the mouse pointer to another position and again press and
release the left mouse button. A straight line is created between the two points.
Continue this action until the desired shape has been created.

For rounded borders: This is an example of creating a shape with smooth rounded
borders; follow the steps described below:

Example

In the layout, press and hold the left mouse button and pull the mouse
pointer downwards. Pressing the mouse button creates a path point and
pulling the mouse downwards creates a control point in the opposite
direction. Let go of the mouse button to create the control point. The
result of this action should look like this:

Now move the mouse pointer to the right on a parallel height with the
first path point and again press and hold the left mouse button, only this
time move the mouse pointer upwards and then release the button.
Now, the Bezier should look like this:

To complete the circle move the mouse pointer back to the starting point
and again press and hold the left mouse button and pull it downwards.
The shape will now be complete as in the screenshot below.

787
7 Layout Module

Tip It is also possible to combine both methods of using the Draw Bezier tool in one
shape.

3. Press the right mouse button to finish the shape. A new shape node will be created in
the Layout Tree.

4. If necessary, you can modify the newly created shape. See the section Modifying Shapes
for details.

5. Select the newly created shape in the Layout Tree and go to the Layout Properties to
apply attributes to the shape.

Tip Use the Make curve closed, enable it to fill icon located on the Path Description
tab to ensure that the beginning and end of the object are joined. No fill style can be applied
to newly created shapes whose ends dont meet and thus close the shape (this can be difficult
to achieve manually).

7.6.32.2 Shape Layout Properties

Use the Shape Layout Properties to specify the appearance of the shapes you have created.
Following tabs are available:

Position Tab

Runaround Tab

Content Tab

Path Description Tab

Position tab
Refer to the Position Tab section for details.

Runaround Tab
If you place a shape into a flow area filled with text, it is possible to let the text run around this
shape instead of having text and shape overlap. Specify the runaround type you would like in
this tab. Settings available on this tab vary according to the selection made in the Type combo-
box. See the description below for details.

788
 7.6 Layout Objects

Note The Runaround option in combination with flow areas vertical alignment works correctly
only if the vertical alignment is set to Top.

Options Description

Type

None - This is the default setting. No runaround is applied. Text will run either over
or under the shape placed in the flow area (this depends on the Z-order of the
shape and flow area, i.e. which object has been placed on top of the other). No
further options are available.

Square Text will run around the outer boundaries of the shape. When selected,
you can specify the way text should run around on the side of the shape in the
Wrap type combo-box. Options are:

Both This is the default setting. Text runs around on both sides of the shape
(as in the screenshot below).

Left Text runs around only on the left side of the shape.

Right Text runs around only on the right side of the shape.

Largest Text runs around only on the side of the shape that is larger.

Additionally, it is also possible to specify individual values for the margins between
the text and the shape in the Left, Top, Right and Bottom edit-boxes. Use the
Invert check-box to place the text inside of the shape instead of having it run
around outside of the shape.

Example Square is selected and Wrap type is set to Both:

Tight Text will run around the inner boundaries of the shape as close as possible
to the shape. When selected, you can also specify the way text should run around

789
7 Layout Module

on the sides of the shape in the Wrap type combo-box. Options are: Both, Left,
Right and Largest. Check the description of the Square option above for details on
these setting options. Additionally, it is also possible to specify a value for the
margins between the shape and text in the Margin edit-box. Use the Invert check-
box to place the text inside of the shape instead of having it run around outside
of the shape.

Example Tight is selected and Wrap type is set to Both:

Through Text will run around the inner boundaries of the shape as close as pos-
sible to the shape. Additionally, if the shape has any vacant space within its borders,
this space will also be filled with text. When selected, it is also possible to specify
a value for the margins between the shape and text in the Margin edit-box. Use
the Invert check-box to place the text inside of the shape instead of having it run
around outside of the shape.

Example Through is selected:

Top and bottom Text will run above and below the shape, but not on the left or
right. When selected, it is also possible to specify values for the top and bottom
margins between shape and text in the Top and Bottom edit-boxes.

Top Only the text above the shape will be shown in the current flow area. Text
that follows the shapes position will be overflowed. Therefore, to see it an overflow
must be set to the next page or to another flow area. When selected, it is also
possible to specify a value for the top margin between shape and text in the Top
edit-box.

Note In addition to the runaround setting made for the shape in this tab you must also enable
runarounds in the flow area over which you placed the shape for the runaround to work. Go
to the Runaround combo-box in the Content tab of the according flow areas layout properties
and make the appropriate settings there.

790
 7.6 Layout Objects

Content Tab

Options Description

Line Width Sets the width of the outline of the shape.

Miter Controls the effect of the Join setting when Miter has been selected there. You can
specify the length ratio of the miter which sets the maximum distance between the corner
and the middle of the border line. This will affect the appearance of corners. The effect
of miter settings depends on the angle of the corners. The smaller the angle inside the
object is, the larger the setting for miter must be to allow the maximum distance of the
corner.

Example High value for Miter is set:

Low value for Miter is set:

Cap Selects the appearance of the end of a line: Butt, Round or Square.

791
7 Layout Module

Join Selects the shape of corners that will be used. You can choose from the following options:

Miter - pointed corners

Round - rounded corners

Bevel - flattened corners

Note Caps and Joins are not supported by the AFP engine config if Graphic support
is set to Full with outlines on its General tab.

Fill Style Sets the color of the shape.

Line Fill Style Sets the color of the outline of the shape.

Line Style Enables you to select an existing line style or create a new one.

Overlap If checked, vacant areas inside of a shape are considered as areas not belonging to
the shape and will not be filled when a fill is applied to the shape. If unchecked all areas
within the border lines are filled.

Example Overlap is checked:

Overlap is not checked:

Runaround fill only This option is relevant when text runs around a shape. When checked,
the border of a shape will not be considered to be part of the shape; the runaround will
be oriented to the fill of the shape only.

Note This can lead to overlapping of text and shape borders, especially when the width
of the border is set to a relatively high value.

URL target Select a variable containing an Internet URL in this combo-box. The URL link will
then be active in the output files in PDF, TNO, and HTML format.

792
 7.6 Layout Objects

Note

For HTML and HTML Simple outputs the URL link has to contain the http:// prefix,
otherwise the link may not work.

When you proof a job with a shape that has a URL target set, hover the mouse
pointer over that object in proof to have the URL target displayed.

Converts the current shape to the shape selected, keeping the size of
the original shape. If you convert the shape to a star or polygon, a dialog will be opened
where further parameters can be specified.

Path Description Tab

In the Path Description tab the selected shape is displayed as a series of path points. You can
modify your shape by adding or deleting path points or by changing the values for already ex-
isting path points.

Options Description

Type In the Path Points area, shapes are described with the help of four different types of
path points. Path points only describe a single point; this means that at least two path
points (one specifying the starting point and the other specifying the ending point) are
needed to describe a line. Additionally, the LineTo, ConicTo and BezierTo path points also
influence the appearance of the line that is created. See the description below for details:

MoveTo All shapes begin with a MoveTo path point as an initial starting point.
As a MoveTo path point is a simple point, it is described by a single XY-position in
the Path Points area.

LineTo LineTo path points are used to describe rectangles, stars, polygons, triangles
and Bezier drawings consisting of straight lines. LineTo path points have only one
XY-position (see above screenshot) which describes the ending point of the line.
The line begins at the path point situated above the LineTo path point in the Path
Points area (this starting path point can be any of the four types of path point).

ConicTo ConicTo path points describe a parabola shaped line. The appearance
of this parabola is determined by a single control point. Thus, ConicTo path points
are described by two XY-positions in the Path Points area (see above screenshot);
the first XY-position describes the position of the control point and the second one

793
7 Layout Module

sets the ending point of the parabola. The parabola begins at the path point situated
above the ConicTo path point in the Path Points area (this starting path point can
be any of the four types of path point).

BezierTo BezierTo path points are used to describe ellipses, freehand drawings
and curved Bezier drawings. The appearance of Bezier curves is determined by two
control points. Thus, BezierTo path points are described by three XY-positions in
the Path Points area (see above screenshot); the first two XY-positions describe the
positions of the control points and the third one describes the ending point of the
Bezier curve. The Bezier curve begins at the path point situated above the BezierTo
path point in the Path Points area (this starting path point can be any of the four
types of path point).

X Shows the position of the particular path point (or control point) on the X axis.

Y Shows the position of the particular path point (or control point) on the Y axis.

New MoveTo item Creates a new MoveTo item in the Path Points area.

New LineTo item Creates a new LineTo item in the Path Points area.

New ConicTo item Creates a new ConicTo item in the Path Points area.

New BezierTo item Creates a new BezierTo item in the Path Points area.

Make Curve Closed Closes shapes created manually with the Draw Freehand or Draw
Bezier tool by connecting the beginning and the end point of the shape.

Note If shapes are not closed, it is not possible to apply fill styles to them.

Delete item Removes the selected item from the Path Points area.

Delete all items Removes all items except the initial MoveTo item from the Path Points
area.

Edit path as script Click the Edit path as script icon to open the Expression Editor
window. A scripted version of the shape you are working on will be displayed here. You
can modify the object by changing the script or you can copy the script describing a shape
and paste it into the Expression Editor of another shape, text on curve or runaround path
of a flow area in order to give the two objects the same form.

7.6.32.3 Modifying Shapes

There are many different ways to modify an already created shape. The different possibilities
are explained in the sections below.

Using the Change Shape Tool

Select the Change Shape tool icon and click on the shape you would like to modify. The
path points of the shape/Text on Curve will be displayed:

794
 7.6 Layout Objects

Legend

1. Path point

It is now possible to modify the shape by clicking on a path point and altering its position.

Clicking on a BezierTo or ConicTo path point will make the according control point(s) visible
as well. They can also be modified in the same way as the path points:

Legend

1. Control point

Tip When you have selected a shape with the Change Shape tool and the path points of the
shape/Text on Curve are displayed, clicking on a path point in the Path Points field of the Path
Description tab will highlight the corresponding path point or control point in the layout.

You can move through all of the path and control points of a selected object by using the arrow
keys on your keyboard.

Shape Context Menus

To use the options available in the right-click context menus you have to select the Change
Shape tool icon and then select a shape/Text on Curve so that its path points are highlighted.
Depending on where you right-click, there are two variants of context menus available (depend-
ing on the exact point you click on, the options displayed in the two context menus below
might be mixed):

When you right-click directly on a path point, the following commands are available in
the context menu:

795
7 Layout Module

Note The checkmarks to the left of the options show the current state of the path
points preceding and following the selected path point. In the example screenshot
above both path points surrounding the selected path point are BezierTo.

Options Description

Delete Point Deletes the selected path point.

Center Point Centers the selected path point in relation to the two neighboring
points.

Example Before selecting the Center Point option:

After right-clicking the path point in the middle and selecting the Center
Point command the path point is centered between the two surrounding
path points:

Note This option is available only for BezierTo path points positioned between
two other BezierTo path points.

Average control point distances Modifies the position of the control points belong-
ing to a path point by moving the control points so that the path point is situated
exactly in the middle of them. The distance between the two control points is not
changed during this process.

Example Before selecting the Average control point distances command:

After right-clicking the path point in the middle and selecting the Average
control point distances command:

Note This option is available only for BezierTo path points positioned between
two other BezierTo path points.

Convert Previous to Line The path point preceding the selected path point is con-
verted to LineTo.

796
 7.6 Layout Objects

Convert Previous to Conic The path point preceding the selected path point is
converted to ConicTo.

Convert Previous to Bezier The path point preceding the selected path point is
converted to BezierTo.

Convert Previous to Move The selected path point is converted to a MoveTo path
point and thus the segment between this path point and the path point preceding
it is deleted.

Convert Next to Line The path point following the selected path point is converted
to LineTo.

Convert Next to Conic The path point following the selected path point is converted
to ConicTo.

Convert Next to Bezier The path point following the selected path point is converted
to BezierTo.

Convert Next to Move The path point following the selected path point is converted
to a MoveTo path point and thus the segment between the two path points is
deleted.

These options are available after right-clicking above any part of the outline of a
shape/Text on Curve.

Options Description

Insert Point Inserts a new point. The type of the inserted path point will be the same
as the type of the following path point.

Delete Segment Deletes the selected segment. The following path point is converted
to a MoveTo path point.

Convert Segment to Line Converts the selected segment to a line, i.e. the following
path point is converted to a LineTo path point.

Convert Segment to Conic Converts the selected segment to a conic, i.e. the follow-
ing path point is converted to a ConicTo path point.

Convert Segment to Bezier Converts the selected segment to bezier, i.e. the follow-
ing path point is converted to a BezierTo path point.

Note Of the three Convert Segment to... options, only the two appropriate ones
will be visible at any one time in the context menu.

The path point type is displayed in the Type column located on the Path Description
tab.

The Change Shape tool can also be used for modifying objects (shapes, images or text) using
the effects created within the Effect Areas.

797
7 Layout Module

Other Methods of Modifying Shapes

There are many other ways to modify shapes:

1. Select the Selection Tool icon, click on the outer border of the shape and expand
or decrease the size of the shape.

2. Enter new path points or modify existing ones in the Path Points field. See the section
describing the Path Description tab for details.

3. Modify the script describing the appearance of the shape. See the description of the
Edit path as script icon in the Path Description tab section for details.

4. Use the icons at the bottom of the Content tab.

5. Change the size, position, and rotation etc. of the shape in the Position tab.

6. Use the rotation tool located on the Tools toolbar to rotate the shape.

7. Modify the shape using perspective and warp effects. See the description in the Effect
Areas section.

7.6.33 Tables
7.6.33.1 Tables Overview
See also:
How to Create a Table
Table Context Menu
Table Layout Properties
Layout Objects Overview
Row Sets
Cells

Tables provide a powerful way to organize the physical layout and appearance on your page.
They give you total control over where and how text or objects will appear. You can:

Designate whether tables should have a fixed size or vary, depending upon the size of
variable data being called into a cell.

Place tables within tables.

Designate every attribute (e.g., size, borders, colors, type of content, etc.), assign these
attributes to an entire table or to specific rows, and reuse those attributes when you
create another table.

Easily modify the size, content or general appearance of a table.

Tables are easily built in the WYSIWYG environment. You can insert a table into a flow area,
designate the table properties (size, borders, colors, etc.). As you do this, nodes (table, row
sets and cells) are automatically added to the Layout Tree.

798
 7.6 Layout Objects

You can also create a table by adding a table node (and its associated row set and cell nodes)
to the Layout Tree.

No matter which way you prefer to create a table (in WYSIWYG or in the Layout Tree), you
can make settings in the property panels of both environments:

The Border Properties and Cell Properties dialogs, displayed in the WYSIWYG environ-
ment of the Layout window, control the physical appearance of the table.

The Tables Layout Properties panel, displayed in the Layout Tree, controls the type of
information and the behavior of the table.

7.6.33.2 How to Create a Table

In this section: See also:
Inserting a Table into a Flow Area Tables Overview
Basic Table Structure Table Context Menu
First Header and Last Footer Table Layout Properties
Formatting a Table Row Sets
Helpful Hints for Working with Tables Cells

Inserting a Table into a Flow Area

Tables can be created and their appearance defined in the Layout window. Follow the steps
below to create a new table:

1. Create a flow area.

2. Insert a table into this flow area. There are two ways of doing this:

By selecting the Insert Table option from Table menu on the Layout Window
menu.

By right-clicking within a flow area and selecting the Insert Table option from the
Table context menu.

799
7 Layout Module

Tip It is also possible to create a table directly in the Layout Tree. Right click on the
Tables node and select Insert Table. All settings must be made manually. When finished,
drag and drop the table into the desired flow area. Creating a table this way is recom-
mended for advanced users only.

3. Define the basic structure of the table using the Insert Table dialog.

Options Description

Columns Sets the number of columns that the table will have.

Header rows Sets the number of header rows that the table will have.

Body rows Sets the number of body rows that the table will have.

Example If you have a repeated array and wish to alternate the rows of
the table with shaded and unshaded backgrounds, two body rows are needed,
each with different styles applied.

Footer rows Sets the number of footer rows that the table will have.

Repeat body by variable If checked, it enables you to select a variable according

to which the body row will be repeated.

800
 7.6 Layout Objects

Basic Table Structure

The settings in the above screenshot of the Insert Table dialog will create the following logical
structure in the Layout Tree which will be displayed in the Layout accordingly (the sample text
in the table has been added for clarification):

Explanations:

Each single row belonging to RowSet 1 (header/footer) contains two cells, as two
columns were specified in the Insert Table dialog (see RowSet 2 as an example in the
Layout Tree).

The row set type for RowSet 1 is always header/footer, when a header row and/or a
footer row has/have been specified in the Insert Table dialog. In this example the
header row is RowSet 2 and the footer row is RowSet 4.

Due to the specification of header/footer rows, specifying one header row in the Insert
Table dialog will display two header rows under the Tables node in the Layout Tree
(RowSet 2 is in the Layout Tree structure twice) and specifying one footer row in the
Insert Table dialog will display two footer rows under the Tables node in the Layout
Tree (RowSet 4 is in the Layout Tree structure twice). Note that in contrary to the Layout
Tree structure only one header row and one footer row is displayed in the Layout Area.
See First Header and Last Footer section below for details on this.

The body row specified in the Insert Table dialog (in this case RowSet 3) is placed
between the header and footer rows.

First Header and Last Footer

If you have a table in which the data do not fit one page but overflow to a second page (that
can be repeated or the data continue on a third page, etc.), you might want to distinguish
between:

the First Header (only displayed on the first page where the table appears) and the
Header (displayed on all other pages)

and also between the Last Footer (displayed only on the very last page where the table
appears) and the Footer (displayed on all other pages).

In the example above two header rows and two footer rows are displayed in the Layout Tree
but only one of each is displayed in the Layout itself. It is because until now RowSet 2 has been
assigned to the Header and the First Header whereas RowSet 4 has been assigned to the
Footer and the Last Footer.

801
7 Layout Module

To make specific settings for the First Header and the Last Footer, follow these steps:

1. Select the header/footer row set (in this example RowSet 1) in the Layout Tree.

2. Change the row set assignment in the Layout Properties in order to be able to enter
different text for the Header and the First Header and for the Footer and the Last
Footer respectively. To change the row set assignment simply open the drop-down
menu next to the row that you want to change the assignment for (in the below
screenshot the Last Footer):

Now you can either:

Select an already created row set from the list (only row sets with the same number
of columns will be available for selection),

or create a new row set by selecting Create New RowSet from the drop-down
menu. Row sets created this way will automatically have the correct number of
columns.

Note The number of columns of the row set is displayed in the bottom left corner
of the Layout Properties (there are 2 columns in this example).

3. Now check Display all rows in order to have the two header and the two footer rows
displayed in Layout. The table will now appear in Layout like this (the sample text in
the table has been added for clarification):

Note When Display all rows is checked, the First Header and Header rows will always
be displayed at the beginning of the table and the Footer and Last Footer will always
be displayed at the end of the table in the Layout, even if the table overflows between
pages or flow areas. Keep in mind that this way of displaying the header and footer
rows does not resemble the result you will get when proofing or printing the job. This
option is useful when you have a body row that is repeated by a variable that will fill
several pages when proofed or printed.

802
 7.6 Layout Objects

When Display all rows is not checked, the header and footer rows will be displayed
only when proofing or printing. For a table staying on one page and in one flow area
this means the First Header and Last Footer will be displayed in Layout. If the table
overlaps on to a second page or flow area or more, then the first page/flow area will
display the First Header and the Footer and the last page/flow area will display the
Header and Last Footer. Any pages/flow areas in between these two will display the
Header and the Footer.

Formatting a Table
To format tables, you have the following options:

1. The newly created table can be found in the Table node of the Layout Tree. If there is
more than one table, the new table will be the last one in the list of tables. In the Table
Layout Properties it is possible to set values for spacing, for adjusting the width of the
columns in percent, etc.

2. Right-click within the table and select Table Border Style from the context menu to
display the Border Properties dialog. Here you can set borders/shading, margins and
offsets for the table.

3. Right-click within the table and select Table Cell Properties from the context menu
to display the Cell Properties dialog. Here you can define the properties of single cells
or a range of selected cells.

Helpful Hints for Working with Tables

These hints will make working with tables easier:

When working in the WYSIWYG mode, be sure that the Flow area tool icon has
been selected when you want to select a table.

It is recommended to rename the table and the associated row sets appropriately in
the Layout Tree for easy management when working with more than one table.

You can manually adjust the height and width of cells by holding down the <Ctrl> key
and moving the column or row border with the mouse (with the left button held down).

If you delete a table, row or cell from the Layout window, the node remains in the
Layout Tree, where it can either be retrieved for later use or deleted.

For complex tables, incorporating static and variable information, or multiple arrays,
you can create tables within tables.

803
7 Layout Module

7.6.33.3 Table Context Menu

In this section: See also:
Border Properties Dialog Tables Overview
Cell Properties Dialog How to Create a Table
Table Layout Properties
Row Sets
Cells

The table related options described in the list below appear when you select a table and:

Select Table from the Layout Window menu

or

Right-click on a cell or a selection of cells.

Note When right-clicking a single cell, other options not concerning tables will also
appear in the menu.

Availability of the options below depends upon the area of the table that has been selected.

Options Description

Insert Table Inserts a table into the selected flow area. The Insert Table dialog allowing you
to define the table parameters will be opened.

This option is active only if the Flow Area Tool is selected.

Tip You can insert a table within a table.

Insert Reveals a sub-menu allowing you to select:

Insert Row Opens the Insert Row(s) dialog:

804
 7.6 Layout Objects

Count Specifies the number of rows that will be added to the selected table.

Insert The following options are available here:

Above Inserts the specified number of rows above the currently selected
row(s).

Below Inserts the specified number of rows below the currently selected
row(s).

Insert Column Opens the Insert Column(s) dialog:

Count Specifies the number of columns that will be added to the selected table.

Insert The following options are available here:

Left Inserts the specified number of columns to the left of the currently
selected column(s).

Right Inserts the specified number of columns to the right of the cur-
rently selected column(s).

Delete Reveals a sub-menu allowing you to select:

Delete Column Deletes the currently selected column of the table.

Note To delete a row from a table, select the according node of the row set in the Layout
Tree and delete it there.

Table Border Style Opens the Border Properties dialog, where you can further specify
parameters for the borders, shading and margins/offsets of the selected table.

Table Cell Properties Opens the Cell Properties dialog, where you can further specify para-
meters for the cells of the selected table.

Merge Cells Merges selected cells into a single cell.

Note Set the cell properties before merging cells. Changing the properties later is possible,
but tricky.

Unmerge Cells Unmerges cells previously merged using the Merge Cells command or by
having selected Span Up or Span Left available on the Cell Properties dialog and the Cell
Layout Properties.

805
7 Layout Module

Distribute Columns Evenly Resizes selected columns to equal widths.

Distribute Rows Evenly Resizes selected rows to equal heights.

Border Properties Dialog

The Border Properties dialog enables you to define the physical appearance of the table.

To access this dialog:

Select Table | Table Border Style from the Layout Window menu.

or

Right-click within the table and select Table Border Style from the context menu.

806
 7.6 Layout Objects

Options Description
For a description of the options not described just below, see the Border Styles section.

Border Style Allows you to select an already existing border style or to create a new border
style. By default, the value set here is Empty, which means that all options are set to their
default values.

If you have already created a border style you would like to apply to the table/cell(s), select
that style in this combo-box. Then, all options in the dialog will be filled with the values
which have been specified for the border style you have selected. Click on OK or Apply
and this border style will be applied to the table/cell(s) according to the setting made in
the Apply to combo-box.

If you want to create a new border style, simply fill in the options with the values you re-
quire. As soon as you change any of the settings, Modified will be displayed in the Border
Style combo-box. When you then click on either OK or Apply, a new border style will
be created in the Layout Tree under the Border Styles family.

Apply to Enables you to specify which part(s) of the table your changes will be applied to
when you click on the Apply or OK buttons. The following options are available:

Selection cells Applies the specified properties to the selected cells. This is the
default setting.

Table cells Applies the specified properties to all cells of the table, regardless if
the cells are selected or not.

Table Applies the specified properties to the outside border of the whole table,
but not to individual cell borders within the table.

All table Applies the specified properties to both the table and all cells within the
table. This setting combines the Table and Table cells setting.

Boundary Applies the specified properties to the outside borders of the selected
cells only; settings already applied to the borders inside the selection will be kept.

Example Cell appearance before modification:

Selection of multiple cells:

BlackFill has been selected in the Line fill style combo-box on the
Lines/Corners tab and Boundary was selected in the Apply to combo-box
before clicking on OK:

807
7 Layout Module

Boundary and clear Applies the specified properties to the outside borders of the
selected cells only; the borders inside the selection will be set back to the default
setting.

Example Cell appearance before modification:

Selection of multiple cells:

BlackFill has been selected in the Line fill style combo-box on the
Lines/Corners tab and Boundary and clear was selected in the Apply to
combo-box before clicking on OK:

Note To select a single cell simply click into it, for multiple cell selection click into a cell
and drag the mouse pointer across the desired cells to highlight them.

For an example of creating a border style and working with the preview window and the border
options go to the section How to Create or Modify a Border Style.

Cell Properties Dialog

The Cell Properties dialog enables you to define elements related to cells.

All attributes available here can also be found in the Cell Layout Properties, where they can be
set for each cell individually. Additionally, the Cell Layout Properties allow you to specify a
border style for each individual cell as well as selecting the cell flow which determines the
content of the cell.

To access this dialog:

Select Table | Table Cell Properties from the Layout Window menu.

808
 7.6 Layout Objects

or

Right-click within the table and select Table Cell Properties from the context menu.

Options Description
For a description of the options not described just below, see the Cells section.

Modification flag / The Modification flag icon is activated (i.e. it changes to )

when the setting which it is located next to has been modified. Only settings with an ac-
tivated modification flag will be applied when OK or Apply is clicked on.

When a range of cells has been selected and the Cell Properties dialog is opened, the
settings displayed there will reflect the settings made for the top left cell of the selected
range of cells, which might differ from settings made for other cells in the selected range.
In this case, it is possible to extend the settings of the top left cell of the selected range
to all cells of the selected range by activating the modification flag located to the left of
the option(s) you would like to have extended to all selected cells and then clicking on the
Apply or OK button.

Apply to Enables you to specify which part(s) of the table your changes will be applied to
when you click on the Apply or OK buttons. The following options are available:

Selection cells Applies the specified properties to the selected cells. This is the
default setting.

Table cells Applies the specified properties to all cells of the table, regardless if
the cells are selected or not.

Note To select a single cell simply click into it, for multiple cell selection click into a cell
and drag the mouse pointer across the desired cells to highlight them.

Note The Min height and Max height edit-boxes are visible only when Type is set to Custom.
If you select Fixed height in the Type combo-box, the Fixed height edit-box will be displayed
instead (see the Cells section for details).

809
7 Layout Module

7.6.33.4 Tables Layout Properties

In this section: See also:
General Tab Tables Overview
Columns Tab How to Create a Table
Spacing Tab Table Context Menu
Row Sets
Cells

Table Layout Properties allow you to set the outward appearance of tables.

To access the Table Layout Properties go to the Tables node in the Layout Tree and click on
the table you would like to modify. The according Layout Properties window will appear.

The Table Layout Properties has three tabs in which it is possible to specify the properties of
the selected table:

General

Columns

Spacing

810
 7.6 Layout Objects

General Tab

Options Description

Type Displays the table type. There are three different types of tables:

General

With fixed height

Simple

Note Table types are important because they influence the speed of preprocessing and
formatting of tables which in turn influence the overall processing speed when proofing
or creating output data. Processing of General tables is the slowest, With fixed height
tables are faster and Simple tables are the fastest.

Following settings determine the table type (which is General by default) and thus its
processing speed:

The table type changes to Simple when Fixed Height or Calculate fixed height has
been set for all of the cells of the table in the Type combo-box available on the
Cell Properties dialog.

Note The processing speed of Simple tables can vary. Processing will be slower
(although still faster than for With fixed height or General tables), if:

any cell contains data other than text or

vertical alignment is applied to any cell or

more than two variables are inserted in a single cell or

variables contain a tabulator (character code 9), an end of line marker (character
code 10) or an end of paragraph marker (character code 13).

The table type changes from Simple to With fixed height when cells have been
vertically merged or when Type in the Flow Layout Properties of any cell flow in
the table has been set to a value other than Simple (see the screenshot below).

811
7 Layout Module

Row set Selects the row set upon which you wish to base the table.

Border style Selects the specific Border style that you want to apply on the selected table.

Tip Click on the Find Node icon to find the node in the Layout Tree to view or change
its properties.

Border type When neither horizontal nor vertical spacing is applied, all borders between
cells are shared. For instance, the bottom border of one cell will at the same time be the
upper border of the cell below. When using dashed borders (by using a border style with
a line style applied) overlaying may occur with unwanted visual effects as a result, i.e. the
dashing may overlap and obstruct the effect.

This may occur when the default setting Simple is applied, as in the below screenshot,
where dashed lines are not visible in the inside of the table because of overlaying:

Selecting Merge borders prevents overlaying of borders and makes the dashed line style
of the borders visible in the whole table:

812
 7.6 Layout Objects

Note When two borders employing different line styles overlap, then:

for Simple borders The line drawing order is: from top to bottom and from left
to right. The line that is drawn later is displayed on top of one drawn earlier. In
the sample image of two different lines in Simple borders below, the thinner green
line is covered by the dashed lilac line in the top row, where the lilac line was drawn
after the green one. In the lower row the thinner green line is on top of the lilac
one, as it was drawn later.

for Merged borders Only the thicker of the lines (even if dashed) is displayed,
regardless of the order they were drawn in.

Alignment Selects the horizontal alignment of the table within the flow area where it is in-
serted. Options are Left, Right and Center.

Note The effect of this setting is only visible when you set Percent width to a value
below 100%.

Percent width The relationship between the width of the table and the width of the flow
area in which it is inserted.

Min width Sets the minimum width of the table. This will override the percent width if there
is a conflict.

Include line gap Enables you to determine whether a line gap will be calculated in vertical
alignment or not.

If the option is checked, a space will be added between the cell bottom line and the
characters lower edge. This functionality is useful for fonts, where the inclusion or exclusion
of a line gap makes a visible difference.

By default, the box is unchecked. However, if you load WFD files created in previous ver-
sions, the option will be checked because the line gap was added automatically in those
versions.

813
7 Layout Module

Example Comparison of texts without (left) and with (right) line gap.

Columns Tab

Options Description

Min width Sets the minimum width of the column, in specified units. This will override the
percent width if there is a conflict. The default setting is 1 mm.

Size Ratio Sets the size ratio of the columns in the table. When a table is created, all columns
have the same width, so the values will always be the same for each column. Default set-
tings are calculated in the following way: 1 is divided by the number of columns.

Example Default settings would be:

For a table with two columns the value will be 0.5 for each column.

For a table with four columns the value will be 0.25 for each column.

For a table with eight columns the value will be 0.125 for each column.

Tip Values above 1 can also be set. For instance, for a table with three columns you
could assign the ratio 2:1:1 by entering these digits in the corresponding fields of Size
Ratio. The first column will be twice the size of each of the other columns.

Selected Unit Sets the unit of measurement for the Min. width setting.

814
 7.6 Layout Objects

Spacing Tab

Options Description

Horizontal/Vertical spacing Sets the spacing between columns and rows, in specified units.

In this example both horizontal and vertical spacing are set to 2 mm:

Space left/top/right/bottom Sets the minimum space between the table and the border
of the flow area, in specified units.

In this example all four space values are set to 1 mm:

7.6.33.5 Cells
See also:
Tables Overview
How to Create a Table
Table Context Menu
Table Layout Properties
Row Sets

Cells always appear grouped under the row set node in which they reside in the Layout Tree.
They are automatically created as you create tables and row sets.

The Cell Layout Properties panel appears when you select a cell in the Layout Tree and enables
you to define the cell attributes of single cells. All attributes (except the content of the cell set
in the Flow combo-box and the border style selected in the Border style combo-box) can also
be set in the Cell Properties dialog for either a selection of cells or for all of the cells of a table.

815
7 Layout Module

Options Description

Flow Determines the flow which provides the content of the cell. You can select an already
existing cell flow from the list or create a new flow if you want to change the cell's content.

Border style Sets the border style which will be applied to the selected cell. You can:

select an existing border style,

create a new border style,

or leave the combo-box set to Empty if you do not want to apply a border style to
the selected cell.

Alignment Selects the vertical alignment of the cell content. The options are:

Top

Bottom

Center

Tip The horizontal alignment of the cell content can be set by using the appropriate
icons in the Layout window toolbar.

Fitting This setting is needed when you apply First fitting or First fitting auto to a flow con-
tained in a cell of a table. Available options are:

None This is the default setting. When set, first fitting will be applied when
proofing the job, but an error message will be displayed and processing might be
slowed down.

Horizontal Fitting is applied horizontally.

Vertical Fitting is applied vertically.

Both Fitting is applied horizontally and vertically.

816
 7.6 Layout Objects

Type The setting in Type specifies the way the height of cells will be controlled. Depending
on the setting further values must be specified. There are three options available:

Custom The cell height is adjusted according to the height of the content within
a size limit determined by the user. When selected, the Min height and Max
height edit-boxes are displayed where the size limit can be specified.

Fixed height Sets the height of a cell to a constant size, regardless of the data
populating it. When selected, the Fixed height edit-box is displayed where you
can specify the height of the cell(s).

Calculate fixed height The cell height is adjusted according to the height of the
content. When selected, no further settings are necessary.

Fixed height Determines a constant height for the cell(s). Using this option increases the
speed of table processing.

This option is only available when Fixed height has been selected in the Type combo-box.

Min height Minimum height of the cell(s), in specified units.

This option is only available when Custom has been selected in the Type combo-box.

Max height Maximum height of the cell(s), in specified units.

This option is only available when Custom has been selected in the Type combo-box.

Span left Select this option to merge the selected cell(s) with the unselected cell to the left.
The content of the selected cell(s) will not be displayed after being merged, but it is still
accessible in the according Layout tree node. Only the content of the cell to the left of
the selected cell(s) will be displayed in the merged cell.

To split cells you have merged/spanned do one of the following:

Find the node of the merged cell in the Layout Tree and click on it to have the ac-
cording Layout Properties displayed. There you can uncheck the Span Left option.
If you have merged more than two cells, this must be done for each merged cell.
When cells are unmerged, their original content is displayed again.

Right-click into the merged cell and select the Unmerge Cells command from the
context menu.

Note Keep in mind that Span left works differently than the Merge cells command.
Whereas Span left merges the selected cells with the unselected cell to the left, Merge
Cells only merges the cells which have been selected.

Span up Select this option to merge the selected cell(s) with the unselected cell above. The
content of the selected cell(s) will not be displayed after being merged, but it is still access-
ible in the according Layout tree node. Only the content of the cell above the selected
cell(s) will be displayed in the merged cell.

To split cells you have merged/spanned do one of the following:

Find the node of the merged cell in the Layout Tree and click on it to have the ac-
cording Layout Properties displayed. There you can uncheck the Span Up option.

817
7 Layout Module

If you have merged more than two cells, this must be done for each merged cell.
When cells are unmerged, their original content is displayed again.

Right-click into the merged cell and select the Unmerge Cells command from the
context menu.

Note Keep in mind that Span up works differently than the Merge cells command.
Whereas Span up merges the selected cells with the unselected cell above, Merge Cells
only merges the cells which have been selected.

Flow to next page When selected, the content of the cell can overflow to another flow
area (which can be on a different page) if a flow order has been set up between the flow
area containing the table which the cell is located in and another flow area.

When cell content overflows (i.e. when the cell becomes too large to fit into the flow area
in which the table it belongs to is located), the whole row it is a part of will be displayed
in the flow area to which it overflows, not just the overflowing cell. If some of the other
cells of this row do not have the Flow to next page option selected, they will also be
displayed provided there is no overflowing content in those cells. If there is overflowing
content in those cells, the whole row will be moved to the new flow area (i.e. there will
be no flowing).

When this option is not selected, all the content of the cell will be moved to the next flow
area if it does not fit into the current flow area. If it does not fit into any of the available
flow areas set up in the flow order, it will not be displayed at all.

Note

For some table designs using merged or multi-line cells it can be necessary to use
nested tables (i.e. tables placed inside cells) in order to achieve the desired appear-
ance when these cells overflow.

Always process Allows you to determine whether or not the cell will be formatted for
wrapping text. If the text in the cell will not wrap, it is recommended to uncheck this option
for optimal production speeds.

Note Leave Always process checked when you use a global variable in the table and
Type has been set to Fixed height.

This is necessary, because normally global variables will only be only be evaluated and
updated during preprocessing if they are placed in an object whose size is built dynamically
(variable size).

Fill relative to cell This check-box allows you to set whether the dimensions of an image or
a color gradient used as a cell fill are determined by the cell or by the flow area. When
checked, the fill dimensions are relative to the cell. If unchecked, the fill dimensions are
relative to the whole table flow area.

818
 7.6 Layout Objects

7.6.33.6 Row Sets

In this section: See also:
Row Set Layout Properties Panel Tables Overview
Row Set Types How to Create a Table
Table Context Menu
Table Layout Properties
Cells

Row sets are one of the building blocks of tables. They define the type of row (e.g., a single
row or multiple rows), the selection criteria for the row, and the general contents of the row
(e.g., cells, variables, row sets, etc.).

To add a row set to the Layout Tree, you can do one of the following:

Right-click on the RowSets node, select Insert RowSet from the context menu and
specify the row set type and the number of columns.

Insert a new table into a flow area.

Select Create New RowSet in the Row Set combo-box on the General tab of the Table
Layout Properties window.

Newly created row sets will be listed under the Row Sets node in the Layout Tree (they will also
be listed under the Tables node if used in a table and under the Pages node if positioned on
a page). The according icon indicates the row set type of the row set as does the information
in brackets and italics behind the row set name:

Note For more information on row set types see the section Row Set Types.

It is recommended to rename row sets and their components as they are created. To do this,
select the node you would like to rename and click on the Rename icon in the Layout
Properties panel or press the <F2> button.

For more information about tables see the following chapters:

Tables Overview

How to Create a Table

Table Context Menu

819
7 Layout Module

Row Set Layout Properties Panel

Select the row set you would like to make settings for in the Layout Tree. The Layout Properties
for the according row set will be displayed. The following tabs are available:

General Tab

Orphan/Widow Tab

Note The Orphan/Widow tab is only available when Row has been selected in the Type
combo-box on the General tab.

General Tab
On this tab you can specify the type of row set you want to use in the Type combo-box. De-
pending upon the row set type selected the additional fields will vary, enabling you to define
the construction of the row set. See the section Row Set Types for details.

Options Description

Type Select the row set type for the row set. See the section Row Set Types for details on
the different types available.

Number of Columns The number displayed in the bottom left corner indicates the number
of columns the selected row set contains.

Go To Finds the node of any cell or row set selected.

Move Up / Move Down Moves the selected row set or cell (availability depends on
the selected row set type) up or down one space in the list.

Note Moving a row set or cell will affect the appearance of the table in the Layout Area
(i.e. the order of row sets/cells will be changed).

Create New Adds a new item to the list. The exact functionality depends on the selection
made in the Type combo-box.

Example When Single row has been selected in the Type combo-box, clicking on
this item will add a new column to the table.

Delete Deletes the selected item from the list.

820
 7.6 Layout Objects

Row Set Types

Icon Option Definition Constructed of...

Single row A single row of cells with flows. Cells

Multiple A group of rows. Other row sets
rows
Repeated A row set repeated by a selected ar- Variables and other row sets
ray or integer variable.
See also: System Variable: In-
See the section Row Set Example for dex
details.
Select by in- The row set is selected from a group Variables and other row sets
teger of row sets by an integer variable.

See the section Types of Variable Se-

lection for details.
Select by in- The row set is selected from a group Variables and other row sets
terval of row sets by a range within the
data variable.

See the section Types of Variable Se-

lection for details.
Select by The row set selected (you can also Variables and other row sets
condition specify the row set to be Empty for
a certain value) is controlled by a See also: System Variable:
Boolean variable. Exists

See the section Types of Variable Se-

lection details.
Header and You assign individual row sets to Other row sets
Footer header, first header, body, footer and
last footer rows which are the ele-
ments of a table. It is also possible to
have some of these parts Empty, i.e.
without an assigned row set.

See the section First Header and Last

Footer for details.
Select by text The row set is selected from a group Variables and other row sets
of row sets by text.

Note This type of row set is marked

as "select by string" in the Layout
Tree.

See the section Types of Variable Se-

lection for details.
Select by in- The row set is selected from a group Base context and other row
line condi- of row sets by an inline condition. sets
tion

821
7 Layout Module

Icon Option Definition Constructed of...

Note This type of row set is marked

as "select by script" in the Layout
Tree.

See the section Types of Variable Se-

lection for details.

Orphan/Widow Tab
If you have selected Single row in the Type combo-box on the General tab for the selected
row set you can specify properties for orphans and widows on the Orphan/Widow tab. Use
these settings to control the behavior of table breaking when a table is displayed in more than
one flow area.

Options Description

Keep with previous Select the variable which will control whether the row set is kept with
the previous one, i.e. these row sets are not separated.

Keep with next Select the variable which will control whether the row set is kept with the
following one, i.e. these row sets are not separated.

Break before Select the variable which will control whether the table is broken (i.e. continues
in the next flow area) before the selected row set.

Break after Select the variable which will control whether the table is broken (i.e. continues
in the next flow area) after the selected row set.

Go To Finds the node of the variable selected in the according combo-box.

7.6.34 Text On Curve

In this section:
Creating Text On Curve
Text On Curve Layout Properties Panel

Text on Curve allows you to place text on the border of a shape. The standard Text on Curve
item is an ellipse, but all other shapes you have created can be converted to Text on Curve and
thus be used to control text orientation in the same way.

822
 7.6 Layout Objects

7.6.34.1 Creating Text On Curve

To create Text on Curve, do the following:

Click on the Text on Curve Tool , then click and hold the left mouse button in the
layout and drag it to create the standard Text on Curve object, i.e. an ellipse.

or

Right-click on an already created shape in the layout or its node in the Layout Tree and
select the command Convert to Text on Curve from the context menu. The shape
will be converted to Text on Curve.

Regardless of the method you create a text on curve with, it will always be displayed with the
default text Text on Curve so that you can see how the text will behave on the shape.

Example A standard Text on Curve shape:

A shape (in this case a polygon) converted to Text on Curve:

Note The shape itself is displayed only for your orientation, i.e. so that you can see how
the text will flow. When printing or proofing, only the text itself will be visible, the shape
will not.

You can modify your Text on Curve shape at any time. See the Modifying Shapes section for
details.

7.6.34.2 Text On Curve Layout Properties Panel

After creating a new TextOnCurve an according node is placed in the Layout Tree ("TextOnCurve
1" in the screenshot below) and a flow is automatically created inside of it ("Flow 1" in the
screenshot below), which contains the default text Text on Curve. When you select the
TextOnCurve node in the Layout Tree the according properties panel is displayed:

823
7 Layout Module

The Layout Properties panel for Text on Curve consists of the following tabs:

Position Tab

Content Tab

Path Description Tab

Position Tab
Refer to the Position Tab section for details.

Content Tab
On this tab you can determine the text which will be displayed on the Text on Curve.

Options Description

Content Specifies the flow which will be displayed on the Text on Curve. You can select an
already created flow or create a new flow by selecting Create new flow.

Alternatively, you can modify the flow selected in the Content combo-box. Open the flow
by double-clicking on the according node in the Layout Tree and modify the text.

By default a flow containing the text "Text on Curve" is selected in the Content combo-
box.

Supplementary characters support If checked, the supplementary characters are supported

in the current flow. Additionally, if the same option is enabled in the Workflow/Layout
General Options, then every new flow will have the supplementary characters support
enabled by default.

Path Description Tab

Refer to the Path Description Tab section for details.

824
 7.6 Layout Objects

7.6.35 Text Styles

In this section: See also:
Text Style Layout Properties How to Create or Modify Text Styles and
Setting Default Text Style Paragraph Styles
Variable Text Style Paragraph Styles
Fill Styles
Border Styles

Text styles define multiple aspects of text within a paragraph and employ other styles, i.e. fill
styles, border styles and line styles. It is recommended that you create those other styles before
creating text styles.

Example You might create a "warning" style that would define the text as Arial/Bold/10
point with red fill and red outline. An "emphasis" style would be similar, except for the
color of the text.

For several different methods of creating and managing text styles, see the separate section
How to Create or Modify Text Styles and Paragraph Styles.

Tip A text style is also employed as part of the properties of a paragraph style. Therefore,
when a different paragraph style is applied the text style will change to the one that is linked
to that paragraph style.

7.6.35.1 Text Style Layout Properties

The tabs are:

Font

Rules

Super/Sub Script

Lines

Border

Outline

The specified units for various attributes can be changed by clicking on the units symbol and
selecting from the drop-down menu that appears. All units are absolute except percentage
(%) which is percentage of the font size that is selected.

825
7 Layout Module

There are some additional options at the top of the panel:

Options Description

Parent Creates a link to another text style from which the current style inherits all of that
style's properties.

You can then set which properties will remain as inherited (i.e. linked), by clicking on the
Parameter linked to parent / Unlinked parameter icons next to the appropriate
combo-boxes.

Visible text style Indicates the visibility of the currently selected style.

This check-box is not editable.

Promote to Variable Changes the style into a variable text style.

Font Tab

Options Description

Font name Selects the font.

Subfamily Selects a face (style) from the list of faces supported by the particular font which
has been selected in the Font name field.

This is useful if you use fonts which have more faces than just the usual ones, e.g. regular,
bold and italics.

Font size Determines the size of the font.

The default unit is set by the Font units option in the Options Dialog.

Tip If intending to use the Follow naming convention option in AFP Engine Configur-
ation for Production, the permitted font size range is between 1 and 36.9 pt. If you need

826
 7.6 Layout Objects

to use font sizes beyond the naming convention limit, disable this option and do not employ
double-byte fonts.

Bold If Yes is selected, the text will be bold.

Italic If Yes is selected, the text will be italicized.

Small caps If Yes is selected, the text will be written in small capitals. Small caps means that
lowercase letters are capitalized, but are slightly smaller than uppercase letters.

Super/Subscript Selects whether the text will be superscript or subscript. Select from:

No No formatting will be applied.

Superscript Text will be written as superscript.

Subscript Text will be written as subscript.

Tip You can use the above settings even for fonts which support only regular face (i.e. if only
Regular option appears in the subfamily combo-box) because Inspire Designer can create the
faces (styles) itself.

Rules Tab

Options Description

Baseline shift Determines the space between the characters and the baseline.

Inter. spacing Determines the space between individual characters.

Kerning If Yes is selected, kerning is applied to the text style.

This adjusts the inter-character spacing of any used proportional fonts so that the spaces
between each pair of letters have a similar area. The result is that the characters of single
words look more evenly spaced.

Example

827
7 Layout Module

Language Determines the alphabet/characters that will be used in the document.

Note This needs to be set in order to hyphenate text via Hyphenation tab of paragraph
styles.

Horizontal scale Sets the percentage of horizontal scaling which makes the text enlarge or
shrink horizontally.

Example

URL target Selects a variable to return a URL link value.

The variable will transform the highlighted text to an URL link, which is defined in the
variable. The URL link will then be active in the output files in PDF, TNO, Docx, HTML and
HTML Simple format.

The link can be created using either the Layout Insert URL target or the same option from
the context menu displayed after right-clicking on a selected text in a flow area.

Note For HTML and HTML Simple outputs the URL link has to contain the http:// prefix,
otherwise the link may not work.

828
 7.6 Layout Objects

Example A hypertext link can be created easily with the Layout Insert menu option
Insert URL Target. This automatically creates a new text style and a variable contain-
ing the URL link.

You can also do this manually:

1. Define a variable that will control a text.

2. Highlight a text that is to be made to a URL link:

3. Select a variable with a defined URL link to control the highlighted text:

In PDF output files a wider functionality of the URL links can be used to:

Insert a link to a web page,

Attach a tooltip (hint),

Insert an unsigned signature field,

Insert an internal link (to a given page of the document) and

Define alternative content for tagged objects.

The table below lists the strings used for particular functionalities.

829
7 Layout Module

Usage URL Type Scheme Sample String/ Purpose

Name Sample String
with User
Specified
Identifier

Gener- WWW* http ht- Clicking on the object

al tp://www.gmc.net takes to the specified
web site.
PDF Tooltip* cx:tooltip cx:tooltip://Text The tooltip's text appears
cx:tooltip.Tool- when hovering the
tip1://Text mouse pointer over the
object.
PDF Signature cx:sig cx:sig:// Allows to insert a digital
field* cx:sig.Signature1:// signature (using an appro-
priate post-processing
tool).
PDF PDF link to ref ref://5 Clicking on the object
a page takes to the specified
within doc- page (pages are
ument* numbered from 1).
PDF Alternative cx:pdf cx:pdf:alt=Text Alternative content is text
content substitute for objects,
(assigned that do not translate nat-
to images urally into text. It im-
and shapes proves the document's
only) used accessibility to users with
via PDF visual impairments or can
tags serve for other purposes.
PDF Pop-up cx:note cx:note://Text Adds notes equivalent to
note (an- cx:note.Label://Text the "Add Note" function
notation) in the Adobe Acrobat.
The label (if inserted) is
displayed in the title bar
of the notes pop-up
window when open and
active. Typically, labels
identify the user who ad-
ded the note.
Both, the label and the
text, can be edited in PDF
files in Adobe Acrobat. In
Adobe Reader notes are
displayed, but cannot be
edited.
HTML HTML link cx:url:win- cx:url:window:\\ht- The link is opened in the
opened in dow:\\ tp://www.gmc.net current window.
current
window** cx:url:window:\\Ele- If a link is designed for
ment 1 elements in pop-up win-
dows, the web page is

830
 7.6 Layout Objects

Usage URL Type Scheme Sample String/ Purpose

Name Sample String
with User
Specified
Identifier

opened in the current

browser window (not in
the pop-up).
HTML HTML link cx:url:blank:\\ cx:url:blank:\\ht- The link is opened in a
opened in tp://www.gmc.net new window/tab (depend-
new win- ing on browser settings).
dow** cx:url:blank:\\Ele-
ment 1
HTML HTML link cx:url:popup:\\ cx:url:popup:\\Fam- The link is opened in a
opened in ily 1.Element 1 pop-up window. This
pop-up** setting works for ele-
ments only.

* These features work for any objects, that can be assigned an URL link.

**These features can be used e.g. when designing HTML catalogue.

The PDF format requires an identifier for each URL link entry. The identifiers are generated
automatically, although for tooltips and signature fields they can also be specified by the
user. User selected identifier needs to be inserted right after the scheme name element
followed by a dot (see the sample strings in the table above). Make sure your user specified
identifiers are unique for each object.

Wrapping Rule Selects a wrapping rule which defines what characters are allowed at the
beginning and at the end of lines.

The rules are created or changed in the Wrapping Rules Editor.

Note If the Empty option is selected, the default text wrapping rules apply. These rules
are different to the default wrapping rule for compatibility reasons; the default wrapping
rule is set by selecting Insert Wrapping Rule from the context menu when you right-click
on the Others node in the Layout Tree. The difference appears because wrapping rules
are intended and customized mainly for Asian languages, where spaces are not used. The
wrapping is not allowed between Latin characters by default.

The Enable wrap anywhere option for paragraphs has a priority over any wrapping rule.
If you want to apply a defined wrapping rule, be sure to set this option to No.

831
7 Layout Module

Super/Sub Script Tab

Most options here are only applicable if Super/Subscript on the Font Tab is other than No.

Options Description

Superscript offset Sets the superscript offset from the baseline.

Subscript offset Sets the subscript offset from the baseline.

Super/Sub script size Sets the size of superscript/subscript.

Affect sup(b)script underline Selects whether superscript/subscript will be underlined inde-

pendently from the remaining text:

Yes Superscript/subscript will be underlined independently from the remaining

text (discontinuous underline).

Example

No Superscript/subscript will be will be underlined as if it was a normal text

(continuous underline).

Example

Affect sup(b)script strikethrough Selects whether superscript/subscript will be struck

through independently from the remaining text:

Yes Superscript/subscript will be struck through independently from the remaining

text (discontinuous strike-through).

Example

832
 7.6 Layout Objects

No Superscript/subscript will be struck through as if it was a normal text (continu-

ous strike-through).

Example

Small caps size Sets the size of small caps.

Only used if Small caps on the Font Tab is set to Yes.

Lines Tab

Options Description

Underline If Yes is selected, the text will be underlined.

Underline line style Selects a line style that will be used for underlining the text. If no line
style is selected (Empty), the default underlining (simple straight line) is used.

Strikethrough If Yes is selected, the text will be struck through.

Strikethrough line style Selects a line style that will be used for striking through the text.
If no line style is selected (Empty), the default strikethrough (simple straight line) is used.

Custom underline/strike If Yes is selected, the options below can be set, otherwise they
are disabled.

Underline offset / Underline width Sets the underline offset / width from the baseline.

Strikethrough offset / Strikethrough width Sets the strike-through offset / width from
the baseline.

833
7 Layout Module

Border Tab

Options Description

Border style Selects a previously defined border style or creates a new one that will be applied
around the text.

Example If you want white text on a black background, you can create a border
style filled with black and set your text style to white.

Connect borders Determines whether the borders will be connected.

With line gap Determines whether the border will extend slightly below the text.

Outline Tab

Options Description

Line width Determines the width of the outline of the text, if the fill color is different from
the outline color.

Miter Controls the size of the miter effect, if Miter has been selected for Join.

Cap Controls the corners of the outline when two line segments intersect. Select from: Butt,
Round or Square.

Join Controls the shape of the intersection points of the outline. Select from: Miter, Round
or Bevel.

Fill style / Line fill style Select or create the fill style for the interior of / outline around the
individual text characters.

834
 7.6 Layout Objects

For more information on the options that appear for selecting fill styles, see the Fill Styles
section.

Shadow fill style Defines a fill style for glyph shadows. See the separate Fill Styles section.

Shadow offset X Sets the offset of the shadow on the X axis.

Shadow offset Y Sets the offset of the shadow on the Y axis.

7.6.35.2 Setting Default Text Style

It is possible to set any text style created in Layout as your default text style. To do this, in the
Layout Tree right-click on the name of the text style, which you want to make your default
text style and select the Set as Default option.

The change is saved in the PNetT.cfg file and the text style becomes the new Normal text style
(i.e. the default text style for new layouts; it has no effect on the current Layout).

Note

Border style and fill style settings (on the Outline tab) are not saved in the configuration
file. Instead, the default values set in the application are always used.

To restore the original Normal text style settings, delete the PNetT.cfg file (in the direct-
ory, where Inspire Designer is installed). Remember, that by deleting this file you will
loose all other user settings made in the application.

7.6.35.3 Variable Text Style

The same text in Layout can be displayed in various text styles according to specific conditions
that are set.

To create a new variable text style, right-click on the Text Styles family in the Layout Tree and
select the Insert Variable Text Style option. Then define the condition type and apply the
newly created text style to selected text.

To change a selected text style into a variable one, do the following:

1. In the Layout Tree, select the text style that you want to promote to a variable text
style. This text style will be the default option in the condition controlling the variable
selection (this can be changed later).

2. Click on the button Promote to Variable or in the context menu on the option Pro-
mote to Variable Text Style. This action creates a new node under the TextStyles
family in the Layout Tree, which represents the newly created variable text style. This
node has a nested text style a copy of the original promoted text style. To the name
of the original text style the digit "1" is appended, as it cannot have the same name
as the variable text style.

3. Set the condition type and assign other text styles to each of the created conditions.
These text styles will also appear under the node of the variable text style.

4. Apply the variable text style to the desired text in the Layout.

835
7 Layout Module

7.7 Layout Options Dialog

See also:
Workflow Options Dialog
Proof Options Dialog
Production Options Dialog

The Options dialog (File | Options) in the Layout window enables you to customize your layout
environment. Different panels display as you select options from the tree on the left. The Layout
Options dialog is divided into the following main groups:

General Options

Global Layout Modules Options

Current Layout Module Options

Current Workflow Options

7.7.1 General Options

The General options available here are the same as those available on the Workflow Options
Dialog. For a description of these options refer to the appropriate section of the Workflow
Options Dialog:

General Options

Auto Save

Fonts

Color Management

Scripting

PTF Import

Used Files Conditions

Secure Data

Message Colors

Inspire Content Manager

Media Bin Retrieval Tasks

File Open Dialog

Caching

836
 7.7 Layout Options Dialog

Recent Files

Default Hyphenator

7.7.2 Global Layout Modules Options

Besides the Global Layout Modules Options there are also the following sub-sections available
where further settings can be made:

New Page Size

Layout Tree

Layout View

Flow

Colors

837
7 Layout Module

Copy/Paste

Undo/Redo

Insert Color

Insert Font

Insert Image

Insert Character Palette

File Import

Image Transparency

X-Rite Eye-One

Shortcuts

Global Layout Modules Options are application settings, i.e. they apply to all Layouts in the
current workflow and are applied when editing any other workflow with the current instance
of Inspire Designer.

Example Set New page size to 50 mm x 50 mm. If you have a workflow opened and
you create a new page in Layout, its size will be 50 mm x 50 mm and if you then create
a new workflow and add a layout module, the page size there will also be 50 mm x 50
mm.

Options Description

Text/Para style parent/child link Selects the default relationship between text and paragraph
styles that are related to similar styles via the Parent option (see the separate section How
to Create or Modify Text Styles and Paragraph Styles), i.e. parent and child styles:

Unlink child when modified Determines that the inherited parameters of the child
style are linked to start with, but the child is subsequently independent.

838
 7.7 Layout Options Dialog

Editing a parameter at the parent will result in the same change in property being
made for the child, but editing a single property of the child will break the link
between parent and child for that property and that property is made unique to
the child. I.e. any subsequent change of that property will only apply to the child.

The parent and child can be re-linked using the Link icon on the child paragraph
style's Layout Properties.

Maintain parent/child link Determines that the parent and the child continue to
be linked and that editing parameters of the child, also edits the same parameters
of the parent.

Many styles can have the same parent and parents can have parents too. So when
this option is chosen, each time a property of one member of these related styles
is changed, the same property changes for every relation.

The parent and child can be unlinked using the Link icon in the child paragraph
style's Layout Properties.

Object step Sets the distance that a selected object will move across the Layout Area when
cursor keys are pressed on the keyboard.

There are two edit-boxes, the top one is for steps along the X axis (left and right) and the
bottom one is for the Y axis (up and down).

Object step with shift Sets the distance that a selected object will move across the Layout
Area when cursor keys are pressed while <Shift> is held down.

There are two edit-boxes, the top one is for steps along the X axis (left and right) and the
bottom one is for the Y axis (up and down).

It is intended that a larger value than for Move object step is entered here.

Run in admin mode (unsafe) If checked, enables you to edit any object in the Layout
module, including external objects which are otherwise locked for editing.

Considered to be unsafe and so, by default, this is not checked.

Change text style together with paragraph style If checked, then text style becomes a
property of paragraph style.

The text style, chosen in the Default text style combo-box on the Advanced tab of a
paragraph style's properties panel, will be linked to the paragraph style so that, when the
paragraph style is applied to a paragraph, then the text style is also applied to that para-
graph.

Checked is the default setting.

If unchecked, the Default text style is only applied when the corresponding paragraph
style is defined as the Next para. style of another paragraph style.

Search and replace also in scripts If checked (default setting), scripts are included when
searching, renaming or replacing objects. This concerns the Find Object Uses feature and

839
7 Layout Module

renaming objects in the Layout Tree. Unchecking this option can be helpful for Layouts
with extensive scripts that do not require any attention.

Create new table with merged borders If checked (by default), every new table created
in the current Layout will have borders merged. If unchecked, simple borders are applied.
Changing the setting later in the Table Layout Properties applies the new setting only to
the respective table.

7.7.2.1 New Page Size

Options Description

New page size Enables you to set up the size of all new pages in Layout. For details about
Size, Width and Height options and the related icons see the Output module.

7.7.2.2 Layout Tree

Options Description

Font size Sets the font size used in the Layout Tree. By default the size is set to 10.

Link color Sets the color of link references in the Layout Tree. The default setting is Blue.

External object color Sets the color of nodes representing external objects in the Layout
Tree. The default setting is RoyalBlue.

Link to external object color Sets the color of link references leading to external objects
in the Layout Tree. The default setting is SlateBlue.

Underline link Determines that link references in the Layout Tree will be underlined. This
option is selected by default.

840
 7.7 Layout Options Dialog

Show row set type Determines if the type of individual row sets will be displayed in the
Layout Tree. This option is selected by default.

Example When Show RowSet Options is selected, individual row sets in the
Layout Tree will appear with their type displayed in brackets behind the name of the
row set:

Layout properties vertical mode If checked, the Layout Properties tabs are displayed on
a single panel which you can scroll down.

This vertical mode can also be activated by right-clicking on any tab name and selecting
the option Switch to vertical mode from the context menu. To switch back to the tab
mode, uncheck this option or right-click on any tab name and select the Switch to tab
mode option.

Include variables when sorting nodes If checked, variables will be sorted alphabetically
when the Sort Layout Tree Nodes A-Z option in the Layout View Menu is enabled.

7.7.2.3 Layout View

841
7 Layout Module

Options Description

Ruler color Selects a color for the ruler in the layout environment.

Ruler units Selects the ruler units.

Ruler unit division Sets the number of sections the unit will be divided into (8 or 10 is
available), e.g. one centimeter can be divided into tenths, one inch into eighths.

Grid line X spacing Sets the distance between the grid lines on the X axis.

Grid line Y spacing Sets the distance between the grid lines on the Y axis.

Grid line color Selects the color for the grid lines.

Guideline color Select the guideline color

Grid X subdivision Sets the number of parts (maximum 25) into which the space between
the grid lines is divided on the X axis. The sub-divisions are marked with thinner lines.

Grid Y subdivision Sets the number of parts (maximum 25) into which the space between
the grid lines is divided on the Y axis. The sub-divisions are marked with thinner lines.

Font units Selects font units that display by the font size edit field in the Layout window.

Char. for line space count Sets the width of a unit used to estimate the number of characters
(or spaces) remaining to the end of the line within the selected flow area. By default, a
space is inserted in the field and serves as the estimation unit. The estimated values are
displayed at the bottom of the Layout window.

Type in the suitable character(s) in the edit-box or click in the edit-box, press <F2> and
choose the character(s) from the menu. You can enter as many different characters as you
need into the edit-box. The first (from the left) of the characters, that occurs in the currently
used font, will be used as a sample character for the estimation. When no character is in-
serted or no characters matching the currently used fonts are found, the width of the
glyph 0 (also known as the missing character glyph, represented in the text usually by a
blank box) is used as the sample unit.

Design time image resolution Sets the resolution (in DPI) in which imported images (native
and non-native) will be displayed in Layout.

This is useful e.g. for natively imported images for which the default 96 DPI resolution is
not sufficient, you can change it to the original DPI of the image and view the image in
better resolution.

Show object print state If checked, the print state of an object is displayed. For more details
see the Position Tab section where Print state is described.

Show guidelines in background If checked, guidelines are always drawn in the background.

Enable adding and moving guidelines If checked, it is possible to add new guidelines and
drag them to any position in Layout. Unchecking this option locks the position of guidelines.

Show grid in background If checked, the grid lines are drawn in the background.

If not checked, the grid lines are drawn in the foreground, i.e. they are always visible on
top of all objects. This may be useful when there are more objects placed on top of each
other and they need to be positioned to the grid precisely.

842
 7.7 Layout Options Dialog

Show heads in background If unchecked, heads are shown in the foreground and therefore
always visible.

Show drawing frame If checked, a rectangle frame is displayed while drawing an object.

7.7.2.4 Flow

Options Description

Flow width Sets the flow width in the layout environment.

Show variable instead of variable formatted flow If checked, the name of the variable
controlling a nested variable formatted flow is displayed instead of its content in Layout.

Default language flow postfix Sets the postfix that is added to the name of default lan-
guage subflow (a simple flow nested in the language flow).

Copy content into new language subflows If this option is checked, for any flow converted
to a language flow, a new subflow will be created for each of the languages in the job
(i.e., there already must be at least one language flow) and the content of the default
language flow is copied to the other subflows.

Display variable full name If checked, the full name of variables is displayed in flows
(without the root node Data which is common for all variables), e.g. Records.Value.CustID.
It is possible to limit the length of the displayed name in the Maximum variable length
option below.

Even if this option is unchecked you can still find out the full name of the variable quickly
using the tooltip for Layout objects.

Maximum variable length Sets the maximum number of characters for displaying of vari-
ables names. If 0 is set the length is not limited and the full name of the variable is dis-
played. If, for example, the value 5 is entered, the last 5 characters of the variables name
are displayed together with three dots at the beginning to suggest the name has been
shortened.

This option is only active if the Display variable full name option (above) is enabled.

843
7 Layout Module

7.7.2.5 Colors

Options Description

Vertical overflow mark color For an explanation of Vertical overflow see the Flow Areas
section.

Horizontal overflow mark color For an explanation of Horizontal overflow see the Flow
Areas section.

Selected bounding box color Applies to any object in Layout and rectangles in theText in
Rect module.

Normal bounding box color Applies to any object in Layout and rectangles in theText in
Rect module.

844
 7.7 Layout Options Dialog

Focused bounding box color Applies to Flow areas.

External bounding box color Sets the color of the bounding box used with external objects.
For more information see the External Objects section.

Input variable outline color See a sample image below.

Constant variable outline color See a sample image below.

Global variable outline color See a sample image below.

Calculated variable outline color See a sample image below.

Arrows to next flow area color For more information see the Overflow Management
section.

Arrows to next page flow area color For more information see the Overflow Management
section.

845
7 Layout Module

Line separator For more information see the Flow break after field description in the
Paragraph Styles section.

Runaround path color For more information see the Runaround Tab section.

Clipping path color For more information see the Clipping Path Tab section.

Odd / Even heads color Sets the colors for odd and even heads, when heads are set up in
the Page Layout Properties and the Show Heads option is selected in the View menu.

The same settings are available in the Proof Options dialog.

7.7.2.6 Copy/Paste

Sets the default actions for the pasting of copied items. An explanation of how the paste
function works can be found in the separate Copy and Paste section.

846
 7.7 Layout Options Dialog

Options Description

Clone Objects Determines which objects will be cloned, i.e. pasted as new objects which
are independent of the original object.

Objects that are not checked here will be pasted as the same instance of the copied object.
Remember that all object instances are listed as nodes in the Layout Tree.

Use RTF in clipboard if available Determines whether the RTF (Rich Text Format) of a copied
text will be pasted with it, if you are pasting text that has been copied from an application
other than Inspire Designer.

Uncheck if you want to paste the text but not its format. It is checked by default.

In Layout, this default behavior can be adjusted when pasting via Edit | Enhanced Paste, i.e.
the Enhanced Paste Dialog. Further, if the Save paste mode option is checked there, then
those settings will also be saved as the default here.

Clicking on the Reset button will reset this panel to the original settings which are as shown
in the screenshot above, i.e. Only first-level flows to be cloned.

7.7.2.7 Undo/Redo

Undo limit specifies the reserved memory for undo/redo steps that will be available for tracking
in the Layout.

7.7.2.8 Insert Color

If checked, all newly added colors are defined in CMYK color space instead of RGB.

7.7.2.9 Insert Font

Options Description

Insert font full time Inserts the font full name in the layout. The long font name is taken
from INF file (VPMenuName section) if there is any placed in Fonts directory; if there is

847
7 Layout Module

only font (without the appropriate INF file) available, then the name is taken from the font
file.

AFP font - Remap glyphs after setting code page If checked, glyphs are remapped after
changing the AFP font code page setting. See the section Fonts for details.

7.7.2.10 Insert Image

Options Description

Default image color space Sets the default color space type. The options are: Black and
white, Gray scale, RGB and CMYK.

Default embedded profile usage Sets the default embedded profile usage.

Default load with transparency See the Images section for details.

Default load natively See the Images section for details.

Default place native image in overlay Automatically places natively loaded images in
overlays. The option is active only when the Default load natively check-box is enabled.

Image format Lists all supported image formats.

Default color space Sets the color space which will be default for the respective image
format. The options are: Default, Black and white, Gray scale, RGB and CMYK.

If Default is selected, the value set in the Default image color space combo-box is used.

848
 7.7 Layout Options Dialog

7.7.2.11 Insert Character Palette

Options Description

Show defined characters only If checked, only characters defined for the selected language
get displayed.

Show characters hint If checked, when you hover with your mouse above the character
palette you see a tool tip with character:

Show decimal char. index hint If checked, when you hover with your mouse above the
character palette you see a tool tip with decimal character index:

Show hexadecimal char. index hint If checked, when you hover with your mouse above
the character palette you see a tool tip with hexadecimal character index:

Note By default all hint options are checked and the hint looks like this:

849
7 Layout Module

7.7.2.12 File Import

Options Description

Imported resources folder Defines the folder where the resources of imported files are
stored.

If no location is specified, images or other files get stored at resources directory placed at
the same location as Inspire Designer executable file.

Perform selected operation without asking If checked, then after you select Import |
RTF or DOC from the Layout File menu, the import will run automatically according to
the action selected below.

If unchecked, the RTF Import or DOC Import dialog with selected action will open before
importing, but you can still change whether the document is completely imported into
one flow or not.

Action The following options are available:

Set up text flowing Document is imported on to one page and flowing is set up
for that page.

Split into pages Document is imported on to more pages (as many pages as ne-
cessary are created).

Don't perform action Document gets completely imported into one flow on one
page, no flowing is set up.

Advanced numbering bulleting If checked, RTF and DOC files containing bulleting and
numbering will be imported with bulleting and numbering functionality retained.

If unchecked, the files are imported as simple text only.

Numbering files folder Enables you to select the folder which contains NMB files (containing
the different numbering styles, i.e. language rules for converting numbers).

The numbering style can be easily modified. To create your own NMB file see the example
dealing with numbering style creation in the separate How to Create Numbering Style in
Imported RTF and DOC Files section.

850
 7.7 Layout Options Dialog

7.7.2.13 Image Transparency

This option enables you to define transparency for a color range, either for RGB or CMYK color
space.

The transparency will be applied either to all newly inserted images or to all newly inserted PDF
and EPS files (to be selected in the field Make transparent). Any color from the selected range
will be converted to transparent.

Possible options are:

Don't use No color will be changed to transparent automatically when loading new
image (default)

Use for PDF and EPS When loading new PDF and EPS images, the colors within the
range set in the Image Transparency dialog will be converted to transparent color. For
other image types, no color will be changed to transparent automatically when loading
new image.

Use for all images For all image types, the colors within the range set in the Image
Transparency dialog will be converted to transparent color.

7.7.2.14 X-Rite Eye-One

This dialog allows to choose settings for scanning colors with the X-Rite Eye-One spectropho-
tometer. The very same dialog appears when Configure is chosen from the X-Rite Eye-One
menu.

851
7 Layout Module

Options description

Mode Displays the current scan mode. The current mode can be changed here as well as in
the Layout Tree or in the toolbar. If the Single scan mode is selected, the check-boxes in
the Measured Color Handling section become available.

Color space Sets the color space. The default setting is LAB, other options are CMYK (Default)
and CMYK (Absolute Colorimetric).

Use for default fill style Sets the last acquired color as the default fill style. This option is
active for the Single scan mode only.

Use for default line fill style Sets the last acquired color as the default line fill style. This
option is active for the Single scan mode only.

Apply to selected layout objects Applies the last acquired color to selected layout objects,
e.g. shapes or barcodes. This option is active for the Single scan mode and only if at least
one of the other fill style options directly above is enabled.

Automatically connect to device at startup If checked, the application automatically

connects to the spectrophotometer, when it is launched. If unchecked, only the Connect
and Configure options in the X-Rite Eye-One menu are active until the connection to the
device is done manually.

Info Shows the date and the time of the last calibration with the count of measurements
since the last calibration.

852
 7.7 Layout Options Dialog

7.7.2.15 Shortcuts

This panel shows which key-pad shortcuts are assigned to the current layout. For a description
of the options here, see the Shortcuts description for the Workflow Options dialog.

7.7.3 Current Layout Module Options

Besides the Current Layout Module Options there is also the following sub-section available
where further settings can be made:

Overlays Properties

Settings made in this section will be applied only to the currently opened Layout and are saved
with the according WFD file. They are used for transforming color spaces of images and color

853
7 Layout Module

values (set in the Color dialog). The profiles set here will be used for transformations in the
following parts of Inspire Designer:

In Layout (only for CMYK images. As only these have to be converted for monitor display
(which uses RGB)). Further profiles specifying the appearance of colors in Layout can
be set in the Color Management) window of this section.

In Proof (the CMYK profile set here is not necessarily used in Proof, see the description
of CMYK Profile below).

In Output (the CMYK profile set here is not necessarily used in Proof, see the description
of CMYK Profile below).

Options Description

RGB Profile Sets the RGB color profile for this Layout. The following options are available
from the drop-down menu by default:

Built in sRGB profile This option is selected by default.

Current Layout RGB profile (Built in sRGB profile) This option shows the currently
set profile in brackets.

Note This is useful when you have loaded a workflow using a profile not installed
on the machine you are using. If you decide to change this profile to a profile in-
stalled on your computer the profile originally contained in the workflow will be
overwritten and cannot be reselected. Even if you have a profile of the same name
installed on your machine, this option can be helpful as only the profile names are
displayed; it is not verified if profiles of the same name are really identical.

CMYK Profile Sets the CMYK color profile for this Layout. The following options are available
from the drop-down menu by default:

Built in CMYK profile This option is selected by default.

Current Layout CMYK profile (Built in CMYK profile) This option shows the cur-
rently set profile in brackets.

Note This is useful when you have loaded a workflow using a profile not installed
on the machine you are using. If you decide to change this profile to a profile in-
stalled on your computer the profile originally contained in the workflow will be
overwritten and cannot be reselected. Even if you have a profile of the same name
installed on your machine, this option can be helpful as only the profile names are
displayed; it is not verified if profiles of the same name are really identical.

If a CMYK profile is set in the ICC Profile Setting area of a Proof profile or Output engine
dialog, the setting made here will be disregarded for transformation purposes concerning
these parts. In this case the CMYK profile set here will only be used for displaying CMYK
colors correctly in Layout.

Tip It is recommended to change the Built in CMYK profile only if it is necessary for
CMYK images to be displayed correctly in Layout. Otherwise, set the appropriate profile
in the ICC profile dialog of the according Output Engine configuration dialog (in this case
it will only be used for production purposes), as making settings in Layout will slow down
rendering.

854
 7.7 Layout Options Dialog

Some ICC profiles are distributed directly with Inspire Designer; they can be found in the
Normalizer7\ICCProfiles directory placed in the installation folder.

CMYK Intent Selects a method for transforming colors from one color space into another.
There are four methods to create a color rendering: Perceptual, Relative Colorimetric,
Saturation, and Absolute Colorimetric. The default setting is Perceptual.

For more information see the section Rendering Intents.

Recalculate When checked, colors are recalculated when profiles are changed. By default,
the Recalculate check box is not checked.

Add Profile Clicking on this button opens a standard Open dialog allowing you to add new
color profiles (ICC and ICM files) which can then be selected from the above combo-boxes.

Undefined character check If checked, a warning message is generated if the layout contains
a character that is not included in the respective font. The character is replaced by '0'.

Interpret message category in script as 'Int' If checked, scripting methods dealing with
message categories return integer values instead of string values. See the section Message
Scripting.

Also see ICC Profiles and RGB Color Space

7.7.3.1 Overlays Properties

On this panel you can disable placing static objects, paragraphs, elements and borders into
overlays. By default, they are all placed into overlay.

Options Description

Use overlays for static objects If checked, static objects will be placed into overlays.

Use overlays for static paragraphs If checked, static paragraphs will be placed into overlays.
The option Optimize static paragraphs must be checked too in order to use overlays
for static paragraphs.

Use overlays for static elements If checked, static elements will be placed into overlays.

Use overlays for borders If checked, borders will be placed into overlays.

If this option is unchecked, the settings defined in the Max overlay count for merged
table borders and Process table borders as 'Simple' if max overlay count is exceeded
options (described below) are ignored.

855
7 Layout Module

Example Unchecking this option can be useful for Metacode Engine Configuration
where a simple border can be printed as text.

Optimize static paragraphs If checked, processing of static paragraphs will be faster because
they will be formatted just once and their content will be copied from the cache in the
next paragraph occurrence.

If the option Use overlays for static paragraphs is checked, they will additionally be
placed into overlays too.

Max overlay count for merged table borders Sets the maximum number of overlays, that
can be used for merged table borders in each table in the current Layout. The default
value is 20. You can set any number from 0 to 99,999,999. Setting the value to 0 means,
that overlays are not used for merged table borders and no warning is generated during
processing. Allowing too many overlays may require too much memory while processing
and slow it down.

If the max overlay count is exceeded, a warning is displayed in the Log Window-Pane.
How the merged borders not included in overlays are processed, depends on the setting
of the check-box right below.

For WFD files created in PrintNet T versions 6.1 and earlier, the value is set to the highest
possible.

This option is active only, when the Use overlays for borders above check-box is enabled.

To customize the default maximum overlay count for all Layouts, apply the appropriate
command via the CONFIG file.

Process table borders as 'Simple' if max overlay count is exceeded If checked (by de-
fault), all merged table borders that were not included in the overlays (due to the max
overlay count limit for merged table borders, see above) are processed as simple (i.e. not
merged) and put in overlays. If unchecked, the merged table borders that were not included
in the overlays, are processed as merged, but kept out of overlays.

This option is active only, when the Use overlays for borders above check-box is enabled.

7.7.4 Current Workflow Options

See the appropriate section in the Workflow Options Dialog for options description.

7.8 Other Helpful Features

7.8.1 Arabic, Hebrew, Indic Languages Support
Inspire Designer offers enhanced support for languages with right-to-left reading order (Arabic,
Hebrew, Indic etc.).

856
 7.8 Other Helpful Features

It is an optional feature that sets writing direction from right to left for the relevant characters
and binds the characters correctly.

To use this feature, you need to activate Worldwide Support and set the correct reading order.
There are two ways how to apply Worldwide Support:

For any opened workflow

Go to the Options Dialog in the File menu and check the Worldwide support
checkbox.

Only for a selected flow area

Select a flow area and go to its Layout Properties window. Check the Worldwide
support checkbox on the Content tab.

857
7 Layout Module

To set the reading order, go to the paragraph style's Layout Properties and on the Advanced
tab select Right for the option Reading order. This is necessary for correct formatting of Ar-
abic text.

7.8.1.1 Features Supported by the Worldwide Support

Option
When you use, for instance, Arabic keyboard, characters get typed from right to left.
If Reading order is set to Right, the flow area is aligned to the right and all align options
work correctly in relation to the writing direction.

All characters are bound correctly.

<Backspace> deletes from left to right.

<Delete> deletes from right to left.

The <Home> key moves the cursor to the right end of the line.

The <End> key moves the cursor to the left end of the line.

When the <Forward Arrow> key is pressed the cursor moves from right to left. If there
is some text in left-to-right reading order (for example English text) in the middle of
Arabic text, the cursor moves accordingly:

in Arabic text the cursor moves from right to left,

then it jumps to the beginning of the English part and moves there from left to
right and

then it continues in the right-to-left direction in the rest of Arabic text.

When the <Backward Arrow> key is pressed the cursor moves from left to right.

858
 7.8 Other Helpful Features

7.8.1.2 Data Input Format

The format of the Data Input file depends on the operating system that you use:

If your operating system is based on MS DOS the data get saved in the correct reading
order.

If you use some other operating system the data get saved in logical order (i.e., incorrect
reading order) that is from left to right. To import such a file into Inspire Designer
correctly, you need to use a script reverting the order and turn on the Worldwide support
feature.

Note If Arabic, Hebrew or Indic languages are not used in your document it is not recommen-
ded to have this option checked, since a more complicated algorithm is used for formatting
when Worldwide support is set.

7.8.2 Bullets and Numbering

See also:
Paragraph Style
How to Generate a Table of Contents
Number to Spell Conversion
Arabic to Roman Number Conversion
Letter Indexing Conversion

To structure your text you can use the Bullets and Numbering feature. You can either use pre-
defined formats for bullets and numbering from the Paragraph Style toolbar, or you can create
your own bullets or numbering style, even using your own images for bullets, from within the
Bullets and Numbering dialog. Bullets and Numbering can also be a part of automatically
generated Table of contents.

See also the example How to Set Bullets and Numbering at the end of this section.

7.8.2.1 Paragraph Style Toolbar Bullets and Numbering

Related Options
To add or edit numbering and/or bullets and to increase and/or decrease their indent four icons
on the right side of the Paragraph Style toolbar in Layout can be used.

Options Description

Bulleted List Adds or removes a bullet at or from the beginning of the selected paragraph.

Numbered List Adds or removes numbers, incrementally, at or from the beginning of

the selected paragraph.

859
7 Layout Module

Decrease Indent Decreases the indent used for the selected paragraph.

Increase Indent Increases the indent of the selected paragraph (up to 20 levels).

7.8.2.2 Bullets and Numbering Dialog

To edit bullets and numbering go to menu Format | Bullets and Numbering or right click
inside the text where a bulleted or a numbered list is desired. The dialog which appears has
two tabs Bullets and Numbering.

Bullets Tab
In the Bullets tab you can check what bulleting styles you have used and alter their indent, you
can find a selection of predefined bulleting styles for you to select from and apply to paragraphs,
or you can create a new flow with your own bulleting style.

Options Description

None This option is used for a paragraph with bulleting style when you want to abandon
the style. Select the None line and click on Apply.

Used bullets Available only if bullets have previously been used. Lists all of the used bulleting
styles so that they can be reused for other paragraphs. Select the line with a bulleting style
and click on Apply to use it for the current paragraph.

Default bullets Lists preset bulleting styles. Select one of your choice and click on Apply to
use it for the current paragraph.

Custom bullets Enables you to select an existing flow or create a new one this flow can
contain any character, text, or even an image of your choice. After it is applied to a para-
graph it is moved among the Used bullets.

Go to bullet flow Available only for Used bullets. Finds the selected bullet flow in the
Layout Tree.

860
 7.8 Other Helpful Features

Bullet indent Sets the distance from the margin of a flow area for the bullet. Units can be
selected from: m, cm, mm, in, di, pt.

Text indent Sets the distance from the margin of a flow area for the text written in the
paragraph to which a bulleting style is applied. Units can be selected from: m, cm, mm,
in, di, pt.

Note It is recommended to set the Text indent to a greater number than Bullet indent.
If set to a smaller number, the position of the text will be calculated as a multiple of the
default tabulator value of the paragraph style.

For example, if you set Bullet indent to 20 mm and Text indent to 10 mm, the text will
appear at position 25 mm as that is the multiple of the Default tabulator (12.5 mm). The
position of the text (25) is calculated as 2x12.5, which is the first multiple greater than
the Bullet indent value (20) and so the text is displayed at this position behind the bullet.

The value of the Default tabulator can be changed in the Tabs tab of the used paragraph
style Layout Properties.

Numbering Tab
In the Numbering tab you can check what numbering styles (and with them connected num-
bering variables) you have used and alter the indent, you can find a selection of predefined
numbering styles for you to select from and apply to paragraphs, or you can create a new flow
with your own numbering style.

Options Description

None This option in the left part of the tab is selected for a paragraph with no numbering
style set, e.g. if you invoke the dialog above a bulleted list and switch to this tab. It is also
selected after you delete a numbering variable from the list.

Numbering Variable Available only if numbering has previously been used. Every numbering
style is based on a numbering variable, which is automatically created under the Data
node in the Layout Tree whenever numbering is applied to a paragraph. This variable can
be further modified e.g. using the conversions Number to spell, Arabic to Roman number,
Letter indexing from the Conversion tab and/or its presentation on the output can be
changed by adding prefixes or suffixes from the Text Presentation tab of the numbering
variable Layout Properties.

861
7 Layout Module

Go to numbering variable If a numbering variable is selected, it finds the variable in the

Data node of the Layout Tree.

Create a numbering variable Creates a new numbering variable on the first level.

Note To create a numbering style, you need to assign one of the numbering flows listed
in Default or Used numberings to the newly created variable, or create a new numbering
flow via Custom numbering.

Create a dependent numbering variable Creates a new numbering variable one level
below the selected one. If None is selected (no numbering has been used yet), this option
is disabled and only a numbering variable of the first level can be created.

The dependency indicates the level of numbering. For example, for the first level numbering
0. the second level would be 0.0. and the third would be 0.0.0. The level also influences
what will be offered among Default numberings in the right part of the dialog it offers
the numbering styles based on the level.

Remove numbering variable Removes the selected numbering variable from the list
and from the Data node in the Layout Tree after you click on OK or Apply button to
confirm the changes in the Bullets and Numbering dialog.

None This option in the right part of the tab is used for a paragraph with numbering style
when you want to abandon the style. Select the None line and click on Apply.

Used numberings Available only if numbering has previously been used. Lists all of the used
numbering styles so that they can be reused for other paragraphs. Select the line with a
numbering style and click on Apply to use it for the current paragraph.

Default numberings Available only if numbering has previously been used. Lists preset
numbering styles. Select one of your choice and click on Apply to use it for the current
paragraph.

Custom numbering Enables you to select an existing flow or create a new one this flow
can contain your own numbering variable or any character, text, anything a flow can
contain. After it is applied to a paragraph it is moved among the Used numberings.

Go to numbering flow Available only for Used numberings. Finds the selected numbering
flow, which contains the numbering variable, in the Layout Tree.

Type Sets the type of numbering. Two options are available:

Increment If selected, a row of successive numbering is created for all paragraphs

of the numbered list. It is the default option.

Reset This option is used if you need to break the numbering row and either skip
some numbers or repeat a part of the sequence. The number which starts the new
sequence is set in the Start from edit box below.

Example To change numbering for a list of 15 lines, which you want to

split into three lists numbered 1-5, you need to invoke the Bullets and Num-
bering dialog above the sixth and eleventh line and change the Type option
to Reset, Start from to 1 for each.

862
 7.8 Other Helpful Features

Start from This option is available only for Reset type. It sets a starting number for the new
sequence of numbers.

Indent Sets the distance from the margin of a flow area for the number. Units can be selected
from: m, cm, mm, in, di, pt.

Text indent Sets the distance from the margin of a flow area for the text written in the
paragraph to which a numbering style is applied. Units can be selected from: m, cm, mm,
in, di, pt. See also the note in Bullets tab section.

Example How to Set Bullets and Numbering

This example will show you how to set up bullets and numbering to achieve a result as
shown in the following picture:

1. Draw a flow area and place the sample text, e.g. First Chapter, Section 1, etc. on
separate lines as separate paragraphs.

2. Click on the first paragraph (so that the settings are applied to the First Chapter
line) and click on the Numbered List icon in the Paragraph Style toolbar.

Right-click on the first paragraph and go to the Bullets and Numbering dialog via
the Bullets and Numbering option and the Numbering tab in it.

Select the number-with-bracket style from the Default numberings, as shown in

the screenshot below, and click on Apply to confirm the change.

Click on the NumberingVariable 1 in the left part of the dialog and then on the
Go to numbering variable icon. The Bullets and Numbering dialog is closed
and the variable is selected in the Data node of the Layout Tree.

863
7 Layout Module

Go to the Conversion tab in the Layout Properties of the variable and in the
Conversion combo-box select the option Letter Indexing.

3. Click on the second paragraph (so that the settings are applied to the Section 1
line) and click on the Numbered List icon and then on the Increase Indent
icon in the Paragraph Style toolbar.

4. To apply the same settings to the third line, right-click on it and in the Bullets and
Numbering dialog, Numbering tab, select NumberingVariable 2 (second level of
numbering) in the left part and the flow belonging to it from the Used number-
ings, e.g. NuberingFlow 3 in the right part of it, as shown in the screenshot below.
Then click on OK.

5. Click on the fourth paragraph (so that the settings are applied to the Part 1 line)
and click on the Numbered List icon and then twice on the Increase Indent
icon in the Paragraph Style toolbar.

6. To apply the same settings to the Part 2 line, right-click on it and in the Bullets
and Numbering dialog, Numbering tab, select NumberingVariable 3 (third level
of numbering) in the left part and the flow belonging to it from the Used num-
berings, e.g. NuberingFlow 4 in the right part of it. Then click on OK.

7. To apply the bulleting style to the two paragraphs, click first on the Paragraph 1
line and then on the Ordered List icon and then twice on the Increase Indent
icon in the Paragraph Style toolbar. Repeat the same sequence for Paragraph
2 line.

8. To apply the same settings as to the First Chapter to the Second Chapter line,
right-click on it and in the Bullets and Numbering dialog, Numbering tab, select
NumberingVariable 1 (first level of numbering) in the left part and to it belonging
flow from the Used numberings, e.g. NuberingFlow 2 in the right part of it.
Then click on OK.

9. To use your own image as a bullet for the last two paragraphs, select the first one
and right-click on it to open the Bullets and Numbering dialog, Numbering tab.
From the Custom bullets drop down menu select the Create New Flow option
and click on Apply. Then click on the Go to bullet flow icon to find the newly
created flow in the Layout Tree.

864
 7.8 Other Helpful Features

Double-click on the flow to be able to edit it and drag and drop a selected image
there, which will be used as the bullet, and add a tabulator behind it so that the
Text indent can be modified.

Double-click on the page on which you are using bullets and numbering (e.g.
Page 1) in Layout Tree or proof your workflow to see the result.

If you want to achieve the same look as is shown in the picture at the beginning
of this example, you need to increase the indent. To do so, open the Bullets and
Numbering dialog again and change the Bullet indent option (set it to e.g. 12
mm) and the Text indent option (set it to e.g. 20 mm).

To apply the same settings as to the Paragraph 1 to the Paragraph2 (last line of
the example), right-click on the second paragraph and select the flow with the
image from the Used bullets list and adjust the Bullet indent and Text indent
options to the same values.

7.8.3 Clone Selected Objects

See also:
Copy and Paste

Use this option to clone all objects selected in Layout or in the Layout Tree. You can set the
number, size and position of the cloned object(s).

Cloning creates a new instance(s) of the selected object, but any content the object has will
only be duplicated (i.e. the same instance is displayed several times), not cloned.

Example See the below screenshot from the Layout Tree:

In this case FlowArea 1 has been selected in Layout and cloned three times (The value for
Count in the Clone Selected Objects dialog was set to 3). This has created three new in-
stances (i.e. clones) of the original flow area. By default their names reveal their origin
(CloneOfFlowArea 1 etc.). Be aware that in contrary to the flow areas themselves their
content has not been cloned but merely duplicated; each of the clones contains the same
Flow 1. This means that when you alter Flow 1, this will affect the appearance of the
content of all four of these flow areas.

865
7 Layout Module

7.8.3.1 Using the Clone Selected Objects Dialog

After selecting one or more objects in Layout or in the Layout Tree select Clone Selected
Objects from the Edit menu. The Clone Selected Objects dialog is displayed where you can
specify the details of the cloning process:

Options Description

Count Sets the number of clones that will be created.

Translate X Sets the horizontal offset from the original object(s), in specified units. When
cloning more than one object, all further objects are offset in relation to the previous object.

Translate Y Sets the vertical offset from the original object(s), in specified units. When
cloning more than one object, all further objects are offset in relation to the previous object.

Rotate Sets the degree of rotation of the cloned object in relation to the original. When
cloning more than one object, all further objects are rotated in relation to the previous
object. Positive values rotate clockwise; negative values rotate counter-clockwise.

Resize X Increases/decreases the width of the cloned object in relation to the original. A
value of 1 indicates no size change; a value of 2 makes the cloned object twice as wide
as the original, etc. When cloning more than one object, all further objects are resized in
relation to the previous object.

Resize Y Increases/decreases the height of the cloned object in relation to the original. A
value of 1 indicates no size change; a value of 2 makes the cloned object twice as high as
the original, etc. When cloning more than one object, all further objects are resized in re-
lation to the previous object.

Cloning Examples
See the following two examples for details on the effects of the settings you can make in the
Clone Selected Objects dialog.

Example Multiple Cloning with Non-Zero Rotation

When Count is set to a value above 1 and Rotate to a value other than 0, each cloned
object will be rotated by the value set in Rotate in relation to the rotation of the previous
object.

For instance, you could make the following settings in the Clone Selected Objects dialog:

866
 7.8 Other Helpful Features

These settings will lead to the following result:

Each cloned object (here in light grey compared to the dark grey of the original object)
has been rotated by 10 degrees in relation to the object before it.

Example Multiple Cloning with Resizing

When Count is set to a value above 1 and Resize X (Y) to a value other than 1, each
clones width (height) will be based on the size of the previous object. Setting values in
the Translate fields will set the offset of each clone in relation to the previous object.

For instance, you could make the following settings in the Clone Selected Objects dialog:

These settings will lead to the following result:

867
7 Layout Module

Each cloned object (here in light grey compared to the dark grey of the original object) is
resized to 70% of the previous objects size and the offset values set in Translate X and
Translate Y are applied to each cloned object in relation to the previous object.

7.8.4 Copy and Paste

In this section: See also:
Cut Layout Window Menu
Copy Layout Options Dialog
Paste
Enhanced Paste
Paste Multiple
How to Clone in the Layout Tree
Copy and Paste via Context Menus

The options described below are available in the Layout Edit menu:

When editing content in Inspire Designer, standard Cut, Copy and Paste options are available:

7.8.4.1 Cut
To cut a selected item, go to Edit | Cut in the Layout menu; select the option Cut in the item's
context menu in the Layout Tree; or press <Ctrl>+<X>. The cut item will be removed from the
layout (Layout Area and Layout Tree) and placed on the clipboard awaiting the next paste option
to be executed.

7.8.4.2 Copy
To copy a selected item, go to Edit | Copy in the Layout menu; select the option Copy in the
item's context menu in the Layout Tree; or press <Ctrl>+<C>. The copied item will be placed
on the clipboard awaiting the next paste option to be executed.

868
 7.8 Other Helpful Features

7.8.4.3 Paste
To paste an item that you have just copied/cut, go to Edit | Paste in the Layout menu; select
the option Paste in the item's context menu in the Layout Tree; or press <Ctrl>+<V>.

Be aware that when you paste an item you will not always create a new, completely independent
instance of the item that has been copied (such an independent object is called a clone).

When you copy an item in the Layout Area you are likely to be copying several objects that are
contained in that item, e.g. when you copy a flow area with text inside, you actually copy: a
flow area; a flow; a paragraph style; and a text style.

Different object types behave differently:

Position and area defining objects are, by default, always cloned (i.e. new objects are
created) when pasted and are thus independent:

Position defining objects are: Shapes, Barcodes, Charts, Flow Areas, Image Areas, Element
Areas, Lines, Message Areas, etc.

Area defining objects are: Pages and Elements.

Style and content defining objects are not cloned by default; instead, when pasted, a
reoccurrence of the copied object is placed, i.e. the same object will be displayed at the
pasted position in addition to its original position. Therefore, when you modify an object
of this kind, all of its occurrences will be modified.

Style defining objects are: Tables, Row sets, Cells, Paragraph styles, Text Styles, Border
Styles, Line Styles and Fill Styles.

Content defining objects are: Colors, Images, Fonts and Flows.

Any variables updated in the result of copying objects, are listed in an information dialog dis-
played immediately after the pasting of the object into the target workflow/layout.

Pasting Flows
By default, the above distinction made between position/area defining objects on the one hand
and style/content defining objects on the other, has one major exception: flows.

Flows are content defining objects, but the default setting of paste determines that first level
flows will be cloned when pasted. This is a nature of first level flows only, all other flows nested
within a flow will be pasted as reoccurrences like all other content defining objects.

Cloning of first level flows is helpful because a flow area always contains at least one flow (a
first level flow) when it is drawn and typical design use dictates that: when flow areas are
copied and pasted to a new position then the text within that flow area (the flow) is sub-
sequently required to be independent of the original.

869
7 Layout Module

Example

If FlowArea1 containing Flow1 and the nested Flow2 is copied and then pasted,
a new cloned FlowArea11 containing a new cloned Flow11 containing the same
Flow2 is created.

Any further changes made in Flow 2 will be visible in both the original and pasted
flow areas.

If you copy a flow area with a flow containing a table and then paste it, the flow
area and flow will be cloned but the table will not.

This is because the table is a style defining object. Therefore, modifications made
to the table will be visible in both flow areas.

This behavior can be changed in the Options Dialog or, for single-paste actions, you can
modify the default paste settings by using the Enhanced Paste dialog.

For more information on cloning see the section Enhanced Paste.

Note Text is not a layout object. When pasted, it is always a new and independent occurrence
of the text.

RTF (Rich Text Format) does not support some font files included in Adobe Acrobat. Therefore,
when text is copied from a PDF file, it might be pasted to Inspire Designer incorrectly. This is
an Adobe issue that can not be influenced by Inspire Designer settings.

7.8.4.4 Enhanced Paste

The Enhanced Paste option allows you to clone style defining objects when you paste them
to a new place (e.g. flow or page) within your Layout, i.e. create independent versions of the
object instead of a new occurrence of the same object

Going to Edit | Enhanced Paste opens the Enhanced Paste Dialog.

870
 7.8 Other Helpful Features

The screenshot above shows the Enhanced Paste dialog with its default settings. The default
settings displayed here are also applied when you use the normal Paste command.

Options Description

Clone Objects In this field all style/content defining objects are listed. Checking the check-
boxes here identifies the objects that you would like to be cloned, i.e. pasted as new objects
independent of the original object. You can then go on to modify these new objects inde-
pendently.

When Flows is checked (as it is by default) you can further specify First Level (default) or
All. This defines whether pasting a flow will clone All of the flows of the copied selection
or just those to be found at the First Level of the Layout Tree.

Example

If you copy:

A flow area containing one flow (i.e. a first level flow) and then use Enhanced
Paste with Paragraph Styles checked in addition to the default settings (see
above screenshot).

The result is:

A new flow area (flow areas are always cloned) with a new flow (by default,
Flows is checked and First Level is selected, so it is cloned) with a new Para-
graph Style (Paragraph Styles was checked and so the original paragraph
style was cloned).

But, the text style applied to the text is not cloned (Text Styles was not
checked) and any changes made to the text style will affect both the original
and the pasted item.

If you copy:

FlowArea1 containing Flow1 (first level flow) and nested Flow2 and then use
Enhanced Paste with the Flow option checked and All selected.

The result is:

FlowArea1 1 with Flow1 1 and nested Flow2 1, i.e. all new flows based on
the originals.

If you then modify text in any of the flows, the changes will be shown in that
flow only because now all flows have been cloned.

Use RTF in clipboard if available When you are pasting text that has been copied
from an application other than Inspire Designer, this option determines whether the
RTF (Rich Text Format) of that text will be pasted with it.

This option is checked by default.

Save paste mode Checking this option will save the cloning parameters that you have
chosen for use as the default Paste setting, i.e. this synchronizes with the Options
Dialog settings. You can reset to the original default settings in the Options Dialog.

871
7 Layout Module

Tip These clone object settings are exactly the same as can be found in the Options Dialog
of Layout and can be set in either place.

7.8.4.5 Paste Multiple

This option is used for pasting the same item to multiple defined positions:

1. Select an item you want to copy with the Selection Tool icon .

2. Go to Edit | Copy.

3. Go to Edit | Paste Multiple in the Layout window.

The Insert Object dialog opens.

Options Description

Get position from previous pasted object When checked, the first pasted item will be
pasted in the position of the copied item and each following item will be pasted according
to the position of that previous item, plus any offset that is entered.

Position X and Position Y are not required and so become inactive.

Position X The horizontal position of the first pasted object, in relation to the top left corner
of the defined page in the Layout Area.

If Count in X is 1 then no offset can be applied as there are no neighbors in the X direction.

Position Y The vertical position of the first pasted object, in relation to the top left corner
of the defined page in the Layout Area.

If Count in Y is 1 then no offset can be applied as there are no neighbors in the Y direction.

Offset X The horizontal offset between neighboring pasted objects.

Offset Y The vertical offset between neighboring pasted objects.

872
 7.8 Other Helpful Features

You can select the units by clicking on the unit symbol.

Count in X The number of objects to be pasted in a horizontal direction. 1 is the minimum

value.

Count in Y The number of objects to be pasted in a vertical direction. 1 is the minimum

value.

Note Paste Multiple is not available for items selected and copied directly in the Layout
Tree because it is based upon position.

7.8.4.6 How to Clone in the Layout Tree

Remember that the area and style defining objects of a Layout design (paragraph styles, text
styles, tables, images etc.) are organized under the category nodes of the Layout Tree and you
can also copy and paste them there. When they are pasted this way, they always create a clone.

This is especially useful for style defining objects (e.g. TextStyle1, Color1) as it is often needed
to simply alter a style and use it without affecting the original style that is already used in places
throughout a Layout design.

When cloning a new object in the Layout Tree it must be pasted into the correct category
branch (e.g. TextStyles, Colors). Area and style defining objects (nodes) can also be cloned
between multiple Layout modules of a workflow and even WFD files.

Cloning can also be performed by right-clicking on an object's node and selecting Clone from
the context menu.

7.8.4.7 Copy and Paste via Context Menus

The Cut, Copy and Paste options also appear in the context menu when editing layout objects,
flow area content, parameters or variables:

These options are available in the context menu for all layout objects, either when se-
lected in the Layout Tree or Layout Area.

When the Flow Area Tool is active, the content within a flow can be selected and
right-clicking will reveal a context menu that offers them. E.g:

873
7 Layout Module

When editing parameters inside properties panels and dialogs, any text that has been
entered (in edit-boxes or other editable areas) can be selected and right-clicking will
reveal a context menu that offers them. E.g.:

These options are available for parameters and scripting throughout the different In-
spire Designer environments.

When a variable is selected in the Data Transformer module window, right-clicking on

the variable node reveals a context menu with the Copy and Paste options. They enable
you to copy the type of field conversion of the selected variable and paste it to another
variable.

7.8.5 Find Object Uses

The Find Object Uses option provides a list of all places in the Layout design where the currently
selected object or variable is being used (or referenced).

The option is executable by either going to: Edit | Find Object Uses in Layout menu or from
the context menu of the object.

The system of object usage has a certain hierarchy (e.g. a color can be used in a fill style, the
fill style in a text style, the text style in a flow and the flow in a flow area). The Find Object Uses
dialog displays uses of an object in the closest superior object category. To see a further category,
you have to select the particular object use (represented by an object) in the dialog, highlight
that object in Layout Tree (which can be done via the Go To button) and repeat the search for
uses of the highlighted object.

For individual pages, the places where they are referenced are listed. For example, if a page is
set as the starting page at the Pages family node (Page order has to be set to Variable selection),
and under its own node it is set to overflow to the same page, the dialog will list the Pages
family node and the node of the actual page.

874
 7.8 Other Helpful Features

Example The screenshot above lists the uses of a fill style in all objects that are one
category above it: the fill style is used in a shape, a chart and a text style. If you want to
find out where TextStyle1 is further used, you select TextStyle1 in the dialog, use the Go
To button (which closes the dialog and highlights TextStyle1 in Layout Tree) and repeat
the search for object uses. The Find Object Uses dialog that appears again provides now
the list of uses of TextStyle1.

Note

The dialog provides no list of uses for objects that can be only used at the place defined
by the objects' parent node in the Layout Tree. Objects like flow areas, shapes, barcodes,
charts, etc. cannot be used (or referenced) at another place than under their parent
node. Therefore the option has no practical value for them and the single possible use
is not listed.

The dialog also does not list uses of objects in scripts if the option Search and replace
also in scripts in the Layout Options dialog is disabled.

Options Description

Name The names of the other objects where the content of the currently selected object,
that you are finding the uses for, is being used.

Objects that are not used in the design, only marked as used by the Mark as used icon
on the Layout Properties toolbar, are listed in the Find Object Uses dialog with the Name
option empty and the Path option stating Layout.

Usage For objects and variables used in scripts it displays their position in the script (row,
column); it has no practical value for variables and objects used only in the Layout Area.

Path An abbreviation of the path through the Layout Tree where the selected object is located.

Replace with Any object selected in this combo-box will replace the occurrence of the object
that is selected in the table above.

The drop-down menu of this combo-box reveals the complete set of the objects in the
Layout Tree for you to choose from. You should be sure that the object being replaced
and the replacement are of a similar category. If not, Inspire Designer will show a warning
dialog.

Note

This feature does not replace variables in scripts. However, objects used in scripts
are remapped. Variables in scripts can be traced and replaced via Find/Replace Text
palette.

It is possible to switch off searching and replacing objects in scripts. See the section
Global Layout Module Options.

Example During Layout design you have changed some text to be a different font
size, which creates an "invisible" style (this was automatically named TextStyle1). To

875
7 Layout Module

maintain consistency, you decide that all text should be in the Normal text style. To
replace the styles, follow these steps:

1. Highlight TextStyle1 in the Layout Tree.

2. In the Edit menu select the Find Object Uses option.

3. From the list in the Find Object Uses dialog select the occurrence that you
want to replace.

4. Select the Normal text style in the Replace with combo-box.

5. Click on Replace.

6. If there had been more occurrences of TextStyle1, repeat steps three to five
for the remaining occurrences.

Show only nodes of the same type Reduces the options available in the Replace with
combo-box to only those nodes of the Layout Tree that are of the same type as the object.
For example, if the object is a fill style, only fill styles will be listed here. Enabled by default.

Go To Closes this dialog and highlights the object (selected in the dialog) in the Layout Tree.

Replace Performs the replacement of the occurrence of the nodes content in the position/path
selected in this dialog with the content of the node that is selected in the Replace with
combo-box.

Close Closes the dialog.

7.8.6 Find/Replace Text Palette

On this palette you can enter text that you want to search for and replace it with a text or a
variable. The Find/Replace Text Palette window-pane is available after checking this option in
Layout Window Menu and can be moved and placed where required.

Unlike the Find & Replace dialog, which searches within a current flow or script, the Find/Replace
Text Palette lists all of the places in the Layout design where the specified text can be found.

876
 7.8 Other Helpful Features

Moreover, the Replace option in the palette is enhanced with a possibility to replace text with
a variable.

Options Description

Find in By selecting the appropriate combo-box option it is possible to look for texts in flows,
in scripts or in both.

Match whole word only If checked, only matching whole words are looked for.

Match case If checked, searching is case sensitive.

Find Enables to enter the text to be searched for.

After you click on the Find Text icon, all nodes where the text has been found are listed
with occurrences count in brackets.

Nodes Shows the number of nodes selected. Multiple selection can be made with <Ctrl> or
<Shift>.

Count Shows the number of occurrences in selected node(s).

Replace Any text found in the selected node(s) can be replaced here. There are two options
for replacement.

With text Enables to enter a new text which replaces the found text in selected node(s)
after clicking on the Replace icon.

With variable Selects a variable which replaces the found text in selected node(s) after
clicking on the Replace icon.

This function only replaces text with a variable inside flows, it does not allow to replace
text inside scripts. The Go To icon selects the chosen variable in the Layout Tree.

7.8.7 Find Unused Objects

The Find Unused Objects option enables you to quickly find and remove objects that are not
used in the workflow.

Many unwanted objects may be created during the design of a Layout: images, flows, text
styles, object fil styles, etc. that at the end of the design process are not being used. For example,
a flow will be created and placed in the Layout Tree each time that you create a flow area. If
you then delete the flow area from the pages in the Layout Area, the flow will still remain in
the tree structure.

In the interest of keeping your WFD file as small as possible, and reducing the spooling time
of your workflow in later production stages, it is good to check your unused objects during
the later stages of designing your layout and consider removing those that you do not intend
to use again.

When you select Edit | Find Unused Objects from the Layout Menu, the Find Unused Objects
dialog appears:

877
7 Layout Module

In this dialog there is a list in dependency-tree form with all objects (colors, styles, flows, etc.)
that are not currently being employed anywhere in the pages of your design.

Using the Remove button, it is possible to delete selected objects. If you delete an object
containing another object, the contained object will remain in the list but will be listed
under a new category.

Example The screenshot above captures a situation where TextStyleBlue contains

BlueFillStyle (the fill style cannot be viewed in the list above as it is still actively
used, in TextStyleBlue). If TextStyleBlue is deleted, the BlueFillStyle, if not used in
any other object, will appear in the list under the category FillStyles.

The YellowFillStyle is listed among Fill styles and contains the yellow color. If Yel-
lowFillStyle is deleted, the color Yellow will remain in the list but will be listed under
the category Colors.

After deleting TextStyleBlue and YellowFillStyle, the list of unused objects will have
the following structure:

The Remove all button deletes all objects in the list.

Note Make sure that other objects that are used as components of the listed objects
will not be required in future as they will also be deleted.

Objects belonging to the Data and Pages nodes are not listed here and cannot be removed by
this method, as their removal might have wider consequences.

Objects that are marked as used by the Mark as used icon on the Layout Properties toolbar
are not listed in this dialog either. Instead, they appear as used in Layout in the Find Object
Uses dialog.

878
 7.8 Other Helpful Features

7.8.8 Insert Character Palette

The Insert Character Palette enables you to display special characters and place them into the
active flow by clicking on the desired character.

The content of the character palette optionally displayed as part of the Layout window (Window
| Show Insert Char) depends on the font set in the drop-down menu in the Text Format
Toolbar.

When the palette is opened from an edit-field (using the <F2> key), the palette displays char-
acters included in the font set as the Proportional system font in the Workflow/Layout General
Options.

Options Description

Nonbreaking space/ Soft hyphen/ End of line Clicking on these buttons inserts the re-
spective special character.

Insert Clicking on this button enters into the text the character defined by the Unicode value
in the edit-box. If the inserted value is invalid, a suitable warning is displayed. Entering a
value that is a valid Unicode character value but has got no designate within the currently
selected font, results in inserting the missing character glyph (a blank box).

879
7 Layout Module

Context Menu
If you right-click on the panel, you can manage how characters will display (e.g., with/without
hexadecimal or decimal values). The context menu has the same options as described in the
Layout Options Dialog.

Additionally, the palette's context menu has the Find Unicode character option. It opens a
dialog, where you can insert the Unicode value of the searched character.

Once the value is inserted into the edit box and you click on OK, the required character will
be displayed and highlighted within the character palette. If the exact match is not found, the
palette shows characters with neighboring/similar values.

7.8.9 Navigation in Layout

When working in Layout, every object and its properties can be found in the Layout Tree
structure. In complex designs the list of created and used objects in the Layout Tree can be
long and structured, also the Layout Area can be populated with many objects, e.g. tables can
be composed of multiple cells. In such cases you can make use of the following features which
help you find the object node and its properties panel you are looking for much faster:

Page Toolbar

Go to Object Icon

Arrows in Layout Properties Toolbar

Layout Objects Tooltips

Show Node Option

7.8.9.1 Page Toolbar

The Page toolbar, by default located at the bottom of the Layout window, contains options
that enable you to move between the pages of a multi-page layout, go back and forward to
views in the Layout Area, or also to create a new page from there.

For a detailed options description see the Page Toobar section.

880
 7.8 Other Helpful Features

7.8.9.2 Go to Object Icon

Objects in Layout are often defined using other objects properties, e.g. a fill style can be based
on a color, or an image or a gradient. To modify the properties of a selected object you may
need to alter the related object settings.

The Go to object icon displayed next to the related object finds for you the related object
node in the Layout Tree, where you can modify its settings.

You can get back to the previously selected object quickly using another navigating related
feature, the Go back arrow from the Layout Properties toolbar.

Tip The Go to object icon is typically placed to the right of the object property (e.g. a
combo-box with a related object selected), which you would like to go to and change.

7.8.9.3 Arrows in Layout Properties Toolbar

Layout Properties toolbar for each Layout object has on its left side the arrows used for navig-
ation. These arrows move you back and forth in the Layout Tree following the order in which
you have selected Layout Tree nodes, move you to the object's family, or up and down one
object (on the same level) in the Layout Tree.

For a complete description of the toolbar, including the arrows for navigation, see the Layout
Properties Toolbar section.

Note The first two arrows Go back and Go forward are typically used in connection
with the icon Go to object described above. For example, you first find the related object
in the Layout Tree via the icon, modify its properties and then use the Go back icon to return
to the previously selected node.

7.8.9.4 Layout Objects Tooltips

Layout objects tooltips give information about the path to objects within the Layout. To display
the tooltip, press <Ctrl> and hover the mouse pointer above the object.

881
7 Layout Module

The tooltip can give up to four types of information:

Stack Available only for objects within flow areas. Displays the full path to the object
nested in a flow area. Each line in the stack shows one level of the hierarchy within the
flow area and the full name of the object in that level.

Name Displays the objects full name, i.e. name that contains the full path to the object
in the Layout.

Code Available only for texts within flow areas. Displays the unicode value of the
character above which you hover the mouse pointer. For example, value 97 is shown
for the letter "a", 32 for a space.

Section Available only if a section is defined in the flow. Displays the name of the
section and the path to it in the Others node.

7.8.9.5 Show Node Option

This option is available on right-click on an object placed in a flow area, with the Flow Area
tool selected. It enables you to list all nodes constituting the selected object, quickly move to
any of these nodes in the Layout Tree and have the appropriate Layout Properties displayed
for them.

Note Other options accompanying Show node depend on the type of object. For their de-
scription refer to the appropriate object section.

Example When you right-click on a content of a cell in a complex table you get the
following options:

882
 7.8 Other Helpful Features

The Show node option enables you to move directly to:

a variable placed in this cell (Amount),

a flow placed in this cell (Cell2Flow) and to a cell itself (Cell2),

every part of the table (very helpful in case of multiple nested or conditional row-
sets) and the table itself (AccountStatementTable),

the flow and the flow area in which the table has been created and finally the
page on which it is displayed.

The Show node option actually tells us complete information about the object we right-clicked:
if you read the information from the bottom you can see the nodes from the most general to
the most particular one. It corresponds exactly to the structure in Layout Tree.

7.8.10 Quick Access Rights

See also:
Access Rights for Layout Tree Objects

The Quick Access Rights context menu allows you to quickly lock or unlock access rights for
individual objects in the Layout Tree and for their further editing in web applications. The options
are similar to access rights for layout tree objects, but these can be set for different users and
groups. Quick Access Rights menu relates only to a user group Everyone and applies also for
web editing.

This feature is used in connection with Inspire Storefront; see the separate document Inspire
Storefront User Guide for details about web editing.

The menu is available after right-clicking on the selected object in the Layout Tree. You have
to select the appropriate locking / unlocking level after selecting the access right. The tick mark
changes into the lock when the access right is denied for the specific object.

883
7 Layout Module

Options Description

Add Child If this right is locked, the user will not be able to:

Add a new object if this right has been denied to the parent.

Clone an object if this right has been denied to the parent.

Note Inserting a nested flow is still allowed even if the Lock with Links option
has been selected for the parent flow. For disabling it, select the Edit Content
access right and the Lock with Links option.

Example When the Add child right is denied to the FillStyle family, the
options Insert Fill Style and Insert Family will not be available from the
context menu opened after right-clicking on the family.

You have to select one of the available options to enable/disable the access right. These
commands relate to all the operations:

Lock Disables performing the operation for the current level. However, the operation
can still be performed for children and links.

Lock with Children Disables performing the operation directly for the current level and
for all children. However, performing the operation for links is still possible.

Lock with Links Disables performing the operation directly for the current level and for
all links. However, performing the operation for children is still possible.

Unlock Enables performing the operation for the current level. Use this option after you
have formerly selected the Lock option. However, performing the operation for chil-
dren or links is still disabled, if you have formerly selected the Lock with Children
or Lock with Links options.

Unlock with Children Enables performing the operation for the current level and for
all children. Use this option after you have formerly selected the Lock with Children
option. However, performing the operation for links is still disabled, if you have
formerly selected the Lock with Links option.

Unlock with Links Enables performing the operation for the current level and for all
links. Use this option after you have formerly selected the Lock with Links option.
However, performing the operation for children is still disabled, if you have formerly
selected the Lock with Children option.

Remove Child If this right is locked, the user will not be able to delete any object if this right
has been denied to its parent.

See the description above for a list of available options.

Example When this right is removed for the FillStyle family, the Delete option will
not be available from the context menu opened after right-clicking on any object
grouped directly below this family.

884
 7.8 Other Helpful Features

Edit Content If this right is locked, the user will not be able to edit any of the Layout Prop-
erties tabs of an object, neither to edit the content of an object itself. Editing the content
(i.e. modifying texts, inserting/deleting images, etc.) can only be locked for flows. Use this
right to enable/disable editing the flow in web editor (see the separate document Inspire
Storefront User Guide for details about web editing).

See the description above for a list of available options.

Example When you select the Lock option for setting the Edit Content right for
a flow area, any of the tabs in the Layout Properties panel cannot be edited. However,
you will be able to edit the content of the flows.

To disable editing the content of the flow, select the Lock with Links option for a
flow area.

Change Order If this right is locked, the user will not be able to change the order of objects
within a parent.

See the description above for a list of available options.

Example When the Change Order right is denied to an object group, it is neither
possible to change the order of children in the Layout Tree, nor to use options for
moving objects in the Layout Area.

Change Object Transformation If this right is locked, the user will not be able to move,
scale and rotate objects in the Layout Area. This affects only objects which have a Position
tab in their Layout Properties panel; there, the according edit-boxes are greyed out and
will be unavailable for modification.

See the description above for a list of available options.

Web Editing If this right is locked, the user will not be able to use the appropriate option in
web editor. This feature is used in connection with Inspire Storefront; see the separate
document Inspire Storefront User Guide for details about web editing.

Example When this right is denied for a text or a paragraph style, the user will not
be able to apply this style on a text in web editor. However, if the Lock option is
applied on a flow area, the user will be able to view it and to edit its content. To
disable modifying the text in the flow, lock the Edit Content right (see above).

You can also use the Lock/Unlock in Web Editing icon from the Layout Properties
toolbar to apply the same setting.

See the description above for a list of available options.

885
7 Layout Module

7.8.11 Spell Check

You can spell check text either in a single flow or in all flows within the document. To access
the spell checking options, go to the Layout Window menu Edit | Spell Check Current Flow
or Edit | Spell Check All Flows.

The spell checker automatically finds out the language of the text from its Text Style settings
(Language option on the More tab of the Layout Properties panel) and uses the appropriate
dictionary (if available).

When an error is detected, the Spell Checker palette is opened.

Suggested spellings appear in the upper panel. If you want to replace the highlighted spelling
error in your text with one of the suggestions, double-click on the word in the Spell Checker
palette, or use the icons at the base of the palette.

Options Description

Set default language If checked, you can set the language for spell checking for all flows
in the layout. Select the desired language in the Language combo-box. In this case, the
language set on the More tab of the Text Style Layout Properties panel is not taken into
account.

Language Selects the language that will be used for spell checking. Enabled only if the De-
fault language option is enabled.

If you wish to use a language which is not available in the installation, you can place a file
containing the dictionary for your language (the first part of the dictionary name has to
be according to ISO country codes, e.g. de.dic) to the same directory as the PNetT.exe file.
You can select the added language in this combo-box after restarting Inspire Designer.

Continue spell check Continues with spell checking after you have finished making
manual changes.

Replace word Replaces the flagged word with the spelling you have selected from the
Spell Checker palette.

Skip word Skips the flagged word. Moves you on to the next flagged word without
making changes.

886
 7.8 Other Helpful Features

Always skip word Skips all further occurrences of the flagged word in the current spell
checking session.

Add to user dictionary Adds the flagged word to the dictionary so it will not be flagged
in the future.

Note If you add a new entry into your dictionary, it will be applied to the current job,
but the new entry will appear in the dictionary only after you close Inspire Designer.

The apostrophe (') character is taken as a valid part of a word, i.e. the spell checker counts a
word with apostrophe as a whole unit. The ampersand (&), quote (") and hyphen (-) characters
divide a word into items that are checked in the dictionary (or added into it) as individual words.

Inspire Designer can spell check text in all languages available in the installation. If you have
another dictionary available, you can use it in the following way:

1. Create a text file called user.dic in UTF-8 coding, copy the dictionary content to the file
and place it to the same directory as the PNetT.exe file.

2. Run Inspire Designer, select a spell checking option as described above. It always goes
through the user.dic first, if present.

7.8.12 Transform Selected Objects

Using the Transform Selected Objects option, it is possible to transform (move, rotate or
scale) multiple objects selected in Layout or in the Layout Tree. The option can be accessed in
Edit menu of the Layout window.

In general, there are two ways of transforming multiple objects in Layout: the Transform Se-
lected Objects option and the Position tab in Layout Properties of the selected objects. The
following table compares their characteristics:

Transform selected objects Position tab

Can move, rotate and scale multiple objects. Can only move multiple objects.
The transformation origin points* of selected The transformation origin points* of selected
objects maintain the same position in relation objects do not maintain the same position in
to each other. relation to each other.
Values that set the position of the objects are Values that set the position of the objects are
counted from the previous state (the values counted from 0 on the X and Y axes.
are automatically reset to 0 after each
change).

* Transformation origin point is represented by the top left corner of each object.

887
7 Layout Module

Example Transformation of Multiple Objects - Comparison

Consider the initial position of two objects on the following screenshot:

If you select both objects, open the Transform Selected Objects dialog and set Move X
to 10.00, both objects will be moved on the X axis 10 mm to the right..

If you select both objects and in the Layout Properties Position tab set X to 10.00, both
objects will be moved so that their transformation origin points are set to 10 mm on the
X axis.

Selecting the Transform Selected Objects option from the Edit menu will open the Transform
Selected Objects dialog, where you can specify the details of the transformation process.

Options Description

Move X Sets the horizontal offset from the original position of the object(s), in specified
units. Positive values move the object(s) on the X axis to the right, negative values to the
left.

Move Y Sets the vertical offset from the original position of the object(s), in specified units.
Positive values move the object(s) on the Y axis down, negative values up.

888
 7.8 Other Helpful Features

Rotate Sets the degree of rotation in relation to the original position of the object(s). Positive
values rotate the object(s)clockwise; negative values counter-clockwise.

Resize X Increases/decreases the width of the object(s) in relation to the original size. A value
of 1 indicates no size change; a value of 2 makes the object(s) twice as wide as the original,
etc.

Resize Y Increases/decreases the height of the object(s) in relation to the original size. A
value of 1 indicates no size change; a value of 2 makes the object(s) twice as high as the
original, etc.

7.8.13 Undo/Redo Palette

See also:
Layout Window Menu

The Undo/Redo palette (Window | Show Undo/Redo Char Palette) enables you to see the
actions you have taken and choose to undo or redo those steps.

The Type check box shows the selected actions that have been taken against the layout.

Options Description

Undo Undoes the last action made.

Shortcut: <Ctrl>+<Z>

Redo Redoes the action previously undone.

Shortcut: <Ctrl>+<Y>

Count All actions in document memory

Size Total size for all actions in bytes (computer memory unit)

Action size Size for one action in bytes

889
7 Layout Module

Example Each action in Layout could be seen in the Undo/redo Palette.

The new Layout has an empty Undo/Redo Palette, because no action has been done. The
Undo buffer Type is selected and activated.

Redo buffer Type is selected and activated.

After the first step (make for example a new Flow Area) you can see one Undo buffer
entry in the Undo/Redo Palette and nothing in the Redo buffer entry.

The Undo buffer Palette shows that Create flow area action can be Undone.

890
 7.8 Other Helpful Features

The Redo buffer Palette shows that there is still no Redo action available.

Now <Ctrl>+<Z> could be used to Undo the Create flow area action. The Flow Area is
deleted. When <Ctrl>+<Z> is pressed then no action remains in Undo buffer.

There is the new action Create flow area available in the Redo buffer (screenshot below)
.

891
7 Layout Module

Now <Ctrl>+<Y> could be used for the Redo action to be executed (screenshot below).
The FlowArea is created again.

892
8 Impositioning Modules

8.1 Impositioning Modules Overview

8.2 Booklet Maker Module
8.3 Group Filter Module
8.4 Imposition Script Module
8.5 Marks Inserter Module
8.6 Media Pattern Filter Module
8.7 Region Binder Module
8.8 Saddle Stitch Module
8.9 Select N Groups Module
8.10 Sheet Aligner Module
8.11 Sheet Backgrounder Module
8.12 Sheet Concatenator Module
8.13 Sheet Content Modifier Module
8.14 Sheet Duplexer Module
8.15 Sheet Duplicator Module
8.16 Sheet Filter Module
8.17 Sheet Inserter Module
8.18 Sheet Mixer Module
8.19 Sheet Multiplexer Module
8.20 Sheet NS Splitter Module
8.21 Sheet Padder Module
8.22 Sheet Regrouper Module
8.23 Sheet Sorter Module
8.24 Sheet Transformer Module
8.25 Simple N-Upper Module
8.26 Text in Rect Module
8 Impositioning Modules

8.1 Impositioning Modules

Overview
Impositioning is the process of collating sheets. Placing the sheets created by the layout design
in an arrangement that prepares them for a particular media on which they will be printed.

Booklet Maker Module Positions, scales and rotates sheets in order to print the
different pages of brochures, books, etc.

See the section Booklet Maker Module.

Group Filter Module Filters groups or sheets according to selected ranges.

See the section Group Filter Module.

Imposition Script Module Allows the scripting of impositioning and/or data

processing.

See the section Imposition Script Module.

Marks Inserter Module Inserts marks of two types (target or square) in a defined
position on the sheets.

See the section Marks Inserter Module.

Media Pattern Filter Module Separates the incoming sheets to two outputs ac-
cording their pattern sequence.

See the section Media Pattern Filter Module.

Region Binder Module Separates the output among three separate outputs ac-
cording to the weight of the envelopes.

See the section Region Binder Module.

894
 8.1 Impositioning Modules Overview

Saddle Stitch Module Organizes incoming sheets to a booklet and positions them
on the output sheets in a way suitable for saddle stitch binding.

See the section Saddle Stitch Module.

Select N Groups Module Selects the defined number of groups for Proof or
Production.

See the section Select N Groups Module.

Sheet Aligner Module Positions input sheets on the output sheets (aligns the
input sheets along one of the output sheets margins, rotates, stretches or shrinks the input
sheets).

See the section Sheet Aligner Module.

Sheet Backgrounder Module Merges two sheets together so that the input to
the top will be printed first (the background), the bottom input will be printed over it.

See the section Sheet Backgrounder Module.

Sheet Concatenator Module Concatenates the sheets, i.e. adds the sheets from
one Layout after the sheets of the other.

This module is not configurable.

See the section Sheet Concatenator Module.

Sheet Content Modifier Module Enables operations with the content of pages
(e.g. changing color of objects, filtering overlays or handling groups).

See the section Sheet Content Modifier Module.

Sheet Duplexer Module Duplexes. The sheets from the connected layouts are
printed alternately.

See the section Sheet Duplexer Module.

895
8 Impositioning Modules

Sheet Duplicator Module Duplicates sheets.

See the section Sheet Duplicator Module.

Sheet Filter Module Filters sheets, based on a given criteria.

See the section Sheet Filter Module.

Sheet Inserter Module Inserts all sheets from the Layout connected to second
(bottom) input: before or after every nth sheet or before or after every nth group (record).

See the section Sheet Inserter Module.

Sheet Mixer Module Merges two sheets together to give the appearance of
mixed content on any single sheet.

This module is not configurable.

See the section Sheet Mixer Module.

Sheet Multiplexer Module Determines which sheet input will be used for pro-
cessing. The input is controlled by the value of a defined variable.

See the section Sheet Multiplexer Module.

Sheet NS Splitter Module Combines sheets using North/South split positioning.

You can set count and offset on both axes.

See the section Sheet NS Splitter Module.

Sheet Padder Module Pads the number of sheets up to the next multiple of a
given value.

See the section Sheet Padder Module.

896
 8.2 Booklet Maker Module

Sheet Regrouper Module Regroups sheets, based on given criteria.

See the section Sheet Regrouper Module.

Sheet Sorter Module Sorts groups of sheets or sheets within groups according
to sheet name.

See the section Sheet Sorter Module.

Sheet Transformer Module Modifies output. You can set parameters to: rotate
pages; change the scaling of either axis (independently); and set both horizontal and ver-
tical offsets.

See the section Sheet Transformer Module.

Simple N-Upper Module Sets up the document for printing multiple pages per
sheet with definable offsets and counts in either direction.

See the section Simple N-Upper Module.

Text In Rect Module Controls sheets' design and content according to conditions
based on the content captured by the rectangles drawn in this module.

See the section Text In Rect Module.

Note Some of the modules described above are only available with a separate licensing
agreement.

8.2 Booklet Maker Module

The Booklet Maker module can be used to position, scale and rotate sheet(s) within the Output
Face(s) for defined range(s) of input sheets within each group.

897
8 Impositioning Modules

There is no defined output sheet size for the Booklet Maker module. The size of Output Face
can be specified in Output module.

When you double click on the Booklet Maker module in the Workflow the following dialog
opens:

Options Description

Min Sets the minimum value of range for input sheets.

Max Sets the maximum value of range for input sheets.

Output Faces Selects on how many output faces the range of input sheets will fit. (2 faces
may constitute 1 sheet of paper - e.g. for duplex purposes).

Adds more ranges of input sheets. When you click on the Add definition icon, the fol-
lowing dialog opens:

Range end: Selects the end of another range. The new range starts where the previous
range ended.

Output faces: Selects on how many output faces the range of sheets will fit.

Enables you to modify the booklet definition:

Either in Simple edit mode;

Or in Advanced edit mode.

Detailed description of the configuration process follows below.

Deletes the selected range of input sheets.

Enables you to load an existing booklet definition (a BLD file).

Saves the complete booklet definition (a BLD file).

898
 8.2 Booklet Maker Module

Example Sample values for input and output faces can be illustrated this way:

8.2.1 Booklet Definition

When you start designing your booklet, you need to specify the range(s) of input sheets and
the appropriate number of the output faces first. You can do this either by clicking on the
Add definition icon or by loading a booklet definition ( Load definition icon ).

Booklet can be then edited in two modes:

Simple - offers visual assigning of input sheets to output faces and only basic rotation
of 90 degrees

Advanced - offers input sheet assigning, full scale rotation, scaling and offset definition

You can edit booklet after you click on the Visual Booklet Design icon. For a new booklet
the simple edit window opens by default; for modifications of existing booklet either simple
or advanced edit dialog opens depending on where you have created the booklet definition.

899
8 Impositioning Modules

8.2.1.1 Simple Edit Mode

Options Description

Input Sheet Size Enables you to set the size of input sheets. For details about Size, Width
and Height options and the related icons see the Output module.

Rotate Sheet If checked, input sheets are rotated 90 degrees to the right (shown in the
Output faces preview).

To achieve rotation of 180 or 270 degrees, use also the option Toggle rotation available
on right click on specific sheet in the Output Faces preview:

If Toggle rotation option is applied to the first sheet, the result is:

N-Up X Defines how many input sheets will be placed on the output face horizontally.

900
 8.2 Booklet Maker Module

N-Up Y Defines how many input sheets will be placed on the output face vertically.

Booklet Space X Sets the inner space between the input sheets on one output face on the
axis X.

Note The booklet space does not show in the Output faces preview.

Booklet Space Y Sets the inner space between the input sheets on one output face on the
axis Y.

Note The booklet space does not show in the Output faces preview.

Composing Area In this area you can define the layout of your booklet - simply by dragging
the input sheets to the output faces.

If you wish to undo the input sheet assignment on the output face, select the option No
page available on right click on the given sheet.

Print direction arrow refers to the direction in which the sheet of paper is fed into the
printer.

Recommended sequence of steps:

1. Select Input Sheet Size.

2. Define how many input sheets will be placed on one output face (fields N-Up X and
N-Up Y).

3. Drag the input sheets to their positions within the output faces.

Additionally:

4. Apply rotation.

5. Define booklet space.

Tip The output face size is defined in the Output module and it needs to reflect the size of
the input sheets in the booklet because Simple edit mode cannot do scaling. E.g. if you have
two A4 input sheets on one output face, this sheet needs to be A3 size. Use the Advanced
edit mode for scaling or setting offsets.

8.2.1.2 Advanced Edit Mode

The images included in the explanations below show how an input sheet A4 is modified to
become one of the two sheets put in one booklet printed A4 page.

901
8 Impositioning Modules

Options Description

Input Sheet Lists all the input sheets.

Output Face Selects an output face, i.e. where the input sheet will be printed.

ScaleX Changes the size of the input sheet on the axis X.

ScaleX value is set to 0.55 (= sheet width will be 55% of its original width).

ScaleY Changes the size of the input sheet on the axis Y.

Note ScaleX and ScaleY need to be the same if you wish to maintain the aspect ratio.

ScaleY value is set to 0.55 (= sheet height will be 55% of its original height).

Rotation Rotates the input sheet.

The rotation point is in the upper left corner of the sheet.

902
 8.2 Booklet Maker Module

The image shows a rotation of -90 degrees.

OffsetX Sets the offset on the axis X.

OffsetY Sets the offset on the axis Y.

Note If you modified the booklet in Advanced edit mode and now you decide to switch back
to Simple edit mode, you loose the changes you made in Advanced edit mode if you confirm
this message box:

903
8 Impositioning Modules

Example How to Make a Booklet with 8 Sheets

There are 7 input sheets A4 that we would like to put in a booklet printed on 4 output
faces of the size A4 (it means 2 output duplex sheets).

The input sheets need be to be scaled down, rotated and organized in the following way
so that the booklet gets created correctly:

First set the range of input sheets from 1 to 8 and select 4 output faces. We expect 2 input
sheets on one output face.

We can have 7 input sheets within one group. The 8th sheet is missing so an empty sheet
will be inserted at the end of the input sheets sequence.

Then click on the Visual Booklet Design icon, select Advanced Edit and set the fol-
lowing parameters:

904
 8.2 Booklet Maker Module

Setting of Output Faces reflects the illustration above showing where each input sheet
needs to be placed in order to have the booklet set up correctly.

ScaleX and ScaleY determine how much the input sheets should be smaller so that two
of them can fit on one output face. In this case, the input sheet is 66% of its original size.
Values for ScaleX and ScaleY are the same to keep the aspect ratio.

Rotation is set to -90 degrees. It makes the sheet rotate as shown above. Notice that the
rotated input sheet is now positioned outside of the output face range.

OffsetX is the distance in X-axis between the left edge of the output face and the upper
left corner of the input sheet (if rotation is applied the original upper left corner can be
in another position).

OffsetY is the distance in Y-axis between the top edge of the output face and the upper
left corner of the input sheet (if rotation is applied the original upper left corner can be
in another position).

Note that, in our example, after rotation this point appears in the bottom left corner:

905
8 Impositioning Modules

After processing the booklet looks like this:

8.3 Group Filter Module

See also:
Group Filter Module Command Line
Parameters

The Group Filter module enables you to filter groups or sheets according to selected ranges.
The ranges can be defined in the module panel edit fields or using an external file.

906
 8.4 Imposition Script Module

Options Description

Group oriented Filters sheets by groups (record).

Sheet oriented Filters by sheets.

Print all When selected, no filtering is applied.

Range You can specify the start and end numbers of groups/sheets.

Custom

Range You can specify the range(s) in this edit field. Individual values need to be separ-
ated with semicolons, not spaces. For ranges use a dash. For example: 1;3;5-15.

Range from file

Input file Enters a path to an external TXT file with definition of range(s). The same
rules apply for ranges definition as in the Range edit field (see above).

Text encoding Defines the coding of the input file.

See the separate section Text Encoding for more details.

Invert Inverts the condition, i.e., all groups/sheets outside the specified range are printed.

First sheet/group is 1 If unchecked, the indexing begins with zero.

8.4 Imposition Script Module

8.4.1 Imposition Script Module
See also:
Impositioning Script Types and Methods
How to Make a Booklet of Groups with
Variable Size

The Imposition Script module is for performing both impositioning and/or data processing by
scripting.

The intention is to allow scripts to perform any kind of manipulation that is not yet provided
by the standard set of modules in Inspire Designer. However, first consider the existing set of

907
8 Impositioning Modules

Data Processing modules or Impositioning modules to see if they can fit your requirements,
because those modules have been designed to process as efficiently as possible.

Options Description

Data input count / Data output count Determines the number of data inputs/outputs to
the module. This is indicated by the number of connectors on the module icon.

The intention of having data inputs and outputs is so that the module can also be used
for data processing, i.e. the module can be used without performing any impositioning.
However, it is also possible to combine data and sheet manipulations with this module.

If you define one or more data input/outputs, two new areas appear on the left side (see
the screenshot below).

Input Displays the structure of the input data.

Output Specifies the output data structure.

908
 8.4 Imposition Script Module

The Type column selects the data-type of the corresponding field. It is possible to
build a structure of many dependency levels using the icons below.

Create New Opens the context menu for the selected field. This can also be re-
vealed by right-clicking on the field, e.g.:

Insert to script Adds the field to the script written in the Script area.

Find in Script Opens the Find & Replace dialog where you can search for the
variable in the script and possibly replace it with another.

String / Int / Int64 / Currency / Double / DateTime / Bool / Binary / SubTree

/ Optional / Array Creates a dependant field of the selected data-type.

These options only appear for fields with the Type of SubTree, Optional
and Array.

Copy / Paste Copies/Pastes the field via the clipboard, so that its definition
can be used for other fields.

Move Up / Move Down Moves the field up/down in the order of its current
dependency level.

Delete Deletes the field.

Save Saves the data structure definition as a separate WD file.

Sheet input count / Sheet output count Determines the number of sheet inputs / outputs
to the module. This is indicated by the number of connectors on the module icon.

Index sheet names from zero If unchecked, sheet name indexing starts from 1.

Script Special methods are available when working with the Imposition Script module. See
the Impositioning Script Types and Methods section.

909
8 Impositioning Modules

Example The following script for Imposition Script module works in the same way as
Sheet Mixer Module module (places the content of two designed layouts together into a
single layout):
for(Int i=0;i<InputSheeter_0.SheetCount;i++)
{
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[i]);
}
for(Int i=0;i<InputSheeter_1.SheetCount;i++)
{
OutputSheeter_0.SheetInfo[i].addLogPage(InputSheeter_1.SheetInfo[i].Lo
gPage[0]);
}

Notice how the indexes of the inputs and outputs start at 0.

It is possible to use either of the syntaxes:

InputSheeter_0 is processed faster.

InputSheeter[0] is used if you do not have a constant in the [] brackets,

e.g. SheetInfo[i] in this example.

Example This script works like the Sheet Concatenator Module module (concatenates
the output of the layouts):
for(Int i=0;i<InputSheeter_0.SheetCount;i++)
{
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[i]);
}
for(Int i=0;i<InputSheeter_1.SheetCount;i++)
{
OutputSheeter_0.addSheetInfo(InputSheeter_1.SheetInfo[i]);
}

Example The following script enables you to print pages in reversed order, i.e. from
the very last page to the very first:

for(Int i=InputSheeter_0.SheetCount-1;i>=0;i--)
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[i]);

910
 8.4 Imposition Script Module

Example In the following workflow there are 3 pages using data and the current order
is:

Page 1 with "0" and background color of Yellow

Page 2 with "0" and background color of Green

Page 3 with "0" and background color of Red

The file needs to be split so when the data is printed it will be in the proper order. To ac-
complish this we must split the pages into separate files.

The Imposition Script module will separate the pages by sheet name 1 that has been set
up for the individual pages in Layout. Sheet name 1 has an index of 0.

Pages with SheetName = "Y" will be placed on "MyOutput 1"

Pages with SheetName = "G" will be placed on "MyOutput 11"

Pages with SheetName = "R" will be placed on "MyOutput 12"

for(Int i=0;i<InputSheeter_0.SheetCount;i++)
{
if (InputSheeter_0.SheetInfo[i].SheetName[0]=="Y")
{
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[i]);
}
else if (InputSheeter_0.SheetInfo[i].SheetName[0]=="G")
{
OutputSheeter_1.addSheetInfo(InputSheeter_0.SheetInfo[i]);
}
else
{
OutputSheeter_2.addSheetInfo(InputSheeter_0.SheetInfo[i]);
}
}

911
8 Impositioning Modules

Example The following workflow uses the Imposition Script module to process data.

Notice that there is only one data input and one data output. The nature of the data is
not important for this brief demonstration but the structure of the data and the script
used in the Imposition Script module may be useful to help you familiarize with syntax.

The data structure:

A script that processes that input data (it groups people according to birth dates)
and sends it to the outputs:
Util.StringTable table;
table.ColumnCount=2;
for(Int i=0;i<Input_0.Records.Count;i++) // Takes data from inputs
{
DateTime d=Input_0.Records[i].DateOfBirth;
table.addRow();
table[i,0]=(d.Month*100+d.Day).toString(4,true);
table[i,1]=Input_0.Records[i].Name;
}
table.sortRows(0);
for(Int i=0;i<table.RowCount;i++)
{
Int mmdd=table[i,0].toInt();
Int dd=mmdd%100;
Int mm=mmdd/100;
if (i==0 or dd!=Output_0.Birthdays.Day or mm!=Output_0.Birth
days.Month)
{
Output_0.Birthdays.commit();
Output_0.Birthdays.Day=dd;
Output_0.Birthdays.Month=mm;
}
Output_0.Birthdays.Names.Name=table[i,1];

912
 8.4 Imposition Script Module

Output_0.Birthdays.Names.commit(); // Sends data to outputs

}

8.4.2 Impositioning Script Types and Methods

8.4.2.1 CaptureSkipOverlays
If set to true, overlays are not processed when the SheetInfo methods TextInRect and dotsOn-
Page are evaluated.

Syntax
CaptureSkipOverlays

Return Value
Bool

8.4.2.2 InputSheeter Methods

Selects the sheeter for the input.

getSheetCount () : Int
getSheetInfo (Int aP1) : SheetInfo
SheetCount : Int
SheetInfo [Int aP1] : SheetInfo

getSheetCount
Returns the number of sheets in the respective input. Same as SheetCount.

Syntax
getSheetCount ()

Return Value
Int

getSheetInfo
Retrieves further information about input sheets. See the SheetInfo Methods section.

913
8 Impositioning Modules

Syntax
getSheetInfo (Int aP1)

Return Value
SheetInfo

SheetCount
Returns the number of sheets in the respective input. Same as getSheetCount.

Syntax
SheetCount

Return Value
Int

SheetInfo
Retrieves further information about input sheets. See the SheetInfo Methods section.

Syntax
SheetInfo [Int aP1]

Return Value
SheetInfo

8.4.2.3 LogPageInfo Methods

Contains all the settings for a logical page (content, position etc.) in the input. The settings
cannot be changed.

assign (LogPage aP1)

getLayoutIndex () : Int
getLogPageIndex () : Int
getPageIndex () : Int
getPageSize () : RVector
getPageWeight () : Double
getTransformation () : Transformation
LayoutIndex : Int
LogPageIndex : Int
PageIndex : Int
PageSize : RVector
PageWeight : Double
Transformation : Transformation

914
 8.4 Imposition Script Module

assign
Assigns the logical page to a variable. The same result can be achieved using the = operator
(preferable).

Syntax
assign (LogPage aP1)

Return Value
Void

getLayoutIndex
Returns the index of the Layout module from which the logical page comes. Same as LayoutIn-
dex.

Syntax
getLayoutIndex ()

Return Value
Int

getLogPageIndex
Returns the index of the logical page within the Layout module. Same as LogPageIndex.

Syntax
getLogPageIndex ()

Return Value
Int

getPageIndex
Returns the index of the sheet in the output. Same as PageIndex.

Syntax
getPageIndex ()

Return Value
Int

915
8 Impositioning Modules

getPageSize
Returns the dimensions of the specified logical page (in meters). Same as PageSize.

Syntax
getPageSize ()

Return Value
RVector

getPageWeight
Returns the weight of the page as it is specified in the Layout Properties. Same as PageWeight.

Syntax
getPageWeight ()

Return Value
Double

getTransformation
Returns the transformation that has been performed for the given logical page. Same as
Transformation.

Syntax
getTransformation ()

Return Value
Transformation

LayoutIndex
Returns the index of the Layout module from which the logical page comes. Same as getLay-
outIndex.

Syntax
LayoutIndex

Return Value
Int

916
 8.4 Imposition Script Module

LogPageIndex
Returns the index of the logical page within the Layout module. Same as getLogPageIndex.

Syntax
LogPageIndex

Return Value
Int

PageIndex
Returns the index of the sheet in the output. Same as getPageIndex.

Syntax
PageIndex

Return Value
Int

PageSize
Returns the dimensions of the specified logical page (in meters). Same as getPageSize.

Syntax
PageSize

Return Value
RVector

PageWeight
Returns the weight of the page as it is specified in the Layout Properties. Same as getPage-
Weight.

Syntax
PageWeight

Return Value
Double

917
8 Impositioning Modules

Transformation
Returns the transformation that has been performed for the given logical page. Same as
getTransformation.

Syntax
Transformation

Return Value
Transformation

8.4.2.4 LogPageInfoWithSet Methods

Contains all the settings for a logical page (content, position etc.) in the output. The settings
can be changed.

assign (LogPage aP1)

getLayoutIndex () : Int
getLogPageIndex () : Int
getPageIndex () : Int
getPageSize () : RVector
getPageWeight () : Double
getTransformation () : Transformation
LayoutIndex : Int
LogPageIndex : Int
PageIndex : Int
PageSize : RVector
PageWeight : Double
setPageSize (RVector aP1)
setPageWeight (Double aP1)
setTransformation (Transformation aP1)
transform (Transformation aP1)
Transformation : Transformation

setPageSize
Sets the dimensions of the specified logical page (in meters).

Syntax
setPageSize (RVector aP1)

Return Value
Void

setPageWeight
Sets the weight of the page. This setting overrides the value set in the Layout Properties.

918
 8.4 Imposition Script Module

Syntax
setPageWeight (Double aP1)

Return Value
Void

setTransformation
Sets a transformation for the logical page for which the method is called.

Syntax
setTransformation (Transformation aP1)

Return Value
Void

transform
Applies the specified transformation to the logical page (allows multiplication of transformations).

Syntax
transform (Transformation aP1)

Return Value
Void

8.4.2.5 OutputSheeter Methods

Selects the sheeter for the output.

addEmptySheetInfo () : Int
addSheetInfo () : Int
addSheetInfo (SheetInfo aP1) : Int
addSheetInfo (SheetInfo aP1, Transformation aP2) : Int
addSheetInfo (SheetInfoWithSet aP1) : Int
addSheetInfo (SheetInfoWithSet aP1, Transformation aP2) : Int
getLastSheet () : SheetInfoWithSet
getSheetCount () : Int
getSheetInfo (Int aP1) : SheetInfoWithSet
LastSheet : SheetInfoWithSet
setSheetInfo (Int aP1, SheetInfo aP2)
setSheetInfo (Int aP1, SheetInfoWithSet aP2)
SheetCount : Int
SheetInfo [Int aP1] : SheetInfo
SheetInfo [Int aP1] : SheetInfoWithSet

919
8 Impositioning Modules

addEmptySheetInfo
Adds an empty sheet to the output.

Syntax
addEmptySheetInfo ()

Return Value
Int

addSheetInfo
Adds all logical pages from the defined SheetInfo into the SheetInfo, for which the method is
called. These methods do not copy or change sheet names.

The methods with the Transformation parameter also apply the defined transformation to all
added logical pages.

Syntax
addSheetInfo ()

addSheetInfo (SheetInfo aP1)

addSheetInfo (SheetInfo aP1, Transformation aP2)

addSheetInfo (SheetInfoWithSet aP1)

addSheetInfo (SheetInfoWithSet aP1, Transformation aP2)

Return Value
Int

getLastSheet
Contains all the settings for the last sheet (content, position etc.) in the output (settings can
be changed). Same as LastSheet.

Syntax
getLastSheet ()

Return Value
SheetInfoWithSet

920
 8.4 Imposition Script Module

getSheetCount
Returns the number of sheets in the respective output. Same as SheetCount.

Syntax
getSheetCount ()

Return Value
Int

getSheetInfo
Contains all the settings for a sheet (content, position etc.) in the input (settings cannot be
changed). Same as SheetInfo.

Syntax
getSheetInfo (Int aP1)

Return Value
SheetInfoWithSet

LastSheet
Contains all the settings for the last sheet (content, position etc.) in the output (settings can
be changed). Same as getLastSheet.

Syntax
LastSheet

Return Value
SheetInfoWithSet

setSheetInfo
Replaces the content of one sheet info with the content of another sheet info.

Syntax
setSheetInfo (Int aP1, SheetInfo aP2)

setSheetInfo (Int aP1, SheetInfoWithSet aP2)

921
8 Impositioning Modules

Return Value
Void

SheetCount
Returns the number of sheets in the respective output. Same as getSheetCount.

Syntax
SheetCount

Return Value
Int

SheetInfo
Contains all the settings for a sheet (content, position etc.) in the input (settings cannot be
changed). Same as getSheetInfo.

Syntax
SheetInfo [Int aP1] : SheetInfo

SheetInfo [Int aP1] : SheetInfoWithSet

Return Value
SheetInfo / SheetInfoWithSet

8.4.2.6 pauseAfterCurrentSheet
Pauses production and logs the specified message in the Main Production window.

Syntax
pauseAfterCurrentSheet (String aP1)

Return Value
Void

922
 8.4 Imposition Script Module

8.4.2.7 Sheeter Methods

A sheet or group of sheets in the input. The settings cannot be changed.

assign (Sheeter aP1)

getSheetCount () : Int
getSheetInfo (Int aP1) : SheetInfo
SheetCount : Int
SheetInfo [Int aP1] : SheetInfo

assign
Assigns the sheeter to a variable. The same result can be achieved using the = operator
(preferable).

Syntax
assign (Sheeter aP1)

Return Value
Void

8.4.2.8 SheeterWithSet Methods

A sheet or group of sheets in the input. The settings can be changed.

addEmptySheetInfo () : Int
addSheetInfo () : Int
addSheetInfo (SheetInfo aP1) : Int
addSheetInfo (SheetInfo aP1, Transformation aP2) : Int
addSheetInfo (SheetInfoWithSet aP1) : Int
addSheetInfo (SheetInfoWithSet aP1, Transformation aP2) : Int
assign (SheeterWithSet aP1)
getLastSheet () : SheetInfoWithSet
getSheetCount () : Int
getSheetInfo (Int aP1) : SheetInfoWithSet
LastSheet : SheetInfoWithSet
setSheetInfo (Int aP1, SheetInfo aP2)
setSheetInfo (Int aP1, SheetInfoWithSet aP2)
SheetCount : Int
SheetInfo [Int aP1] : SheetInfo
SheetInfo [Int aP1] : SheetInfoWithSet

assign
Assigns the sheeter to a variable. The same result can be achieved using the = operator
(preferable).

923
8 Impositioning Modules

Syntax
assign (SheeterWithSet aP1)

Return Value
Void

8.4.2.9 SheetInfo Methods

Contains all the settings for a sheet (content, position etc.) in the input. The settings cannot
be changed.

assign (SheetInfo aP1)

BoundingBox : RRect
ColorSaturation ()
dotsOnPage (BoolList & aP1, Transformation aP2, Int aDPI)
dotsOnPage (BoolList & aP1, Transformation aP2, Int aDPI, Int aColumnCount)
getBoundingBox () : RRect
getColorSaturation ()
getGroupBegin () : Bool
getLogPage (Int aP1) : LogPage
getLogPageCount () : Int
getSheetName (Int aP1) : String
getTextInRect (RRect aP1) : String
GroupBegin : Bool
isEmpty () : Bool
LogPage [Int aP1] : LogPage
LogPageCount : Int
meetsColorSaturation () : Bool
meetsColorSaturation (Int aLimit) : Bool
SheetName [Int aP1] : String
TextInRect [RRect aP1] : String
TextInRectData : CharInfoList

assign
Assigns the sheet info to a variable. The same result can be achieved using the = operator
(preferable).

Syntax
assign (SheetInfo aP1)

Return Value
Void

BoundingBox
Returns the bounding box comprising all printed content on the page. Same as getBoundingBox.

924
 8.4 Imposition Script Module

Syntax
BoundingBox

Return Value
RRect

ColorSaturation
Returns the color saturation value on the sheet. By using this function you can separate grayscale
and black and white sheets from the color ones. You can send different sheets into different
printers then and thus reduce the ink costs.

The value is counted as the maximum difference between individual color components. The
result is zero for grayscale and black and white images and up to 255 for color images. The
function is very similar to Max Image Color Saturation field converter in Data Transformer
module. However, this converter only calculates the difference for whole images and per indi-
vidual pixels in RGB color space model. The ColorSaturation script enables you to calculate the
color saturation per whole sheet. It also represents a faster and more flexible way of calculating
the color saturation as it is performed for each object on the sheet individually and in a native
color space model. There might be minor differences in results of these two methods due to
a different way of calculation; however, they are not significant for separating the sheets.

To decide which sheets are black and white and which sheets include colors a default limit has
been set with a value of 20. Experience shows that all sheets with a color saturation value
lower than this limit are black and white for a human eye. You can also set your own limit in
the script (e.g. saturationLimit = 10).

Syntax
ColorSaturation ()

Return Value
Int

dotsOnPage
Read any pixel sequence from the position (and in the direction) defined by Transforma
tion aP2.

How many pixels will be read and the Boolean value ascribed to any single pixel is defined by
BoolList aP1. By default, the pixel will return the Boolean value of true (1) if there is more
than fifty percent black. The size of the pixels is defined by Int aDPI.

The intention of these functions is for transcribing barcodes, in which case the size of a single
pixel must be at least twice as wide as the thinnest bar in the barcode.

Including the parameter Int aColumnCount defines how many columns of pixels should
be read. This should be used for 2D barcodes. In this case, the size of the vector aP1 must be
divisible by aColumnCount.

925
8 Impositioning Modules

The data received from the reading of the pixels (a sequence of 1s and 0s) can then be used
by subsequent functions, e.g. to recognize the existence of barcodes, to decode barcodes or
to redraw them elsewhere.

Syntax
dotsOnPage (BoolList & aP1, Transformation aP2, Int aDPI)

dotsOnPage (BoolList & aP1, Transformation aP2, Int aDPI, Int aColumnCount)

Return Value
Void

Example
Util.BoolList bools;
Transformation tr;
tr.translate(0.1, 0);
bools.resize(500, false);
InputSheeter_0.SheetInfo[0].dotsOnPage(bools, tr, 200);
//reads 500 pixels (black = true, white = false) from position 0.1m with
dpi 200
Reading a 2D barcode (dots within a rectangle of 10*5cm):

Util.BoolList points;
for(Int I=0; i<InputSheeter_0.SheetCount; i++)
{
Int dpi=100;
Int columns=(Int)(10/2.54 * dpi);
Int rows=(Int)(5/2.54 * dpi);
points.resize(columns*rows, false);
InputSheeter_0.SheetInfo[i].dotsOnPage(points, Transformation(), dpi,
columns);
}

getBoundingBox
Returns the bounding box comprising all printed content on the page. Same as BoundingBox.

Syntax
getBoundingBox ()

Return Value
RRect

926
 8.4 Imposition Script Module

getColorSaturation
Returns the color saturation value on the sheet. Same as ColorSaturation.

Syntax
getColorSaturation ()

Return Value
Int

getGroupBegin
Returns true if the sheet is the first sheet in a group. Same as GroupBegin.

Syntax
getGroupBegin ()

Return Value
Bool

getLogPage
Returns the LogPage, further methods can be called. Refer to the sections LogPageInfo Methods.

Same as LogPage.

Syntax
getLogPage (Int aP1)

Return Value
LogPage

getLogPageCount
Returns the number of logical pages in the input. Same as LogPageCount.

Syntax
getLogPageCount ()

Return Value
Int

927
8 Impositioning Modules

getSheetName
Returns the sheet name according to the specified sheet name index. Same as SheetName.

Syntax
getSheetName (Int aP1)

Return Value
String

getTextInRect
Captures the text placed in a defined rectangle (RRect) and makes it a string variable. Available
for all native inputs and Layout. Same as TextInRect.

Syntax
getTextInRect (RRect aP1)

Return Value
String

Example

String text;
text=InputSheeter_0.SheetInfo[0].getTextInRect(Rect1);

GroupBegin
Returns true if the sheet is the first sheet in a group. Same as getGroupBegin.

Syntax
GroupBegin

Return Value
Bool

isEmpty
Returns true if the input sheet is empty.

928
 8.4 Imposition Script Module

Syntax
isEmpty ()

Return Value
Bool

LogPage
Returns the LogPage, further methods can be called. Refer to the section LogPageInfo Methods.

Same as getLogPage.

Syntax
LogPage [Int aP1]

Return Value
LogPage

LogPageCount
Returns the number of logical pages in the input. Same as getLogPageCount.

Syntax
LogPageCount ()

Return Value
Int

meetsColorSaturation
Returns true if the maximum difference between individual color components on the sheet
(see ColorSaturation method) is smaller than or equal to the limit. The default limit has been
set to 20. Experience shows that all sheets with a color saturation value lower than this limit
are black and white for a human eye. You can also set your own limit in the script (e.g. sat
urationLimit = 10).

Syntax
meetsColorSaturation ()

meetsColorSaturation (Int aLimit)

929
8 Impositioning Modules

Return Value
Bool

SheetName
Returns the sheet name according to the specified sheet name index. Same as getSheetName.

Syntax
SheetName [Int aP1]

Return Value
String

TextInRect
Captures the text placed in a defined rectangle (RRect) and makes it a string variable. Available
for all native inputs and Layout. Same as getTextInRect.

Including the parameter Bool aSortGlyphs defines whether the glyphs will be sorted. Same
as the option Sort glyphs in Text in Rect.

Syntax
TextInRect [RRect aP1]

TextInRect[RRect aP1, Bool aSortGlyphs]

Return Value
String

TextInRectData
Returns the list of characters on the page including their position on the page.

The methods for the CharInfoList are the same as for Util.IntList.

For each CharInfo (out of the CharInfoList) there are two methods available: Character
of the Char type and Position of the RVector type.

Syntax
TextInRectData

Return Value
CharInfoList

930
 8.4 Imposition Script Module

8.4.2.10 SheetInfoWithSet Methods

Contains all the settings for a sheet (content, position etc.) in the output. The settings can be
changed.

addLogPage (LogPage aP1) : Int

addSheetInfo (SheetInfo aP1)
addSheetInfo (SheetInfo aP1, Transformation aP2)
addSheetInfo (SheetInfoWithSet aP1)
addSheetInfo (SheetInfoWithSet aP1, Transformation aP2)
assign (SheetInfo aP1)
assign (SheetInfoWithSet aP1)
getGroupBegin () : Bool
getLogPage (Int aP1) : LogPage
getLogPageCount () : Int
getSheetName (Int aP1) : String
GroupBegin : Bool
LogPage [Int aP1] : LogPage
LogPageCount : Int
setGroupBegin (Bool aP1)
setLogPage (Int aP1, LogPage aP2)
setSheetName (Int aP1, String aP2)
SheetName [Int aP1] : String

addLogPage
Adds a logical page to the output.

Syntax
addLogPage (LogPage aP1)

Return Value
Int

addSheetInfo
These methods add all logical pages from the defined SheetInfo (parameter aP1) into the
SheetInfo, for which the method is called. These methods do not copy or change sheet names.
The methods with the transformation parameter also apply the defined transformation to all
added logical pages.

Syntax
addSheetInfo (SheetInfo aP1)

addSheetInfo (SheetInfo aP1, Transformation aP2)

addSheetInfo (SheetInfoWithSet aP1)

addSheetInfo (SheetInfoWithSet aP1, Transformation aP2)

931
8 Impositioning Modules

Return Value
Void

Example

Transformation MyTrans;
MyTrans.scale(0.5);
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[0],MyTrans);
//adds the first sheet of the first input to the output with the specified
transformation

assign
Assigns the sheet info to a variable. The same result can be achieved using the = operator
(preferable).

Syntax
assign (SheetInfo aP1)

assign (SheetInfoWithSet aP1)

Return Value
Void

getLogPage
Returns the LogPageWithSet, further methods can be called. Refer to the section LogPageIn-
foWithSet Methods.

Same as LogPage.

Syntax
getLogPage (Int aP1)

Return Value
LogPage

setGroupBegin
If set to true, the sheet is set as the first sheet of a new group.

Syntax
setGroupBegin

932
 8.4 Imposition Script Module

Return Value
Void

Example

OutputSheeter_0.SheetInfo[0].setGroupBegin(true);

setLogPage
Replaces the content of one logical page with the content of another logical page.

Syntax
setLogPage (Int aP1, LogPage aP2)

Return Value
Void

setSheetName
Sets a sheet name for the specified sheet.

Syntax
setSheetName (Int aP1, String aP2)

Return Value
Void

Example

OutputSheeter_0.SheetInfo[0].setSheetName(3,"MySheetName");
//sets the sheet name with the index 3 of the first sheet

933
8 Impositioning Modules

8.5 Marks Inserter Module

The Marks Inserter module enables you to insert various types of marks of the size and in the
position you specify. Marks can be used e.g. for checking the print quality of spot colors or for
determining positions for paper cutting and stitching. You can print these marks on every page,
even pages or odd pages. To enter a mark, click on the Create new icon. Then a new mark
will be created and you can set its properties.

Note If you intend to print multiple pages per sheet and need to insert crop marks on the
individual pages, place the Marks Inserter module immediately after the Layout module in the
workflow, before the Simple N-Upper module.

Options Description

Mark type You can choose among:

Target

Square

Crop marks

Stitch mark

Stitch marks

Crop marks2

Center target

Example

934
 8.5 Marks Inserter Module

Legend

1. Stitch mark

2. Square

3. (Center) Target

4. Stitch marks

5. Crop marks

6. Crop marks2

PosX Sets the position of the mark in millimeters X coordinate (can also be a negative
number).

Note

For the Target mark, the position is set for the upper left corner of the square
corresponding to the target. See the result of setting both PosX and PosY values
to 0:

935
8 Impositioning Modules

For Square mark and Stitch marks it is the upper left corner too.

For the Center target mark, the reference point is the center of the square corres-
ponding to the target.

Legend

1. PosX and PosY values set to 0.

2. PosX and PosY values to 10.

PosY Sets the position of the mark in millimeters Y coordinate (can be also negative number).

Width Sets the size of the mark in millimeters X coordinate.

Height Sets the size of the mark in millimeters Y coordinate.

Offset/Radius Sets the offset or radius of the mark. The bigger the value entered is, the
larger the mark appears visually.

Line width Sets the width of the line in millimeters (only for Target type marks).

Occurrence Selects where the marks will appear:

On every page

On even pages

On odd pages

Spot colors Selects which spot colors will be used for marks. When you click on the icon,
the following window opens:

In Layout Spot color 0 is by default assigned to black color and in Marks Inserter it is always
checked to ensure that the mark gets printed.

936
 8.6 Media Pattern Filter Module

If you use more spot colors, the mark will get printed by using them all and this way you
can check the spot colors print quality.

See also Defining spot colors.

Handling group Selects the handling group, for more details see Handling groups on the
Position Tab and the section on Dithering.

8.6 Media Pattern Filter Module

The purpose of this module is to separate the incoming sheets to two outputs according to
their pattern sequence.

Example of Use
We have a printer that has the tray filled with white, yellow and green papers (in this order,
so the sequence of the papers is white, yellow, green, white, yellow, green, white ... etc.).

We want to print out the group (records) that have individual sheets (within the record) sorted
in the same sequence:

1st sheet is to be printed on white paper,

2nd one on yellow paper and the

3rd on green paper.

The sheet - paper type assignment is defined by specifying the sheet name (so in this case we
set the Sheet name in Layout to white, yellow or green respectively).

Define the pattern sequence in the Media Pattern module as described below on the screen
shot. This defines the sequence of the papers on the printer, respectively sequence of the sheet
names that have to match the sequence of the papers on the printer.

937
8 Impositioning Modules

Sheets can be printed (i.e. their Sheet names sequence matches the defined pattern sequence)
they go into the top output node of the module.

If the sequence does not match, or some used Sheet name is not defined in the Media Pattern
sequence, then they go into the bottom output node of the module (e. g. second printer).

When Ignore order is checked, then the sequence is ignored and when the Sheet name matches
one of the Media Pattern items, it is passed to the top output node.

This may be the case, when the top output node printer has three trays for instance, each filled
with one paper type (white, yellow, green) and the printer can distinguish the correct paper
type needed (so the sequence of the papers is irrelevant in this case).

For the following sheet names sequence For the specified sheet names sequence
you will get this (when Ignore order is you will get this (when Ignore order is
unchecked): checked):

Sheet Name Output Node Sheet Name Output Node

white white top (first output)

yellow top (first output) yellow top (first output)
green green top (first output)

blue bottom (second output) blue bottom (second output)

white bottom (second output) white top (first output)
green bottom (second output) green top (first output)

white white top (first output)

yellow top (first output) yellow top (first output)
green green top (first output)

white white top (first output)

yellow top (first output) yellow top (first output)
green green top (first output)

white bottom (second output) white top (first output)

blue bottom (second output) blue bottom (second output)

938
 8.7 Region Binder Module

8.7 Region Binder Module

See also:
Region Binder Module Command Line
Parameters

The Region Binder module enables you to sort documents that are to be mailed according to
their weight and ZIP code. Documents (letters, bank statements etc.) in envelopes are divided
into three weight groups. Within these groups the envelopes are sorted to bundles by zip
codes. It prints technical data on the first and other pages of each document and inserts sep-
aration sheets between individual envelope bundles.

The Region Binder module settings are defined by a configuration file in XML format. You can
specify envelope bundle parameters (e. g. bundles must contain 10 envelopes minimum and
weigh 450g maximum), separating sheets content, the structure of a report file. See the section
How to create the Configuration File for information on the file structure.

For each weight group there is a separate output connector. The module also automatically
generates an output file for each of the weight groups.

Note For the time being this module works only for Czech ZIP codes. It cannot be used for
other types of ZIP codes without further modification.

Options Description

Output file Selects where output files will be saved. An output file (in CSV format) is created
automatically for each of the weight groups and it contains the following information
about each generated bundle: bundle number, bundle type, bundle ZIP code, bundle de-
scription, bundle weight, number of letters in the bundle, number of sheets in the bundle.

Text encoding Selects output file encoding.

Report file Selects where a report file about processed records will be saved. Its content is
defined in the configuration file. Saves the file in the CSV format.

Text encoding Selects the codec for the text characters of the report file.

939
8 Impositioning Modules

See the separate section Text Encoding.

Module config Loads the configuration XML file that defines the Region Binder module
parameters. See below for details on how to create the configuration file.

8.7.1 How to Create the Configuration File

The configuration file defines the data input files, output groups and other Region Binder
module settings. The file consists of the following parts:

1. Define the ZIP file (list of zip codes), Region file (list of zip code ranges for individual
regions) and their encoding. Envelopes will be sorted according to ZIP codes and ZIP
code ranges defined in these files.

<ZipFile>e:\testing\LastversionofRB\PSCu.tbl</ZipFile>
<ZipFileCodec>UTF-16</ZipFileCodec>
<RegionFile>e:\testing\LastversionofRB\PSCuRegion.ini</RegionFile>
<RegionCodec>UTF-16</RegionCodec>

2. Define bundle properties: The minimum envelope count in each bundle, the maximum
bundle weight, and the index of the sheet name where the code for the OMR barcode
is stored. The OMR barcode will be printed on the sheets that you specify later.

<MinEnvInPackage>10</MinEnvInPackage>
<MaxWeightPackage>750.0</MaxWeightPackage>
<OMRMatrixFromSheetName>4</OMRMatrixFromSheetName>

3. Define the content of the report file. The report file contains information on each record,
its content is configurable. The first line (header) includes the name of the job, the
content of the following lines is defined by the <ReportLine> element, you can use
sheet names or Region Binder variables.

<FirstReportLine>Job:%wpdifDataInput1</FirstReportLine>
<ReportLine>%sn3 number: %sn4%sn2</ReportLine>

4. Define the page sequence settings: ZF (folding of multiple sheets at a time), printing
method (Simplex/Duplex), print medium (Role/CutSheet)

<ZF>0</ZF>
<PrintingMethod>Simplex</PrintingMethod>
<PrintMedium>Role</PrintMedium>

5. Set the interval for inserting a separation sheet. Note that bundles are not interrupted
- the separation sheet is always inserted after the end of the current bundle. The content
of the separation sheet is defined by the <SeparationPage> element.

940
 8.7 Region Binder Module

<SeparateAfter>1000</SeparateAfter>

6. Define the initial mailing number and weight constants (the weight in grams of an
envelope, page and appendix).

<PassNumber>495001</PassNumber>
<EnvelopeWeight>4.8</EnvelopeWeight>
<PageWeight>5</PageWeight>
<AppendixWeigth>0</AppendixWeigth>

7. With the following elements you can define the OMR barcode type.

<BarcodeName>B25InterlaveBarcodeGenerator</BarcodeName>
<BarcodeLength>8</BarcodeLength>

8. Define three groups to which envelopes are sorted by their weight (in grams).

<EnvelopeWeigthGroups>
<SplitRange>
<LowLimit>0</LowLimit>
<HighLimit>20</HighLimit>
</SplitRange>
<SplitRange>
<LowLimit>20</LowLimit>
<HighLimit>50</HighLimit>
</SplitRange>
<SplitRange>
<LowLimit>50</LowLimit>
<HighLimit>349</HighLimit>
</SplitRange>
</EnvelopeWeigthGroups>

9. Define the data inserted into main pages (i.e. individual sheets of bank statements,
letters, etc.) - an OMR barcode and flow areas with variable text (client and bundle
number, pass number, page counter). You can define whether the data will be printed
only on the first page of the document (the element <FirstPageOnly>).

<MainPage>
<OMR>
<Pos X="0.014" Y="0.032"/>
<Rot>90</Rot>
<ModulWidth>0.5 mm</ModulWidth>
<ModulHeight>6 mm</ModulHeight>
<ModulShift>12 pt</ModulShift>
<PreString/>
<InitialValue>1Ndm</InitialValue>
</OMR>
<FlowArea>
<FontLocation>P:\GMC\job_root\fonts\Ftxl___.pfb</FontLocation>
<FontSize>8 pt</FontSize>
<Pos X="0.122" Y="0.044"/>

941
8 Impositioning Modules

<Size X="1" Y="1"/>

<Rot>0</Rot>
<Text>%p/%c</Text>
<FirstPageOnly>true</FirstPageOnly>
</FlowArea>
...
</MainPage>

10. Define the content of the separation sheets (e.g. an OMR barcode, a mark and a flow
area with variable text).

<SeparationPage>
<OMR>
<Pos X="0.014" Y="0.032"/>
<Rot>90</Rot>
<ModulWidth>0.5 mm</ModulWidth>
<ModulHeight>6 mm</ModulHeight>
<ModulShift>12 pt</ModulShift>
<PreString/>
<InitialValue>1N001</InitialValue>
</OMR>
<Mark>
<Pos X="0.005" Y="0.005"/>
<Size X="0.015" Y="0.065"/>
</Mark>
<FlowArea>
<FontLocation>C:\GMC\JOB_ROOT\FONTS\Ftxfc___.pfb</FontLocation>
<FontSize>20 pt</FontSize>
<Pos X="0.100" Y="0.020"/>
<Size X="1" Y="1"/>
<Rot>0</Rot>
<Text>*separation* page %n of %g</Text>
</FlowArea>
</SeparationPage>

11. Define the data inserted to beginning/end pages of the whole printing job (e.g. creation
date, job name, number of records).

<BeginEndPage>
<OMR>
<Pos X="0.014" Y="0.032"/>
<Rot>90 </Rot>
<ModulWidth>0.5 mm</ModulWidth>
<ModulHeight>6 mm</ModulHeight>
<ModulShift>12 pt</ModulShift>
<PreString/>
<InitialValue>1N001</InitialValue>
</OMR>
<FlowArea>
<FontLocation>C:\GMC\JOB_ROOT\FONTS\Ftxlc___.pfb</FontLocation>
<FontSize>20 pt</FontSize>
<Pos X="0.05" Y="0.05"/>
<Size X="1" Y="1"/>
<Rot>0</Rot>
<Text>creation date: %sn5</Text>
</FlowArea>

942
 8.8 Saddle Stitch Module

...
</BeginEndPage>

The whole XML configuration has to be enclosed in the <RegionBinderConfig> element.

8.8 Saddle Stitch Module

See also:
How to Make a Booklet of Groups with
Variable Size

The Saddle Stitch module organizes incoming pages into a booklet and positions the pages on
the output sheets in a way that is suitable for saddle stitch binding. Simultaneously, the module
automatically organizes the sheets for duplex printing and performs sheet padding so that the
total number of pages is a multiple of four.

The Input Page section is to let the module know what size the incoming pages are. The
module can retrieve this data from a Layout module but only if it is connected immediately
after it. In case there are more impositioning modules before the Saddle Stitch module the
correct page size has to be checked and set manually.

The Page Creep section defines the offset of pages for saddle stitching. From the middle of
the booklet to the cover, pages are gradually moved from the center of the sheet (offset) so
that the visibility of the complete printed content is ensured for all pages.

943
8 Impositioning Modules

Options Description

Input Page

Size Selects the size of the incoming pages. The Portrait and Landscape icons
rotate the medium selected in the Size combo-box so that the value entered in Width
becomes the value entered in Height and vice-versa.

Width Sets the width of the incoming pages.

Height Sets the height of the incoming pages.

Page Creep

Offset Sets the offset iteration. For each pair of sheets (i.e. two pages on each output
face) the Offset start value is increased by this value.

Offset start Sets the starting offset value which will be used for pages on the sheet
that makes the middle of the booklet. Both pages on the output sheet will be moved
from the center of the sheet by this value.

Tip The offset between the pages of the booklet may drive the logical pages outside
the printing page area, e.g. when printing an A4 booklet on an A3 output page. This
can be avoided by setting a negative starting offset value. Doing so will result in page
overlapping in the middle of the booklet, however, the outer edges will remain
within the printing page area.

Print in reverse order If checked, the sheets are reordered so that the sheets constituting
the middle of the booklet are printed first.

Example We have 15 pages designed in the Layout and we want to use them to prepare
a booklet suitable for saddle stitch binding. The sheets enter the module and they are
organized into a booklet:

sheets are reorganized for duplex printing

a 16th page is added at the end of the booklet (padding)

for the appropriate sheets a space between booklet pages is inserted according
to the settings in the Offset and Offset start options

The first pair of sheets will look as follows:

On the first sheet, the first page of the booklet is printed together with the padding page
(that will be at the end of the booklet). The sheet on the reverse output face constitutes
the most rear part of the booklet, so the space between pages is the largest here. The

944
 8.8 Saddle Stitch Module

space size gradually decreases towards the middle of the booklet (in each step the Offset
value is deducted).

The next pair of sheets has the space width between pages calculated as the sum of the
Offset start value plus double the Offset value.

The next pair of sheets has the space width between pages calculated as the sum of the
Offset start value plus the Offset value.

The space between the pages that constitute the middle of the booklet is just the Offset
start value.

945
8 Impositioning Modules

8.9 Select N Groups Module

See also:
Select N Groups Module Command Line
Parameters

This module enables you to reduce the number of records (sheet groups) in Proof or both in
Proof and Production. This might be useful if you have a large number of records but it is not
necessary to check all of them.

The resulting number of groups is determined directly in the module. The first and the last
group are always displayed with a selection of in-between groups with regular intervals. For
example, when you have 100 groups and want to display just 10, you will get groups with in-
dexes 0, 11, 22,... to 99 in proof.

It is also available as a workflow parameter, which can be changed dynamically in runtime.

Options Description

Number of groups Sets the number of groups displayed in proof.

Note

If 0 is set, all groups will be displayed (i.e. the module is disabled).

If 1 is set, the first group is displayed.

If a higher number than the overall number of groups is entered, all groups are
displayed.

Use in production If checked, the spool file content will be reduced to the number of groups
set in the above option.

946
 8.10 Sheet Aligner Module

8.10 Sheet Aligner Module

The Sheet Aligner module enables you to position the input sheet on the defined area of the
output sheet that is of different size. You can align the input sheet along one of the output
sheets margins or place it in its center, rotate the input sheet if its orientation is different to
the output sheet, stretch or shrink the input sheet.

If sheet name 1 of the input sheet contains page size, it is automatically recognized by the
module and the sheet name 1 value of the output sheet is set to the new size. The page size
has to be in correct format, i.e. in brackets. See also the Variable medium size option in the
Output Module.

Options Description

Size Selects the size of the output sheet. See also the Output Module section.

Width Sets the width of the output sheet.

Height Sets the height of the output sheet.

Horizontal align Determines the horizontal position of the input sheet relative to the output
sheet. The options are:

Left Aligns the input sheet along the left margin of the output sheet.

Center Aligns the input sheet along the horizontal axis on the center of the output
sheet.

Right Aligns the input sheet along the right margin of the output sheet.

947
8 Impositioning Modules

Vertical align Determines the vertical position of the input sheet relative to the output sheet.
The options are:

Top Aligns the input sheet along the top margin of the output sheet.

Center Aligns the input sheet along the vertical axis on the center of the output
sheet.

Bottom Aligns the input sheet along the bottom margin of the output sheet.

Auto rotation Compares the orientations of the input and output sheets and if they are
different, it rotates the input sheet so that it has the same orientation as the output sheet.

Preserve aspect ratio Preserves the size ratio of the input sheet when it is stretched or
shrunk.

Stretch Stretches the input sheet so that it covers the whole area of the output sheet. If the
Preserve aspect ratio option is checked, maximum possible area is covered that is allowed
by keeping the size ratio of the input sheet.

Shrink Shrinks the input sheet so that it fits to the area of the output sheet. If the Preserve
aspect ratio option is checked, maximum possible area is covered that is allowed by
keeping the size ratio of the input sheet.

8.11 Sheet Backgrounder Module

The Sheet Backgrounder module merges two layouts. The layout connected to the top connector
(Input A) presents the background and is printed first. The layout connected to the bottom
connector (Input B) is printed over the background.

The Layout connected to Input B (Layout B) is the only one that can be repeated by variable
data and the final number of sheets of the combined output is determined by that Layout.
Sheets will only be taken from the Layout connected to Input A (Layout A) while there are
sheets being produced by Layout B. Layout A can have multiple pages and the backgrounds
will be taken in the page order that has been determined in that Layout and then repeated as
required by Layout B.

Example Layout B produces 15 sheets and Layout A has 5 pages designed.

In this case 15 sheets will be produced with the backgrounds repeated 3 times. Sheets
1-5 having the differing backgrounds from Layout A and then again 6-10 will have those
backgrounds repeated, and 11-15 again with the repeated backgrounds.

948
 8.12 Sheet Concatenator Module

A workflow using the Sheet Backgrounder module:

The Sheet Mixer module also merges sheets but, for that module, the two inputs have different
roles.

8.12 Sheet Concatenator Module

Concatenates the output of the connected layouts. All the pages of the layout connected to
the top node of the module are printed first, then pages from the second layout are appended
and so on. The total number of pages is the sum of pages of all the layouts connected to the
module.

Options Description

Input count Sets the number of connectable sheet inputs. The maximum count is 100.

8.13 Sheet Content Modifier

Module

949
8 Impositioning Modules

The Sheet Content Modifier module is useful when you want to send only specified parts of
the sheet content to the Output. The content can be chosen by handling group, overlay or
color. The module can also change handling group affiliation or color of objects to the defined
values, insert shapes into overlays, merge overlays or extract images to an external location.

The output is defined by a string which is typed to the Modifier edit field. Alternatively, you
can use a string provided by another module which you connect to Sheet Content Modifiers
data input in that case the first string or the string from the first subtree will be used.

Note Workflows using the Sheet Content Modifier module cannot be spooled to the DOCX
format.

Options Description

Modifier The Modifier edit field is a multiple line field allowing to type in a sequence of
commands on a single line and/or on multiple lines.

A command can be followed by a comment, which can be typed after a hash mark (#) or
a forward slash. If a comment is inserted, the next command has to begin on a new line.

Available commands:

HP Passes only selected handling groups to the Output command HP together

with group number(s).

HS Filters out selected handling groups use command HS together with group
number(s).

950
 8.13 Sheet Content Modifier Module

HC Changes handling groups command HC together with group numbers, e.g.

HC1>2.

OS Skips overlays.

OP Passes only overlays to the Output.

CD Sets the maximum tolerance for the values of the color commands (CP, CS, CC,
CA, CN, CN2) command CD together with a tolerance value. The tolerance
ranges from 03 for RGB, 04 for CMYK.

When you use this command, the application compares the color space of the
color set in a color command with the color space of the evaluated color. To get
the difference between the two color spaces, the following equation is used:

Where R1, G1 and B1 are RGB color space components of the color set in a
color command; R, G, B are RGB color space components of the evaluated color.
The result is always in the range from 0 to 3.

If the result is smaller or equal to the tolerance value, all objects in this color are
passed to the Output.

CP Passes only those object to the Output that have the specified color value (RGB)
command CP together with RGB value.

A tolerance for RGB color values can be defined using the CD command.

CS Filters out objects that have the specified color value (RGB) command CS to-
gether with RGB value.

A tolerance for RGB color values can be defined using the CD command.

CC Changes all colors that pass to the Output to the specified RGB value command
CCRGB together with RGB value (in the range 0255 or as a percentage value),
or to the specified CMYK value command CCCMYK together with CMYK value
(in the range 0100).

Note CC command cannot be combined with CN or CN2 commands.

CA Names a specific RGB or CMYK value as a specific colorant command CA and

then either RGB or CMYK together with the value and thereafter the name of
the colorant in quotation marks, e.g. CARGB0,150,150,"Brown'". Apart from
colorants, this command also applies to spot colors and dithered spot colors.

You can further define a tolerance for the RGB or CMYK color values using the
CD command before this one.

See the section Colors for an introduction to colorants, spot colors and dithered
spot colors.

Tip Color conversions made in the Sheet Content Modifier module affect both
raster and vector outputs, i.e. the commands used for converting colorants, spot
colors and dithered spot colors can be used for converting colors. The color
conversion can be verified using a vector proof profile or a raster proof profile
using CMYK output colors (no colorants are involved).

951
8 Impositioning Modules

CN Defines that a color with a specific RGB or CMYK value will become a specific
colorant command CN and then RGB or CMYK together with the value and
name of the colorant in quotation marks. The CN command also applies to spot
colors and dithered spot colors.

Example You want to convert the RGB colors 200,10,10 and 10,10,200
in the design to colorants with names Red and Blue, enter: CNR-
GB200,10,10,"Red" CNRGB10,10,200,"Blue".

Alternatively, you can describe a multiple colorant mix inside brace marks by
putting the name of each colorant inside quotation marks, following it with its
percentage in the mix, e.g. CNCMYK15,0,90,0,{"Yellow",60%,Blue,12%}.

All colorants used when converting to a multiple colorant must either first have
been named using the CA command or converted using the CN command.

You can further define a tolerance for the RGB or CMYK color values using the
CD command before this one.

Example You want to convert a color, that has been used in the design,
into a multiple colorant:

1. You can define RGB value 200,10,10 as the red colorant and value
10,10,200 as the blue by entering: CARGB200,10,10,"Red" CAR-
GB10,10,200,"Blue".

With this first step no colors are converted, only named as colorants.

2. Then you can convert a third color, with RGB value 200,10,200 into
a multiple colorant that mixes both of the colorants defined in step
1 by entering: CNRGB200,10,200,{"Red",50%,"Blue",50%}.

In total, you have an entry in the Modifier edit-box that reads: CAR-
GB200,10,10,"Red" CARGB10,10,200,"Blue" CNRGB200,10,200,-
{"Red",50%,"Blue",50%}.

See the section Colors for an introduction to colorants, multiple colorants, spot
colors and dithered spot colors.

Note CN command cannot be combined with CC command.

CN2 Changes a specific RGB or CMYK color range into a colorant gradient com-
mand CN2 followed by RGB or CMYK together with the initial and terminal values
of the selected range, the names of the colorants to be used, and the number
of interpolation sections of the gradient. Apart from colorants, this command
also applies to spot colors and dithered spot colors.

You can further define a tolerance for the RGB or CMYK color values using the
CD command before this one.

952
 8.13 Sheet Content Modifier Module

Example You want to convert a range of colors into a colorant gradient.

The starting colorant of the gradient is Red, the ending colorant is Blue.

Write in the CN2 command, then RGB followed by the starting value of the
range to be selected. Then write the colorant name and percentage in brace
marks. Proceed identically with the ending value of the range and the name
of the ending colorant. Finally, write the number of interpolation sections.

The command could read this way (depending on selected values):

CN2RGB0,0,0,{"Red",100%},255,255,255,{"Blue",100%}, 15.

See the section Colors for an introduction to colorants, spot colors and dithered
spot colors.

Note CN2 command cannot be combined with CC command.

MT Modifies the alpha channel (transparency) of RGBA or CMYKA images. If used,

white color becomes fully transparent while other colors lose their transparency.
Modifications will only take effect provided the alpha channel value of the re-
spective color ranges between 0 and 255 (if the value is just 0 or 255, the alpha
channel is left unchanged).

This feature is useful when printing images with transparency, especially on white
media.

DO Inserts shapes into overlays enter the DO command followed by the number
of shapes repetitions needed for creating an overlay and the maximum number
of overlays.

This feature is useful when you produce AFP or AFP-like outputs and the print
job's layout contains multiple variable shapes (or multiple shapes not included
into overlays) with the same path. The benefit of applying this command is de-
creasing processing time and spool file size.

Example Entering the command DO3,200 will create an overlay for a

shape which has been repeated for the third time at least. The maximum
number of overlays is set to 200.

The setting shown in the example is the recommended one, however, the number
of repetitions is up to your decision and the maximum number of overlays which
can be created depends on the memory size of the printer being used. The
overlays created using this feature are additional overlays if there are any other
overlays in the print job, they will remain unaffected.

EI Extracts images in a specified resolution into a disc location enter the EI com-
mand followed by DPI values and the path to the directory where the extracted
images will be saved. Images will be extracted when proofing the job.

The purpose of the command is adjusting DPI and editing the images used in
the Layout without affecting original images.

The EI command extracts and saves every transformation of an image used in

the Layout, i.e. if an image is used multiple times and every instance has a differ-

953
8 Impositioning Modules

ent rotation, the number of extracted images will be the same as the number of
different settings. The extracted images are saved in TIF format.

When proofing for the first time, images will be extracted to the desired location
and assigned unique filenames containing image-related information. When re-
proofing, the extracted images will be used.

Note Format config settings in the Production environment may affect the
generating of file identifier(s), so spooling a file may result in extracting files with
different identifiers.

The extracted images can be edited using an external application with the ad-
vantage of leaving the original images untouched. The changes made to the
images will appear in the Proof environment they will be visible when the job
is re-proofed or any action (zoom, move up/down) is taken in the Proof.

Example Entering the command EI300,300,"c:\ExtractedImages" will ex-

tract the images used in the layout to the specified directory with the DPI
values set to 300,300.

If you change the command to EI300,300,".", images will be extracted to

the directory where you have executed PNetT.exe.

If you wish to extract images to the directory where your WFD file is located,
change the command to EI300,300,"map://wfd /.".

A unique name of an extracted image will follow the pattern shown below:

OCP Removes unnecessary clipping paths from input files used in the Layout enter
the OCP command.

The OCP command works in a way similar to the Optimize clipping paths option
of Native Import to Layout, however, this command is executed during the ap-
plication runtime. Using the OCP command helps decrease the number of objects
in the spool file, which may lead to a reduction of its size.

MO Merges multiple overlays created from a page into one overlay enter the MO
command.

This command is useful when printing N-Up pages on printers that support only
one overlay per page, e.g. ScreenTop printers.

Note Entering the MOI command will also add images to the overlay.

RO Removes images from overlays.

This command is useful if you wish to remove objects. e.g. images or shapes,
from overlays so that they could be processed independently.

954
 8.14 Sheet Duplexer Module

Example You have a workflow that features a Inspire Native module using
a PDF file containing images in overlays. The AFP image handling options,
however, do not apply to those images.

Using the RO command removes the images from overlays and the AFP
image handling can be applied.

Example You can use combinations of these commands to create an output

that fits your needs.

The string in this example will only pass to the Output objects affiliated to
handling group 1 (HP1) that are simultaneously in red color (CP255,0,0). Then
the color of all objects passed to the Output is changed to green (CCRGB0,255,0).

Tip You can write the string either with or without spaces between individual
commands.

Find Error Checks for errors in the command syntax and sequence and enables you to correct
it.

8.14 Sheet Duplexer Module

The Sheet Duplexer module is used to print pages of two connected Layout modules alternately,
i.e. the sequence is: the first page from the first Layout (connected to the top connector), the
first page from the second Layout (connected to the bottom connector), the second page from
the first Layout, the second page from the second Layout, etc.

This can be useful when, for instance, you print account statements and want to use the back
pages for advertising.

The Sheet Duplexer enables you to handle the two Layouts even if they have different total
number of pages you can select from three "Repeat" options.

Note If the print-out should be duplex, make sure that you specify the duplex type and the
output sheet size (size of the medium) in the Output module.

955
8 Impositioning Modules

Options Description

Simple If selected, pages from both Layouts will be printed alternately. If one Layout has
more pages than the other one, the missing pages are left blank.

Repeat first The option is used when you have fewer pages in the first Layout than in the
second one. If selected, printing of pages from the first Layout will be repeated until all
pages from the second Layout are printed.

Repeat second The option is used when you have fewer pages in the second Layout than
in the first one. If selected, printing of pages from the second Layout will be repeated
until all pages from the first Layout are printed.

Repeat auto The option recognizes automatically which Layout has more pages and the
result is either like for the Repeat first option or like for the Repeat second option. No
page is left blank.

Example This example shows the usage of Sheet Duplexer with the Repeat second
option selected.

The bottom connector of the Sheet Duplexer is marked to show that the pages coming
from the second Layout can be repeated, if the first Layout has more pages than the
second.

The image below shows the sequence of pages in case that there were four pages coming
from Layout 1 and of two pages from Layout 2.

Front Page Back Page Front Page Back Page Front Page Back Page Front Page Back Page

Layout 1 Layout 2 Layout 1 Layout 2 Layout 1 Layout 2 Layout 1 Layout 2

Page 1 Page 1 Page 2 Page 2 Page 3 Page 1 Page 4 Page 2
(REPEATED) (REPEATED)

956
 8.15 Sheet Duplicator Module

Note If the system variable Global Page Counter was used on the pages, it would show
the values 1-4 for Layout 1 pages (for front pages), but for Layout 2 there would be values
1,2,1,2 (on the back pages) as the pages 1 and 2 would be repeated.

8.15 Sheet Duplicator Module

The purpose of the Sheet Duplicator module is duplication of single sheets or whole groups of
sheets. The duplication can be fixed or controlled by a variable. The modules two sheet inputs
allow to combine layouts with the ability to determine the positions of overlays.

The Sheet Duplicator module is able to combine two Layouts. The pages from the Layout
connected to the upper input (input A) of the Sheet Duplicator module are duplicated and
combined with the respective pages from the Layout connected to the lower input (input B).
The first (original) page from Layout A is combined with the first page from Layout B, its first
duplication is combined with the second page in Layout B, etc. If there are more duplications
than available pages, the last page from Layout B is repeated for the rest of duplications.

Options Description

Duplicate Selects if single sheets or whole groups are duplicated.

If the Sheets option is chosen, each sheet is duplicated immediately, groups are ignored.
The Groups option duplicates the whole set of pages.

Note In case of variable controlled duplication the number of duplications set by the
variable is valid for the whole group, if the Groups option is selected. This means that each
sheet in the group is duplicated as many times as the variable on the 1st page of the group
sets.

957
8 Impositioning Modules

Duplication type This combo-box selects the duplication mode. There are two options
available:

Variable - Each sheet duplication is driven by the variable specified in the Sheet
name index edit field (see below).

Fixed - All the sheets will be duplicated as many times as stated in the Count edit
field (see below).

Sheet name index Selects the duplication controlling variable (according to its index) from
the Sheet Names tab of individual pages' Layout Properties panel or globally for all pages
in the same tab of the Pages Layout Properties.

Only editable when variable duplication is selected.

Note The sheet name is a string, but has to contain string representation of an integer.

Count The value states the overall count of sheets in the output, e.g. if the value is 3 the
output is 1 original plus 2 copies.

Only editable when fixed duplication is selected.

Overlay Z-order By selecting either the option Back or Front, you determine the position of
the overlay on the Z-axis.

If you set the option to Back, the overlay from Layout B will be printed beneath the overlay
from Layout A; if Front is selected, the overlay from Layout B will be printed over the
overlay from Layout A.

8.16 Sheet Filter Module

The Sheet Filter module enables you to pass selected sheets, that have been defined in Layout,
on to the output (or keep them from passing to the output) based on a specified group size
or sheet name criteria. Each of the three radio buttons By group size, By sheet name and
By sheet name from file displays a specific panel for setting these criteria.

Options Description

By group size

958
 8.16 Sheet Filter Module

If selected, only records (groups) containing the specified number of sheets are passed on
to the output.

If the range is set, for example, from 1 to 10 as in the screenshot above, only those records
that have between 1 and 10 sheets are passed through. Records with 11 or more sheets
are filtered out.

Tip A "group", by default, means "record", unless you change this via a Sheet Regrouper
module.

By sheet name

If selected, only sheets with specified sheet name will be passed on to the output.

Sheet name index Sets the index of the sheet name used for setting a condition.

Name The sheet name condition can be built using the options Equal to, Begins with
or Contains in the Name combo-box. See the example below.

By sheet name from file

959
8 Impositioning Modules

If selected, only sheets with names specified in an external file are passed on to the output.

Input file with sheet names Enters a path to external TXT file with sheet names, each
sheet name has to be on a separate line.

Text encoding Defines the coding of the input file.

Invert If checked, the condition set above is inverted, i.e. all sheets except those that meet
the specified criteria are passed on. See the example below.

Example In the following example, there is one input file and we want to have two
outputs one including a cover page only and the other one including the rest of the
pages excluding the cover page. In order to get the desired result we have to implement
two Sheet Filter modules.

First set the Sheet name option to CoverPage in the page Layout Properties.

The SheetFilter1 module passes only those pages that have CoverPage set as their sheet
name because this output is set to be filtered By sheet name.

The second Sheet Filter module, SheetFilter2, passes all other pages to the output apart
from the cover page because the Invert option has been checked. It reverses the condition
Equal to CoverPage so that only pages other than the cover page are passed through.

960
 8.17 Sheet Inserter Module

8.17 Sheet Inserter Module

The Sheet Inserter module inserts all of the sheets from any layout that is connected to its lower
input (input B) in between sheets that are being read from the layout that is connected to its
upper input (input A).

The manner in which this is done is further defined by the following options:

Options Description
Select from:

Groups Defines that the sheets from Input B (lower) will be inserted at points between
groups that have been defined via Input A (upper).

By default, a group is one record that has been read from the data input.

Sheets Defines that the sheets from Input B (lower) will be inserted at points between
the sheets that are read via Input A (upper).

One sheet is equivalent to one printed page-side.

For both of the above selections you should further define the following attributes.

Count Defines the number of groups or sheets from Input A (upper) that should be counted
to judge the place where the sheets from Input B will be inserted.

This is a repetitive count, i.e. once the count total is reached to find one sheet/group it is
restarted to find the next. The exact position relative to that sheet/group must then be
further defined by the Insert combo-box.

961
8 Impositioning Modules

Example If the Sheets radio-button has been selected and 3 is entered in the Count
edit-box, then all of the sheets from Input B will be inserted in a position relative to
every third sheet read from Input A.

Insert Defines where the sheets from input B will be inserted in relation to the sheet or group
determined by Count. Select from:

Before Before that sheet/group.

After After that sheet/group.

At position At a specific position between sheets.

This is particularly relevant to groups, i.e. when Groups has been selected it is for
inserting the sheets from input B in a position between the sheets contained
within those groups.

That position must be entered in the edit-box below.

Position 1 is before the first sheet of the group, 2 is between the first and second
sheet of the group etc. Position 0 is at the end of the group, -1 is before the last
sheet of the group etc.

At position by sheet index At a specific position between sheets that is further

defined by the value returned by a sheet name.

Definition of position by sheet name can be more flexible as the sheet name could
be assigned a variable that, for example, could have values read from a data file.

The index number of the sheet names that will return the value must then be
entered in the edit-box below.

Example It is needed to print an advert that has been designed in Layout 2, together
with each and every record that is read via Layout 1. It should be printed after last sheet
of the record.

Layout 1 is connected to Input A (upper) and Layout 2 is connected to Input B (lower).

Groups is then selected and Count is left with value 1. In the Insert combo-box, then
select After, defining that "after every 1 record the complete design from Layout 2 will
be inserted".

Example It is needed to print a notification of a 'special prize', that has been designed
in Layout 2, to every 500th customer whose record is read from Layout 1. This notification
must always be the third sheet printed for that customer.

Layout 1 is connected to Input A and Layout 2 is connected to Input B. Groups is then

selected and 500 is entered in Count. In the Insert combo-box, select At position and
then enter 3 in the edit-box below. This defines that "for every 500th record the complete
design from Layout 2 will be inserted inbetween the second and third sheets read from
Layout 1".

962
 8.18 Sheet Mixer Module

Example It is needed to print a flag (a single sheet designed in Layout 2) to indicate

that a 'bundle' of one thousand sheets from Layout 1 has been printed.

Layout 1 is connected to Input A and Layout 2 is connected to Input B. Sheets is then se-
lected and 1000 is entered in Count. In the Insert combo-box, then select After. This
defines that "after every 1000th sheet from Layout 1 the sheet from Layout 2 will be in-
serted".

8.18 Sheet Mixer Module

The Sheet Mixer places the content of two designed layouts together into a single layout.

The content from the layout connected to the bottom input of the module (Input B) is placed
over the other. However, the resulting effect is a mix of the designs and only if objects in the
design are not transparent (e.g. images) will it be possible to see that one object is on top of
another.

The two layouts can be completely independent and may even have separate data input files
or produce a different number of sheets. However, when the sheets from one input run out
they are not repeated.

Example The Layout going into Input A has 12 sheets but the Layout into B only has
5.

In this case, 12 sheets will be produced but only the first 5 will be mixed.

A workflow using the Sheet Mixer module:

Alternatively, this module can be used to mix previously printed native files (e.g. AFP or PDF
files) with newly designed content. Such a workflow would mix a Inspire Native module with
a Layout module. For an example of such a workflow see How To Use AFP Index Module or
How to Use the Statistic Data Module.

963
8 Impositioning Modules

There are no options associated with this module.

The Sheet Backgrounder module also merges sheets but, for that module, the two inputs have
different roles.

8.19 Sheet Multiplexer Module

Sheet Multiplexer module enables you to affiliate a specified sheet input with the modules
output. The module has one data input and two or more (max. 30) sheet inputs and one sheet
output. This module helps to reduce the number of modules in the post-processing part of the
workflow by using just one output for several ways of processing (inputs).

The purpose of the data input is to provide a variable or parameter determining which sheet
input will be used. It can be any suitable data input module (e.g. Script Data Input, Param Input)
or the Layout module.

Example In this example there are three available sheet inputs: a simple input from
Layout, an input with Sheet Regrouper and another one with Sheet Duplicator. A para-
meter defined in the Param Input module is used as a variable for selection of sheet input.

In the Sheet Multiplexer module you can configure the input to be used. Double-click the
module icon and select an integer type variable from the list displayed. The value of this variable
will determine the sheet input used for production. If the value is zero, no input will be pro-
cessed. If the value is 1, the first sheet input will be used, if the value is 2, the second sheet
input will be used, etc.

In the Sheet input count field it is possible to specify the number of sheet inputs of the
module.

964
 8.20 Sheet NS Splitter Module

Example In this example, that corresponds to the previously presented workflow, the
user has created three sheet inputs and selected InputSelect as the variable controlling
the input.

8.20 Sheet NS Splitter Module

See also:
Sheet NS Splitter Module Command Line
Parameters

The Sheet NS Splitter module provides North/South split positioning of the sheets that are input
into the module. This combines the input sheets into fewer output sheets.

This can be especially useful for many continuous printing applications, such as printing A4
pages on an A3 width roll or if it is required to arrange many sheets (that have been created
from the pages of the layout design) onto a single sheet and specify their order.

Basically, you can set count and offset for each axis.

965
8 Impositioning Modules

Options Description

Count X Sets the number of input sheets to be printed across a single output sheet (width
of the printer).

The Continue icon reveals further 'offset X' combo-boxes to allow the entry individual
offsets for each sheet in the X direction, e.g. if 3 is entered in the Count X combo-box,
two more combo-boxes Offset X2 and Offset X3 will appear.

Offset X Sets the distance between the origins of the input sheets being printed across the
output sheet. The first sheet is positioned according to its origin and the value entered is
repeated as the additional offset for each further sheet in the X direction.

Example If 3 is entered in the Count X combo-box and 1 is entered for Count Y

and then 220 mm is entered for Offset X. The result is that the first sheet will be at
position (0,0) mm, then the second will be at (220, 0) mm and the third will be at
(440, 0) mm.

However, if the Continue icon has been used (it shows as rotated ) then the value
set here, in the Offset X combo-box, is the offset of the first sheet from the origin. The
offset of each further sheet in the X direction must be entered in the further 'offset X'
combo-boxes that appear below this one, e.g. Offset X2 for the second sheet and Offset
X3 for the third.

Alternatively, entering a value in the Offset X and then clicking on the Continue icon ,
automatically calculates the equally-spaced offsets for the number of sheets entered for
Count X and displays them in the corresponding 'offset X' combo-boxes. The displayed
values can then be adjusted.

It is recommended to set values larger than the width of the page (set in Layout) in order
to avoid overlapping.

Count Y Sets the number of input sheets to be printed down a single output sheet (Y axis -
in the feed direction).

Similar to with Count X, the Continue icon reveals further 'offset Y' combo-boxes to
allow the entry individual offsets for each sheet in the Y direction.

Offset Y Sets the distance between the origins of the input sheets being printed down the
output sheet. The first sheet is positioned according to its origin and the value entered is
repeated as the additional offset for each further sheet in the Y direction. See the example
for the option Offset X above.

However, the Continue icon has a similar effect on this option as it does with Offset
X (see above).

It is recommended to set values larger than the height of the page (set in Layout) in order
to avoid overlapping.

Example If the Continue icon has not been used and Offset X and Offset Y
are both 0, then the sheets will be placed exactly on top of one another.

966
 8.20 Sheet NS Splitter Module

Split offset If Split type is set to Simple, sets the input sheet after which a split should occur
in order to make a single NS split package.

This is particularly useful if odd numbers of sheets are being printed and more input sheets
should be positioned on the first side of the split than on the other(s).

Example If a layout design will process 17 sheets, with 1 to 10 required to be

printed on the left side of the printing media (the output sheets) and 11 to 17 to be
printed on the right side.

Count X should be set to 2 and Count Y would be set to 1 (i.e. one sheet on the
left and one on the right) and Split offset should be set to 10.

The value 10 means that the first ten input sheets will be placed on the left of ten
output sheets. Then, the remaining seven input sheets will be printed on the right
of those same ten output sheets.

The value 0 defines that the single NS split will be calculated automatically according to
the total number of input sheets.

Forbid splitting records/groups If checked, previously defined records or groups will not
be split between output sheets. As a result, which input sheets appear on an output sheet
will be defined, in part, by the end of a record or group. The groups are tied down so
that they are not split.

This option is not available if By group or By group with limit are selected for Split type.

For example, if you have multiple pages per record in the transactional type of job, it is
difficult to predict how many pages exactly will be generated for one person (person =
record). Using this check-box can force all pages for a particular person to stay on one
side of the page, so that when cut, all pages for one record are in one package.

Duplex type Enables you to change the sequence of the input sheets on the reverse side of
the output sheet. The options are:

Simplex Does not change the input sheet sequence.

Duplex X change back page Changes the input sheet sequence on the reverse
sides in X direction.

Duplex Y change back page Changes the input sheet sequence on the reverse
sides in Y direction.

Duplex X change front page Changes the input sheet sequence on the front
sides in X direction.

Duplex Y change front page Changes the input sheet sequence on the front
sides in Y direction.

See an examples for each of the options in the How to Set NS Splitting section.

Split type Selects how sheets will be split into NS split packages. The options are:

Simple Makes a single NS split package according to the number of input sheets
set in the Split offset setting.

967
8 Impositioning Modules

Any groups of sheets created before this module (e.g. by the Repeated by option
for the Pages family in Layout) will be regrouped to form one group per split.

By count Splits according to the number of input sheets set in the Sheet count
field.

This is different from Simple because it is repetitive, e.g. if 7 is the Sheet count
then a NS split package of seven sheets is created and then another seven sheets
will follow etc., until the last input sheet has been positioned.

Any groups of sheets created before this module (e.g. by the Repeated by option
for the Pages family in Layout) will be regrouped to form one group per split.

By group Splits according to groups that have been previously defined in the
workflow, i.e. one NS split package will be made up of all of the sheets of one
group.

By group with limit Splits according to any groups that have been previously
defined in the workflow but allows the further definition of a maximum number
of input sheets that can be in a single NS split package.

Enter the limit for sheets in the Sheet count edit-box.

Tip By default a group is a single record unless alternative grouping has been set, e.g.
in Layout or the Sheet Regrouper module.

See also the example section How to Set NS Splitting.

Sheet count If the option By count is selected for Split type, it determines the number of
input sheets after which the split will be made.

If the option By group with limit is selected for Split type, it determines the maximum
number of input sheets after which the split will be made.

Regroup by new sheet count If checked, one group will become equal to each split created,
including any split that is forced by the limit set in the Sheet count edit-box.

If unchecked, groups remain as they were defined previous to this module, even though
some groups might be split by the Sheet count limit.

This option is only available if By group with limit is selected for Split type.

Propagate params to production If checked, the following options (of the Sheet NS Splitter)
will be displayed in the Workflow Parameters window-pane in Production, where you can
also set them:

Count X

Offset X

Count Y

Offset Y

Split offset Only displays if Split type has been set to Simple in this module.

Sheet count Only displays if Split type has been set to By count or By group
with limit in this module.

968
 8.21 Sheet Padder Module

Example The layout design creates seven sheets and we set Count X = 2, Count Y =
2. Those input sheets get organized in such a way that after splitting the output sheets
we only need to put the four stacks on top of each other to maintain the intended page
order.

1 3 2 4

5 7 6

Compare modules Sheet NS Splitter and Simple N-Upper modules (an example for Simplex
printing):

Sheet NS Splitter Simple N-Upper

1 4 1 2
2 5 3 4
3 6 5 6

See more examples in How to Set NS Splitting.

Note You must specify the output sheet size (size of the medium) and the type of printer
that will be used, in the Output module.

Inspire Designer always uses the upper left corner as the 0/0 reference point (origin).

8.21 Sheet Padder Module

The Sheet Padder adds sheets in order to even up the sheet count between differing records.

For cases where variable-page selection creates a different number of sheets for each record,
and yet it is still required that each record produces a similar number of sheets in order to fill
the medium on which it will be printed.

969
8 Impositioning Modules

Example If duplex is required and the last sheet of a record is an odd number, the Sheet
Padder can add an extra sheet to the end of the document so that the new document
(i.e. the next record) begins on the front of the next page.

The top connection (input A) is the one where the Layout with the main design should be
connected. The bottom connection (input B) is for the input of the sheets for padding, sheets
from a blank Layout design would be sufficient but any design can be used, e.g. an advertise-
ment.

Options Description

Pad to Sets the multiple to which the sheets for each record will be padded to.

Example If 4 is entered: Then if Layout creates 1 sheet for a record then this option
will add 3 sheets so that 4 sheets belong to that record.

And if Layout creates 7 sheets, then this option will add 1 sheet so that 8 sheets exist.
But if Layout creates 12 sheets then it will not add any sheets because 12 is a multiple
of 4.

Note This module does not affect the PagesPerRecord system variable which can be
used to print a page count (e.g. to return the value 2 in Page 1 of 2), because that count
is calculated by the Layout module connected to input A.

8.22 Sheet Regrouper Module

The Sheet Regrouper module regroups sheets according to various criteria such as group count,
sheet count or sheet names options. It is also possible to create a single group from all of the
sheets.

By default, a group is identical with a record. This module enables users to redefine groups so
that the group composition does not correspond to records but reflects some other parameters.
The newly defined groups can then be used for further operations (e.g. sorting, filtering etc.)
in other Impositioning modules.

970
 8.22 Sheet Regrouper Module

Options Description
Select from one of the regrouping methods using the radio buttons:

By group count

By sheet count

Single group

By sheet name change

By sheet name condition

The options described here apply to the bottom part of the Sheet Regrouper dialog, which is
the same for all Sheet Regrouper types which can be selected at the top of the dialog. For de-
scriptions of the individual regrouping methods follow the above links to the sections further
below.

Change group beginning If checked, the group beginnings and ends are set according to
the newly established groups. You can see this information in the SheetInfo window-pane
in Proof.

Auto insert white space If checked, a space will be inserted before the text entered in the
Append text to sheet name field if the sheet name has been set and if that sheet name
does not have a space at its end. This enables printers to correctly process commands
which can be inserted as text into the Append text to sheet name field.

First Page of the Group

Set sheet name When checked, you can change the selected sheet name of the first
page in the group.

971
8 Impositioning Modules

Example Select the sheet name's index number (2) in the combo-box and
write "STITCHHERE" into the field below. Then the Sheet Name 2 of the first
page in each group will have the value "STITCHHERE". You can see this inform-
ation in the SheetInfo window-pane in Proof. See the screenshot below.

Append text to sheet name When checked, you can append some text to the selected
sheet name of the first page in the group.

Last Page of the Group

Set sheet name When checked, you can change the selected sheet name of the last
page of a group.

Append text to sheet name When checked, you can append a text to the selected
sheet name of the last page of a group.

8.22.1 By Group Count

When the By group count option is checked, Sheet Regrouper creates new groups from the
selected number of groups (the number is entered in the Split count field).

Example A new group of sheets is created from every four groups:

The other options are common for all of the Sheet Regrouper types. For their description, see
the Options section above.

8.22.2 By Sheet Count

When the By sheet count option is checked, Sheet Regrouper creates new groups from the
selected number of sheets (the number is entered in the Split count field).

972
 8.22 Sheet Regrouper Module

Example A new group of sheets is created from every four sheets:

Tip The same result can also be achieved by using the Sheet NS Splitter module, where
a new group is created from a package for N/S splitting.

Check the Keep groups together option if you want sheets to be split by sheet count without
splitting records. To avoid splitting records, the number of sheets in the group can be lower
than the value set in the Split count field. When a complete record does not fit into a group
it is placed into the following group.

Example If you set Split count to 7, the records will be grouped as follows:

The other options are common for all of the Sheet Regrouper types. For their description, see
the Options section above.

8.22.3 Single Group

When the Single group option is checked, Sheet Regrouper creates a new group from all the
sheets. No further specifications are necessary.

The other options are common for all of the Sheet Regrouper types. For their description, see
the Options section above.

8.22.4 By Sheet Name Change

When the By sheet name change option is checked, Sheet Regrouper creates new groups
whenever the sheet name changes. The decisive sheet name is selected in the Sheet name
index field and the Split count field specifies the number of changes.

973
8 Impositioning Modules

Example

According to the settings in the screenshot, a new group gets created whenever sheet
name 3 changes twice.

Example The Sheet Regrouper with this setting can be used for creating groupings for
postal sorting requirements.

Send the data to the Sheet Regrouper, sorted according to the ZIP code, i.e. the records
with the same ZIP code follow, one after another, and with every new ZIP code coming
to the Sheet Regrouper a new group is created. If you were then to place the Sheet Filter
module after the Sheet Regrouper module, then sheets can be filtered according to each
ZIP group size.

The other options are common for all of the Sheet Regrouper types. For their description, see
the Options section above.

8.22.5 By Sheet Name Condition

When the By sheet name condition option is checked, Sheet Regrouper creates new groups
whenever the search term entered in the Name field is found. Following conditions can be
selected for matching with the search term:

Equal to

Begins with

Contains

The decisive sheet name is selected in the Sheet name index field.

Example

A new group gets created whenever Sheet name 3 contains the word BEGIN. The Invert
checkbox negates the condition, i.e. a new group will be created whenever Sheet name
3 does not contain the word "BEGIN".

974
 8.23 Sheet Sorter Module

The other options are common for all of the Sheet Regrouper types. For their description, see
the Options section above.

Note When two Layout modules are merged together by, for example, the Sheet Duplexer
module, then each Layout module delivers its own group start. You have to consider this in
your job design.

8.23 Sheet Sorter Module

See also:
How to Print Pages in Reversed Order
Processing in Inspire Designer

Sheet sorter can be used in two ways:

1. To sort the sheets within each group of sheets.

2. To sort groups of sheets.

This is done by sorting one of the sheet names that has been assigned to the pages in the
Layout module.

975
8 Impositioning Modules

Options Description
Select from:

Sort sheets in groups Determines that the sheets within each single group will be
sorted into the order defined by the other options on this module.

Sort groups Determines that the groups of sheets will be sorted into the order defined
by the other options on this module.

For both of the above selections you should further define the following attributes:

Sheet name index Identifies which sheet names will be used to perform the sorting.

It is recommended to choose where to assign sheet names according to the type of sorting
that you want to perform, i.e.:

If you have selected Sort sheets in groups, then it is better to use a sheet name
that has been assigned to each of the individual pages in Layout. This is because,
when one group equals one record (the default formation for groups of sheets),
then sheet names assigned to the pages family are the same for all of the sheets
in the group.

If you have selected Sort groups , only the first sheet of each group is checked for
sheet names, so if you know which page will create the first sheet in each group
then a sheet name from that individual page can be used.

However, it is better to use a sheet name that has been assigned to the Pages
family in Layout. This is because, when one group equals one record (the default
formation for groups), then having a sheet name that is different for each individual
page creates sheets with different sheet names within each group. This is not
useful to the sorting of groups.

Descending If checked, the order of sheets will be the reverse order of the sorting criteria,
e.g. Z to A.

Memory usage Selects what will be stored within Inspire Designer while it is processing the
workflow. The options are:

On disk The sheet names will be read during processing and sorted, one by one,
without using any application memory.

This is recommended if a very large amount of sheets are being created and there
would be insufficient processing memory on the computer being used.

Indexed in memory Determines that an index of the data will be loaded to the
application memory when the workflow is processed.

This provides faster processing providing that the amount of sheets being created
is not very large. Although efficiency with larger quantities is better than that with
Fully in memory.

Fully in memory Determines that all of the sheet names will be loaded to the
application memory when the workflow is processed.

This provides the fastest, most efficient processing providing that the amount of
sheets being created is not large.

976
 8.23 Sheet Sorter Module

Binary compare If checked, sheet name values (strings) are compared lexicographically by
the Unicode values of their characters.

The result is similar to selecting Identical for the option Strength except it does not recog-
nize any particular linguistic rules. However, for numbers and English text it works well
and is much faster.

Locale Specifies the language that will be used for applying sorting rules.

Strength Selects the level to which sorting should take place. The options are:

Primary Only considers the differences between all base characters, e.g. sorts in
alphabetical order.

This is the fastest sorting method.

Secondary Diacritics are also considered.

Other differences may also be considered, depending on the locale used.

Tertiary Upper and lower-case differences are also considered.

Quaternary Punctuation differences are also considered.

Identical Unicode code point values of the NFD form of each string are also con-
sidered.

Code point value differences between two strings are rare, but are found in some
languages, e.g. Hebrew.

This is the slowest sorting method.

French collation Uses the French preferred sorting of characters with diacritics.

Case level Casing of characters in the common fields is considered for matching.

This is an alternative to selecting Tertiary for Strength, that could be used if Primary is
selected there and no consideration for diacritics is needed.

Can also be used for Japanese to recognize the difference between small and large Kana.

Normalization mode If checked, differences in Unicode strings are standardized.

Standard characters will be recognized if they are described slightly differently in the Uni-
code.

Example The two described characters ' and e when they appear together as 'e
will be recognized and sorted as .

977
8 Impositioning Modules

8.24 Sheet Transformer Module

See also:
How to Apply Transformations
Sheet Transformer Module Command
Line Parameters

The Sheet Transformer module modifies output. It has parameters that: rotate pages, change
the scaling of either axis (independently) and set both horizontal and vertical offsets. If a sheet
is scaled or rotated in the Sheet Transformer, the Output module needs to be set accordingly.

See also the description of the Booklet Maker module where some of the transformations de-
scribed here are also used.

Options Description

Scale X / Scale Y Changes the size of the input sheet on the X/Y axis. If you want to keep
the same ratio, set both Scale X and Scale Y to the same number.

Example If the value of Scale X is set to 0.50, it means that the sheet width will
be passed to the next module as 50% of its original width.

If negative values are entered, the sheet is flipped. See an example in the How to Apply
Transformations chapter.

Rotate Rotates the object by the value entered. The units are degrees. The rotation point is
the upper left corner of the sheet.

Positive values mean clockwise rotation, negative values will result in counter-clockwise
rotation.

978
 8.24 Sheet Transformer Module

If you use rotation, you must set the offset correctly, so that your sheet is printed on the
medium.

Offset X / Offset Y Moves the sheet on the X/Y axis.

Positive values mean movement to the right (on the X axis) or down (on the Y axis). Neg-
ative values will result in moving the sheet to the left or up. Measurement units can be
changed by clicking on the unit symbol.

Condition

Always Applies the transformations to every sheet.

Sheet name Applies the transformations only to pages of the layout design that
have been assigned a particular sheet name.

See the separate Sheet Names section for how to assign sheet names in Layout.

You must further specify the following options:

Sheet name index Enter here the index number of the sheet name that will be
used to identify which page to transform.

Name Here you must further specify that the value returned by the sheet name
must comply with one of the following conditions in order to be transformed:

Contains The value returned by the sheet name must contain the text:

Further enter that text to the edit-box to the right.

Equal to The value returned by the sheet name must completely match
the text:

Further enter that text to the edit-box to the right.

Begins with The value returned by the sheet name must begin with the
text characters:

Further enter those text characters to the edit-box to the right.

Invert Indicates that everything but the specified sheet(s) will be transformed.

Propagate params to production If checked, the following options will be displayed in the
Workflow Parameters window-pane in the Production environment, where they can be
set:

Scale X and Scale Y

Rotation

Offset X and Offset Y

979
8 Impositioning Modules

8.25 Simple N-Upper Module

See also:
Simple N-Upper Module Command Line
Parameters

The Simple N-Upper module is used to set up a document to print multiple pages per sheet
with definable offsets and counts in either direction.

Note Inspire Designer always uses the upper left corner as the 0/0 reference point.

You must specify the sheet size and the type of printer that will be used, in the Output module.

Options Description

Count X Sets the number of pages to be printed across the sheet.

Offset X Sets the space between the X pages being printed across the sheet. This option is
enabled when the number of pages is set to a higher value than one or after clicking on
the Advanced settings icon (which is useful if you want to place just one page on a
sheet along the X axis with an offset).

Count Y Sets the number of pages to be printed down on the sheet.

Offset Y Sets the space between the Y pages being printed down the sheet. This option is
enabled when the number of pages is set to a higher value than one or after clicking on
the Advanced settings icon (which is useful if you want to place just one page on a
sheet along the Y axis with an offset).

980
 8.26 Text in Rect Module

Duplex Type Options are:

Simplex Prints as received, in portrait or landscape.

Duplex X Prints information on the back and in the horizontal direction (i.e. in
landscape).

Duplex Y Prints information on the back and in the vertical direction (i.e. in por-
trait).

Propagate params to production If checked, the following options (of the Simple N-Upper
options) are displayed in the Workflow Parameters window-pane in Production, where
you can set them:

Count X

Offset X

Count Y

Offset Y

8.26 Text in Rect Module

In this section
Scripting Methods in Text in Rect Module
How to Set a Cross-Rectangle Condition
Reading Barcodes
Calculating the Bounding Box

With the Text in Rect module you can modify sheet content and design according to conditions
based on the existing content of rectangles that are drawn upon each sheet. This module also
provides an alternative, graphical interface to the TextInRect impositioning scripting method,
can read barcodes, assign the read values to sheet names or convert spelled numbers into
numbers.

When you open the module it displays, on the right-hand side, a proof view where you can
see how the sheets look like at the moment. With the help of the text capturing rectangles
you can make further changes to the output, according to your needs. Moreover, you do not
need to close the module to check the result of these changes, as the preview of the output
(a regular proof displayed inside this module) is also available here.

The modules toolbar enables you to draw and adjust rectangles, navigate through sheets or
preview the final result. In the left-hand panel you can adjust the position of rectangles and
set conditions.

981
8 Impositioning Modules

Options Description

Rectangles This section lists all drawn rectangles and their hierarchy. With the icons you can
change position and hierarchy of the rectangles.

Create New Adds a new rectangle. You will find it in the top left corner.

Unindent Moves the rectangle one level up.

Indent Makes the rectangle dependent on the rectangle that is right above in the
list.

Move up Moves the rectangle one position up on the same level.

Move down Moves the rectangle one position down on the same level.

Delete Removes the rectangle. If a rectangle, on which some other rectangle depends,
is removed, the subordinate rectangle becomes dependent on the rectangle right
above in the list.

Tip You can copy and paste selected rectangles using the <Ctrl>+<C> or <Ctrl>+<Insert>
and <Ctrl>+<V> or <Shift>+<Insert> keyboard shortcuts.

Position This section sets or modifies the position of each rectangle.

Name Names the rectangle.

Left Sets the rectangles position from the left page margin.

Top Sets the rectangles position from the top page margin.

982
 8.26 Text in Rect Module

Width Sets the width of the rectangle.

Height Sets the height of the rectangle.

Sort glyphs Sorts glyphs so that they are displayed in visual order in the Captured Text
Preview field (see below). The order of glyphs is changed also in the data output of
the module. This feature is useful when reading any natively loaded file where the
order of glyphs in its page description is different to actual visual order.

Text fields with the same rotation are taken as a group and for each group, sorting
is performed separately. This ensures that glyphs from different text fields do not get
mixed up.

Viewing group Determines which viewing groups the rectangle belongs to.

Viewing groups allow similar rectangles to be placed in the same group and that
group can be viewed separately by selecting it from the View group combo-box in
the toolbar. Using these groups can be helpful if there are many rectangles marked
on the sheets.

Condition Specifies a condition for performing the operation set below in the Operation
combo-box. Please note that the condition applies only to objects included within the
rectangle.

Type Selects the condition. The available options are:

None No condition is set. The selected operation will always be applied.

Equal to The condition is met, if the captured text is identical with the text
entered in the Value edit-field.

Smaller than The condition is met, if the captured number is smaller than
the value set in the Value edit-field.

Bigger than The condition is met, if the captured number is larger than the
value set in the Value edit-field.

Begins with The condition is met, if the first character (or characters) of the
captured text is identical with that entered in the Value edit-field.

Contains The condition is met, if the captured text contains the character
(or characters) entered in the Value edit-field.

Ends with The condition is met, if the last character (or characters) of the
captured text is identical with that entered in the Value edit-field.

Script Allows any condition to be scripted.

An area for script entry appears when this option is selected. It has the same
features as the Script Editor dialog.

See the list of available scripting methods in the Scripting Methods in Text in
Rect Module section below.

983
8 Impositioning Modules

Example Here we set a different sheet name to the data read inside
the rectangle, depending on the content of that data:

if(Input=="T+N+G-G.M.C")
SheetName[6]="Contains Prize"; // if the text read by the
rectangle is "T+N+G-G.M.C" then sheet name 6 will be "Con
tains Prize"
else
SheetName[6]="No Prize"; // otherwise sheet name 6 will
be "No Prize"

Value Sets the value that will be a part of the condition.

Negate Reverts the condition. For example, if Type is set to Equal to and Value to
"London", the condition will be met for all text strings other than "London".

Function Specifies the operation that will be performed.

Operation The available options are:

None No operation is performed.

Set as sheetname Sets the captured text as the sheetname whose index is
selected in the Sheet name index option.

Tip See the example how to use the extracted data from the sheet name to
create a barcode using Statistic Data module.

Prefix to sheetname The captured text is prefixed to the sheetname whose

index is selected in the Sheet name index option.

Append to sheetname The captured text is appended to the end of the

sheetname whose index is selected in the Sheet name index option.

Set group begin Sets the SheetInfo GroupBegin value to true, i.e. the sheet
is set as the first sheet of a new group.

Hide text All text within the rectangle is hidden.

Hide images All images within the rectangle are hidden.

Hide shapes All shapes within the rectangle are hidden.

Hide all All objects within the rectangle are hidden.

Move text The text within the rectangle is moved to the position specified
in the Move X and Move Y fields that become available, when this option
is selected.

Move all All objects within the rectangle are moved to the position specified
in the Move X and Move Y fields that become available, when this option
is selected.

Add clipping path Clips the area outside the rectangle boundaries.

984
 8.26 Text in Rect Module

Remove clipping paths Objects within the rectangle are displayed unclipped.

Read barcode Reads the barcode within the rectangle.

See the Reading Barcodes section for details.

Bounding box calculator Returns the coordinates of upper left and lower
right corner of the bounding box comprising the filled space within the rect-
angle.

The coordinates are assigned to the sheet name whose index is selected in
the Sheet name index option. See a brief example below.

Sheet name index Specifies the index number of the sheet name that will be set or
edited. The sheet name indexing starts from 1.

Available when one of the following options is set: Set as sheetname, Prefix to
sheetname, Append to sheetname or Bounding box calculator. See the Sheet Names
section for information on sheet names and their indexes.

Any single sheet name should only be used in one modification. If the same index
number is chosen to be modified for two or more rectangles then a warning icon
will show next to this combo-box.

Move X, Move Y Specifies the distances on both axes by which the text or object will
be moved. The edit-fields become available when the Move text or Move all options
are selected in the Operation combo-box.

Captured Text Preview Displays the text currently captured by the selected rectangle.

Toolbar The module toolbar offers tools for drawing and adjusting rectangles, navigating
through sheets or checking the final result in proof.

Rectangles Tool If selected, you can create new rectangles or change the size of
rectangles with mouse cursor.

Move Rectangles Tool If selected, you can create new rectangles, move them or
adjust their size with mouse cursor. If you want to create a rectangle within rectangle,
switch to the Rectangles Tool.

Zoom Tool If selected, the mouse pointer becomes a zooming tool.

Navigation Options See the Page Toolbar section.

Zoom In / Zoom Out Increases or decreases the magnification of the proofed

pages.

Fit to Page Scales the page so that the whole page is visible in the panel.

Fit to Page Width Zooms the page so it fits the width of the panel.

View Group Selects which rectangles are shown according to their

viewing group.

985
8 Impositioning Modules

Rectangles are assigned to groups with option Viewing group in the Position section
of this module.

Proof Results After clicking on this icon the job is proofed, which enables you to
check the effects of the conditions set in this module.

The proof is displayed together with the Sheet Info window-pane.

8.26.1 Scripting Methods in Text in Rect

Module
The following methods are available in the Text in Rect module:

getInput() : String / Input : String Returns the content of the rectangle for which the
condition is created.

getTextInRect(String nameOfRect) : String / TextInRect[nameOfRect] : String Returns

the content of the rectangle specified as the parameter, e.g. Rect1.

getSheetCount() : Int / SheetCount : Int Returns the number of sheets coming to Text in
Rect module.

getCurrentSheetIndex() : Int / CurrentSheetIndex : Int Returns the sheet index (beginning

from 0) for the current sheet.

setGroupBegin(Bool aP1) : Void / GroupBegin Sets the current sheet as the first sheet of
a new group.

getGroupBegin() : Bool / GroupBegin : Bool Returns true if the sheet is the first sheet in
a group.

getGroupBegin(Int sheetIndex) : Bool / GroupBegin[Int sheetIndex] : Bool Returns

true if the sheet with the sheet index specified as the parameter is the first sheet in a
group.

setSheetName(Int sheetName, String aP2) : Void / SheetName[Int sheetName] :

String For the current sheet it sets the sheet name specified as the first parameter to
the specified string value.

getSheetName(Int sheetName) : String / SheetName[Int sheetName] : String For the

current sheet it returns the sheet name value for the sheet name specified in the parameter.

getSheetName(Int sheetIndex, Int sheetName): String / SheetName[Int sheetIndex,

Int sheetName]: String For the sheet specified by the first parameter it returns the
sheet name value for the sheet name specified in the second parameter.

pauseAfterCurrentSheet(String aString) : Void Pauses the production and writes the

message specified as the parameter to the log.

Note The methods beginning with get are displayed only if the Show getters option is se-
lected in the Workflow Options dialog.

986
 8.26 Text in Rect Module

8.26.2 How to Set a Cross-Rectangle Condition

As mentioned above, conditions apply only to objects within the boundaries of the respective
rectangle. But what if you need to control an object on a distant part of the page but drawing
a large rectangle encompassing both the controlling text and the controlled object is out of
question? In this case it will be necessary to draw two rectangles, where one rectangle will be
subordinate to the other.

Example You want to show or hide an image placed at the right bottom corner of the
page. The operation is intended to be controlled by variable text at the top of the page:
the image will be hidden when a certain value occurs.

1. Draw a rectangle over the part of the text that is variable.

2. Draw another rectangle over the object that will be alternately displayed or hidden.

3. In the Rectangles section, subordinate the Image rectangle to the Text rectangle
using the Indent icon.

4. For the Text rectangle set the condition type to Contains and type the value. Leave
the None option in the Operation combo-box.

Tip The Contains option is generally a safer choice for variable text than the
Equal to option. Variable text usually varies in length so other characters can get
inside the rectangle and the condition Equal to is not met.

5. For the Image rectangle, leave the None option in the condition Type combo-box
and set Operation to Hide images.

6. Proof the result by clicking on the Proof Results icon and check that the con-
dition works properly and the image is hidden on the correct pages.

8.26.3 Reading Barcodes

The Text in Rect module can also be used for reading barcode values and saving them into
sheet names. The currently supported barcode types are Code 39, Data Matrix, OMR and PDF
417.

Draw a rectangle over a barcode and select the option Read barcode from the Operation
combo-box. The following options appear in the Modification section:

Sheet name index Determines the index of the sheet name to which the value of the barcode
will be assigned.

Raster DPI For the purpose of barcode reading, the area defined by the rectangle is trans-
formed into an image. This option sets the resolution of that image.

987
8 Impositioning Modules

Minimum value is 72, maximum is 600.

Rotation Selects the rotation of the barcode on the page. Any means that the application
tries to detect the rotation automatically.

Barcode type Selects the type of the barcode.

Select from the supported barcode types: Code 39, Data Matrix, OMR and PDF 417. Detect
all means that the application tries to detect the type of the barcode automatically.

OMR distance Determines the spacing between OMR barcode modules. You can set the
value manually in case the automatic spacing detection does not give the correct result.

The value represents the shortest distance between modules.

Detect Automatically detects the values for the Barcode type, Rotation and in case of OMR
barcodes also the OMR distance value.

8.26.4 Calculating the Bounding Box

The Text in Rect module is able to calculate the bounding box of the filled space within the
given rectangle. As the example below shows, this can be used for white space management
in situations when you work with natively read image files.

Example You read natively a PDF file and you need to find out the white space available
for messages on each of the pages.

1. Connect the Text in Rect module after the module that reads the PDF file.

2. Draw a rectangle over the variable area of the document, e.g. a table of transac-
tions in a bank statement. For each page, the module will calculate the bounding
box of the filled space and assign its coordinates to the sheet name whose index
you have entered.

3. Use the Statistic Data module to make the values of the sheet name available as
data in the subsequent Layout module.

4. In the Layout module at the position 0,0 of the message area draw a scripted
area. For the scripted area use the method removeFromWhiteSpace (String

988
 8.26 Text in Rect Module

aP1) and as the parameter use the sheet name in which the bounding box co-
ordinates are stored.

As a result, the scripted area takes over the size of the bounding box and in this way re-
duces the area of the white space available for messages.

989
9 Output Modules

9.1 Output Modules Overview

9.2 Advanced Data Output Module
9.3 Data Output Module
9.4 Job Reporter Module
9.5 Output Module
9.6 Data Center Output Module
9.7 Sheet Statistic Module
9.8 Statistic Data Module
9 Output Modules

9.1 Output Modules Overview

Output Modules define parameters for the formats in which the workflow design will be created
when the WFD file is processed.

Advanced Data Output Module Creates structured text or XML files based upon
selected data that has been manipulated by the workflow when it was processed.

See the section Advanced Data Output Module.

Data Center Output Module Sends data, that has been manipulated by a
workflow, to a data center.

See the section Data Center Output Module.

Data Output Module Sends data, that has been manipulated by a workflow, to
data files or data center.

See the section Data Output Module.

Job Reporter Module Creates simple data files that log the events of the job, as
the workflow was processed, based on records that have been read from data files.

See the section Job Reporter Module.

Output Module Defines media selection and other parameters for the printing
device via which the workflow will be processed.

See the section Output Module.

Sheet Statistics Module Creates simple data files of statistics about which sheets
were produced when the workflow was processed.

992
 9.2 Advanced Data Output Module

See the section Sheet Statistics Module.

Statistic Data Module Produces data variables based on additional data that is
created by the Layout module (sheet name, groups etc.), as opposed to from data that
has been read into the workflow.

See the section Statistic Data Module.

Note Some of the modules described above may only be available with a separate licensing
agreement.

9.2 Advanced Data Output Module

See also:
Advanced Data Output Module
Command Line Parameters

The Advanced Data Output module is suitable for creating customized data outputs. It allows
the definition of the content of created XML or text files. The module has both data and sheet
inputs/outputs, therefore it is possible to connect this module to a sheet output module and
create both the print output and the data output in just one run of your Inspire Designer
workflow. If connected to the Layout module, a data structure needs to be defined using the
Data Output family in the Layout Tree.

The module's panel has two areas, one (on the left hand side) displays the input data structure,
the other (on the right hand side) enables you to create and edit the data output file structure.
Next to the Data Node area, some edit fields appear if a node in the Data Node area has been
selected.

993
9 Output Modules

There are two possible types of output file: text (TXT) or XML, either as a single file or separate
file for each record (see the Add Repeat By option). This selection is made by choosing the
desired option when either clicking on the Create a Node in Root or Create a Node
icon.

Text File Options

A new text file is created by selecting the Create Text File option. Then it is possible to
define the file's properties in the edit fields on right side of the module panel.

The following options are available:

File encoding Determines the codec that will be used for the text in the file.

See the separate section on Text Encoding.

File type Displays the chosen file type (text or XML). It is not editable.

Open type Determines how the output file will be opened for writing. The output can be
written to an existing file or a newly created file from its beginning by selecting the option
Truncate or create or can be written from the end of an existing file, if the option Append
is selected.

994
 9.2 Advanced Data Output Module

Output file Defines the path to where the file will be created and names the file.

Enter the path or use the Browse icon to find the directory. If you have selected Append
for Open type then select the file, that the data will be appended to, here.

However, if you have selected Truncate or create then write the name of the file (with file
extension) to be created at the end of the path. The following substitution characters can
be used in the file name:

%v Returns the value of the variable entered in the Variable output file combo-
box below.

%f Returns whatever value is entered for the File modifier string parameter in
the Workflow Parameters window-pane when the workflow is loaded to Production.

A default value, that will be used in the file name if nothing is changed in Produc-
tion, can be set in the Default %f value option below.

Variable output file Selects a variable that will be used to return part of the file name, if
%v has been used in the path entered for Output file.

Default %f value Sets a default value that will be used to return part of the file name, if
%f has been used in the path entered for Output file.

This default value can also be set in the command line.

Example If the path Z:\Resources\SpoolFiles\%f.txt has been entered for Output

file and AdvancedDataOutput has been entered here, then the resulting file path
will be:

Z:\Resources\SpoolFiles\AdvancedDataOutput.txt

This value of %f would also appear in the Value column for the File modifier string
of the Workflow Parameters window-pane, where it can be changed at the time of
production, e.g.:

995
9 Output Modules

XML File Options

Element name In this combo-box it is possible to edit the name of the root element.

The other options here are as described in the Text File Options section.

File Structure Toolbar

You can define the structure of the data output with the help of the toolbar below the Data
Node area.

Create a Node in Root / Create a Node Add new nodes to the file structure.

Clicking on the icons reveals the following options:

Create Text File Creates a new text file.

Create XML Creates a new XML file.

Add Condition Adds a condition defined by a Boolean variable.

This variable has to exist in the data structure and can be selected in the If combo-
box on the right of the Data Node area. The nodes depending on this condition will
be printed only if the condition is met.

Add Repeat By Adds a node where it is possible to select a variable by which the
file is repeated.

This enables the creation of multiple output files of the same format. To define re-
peated files:

1. Click on the Create a Node in Root icon and select the option Add Re-
peat By .

2. In the Repeat by combo-box on the right-hand side of the module panel

select a suitable variable.

3. Add a node for an output file to be created by right-clicking on the root node
and selecting the option Create Text File or Create XML .

996
 9.2 Advanced Data Output Module

4. In the Variable output file combo-box, select the variable. The values re-
turned by this variable will be used to name of each of the output files.

5. Define the content of all of these files with the help of the Create a Node
icon.

Add If Empty Can be used if you need to display some text or data only if an array
or an optional type variable is empty. Select the desired variable in the If empty
combo-box on the right side of the module panel.

Add Variable Adds a new variable into the output data file structure. There are sev-
eral edit fields and combo-boxes available to specify the variable and its properties:

Add variable Selects the desired variable.

Padding char Enables you to set a character used for padding.

Padding width Sets the number of used padding characters.

Padding alignment Allows you to set the alignment of the padding char-
acter(s). The options available are Left and Right.

Double quotes If checked, all double quotes in the input data file are
doubled.

Conversion Performs field conversions like in the Data Transformer module.

Add Group Adds a new array to the data output file structure. It is possible to change
its name in the Group name edit field on the right side of the module panel.

Add Text Available only for text files. Adds a new text string to the output file. Typ-
ically, it will be used for explaining the data provided by variables.

Add Element Available only for XML files. Adds a new element to the output data
file structure. You can define its properties using the following options:

Add PC data Selects a variable, the content of which will be displayed as

the content of the element.

Element name Allows to edit the name of the element.

Element variable name Allows to rename the element according to the

particular value of the variable.

Conversion Performs field conversions like in the Data Transformer module.

Add Attribute Available only for XML files. Adds an attribute to the selected element.
The attribute properties can be edited using the following options:

Add attribute Selects a variable, the content of which will be displayed as

the content of the attribute.

Attribute name Allows to edit the attribute's name.

997
9 Output Modules

Attribute variable name The variable selected in this combo-box renames

the attribute according to the particular value of the variable.

Conversion Performs field conversions like in the Data Transformer module.

These options are also available in the right-click menu of the relevant nodes.

Delete Node Deletes the selected node and all its sub-nodes.

Move Up Moves the selected node one line up.

Move Down Moves the selected node one line down.

Copy Node Copies the selected node to the clipboard.

Paste Node Inserts the node copied to the clipboard.

Add Using a Wizard The wizard helps you to create the desired output data file structure.
To be able to use the wizard, you have to first create a new text or XML file root node.
The options are different for each and the number of options displayed depends on which
node is selected in the input data structure area.

For the text file type the options available are as follows:

Create First Line Creates the first line of the output data file, that lists all
variables included in the selected array. This option is available only if an array is
selected in the input data structure area.

Create Record Line Creates a new array in the output data file structure. It
copies the selected array to the output structure and adds separating text fields.

Create Variable Copies the selected variable to the output structure.

Create Complete CSV Creates a complete structure mirroring the input CSV
file.

For the XML file type there are two options:

Create XML Structure This option has a different effect depending on which
node in the input data structure is selected. If the root node is selected, the com-
mand copies the complete input data structure. If an array or individual variable is
selected, the command copies the selected array or variable to the output data
structure.

Create XML Structure by XSD Creates a new structure that is defined by a

previously-prepared XSD file (XML data definition). XSD files can be exported from
the XML Data Input module or can be created externally. While loading, you will
have to fill in the XML Schema Parser dialog, where it is required to select an array
that should be the highest-level of the structure (Document root) and how many
dependent levels will be used (Max recursive nesting).

Add Using Wizard Properties By using this function you can define the output file
properties before you run the actual wizard. Click on the icon and the Add by Wizard
Properties window opens. There are several editable fields. Padding char, Padding

998
 9.2 Advanced Data Output Module

width and Padding alignment are the same as for the Add Variable properties area.
The other options are:

Default quotes Enables to set the type of quotes separating the printed variable
values.

Delimiter Enables to select a character for separation of displayed variable values.

Example Sample Data Output File

For information about which customers have activated the option to control their account
via the internet you can create a simple data output file. This file will list all customer IDs
and display the text "Internet" next to every customer's ID where it is applicable.

1. Create a FileText root node and define the file's properties.

2. Define an array for repetition (Records in this example) using the Add Repeat By
function.

3. Specify the actual output.

The line will start with a variable (CustID), then using the function Add Condition
specify a condition a scripted variable created in the Data Transformer module
determining when the text "Internet" is displayed.

The last text item, containing enter, is there to ensure that the next record starts
on a new line.

999
9 Output Modules

4. When the workflow is processed (i.e. run in Production) a file with the following
content is created.

9.3 Data Output Module

See also:
Data Output Module Command Line
Parameters

The Data Output module sends data from the workflow to data files or to a data center. The
newly created data files can then be used as input files in other workflows or for other purposes.

Common usage would be to connect the Data Output module after:

Data Input modules

Data Processing modules

Layout (a data structure needs to be defined using the Data Output family in the Layout
Tree)

Other output modules (e.g. Advanced Data Output or Data Center Output) so that the
workflow can be loaded to Production.

To create a data file using the Data Output module click on the Production icon or press
<F5> to open the Main Production window and, if not already selected, select the Data Output
module being used in the Module combo-box.

1000
 9.3 Data Output Module

Then click on the Start button and the data file will be created according to the specifications
you have made in the module:

Options Description

Output file Defines the output file position and name.

By default, the output file name is defined using the following substitution characters:

%n uses the name of the WFD (without the extension) as the output file name.

%e defines the file extension according to the default extension of the file type
selected in the File type combo-box.

For a list of all available substitution characters see the separate section Substitution
Characters.

Output type Selects how the data from the workflow will be stored:

CSV Creates a Comma-Separated Values (CSV) file.

Example A set of data with a master array and two levels of nested array
could look like this:

"Records","426351","John","Smith","105 Forest
Rd","Arncliffe","NSW 2205"
"Accounts","426351","-9963.4","19702.95"
"Tr","17.8.2001","32206101","ABWDL Town Hall","-3.7"
"Tr","23.8.2001","69881050","Handyway Flight","-47"
"Tr","23.8.2001","87602586","1st International Lottery","-86"

Notice that "Records" is the master array, "Accounts" is nested inside that
and "Tr" (Transactions) is nested inside Accounts. This example shows three
transactions for one account of one client.

Data center Saves the data to a data center.

Data Centers are a feature of the related application Inspire Content Manager and
you must be logged in to Inspire Content Manager to be able to write to any data
center that has been created there. In addition, you must add the Data Center

1001
9 Output Modules

Config module to the workflow and create data center configs before you can use
this output module.

If selecting this option, further select the Data Center config and the Data Center
mode.

Flat Creates a flat data (FLT) file.

This is similar to CSV, however if you have nested arrays of data (e.g. your workflow
combines two data files using a merge module) the nested data is flattened, i.e.
one record is created for every record in any array at lowest level of dependency.

Example Compared to the example for CSV, this example shows three
transactions for one account of one client:

"426351","John","Smith","105 Forest Rd","Arncliffe","NSW

2205","426351","-9963.4","19702.95","17.8.2001","32206101","AB
WDL Town Hall","-3.7"
"426351","John","Smith","105 Forest Rd","Arncliffe","NSW
2205","426351","-9963.4","19702.95","23.8.2001","69881050","Handy
way Flight","-47"
"426351","John","Smith","105 Forest Rd","Arncliffe","NSW
2205","426351","-9963.4","19702.95","23.8.2001","87602586","1st
International Lottery","-86"

Flat (pure) Creates a flat data (FLT) file.

This is the same as Flat, but without any Text qualifiers.

Example Compared to the example for CSV, this example shows three
transactions for one account of one client:

426351,John,Smith,105 Forest Rd,Arncliffe,NSW

2205,426351,-9963.4,19702.95,17.8.2001,32206101,ABWDL Town
Hall,-3.7
426351,John,Smith,105 Forest Rd,Arncliffe,NSW
2205,426351,-9963.4,19702.95,23.8.2001,69881050,Handyway
Flight,-47
426351,John,Smith,105 Forest Rd,Arncliffe,NSW
2205,426351,-9963.4,19702.95,23.8.2001,87602586,1st Internation
al Lottery,-86

Flat XML Creates an XML file with a simplified structure.

1002
 9.3 Data Output Module

Example Compared to the example for CSV, this example shows three
transactions for one account of one client:

<Root>
<Records>
<Id>426351</Id>
<FirstName>John</FirstName>
<Surname>Smith</Surname>
<Address>105 Forest Rd</Address>
<Town>Arncliffe</Town>
<ZIPcode>NSW 2205</ZIPcode>
<Accounts>
<Id>426351</Id>
<Account>87959799</Account>
<Balance>550</Balance>
<Tr>
<Date>17.8.2001</Date>
<Account>32206101</Account>
<Details>ABWDL Town Hall</Details>
<Amount>-3.7</Amount>
</Tr>
<Tr>
<Date>23.8.2001</Date>
<Account>69881050</Account>
<Details>Handyway Flight</Details>
<Amount>-47</Amount>
</Tr>
<Tr>
<Date>23.8.2001</Date>
<Account>87602586</Account>
<Details>1st International Lottery</Details>
<Amount>-86</Amount>
</Tr>

Null If selected, no output will be generated.

This can be useful when no output is required via this module. For example, when
using the Data Center Output module or Advanced Data Output module in a
workflow, no data is passed out of those modules yet it is still required to finish
the workflow with a Data Output module in order to be able to load it to Produc-
tion. In such cases, if Null is not selected, then an empty data file will be created
when the workflow is processed.

TSD Creates a Transactional Data Format (TSD) file.

This is a format specifically for use in Inspire Designer, so that data can be prepro-
cessed in one workflow and then used in another. This can help decrease processing
time when data does not have to be live, allowing for faster printing.

XML Creates an XML file.

1003
9 Output Modules

Example Compared to the example for CSV, this example shows three
transactions for one account of one client:

<Array-Records>
<Records>
<Id>426351</Id>
<FirstName>John</FirstName>
<Surname>Smith</Surname>
<Address>105 Forest Rd</Address>
<Town>Arncliffe</Town>
<ZIPcode>NSW 2205</ZIPcode>
<Array-Accounts>
<Accounts>
<Id>426351</Id>
<Account>87959799</Account>
<TotalDebit>-9963.4</TotalDebit>
<ClosingBalance>10289.55</ClosingBalance>
<Array-Tr>
<Tr>
<Date>17.8.2001</Date>
<Account>32206101</Account>
<Details>ABWDL Town Hall</Details>
<Amount>-3.7</Amount>
</Tr>
<Tr>
<Date>23.8.2001</Date>
<Account>69881050</Account>
<Details>Handyway Flight</Details>
<Amount>-47</Amount>
</Tr>
<Tr>
<Date>23.8.2001</Date>
<Account>87602586</Account>
<Details>1st International Lottery</Details>
<Amount>-86</Amount>
</Tr>

Note If you are using the Data Input module as the input for the master array and there
are field names used in the first record of that data, you can only transfer the field names
to the output if you uncheck Skip first line in the Data Input module. However, some
software (e.g. postal software) cannot handle field names in the first record.

File encoding Selects a codec for the text characters in the data.

See the separate chapter on Text Encoding for details.

Field separator Specifies the character to be used as field separators in the output data file.

Only active if CSV, Flat or Flat (pure) are selected for Output type. More information on
field separators can be found in the Data Input Module section.

1004
 9.4 Job Reporter Module

Text qualifiers Specifies the character to be used as the text qualifier in the output data file.

Only active if CSV or Flat are selected for Output type. Text qualifiers are characters that
indicate that everything between them is a string and should be interpreted by software
programs exactly as it appears.

Data Center config / Data Center mode Select which data center config the data will be
written to and how it will be written.

These options are only available if Data center has been selected for Output type and
are described in detail in the Data Center Output Module section.

Tip Alternatively, the above data output settings can be specified in the Main Production
window when a workflow with a Data Output module is loaded to Production; or after selecting
a Data Output module in the Module combo-box there.

9.4 Job Reporter Module

In this section:
How to Input Page Weights from a CSV
File

The Job Reporter module creates a TXT file that lists some simple information about the job
each time the workflow is processed.

The module is placed in a workflow after the Layout module and is intended to calculate the
weight of any job produced from the workflow. For each group processed, it counts how many
sheets are created from of each individual page and sums the value that has been entered in
the Weight edit-box on the General tab of those pages. These sums are listed in a text report
which also lists the values of the third and fourth sheet names to help group identification.

Alternatively, data about the corresponding weight of pages can be fed into the Job Reporter
module from a data input module. For an example of this, see the section How to Input Page
Weights from a CSV File below.

1005
9 Output Modules

Options Description

Output file Names the TXT file and describes the relative path where it will be created.

The Browse icon opens an explorer to help you search for a suitable directory.

Append existing file If checked, new information for each job is appended to any existing
version of the file. If left unchecked, any existing version of the file will be overwritten for
each job.

Text encoding Selects a codec for the text characters of the file. See the separate section
on Text Encoding.

Example The produced report is presented like this:

As can be seen in this example, the report contains the following rows:

Job Contains the name of the output module via which the workflow was processed,
e.g. Output1.

Doc Contains information on the sheets processed for each of the groups, i.e. the count
of the group; how many sheets from each page are in the group; how much all of
the sheets of the group weigh; sheet name 3 for the group and sheet name 4 for
the group.

Doc:;1;2;2;20;Smith;87959899; can be translated as: The first record (1) contains

two sheets of the first page (2) and two sheets of the second page (2) which weigh
twenty grams (20). Sheet name 3 for the group is Smith and sheet name 4 is
87959899.

TotDocument Shows how many groups were processed in total.

TotAccountStatement Shows how many sheets with the sheet name 1 value of Ac-
countStatement were processed.

TotCont Shows how many sheets with the sheet name 1 value of Cont were processed.

TotWeight Shows the total weight of all of the processed sheets.

Tip The Weight is not counted accurately when spooling a duplex job, because the Job Re-
porter module is placed before Output module in the workflow, so it cannot take into account
the duplex pages.

1006
 9.4 Job Reporter Module

Solution: Use the Imposition Script module, where you can script the Weight count the required
way.

Note Sheet name 1 is set on the Sheet Names tab of individual pages and sheet names 3
and 4 should be set on the Sheet Names tab of the Pages family.

9.4.1 How to Input Page Weights from a CSV

File
In order to overwrite the weight of the pages, that are set in Layout, with weights from a
separate CSV data file:

1. Create a simple CSV file with two columns:

a. The first column should contain the expected values of sheet name 1.

b. The second column should contain the corresponding weights.

2. Use the Data Input module to read the CSV file into the workflow. E.g.:

The screenshot above is of the Properties tab of a Data Input module that is set-up to
read a CSV file containing the columns 'Sheet name 1' and 'Weight'. The values of the
different sheet name 1s and their corresponding weights can be seen listed in the
Preview area.

1007
9 Output Modules

3. Use a Data Transformer module to convert the weight values to a numerical data-type,
e.g. select BC.- toDouble for Field Converter:

4. Connect the Data Transformer module to the input of the Job Reporter module that
is for data, i.e. the lower connector.

9.5 Output Module

9.5.1 Output Module
In this section: See also:
Device Profiles Output Modules Command Line
Parameters
How to Apply Transformations
Proof Profiles

The Output module is placed at the end of a workflow and is used to define specific parameters
for the media, that the workflow will be printed on, and the printing device. It identifies differ-
ences between intended media so that corresponding media can be selected, created or ma-
nipulated by the device that will print a job from the workflow.

It is possible to proof or produce a workflow without an Output module. However, this module
should be configured if:

Pages in the Layout design are of differing dimensions (e.g. landscape and portrait).

If you need to define extra operations to be performed by the printer (e.g. PostScript
PPD).

Several Output modules can be useful, e.g. if you want to quickly verify your design applying
various settings of the HTML or HTML Simple engines, before actually generating the documents.
See the Proof tab description for more information.

1008
 9.5 Output Module

Opening the module reveals the Output module dialog.

9.5.1.1 Output Module Dialog

The available tabs are:

Media Tab

Proof Tab

General Tab

Media Tab
A single medium should be created for each type of media that you want to print the workflow
on.

1009
9 Output Modules

The procedure for defining these media is as follows:

1. Ensure that all of the pages in the workflow design have been assigned a 'sheet name
1'. Sheet name 1 is a combo-box on the Sheet Names tab of a page's properties
panel in Layout. It should only differ when a different medium is required for any par-
ticular page.

2. Click on the Fill from Layout button at the bottom of the panel in order to add a
single medium for each sheet name 1 that has been defined in Layout.

3. Create a device profile to assign specific, printing device related, attributes to each in-
dividual medium.

Options Description

New Creates a new medium in the area above the button.

Remove Deletes any selected medium.

Fill from Layout Reads the properties (Sheet name 1, Width and Height) of the individual
pages from the Layout module and creates one medium for each unique set of values.

The differences between media should first be identified in the Layout module by entering
values in the Sheet name 1 combo-box of the Sheet Names tab of every page, i.e. use
the same sheet name 1 for all pages that should be printed on the same media. It follows
that a unique sheet name 1 will then exist in Layout for each and every required medium.
If this has been done, then clicking on this button is the fastest way to ensure that all of
the necessary media definitions are created.

Example If there were three page sizes in the Layout design (Portrait, Landscape
and Envelope) you could give them suitable sheet name 1's (Portrait, Landscape and
Envelope) and in the Media Tab of the Output module click on the Fill from Layout
button to create the corresponding media. E.g.:

Note Do not use this button if the option Variable sheet name 1 has been checked
in Layout.

This button does not process the workflow, therefore if sheet name 1 is variable for a
particular page then it is impossible to read the values of that variable. It follows that no
medium can then be created.

1010
 9.5 Output Module

Sheet name 1 Selects which existing sheet name 1 corresponds to the medium that is selected
in the area.

The sheet name with index 1 should be used exclusively for the purpose of media selection.
The value returned by sheet name 1 for any single sheet acts as a way to identify which
medium should be used for that sheet. The Output module tries to match the value of
each sheet's sheet name 1 with one of the values entered here.

If the Fill from Layout button has been clicked on, all of the values of sheet name 1 that
have been defined in Layout are available to select from the combo-box menu. However,
by default the correct sheet name 1 is assigned to the correct medium (i.e. one with cor-
responding Width and Height) so there is no need to use this combo-box unless you
specifically want to change or add a medium.

You can add new media with the New button and then add an entirely new sheet name
for each medium using this combo-box, but remember that you must subsequently ensure
that corresponding pages in Layout have been given the exact same values in their own
Sheet name 1 combo-boxes on the Sheet Names tab.

Size Selects the size of the medium. The options are: A3, A4, A5, B5, Letter, Legal, Tabloid,
Compact Disc, Manage and Custom.

With the exception of Manage and Custom, when a selection is made, the corresponding
width and height of the medium are set in the Width and Height edit-boxes below.

The Manage option enables to define custom page sizes (named) in the Page Size dialog
that this option opens. In this dialog you can also modify, delete or change the order of
existing custom page sizes. Newly defined sizes are added to the Size drop-down menu
as options for later use (they are stored in the configuration file but are not shared with
other users).

The Custom option appears after you set your own page size directly in the Width and
Height edit-boxes or when another user opens a WFD file with your own page size pre-
defined in the Manage option. This size is not kept in the Size drop-down menu, however
you can save it via the Manage option: the newly added custom page will take its size
from the current values in the Width and Height edit-boxes.

Note The assumed units for the media sizes are those selected in the Layout Window.

The Portrait and Landscape icons rotate the medium selected in the Size combo-
box so that the value entered in Width becomes the value entered in Height and vice-
versa.

The medium orientation setting / changes according to the relation of values entered
into the Width and Height fields: higher value in the Height field results in the Portrait
orientation, higher Width value results in Landscape .

Width Determines the measurement across the medium.

Measurement units can be changed by clicking on the unit symbol.

Height Determines the measurement from top to bottom of the medium. Also known as
the length of the medium.

Measurement units can be changed by clicking on the unit symbol.

1011
9 Output Modules

Duplex type Selects whether the medium will be printed on only one side or on both sides.
The options are: Simplex, Duplex short edge or Duplex long edge.

Device Profiles This area of the panel is for creating profiles for the devices that may be
used for printing and how those devices should handle the media defined here.

See the Device Profiles section below.

Variable medium size If checked, the size of any of the defined media will be determined
by the value of sheet name 1.

The value returned by sheet name 1 should be formulated to include the required medium
size in brackets (width/height), e.g. A4 (0.210m/0.297m).

The intention behind this is for use with the Imposition Script module. There, the value of
sheet name 1 can be changed according to the size of medium that will be needed for
the imposition that is being scripted. However, a sheet name 1 value (including the size)
can be entered in the other usual ways including using the option Variable sheet name
1 in the Sheet Names tab for individual pages in Layout.

Device Profiles
Each medium created in the Output module can have further parameters. In the Device Profiles
area of the panel you can set parameters relating to the printing device that the workflow will
be printed on.

Options Description

New Opens the Create Device Profile dialog in order to create a new profile:

Type Selects the type of device that a profile will be created for.

The available selections are the device types that are supported by Inspire Designer:

AFP

Creo VPS

HTML Simple

IJPDS

IPDS

1012
 9.5 Output Module

Metacode

MIBF

NexPress VDX

PCL

PDF

PPML

PostScript

VIPP

Name Names the profile.

Clicking on the OK button closes this dialog and, for some types of device, opens another
dialog for setting general attributes that apply to all of the defined media. For other device
types, there are no general settings and so no dialog is shown and only the media settings
appear on the Output module itself. Follow the links above for more details on the attributes
for specific device types.

Edit Opens the dialog for the device profile that is selected in the Profile combo-box so that
its attributes can be adjusted.

Some device types do not have any dialog, in which case the button will be inactive.

Rename Opens a dialog which allows you to enter a new name for the profile selected in
the Profile combo-box.

Remove Deletes the profile that has been selected in the Profile combo-box.

Profile Selects a device profile for viewing and editing.

All created profiles are listed in the combo-box menu and there can be profiles for each
type of device. If media have been defined, the selection of a profile shows other device
related options below this combo-box.

The profile selected here is not necessarily the profile that will be used when the workflow
is loaded to Production. The profile that is actually used is determined by the type of engine
selected in the Engine combo-box in the Main Production window.

Note If there is more than one device profile for any one type of device (e.g. AFP) then
only the one which was created first will be applied and you will receive a warning when
Production is started.

This is valid for all outputs except PostScript, in which case it searches for any profile that
has been defined with the same PPD as in Production.

Any options that are shown below the Profile combo-box are the media settings and are
particular to the type of device. The settings for these options are independent for each medium
that has been defined in this module and so it is possible to have different settings for each
medium.

See the option Type in the Create Device Profile dialog (described above) for links to the sections
where those options are described.

1013
9 Output Modules

Proof Tab
In this tab you can define a Proof profile, that would be forced (used primarily) when proofing
the workflow.

Every time you proof a workflow via given Output module or Layout, the profile selected in
the dialog above will be primarily used and marked in the Profile field of the Proof profile
toolbar as '(Forced)'.

Note You can have many Output modules and define forced profiles for more than one.
Modules without their own forced profile employ primarily the last profile used in Proof.

Options Description

Force Proof profile If checked, the Proof profile defined in this tab will be forced. If you
proof a workflow, it will display with settings defined for the forced Profile selected just
below.

Proof engine Defines the forced Proof profile. Choose from:

Vector

Raster

HTML Simple

HTML

Proof profile Click on the Edit button to change the settings of the selected forced Proof
profile. Depending on the chosen engine, it opens:

Vector Proof Profile Dialog

Raster Engine Configuration

HTML Engine Configuration

HTML Simple Engine Configuration

General Tab

1014
 9.5 Output Module

Options Description

Default engine Designates the engine that will be selected automatically when the workflow
is loaded to Production.

When the workflow is loaded to Production, this option determines which engine will be
selected in the Engine combo-box on the Main Production window. If there is more than
one Output module in the workflow, each of them can have a different engine set here
so that if that module is selected to be the one used for production (via the Use for Pro-
duction option from the Workflow window or the Module combo-box from the Main
Production window) then its intended engine will be automatically selected.

The engine defined in the Output module overrides the engine defined in a JOB file.

See the separate section Main Production window for more details on the Engine combo-
box.

Run by record If checked, the workflow can be processed as each record is read. This results
in the initiation of printing being faster, especially for the IPDS engine.

This option also exists in the Main Production window and must also be set there when
producing the workflow. If it is left unchecked here, in the Output module, you can still
check it in Production and the feature will be employed. However, if the option is not
checked in Production, it is disabled for the whole workflow even if it is checked here.

See the description in the Main Production window for a list of limitations to this option.

9.5.2 AFP Device Profiles

In this section: See also:
AFP Device Profile Dialog Output Module
Device Profiles Area for AFP AFP Engine Configuration
AFP Printer Configuration
Finishing Operations Illustration

Media pages that have been created in the Output module can be further defined for an AFP
printing device. The according device related settings can be made in two places:

1. In the AFP Device Profile dialog, which is opened upon clicking on New and selecting
AFP for Type in the Create Device Profile dialog or on Edit (in case the profile has
already been created) in the Device Profiles area. The settings made in this dialog will
apply to all media defined in Output module they are defined once for the AFP
printing device.

2. In the tabs of the Device Profiles area of the Output module, which are displayed after
you create a device profile of AFP type. The settings made on these tabs will apply to
the medium that has been selected when modifying options in the Device Profiles area,
i.e. different settings can be defined for each medium, where applicable.

1015
9 Output Modules

9.5.2.1 AFP Device Profile Dialog

In the AFP Device Profile dialog the device settings common for all media set in the Output
module can be defined.

Different device related settings for each medium can be set in the Device Profiles Area for
AFP.

This dialog has the following tabs:

General

Indexing

General Tab

Options Description

Advanced finishing control (incl. UP3I) If checked, finishing operations can be further
defined to be different for each media page on the Finishing Operations tab in the Device
Profiles area of the Output panel. Otherwise, one set of defined finishing operations will
be applied to all of the pages.

Additional UP3I (Universal Printer Pre- and Post-processing Interface) finishing operations
are also made available when checking this option.

1016
 9.5 Output Module

Advanced Finishing Control features are relatively new and only newer machines will
support UP3I operations. Please check the capabilities of the device on which jobs using
this output will be printed.

Oc media selection (AIMS) Checking this option will support Advanced Input Media Se-
lection for Prisma.

A tab called Input Media Selection will appear in the Device Profiles area where the attrib-
utes of the input media can be determined.

This option is only relevant for Oc Prisma and has no effect on other AFP devices.

Use fidelity controls Checking this option allows you to further define the Fidelity Control
parameters below.

Fidelity Controls The options here allow for alternative actions to be performed if exceptions
occur.

Toner saver Sets whether color toners should be used sparingly by the printer. The
following options are available:

Device default Allows the settings of the printer itself to determine how
toners will be used.

On Communicates that less toner than required for the colors should be
used and therefore print quality will be reduced.

Off Passes no restriction and does not change print quality at this point.

Not used Does not add any entry into AFP file, unlike the other available
options by which you define explicitly the behavior of the printing device
adding the information to the AFP file.

Color fidelity Sets whether all of a jobs defined colors must be assigned. This is especially
important if highlight colors have been assigned using the AFP Engine Config from
the Production window.

The following options are available:

Require mode Defines that all of the colors defined in Layout must have an
actual equivalent at the printer, otherwise printing will be halted.

Substitute mode Communicates that if a color from Layout has not been
assigned, then the printer should assign another color instead.

Not used Does not add any entry into AFP file, unlike the other available
options by which you define explicitly the behavior of the printing device
adding the information to the AFP file.

Text fidelity Sets whether all of a jobs text definitions must be compatible.

1017
9 Output Modules

The following options are available:

Stop on error Stops printing, if text characters or fonts are not recognized
by the printer.

Ignore errors - Continues printing, if text characters or fonts are not recognized
by the printer, and the printer ignores that text instance.

Not used Does not add any entry into AFP file, unlike the other available
options by which you define explicitly the behavior of the printing device
adding the information to the AFP file.

Media fidelity Sets whether the media type must be as defined. For example, if the
output is defined as duplex but the printer does not cater for two-sided printing.

The following options are available:

Terminate Stops the print job, if media type is not possible.

Continue with defaults Prints the job using whatever media settings are
available.

Not used Does not add any entry into AFP file, unlike the other available
options by which you define explicitly the behavior of the printing device
adding the information to the AFP file.

Finishing fidelity Sets whether notification should be made if the defined finishing
operations are not available functions of the printer.

The following options are available:

Stop on exception and report it Stops printing, when an un-executable op-

eration is requested, and an identifying warning is displayed.

Ignore all exceptions and do not report them Continues printing, when an
un-executable operation is requested, i.e. the print job simply keeps on without
performing that task.

Not used Does not add any entry into AFP file, unlike the other available
options by which you define explicitly the behavior of the printing device
adding the information to the AFP file.

1018
 9.5 Output Module

Indexing Tab

Options Description

Indexing If checked, Tagged Logical Element (TLE) indexing can be defined for the layout
design. It will be applied if the workflow is produced using the AFP engine.

Use the toolbar (see description below) to create index items.

Sheet Name Index Enter in this column the index number of the sheet name that will return
values that will appear as the index.

There are two categories of index:

Group indexing Used for indexes that relate to groups of pages, e.g. pages that
relate to the same record of a data file.

Page indexing Used for indexes that relate to individual pages, e.g. page number
within a record (returned by the PageCounter variable) and page number within
the whole job (returned by the GlobalPageCounter variable).

A new entry will appear in the index for each unique value returned via the sheet name.
Therefore, all matching occurrences will create only one index entry. For example, records
for Andrew Miles and James Miles have the same value for a variable called 'Surname'
(which returns the surnames in each record) and so if this variable is assigned to be an
index (via a sheet name) both records would be indexed together.

Index Name Enter in this column the label that will appear in the AFP file as the name of
the index.

As a result it will become a selectable index title in an AFP viewer. When it is selected
there, the values that have been returned by the sheet name will be listed so that each
corresponding page/group can be selected and viewed.

Default Value Enter in this column a value that will appear as the index if the sheet name
does not return any value.

1019
9 Output Modules

Toolbar

Create Level / Flatten Level Alters the dependency level of the selected index
item by stepping it up or down a level.

Move Up / Move Down Moves the selected index item up or down one position
at a time.

Create New Index Adds a new group index item.

Create New Child Index Adds a sub-group within a group index item.

Create New Page Index Adds a new page index item.

Delete Deletes the selected index item.

Encoding for pages index From the combo-box menu, select one of the pre-defined encod-
ings for the text of the index entries.

Available codecs are: EBCDIC or ASCII.

Alternatively, select Other encoding to activate the Encoding options below to be able
to select and modify another standard codec.

Encoding See a separate Text Encoding section for more details.

Replace unresolved characters with Type here a character that will be used for replacing
characters that cannot be encoded by the selected code page.

Don't write empty items If checked, index items that do not have a value will not be written,
i.e. no index entry will be created if a sheet name returns an empty value.

Note TLE indexing can also be defined on the indexing tab of the AFP Data Stream Configur-
ation Dialog when editing an AFP Engine Configuration profile. However, device profiles here
in the Output are saved as part of the workflow and override any settings that may be defined
in the Production environment, should they conflict.

9.5.2.2 Device Profiles Area for AFP

In Device Profiles area for AFP different device settings for each medium set in the Output
module can be defined.

Each media for which some common settings in the AFP Device Profile dialog have been made
can have also an independent set of attributes defined for itself, different from other media.
These attributes appear on the Output panel on the tabs of the Device Profiles area when that
profile and a media page are selected. Any attributes set for a media page will be saved as a
part of that printer device profile and each time you use that profile those parameters will be
communicated to the printer.

To make different device related settings for each medium, first select one of the Media on
the left and then change the settings for it in the Device Profiles area.

1020
 9.5 Output Module

An AFP device profile has the following tabs:

General

Finishing Operations

Input Media Selection

General Tab

Options Description

Medium settings to apply This option influences which settings of the Device Profiles area
can be altered for the selected medium and helps to configure AFP finishing operations
(advanced finishing operations, if the Advanced finishing control (incl. UP3I) option is
checked in General tab of the AFP Device Profile dialog). The finishing operations are
triggered by usage of the three option values available here and assigned to the media.

1021
9 Output Modules

Knowing the sequence logic of the sheets coming from Layout or impositioning modules
and having the sheets assigned to the media in the Output module you can further set
this option for each of the media to either only print the content and have no effect on
the finishing (None, All except finishing) or to set this option to All and set the desired
finishing operations and their parameters on the Finishing Operation tab.

You can select from three values:

All If selected, settings on all tabs of the Device Profiles area can be altered and
are applied whenever the medium for which this option has been set is printed.
As for finishing operations, if a medium with All set comes in the sequence, the
finishing operations defined for the previous medium with All setting are finished
(performed) and the ones defined for this one are started. See the example below.

None (pass through all options) If selected, none of the options in the Device
Profiles area can be altered. All settings are taken from the previous medium set-
tings. As for finishing operations, if a medium with None set comes in the sequence,
no finishing operations are finished or started. See the example below.

All except finishing If selected, settings on both the General tab and the Input
Media Selection tabs of the Device Profiles area can be altered and are applied
whenever the medium for which this option has been set is printed. The Finishing
Operations tab settings are disabled and no finishing operations are finished or
started just like in the case of None. See the example below.

Example There are 2 pages in Layout which should be stapled together. In Output
you define for them 2 output media. The first medium Page1 is set to All and stapling
is defined, the second medium Page2 is set to None.

1. Layout generated sheet 1 applies to medium Page1. All is set for it, but as
there are no operations to be finished (performed), no previous sheets in the
sequence, the operation is only "started" waiting for another medium with
All to "finish" it so that it can be performed.

2. Layout generated sheet 2 applies to medium Page2. None is set for it, no
finishing operations are finished or started.

3. Layout generated sheet 3 applies to medium Page1. All is set for it and so
the operation set in the previous medium (for which All has been set and the
finishing operation defined, i.e. sheet 1) is performed: a command is inserted
to AFP data stream to staple sheet 1 and 2. Every time media changes to
medium with All option, stapling takes place.

Note Finishing operations can also be defined as a part of the AFP Printer Configuration
profile in the Production environment of Inspire Designer. If you set up finishing operations
there, any finishing operations configured on this tab in the Output module of the WFD
file will be ignored.

The possibilities as to which finishing operations are available in Production environment

and here are the same. More simple to set and recommended to use is the configuration
in AFP Printer Configuration. Basic finishing operations can be selected in the Finishing
Parameter drop-down menu after Traditional has been selected in the Finishing Type
drop-down menu. Advanced finishing operations (UP3I) are the other ones but Traditional
in the Finishing Type, their specific variations are set by the Finishing Parameter.

1022
 9.5 Output Module

Orientation Specifies the orientation of the content that will be printed.

Auto Job orientation is calculated from the paper size defined in Layout.

When this option is selected, the MDDflag is set to 0x00; i.e. this rotation is not
applied to cut-sheet printers, but only to continuous-forms printers.

Portrait The job is sent to the printer as Portrait.

When this option is selected, the MDDflag is set to 0x80, i.e. this rotation is applied
to cut-sheet printers as well as continuous-forms printers.

Landscape The job is sent to the printer as Landscape.

When this option is selected, the MDDflag is set to 0x80, i.e. this rotation is applied
to cut-sheet printers as well as continuous-forms printers.

Note

The MDDflag is a part of the 'Medium Descriptor' structured field available within
the MO:DCA sub-architecture of AFP files.

The options for Orientation only apply if the AUTOROTATE option on the printer
has been disabled. If it is activated, then job orientation is controlled by the rules
described in the following rotation samples.

Input tray Enables you to select the number of the blank media input tray on your printer.

Output tray Enables you to select the number of the printed media output tray on your
printer.

N-up Selects the amount of sheets that should be printed on one side of the media. The
options are:

Not used Does not request any N-up from the printing device.

2-up Requests 2-up to be performed by the printing device. Two sheets will be
re-sized to fit side-by-side on the media.

N-up selected here will be performed by the AFP printing device as opposed to any software
N-up that has been determined elsewhere in the workflow. Therefore, any other N-up
defined in the workflow will be multiplied by this one.

Example A software 4-up defined using the Simple N-Upper module (Count X set
as 2 and Count Y set as 2) becomes 8-up (with a count of 4 in the X plane) if 2-up
is selected here.

Jog (offset stack) If checked, the set of printed sheets for each Output page is slightly moved
in the output tray, so that you can easily distinguish them. To be able to use this feature,
you need to have two or more output pages defined and on each of them this option
needs to be enabled.

1023
9 Output Modules

Tip More advanced media definition logic has to be implemented to an output module
if you use Jog together with finishing operations because these features are sensitive to
media definition change.

See the separate section How to Use the Jog Option for more details.

Apply settings to each group If checked, then all settings will be applied once to each
grouping.

Groups are defined by records of a data input (or by the Sheet Regrouper module) and,
with this option, they will be used to identify groups of pages upon which any attributes
set here are applied. This avoids the need for setting up some logic involving sheet names
in order to identify at which point the setting should be applied.

If left unchecked then the settings will be applied on sheet name change only.

Device default monochrome appearance If checked, the selected medium will be printed
in black and white.

Finishing Operations Tab

On this tab finishing operations can be set, but their usage is triggered by the option Medium
settings to apply on the General tab.

Each media page can have its own properties if Advanced finishing control has been checked
on the AFP Device Profile dialog. However, if that option is left unchecked, settings from this
tab are adopted by all media pages. In any case, the printer must support the features that you
select, if not, then the command may be ignored or the job may be stopped depending on
you selection for Finishing fidelity. If possible, it is best to check with your intended printing
device before assigning the finishing operation, to be sure that it supports it.

To add a new finishing operation, click on the Create New icon.

Tip Set the UP3I finishing operations in the correct order according to the printer setup. The
printer will not work properly otherwise.

To delete an existing one, select its row and click on the Delete icon.

1024
 9.5 Output Module

Options Description

Finishing Operation In this cell, select a finishing operation from the drop-down menu.
Some of the basic finishing operations are described in the separate section Finishing Op-
erations Illustration.

These are standardized AFP physical operations that are not performed by Inspire Designer
and further details of these finishing operations should be available in documentation
either from the printing device or the printer extension that is used to perform them.

The drop-down menu contains a list of possible operations. If Advanced finishing control
has been checked (in the AFP Device Profile dialog), then there are many more UP3I finishing
controls available. Those options denoted (UP3I) are advanced options that only newer
printers will support.

Reference Corner/Edge In this cell, select a reference position (corner/edge) from where
the position, in which these operations should be performed, will be measured.

Each operation offers its own relevant options, but selecting Device default defers the
decision to whether and how an operation will be executed to the settings of the printing
device.

Axis Offset (mm) In this cell, enter the position of the operation as an offset from the position
selected in Reference Corner/Edge.

-1 is default and means that the position is not set.

Parameters The edit field in the cell enables you to enter additional parameters if required;
e. g. the distance between staples for edge stitch etc.

Input Media Selection Tab

This tab and the parameters determined by it are specific to Advanced Input Media Support
(AIMS) for Oc Prisma printing devices only. It will be visible, only if the option Oc media
selection has been checked on the AFP Device Profile dialog. The parameters communicate
details about which printing media the job will be printed on, so that it may be selected auto-
matically from designated trays.

Each media page defined in the left part of the Output module has independent settings on
this tab and AIMS parameters.

1025
9 Output Modules

Options Description

Media name Type here the name of the media to be used for this page.

This is not compulsory as you may use any of the parameters on this tab as tray selection
criteria.

Color name This parameter is used for selecting the printing media when different colors of
paper are to be sent to a printer which has each tray assigned a different color.

Select the name of the input media color from the list of colors in the combo-box menu
or select:

Not used Sets that the color of the input media is not a parameter for selecting
the printing media.

No color Sets that the color is used for selecting the printing media and the name
of the color is "No color".

Custom Sets that the color is used for selecting the printing media and activates
the edit-box next to it, to allow the entry of any unlisted name. For clarity reasons
it is recommended not to use any of the color names that exist in the drop-down
menu.

If Custom or a certain color is selected in the Color name combo-box, there are two more
drop-down menus enabled below it.

The options available in the first one are:

Default Sets that the first tray to which the color set in the Color name is assigned
gets selected.

Clear Sets that the tray to which the color set in the Color name and the para-
meter Clear are assigned gets selected. Clear is the parameter of the printer, which
specifies the color further.

The options available in the second one are:

Default Sets that the first tray to which the color set in the Color name is assigned
gets selected.

Light/Dark Sets that the tray to which the color set in the Color name and the
parameter Light/Dark are assigned gets selected. Both Light and Dark are the
parameters of the printer, which specify the color further.

Type Select the type of the input media from the list of media types in the combo-box menu
or select:

Not used Sets that the input media type is not a parameter.

Custom Activates the edit-box next to it, to allow the entry of any unlisted type
name.

Example Page 3 designed in Layout and defined among the Media of the Output
module is an envelope, so we select Envelope in the Type combo-box for it and the
assigned envelope tray will be called on to feed to the printer.

1026
 9.5 Output Module

Weight If checked, the weight of the printing media will be used as a parameter.

You can further enter the corresponding weight of the media into the edit-box next to it.

Dimensions Select which set of dimensions of the media will should be used from the combo-
box menu:

Not used Sets that dimensions are not a parameter.

From media size Determines that the dimensions that are set in Size field of the
Output panel will be used for the media selection.

Set Activates the edit-boxes next to it, to allow the entry of other dimensions to
be used as a media selection parameter.

Pre-drilled holes If checked, the number of pre-drilled holes will be used as a parameter for
media selection for this page.

Then you can further enter the number of holes into the edit-box next to it.

Media sets If checked then Media sets determine which media tray of the printer will be
used and how often.

When checked, further enter the Set count and Ordered-set piece in the respective
edit-boxes.

Example A media set always consists of two pink forms of A4 paper and a white
form and so enter 2 in Set count for the pink and the Ordered set piece would be
1 for the white. The trays should then be set up correspondingly.

Note Media Set count should only be set when the other attributes on this tab apply
to all sheets being used, e.g. a media set of 1 white and 2 pink forms (3 pieces) should
not have the Color name defined as it is not the same for all sheets; Media name and
Dimensions, however, could also be defined.

9.5.3 HTML Device Profiles

The HTML output can be further defined with metadata. Metadata is additional information
on the HTML document typically used to specify page description, keywords, author of the
document or the last modification (in Inspire Email Gateway metadata contains the recipient's
email address which is used for validation). Metadata can be further used by browsers, search
engines (using keywords) or other web services.

1027
9 Output Modules

Metadata is set in the HTML Profile dialog displayed after selecting the HTML type in the Create
Device Profile.

Options Description

Name Enter the name of the metadata. It can be anything of your choice but it typically will
be the document author, copyright, description, distribution, generator or keywords.

Content Enter the metadata content (value).

Add New Metadata Adds a new metadata entry to the Metadata table.

Delete Current Metadata Removes the selected metadata entry from the Metadata
table.

In the final output, the metadata looks like this:

<head>
<meta name="To" content="[email protected]" />
<meta name="Author" content="Simona Kazinski" />
<meta name="Keywords" content="Transpromo" />
</head>

Tip To insert variable data into metadata, use Substitution Characters. Hover your mouse
pointer over the metadata table edit-fields to see the tool-tip with the substitution characters
list.

Note If the HTML output is split, metadata is present in each HTML file.

1028
 9.5 Output Module

9.5.4 HTML Simple Device Profiles

See also:
Output Module
HTML Simple Engine Configuration
How to Mark Script for HTML Simple

Each media page that has been created in the Output module can be further defined with extra
HTML elements when printing with the HTML Simple engine in the Production environment
of Inspire Designer. This is done via the Device Profiles area in the Output module.

To assign your pages to HTML Simple device type, you should first create a new profile by
clicking on the New button.

To edit an existing profile, first select one of the Media on the left and then change the settings
for it in the Device Profiles area. You can either:

Enter/edit the HTML code directly in the edit fields described below

1029
9 Output Modules

or

Click on the Edit button, that opens the HTML Simple Profile dialog.

The functionality of the Metadata table is described in the HTML Device Profiles section.

Each profile has an independent set of attributes for each of the media pages. These attributes
appear on the Output panel when the device profile and a media page are selected. Any attrib-
utes set for a media page will be saved as part of that device profile and each time you use
that profile those parameters will be communicated to the printer.

Options Description

HTML Header The options here are elements that make up the <head> element of the
HTML definition.

<title> </title> This edit-box is the title element.

Enter here text that will become the title for the HTML version, of any sheet that will
be printed using the selected media page.

The default shortcut %h02 declares that the title will be returned by Sheet Name
2. If this is used, ensure that this sheet name (i.e. 2) is assigned to all of the individual
pages that will be printed. See the separate Sheet Names section for details on how
to assign sheet names.

<meta http-equiv="Content-Type" content="text/html; charset=> This edit-box

is for any additional elements that will be part of the head element, such as keywords
or script to perform actions on the header.

Tip Metadata in HTML Simple proves handy when sending personalized files via
Inspire Email Gateway. Before sending, each recipient's email address stored in
metadata (set e.g. in sheet names) is matched with the items of the recipients' list (in
the ToMail column of the input CSV file). Only those HTML files that have a match
in the CSV file are sent. Inspire Email Gateway generates warnings about unmatched
HTML files and lists them in the Errors.csv file. The metadata format for recipients'
verification is: <meta name="to" content="recipientEmailAddress"/>.

See also the Inspire Email Gateway user manual.

Substitution Characters can be used for variable-data, that has been processed by the
workflow, in both of HTML Header elements.

HTML Body This edit-box is the body background element.

Use the Browse icon to select an image file that will provide a background for the
HTML version of any sheet that will be printed using the selected media page.

1030
 9.5 Output Module

9.5.5 IJPDS Device Profiles

See also:
Output Module
IJPDS Engine Configuration

Each media page that has been created in the Output module can be further assigned to a
specific page for the printer, which is then used in Production. This is done via the Device Profiles
area in the Output module.

To assign your pages to be IJPDS device type, you should first create a new profile by clicking
on the New button.

To edit an existing profile, first select one of the Media on the left and then change the setting
for it in the Device Profiles area.

Each profile has independent setting for each of the media pages. It appears on the Output
panel when the device profile and a media page are selected. The setting for a media page
will be saved as part of that device profile and each time you use that profile those parameters
will be communicated to the printer.

Options Description

Page for printers Numbers the medium so that it can be assigned to a specific page for the
printer via the Printers tab of the IJPDS Engine Configuration when preparing to produce
the workflow.

The Page for printers option here in the Device Profile section must correspond with the
settings done in the Page Side Configuration dialog, otherwise you will receive the "Invalid
media config. Check Output module configuration." error message. See the two simple

1031
9 Output Modules

examples below which show you how the options should be set in case of IJPDS simplex
and duplex printing.

Example If you want to print two pages in simplex mode, do the following:

1. Assign the sheet name 1 to both pages in Layout in their Layout Properties,
Sheet Names tab: Change the Constant Value for sheet name 1 to e.g.
Page1 for the first page and to e.g. Page2 for the second page.

2. To add the two new Media in the Output module, click on Fill from Layout.

3. Create a new Device Profile of IJPDS type.

4. Click on the Page1 medium and set the Page for printers option to 0, then
click on the Page2 medium and set the option to 1.

5. Go to Production and select the IJPDS engine. Edit the Engine Configuration,
Printers tab. The first Page side configuration will be there with default set-
tings. For our simple example only the setting in the Page cell matter. The
default value 0 - Front side is correct, as we want to print simplex. The settings
will be applied to Page1 as it has the 0 value set in the Page from printers
of the Output module.

6. Now add a new Page side operation and in the Page Side Configuration
dialog define Page for printers to be 1 and Side of page to be Front side.
Set the physical RIP and heads by selecting e.g. RIP 1 and Head 1 and confirm
the dialog. This way a new Page side operation line is created with the Page
cell value 1 - Front side.

Example If you want to print pages in duplex mode, do the following:

1. If you have just one type of page designed in Layout, there is no need to assign
it a different sheet name 1. Different sheet names have to be assigned only
in case that you need to set your device profile differently for each medium.

2. To add the medium in the Output module you can click on Fill from Layout.
Then change the Duplex type combo-box value to e.g. Duplex long edge.

As there is only one medium, the pages of the same kind will be coming from
Layout and every odd page will be printed on the front and every even page
on the back side of an IJPDS page.

3. Create a new Device Profile of IJPDS type.

1032
 9.5 Output Module

4. Click on the medium and set the Page for printers option to 0. You can
see the Output module settings in the screenshot at the beginning of the
section.

One IJPDS page can have two page sides and so the two sides share the same
page number (0 in this example). So, if the pages coming from Layout should
be printed on the front and back side of an IJPDS page, you need to set it in
the Engine Configuration in the next steps.

5. Go to Production and select the IJPDS engine. Edit the Engine Configuration,
Printers tab. The first Page side configuration will be there with default set-
tings. For our simple example only the setting in the Page cell matter. The
default value 0 - Front side is correct as the first incoming page should be
printed on the front side of the page.

6. Now add a new Page side operation and in the Page Side Configuration
dialog define Page for printers to be 0 again and Side of page to be Back
side, because we want to print the next page on the other side of the same
page. Set the physical RIP and heads by selecting e.g. RIP 1 and Head 1 and
confirm the dialog. This way a new Page side operation line is created with
the Page cell value 0 - Back side.

Note If you set 1 - Back side here, you would receive the "Invalid media
config." error message after starting production.

1033
9 Output Modules

9.5.6 IPDS Device Profiles

See also:
Output Module
IPDS Engine Configuration
IPDS Printer Configuration

Each media page that has been created in the Output module can be further defined to set
parameters for any printing device that the workflow will be printed on. This is done via the
Device Profiles area in the Output module.

To assign your pages to be IPDS device type, you should first create a new profile by clicking
on the New button.

To edit an existing profile, first select one of the Media on the left and then change the settings
for it in the Device Profiles area.

Each profile has an independent set of attributes for each of the media pages. These attributes
appear on the Output panel when the device profile and a media page are selected. Any attrib-
utes set for a media page will be saved as part of that device profile and each time you use
that profile those parameters will be communicated to the printer.

1034
 9.5 Output Module

Options Description

General Options The options available in the IPDS Device Profiles area are identical to the
corresponding ones available in the AFP Device Profiles area, General tab, and are described
in that section.

Finishing Operations Area The cells and icons available in the IPDS Finishing Operations
area are identical to those available in the AFP Device Profiles area, Finishing Operations
tab, and are described in that section.

Note

There are all finishing operations (traditional as well as advanced incl. UP3i) available in
IPDS Device Profiles area, there is no option to enable the advanced ones like in AFP
the Advanced finishing control (incl. UP3I) check-box.

Finishing operations can also be defined as a part of the IPDS Printer Configuration
profile in the Production environment of Inspire Designer. If you set up finishing opera-
tions there, any finishing operations configured in the Device Profiles area in the Output
module of the WFD file will be ignored.

The possibilities as to which finishing operations are available in Production environment

and here are the same. More simple to set and recommended to use is the configuration
in IPDS Printer Configuration. Basic finishing operations can be selected in the Finishing
Parameter drop-down menu after Traditional has been selected in the Finishing Type
drop-down menu. Advanced finishing operations (UP3i) are the other ones but Tradi-
tional in the Finishing Type, their specific variations are set by the Finishing Paramet-
er.

1035
9 Output Modules

9.5.7 Metacode Device Profiles

See also:
Output Module
Metacode Engine Configuration
Metacode Printer Configuration

Each media page that has been created in the Output module can be further assigned an input
tray on the printer and paper format. This is done via the Device Profiles area in the Output
module.

To assign your pages to be Metacode device type, you should first create a new profile by
clicking on the New button.

To edit an existing profile, first select one of the Media on the left and then change the setting
for it in the Device Profiles area.

Each profile has an independent set of attributes for each of the media pages. These attributes
appear on the Output panel when the device profile and a media page are selected. Any attrib-
utes set for a media page will be saved as part of that device profile and each time you use
that profile those parameters will be communicated to the printer.

Options Description

Input tray Sets the name of the input tray on the printer, which should be used to print the
media page.

Page size Sets the paper format, which should be used to print the media page.

The possible values for these two options are listed in the JSL file, which needs to be loaded
to the Metacode printer before printing jobs from Inspire Designer.

1036
 9.5 Output Module

9.5.8 MIBF Device Profiles

See also:
Output Module
MIBF Engine Configuration
MIBF Page Side Configuration

Each media page that has been created in the Output module can be further assigned to a
specific page for the printer, which is then used in Production. This is done via the Device Profiles
area in the Output module.

To assign your pages to be MIBF device type, you should first create a new profile by clicking
on the New button.

To edit an existing profile, first select one of the Media on the left and then change the setting
for it in the Device Profiles area.

Each profile has independent setting for each of the media pages. It appears on the Output
panel when the device profile and a media page are selected. The setting for a media page
will be saved as part of that device profile and each time you use that profile those parameters
will be communicated to the printer.

Options Description

Page for printers Each defined media page can be assigned either 1 or 0 which corresponds
to an MIBF printer's page side configuration. See the section MIBF Page Side Configuration
dialog (Page & Side parameters).

1037
9 Output Modules

9.5.9 NexPress VDX Device Profiles

See also:
Output Module
NexPress VDX Engine Configuration

Each media page that has been created in the Output module can be further assigned a specific
printer tray, from which paper will be taken when printing the page. This is done via the Device
Profiles area in the Output module.

To assign your pages to be NexPress VDX device type, you should first create a new profile by
clicking on the New button.

To edit an existing profile, first select one of the Media on the left and then change the setting
for it in the Device Profiles area.

Each profile has independent setting for each of the media pages. It appears on the Output
panel when the device profile and a media page are selected. The setting for a media page
will be saved as part of that device profile and each time you use that profile those parameters
will be communicated to the printer.

Options Description

Select media The following options are available:

Not specified Does not set any tray for the media page, the printer default will
be selected. It has no effect on the output, just like in case of no device profile has
been defined.

Cover/Insert/Body Sets one of the possible tray names supported by the RIP.
Media from the tray will be used for printing the page to which it has been assigned.

1038
 9.5 Output Module

9.5.10 PCL Device Profiles

In this section: See also:
PCL Device Profile Dialog Output Module
Device Profiles Area for PCL PCL Engine Configuration
Settings in PCL Device Profiles vs. in PCL Printer Configuration
Printer Configuration Finishing Operations Illustration

Media pages that have been created in the Output module can be further defined for a PCL
printing device. The according device related settings can be adjusted in two steps, in two
places:

1. In the PCL Device Profile dialog, which is opened upon clicking on New and selecting
PCL for Type in the Create Device Profile dialog or on Edit (in case the profile has
already been created) in the Device Profiles area.

The dialog is used for importing a GPD file.

2. In the tabs of the Device Profiles area of the Output module, which are displayed after
you create a device profile of PCL type. The settings made on these tabs will apply to
the medium that has been selected when modifying options in the Device Profiles area,
i.e. different settings can be defined for each medium, where applicable.

If a GPD file is loaded in the PCL Device Profile dialog, the GPD Features tab becomes
available in the Device Profiles area. If it is not loaded, you will be able to change settings
on the General tab and Finishing Operations tab available then in the area.

9.5.10.1 PCL Device Profile Dialog

When you create a PCL device profile, you can first select a GPD (General Printer Description)
file that will be used for printer settings in the PCL Device Profile dialog.

To import a GPD file, check the Use GPD features check-box and click on the enabled Import
GPD button to browse for a GPD or an INF file.

1039
9 Output Modules

An INF file is issued by the printer manufacturer for a series of printers and after selecting it,
Inspire Designer enables you to choose the particular printer you have and will import the GPD
file accordingly, you do not need to know which of the GPD files to use.

The GPD files related to the INF have to be present in the same directory as the INF file you are
importing. Only the INF files for printers supporting the PCL engine (this is usually recognized
by the "PCL" letters next to the printer name) can be successfully loaded.

It can happen that the import has been completed but an error occurred. Then it is useful to
read the error displayed in the GPD Errors dialog. Click on the More details... button in the
Import GPD File dialog to check it. You should consider if the error affects your PCL or not. For
example, if the error concerns only the name of a GPD feature, the spool file can be generated
and then printed without problems. Or if the error concerns a command (e.g. an unsupported
command requiring an input parameter), which you will not use, the spool file will be generated
and printed correctly.

If the import fails, you can read the reason after clicking on the More details... button and
you need to solve the issue (e.g. missing GPD) to be able to use the GPD features.

If the GPD file is loaded, the Full View tab in this dialog shows the preview of the whole GPD
file organized into a tree structure and the GPD Features tab becomes available in the Device
Profiles area, where you can select for each feature if it should be used during printing and
with what settings. If no file is loaded, you can change settings on the General tab and Finishing
Operations tab, which are displayed in the Device Profiles area after closing the dialog.

By default, the GPD features will still be set to Do not use value after loading. To set the default
values from the GPD file, click on the Reset all options to default values button.

Note Setting GPD features in the Output module is used if you want to set different GPD
features for individual media (documents). To make different device related settings for each
medium, first select one of the Media on the left and then change the settings for it in the
Device Profiles area. If you want to apply the GPD features to the whole job, load the GPD file
in the PCL Printer Configuration dialog.

Occasionally it may be useful to make settings in both Output module (Device Profiles) and
Production (Printer Configuration). For more information about the possibilities and priorities
see the section Settings in PCL Device Profiles vs. in Printer Configuration.

9.5.10.2 Device Profiles Area for PCL

The tabs available in the Device Profiles area differ based on what choice you have made in
the first step, in the PCL Device Profile dialog. The GPD Features tab becomes available here if
a GPD file has been loaded in the PCL Device Profile dialog and the check-box Use GPD features
enabled. Otherwise, you will be able to change settings on the General tab and the Finishing
Operations tab.

1040
 9.5 Output Module

General Tab

Options Description

Medium settings to apply See the description of this option in the section AFP Device
Profiles.

Input tray Enables you to select one of the input trays predefined according to HP specifica-
tion, or the option Tray number and then to enter the input tray ID in the edit field below.

If you select a format, Inspire Designer will require the printer to use paper of the selected
format, regardless of the tray the paper is in. If you select Tray number, Inspire Designer
will require the printer to use paper from the tray which is specified in the Input tray #
field.

Note In case you select a format, some printers may always take paper from the same
tray even if paper of the required format is available in several trays, of different color in
each tray for instance. This can be solved by specifying the tray number, or, if it is necessary
to specify both the paper format and the tray number, you need to use a GPD file, or use
sheet names to insert Print Commands in PCL Engine Configuration.

Input tray # If Tray number is selected in the Input tray field, you can select the ID of the
input tray on your printer here.

Output tray Enables you to select one of the output trays predefined according to HP spe-
cification, or the option Tray number and then to enter the output tray ID in the edit field
below.

Output tray # If Tray number is selected in the Output tray field, you can select the ID of
the output tray on your printer here.

Finishing Operations Tab

On this tab finishing operations can be set, but their usage is triggered by the option Medium
settings to apply on the General tab, which is described in the AFP Device Profiles section.

1041
9 Output Modules

PCL supports only the UP3I (Universal Printer Pre- and Post-processing Interface) finishing oper-
ations, it does not have any own operations like AFP or IPDS.

To add a new finishing operation, click on the Create New icon.

Note Set the finishing operations in the correct order according to the printer setup. The
printer will not work properly otherwise.

To delete an existing one, select its row and click on the Delete icon.

The options available on this tab are identical to the corresponding ones available in the PCL
Printer Configuration, Variable Operations tab, and are described in that section.

GPD Features Tab

The GPD Features tab is available in the Device Profiles area only if the check-box Use GPD
features has been enabled and a GPD file has been loaded in the PCL Device Profile dialog.

1042
 9.5 Output Module

Options Description

Feature Lists features applicable for documents and jobs. A job consists of more documents.
One medium defined in the Output module represents one document, all sheets coming
from Layout are considered as one job. In Output module the single GPD features can be
applied to each medium, while in PCL Printer Configuration only to the job.

Selected Option Selects the value of the GPD feature. The drop-down menu lists alternative
selections that are applicable to the printing device and available in the GPD file. Alternat-
ively, you can select Do not use.

Show only used GPD features When certain GPD features are not used you can hide them
from the list in order to get more synoptic overview.

Show symbolic names If checked, it displays the name of a GPD feature taken from the
GPD section name the name is the same for all languages and contains no spaces.

If you uncheck this option, an alternative name of the GPD feature is taken from the feature
name, provided that it is defined for the feature in the GPD file. This name can be localized.

Reset All Options to Default Values Sets all GPD features to their default values, i.e. values
defined in the GPD file.

Reset All Options to Value: Do not use Sets options for all GPD features to Do not use
value.

9.5.10.3 Settings in PCL Device Profiles vs. in Printer

Configuration
You can import a GPD file and/or set finishing or variable operations in both Output module
(Device Profiles) and Production (Printer Configuration). This section contains information on
which settings have priority if set at both places.

You would make the settings in both places on purpose in case that you need some features
defined for each document (medium) these are set in the Device Profiles and other features
for the whole job those are set in the Printer Configuration. Otherwise it is recommended to
use just one of the possibilities.

There can be six different scenarios based on the (non)existence of GPD in Device Profiles, GPD
in Printer Configuration and variable operations definition in Printer Configuration. The influence
matrix looks as follows, the numbers in the last column correspond with the numbered list
below with an explanation for each case:

GPD in Device Profiles GPD in Printer Config. Var. Operations in Printer See:
Config.

yes yes no 1
no yes no 2
yes yes yes 3
no yes yes 4

1043
9 Output Modules

GPD in Device Profiles GPD in Printer Config. Var. Operations in Printer See:
Config.

yes no yes 5
no no yes 6

1. GPD imported in both Device Profiles and Printer Configuration, no variable opera-
tions defined If you set GPD features in both places, the same GPD file has to be loaded.
Otherwise the GPD file loaded in the Output module will have priority and the GPD file
loaded in the PCL Printer Configuration dialog will be ignored.

If the same feature is set differently in the GPD in Device Profiles and in Printer Configur-
ation, the procedure of coming to a result will be as follows: In case of the medium that
comes as first and/or last, the settings in Printer Configuration are also considered (as it
is the beginning or the end of the job) and if there are settings in both, the setting from
Device Profiles will be used. Only if a feature is set to Do not use in Device Profiles, the
setting from Printer Configuration will be used.

2. GPD imported in Printer Configuration, no variable operations defined, no GPD in

Device Profiles This combination can be used in case that you want to use other GPD
features than UP3I operations. You may use the GPD in the Printer Configuration to define
features related to the whole job in the Job & Document Property tab and define the fin-
ishing operations related to single media (documents) in Device Profiles. It is recommended
not to mix finishing operations settings from the Device Profiles with variable operations
from the GPD loaded in Printer Configuration.

3. GPD imported in both Device Profiles and Printer Configuration, variable operations
defined If a GPD file is imported in Printer Configuration, the variable operations that
are available there on the Variable Operations tab are only those defined in the GPD. The
settings of the operations have to be made correctly on both the Job & Document Property
tab and Variable Operations tab. First the GPD has to be loaded (the features will be set
to their default values in the Job & Document Property tab), then variable operations can
be defined (only features from the GPD will be available).

There are three possibilities, how to set a feature you want to use in Job & Document
Property and Variable Operations tabs:

Set the feature to Do not use in the Job & Document Property tab and set it as
needed in the Variable Operations tab (together with correct settings of sheet
names in Layout). This way the first sheet coming will not be influenced by the
settings from the Job & Document Property tab and the feature will be used as
defined in the sheet name and Variable Operations tab.

Leave the feature set to a default value in the Job & Document Property tab, which
will influence the first sheet(s) coming till the settings change with a sheet for which
different value is set via sheet name and Variable Operations tab. Should the settings
for the first sheet be set differently in Job & Document Property tab and Variable
Operations tab, the settings from the Variable Operations tab will have priority.

Set the feature the same way in the Job & Document Property tab and Variable
Operations tab. This can be used as a checking mechanism as well.

In case that variable operations are defined on the Variable Operations tab, the GPD file
imported in Device Profiles (while the check-box Use GPD features is enabled) and its
settings will be ignored.

1044
 9.5 Output Module

4. GPD imported in Printer Configuration, variable operations defined, no GPD in

Device Profiles If a GPD file is imported in Printer Configuration, the variable operations
that are available there on the Variable Operations tab are only those defined in the GPD.
The settings of the operations have to be made correctly on both the Job & Document
Property tab and Variable Operations tab. See point 3. above for the three possibilities,
how to set a feature you want to use on Job & Document Property and Variable Operations
tabs.

If there are any settings in the Device Profiles area, General tab, they will be processed,
but any finishing operations on the Finishing Operations tab defined in the area will be
ignored. (If the value None is selected on the General tab for the Medium settings to apply
option, it is as if there were no settings for the medium in the Device Profiles, because
also the General tab options are disabled.)

5. No GPD in Printer Configuration, variable operations defined, GPD imported in

Device Profiles If there are variable operations defined in Printer Configuration, the
GPD file imported in Device Profiles and its settings will be ignored.

6. No GPD in either Device Profiles or Printer Configuration, variable operations

defined If there are variable operations defined in Printer Configuration, any settings
in the Device Profiles area, General tab, will be processed, but any finishing operations on
the Finishing Operations tab defined in the area will be ignored. (If the value None is se-
lected on the General tab for the Medium settings to apply option, it is as if there were
no settings for the medium in the Device Profiles, because also the General tab options
are disabled.)

9.5.11 PDF Device Profiles

In this section: See also:
Device Profile Dialog Output Module
Device Profiles Area for PDF How to Split PDF and Insert Bookmarks

Selecting the PDF device type in the Create New Device Profile dialog opens the PDF Device
Profile dialog.

1045
9 Output Modules

9.5.11.1 PDF Device Profile Dialog

This dialog has attributes which are additional properties of the media that can be provided
by the printing device.

Options Description

Media selection If checked, media selection becomes part of the device profiles and a Select
media combo-box will appear on the Output panel, which is for assigning NexPress media
types to each of the media pages.

This option is only relevant when using a NexPress printer. See the Device Profiles Area
for PDF section below for more details.

Generate bookmarks If checked, you can further define bookmarks for the PDF file.

Bookmarks are a feature of PDF documents comprising of a tab where an active table of
contents is displayed alongside the PDF document when it is viewed in some PDF viewing
software, e.g. Adobe Reader. When a bookmark is clicked on, the viewer will navigate to
the corresponding page.

See the How to Set Bookmarks section below for more details.

Label The name of the bookmark that will appear on the Bookmarks tab of the viewing
software.

Enter here text that you would like to appear to indicate the structure of the bookmarks
tab.

Depending on the Type it could be either fixed text or text that is assigned by a sheet
name whose index number is entered here.

Type Shows the type of entered label:

Fixed text Defines a fixed label that has no link to any part of the document when
clicked on.

1046
 9.5 Output Module

This is useful for defining categories for the bookmarks.

Sheet index Defines that a bookmark is generated according to the value returned
by the sheet name whose index number has been entered in the Label column.

A new bookmark will be created each time the value of the assigned sheet name
changes. This bookmark will contain a link to the first page with that value and
that value will become the text of the label of the bookmark.

Move Up / Move Down Moves up/down in the list the selected bookmark entry.

New Text / New Child Text Creates new text/child text entry in the bookmark list.
The Text and Child Text entries allow to build the bookmarks structure fitting the required
document framework, e.g. main bookmarks on the same level containing some dependant
sections built with subsections, etc. See the How to Set Bookmarks section for an example.

New Text from Sheet Name / New Child Text from Sheet Name Creates new text
from sheet name/child text from sheet name entry in the bookmark list.

Delete Entry Deletes the selected entry.

If Sheet Name is Empty

Skip bookmark Skips empty sheet names while creating bookmarks. This method is
used by default and is recommended instead of the Use last non-empty value and
Replace with options which have been kept in the GUI for compatibility reasons.

First, the lower-most level of sheet names is checked and if:

All of the sheet names are empty, the whole lower-most level is omitted.

Then bookmarking continues with the level which is just above it (in the tree
in the Label column) and applies the same logic until the first non-empty
sheet name is found.

Or

There is any empty sheet name on that level (but not all of them empty), the
bookmark corresponding to the empty sheet name is omitted.

Then bookmarking continues with the level which is just above it (in the tree
in the Label column) and, if any empty sheet name is found, it uses the value
of the last non-empty sheet name on the same level.

Example The settings show sheet names structure and the resulting
bookmarks in a PDF file.

Settings Bookmarks are defined for the sheet names 3 8 in the fol-
lowing way:

Page 1 Sheet name 3 Getting Started

Page 2 Sheet name 3 Getting Started, Sheet name 4 Install and

Uninstall

1047
9 Output Modules

Page 3 Sheet name 3 Getting Started, Sheet name 4 Install and

Uninstall, Sheet name 5 System Requirements, Sheet name 6
Hardware Requirements, Sheet name 7 Server

Page 4 Sheet name 3 Getting Started, Sheet name 4 Install and

Uninstall, Sheet name 5 System Requirements, Sheet name 6
Hardware Requirements, Sheet name 7 Client

Page 5 Sheet name 3 Getting Started, Sheet name 4 Install and

Uninstall, Sheet name 5 System Requirements, Sheet name 6
Software Requirements

Page 6 Sheet name 3 GUI Introduction

Page 7 Sheet name 3 Basic Functions

Bookmarks are displayed only for those sheet names which are not empty.
Empty sheet names are e.g. on the Page 1 from 4 to 8.

Use last non-empty value Uses all sheet names defined in the structure (the Label
and Type columns) and, if any is empty, the last non-empty value of the sheet name
is used.

This option has been kept for compatibility reasons only.

Replace with Enter a name for all bookmarks without a label.

For example, if a sheet name does not return a value for the label's name, this avoids
the creation of a bookmark with no name. The text entered in the edit-box is used
as a label. However, if you enable this option and insert no text into the edit-box,
empty bookmarks will be created for each sheet name with no label's value detected.

Note Limitations of Use last non-empty value and Replace with options:

It is not possible to generate bookmarks from later than the first page. This is
due to the fact that the first page is always considered as changed sheet name
even if the sheet name is empty.

The structure of the definition (in the Label and Type columns) is kept. I.e.
all bookmarks defined in the structure are always generated even if the corres-
ponding sheet names are not defined in Layout or if they are empty.

1048
 9.5 Output Module

This option has been kept for compatibility reasons only.

Show bookmarks when document is opened Forces opening document(s) with

bookmarks automatically displayed. Disabled by default.

How to Set Bookmarks

With the option Generate bookmarks checked, right-clicking on any entry (e.g. Bookmarks)
in the table reveals the same options as in the toolbar described above:

Insert Text Inserts a fixed label that will be on the same level as the currently selected
label. The text that will appear as the label must be further entered in the Labels column
of the entry that is created.

Insert Child Text Inserts a fixed label that will be nested under the category of the
currently selected label. The text that will appear as the label must be further entered
in the Labels column of the entry that is created.

Insert Text from Sheet Name Inserts a bookmark on the same level as the currently
selected label. The index number of a sheet name must be further entered in the Labels
column of the entry that is created.

Insert Child Text from Sheet Name Inserts a bookmark that will be nested under the
category of the currently selected label. The index number of a sheet name must be
further entered in the Labels column of the entry that is created.

Delete Entry Deletes the selected bookmark entry.

The Bookmarks entry is the root of the structure of the bookmarks, all subsequent entries must
be dependent on it. Therefore in the first instance, you must Insert Child Text from Sheet Name
or Insert Child Text to create a dependent level.

Example In the screenshot below you can see an example bookmark structure where,
on the first 'child' level, two category labels (Surname and ZIP) have been created for the

1049
9 Output Modules

bookmarks. Then, dependent on those categories, the bookmarks have been assigned
the sheet names that will create them.

The aim of the above bookmark configuration is to use sheet names to create bookmarks
for each and every customer surname and each and every ZIP code. This can be achieved
by the following steps:

1. In the Layout module, assign some appropriate sheet names.

In this case we are creating a document which has different pages for different
customers whose details are being read from a data file. Therefore we have chosen
to assign variables that relate to those customers: Surname will return the surnames

1050
 9.5 Output Module

of the customers whose records are printed and ZIP will return the ZIP codes for
those customers.

2. Select the Bookmarks entry and Insert Child Text, twice, to create category labels
for the bookmarks.

3. Enter suitable names for both of these category labels.

4. For both of the categories select Insert Child Text from Sheet Name.

1051
9 Output Modules

5. Enter the index numbers of corresponding sheet names that were assigned for
both of these bookmarks.

6. Click on OK to confirm the configuration and dismiss the dialog.

7. Now, when a PDF file is printed (via the production tab) the resulting bookmark
structure in PDF will look something like in this example screenshot:

Note The data file only had two records in this example (Mr. Planck and Mr. Miles) and
if there were more records there would be more bookmarks.

9.5.11.2 Device Profiles Area for PDF

Once a 'printer media config' has been created and is selected, Device Profiles on the Output
panel has attributes which have independent values for each of the media pages that have
been created.

1052
 9.5 Output Module

The values for each media page can be edited when that media page is selected. Any attributes
set for each media page will be saved as part of the workflow and each time you use that
profile those parameters will be communicated to the printer.

Options Description

Select media Assigns a Kodak NexPress media type to the selected media page.

Select one of the following values from the combo-box menu:

Not Specified

Cover

Insert

Body

This option is available after enabling the Media selection check-box in the PDF Device
Profile dialog. It is only relevant when using Kodak NexPress solutions.

Example You will print the PDF file using Kodak NexPress solutions and have already
created three different types of media page that correspond to different page designs in
layout:

1. FrontPage is Sheet Name 1 for the first design and it will be used for the front
cover of the document.

You could assign this page Cover in the Select media combo-box and ensure
that the corresponding printer settings are as required.

2. InternalPage is Sheet Name 1 for the second design and it will be used for the
body of the document

You could assign this page Body in the Select media combo-box and ensure that
the corresponding printer settings are as required.

3. ExtraPage is Sheet Name 1 for the third design and it will be used for any extra
inserted pages that are required.

You could assign this page Insert in the Select media combo-box and ensure
that the corresponding printer settings are as required.

1053
9 Output Modules

9.5.12 PostScript Device Profiles

In this section: See also:
PostScript Device Profile Dialog Output Module
Device Profiles Area for PostScript PostScript Printer Configuration

After selecting CreoVPS or PostScript for Type in the Create Device Profile dialog (opened from
the Output module) the according device related settings can be made in two places:

1. In the PostScript Device Profile dialog.

2. In the Device Profiles area on the Media tab of the Output module.

9.5.12.1 PostScript Device Profile Dialog

After you select CreoVPS or PostScript for the new printer media configuration, the PostScript
Device Profile dialog opens:

This dialog can be opened again at any time by clicking on the Edit button in the Device Profiles
area.

Options Description

Import PPD File Enables you to load a PPD (PostScript Printer Description) file that contains
information on the screen angle, resolution, page size and device-specific information for
a file to be printed on a PostScript device.

This PPD file is applied to all pages. After it has been selected, the PPD keys are listed in
the Device Profiles area for each page defined on the Media tab in the Output module.

Indexing The Indexing field contains two tabs where settings can be made:

The On Start Page tab enables you to set indexing for the beginning of the page.

The On Finish Page tab enables you to set indexing for the end of the page.

1054
 9.5 Output Module

For both of these tabs, the following options and columns are available:

Index Enables you to select a sheet name from which all information (without any
changes) is inserted into PostScript as a print command. This allows you to enter any
user commands into the file.

Description Enables you to enter a name or description of the index. This text is not
used anywhere, it is only for your information.

Move Up / Move Down Moves the selected row up/down in the list of indexes.

New Row Adds a new row to the list.

Delete Row Deletes the selected row from the list.

Page name from sheet name Selects a sheet name by its index number. The page name
is then taken from this sheet name.

9.5.12.2 Device Profiles Area for PostScript

After closing the PostScript Device Profile dialog and selecting a media page in the left part of
the Media tab, PPD parameters can be viewed and set in the Device Profiles area in the bottom
right part of the tab:

1055
9 Output Modules

For a description of the buttons at the top of this area and of the Profile combo-box, see the
Device Profiles section.

When a PPD file has been loaded, the 'ModelName' contained in the Product Version Inform-
ation section of the loaded PPD will be displayed behind the Machine: text.

The 'No constraint conflict' text will be replaced by a red-colored text informing about constraint
conflicts should these occur. See the description of the Constraints tab for more details on
constraints.

For a description of the rest of the options available here see the On Start/Finish Documents
Tabs section of the PostScript Printer Configuration chapter, where corresponding options
available in the Production environment are discussed.

Note In the Production environment the corresponding tabs are called On Start Document
and On Finish Document instead of On Start Page and On Finish Page. This difference in
naming reflects the fact that in Production it is possible to make settings for PPD keys concerning
the whole document, whereas here in the Output module settings can only be made for media
(i.e. page) dependent parameters.

It is possible to check which PPD keys can be set here in the Output module by checking the
PostScript Printer Configuration section in Production. There, on the User Interfaces sub-tab
(organized below the Full View tab), you can go through all PPD keys to check their Section
index. Only keys for which the value in the Section index field is PageSetup or AnySetup can
be set here. PPD keys with the DocumentSetup value can only be set on the On Start/Finish
Document tabs in Production.

If settings for PPD keys are made here, they will override any settings made for the same keys
in the Production environment (in the PostScript Printer Configuration).

If variable operations are set in the PostScript Printer Configuration, they will override settings
in the Output module.

For settings made here to take effect, it is necessary to select PPD in the Select description
format combo-box available in the PostScript Printer Configuration dialog.

9.5.13 PPML Device Profiles

Each media page that has been created in the Output module can be further defined for a
PPML printing device. This is done in the Device Profiles area.

For PPML profiles a Use check box appears and, if it is checked, the combo-box to the right
offers three methods of media selection or impositioning:

PPML page media Displays media selection options that are mainly used for CREO
RIPs.

PPML impositioning Displays impositioning options that are mainly used for XEIKON
RIPs.

PPD file Displays PPD file related options that are mainly used for EFI RIPs.

1056
 9.5 Output Module

Click on the links above for a description of the options that appear for each selection.

9.5.13.1 PPML Page Media

Options Description

Page Section of Spool File Determines whether a media selection command will be used.
Select from:

Do not use command for media selection Does not use any media selection
command.

Use command for media selection from Employs media selection commands
found in a pre-prepared PS file.

An appropriate PS file should be selected in the combo-box to the right. By default

the combo-box is empty and PS files with commands must be created. This can be
done writing PPD commands in a basic text editor (e.g. Notepad) and saving the
file with the PS extension. Any PPD command can be written inside the PS file but
the intention was primarily for media selection commands:

Example To select a blue medium, place the following PPD command into
a PS file:

<</MediaColor (Blue)>> setpagedevice

If required, the command for Duplex printing should also be written in the PS file:

Example <</Duplex true>> setpagedevice

Note Different devices may require differing PPD commands.

Add Shows an Open dialog in order to locate a PS file and add it to the combo-
box list.

Remove Removes a PS file from the combo-box list.

Edit Opens an Edit dialog to edit the text content of the PS file.

1057
9 Output Modules

Selection of Media Determines where, in the produced PPML spool file, any media selection
commands will be inserted. Select from:

Select at the beginning of a document Writes the commands at the beginning

of each document.

A document is then determined by the grouping of sheets. By default one group

of sheets is created by one record read from the data file, but this can be redefined
using other modules in a workflow, including the Records by option for Data in
the Layout module and the Sheet Regrouper module.

Select at the beginning of a page Writes the commands at the beginning of each
page.

Tip Whether the commands are inserted at the start of each document or page is also
affected by the option Include commands to spool only on change.

Include commands to spool only on change If checked, the PPD commands are only
written to the produced spool file when a new command differs from the previous one.

The intention of this option is to avoid media selection commands being on both sides of
a page when duplex printing, but it also can help reduce spool file size.

If this option is left unchecked, then the commands will always be inserted according to
the Selection of Media choice.

Example

In the spool file, the PS file is called with this entry:

<SUPPLIED_RESOURCE Name="BluePaper" ResourceName=" BluePaper " Src="

BluePaper.ps" Format="application/postscript" Type="ProcSet"/>

If the PS file is then referenced again (e.g. when media has been changed and a
previously used media should be selected again) the <SUPPLIED_RE
SOURCE_REF /> tag is used:

<REQUIRED_RESOURCES>

<SUPPLIED_RESOURCE_REF Name="BluePaper"/>

</REQUIRED_RESOURCES>

9.5.13.2 PPML Impositioning

Impositioning is the process of placing the pages on the sheet so they will be right side up and
in the correct order after cutting/folding. You can define here different configurations for dif-
ferent media. You can use custom commands or predefined commands.

1058
 9.5 Output Module

Options Description

Use simplex/duplex settings from page If checked, the setting in Page area above is used.

Use custom command (overwrite page settings) If checked, the setting in Page area
above is ignored and you can select either predefined commands or custom commands.

Use predefined command If the option Use custom command is checked, you can select
from these predefined commands:

Simplex 1-UP

Duplex 1-UP short edge

Duplex 1-UP long edge

Simplex 2-UP

Duplex 2-UP short edge

Duplex 2-UP long edge

Duplex 2-UP bundled

Custom command Shows the commands for predefined options.

If you uncheck the option Use predefined command, you can edit them or insert in this
field your own impositioning.

Example How to set Simplex 2-UP:

<SHEET_LAYOUT Hsize="841.89" Vsize="1190.55">
<IMPOSITION Name="Simplex 2-UP">
<SIGNATURE Nrows="1" Ncols="2">
<CELL Row="1" Col="1" Face="Up"
PageOrder="2*s-1" Rotation="90"/>
<CELL Row="2" Col="1" Face="Up"
PageOrder="2*s" Rotation="90"/>
</SIGNATURE>
</IMPOSITION>
</SHEET_LAYOUT>

1059
9 Output Modules

9.5.13.3 PPD File

Any configuration set when PPD file is selected is valid for the whole document (for all media
it is the same).

Options Description

Output file name Names the output file.

By default it is the same file name as the workflow (using the substitution character %n)
with the extension JTML.

Load PPD Opens an Open dialog in order to load a PPD (PostScript Printer Description) file
that contains information on screen angle, resolution, page size or device-specific inform-
ation for a file to be printed on a PostScript device.

PPD Key Lists PPD keys applicable for the document.

Selected Option Displays the value of the PPD key and enables you to edit it (by selecting
from a combo box)

Show only used PPD keys Hides unused PPD keys from the list in order to get a more syn-
optic overview.

Show translation values Displays any translated PPD keys and values that the PPD file
contains, so you can switch between the original and translated ones.

Include commands to spool only on change If checked, the PPD commands are only
written to the produced spool file when a new command differs from the previous one.

The intention of this option is to avoid media selection commands being on both sides of
a page when duplex printing, but it also can help reduce spool file size.

Example Here are some PPD commands that select the output JTML file tray (any) and
page size (A4):

%%BeginFeature: *InputSlot Auto

%SCIPPD: DFE Tray Auto
%%EndFeature

1060
 9.5 Output Module

%%BeginFeature: *PageRegion A4
<< /PageSize[595.275 841.889] >> setpagedevice%SCIPPD:
DFE OM_Paper_Size PB_A4_P%SCIPPD: DFE OM_Orient
PB_BEST_FIT
%%EndFeature

9.5.14 VIPP Device Profiles

In this section: See also:
VIPP Device Profile Dialog Output Module
Device Profiles Area for VIPP VIPP Engine Configuration
Finishing Operations Illustration

Each media page that has been created in the Output Module can be further defined for a
VIPP printing device. This is done in the Device Profiles area of the Output dialog.

To define an existing VIPP device profile for specific medium (page size), do the following:

1. Select the medium in the Media tab of the Output Module dialog.

2. In the Profile combo-box select required VIPP profile. That displays the Device Profiles
Area for VIPP, where you can view/edit detailed settings of the profile.

To create a new VIPP profile, do the following:

1. Select the medium in the Media tab of the Output Module dialog.

2. In the Device Profiles area click on the New button, that opens the Create Device Profile
dialog.

3. Select VIPP in the Type combo-box and enter the required name of the profile in the
Name edit-box. Click on the OK button to confirm the settings made. That opens the
VIPP Device Profile dialog.

To edit an existing config, select it from the combo-box menu and click on the Edit button in
the Device Profiles area. That also opens the VIPP Device Profile dialog.

See the Output Module section for more details on creating a 'printer media config'.

1061
9 Output Modules

9.5.14.1 VIPP Device Profile Dialog

This dialog opens after confirming the VIPP (Variable Data Intelligent PostScript Printware)
device type selection in the Create Device Profile dialog or after clicking on the Edit button in
the Device Profiles panel of the Output module dialog.

Options Description
VIPP Commands

Use legacy finishing commands If checked, some options in the VIPP Finishing Oper-
ations are disabled. This option is suitable for historical VIPP versions, that have nar-
rower finishing capabilities. Disabled by default.

PPD Commands This section displays the name of the currently selected PPD (or displays:
No PPD selected) that is acquired by clicking on the Import PPD button. That opens the
Open dialog, where you browse for the required PPD (PostScript Printer Description) file.
To remove a PPD file, click on the Remove PPD button or replace the PPD with the required
one by clicking on the Import PPD button.

Custom Commands

Description Enables you to enter a name or description of the index. This text is not
used anywhere, it is only for your information.

Sheet Name Enables you to select a sheet name from which all information (without
any changes) is inserted into VIPP as a print command. This allows you to enter any
user commands into the file.

Position Enables to assign the defined commands to be applied either:

On start page or

On finish page.

Move Up/ Move Down Moves the selected entry one position up/down the list.
This way you influence the order the commands are written in the PPD file. The order
has no influence on the functionality.

1062
 9.5 Output Module

Adds a new entry to the list.

Deletes the selected entry.

9.5.14.2 Device Profiles Area for VIPP

For the description of the options placed at the top of the Output dialog see the Output
Module section.

After closing the VIPP Device Profile dialog and selecting a media page in the Media tab, the
VIPP and PPD parameters can be viewed and set on the two available tabs in the Device Profiles
area in the bottom-right part of the Output dialog:

VIPP Tab
The VIPP tab (shown in the screenshot above) allows to define and view media properties, the
finishing operations and the output tray setting for the media selected in the left-hand side of
the Output dialog.

1063
9 Output Modules

Options Description

Input Tray Media characteristics inserted in the Input Tray section can help to identify the
required kind of media. It is sufficient to define only one, the relevant characteristic.

Media type Type in the media type or select it from the drop-down menu.

Media color Type in the media color or select it from the drop-down menu.

Media weight Type in the media weight or select it from the drop-down menu.

Finishing Operations If required, set the finishing operations to be performed by typing in

or selecting the preset values from the drop down menus. Leaving a field empty applies
no action; selecting Off disables the respective operation. See also the section Finishing
Operations Illustration.

Staple Type in or select the preset position(s) of stapling.

Bind Type in or select the preset binding position.

Offset Type in or select Offset to acquire an offset. This feature has its use limited only
to some hardware and specific settings (DocuPrints NPS with the MultiSet feature
enabled or DocuSP systems running version 1.32 or later, and Free Flow Print Server;
on FreeFlow Print Server systems OFFSET_on forces the output to the stacker).

Fold Type in or select a preset type of folding from the drop-down menu.

Note This option and the ones below are disabled when the Use legacy finishing
commands option in the VIPP Device Profile dialog is enabled.

Make Booklet Type in or select BookletFold or BookletSaddleStitch.

Punch Type in or select a preset option for the punching position. Selecting here any
option (except for Off), enables the Number of holes edit-box (below).

Number of holes Type in or select a preset number of holes punched in the media.

Output Tray

Destination Type in or select a preset destination of the printout.

1064
 9.5 Output Module

PPD Tab
The screenshot below shows the PPD tab after loading a PPD file and clicking on the Set all
options to default icon.

Options Description

No constraint conflict The 'No constraint conflict' text will be replaced by a red-colored
text informing about constraint conflicts should these occur. See the description of the
Constraints tab in the PostScript Printer Configuration chapter for more details.

PPD Feature Lists applicable PPD commands.

Note The Warning icon displayed next to some PPD keys indicates that the options
will have no impact on the output. That may be due to two reasons: either the PPD com-
mand does not contain any string, or it is a commented command.

On Start Page Option Displays PPD commands that are inserted into the document setup
section (the section placed before all the pages in the spool file).

On Finish Page Option Displays PPD commands that are inserted at the end of a spool file.

Show translation options If enabled (by default), some technical keywords that a user
can encounter in the user's interface are reworded for clarity. There might also be keywords
translated into a language other than English, if a given PPD file has been created in that
language. Toggle the icon to switch between the keywords and the translation.

Set all options to default Click to set all options to default, that is to values specified in
the imported PPD file.

Reset all options Click on the icon to reset all PPD options to the neutral Do not use po-
sition.

1065
9 Output Modules

9.5.15 Finishing Operations Illustration

See also:
AFP Device Profiles

Corner Staple Edge Stitch Punch

Oblique stapling

Left edge

Left edge
Front Front Front
of of of
sheet sheet sheet

Parallel stapling

An edge stitch with 2 staples A 3 hole punch operation

parallel to the left edge. parallel to the left edge.

Saddle Stitch In Center Fold In Saddle Stitch Out

Top edge Top edge Top edge

Fold Fold Fold

is is is
inward inward outward

A saddle stitch with 2 staples parallel to Center fold in is the same as saddle A saddle stitch with 3 staples parallel
the top edge. The first sheet is on the stitch in without the staples. to the top edge. The first sheet is on
inside of the booklet. the outside of the booklet.

Fold In Cuts
Top edge

Axis offset
from top edge
Separation cut

Perforation cut
Axis offset from
bottom edge
Bottom edge

A sheet folded inward at an offset A sheet that has been cut using
of 4.4 inches from the top. 2 different finishing operations.

1066
 9.5 Output Module

9.5.16 Rotation Samples

Rotation Sample 1
Paper format: Portrait

Job format: Portrait

Job rotated 180 degrees.

Rotation Sample 2
Paper format: Landscape

Job format: Portrait

Job rotated 180 degrees.

1067
9 Output Modules

Rotation Sample 3
Paper format: Portrait

Job format: Landscape

Job rotated 180 degrees.

Rotation Sample 4
Paper format: Landscape

1068
 9.6 Data Center Output Module

Job format: Landscape

Job rotated 180 degrees.

9.6 Data Center Output Module

See also:
Inspire Data Center

The Data Center Output module saves data from the workflow to a Inspire Data Centers.

This module can be placed between data connections in a workflow and is used to send data
to a data center config as one of multiple functions of that workflow. The module cannot be
used as the final output which can be loaded to production, instead it is usual to have Data
Output module at the end of the workflow (after this module) so it can be loaded to data
production. The intention of this system of module placement is so that many Data Center
Output modules can be placed in one workflow and be used for writing into multiple data sets
/ splits.

1069
9 Output Modules

Example

For workflows which only require to send data to a single data center config, use the Data
Output module.

Data Centers are managed by the related application Inspire Content Manager and you must
be logged in to Inspire Content Manager to be able to write to any data center that has been
created there. In addition, you must create data center configs in the Data Center Config
module before you can use this output module. After using this output and running the
workflow in Production, the data will be stored in the data center for reuse by other workflows
or other GMC Software Technology products.

Options Description

Data Center config Selects the data center config that the data will be sent to.

The combo-box lists any configs for data centers that have been set-up in the Data Center
Config module.

Any data being sent to any data center config must contain a field named Id which contains
unique values for each record. If the data center config is based upon a split (i.e. a split
was nominated in the Split column) then the data that is being sent to that config must
ONLY contain Ids, i.e. all other fields must be deleted (using the Data Transformer module)
before this module is used for writing to splits.

Tip If the selected Data Center config is based upon a data set (i.e. a data set was
nominated in the Data Set column of the Data Center Config module, but no split was
nominated in the Split column) then you can write to it using a binary field called Content

1070
 9.6 Data Center Output Module

that can, with each value, describe many field's values for a record. See Type in the Data
Input Module section for more details.

Data Center mode Selects how to add the data to the Data Center config:

Append Combines the structure of the output data and the data within, with
any existing structure and data in the Data Center config.

In the case that the data center config is based upon a data set (i.e. a split was not
nominated in the Split column) and:

A record in the data set has the same id as a record from the workflow and
a field in the data set has the same name as any field from the workflow; then
data from the workflow is added to that field, i.e. if the field from the workflow
has new records, those records are added to the corresponding field in the
data set.

Example

1. Data set contains two fields Id (id field on parent level) and Click-
Through Destination (array) which contain records:

Id Click-Through Destination

Walter Nose Toys, Music

Hanife Demir Jewelery

2. The workflow contains the same two fields with data that Walter
Nose has clicked-through to a new destination and somebody else
has clicked-through, but has nothing about Hanife Demir:

Id Click-Through Destination

Walter Nose Sport

Henry Stimson Software

3. With Append, the resulting entries in the data set would be:

Id Click-Through Destination

Walter Nose Toys, Music, Sport

Hanife Demir Jewelery
Henry Stimson Software

A field from the workflow has no corresponding field in the data set, then a
new field is created in the data set.

1071
9 Output Modules

Example

4. Following the example above, a workflow appends a new field

(Purchase) with info that Walter Nose went on to buy a toy and
Hanife Demir bought some jewelery:

Id Click-Through Destination Purchase

Walter Nose Toys, Music, Sport Toy018

Hanife Demir Jewelery Jewel300
Henry Stimson Software

Append only Adds data only into existing records but ignores data for records
that are not present in the existing data structure, i.e. this option does not allow
adding whole new records by mistake.

If there is a wrong Id of the record (not matching any of the existing ones), an error
is issued.

Replace Overwrites the whole record if any value in the record has changed.

In the case that the data center config is based upon a data set (i.e. a split was not
nominated in the Split column) and:

A record in the data set has the same id as a record from the workflow, then
all the fields in the data set will be replaced by those from the workflow.

Example

1. Data set contains three fields Id (id field on parent level), Click-
Through Destination (array) and Purchase which contain records:

Id Click-Through Destination Purchase

Walter Nose Toys, Music Toy018

Hanife Demir Jewelery Jewel300

2. The workflow contains the same two fields with data that Walter
Nose has clicked-through to a new destination and somebody else
has clicked-through, but has nothing new about Hanife Demir:

1072
 9.6 Data Center Output Module

Id Click-Through Destination

Walter Nose Sport

Henry Stimson Software

3. With Replace, the resulting entries in the data set will be:

Id Click-Through Destination Purchase

Walter Nose Sport

Hanife Demir Jewelery Jewel300
Henry Stimson Software

A field from the workflow has no corresponding field in the data set, then a
new field is created in the data set.

This is same behavior as Append.

Replace whole data set Overwrites the complete data structure of the Data
Center config with the new data from the workflow.

Any records in the data set which has an id that is not in the data output from the
workflow, will no longer exist. Any fields in the data set (even with matching ids)
that are not in the workflow will also no longer exist.

Remove Takes the data from the workflow that must ONLY contain Ids, i.e. all
other fields must be deleted (using the Data Transformer module), and deletes the
records with these Ids.

It can be used for removing records from both: data sets and custom splits.

In the case that the chosen Data Center config is based upon a split (i.e. a split was
nominated in the Split column in Data Center Config module) then the net result of Ap-
pend and Replace are the same, i.e. the list of IDs that is in the split increases with each
new ID that is written to it by the workflow.

1073
9 Output Modules

9.7 Sheet Statistic Module

See also:
Sheet Statistic Module Command Line
Parameters

The Sheet Statistic module creates a data file which contains the number of pages generated
for each input data record.

This file is typically used to re-process the original data file into a postal rate optimized file.

Here you define items to be logged, the separator type and coding. The module is set in the
workflow directly after the Layout module for which you want to gather statistics.

Options Description

Output file The output file and path where he logged items are to be saved.

File encoding See the separate chapter on Text Encoding.

Output Identifies whether statistics will be provided by group or all sheets.

Begin group means only information from the first sheet of every group will be
included.

All sheets means that information for all sheets of every group will be included.

Sheet name 1 If checked, information included for sheet name 1.

Sheet name 2 If checked, information included for sheet name 2.

Page count If checked, provides page counts.

1074
 9.7 Sheet Statistic Module

Sheet count If checked, provides sheet counts.

Page Align CharWidth Reserves the number of characters in CharWidth field for the page
count.

When set to 5, the number will be left padded with zeros (00001).

Sheet Align CharWidth Reserves the number of characters in CharWidth field for the
sheet count.

When set to 5, the number will be left padded with zeros (00001).

Group begins When checked, a special field is added to the end of each line indicating,
whether the current sheet is the first sheet of the group (i.e. group begins with this sheet).
When this is the 1st sheet, it is 1, otherwise it is 0.

Separator The character Inspire Designer will use to divide fields in a CSV output log file.

Example Typical settings might be:

delimiter is set to semi-colon

first columns is sheet name 1

second column is the page count

third column is the sheet count

the last column distinguishes between the first sheet of the group (when = 1) and
other sheets (=0).

They would return the following result:

Introduction;1;5;1

Introduction;1;5;0

Statement;1;5;0

Statement;1;5;0

Stocklist;1;5;0

Introduction;1;11;1

Introduction;1;11;0

1075
9 Output Modules

9.8 Statistic Data Module

See also:
How to Use the Statistic Data Module

The Statistic Data module can be used to create new variables from values returned by variables
or sheet names from a preceding Layout module. These new variables can then be used by
another Layout.

Example

Here Layout2 receives values from Layout1 as variables:

There are the following tabs available:

Sheet Names

Basic

1076
 9.8 Statistic Data Module

9.8.1 Sheet Names Tab

The Sheet Names tab allows the structure of the data to be determined according to sheet
names that have been assigned in the previous Layout.

Options Description

Data structure Determines how the data will be structured on the first level, i.e. what kind
of array it will be. Select from:

None No data will be created via this tab.

Array of sheets The created array will return a new set of values for each sheet
that is processed, e.g.:

Array of groups with first sheets and group size The created Sheet Names array
will return a new set of values for each group that is processed (the first sheet of
each defined group will be used to provide those values), and the Sheet Count
array will return the number of sheets in a group, e.g.:

Array of groups with array of sheets The created array will return a new set of
values for each defined group that is processed and another, dependent array re-
turns a set of values for each sheet within that group, e.g.:

1077
9 Output Modules

See the example how to use data extracted from PDF files and pass them as sheet
names to a next Layout to create barcodes in section How to Use the Statistic Data
Module.

Note When a WFD file created with PrintNet T version 7.0 and earlier is opened, the
menu offers 5 options. For backwards compatibility you can select the old value Array of
groups with first sheets. This extra option disappears once the setting has been changed
in Inspire Designer 8.0 or a later version.

Sheet names Determines which sheet names will be returning the values. The options
available in the combo-box depend on what has been selected in the Data structure
combo-box:

All sheet names Sheet names will occur as an array that returns the values of all
of the sheet names that have been assigned to individual pages.

Selected sheet names Opens an area that allows the further definition of which
sheet names should be used to return the values, e.g.:

Sheet Name Index Enter here the index number of the sheet name that will
return the values.

Output Field Name Enter here the name for the variable that will return these
values.

Create New Creates a new variable.

Delete Deletes the selected variable.

Move Up / Move Down Change the order of the variables.

Add GroupBegin field If checked and Selected Sheet Names has been set in the Sheet
names combo-box, adds a variable of Boolean data-type into the array, e.g.:

When a sheet is the first sheet any defined group, then the variable will return 1 to repres-
ent true.

This option only appears when Array of sheets is selected for Data structure.

The Sheet names combo-box is not available if None is selected for Data structure.

1078
 9.8 Statistic Data Module

9.8.2 Basic Tab

The Basic tab enables the creation of variables from the following Layout statistics:

Page Statistics

Layout Statistics

Page Size

Group Statistics

Sheet Info

Options Description

Page statistics If checked, creates a PageStatistics array.

Using

Sheet name 1 If checked, SheetName will appear as a variable in the PageStatistics

array, in order to return the values provided by sheet name 1.

Sheet name 2 If checked, SheetName2 will appear as a variable in the PageStatistics

array, in order to return the values provided by sheet name 2.

Other sheet names If checked, an array named OtherSheetNames will appear in

the PageStatistics array. It returns values from any other assigned sheet names
if and when they occur on a sheet.

The variable PrintedCount also appears to provide the total number of sheets processed
with the stated sheet names.

1079
9 Output Modules

Example If all of the above are checked, the following data structure occurs:

Layout statistics If checked, creates a LayoutStatistics array. It contains the variable Layout-
Name which returns the name of the previous connected Layout module.

Include page statistics If checked, an array named PageStatistics will appear in the
LayoutStatistics array. It contains the system variable PageIndex from the previous
Layout module, in order to return the page index of the sheets.

The variable PrintedCount also appears in both arrays to provide the total number of sheets
processed with the stated layout / page statistics.

Example If all of the above are checked, the following data structure occurs:

Page size If checked, creates a PageSizeStatistics array. It contains the variables Width and
Height to return the width and height of the pages that create the sheets.

The variable PrintedCount also appears to provide the total number of sheets processed
with the stated page size statistics.

Example If Page size is checked, the following data structure occurs:

1080
 9.8 Statistic Data Module

Group statistics If checked, creates a GroupStatistics array. The radio-buttons below father
determine the structure of this array:

Page based The array will contain the variable NumberOfLogicalPages which re-
turns the number of pages that have been used in each group. e.g.:

Sheet based The array will contain the variable NumberOfSheets which returns
the number of sheets that have been processed in each group.

The variable PrintedCount also appears for both of the above, to provide the total number
of sheets processed with the stated page / sheet based group statistics.

In this array you can also add the arrays that are described above so that those same
variables are created to return those values for each group:

Include layout statistics Creates the LayoutStatistics array in the GroupStatistics array.

Include page statistics Creates the PageStatistics array in the GroupStatistics array.

Using The other options here are the same as for the Page statistics check-box,
see above.

Include page size statistics Creates the PageSizeStatistics array in the GroupStatistics
array.

Example If all of the above are checked, the following data structure occurs:

1081
9 Output Modules

Sheet info If checked, creates a SheetInfo array.

The SheetInfo array contains the variables GroupBegin, SheetName, SheetName2, in order
to return these sheet related values for each sheet. It also contains another array Logic-
alPages which contain variables (LayoutIndex, LayoutName, LogPageIndex, PageIndex,
Width, Height and Weight) that return values that relate to the pages that create the
sheets.

The variable AllSheetWeight also appears, to provide the total weight of the sheets from
the Weight variable which is a value that must be set on the General tab for each individual
page in Layout. E.g.:

Include other sheet names Creates the OtherSheetNames array in the SheetInfo array.

Group result Creates a Group array in the SheetInfo array, which contains all of the
variables previously in the SheetInfo array. The result is that the variables return those
values for each group.

The variable GroupSheetWeight also appears, to provide the total weight of the sheets
for the group. E.g.:

Include normal transformation Adds the variables Flipped, X-scale, Y-scale, Shear,
Rotation, X-offset and Y-offset to the LogicalPages array, in order to return values

1082
 9.8 Statistic Data Module

that relate to any transformation that may have taken place to a page via an imposi-
tioning module. E.g.:

1083
10 Other Modules

10.1 Authentication Library Module

10.2 Event Script Module
10.3 Inspire Native Module
10.4 Data Center Config Module
10.5 Script Library Module
10.6 Template Merger Module
10.7 Workflow Gate and External Workflow Modules
10.8 XSLFO Module
10 Other Modules

10.1 Authentication Library

Module
See also:
Social Data Connector Module
How to Auto-Follow on Twitter

The Authentication Library is for storing authentication codes to connect to the API of Facebook
and Twitter, so that your accounts can be accessed by the Social Data Connector module.

In order to use the Social Data Connector module to retrieve and send data to social networking
accounts, you must first add this module to the same workflow and use it to log on to those
accounts and authenticate Inspire Designer as an application that is authorized to access those
accounts. You must authenticate each of the accounts listed in each Authentication Library
module individually, however you can copy and paste this module to other workflows to avoid
having re-authenticate for every workflow you create.

The tabs are:

Twitter

Facebook

Note In order for this module to work, you must be connected to the internet.

10.1.1 Twitter Tab

Each Inspire Designer installation (e.g. many instances of Inspire Designer controlled by one li-
cense), should be registered as a new application with Twitter Inc. so that they can grant it
access to the API. At the time of registration, Twitter provides you with a consumer key and
secret which are used to identify the application each time a request is made to the API. More
on registering can be found on the Twitter web site for developers.

1086
 10.1 Authentication Library Module

Options Description

Consumer key Enters the consumer key provided by Twitter.

Consumer secret Enters the consumer secret provided by Twitter.

Account Enters a name for a Twitter account that this module will use to read data from or
write messages to.

This does not have to be the actual username. There can be many accounts stored on this
tab for use by the many Social Data Connector modules that can be used in this one
workflow. Enter a new account by clicking on the Create New icon.

Authentication Informs whether Inspire Designer is currently authorized to access that ac-
count.

In the first instance, you have to authorize Inspire Designer's access to the account by
signing in to the Twitter account. Click on the button to connect to the Twitter sign in
page (via the Twitter Application Authentication dialog) and sign in to grant Inspire De-
signer access. Twitter will then provide you with a PIN number which you should enter in
the PIN edit-box and click on the Next button to complete the process.

If the status is Not tested, then test the authentication by clicking on the Refresh icon.

10.1.2 Facebook Tab

Each Inspire Designer installation (e.g. many instances of Inspire Designer controlled by one li-
cense), should be authenticated as a new application with Facebook so that they can grant it
access to the API. At the time of registration, Facebook provide a client ID which is used to
identify the application so that a Facebook user's information is only shared with the correct
application. More on authentication can be found on the Facebook web site for developers.

Options Description

Client id Enters the client_id parameter that will have been generated by Facebook at the
time of authentication of the application.

Account Enters a name for a Facebook account that this module will use to read data from
or write messages to.

This does not have to be the actual username. There can be many accounts stored on this
tab for use by the many Social Data Connector modules that can be used in this one
workflow. Enter a new account by clicking on the Create New icon.

Authentication Informs whether Inspire Designer is currently authorized to access that ac-
count.

1087
10 Other Modules

In the first instance, you have to authorize Inspire Designer's access to the account by
logging in to the Facebook account. Click on the button to connect to the Facebook
login page (via the Facebook Application Authentication dialog) and login to the account
to grant Inspire Designer access.

If the status is Not tested, then test the authentication by clicking on the Refresh icon.

10.2 Event Script Module

In this section:
How to Use the Event Script Module

With the Event Script module you can set up simple automation tasks in Inspire Designer. Scripts
entered into this module are run at a specified event. This module is not connected to other
modules.

Options Description

Event Selects the event when the script is run. The options are:

After loading external workflow After loading an external workflow or before

preprocessing.

Before spooling job After preprocessing, before the job is spooled.

After creating file After the output file is created. If the output is split to multiple
files, the script is run after each of the file has been created.

After ending job After successful finish or when the job is aborted.

The script is entered in the empty panel below; for explanation of the icons and options at the
bottom of the dialog see the section Script Editor Dialog. For general information on scripting
see the Scripting section.

1088
 10.2 Event Script Module

10.2.1 How to Use the Event Script Module

This section presents a simple example of the Event Script module usage.

Example If the job is aborted during spooling, the files that have been generated so
far need to be moved to a special folder.

For this kind of task two Event Script modules are needed:

1. The first module will create a string list with the names of all files that already
have been created.

Set the Event option to After creating file.

The script will look as follows:

static Util.StringList files;
files.add(WorkFlow.CurrentOutputFileName.FileNameExt);

2. The second module will move all files whose names are included in the string list
to a specified directory, provided the job has been aborted. If it is not aborted,
the files will stay in the original output directory.

Set the Event option to After ending job.

The script will look as follows:

static Util.StringList files;
if(WorkFlow.IsJobAborted)
{
for(Int i=0;i<files.Size;i++)
{
File.move("C:\Output\"+files[i],"C:\Aborted\"+files[i]);
}
}

1089
10 Other Modules

10.3 Inspire Native Module

10.3.1 Inspire Native Module
In this section: See also:
Main Tab How to Use Inspire Native
Replacement Tab File Import Overview
How to Use the AFP Index Module
How to Use PCL Data Module

The Inspire Native module reads native files into a workflow so that they can be manipulated
by the workflow, e.g. combined with other files and impositioned.

10.3.1.1 Main Tab

1090
 10.3 Inspire Native Module

Options Description

EPS/PS

Override EPS/PS page size If checked, determines the size of a EPS or PS document
imported to your workflow.

If left unchecked, the original size of the page will be imported.

Files are read as PS rather than EPS If checked, EPS files are read as PS files (all pages
are read instead of just the first one).

EPS/PS page size Sets a customized page size of imported EPS or PS files.

Available when the Override EPS/PS page size option (above) is checked.

Sheet Name Configuration

Add page size info to sheet name 1 If checked, the size of any native page will be
appended to its corresponding sheet name 1 inside brackets, e.g.
Main(0.420m/0.297m).

This is the format of sheet name 1 that is required to be used with the option Variable
medium size in the Output module. Therefore, when both this option and Variable
medium size are checked then (when the workflow is processed) media sizes will
be automatically adjusted to the page sizes already defined by the native file.

The page size is taken from the native file, regardless of any new values entered for
EPS/PS page size.

Set file name to sheet name If checked, the name of the file will be the sheet name
which has its index number entered in the edit-box to the right.

The intention of this option is that the original native file name can continue to be
used to identify sheets even when they have been combined by this module. This
could be useful if, for example, you want to regroup the sheets according to that
original file name using the Sheet Regrouper module.

Any existing sheet names of the same index number will be overwritten.

Resource Merging

Don't merge resources If selected, no resources are merged. Select, if you import one
large native file.

Merge only TNOs If selected, only identical resources (like overlays, fonts, images) from
the various TNO files are merged. This option is enabled by default.

Merging helps to speed up output creation by reducing the number of resources for
processing.

Note If you have many TNOs (depending on their size, number and PC configuration),
it is recommended to use the Merge all native files, as that option can handle bigger
amounts of files than Merge only TNOs, although the processing may be slower.

Merge all native files If selected, all repeated resources from native files are merged.
Select this option, if you import numerous files of various formats.

1091
10 Other Modules

Files

Type Selects how to run the files:

All pages All pages of all of the files are printed.

Sheet range Allows the definition of a sheet range (start and end sheet)
from each of the files.

Sheet Allows the selection of single sheets from the files.

Group range Allows the definition of a group range (start and end group
number) from each of the files.

Group Allows the selection of single groups from the files.

Run from input data If selected, the list of files to be imported is specified from an
external data file.

The data file should list the names and paths to each of the native files and (if neces-
sary) other fields of integer data-type that relate to which sheets or groups from the
native file should be used. The data file is then read by a data input module which is
connected to the Inspire Native module.

The data files should be structured according to the selection made in the Type
combo-box:

All pages The data structure should have one field of string data-type, spe-
cifying the name and path of the appropriate file.

The file name can be relative (to the current WFD file) or absolute.

Sheet range The data structure should have:

One field of string data-type, specifying the name and path of the appro-
priate file.

File name can be relative (to the current WFD file) or absolute.

One field of integer data-type specifying the start sheet.

One field of integer data-type specifying the end sheet.

Note -1 entered as an integer means that no particular sheet is set and the
end sheet will be the last sheet of the file.

1092
 10.3 Inspire Native Module

Example If the input data do not have the required structure, use the
Data Transformer module to modify it.

1. The first screenshot displays a data structure in the Data Input module.
The variable called "Name" specifying the name of the file to be printed,
the "from" and "to" variables specify the start and end sheet of the
print output.

2. However, all the three variables are of the string data-type, which
means it is necessary to use the Data Transformer module to convert the
"from" and "to" variables to the integer data-type.

Sheet The data structure should have:

One field of string data-type, specifying the name of the appropriate file.

File name can be relative (towards the current WFD file) or absolute.

One field of integer data-type specifying the sheet number.

Group range The data structure should have:

One field of string data-type, specifying the name of the appropriate file.

File name can be relative (towards the current WFD file) or absolute.

One field of integer data-type specifying the start group.

One field of integer data-type specifying the end group number.

1093
10 Other Modules

Note -1 entered as an integer means that no particular sheet is set and the
end sheet will be the last sheet of the file.

Group The data structure should have:

One field of string data-type, specifying the name of the appropriate file.

File name can be relative (towards the current WFD file) or absolute.

One field of integer data-type specifying the group number.

Run from local definition If selected, no input data is required and you can define the
files list in the area at the bottom of the panel. E.g:

To add the files, use the Create New icon.

The sequence of the files can be changed using the arrow icons .

The columns that appear are dependent upon the selection made in the Type combo-
box:

File Name Enter the name and path of the file in this column.

Start Sheet Enter the first sheet of a range that should be used.

End Sheet Enter the last sheet of a range that should be used.

Sheet Enter the sheet that should be used.

Start Group Enter the first group of a range that should be used.

End Group Enter the last group of a range that should be used.

Group Enter the group that should be used.

Note -1 entered in a column means that no particular sheet is set and the end sheet
will be the last sheet of the file.

10.3.1.2 Replacement Tab

Enables you to replace any part of a path to an external font or image if the path defined in
the imported native file does not suite your needs. For example, if dozens of external images
are referenced to a directory called Resources in the native file, but on your computer you have
them stored in a directory called Images, on this tab you can instantly change the path to all
these images.

Note

This feature is available only for TNO files.

No replacement can be defined for other formats. However, if the option Use TNO as
intermediate format is selected in the Options Dialog, a warning is issued specifying by

1094
 10.3 Inspire Native Module

which font the missing font has been replaced in imported RTF, DOC and DOCX formats.
You can add the missing font before running production.

Options Description

Find Substring in Location Specifies a part of a path that will be replaced.

Replace With Specifies a string which replaces the above defined part of a path.

Create New Adds a new empty item to the list.

Delete Deletes the selected replacement pair.

10.3.2 How to Use Inspire Native

See also:
Inspire Native Module
Inspire Native Engine Configuration

The Inspire Native module can enable processing of several workflows, by allowing the building
of larger documents by combining previously produced sub-documents.

Example When running production for 20 small jobs, it would be necessary to run the
production twenty times, once for each job.

In this case:

The user can select the Inspire Native engine for each job and generate the output
TNO files (described below).

The files are then specified in the Inspire Native module, and are processed one
after another, in one continuous step.

After the Inspire Native module, other modules can continue to process the sheets that have
been read into the workflow, i.e. you can connect any of the same types of module that can
be connected to a Layout module output connector (impositioning modules or output modules).
You can also add sheet names (to identify the individual sheets or groups of sheets) via the
Inspire Native module itself or other modules such as the Text in Rect module.

1095
10 Other Modules

Example A Combination of Two Workflows into one Inspire Native Module

1st workflow

2nd workflow

1096
 10.3 Inspire Native Module

Combination of 1st and 2nd TNO files There is no preprocessing step needed for
printing Inspire Native output.

The Inspire Native module then prints the defined list of Inspire Native Output (TNO)
files.

1097
10 Other Modules

Note

Text and HTML Simple outputs are NOT supported

Vector charts are rendered during printing stage (AFP2IDPS is faster then Native to IPDS);
Inspire Native is DPI and output independent format.

TNO (the native output format) is similar to the legacy PRT Stream in PrintNet 3) and is
based on vector formats:

PDF

PS

The size of the output file with external fonts and images is very small 2-10 times
compared to compressed a PDF.

1098
 10.4 Data Center Config Module

10.4 Data Center Config Module

See also:
Inspire Data Center

The Data Center Config module connects selected data sets (or splits of data sets) to the
workflow from data centers, so that they can be read, manipulated and written to by the
workflow.

Data Centers are managed by the related application Inspire Content Manager and you must
be logged in to Inspire Content Manager to be able to use the data from any data centers that
has been created there. Then, to be able to read that data into the workflow, you must add
this Data Center Config module and nominate which of the data centers you will use. Each
data set or split that is nominated is then identified as a particular data center config.

After placing this module in a workflow (it has no connectors and can be placed in any position),
you can further use the Data Center Input module or Data Center Merger module) to read the
data into that workflow. Then the workflow can manipulate (e.g. using the Data Filter module
or Data Transformer module) and use the data (e.g. as a set of records for the repetition of a
Layout design), or write the manipulated data back into the workflow using the Data Center
Output module or Data Output module.

Add configs to the list using the Create New icon.

Options Description

Config Names the data center config for the purpose of selecting it within the current
workflow.

Data sets can be selected for use by other modules (e.g. Data Center Merger) and this is
the name a set will be identified by when setting those modules. It does not alter the
name given to the data center in the Inspire Content Manager (VCS), which is the value
in the Data Center column.

Data Center Selects the data center that the required data set belongs to.

If you are logged in to the Inspire Content Manager (VCS), this combo-box lists all data
centers that are available to your account.

1099
10 Other Modules

Data Set Selects the data set to be used by the workflow.

This combo-box lists all data sets that make up the data center that is selected in the Data
Center column.

Split Selects a split to be used by the workflow.

This combo-box lists all pre-defined splits that make up the data set that is selected in the
Data Set column. Alternatively, enter the name for a new split that will be created by the
workflow when it is processed.

A split is a sub-set of a data set which uses the same structure as the data set but only a
selection of the records. Which records are in a split is conditional. The conditions that
define a split can be an expression in the Edit Splits Dialog (accessed via Inspire Content
Manager) or they can be decided by a workflow, i.e. a workflow can write to previously
created splits of data or they can create new splits.

In order for a workflow to create a new split, enter a name for the split here then select
this empty split in the Data Center config combo-box in either the Data Center Output
module or Data Output module. The split will then be created at the time when the
workflow is processed in Production.

10.5 Script Library Module

The Script Library is for storing scripted function definitions that will be shared across the
workflow. It does not have any input or output connectors, it simply saves functions for use in
any scripting of additional parameters that may be employed as part of the workflow design.

The functions in the Script Library can also be called from any external workflows if a master
to slave relationship has been set-up using the External Workflow and Workflow Gate modules.

1100
 10.5 Script Library Module

Functions can be declared in the scripting area of this module and further edited using the
other options of this module. See the separate section How to Declare Script Functions.

Options Description

Auto include If checked, functions from the scripts defined here in the library can be called
upon (by pressing <Ctrl>+<Space> ) when scripting in any script area within the workflow.

This option should only be used if all of the functions, that are in the library, are applicable
to all of the modules used in the workflow.

If Auto include is left unchecked, enter the keyword #use in order to employ any of
the predefined functions from the library.

Once the keyword is entered (in the format: #use YourScriptLibraryName) in any
script area, the functions from the Script Library become available for the current module
and you can then select from them using <Ctrl>+<Space>.

Example #use ScriptLibrary1;

Script file Functions can be loaded from an external file (a TXT file containing scripted
functions).

This file is then listed in the Used Files Dialog and can be included in the workflow from
there if required.

Show Content Opens the Script Editor Dialog and displays the content of the TXT file selected
in the Script file edit-box. It allows you to view the script, find errors or edit it.

Note Used files included in the workflow are not editable.

Text encoding Select here the correct codec for the text of any script file that has been se-
lected in the Script file combo-box.

See the separate section Text Encoding for more details.

Open Script Editor Allows you to edit the script in a detached Script Editor dialog. See
the section Script Editor Dialog for details and explanation of the other icons in the same
line.

Note

As this module only contains functions declarations, then errors detected after clicking
on the Find Error button might be only errors because of the present context, i.e. it is
not processable script. Additional errors may occur if Auto include has been checked.

If there are Script Libraries with identical names in the master and slave workflows, the
library in the slave workflow will be overridden by the master workflows library.

1101
10 Other Modules

10.6 Template Merger Module

10.6.1 Template Merger Module
See also:
How to Add Variables to HTML
Template Merger Options Dialog
HTML Import

Template Merger adds variable-data to text, i.e. data that has been read into a workflow can
be added to text that has been entered here or read from a file.

The formats that the module works with are: TXT, HTML, XML. All of them are referred to as
'text' in the context of this module. They can be also considered 'templates' to which variable-
data have to be merged.

Variables (that return the values from data fields) can be easily added to HTML designs by re-
placing text between HTML tags. The HTML design cannot be viewed in this module, it can be
viewed in Proof using the HTML Simple Proof profile. The output from this module can then
be processed by the HTML Simple or Text engines to produce, for example, e-mails or SMS
messages.

Unlike with HTML native import (the output of which is meant for printing mainly), the output
from this module is intended for e-mails or SMS messages. The inserted HTML is not processed
in any other way than highlighting texts from in between the tags and images to make it
easier for you to replace them or make them variable if needed. Otherwise the HTML code
(including e.g. JavaScripts) remains the same, provided you do not make any changes.

It is also possible to use the module in run-time, i.e. read multiple designed HTML files via e.g.
Script Data Input and process them one after another. Such process would be similar to import-
ing HTML via Inspire Native module, but in case of Template Merger the code is not changed.

1102
 10.6 Template Merger Module

When open, the module is represented as a window which has its own sub-tab in the workflow
tab. This window is split into the following GUI components:

Merger area Views any text that has been entered or read into the module and text,
variables and images can be added.

Object Tree Determines the relationship between data variables, being read from a
data file and other objects that are created when editing the text; and allows navigation
between those objects.

Object Properties Adjusts the properties of any object selected in the Object Tree.

Menu Offers options relating to the module and its features.

Zooming Toolbar Zooms the view of the text in the Merger area:

Text can also be zoomed by pressing <Ctrl> and scrolling the middle button of your
mouse.

1103
10 Other Modules

10.6.1.1 Merger Area

The Merger area is where text is viewed and edited; and where variables and images can be
inserted by dragging and dropping to position. It is a view of the output that will be sent from
this module, which is unformatted text. When images are placed in this text, HTML code is
used to describe them as a resource.

In the area, each editable passage of text (called a text) is contained by tags which are labeled
with the name of the text as it has been named in the Object Tree. The different functions of
the text are colored: Code (e.g. HTML) is pink; variables that have been inserted from the Object
Tree are highlighted with green; images that have been inserted from the Object Tree are
named in green; and text that is written or escaped (see below) is in black. There is also a
context menu:

The context menu in the screenshot above appears when selecting text. When clicking in
between characters, you can only select Paste, Insert Text or Insert Image.

Options Description

Cut / Copy / Paste / Delete Perform the standard text manipulations.

There is a difference between pasting cloned objects and pasting copied ones, that is de-
termined in the Copy/Paste branch of the Template Merger Options Dialog.

Insert Text Creates a new text at the position inside the parent text.

1104
 10.6 Template Merger Module

Insert Image Selects an external image file that will be placed in the position in the text.

This is the same function as Insert | Insert Image from the menu except that it places a
copy of the image direct to the selected position.

Escape / Unescape Characters (<Ctrl> + <E>) Escapes / Unescapes HTML code.

If characters are escaped, they will not be processed as HTML code when the workflow
is processed by the HTML Simple engine, e.g. any escaped HTML code will appear as text
when the produced HTML file is viewed. Template Merger attempts to escape all normal
text, from in between the tags of HTML code, as any HTML file is imported via the Import
Text from File icon.

For images the option shows additional parameters: width, height and alternative text.
For example, when imported, you will see 'Image1' (green) in your text, but if you select
it and escape it, you will see <img src="Image1" alt="..." width="503"
height="386"/>.

10.6.1.2 Object Tree

The Object Tree lists every object that is currently present in the Template Merger, in a depend-
ency tree format. These objects may have been read in, imported to or created in the module
depending on their family type. The tree can be used to navigate through the objects and the
objects can be clicked on to open their Object Properties.

There are also context menus for each selected object, the options available for these are also
found in the Layout Tree Context Menu for objects in the Layout module and they are described
in relation to the corresponding objects there.

The object families (represented on the first-level of the tree) are:

Data Contains all the variables read into the module, system variables and any ad-
ditional variables that have been added in this module.

The variables can be placed in the text by dragging and dropping so that they return
values as part of that text. Also, they can be used to calculate conditions that control
when texts or images appear.

1105
10 Other Modules

The structure of the tree under the data family represents the actual relationship of the
variables within it, to each other.

Output Lists all objects that will be part of the text which will be passed out of this
module.

The structure of the tree in the Output family represents the processing order of all of
the used objects when the workflow is processed.

Texts Contains all texts that have been created or inserted to this module.

An individual text is very similar to a flow in Layout except that formatting (i.e. text
styles and paragraph styles) cannot be applied to them and they can only contain images.

Colors Contains all colors that have been created in this module by selecting a
different color for a palette image in the Palette tab of its properties. The Color dialog
is the same as for Layout.

Images Contains all images that have been inserted or imported to this module.

From the Object Tree, they can be dragged and dropped into positions in texts in the
Merger area. They are placed in text using HTML code and so images are only for use
if you will be using the HTML Simple engine. Once placed, the HTML code is 'unescaped'
by default so that only the name of the image is seen, you can escape the image (to
view the original HTML tags) by selecting the image name in the Merger area, right-
clicking and selecting Escape characters.

10.6.1.3 Object Properties

The Object Properties adjust the object for its intended purpose. Most object types have their
own set of properties that can be accessed by clicking on the object in the Object Tree.

The object types with properties are:

Data family Determines how the data is read into the Template Merger module.

The options available are the same as for the Data family properties in the Layout
module.

Variables Determine how the data returned by the variable will be presented and also
if it will perform any calculation.

The options available are the same as for Variable properties in the Layout module.

Output family Determines which text will be used in the output.

1106
 10.6 Template Merger Module

The option Content selects which of the texts in this module will be the output or allows
to Create new text and the Sheet Names tab allows an identifier for that text to be
entered and passed to other modules during processing.

Texts Contain passages of text and determines whether the text used should be selec-
ted by a variable.

All possible selections for Type are described in the section Types of Variable Selection.

Images Determine whether the image will be static or variable and how the image
will appear.

The properties of images here are the same as in the Layout module, see the separate
section Images for a description.

The set of icons at the top of the panel have the same functionality for objects in this module
as they do for objects in the Layout module. See the section Layout Properties Toolbar.

10.6.1.4 Menu

Options Description
All of the menu options are described in the separate section Layout Window Menu except for
the following.

View

Line Wrap If selected, the text will be wrapped in the Merger area so that all text is
visible without having to scroll horizontally.

Show All Texts If selected, all texts that may be used in the output will be shown in
the Merger area.

The intention for this option is for conditional text, where there can be many child
texts that are only part of the output if a condition is met for the parent text. Only
one text is shown inside a parent text if Show All Text is not checked, you can select
which one via the text's properties panel.

Automatically Finish Tags If selected, tags will be automatically closed while you are
editing HTML code, i.e. the first tag of any element must be written in full, but the
closing tags will be added by just entering </.

Insert

Import Text from File Imports text and included images from external files.

Text from any format of file can theoretically be imported but the intention is
primarily to import plain text or HTML files (e.g. TXT or HTM). For HTML files, refer-
enced resources (i.e. images) will also be imported. Afterwards, the texts and images
become available for selection in the Object Tree.

1107
10 Other Modules

When the file is loaded, you are prompted by the Import file options dialog to select
the correct codec for the text in the file. See the separate section Text Encoding if
you require more details.

Also, in case that you have a data file with variable-data connected to Template
Merger, you can select if the variables from the data file should be matched to the
variables in the inserted text by checking the Use dynamic variables check-box. See
the separate section Layout Objects from Imported Files if you require more details.

Insert Image Selects an external image file that will be used by the module.

The images become available for selection in the Object Tree, a single image file can
then be used many times in the same output. Images are managed as used files (i.e.
they are kept external unless you specifically include them in the workflow) and read
into the module at the time that the workflow is processed.

Tip When changing the location of your workflow (WFD) file, you can include all
images using File | Export with All Included in the Workflow Window menu.

Format

Change Current Text into Language Text Converts the selected text into a text that
is conditional on the language it was written in, making other language options
available.

Change All Texts to Language Texts Converts all texts in the module into texts that
are conditional on the language it was written in, making other language options
available.
For more details on the options here, see the section Language Flows and Texts.

Window

Show Object Tree If selected, displays the Object Tree window-pane which can be
moved and placed where required.

Show Object Properties If selected, displays the Object Properties window-pane which
can be moved and placed where required.

1108
 10.6 Template Merger Module

10.6.2 Template Merger Options Dialog

See also:
Template Merger Module

The Options dialog (File | Options) in the Template Merger module contains the branches:

General Options Application settings for Inspire Designer.

All of the options here are described in the section Workflow Options Dialog.

Global Template Merger Options Settings for the functionality and look of all Template
Merger modules.

The options here are split into the following branches:

Object Tree Sets the style of the Object Tree.

The options here are used for similar purposes in the Layout module and are also
described in the section Layout Tree for the Layout Options dialog.

Undo/Redo Determines the maximum storage (Undo limit) for remembering

user actions, so that they can be undone or redone using Edit | Undo / Redo.

Copy/Paste Determines whether copied texts and images will be cloned when
they are pasted.

The options here are used for similar purposes in the Layout module and are also
described for Copy / Paste for the Layout Options dialog.

Insert Image Sets parameters for handling images.

The options here are similarly used for images in the Layout module. All options
found here are described for Insert Image in the section Layout Options Dialog.

Shortcuts Assigns key-pad shortcuts for the options available to Template Merger
modules.

For a description of the options here, see the Shortcuts description for the Workflow
Options dialog.

1109
10 Other Modules

10.6.3 How to Add Variables to HTML

See also:
Template Merger Module

A template designer has a promotional e-mail that they have designed in an external HTML
design software application and has saved it as an HTM file. A Marketing Communications
Manager would like to personalize the e-mail's message to all the clients from the data that
has been read into the workflow. The structure of that data looks like this:

To personalize the HTML, do the following:

1. In the Workflow window connect the data input module with the variable data to the
Template Merger module.

2. Open the Template Merger module and click between the tags of Text 1 in the Merger
area so that the cursor blinks, i.e.:

3. Select Insert | Import Text from File.

In the Open dialog that appears, select the HTM file of the template. If there were im-
ages used in the file, ensure that the resources folder which the HTML code references
is in the correct, referenced location.

Once you have clicked on Open, you will be prompted to select the correct codec for
the text in the file. See the separate section Text Encoding if you require more details.

Also, you can select if the variables from the data file should be matched to the variables
in the inserted text. The inserted text would have to contain prepared placeholders in
the format <<VariableName>>, where the text between the <<>> marks must exactly
match the names of variables, e.g. <<Records.FirstName>>. See the separate section
Layout Objects from Imported Files if you require more details.

1110
 10.6 Template Merger Module

Here is an example of an imported HTML template:

Notice how the images have been read into the module as well as the text. There are
now also listed images in the Object Tree, e.g.:

Also notice how the text (between the HTML tags) has been recognized by the module
and escaped so that it appears in black, this makes it easier to find text that might need
replacing with variables.

4. Drag and drop variables from the Object Tree, into text positions (between HTML tags)
as required, e.g.:

When our example HTML had all of its required variables added, it looked like this:

5. Check that the variables are in the correct context in relation to their repetition.

In the data structure at the beginning of this example, it can be seen that Closing Bal-
ance and Account are within a sub-array, i.e. there can be many accounts to one client's
record. Therefore, to be able to return the values from the many accounts, the part of
the HTML code where these variables appear needs to be repeated the same number
of times as the number of accounts.

6. Enclose content that contains variables on different levels, in new texts nested inside
the main text.

1111
10 Other Modules

This enclosing in nested texts can be done by: Right-clicking just before that content
and select Insert Text, then cutting and pasting that text inbetween the tags of the
new text, e.g:

In our example, the image also needs repeating because it is a colored table where the
text appears. Therefore, we must also include it in the nested text.

7. Change the Type of the nested text to Repeated in its Object Properties, and select
the array which contains the variables (in the data structure) as the Variable, e.g.:

The view of the texts in the Merger area for our example is now:

8. Run Proof for the workflow.

To proof HTML from the Template Merger module, you must select an HTML Simple
profile (from the Proof Profiles toolbar), which views how the output of the workflow
will look if it is produced in the HTML Simple engine.

The proof and final view for one client record of our merged, example HTML file looked
like this:

This example HTML is, of course, only the header part of an e-mail, but notice how the
values returned by the variables have replaced the original text from the HTML template.

1112
 10.7 Workflow Gate and External Workflow Modules

10.7 Workflow Gate and External

Workflow Modules
10.7.1 Introduction to Workflow Gate and
External Workflow
See also:
Workflow Gate Module
External Workflow Module

Workflow Gate and External Workflow are two modules that are used for interconnecting
more workflows (WFD files). Either a part of a workflow can be appended (e.g. adding back-
ground to the layout), or a part can be stored separately and after processing in the external
workflow returned back (e.g. data processing which is repetitive for multiple workflows).

In the diagrams below, you can see how the modules are used to simplify data management.

The configuration of one of the original workflows can be seen in the first schema a set of
data processing modules containing data conversions and calculations is used in multiple
workflows resulting in different layouts for the same data.

In such a case this data processing part can become an external workflow, referred to as slave
workflow as well, and would contain the Workflow Gate modules at its beginning and end.
The multiple workflows would be referred to as master workflows and they would contain the
External Workflow module, which accesses the external part with data processing. This way

1113
10 Other Modules

changes to the Data Processing modules can be done in one (slave) workflow and are automat-
ically applied in the multiple (master) workflows.

It can be data or sheets that can be transferred from one workflow to another:

In case of data, the slave workflow can do transformations, merging, calculating variables
etc. and it can bring the processed data to the master workflow to print e.g. different
layout variations of the same letter.

See the Example 1 - Usage with Data section below.

In case of sheets, the slave workflow can perform some standardized sheet manipulations
(e.g. filtering, regrouping), can contain modules to append certain background, barcodes
or current date and time of printing.

See the Example 2 - Usage with Sheets section below.

It is possible to access parameters from the slave workflow during production (using the
Workflow Parameters window-pane) or in proof (using the Proof menu: Proof | Edit Workflow
Parameters). They have to be linked on the External workflow parameters tab of the External
Workflow module.

Slave workflows can be nested, i.e. you can use a slave workflow which contains another slave
workflow.

To proof the master workflow, the slave workflow cannot be opened for editing. This applies
also for the case when the workflows are in Inspire Content Manager (VCS), i.e. you do not
have to check the changes for slave workflow in, you just need to save the changes and close
the slave workflow to proof the master workflow.

Tip If there are just Layout objects that you would like to manage within one workflow but
use them in multiple other workflows, you may use the External Objects functionality.

If you are working with Projects, both modules and Layout objects with all their settings can
be shared among workflows as public objects.

1114
 10.7 Workflow Gate and External Workflow Modules

10.7.1.1 Example 1 Usage with Data

This example shows how Workflow Gate and External Workflow functionality can be used to
prepare data in the slave workflow and to re-use them then in many other master workflows
printing different documents.

1. The external workflow (slave workflow) prepares data for multiple main workflows.

The Workflow Gate module is set to be of Output data type.

2. One of the main workflows (master workflows) uses the merged data to print one of
the possible designs. (The other workflows would contain the same modules, the settings
inside Layout and Output modules would differ according to the design.)

The External Workflow module contains the following settings:

General tab Path to the external workflow with data.

When setting the path, you can confirm the message asking if you want to load
the set-up from the external workflow and then you can only check the settings
in the other tabs.

Data Outputs tab WorkflowGate1 in the Linked Gate dialog part.

External Workflow Parameters tab Parameters added so that the data files to be
processed could be selected during production (using the Workflow Parameters
window-pane) and only a certain part could be printed using the records range.

1115
10 Other Modules

10.7.1.2 Example 2 Usage with Sheets

This example shows how Workflow Gate and External Workflow functionality can be used to
add date of the production to each page of the design in the main workflow.

1. The external workflow (slave workflow) contains Layout module with the text to be
added, e.g. System variable JobStarted, and Sheet Backgrounder module for merging
two layouts together, i.e. joining objects from the Layout of the slave workflow with
sheets coming from the master workflow. The two Workflow Gate modules connect
it to the main workflow (master workflow).

The format of the date coming from the system variable and some accompanying text
are set only once (and can be changed only in this one place) in this workflow and do
not have to be set in multiple master workflows and positioned on each page in all of
them.

The Workflow Gate on the input side (Input sheets type) passes sheets from the master
workflow. The Workflow Gate on the output side (Output sheets type) returns sheets
back to the master workflow.

2. The main workflows (master workflows) just need the External Workflow module to
be added between the Layout and Output modules.

The settings for the External Workflow module are simple:

General tab Path to the external workflow with the text to be added by Sheet
Backgrounder module.

Sheets tab Input Sheets Linked Gate set to WorkflowGate2 and the Output
Sheets Linked Gate set to WorkflowGate3, as these are the names of the modules
in the external workflow.

1116
 10.7 Workflow Gate and External Workflow Modules

10.7.2 Workflow Gate Module

See also:
Introduction to Workflow Gate and
External Workflow
External Workflow Module

Workflow Gate module is used in the external workflow (slave workflow) as the opening and/or
closing point, i.e. it marks the beginning and/or the end where the main workflow (master
workflow) provides and/or receives data or sheets.

For more information about Workflow Gate and External Workflow modules usage, master
and slave workflows relation and examples see the section Introduction to Workflow Gate and
External Workflow.

Options Description

Input data Sets the Workflow Gate module to work as an opening point in front of a set of
modules manipulating data or in front of Layout. It receives the data from the External
Workflow module created in a master workflow. The data structure has to be set in the
dialog so that it matches the structure coming from the master workflow. The structure
is built or loaded via the icons at the bottom of the dialog. Their functionality is fully de-
scribed in the Script Data Input Module. The data structure can also be copied from the
Debug Data window-pane.

Output data Sets the Workflow Gate module to work as a closing point behind a set of
modules manipulating data. It provides the data to the External Workflow module of the
master workflow.

See the usage of the Workflow Gate set to Output data in an example.

Input sheets Sets the Workflow Gate module to work as an opening point in front of a set
of modules manipulating sheets (impositioning modules). It receives the sheets from the
External Workflow module created in a master workflow.

1117
10 Other Modules

See the usage of the Workflow Gate set to Input sheets in an example.

Output sheets Sets the Workflow Gate module to work as a closing point behind a set of
modules manipulating sheets (impositioning modules). It provides the sheets to the External
Workflow module of the master workflow.

See the usage of the Workflow Gate set to Output sheets in an example.

10.7.3 External Workflow Module

See also:
Introduction to Workflow Gate and
External Workflow
Workflow Gate Module
External Workflow Module Command
Line Parameters

External Workflow module is used as one of the modules in a master workflow and it links a
slave workflow to the main workflow.

The main advantage of this setup is that the slave workflow content is defined only once, the
External Workflow module is configured also just once and then the External Workflow module
can be used in multiple master workflows.

For more information about Workflow Gate and External Workflow modules usage, master
and slave workflows relation and examples see the section Introduction to Workflow Gate and
External Workflow.

Available tabs for the External Workflow module are:

General

Data Inputs Tab

Data Outputs Tab

Sheets Tab

External Workflow Parameters Tab

Output Modules Tab

1118
 10.7 Workflow Gate and External Workflow Modules

10.7.3.1 General Tab

Options Description

External workflow Selects the external workflow (slave workflow) to/from which the data
or sheets will be passed.

When setting the path, you can confirm the message asking whether you want to load
the set-up from the external workflow. If you confirm, then the names of the Workflow
Gate modules used in the external workflow and the input/output counts as well as the
external workflow parameters will be filled in to the corresponding tabs. This is very useful
in case of working with data as the data structure does not have to be created but is
loaded, as well as in case of the workflow parameters as they are all linked automatically
and you can only select those you need.

Tip When an external workflow is selected on this tab, it can be opened after right-
clicking on the External Workflow module and selecting the option Open external
workflow.

Reload External Workflow Reloads the external workflow. It is used after the slave
workflow has been altered. It offers you the possibility to load the set-up from the external
workflow just like after selecting it. The counts below will be also updated, if you confirm
the message.

Verify External Workflow Verifies if the external workflow contains Workflow Gateways
used correctly to match the modules that the External Workflow module is connected to
in the master workflow. If there are differences between the settings in the External
Workflow module and the external workflow, the Difference Report dialog opens and lists
them.

Update External Gates Updates the external workflow input to correctly match the data
structure in the master workflow. It is used after the master workflow has been altered.
You can check the concordance of the data structure between the master and external
workflow by clicking on Verify External Workflow icon; see the description above.

Data input count Sets the number of data inputs according to the input Workflow Gate
module(s) set in the external workflow.

Data output count Sets the number of data outputs according to the output Workflow
Gate module(s) set in the external workflow.

Sheet input count Sets the number of sheet inputs according to the input Workflow Gate
module(s) set in the external workflow.

Sheet output count Sets the number of sheet outputs according to the output Workflow
Gate module(s) set in the external workflow.

1119
10 Other Modules

10.7.3.2 Data Inputs Tab

Options Description

Linked Gate Displays the Workflow Gate module of Input data type, used as an opening
point in front of a set of modules manipulating data or in front of Layout, in the external
workflow.

Structure Enables you to view and edit the data structure. The structure is built or loaded
via the icons at the bottom of the dialog. Their functionality is fully described in the Script
Data Input Module. The structure can also be copied from the Debug Data window-pane.

10.7.3.3 Data Outputs Tab

Options Description

Linked Gate Displays the Workflow Gate module of Output data type, used as a closing
point behind a set of modules manipulating data, in the external workflow.

Structure Enables you to view and edit the data structure. The structure is built or loaded
via the icons at the bottom of the dialog. Their functionality is fully described in the Script
Data Input Module. The structure can also be copied from the Debug Data window-pane.

1120
 10.7 Workflow Gate and External Workflow Modules

10.7.3.4 Sheets Tab

Options Description

Input Sheets Linked Gate Displays the Workflow Gate module of Input sheets type, used
as an opening point in front of a set of modules manipulating sheets (impositioning
modules), in the external workflow.

Output Sheets Linked Gate Displays the Workflow Gate module of Output sheets type,
used as a closing point behind a set of modules manipulating sheets (impositioning mod-
ules), in the external workflow.

10.7.3.5 External Workflow Parameters Tab

The content of this tab is propagated to the master workflow and added to its own workflow
parameters.

The parameters can be viewed and modified in the master workflow in the Workflow Parameters
window-pane in Production or via the Proof menu option Edit Workflow Parameters in
Proof.

When selecting a workflow on the General tab you can choose whether you want to load its
parameters. If you click on Yes, the parameters will be listed on this tab.

Options Description

Linked Module The name of the module used in the slave workflow.

See the description of other options and icons in the section Param Input Module.

1121
10 Other Modules

Note It is possible to change the external workflow files from within Production or Proof using
one of the workflow parameters as shown in the example screenshot with parameters for a
master workflow below.

In such a case you need to make sure that all parameters that you want to access from all those
external workflows that may get selected during Production/Proof are added in this Parameters
tab. If an external workflow with different and/or additional parameters than those listed on
the tab is selected during Production/Proof, they would not be propagated to the master
workflow and hence inaccessible from Production/Proof.

Upon selecting a slave workflow on the General tab, the parameters for only that single
workflow are loaded. Upon selecting another one, they are overwritten on the tab. This means
that you can use the automatic load for one workflow and have to add the other parameters
you need from the other workflows using the buttons at the bottom of the dialog.

10.7.3.6 Output Modules Tab

1122
 10.8 XSLFO Module

Options Description

Linked Module Lists the Output modules used in the external workflow. They have to be
linked in case you want to access them in Production or Proof when running the master
workflow. Only the modules of the types listed below can be linked.

Output Type Sets the type of the Output module:

Output

Data output

Sheet statistic

Create a New Field Adds a new Output module item. You have to use the same name
as the module has in the external workflow.

Delete Field Deletes the selected Output module item.

10.8 XSLFO Module

See also:
XSLFO Module Command Line
Parameters

FO files are XML (Extensible Markup Language) format definition files that have either been
created by an external XSL formatter (e.g. MS XML) or directly (using HTML etc.). These files
can be loaded into Inspire Designer using the XSLFO module.

Or, alternatively, directly imported to the Layout.

To import an FO file to the Layout, go to the Workflow Window options and select File | Import
| XSLFO.

Used Terms

XSL Is a family of recommendations for defining XML document transformation and

presentation. Here, we look closer at two of them; XSLT and XSL-FO.

XSLT (XSL Transformations) Is an XML language for transforming XML documents.

XSL-FO (XSL Formatting Objects) Is an XML language for specifying the visual formatting
of an XML document.

1123
10 Other Modules

The schematic diagram below shows the process of adding formatting information to the
XML file using XSL Transformation:

XML file Contains the actual content (data) without format definition.

XSL(T) file Is an XML-based language used for the transformation of XML document.

XSL file Extensible Stylesheet Language XSL is a specification developed by W3C (World
Wide Web Consortium) for XML documents to be laid out and printed neatly. It gives a
format to XML files, i.e. how the XML source content should be styled, laid out and pagin-
ated onto a presentation medium, such as a window in a Web browser, a hand-held device
or a set of physical pages e.g. in a book. XSL Specification (style sheet) defines objects
that specify the page format, various types of objects such as paragraph, table, list. They
are called Formatting Objects (FO).

As XSL is a file separated from XML, it is also possible to apply multiple XSL specifications
to one XML file and output various layouts.

XSLT Processor Is a formatting engine that formats a XML file according to the instructions
described in a matching XSL file. In other words, the XSL Formatter takes XML documents
and the layout format information described in XSL, then formats them, outputs them to
XML, plain text or, in our case, .FO.

FO file Is an XML markup language for document formatting which can be loaded to In-
spire Designer. XSL-FO is a language that can be used to specify physical layout, colouring,
typography, etc, of XML documents for screen, print and other media. In this sense its
role is similar to that of CSS, but it is more powerful and flexible, particularly with regard
to pagination and scrolling.

XSL-FO, unlike CSS, is, itself, expressed in well-formed and valid XML.

For more details consult the XSL manual at http://www.w3.org/TR/2001/REC-xsl-20011015/.

10.8.1 Known Limitations

Inspire Designer does not support the following specifications of the FO format:

"Float" with anchors Float is an object that can overflow between pages. If a float
overflows, there can be an absolute position specified to which the end of the page
should be set.

"Footnotes" are appended at the end of a flow (not at the end of a page)

"last-line-end-indent" unsupported property in paragraph style

Only local locations of images are supported (images cannot be automatically down-
loaded from the web)

1124
 10.8 XSLFO Module

"Hyphenation-character" it is not possible to define the hyphenation character

All possibilities of formatting list blocks

Setting of different border styles for table header, body, footer (Inspire Designer only
supports the setting of a different border style for the whole table and separate cells)
<fo:table-body border-bottom-style="solid">

Setting of a fixed height for the whole table

Options Description

Input file Sets the location of the FO input file.

Text encoding Enables to select which encoding is used in the FO file.

Note If you select AutoDetect, the encoding will be detected automatically.

Image directory Sets the location of the directory containing images used in the FO file.

Note If the paths contained in the FO file are relative, they will be added automatically
to the path which is specified in the Image Directory field. The resulting combined paths
will describe the locations where the images can be found.

Example There is an XSL-FO module containing the design of the layout of a bank
statement, i.e. a bank statement form.

In the Layout1 module there are defined data fields containing the data about customers.

By using the Sheet Backgrounder, you can combine these two modules to set the design
from the XSL-FO module as the background of the bank statement form which will contain
the customer data, of DataInput 1, over-layed as it has been formatted in Layout 1.

1125
11 Proof

11.1 Proof Overview

11.2 Sheet Proof Window Menu
11.3 Sheet Proof Toolbars
11.4 Data Proof Window
11.5 Proof Options Dialog
11.6 Proof Profiles
11.7 Sheet Info Window-Pane
11.8 Print from Proof Dialog
11 Proof

11.1 Proof Overview

In this section: See also:
Sheet Proof Window Data Proof Window
Inspire Native Viewer

The Proof environment processes workflows, TSD data files and native files so that they can
be viewed in order to identify and eliminate possible errors prior to production.

To open the Proof environment when in the Workflow Window, go to Workflow menu: File
| Show Proof.

To load a workflow proof (WFD file), go to Proof menu: File | Open Workflow.

To proof any workflow that is currently open, select any open workflow environment tab for
that workflow (either Workflow window or Layout window) and click on the Proof icon .
Alternatively, you can select Workflow | Run Proof or press <F6>.

The Proof environment consists of two windows, both of which are active when a workflow
is proofed:

Sheet Proof window Is for viewing the pages of the intended document, as they have
been designed and collated in the workflow (see below).

Data Proof window Is for viewing how data, that has been read into the workflow,
has been processed at different stages in the workflow (see the separate section Data
Proof Window).

You can toggle between these windows using the tab at the bottom of the environment
or using the keypad shortcuts: <Alt>+<1>, and <Alt>+<2>.

1128
 11.1 Proof Overview

11.1.1 Sheet Proof Window

Legend

1. The Sheet Proof window menu. See the Sheet Proof Window Menu description.

2. The Sheet Proof toolbars can be found, by default, around the perimeter of the Sheet
Proof window. See the Sheet Proof Toolbars description.

3. The URL address field is displayed only for the HTML and HTML Simple proof profiles.
The field either displays the number of the proofed page of the document (when
viewing your document page), or the URL address of a web page currently viewed
(when viewing an HTML content located on the web). The Back/Forward buttons are
active only for web pages.

4. Once a workflow has been successfully loaded to proof, the pages of the workflow's
design are viewed in the Sheet Proof Area.

5. Hypertext links (inserted in Layout), are active in the Sheet Proof Area. Click on a link
to open the defined web site in the default web browser.

6. The Log window-pane summarizes the events of the processing of the workflow as
the workflow is loaded. Afterwards, this events description can be used to help locate
any errors that may have occurred.

7. The tab at the bottom of the Proof environment shows the open windows in the envir-
onment, which always includes the Data Proof window.

1129
11 Proof

Other information displayed at the bottom of the Sheet Proof window includes:

Displays the status of proofing.

Shows the Inspire Content Manager (VCS) status whether a user is

logged on or not. For more information see the Inspire Content Manager section.

Displays the current position of the mouse pointer over the proofed
page.

Displays the unit in which the current position of the mouse pointer over the
proofed page is shown. Units can be set in the Proof Options dialog.

Shows the rotation status (how many degrees the page is rotated). Rotation
can be changed using the rotation icons on the Zoom toolbar.

Shows the zoom set for Sheet Proof. It can be changed via the Zoom toolbar.

11.2 Sheet Proof Window Menu

In this section:
Proof Menu
Document Menu
View Menu
Profile Menu
Window Menu
Help Menu

The Sheet Proof Window menu has five sets of options, see the descriptions below for details
of each:

11.2.1 Proof Menu

Open Workflow Opens a workflow, TSD data file or any native file, so that it is Proofed.

You can also drag and drop supported files to the Proof environment in order to load
them. Supported files are WFD, TNO, AFP, PDF, EPS, JOB and INDD (Adobe InDesign must
be installed locally).

Save Workflow Saves the proofed workflow. You can also use the shortcut <Ctrl>+<S>.

If the workflow file is open in read-only mode, a warning message appears and a Save As
dialog pops up, when you try to save it.

1130
 11.2 Sheet Proof Window Menu

Print Prints selected pages in Sheet Proof.

For more details see Printing from Proof section.

Compress or Send to Mail Recipient See the Production Window Menu section for the
description of this option.

PreFlight Opens the PreFlight Check dialog. See the section Sheet Proof Toolbars.

Options Opens the Proof Options Dialog.

Edit Warning Config Opens the Warnings Config dialog, enabling you to edit the level
of severity and the logging status of Proof warnings.

For description of the Warning Configs dialog refer to Warnings section.

Edit Workflow Parameters Opens the Edit Workflow Parameters dialog, enabling you
to edit workflow parameters.

The Edit Workflow Parameters dialog has the same options as the Workflow Parameters
window-pane in Production.

Load Job Config Opens an Open dialog, enabling you to load workflow configurations
that have been saved previously in a JOB file.

Save Job Config Opens a Save As dialog, enabling you to save the current workflow
configuration in a JOB file.

Saving this as a separate file allows the reuse of defined settings and sharing of the settings
between different installments of Inspire Designer.

Inspire Content Manager See the Workflow Window Menu section for the description of
this option.

Select Workspace Opens the Select Workspace dialog, to select a specific workspace from
those that have been set-up via Manage Workspace.

Manage Workspace Opens the Manage Workspace dialog, to define default directories for
the different types of files that are used by Inspire Designer.

Exit Proof Closes the Proof environment.

11.2.2 Document Menu

First Page Displays the first page of the proofed document.

Previous Page Displays the previous page of the proofed document.

Next Page Displays the next page of the proofed document.

Last Page Displays the last page of the proofed document.

Go to Page Enables you to go to the selected page.

1131
11 Proof

Find Searches in the proofed sheets for the text you enter in the Find in Proof dialog. For
more details see Sheet Proof Toolbars section.

Find Next Finds the next occurrence of the text you entered for searching. For more details
see Sheet Proof Toolbars section.

Find Previous Finds the previous occurrence of the text you entered for searching. For
more details see Sheet Proof Toolbars section.

11.2.3 View Menu

Zoom In / Zoom Out Increases or decreases the magnification of the proofed pages
in the Sheet Proof Area.

Shortcut: <Ctrl>+<+> and <Ctrl>+<-> (+ or - from the number keypad).

Fit to Page Scales the page so that the whole page is visible in the Sheet Proof Area.

Shortcut: <Ctrl>+<*> (* from the number keypad).

Fit to Page Width Zooms the page so it fits the width of the Sheet Proof Area.

Actual Size Zooms the page to its actual size, i.e. 100%.

Shortcut: <Ctrl>+</> (/ from the number keypad).

Print Group Refines the proof view so that only the objects of the selected print group
are visible.

Print groups are assigned to objects in the Layout of a workflow, via the Position tab.

Show Overlays If checked, overlays (even within a flow content) are always shown when
proofing a job.

In Layout Options Dialog you can determine what objects will be placed into overlays.

Show Variable Data If checked, variable data is always shown when proofing a job. That
includes any objects that are not part of overlays.

Highlight Variables If checked, variables are during proofing and in the printed output (if
printed from Proof) highlighted with a color selected in the Proof Options Dialog. By default
it is lime green.

Enabling this option also automatically enables the Advanced Tracing option (described
right below).

Advanced Tracing If checked, the Trace to Workflow tool displays detailed information
about Layout objects.

Highlight URL Targets If checked, active URL links, defined in the Text Styles, are highlighted
with a color selected in Proof Options Dialog when proofing a job. By default it is aqua
blue.

1132
 11.2 Sheet Proof Window Menu

Show Variable Names If checked, the names of variables are shown instead of variable
data when proofing a job. The option is inactive when both Show Overlays and Show
Variable Data are disabled.

Tip When natively importing files with variables, enable the Use dynamic variables
option in the Native Import Advanced Options dialog, to be able to view the variable values
in Proof.

Show Heads Shows any virtual printing heads that have been defined via the Splitting tab
of the Raster Proof Profile dialog or using the Head Tool from the Tools toolbar.

This option cannot be deselected while the Head Tool is being used .

Process Heads Processes only those parts of the proofed document that are covered by the
virtual-printing heads.

If no head is defined and this option is selected, the proofed page will appear blank. For
more details see Splitting tab and Setting Heads in Layout.

11.2.4 Profile Menu

For details on the options available here see the separate section Proof Profiles.

11.2.5 Window Menu

Options Description

Show Log When checked, the Log window-pane displays. By default, at the bottom of the
Sheet Proof window.

For more details see the section Log Window-Pane.

Show SheetInfo When checked, Sheet Info window-pane is displayed.

For more detail see the section Sheet Info Window-Pane.

Show Data Preview If checked, the Data Preview window-pane is displayed. By default, to
the right of the Sheet Proof Area.

It enables the viewing of data for the current record being proofed. This feature works in
a similar way to the Bind Data option in the Data Proof Window.

Load Environment Loads or reloads the last saved environment settings for the Sheet
Proof window.

Save Environment Saves the current size, position and visibility of the menu, toolbars,
window-panes and Sheet Proof Area etc.

1133
11 Proof

Whenever you start Inspire Designer, the last saved settings will be applied to the Sheet
Proof Window. You can make adjustments as you work, but modifications will not be
maintained unless you save them.

Reset Environment Sets the positioning and visibility of the menu, Sheet Proof Area, Log
window-pane etc. back to their original default values, i.e. ignoring the last saved environ-
ment.

However, should you close and open Inspire Designer once again then the last saved en-
vironment will be restored. Therefore, to keep this reset version use Save Environment
.

11.2.6 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

Getting Started Opens the Getting Started guide, which offers a step-by-step introduction
to Inspire Designer.

About Displays the version number of Inspire Designer, copyright information and licensing
related information: IP address of the server where GMC License Manager is running (in
case of Net licensing), computer License IDs and dongle ID (in case a dongle is used for li-
censing). See the document Public Licensing Guide for details on licensing and guidelines
how this information can be used.

11.3 Sheet Proof Toolbars

In this section:
Tools Toolbar
User Printer Groups Toolbar
Find Toolbar
Module Toolbar
Page Toolbar
Zoom Toolbar

Around the Sheet Proof window there is a collection of tools, the description below summarizes
them.

If you need to add new functions to the existing toolbars or even create a new toolbar, right-
click on the grey toolbar area and select the displayed Customize option. For more information
see the section Customizable Toolbars.

1134
 11.3 Sheet Proof Toolbars

11.3.1 Tools Toolbar

By default this toolbar is to the left of the Sheet Proof window.

Options Description

Zoom Tool If selected, the mouse pointer becomes a zooming tool.

You can then zoom in by clicking on the proofed page; or zoom out by pressing <Ctrl>
and clicking on the proofed page.

Hand Tool If selected, the mouse pointer becomes a grabbing tool.

You can then grab the proofed page (by clicking on it in the Sheet Proof Area) and drag
it in the desired direction.

Print Area Tool If selected, you can mark a specific area for printing in the Sheet Proof
Area with the mouse pointer.

If you click on Print icon after selecting an area, the marked area serves as a pre-selection
for the Offset and Size settings in the Print from Proof dialog.

Head Tool If selected, you can move the currently defined, virtual-printing heads.

The coverage of the currently defined heads will be highlighted in the Sheet Proof Area:

Right-clicking on the highlighted area reveals a context menu where you can further
select:

Edit Head Opens the Edit Head dialog, enabling you to redefine the head size
and position.

Remove Head The head definition will be removed.

That head's coverage area will no longer be highlighted and any portion of
the proofed pages, that was covered by that head, will no longer be visible.

Right-clicking outside the highlighted area opens the New Head dialog, enabling
you to define a new head to cover the area.

Note This icon is disabled when a vector type proof profile is in use.

For more details see the sections Splitting Tab and Setting Heads in Layout.

1135
11 Proof

Debug Allows you to set when the Script Debugger should be used. Right-clicking the
displayed icon will reveal the following options:

No Debug No debugging is performed.

Stop on Break Points If breakpoints have been inserted into the used script(s) or if
exceptions occur, the script(s) will be debugged when you run proof.

Stop on Start The script(s) will be debugged when you run proof, regardless if there
are breakpoints in the used script(s).

See the separate section Script Debugger for more details.

Trace to Workflow Tool If selected, the tool displays detailed information about Layout
objects you click on. The information is shown in the Trace to Workflow palette that ap-
pears.

The level of details depends on the status of the Advanced Tracing option in the View
menu. If it is checked, more detailed information is available, e.g. for variable objects the
name of the flow displayed for the current record or more details in log messages in case
of overflow. If the option is not checked, only basic information is provided (e.g. variable
objects are traced only to flow area level), but generating of the information is faster.

The Trace to Workflow palette displays the complete path from the module name to the
actual object (in the screenshot above a variable in a table), indexes of records and arrays
(in square brackets next to the page name), repeated flows and rowsets (in square brackets
next to the respective flows and rowsets names).

Double-clicking on an item takes you to the appropriate place in the Layout (e.g. double-
clicking on a flow name opens the flow, etc.).

11.3.2 User Print Groups Toolbar

By default this toolbar is placed vertically, to the left of the Sheet Proof window.

1136
 11.3 Sheet Proof Toolbars

Options Description

Print Group Refines the proof view so that only the objects of the selected print group
are visible.

Print groups are assigned to objects in the Layout of a workflow, via the Position tab.

Toggle Handling Group When right-clicked, opens a menu with a list of handling groups.
A click on a given group either hides the objects belonging to the handling group or shows
the ones that have been hidden. Handling groups for selected objects are assigned within
the Position Tab in Layout.

Edit Warning Config Opens the Warnings Config dialog, enabling you to edit the level
of severity and the logging status of Proof warnings.

For a description of the Warning configs dialog refer to the Warnings section.

Edit Workflow Parameters Opens the Edit Workflow Parameters dialog, enabling you
to edit Workflow parameters.

The Edit Workflow Parameters dialog has the same options as the Workflow Parameters
window-pane in Production.

Load Job Config Opens an Open dialog, enabling you to load workflow configuration
that has been saved previously in a JOB file.

Save Job Config Opens a Save As dialog, enabling you to saves the current workflow
configuration in a JOB file.

Saving this as a separate file allows the reuse of defined settings and sharing of the settings
between different installments of Inspire Designer.

11.3.3 Print Toolbar

By default you can find the Print toolbar at the top of the Sheet Proof window:

Options Description

Print Opens the Print from Proof dialog, enabling you to define parameters for printing
selected pages via a desktop printer, i.e. one locally connected to your computer.

PreFlight Check Opens the Pre-Flight Check dialog, allowing you to define a page range
to be sampled in order to calculate the ink coverage (in %) required by the workflow
design that is being proofed. The results of this sampling process are displayed in the Pre-
Flight Progress dialog.

This can be a very helpful feature when implementing methods such as GCR (Grey Com-
ponent Removal) via color transformation based on accordingly designed ICC profiles in
order to save ink. Using this feature, it is simple to perform virtual production processes
to monitor the amount of ink which would be used by the solution in use.

1137
11 Proof

Tip It is also possible to control the visual appearance of each of the used colors in Proof
when employing a raster proof profile and then using the according dialog to determine
which of the colors should be displayed in proof. See the Viewing Colors in Raster Proof
section for details.

11.3.3.1 Pre-Flight Check Dialog

Options Description

Beg Defines the first page to be run in the Pre-Flight check.

End Defines the last page to be run in the Pre-Flight check.

Print to end If checked, all of the pages that follow after the beginning page will be included
to the range.

After clicking on the Start button, the Pre-Flight Progress dialog will be displayed:

11.3.3.2 Pre-Flight Progress Dialog

Options Description

Color Lists the Output colors which have been assigned for the current raster proof profile.

Coverage (%) Displays the total percentage of cover for particular colors and also the sum
for all colors (Total), over all of the pages within the selected range.

The maximum value for any color is 100%, i.e. the maximum overall value for the four
colors is 400%. These percentual values can be "translated" into absolute values (the

1138
 11.3 Sheet Proof Toolbars

calculation depends on the printer which is being used) allowing an exact precalculation
of the ink amounts which will be used for printing and thus simplifying the optimization
of ink usage; e.g. using GCR (Grey Component Removal) implemented by employing ac-
cordingly designed ICC profiles (which need to be selected in the raster proof profile being
used).

Example If a job consists of 2 sheets and the color cyan has a Coverage (%) of
1.616, this means 1.616% of both of the sheets together are covered with cyan ink.
I.e. on one sheet there might be more than 1.616% and less on the other, but an
average of 1.616% of each sheet is covered by cyan ink.

Note Values in the Color and Coverage (%) fields are only available when a raster
proof profile is in use.

Time / Severity / Event Description Lists the individual events that took place during pro-
cessing and their duration.

Acknowledge Closes the dialog.

Note Color calculations displayed in the Color and Coverage (%) columns are not performed
for vector type proof profiles. See the separate section Proof Profiles for an explanation of
raster and vector proof types.

11.3.4 Find Toolbar

By default this toolbar is at the top of the Sheet Proof window.

Options Description

Find / Find Next / Find Previous The find tools are for locating instances of text
within the proofed workflow.

In the Sheet Proof window, the text is searched for in the pages of document, and if found
the corresponding page appears in the Sheet Proof Area with the text highlighted.

Clicking on one of the find icons opens the Find in Proof dialog in order for you to define
the search.

Subsequent clicks on Find Next or Find Previous will repeat the last-defined search
in the respective direction.

1139
11 Proof

11.3.4.1 Find in Proof Dialog

Options Description

Find what Enter the text that you are looking for, here.

Where You can select: Text (searches in proofed pages); or AllSheetNames (searches through
the Sheet Info).

Match whole word only If checked, only matching whole words are looked for.

Match case If checked, searching is case sensitive.

Direction Selects the direction of searching Forward or Backward. If you click on the Find
Next button in this dialog, this direction is followed.

Note Text added as Text on Curve cannot be found.

11.3.5 Module Toolbar

By default this toolbar is at the top of the Sheet Proof window.

Open Opens the Open dialog to enable the loading of a workflow or any other supported
file.

You can also drag and drop supported files to the Proof environment to load them. Sup-
ported formats are WFD, TNO, AFP, PDF, EPS, JOB and HTML.

Output This combo-box menu offers a complete list of any Output or

Layout modules that are a part of the loaded workflow(s). Each workflow can contain
multiple outputs. The name of the workflow is written in brackets.

A forced proof profile selected for given Output module will be primarily used every time
you use that profile for Proof. After selecting another output it will employ its own forced
profile (if it has one) or the one used last.

Unload Unloads the workflow selected in the Output field (described above).

1140
 11.3 Sheet Proof Toolbars

11.3.6 Page Toolbar

By default this toolbar is at the top of the Sheet Proof window.

Options Description

Page Number Determines which page of the proofed design will be shown.

Enter a number here to navigate to that page.

Previous / Next Navigates through the proofed design, one page at a time.

Previous Record / Next Record Navigates through the proofed design, one group of
sheets at a time.

Remember that sheets from a workflow are most commonly grouped by the data array
selected in the Records by combo-box for the Data family of a layout, however this can
be altered, e.g. using the Sheet Regrouper module.

First / Last Navigates to the ends of the proofed design, i.e the very first page or the
very last page.

11.3.7 Zoom Toolbar

By default this toolbar is at the top of the Sheet Proof window.

Options Description

Zoom In / Zoom Out Increases or decreases the magnification of the proofed pages
in the Sheet Proof Area.

Shortcut: <Ctrl>+<+> and <Ctrl>+<-> (+ or - from the number keypad).

Fit to Page Scales the page so that the whole page is visible in the Sheet Proof Area.

Shortcut: <Ctrl>+<*> (* from the number keypad).

Fit to Page Width Zooms the page so it fits the width of the Sheet Proof Area.

Scale Determines the scale of the view of the proofed pages.

Units are percent of the original size. The current zoom setting can also be viewed at the
bottom-right corner of the Sheet Proof window.

Rotate Anticlockwise / Rotate Clockwise Rotates the view of the proofed page.

1141
11 Proof

Neither action changes the page orientation defined in the workflow.

11.3.8 Proof Profiles Toolbar

By default this toolbar is at the top of the Sheet Proof window.

For more details on the options available here see the separate section Proof Profiles.

11.4 Data Proof Window

In this section:
Data Proof Menu
Data Proof Toolbars

The Data Proof window is for viewing how the data within a proofed workflow has been pro-
cessed at various stages in that workflow.

1142
 11.4 Data Proof Window

You can select any one of the data input or data processing modules and scroll through the
records that are being read through the workflow at that point, in order to check whether it
is processing how you would like it to. The parameters of the view are controlled by the menu
and other tools:

For a description of the status panel at the bottom of the screen see the section Log window-
pane.

The bottom status bar shows the number of characters that the value of the selected variable
has for the current record, and the Inspire Content Manager (VCS) login status.

11.4.1 Data Proof Menu

All options found in the menu are also found in the Sheet Proof Window menu.

11.4.2 Data Proof Toolbars

11.4.2.1 Config Toolbar

All tools found on this toolbar are also found on the User Print Groups toolbar for the Sheet
Proof window.

11.4.2.2 Input Toolbar

Options Description

Output In the Data Proof window, this combo-box menu offers a

complete list of Data Input and Data Processing modules to choose from.

These are categorized according to the route from which they exited the workflow, i.e.
the Output or Layout modules. A workflow can contain multiple outputs and therefore
there can be multiple exit points for the data.

Selecting a module here is choosing which stage of data processing you would like to
proof.

11.4.2.3 Record Toolbar

1143
11 Proof

Options Description

Record Number Determines which record of the proofed data will be shown.

Enter a number here to navigate to that record.

Previous / Next Navigates through the proofed data, one record at a time.

First / Last Navigates to the ends of the proofed data, i.e. the very first record or the
very last record.

Find / Find Next / Find Previous The find tools are for locating instances of text
within the proofed records.

In the Data Proof Window, the text is searched for in the values of the variables of all re-
cords, and if found the corresponding record appears in the Data Proof Area with the text
highlighted.

Clicking on one of the find icons opens the Find Record dialog in order for you to define
the search.

Subsequent clicks on Find Next or Find Previous icons will repeat the last-defined
search in the relative direction.

Bind Data When checked and when the Records by combo-box of the Data node in Layout
is set correctly, it enables you to see the data for the record that you are currently proofing.
For instance, when you go to Record X in the Data Proof window, you can also see Record
X in the Data Proof Window.

Note When Bind Data is checked, you cannot move between records of an array by
which the logical page is repeated. This effect does not apply to other arrays in the Data
sub-tab.

Find Data Finds and displays the first occurrence of the selected data in the pages of the
workflow design shown in the Data Proof Window.

Example Select a field in the Record structure and click on the Find Data icon .
This will move you to the page where the given value from the selected field is used
for the first time.

Favorite Marks the current record as your favorite.

To save the favorite record, see the description of the icon Save Favorite below.

Example This can be helpful when you need to test records that may prove to be
challenging when a desired effect is expected. The TSD files with favorite records can
be called in by using an Internal Input module.

This feature is also used when populating variables with favorite data in Layout.

Save Favorite Opens a Save As dialog, enabling you to save records that have been selected
using the Favorite icon to a TSD file. The TSD file can then be loaded directly from the

1144
 11.5 Proof Options Dialog

Layout Tree. The content of the file can be easily checked after dragging and dropping it
into the Proof window.

This icon is enabled only if the current record to be saved has been selected as a favorite.

11.5 Proof Options Dialog

In this section: See also:
General Options Workflow Options Dialog
General Proof Options Layout Options Dialog
Production Options Dialog

The Proof Options dialog (Proof | Options) enables you to customize your Proof environment.
Different panels display as you select the options from the tree on the left.

11.5.1 General Options

For description of the options see the section Workflow Options Dialog.

1145
11 Proof

11.5.2 General Proof Options

Besides the General Proof Options section itself there is also the Shortcuts sub-section available.

Options Description

Run by record If checked, the initiation of proofing is faster. If grayed, the setting from
Output module is used.

This option also exists in Production, for more details and a list of limitations see the de-
scription for the Main Production window.

Highlight variables If the option Highlight Variables in the View menu is checked, variables
in Proof are highlighted with the selected color. The same feature can be used also in PDF
Engine Configuration.

URL target If the option Highlight URL Targets in the View menu is checked, URL targets
in Proof are highlighted with the selected color.

Odd / Even heads color Sets the colors for odd and even heads, when the Head tool is
used for Raster Proof.

The same settings are available in the Layout Options dialog.

Ruler units Selects units for the ruler in the Sheet Proof window.

Ruler unit division Sets the number of sections the unit will be divided into (8 or 10 is
available), e.g. one centimeter can be divided into tenths, one inch into eighths.

Proof units Selects units for X, Y position shown at the bottom of the Sheet Proof window.

1146
 11.6 Proof Profiles

Skip preprocessing on print group change If checked, it saves time by skipping prepro-
cessing on print group change. But it can cause wrong output if the job contains flow
areas with overflow or global variables.

Log to file If checked, all actions, status, warnings and errors that occur during the printing
from proof are written to a log file.

See the Production Options Dialog section for more details on all the log file options.

11.5.2.1 Shortcuts

Enables you to create or edit shortcuts (hot keys) for the current Proof. See the relevant section
in Workflow Options Dialog for the description of the options.

11.6 Proof Profiles

In this section:
Proof Profile Toolbar
Vector Proof Profile Dialog
Raster Proof Profile Dialog
HTML and HTML Simple Proof Profile
Settings

Proof profiles are available in the Sheet Proof window to enable the simulation of the actual
printer output.

1147
11 Proof

No settings made in proof profiles become properties of the workflow being proofed or of any
engine configuration that will eventually be used to produce the workflow they only apply
to the view of the sheets in the Sheet Proof window.

The available types of the proof profile are:

Vector

Raster

HTML

HTML Simple

Also, you can use any of the above profiles as forced profiles. Set them in the Output module.
The forced profile used last for proofing will be added to the values in the drop-down menu
(marked as 'Forced').

There are two ways to create a new proof profile:

Select the option Create New Profile from the combo-box in the Proof Profile toolbar:

Right-click on the Edit Proof Profile icon in the Proof Profile toolbar and select
Create Proof Profile from the menu.

Both of the above actions open the Create Profile dialog where you can make some initial
settings for the proof profile being created:

Enter a new name for the profile in the Name field and determine its Type by selecting from:

Vector

Raster

HTML

Simple HTML

1148
 11.6 Proof Profiles

11.6.1 Proof Profile Toolbar

By default this toolbar is located at the top of the Sheet Proof window.

Options Description

Profile Determines which proof profile will be used for processing the
workflow.

The combo-box offers the complete selection of existing profiles. All created profiles are
saved as part of the Inspire Designer application, so that they can be selected at another
time and used with other workflows.

Also, the option Create New Profile is available which allows you to create a new profile.

Edit Opens the according Edit Profile dialog (Vector or Raster) of the currently selected
proof profile.

Right-clicking on this icon reveals a context menu:

Edit Proof Profile Opens the appropriate Edit Profile dialog (Vector or Raster) allowing
you to adjust the settings for the currently selected profile.

Create Proof Profile Opens the Create Profile dialog, allowing you to add a new
profile.

Delete Proof Profile Deletes the currently selected proof profile.

Rename Proof Profile Opens the Rename Profile dialog, allowing you to edit the
name of the selected profile in the New name edit-box.

Tip The options available after right-clicking the Edit icon can also be accessed from
the Profile menu available in the Sheet Proof window.

Edit Process Colors Opens one of the Edit Process Colors dialogs, whose form varies ac-
cording to the option selected in the Output colors combo-box of the current Raster
Proof Profile dialog:

CMYK / CMYK split

Spot colors / Dithered spot colors / Dithered colorants / CMYK dithered colorants

This icon is active only for raster proof profiles. See the section Viewing Colors in Raster
Proof for details.

1149
11 Proof

11.6.2 Vector Proof Profile Dialog

Options Description

DPI for PDF/EPS Sets the DPI for rendering PDF and EPS images in Proof allowing you to
resemble the settings of the printer which will be used for production.

ICC Profile Setting See the section ICC Profile Setting for more information.

Resize barcodes See the section Resize Barcodes for more information.

Head Settings These options are intended to be used when preparing a workflow to be
printed on an IJPDS device. Splitting errors occur when objects or text to be printed are
not completely covered by a head, but overlap over its borders.

Log splitting warnings If checked, warnings will be shown in the Log window-pane
if objects on the pages of the design are split between heads (the warnings note the
heads which are affected) or are printed out of page.

When this option is checked, the other options in this area are activated.

Show splitting warnings on sheets Displays the heads in the Proof window and marks
errors there, i.e. shows objects that are split between heads and parts of the document
not covered by the heads which have been set up. This is also visible in the Print Pre-
view panel of the Print from Proof dialog and on the physical printout when the
document is printed from proof.

This option is only available if Log splitting warnings has been enabled.

1150
 11.6 Proof Profiles

Head Settings Opens the Splitting dialog where you can define printing heads and
where they splits between them are:

The Splitting dialog is for setting or loading head positions and the options on it can
also be found on the Splitting tab of the Raster Proof Profile dialog. Additional options
are:

Printer resolution X Sets the horizontal printer resolution in DPI (dots per inch).
You can select from the following predefined values: 120 DPI, 240 DPI and 300
DPI. It is also possible to manually enter a value other than the predefined ones.

Edit Head Properties Opens the Head Data Configuration dialog.

Units Allows you to select the unit in which the horizontal head settings will be
displayed.

The unit px is the equivalent of dots. If any unit except the default px is selected,
the values are always linked to the DPI selected in the Printer Resolution X
combo-box, i.e. if you change the DPI value there the head settings here will be
recalculated appropriately. The change is informational only. After reopening
the Splitting dialog the values will again be displayed in the default unit px (pixel).

Note

Any head settings made here are not linked to raster head settings, i.e. those
set using the Raster Proof Profile dialog and/or the Head Tool .

Head settings are automatically saved into the CFG configuration file. So even
if you do not save them to an XML file, they will still be used at your next
session.

1151
11 Proof

11.6.2.1 Head Data Configuration Dialog

Clicking on the Edit icon on the Splitting dialog opens the Head Data Configuration dialog
allowing you to enter custom configuration data for the head selected in the Horizontal Head
Settings field:

Key Lists the keys you have entered for the selected head. Keys can be useful for making
notes on configuration details of heads for later use in custom production procedures in
connection with the PDF engine.

Value Lists the values belonging to the keys you have entered for the selected head.

Load previous settings Fills the configuration data entered for the head located above
the head you are editing in the Horizontal head settings field on the Splitting dialog. This
icon is not available if the first head in the list is being edited.

Any settings you will have made for this head will be overwritten when this icon is used.

Move Up / Move Down Moves the selected row up/down in the list.

Create New Opens the Head Data Item dialog where a Key and Value can be determined
for a new row which is added to the list:

Key Sets the key for the head data item being created.

Type Determines the type of the key. Available options are: String, Number and Bool.

The selection made here influences what kind of entry you can make in the Value
edit-box.

Value Sets the value for the key. The possible entries depend on the Type selected:

If String has been selected in the Type combo-box then any text can be
entered.

If Number has been selected in the Type combo-box then any numerical value
can be entered.

If Bool has been selected in the Type combo-box then you can select either
True or False.

1152
 11.6 Proof Profiles

Configure Opens the Head Data Item dialog (described just above) allowing you to edit
the entry in the selected row.

Delete Deletes the selected row from the list.

Save Saves the defined head data into a XML file.

Open Allows you to select and load a XML file which contains previously saved head data.

11.6.3 Raster Proof Profile Dialog

The Raster Proof Profile dialog is used for editing raster proof profiles. All of its options are also
used for Raster Engine Configuration, see that section for their description.

There are two further functionalities of raster profiles which can be useful for monitoring pro-
duction processes:

Viewing Colors in Raster Proof

Pre-Flight Check with Raster Proof Profiles

11.6.3.1 Viewing Colors in Raster Proof

When using a raster proof profile, it is possible to determine the way colors will be displayed
by clicking on the Edit Process Colors icon available on the Proof Profile toolbar.

This icon opens the Edit Process Colors dialog, the options available on it depend on the selection
made in the Output colors combo-box on the General tab of the Raster Proof Profile dialog:

CMYK / CMYK split

Spot colors / Dithered spot colors / Dithered colorants / CMYK dithered colorants

Both of the possible sets of options are described in the sections below.

CMYK/CMYK Split
When CMYK or CMYK split is selected as Output colors, this dialog is displayed after clicking
on the Edit Process Colors icon:

1153
11 Proof

This dialog enables you to:

Display the CMYK colors in any combination or alone. This is useful to see which of the
colors will be used in which intensity and for which parts of the document you are
proofing.

Display the primer coat for CMYK split, with any colors or alone.

Primer must first be enabled on the General tab of the Raster Proof Profile dialog.

The following options are available from the Show combo-box:

Solo color C, Solo color M, Solo color Y, Solo color K Displays the selected color on
the sheets.

Using grey tones for CMYK or their true color for CMYK split.

CMYK Shows cyan, magenta, yellow and black on the sheets, without any primer.

Only available for CMYK split if Primer has been enabled on the General tab of the
Raster Proof Profile dialog.

All Displays all colors (including any primer for CMYK split) together, this is the default
setting.

Selected If selected, the check-box for each color is active and you can select which
colors should be displayed in Proof.

If the check-box of a color is unchecked, the color will not show in Proof.

Spot Colors / Dithered Spot Colors / Dithered Colorants /

CMYK Dithered Colorants
If Spot colors, Dithered spot colors, Dithered colorants or CMYK dithered colorants is selected
as Output colors, this dialog is displayed by clicking on the Edit Process Colors icon:

1154
 11.6 Proof Profiles

The colors that appear on this dialog are those that belong to the selected Output colors, i.e.
sixteen spot colors for Spot colors, seven spot colors for Dithered spot colors, any colorants
defined in the Colorants field (General tab) for Dithered colorants or cyan, magenta, yellow
or black plus any other Colorants for CMYK dithered colorants.

This dialog enables you to:

Edit the colors for Proof.

Click on a color to open the RGB Color dialog where you can define a new color.
However, you cannot edit default colorants, i.e. cyan, magenta, yellow or black for
CMYK dithered colorants or black for Dithered colorants.

Display only selected colors. This is useful when you need to check how each color (or
group of colors) will be printed.

The following options are available from the Show combo-box:

Solo color 0-15 Enables you to select only one color that will display on the sheets.

For Dithered spot colors, there is only Solo color 0-6.

For Dithered colorants or CMYK dithered colorants, the names of the colorants defined
in the Colorants field on the General tab will be available for selection instead.

All Displays all colors on the sheets. This is the default setting.

Selected If selected, the check-box for each color is active and you can select which
colors should be displayed in Proof.

If the check-box of a color is unchecked, that color will not show in Proof.

RGB Color Dialog

The RGB Color dialog is opened when you click on one of the colors available in the Edit Process
Colors dialog, if Spot colors, Dithered spot colors, Dithered colorants or CMYK dithered colorants
has been selected for Output colors.

1155
11 Proof

You can define an RGB color which will be used solely for displaying the color being modified
in the Sheet Proof window.

It is possible to create the color using the RGB or HSB color space or by entering an HTML color
code. Regardless of the way you define the color it will always be transformed to RGB for on-
screen display.

For more information on colors see the Colors section.

11.6.3.2 Pre-Flight Check with Raster Proof Profiles

When employing raster proof profiles it is possible to make use of the Pre-Flight Check func-
tionality, which allows the definition of a page range to be sampled in order to calculate the
ink coverage (in %) required by the workflow design that is being proofed and check the
spooling events in order to optimize the amount of ink used when printing.

11.6.4 HTML and HTML Simple Proof Profiles

The settings for the HTML and the HTML Simple proof windows are made in the respective
engine configuration dialogs.

When you select the HTML or HTML Simple Proof profile in the Profile combo-box in the Proof
Profile Toolbar, you can view the content of your document as a web page or an HTML email
message. In fact, what you view in Proof is an HTML document generated into the temporary
folder and opened through your system web browser.

The HTML and HTML Simple proof profiles have an extra feature: the URL address field. It either
displays the number of the proofed page of the document (when viewing your document
page), or the URL address of a web page currently viewed (when viewing an HTML content
located on the web). The Back/Forward buttons at the URL address field are active only for
web pages.

For displaying HTML the following versions of currently installed web browsers are used as
cores:

Internet Explorer for the Windows platform

WebKit for the Mac platform

11.7 Sheet Info Window-Pane

The Sheet Info window-pane displays information (sheet name, applied transformations, size
etc.) about the sheet which is currently being viewed.

1156
 11.8 Print from Proof Dialog

Tip Each Sheet Info value can be selected with a left-click, copied by <Ctrl> + <C> and pasted
by <Ctrl> + <V>.

You can display/hide the Sheet Info window-pane via the Window menu of the Sheet Proof
window: Window | Show SheetInfo.

Options Description

SheetName Shows the value of the first sheet name (sheet name 1) of the currently viewed
page.

SheetName2 Shows the value of sheet name 2 of the currently viewed page.

Note If more sheet names are defined in the Layout, their content is displayed under
Sheet Name 3 etc.

GroupBegin Shows True for a start of a new record, False for continuing page of a record.

LogPageInfo[0].Transformation Shows which transformation was applied (copying, moving,

dimensioning, transposition).

LogPageInfo[0].PageSize Shows the size of the current page in Sheet Proof (in meters).

LogPageInfo[0].PageIndex Shows the index of the Layout page (Pages node Page1,
Page2etc.) used for the current page in Sheet Proof. (It is the real position of the Layout
page in the Layout Tree.)

LogPageInfo[0].GlobalSheetCounter Shows the current sheet number within the whole

job.

GroupSheetIndex Shows the current sheet index within the group.

11.8 Print from Proof Dialog

To print all or selected pages of the proofed job, click on the Print icon in the Proof window
or select Proof | Print from the Proof Menu. The Print from Proof dialog then appears:

1157
11 Proof

The dialog has two panels. The left-hand side panel displays all the options and the panel on
the right-hand side shows the print preview of one selected page or a specific printing area of
the proofed layout.

Options Description

Profile Enables you to select a Print from Proof profile from the combo-box.

A profile contains settings for Printer, Print to file options, Engine and Autofit only.
Inspire Designer automatically saves all profile settings when changed and so if you want
to save your settings then it is recommended to create a new profile for them using the
New button first.

Page settings such as Begin, Copies, Scale, etc., are not saved if you close Inspire Designer.

New Creates a new Print from Proof profile.

Rename Renames the selected Print from Proof Profile.

Remove Removes the selected Print from Proof Profile.

Printer Enables you to select a printer from the drop-down list of currently accessible printers.

Properties Opens the printers properties dialog.

Print to file If checked, a spool file is generated from the Proof.

File name See Driver Configuration.

Split by group See Driver Configuration.

Split by size See Driver Configuration.

Engine Enables you to select engine type for your printer. Choose either Desktop Printer or
PCL Engine Configuration.

1158
 11.8 Print from Proof Dialog

Config Use this button to set proofing attributes, such as the DPI, of the output document.

It is strongly recommended to set the resolution to the same DPI as that of the production
printer.

Print range Selects a range of pages for printing. The options are:

All Selects the entire document for printing.

Current Selects the page indicated in the edit-box Begin below the radio-buttons.

Selection Enables the user to set the range of printed pages starting with a page
number indicated in the Begin edit-box. The final page can be set with chosen
page number inserted into the End edit-box. Alternatively, if the Print to end
check-box is enabled, the job will be printed to the last page.

The limit for the value of the page number in Begin and End fields is
2,147,483,647.

Copies Enter here the number of copies to be printed.

Print to end If checked, all pages of the job (visible in the Proof window) will be printed.

Collate If checked and if multiple copies have been requested, the job is printed from the
first to the last page and then from the beginning to the end again as many times as the
number of copies requested.

If left unchecked, all copies of the first page are printed first, then all copies of the second
page etc.

Scale X, Y Scales the output sheet along both axis and aligns it to the top left corner.

Offset X, Y Sets the offset for the output sheet aligned to the top left corner.

Size X, Y Enables you to set up the size of the printed page.

Autofit Enables you to select from these options:

None The page is printed with no size changes, i.e. if a page is bigger than the
output sheet it is cropped at the edge of the sheet; if a page is smaller the remaining
area of the output sheet is left empty.

None (with borders) The page is printed as with None but kept within the printers
set margins.

Simple The page is adjusted to the "complete" area of the paper size of the
currently selected printer.

With borders The page is adjusted to the printable area of the paper size of the
currently selected printer.

Print Preview Panel

The panel displays pages according to the settings of the Print Range options. Changes made
to Scale, Offset, Size and Autofit settings or choosing a different profile are instantly visible
in the preview panel.

1159
11 Proof

There are two ways to navigate through the pages selected for printing (and viewing).

1. Use the slider at the bottom of the preview area.

There are three numbers above the slider that identify the displayed page. For example,
the sequence of numbers seen in the screenshot above, i.e. 3/4 (5), indicates that:

within the selected print range, the third page is displayed,

the print range contains 4 pages,

the actual page number of the displayed page in the whole document is 5.

That last number is also shown in the tool-tip when you hover the mouse pointer over
the slider.

2. Use the navigation buttons underneath the slider. They allow to go to the first sheet,
the previous, the next or the last sheet of the previewed design.

1160
12 Production

12.1 Production Overview

12.2 Main Production Window
12.3 Production Window Menu
12.4 Engine Configuration
12.5 Printer Configuration
12.6 Driver Configuration
12.7 Jobs Window
12.8 Drivers Window
12.9 Multiple Jobs Window
12.10 Workflow Parameters Window-Pane
12.11 Report File Config Dialog
12.12 Production Options Dialog
12.13 Secure Printing
12.14 Encrypted TNO Files
12 Production

12.1 Production Overview

In this section: See also:
Opening the Production Environment Main Production Window
Production Environment Structure Jobs Window
Drivers Window
Multiple Jobs Window
Production Menu

The Production environment allows you to configure the production process of an already de-
signed and defined WFD file or other file types native to Inspire Designer such as TNO, AFP,
PDF, PCL or EPS. In this environment you can e.g.:

Specify printing protocol and output parameters

Control printing

View job history and status messages

12.1.1 Opening the Production Environment

There are several ways to open the Production environment:

By selecting Run Production from the Workflow menu in the Workflow Window or
clicking on the Production icon. These load the current workflow so that it is ready
to be produced.

Alternatively, <F5> is the keypad shortcut for this.

By selecting Show Production from the File menu in the Workflow Window or Layout
Window. Opening the Production environment by this method will not load a file, i.e.
there will be no file to run in the Production environment (unless you have already
loaded one earlier in the same session). To load a workflow use the Open button located
on the Main Production window.

By using the command-line parameter ap.

If you want to simultaneously load a workflow, that file needs to be specified as well.

Example PNetT.exe "C:\MyProject\Sample_Letter3.wfd" -ap

Tip Alternatively, you can also run a job from the console application PNetTC.exe or in the
Simple Production environment.

1162
 12.2 Main Production Window

12.1.2 Production Environment Structure

The Production environment is structured into four windows:

Main

Jobs

Drivers

Multiple Jobs

These windows can be accessed by clicking on the appropriate button within the Production

tab located at the bottom of the environment or using

the keypad shortcuts: <Alt>+<1>, <Alt>+<2>, <Alt>+<3> and <Alt>+<4>.

In each window of the Production environment, you can customize the toolbars. For more in-
formation see the Customizable Toolbars section.

12.1.2.1 Log
Common to all four windows of the Production environment is the log that displays critical
information as the job runs:

For a description of the options see the section Log Window-Pane.

12.2 Main Production Window

See also:
Production Overview

1163
12 Production

The Main Production window is used to set all parameters for a print job.

Options Description

Workflow Selects the file that will be processed here in Production.

The combo-box menu lists all files that have been loaded to Production.

Unload Unloads the file selected in the Workflow combo-box.

Open Loads a file to be produced. Supported file types are: WFD, JOB and all native files.

Tip Alternatively, you can drag and drop supported files to the Production environment
in order to load them.

Note You cannot open a WFD file, which was previously loaded using the Open
Workflow option in Workflow window and unloaded using the Unload button in the
Main Production window. To open such a workflow again, use the Open Workflow option
in Workflow window.

Module Selects the module via which a workflow will be processed.

If there are multiple outputs to any WFD file selected in the Workflow combo-box, this
combo-box menu offers a list of the alternative modules. However, if another type of file
is selected (e.g. AFP file) then only one value can be selected (e.g. AFP).

Job Config The settings in the Job Config area can also be controlled and saved using the
options Load Default Job Config, Save Default Job Config and Reset Job Config
commands available in the Production menu.

Begin Specifies the first page to be printed. This can be also used with negative values.

Example -1 = last page of the job, -2 = last but one page of the job etc.

1164
 12.2 Main Production Window

End Specifies the last page to be printed. This can be also used with negative values.

Example -1 = last page of the job, -2 = last but one page of the job etc.

Note When Print to end is enabled, this option is not available.

Copies Number of copies to be printed.

Debug Set here whether you would like to use the Script Debugger to debug scripts
used in your workflow when processing.

For details on the available options see the section Script Debugger in Production.

Keep data confidential Displays data as confidential in Production. This option sup-
presses the Proof only option selected for confidential data in the Data Transformer
module or in Layout.

Preprocess If the options Print to end and Run by record are not checked, you can
find out the total number of sheets to be printed by clicking on this button.

After you click on it, it changes into the Set max button containing information about
the total number of sheets:

You can now decide how many sheets you need to have printed and enter the
number in the End field. If you still want to print the whole job, you can just press
the Set max button and the total number of sheets will be inserted in the End field.

Print to end If checked, all pages of the layout are printed.

Collate If checked and if multiple copies have been requested, the job is printed from
the first to the last page and then from the beginning to the end again as many times
as the number of copies requested.

If left unchecked, all copies of the first page are printed first, then all copies of the
second page etc.

Run by record If this option is checked, each record gets printed as soon as it has been
pre-processed.

The result is that the initiation of printing is faster, especially when using the IPDS
engine, because there is no wait until the whole preprocessing is complete before
the printing itself starts. The total time of job printing may also be shorter but this
depends on the complexity of the job.

Example If we need to print the first 10 000 pages out of 20 000, it is printed
twice as quickly because only half of the job needs to be preprocessed.

But if we want to print the second 10 000 pages (i.e. pages 10 001 20 000)
we will not get such a time saving benefit as all the pages before page 10 001
will be preprocessed as well.

1165
12 Production

If this option is checked and grayed, then Run by record has been checked in the
Output module of the workflow and so it is set here by default. It can still be un-
checked if it is not required.

If this option is unchecked, the Run by record mode is disabled for the whole
workflow (even if this option is checked in Output module the setting made here
has a higher priority).

There are the following limitations to this option:

It is only intended for simple workflows and the following modules are NOT
supported by this option: Booklet Maker, Imposition Script, Job Reporter,
Saddle Stitch, Select N Groups, Sheet Aligner, Sheet Content Modifier, Sheet
Duplexer, Sheet Duplicator, Sheet Inserter, Sheet NS Splitter (unless the option
Split type is set to By count), Sheet Sorter, Statistic Data, Text In Rect.

It is not meant for Layouts that use the system variables Global Sheet Count
and Global Page Count, because complete processing needs to be done to
calculate the values of these variables and so the printing would not start any
quicker.

If there are multiple Layout modules in the workflow they need to be connected
to same Output module via impositioning modules.

Using the data output from any Layout in the workflow prevents the speeding
up of processing.

The Run by record option is also available for proofing and in the command line
application. See also Processing in Inspire Designer.

Print group 1 / 2 / 3 Enables/disables the printing of objects belonging to a print group.

Parallel processing Uses two processors (or a multi-core processor) as a method of

speeding up processing. However, the effect of this functionality is influenced by
hardware and software used in the customer solution so it is recommended to
benchmark your solution first to test the influence of this feature.

If the computer where Inspire Designer is installed has two processors, the load of
processing is split so that the workflow is processed by one and the spooling of page
content is done on the other and at the same time.

In addition, another thread which is not counted among working threads (threadcount)
is created on Inspire Production Server. Therefore, it is necessary to have enough cores
to avoid overloading and slowing down processing.

Note

When processing PDF files with flattened transparency, single threaded pro-
cessing is always recommended.

Parallel processing cannot be used for the following engines: DOCX, Text,
HTML Simple, HTML if the option Raster flows is unchecked for the Email
generation mode.

Offset Sets the offset for the output sheet.

1166
 12.2 Main Production Window

Example When we set offset values to -100mm and -20mm, the result on an
A4 sheet looks like this:

Scale Scales the output sheet on horizontally and vertically. The scaled output is aligned
to the top left corner.

Example Scale values are set to 0.75 and 0.5:

Warnings Displays a list of production warnings and enables you to edit them. For more
details see Warnings section.

Report File Opens the Report File Config dialog to allow the production of separate
report files for each job that is run here in Production.

Engine Selects the engine that will be used to process the job.

An engine uses an appropriate page description protocol to describe a processed workflow

(or native file) so that it can be printed by a corresponding device. An engine configuration
profile should be further created or adjusted, according to the requirements of the job,
via the Engine Config.

When a workflow with at least one Output module is loaded, then the engine that is se-
lected in this combo-box by default is the same as the selection in the Default engine
combo-box of the Output module which is selected in the Module combo-box here in
the Main Production window. I.e. you can also select engines by switching between output
modules.

Engine Config The options in this part of the window determine parameters for the engine
configuration.

For further description see the chapter Engine Configuration Overview.

Printer Config The options in this part of the window determine parameters for the printer
configuration.

For further description see the chapter Printer Configuration Overview.

These options are not available for some engines.

Driver Config The options in this part of the window determine parameters for the driver
configuration.

1167
12 Production

For further description (including options File name, Job name, Split by group and Split
by size) see the chapter Driver Configuration Overview.

These options are not available if IPDS, Multi or Null are selected in the Engine combo-
box.

Parameter/Value Displays parameters and their values and enables you to edit them.

Connect Establishes the connection to the printer, using the driver you have specified.

Start Starts printing the job, using the engine and driver you have specified.

After pressing Start the Jobs window is displayed. You can pause printing programmatically
using the pauseAfterCurrentSheet method.

If you go back to Main Production window in the middle of printing, you will find this
button changed into Schedule button. Schedule button remains there for the whole
time the job is being processed. By clicking on it, you send the command to print the
current WFD file again when printing of the first file is completed.

Proof Job Runs the Proof view and the workflow output is displayed in the Proof window.
The Proof view works as Proof itself, i.e. it does not display exactly what you are going to
print but it is just a shortcut to Proof (settings for Proof are applied, e.g. settings in Data
Cacher or Data Input module).

Run on remote server Checking this option enables you to spool jobs on remote machines
by connecting to them and running Inspire Production Server.

By default, workflows are uploaded to the server with all files included. Alternatively, you
can define remote paths to file servers (which e.g., contain images, data, etc., used in the
workflow) in order to avoid having to upload resources with the workflow which are also
available remotely; this will enhance the upload speed of the workflow file.

The request is executed and stored under a temporary file name on the remote server and
then the spool file is downloaded back to the local workstation (unless you choose to
spool to a shared remote path).

Server parameters and remote paths to file servers can be set in the Run on remote
server options panel on the Production Options dialog.

Note Normally, there will be no difference between jobs run locally and jobs run on a
remote server. However, when you, for instance, use scripting to list files etc., spooling a
job on a remote server may produce different results, as the remote server is a different
machine and might have different local files.

See the Warnings and the Log Window-Pane sections for a description of the latter.

1168
 12.3 Production Window Menu

12.3 Production Window Menu

At the top of the Production window there are the following menus:

Production

Window

Help

The options that are listed in each of these are described below.

12.3.1 Production Menu

Open Workflow Opens a standard Open dialog for you to select a file to run.

Primarily this is for loading workflow (WFD) files so that they can be produced, but also
JOB files and native files are supported.

Tip Alternatively, you can also drag and drop supported files to the Production environ-
ment in order to load them.

Note You cannot open a WFD file, which was previously loaded using the Open
Workflow option in Workflow window and unloaded using the Unload button in the
Main Production window. To open such a workflow again, use the Open Workflow option
in Workflow window.

Compress or Send to Mail Recipient Opens the Compress or Send to Mail Recipient dialog
where you can select files that will be packed into a ZIP file together with the currently
opened WFD file (with all external files included). The ZIP file can be saved or sent by email.

Add *.cfg file If checked, the CFG file containing the user settings of the application is
added to the ZIP file.

Add *.config file If checked, the configuration file is added to the ZIP file.

Add screenshot If checked, a screenshot of the current Inspire Designer window in

PNG format is added to the ZIP file.

Add job config If checked, the JOB file is added to the ZIP file.

1169
12 Production

Save Opens the Save As dialog enabling you to determine the location, where the ZIP
file with the defined content will be saved.

Send to Mail Opens an email client window, from which you can send a message with
the ZIP file in the attachment.

Tip This dialog is accessible also from the Workflow and Proof windows. The check-box
Add job config is available only if this dialog is opened from the Proof or Production
window.

Connect Establishes a connection to an IPDS printing device.

This is only available for use with an IPDS device, if a connection type (not a spool file) has
been selected for the Driver Config.

Disconnect Disconnects any connected IPDS printing device.

Reset Driver Resets the driver for any connected IPDS device, i.e. closes the current connection
and tries to establish a new connection.

Start job Starts the print job, using the engine and driver that you have specified.

Run Multiple Data Enables you to use the current workflow for multiple data input files. If
selected, the Run Multiple Data dialog opens:

The input data file appears in the column with the same name as the respective data input
module. If the workflow contains multiple data inputs, multiple columns will display.

If there is no input data defined in the workflow, the Add Data Files dialog allowing selec-
tion of data files opens instead of the Run Multiple Data dialog. When confirmed by
clicking on the Open button, the selected files will appear in the data input column of
the Run Multiple Data dialog.

Create New Adds a new empty row in which you can browse for another data input
file to be used in the workflow.

Add Data Files Opens the Add Data Files dialog that enables selection of data files
to be used in the workflow. If multiple data files are selected, a new row will be created
for each of them.

Note If the workflow contains multiple data inputs, this option can be used for the
first data input only. If you wish to add data files to the other data inputs, you need
to use the 3 Dots icons.

Remove Removes the selected data input file.

1170
 12.3 Production Window Menu

In the Output file column it is possible to select the location and output type for each
input file.

Spool file names can be created automatically using substitution characters. These enable
you, for instance, to have split files named in the same convention without having to set
it manually for each file. A file name can contain a combination of substitution characters,
e.g. %n%s%j.pdf.

For a list of the available characters, see the separate section Substitution Characters.

Note Clicking on the OK button starts the production immediately.

Hide Production Closes the Production environment.

Run Proof Runs Proof of the workflow.

Load production configuration Loads the selected Production configuration (i.e. engine
and driver configuration) that was previously saved as JOB file.

Note When loading a configuration saved in the Main Production window (i.e. a single
job Production config), all settings are set according to it, but no WFD file is loaded. The
WFD file has to be loaded separately either using the Open Workflow option or by the
Open button in the Main Production Window.

When loading a Production Configuration from the Multiple Jobs window, all WFDs (paths
to them) are loaded along with the Production settings. The Multiple Jobs windows is
open. See also the Multiple Jobs sub-tab description.

JOB files can also be dragged and dropped into the Production window. The Production
Configuration saved in the JOB file is then applied.

Merge Production Configuration Merges the selected JOB file with the one currently
opened. If there are items with the same name and different content, they are added with
"_merged" suffix.

Save Production Configuration Chooses a location for and saves the current production
configuration as a JOB file.

By default this is in XML format but you can also select the binary JOB file format (the
format used in PrintNet T prior to version 4.3) from the drop down menu in the Save as
type combo-box. See the JOB File Structure section for more information about the
structure of the file and the meaning of the individual elements and their attributes.

In the Save As dialog you have additional options:

Include all engine configs If checked, the configuration for all of the predefined engines,
other than the current one, will be saved.

Include current engine config If checked the current engine configuration will be
saved in the file. If this is not checked then the current engine config will not be in-
cluded even if the Include all engine configs option is checked.

Include all workflow module parameters If checked, all workflow module parameters
will be saved. If unchecked, only those parameters changed in Production will be
saved.

1171
12 Production

Example In Workflow and Layout there is presently a data input file with only 10
records. For production, however, you want to use a full version of this data input
file which contains 800 records but only the first 400 are required to be printed. Fi-
nally, you want to save this new configuration.

How it is done: In the Production Parameters window, select the data input file with
800 records and set the Start record to 1 and the End record to 400. If you now save
this production configuration (making sure that Include current engine config is
checked but not Include all engine configs and Include all workflow module
parameters), the JOB file will contain a path to the full data input file and information
about the record range.

Note Saving the Production Configuration from the Main Production window does not
save the path to the WFD file. This behavior allows to avoid a situation, where an invalid
path to the WFD disqualifies the whole JOB file.

Create Secure Job See Secure printing section.

Reset Production Configuration Resets the complete settings in the Production window
including engine, printer and driver configurations to the original default values (to the
state they were after installation).

Inspire Content Manager

Log in to ICM Opens the User Login dialog of Inspire Content Manager (VCS), which
asks for Username and Password in order to log into Inspire Content Manager (VCS).

Log out of ICM Logs the current user out of Inspire Content Manager (VCS).

Open ICM Explorer Launches the ICM Explorer window from where you can manage
version controlled documents.

Options Displays the Production Options dialog.

Load Default Job Config Enables you to load a default job configuration. If you have not
saved your own settings previously, the values will be the same as for newly opened Pro-
duction.

See the Main Production Window section for a description of the definable parameters
of a job configuration.

Save Default Job Config Enables you to save the current job configuration settings as the
default settings.

The Job Config consists of these fields: Begin, End, Copies, Debug, Preprocess, Print
to end, Collate, Run by record, Print group1-3, Parallel Processing, Offset, Scale
and Warnings.

See the Main Production Window section for a description of the definable parameters
of a job configuration.

Reset Job Config Sets the Job configuration back to the original default values, i.e. any
settings saved as a new default are not used.

1172
 12.3 Production Window Menu

The reset settings are not saved as the default job configuration when selecting Reset
Job Config. To save it as default job config, use the Save Default Job Config option.

In order to save it to a JOB file, you need to select the Save Production Configuration
option.

Select Workspace Opens the Select Workspace dialog, to select a specific workspace from
those that have been set-up via Manage Workspace.

Manage Workspace Opens the Manage Workspace dialog, to define default directories for
the different types of files that are used by Inspire Designer.

Exit Production Closes the Production environment.

12.3.2 Window Menu

Main Displays the Main Production window.

Jobs Displays the Jobs window.

Drivers Displays the Drivers window.

Multiple Jobs Displays the Multiple Jobs window.

Show Workflow Parameters Displays the Workflow Parameters window-pane within the
Main Production window.

Load/Save/Reset Environment See the How To Set System Defaults section for the descrip-
tion of the three options.

Customize Toolbars See the Customizable Toolbars section.

Select Language Lists all of the languages currently available for the user interface enabling
you to select the language that you wish to use. Language is preset to English.

12.3.3 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

Getting Started Opens the Getting Started guide, which offers a step-by-step introduction
to Inspire Designer.

Sheet Counters Opens the Sheet Counters dialog, which contains values if volume licensing
is used:

For volume license (with dongle) the remaining volume is shown.

For annual license the already produced volume is shown.

Save Report For annual license the volume report in XML format can be created.

1173
12 Production

About Displays the version number of Inspire Designer, copyright information and licensing
related information: IP address of the server where GMC License Manager is running (in
case of Net licensing), computer License IDs and dongle ID (in case a dongle is used for li-
censing). See the document Public Licensing Guide for details on licensing and guidelines
how this information can be used.

12.4 Engine Configuration

12.4.1 Engine Configuration Overview
Engine Configuration enables you to manage the engine that you have selected.

When an engine is selected in the Engine combo-box an engine configuration must be used.
The Engine Config area of the Production window allows the creation of an engine configur-
ation profile.

The first time that an engine is used you should create a new profile that suits your printing
requirements. These profiles will be saved in the Inspire Designer application and you can select
from them via the Profile combo-box .

Options Description

Edit Launches the Engine Config dialog for the engine selected in the Engine combo-box.

For details about any specific Engine Config dialog for each engine, refer to the sections
listed below:

AFP Engine Configuration

Adobe PostScript2 Engine Configuration

Adobe PostScript3 Engine Configuration

Creo VPS Engine Configuration

Desktop Printer Engine Configuration

Docx Engine Configuration

HP PPML Engine Configuration

HTML Engine Configuration

HTML Simple Engine Configuration

IJPDS Engine Configuration

IPDS Engine Configuration

Image Engine Configuration

1174
 12.4 Engine Configuration

Metacode Engine Configuration

Multi Engine Configuration

MIBF Engine Configuration

NexPress VDX Engine Configuration

PCL Engine Configuration

PDF Engine Configuration

PDF Fixed Resolution Engine Configuration

Inspire Native Engine Configuration

Podi PPML Engine Configuration

Raster Engine Configuration

SWF Engine Configuration

SX/AP Engine Configuration

Text Engine Configuration

VIPP Engine Configuration

View Launches the Engine Config dialog, in read only mode, for the engine selected.

Save Saves the profile.

Save as Saves the profile with a new name or location that you specify.

New Creates a new profile based on the current one.

Remove Deletes the current profile.

Note If you want to permanently change an existing profile, then you must save the changes.
If you have just changed the configuration, a dialog opens after clicking on OK in the config-
uration dialog. It asks you whether you would like to save the changes, click on Yes or No
accordingly.

12.4.2 Adobe PostScript2 Engine Configuration

In this section: See also:
PostScript Level 2 Engine Config Dialog Driver Config
PostScript Printer Configuration

The Adobe PostScript2 engine produces PostScript level 2 files according to Adobe specification.

You can further define the PostScript2 Engine Config, Driver Config and the Printer Config.

1175
12 Production

Selecting AdobePostScript2 in the Engine combo-box and clicking on the Edit button in the
Engine Config area displays the PostScript Level 2 Engine Config dialog.

12.4.2.1 PostScript Level 2 Engine Config Dialog

Available tabs are:

PS Output Option

Advanced Settings

PS Output Option Tab

Options Description

Optimized for output size Predefined parameters that have been chosen to generate an
output spool file which will be of a minimum size and use least memory.

Optimized for portability Predefined parameters that have been chosen to generate an
output spool file that is as portable as possible. "Portable" or "compatible" means that
it can be printed on a wide range of compatible printers and will consistently produce
identical or close to identical documents.

Advanced settings Unlocks the Advanced Settings tab for you to define the parameters for
yourself.

Add debug info into spool file When checked then information used for indicating possible
spooling issues is added into the spool file. This information can later be used for support
purposes.

Advanced Settings Tab

1176
 12.4 Engine Configuration

The Advanced Settings tab has the following sub-tabs:

DSC

Fonts

Images

Image Handling

PS Settings

PJL Commands

Engine

ICC Profile Setting

At any point you may use the Reset all values to combo-box to reset the values to the pre-
defined Optimized for size or Optimized for portability which are the same settings as can be
set via the PS Output Option tab.

DSC Tab

Using Document Structuring Conventions (DSC) not only helps assure that a document is device
independent, it allows PostScript language programs to communicate their document structure
and printing requirements to document managers in a way that does not affect the PostScript
language page description.

DSC conforming files also contain comments to indicate additional information such as struc-
turing.

1177
12 Production

Options Description

Document Structuring Conventions Type You can select from:

None Does not use any document structuring.

Basic Uses basic document structuring.

DSC version 3 Uses document structuring to DSC version 3 specifications. Recom-

mended as it allows many RIPs to handle the output.

End of Line You can select from:

Mac style (carriage return) Each end of line will consist of carriage return character
(h0D)

Unix style (line feed) Each end of line will consist of line feed character (h0A)

Windows style (carriage return and line feed) Each end of line will consist of line
feed + carriage return characters (h0A h0D)

Line length Here you can specify the max. length (in characters) of one line in the spool file.

Fonts Tab

Options Description

Encryption If required, you can select a type of encryption for the file:

ASCII charstring encryption Toggles on/off ASCII encryption. Checked by default.

Use eexec encryption Toggles on/off Eexec binary encryption.

ASCII eexec encryption Enabled only if the Use eexec encryption is checked. Toggles
on/off ASCII eexec encryption.

Text encodings You should select from either: Binary, Octal or AsciiHex type of encoding
for the output. A font's encryption determines the type of 'encoding' of the vector fonts
data to be passed to the printer.

1178
 12.4 Engine Configuration

Font encoding

Share font encoding If this option is checked, all used font encodings are stored as
external objects; the spool file contains only reference to them. Using this option de-
creases the spool file size.

Use encoding for fonts Checking this option enables further selection of font encoding
settings. Encoding fonts is important if you want to use Find Text options in viewers,
e.g. Adobe Acrobat.

Predefined encoding If selected, chose from the standard types of encoding in the
combo-box menu: Adobe Standard, ISOLatin1.

For PostScript 3 you can also select: Japan1, Japan2, CNS1, GB1, Korea1 for which
CID (character identifier) fonts are automatically used.

This makes the work with fonts that have a high number of glyphs more effective. If
the PS file contains a character which belongs to the selected encoding, a CID font
file is created as a resource of the generated PS file. Such characters are then
searchable in the PS file. In addition, such characters are written in UTF8 encoding in
the source PS file.

Other encoding If selected, chose an alternative codec for the font used in the layout
design from the complete range of codecs from the International Components for
Unicode.

See the separate section Text Encoding for more details.

Single or Double-byte Fonts Here you can determine a threshold value that specifies that
after a number (the value entered in the Maximal count of single-byte fonts text box)
of single-byte fonts, double-byte fonts will be created.

Tip It is possible to use the PostScript output downstream even if you use fonts from native
inputs, e.g. native PCL. The PostScript engine retains the Unicode information, so these fonts
can be recognized. This may be useful if you wish to re-use the PostScript output, e.g. using
the Text in Rect module or if you use the PostScript output to generate searchable PDF files.

1179
12 Production

Images Tab

Options Description

EPS/PDF rasterization resolution Defines the resolution used to render EPS and PDF images
by entering a DPI value in the combo-box.

Image buffer size Sets the size (in Bytes) of the buffer to be used for processing of images.

The larger the buffer, the more memory is made available for the processing.

Image Filters Sets filters for images for cases where the printer has problems processing
images in their original format. The filters will transform the image into the chosen coding.

By clicking on the AsciiHex or Ascii85 buttons (Flate is also available for PostScript3 En-
gine) you add a filter of that type to the queue (in the area on the left). More than one
filter can be used, the filter at the top of the list will be used first and so on down the list.

To remove a filter, select it from the list and click on the Remove button.

Note The optimized output settings found on the PS Output Options tab employ image
filters as follows:

Optimized for portability uses filter AsciiHex (+ Flate for the PostScript 3 engine).

For the PostScript 3 engine, Optimized for output size uses the Flate filter.

1180
 12.4 Engine Configuration

Custom Image Generation

Enhancement Generates images according to the settings made in this area of the tab
and the Image Handling tab where you can specify the way images will be generated.

You can select from the following enhancement protocols in the combo-box to the
right:

ScreenTOP Allows setting parameters for the ScreenTOP protocol.

Unlocks the Apply for combo-box.

Note ScreenTOP enhancements are controlled by a specific license.

If this specific type of license has not been purchased for Inspire Designer,
then this functionality will not work and will return an error if applied.

Xerox Allows setting parameters that are specific to Xerox devices.

If selected, images will be processed the same way as if they were processed
using the Backgrounds setting of Apply for, described below.

In particular, this option is intended to be used to create background ('back

form') images for use with the Xerox X490/980 device. An example of which
settings should be used to achieve this can be found in the section How to
Produce PS Hybrid Spool Files.

Unlike ScreenTOP enhancements, applying Xerox enhancements does not re-

quire an extra license and any VIPP viewer can be used.

Apply for Selects which images will be processed:

Variable parts All images will be processed as variable parts and generated
as external images. You can set the method of generating external images
using the other options below.

Backgrounds Objects placed right under the Page node in the Layout Tree
(Z-order = 1), can be generated as whole-page background images. There are
two types of such objects:

A single image kept out of overlays (by enabling the Don't place in
overlays option in the in the Position tab of Image Area's Layout
Properties) or

A group of consecutively listed static objects, that are allowed to be pro-

cessed as an overlay (by keeping the Don't place in overlays option
disabled); to ensure that all required static objects can be placed into one
overlay and then into Backgrounds, go to the Layout Edit menu and select
Optimize | Static Objects Order.

Objects processed as Backgrounds of pages can be generated externally in

the EPS format. Make sure the required settings for internal/external image
generating are inserted in the Image Handling Tab.

Example Place the image (and the area containing it, e.g. image area
number 1 in the screenshot) or a list of static objects processed as an

1181
12 Production

overlay (number 2 in the screenshot) that is required to be the 'back-

ground', so that it is the closest object to the Page node in the Layout
Tree of the workflow that you are printing. E.g.:

However, when this option is used with Merge overlays (below) then the Z-
order is not important because all overlays will be merged regardless of the
position of the objects that they were created from. The background image
is then generated from that single overlay.

Note The option Use overlays in the PS Settings tab also needs to be en-
abled to generate the selected overlays as Backgrounds.

Tip Typically, variable and background images, if generated externally as

EPS, are renamed after the main PS output file, marked with the ending "_v"
for "variable" or "_b" for "background", and a number, e.g. Leaflet_b2.eps.

To generate the background image externally and keep its original name and
size, additionally make sure to:

Enable the Keep out of overlay option in the Position tab of the image
area's properties.

Position the image:

For ScreenTOP in the bottom-left corner of the page (the distance

from either edge has to be below 0.5 pt), and

For Xerox precisely in the top-left corner of the page.

If the background is the first overlay, then only the Internal images setting
for the first handling group is applied.

Variable parts & Backgrounds The image/group of static objects that is placed
in the very first layer of a page (Z-order = 1) in a layout design will be processed
as a background of the page and the rest of the images will be processed as
variable parts. All images will be generated as external images.

This option is only available if ScreenTOP has been selected in the Enhancement
subsection.

Custom Group name Nominates the Custom Group for the images.

Custom groups are a feature of some printing devices. If the images have been placed
in Custom Groups via a printing device, you can further enter the name of that pre-

1182
 12.4 Engine Configuration

defined group here. As a result, that device will call the correct custom group, leading
to the directory in which to find images, when the spool file is being printed.

If used with the Xerox option selected for Enhancement, the name defined here is
also specified in the PS file(s) metadata as the folder name parameter.

External resources directory Determines the location where resources (e.g. background
images) will be saved if they are generated externally.

Using the Browse icon to select a directory. If no location is selected here, externally
generated resources will be saved to the same directory as the spool file.

If you wish to generate images externally, use the options available on the Image
Handling tab.

This field is active only after the Use check-box in the Custom Image Generating
area of this tab.

Merge overlays If checked, merges the overlays created by the workflow into a single
overlay.

This single overlay can then be spooled as a background image or as an inline overlay
in the PS, depending on the other image settings made here and on the Image
Handling tab.

Merge also images If checked, merges all images from the workflow into the same
single overlay created by Merge overlays.

This option is only active if Merge overlays has been checked.

Reuse generated background images If checked, references background images as

unique resources so that they can be reused throughout multiple jobs.

The generated EPS images are given a unique hash code as a file name (e.g.
011F50044893C6D37C4ECB0AF1C22E5324E43FFF.eps) that allows many images
to be stored and retrieved whenever they are required by whatever job. Therefore,
more jobs can be run that use the same images and the image is simply retrieved in-
stead of having to be recreated.

Note It is recommended to avoid using diacritical marks and double-byte characters in

image file names.

Use original EPS images If checked, Inspire Designer does not process EPS images but treats
them as original EPS files.

Put transparent monochromatic images into fonts If checked, transparent monochro-

matic images are converted to fonts for faster processing.

Tip When printing black and white, it is recommended to turn on transparency in Layout
for all images and set them to black and white and then enable this option. This will help
the job run faster.

Use CCITT compression for monochromatic images If checked, monochromatic images

are compressed without loss using the CCITT compression, group 4. This option is available
if the Used cached images and Use overlays (on the PS Settings tab) options are un-
checked.

1183
12 Production

Use cached images If checked, images are loaded once and then stored for repeated use
throughout the job. Using this option makes printing faster, especially if variable images
are being used, but requires more printer memory.

Optimize non-tiled image fill styles If checked, any shape objects with fill styles that are
in the layout design of the workflow being printed, will be processed as images with
clipping paths.

This should provide noticeably faster spooling if many shapes have been used.

Suppress native loading of images Enables you to globally suppress native loading of images
set by selecting the Load natively check-box on the Advanced tab of the Image Layout
Properties dialog.

The advantages and disadvantages of native loading of images are summarized in the
Native Loading of Images section; see also the information on handling of PDF/EPS images,
which is part of the ICC Profiles section of this User Manual.

Convert PDF to vector EPS conforming to If checked, PDF objects will be converted to
vector EPS files.

You should further select the PostScript variant that they should conform to, either: Post-
Script level 2 or PostScript level 3.

Otherwise, they will be rasterized to EPS.

Image color space Select from the combo-box menu the color space method to be applied:

Take from Layout image Applies colors as they have been defined in the Layout
of the workflow, i.e. image colors are not converted.

Example On the Advanced tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions
such as CMYK will be converted to RGB at that point and then RGB will be
the colorspace used by this engine if Take from Layout image is selected here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

See the separate Color Spaces section for a description of color.

1184
 12.4 Engine Configuration

Image Handling Tab

The options on this tab are unlocked by selecting the Enhancement check-box in the Custom
Image Generation area on the Images tab.

Options Description

Handling Group Images can be grouped in handling groups that are set in Layout (the same
grouping that can be seen on the Dithering tab). There are 8 handling groups available.

Images Selects the way images will be generated. The available options are:

Place inline Generates images within the spool file.

Generate externally Generates images into a directory outside the spool file.

By default, it is the same directory where the spool file is saved but a different
target location can be set in the External resources directory field on the Images
Tab.

Select this option to generate images as pages' Backgrounds.

Do not generate Uses the images generated in a previous run of the job or ori-
ginal images stored at a defined location.

It is the default setting of the option.

You can use this option if you have previously run a job where you selected one
of the other image generating options (Place inline or Generate externally). The
images have already been processed and stored, therefore it is not necessary to
spend extra time on recreating them. Thus, using the Do not generate option for
a subsequent job run can reduce spooling time.

Alternatively, you can select this option if you are spooling a job using original im-
ages (formats supported by the printer) which are stored at a defined location.
Since the printer can load the images from their location, recreating the images is
no longer necessary.

For example, you may select this option if you are using a TIF image stored on a
network shared drive in your Layout and your printer RIP supports TIF files.

Internal images Selects whether internal images will be generated within the spool file or
externally.

1185
12 Production

The term "internal images" refers to images imported to Layout using the Load Natively
option, e.g. 3D charts.

The two available options (Place inline and Generate externally) are identical to those de-
scribed in the Images section above, Place inline being the default setting.

Select Generate externally to generate a group of static objects as pages' Backgrounds.

PS Settings Tab

Options Description

Spool File Compression Specifies the compression method for the spool file.

For the PostScript 3 engine, you can select here if Partial compression of the spool file is
needed in order to reduce the disk space required to store it.

Overlays

Use overlays If checked, static objects (static text, images, flow areas etc.) will be loaded
as overlays.

Tip If you use this option together with the option Load natively in Layout, the
output PS file may not be handled correctly by Acrobat Distiller. You can use Ghost
Script software as an alternative way to display the file.

Define forms as resources If checked, any defined 'forms' (Xerox term for overlays)
will be processed to the spool file as resources.

Maximum size of overlay If a value is entered in the edit-box, then overlays will be
split if their size exceeds that value.

Colors Checking Use separation color spaces and DeviceN Colors employs the separation
colors, that have been defined in Layout, as color identifiers in the output. This allows
printers that are coordinated with the Device N or Separation color system to recognize
them.

Checking Append ICC profile to images ensures that any ICC color definition will remain
with a image as it is processed.

1186
 12.4 Engine Configuration

See the separate section ICC Profiles.

PJL Commands Tab

Checking the Include PJL command check box will allow you to enter PJL (Hewlett-Packards
Printer Job Language) commands into the text fields for the beginning and end of a job file
respectively. This can be useful when you are running a printer that supports some finishing
operations such as stitching, stapling etc.

Substitution characters are available for variable data that will be returned by the workflow
being processed. For a list of the available characters, see the separate section Substitution
Characters.

Engine Tab

Options Description

Zip all files generated into same directory as spool If checked, all associated files that
are in the same directory as the spool file will be compressed into a ZIP file.

Compress temporary files If checked, temporary files created during spooling are compressed
to reduce disk space usage.

Page extent

Maximum page length Your printing device will have a preset maximum page length.
By entering that maximum page length here the spooling of any larger pages will be
prevented.

1187
12 Production

The measurement units can be changed by right-clicking on the symbol.

Resize barcodes See the separate Resize Barcodes section.

ICC Profile Setting Tab

See the separate ICC Profile Setting section.

12.4.3 Adobe PostScript3 Engine Configuration

See also:
PostScript Level 2 Engine Config Dialog

The Adobe PostScript3 engine produces PostScript level 3 files according to Adobe specification.

You can further define the PostScript3 Engine Config, Driver Config and the Printer Config.

Selecting AdobePostScript3 in the Engine combo-box and clicking on the Edit button in the
Engine Config area displays the PostScript 3 Engine Config dialog.

The options for the PostScript 3 Engine Config dialog are also available on the PostScript 2
Engine Config dialog. See that section for the option descriptions.

12.4.4 AFP Engine Configuration

In this section: See also:
AFP Engine Config Dialog AFP Printer Config
Assign AFP Color to Index Dialog Driver Config
Assign AFP Font Shortcuts Dialog AFP Device Profiles
AFP Engine Command Line Parameters

The AFP engine communicates print jobs via a spool file that is written in AFP data stream
format.

You can further define the AFP Engine Config and the Driver Config.

Selecting AFP in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the AFP Engine Config dialog.

12.4.4.1 AFP Engine Config Dialog

Available tabs are:

General

Indexing

1188
 12.4 Engine Configuration

Miscellaneous

Resources

Text

Advanced

Dithering

Images

Image Handling

Color Management

General Tab

Options Description

Printer resolution Select one of the predefined values from the combo-box or enter other
resolution value in which the spool file should be generated. The predefined options are:
240, 300, 360, 480, 600, 720, 1200 and 360x720 DPI. You can enter any value between
72 and 9600 DPI.

Note The 240 and 300 DPI are recommended for bitmap (raster) fonts. Other resolution
settings may not be supported by the printer and the usage of outline fonts is recommen-
ded.

The 360x720 DPI resolution is not suitable for bitmap fonts. If used, the spooling ends
with an error.

Output colors Selects how the colors of the design will be printed:

Black and white Prints the colors by dithering black and white dots.

1189
12 Production

Further select dithering patterns on the Dithering tab.

Spot color Prints the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can be
done via the Color dialog.

Dithered spot color Prints the colors by dithering spot colors or black and white
dots.

Dithered spot colors should be assigned to each of the colors in the workflow, this
can be done via the Color dialog. Colored objects that use colors that are not as-
signed as dithered spot colors are dithered using black and white dots. Further
select dithering patterns on the Dithering tab.

Simple color Prints colors in the selected color space (selected in the Use combo-
box of the Color dialog of the workflow) except for images which are dithered in
black and white dots.

This selection is intended for black and white printers which support full process
colors (CMYK, RGB, Lab) for text and vector graphics. The AFP file is in color, but
it is still simple enough to be processed on Black and White printers.

Further define Color space for text and graphic and a dithering pattern for the
images on the Dithering tab.

Full color Prints the colors in the color space selected in the Use combo-box of
the Color dialog of the workflow.

Dithered colorants Prints the colors by dithering colorants or in black and white.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are dithered using black and white dots. Further select dithering patterns
on the Dithering tab.

Indexed colorants Prints the colors using indexed colorants or in black and white.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are dithered using black and white dots. Further select dithering patterns
for the black and white on the Dithering tab.

For this setting it is necessary for the intended printer to support indexed CMRs
(Color Management Resources).

Full color + dithered colorants Prints the colors by dithering colorants or in the
selected color space.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are printed in the color space selected in the Use combo-box of the
Color dialog. Further select dithering patterns for the colorants on the Dithering
tab.

Full color + indexed colorants Prints the colors using indexed colorants or in the
selected color space.

1190
 12.4 Engine Configuration

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog of the workflow. Colored objects that use colors that
are not assigned as colorants are printed using the color space selected in the Use
combo-box of the Color dialog.

Your selection should reflect the actual colors that are assigned in the workflow that you
are printing.

Note Use of dithered color types will dramatically increase the spooling time of workflow.
It is recommended to consider using simple spot colors or full colors in order to optimize
a workflow and its production.

Assign AFP colors to index Selecting Spot color, Dithered spot color, Dithered colorants or
the Full color + dithered colorants option activates the Assign button, that opens the
Assign AFP Color to Index dialog. This dialog allows to map each of the AFP or Highlight
colors to the spot colors that have been defined in Layout.

Color space for text and graphic Selecting Full color or Simple color activates this combo-
box.

CMYK A device dependant standard (cyan, magenta, yellow, and black).

CIELab A device independent standard that is specified by three components:

luminance (L) and color values on a red-green axis (a*) and a blue-yellow axis (b*).

Take from Layout color Allows to retain the Layout color space in Production.
Colors defined in Layout in RGB/CMYK/CIELab color space are defined in the re-
spective color space in the AFP output, Layout HSB is converted into RGB in the
AFP file. Transparency in TIFF images is automatically supported.

Graphic support Selects the level of graphic support of the printer to be used. You can
choose from:

None Specifies that the printer does not support graphics. All graphic objects will
be printed as images.

Simple lines Specifies that the printer supports rectangular shapes. This option
is suitable for documents with only text underline or simple vertical/horizontal lines
as lines are drawn using the PTOCA rules.

Lines and rectangles Specifies that the printer supports rectangular shapes. Lines
are drawn using the GOCA rules (vector graphic).

Full Specifies that the printer supports all graphics. Lines and fills are printed
gradually.

Full with outlines Specifies that the printer supports all graphics. This is an effective
mode as lines and fills are drawn in one step.

However, if the output from the printer is not ideally suited to this, use the option
Full where incremental drawing will ensure a more accurate result.

1191
12 Production

Note Does not support Caps or Joins for lines, e.g. applied to lines, shapes or
border styles in Layout.

Full with outlines and Beziers Specifies that the printer supports all graphics. Lines
and fills are drawn in one step and curves are represented by points of a Bzier
curve to be rendered by the printer.

This is a more efficient processing method but depends on the ability of the printing
device to render curves. In cases where the Miter of line joins is greater than 10
(see for example the Content tab of Shapes in the Layout module of a workflow)
then the lines are rendered as shapes with fill styles.

White processing Selects whether the colors of text and images should be printed over any
background, or if the background should be cut out where any text or images are to be
printed.

See the separate White Processing section.

Compress black and white images (CCITT G4) Monochromatic images are compressed
without loss, when this option is checked, using CCITT 4 compression.

Use cut operations uncompressed (IM1) If set, IM1 image commands are used for the
white processing of overlapped images.

Full color image format Select the desired format for the jobs color images from the combo-
box menu. The options are:

uncompressed (FS45) Used only when other settings do not result in the desired
output; generates unnecessarily large files.

JPEG (FS45, half resolution) Suitable for photos; the AFP file is smaller, but the
quality is worse.

JPEG (FS45, full resolution) Suitable for photos; the AFP file is larger, the quality
is better but not all printers support this setting.

TIFF LZW (FS45) Suitable for images containing fine shapes and/or text (e.g., logos);
default setting.

Only active if Full color has been selected in Output colors.

Grayscale image support Ensures that no dithering will be performed later in the process.

Check the box to activate the two combo-boxes that set grayscale parameters. This cannot
be done if Full Color has been selected in Output colors.

From the combo-box menu select either No compression or JPEG compression for grayscale
images if you require compression to speed up processing.

Note If the Grayscale image support feature is enabled, transparency is not supported.

Convert to grayscale When set to 16M color images, PDF, EPS, any full color images and
EPS and PDF images will be converted into grayscale. Palette based and monochromatic
images are left intact.

1192
 12.4 Engine Configuration

When set to All images except monochromatic then all images except those that are
already in the black and white/grayscale format images are converted to grayscale.

JPEG compression quality When JPEG has been selected as the image type in for Full color
image format or Grayscale image support, you can further set the subsequent image
quality. 100 (%) is the highest quality and produces the largest output (the image as stored
in Layout is uncompressed and loses no quality), 1 is the lowest quality and produces the
smallest output size.

The difference in size and quality between 1 and 100% is significant and will affect
spooling speed considerably.

Assign AFP Color to Index Dialog

This dialog opens when the Spot color, Dithered spot color, Dithered colorants or the Full color
+ dithered colorants option is selected in the Output colors combo-box, and after clicking on
the Assign button. Its first column differs slightly depending on the Output colors option
selected.

Each (spot) color listed in the Spot Color/ Color Name column, has a row of possible assign-
ments.

Assigning spot colors is effectively making a link between the colors of your design and color
names that the printer recognizes. AFP printers most often use the AFP Color naming system
but a Highlight Color Index exists as an alternative as some printers do not support AFP Colors.

For each Spot Color defined in the workflow to be printed select an AFP Color or Highlight
Index in the corresponding cell in its row.

Tip It is possible to assign a MICR (Magnetic Ink Character Recognition) toner to a spot color
or colorant. MICR toner can be used for printing of any fonts, but make sure you select a font
readable for the intended reader(s).

However, MICR colors can be used for text only. If you try to use a MICR toner for images or
graphics, the MICR color will be replaced with spot color 0 and a production warning will be
issued.

If the MICR font comes from the input AFP file, you have to use the original font, i.e. check
the following options on the Text tab: Use original AFP fonts and Include original font
resource files into AFP. The text that should be printed using MICR toner is not typically
placed in overlay, but if not sure, uncheck the option Merge static objects into overlay on
the Resource tab.

1193
12 Production

For natively imported AFP files you can set the color and colorant for MICR font in the Options
dialog. Then use the name of the colorant as Color name, i.e. rename a newly added color
to the colorant name, and assign the MICR AFP Color to it.

Example A shade of yellow has been defined in Layout as Spot Color 2 and, the AFP
printer that will be used, has a Yellow toner correctly placed as its Yellow AFP color.

Simply select Yellow in the AFP Color column of Spot Color number 2.

If you are using the Highlight Indexes instead, then the AFP Color definition is ignored, but you
can use the colors available in this cell to simply label the highlight color with a color name
that is similar to the actual color that it refers to. For example, a pink color in Layout is assigned
to Spot Color 1 and Highlight Color 5 is a shade of pink toner on the printer. In this case, we
enter 5 in the Highlight Color cell and label it as Pink/Magenta in the AFP color cell.

When using Highlight Colors, you can further define Highlight Coverage and Highlight
Shading:

Highlight Coverage (%) corresponds to the amount of toner that will be used for
that color.

Example 100% would give a full and thickly layered color (high quality print)
and 0% would be no color used.

Highlight Shading (%) designates an amount of black toner that should be added to
the color in order to print a darker shade.

Example 0% adds no black and the color is the pure color tone assigned at the
printer head; 100% would result in black being printed.

Tip It is recommended to have spot color 0 as black. The spot color 0 is automatically used
for halftoning.

1194
 12.4 Engine Configuration

Indexing Tab

Options Description

Index Pages using TLE The options in this area relate to indexing using Tagged Logical
Element commands.

Index pages using TLE When checked, all of the fields related to TLE indexing are ac-
tivated so that new index items can be added to the list by clicking on the Create
New icon .

The purpose here is to add indexes using the values returned by sheet names. Since
one sheet name may return many different values, each assigned index is categorized
using Index Names.

Within an AFP output, each sheet has a name and a number. The number is simply
the page number but the name can be a group of pages that relate to each other by
some common content. It is assigned to the sheet name which can, for example,
represent a group of pages that relate to the same record that has been read from
a data file.

For each index item, sheet names should first be defined in Layout for each of the
workflows to be printed. The sheet name's index number should then be nominated
in the Sheet Name Index column and the desired Index Name should be typed in
that column.

For an example, go to the separate section How to Assign TLE Indexes.

1195
12 Production

Note The first assigned index becomes a master index pages will be organized
into page groups according to the variable assigned.

Remember that during pre-processing sheet names set for the Pages node are evalu-
ated before the sheet names from the individual pages. Therefore, if the same sheet
name is assigned in two places it will be the last one processed that is used for the
TLE, e.g. if Sheet Name 3 is assigned on Pages, Page 1 and Page 4 then it will be the
variable that is assigned to Sheet Name 3 on Page 4 that will be passed to TLE as the
Index Name.

TLE indexing can also be defined as part of a workflow (see AFP Device Profiles). Any
index definition saved as part of the workflow will override any settings that may be
defined here in production as part of the engine configuration.

Encoding for page indexes Select here the coding type for page indexes from the
drop-down menu EBCDIC (code page 500), ASCII (code page 819) or Other encoding.

Encoding If you select the Other encoding option, here you can choose the text encoding
to be used.

Replace unresolved characters with Type here a character that will be used for repla-
cing characters that cannot be encoded by the selected code page.

Medium Options This area enables invoking media options.

Reinvoke medium options with every page group Checking this option ensures
that media options are invoked at the beginning of every page group inserting an
IMM (invoke medium map) command before the page groups.

Consequently, every page group is independent for printing when they are split,
which may be useful for later page group retrieval from the archive.

Separate Object Files The options in this area enable creating ACIF compatible output.

Create separate resource, document and index object files When checked, then
an ACIF compatible output is created. This consists of three files: the first containing
all resources, a second containing pages and a third containing indexes to page groups
and optionally to every page (when the option Add page level entries to index
file has been checked).

Note This option creates individual output files that cannot be printed directly.
Some method of combination (software or manual concatenation of all three files in
the correct order (IDX + RES + AFP)) has to be used to get printable AFP.

Example Sample of a command line:

copy /b index.idx + index.res + index.afp output.afp

Resource file name Define here the name for the resource part of the AFP output.

You can use substitution characters, e.g. %n, %s, %a.

Index file name Define here the name for index part of the AFP output.

1196
 12.4 Engine Configuration

You can use substitution characters, e.g. %n, %s, %a.

Add page level entries to index file When checked, indexes to every page are added
to the index file.

If left unchecked, only the indexes to page groups are added to the index file.

Custom Index File

Create custom index file If checked the Edit Custom Index File button is activated
which, when clicked on, opens the Custom index-file configuration dialog.

Custom Index-File Configuration Dialog

The Custom index-file configuration dialog is for configuring a separate index file for your job.
This may be created in addition to an index configured using TLE (see option Index pages
using TLE above).

First create a new item, click on the Create New icon.

Each row represents an Index File item which will be an entry in the index file. Each of the items
will appear for each page of output in the IDX file that is created.

Options Description

Index-File Item Select here the type of item that you would like to index your file with. You
can select from the cells drop-down menu:

Sheet Name Index

AFP Variable

Fixed Text

Index-File Variable If Sheet Name Index has been selected, you can enter here a sheet name
index number that a defined variable has been assigned to in the Layout Properties Panel
for Pages in Layout for each of the workflows to be printed. That variable can be, for ex-
ample, a category field from the data input.

You can enter here the Sheet name index number that you would like to index your file
with.

1197
12 Production

If AFP Variable has been selected, you can choose from the following variables that are
created by the AFP output:

PageBeginOffset An offset in bytes from the beginning of the document (BDT)

to the beginning of page (BPG).

PageEndOffset An offset in bytes from the beginning of the document to the

position just after the end of page (EPG).

OutputFileName Current output file name.

The variable value is then used as an index item.

If Fixed Text is selected, you can enter here some text that will appear in the index file.
Each Fixed Text string will be inserted alongside each of the entries in the index.

Move Up / Move Down Moves the selected index file item up or down one position
at a time.

Create New Adds a new index file item.

Delete Removes the selected index file item.

Replace non-Latin1 characters with Specify here the character that will be used for replacing
any non-Latin1 characters that are found in the index file.

Index file items separator Specify here a suitable character for use as a separator in between
the index file items that will appear on one line in the index file.

By default there is a space character as a separator (it is entered in the edit box but not
visible).

Select index file path Specify here the path and location where the index file should be
saved.

The Browse icon will open a Save as dialog to help you select a directory.

1198
 12.4 Engine Configuration

Misc. Tab

Options Description

Page Name & Page Group Name

Take page name from sheet name If checked, pages are named according to the
sheet name which has its index number entered in this edit-box.

Sheet names for this purpose should be assigned via the Sheet Names tab for individual
pages in the Layout of the workflow. For naming pages it is usual to assign a single
constant value (of string data-type) for each page.

Page names are BPG/EPG in the AFP structure.

Only the first 8 characters are used as the page name, unless the Long name support
option is used.

Take page group name from sheet name If checked, page group names are named
according to the sheet name which has its index number entered in this edit-box.

Sheet names for this purpose should be assigned via the Sheet Names tab for the
whole Pages family in the Layout of the workflow. For naming groups it is usual to
assign variables that change their value with each new group.

Page group names are BNG/ENG in the AFP structure.

1199
12 Production

Only the first 8 characters are used as the page group name, unless the Long name
support option is used.

Long name support If checked, the page / page group name is written into another
(extended) AFP field that enables max. length of 250 characters.

Note The names are encoded in EBCDIC code page 500, so the sheet name should
contain only such unicode characters that can be encoded by that code page.

NOP Comments

Write NOP comments with sheet name data If checked, any sheet name value defined
in the Layout can be inserted into the AFP file as a NOP comment.

Sheet Name Index Enter here the index number of the sheet name, that has been
defined in Layout and will return a value that will be the NOP comment.

Each row allows a sheet name to be assigned an NOP location.

NOP Location Enables you to select where the NOP comment containing the sheet
name value will be placed. The options are:

Before every page Appears before the BeginPage command.

First command on the page Appears after the BeginPage command.

Last command on the page Appears before the EndPage command.

Before document Appears before the BeginDocument command.

After document Appears after the EndDocument command.

Move Up / Move Down Move the selected index file item up or down accordingly.

Create New Adds a new index file item.

Delete Removes the selected index file item.

NOP data encoding Select a codec here for the text that is used in the string variable
that is assigned to the NOP via the sheet name index.

See a separate chapter Text Encoding.

RSD Index

Folder Name taken from sheet name Values for the Folder Name index item will be
returned by the sheet name with the index number that is entered in the edit box
here.

Document Name taken from sheet name Values for the Document Name index item
will be returned by the sheet name with the index number that is entered in the edit
box here.

Working Date taken from sheet name Values for the Working Date index item will
be returned by the sheet name with the index number that is entered in the edit box
here.

1200
 12.4 Engine Configuration

Create XML summary file If checked, a summary of any job printed using this engine profile
is created as an XML file.

The summary will include the version number of Inspire Designer, the name of the processed
WFD file, the number of pages (and sheets etc.) and the size of the AFP file.

Enter a name and location for the XML file in the edit-box to the right of this option.
Substitution characters can be used to add variable information from the workflow into
the file name. The Browse icon opens an Open dialog to aid location of a suitable dir-
ectory for the file.

Resources Tab

The Resources tab sets the parameters for the resources of the print job which are to be loaded
once and stored for quick reference and access. This avoids having to repeatedly reload them
throughout the job.

Options Description

Resource Type The fields are:

FormDef (Form Definition) contains a media definition (simplex/duplex, used tray,

etc.) and one or more medium maps (media size definitions) as they have been
defined for each page in the Output module of the workflow.

1201
12 Production

If the Status for this resource is Not used, then medium maps can be defined in
a variable in the workflow and called on by this engine configuration profile via a
sheet name. The index number of the sheet name should then be entered in either
Take foreground resources from sheet name or Take background resources
from sheet name edit boxes (not both at the same time) that can be found further
down this tab. If this is not done, then the printing device will use its own settings
for form definition.

Overlays are used for static portions of pages and for variable images. Used only
when the option Use page segments only as (see the Advanced tab) is left un-
checked.

By selecting Both as the Status for this resource and then checking Reuse external
image resources, image resources will be cached at the location specified in the
Directory column for use when processing other workflows. Any new resources
from consecutive workflows, printed using this profile, will be saved once and will
not be included in the spool file, only referenced with the entered path.

Page segments are used, for similar purposes as overlays, to identify static portions
of pages.

Code pages are resources that specify raster or outline font encoding.

Raster fonts are bitmapped fonts. Every glyph is represented by a bitmap image.

Outline fonts are Adobe PostScript vector fonts that can be this way integrated
into the AFP file. Whether they can be processed is dependant upon the printer.

Coded fonts are only used in conjunction with MCF-1 (see the Advanced tab for
details) and they are meant only for some older printing systems. Inspire Designer
generates this resource only for raster fonts.

Object containers group objects in the AFP data stream that are not in AFP syntax.

They define both presented (e.g. TIF images, JPEG images) and not-presented items
(e.g. color-mapping tables, true-type fonts). This option is just for presented-object
containers such as those used for TIF images. The non-presented objects are dealt
with by options CMOCA resources and True Type fonts.

Note Due to the way of writing to the CDD structure field in object containers,
BTB and other AFP viewers might not display these objects.

CMOCA resources are tools for color management ensuring consistent output
independently of the environment/kind of the data stream.

True Type fonts are a kind of outline fonts. If the True Type fonts option in the
Text tab is enabled, then the input True Type fonts are kept in this format without
being converted into FOCA (Font Object Content Architecture).

1202
 12.4 Engine Configuration

Fonts that cannot be kept in their original format are converted into FOCA according
to the settings in the settings in the Text tab.

Status The drop-down menus of cells in this column contain options that relate to how the
resources will be used. You can select from:

Included The corresponding Resource type will be included in the spool file.

External The resources will be generated as separated files.

Both The resources will be included in the spool file and generated as separate
files.

Not used The resources will not be generated at all.

Directory When External resource type is selected in Status you can define in this column
the location that you would like the resource files to be saved to. The Browse icon
opens an explorer to help you search for a file location.

When no directory is specified the resource files are generated in the same directory as
the spool file.

Naming If External has been selected for Status, a naming method for the external resource
files can be selected from the combo-box menu here:

Continuous Numbers the resources for the current job continuing from the last
number already used for the resource files in the same directory.

The intention is that the previous resource files in the directory would be the re-
sources from a previous job and, therefore, this avoids overwriting resources from
previous jobs.

Numbered from 1 Numbers the resources for the current job starting from 1.

This will overwrite resources which are already in the directory with the same
number.

However, the following resource types do not have a combo-box menu:

FormDef has a default name that can be changed.

Code pages has fixed naming and cannot be changed.

Extension A file extension type can be defined here depending on the resource type and
the requirements of the printer. By default, no extension will be added except in the case
of Outline Fonts (OLN file extension).

External resources with RDW When checked, the AFP commands are wrapped into blocks
with Record Descriptor Word (RDW).

Reuse external image resources When checked, all external image resources are reused
in repetitive production runs.

This option can only be used for overlays and when Naming is set to Continuous.

Do not use this option, if overlays are generated to Inspire Content Manager (VCS), as
with each new version these overlays are rewritten.

1203
12 Production

Always generate all known resources When checked, ensures that all recognized resources
required for the workflow (WFD file) are listed in the spool file, even those that haven't
been used in the job.

Lowercase external resource names When checked, determines that the names of the
resources will be written in lowercase when generated.

This can be important to consider when generating resources as separate files, as it ensures
that the file name of the resource will be lowercase.

Use image name for AFP image resource If checked, determines that the names of the
resources will be composed directly from the names of the image files.

However, if any image name has more than eight characters then the image's name will
not be used and the standard naming will be applied for that image (including any settings
made in the Naming column).

Size optimization See the Size optimization description in the IJPDS Engine Configuration
section.

Only repeated images as resources If checked, "marked" images will be reused as resources
only if they appear several times. If an image comes just once, it will be placed directly on
the page. Only if it comes for a second time, it will be placed to overlay.

The images for which you want to apply this option must first be "marked" by either of
the following ways:

Select the image in Layout and click on the Keep out of overlay icon in the Layout
Properties panel of the image.

Select the image type in AFP Engine Configuration, Images tab. If your image can
be used in its original form thanks to settings on this tab, then the Only repated
images as resources option can be applied. See the Images tab description for
more information about the images to which the options on the tab can be applied.

Embed object containers in overlays If checked, embeds object containers in overlays.

If unchecked (default), object containers are created as independent resources and are
URL-linked or taken from overlays. Non-native objects are produced as IOCA.

Merge static objects into overlay If checked, all objects that do not contain variables will
be merged together into a single overlay.

If left unchecked, static objects (text, images) will be placed in separate overlays. For images,
leaving this option unchecked has the same impact as using the Place native image in
overlay check-box on the Image Layout Properties tab.

It is recommended to uncheck this option in case that a large design has been created in
Layout.

Note In case that the objects overlap and this option is unchecked, it is necessary to set
white processing carefully, as it is handled by the output engine settings. It is recommended
to set it to Auto, for which the only disadvantage can be slower speed.

1204
 12.4 Engine Configuration

Customer AFP Resources

Overlays and Page Segments

AFP overlays and page segments Enables you to determine how AFP overlays
and page segments should be handled. The options are:

Process AFP overlays and page segments is processed as any other image
format.

Include without processing Original resource data is included in AFP

and used.

Reference without processing Original resource data is external and

AFP only uses references to them.

Options Include or Reference without processing can be only used if the content
of original resource data is not a shape, has not been resized or rotated and is
variable. Basic rotation can be supported see the following option.

Basic rotation support If checked, options Include/Reference without processing

can be used for overlays and page segments with basic rotation (0, 90, 180 and
270 degrees).

This option can only be used if it is supported by the printer.

Include also all referenced resources If checked, all external resource data refer-
enced in overlays or page segments (e.g. fonts) will also be included in the spooled
AFP file. This option is available only when the Include without processing option
is selected in the AFP overlays and page segments combo-box above.

Take foreground resources from sheet name Here you can specify the index number
of a sheet name that will return the resources (page segments, overlays, medium
map) that will be printed last in the object Z-order.

Because they are last in the Z-order (printed in the foremost layer) these resources
may overprint variable information. Find information about the available commands
below.

Take background resources from sheet name Here you can specify the index number
of a sheet name which will return the resources that will be printed first in the object
Z-order.
In the two above options (Take ... resources from sheet name), OVERLAY, PSEG (page
segment) and MEDIUM_MAP commands should be assigned to the sheet name (usually
as a variable, see the example below) in the following format:

OVERLAY Name X Y This command takes any overlay resources with the same
name and places them on the position given by X and Y coordinates (in pixels).

PSEG Name X Y This command takes any page segment resources with the
same name and places them on the position given by X and Y coordinates (in
pixels).

MEDIUM_MAP Name Width Length This command takes medium resources

with the same name and uses them to define the media size.

1205
12 Production

Name can be a maximum of eight standard characters. Width and Length should
be entered as a numerical value in pixels. The FormDef resource's Status must also
be set to Not used otherwise the media size will be taking from settings in the
Output module of the workflow being printed.

Example There can be more commands in one variable of string data-type, as

shown in the screenshot below. In such a case each command has to be each on
separate line.

1206
 12.4 Engine Configuration

Text Tab

Options Description

Single-Byte AFP Fonts

Text encoding If checked, text encoding will be used for the files text.

Further select from the combo-box menu the codec that you require for your texts
language. A wide range of single-byte ASCII or EBCDIC codecs are already available.

ISO-8859-1 is standard and recommended for Latin (western) style text.

See a separate chapter Text Encoding.

User code page name Enters a name for the selected encoding, as an alternative to
the name already entered in the edit-box. Numbers, capital letters and the symbols
@, & and # are allowed. If other character is inserted, a warning is generated.

This code page name will aid identification of the codec when viewing the AFP spool
file that is produced.

Follow naming convention If checked, an 8-character font naming convention will

be used and the Assign Shortcuts button is activated.

Inspire Designer uses internally GCID naming convention for fonts. The string CHU
followed by the Unicode decimal representation is used, when an encoding is defined.
For glyphs not defined in an encoding, the string CPT is used, again followed by
eight digits. Those glyphs' names are used for that given job only.

1207
12 Production

Note For this option the permitted raster font size range fits between 1 and 36.9
pt. The limitation is a result of technical issues to do with the character coding that
is partially based on the IBM naming convention. There is no limitation for outline
(vector) fonts as their size is not a part of the font name.

Assign font shortcuts Opens the Assign AFP Font Shortcuts dialog.

Use outline fonts Only outline fonts will be used when this option is checked.

Outline fonts are Adobe PostScript vector fonts.

Double-Byte AFP Fonts The options here relate to double-byte fonts only and are not ne-
cessary if outline fonts are employed.

Use double-byte raster fonts Check this option if job, to be printed with this engine
configuration profile, contains double-byte fonts. Then, select a suitable codec from
the combo-box menu.

Shortcut Enter here a shortcut, of maximum two characters, to help identification of

the fonts when viewing the AFP file.

Assign font shortcuts Opens the Assign AFP Font Shortcuts dialog.

True Type fonts If selected, all input True Type fonts are kept as the True Type fonts without
being converted into the FOCA in the output AFP file. Use the True Type fonts option
in the Resources tab to determine, whether the True Type fonts are embedded, generated
externally or referenced by name only.

Keep glyphs positions within words Uncheck this box if you do not want character posi-
tions to be altered within the string of single words if realignment takes place. Positions
will only be altered in between words.

In order to have the AFP output DPI-independent and to provide kerning, there are often
small corrections of character positions required inside text flow.

When this option is checked, then these corrections are not applied inside words. This
results in the possibility to search for specific words in the file content in viewers. (There
are no inter-character moves within any word, so the individual words stay in whole.
However, when this option is checked, the positions of individual characters within the
words may not be precise.)

Do not use this option when you require precise character positioning.

It is also strongly recommended to switch off kerning when you use this option. It is better
to use the Use relative font metric option on the Advanced tab than this one.

Use fonts for Selects how glyphs are handled by fonts:

Any glyphs Sets that all glyphs will be written as fonts.

Any received glyph becomes a font, regardless of what it actually represents.

Therefore, no text is printed as an image except when it is static in an overlay.

Text codec controlled glyphs only Sets that only those glyphs that have been re-
cognized by the codec (selected in the Text encoding combo-box) and are mapped
to characters, should be printed in the correct font. All other glyphs will be printed
as an image.

1208
 12.4 Engine Configuration

If no text codec is selected, then all text is printed as an image.

Tip Use this option to generate AFP files for OnDemand and ensure that you
have the correct codec selected.

Use fonts for graphics If checked, black and white graphics are stored as individual font
characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering type
is used (for details on matrix dithering types see the Edit Dithering dialog section). It is
most useful with variable graphics (it works for overlays that are not merged as well, but
to less advantage) and this option was implemented to speed up the processing of 2D bar
charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create a
9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, depending
on the position of the rectangle, and the image content data would be just 32 bytes
with usually an additional overhead.

If None is selected for Graphic support on the General tab, any black or gray color rect-
angle is processed much faster with less memory use. If Simple lines or Lines and rectangles
are selected for Graphic support then the rectangle support of the printing device has
priority, so that pure black rectangles are printed using the printer function, but still gray
rectangles are printed using fonts. For all other settings of Graphic support, and for
colored graphics, it is better to leave this option unchecked and use the rectangle support
provided by the printing device.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Upload only used glyphs Checking this option ensures that only glyphs that will actually
be used to print will be uploaded.

Allow anamorphic scaling Available only if Use outline fonts is checked.

If checked, anamorphic scaling is enabled and only one font is added into AFP when
scaling (in one of the directions) is used in Layout. For this font the Follow naming con-
vention option can be used.

This option works for FOCA outline fonts (Use outline fonts must be checked) and True
Type fonts (True Type fonts must be checked additionally).

External AFP Fonts

Use original AFP fonts If checked, the original data of AFP fonts can be used in AFP
file.

The font file needs to be in currently accessible directory.

Note If the MICR font comes from the original AFP file, check this option to use
the original font and check also the Include original font resource files into AFP
option below. The text that should be printed using MICR toner is not typically placed
in overlay, but if not sure, uncheck the option Merge static objects into overlay
on the Resource tab.

1209
12 Production

Default code page The path to the AFP font code page should be entered here.

This code page then becomes valid for all AFP fonts used. If you want to have a dif-
ferent code page for each AFP font, set it in Fonts Layout Properties window.

Include original font resource files into AFP If checked, the files of any used AFP
fonts will be included as part of the AFP file as opposed to being just a referenced
resource.

If two or more fonts have the same name then the font file is checked to determine
whether they are actually the same font. If so, the font will only be included once. If
not, Inspire Designer tries to rename those fonts that have duplicate names. However,
if renaming is not possible an error will occur.

Use already generated font resources If enabled, it allows to reuse once generated
fonts for multiple jobs. Instead of generating the same fonts repeatedly, the application
searches through the directories where the generated fonts are saved which results
in reducing the spooling time.

For this option to become available, the following settings are necessary:

1. all used font resources set as external,

2. enabled Follow naming convention option for single-byte fonts

or

double byte-fonts selected, and

3. Upload only used glyphs option disabled.

Assign AFP Font Shortcuts Dialog

This dialog should be used to assign two-character shortcuts for all fonts that are used in jobs
that will be run using this engine configuration profile. The shortcuts will then be used as part
of the code page name. This will aid identification of the fonts when viewing the AFP spool
file that is produced.

Font Select from the fonts listed in the drop-down menu or click on a row to type in the
fonts names directly.

Shortcut Enter a shortcut of max. 2 characters for the font.

Load Fonts from Layout Loads all fonts used in Layout(s).

Move Up / Move Down Select the font above or below the currently selected one,
respectively.

1210
 12.4 Engine Configuration

Sort Sorts the fonts in the table to an alphabetical order.

Create New Adds a new font to the table.

Delete Deletes the selected font.

Advanced Tab

Options Description

Compatibilities

Old style of font use (MCF-1) Use this option on systems where newer mechanism of
mapping font on page does not work. This option cannot be used together with
outline fonts.

MCF structured field identifies any font used during printing. It has two formats and
this option switches between them: older (MCF-1) and newer (MCF-2) format.

Use relative font metric When not checked, Inspire Designer uses fixed metric fonts,
where all coordinates are in dots. When checked, all glyph coordinates are defined
relatively to the height of the font. Sometimes it is necessary to generate AFP files in
300 or 600DPI.

Note Relative metric is always used with outline fonts.

If the printer does not support fixed font metric, an error message may appear. In
such cases this option might be helpful.

1211
12 Production

Old FormDef format AFP recognizes two formats. When this option is checked, an
older format of the medium defining FormDef resource (Begin Form Environment
Group [BFG]) is generated.

Use IM1 image format If checked, IM1image format is used. This is for printers that
do not support IOCA format.

Note This option can only be used if the option Compress black and white images
on the General tab is unchecked.

Use page segments only as Inspire Designer uses overlay resources wherever possible.

If overlays are not supported by printer, use this option to force creating and using
page segments only. Further use the combo-box to select from:

Hard (mapped) Determines that page segments will be used on the page in
a pre-defined manner.

Soft (unmapped) Determines that page segments will only be used on a

page as they are read from the WFD file.

1440 DPI positioning Forces 1440 DPI for positioning of all objects. Required on older
systems where AFP cannot use printer native 300 or 600 DPI for positioning of objects.

Variable space character increment optimization Ensures optimization of the resulting

AFP file size by going through the text, finding the size of the most commonly used
space and then using this space.

If unchecked and no align option is used, the spaces are taken from the font used
for the text.

Resize Barcodes See the Resize Barcodes section.

Maximum page length Some printers will have a preset limit on page length. By entering
that maximum page length here the spooling of any larger pages will be prevented.

By default there is 577.85 mm set (X or Y page extent in the direction of the paper feed).
Check your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

Maximum AFP record length Allows to set the maximum AFP record length. You can either
select from the preset values, or enter a custom value in the edit-box. The custom value
range is from 8192 to 32752 characters.

Cut negative coordinates Enables to cut off objects with negative coordinates, usually
portions of images outside the printing page, within the whole job. If unchecked, objects
with negative coordinates are cut off when processing each individual page.

If checked, the feature improves AFP engine performance when handling objects with
negative coordinates by avoiding repeated calculations, which might lead to increased
processing time for jobs with a higher amount of pages.

The option is checked by default.

Setup Verification ID Index / Setup Verification ID Value This is an AFP printer operatives
security code that is a part of the AFP spool file and is also known to the printer. It ensures

1212
 12.4 Engine Configuration

that the color set-up defined in Inspire Designer corresponds to that of the printer set-up.
The printer will not pass the job if the set-up codes do not match.

The security code is calculated from the values of the IDs entered in the right-hand column.
It is then inserted as a byte sequence into the spooled AFP file.

It is possible to enter up to 8000 IDs. The available value range is from -1 to 65535. The
value -1 means that the ID is not included in the code calculation.

Dithering Tab

The options on this tab that are not described below are described in the separate Dithering
section.

Options Description

Printer will apply LUT and halftone data If checked, activates the options LUT curve and
Generic halftone.

This means the method of calculation of any tone transfer (LUT) curve or halftone is
communicated to the printer in the manner that is specified by those options. And the
calculations are performed by the printing device.

If left unchecked, LUT curve calculation is applied by Inspire Designer using the other set-
tings here on this tab.

LUT curve Specifies which method the printing device will use to calculate the tone transfer
curve if the option Printer will apply LUT and halftone data has been checked. Select
from:

Upload Sends the calculation of any tone transfer (LUT) curve that has been
specified on this tab to the printer so that it will apply them.

The printer must support tone transfer CMR data. If the printer is not capable of
applying it, then a warning will be shown in the Log window-pane during pro-
cessing.

1213
12 Production

In addition, the correct printing device must be declared in the Device Settings
(for CMR) area on the Color Management tab. The curve specifications will then
be communicated in the correct manner for that device, so that it can calculate
the curve. If the device is not correct then the curve may still be calculated correctly,
if that device has the corresponding conversion table.

Standard, Highlight midtone, Accutone or Dark Determines that the LUT curve
will be applied according to the name preset by the printer.

The actual curve that will result is dependent on the printing device.

Generic halftone Specifies the halftone that the printer should apply. Select from:

Not set No halftone will be applied.

Any other halftone in the combo-box menu Sends a command that the printer
should apply that particular halftone.

The actual halftone that will result is dependent on the printing device.

Images Tab

Selecting the various image formats in this tab allows to include them in to the AFP file in their
original form. Skipping the processing of images saves the overall processing time, but has to
be selected according to the intended printer's capabilities.

Options Description

Image Data without Processing If the individual image formats here are checked, images
of that type can be directly included in the AFP file without being processed.

There are certain conditions for the image formats that have to be met for the option to
work:

JPEG For the option to work, rotation of the images only with the basic values (90, 180
and 270 degrees) is supported.

This option will not be applied to transparent JPEG images.

1214
 12.4 Engine Configuration

Note It is strongly recommended not to use progressive JPEG images. Instead use
baseline DCT encoded JPEG images. The option would be applied to JPEG images
with any compression, but the printer may not deal with the progressive type well.

TIFF For the option to work, rotation of the images only with the basic values (90, 180
and 270 degrees) is supported.

Multi-page TIFF images are supported.

IOCA For the option to apply, the IOCA images must have the same resolution as the
AFP. They cannot be resized or rotated in Layout.

PNG, EPS, PDF For the option to work, rotation of the images only with the basic values
(90, 180 and 270 degrees) is supported.

If PDF is checked, further select from:

Use original data No additional processing is applied by the engine.

This is the case regardless of the files size, each PDF is put in one object container
(even multi-page ones). However, if Load natively has been applied on the Ad-
vanced tab of the Image Layout Properties dialog in a workflow, then the PDF will
still be processed. In such cases, you can either uncheck Load natively there or
check Suppress native loading of images on this tab.

Convert to vector EPS The PDF files are converted into vector EPS.

Make separated one-page PDFs Multi-page PDF files that are to be included to
the AFP file are split into individual pages and placed each in a separate object
container.

Extract and reference image ICC profile If checked, the ICC profile of any JPG or TIFF image
will be treated as a resource, i.e. simply described once and referenced for other images
that use the same ICC profile.

Note For this option to work, the intended printer has to support CMOCA (Color Man-
agement Object Content Architecture).

Suppress native loading of images Suppresses any native loading of images that has set
by selecting the Load natively check-box on the Advanced tab of the Image Layout
Properties dialog in a workflow.

The advantages and disadvantages of native loading of images are summarized in the
Native Loading of Images section; see also the information on handling of PDF/EPS images,
which is part of the ICC Profiles section of this user manual.

Support transparent TIFF If enabled, transparency in TIFF images is supported. If disabled

(by default), transparent areas are displayed as opaque. This check-box is active only when
the Use original image data without processing for TIFF is selected at the top of the
tab.

1215
12 Production

Image Handling Tab

The Image Handling tab defines how different groups of images from the layout design will
be processed to the AFP spool file.

The settings on this tab supersede any image processing commands that have been set on the
General tab.

Options Description

Handling Group Groupings for the images are the handling groups that can be set in Layout
(the same grouping that can be seen on the Dithering tab). Eight groups in all.

You can further go on to define the below described parameters for each of the groups.

Image processing Choose either Standard or Enhanced from the drop-down menu in the
Option column.

Selecting Enhanced reveals further parameters to be set. These are described below.

Image compression Choose here the type of compression for the image handling group
from the drop-down menu in the Option column. Options are JPEG or TIFF LZW (lossless
compression, TIFF transparency supported).

Only definable if Enhanced has been chosen for Image processing.

Compression quality Enter the percentage of compression required for the image handling
group in the Option column of this row.

Only definable if JPEG has been chosen for Image compression.

Downsample color images to Determines that color images in the handling group will be
reduced to the DPI value selected from the drop-down menu in the Option column,
providing that they have larger DPIs.

1216
 12.4 Engine Configuration

Available sizes are: 240, 300, 480, 600 DPI or Not set. Alternatively, type in your own DPI
value.

By further entering a DPI value for the option If over in the dependent row below, you
can determine that only color images larger than that value will be reduced to the DPI set
for Downsample color images to. However, if Not set is selected here then all color
images will be reduced.

Only definable if Enhanced has been chosen for Image processing.

Downsample grayscale images to Determines that grayscale images in the handling group
will be reduced to the DPI value selected from the drop-down menu in the Option column,
providing that they have larger DPIs.

Available sizes are: 240, 300, 480, 600 DPI or Not set. Alternatively, type in your own DPI
value.

By further entering a DPI value for the option If over in the dependent row below, you
can determine that only grayscale images larger than that value will be reduced to the DPI
set for Downsample color images to. However, if Not set is selected here then all
grayscale images will be reduced.

Only definable if Enhanced has been chosen for Image processing.

Image preprocessing Determines whether images will be additionally listed as resources

(object containers) at the very start of the print job in order to be preprocessed. Select
from:

None No extra listing will occur.

Map in resource environment group Lists images in the resource environment

group at the beginning of the job so that the printing device will process them in
advance.

This allows for smoother progress of the print job on the device (with less clutching)
because the resources do not have to be processed the first time that they appear
on a page. However, this option is intended for use when the job contains larger
images (e.g. full-page background images) which take a long time to process and
is usually not recommended for regular overlay processing.

Map and preprocess Images are listed and preprocessed at the beginning of the
job to avoid repetitive downloading and processing of constant data.

The aim is to smoothen the progress of the print job on the device. Complex re-
sources are listed in an environment group and RIPed to the desired rotation/size/clip
window before the printing starts, using the PPO (Preprocess Presentation Object)
structured field.

As preprocessing is relevant for generating resources, this option is unavailable

when the Image placement is set to Page. See below.

Note This feature is targeted at full-color IPDS printers and print servers and may
not be supported by older devices.

1217
12 Production

Image placement Determines where repeatedly used images are generated.

Resource All repeatedly used images assigned to a given handling group are once
generated into resources and referenced to instead of being processed for each
occurrence in a document (default).

Page All images assigned to a given handling group are processed for each page
separately which means, that no overlays are created for them. For this option to
work enable the Do not place in overlay option in the Position Tab of Image
Area Layout Properties. Any images with that feature disabled (default) will be
generated into resources and a warning will be generated.

This option might be useful if the number of overlays per page that the intended
printer can handle is limited and some images, even though static and repeated,
need to be processed for each page.

Color Management

Options Description

ICC Profile Setting Sets the ICC profile to be used for defining the colors of the design, e.g.
for images.

See the separate ICC Profile Setting section for a description of the options here.

Attach ICC Profiles with rendering intents If checked, an ICC profile with rendering intents
are added to the AFP file. This helps the AFP file to be device independent.

1218
 12.4 Engine Configuration

The ACMA audit-type profile describes how the colors have been created, i.e. for which
intended printing device. Then, should the AFP file be printed on a device other than the
intended one, this is recognized and adjustments can be made.

Use colorant combinations for indexed colorants If checked, multiple colorant combina-
tions are supported for the purpose of DeviceN color spaces.

Multiple colorants can be set up for colors in the Layout of a workflow. If they exist in the
workflow being processed then this option should be checked. If left unchecked, the dif-
ferent colors that make up the multiple colorant will be printed on top of one another
and will need to be resolved using dithering techniques.

This option is only active if Indexed colorants has been chosen for Output colors on the
General tab of this dialog.

Device Settings (for CMR) The attributes here relate to the printing device that will be used
to print jobs using this engine config and are for use if CMR color selection will be used.

Manufacturer name Enters the manufacturer of the printing device.

Device type Enters which series of printing device, from that manufacturer, will be
used.

Device model Enters which model of printing device, in that series, will be used.

Map black color to OCA black If checked, CMYK, CIELab or RGB black color shades
used in the Layout will always be printed as pure OCA black, i.e. they will not be af-
fected by any color management settings (ICC profiles). The option is checked by
default.

12.4.5 Creo VPS Engine Configuration

In this section: See also:
Creo VPS Engine Config Dialog Driver Config
Adobe PostScript 2/3 and CreoVPS Printer
Configuration

The VPS (Variable Print Specification) engine produces VPS files according to Creo VPS version
1.5 specification.

You can further define the VPS Engine Config, Driver Config and the Printer Config.

Selecting CreoVPS in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the Creo VPS Engine Config dialog.

Tip A recommended routine when sending a VPS file to the printer is to delete the variable
resources at the end of the job - manually from the RIP.

This step prevents the RIP from having the memory "fragmented" after files clean-up and the
following job will be printed smoothly. The memory issue is caused by RIP behavior.

Note Avoid using diacritical marks and the underline character _ in the names of workflows
and/or images on RIPs.

1219
12 Production

12.4.5.1 Creo VPS Engine Config Dialog

Available tabs are:

VPS Output Option

Advanced Settings

DSC

Fonts

Images

Image Format Tab

VPS Settings

PJL Commands

Engine

ICC Profile Setting

VPS Output Option Tab

Options Description

Optimized for output size Determines that the output will be produced using predefined
parameters that have been chosen to generate an output spool file which will be of a
minimum size and use least memory.

Optimized for portability Determines that the output will be produced using predefined
parameters that have been chosen to generate an output spool file that is as portable as
possible.

"Portable" or "compatible" means that it can be printed on a wide range of compatible

printers and will consistently produce identical or close to identical documents.

Advanced settings Unlocks the Advanced Settings tab.

Add debug info into spool file If checked, adds information used for indicating possible
software issues into the spool file. This information can later be used for support purposes.

1220
 12.4 Engine Configuration

Advanced Settings Tab

The Advanced Settings tab has the following sub-tabs:

DSC

Fonts

Images

Image Format

VPS Settings

PJL Commands

Engine

ICC Profile Setting

Use the attributes that are listed on each page to define your own output requirements. At
any point you may use the Reset all values to combo-box to reset the values to the pre-defined
Optimized for size or Optimized for portability which are the same settings as can be set via
the VPS Output Option tab.

DSC Tab
Using Document Structuring Conventions (DSC) not only helps assure that a document is device
independent, it allows PostScript language programs to communicate their document structure
and printing requirements to document managers in a way that does not affect the PostScript
language page description.

DSC conforming files also contain comments to indicate additional information such as struc-
turing.

1221
12 Production

Options Description

Document structuring conventions type Select from:

None Does not use any document structuring.

Basic Uses basic document structuring.

DSC version 3 Uses document structuring to DSC version 3 specifications. Recom-

mended as it allows many RIPS to handle the output easier.

End of line (EOL) Select from:

Mac style (carriage return) Each end of line will consist of carriage return character
(h0D)

Unix style (line feed) Each end of line will consist of line feed character (h0A)

Windows style (carriage return and line feed) Each end of line will consist of line
feed + carriage return characters (h0A h0D)

Line length Specifies the max. length (in characters) of one line in the spool file.

Fonts Tab

Options Description

Encryption Selects a type of encryption for the file:

ASCII charstring encryption Toggles on ASCII encryption. Checked by default.

Use eexec encryption Toggles on Eexec binary encryption.

ASCII eexec encryption Toggles on ASCII eexec encryption.

Enabled only if the Use eexec encryption is checked.

Text Encodings Selects from either: Binary, Octal or AsciiHex type of encoding for the output.

1222
 12.4 Engine Configuration

A font's encryption determines the type of 'encoding' of the vector fonts data to be passed
to the printer.

Font Encoding

Share font encoding If checked, stores all used font encodings as an external object;
the spool file contains only reference to them. Using this option decreases the spool
file size.

Use encoding for fonts If checked, selects the type of codec to be used from the
combo-box menu; Adobe Standard or ISO Latin.

Encoding fonts, by checking this option, is important if you want to use Find Text
options in viewers, e.g. Adobe Acrobat.

Predefined encoding If selected, chose from the standard types of encoding in the
combo-box menu: Adobe Standard, ISOLatin1, Japan1, Japan2, CNS1, GB1, Korea1.

For Japan1, Japan2, CNS1, GB1, Korea1, CID (character identifier) fonts are automat-
ically used. This makes the work with fonts that have a high number of glyphs more
effective. If the CreoVPS file contains a character which belongs to the selected en-
coding, a CID font file is created as a resource of the generated CreoVPS file. Such
characters are then searchable in the CreoVPS file.

Other encoding If selected, chose an alternative codec for the font used in the layout
design from the complete range of codecs from the International Components for
Unicode.

See the separate section Text Encoding for more details.

Single or Double Byte Fonts Determines a threshold value that specifies that after so many
(the number entered in the Maximal count of single byte fonts text box) single-byte
fonts, double-byte fonts will be created.

1223
12 Production

Images Tab

Options Description

EPS / PDF Images Render Defines the resolution used to render EPS and PDF images by
entering a DPI value in the combo-box.

Image Filters Sets filters for images for cases where the printer has problems processing
images in their original format. The filters will transform the image into the chosen coding.

By clicking on the AsciiHex, Flate or Ascii85 buttons you add a filter of that type to the
queue (in the area on the left). More than one filter can be used, the filter at the top of
the list will be used first and so on down the list.

To remove a filter, select it from the list and click on the Remove button.

Note The optimized options on the VPS Output Options tab already use filters:

Optimized for portability - Flate + AsciiHex

Optimized for output size - Flate

Use cached images If checked, images are loaded at one time and stored for repeated use
throughout the job.

Note Using this option makes printing faster if many variable images are being used,
but requires more printer memory.

Put transparent monochromatic images into fonts If checked, transparent monochro-

matic images are converted to fonts for faster processing.

1224
 12.4 Engine Configuration

Tip When printing black and white, it is recommended to turn on transparency in Layout
for all images and set them to black and white and then enable this option. This will help
the job run faster.

Create Images Selects from one of the following image generation methods:

Insert images into spool file Includes images in the spool file.

This option should only be used when images are EPS format or PDF converted to
EPS which can be performed using the Image Type Conversion options on the
Image Format tab.

Generate images into directory same as for spool file Creates external images
stored in the same directory as the spool file.

Generate images into directory Creates external images stored in the directory
selected in the combo-box.

The Browse icon opens the Browse for Folder dialog to aid location of a suitable
directory.

Do not generate images (Use images created before) Uses the images that have
been generated in a previous run of the job or original images from their defined
location.

Example If you have previously run a job where you have selected one of
the other Generate images options, then the images will have already been
processed one time and stored, therefore it is not necessary to create them
again and it would take more time to do so.

So, using the Do not generate images option for subsequent job running re-
duces spooling time.

Alternatively, you should check this option if you are using an original image sup-
ported by printer and images do not need to be generated because they can be
processed as images of a supported type.

Note It is recommended to avoid using diacritical marks and double-byte characters in

image file names.

Image color space Selects from the combo-box menu a color space method to be applied:

Take from Layout image - Applies colors as they have been defined in the Layout
of the workflow, i.e. image colors are not converted.

Example On the Advanced Tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions

1225
12 Production

such as CMYK will be converted to RGB at that point and then RGB will be
the colorspace used by this engine if Take from Layout image is selected here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

See the separate Color Spaces section for a description of color.

Image file name pattern This option names created external images. Numbers will be added
to the pattern, e.g. VPSImage, VPSImage1, VPSImage2, etc. You can also use substitution
characters for variable image names.

Optimize non-tiled image fill styles If checked, any shape objects with fill styles that are
in the layout design of the workflow being printed, will be processed as images with
clipping paths.

This should provide noticeably faster spooling if many shapes have been used.

Image Format Tab

Options Description

Image Type Conversion

Images supported by printer Select here all of the image formats that are supported
by your printer.

If the additional option Use image source code is checked, the image is processed
without altering its coding, i.e. without rasterization.

1226
 12.4 Engine Configuration

If the PDF option is checked, you can further select:

Use image source code Processes any PDF images without altering their
coding.

Convert to vector EPS Converts any PDF images to vector EPS format.

Make separated one-page PDFs Creates one-page PDF files from any PDF
images.

If a PDF file used in the Layout of a workflow has more than one page, then
the file will be split, e.g. a six page PDF will be split into six PDF files.

Note If Insert images into spool file has been selected for Create Images on the
Images tab then it is only possible to select EPS and PDF with Convert to vector EPS
for this option.

Suppress native loading of images Enables you to globally suppress native loading
of images set by selecting the Load natively check-box on the Advanced tab of the
Image Layout Properties dialog.

The advantages and disadvantages of native loading of images are summarized in

the Native Loading of Images section; see also the information on handling of PDF/EPS
images, which is part of the ICC Profiles section of this User Manual.

Convert unsupported image types into Designates that unsupported image types
will be converted into the image type selected from the combo-box menu.

Select an image type that is supported by your printer.

JPG compression quality Determines the compression of JPEG images compared to

the original image.

Units are % of original image size, e.g. 100 is no compression.

1227
12 Production

VPS Settings Tab

Options Description

Spool File Compression Selects if Partial compression of the spool file is required to reduce
the disk space required to store it.

Overlays Loads static objects (images, flow areas etc.) as overlays if the Use Overlays check
box is checked.

Colors

Use separation color spaces and DeviceN Colors Checking this option employs the
separation colors, that have been defined in Layout, as color identifiers in the output.
This allows printers that are coordinated with the Device N or Separation color system
to recognize them.

Append ICC profile to images If checked, ensures that any ICC color definition will
remain with an image as it is processed.

Example If an image contains an embedded ICC profile and it is then trans-

formed using true ICC profiles (not any built-in CMYK profile) or not transformed
at all, the current ICC profile is written to the spool file together with the image
data which makes the image device-independent.

See the separate section ICC Profiles.

Booklet Splitting Defines booklets at intervals in the spool file.

1228
 12.4 Engine Configuration

Inserts the commands startbooklet and endbooklet. Select from the following in-
sertion frequencies:

One booklet for the whole job Inserts startbooklet at the beginning of the
spool file and endbooklet at the end.

One booklet each x sheets Counts sheets and defines a new booklet when a
certain number of sheets has been reached.

Enter the number of sheets in the edit-box to the right.

Note Extra consideration is required if the workflow uses duplexing. Odd numbers
entered here may split pairs of duplexed sheets into two different booklets.

Split by group Uses the grouping defined in the workflow and inserts start
booklet at the beginning of each group and endbooklet at the end of each
group.

By default this grouping is determined by the Records by option for Data Layout
Properties as being one group per data record.

Note Extra consideration is required if the workflow uses variable page selection
and duplexing. If the sheets have been duplexed in a way that would usually print
with two groups appearing on opposite sides of one medium, then this option
would split the groups so they would be on different media.

Cached VI (Variable Information) Elements Variable Information elements (e.g. images

or overlays) can be handled in different ways:

Do not generate cached VI elements VI elements are generated but not stored
permanently on RIP.

Generate with job name VI elements are generated and stored with job name.

Generate with user name VI elements are generated and stored with selected
name.

Example How to share images across additional jobs.

There are two jobs A and B using the same image img.eps. Job A contains this image,
job B does not. To share this image during printing, do the following:

1. For job A check the option Generate with user name and enter a user name
(e.g. shared_images). This way the image will be stored under the user name:
shared_images/img.eps.

2. For job B check the same option Generate with user name and use the same
user name as for job A. This will prompt the printer to look for the image
stored under that name and use it.

Note Image selection depends on file name only. If you use img.eps in both jobs
but later change the image in job B (and keep its original file name), the image gets
printed as in job A.

1229
12 Production

This only applies to the case when the image is shared as described in steps 1 and 2
above.

Generate job unique element names If checked, elements from different jobs with the
same name are distinguished when.

PJL Commands Tab

Checking the Include PJL command check box will allow you to enter PJL (Hewlett-Packards
Printer Job Language) commands into the text fields for the beginning and end of a job file
respectively. This can be useful when you are running a printer that supports some finishing
operations such as stitching, stapling etc.

Substitution characters are available for variable data that will be returned by the workflow
being processed. For a list of the available characters, see the separate section Substitution
Characters.

Engine Tab

Options Description

Compress temporary files If checked, temporary files created during spooling are compressed
to reduce disk space usage.

Page extent

Maximum page length Limits the size of the pages.

1230
 12.4 Engine Configuration

Most printers have a preset limitation on the length of page that they can print on.
By entering a maximum page length here the spooling of any larger pages will be
prevented.

By default there is 10000 mm set (page extent in the direction of the paper feed).
Check your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

Resize barcodes See the Resize Barcodes section.

ICC Profile Setting Tab

See the ICC Profile Setting section.

12.4.6 Desktop Printer Engine Configuration

In this section: See also:
Desktop Printer Engine Command Line TNO Writer
Parameters

The Desktop Printer engine allows a job to be printed via a locally connected printing device(s).

You can further define the Desktop Printer Engine Config and the Driver Config.

Selecting Desktop Printer (driver) in the Engine combo-box and clicking on the Edit button in
the Engine Config area displays the Desktop Printer Config dialog.

After setting the engine properties, select one of your own, locally installed, printing devices
in the Desktop printer combo-box in the Main Production window. You can further adjust
the properties of that selected printer by clicking the Edit button in Driver config area. The
properties dialog windows of the printer is launched by clicking the Properties button in the
dialog that opens.

12.4.6.1 Desktop Printer Engine Config Dialog

Options Description

DPI X Sets the horizontal resolution of the output.

DPI Y Sets the vertical resolution of the output.

1231
12 Production

Colorspace Defines if the printing will be in color or black and white.

Autofit The options are:

None The page is printed 1:1.

With borders The page will be adjusted to the printable area of the paper size
of the currently selected printer.

Simple The page will be adjusted to the "complete" area of the paper size of
the currently selected printer.

12.4.7 Docx Engine Configuration

In this section:
Docx Engine Config Dialog
Docx Restrictions for Overflowing Text

The Docx engine is for producing files in the DOCX format for MS Word 2007 and earlier ver-
sions of that software providing that the relevant compatibility update has been installed. The
produced DOCX file can be made up of text, text boxes and/or auto-shapes that correspond
to the flow areas and other objects used in the Layout of the workflow.

Note Parallel processing cannot be used for this engine.

You can further define the Docx Engine Config and the Driver Config.

Selecting Docx in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Docx Engine Config dialog.

12.4.7.1 Docx Engine Config Dialog

1232
 12.4 Engine Configuration

Options Description

Format Selects the production method according to how the DOCX file is required to be
formatted. The options are:

Overflowing text Calculates which is the largest flow area that has Flowing to
next page set and creates editable text content from the flow that is in that flow
area.

Flow areas without Flowing to next page set will become editable text boxes
and other objects on a page will be vectorized and appear as auto-shapes. See the
Overflowing Text example below for a comparison of a page design in Layout and
the resulting page of the DOCX file.

If using this method, some extra consideration about the design of the pages in
the Layout of the workflow is required. Most of the attributes of the largest flow
area and its flow are supported and will be maintained in the DOCX file, however
there are some attributes of objects that are not supported (see Docx Restrictions
for Overflowing Text). In general, the layout should be designed to contain only
one flow that overflows to a next page, i.e. the largest flow area with text in should
have Flowing to next page set but the text does not actually need to overflow.
The receiving pages, that the subsequent flow areas are on, do not need to contain
any objects other than that flow area because those other objects will not appear
in the DOCX file, unless Add objects to the last page is checked.

This is intended for use if there is one flow that should appear as the main text
content in the DOCX file and the text and its attributes must be editable. It is the
slowest processing method.

Text boxes Text content (i.e. flows placed in flow areas on a page in Layout) is
placed into small text boxes and other objects on the page are vectorized.

Unlike with Overflowing text, the text boxes are not related to the size of flow
areas, instead the text in the flows is split into boxes according to lines and spaces
in between text. Therefore, each line of text has its own text box and single sen-
tences are split if they continue over more than one line. If there is a large space
on one line (e.g. a tab space), a single line will also be split.

This is intended for use if minor adjustments to text may be required in the DOCX
file. It is a faster processing method than Overflowing text.

Vector Vectorizes all objects that are on the pages in the Layout of the workflow,
so that all content appears in the DOCX file as images fixed into place by auto-
shapes.

This is intended for use if no further editing of text is required in the DOCX file. It
is the fastest processing method.

Font embedding If checked, any TrueType fonts that have been used in the workflow will
be added to the DOCX file.

This is intended for use if non-standard fonts (not usually found in MS Word) have been
used in the layout design. This option is not available if Vector has been selected for
Format.

Add objects to the last page If checked, objects that are on the last page used for an
overflowing flow will also be included in the DOCX file.

1233
12 Production

Example If three sheets are required for an overflowing flow, then:

1. All objects on the first page that is used for the flow will appear in the docu-
ment.

2. Only the relevant flowing-to-next-page flow area will appear for the second
page used.

3. All objects on the third page that is used for the flow will appear in the doc-
ument.

The objects appear as described for the Format selection Overflowing text. This option is
only available if Overflowing text is selected, in which case it is checked by default.

Header/Footer support If checked, headers and footers will be created in the DOCX file if
they are specified in the design in Layout.

In the Layout Tree rename the flow area that you want to use as the header to Header
and rename any footer flow area to Footer. This name is not case-sensitive and there can
be additional characters after it, e.g. footerforAccount.

Additional Functionality

The even headers and footers (i.e. MS Word header option Different Odd & Even
Pages) can be created by naming flow areas EvenHeader and EvenFooter for those
headers/footers that will be on even pages.

If in the Layout the first page is used once and the following page is repeated (e.g.
page order: first page, second page, second page, second page, etc. until all variable
content is printed), then any flow area named Header on the first page becomes
a First Page Header in the DOCX file (i.e. the MS Word option Different First Page
is checked) and any Header on the second page becomes the normal header.

The system variables PageCounter and PagesPerRecord are converted into the MS
Word page numbering system Page X of Y (where PageCounter = X and PagesPer-
Record = Y) if they are used in those flow areas that are defined as either header
or footer.

The system variable PagesPerSubRecord is converted into the MS Word page

numbering system (where PagesPerSubRecord stands for a total number of pages
in a section) if it is used in those flow areas that are defined as either header or
footer.

Page numbering can be set to start from a number you choose by renaming the
header with PageCounter to "HEADER_PGNUMBERSTART*", where * is the chosen
number. For example, rename the header to "HEADER_PGNUMBERSTART10", to
start numbering from 10.

Merge with predefined template If checked, the output from the workflow will be com-
bined with an existing DOCX file in order to use the headers and footers that are defined
in that file.

Set a path to an existing DOCX file in the File edit-box.

1234
 12.4 Engine Configuration

Only the defined headers, footers and also margins from the existing DOCX file will be
kept in the newly created DOCX file. All other content will be determined by the workflow.

This option is only available if Overflowing text has been selected for Format and if
Header/Footer support is not checked.

This feature is not supported by Mac version of Inspire Designer.

Protect document If checked, modifying the flow content, for which the Lock for Docx option
has been activated, will not be allowed in the produced DOCX file.

For working with the locked content in the produced DOCX file use the standard MS Word
features.

Password Enter the password that is used in conjunction with the Protect document option
(see above). You can unlock the protected areas of the document in MS Word using this
password. Entering the password is optional; you can lock the flow content even without
typing it. However, it increases the security of the document.

Password is case sensitive.

Note

For both Overflowing text and Text boxes selections, Position tab options Skew,
Scale X, Scale Y, Flip X, Flip Y are not supported for flow areas. If any of
these are set, then the flow area and the flow it contains are vectorized.

The supported Rotation values for text-boxes are 0, 90 and 270. Text-boxes with
other rotation values applied will be vectorized (the text will not be editable).

The following impositioning modules are not supported: Simple N-Upper, Booklet Maker,
Sheet Duplexer, Sheet NS Splitter, Sheet Regrouper, Media Pattern Filter, Imposition
Script, Sheet Multiplexer, Sheet Content Modifier.

Tip Since v8.1, basic bullets and numbering available in Layout toolbar are now handled in
DOCX files in the same way as handled by MS Word (as bullets and numbering; originally they
were handled as text). For these features the following conversions are supported; Arabic to
Roman Number, Letter Indexing, Number to Spell.

1235
12 Production

Example Overflowing Text: A Comparison of Layout Design and Docx Results

The following objects are placed on a page in the Layout of a workflow:

The objects are:

1. Small flow area with a short flow inside. The flow area does not have Flowing
to next page set.

2. Large flow area with a long flow inside. The flow area has Flowing to next page
set which is indicated by the pink arrow.

3. Image area with an image inside.

Those objects become the following features on the page in the DOCX file when Over-
flowing text is selected for Format:

1236
 12.4 Engine Configuration

The features are:

1. Small text box.

2. Main text content of the file. It is directly on the page.

3. Auto-shape holding the vectorized image.

12.4.7.2 Docx Known Limitations for Overflowing Text

The following list describes unsupported features and restrictions for the Format selection
Overflowing text when Add objects to the last page is not checked:

Pages

The option Background color is defined by the first page in the page order, i.e.
all pages will have the background color of that first page.

Elements

Objects placed on elements are vectorized if the element is placed on a page. E.g.
if an element has two flow areas and an image area on it, all three objects will be
vectorized into separately placed auto-shapes but the element itself will not appear.

Objects placed on elements are vectorized and grouped if the element is nested
inside a flow. E.g. if an element has two flow areas and an image area on it, all
three objects will be vectorized into auto-shapes that are grouped together in a
group that has the same size as the original element.

Flow areas

If no flow area has Flowing to next page set, then all flow areas will appear as
text boxes in the DOCX file.

If Flowing to next page is set between flow areas on different pages, only the
largest flow area on the first page (with Flowing to next page set) is chosen to
be the main text content of the DOCX file.

Flow areas that are in any other flowing-to-next-page sequence, will be vectorized
so that only the text that fits in those flow areas on the first page of the sequence
is visible but not editable. I.e. all subsequent text in that flow will not appear in
the DOCX file.

Flow areas that are not in any flowing-to-next-page sequence will appear as text
boxes in the DOCX file.

Any consecutive flow area in the flowing-to-next-page sequence, to which the

main text content flows to (e.g. on the next page), must be the same size and in
the same position (relative to the page) as the first flow area in that sequence. If
not, the resulting main text content in the DOCX file will be sized and positioned
according to the last flow area in the overflow sequence.

Subsequent pages used in the flowing-to-next-page sequence will only contain

the main text content created from the flow area that is set as Flowing to next

1237
12 Production

page, i.e. all other flow areas (or other objects) on those pages will not be repres-
ented.

Overflowing set between flow areas on a single page (that which is indicated with
a blue arrow) is supported. Text boxes that correspond to the overflowing flow
areas are created in the DOCX file and the text within those boxes is linked in the
same way as the overflowing flows are in Layout, i.e. when the text in one text
box is edited all text boxes are adjusted accordingly.

This is also true even if Flowing to next page is set for other flow areas on a
page. But remember, if the overflow sequence continues to a flowing-to-next-page
sequence then all of the overflowing flow areas in that sequence will be vectorized.

Runaround options Type set as Top and Invert are not supported.

Flows

Objects nested inside flows (e.g. anchors, images and tables) are only supported
for the flow that is in the largest flow area that has Flowing to next page set,
i.e. the flow for the main text content.

Paragraph styles Unsupported attributes are:

Alignment selections Justify left, Justify center and Justify right become Justify
block.

MS Word can only have one spacing value for paragraphs, therefore only the largest
value set for either Space before or Space after is used. Any negative value (e.g.
-2.00) set for either of these options is read as 0.

Line spacing selections Additional, Exact from previous with adjust, Exact from
previous with adjust (old) and Exact from previous.

Line spacing value negative values (only positive values are supported).

The Advanced tab options Default text style, Reading order and Reversed.

The Border tab options Connect borders to Yes and With line gap to No.

The Orphan/Widow tab options Do not wrap, Orphan, Widow, Enable wrap
anywhere and Truncate to one line to Yes.

The option Flow break after is supported for Page and Column, but is unsupported
for Flow Area. See also the Paragraph Styles section.

The Tabs tab option Use outside tabs to Yes.

The Hyphenation tab options Left chars min, Right chars min and Max consec.
hyphens.

Text styles Unsupported attributes are:

The Super/Sub Script tab options Affect sup(b)script underline and Affect
sup(b)script strikethrough.

The Lines tab option Custom underline/strike.

1238
 12.4 Engine Configuration

The Border tab options Connect borders to No and With line gap to No.

Outline styles on text (Outline tab).

Border styles

Only the Standard selection is supported for Corner.

Only the Butt selection is supported for Cap.

Shadow is unsupported.

All margin and offset settings (Margins and Offsets tabs) are unsupported.

Fill styles

Type selections Gradient or Image are not supported, i.e. just plain colors are
supported.

Line styles

MS Word has its own selection of line styles and so line styles are approximated,
i.e. they will not be an exact match, only similar where possible. If no similar line
is found then a simple, unbroken line is used.

Tables

Spacing option Space top is converted into an empty paragraph above the table.
The empty text of the paragraph then has a font size with the same value as Space
top.

Spacing option Space bottom is not supported. Space left is not supported for
MS Word 2003.

Row sets Type selection Header and Footer is not compatible with MS Word tables. This
type of tables contain a first header, a header, a footer and a last footer:

The first header is not supported and the header of the table will contain both of
these rowsets together, e.g. if the first header has two rows and the header has
two rows, then the resulting table in MS word will have four rows in its header.

The footer is unsupported. Therefore, no footer will be placed at the bottom of

the page if the table overflows to another page.

The last footer is supported and will appear at the end of the table.

1239
12 Production

Anchors

The General option Must be inside.

Runaround option Type set as Top is not supported.

Anchors cannot be inserted into text-boxes.

Sections

Balancing is not supported because MS Word only fills columns left to right, which
is similar to the selection First column biggest.

Line width is not supported.

Fill will always be colored black in the DOCX file.

Border style is not supported.

Generally, impositioning modules used to change order of overflowed pages are not supported.

12.4.8 HP PPML Engine Configuration

In this section: See also:
HP PPML Engine Config Dialog Driver Config
PPML Printer Configuration
PPML Device Profiles
How to Configure HP PPML for Indigo
Devices

HP PPML engine creates output in a PPML stream format that also includes some additional
Page Description Language possibilities that are suitable for HP (Indigo) printers.

You can further define the HP PPML Engine Config, Driver Config and the Printer Config.

Selecting HP PPML in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the HP PPML Engine Config dialog.

Note Avoid using diacritical marks and the underline character "_" in the names of workflows
and/or images on RIPs.

12.4.8.1 HP PPML Engine Config Dialog

The options on the HP PPML Engine Config dialog can all be found on the Podi PPML Engine
Config dialog, see that section for their description. However, some extra options are found
on the PPML Settings 2 sub-tab.

1240
 12.4 Engine Configuration

PPML Settings 2 Tab

Options Description

Conformance

Graphic Art subset GA If checked, the make-up of the output and use of resources
is streamlined to the requirements of a graphic art workflow.

This means that there is less content to the spool file but only TIFF and JPG images
can be used and only Postscript and PDF content is supported. The output of the job
can contain any or all of these formats but the printing device must support all of
them.

Note Only supports PDF versions 1.3 and higher.

Not compatible with SVG. Use SVG is disabled if Graphic Art subset GA is
checked.

Internal Data Encoding

Use Base64 encoding on PS command If checked, employs Base64 encoding for the
PostScript commands in the spool file.

This option is checked by default and is recommended. If unchecked, more information

is added into the PPML spool file which is useful for debugging purposes but processing
becomes longer and more unstable.

Use Base64 encoding on SVG command If checked, then any SVG page description
language used in the output will also be encoded using Base64.

Page Description Language

Use SVG If checked, SVG (Scalable Vector Graphics) is used for page description.

SVG is faster for use with text that has been rotated through basic rotations (e.g. 0,
90, 180, 270 degrees), uses basic colors (red, blue) and plain (Latin 1) characters.

Note SVG speeds up processing for simple workflows, e.g. address printing. Gen-
erally though the speed of SVG in comparison to PS may differ up to 10% either way.
To use the SVG, both Inspire Designer and the RIP have to use the same fonts. Those

1241
12 Production

fonts have to be installed to the RIP manually, with the correct size. Any inconsistencies
result in wrong font substitution during printing.

Enlarge source bounding box Makes the bounding box bigger by the amount entered
in the edit-box and thus all the glyphs inside get printed.

If you use SVG and not all of the glyphs used fit in the bounding box (due to glyph
width differences between the RIP type and Inspire Designer) you can use this option.

The default value 5 points should be sufficient for most cases but it is recommended
to check the resulting output before a final print.

12.4.9 HTML Engine Configuration

In this section: See also:
HTML Engine Config Dialog HTML (Simple) Proof Dialog
Best Practices
HTML Engine Known Limitations
Known Third Party Limitations

The HTML engine communicates print jobs via a spool file that is written in XHTML format.
The HTML engine outputs generated via PrintNet T 6.2 and later comply with the XHTML 1.0
Transitional specification.

In difference to the HTML Simple engine, the HTML engine prints the complete content of
pages, not just the main flow. Therefore, the main flow setting necessary for the HTML Simple
engine, is not required here. The HTML engine uses absolute or table positioning of objects,
so the proof is very near to the actual output (see the HTML Engine Known Limitations section).

Note

Inspire Designer HTML output files are not supported by MS Internet Explorer 6 and
earlier versions.

Parallel processing cannot be used for this engine, if the option Rasterize flows is
unchecked for the Email generation mode.

Tip The HTML output supports alternative text for images and image fill styles. In cases these
images are not displayed in web browsers and email clients (e.g due to slow internet connection,
an error in the src attribute, switching off the images) the alternative text is displayed instead.

Selecting HTML in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the HTML Engine Config dialog.

12.4.9.1 HTML Engine Config Dialog

The available tabs are:

General

Resources

1242
 12.4 Engine Configuration

Images

Fonts

Catalogue

Text at Start

General Tab

Generation mode Generation mode controls allow to set the positioning used for the HTML
output.

Website Absolute positioning suitable for output files used as websites content
(default).

Email Table-based positioning suitable for output files used as email content.
Table-based positioning offers better fidelity to the intended design.

See also HTML Engine Known Limitations and Best Practices sections.

Center document If checked, the generated document is centrally aligned. If left unchecked,
the document is aligned left.

Document background color If background color other than the default white (defined
hexadecimally as #FFFFFF or by a CSS color as white) is required, enter the selected
HTML/CSS color name in the edit-box. For a customized color you can define the hexa-
decimal color value e.g. in the Color dialog. If the document's page fills the whole width
of the window, the background is not visible.

1243
12 Production

Page spacing [mm] Specifies vertical space between the edge of the browser and the first
page and between other pages. This can help making the web page nicer.

Thread count Specifies the number of threads that you want to use. Employing more threads
for multi-core processors can speed up the processing. See also the Best Practices section.

Text encoding Selects and edits the codec required for the text used in the Layout design.

See the separate section Text Encoding for more details. See also the Best Practices section.

Features available exclusively for each generation mode are described in the respective Website
and Email sections below.

Website Generation Mode

1244
 12.4 Engine Configuration

Options Description

Keep glyphs positions within words If checked, necessary corrections of glyph positions
in text flows are done between words. This way individual words are not split so that they
are searchable in viewers. Leave this option unchecked, if precise glyph positioning is re-
quired.

Draw gradient in background If checked and any color is defined in Document back-
ground color, gradient will be applied to the background color.

Email Generation Mode

Note In Outlook 2007, bullets are displayed as they were designed in Layout. In other email
clients, bullets may not be displayed at exact position in comparison to Layout but slightly
moved.

Options Description
Options common for both generation modes in this tab are described in the General Tab section
above.

Rasterize flows If selected (default), all flows are rasterized. Rasterization of the document
can be useful, when you are determined to keep the exact design of the document regard-
less of the fonts installed locally on the machine, where the document is viewed.

Deselect to allow text support (so that text is processed and can be searched through
and/or copied from the generated HTML files as text). For a description of other important
conditions necessary for text support see the Best Practices section.

1245
12 Production

Resources Tab

Options Description

Create external CSS If checked (default), a separate CSS (Cascading Style Sheet) file is
generated into the indicated Resources generation directory. External CSS files allow to
separate the documents' content from the design, which makes the design easier to edit
and more flexible. Also, excluding the CSS file from the HTML document reduces the latter's
size.

If left unchecked, the generated document(s) include inline CSS information.

Generate all resources If checked (default), all resources are generated into the directory
specified in the Resources directory edit-box below. 'All resources' includes also the ones
only referenced in the HTML file, e.g. images used in the workflow without any changes
and without any objects overlapping those images.

If unchecked, only the internal objects are generated. Internal objects are those, that have
been processed (not just copied) in the workflow or images that are created as rasterized
images when processing unsupported formats, e.g. shapes with gradient fill. Unchecking
this option speeds up the production and is useful when web-based objects are used.

Download web located embedded objects If checked, any embedded objects used in a
workflow will be downloaded to the Resource directory and referenced locally.

One intention is to be able to download embedded objects, to a location where you have
more control over them, in cases where it is not certain that the object will remain on the
internet for a required period. However, you should ensure that the downloaded content
will display as required because the original web located object might be subject to restric-
tions or require other components that could not be downloaded. For example, videos
from You Tube cannot be downloaded.

Leave unchecked to reference the embedded objects on the web.

Tip Embedded objects can be included in a design using Embedded Object Areas in the
Layout module.

Resource directory Determines the location of the folder where resources will be generated.

The default setting %n_files means that the folder will be named after the WFD file and
stored in the same location as the HTML file. To learn more about these substitution
characters see the dedicated section or the tool-tip in the application.

1246
 12.4 Engine Configuration

HTML path to resources Determines the path where a browser will look for resources used
in the XHTML file (typically a relative path to a server).

Use additional directory If checked, you can define a location for those resources that you
want to store in a location other than the one defined above. This may be for example,
for security reasons (storing sensitive data) or to avoid transferring large amounts of data
(i.e. embedded images) in HTML emails.

Checking this check-box enables fields for defining the location and the HTML path for
resources. See the descriptions directly above.

Tip The default values, for both the standard and the additional directories, are the
same. If using both, you need to give them different names. Otherwise there will only be
one resources directory.

Apply for Handling Groups Lists numbers of Handling Groups, that mark object(s)
that would be generated into the additional directory described right above.

Images Tab
Here you can set support for PNG, JPG and GIF images, all other images are created (or gener-
ated again) in the PNG format.

Options Description

Support PNG If checked, used PNG images are copied in the original form into the Resource
generation folder, specified in the Resources tab. To keep any changes applied to the PNG
images in Layout, disable the option.

Support JPG/GIF If checked, used JPG/GIF images are copied in their original format to the
Resource generation folder, specified in the Resources tab. Otherwise, they will be copied
as PNGs. To keep any changes applied to JPG/GIF images in Layout, disable the option.

Threshold value Determines how the HTML file will be divided:

1247
12 Production

Tip The higher value (slider to the right), the less number of parts that are referenced in
the HTML file which makes the HTML file smaller.

For Website Generation mode this rasterizes unsupported objects into an image
(see the Supported Features section description below).

Minimum threshold value (to the left) There will be as many images in the
output as there are unsupported objects. An image will be created for each
one of them.

Maximum threshold value (to the right) All unsupported objects will be put
together into a single image. If there are objects for which images with different
resolution are created (see the Other section description below), a separate
image is created for each group of objects with the same resolution.

This does not apply to barcodes; each barcode will always be placed into a
separate image.

For Email Generation mode this divides the HTML page (including its content)
into parts.

Minimum threshold value (to the left) The HTML page will be divided into
parts, each 50 px high. This results in a high number of parts of small size
which can increase the size of the HTML file. Minimum threshold value is
useful if you want to have smaller images no matter what the size of the res-
ulting HTML file.

Maximum threshold value (to the right) The HTML page will be divided into
as few parts as possible. The number of parts depends on the objects and
layout of the HTML file. Maximum threshold value is useful if you want to have
smaller resulting HTML file no matter what the size of the images.

To Layout objects generated as images via the HTML engine a hash function is applied.
Hashing allows to quickly retrieve once generated images when they are used repeatedly
in an output file. During production the images are referred to by unique fixed-length
hash keys generated for each image. Using this procedure significantly saves processing
time.

DPI of Rasterized Objects Enables you to set DPI for unsupported objects that are rasterized.
When a different DPI is set for an object, the current image gets replaced by a newly created
one.

For the Email generation mode the settings here can be applied only to images and bar-
codes.

Component Lists all rasterized components in the HTML output.

DPI Sets the resolution for the respective component. The default values are higher for
barcodes and gradients, because, for example, barcodes as images would hardly be
readable in the resolution of 96 DPI.

1248
 12.4 Engine Configuration

Fonts Tab

Options Description

Fonts Here you can decide which vector fonts will be supported (i.e. they will be kept as text
and searchable) and which will be rasterized in the final output file. For the Website mode,
it applies to single fonts, for the Email mode to flows containing these fonts.

Note

These settings are relevant only for True1 and TrueType fonts (vector fonts). All
other fonts are always rasterized.

Fonts that have encoding different from the setting in the Text encoding combo-
box (in the General tab) or fonts that are not available on the system where the
HTML file is displayed, will be replaced by a different font (depending on the
viewer). In such a case, the HTML file text will look different than intended. Raster-
ization of fonts keeps the text appearance in any viewer identical to what is dis-
played in Proof.

The tab is inactive for the Email generation mode selected in the General tab, when the
Rasterize flows check-box is enabled.

Select one of the following options:

All fonts All vector fonts will be supported in the output file (i.e. kept as text and
searchable).

Listed fonts Vector fonts defined in the list below will be supported in the output
file. For the Website mode, all other fonts will be rasterized. For the Email mode,
flows containing at least one of not listed (unsupported) fonts will be rasterized.

All except listed fonts Vector fonts not defined in the list below will be supported
in the output file. For the Website mode, the listed fonts will be rasterized. For the
Email mode, flows containing at least one of the listed (unsupported) fonts are
rasterized.

To add a new font to the list, use the Add New icon below the list. Press the <F2> key
to replace the default font name with another. You can enter just any part of its name
(e.g. "Times" is enough for Times New Roman).

To delete a font from the list, use the Delete icon below the list.

See the Best Practices for more information on text support.

1249
12 Production

Catalogue

This tab is available only if the Website mode is selected on the General tab.

Options Description

Insert content into catalogue frame If checked, the HTML output will be generated as a
catalogue, i.e. set of web pages that can be browsed using arrows and with thumbnails
(if set).

Template Select for which device the catalogue is intended, whether it will be browsed on
a standard or tablet PCs (Desktop predefined) or on mobile phones (Mobile device pre-
defined).

Desktop template is supported by Firefox 6.0, Opera 11.5, Internet Explorer 9.0 and Google
Chrome 13.0.

Mobile template is supported by Android and iPad platform with the following browsers:

Android: Android native browser, Firefox 6.0, Opera 11.10, Skyfire 4.0, Dolphin
HD 6.1

1250
 12.4 Engine Configuration

Note Known issue on Android: except for Firefox and Opera, swiping to
next/previous page does not work on tablet computers.

iPad: Safari

Tip To provide more details to single catalogue offers, pop-up dialogs can appear after
clicking on an area in a catalogue. This can be achieved by using HTML links.

Primary color Select a color that will be used for the title text, arrows and the line between
the catalogue and thumbnails.

Tip The appearance of a catalogue is also influenced by Document background color

and Draw gradient in background on the General tab.

Title Name the catalogue HTML file.

Note The browser tab/window with the opened catalogue HTML file is named according
to the value in Job name in the Production window.

Generate thumbnails If checked, the catalogue will contain thumbnails of single catalogue
pages. A thumbnail of the page which you are just previewing is grey.

Max. thumbnails in one row Enter the maximum number of thumbnails that will be dis-
played in one row below the catalogue.

Note In Proof, only the first thumbnail is always displayed.

Thumbnails placement Select how thumbnails will be ordered. In single row is intended
for desktop and tablet PCs and In multiple rows is intended for mobile phones.

Text at Start Tab

The Text in the Start tab is available when the Email generation mode is selected in the General
tab. It allows to insert some text that would be placed at the very top of the generated HTML
file(s). Enable the Add text to start of HTML check-box to activate the script panel.

The text inserted here may also be variable. Hover the mouse pointer over the script panel to
see a hint on the substitution characters.

The default string, completed with a link, allows to redirect the email addressee to the HTML
file saved elsewhere, in case the images in the message are not displayed properly by an email
client.

1251
12 Production

12.4.9.2 Best Practices

For both Website and Email modes:

The recommended units for fonts are pixels.

The recommended resolution set in Workflow Option dialog (the DPI for pixel units
option) is 96 DPI.

How To Ensure Text Processing

Note All HTML views are presented in this section the way they are displayed in an HTML
email message received through Outlook 2007.

The Email mode is used to generate HTML files suitable for sending via email and displaying
by email clients. By default text in HTML file is rasterized, however, it can be supported (i.e.
selected, copied and searchable) when all of the following conditions are met:

The Rasterize flows check-box in the General tab is disabled and all used fonts are
listed for support in the Fonts tab.

Flow areas intended for text support are completely within the page.

Example

Legend

1. Layout: text flow area within the page border; HTML: supported text

2. Layout: text flow area extending the page border; HTML: rasterized text

There are no overflows.

The text is not in sections.

The workflow is not processed parallelly.

The text is not closer than 1 px from the nearest (rectangular, standard corners, thin
line) border, with no overlaps.

1252
 12.4 Engine Configuration

Tip

When working with more fancy borders (e.g. thicker or with rounded corners), set
suitably big margins to keep the border far enough from the content.

Do not use offsets with positive values, as they push the borders towards the center
of the flow area.

The border type setting is set to Full area. Other types might cause flow area content
and border to overlap, which triggers rasterization.

Text background is monochromatic. Using a pattern or an image as background rasterizes

the text over it.

Also the default UTF-8 text encoding is strongly recommended.

12.4.9.3 HTML Engine Known Limitations

Tip Double-clicking on a warning in the Production log window-pane takes you exactly to
the spot, where the corresponding issue occurs. In Layout the according flow area is high-
lighted.

General

Barcodes are always generated as images.

Used fonts are not embedded and due to this fact, supported text could be displayed
differently from the Layout.

Flow areas with unsupported objects (e.g. scaled or rotated text, sections, etc.) are
rasterized and saved to the specified folder as PNG images.

Anchors are not supported.

Text with scale, rotation, skew or flip is rasterized and the quality of the final image
depends on the image resolution.

Email Generation Mode

Text in sections is not supported and is rasterized.

Text placed over a border, or within 1 pixel from it, is rasterized. In Proof/Production a
warning informs you about rasterized flow areas.

Flash type embedded objects (e.g. Embedded Object Areas with Object type: Flash)
are not supported, because most e-mail environments will not allow flash to run within
a mail.

1253
12 Production

12.4.9.4 Known Third Party Issues

Email Clients
HTML clickable maps (areas with a link to another URL address assigned) can be displayed
incorrectly in Outlook 2007 (in other email clients the issue does not occur).

If in Layout, in one flow area, there are two (or more) elements with URL paths through
image areas assigned, only the one processed first is displayed and works 100% correctly
in Outlook 2007. The clickable areas of the remaining elements are placed outside of
the assigned objects in a blank space or over other objects. The issue may additionally
interfere with the HTML document's background (if set).

Example
Both images are placed in elements, that are placed in one flow area.

Legend

1. The clickable area assigned to the first image works correctly.

2. The clickable area is shifted below the image that the URL path is assigned
to.

Workaround

Place elements, with the URL path assigned, into separate table cells or separate
flow areas. Then all of those objects display correctly and keep their functionality
in Outlook 2007, or

Make the image area, with the URL path assigned, exactly the same size as the
element box.

Some email clients (e.g. Outlook 2007) do not support background images in HTML
email content. To keep the intended design, any flow area overlapped by an object
drawable in the HTML output (in the Email mode) is automatically rasterized.

HTML files generated in the Website mode, are not suitable for emails as some email
clients might not display the content properly (e.g. MS Outlook 2007 does not support

1254
 12.4 Engine Configuration

absolute positioning). It is recommended to select the Email generation mode or use

the HTML Simple engine for generating files that are intended to be sent by email.

Some email clients do not support animated GIF images. This results in the following
behavior depending on the email client:

Outlook 2007-like such images are displayed as static (only the first slide of the
animation will be used).

Thunderbird-like such images are not displayed at all.

Web Browsers
MS Internet Explorer does not support CMYK images. The images are automatically
converted to RGB.

12.4.10 HTML Simple Engine Configuration

In this section: See also:
HTML Simple Engine Config Dialog How to Mark Script for HTML Simple
HTML Simple Output Known Limitations HTML (Simple) Proof Dialog

The HTML Simple engine communicates print jobs via a spool file that is written in HTML format.

The HTML Simple engine outputs generated via PrintNet T 6.2 and later comply with the HTML
4.1 Transitional specification.

A single flow must be selected as the Main flow in the properties of the Pages node. E.g.:

Only that main flow will be printed. All other objects on page will be ignored.

Tip As the HTML Simple engine does not use absolute positioning, the actual output can
look different from what you see in your Layout. Using Elements within the Main Flow offers
a partial workaround, as in elements it is possible to employ features otherwise not supported
in HTML Simple (see the HTML Simple Output Known Limitations below). However, if the
content of Elements is text, it is generated as a rasterized image. Any content outside the ele-
ments' boundaries will be cropped.

For reliable proofing of documents meant for HTML Simple engine, select the matching Proof
profile.

URL links are supported within elements as well as outside of them in the Main Flow.

1255
12 Production

Alternative text for images and image fill styles is also supported. In cases these images are not
displayed in web browsers and email clients (e.g. due to a slow internet connection, an error
in the src attribute, switching off the images) the alternative text is displayed instead.

Note Parallel processing cannot be used for this engine.

You can further define the HTML Simple Engine Config and the Driver Config.

Selecting HTML Simple in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the HTML Simple Engine Config dialog.

12.4.10.1 HTML Simple Engine Config Dialog

Options Description

General

Text encoding Selects and edits the codec required for the text used in the layout
design.

See the separate section Text Encoding for more details.

Create external CSS If checked, a separate CSS (Cascading Style Sheets) file is generated
along with the Simple HTML document(s). External CSS file allows to separate the docu-
ments' content from the presentation, which makes the presentation easier to edit and
more flexible.

If left unchecked (default), the generated document(s) include inline CSS information.

Adjust table widths to content If checked, the tables and columns are generated only as
wide as the content demands, so all the content with no empty space within columns is
displayed. The feature applies to tables that have width set to 100% in the Table Layout
Properties. If the table width is set to value different from 100%, enabling this check-box
takes no effect.

1256
 12.4 Engine Configuration

If left unchecked, tables fit to the full width of the displayed page.

Additionally, you can define the selected cells' inner margin (padding) by setting the
Margin values in the Border Layout Properties.

Images

Supported Image Types Select the format(s) supported by your printer.

Use original image If checked, the image is used without processing.

Set image resolution [DPI] Sets the output image resolution in DPI.

Convert unsupported image types into Unsupported image types will be converted
into the image type selected from the combo-box menu.

JPG compression quality Sets the compression quality.

Units are percent (%), where 1 has the lowest quality but allows the smallest file size
and 100 is high quality and large size. However, even the value 100 means image
processing will take place and a decrease in image quality may occur.

Generate images to If checked, then any images used in the design will be created in
the directory entered in the edit-box.

HTML path to images Determines the path to the actual directory that will be used for
keeping the image resources in relation to the produced HTML file.

Example When sending the HTML by e-mail this could be the address of a
server. Then, when the email is opened, the image is opened from that server.

To Layout objects generated as images via the HTML Simple engine a hash function is applied.
Hashing allows to quickly retrieve once generated images when they are used repeatedly in
an output file. During production the images are referred to by unique fixed-length hash keys
generated for each image. Using this procedure significantly saves processing time.

12.4.10.2 HTML Simple Output Known Limitations

Tip Double-clicking on a warning in the Production log window-pane takes you exactly to
the spot, where the corresponding issue occurs. In Layout the according flow area is high-
lighted.

Not all of the features of the design created in Layout are supported by the HTML Simple engine.
The features not supported by the HTML Simple engine are listed below.

Text styles

Font subfamily

Superscript

Subscript

Horizontal scale

1257
12 Production

Language

Kerning

Image fill style

Gradient fill style

Border style

Line fill style

Paragraph styles

Line spacing

Tables

Alignment

Line gap

Border styles

Cap

Corner

Join

Shadow

Margin for tables and flow areas. See also the description of the Adjust table widths
to content option.

Offset

Gradient fill style

Image line fill style

Gradient line fill style

Line styles

Dash style with more than two line gap values

Stripe style

Line ending

Note The page will have a certain width and boundless length.

1258
 12.4 Engine Configuration

Tip

Employing Elements in Layout allows to use the features otherwise unsupported in flow
areas. However, if the content of Elements is text, it is generated as a rasterized image.

If sheet names are used, define them on the start page.

When image fill styles are used, images are inserted into a table or cell without any
transformation (moving, scaling, rotating). To achieve the maximum possible fidelity
compared to the proof result, set the option Fill relative to cell in the Cell Properties
dialog to Yes and disable the Autofit option in the fill styles Layout Properties panel.

12.4.11 IJPDS
12.4.11.1 IJPDS Engine Configuration
In this section: See also:
IJPDS Engine Config Dialog IJPDS Page Side Configuration Dialog
IJPDS Printing System Components

The IJPDS engine produces spool file files to IJPDS (Ink Jet Printer Data Stream) specification.

You can further define the IJPDS Engine Config and the Driver Config.

There are additional options for IJPDS in the Main Production window that relate to the Engine
Configuration but are independent from the profile that is selected:

Options Description

Initial document number Selects where the IJPDS document numbering will start.

Example This can be useful if you have printed previous jobs that belong to the
same series of documents. So, for example, previously you have printed documents
1-15 and then you printed 16-26 and now you want to print 27 to the end of the
current defined job. So here you would enter the number 27.

Continuous document numbering If checked, the created IJPDS documents are numbered
continuously; the numbering is not reset with every new group/size.

Applicable only if options Split by size or Split by group in the section Driver configuration
are used.

Selecting IJPDS in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the IJPDS Engine Config dialog.

1259
12 Production

IJPDS Engine Config Dialog

Available tabs are:

General

Printers

Resources

Stop Command

Page(s)

Font Options

ICC Profile

Additional Info

Advanced

At the bottom of the dialog there is the Verify button. This can be clicked on at any time
during the allocation of attributes in the dialog in order to check whether they are correct, i.e.
none of the set attributes contradict each other or the printer assigned. The following check
is performed:

No 2 identical colors are set for 2 different RIPs.

CMYK assignments have all 4 colors set.

A corresponding number of pages and assigned RIPs exist.

No required definitions are left empty.

1260
 12.4 Engine Configuration

General Tab

Options Description

Spool File Format Selects a format for the spool file according to the actual configuration
of the IJPDS Data Station:

Disk format

Tape format

Block size Determines the size (in bytes) for the data blocks.

Only selectable when Tape format has been selected above, always 4096 bytes for
disk format.

Max SDC per block Determines the maximum allowable number of SDC (Start of
Document and Cue Command) pages per data block.

This value will depend on a specific job and on printer speed. Generally recommended
values are:

6 for Black and White

4 for CMYK

If you start receiving PIP errors (e.g. "Data out"), you will need to lower the Max SDC
per block value and start spooling again.

1261
12 Production

Generally, a higher number for the SDC produces a smaller spool file.

File Splitting

Use file splitting If checked, the spool file will be split into more files. Further select
one of the radio buttons:

Split file by size The spool file will be split when it reaches the size that has
been set in the Size of file splitting edit field.

Split file by group The spool file will be split according to the groups that
are defined in the workflow being printed.

The split files are numbered from a01 to z99, e.g. a01, a02, ..., a99, b00, , b99,
, z00, , z99.

Tip The options Split by size and Split by group in the driver configuration override
file splitting set here.

Fixed resources If checked, the resources are placed in the first split file.

It follows that, the individual files are created as soon as possible (not after the whole
spooling has finished) but, cannot be modified later during spooling.

Note If a font that has not been used in the first split file is used in subsequent split
files, its glyphs are printed as bitmaps. Overlays that have not been used before this
point are also printed as bitmaps.

It is recommended to use a codec so that only the glyphs for that codec are loaded
(max. 256 glyphs), otherwise all used glyphs will be loaded and that could mean
thousands of them.

Allow splitting of resources If checked, then resources are split in the case that the
resulting spool file would be bigger than the value set in the Size of file splitting
field. A separate resource file is then created in addition to the split files that contain
both resources and data or resources only.

This means that the spool files can then be split where ever necessary and, if it happens
that a required resource for printing data from a particular split file is not present in
that split file, then the printer will be able to find that resource in that separate re-
source file.

The printer that is running the job must support this feature if it is checked.

Fill blank pages If checked, any difference between the number of sheets in the groups
will be buffered by blank pages of media.

This is especially helpful when printing on parallel RIPs because two groups of different
sizes would cause problems with synchronization.

Only available if Split by group has been selected.

Size of file splitting Determines the size of the split files (in megabytes) if Split by size
has been selected.

1262
 12.4 Engine Configuration

Index Files

Create index file If checked, then a NDX file is created with the same name as and in
the same location as the spool file.

It lists the positions of the SDC commands that are in the spool file and has a minimum
of two positions the first SDC for the first document and the first SDC of the last
document. The positions are described as offsets to the document blocks that contain
the SDC, not the SDC itself. The file is intended to be read on the controller.

Note The CS400 controller does not support index files.

Old scheme If checked, writes the index file according to a previously used format. Use
when the Mpc4Run version is lower than 1.56.

This option only has any effect if Create index file is also checked.

RPX File

Create RPX file If checked, then printing using an RPX file is enabled.

Example scenario: Front pages are printed on one printer (including the index inform-
ation, e.g. a barcode), then a barcode reader or a camera is employed to read the
information and the created RPX file is used to match that index to the correct back
page that should be printed for each front page on a second printer.

The RPX file is created in the same folder as the IJP file. It contains the values coming
from the sheet name defined in Sheet name index and the matching offsets to the
back pages in the IJP file. The sheet name values must be of string type and convertable
to ASCII encoding.

Note The CS400 and CS410 controllers support the RPX file usage.

Length of index value The length of the string value in the RPX file can be max. 20
characters.

Add spaces to index value If a longer index is expected by the barcode reader / camera,
it can be adjusted by adding spaces to the index value.

Sheet name index Specify from which sheet name the values for the RPX file creation
will be taken. The values must be of string type and convertable to ASCII encoding.

The Sheet name value for 'Default document' and Sheet name value for 'Error
document' are taken from this sheet name index as well.

Sheet name value for 'Default document' Specify the sheet name value of the 'default
document', which will be printed in case that the barcode reader / camera detects
an index that is missing in the RPX file. The 'default document' page is created in
Layout and the page is assigned the same sheet name value to the sheet name spe-
cified in the Sheet name index above.

If more pages existed for one index, the first page would be used and a warning
would be issued.

If the 'default document' page was not created, a warning would be issued and an
empty page would be used.

1263
12 Production

If there did not exist all pages for an index (on the multi-RIP system), the 'default
document' page would be used and a warning would be issued.

Sheet name value for 'Error document' Specify the sheet name value of the 'error
document', which will be printed in case that the barcode reader / camera cannot
read an index printed on the first page. The 'error document' page is created in Layout
and the page is assigned the same sheet name value to the sheet name specified in
the Sheet name index above.

If the 'error document' page was not created, a warning would be issued and an
empty page would be used.

Printers Tab

Options Description

Use RIP stitching If checked, it allows the assignment of more RIPs to one page side and
each of the RIPs used will share the same resolution. Only RIP types that support the same
resolution as that of the first RIP will be offered for selection.

RIP stitching is the process where a single page is produced by two or more print heads.
Multiple print heads can be stitched so that one page appears to have been printed by
one head only. This is often used when printing large sheets as the stitching of heads in-
creases the maximum continuous width of the page to be printed.

If RIP stitching is used, it is recommended to uncheck the Merge static objects into
single overlay option on the Resources tab.

Example Stitching can make three separate physical RIP's;

RIP 0 with head 1

RIP 1 with head 1

RIP 2 with head 1

behave like one logical printer:

RIP 0 with head 1

RIP 0 with head 2

RIP 0 with head 3

1264
 12.4 Engine Configuration

See also How to Use RIP Stitching.

Note Some older IJPDS controllers may not support RIP stitching.

Use RIP splitting If checked, allows for the splitting of a RIPs heads so that some of them
may be used for printing another page side (as part of another defined logical printer).

RIP Splitting is a software (not hardware) dependant process and is particularly useful for:

Systems not allowing RIP stitching (hardware stitching)

Printing systems with RIP's containing more than one head, which can print a page
wider than the width of the logical printer, or for spot color printing.

Example When using 3X00 series with 2 RIPs, it is needed to print the front side
using 5 heads and the back side with only 3 heads. So we have to split the RIP's into
2 logical printers:

the first logical printer (Front Side) RIP #0 would consist of head #1, #2,
#3, #4 of physical RIP #0 + head #4 of physical RIP #1

the second logical printer (Back Side) RIP #1 would consist of head #1, #2
and #3 of physical RIP #1

See also How to Use RIP Splitting.

1265
12 Production

Example When using 3X00 series with 1 RIP, it is needed to print a page with the
combined width of the 2 heads (for black) and 2 heads (for one additional spot color).
So we have to define 2 logical printers for one page side:

the first logical printer (Front Side) would consist of head #1 and #2 of phys-
ical RIP #0 (black)

the second logical printer (Front Side) would consist of head #3 and #4 of
physical RIP #0 (spot color #0 e.g. red)

Note Physical RIPs split into logical printers must have the same resolution.

Partial overlapping heads If checked, this feature helps to set the overlapping of unstitched
heads which considerably improves printing quality (registration of heads).

See How to Handle Overlapping Heads.

Logical printer operations The icons here only relate to the logical printer definitions (rows)
that are a component part of a single page side. Multiple logical printers with different
properties can be set to one page side.

Example A page side that is set for CMYK color printing will have 4 logical printers.
By configuring this page side using the Page side operations icons (see below) you
will be taken through the definition of each of the 4 logical printers. However, if you
only want to edit or add a single logical printer then you would use these icons.

Create New Adds a new logical printer definition.

A new row will be created as a part of the currently selected page side and the Logical
Printer Configuration dialog will open so that it can be configured.

Configure Opens the Logical Printer Configuration dialog, enabling the editing of
the selected logical printer.

Heads Info Opens the Heads Info dialog, enabling the viewing of the currently set
head positions for the selected logical printer.

Delete Deletes the selected logical printer.

Page side operations The icons here relate to all of the rows of a single page side definition.

Create New Adds a new page side and the IJPDS Page Side Configuration dialog will
open so that it can be configured.

Configure Opens the IJPDS Page Side Configuration dialog, enabling the editing of
the selected page side definition.

Heads Info Opens the Heads Info dialog, enabling the viewing of the currently set
head positions for all of the logical printers on the selected page side.

Open File Loads a head definition in XML format, that has been previously saved
from Layout (a property of the individual pages) or Proof (a property of a raster proof
profile).

1266
 12.4 Engine Configuration

When doing this ensure that the Output colors of the selected page side has been
set to Black and white and the number and width of heads is the same as has been
defined in Layout.

Delete Deletes all of the rows for the single page side that is selected.

Delete All Deletes all of the created rows.

For an example of how to set up this tab, see the separate section How to Configure RIPs for
IJPDS.

Resources Tab

Options Description

Compression

Font compression

Off No font compression is performed.

On Applicable only to font II; run length 32 compression will be used. This
compression is supported by system controllers 220 and later.

Defined on printers Compression is defined for each page side in the Page
Side Configuration dialog. (The previous two options are applied globally.)

Image compression

Off No image compression is performed.

On Variable images will be stored as if they were characters of fonts.

Defined on printers Compression is defined for each page side in the Page
Side Configuration dialog. (The previous two options are applied globally.)

1267
12 Production

Overlay Setting

Load overlay as font If checked, overlays will be processed as if they were fonts.

A resource will be created dynamically and separately for each overlay, i.e. a resource
made for each image. The resources are inserted into the beginning of the spool file
after spooling of the last page. Generally the spooling and printing of a job with
variable images is faster than without this option.

As an alternative optimization, it may be required to reduce the number of overlays

created by storing them directly as resources and not as fonts, i.e. if there are many
overlays this might use up all of the possible 255 fonts. In such cases, uncheck this
option.

Overlay glyph width Determines the width of the cell of the matrix in which the image
is mapped (the width of the "character).

Only definable if Load overlay as font has been checked.

Overlay glyph height Sets the height of the cell of the matrix, in which the image is
mapped (the height of the "character).

Only definable if Load overlay as font has been checked.

Optimize overlay font size If checked, glyphs that are already stored in resources are
reused and not duplicated. Better results (reduction of the spool file size) are obtained
for smaller overlay glyph sizes.

Other

Do not use extra white processing If checked, suppresses white processing on an

IJPDS command level, ignoring any masks that are being used for full color images.

Masks are created in the spooling of full-color images to deal with printing the separate
color-layers of images and their transparency, especially if a transparent image is
placed over another one.

Example If a transparent image (1) is placed over another image (2) then it is
actually not desired to print the parts of image 2 where the non-transparent
parts of image 1 will be printed so a mask of image 2 is created with those parts
knocked-out of it.

Masks are stored as resources and use up space in the printer memory which
can cause problems on printers with a limited memory.

Use temp files If checked, used images are stored in a temp file while processing. This
can decrease memory usage.

Use fonts for graphics If checked, black and white graphics are stored as individual
font characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering
type is used (for details on matrix dithering types see the Edit Dithering dialog section).
It is most useful with variable graphics (it works for overlays that are not merged as
well, but to less advantage) and this option was implemented to speed up the pro-
cessing of 2D bar charts.

1268
 12.4 Engine Configuration

Example If a rectangle is printed and you have an 8x8 matrix size and create
a 9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, de-
pending on the position of the rectangle, and the image content data would be
just 32 bytes with usually an additional overhead.

For colored graphics, it is better to leave this option unchecked.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Use fixed files If checked, the sequences of defined overlays are saved in the resource
memory (that is a part of the spool file) and the spool file only uses a links to this se-
quence. As a result, the processing can be faster.

This should only be used with overlays that have the Overlay glyph width defined.

Create fixed resource set If checked, all of the resources are created in one fixed set
for the whole job, as opposed to being attached to the sections that they are use in.

Example A job is run in two stages; in the first stage pages from 1 to 20 and
in the second from 21 to the end.

The default behavior of spooling would produce different resources in IJP files
for each step. These would be calculated separately for each part of production,
i.e. separate resources for pictures, fonts etc. appearing on pages 1-20 and
pictures, fonts etc. that appear on pages 21-end.

However, when this option has been checked the resources (pictures, fonts, etc.)
are calculated one time (at the end of spooling) to create one fixed resource for
the whole job, irrespective of whether you are printing 1-20 or 21-end.

Therefore, if you are only printing part of a job and some of the resources will
be unused, it would waste time to use this option. But for large jobs with many
resources that are used repeatedly, it can be advantageous to load the resource
as one fixed set.

Merge static objects into single overlay If checked, all static objects on a page are
merged into a single overlay providing that they are in an optimized Z-order.

An optimized static objects Z-order is where all of the static objects are in consecutive
layers on the page in the layout of a workflow. This means that they will be processed
consecutively.

1269
12 Production

Example In the workflow being printed, this can be done via the Layout Tree
by simply ensuring that static objects are next to each other:

The highlighted objects on the FirstPage here are all static objects

Alternatively there is the Optimize Static Objects Order feature which rearranges
the objects in the same way throughout the entire layout design. Go to Layout
menu: Edit | Optimize | Static Objects Order.

A possible advantage of unchecking this option is to make better use of white space
on a page. If two or more static objects are separated by unfilled space on a page,
then the overlay produced by this option would be unnecessarily large. Also smaller
objects are more likely to be commonly occurring objects and therefore it can be
better to have these smaller objects stored as resources, particularly if using the option
Size optimization.

It is recommended to uncheck this option in case that a large design has been created
in Layout or RIP Stitching is used.

Note

This option is checked by default because when it is checked it represents the

default behaviour of PrintNet T before version 5.1.

In case that the objects overlap and this option is unchecked, it is necessary
to set white processing carefully, as it is handled by the output engine settings.
It is recommended to set it to Auto, for which the only disadvantage can be
slower speed.

Size optimization Allows to reduce the size of a spool file by means of intelligent re-
sources management.

The following options are available:

None No optimization applied.

Low (overlays) Standard optimization; suitable for most jobs. Overlay images
are compared and if they are already stored in resources, they are reused to
avoid duplicating. The second appearance of images will put these images
into resources.

High (variable images) High level of optimization with higher memory de-
mands. The second appearance of variable images will put these images into
resources.

High (overlays + variable images) High level of optimization; combination of

the two preceding options.

1270
 12.4 Engine Configuration

Note The Use Font Optimize option from earlier versions of Inspire Designer is now set by
default to be always used and the optimizing characters are included in the spool file.

The example How To Spool Many PDFs to IJPDS employs many of the settings on this tab,
providing some extra explanation.

Stop Command Tab

Options Description

Stop Command The parameters here relate to adding soft stop IJPDS commands to the
spool file.

Put stop command If checked, stop commands can be included in the IJP file.

You can further determine, whether the command will be inserted:

By sheet count after a certain sheet count.

By sheet name change when a specified sheet name changes.

By sheet name condition when a sheet name condition is met, e.g. it equals
a specified string.

Put message from sheet name index If checked, a pre-defined stop message will be
shown on the Scitex printer display.

The message will be returned by the sheet name with the index number that is entered
in the combo-box here.

1271
12 Production

Pages Tab

Options Description

Pages Per Cue Mark Cue marks are generally for older machines for which it is not possible
to define longer pages.

Pages per cue mark Defines the number of pages that are required between individual
cue marks.

Apply on one sheet If checked, the number of pages per cue mark will be printed on
one output sheet, i.e. the sheet will be horizontally split into the number of more
pages entered.

If left unchecked, one sheet corresponds to one cue page.

Definition of Pages

Crop bottom of page If checked, the bottom of the page will be cropped according
to the defined page height.

Page The number of the page that appears within the cue marks.

Example If 3 has been entered in the Pages per cue mark field there will be
3 rows here numbered 1 to 3.

Height definition Selects where the definition for the height of the page should be
taken from:

Media size Takes the defined medium height as set in the in Output module.

Sheet data dependent Sets sizes according to how much height is required
to fit the data that is defined as part of the sheet.

Page buffer length Takes the value set in the Page Buffer Length column
on the Printers tab of this config.

User defined Takes the value set here in the Height column. Units are dots.

1272
 12.4 Engine Configuration

Height Displays a note that refers to the selection in the Height definition column, or
if User defined has been selected you can edit the page height value.

Page command Shows SDC (Start Document at Cue) if it is the first page after a cue
mark (page 1). This indicates that the start of the page will be at the cue mark.

For the rest of the pages of a document you can select either SOD or SOP from the
combo-box menu of the second defined row:

SOD Start of Document command will be added where the next page starts
so that the document counter will be incremented there and each page will
be recognized as a separate document.

SOP Start of Page command will be added where the next page starts. The
document counter remains unchanged.

Font Options Tab

Options Description

Encoding

Text encoding If checked, defines that text encoding will be used for the text of the
file.

See the separate section Text Encoding.

Tip Using this option is recommended when the option Fixed resources on the
General tab is enabled, as it reduces the number of glyphs to be loaded.

1273
12 Production

Note

You should select a codec that is also compatible with the IJPDS controller
you are using, for Scitex the Text encoding option must be checked and set
to ibm-500_P100-1995.

It is not possible to search for text that is placed in overlays (nothing is found).
Barcode strings cannot be found either. If the face is italic, the text is divided
into glyphs.

Keep glyphs positions within words If unchecked, then corrections are not applied
inside the string of a word.

In order to have the Inspire Designer output DPI-independent and to provide kerning,
there are small corrections of character positions required inside text flow. This option
retains the possibility to search for specific words in the file content because the indi-
vidual words stay "as a whole word".

Note When this option is checked, the positions of individual characters within the
words may not be precise. Do not use this option when you require precise character
positioning.

It is also strongly recommended to switch off kerning in the workflow being produced
because it interferes with character recognition. Kerning is a property of text styles
(on the More Tab of a text-style's properties panel).

Use only for fonts marked for encoding in Layout If checked, the selected text en-
coding file is used only for fonts previously marked using the Preserve font encoding
for IJPDS output icon on the respective font's Layout Properties tab.

Follow Point

Always round-down glyph follow point If checked, the follow points that are used
to space the glyphs are rounded-down to the closest full-pixel value.

This can help avoid accumulative errors that occur due to repeatedly rounding-up
follow point values in long words and especially long numbers (e.g. barcode numbers).

Resize Barcodes See the separate Resize Barcodes section.

Log warning if number of fonts exceeds Enter the number of fonts. When this number
of fonts exceeds in RIP, a warning message is displayed. The maximum number of fonts
is 255. It is typically used with the option Create fixed resource set (on the Resources
tab) if you want to abort processing when the number of fonts exceeds.

ICC Profile Tab

See the separate ICC Profile Setting section.

1274
 12.4 Engine Configuration

Additional Info Tab

Options Description

Additional Info

Put additional info into spool file If checked, the area below is activated to allow
entry of some additional text that will be written to the spool file.

You can enter any text and use substitution characters to return variable information
specific to the workflow that is being printed. This information will be placed at the
beginning of the first document, inside a NOP command.

The following options also become available:

Encoding for additional info Selects the codec that should be used for the text char-
acters of the additional info. Select from: EBCDIC or ASCII.

EBCDIC is the required encoding if you also check the option Show additional info
on the controller.

Show additional info on the controller If checked, the additional info entered here
will be displayed on the controller of the printing device after starting the print job,
i.e. the information will be inside a MSG command instead of a NOP command.

1275
12 Production

Advanced Tab

Options Description

User Output Signals

Use user output signal If checked, output signals are employed to help synchronization
of RIPs with the IJPDS Controller.

The following options also become available:

Use calculated output signal The output signal algorithm is: digout =
Rev16((WORD)((((IJPDS_Document# / 3) % 3) + (IJPDS_Document# %
5)) % 2)); //digital output, where % = module.

Use sheet name value for output signal The output signal value is taken from
the variable assigned to the sheet name with the specified index number.

The values returned by that variable can be in hexadecimal (e.g. x10), decimal
(e.g. 15), octal (e.g. o7) or binary (e.g. b1001). Below is a table of the binary
and decimal signal values that are currently used by IJPDS controllers:

Low-Order (First Byte) High-Order (Second Byte)

Bit Binary Decimal Binary Decimal

0 8
1 2 1 2 256
1 9
2 2 2 2 512
2 10
3 2 4 2 1024
3 11
4 2 8 2 2048

1276
 12.4 Engine Configuration

Low-Order (First Byte) High-Order (Second Byte)

Bit Binary Decimal Binary Decimal

4 12
5 2 16 2 4096
5 13
6 2 32 2 8192
6 14
7 2 64 2 16384
7 15
8 2 128 2 32768

The sixteen values in the table represent the sixteen RIPs, e.g. RIP 0 is low-order
bit 1 and RIP 15 is high-order bit 8. To combine multiple signals into one value,
add the individual values together.

Example

1. To send both a high-order and low-order signal for bit 2 (for RIPs 1
and 9) then the decimal value 514 can be used. I.e. 2 (for low-order
bit 2) + 512 (for high-order bit 2).

2. If the variable returns the decimal value of 15 this would be inter-

preted as four low-order signals for bits 1, 2, 3 and 4, i.e. decimal
values 1 + 2 + 4 + 8 = 15.

EBCDIC Conversion

Replace non-EBCDIC characters with Specifies a character that is to be used for repla-
cing all non-EBCDIC characters. This can aid recognition of unsupported characters
when viewing.

DPI for PDF/EPS

Use the highest DPI of used RIPs If checked, the DPI of any used PDF and EPS images
will be determined by the resolution set for the RIPs via the Printers tab. The highest
DPI defined there will be the one that is employed.

DPI for PDF/EPS Determines the DPI that will be used for any used PDF or EPS images,
X value = left edit-box and Y value = right edit-box.

Variable Cue Length Selects the method for determining the intervals between cues.

This is only for devices that provide the possibility to use variable cues from the spool file.
This feature will require changes throughout the CS410 system, including the CS410 system
controller software, CD132 data station software, and the external tach/cue system.

The options are:

Disable No cues will be defined in the spool file.

Medium size Determines that the interval between cues equals the height of the
media that have been created in the Output module of the workflow.

1277
12 Production

This allows you to define the cues by setting appropriate medium sizes in the
workflow. Each page that is defined on the Printers tab of this dialog must have
an equal number of media, of the same dimensions, defined in the Output module.

It is important to remember that each medium defined in the Output module must
also have at least one equivalent page in Layout. See the separate example How
to Set IJPDS Cue Intervals from Size of Medium.

User defined Determines that a single value will be used for the cue interval, i.e.
the cue will always be repeated with the spacing that is entered in the edit-box
here.

The default value is 17 inches, which is the industry standard.

Cropping of Sheets

Crop sheets If checked, each sheet is cropped according to the medium size set via the
Output module of the workflow.

Native Loading of Images

Suppress native loading of images Enables you to globally suppress native loading
of images set by selecting the Load natively check-box on the Advanced tab of the
Image Layout Properties dialog.

This feature is used to increase the processing speed or produce both electronic (e.g.
PDF) and IJPDS print outputs out of the same job.

Note If PDF, EPS or AFP images are loaded natively, they retain their transparency
by default; if they are loaded as raster images, they are not transparent.

The advantages and disadvantages of native loading of images are summarized in

the Native Loading of Images section.

12.4.11.2 IJPDS Printing System Components

See also:
IJPDS Engine Configuration

The following section is a citation from: Digital printing, IJPDS Formats by Scitex Printing Systems.

The following components are included in the printing system:

System Controller.

Data Station.

Print Station.

1278
 12.4 Engine Configuration

The following diagram illustrates one possible printing system configuration:

Description

System Controller The system controller software is installed on a PC. Using this software,
the operator controls the printer, the printing system components and the IJPDS spool
files. The software accepts IJPDS spool files as input, divides the IJPDS data to different
RIP numbers, and sends the IJPDS data to the correct data station.

Data Station The data station uses fonts, character input data, and positioning information
from the IJPDS job file to build bit maps, which it sends to the print head. The data station
receives IJPDS spool files from the system controller. However, some data stations can re-
ceive job files directly from another source, e.g. network.

The data station contains at least one Raster Image Processor (RIP). Each RIP feeds at least
one print head. Some data stations contain up to four RIP's.

Print Station Fluids for the print head are controlled by the print station. Print head sizes
vary among print stations and include 13-inch, 10-inch, 9-inch, 4-inch and 1-inch print
heads.

IJPDS Printer Components

The data station and print station may also be integrated in one component, called a printer.
The printers data station contains one RIP, which feeds one print head (PH) as shown in the
following diagram:

RIP The Raster Image Processor (RIP) uses input character data and fonts from the IJPDS spool
file to build a bit map, in a page buffer, that represents the image to be printed. Each bit
in a page buffer represents a single dot in the image to be printed. Each bit map represents
one page of the document to be printed.

Many printing systems contain more than one RIP. In a multi-RIP system, information from
an IJPDS spool file must be divided among the RIP's used for the job using a RIP record.

1279
12 Production

Each RIP can control from one to four print heads, depending on the data station, print
station, and the width of the print head being used.

In some configurations, multiple print heads can be stitched together so that a large image
appears to have been printed by one print head. Stitching print heads can greatly increase
the maximum width of the image to be printed. If stitched print heads are controlled by
separate RIP's, then the RIP's are also said to be stitched.

In the IJPDS spool file, the physical RIP's are numbered consecutively starting from 0. Lo-
gical printer numbers are required when two physical RIP's are stitched. For example, in
the diagram below RIP 0 is used as the logical printer number for the two stitched RIP's,
because RIP's 1 and 2 in data station 1 are stitched.

The diagram below shows the formation of physical RIPs and logical printer's. The system
controller interprets the RIP numbers in the IJPDS spool file and directs the data to the
appropriate RIP in the appropriate data station:

12.4.11.3 IJPDS Page Side Configuration Dialog

In this section: See also:
Logical Printer Configuration Dialog IJPDS Physical RIP Configuration Dialog
IJPDS Engine Configuration
How to Configure RIPs for IJPDS
How to Set IJPDS Overlapping Heads

Selecting a row on the Printers tab of the IJPDS Engine Config dialog and clicking on either
the Create New or the Configure icon for Page side operations (bottom-right of the
tab) opens the IJPDS Page Side Configuration dialog.

Alternatively, double-click on that row.

1280
 12.4 Engine Configuration

This dialog sets the parameters of the selected page side, i.e. all of the logical printers that will
print on a single page side. If colors are selected then a logical printer will be added for each
color, although each color is only part of that single page side.

The available tabs are:

General

Dithering

Advanced

General Tab

Options Description

Font Setting

Use font type I Uses no font metrics. Therefore, characters often have to be positioned
which makes the spool file larger.

Use font type II Uses font metrics. Therefore, generates a significantly smaller spool
file.

It is not possible to use this with IJPDS 5120/5240. For IJPDS 6xxx it is allowed from
controller v1.13 and for IJPDS 3xxx from controller v2.13.

Use super font only for overlay fonts Determines that double-byte fonts will be used
for fonts that have been created from overlays and size optimization.

This increases the possible capacity for glyphs by placing them in double-byte fonts
and is recommended for jobs that have many overlays stored as fonts (as a result of
using the options Load overlays as fonts and Size optimization on the Resources

1281
12 Production

tab of the IJPDS Engine Config dialog). This option increases spool file size, but not
as much as Use super font for all fonts.

Use super font for all fonts Determines that double-byte fonts will be used to contain
all glyphs.

This gives the highest possible capacity for glyphs and is recommended for jobs that
use many glyphs. However, this option considerably increases the spool file size.

Note Use one of these two super-font options if you receive the warning 3030 -
Some glyphs will be printed as bitmap because maximum number of fonts reached
when running a job.

Color & White Processing These options directly relate to the printing device, the printing
heads and the respective colors.

Output colors Defines the palettes used for all colors (text, overlays and pictures). Select
from the combo-box menu:

Black and white Represents the colors by dithering black and white dots.

Further select dithering patterns on the Dithering tab.

CMYK split Prints the colors by dithering CMYK based dots.

Each plane of C, M, Y and K is dithered independently and the resulting

dithering pattern uses cyan, magenta, yellow, black, red, blue, green and
white dots. Further select dithering patterns on the Dithering tab.

Spot colors Represents the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can
be done via the Color dialog.

Dithered spot colors Represents the colors by dithering spot colors or black
and white dots.

Dithered spot colors should be assigned to each of the colors in the workflow,
this can be done via the Color dialog. Colored objects that use colors that are
not assigned as dithered spot colors are dithered using black and white dots.
Further select dithering patterns on the Dithering tab.

Printer color Selects one of the component colors (Cyan, Magenta, Yellow or Black) to
be printed using one RIP.

For this color you should further assign an RIP and configure that RIP via the Physical
RIP options.

All of the four colors must be assigned a RIP, i.e. four logical printers must be defined
for the page side. If a color is left unassigned then either: the Logical Printer Config-
uration Dialog will open prompting you to define another color to another RIP; or, if
you have escaped this (e.g. by clicking on Cancel in that dialog), then when you
Verify your printer configuration the unassigned colors will be noted in the Potential
Problems dialog.

Only enabled if CMYK split has been selected in the Output colors combo-box.

1282
 12.4 Engine Configuration

Spot color index Selects a spot color index that corresponds to a spot color that has
been defined for the colors of the workflow. This color will then be used as the color
to be printed where ever the corresponding spot color has been used in the design.

Only visible if Spot color or Dithered spot color have been selected in the Output
colors combo-box.

White processing Selects the method for handling white.

The options are: Always, Never, Auto or Text.

For all options except Never, the check-box Use 'Never' for black printer is available
for CMYK split. If checked, Never will be selected for any used black printer.

See the separate section White Processing for a description of the options.

Page & Side

Page for printers Assigns a page number to the page side.

One page can have two page sides and so the two sides share the same page number.
These numbers should correspond to the number entered in the Page edit-box for
the IJPDS Device Profiles defined in the Output module of the workflow being pro-
duced.

Side of page Selects whether this page is the Front side or the Back side of the page.

Note When duplex has been set in the Output module, then a sequence of 2 page
sides must be set, e.g. Page for printers 0 needs Side of page Front side and then
Back side.

Resolution

Resolution Selects the resolution of the page side.

There are several predefined options (that are based on Scitex, Versa, Kodak Versa
Line and Prosper S series) or you can define your own by selecting User Defined and
activating the combo-boxes DPI X and DPI Y.

By selecting one of the options, not only the resolution but also the RIP Type, # of
jets values and number of heads are pre-defined in the Physical RIP Configuration
dialog.

DPI X Defines the resolution in the X plane (across the page). Units are DPI (dots per
inch).

Only active if User Defined has been selected in Resolution.

DPI Y Defines the resolution in the Y plane (down the page). Units are DPI (dots per
inch).

Only active if User Defined has been selected in Resolution.

Physical RIP This part of the tab displays check-boxes and buttons for each of the 32 possible
RIPs.

RIPs that have already been defined will show as inactive and already checked. One of the
RIPs is automatically checked, for the color that you are currently assigning to the page

1283
12 Production

side, in an active check-box. To re-assign the color to another RIP, uncheck the currently
assigned RIP and check the desired one.

Upon checking, the Physical RIP Configuration Dialog will open to allow you to further
define RIP parameters and head positions.

RIPs 16-31 can be used only if the Use RIP stitching check-box in the IJPDS Engine Config
dialog, Printers tab has been selected.

Dithering Tab
See the separate Dithering section.

Advanced Tab

Options Description

Trapping

Use trapping If checked, applies font trapping and bitmap trapping to the profile.

Trapping refers to the overlapping borders between different printed areas on a page.
This will usually be between a background color and a foreground object such as a
font.

When printing colored text on a colored background, the background is printed with
a knock-out the same size as the text. The knock-out is like a negative of the text
leaving a non-colored space so that, when the text is printed, no color mixing occurs
and the resulting text color is as it was defined.

1284
 12.4 Engine Configuration

The objective of trapping is to make any white space between font/bitmap layer and
background layer as small as possible or even to produce a visible overlap giving the
effect of a border. This border would be of a color that is a mix of both the foreground
and background colors.

Trapping works by decreasing the size of the knock-out from all directions, effectively
making the knock-out smaller than the text and resulting in a border.

Trapping units are pixels.

Example With Scitex printers there is usually a small mis-registration of the

foreground print and the background knock-out. This results in some non-printed
page visible around the text. By using trapping, you can decrease the size of the
knock-out to create an overlap between it and the text and therefore reduce
the visible affect of the misalignment.

Size of font trapping Determines the size of font trapping in pixels.

Size of bitmap trapping Determines the size of bitmap trapping in pixels.

Font storing

Do not divide glyph If checked, glyphs are fitted to blocks as whole glyphs. If a glyph
is bigger than a whole block it is converted into a bitmap.

Normal behavior would be to divide larger glyphs between two blocks. This option
is recommended only for older types of printers that are not designed to cope with
split glyphs.

Sheet offset

Logical RIP group starts with Sets how many empty sheets will be placed in front of
this assigned page side. This option can be used to synchronize the printing of jobs
which also use other RIPs.

PLR command

Suppress PLR command If checked, the PLR (Page Length Requirement) command is
suppressed at the printing device.

If unchecked, the PLR command is used automatically every time the data exceeds
the limit given by Page buffer length. But, as some printers do not support the PLR
command, it is better to set a correct value in the Page buffer length.

1285
12 Production

Page buffer length

Page buffer length Determines the length of the page buffer. This corresponds to the
manufacturer specified buffer capacity of the printing device.

Clicking on the Set RIP default page buffer length button employs the predefined
buffer value for the specific printer from the Physical RIP Configuration Dialog. It is
further possible to modify that value.

Forbid longer media Prevents the device exceeding the page buffer length.

Your printer will have a preset maximum page length. By entering that maximum
page length in the Page buffer length combo-box and checking this option, the
spooling of any longer pages will be prevented.

Compression

Font compression Enables you to define font compression for individual page sides.
This option becomes available after the Font compression option on the Resources
tab is set to Defined on printers.

Image compression Enables you to define image compression for individual page sides.
This option becomes available after the Image compression option on the Resources
tab is set to Defined on printers.

Logical Printer Configuration Dialog

The Logical Printer Configuration dialog is a brief version of the General tab of the IJPDS Page
Side Configuration dialog that only relates to setting a single color to RIPs. It appears automat-
ically if required colors are not yet assigned, when defining the color processing via that dialog,
e.g. if all four CMYK colors have not been set.

Alternatively, it can be opened by selecting the row of a RIP on the Printers tab of the IJPDS
Engine Config dialog, and either clicking on the Create New or Configure icons for
Logical printer operations at the bottom of that tab.

For a description of the options, refer to the options description the General tab of the IJPDS
Page Side Configuration dialog.

1286
 12.4 Engine Configuration

12.4.11.4 IJPDS Physical RIP Configuration Dialog

See also:
IJPDS Page Side Configuration Dialog
IJPDS Engine Configuration
How to Configure RIPs for IJPDS
How to Set IJPDS Overlapping Heads

The Physical RIP Configuration dialog appears when clicking on a RIP button on either the
General tab of the IJPDS Page Side Configuration dialog or the Logical Printer dialog. It is used
as part of the definition of pages sides and their respective logical printers for IJPDS printing
devices.

Options Description

RIP Parameters These attributes relate to the physical parameters of the RIPs that you will
use. Refer to your RIPs to ascertain the values that should be entered.

RIP type Determines the RIP type that is to be used and, therefore, the number of
printing heads.

The options that are available in the combo-box menu depend on the compatibility
of the Resolution that has been set on the General tab of the IJPDS Page Side Con-
figuration dialog:

Resolution Available Types

120x120 dpi Scitex 5120, Scitex 5122.

240x240 dpi Scitex 5240, Scitex 6240, Scitex 6240a, Scitex 3X00,
300x300 dpi Scitex 5300, Scitex 6300, Versa
300x600 dpi Scitex 5300, Scitex 6300, Versa
600x300 dpi Prosper S, Versa
600x360 dpi Kodak Versamark VL-series, Versa

1287
12 Production

Resolution Available Types

600x600 dpi Kodak Versamark VL-series, Versa, Prosper S

300x1200 (Kodak) Kodak Versa

If a RIP type is shown with an asterisk * after it (e.g.Versa*) then this denotes that
the printing device cannot actually print at the chosen resolution and, therefore, that
type should not be chosen.

# of drops Selects the number of drops (0 to 4) of each jet.

Each RIP type has a predefined number of drops that is shown here by default.

# of jets Adjusts the total number of ink jets for one head width of the RIP.

Each RIP type has a predefined number of jets that is shown here by default.

Heads & Position All of the heads positions are linked and automatically calculate a value
if they are checked.

You can alter any value if you click on the Link icon to break its link to other set positions
and activate the edit-box. The Broken Link icon will then show.

All head values relate directly to the # of jets entered. Measurement units can be changed
by clicking on the unit symbol.

Head 1 If checked, defines the start position of head 1 using the value entered in the
combo-box

The automatically set values are relative to other head positions that have already
been set. Usually, it is 0 because head 1 will be the first defined head for printing
that color. However, if Use RIP stitching has been checked on the Printers Tab of
the IJPDS Engine Config dialog then the value here will be the position where the
previous RIP finished.

Head 2 If checked, defines the start position of head 2 (in relation to the previously as-
signed head) using the value entered in the combo-box.

Head 3 / Head 4 Only available if a RIP type that requires four heads is selected.

If checked, defines the start position of the head (in relation to the previously assigned
head) using the value entered in the combo-box.

For an example of head positioning, see also How to Set IJPDS Overlapping Heads.

1288
 12.4 Engine Configuration

12.4.11.5 IJPDS Heads Info Dialog

See also:
IJPDS Engine Configuration

The IJPDS Heads Info dialog appears when clicking on one of the Heads Info icons on the
Printers tab of the IJPDS Engine Configuration. It allows a quick view of the printing heads that
have been set using the IJPDS Physical RIP Configuration Dialog.

Options Description

Used Heads The table here shows all of the heads that will be used for printing with the
current engine config profile.

If two heads overlap, the overlapped jets of each head are counted in brackets, e.g.:

Covered Heads The table here shows all of the heads that have been defined, but which
are in a position that is already covered by other heads on the same logical printer.

12.4.12 Image Engine Configuration

In this section: See also:
Image Engine Config Dialog Image Engine Command Line Parameters

The Image engine can convert a job into an image file of any of the supported image formats
(e.g. BMP, PNG, JPG ) instead of creating a spool file.

You can further define the Image Engine Config and the Driver Config.

Selecting Image in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Image Engine Config dialog.

1289
12 Production

12.4.12.1 Image Engine Config Dialog

Options Description

Color space Selects the color space for the image that will be created. Select from:

Full color Creates full color images.

Palette Creates color images with a RGB palette of 256 colors.

Grayscale Creates images in shades of grey, i.e. using mixed tones of black and
white varying from black at the weakest intensity to white at the strongest.

This can be used to create images that include any objects that were colored (e.g.
images) in a high resolution black and white format.

B&W Creates black-and-white images.

This will only recreate black and white objects from the original design. Other colors
will not show in the resulting image.

B&W ordered Creates black-and-white images using ordered dithering.

Employing dithering allows colors from the original design to be represented as

shades of grey by using just black and white patterns of dots.

B&W Floyd-Steinberg Creates black-and-white images employing the Floyd-

Steinberg dithering method.

Similar to B&W ordered but the Floyd-Steinberg method uses different dot pattern
and an algorithm on pixel order in order to diffuse errors that may accumulate.

DPI Selects the resolution (in Dots Per Inch) for the image that will be created.

The larger the DPI value then the higher quality the image and the larger the created file
size.

Image format Selects the file type of the image that will be created. The following image
formats are available:

BMP Creates a BMP file from each page of the design.

This is an uncompressed Windows bitmap image.

PNG Creates a PNG file from each page of the design.

This is a losslessly compressed bitmap image format that provides alpha transparency
and full color support.

1290
 12.4 Engine Configuration

JPEG Creates a JPG file from each page of the design.

Commonly used for high-resolution full-color images, but is not as well suited for
line drawings and other textual or iconic graphics, because its compression method
performs badly on these types of images (the PNG is in common use for that pur-
pose).

TIFF Creates a TIF file from each page of the design.

The Tagged Image File format uses lossless compression.

MTIFF Creates a multi-page TIF.

This creates a single TIF file even if there are multiple pages to the design. Most
other options here create a separate file for each page of the design.

CXRI Creates a CXRI file from each page of the design.

This format (Chimenix Raster Image) is Inspire Designer's bitmap image format.
Image supports all of the color features (CMYK, RGB, Grayscale, B/W). CXRI is
single page format and no compression is available.

PCX Creates a PCX file from each page of the design.

This format uses a simple form of run-length encoding (a type of lossless compres-
sion algorithm). Most PCX files use a color palette, but the format also allows 24-
bit images.

TARGA (TGA) Creates a TGA file from each page of the design.

This format (Truevision Targa) is most often used for high-color images.

IOCA Creates an IOCA file from each page of the design.

This format (Image Area Content Architecture) for images is used in AFP page
definitions. It is also known as IO1.

IOCA defines five function sets: FS10, FS11, FS20, FS42, and FS45:

FS10 is intended for bi-level images.

FS11 and FS20 cover bi-level, grayscale, and color images.

FS42 covers tiled bi-level images and tiled CMYK images with 1 bit per spot.

FS45 carries tiled bi-level and CMYK images. CMYK images can be either 1 or
8 bits per spot.

FS11 is a superset of FS10. FS45 is a superset of FS42. There are no other rela-
tionships among the functions sets.

MIOCA Creates a multi-page IOCA file.

This creates a single IOCA file even if there are multiple pages to the design. Most
other options here create a separate file for each page of the design.

GIF Creates a GIF file from each page of the design.

1291
12 Production

This is a compressed format that supports a maximum of 256 colors and transpar-
ency, which makes it practical for almost all graphics except photographs.

Interlace If checked, places a rough, blurry copy of the image at the beginning of the data
stream, which allows viewing the preview of the actual image first. The file gradually
sharpens as the image loads.

Available only for PNG and JPEG.

Quality Selects a quality level.

0 corresponds to the greatest compression (and lowest quality), 100 corresponds to the
least compression (and highest quality).

Available only for JPEG.

Compression Selects a compression type:

CCITT group 3 Compresses the file using one-dimensional compression for the
purpose of meeting the TIFF Class F standard.

CCITT group 3 compression is suitable for fax transmission. In order to meet the
requirements of TIFF Class F, select this option and further apply one of two DPI
values (98 or 196 dpi set in this dialog) and one of three page widths (1728 px,
2048 px or 2482 px set on the General tab of each page in the Layout module).

CCITT group 4 Compresses the file to smaller sizes than CCITT group 3 using
two-dimensional compression.

Available only for the B&W variants of TIFF and MTIFF.

12.4.13 IPDS Engine Configuration

In this section: See also:
IPDS Engine Config Dialog Driver Config
IPDS Printer Configuration
pauseAfterCurrentSheet

The IPDS Engine communicates print jobs using an IPDS (Intelligent Printer Data Stream) protocol,
usually via a direct connection.

You can further define the IPDS Engine Config, Printer Config and the Driver Config.

Selecting IPDS in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the IPDS Engine Config dialog.

1292
 12.4 Engine Configuration

12.4.13.1 IPDS Engine Config Dialog

The tabs in this dialog are:

General

Advanced

Color Management

Dithering

Indexing

Image Handling

General Tab

1293
12 Production

Options Description

Printer resolution for positioning Sets the resolution that will be used for positioning of
objects on the page.

Select one from the range of DPI values in the drop down menu. Usually, the printer sup-
ports its physical resolution for positioning of objects, although some printers might require
different setting (e.g. 240,240, 360, 360 or 1440, 1440).

Printer resolution for font and images Sets the resolution that will be used for fonts and
images. Select one from the range of DPI values in the drop down menu or select Printer
to allow the resolution to be determined by the printer parameters.

Max IPDS data packet size Enter here the size into which the IPDS commands are split.

8KB should work on all printers. A bigger size allows a higher transfer speed but it should
be noted that, if the printer does not support higher speeds, IPDS data errors may occur.

Recommended values:

NIPSON 16

old IBM 8, new IBM 16

old OCE 12, new OCE 16

Max page segments count Enter here the maximum amount of segments that should be
sent to the printer at one time.

This is a measure to prevent the filling of the printer memory used for resources. By entering
a number N here, page segments will be sent to the printer until there are N page seg-
ments in the printer memory. No more will be sent until the point in the print job that
they are required, at that time the printer will delete the oldest page segments from its
memory and load new ones, one at a time, i.e. each time a new resource is called in a
print job; one will be deleted from the printer memory.

The default value is 127 which is a reasonable value for most printers and print jobs to
cope with. Setting it to 0 will stop the caching of "page segments" altogether. For some
printers (e. g. later IBM and OCE models) the value can be set to higher than 2000 page
segments, please refer to the respective printers guide for more information.

Max overlays count Enter here the maximum amount of overlays that should be sent to
the printer at one time.

This is a measure to prevent the filling of the printer memory used for resources. By entering
a number N here, overlays will be sent to the printer until there are N page segments in
the printer memory. No more will be sent until the point in the print job that they are re-
quired, at that time the printer will delete the oldest overlays from its memory and load
new ones, one at a time, i.e. each time a new resource is called in a print job; one will be
deleted from the printer memory.

The default value is 254 which is a reasonable value for most printers and print jobs to
cope with. Setting it to 0 will stop the caching of "page segments" altogether. For some
printers (e. g. later IBM and OCE models) the value can be set to higher than 2000 page
segments, please refer to the respective printers guide for more information.

Max fonts count Defines the maximum number of fonts to be uploaded to printer.

1294
 12.4 Engine Configuration

The default value of 128 is usually sufficient (this is the lowest value supported also by
Nipson printers) although some printers may support a value up to 255 fonts.

Pages per acknowledge Sets how many pages will be sent with one acknowledgement.
Higher values increase the performance, but the most tested and recommended value is
1.

Graphic support Selects the level of graphic support of the printer to be used. You can
choose from:

None Specifies that the printer does not support graphics. All such objects are
printed as images.

Lines and Rectangles Specifies that the printer supports rectangular shapes.

Full Specifies that the printer supports all graphics. Lines and fills are drawn
gradually.

Full with outlines Specifies that the printer supports all graphics. Lines and fills
are drawn in one step.

This is an effective mode however, if the output from the printer is not ideal, use
the option Full, where the incremental drawing will ensure a more accurate result.

Full with outlines and Beziers Specifies that the printer supports all graphics. Lines
and fills are drawn in one step and curves are represented by points of a Bzier
curve to be rendered by the printer.

This is a more efficient processing method but depends on the ability of the printing
device to render curves. In cases where the Miter of line joins is greater than 10
(see for example the Content tab of Shapes in the Layout module of a workflow)
then the lines are rendered as shapes with fill styles.

White processing Selects whether the colors of text and images should be printed over any
background, or if the background should be cut out where any text or images are to be
printed.

See the separate White Processing section.

Output colors Selects how the colors of the design will be printed:

Black and white Represents the colors by dithering black and white dots.

Further select dithering patterns on the Dithering tab.

Spot color Represents the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can be
done via the Color dialog.

Dithered spot color Represents the colors by dithering spot colors or black and
white dots.

Dithered spot colors should be assigned to each of the colors in the workflow, this
can be done via the Color dialog. Colored objects that use colors that are not as-
signed as dithered spot colors are dithered using black and white dots. Further
select dithering patterns on the Dithering tab.

1295
12 Production

Full color Prints the colors in the color space selected in the Use combo-box of
the Color dialog of the workflow.

Note Due to the number and variety of JPG formats that do not have to be
supported by printers, the TIFF compression and TIF native images are recommended
for full color printing.

Indexed colorants Prints the colors using indexed colorants or in black and white.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are dithered using black and white dots. Further select dithering patterns
for the black and white on the Dithering tab.

Full color + dithered colorants

Full color + indexed colorants Prints the colors using indexed colorants or in the
selected color space.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog of the workflow. Colored objects that use colors that
are not assigned as colorants are printed using the color space selected in the Use
combo-box of the Color dialog.

When using colorants, you can additionally enable the Use colorant combinations for
indexed colorants option in the ICC Profile Setting tab.

Using colorants requires printers that support color management resources (CMRs).

Assign IPDS colors to index Selecting the Spot Color, Dithered spot color or Full color +
dithered colorants option activates the Assign button that opens the Assign IPDS Color
to Index dialog (see below).

Assign IPDS Color to Index Dialog The Assign IPDS Color to Index dialog allows you
to map each of the IPDS or Highlight colors to the spot colors that have been defined
in Layout.

The first column differs slightly depending on the Output colors option selected.

In the Spot Color / Colorant Name column the spot colors or colorants are listed
and each of them has a row of possible assignments. Assigning is effectively making
a link between the colors of your design and color names that the printer recognizes.
IPDS printers most often use the IPDS Color naming system but a Highlight Color Index
exists as an alternative as some printers do not support IPDS Colors.

1296
 12.4 Engine Configuration

For each Spot Color / Colorant Name defined in the workflow to be printed select
an IPDS Color or Highlight Index in the corresponding cell in its row. It is recom-
mended to have Spot color 0 for black.

Example A shade of yellow has been defined in Layout as Spot Color 2 and
the IPDS printer that will be used has Yellow toner correctly placed. We simply
select Yellow in the IPDS Color cell of the Spot Color 2s row.

If you are using the Highlight Indexes instead, then the IPDS Color definition is ignored,
but you can use the colors available in this cell to simply label the highlight color with
a color name that is similar to the actual color that it refers to, e.g. Pink color in Layout
is assigned to Spot Color 1 and Highlight Color 5 is a shade of pink toner on the
printer and so we enter 5 in the Highlight Color cell and label it as pink/magenta in
the IPDS color cell.

When using Highlight Colors, you can further define Highlight Coverage and
Highlight Shading:

Highlight Coverage (%) corresponds to the amount of toner that will be

used for that color. E.g., 100% would be full and thickly layered color (high
quality print) and 0% would be no color used.

Highlight Shading (%) designates an amount of black toner that should be

added to the color in order to print a darker shade. E.g. 0% adds no black
and the color is the pure color tone assigned at the printer head and 100%
would result in black being printed.

Full color image format Only selectable if Full Color is selected in the Output colors combo
box.

Assigns a format for full color image output. You can select from:

Uncompressed

JPEG

TIFF LZW

Color space for text and graphic The combo-box menu offers the following options:

CMYK A device dependent standard (cyan, magenta, yellow, and black).

CIELab A device independent standard that is specified by three components;

luminance (L) and color values on a red-green axis (a*) and a blue-yellow axis (b*).

Take from Layout color Colors of objects will be kept as they are defined in layout,
no color space transformation is performed.

Report undefined characters Defines if the printer should report printing of the characters
for which the char description inside the font is not defined.

Report print outside page Sets if the printer should report printing outside the page defined
on the printer.

Report all other Sets if the printer should report other alternative exceptions.

1297
12 Production

Print position check highlight Defines if the printer should print marks for position check
exceptions.

Use relative font metric Set if fonts should be loaded to the printer using a relative font
metric. This allows for the uploading of some big fonts that could not be loaded via fixed
metric

Double-byte fonts Check this option when you are to print jobs using double-byte fonts.
However, you can leave it unchecked even if you use double-byte fonts, but only if total
number of used glyphs is lower than the result of the following calculation: max fonts
count x 255. Enabling this check-box activates the Sections 0x41 0x44 check-box below.

Sections 0x41 0x44 only If checked, only the indicated 0x41 0x44 sections of double-
byte fonts are used. This option is disabled by default and becomes active only when the
Double-byte fonts check-box is enabled. It is recommended to enable this option for
modern printers, like the IBM-4100, when printing with the Double-byte fonts option
enabled.

Compression Defines if the CCITT 4 compression should be used for images loaded into
printer.

Use IO Image command as default Toggles the type of command for images uploading.
The IO command contains the image resolution and so the image is always printed with
the correct size.

This option is checked by default. Unchecking is recommended for Nipson 7000 printers
that process the standard command faster.

Stack received pages Defines if the printer should move all printed pages to the stacker
after the whole job is printed.

Split overlays for NIPSON You can choose either None, N8000 - RIP 3 or VaryPress.

When Compression is checked it is recommended to set the appropriate type (N8000 with
RIP 3 or VaryPress) because of printing performance.

Grayscale images support Allows adjustments to be made for supporting grayscale images.

When checked, you can further select from uncompressed or JPEG Compressed in the
drop down combo box next to this option:

If JPEG Compressed is selected you can further define the level of compression in
the JPEG compression quality combo-box, where any value 0100 (%) can be
selected or typed. It is set to 80% by default.

Also the Convert to grayscale combo-box is activated, where you can choose which
images should be converted into grayscale either 16M color images, PDF, EPS (all 24bit
[16 million colors] + PDF and EPS) or all images except monochromatic ones.

Note If this option is checked, dithering will not occur, the image only gets linearized
before printing.

1298
 12.4 Engine Configuration

Advanced Tab

Options Description

Resize Barcodes See the separate Resize Barcodes section for details.

Use fonts for graphics If checked, black and white graphics are stored as individual font
characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering type
is used (for details on matrix dithering types see the Edit Dithering dialog section). It is
most useful with variable graphics (it works for overlays that are not merged as well, but
to less advantage) and this option was implemented to speed up the processing of 2D bar
charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create a
9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, depending
on the position of the rectangle, and the image content data would be just 32 bytes
with usually an additional overhead.

If None is selected for Graphic support on the General tab, any black or gray color rect-
angle is processed much faster with less memory use. If Lines and rectangles is selected
for Graphic support then the rectangle support of the printing device has priority, so

1299
12 Production

that pure black rectangles are printed using the printer function, but still gray rectangles
are printed using fonts. For all other settings of Graphic support, and for colored
graphics, it is better to leave this option unchecked and use the rectangle support provided
by the printing device.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Load all fonts as MICR If the print job is for MICR (Magnetic Ink Character Recognition)
technology then you should check this box to process the fonts accordingly.

Use outline fonts If checked, outline fonts (PostScript Type1 vector fonts) will be applied.
Usage of this fonts makes processing of the IPDS outputs more effective because font
parameters are loaded into printers just once and printers handle further settings by
themselves.

Note This option cannot be used together with raster outline fonts (the option Use
fonts for graphics just above).

Use original IOCA image data without processing Checking this option will ensure that
IOCA images are maintained as complete objects throughout the job processing. This will
help image quality but slow the spooling.

Use original JPEG image data without processing Checking this option will ensure that
JPEG images are maintained as complete objects throughout the job processing. This will
help image quality but slow the spooling.

Use original TIF image data without processing Inspire Designer offers native support
for TIF images and because of this TIF images can be included in the IPDS file without
processing, if this option is checked. The TIF image:

has to be variable (or if it is static, the option Don't place in overlays must be
checked),

needs to have the same DPI as the IPDS,

must not be resized or rotated in layout.

Embed object containers in overlays If checked, object containers are embedded in

overlays. This setting is needed mainly for older devices.

Leaving this option unchecked (default) causes that the object containers are used inde-
pendently, i.e. they are not embedded in overlays. This setting is supported mainly by
newer devices.

Prefer WIC container type behavior Select this check-box if the printer does not support
printing JPEG images using object containers they will be embedded in the IOCA con-
tainer (WIC command). The check-box is only active if Embed object containers in
overlays option has been unchecked.

Extract and reference image ICC profile If checked, the ICC profile is extracted from images
and sent to the printer separately. The ICC profile is then referenced.

The feature reduces data volume when printing large numbers of images with identical
ICC profiles. It is usable for JPG and TIF images only, so the check-box is active if Use
original JPG image data without processing or Use original TIF data without pro-
cessing options have been selected.

1300
 12.4 Engine Configuration

If you decide to use the ICC profile included in the image, it has a priority over the profile
set on the ICC Profile Setting tab.

Note This feature can only be used by printers supporting CMR resources according to
ACMA specification.

Jog page count (AOS) If there is a number entered, the given number of printed sheets is
slightly moved in the output tray.

Example Jog page count is set to 1000.

Note It is also possible to have the Jog option activated by changes of sheet names in
Output.

If the Jog option is enabled both here (in Production) and in Output of the workflow being
run, both will be applied as required by changing sheet names in Output and by sheet
count in Production.

However, remember that any option set in the Output module of a workflow, only applies
to that workflow but when an option is set here in the Production environment it applies
to all jobs printed using this engine config profile.

Restart separator pages Selecting or typing a number here will define the number of blank
sheets that will be inserted as job separators should the print job be stopped (either inten-
tionally or by error) and then restarted.

Pause job after page # Entering a page number here will define that printing of the job
will be paused immediately after that page has been printed.

When printing, this gives the Event Description log message Break on quantity. When
the job is resumed, then the job will continue from the next page

Reset CMT table when not defined A Reset CMT (Color Mapping Table) tells the printer
not to transform the color information found in the document. Checking this option will
ensure that colors are not transformed unless an alternative (normal) CMT has been
defined.

Maximum Page Length Some printers, or at least printer languages, have a preset limit on
page length. By entering a maximum page length here, the spooling of larger pages is
prevented.

By default there is 1000 mm set (X or Y page extent in the direction of the paper feed).
Check your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

Preload resources When checked, all resources such as overlays will be loaded to the
printer at the beginning of the job.

1301
12 Production

This decreases the possibility of the job having to pause (clutch) between pages while new
resources load to the printer.

Load full fonts from encoding When checked, complete fonts will be loaded to the printer
using the codec that is chosen in the combo-box.

In the combo-box, select a codec. You can further modify that codec using the buttons
below the combo-box. See the separate section Text Encoding for more details.

This decreases the need to continually reload characters as they are used. Also, only those
characters that apply to that specific codec are loaded which reduces the spooling time.

When Preload resources is also checked, all fonts used will be loaded to the printer at
the beginning of the job.

Device Settings (for CMR) The attributes here relate to the printing device that will be used
to print jobs using this engine config profile. Some other parameters of this engine profile
(e.g. CMR color selection) depend on them being filled out correctly.

Manufacturer name Enter here the manufacturer of the printing device.

Device type Enter here which series of printing device, from that manufacturer, will be
used.

Device type Enter here which model of printing device, in that series, will be used.

Merge static objects into overlay When checked, all static objects on a page are merged
into a single overlay providing that they are in an optimized Z-order.

An optimized static objects Z-order is where all of the static objects are in consecutive
layers on the page in the layout of a workflow. This means that they will be processed
consecutively.

Example In the workflow being printed, this can be done via the Layout Tree by
simply ensuring that static objects are next to each other:

The highlighted objects on the FirstPage here are all static objects

Alternatively there is the Optimize Static Objects Order feature which rearranges the
objects in the same way throughout the entire layout design. Go to Layout menu:
Edit | Optimize | Static Objects Order.

If left unchecked, static objects (text, images) will be placed in separate overlays. For images,
leaving this option unchecked has the same impact as using the Place native image in
overlay check-box on the Image Layout Properties tab.

An advantage of leaving this option unchecked is to make better use of white space on
a page, that would not be available if two or more static objects are separated but still
appear in the same overlay. Also, generating static texts along with images in one overlay

1302
 12.4 Engine Configuration

might significantly deteriorate the text's quality. However, treating static objects separately
will increase the spooling time.

It is recommended to uncheck this option also in case that a large design has been created
in Layout.

Note In case that the objects overlap and this option is unchecked, it is necessary to set
white processing carefully, as it is handled by the output engine settings. It is recommended
to set it to Auto, for which the only disadvantage can be slower speed.

Color Management Tab

The options that are not described here are described in the separate ICC Profile Setting section.

Ignore CMYK ICC profiles for handling groups Ignores all CMYK ICC profiles for any
objects placed in the handling groups listed in the edit-box to the right.

Some objects in a workflow may have attached CMYK ICC Profiles that are not required.
They can be assigned to a handling group in the workflow (via the Position tab of the
Layout module) and then those groups can be listed here. List the handling groups separ-
ated by commas, e.g. 2, 5, 8.

Attach ICC Profiles with rendering intents Checking this check-box attaches all ICC profiles
used in the workflow with their rendering intents to the spool file, i.e. the profiles are in-
cluded into the IPDS stream. This step helps the spool file to be device independent.

Be aware that if you attach ICC profiles to the job and select to Extract and reference image
ICC profile at the same time, the image's ICC profile (if available) has a priority over the
default profile attached using the check-box on this tab.

1303
12 Production

Use colorant combinations for indexed colorants Enabling this check-box allows to
combine colorants. Before using such combinations you might consider and try out
whether the knockout or overprint technique suit better your printing purposes.

Map black color to OCA black If checked, RGB, CMYK or CIELab black colors used in the
Layout will always be printed as "black", i.e. they will not be affected by any color man-
agement settings (ICC profiles).

The option is checked by default.

Note Attach ICC Profiles with rendering intents and Use colorant combinations for
indexed colorants can only be used by printers supporting CMR resources according to ACMA
specification.

See the ICC Profiles section for further information (general and/or production engine related)
about color management and ICC profiles.

Dithering Tab

The options that are not described below are described in the separate Dithering section.

Options Description

DPI for preview Selects a resolution by which the dithering preview in the Edit Dithering
dialog (which opens when any dithering Component is clicked on) is calculated.

The intention is that the dithering results of the intended printer can be better simulated
by selecting the printer's DPI in this combo-box. Select from: 240, 300, 360, 480, 600 or
1200.

Printer will apply LUT and halftone data If checked, activates the options LUT curve and
Generic halftone.

This means the method of calculation of any tone transfer (LUT) curve or halftone is
communicated to the printer in the manner that is specified by those options. And the
calculations are performed by the printing device.

1304
 12.4 Engine Configuration

If left unchecked, LUT curve calculation is applied by Inspire Designer using the other set-
tings on the Dithering tab.

LUT curve Specifies which method the printing device will use to calculate the tone transfer
curve if the option Printer will apply LUT and halftone data has been checked. Select
from:

Upload Sends the calculation of any tone transfer (LUT) curve that has been
specified on this tab to the printer so that it will apply them.

The printer must support tone transfer CMR data. If the printer is not capable of
applying it, then a warning will be shown in the Log window-pane during pro-
cessing.

In addition, the correct printing device must be declared in the Device Settings
(for CMR) area on the Advanced tab. If the device is not correct then the curve
may still be calculated correctly, if that device has the corresponding conversion
table.

Standard, Highlight midtone, Accutone or Dark Determines that the LUT curve
will be applied according to the name preset by the printer.

The actual curve that will result is dependent on the printing device.

Generic halftone Specifies the halftone that the printer should apply. Select from:

Not set No halftone will be applied.

Any other halftone in the combo-box menu Sends a command that the printer
should apply that particular halftone.

The actual halftone that will result is dependent on the printing device.

Indexing Tab

Options Description

Enable page log When enabled, it writes page counters and the values of the sheet names
into a log file.

Update after Determines when the page log is updated:

Printed The log is updated after every printed sheet.

Sent The log is updated after every sheet sent to the printer (or after every n
sheets according to the value set in Pages per acknowledge on the General tab).

1305
12 Production

Sheet names count Defines the number of sheet name values written in the log file (the
highest index of a sheet name you want to log).

Example When 5 is specified, the values of sheet name 1, 2, 3, 4, 5 are logged.

File name Defines the name of the log file. %n stands for the current job name.

An IDX file contains data about printing process. The printer provides information about the
state of the pages to be printed.

In the IDX file there is the following data:

PreparedPage

SentPage

PrintedPage

PrintedCopy

StackedPage

SheetName0

These items are listed in the order that they occur during the printing process.

Example Creating an IDX File

For the Portrait page we set the Sheet Name 1 to Portrait and Sheet Name 2 to RecordIn-
dex.

For the Landscape page we set the Sheet Name 1 to Landscape and Sheet Name 2 to
RecordIndex.

1306
 12.4 Engine Configuration

We assigned a new variable to sheet name 3 for the Pages group on the Sheet Names
tab. The variable we have chosen is Container. For description of Container variable see
the description below.

Within our Container variable we want to merge variables CustName, CustStreet and
CustZIP together. On the same array level where the desired variables are nested we have
created this new variable Container. On the Type tab we set Kind to Calculated and Type
to String. We then wrote the script below in the Code tab.

We pressed <F5> and set the Engine to IPDS. In Engine Config we went to Edit | Index-
ing. In the Indexing tab we checked Enable page log and set Sheet names count to
3.

Below is an example of the created file:

1307
12 Production

Note Not only the sheet name variables are shown, but also the page counters are
tracked.

Image Handling Tab

The image handling tab defines how different groups of images from the job will be processed.

The settings on this tab supersede any image processing commands that have been set on the
General Tab.

1308
 12.4 Engine Configuration

Options Description

Group Groupings for the images are the handling groups that can be set in Layout (the same
grouping that can be seen on the Dithering tab). 8 groups in all.

You can further go on to define the below described parameters for each of the groups.

Image processing Choose either Standard or Enhanced from the drop-down menu in the
Option column.

Selecting Enhanced reveals further parameters to be set. These are described below.

Image compression Choose here the type of compression for the image from the drop-
down menu in the Option column. Options are JPEG or TIFF LZW (lossless compres-
sion).

Note Only definable if Enhanced has been chosen for Image processing.

Compression quality Enter the percentage of compression required for the image
group in the Option column of this row.

Note Only definable if JPEG has been chosen for Image compression.

Max. DPI Enter the maximum DPI for the image group in the Option column. Use one
of the predefined values (240, 300, 480, 600) or type any other.

Any images with higher DPI values will have their quality reduced to the value selected.

Image preprocessing Choose either None or Preprocess from the drop-down menu in the
Option column.

If Preprocess is selected, the printer preprocesses objects belonging to the respective

handling group using the RPO (rasterized presentation object) structured field.

The feature is useful for processing large, complex images (e.g. backgrounds). It is not in-
tended to be applied to all objects.

12.4.14 Metacode Engine Configuration

In this section: See also:
Metacode Engine Config dialog Driver Config
Metacode Limitations Metacode Printer Configuration
Metacode Device Profiles

The Metacode engine communicates print jobs via a spool file that is written in Metacode
format.

You can further define the Metacode Engine Config, Driver Config and the Printer Config.

Selecting Metacode in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the Metacode Engine Config dialog.

1309
12 Production

12.4.14.1 Metacode Engine Config Dialog

Available tabs are:

General

DJDE Commands

Print Setting

Dithering

Advanced

General Tab

Options Description

Machine type Select the appropriate printer type:

4850 compatible (first and second generation 4050, 4090, 4890, etc.)

4635 compatible (newer printers 4180, Oc with Prism server, etc.) (default setting)

Note When loading jobs saved in PrintNet T version 6.1 and earlier, the Machine type
will be set to 4850 compatible (first and second generation 4050, 4090, 4890, etc.).

Output mode Selects among 4235, HOST, OFFLINE, XPSM, BARRSPOOL, BARR and ONLINE.

It is recommended to use BARRSPOOL, other modes were not tested.

1310
 12.4 Engine Configuration

Color Settings

Machine name Selects the type of printer that you are using. It is possible to choose
between:

Xerox (Black and white)

Xerox color (Spot color)

Xerox dithered spot color

Color Choosing Xerox Color or Xerox Dithered Spot Color activates the Color combo-
box in order for you to select one additional color that can be mapped to the defined
spot color(s) using the Assign Metacode Color to Index dialog that opens upon clicking
on the Assign button.

The values of spot colors are assigned in Layout. It is recommended to have Spot
color 0 for black.

RSTACK

Switch RSTACK on If this option is checked, the output file will contains the RSTACK
string at the beginning and end of file.

RSTACK Hex value The RSTACK String must be defined in Hexadecimal mode. The
Hexadecimal number must have an even number of characters.

File Splitting

Split file by group If checked, one spool file is created for each group.

Resource file name Sets the path and the name of an extra file that will be created
and that will contain all resources (except for in-line images). The other files will just
reference these resources.

Switch JDL on If this option is selected, the output file will contain the JDL selection order
at the beginning of the spool file.

JDL, Job Descriptor Library (Xerox), is a file describing controller settings and is used while
printing, therefore it needs to be stored on the printer for the duration of the print job.

Tip If this option is not selected, the JDL can be selected by an operator at the printer.

See also: JSL file

Switch JDE on If this option is selected, the output file contains the JDE selection order at
the beginning of the spool file.

JDE, Job Descriptor Entry (Xerox), is a file describing page size and is used while printing,
therefore it needs to be stored on the printer for the duration of the print job.

Tip If this option is not selected, the JDE can be selected by an operator at the printer.

See also: JSL file

Use compression Checking this option enables compression for all resources (including
overlays).

1311
12 Production

DJDE Commands Tab

Options Description

DJDE Syntax

Iden prefix String used for prefix (default: DJDE).

Mode prefix Two choices for writing Iden Prefix:

ASCII

EBCDIC

DJDE encoding These are all command characters ASCII or EBCDIC coded.

Skip Position of the DJDE command on metacode record.

Offset Position of Iden prefix on metacode record.

Mode JDL Two choices for writing JDL and JDE selected:

ASCII

EBCDIC

Take Additional DJDE Commands from Sheet Name

Document DJDE commands If checked, you can specify the index of a sheet name
which contains the DJDE Document Commands. This command is valid for the whole
document (it appears there only once).

DJDE Page pre-commands If checked, you can specify the index of a sheet name which
contains the DJDE Page Commands. These commands will be inserted at the end of
the previous page.

1312
 12.4 Engine Configuration

This option is useful for e.g. creating copies because the copy command needs to be
inserted one page before the page that is to be copied.

DJDE Page inline-commands If checked, you can specify the index of a sheet name
which contains the DJDE Page Commands. These commands will be inserted at the
current page.

Example Sample of command for inserting image (with default setting ASCII):

IMAGE=(IMGNAME,294DOTS,354DOTS,(INK,'BLACK'))

Replace non-EBCDIC characters with Specifies the character that is used for replacing
non-EBCDIC character.

Print Setting Tab

Options Description

White processing Selects whether the colors of text and images should be printed over any
background, or if the background should be cut out where any text or images are to be
printed.

For a description see the White Processing section.

Encoding

Text encoding Checking this box defines that text encoding will be used for the files
text.

Furthermore, you can select the codec that you require for your texts language from
the combo-box menu.

See the separate section Text Encoding for more details.

Keep glyphs positions within words Uncheck this box if you do not want character
positions to be altered within the string of one word if realignment takes place. Posi-
tions will only be altered in between words. See also the section PCL Engine Config-
uration.

1313
12 Production

Resource Limitation Sets limits to the amount of resources that is created when spooling
a job. These can be set according to the capability of the printer to avoid exceeding its
memory.

Enter here the Maximum Number of Fonts Per Job and the Maximum Number of
Images Per Page.

Load overlay If checked, any static pictures will be loaded as overlays.

Use fonts for graphics If checked, black and white graphics are stored as individual font
characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering type
is used (for details on matrix dithering types see the Edit Dithering dialog section). It is
most useful with variable graphics (it works for overlays that are not merged as well, but
to less advantage) and this option was implemented to speed up the processing of 2D bar
charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create a
9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, depending
on the position of the rectangle, and the image content data would be just 32 bytes
with usually an additional overhead.

For colored graphics it is better to leave this option unchecked.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Optimize variable images If checked, overlay images are compared and, if they are already
stored in resources, they are reused to avoid duplicating.

The second appearance of images will put these images into resources.

Dithering Tab
See the separate Dithering section.

1314
 12.4 Engine Configuration

Advanced Tab

Options Description

Resize Barcodes See the Resize Barcodes section.

Page Extent

Maximum page length Your printer will have a preset maximum page length. By en-
tering that maximum page length here the spooling of any larger pages will be pre-
vented.

The measurement units can be changed by right-clicking on the symbol.

ICC Profile Setting See the separate ICC Profile Setting section.

12.4.14.2 Metacode Recommendations and Limitations

White Processing Error
If the error message: "Unable to Use White Processing" is shown set this error to be ignored
when you click in the Production window on Warnings button and set the 3501 warning as
shown below:

1315
12 Production

It can happen, because the default settings for White Processing were changed between 4.1
and 4.2 version of PrintNet T (instead of Never there is Auto option by default).

Resources
When printing Metacode, the resources are loaded inline. That means that the resources are
loaded to the controller on-demand (only when they are needed) and they are replaced in
controller memory on the next duplex page by other resources to be printed.

If you print in simplex mode, the resource is deleted on the second following page (current
page index + 2). This is to avoid controller's memory overflow.

Maximum Image and Font Count

The maximum count of images on one page and the maximum font count for a job are depend-
ent on the printer. Check the printer specifications.

Text on Curve
Using Text on Curve and/or Clipping Path is not recommended because it significantly increases
the number of fonts and the maximum font number could easily be exceeded.

Dynamic Tables and Flows

In Metacode it is not recommended to use dynamic tables because they make printing much
slower. Create static table instead and place another table (with just the variable data) over it.

The same applies to flows. If there is a long flow with just a short variable part, it is better to
have the variable flow separate in another flow area and to have this flow area placed over
the flow are with the static part of flow.

1316
 12.4 Engine Configuration

Static and Dynamic Objects in the Layout Tree

It is recommended to move static objects next to each other in the Layout tree. This has an
impact on the order of printing in Metacode (and no impact on displaying in Inspire Designer).
If there are more static objects next to each other, they get printed as one image which is im-
portant due to maximum image count on page.

Sometimes it may be more convenient for printing to have a group of dynamic objects in
between two groups of static objects (thus the area with static objects is divided).

Example See two possible solutions in Layout tree for the sample page:

Overlays
For Metacode output it is recommended to keep the number of overlays low. To ensure this
go to Overlays Properties section of the Layout Properties dialog and leave only the options
Use overlays for static objects and Optimize static paragraphs checked.

1317
12 Production

Border/Shading Style as Font

The option Use font for graphics on the Print Setting tab should be enabled. However, this
feature will not work for border styles where the border is not full.

In the below table, the header row will become a font character (including the shading), but
the body rows borders, where the margin vertical lines are missing, will be printed as image.

It is possible to use the following workaround to print them also as font characters:

1. First, we need to find out what border style the table cells use. Click into a table body
cell and in the contextual menu select the Table Border Style option. The border style
name is displayed at the top of the Border Properties dialog that opens.

2. Go to the BorderStyles family in the Layout Tree and select the border style whose
name you have just discovered. On the Lines/Corners tab of the Layout Properties you
can see which line fill styles are assigned to which lines.

3. Next, clone the fill style. Click on the Go to icon next to the fill style name this will
select the node of the fill style in the Layout Tree. In its right-click menu choose the
Clone option.

1318
 12.4 Engine Configuration

4. Go back to the border style and set this new (but identical) fill style for the vertical line
of the table border.

The aim is to have different fill styles for horizontal and vertical lines of the border style.
Do this for all other vertical lines of the table cells.

After this is done, the option Use fonts for graphics will always work.

JSL File
A JSL file is a text file necessary for printing Metacode. Depending on the Machine type setting,
different JSL file has to be used: GMCON for 4850 compatible printers, GMCOP for 4635
compatible printers.

The file needs to be uploaded and saved on the hard disk of the controller. When it is compiled,
two files *.JDL and *.JDE are created.

JDL
Controller settings. These parameters must correspond to those set in Production in Inspire De-
signer.

The most important are:

CON=X'131313131313'; RSTACK string

PRE=A'DJDE' OFF=0, SKIP=5; Prefix

PCCTYPE=IBM3211 Communication channel setting

The only difference between the GMCON and GMCOP file is that the FONTINDEX parameter
is not specified in the GMCOP file.

GMCON:JDL;
VOLUME HOST=IBMONL

CODE=NONE;
T1:TABLE CON=X'131313131313';
C1:CRITERIA CON=(1,6,EQ,T1);
RSTACK TEST=C1,DELIMITER=YES;

1319
12 Production

VFU1:VFU ASS=(1,1),ASS=(12,255)

TOF=1,BOF=255;
PDE1:PDE PMO=POR

BEGIN=(0,0)

FONT=R812BP;
IDEN OPRINFO=NO

PRE=A'DJDE'

OFF=0

SKIP=5;
LIN DAT=(2,255)

PCC=(0,NOTRAN)

VFU=VFU1

PCCTYPE=IBM3211

FCB=IGN

FONTINDEX=(0,ZERO,7)

OVERPRINT=PRINT

MAR=(0);
OUT COP=1

GRA=YES

FORMAT=PDE1;
RECORD LENGTH=255;

JDE
Page size setting (in inches; if different units they must be specified).

Note Default setting corresponds to sizes set in the Output Module, but some controllers
may not read all page sizes.

DFLT:JDE; OUTPUT PAPERSIZE=A4;

A4:JDE; OUTPUT PAPERSIZE=(8.27,11.69) FORMAT=PDE1;
USLETT:JDE; OUTPUT PAPERSIZE=USLETTER;
END;END;

1320
 12.4 Engine Configuration

12.4.15 MIBF
12.4.15.1 MIBF Engine Configuration
See also:
Driver Configuration Overview
MIBF Page Side Configuration
MIBF Engine Command Line Parameters

The MIBF engine produces files to Miyakoshi specification. Miyakoshi printers can understand
the MIBF language.

You can define the MIBF Engine Config and the Driver Config.

When MIBF is selected in the Engine combo-box, clicking on the Edit button in the Engine
Config area opens the MIBF Engine Config dialog.

Note If you use the MIBF engine for spooling a duplex print job with the Split by group option
activated, printing of a group with odd number of pages, e.g. a 1-page group, may start on
the reverse side of a duplex page. If this happens, the warning "Starting on back side of duplex
page" will appear in the production message area. To prevent this issue it is recommended to
use the Sheet Inserter module.

MIBF Engine Config Dialog

Available tabs are:

General

Printers

Resources

ICC Profile

Image Handling

Advanced

Changes made here can be verified by using the Verify button at the bottom of the dialog.
This searches for incorrect or unusual settings and potential problems. The following check is
done:

identical color assignments for 2 different BIPs (Bitmap Image Processors)

CMYK has 4 colors

number of used heads

number of licensed heads

1321
12 Production

General Tab

Options Description

File Format You can select from:

Combined files MB2 The output will be created as a combined file, i.e. fonts and
page data are stored in the same file.

Separated files MB2 The output will be created with separate files for fonts and
page data for each printer head.

Head Setting

Width of heads Selects the width of heads of the printer (in pixels) to be used from
the drop-down list:

11760 and 5880

12790 and 6395

17906 and 8953

23040 and 11520

These widths are based on Miyakoshi printer specification.

Note When an object is placed outside the printing area defined by the Width of
heads option, a warning message will be issued while spooling the job and the object
will be cropped.

Resolution of heads Selects the resolution of printers heads in DPI. Available values
depend on the selected width of heads:

For the widths of 23040 and 11520 it is:

1200 x 1200

1200 x 600

1200 x 480

1322
 12.4 Engine Configuration

1200 x 400

1200 x 300

For all other widths it is:

600 x 1200

600 x 600

600 x 480

600 x 400

600 x 300

Size Limitation

Check size limitation Specifies a maximum size for the resources in the Limitation
size (MB) combo-box.

Printers Tab

The Printers Tab lists how the different sides of the print media will be printed.

Double-clicking on a row, or clicking on the Configure icon, opens the MIBF Page Side
Config dialog for the Page side that the row relates to. Using that dialog you can edit the
printing formation for that single side.

Selecting a row and clicking on the Delete icon, deletes all of the property rows for that
Page Side.

Clicking on the Delete All icon deletes all of the set properties.

1323
12 Production

Resources Tab

Options Description

Compression

Use compression for images / Use compression for fonts If checked, apply compres-
sion to contained images / fonts.

The resulting spool file will be smaller but the spooling process may be slower.

Other

Use temp files If checked, processes images as temporary files, reducing memory usage.

Use fonts for graphics If checked, black and white graphics are stored as individual
font characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering
type is used (for details on matrix dithering types see the Edit Dithering dialog section).
It is most useful with variable graphics (it works for overlays that are not merged as
well, but to less advantage) and this option was implemented to speed up the pro-
cessing of 2D bar charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create
a 9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, de-
pending on the position of the rectangle, and the image content data would be
just 32 bytes with usually an additional overhead.

For colored graphics it is better to leave this option unchecked.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Merge static objects into single overlay If checked, all of the static objects are put
into a single overlay.

If left unchecked, the static objects are sent to the printer one by one, which slows
down the spooling process.

Leave it unchecked to allow generating all native PDF images as external EPS.

1324
 12.4 Engine Configuration

It is recommended to uncheck this option also in case that a large design has been
created in Layout.

Note In case that the objects overlap and this option is unchecked, it is necessary
to set white processing carefully, as it is handled by the output engine settings. It is
recommended to set it to Auto, for which the only disadvantage can be slower speed.

Size optimization Selects a level of size optimization:

None No optimization is applied.

Low (overlays) Standard optimization; suitable for most jobs. Overlay images
are compared and if they are already stored in resources, they are reused to
avoid duplicating. The second appearance of images will put these images
into resources.

High (variable images) High level of optimization with higher memory de-
mands. The second appearance of variable images will put these images into
resources.

High (overlays + variable images) High level of optimization; combination of

the two preceding options.

ICC Profile Tab

See the separate ICC Profile Setting section for details.

Image Handling Tab

Options Description

Global Non-Resident Images Global non resident images should be listed in a TXT file.
Enter should be the separator between the image names.

1325
12 Production

Example C:\images\dog.jpg

cat.tif

C:\images\mouse.bmp

The path does not have to be entered but if there is more than one file of the same
name as resident then they will also be ignored when creating the spool file.

Text file encoding Selects the codec for the text used in the list from the Text file
encoding combo-box menu.

See a separate chapter Text Encoding.

List of non-resident images The location of the text file should be entered in the List
of non-resident images combo-box and can be browsed for using the Browse
icon.

Image Processing by Handling Group The options in this table are for classifying which
images are non-resident and which are resident.

First the images must be assigned to separate handling groups in the Layout of the
workflow to be printed. Then each of the 8 possible handling groups is listed as a Com-
ponent of the tree and the following group dependent parameters can be adjusted:

Image storing Assigns the images in that handling group to be either:

Resident Stored in a font file as a resource to be loaded once.

Non-resident Loaded each time that they appear on the pages being pro-
cessed. This will result in slower spooling.

Suppress mask Ignores any masks that are being used, for images of this handling
group, by selecting On.

Masks work in a similar way to white processing and are created in the spooling of
full-color images to deal with printing the separate color-layers of images and their
transparency, especially if a transparent image is placed over another one.

Example If a transparent image (1) is placed over another image (2), then it
is actually not desired to print the parts of image 2 where the non-transparent
parts of image 1 will be printed so a mask of image 2 is created with those parts
knocked-out of it.

Masks are stored as resources and use up printer memory.

External storing Determines if images should be stored externally, i.e. the spool file
will only contain references to them.

When printing the job, the references from the spool file are used to identify the ex-
ternal images and print them.

If setting Yes for any group of images, those images must not be modified by the
workflow being printed, i.e. no rotation (except for 90, 180 and 270 degrees), no

1326
 12.4 Engine Configuration

color changes and no stretching, shrinking or resizing of any kind is permitted. Also,
any static images to be stored externally must have the Keep out of overlay option
enabled in Layout.

If the external images are vector (e.g. EPS or PDF), also check the option Use image
DPI, on the Image tab of each image, in the Layout of the workflow being printed.

If the external images are raster (e.g. BMP, TIF, GIF or JPG), ensure that you uncheck
the option Use image DPI and set the image's DPI to the DPI of the head.

Native PDF image processing Selects how to handle images from natively imported
PDF files:

Standard Images are always included in the spool file.

External EPS External images in EPS format are generated. To make sure that
all PDF images (including static ones) are generated as EPS, leave the Merge
static object into single overlay check-box disabled (see the Resources tab).

Note The settings in the option External storing has no effect on images from
natively imported PDF files.

Primer type Selects the shape of the primer coat for objects in the handling group:

Rectangle Coats the printed glyphs, images etc. with a rectangular shape
of primer.

Mask Covers the printed glyphs, images etc. according to their own shape.

Note Primers can be printed using BIPs 4 to 7 (see Used BIPs on the General tab)
and the option Additional size of primer on the Advanced tab of the Page Side
Config dialog also affects how the primer covers the print.

Advanced Tab

1327
12 Production

Options Description

Resize Barcodes See the separate Resize Barcodes section for details.

DPI for EPS/PDF

Use resolution of heads If checked, the EPS/PDF resolution settings are copied from
the heads' settings in the General tab.

DPI for EPS/PDF The two edit-boxes specify the DPI intended for EPS/PDF images. The
edit-boxes are inactive, if the Use resolution heads check-box is enabled.

12.4.15.2 MIBF Page Side Configuration

The MIBF Page Side Configuration dialog edits the settings for printing a single side of the print
medium. It can be opened by clicking on the Configure icon on the Printers tab of the MIBF
Engine Config dialog or double-clicking on a row in the Printers tab's list of BIPs (Bitmap Image
Processors).

MIBF Page Side Config Dialog

Available tabs are:

General

Dithering

Advanced

General Tab

1328
 12.4 Engine Configuration

Options Description

Font Setting

Glyph code length (B) Select from the drop-down menu of the combo-box a length
for the code of the glyphs. The options are 1 or 2 bytes.

Color & White Processing

Output colors Defines the palettes used for all colors (text, overlays and pictures). Select
from the combo-box menu:

Black and white Prints the colors by dithering black and white dots.

Further select dithering patterns on the Dithering tab.

CMYK split Prints the colors by dithering CMYK based dots.

Each plane of C, M, Y and K is dithered independently and the resulting

dithering pattern uses cyan, magenta, yellow, black, red, blue, green and
white dots. Further select dithering patterns on the Dithering tab.

Spot colors Prints the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can
be done via the Color dialog.

Dithered spot color Prints the colors by dithering spot colors or black and
white dots.

Dithered spot colors should be assigned to each of the colors in the workflow,
this can be done via the Color dialog. Colored objects that use colors that are
not assigned as dithered spot colors are dithered using black and white dots.
Further select dithering patterns on the Dithering tab.

CMYK split + dithered colorants Prints the colors by dithering colorants or

dithering CMYK based dots.

Colorants should be assigned to each of the colors in the workflow, this can
be done via the Color dialog. Colored objects that use colors that are not as-
signed as colorants are dithered using cyan, magenta, yellow, black, red, blue,
green and white colored dots. Further select dithering patterns on the
Dithering tab.

White processing Select from the drop down menu of the combo-box; Always, Never,
Auto or Text. For all options except Never you can also select to Use never for black
printer by checking this box. This will recognize if the job is being printed as Black
and white and set Never for that event only.

See the separate White Processing help page for a description of the options.

1329
12 Production

Page & Side

Page for printers Displays the output media page assigned.

This field is inactive but allows you to see the chosen setting from the Printers tab of
the MIBF Engine Config dialog.

Side of page Specifies Front or Back page side. Changing it here automatically changes
the settings in the Printers tab of the MIBF Engine Config dialog.

Used BIP Defines which BIPs process which colors.

BIPs are bitmap image processors. The default settings for each of the Output colors differ
according to the requirements of the particular color format.

Select the BIPs that will be used by checking the respective boxes. Select the color that
you would like them to process in the respective Color combo-boxes. For BIPs 4 to 7, it
is also possible to select Primer, which is intended for use when coating the print with a
primer.

Clicking on the Set Default Color Assignment button returns the colors to the processors
assigned to them by default.

Dithering Tab
See the separate section on Dithering.

Advanced Tab

Options Description

Trapping Font trapping can be used if printer heads are not calibrated precisely. The objective
is to make the white space between the font layer and the background layer as small as
possible. Trapping units are pixels.

Use trapping Check the Use Trapping check box to activate the trapping attributes for
editing:

Size of font trapping Sets the size of font trapping in pixels.

Size of bitmap trapping Sets the size of bitmap trapping in pixels.

1330
 12.4 Engine Configuration

Primer A primer is a transparent coating that is printed over the other printed objects on a
medium. Page sides can be primed using BIPs 4 to 7 (see Used BIPs on the General tab).

Additional size of primer Determines the relation between the primer coat and the
print that it covers. Enter positive values for primer coat exceeding the print shapes
and negative values for primer coat reduced below the print shapes size. Units are
dots.

Example Handling Group 3 contains just flow areas with text of a particular
font, e.g.:

If 2 is entered here and Mask is selected as the Primer type for Handling Group
3 (Image Handling tab), then that font would be coated according to the shape
of the characters with an extra border of primer around each character of 2 dots
in width, e.g.:

In the screenshot above the cream color represents the primer coat. Notice how
there is an extra border of primer beyond the size of the glyphs.

12.4.16 Multi Engine Configuration

In this section:
Multiple Engine Config Dialog

Multi engine enables you to stack several engines and define their parameters. This is meant
for page oriented engines that create spool files. For this reason IPDS, HTML, Text and Desktop
Printer engines are not suitable.

Selecting Multi in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Multiple Engine Config dialog.

1331
12 Production

12.4.16.1 Multiple Engine Config Dialog

Options Description

Common The options here apply to all selected engines, so that the output spool files are
all split in the same way.

For a description of the Split by group, Split by size options and Size option, see the
section Driver configuration.

Table Enter the engines to the table by clicking on the Create New icon and select the
engine in the Add Engine dialog that opens. In this dialog you can also load available engine
and printer configurations.

Engine The engine type.

Engine Config Clicking on the 3 Dots icon opens the relevant engine configuration
dialog. E.g.:

Printer Config Clicking on the 3 Dots icon opens the relevant printer configuration
dialog if a printer configuration is required.

File Determines the path to the directory, where the spool file should be created, and
the spool file's name.

1332
 12.4 Engine Configuration

Clicking on the 3 Dots icon opens a Save As dialog to aid the location of a suitable
directory.

For a description of substitution characters used in File column, see the separate
section Substitution Characters.

12.4.17 NexPress VDX Engine Configuration

In this section: See also:
NexPress VDX Engine Config dialog Driver Config
NexPress VDX Device Profiles

The NexPress VDX Engine produces spool files in Variable Data eXchange (.VDX) format, which
combines both PPML and PDF formats so as to fit the needs of variable data printing.

The variable data job and its composite layout and organization are described using a subset
of the features of PPML. This PPML data is stored as a PDF stream object within a PDF file,
therefore every PPML/VDX instance contains a PPML/VDX Layout file (.PDF).

You can further define the NexPress VDX Engine Config and the Engine Config and the Driver
Config.

Selecting NexPressVDX in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the NexPress VDX Engine Config dialog.

12.4.17.1 NexPress VDX Engine Config Dialog

Available tabs are:

General

Graphics

General Tab

1333
12 Production

Options Description

Compression When checked then the PDF file content will be compressed which results in
a smaller final file size.

Page extent Most printers have a preset limitation on the length of page that they can
process. By entering that Maximum page length here the spooling of any larger pages
will be prevented.

By default there is 10000 mm set (page extent in the direction of the paper feed). Check
your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

Resize barcodes See the Resize Barcodes section.

Create ANSI VDX Selecting this option determines that the VDX file produced will conform
to the newer PPML/VDX CGATS.20 ANSI standard.

Selecting this option is recommended.

Graphics Tab

1334
 12.4 Engine Configuration

Options Description

Variable EPS /PDF Output Resolution Enter here a desired resolution for your output
quality. Units are DPI.

Colorspace For more details on color definition, see the separate sections Colors and Color
Spaces.

Text and graphics Select here the color space to be used for the text and graphics from
the combo-box menu:

Take from Layout color Applies the colors used in the Layout of the workflow,
i.e. colors are not converted.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

Force Lab Processes all colors using the Lab system.

Images Select here the color space to be used for the images from the combo-box
menu:

Take from Layout image Applies colors as they have been defined in the
Layout of the workflow, i.e. image colors are not converted.

Example On the Advanced Tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions
such as CMYK will be converted to RGB at that point and then RGB will
be the colorspace used by this engine if Take from Layout image is selec-
ted here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

Use separation and DeviceN colorspaces Checking Use separation color spaces
and DeviceN Colors employs the separation colors, that have been defined in Layout,
as color identifiers in the output. This allows printers that are coordinated with the
Device N or Separation color system to recognize them.

Append ICC profile to images Checking this option includes a standard ICC color
profile of each of the images of a job.

See the separate section ICC Profiles.

Apply color management conversions only on colorspace change Checking this

option defines that any conversions selected in the Text and graphics and Images
combo-boxes will only happen when the color spaces of the objects differ from the
target colorspace.

1335
12 Production

JPEG Compression

Use JPEG Compression Select from the combo-box menu how you would like to apply
JPEG Compression:

For all pictures compression will be performed on all images included in a

job except palletized and JPG images. A JPEG image has already been com-
pressed using JPEG compression and no further compression is applied.

For JPEGs only maintains the existing compression on JPG images, i.e. no
compression is performed except if the image has to be decompressed during
processing (e.g. Adobe Marker is not supported by Adobe Acrobat Reader
and if it has been used on the JPG image then it must be decompressed to
remove it). Other images are converted to bitmaps.

Never All pictures, regardless of image format, are stored as bitmaps.

Compression Quality Enter in the combo-box the desired level of compression to be

performed on all images that are to be compressed.

A quality level of 0 corresponds to the greatest compression (and the lowest quality),
and a quality level of 100 corresponds to the least compression (and the highest
quality).

ICC Profile Setting See the separate ICC Profile Setting section.

12.4.18 PCL Engine Configuration

In this section: See also:
PCL Engine Config Dialog Driver Config
PCL Printer Configuration
PCL Device Profiles

The PCL Engine uses PCL5 format for black and white printing and PCL5C format for color
printing. PCL (Printer Control Language) was formulated by Hewlett Packard and is a printing
protocol which almost all HP printers can interpret.

You can further define the PCL Engine Config, Driver Config and the Printer Config.

Selecting PCL in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the PCL Engine Config dialog.

12.4.18.1 PCL Engine Config Dialog

Available tabs are:

General

PJL Commands

Dithering

1336
 12.4 Engine Configuration

Text Options

Advanced

General Tab

Options Description

Printer resolution Select here the desired resolution for the generated spool file.

Besides the three preset DPI values available in the combo-box it is possible to type any
DPI value directly. This may be useful when entering non-standard DPI values calculated
from metric typographic units.

Note When the Printer resolution option is set to 600 DPI, the Font format option
has to be set to PCL 5 to have the fonts printed correctly.

Output colors Selects the intended output colors from the combo-box menu. It can be
either: Black and white, Full color, Spot color, Dithered spot color, Device colorants or Full
color + dithered colorants.

If Device colorants is selected, the layout design should only employ three colors. Addition-
ally, those colors must have been designated as colorants in the Color dialog. This is done
by assigning unique colorant names that correspond to the names of the toners used by
the device. For example, an Oc device might have a toner called oct20a01 and so the
name given to the corresponding colorant should be oct20a01.

Use only CMY colors If checked, the PCL output file is generated using the CMY colors. It
may be useful, when the intended printer supports the CMY(K) colors only.

If unchecked (default), colors defined in Layout are used for production allows to avoid
the conversion to CMY.

This option is available if either the Full color or the Full color + dithered colorants option
in the Output colors combo-box is selected.

1337
12 Production

Assign colors to index Only selectable if Spot color or Dithered spot color is selected in the
Output colors combo box.

Click on the Assign button to open the Assign PCL Color to Index dialog, where you can
re-assign spot colors that have been defined in Layout to individual colors for PCL (the
drop-down menus in the PCL color column reveal the choice of colors available). The res-
ulting printed color actually depends on the printer.

Use highlight colors Only selectable if Spot color or Dithered spot color is selected in the
Output colors combo box.

Checking this box will set highlight colors to be assigned to the spot colors and printed,
as an alternative to assigning the spot colors to an indexed PCL color.

A highlight color is referenced by a number in PCL and therefore the corresponding spot
color number can be matched automatically.

White processing See the separate White Processing section.

Font format Allows a choice between the following font formats:

DeskJet Font format 0.

LaserJet Font format 0, header length like for font format 20. This font format
should be used for printers which only support font format 0 but require the
header length for font format 20.

PCL 5 Font format 20.

Do not use overlay Checking this box will mean that overlays are left undefined.

Note Overlays significantly reduce file size as static objects are stored only once in the
file even if they are used multiple times. Only references to the objects are then used then
further in the file.

Only check this option if your printer does not support overlay description.

Image compression Selects the compression method for images. The available variants are:
TIFF, Delta row and Adaptive compression.

It is recommended to use Delta row and Adaptive methods because they achieve better
compression ratio, Adaptive evaluating each line separately (whether to use the Delta row
compression or no compression at all). TIFF was used for image compression by default
in PrintNet T version 5.2 and lower.

Kerning not supported by printer Check this box if your printer does not support kerning.

Kerning automatically adjusts inter-character spacing. This can be activated for individual
text styles in Layout.

Allow single file splitting When checked, a single output PCL file will be split into subsec-
tions according to the options of the Driver Config on the production window panel (Split
by group or Split by size).

Only for use with Native or Lpr printer driver configurations.

1338
 12.4 Engine Configuration

Example For generating one PCL file only which is not defined by GPD but still
requires finishing operations (stapling, etc.). Therefore, groups must be defined
within that file for reference as to where the finishing operation should take place.

Note Not recommended for using if GPD files are being used to define a print job, either
linked to the job via the PCL Device Profiles in Output or the PCL Printer Configuration.

If this option is not checked then using split options (Split by group or Split by size) will
produce split files that are repeatedly overwritten and the final PCL file will be only the
last split section of the job. To avoid this you can also use the file naming protocol %g
group counter, %I split counter, see the separate section Driver Configuration Overview
for more details.

Use permanent resources This option stores all used Fonts and Macros permanently and
draws on them should the Engine Config profile be used again.

This is a recommended safeguard against these resources being overwritten when page
commands contain PJL commands, Reset commands or Allow single file splitting has
been checked. It should also be used if GPD files are being used.

Suppress initial reset Checking this option means that no UEL (Universal Exit Language) or
Printer Reset command will appear at the beginning of the spool file.

Some models of printer do not recognize the initial reset command that appears at the
start of PCL spool files created by Inspire Designer (e.g. OCE 31 series), therefore for those
printers this option should be enforced.

Reset margins after rotation If checked, the size of the unprinted vertical margin is reset
after each rotation of the medium.

This means that the PCL command Esc9 will be used after each 8a rotation command.
It is recommended to check this option in cases where media rotation is used, otherwise
the margin will remain constant even though the dimensions/position of the medium may
have changed.

PJL Commands Tab

1339
12 Production

Printer Job Language (PJL) gives software applications more job-level printer control and provides
printer status information applications. PJL provides for the special needs of networks and
other multi-user systems, in addition to enabling applications to simulate control panel functions
that previously could not be controlled without pressing control panel keys.

This can be useful when you are running a printer that supports some finishing operations.

Commands (stitching, stapling, etc.) can be inserted in this dialog at the beginning or at the
end of the job file by typing them into the Start PJL commands or End PJL commands text
fields respectively.

Substitution characters are available for variable data that will be returned by the workflow
being processed. For a list of the available characters, see the separate section Substitution
Characters.

Note If you are using a GPD file for your job definition, either linked to the job via the PCL
Device Profiles in Output or the PCL Printer Configuration, you must delete the PJL commands
here and not use any PJL commands at all, as they are incompatible.

Dithering Tab
See the separate Dithering section.

Text Options Tab

Options Description

Text encoding Checking this box defines that text encoding will be used for the files text.

Furthermore, you can select the codec that you require for your texts language from the
combo-box menu.

Note Make sure some text encoding is employed for generating of those PCL files, that
are intended for subsequent native import to Inspire Designer and further edition using
the Text in Rect module.

See the separate chapter on Text Encoding.

Keep glyphs positions within words Uncheck this box if you do not want character posi-
tions to be altered within the string of one word if realignment takes place. Positions will
only be altered in between words.

In order to have the PCL output DPI-independent and to provide kerning, there are often
small corrections of character positions required inside text flows.

1340
 12.4 Engine Configuration

When this option is checked these corrections are not applied inside of words. This results
in the possibility to search for specific words in the file content in viewers. (There are no
inter-character moves within any word, so the individual words stay whole. However,
when this option is checked, the positions of individual characters within the words may
not be precise.)

Note Do not use this option when you require precise character positioning.

It is also strongly recommended to switch off kerning in the jobs workflow when you use
this option as it interferes with character recognition. Kerning can be set in the Text Styles
Layout Properties.

Use precise metric If checked, the PCL metric will not be defined in dots but more precisely.
This ensures a more exact positioning of characters. This option depends on the printers
capability and thus it cannot be used with every printer.

Use big glyphs compression If checked, big glyphs will be compressed. This is useful for
some viewers and printers which cannot handle big glyphs.

Advanced Tab

1341
12 Production

Options Description

Maximum page length Your printer will have a preset maximum page length. By entering
that maximum page length here the spooling of any larger pages will be prevented.

The measurement units can be changed by right-clicking on the symbol.

Resize barcodes See the separate Resize Barcodes section.

Print Commands The options in this section of the tab relate to additional print commands
defined by the PCL language. The commands are created as new variables which are added
to sheet names on the Sheet names tab of a Page Layout Properties dialog. These com-
mands are inserted into the PCL output file and are specific to the printer type. The options
are:

Take initial page commands from Sheet name index If checked, you can further
define the index of a sheet name, which contains the PCL and PJL commands that
every page should be started with.

Finish page commands from Sheet name index If checked, you can specify the index
of a sheet name, which contains the PCL and PJL commands every page is finished
with.

Translate [ to escape characters PCL commands always begin with an escape character,
a byte with hexadecimal value of 0x1B. Since this escape character cannot be typed
in a sheet name directly, you can use the [ character instead and let the engine
translate it to escape character automatically.

Example The additional print commands can be used for tray selection. To
feed paper from the manual tray, set the sheet name variable to [&l2H where
[ will be replaced with the escape character.

Note It is advisable to use these additional commands only if no other way is available
because if they are not entered correctly, files can be left unprinted or misprints may occur.
If possible, use GPD files for a print job definition.

If GPD files are used to define a print job, either linked to the job via the PCL Device Profiles
in Output or the PCL Printer Configuration, it is not recommended to add any extra com-
mands.

ICC Profile Setting See the separate ICC Profile Setting section.

1342
 12.4 Engine Configuration

12.4.19 PDF Fixed Resolution Engine

Configuration
In this section: See also:
PDF Fixed Resolution Engine Config Driver Config
Dialog PDF Device Profiles
PDF Engine Command Line Parameters

The PDF fixed resolution output creates a device dependent PDF file with images, vector objects
and glyphs rasterized at a specific resolution. It is more simple than the PDF engine and ensures
that images will maintain the appropriate resolution.

It is also possible to generate simple vector objects containing lines only for cases when a fixed
job resolution is required instead of a mix of raster and vector resources.

You can further define the PDF Fixed Resolution Engine Config and the Driver Config.

Selecting PDF Fixed Resolution in the Engine combo-box and clicking on the Edit button in
the Engine Config area displays the PDF Fixed Resolution Engine Config dialog.

12.4.19.1 PDF Fixed Resolution Engine Config Dialog

Available tabs are:

General

Fonts

Dithering

Splitting

Acrobat (described in the PDF Engine Configuration section)

1343
12 Production

General Tab

Options Description

Printer resolution X Select from the combo-box menu the resolution that the file should
be in the X plane. The predefined options are 240, 300, 480 and 600 DPI but any value
between 10 and 2400 can be entered here.

Printer resolution Y Select from the combo-box menu the resolution that the file should
be in the Y plane. The predefined options are 240, 300, 480 and 600 DPI but any value
between 10 and 2400 can be entered here.

Output colors Defines the palettes used for all colors (text, overlays and pictures). Select
from the combo-box menu:

Black and white Represents the colors by dithering black and white dots.

Further select dithering patterns on the Dithering tab.

Spot colors Represents the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can be
done via the Color dialog.

1344
 12.4 Engine Configuration

Dithered spot colors Represents the colors by dithering spot colors or black and
white dots.

Dithered spot colors should be assigned to each of the colors in the workflow, this
can be done via the Color dialog. Colored objects that use colors that are not as-
signed as dithered spot colors are dithered using black and white dots. Further
select dithering patterns on the Dithering tab.

Full color Prints the colors in the color space selected in the Use combo-box of
the Color dialog of the workflow.

Assign colorants Selecting Spot colors or Dithered spot colors activates the Assign button
to open the Assign colorants and alternative colors to index dialog that allows the mapping
of each of the colors to the spot colors that have been assigned in Layout.

Make sure that you use the same spot color indexes for the same colors as defined in
Layout. It is recommended to have Spot color 0 for black color.

Color Space for Text and Graphic Selecting Full color activates this combo-box which allows
you to choose either CMYK or CIELab color spaces.

The CMYK (cyan, magenta, yellow, and black) standard is device dependant.

CIELab is a device independent standard that is specified by three components; luminance

(L) and color values on a red-green axis (a*) and a blue-yellow axis (b*).

Graphic support Selects the level of graphic support of the printer to be used. You can
choose from:

None Specifies that the printer does not support graphics. All image-like objects
(shapes, lines, fill styles etc.) are printed as images.

Rectangles Specifies that the printer supports rectangular shapes.

Full Specifies that the printer supports all graphics. Lines and fills are drawn incre-
mentally.

1345
12 Production

Full with outlines Specifies that the printer supports all graphics. This is an effective
mode as lines and fills are drawn in one step.

However, if the result is not ideal, use the option Full where the step-by-step
drawing will ensure a more accurate result.

Full with outlines and Beziers Specifies that the printer supports all graphics. Lines
and fills are drawn in one step and curves are represented by points of a Bzier
curve to be rendered by the printer.

This a more efficient processing method and also supports curved line ends and
joins and but it depends on the ability of the printing device to render curves.

Note This feature has no practical effect in PDF, however smaller spool sizes and the
better quality are achieved using Full with outlines because the PDF is vector format.

White color processing Selects whether the colors of text and images should be printed
over any background, or if the background should be cut out where any text or images
are to be printed.

See the White processing section.

Grayscale support Ensures that dithering will only be performed later in the process if ne-
cessary.

From the combo-box menu select either:

None

Simple images For simple images, i.e. objects such as shapes without fills.

Images including fill styles For all images.

Compress When checked then the PDF file content will be compressed which results in a
smaller final file size.

JPEG compression for full color and grayscale images If checked, JPEG compression will
be used for full color and grayscale images according to the JPEG Compression quality
setting.

Existing JPEGs are not altered except if the image has to be decompressed during pro-
cessing.

Example Adobe Marker is not supported by Adobe Acrobat Reader and if it has
been used on the JPG image then it must be decompressed to remove it.

JPEG compression quality Enter in the combo-box the desired level of compression to be
performed on all images that are to be compressed.

A quality level of 0 corresponds to the greatest compression (and lowest quality), and a
quality level of 100 corresponds to the least compression (and highest quality).

Page extent Most printers have a preset limitation on the length of page that they can print
on. By entering that Maximum page length here the spooling of any larger pages will
be prevented.

1346
 12.4 Engine Configuration

By default there is 10000 mm set (page extent in the direction of the paper feed). Check
your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

ICC Profile Setting See the ICC Profile Setting section.

Fonts Tab

Options Description

Encoding See the Text Encoding section.

Resize Barcodes See the Resize Barcodes section.

Dithering Tab
See the separate Dithering section.

Splitting Tab

1347
12 Production

Options Description

Media Index Enables you to set different types of output sheets to differing Horizontal
head settings.

Use the Create New icon to add a Media Index row.

The Media Index (0, 1, 2 ) corresponds with the media pages that can be set in the
Output module (in Workflow). This represents a sequence of pages that have been created
in Layout which have different values for sheet name.

Example If we have a Layout with 2 pages with different sheet names then:

for Page1 you edit the head setting for media index 0

for Page2 you edit head setting for media index 1

If no Media Index is set here for an existing page (set in Output module) then the
Horizontal head setting from the default media index is used.

Pages that have not had a sheet name set in Layout (e.g. have the default Main set
as a sheet name) are also given the Default settings.

The Default media index cannot be deleted.

In the Face cell for each media index select, from the drop-down menu, whether the
corresponding head will be printing the Front side, Back side or Both sides.

In the Shrink cell for each media index select, from the drop-down menu, whether
the corresponding head will have the image shrunk to fit the head width. Set True
for yes and False for no.

If set to True, all heads are moved next to each other. This way you can print with
several separate heads on the smallest possible sheet.

Horizontal head setting Set here the horizontal head settings for the selected media index.

To create a new head definition, click on the Create New icon.

The Open icon enables the loading of an XML head definition that has been previously
saved in Layout or Proof. When doing this ensure that the Output colors of the selected
page side have been set to Black and white and the number and width of heads is the
same as has been defined in Layout.

For each head setting row set the point where the head should start in the From cell and
the width of the printing head in the Width cell.

See also: Setting heads in Layout and Raster Proof Profiles

Acrobat Tab
For the explanation of the options see the description of the Acrobat tab of the PDF Engine
Config dialog.

1348
 12.4 Engine Configuration

12.4.20 PDF Engine Configuration

In this section: See also:
PDF Engine Config Dialog Driver Config
PDF Device Profiles
PDF Engine Command Line Parameters
URL Links Functionality in PDF Output
Files

The PDF engine produces files in the Adobe Portable Document Format (PDF) compatible
with version 1.4 and later.

PDF version 1.4 covers all the features used in Inspire Designer. The lowest possible version
(that is 1.4) of PDF is used, as some older viewers might not display a PDF file just because of
its higher version number (even if the file does not contain any features from the higher versions
exclusively). That way a wider range of viewers can be used to adequately display PDF files
generated by Inspire Designer.

Produced PDF files can be as large as approx. 10 GB if required, however, many PDF viewers
will not support such large sizes.

You can further define the PDF Engine Config and the Driver Config.

Selecting PDF in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the PDF Engine Config dialog.

12.4.20.1 PDF Engine Config Dialog

Available tabs are:

General

Fonts

Graphics

Group Handling

Security

Digital Signatures

Acrobat

Advanced

Custom

DPM

1349
12 Production

General Tab

Options Description

Compress streams When checked then the non-image PDF file content will be compressed,
resulting in a smaller final file size. Image compression is set in the Group Handling Tab.

Highlight variables If checked, variables in PDF are highlighted with the selected color.

Show variable names If checked, all variables are displayed as a variable name, instead of
the actual values.

Use Overlays Checking Use Overlays allows the engine to recognize the overlays defined
by Inspire Designer (repetitive objects that appear on more than one page) so that they
are processed only once when spooling.

With large jobs this decreases spooling time considerably.

Optimize for fast web view If checked, the generated PDF file will be organized, so that
it allows quick access to a selected part of the PDF file (whatever the file size) online without
the necessity to download the whole file beforehand. This feature is particularly useful for
PDF presentations to be accessible on the web.

Processing a job with the Optimize for fast web view option enabled means that:

significantly more memory will be needed,

spooling time will be longer,

the PDF output will be slightly larger (but the larger the file, the less significant the
difference between a file with and without the web view optimization).

Note If intending to use the fast web view optimization, make sure the output file does
not use external resources, such as images or fonts. In case of such situation a warning is
generated during production.

1350
 12.4 Engine Configuration

Flate compression level This combo-box allows to select the adequate compression level
depending on the user's needs for the PDF file sizes and/or the spooling speed. There are
three levels of compression to choose from:

1. Low (Fast) Sets the compression at a low level and allows fast spooling.

2. Medium Sets the compression at a medium level with medium spooling speed.

3. High (Slow) Sets the compression at a high level allowing only relatively slow
spooling.

Conformance Level This sub-section specifies restrictions to the PDF format. The restrictions
(also referred to as 'PDF subsets') are used for creating PDF outputs suitable for various
specific purposes (see the subsets description below for more information).

If any of the restrictions is enabled, the Security and the Acrobat tabs are not available in
the PDF Engine configuration.

Also, some options are unavailable in the following tabs:

Fonts The Font Settings sub-section,

Graphics For PDF/A the RGB and CMYK color spaces are allowed; for PDF/X-4
and PDF/VT only CMYK is allowed,

Group Handling The Merge original PDF objects and the Create external
reusable images,

Custom The Generate OPI information for images and Head Settings sub-
section.

A warning is displayed at the bottom of the configuration dialog, if any of the restrictions
is enabled. By default all restrictions are disabled.

PDF/A If enabled, the PDF/A-1b restriction is applied to the generated PDF file. PDF/A-
1b ensures archiving and reproduction of selfcontained documents independently of
tools and operating systems.

Also, enabling additionally the Create tagged PDF check-box on the Advanced tab,
allows to generate PDF files compliant with the PDF/A-1a format. PDF/A-1a includes
all the conditions of PDF/A-1b and requires the document to be structured. This
structure is built by tags, that allow the document content to be searched and repur-
posed. Common uses of this restriction would be adapting documents to be, for in-
stance:

Read out loud by a machine for users visually impaired,

Redesigned after import to some editing application, or

Reflowed (e.g. to be displayed on hand-held devices), or

Archived in a highly adaptable format.

For more information about PDF/A specification, see http://www.pdf-tools.com/pub-

lic/downloads/whitepapers/whitepaper-pdfa.pdf.

PDF/X-4 If enabled, the PDF/X-4 restriction is applied to the generated PDF file.

1351
12 Production

The PDF/X-4 subset does not support URL links. A warning is displayed, when trying
to process a PDF file with URL links employing the PDF/X-4 restriction.

PDF/X-4 ensures that a document contains all elements necessary for final print repro-
duction. It requires referring to no external files and using exclusively CMYK color
space (and spot colors).

PDF/VT If enabled, the PDF/VT ('V' for variable and 'T' for transactional) restriction is
applied to the generated file.

PDF/VT subset is meant for VDP (Variable Document Printing). This restriction can
define graphical objects to be referenced, so that the files sizes can be reduced and
readers can apply various optimization techniques while document processing. It also
supports transparency.

PritnNet T PDF Engine outputs can support 2 conformance levels:

1. PDF/VT-1 Selfincluded files (conforming with PDF/X-4),

2. PDF/VT-2 Referencing external XObjects reusable for multiple files and ICC
profiles (conforming with PDF/X-5g).

Additionally, you can define Document Part metadata on the DPM tab, that is available
only when the PDF/VT restriction is enabled.

Enabling this restriction along with the PDF/X-4 check-box results in generating
PDF/VT file(s) PDF/X-4 compliant.

Tip For an overview of available PDF subsets combinations, refer to the table below.

PDF/A PDF/X-4 PDF/VT* PDF Tags External Resulting

XObjects Conformance
Level

1 n/a PDF/A-1a

2 n/a PDF/A-1b
3 n/a PDF/X-4 and
PDF/A-1a
4 n/a PDF/X-4 and
PDF/A-1b
5 n/a PDF/VT-2 and
PDF/X-5g
6 n/a PDF/VT-1 and
PDF/X-4
7 n/a n/a PDF/VT-1 and
PDF/X-4
8 n/a PDF/VT-1 and
PDF/X-4 and
PDF/A-1b

1352
 12.4 Engine Configuration

PDF/A PDF/X-4 PDF/VT* PDF Tags External Resulting

XObjects Conformance
Level

9 n/a PDF/VT-1 and

PDF/X-4 and
PDF/A-1b
10 n/a PDF/VT-1 and
PDF/X-4 and
PDF/A-1a
11 n/a PDF/VT-1 and
PDF/X-4 and
PDF/A-1a

Legend

The subset/feature is enabled.

The subset/feature is disabled.

*When the PDF/VT is enabled, then the PDF file will also be PDF/X-4 (rows 6, 8, 10) or
PDF/X-5g (row 5) compliant, regardless of the PDF/X-4 check-box state.

Fonts Tab

Options Description

Font Handling

Create one font with all used glyphs If selected, all used glyphs from all used
fonts will be encoded as one new font (AllAndNone). The created font will be in-

1353
12 Production

cluded (embedded) in the created output file. That increases the output's size. Se-
lecting this option disables the Font Encoding and Font Settings sections.

Only the glyphs that have been used in the layout design will be part of the encoded
font. Any used glyphs that cannot be encoded using the selected encoding, are
placed into CID fonts named identically to the original fonts but without the encod-
ing type. Such fonts are also included into the PDF file.

Text will be readable as strings in the spool file, if encoding has been used and
Compress streams in the General tab has been left unchecked.

For example, Adobe Acrobat requires these fonts for further editing of the produced
PDF document. However, only glyphs that have been used are embedded by this
option and, therefore, it will be impossible to edit the PDF with non-included glyphs.

Create one font for each input font If selected, allows to create an output font
for each font used in Layout. Select the appropriate settings in the Font Encoding
and Font Settings sections described below.

Font Encoding

Predefined encoding If selected, you should further select from the standard PDF
types of encoding in the combo-box menu:

Adobe Standard

Mac Roman

Win ANSI

Japan1

Japan2

CNS1 (Simplified Chinese)

GB1 (Traditional Chinese)

Korea1

Other encoding If selected, you should further select the codec that you require
for the font used in the layout design.

See the separate section Text Encoding for more details.

Font Settings

Create embedded fonts If checked, all the fonts used in the layout design will be
included (embedded) into the PDF output file. That increases the output file's size.

Text will be readable as strings in the spool file, if encoding has been used and
Compress streams in the General tab has been left unchecked.

Create external fonts in If checked, the original font files used in Layout are saved
(copied) in the folder indicated in the edit box. You can either type in the path to
the chosen folder, or click on the Browse icon to open the Select folder dialog.
Applies only to TrueType and Type1 PFB fonts; other fonts are saved as embedded.

1354
 12.4 Engine Configuration

See the Create internal / external images section for more information.

Reference fonts by name If checked, no fonts will be embedded or saved along

with the PDF output file. When viewing the PDF output, the viewer will search for
the required fonts locally by their standard names, e.g. Arial, Times New Roman,
etc. If the required fonts are not found, they are substituted with others, which
might result in changes in the document's appearance.

This option applies to any TrueType fonts.

Limit to following font names only If enabled, only the fonts listed in the edit-
box are referenced by name. Any other used fonts are embedded.

This option is active only if the Reference fonts by name radio-button is selected.

Tip It is sufficient to enter only the font-family name, e.g. Arial, to include all its
variants.

Note Even though the PDF Engine generates PDF 1.4, for encoding Japan1, Adobe-Ja-
pan1-6 glyphs are supported, and can be referenced by name (do not have to be embed-
ded).
This subsection is disabled if the PDF restricted subsets are employed.

Graphics Tab

1355
12 Production

Options Description

EPS/PDF rasterization resolution Enter here a desired resolution for your output quality.
Units are DPI.

Optimize non-tiled image fill styles If checked, clipping path will be used instead of non-
tiled image fill style. The output result will be the same, but it will speed up processing
and increase reliability.

Color Spaces

Text and graphics Select here the color space to be used for the text and graphics from
the combo-box menu:

Take from Layout color Applies the colors used in the Layout of the workflow,
i.e. colors are not converted.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

Force Lab Processes all colors using the Lab system.

Force Gray Processes all colors in grayscale.

Note If the Highlight variables option is used, it will be applied regardless

of this setting. I.e. the variables will be colored and the rest of text and
graphics will be grayscaled.

Images Select here the color space to be used for the images, from the combo-box
menu:

Specifies colors for images in spool files. You can select from:

Take from Layout image Applies colors as they have been defined in the
Layout of the workflow, i.e. image colors are not converted.

Example On the Advanced Tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions
such as CMYK will be converted to RGB at that point and then RGB will
be the colorspace used by this engine if Take from Layout image is selec-
ted here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

Force Gray Processes all colors in grayscale.

Note If the Highlight variables option is used, it will be applied regardless

of this setting. I.e. the variables will be colored and the rest of images will be
grayscaled.

1356
 12.4 Engine Configuration

Use separation and DeviceN colorspaces Checking this option employs the colorants,
that have been defined in Layout, as color identifiers in the output. This allows printers
that are coordinated with the Device N or Separation color system to recognize them.

Append ICC profile to images Checking this option employs standard ICC color in the
output if applicable.

For example, if an image contains an embedded ICC profile and it is then transformed
using real ICC profiles (not built-in CMYK profile) or not transformed at all, the
current ICC profile is written to the PDF file together with the image data which
makes the image device-independent.

See the separate section ICC Profiles for further description.

Apply color management conversions only on colorspace change Checking this

option defines that any conversions selected in the Text and graphics and Images
combo-boxes will only happen when the color spaces of the objects differ from the
target color space.

Detect grayscale colors Checking this option applies grayscale color to those graphics,
texts and images that have:

all of the RGB values the same (e.g. R=10 G=10 B=10) or

CMY values 0 (e.g. C=0 M=0 Y=0 K=any).

If one of these conditions is not fulfilled and the option is checked, it will not be applied
at all.

Using this option saves time when spooling and might make the final output smaller.

This sub-section has limited functionality if the PDF restricted subsets are employed.

ICC Profile Settings See the ICC Profile Setting section.

1357
12 Production

Group Handling Tab

The Group Handling tab defines how different groups of images from the job will be processed
to the PDF output file. The settings on this tab supersede any image processing commands
that may have been set on the General tab.

Options Description

Handling Group Groupings for the images are the handling groups that can be set in a
workflow (in Layout). You can further go on to define the below described parameters
for each of the groups.

Compression for JPEG images Select from the combo-box menu type of compression
for JPEG images:

None No compression will be applied.

Flate JPEG images will be zipped using lossless compression.

JPEG JPEG images have already been compressed using JPEG compression
and no further compression is applied.

When JPEG compression is set, the image is not processed by Inspire Designer
at all and the image stream is copied directly to the spool file.

1358
 12.4 Engine Configuration

The source image stream is however used only if the following conditions are
met:

Image color space matches both the image color space specified in the
PDF Engine Config dialog (option Images on the Graphics tab) and po-
tential color space modifications requested in Layout.

Note Color space set in Layout works as maximum color space: grayscale
image is not upgraded to RGB, while CMYK image is downgraded to
RGB, if RGB is specified there. Grayscale original JPEG image is allowed
for both Force RGB and Force CMYK options.

No downsampling is applied to the image.

No palette modification in Layout is specified (on the Palette tab of the

image's Layout Properties), with the exception of making the palette entry
transparent.

Note If the image is converted to black and white using the Color space
combo box in the image's Layout Properties, the image is flate compressed
in the PDF spool file (JPEG compression is not possible for black and white
images).

The only way to write a JPEG image with modified parameters to the PDF
spool file is to specify a compression method other than JPEG here. If you
dont want to change the compression method globally for all JPEG images,
it is possible to divide the images into handling groups.

Compression for other images Select from the combo-box menu type of compression
for other than JPEG images:

None No compression will be applied.

Flate Images will be zipped using lossless compression.

JPEG Images will be compressed using JPEG compression

JPEG quality Enter in the combo-box the desired level of compression to be performed
on all JPEG images. A quality level of 0 corresponds to the greatest compression (and
the lowest quality), and a quality level of 100 corresponds to the least compression
(and the highest quality).

Merge original PDF objects Set a level for the processing of any PDF objects (e.g. ori-
ginal PDF images), that are in the workflow (from Layout not from Inspire Native
module) that is being printed. The levels are:

Off PDF objects are not merged.

The object will be either: rasterized into the spool file or, if Load natively has
been selected for the object in the Layout of the workflow, it will be processed
natively.

On No stream reuse PDF objects will be merged with the spool file but
none of the streams will be reused by other PDF objects, even if the streams
are identical. I.e. each included PDF object will have its own independent
stream.

1359
12 Production

On Standard stream reuse PDF objects will be merged and their streams
will be reused by similar PDF objects if their compression method is the same.
This produces a smaller spool file.

On Full stream reuse PDF objects will be merged and their streams will be
reused by all similar PDF objects. This produces an optimal size spool file, but
the spool file takes longer to produce.

Note When this option is On, it ignores options that change the content of the
original PDF objects (options on the Fonts, Graphics and Group Handling tabs).

PDF streams that can be merged via these setting include ICC profiles, fonts and im-
ages.

This option is unavailable if the PDF restricted subsets are employed.

Downsample palette images to Scales down palette images to the specified resolution.
By default, this option is set to Not set.

If you set a resolution, the option If over appears enabling you to apply the trans-
formation only to images with resolutions higher than a certain value. If you set the
If over option to Not set, no limitation will be applied and all of the palette images
in the group will be downsampled if possible.

Example If you set the Downsample palette images to option to 150 and
If over to 300, then all palette images with resolution higher than 300 DPI will
be scaled down to 150 DPI.

If the same image occurs in the document several times having different resolutions,
Inspire Designer handles all the occurring images the same way, based on the resolu-
tion analysis of the first occurring image.

Downsample grayscale images to Scales down grayscale images to the specified

resolution. By default, this option is set to Not set.

If you set a required resultant resolution, the option If over appears enabling you to
apply the transformation only to images with resolutions higher than a certain value.
If you set the If over option to Not set, no limitation will be applied and all of the
grayscale images in the group will be downsampled if possible.

If the same image occurs in the document several times having different resolutions,
Inspire Designer handles all the occurring images the same way, based on the resolu-
tion analysis of the first occurring image.

Downsample color images to Scales down full color images to the specified resolution.
By default, this option is set to Not set.

If you set a required resultant resolution, the option If over appears enabling you to
apply the transformation only to images with resolutions higher than a certain value.
If you set the If over option to Not set, no limitation will be applied and all of the
full color images in the group will be downsampled if possible.

If the same image occurs in the document several times having different resolutions,
Inspire Designer handles all the occurring images the same way, based on the resolu-
tion analysis of the first occurring image.

1360
 12.4 Engine Configuration

Create internal/external images Determines whether any used images will be within
the PDF file or as separate resources.

Use the drop-down menu to select from:

Create internal images Images will be part of the spool file.

Create external reusable images Images will be generated as external re-

sources, either JPG (image), FLT (stream) or RAW (stream) depending on the
selection made for the options Compression for JPEG images and Compres-
sion for other images.

When selected you can further enter a path to the location where the image
files should be created. The path can be:

Relative to the spool (PDF) file (use a single full-stop to indicate the same
directory, two to indicate 'up one').

Absolute. A Browse icon appears to aid directory location.

This option is unavailable if the PDF restricted subsets are employed.

Create external reusable XObjects Each external PDF file with a reusable
image is named with a hash key. If a file with the same hash name already
exists, it is referenced in the spool file. Enter a relative or an absolute path to
the generation directory as described above.

Tip To see external images associated with a PDF file when viewing it using Adobe
Acrobat or Reader you might need to apply the following settings in the application
version used:

Adobe Acrobat or Reader's Version Setting(s) Required for Viewing

External Content

6 and earlier No special settings required

7 and 8 Enable Allow external content in
Preferences | Trust manager
9 1. Define a trusted folder in Prefer-
ences | Security (Enhanced)

2. Enable Show reference XOb-

jects targets in Preferences |
Page Display

Overprint for stroking operations When set to On, overprinting will be applied to
objects belonging to the current handling group. This option enables overprinting for
stroking operations only. This operation can be performed on printers that support
overprinting (i.e. printing one object over another) and the output color is fully de-
pendent on the printing device.

Note For stroking operations the line start and line end coordinates as well as line
width are defined. In Inspire Designer it means all line styles.

1361
12 Production

Overprint for other painting operations When set to On, overprinting will be applied
to objects belonging to the current handling group. This option enables overprinting
for all painting operations but stroking. This operation can be performed on printers
that support overprinting and the output color is fully dependent on the printing
device.

Note For other painting operations the area and color that should be used for filling
this area are defined. In Inspire Designer it means all fill styles and images.

Overprint mode Selects between two overprinting modes:

Standard Or zero mode, is to be used for colorants.

Illustrator Or non-zero mode, is to be used for colors defined in the CMYK

color space.

Security Tab

This tab relates to access permissions set for any PDF file created by the engine profile, excluding
those conforming to PDF/A, PDF/X-4 and PDF/VT.

Options Description

Encryption level Select one of the file encrypting options:

40-bit RC4

128-bit RC4

128-bit AES (PDF 1.6) more complex encrypting method; using this option means
that the PDF file will be generated as the PDF 1.6 and will be slightly larger in
comparison to files encrypted with the RC4 options employed.

Store encrypted passwords in config file If checked, the passwords are not inserted in
the PDF file itself, but are stored in the CONFIG file.

1362
 12.4 Engine Configuration

Password to Open Document Allows you to enter a password for opening the PDF file.
Using the radio-buttons, further select from:

Fixed The password will be the same as any entry entered in the edit-box here.

From sheet name The password will be the value of the sheet name whose index
number is entered in the edit-box here.

The sheet name is used to determine passwords for the printed documents so that password
definition can be done inside the workflow file as opposed to here in the production
stages. Password definition with sheet names is more flexible, the password could even
be read from a data file.

Example In the input data file there could be a field called "Password" which
contains a different password for each record. This is read into the workflow and
becomes a variable called "Password". This variable is then available in Layout where
a sheet name could then be assigned that variable (e.g. Sheet Name 3 assigned
Password). Subsequently, the sheets of the design could be split (e.g. using the Sheet
Regrouper module) so that one document is printed for each record.

In such a case, you could enter 3 here in the From sheet name edit-box and the
password for the each of the created PDF documents would be the value entered in
the corresponding Password field of the data file, i.e. independent for each record.

Password to Change Permissions Allows you to enter a password that enables the changing
of access permissions to the PDF file from the viewing software (e.g. Acrobat). Further
select from:

Fixed The password will be the same as any entry entered in the edit-box here.

From sheet name The password will be the value of the sheet name whose index
number is entered in the edit-box here.

The sheet name is used to determine passwords for the printed documents so that
password definition can be done inside the workflow file as opposed to here in
the production stages. Password definition with sheet names is more flexible, the
password could even be read from a data file. See the example in the Password
to open document description above.

Permissions These permissions relate to editing a document in Adobe Acrobat.

Allow printing If checked, a user will be able to print any PDF file created with this
engine profile.

If unchecked, the corresponding setting in Acrobat Security is that the option Printing
is set to Not allowed.

Allow changes to document If checked, a user will be able to make changes to any
PDF file created with this engine profile.

If unchecked, the corresponding setting in Acrobat Security is that the options

Changing the Document, Document Assembly and Creation of Template Pages
are set to Not allowed.

1363
12 Production

If this option and Allow filling of forms are unchecked, together, the corresponding
setting in Acrobat Security is that the options Changing the Document, Document
Assembly, Commenting, Filling of Form Fields, Signing and Creation of Template
Pages are set to Not allowed.

Allow content copying or extraction If checked, a user is able to copy parts (text,
images etc.) of any PDF file, created with this engine profile, for use elsewhere.

If unchecked, the corresponding setting in Acrobat Security is that the options Content
Copying or Extraction and Content Extraction for Accessibility are set to Not allowed.

Allow filling of forms If checked, a user will be able to fill in any forms that are part
of any PDF file created with this engine profile.

If unchecked, the corresponding setting in Acrobat Security is that the option Com-
menting is set to Not allowed.

If this option and Allow changing the document are unchecked, together, the
corresponding setting in Acrobat Security is that the options Changing the Document,
Document Assembly, Commenting, Filling of Form Fields, Signing and Creation
of Template Pages are set to Not allowed.

Overwrite from sheet name If checked, the user permissions set in the options above
will be overwritten by corresponding values returned by sheet names that have been
assigned in the Layout of the workflow being printed.

The sheet name should return Boolean values assigned to the following keys:

pp E.g. pp=1 is the equivalent of checking Allow printing.

pcd E.g. pcd=0 is the equivalent of unchecking Allow changes to docu-

ment.

pce E.g. pce=true is the equivalent of checking Allow content copying or

extraction.

pff E.g. pff=false is the equivalent of unchecking Allow filling of forms.

Only the options with key values returned by the sheet name will be altered, those
that are not represented in the sheet name will remain as set here on this tab. For
multiple overwrites by one value, the keys must be separated by a semi-colon character,
e.g. pp=0; pcd=0; pff=1.

In practice, this option allows each PDF document printed from a variable data set
(records) to have different permissions.

Example In the input data file there could be a field called "Permission" which
contains different permission keys for each record. This is read into the workflow
and becomes a variable called "Permission". This variable is then available in
Layout where a sheet name could then be assigned to that variable (e.g. Sheet
Name 3 assigned Permission). Subsequently, the sheets of the design could be

1364
 12.4 Engine Configuration

split (e.g. using the Sheet Regrouper module) so that one document is printed
for each record.

In such a case, you could enter 3 here in the Overwrite from sheet name edit-
box and the editing permissions for the each of the created PDF documents
would be according to the value entered in the corresponding Permissions field
of the data file, i.e. independent for each record.

Digital Signatures Tab

Digital signatures use Personal Information Exchange certificates (PFX or P12) in order to verify
that the person that creates a document is the person who is meant to have signed it. They
also verify that the signed document has not been altered since the time it was created.

Such certificates verify identity using information about the computer and user that performed
a specific action and they are usually available via the internet by a third party, e.g. Microsoft
Certificate Services.

Options Description

Add digital signature Enable the check-box to activate the remaining options in the Digital
Signature tab.

Identities The table in this area is for adding the identities of any number of people that
have certificates and might be required to sign a PDF document. To create an identity:

1. Click on the Create New icon to add a new row to the table.

2. Enter a name for the identity in the Name column. Press the <F2> key to edit the
field.

3. Browse in the Personal Information Exchange File column for the certificate
that you require to be connected with that identity.

1365
12 Production

When the certificate file is found and opened the Private Key Password dialog
opens. E.g.:

4. Enter the correct password (a property of the certificate that is determined when
the certificate is created) and click on OK to dismiss the dialog.

The password is encrypted and, subsequently, each time that a PDF file is created
using this engine profile and this identity, the password is used to open the certi-
ficate and verify the signature.

The Alternative Path from Sheet Name column is used when the file with the
certificate is not found in the location specified by the path in the Personal In-
formation File column, e.g. when the user would need to use their digital signa-
ture remotely or when the design and the spooling do not happen on the same
computer. In such situation a path placed in a sheet name is used. That sheet name
is indicated by an appropriate index number entered into this field.

Checking the Store passwords in config file option determines that the password to
the certificate is stored within the configuration file. This is for particular use when it is
known that the command line version of Inspire Designer (PNetTC.exe) will be used to
produce the PDF and avoids having to (insecurely) type the password in the command line
environment.

Identity Selection Method

Always use identity Select if it is required for PDF files to be signed by a single
person.

The person's identity and a correct path to their certificate must have been added
to the Identities table above. Then, enter the Name of the identity of that person
in the edit-box here.

Set identity from sheet name Select if it is required for PDF files to be signed by
a person whose identity should be specified using a sheet name.

Each persons identity and correct path to their certificate must have been added
to the Identities table above. Then, enter the index number of the sheet name
that has been assigned to return the value that corresponds to the identities. The
values that the sheet name returns must match the identities, exactly as they are
entered in the Name column above.

Using sheet names in this case, means that the determination of the identity is
done inside the workflow (WFD file) as opposed to here in the production stages.
Determination using sheet names is also more flexible, the identity could even be
read from a data file.

Example In the input data file there could be a field called "Identity" which
contains a different identity name for each record. This is read into the

1366
 12.4 Engine Configuration

workflow and becomes a variable called "Identity". This variable is then

available in Layout where a sheet name could then be assigned that variable
(e.g. Sheet Name 3 assigned Identity). Subsequently, the sheets of the design
could be split (e.g. using the Sheet Regrouper module) so that one document
is printed for each record.

In such a case, you could enter 3 here in the Sign using identity from sheet
name edit-box and the identity for each of the created PDF documents would
be the value entered in the corresponding field "Identity" in the data file, i.e.
independent for each record.

Reason for Signing Reasons are an additional attribute of the signature tab of a PDF docu-
ment. They are a simple a notation, added to the signature to explain why the document
was approved.

Do not specify reason Select if it is not required to show any reason on the signa-
ture tab of the PDF documents created.

Specify reason here Select if it is required to specify a reason and you want to
enter a single reason here in the PDF engine configuration.

Enter that reason in the edit-box.

Set reason from sheet name Select if it is required to specify a reason and that
reason should be a value returned by a sheet name.

Enter the index number of the sheet name that has been assigned to return the
reason.

Using sheet names in this case means that the determination of the reason for
signing is done inside the workflow (WFD file) as opposed to here in the production
stages. Determination using sheet names is also more flexible, the reason could
even be read from a data file.

Acrobat Tab

1367
12 Production

This tab is not available for files that are in conformance with PDF/A, PDF/X-4 and PDF/VT.

Options Description

Print options

None If selected, no extra print settings for PDF in Acrobat are applied.

Print immediately and close document (Acrobat 5) If selected, then when the
PDF document is opened in Acrobat, it is printed immediately and is closed it is
never displayed on the screen in Acrobat. This can be useful for protecting your
data in the printing phase of the job.

Only available for Acrobat version 5 and higher.

Print immediately If checked, then when the PDF document is opened in Acrobat,
it is printed immediately. After printing, it stays opened.

Print copies (Acrobat 6) If selected, an additional Inspire Designer button will

appear in the tool bar of the PDF reading software that can be used for printing
the number of copies of a document (or page, or record) that has been specified
by the value of a sheet name.

Enter the index number of the sheet name, that returns the value, in the Sheet
name edit-box.

Printer Selection

Show Acrobat print dialog If checked, the Acrobat print dialog will show allowing
the setting of further print properties.

Available only if Print immediately and close document or Print immediately has
been selected.

Print Silently If checked, the Acrobat print dialog will not show before printing.

Available only if Print immediately and close document or Print immediately has
been selected.

Shrink pages to fit If checked, page content is adapted to fit to the printers page size.

Available only if the option Print silently has been selected.

Print as image If checked, the PDF file will be printed as an image.

Using this option is recommended for printers that have problems with processing Post-
Script.

Available only if the option Print silently has been selected.

Search for alternative images for viewing If checked, a different image is displayed in
the PDF when opened in Acrobat that is used for printing.

You should further enter the file name for the alternative image that will be viewed in
Acrobat in the Alternative image format field. You can use the same variable path de-
fining shortcut conventions as can be used for defining File names in the Driver Config
section of the Production Window (e.g. %n stands for file name, %e stands for file exten-
sion).

1368
 12.4 Engine Configuration

By default, it is set to look for the image in the same folder with characters _1 added
to its name. If left empty or the image name is not specified correctly, the original image
is used.

Example For viewing in Acrobat you may select an image with a signature, to make
the documents look complete, but for printing no image is used because the docu-
ment will be signed with an original signature.

This screenshot is defining that Image.jpg will be replaced for viewing in Acrobat by
Image_1.jpg.

Example If the document is to be printed in Adobe Acrobat, we want to print two

copies of pages 1, 2 and 3.

1. In Layout, create a variable. Make the variable a constant that is the value of the
number of copies that you want to print ('Variable1' created with a value of 2).

2. Go to the last page of the range that should be printed twice in Layout of the job
to be produced, i.e. the page that will print as Page 3 of the PDF file (as opposed
to any actual 'Page 3' in the layout).

3. Create a new sheet name on the Sheet Names tab for that page and select the
variable in the Variable column, i.e. sheet name 3 assigned Variable1.

4. Now, when setting the Print copies option, we should enter 3 in the Sheet name
combo-box.

The above example assumes that our pages are printed in logical order and therefore allows
you to simply assign a constant variable to the last page. You can also use conditional
variables or even variables that are read from a data file so that different records have
different amounts of copies.

1369
12 Production

Advanced Tab

Options Description

PieceInfo A PieceInfo entry can hold a page-piece dictionary which can store private data
that relates to any PDF page, e.g. object grouping or layer information. PieceInfo may be
required if orientation will be used in the PDF.

Unless you are using PDF PieceInfo, leave the following options unchecked.

Create PieceInfo dictionary If checked, allows the creation of PDF Dictionary subsets
to the PieceInfo.

Clicking on the Settings button opens the PieceInfo dialog where entries to the dic-
tionary can be added:

PieceInfo name Names the PieceInfo dictionary and selects between previously created
dictionaries.

1370
 12.4 Engine Configuration

Add dictionaries using the Create New icon to the right and you can edit the
name directly in the combo-box. When a dictionary is selected here the options in
the Data Definition area become active.

Data Definition The area on the left-hand side lists the entries within the dictionary
that is selected in the PieceInfo name combo-box.

Add entries using the Create New icon and select an entry to activate the corres-
ponding options on the right-hand side:

Key name Names the key for the entry in the dictionary.

Data type Determines the type of data of the entry. The possible selections are
valid data types for the PDF format, i.e.: Bool, Number, Name, String, Array or
Dictionary.

In the combo-box below Data type select from:

Constant value Determines that the entry will be a constant value. Enter
that value in the edit-box to the right.

From sheet name Determines that the value of the entry will be created
from values returned by a sheet name.

First ensure that a variable that will return the correct PieceInfo has been
created in Layout of the workflow being printed. That variable must also
have been assigned to a sheet name. Then enter the index number of
that sheet name into the edit-box to the right.

Undo / Redo Undoes/Redoes the last change made to the selected entry.

Move Up / Move Down Moves the selected entry one position up/down in
the structure of any array that has been added, i.e. within entries that have Array
selected for Data type.

Create New Adds a new entry to the structure of the dictionary.

Delete Deletes the selected entry.

More information about PieceInfo syntax can be found in the specification http://part-
ners.adobe.com/asn/tech/pdf.

Resize Barcodes See the Resize Barcodes section.

Page Extent

Maximum page length Most printers have a preset limitation on the length of page
that they can print on. By entering that in this edit-box the spooling of any larger
pages will be prevented.

By default there is 10 000 mm set (page extent in the direction of the paper feed).
Check your printers capabilities before you change this dimension.

The measurement units can be changed by clicking on the unit symbol.

Use marked content This option allows to group objects in PDF outputs and define certain
properties for these groups. The grouping is based on handling groups that are set in the

1371
12 Production

workflow (in Layout), so the number of groups is limited to eight. In the spooled PDF file
the beginning of a given group of objects within the PDF content stream is indicated by
the BMC or BDC operators, whereas EMC is the end operator. For more information on
marked content see the PDF Reference document, chapter 10.5.

Click on the Settings button to open the Marked Content dialog.

Handling Group Selects the number of the handling group (from 1 to 8) for which the
tag name and other marked content properties will be edited.

Tag name Any value entered in the edit-box will be assigned as the tag name to the
marked-content operator. A group always has a tag name and can have further op-
tional properties.

Properties The Properties of the Marked Content dialog are designed and work on the
same principle as the Data Definition in the PieceInfo dialog.

Create tagged PDF If checked, the objects in the PDF document are given tags, that enable
to mark (and later access) the original document structure. Additionally, if the PDF/A re-
striction is enabled as well, the generated document(s) will be PDF/A-1a compliant.

Using tags for generating PDF files allows you to assign alternative content to images and
shapes in Layout. Such content may be used, for instance, as substitute descriptions of
pictures in documents that should be read aloud by screen readers. Define the alternative
content either via the Alternative text option or via URL target in Layout. If both ways are
used, setting in Alternative text is always preferred.

Note

For generating tagged PDF files, overlays are not employed. The files are larger and
their spooling takes longer.

Natively imported content is inserted to Layout as it is, without any logical structure
definition. Word breaks and Unicode value for each character is also guaranteed
only for Layout objects. Only objects designed in Layout (not natively imported)
would pass the Accessibility check in Acrobat (which itself is not PDF/A-1a require-
ment).

Alternative text can be used for images, however, it is not supported when the
image is in a flow area.

Document language Select the main language of the generated document(s). English (EN)
is selected by default.

1372
 12.4 Engine Configuration

You can either select a language from the drop-down menu or insert a custom value after
clicking into the edit-box. The custom value needs to be entered in the form of a language
tag as defined in the RFC 3066 (e.g. for languages used in Switzerland you could choose:
de-CH fro German or fr-CH for French, or it-CH for Italian). The languages available in the
drop-down menu have their tag symbols defined in brackets. The RFC 3066 language tags
are used to mark languages inside the documents.

Custom Tab

Options Description

Create RSD Index If checked, RSD indexes (Roger Software Development document
management information) will be added to the PDF definition of pages or groups of pages.

When checking this option, first ensure that variables that will return the correct values
for the RSD indexes have been created in the Layout of the workflow being printed. Those
variables must also have been assigned to different sheet names. Then, enter the corres-
ponding index numbers of those sheet names into the edit-boxes in the RSD Index area
below.

RSD Index

Folder Name taken from sheet name Values for the Folder Name index item will be
returned by the sheet name with the index number that is entered in the edit box
here.

Document Name taken from sheet name Values for the Document Name index item
will be returned by the sheet name with the index number that is entered in the edit
box here.

Working Date taken from sheet name Values for the Working Date index item will
be returned by the sheet name with the index number that is entered in the edit box
here.

Splitting These options are intended to be used when preparing a workflow to be printed
on an IJPDS device. You can use virtual head settings that match those of the device to
help determine whether the pages are split correctly.

1373
12 Production

The result is that the PDF file can be used for proofing a workflow before it is produced,
i.e. when producing the PDF you are given some indication of how the workflow would
also fit to the heads of an IJPDS printer.

Head setting annotations / Log errors If checked, allows the addition of annotations
to the PDF file that contain descriptions of head settings and optional additional in-
formation. In addition, warnings will be shown in the Log window-pane as a workflow
is processed, if objects on the pages of the design are split between those predefined
head positions (the warnings will note the heads which are affected) or are printed
out of page.

This option also activates the other options in this area.

This option is unavailable if the PDF restricted subsets are employed.

Settings Opens the Splitting dialog which is for determining the head positions and is
described in the section Vector Proof Profiles.

Show errors If checked, errors will be highlighted in red on the produced pages of the
PDF file.

Create OPI info for images If checked, allows the spool file to contain additional information
for an Open Prepress Interface (OPI) server.

The OPI server is then used to replace any used images (which have been kept at a low
resolution to reduce file size) with higher resolution versions if they exist. Supported by
JPG, TIF and EPS images.

This option is unavailable if the PDF restricted subsets are employed.

DPM Tab

The DPM tab allows to define Document Part Metadata to be embedded in a PDF file. The tab
is available only when the PDF/VT subset is enabled.

1374
 12.4 Engine Configuration

Document Part Metadata (DPM) is descriptive metadata about the pages, and page ranges, in
the PDF document for a Variable-data printing (VDP) job. This metadata can be used e.g. for
record filtering, impositioning or finishing management. This information, embedded on various
levels of a document structure, allows to refer to the PDF/VT pages in way similar to a structured
database select query.

Options Description

Insert DPM If checked, metadata defined in the Document Part Metadata panel will be in-
cluded into the PDF file structure.

Document Part Metadata

DPM variable name prefix Type in a prefix (required) that will be used to mark metadata
in the PDF file (to distinguish your metadata from metadata inserted by someone
else).

DPM Variable Name In this column you can assign metadata to three levels of the
document structure:

Note The full name for a DPM variable (i.e. combined with DPM variable name
prefix) has to satisfy the XML naming convention.

DPM Variable Name Consisting Of Supported Characters

First character Can contain characters: ":", "_", or

characters from ranges A-Z, a-z, or Uni-
code characters represented by hexa-
decimal ranges 00C000D6,
00D800F6, 00F802FF, 0370037D,
037F01FFF, 200C200D, 2070218F,
2C002FEF, 3001D7FF, F900FDCF,
FDF0FFFD
Second and further characters Can contain same characters as in the
first character (see above) or characters:
"-", "." or characters from range 0-9 or
Unicode characters represented by
hexadecimal character 00B7 or ranges
0300036F, 203F2040

The XML name convention is validated either on this tab or during generating the
output.

Job A job as a whole may be marked with metadata concerning e.g. the job creator
or the time of job creation.

Record A group of pages, most commonly a record, could be marked with

e.g. recipients names. The groups can also be specified according to other
criteria. See also the Data Group By module description.

Page The main object in the Layout module that defines the design space
representing individual pages of the output file.
For each level you can insert keys (variable field names) with the Create New icon
in the bottom-right corner of the dialog. Select a key and press <F2> to rename it

1375
12 Production

according to the metadata field name required. Click on the Delete icon to delete
a key.

Now, in the following column, specify where the values will come from.

Metadata Source Select the source of each metadata variable field. The options are:

User defined value A constant value specified in the DPM Value / Sheet
Name column will be inserted as metadata for the respective field (number
1 in the screenshot below).

From sheet name The variable values will be based on a sheet name. You
will need to specify its index number in the DPM Value / Sheet Name column
(number 2 in the screenshot below).

DPM Value / Sheet Name The meaning of fields in this column depends on the option
selected in the respective row in the Metadata Source column:

For the User defined value option, click on the 3 Dots icon and type in the
user defined constant value.

For the From sheet name option, insert the sheet name index number.

12.4.21 Inspire Native Engine Configuration

In this section: See also:
Inspire Native Engine Config Dialog Inspire Native Module
Inspire Native Engine Command Line
Parameters

The Inspire Native engine communicates print jobs via a TNO spool file. This format is native
to Inspire Designer ideally suited to describing a job from workflow (.WFD file) that has been
designed in Inspire Designer.

A TNO file also contains all sheet names given by the workflow that produced it and the file
can subsequently be efficiently imported to another workflow (via the Inspire Native module
or via the Layout module) where those same sheet names can again be used to identify indi-
vidual sheets or groups of sheets.

You can further define the Inspire Native Engine Config and the Driver Config.

Selecting InspireNative in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the Inspire Native Engine Config dialog.

1376
 12.4 Engine Configuration

12.4.21.1 Inspire Native Engine Config Dialog

Options Description

Variable EPS /PDF output resolution You can overwrite the resolution used to render EPS
and PDF images.

Compression When checked the output TNO (Inspire Native format) will be compressed to
save the disk space, however it may take longer.

Images

Use external images When not checked, used images are stored in the TNO file itself.
This increases the file size but the file is more portable since it does not depend on
external resources.

When checked, the used images are stored as references only:

Use original links Does not change the original path, the file must be in the
same location

Use resource directory The image files are copied into specified resource
directory and then the new reference (pointing to resource directory) is stored
in the TNO file.

Fonts

Use external fonts When not checked, used fonts are stored in the TNO file itself. This
increases the file size but the file is more portable since it does not depend on external
resources.

1377
12 Production

When checked, the used fonts are stored as references only:

Use original links Does not change the original path, the file must be in the
same location

Use resource directory The font files are copied into specified resource dir-
ectory and then the new reference (pointing to resource directory) is stored
in the TNO file.

Include metadata information If checked, metadata is included in the TNO file. When the
TNO file is opened in Simple Production, this metadata displays.

Example Metadata window in Simple Production:

Generate metadata file If checked an XML file with metadata is created in the same directory
as the output TNO file.

Report out of page objects If checked, warnings will be shown in the Log window-pane
as the workflow is processed, if objects on the pages of the design are printed out of
page.

1378
 12.4 Engine Configuration

12.4.22 Podi PPML Engine Configuration

In this section: See also:
Podi PPML Engine Config Dialog Driver Config
PPML Printer Configuration
PPML Device Profiles

Podi PPML engine creates output in the Podi version of the PPML stream format.

You can further define the Podi PPML Engine Config, Driver Config and the Printer Config.

Selecting Podi PPML in the Engine combo-box and clicking on the Edit button in the Engine
Config area displays the Podi PPML Engine Config dialog.

Note Avoid using diacritical marks and the underline character _ in the names of workflows
and/or images on RIPs.

12.4.22.1 Podi PPML Engine Config Dialog

There are two main tabs:

PPML Output Option

Advanced Settings

PPML Output Option Tab

1379
12 Production

Options Description

Output Profiles Selects from:

Optimized for output size Determines that the output will be produced using
predefined parameters that have been chosen to generate an output spool file
which will be of a minimum size and use least memory.

Optimized for portability Determines that the output will be produced using
predefined parameters that have been chosen to generate an output spool file
that is as portable as possible. "Portable" or "compatible" means that it can be
printed on a wide range of compatible printers and will consistently produce
identical or close to identical documents.

Advanced settings Unlocks the Advanced Settings tab for you to define the
parameters for yourself.

PPML version Selects the version of PPML protocol. Select from: 1.02, 1.50, 2.10 or 3.00.

Debug Information

Add debug info into spool file If checked, then information used for indicating possible
issues is added into the spool file. This information can later be used for support
purposes.

Advanced Settings Tab

The Advanced Settings tab has eight sub-tabs:

DSC

Fonts

Images

Image Format

VI Elements

PPML Settings 1

PPML Settings 2

Engine

ICC Profile Setting

Use the attributes that are listed on each page to define your own output requirements. At
any point you may use the Reset all values to combo-box to reset the values to the pre-defined

1380
 12.4 Engine Configuration

Optimized for size or Optimized for portability which are the same settings as can be set via
the PPML Output Option tab.

DSC Tab
Using Document Structuring Conventions (DSC) not only helps assure that a document is device
independent, it allows PPML language programs to communicate their document structure
and printing requirements to document managers in a way that does not affect the PPML
language page description.

DSC conforming files also contain comments to indicate additional information such as struc-
turing.

Options Description

Document structuring conventions type Selects from:

None Does not use any document structuring.

Basic Uses basic document structuring.

DSC version 3 Uses document structuring to DSC version 3 specifications. Recom-

mended as it allows many RIPS to handle the output.

End of Line Selects from:

Mac style (carriage return) Each end of line will consist of carriage return character
(h0D).

Unix style (line feed) Each end of line will consist of line feed character (h0A).

Windows style (carriage return and line feed) Each end of line will consist of line
feed + carriage return characters (h0A h0D).

1381
12 Production

Length of Lines Specifies the max. length (in characters) of one line in the spool file in the
Line Length edit-box.

Directory Separator Selects the separator type to be used in the description of paths and
directories in the output file:

Unix style / (forward-slash) If you are using a UNIX system.

Windows style \ (back-slash) If you use Windows.

Fonts Tab

Options Description

Use Selects:

Type 1 fonts IBM Postscript Type 1 fonts are selected by default as CID fonts are
not yet supported by Inspire Designer.

Encryption Selects a type of encryption for the file:

ASCII charstring encryption Toggles on ASCII encryption. Checked by default.

Use eexec encryption Toggles on Eexec binary encryption.

ASCII eexec encryption Enabled only if Use eexec encryption is checked. Toggles on
ASCII eexec encryption.

Text Encodings Selects from either: Binary, Octal or AsciiHex type of encoding for the output.

A font's encryption determines the type of 'encoding' of the vector fonts data to be passed
to the printer.

1382
 12.4 Engine Configuration

Font Encoding

Share font encoding If checked, all used font encodings are stored as an external object;
the spool file contains only reference to them.

Using this option decreases the spool file size.

Use encoding for fonts If checked, you can further select the type of codec to be used
from the combo-box menu; Adobe Standard or ISO Latin.

Encoding fonts, by checking this option, is important if you want to use Find Text
options in viewers, e.g. Adobe Acrobat.

Single or Double Byte Fonts

Maximal count of single byte fonts Determines a threshold value that specifies that
after so many (the number entered in the edit-box) single-byte fonts, double-byte
fonts will be created.

Images Tab

Note When using the Use media box option (in Layout) for images, the behavior of processing
such images depends on the media box and crop box values. See the overview of such behavior
at the end of this section.

1383
12 Production

Options Description

EPS / PDF rasterization resolution Redefines the resolution used to render EPS and PDF
images by entering a DPI value in the combo-box.

Image Filters Here you can set the filters for images in cases where the printer has problems
processing images in their original format. The filters will transform the image into the
chosen coding.

By clicking on the AsciiHex, Flate or Ascii85 buttons you add a filter of that type to the
queue (in the area on the left). More than one filter can be used, the filter at the top of
the list will be used first and so on down the list.

To remove a filter, select it from the list and click on the Remove button.

Note The optimized options on the PPML Output Options tab already use filters:

Optimized for portability Flate + AsciiHex

Optimized for output size Flate

Create Images Selects how the creation of images should be handled:

Generate images into directory same as for spool file Creates external images
stored in the same directory as the spool file.

Generate images into directory Creates external images stored in the directory
selected in the combo-box.

The Browse icon opens the Browse for Folder dialog to aid location of a suitable
directory.

Do not generate images (Use images created before) Uses the images that have
been generated in a previous run of the job or original images from their defined
location.

Example If you have previously run a job where you have selected one of
the other Generate images options, then the images will have already been
processed one time and stored, therefore it is not necessary to create them
again and it would take more time to do so.

So, using the Do not generate images option for subsequent job running re-
duces spooling time.

Alternatively, you should check this option if you are using an original image sup-
ported by printer and images do not need to be generated because they can be
processed as images of a supported type.

Example You might be using a TIFF image stored on a network shared drive
in your Layout and your printer RIP supports TIFF files. In this case you would
select Do not generate images here and check the option TIFF and select Set
original image location prefix on the Image Format tab.

1384
 12.4 Engine Configuration

Note It is recommended to avoid using diacritical marks and double-byte characters in

image file names.

Patterns

Use inline patterns in overlays If checked, sets any used fill-patterns for objects as
part of the overlay description, as opposed to being a separate resource.

Only use if the Use overlays option has been set on the PPML Settings 1 tab.

Use inline patterns in pages If checked, sets any used fill-patterns for objects as part
of the page description as opposed to being a separate resource.

Optimize non-tiled image fill styles If checked, any rectangle shape objects with fill
styles that are in the layout design of the workflow being printed, will be processed
as images with clipping paths. See also the overview of the behavior when the Use
media box option is (not) used for images.

This should provide noticeably faster spooling if many rectangle shapes have been
used.

Note It is recommended to use the options Use inline patterns in overlays / Use inline
patterns in pages if the design contains images in shapes.

Generate images from native EPS and native PDF externally If checked, any PDF or EPS
images that will be loaded to a workflow natively (option Load natively on the Advanced
tab of any image in the Layout module) will be passed to the directory as separate files to
the spool file.

If left unchecked, then these images will be defined as part of the spool file.

Image color space Selects a color space method to be applied:

Take from Layout image Applies colors as they have been defined in the Layout
of the workflow, i.e. image colors are not converted.

Example On the Advanced Tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions
such as CMYK will be converted to RGB at that point and then RGB will be
the colorspace used by this engine if Take from Layout image is selected here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

See the separate Color Spaces section for a description of color.

See the following section for details on the Use media box option combinations and the con-
sequences for the PPML output.

1385
12 Production

General Rules for Use Media Box Option with PPML Engine

If one clipping path is used and the clipping path is:

rectangle the original image (format of the image depends on the settings in the
PPML configuration) is used as the rectangle clipping path is supported in PPML.

any other shape the image is rasterized into EPS including clipping paths.

If several clipping paths occur (e.g. when applying Object groups), the image is rasterized
into EPS including clipping paths.

For PDF images Based on the PPML specification, the media box of PDF images is always
used for generating the output. So when the Use media box option is not checked,
the PDF image is clipped via crop box in case the Media box value differs from the Crop
box value.

Object Use Media Box Checked Use Media Box Unchecked

Media Box = Media Box Media Box = Media Box

Crop Box Differs from Crop Box Differs from
Crop Box Crop Box

Any image (ex- No effect No effect No effect No effect

cept a PDF im-
age)
PDF image No effect me- No effect me- No effect me- Clipped via crop
1)
dia box used dia box used dia box used box
Any image used Clipped via Clipped via Clipped via Clipped via
2) 2) 2) 2)
as non-tiled fill shape shape shape shape
style for shape

(the Optimize
non-tiled im-
age fill styles
option is also
checked for the
PPML output)
PDF image used Clipped via Clipped via Clipped via Clipped via crop
2) 2) 2) 1)
as non-tiled fill shape shape shape box and via
2)
style for shape shape

(the Optimize
non-tiled im-
age fill styles
option is also
checked for the
PPML output)
1)
Values of crop box are used in clipping path values.
2)
Values of the shape are used in clipping path values.

1386
 12.4 Engine Configuration

Image Format Tab

Options Description

Image Type Conversion

Images Supported by Printer Specifies which images are supported by the printing
device.

Select here all of the image formats that are supported by your printer.

If the additional option Use image source code is checked, the image is processed
without altering its coding, i.e. without rasterization.

If the PDF option is checked, you can further select:

Use image source code Processes any PDF images without altering their
coding.

Convert to vector EPS Converts any PDF images to vector EPS format.

Make separated one-page PDFs Creates one-page PDF files from any PDF
images.

If a PDF file used in the Layout of a workflow has more than one page, then
the file will be split, e.g. a six page PDF will be split into six PDF files.

Suppress native loading of images Enables you to globally suppress native loading
of images set by selecting the Load natively check-box on the Advanced tab of the
Image Layout Properties dialog.

The advantages and disadvantages of native loading of images are summarized in

the Native Loading of Images section; see also the information on handling of PDF/EPS
images, which is part of the ICC Profiles section of this User Manual.

Convert unsupported image types into Designates that unsupported image types
will be converted into the image type selected from the combo-box menu.

1387
12 Production

Select an image type that is supported by your printer.

JPG compression quality Determines the compression of JPEG images compared to

the original image.

Units are % of original image size, e.g. 100 is no compression.

Image Location Prefix If you are using external images (and have selected Do not generate
images on the Images tab) then select either:

Set user defined prefix and define the path of the image file, from the location
that the spool file is being sent to, in the text field.

Example This could be used if you have separate images and you store
them inside a folder in the same location as the spool file. In this case, you
would simply need to enter the name of the folder in the text field as they
both have the same path, except the folder name.

Or, Set original image location prefix will use the already defined path to the image
location. This is the path from where the image was inserted into Layout.

Example This can be used on a network when the job uses images that are
stored on one shared drive (they have not been included in the Inspire Designer
workflow) and the RIP has access to that drive. The images will then be pro-
cessed from that original location.

Cached images If checked, images are loaded at one time and stored for repeated use
throughout the job.

Using this option makes printing faster if many variable images are being used, but requires
more printer memory.

1388
 12.4 Engine Configuration

VI Elements Tab

Options Description

Cached VI (variable information) Elements

Cache Element Selects whether you want to cache elements or how you want them
named:

Do not generate cached VI elements VI elements are generated but not

stored on RIPs.

Generate with job name VI elements are generated and stored with job
name.

Generate with user name VI elements are generated and stored with the
name that is entered in the text field.

1389
12 Production

Enter a name of your choice in the check field.

Overwrite Cache These options are activated if either Generate with job name or
Generate with user name has been selected in the Cache element field.

Overwrite cache overlays If checked, defines that every new spool file overwrites
previously cached overlays on RIP, no global cache is created.

Overwrite cache images If checked, defines that every new spool file overwrites
previously cached images on RIP, no global cache is created.

Global Cache These options are activated if either Generate with job name or Generate
with user name has been selected in the Cache element field.

Add images to global cache If checked, determines that images will be stored on
RIPs for usage in another spool file.

Add overlays to global cache If checked, determines that overlays will be stored
on RIPs for usage in another spool file.

Unique Element Names

Generate job unique element names If checked, elements from different jobs with
the same name are made distinguishable by adding a unique part to the name of
each element.

PPML Settings 1 Tab

Options Description

Use overlays If checked, static objects (images, flow areas etc.) will be loaded as overlays.

Use masters If checked, the set of pages for each record will be loaded as masters.

1390
 12.4 Engine Configuration

Pages are divided into a master (or static) layer and a variable layer. The master layer con-
tains those objects on the pages that are the same (static) for every instance of the variable
data job. The variable layer contains the objects that change (variables).

The fixed objects that will be placed in the master must be in an overlay and not overlap
(on top) variable objects.

Because all printed records will use the same master, the number of pages must be exactly
the same for each record, i.e. no variable page selection can be set in the workflow.

Note Masters are compatible with Xeikon devices only.

This option is not available for HP PPML.

Use Procset If checked, PS commands and procedures are placed into a dictionary and stored
on the RIP to be re-used.

This makes processing on some RIPs faster.

Note This option has to be used for Xeikon printers.

Colors

Use separation color spaces and DeviceN colors If checked, employs the separation
colors, that have been defined in Layout, as color identifiers in the output. This allows
printers that are coordinated with the Device N or Separation color system to recognize
them.

Append ICC profile to images If checked, employs standard ICC color in the output
if applicable.

Example For example, if an image contains an embedded ICC profile and it

is then transformed using real ICC profiles (not built-in CMYK profile) or not
transformed at all, the current ICC profile is written to the spool file together
with the image data which makes the image device-independent.

See the separate section ICC Profiles for additional details.

Internal Document Splitting Splits the job into booklets or documents (set of sheets) that
can be made up of, for example, one record:

One document for the whole job The produced file contains one document.

One document each x sheets The produced file contains documents where each
document consists of the selected number of sheets defined in the combo-box.

Example There are 3 pages in the job (page = sheet) and you want One
document each 2 sheets. This results in having one document for the first
two pages and another document for the remaining one page.

<DOCUMENT>
<PAGE Label="Page 1">
<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>

1391
12 Production

<PAGE Label="Page 2">

<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>
</DOCUMENT>
<DOCUMENT>
<PAGE Label="Page 3">
<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>
</DOCUMENT>

Split by group The produced file contains documents where each document
represents a group.

By default, each group is defined by and is identical to a record, unless impositioning

modules are used to change the group definition.

Example There are 3 pages in the job (page = sheet) and the Sheet Re-
grouper module where you define that each sheet is a group (By sheet count,
Split count: 1). This results in having three documents for three groups. Each
group contains one sheet.

<DOCUMENT>
<PAGE Label="Page 1">
<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>
</DOCUMENT>
<DOCUMENT>
<PAGE Label="Page 2">
<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>
</DOCUMENT>
<DOCUMENT>
<PAGE Label="Page 3">
<PAGE_DESIGN TrimBox="0 0 595.275591 841.889764"/>
</PAGE>
</DOCUMENT>

Reset split counter in new file Resets the sheet counter, that is defined above in the
One document each x sheets option, with each new split file that has been defined
using the Split by group or Split by size options in the driver configuration.

Therefore, the first document of each split file will be the same length each time. It
follows that, consecutive documents in that file will contain the same number of

1392
 12.4 Engine Configuration

sheets until the next file split. That next file split could occur before the entered
number of sheets have been counted.

Reset page number in new file Resets the page counter with each new split file that
has been defined using the Split by group or Split by size options in the driver
configuration.

Therefore the first sheet of each spool file will be numbered as page 1.

Tip Settings in the Driver Config are applied first, then splitting options from here are
further implemented.

Internal or External Font Resources

Use internal data If checked, all font resources will be included in the PPML spool file.

This option is not available for PPML versions earlier than 2.1.

If left unchecked, creates a resource file for the fonts and External resource file
directory will be activated.

External resource file directory Designates a resource file directory for external fonts
that will be created.

Select a destination, either:

Same as for the spool file

or

User defined Enters the location for the file using the Browse icon to
find it.

Only active if Use internal data is unchecked.

Resource file location prefix Defines a resource file location prefix, i.e. a path to find
the file from the location of the spool file.

Example This could be used if you have separate resources and you store
them inside a folder in the same location as the spool file. In this case you would
simply need to enter the name of the folder in the text field as they both have
they both have the same path except the folder name.

PPML Settings 2 Tab

1393
12 Production

Options Description

Conformance

Graphic Art subset GA If checked then the make-up of the output and use of resources
is streamlined to the requirements of a graphic art workflow.

This means that there is less content to the spool file but only TIFF and JPG images
can be used and only Postscript and PDF content is supported. The output of the job
can contain any or all of these formats but the printing device must support all of
them.

Note Only supports PDF versions 1.3 and later.

Internal Data Encoding

Use Base64 encoding on PS command (recommended) If checked, employs Base64

encoding for the PostScript commands in the spool file.

This option is checked by default and is recommended. If unchecked, more information

is added to into the PPML spool file which is useful for debugging purposes but pro-
cessing becomes longer and more unstable.

Engine Tab

Options Description

Output Files

Zip all files generated into same directory as spool If checked, all associated files
that are in the same directory as the spool file will be compressed into a ZIP file.

Copy all files to output directories at once when all files are processed If checked,
all of the output files are copied from the temporary directory to their respective dir-
ectories together and at one time, after all of the files have been processed.

Example This option can be used to prevent the following situation: A RIP
starts processing each resource file as soon as it has been created and placed
(one by one) into a directory. Spooling continues and if the processing of a file

1394
 12.4 Engine Configuration

ends before the next one required has been created then there will be no avail-
able file and spooling will stop.

Temporary Files

Compress temporary files If checked, the temporary files that have been created
during spooling are compressed to reduce disk space usage.

Page Extent Specifies a maximum page length.

Your printer will have a preset Maximum page length. By entering that length here, the
spooling of any larger pages will be prevented.

By default there is 10000 mm set (page extent in the direction of the paper feed). Check
your printers capabilities before you change this dimension.

The measurement units can be changed by right-clicking on the symbol.

Resize Barcodes See the separate Resize Barcodes section.

ICC Profile Setting Tab

See the separate ICC Profile Setting section.

12.4.23 Raster Engine Configuration

In this section: See also:
Raster Engine Config Dialog ICC Profiles Setting
Raster Engine Command Line Parameters

The Raster engine creates raster images with advanced image settings (e.g. CMYK profile and
set dithering).

It can also be used for preparation of images for later use in a job.

Example We would like to use a full color multiple page PDF (or any other image) as
black and white in AFP output. To do this:

1. Read PDF in Layout as B&W, use Raster output with multiple page ioca image
(mioca)

2. Mioca images are copied directly to AFP using the option Use original IOCA
image data without processing

You can further define the Raster Engine Config and the Driver Config.

Selecting Raster in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Edit Profile dialog.

1395
12 Production

12.4.23.1 Raster Engine Config Dialog

The tabs are:

General

ICC Profile Setting

Dithering

Splitting

General Tab

Options Description

Output File Format

Colorspace By default set to Black and white. It corresponds with the settings in Output
colors combo-box located further down on this tab.

Example If you set Output colors to CMYK you can still decide in what Col-
orspace the output should be (if CMYK or RGB).

File type Selects the file type. For details about the main types see the Image engine
section.

Interlace Places a rough, blurry copy of the image at the beginning of the data stream,
which allows viewing the preview of the actual image first. The file gradually sharpens
as the image loads.

1396
 12.4 Engine Configuration

Only available when image/png or image/jpeg are selected in the File type combo-
box.

Quality Selects the JPEG compression quality.

Units are percent of original image size, i.e. 0 is the greatest compression (and lowest
quality), and quality level 100 corresponds with the least compression (and highest
quality).

Only available when image/jpeg is selected in the File type combo-box.

DPI Sets the resolution of the raster output in DPI.

DPI for PDF/EPS Sets the resolution for rendering PDF and EPS images.

Resize Barcodes See the separate section Resize Barcodes for more information.

Output colors Selects how the colors of the design will appear on the sheets:

Black and white Represents the colors by dithering black and white dots.

Further select dithering patterns on the Dithering tab.

CMYK Represents the colors in CMYK color space.

CMYK split Represents the colors by dithering CMYK based dots.

The resulting dithering pattern uses Cyan, Magenta, Yellow, Black, Red, Blue,
Green and White colored dots. Further select dithering patterns on the Dithering
tab.

Spot color Represents the colors as spot colors.

Spot colors must be assigned to each of the colors in the workflow, this can be
done via the Color dialog. For both the raster engine and raster proof, spot colors
are painted in a specific order: Spot color 15, Spot color 14, Spot color 13... through
to Spot color 0. This can cause some colors to be hidden on the resulting sheets,
e.g. if spot color 5 is used for text in a flow area that is over a shape of spot color
2, then the text will be hidden by the shape. However, all assigned spot colors are
still present and can be printed via other raster engines according to any order
determined by the printing device.

When using raster proof, you can check that all spot colors are correctly used in
the design by selecting them individually in the Edit Process Colors dialog.

Dithered spot color Represents the colors by dithering spot colors or black and
white dots.

Dithered spot colors should be assigned to each of the colors in the workflow, this
can be done via the Color dialog. Colored objects that use colors that are not as-
signed as dithered spot colors are dithered using black and white dots. Further
select dithering patterns on the Dithering tab.

Dithered colorants Represents the colors by dithering colorants or in black and

white.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as

1397
12 Production

colorants are dithered using black and white dots. Further select dithering patterns
on the Dithering tab.

CMYK dithered colorants Represents the colors by dithering colorants or in CMYK

color space.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are dithered using CMYK color space. Further select dithering patterns
on the Dithering tab.

CMYK split dithered colorants Represents the colors by dithering colorants or

dithering CMYK based dots.

Colorants should be assigned to each of the colors in the workflow, this can be
done via the Color dialog. Colored objects that use colors that are not assigned as
colorants are dithered using Cyan, Magenta, Yellow, Black, Red, Blue, Green and
White colored dots. Further select dithering patterns on the Dithering tab.

Graphic support Selects the level of graphic support of the printer to be used. You can
choose from:

None Specifies that the printer does not support graphics. All image-like objects
(shapes, lines, fill styles etc.) are printed as images.

Rectangles Specifies that the printer supports rectangular shapes.

Full Specifies that the printer supports all graphics. Lines and fills are drawn incre-
mentally.

Full with outlines Specifies that the printer supports all graphics. This is an effective
mode as lines and fills are drawn in one step.

However, if the result is not ideal, use the option Full where the step-by-step
drawing will ensure a more accurate result.

Full with outlines and Beziers Specifies that the printer supports all graphics. Lines
and fills are drawn in one step and curves are represented by points of a Bzier
curve to be rendered by the printer.

This a more efficient processing method and also supports curved line ends and
joins and but it depends on the ability of the printing device to render curves.

Use fonts for graphics If checked, black and white graphics are stored as individual font
characters for faster processing.

The intention is that this is used for black and white graphics when matrix dithering type
is used (for details on matrix dithering types see the Edit Dithering dialog section). It is
most useful with variable graphics (it works for overlays that are not merged as well, but
to less advantage) and this option was implemented to speed up the processing of 2D bar
charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create a
9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, depending

1398
 12.4 Engine Configuration

on the position of the rectangle, and the image content data would be just 32 bytes
with usually an additional overhead.

If None is selected for Graphic support, any black or gray color rectangle is processed
much faster with less memory use. If Rectangles is selected for Graphic support then the
rectangle support of the printing device has priority, so that pure black rectangles are
printed using the printer function, but still gray rectangles are printed using fonts. For all
other settings of Graphic support, and for colored graphics, it is better to leave this option
unchecked and use the rectangle support provided by the printing device.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Merge static objects into overlay Merges all objects that do not contain variables together
into a single overlay.

In Proof, it emulates the functionality of the check-boxes appearing in the AFP and IPDS
engine configuration dialogs.

It is recommended to uncheck this option in case that a large design has been created in
Layout.

Support other color spaces If checked, colors defined in RGB color space will be processed
as RGB colors in AFP-like outputs.

If not checked, all colors will be treated as CMYK colors.

Note This feature does not affect the look of the output. It is used mainly for testing
reasons (to emulate the actual printer settings).

White processing Selects whether the colors of text and images should be printed over any
background, or if the background should be cut out where any text or images are to be
printed.

See the White Processing section for more information.

Grayscale printing Selects if grayscale will be used in the rendering.

Selecting Include fill styles with images determines that anything that is processed as an
image will be rendered in grayscale quality, i.e. color images, colored shapes, charts, border
styles etc.

It is only active if Black and white has been selected in the Output colors combo-box.

Primer The options here are for adding a representation of a primer coat to the sheets.

Primers can be applied when printing via the MIBF engine. See options for MIBF Engine
Configuration for some extra explanation.

Enabled Displays a representation of a primer coating over the print on the sheets.

Additional size Determines how much bigger the primer coat will be than the print
that it covers. Units are dots.

1399
12 Production

These options are only available if CMYK split has been selected for Output colors.

Colorants This edit-box is only available when Dithered colorants or CMYK dithered colorants
has been selected in the Output colors combo-box.

The Colorants edit-box displays the list of colorants defined in Layout and, depending on
the selected type of output colors, default (hard-coded) colorants, that cannot be further
edited. The default colorants are indicated below:

Dithered colorants Black.

CMYK dithered colorants Cyan, Magenta, Yellow, Black.

All colorants used in the layout have to be present in this list. They are added automatically
when opening the Output colors combo-box.

Note If the output colors for proofing a job are set for Dithered colorants or CMYK
dithered colorants and you add a colorant in Layout, it is necessary to refresh the list of
colorants in this edit-box before re-proofing the job.

Apart from the auto add, colorants can be added manually using the following controls:

Create New Creates a single colorant.

Add Colorants from Layout Adds all colorants as defined in Layout.

The colorants added to the list of colorants can be further edited (editing will affect only
the Proof view, the color definition of the workflow will remain untouched).

Remove Colorant Removes the selected colorant from the list.

Note It is not possible to remove a colorant if there is only one colorant in the list.

Rename Colorant Enters a new name for the selected colorant.

Note The name will only be changed in the list, the renaming will have no effect
on the colorant created in the Layout environment.

Move Up / Move Down Enables you to move the selected colorant up/down in
the list of colorants.

Open Adds all colorants created in Layout to the list.

Note For more details on colorants see the according part of the Colors section.

ICC Profile Setting

See the section ICC Profile Setting for more information.

Dithering Tab
See the Dithering section for more information.

1400
 12.4 Engine Configuration

Splitting Tab

On this tab you can define virtual head positions or load head definitions that have previously
been created. The purpose is to simulate the heads of an IJPDS printer in order to see how the
workflow would be split between them.

Note Splitting is a feature that is used for proofing a workflow with a raster proof profile.

For accurate proofing you should ensure that the settings on this tab correspond to those that
will be set in the corresponding raster engine configuration when the workflow is produced.
To be able to see raster printing heads in Sheet Proof, go to: View | Show Heads in the Sheet
Proof Window menu or select the Head Tool .

Options Description

Media Settings Defines the different media that are used by the workflow in order to allow
you to assign head settings to each one. These media should correspond to the media
that have been defined in the in the workflow, i.e. using Sheet name 1 and the Output
module.

Media Index Assigns which medium has its head settings defined here by using an index
number that links it to a corresponding medium in the workflow,

Each defined medium is assigned an index number, based on the order that it is
processed. The first medium defined (i.e. the Sheet name 1 from the first processed
page from Layout and, therefore, the medium at the top of the list in any Output
module) is given index 0, the second index 1, the third index 2, etc.

1401
12 Production

Example If we have a layout with 2 pages where each have a different value
in the Sheet name 1 field, then:

The first page appearing in the Layout Tree uses the head settings made
for the Media Index set to 0.

The second page appearing in the Layout Tree uses the head settings
made for the Media Index set to 1.

If any medium defined in the workflow is not represented here, the settings assigned
for the Default medium are used. Default cannot be deleted.

Face Selects the face of the output sheet the settings will be applied to. This is important
only when you have selected one of the Duplex settings (Duplex short edge or Duplex
long edge) in the Duplex type combo-box for a defined media page in the Output
module. In this case there can be a back page to which extra Face settings can be
applied (i.e. in Layout, there have to be at least two pages which have the same Sheet
name 1, and in the Output module, a media page defined using this Sheet Name 1
must be set to one of the mentioned Duplex settings). The following options are
available:

Front The settings are applied only to front pages.

Back The settings are applied only to back pages.

Both The settings are applied to both back and front pages.

Note For the Default medium this option is always set to Both and cannot be
altered.

Shrink Allows you to determine the handling of heads when the head in use is not
aligned to the left border of the page or when using several heads when there are
gaps between the heads in use. The following options are available:

True The first head is moved to the left until it is aligned with the page's left
border. All subsequent heads are also moved to the left until they meet the
head to their left. Thus, there will be no gaps left on the left side of the page
or between heads, but there can be a gap to the right of the last head.

The content originally covered by the heads will be moved accordingly, just
as the head. Any content which was not covered by any head is not displayed.

False The heads will stay in the position in which they have been placed.

Create New Adds a new row to the list.

Delete Removes the selected row from the list.

Note The Default medium cannot be deleted.

Horizontal Head Settings (in dots) Sets horizontal heads for the selected Media Index; i.e.
the values displayed here depend on the row selected in the Media Settings field. Keep

1402
 12.4 Engine Configuration

in mind that the values specified here are in DPI, which means the width and position of
the head also depends on the setting for DPI on the General tab of this dialog.

From Sets the starting point of the head (in DPI).

Width Sets the width of the head (in DPI).

Create New Adds a new row to the list.

Delete Deletes the selected row from the list.

Vertical Splitting Sets the vertical splitting position (effectively the height) of the medium
selected in the Media Settings area.

This has no effect on the look of the resulting output, but is the equivalent of the Height
set for the Definition of Pages on the Pages tab of the IJPDS Engine Configuration and
the value can be set accordingly here.

Create New Adds a new row to the Split Position list where you can add a position
value.

Delete Removes the selected row from the Split Position list.

Save Opens a Save As dialog in order to save the current head settings to a XML file.

They can subsequently be used at another time or elsewhere, e.g. for use when setting
up the IJPDS Engine Configuration.

Note Head settings are saved in the CFG file automatically. So even if you do not save
them, they will be used at your next session unless you make some modifications.

Open Opens an Open dialog in order to load a XML file of previously saved head settings.

For example, head settings can also be created and saved on the Head Display tab for in-
dividual pages in Layout.

If there are more media defined, the Load Split Settings dialog appears prompting you to
select the import mode.

Load into selected media Imports the settings for the selected media. In this case the
settings for all other media remain unaffected.

Remove all media settings and load into Default Removes all media present in the
list above and imports the settings to the Default medium.

Because the head positions are measured in dots, make sure that you have the correct
DPI value on the General tab of this dialog to get the same head appearance as was defined
for the saved head definition.

1403
12 Production

12.4.24 SWF Engine Configuration

In this section:
SWF Engine Config Dialog

The SWF engine creates a flash (SWF) file from a workflow. The intention is for viewing a
document using an internet browser (with a SWF plugin, e.g. Adobe Flash Player) as part of a
web page, and some basic flash navigation can be added for multi-page files.

You can further define parameters in the SWF Engine Config and the Driver Config.

Selecting SWF in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Edit Profile dialog.

Note There might be differences between proof and flash plugin/viewer. These can be solved
by zooming in with the flash plugin/viewer.

12.4.24.1 SWF Engine Config Dialog

The tabs are:

General

Controls

Resources

Image Handling

Advanced

General Tab

Options Description

Output resolution Selects the resolution for the created flash document: 18, 36, 72 or 144
DPI.

Alternatively, you can type in any other resolution. Larger resolutions result in better
quality but larger SWF files.

Tip For the catalog control, it is recommended to use a maximum of 72 DPI to ensure
correct and smooth usage.

1404
 12.4 Engine Configuration

Gradients resolution Selects a resolution for any gradient fill styles that have been used in
the workflow and are not supported by this engine: 72, 100, 150 or 300 DPI.

The value set here is the resolution of the resulting image. Alternatively, you can type in
any other resolution. Larger resolutions result in better quality but larger SWF files.

Inspire Designer supports more gradient types than the SWF format, therefore type of
gradients that are used but not supported must be converted to a JPG image. However,
all linear gradients and most radial gradients are supported and will not be converted to
an image.

Crop content to size of medium If checked, any part of the designed content of a page
which is outside the bounds of the medium defined (either in the Output module or Layout
of a workflow) will not be displayed when the flash file is opened.

Controls Tab

Options Description

Use simple navigation Generates a SWF document which can have the following controls
included:

Add keyboard navigation The SWF document can be navigated using the
up/down and left/right arrows and <Page Up> / <Page Down> keys of a keyboard.

Add navigation panel The SWF document can be navigated using the following
panel:

You can also enter a page number for faster navigation. The arrow seen at the
bottom of the panel allows it to be hidden when viewing an individual page.

Navigation Panel

Size in % Sizes the navigation panel. The entered size is a percentage of

the original size.

Relative path Sets the path to the navigations panel's SWF file in relation
to the SWF file of the output design. The navigation panel is created as a

1405
12 Production

separate file to the output and it can be stored in the same directory or any
sub-directory. The path to the sub-directory and a name for the file can be
entered here.

For further use of the generated output SWF file, you also need to have the
SWF file with the navigation panel (called by default NavigationPanel.swf).

Create flash catalog Generates the SWF document as a catalog.

This control enables you to view single pages (one or two pages on the screen), enter
pages, zoom them and navigation with keyboard (up/down and left/right arrows, <Page
Up> / <Page Down> keys) and thumbnails. In standard or full screen mode.

Relative path Sets the path to the catalog's SWF file in relation to the SWF file
of the output design.

The catalog control is created as a separate file to the output and it can be stored
in the same directory or any sub-directory. The path to the sub-directory and a
name for the file can be entered here.

For further use of the generated output SWF file, you also need to have the SWF
file with the catalog control (called by default Catalog.swf).

Create HTML page Creates a HTML file named as the SWF output file (in addition
to the SWF output file and the catalog control file). This HTML file serves for the
user to check the specification of the control before the control is used in their
web pages.

1406
 12.4 Engine Configuration

Best Practices for Catalog

All pages have to be the same size.

Consider the size of the output file; the more pages there are, the slower the
loading of the catalog will be.

Recommended output resolution is maximum 72 DPI to ensure correct and smooth

usage.

Consider size and format of images when generating the output (on the Image
Handling tab) to ensure correct and smooth usage.

Embedded objects make the usage of the control slower.

Note Full screen mode does not allow entering page numbers and navigation with
<Page Up> / <Page Down> keys of a keyboard.

Resources Tab

The paths entered on this tab can be absolute or relative to the produced SWF files. They can
be local network or URL paths. By default a Resources folder will be created in the same directory
as the SWF file, i.e. the directory described by File name of the File Driver config.

Options Description

External Images

Generate images externally If checked, images from the design will be external to
any produced SWF files and their location referenced so that they are viewed when
the SWF file is opened.

Image generation directory Locates the directory where the images will be sent at
the time of production.

SWF path to images Locates the directory where the images will be referenced from
within the SWF file.

1407
12 Production

The intention is that the SWF file might be viewed at different locations (e.g. on the
web), but the images might be at a central location.

Embedded Objects

Download web located embedded objects If checked, any embedded objects used
in a workflow will be downloaded to the Object directory and referenced there in-
stead of at their previous web location.

One intention is to be able to download embedded objects, to a location where you

have more control over them, in cases where it is not certain that the object will remain
on the internet for a required period. However, you should ensure that the downloaded
content will display as required because the original web located object might be
subject to restrictions or require other components that could not be downloaded.
For example, videos from You Tube cannot be downloaded.

Leave unchecked to use the embedded objects directly from the web.

Object directory Locates the directory where the images will be sent at the time of
production.

SWF path to images Locates the directory where the images will be referenced from
within the SWF file.

The intention is that the SWF file might be viewed via at different locations (e.g. on
the web), but the embedded objects might be at a central location.

Tip Embedded objects can be included in a design using Embedded Object Areas in the
Layout module.

Image Handling Tab

The Image Handling tab defines how different groups of images from the workflow will be
processed to the SWF file.

Options Description

Handling Group Groupings for the images are the handling groups that can be set in the
Layout module of the workflow. There are eight groups in all.

You can further define the below described parameters for each of the groups.

1408
 12.4 Engine Configuration

Compression for JPEG images / Compression for other images Selects the type of
compression for any JPEG / other format of images in the handling group. Select from:
JPEG or None.

JPEG quality Determines the percentage of compression required for the image handling
group.

Only relevant if JPEG has been chosen for Compression for JPEG images / Compression
for other images.

Downsample images to Determines that color images in the handling group will be reduced
to the DPI value selected, providing that they have larger DPIs.

Available sizes are: 72, 150, 300, 600, 1200, 2400 DPI or Not set. Alternatively, type in
your own DPI value.

By further entering a DPI value for the option If over in the dependent row below, you
can determine that only images larger than that value will be reduced to the DPI set for
Downsample color images to. However, if Not set is selected here then all images will
be reduced.

Advanced Tab

Options Description

Resize Barcodes Resizes any barcodes.

See the separate section Resize Barcodes for more information.

12.4.25 SX/AP Engine Configuration

In this section: See also:
SX/AP Engine Config Dialog SX/AP Engine Command Line Parameters

The SX/AP engine is an interface for a DLL plugin which allows you to use any specification of
printer with Inspire Designer. The intention is to allow production with page description protocols
that are not yet supported.

The required DLL file should be placed in the same directory as the Inspire Designer GUI applic-
ation (PNetT.exe) or you can add the following variable to your computer's environment vari-
ables: CX_SXAP_DLLPATH. This variable points to the DLL file itself, not just the directory where
it resides.

1409
12 Production

You can further define some basic parameters in the SX/AP Engine Config and the Driver
Config.

Selecting SX/AP in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Edit Profile dialog.

12.4.25.1 SX/AP Engine Config Dialog

The tabs are:

General

Resize Barcodes

Dithering

General Tab

Options Description

White processing Selects whether the colors of text and images should be printed over any
background, or if the background should be cut out where any text or images are to be
printed.

See the White Processing section for more information.

Printer DPI Selects the resolution for the printer that will be used.

Graphic support Selects the level of graphics that the printer supports. Select from:

None Does not support graphics. All such objects are printed as images.

Rectangles Supports rectangular shapes.

Full Supports all graphics. Lines and fills are drawn gradually.

Full with outlines Supports all graphics. This is the most effective mode as lines
and fills are drawn in one step.

However, if the result is not ideal, use the option Full where the step-by-step
drawing will ensure a more accurate result.

Use fonts for graphics If checked, black and white graphics are stored as individual font
characters for faster processing.

1410
 12.4 Engine Configuration

The intention is that this is used for black and white graphics when matrix dithering type
is used (for details on matrix dithering types see the Edit Dithering dialog section). It is
most useful with variable graphics (it works for overlays that are not merged as well, but
to less advantage) and this option was implemented to speed up the processing of 2D bar
charts.

Example If a rectangle is printed and you have an 8x8 matrix size and create a
9x16 rectangle, Use fonts for graphics will produce 4 or 6 characters, depending
on the position of the rectangle, and the image content data would be just 32 bytes
with usually an additional overhead.

If None is selected for Graphic support, any black or gray color rectangle is processed
much faster with less memory use. If Rectangles is selected for Graphic support then the
rectangle support of the printing device has priority, so that pure black rectangles are
printed using the printer function, but still gray rectangles are printed using fonts. For all
other settings of Graphic support, and for colored graphics, it is better to leave this option
unchecked and use the rectangle support provided by the printing device.

Uncheck this option if you do not want to use additional fonts or you require to search
through text in the spool file, searching may result in finding these virtual characters.

Additional configuration Identifies a file with additional configuration details which may
be required depending on the printer being used.

This file name is passed to the DLL file which will handle the additional configuration. The
configuration must be specifically designed to be compatible with the DLL. The DLL and
its configuration are not components of Inspire Designer.

Clicking on the Browse icon opens the Open dialog to aid file location.

Resize Barcodes Tab

See the separate section Resize Barcodes for more information.

Dithering Tab
See the Dithering section for more information.

12.4.26 Text Engine Configuration

In this section:
Text Engine Config Dialog
Text Engine Known Limitations

The Text engine prints the text passage that makes up the main flow, i.e. only the content of
the main flow (selected via the properties panel of the Pages family) will be in the produced
file.

1411
12 Production

Objects that can be placed only directly on a page (or as a part of an element), e.g. barcodes,
charts, shapes, are not supported. See also the Text Engine Known Limitations below.

Only the text information will be passed to the output and the way the text will be displayed
(or printed), e.g. the font that will be used, depends on the viewer. However, it is recommended
to use a fixed-width (non-proportional) font, such as e.g. Courier, for design, because the text
in the output text file will be dispayed in a fixed-width font.

Note Parallel processing cannot be used for this engine.

You can further define the Text Engine Config and the Driver Config.

Selecting Text in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the Text Engine Config dialog.

12.4.26.1 Text Engine Config Dialog

Available tabs are:

General

Data Encoding

Table

General Tab

Options Description

Width of line [m] Defines width of the line in meters. Together with Glyphs per line it in-
fluences wrapping and indentation.

Height of line [m] Defines height of the line in meters. Also, it influences vertical spacing.

Glyphs per line Sets the number of characters in each line.

Even if set to e.g. 1, one word will be displayed on each line.

Space character code Sets the decimal value of the character code used for the 'space'
character, 32 by default.

East Asian characters support When checked, the double-byte characters are supported.

1412
 12.4 Engine Configuration

Supplementary characters support If checked, the supplementary characters are supported.

URL target mode Select the type of handling URL links set for the text in the design phase:

Text The URL link will be disregarded, i.e. only the text will be displayed.

Example Join GMC User Community.

URL The URL link will replace the text.

Example Join http://community.gmc.net.

Both The URL link will accompany the text.

Example Join GMC User Community [http://community.gmc.net].

Data Encoding Tab

Options Description

Text Encoding Sets the output coding of the text file.

See the separate section Text Encoding for more details.

End of line (EOL) The following options are available:

Mac style (carriage return) Each end of line will consist of carriage return character
(h0D)

Unix style (line feed) Each end of line will consist of line feed character (h0A)

Windows style (carriage return and line feed) Each end of line will consist of line
feed + carriage return characters (h0A h0D).

Table Tab
On this tab you can define how borders of tables used in Layout will appear in the text output.

1413
12 Production

By default the table is composed from ASCII table characters (it results in dashed lines). By
pressing Set Default Unicode Table Characters button you can select Unicode table characters
(smooth lines).

Default ASCII Table Characters:

Result in the text output:

Default Unicode Table Characters:

Result in the text output:

For both ASCII and Unicode you can also enter your own characters constituting each part of
the table (indicated next to the edit field). You can either enter the character directly in the
edit field or by using its code.

1414
 12.4 Engine Configuration

12.4.26.2 Text Engine Known Limitations

Graphical objects Images and elements (including any object in the elements, e.g. barcodes,
charts, shapes) that can be inserted to the main flow are not supported.

Text Style Most text style features are not supported. This is the one that is supported and
in what way:

Intercharacter spacing is simulated by inserting spaces.

Paragraph Style Many paragraph style features are not supported. The following list contains
those that are supported and in what way:

Alignment (including the Justify options) is supported.

Indent the indent calculation depends on the values you enter to the Width of
line and Glyphs per line options. The resulting indent is simulated by inserting
spaces.

Space before / after the vertical space calculation depends on the value you enter
to the Height of line option. The resulting indent is simulated by inserting empty
lines.

Ignore empty lines is supported.

Tabulators are simulated by inserting spaces.

Hyphenate is supported.

12.4.27 VIPP Engine Configuration

In this section: See also:
VIPP Engine Config Dialog Driver Configuration Overview
Engine Configuration Overview

The VIPP engine produces a spool file in the VIPP (Variable data Intelligent PostScript PrintWare)
format which is an enhancement of the PostScript format.

Additionally, you can define the VIPP Engine Config and the Driver Config.

Selecting VIPP in the Engine combo-box and clicking on the Edit button in the Engine Config
area displays the VIPP Engine Config dialog.

Note Inspire Designer does not support VIPP in database mode.

1415
12 Production

12.4.27.1 VIPP Engine Config Dialog

This dialog enables you to set attributes related to the VIPP engine. The following tabs are
available in this dialog:

VIPP Output Option Tab

Advanced Settings Tab

DSC Tab

Fonts Tab

Images Tab

Image Format Tab

VIPP Settings Tab

PJL Commands Tab

Engine Tab

ICC Profile Setting Tab

VIPP Output Option Tab

This tab enables you to set the basic output options or unlock the Advanced Settings tab.

Options Description

Optimized for output size If selected, the output will be produced using predefined para-
meters that have been chosen to generate an output spool file which will be of minimum
size and use the least memory.

Optimized for portability If selected, the output will be produced using predefined para-
meters that have been chosen to generate an output spool file that is as portable as pos-
sible.

"Portable" or "compatible" means that it can be printed on a wide range of compatible

printers and will consistently produce identical or close to identical documents.

Advanced settings If selected, the sub-tabs located on the Advanced Settings tab will become
available.

Advanced Settings Tab

This tab enables you to set the attributes that are listed on each sub-tab to define your own
output requirements.

1416
 12.4 Engine Configuration

At any point you may use the Reset all values to combo-box to reset the values to the pre-
defined Optimized for size or Optimized for portability options (which are the same options as
can be set on the VIPP Output Option tab). After you have selected an option from the Reset
all values to combo-box, click on the Reset button to confirm the action.

The Advanced Settings tab contains the following sub-tabs:

DSC Tab

Fonts Tab

Images Tab

Image Format Tab

VIPP Settings Tab

PJL Commands Tab

Engine Tab

ICC Profile Setting Tab

DSC Tab
Using Document Structuring Conventions (DSC) not only helps assure that a document is device
independent, it allows PostScript language programs to communicate their document structure
and printing requirements to document managers in a way that does not affect the PostScript
language page description.

DSC conforming files also contain comments indicating additional information such as structur-
ing.

1417
12 Production

Options Description

Document Structuring Conventions Type Enables you to select what kind of document
structuring will be used. The following options are available:

None If selected, no document structuring is used.

Basic If selected, basic document structuring is used.

DSC version 3 If selected, document structuring conforming to DSC version 3

specifications is used. The use of this option is recommended as it allows many
RIPS to handle the output.

End of Line (EOL) Enables you to select the type of end of line (EOL). The following options
are available:

Mac style (carriage return) If selected, each end of line will consist of a carriage
return character (h0D).

Unix style (line feed) If selected, each end of line will consist of a line feed char-
acter (h0A).

Windows style (carriage return and line feed) If selected, each end of line will
consist of line feed and carriage return characters (h0A h0D).

Line length Enables you to specify the maximum length (in characters) of one line in the
spool file.

Fonts Tab
This tab enables you to set advanced options related to font configuration.

1418
 12.4 Engine Configuration

Options Description

Use Options are:

Type 1 fonts If selected, IBM Postscript Type 1 fonts are used.

This option is selected by default as the CID fonts option is not supported for the
VIPP engine.

Encryption Enables you to select a type of encryption for the file. The following options are
available:

ASCII charstring encryption If checked, it toggles on ASCII encryption.

This option is checked by default.

Use eexec encryption If checked, it toggles on Eexec binary encryption.

ASCII eexec encryption If checked, it toggles on ASCII eexec encryption.

This option is enabled only if the Use eexec encryption option is checked.

Text Encodings You can select from either Binary, Octal or AsciiHex type of encoding for
the output. The font's encryption determines the type of 'encoding' of the vector fonts
data which will be passed to the printer.

Font Encoding You can select a way of handling the font encoding. The following options
are available:

Share font encoding If checked, all used font encodings are stored as external objects,
the spool file contains only references to them. Using this option decreases the spool
file size.

Use encoding for fonts If checked, you can further select the type of codec to be used
from the combo-box:

Adobe Standard

IsoLatin

Tip This option is important if you want to use 'find text' options in some file
viewing software applications.

Single or Double Byte Fonts Enables you to determine a threshold value for single byte
fonts after which double byte fonts will be created. This value can be set in the Maximal
count of single byte fonts field.

Images Tab
This tab enables you to set advanced options related to image configuration.

1419
12 Production

Options Description

EPS/PDF rasterization resolution [DPI] Enables you to redefine the resolution used to
render EPS and PDF images by entering a DPI value in the combo-box.

Image Filters Sets filters for images for cases where the printer has problems processing
images in their original format. The filters will transform the image into the chosen coding.

By clicking on the AsciiHex, Flate or Ascii85 buttons you add a filter of that type to the
queue (in the area on the left). More than one filter can be used, the filter at the top of
the list will be used first and so on down the list.

To remove a filter, select it from the list and click on the Remove button.

Note The optimized options on the VIPP Output Options tab already use filters:

Optimized for portability Flate + AsciiHex

Optimized for output size Flate

Create Images Enables you to select how the creation of images should be handled. The
following options are available:

Insert images into spool file If selected, external images are inserted into the spool
file.

This option should only be used when images are EPS, TIF or JPG formats; or PDF
converted to EPS which can be performed using the Image Type Conversion
options on the Image Format tab.

Generate images into same directory as spool file If selected, external images will
be stored in the same directory as the spool file.

1420
 12.4 Engine Configuration

Generate images into directory If selected, external images will be stored in the
directory set in the field beside this option.

Do not generate images (use images created before) If selected, the images that
have been generated in a previous run of the job or original images from their
defined location will be used.

Example If you have previously run a job where you have selected one of
the other Generate images options, then the images will have already been
processed once and stored. Therefore it is not necessary to create them again
and it would take more time to do so.

So, using the Do not generate images option for subsequent job running re-
duces spooling time.

Note It is recommended to avoid using diacritical marks and double-byte characters in

image file names.

Image color space Enables you to select a color space type from the combo-box. The follow-
ing options are available:

Take from Layout image Applies colors as they have been defined in the Layout
of the workflow, i.e. image colors are not converted.

Example On the Advanced Tab of an images properties panel in Layout

there is the option Color type which specifies the highest possible color
definition for an image. If RGB has been selected there, higher definitions
such as CMYK will be converted to RGB at that point and then RGB will be
the colorspace used by this engine if Take from Layout image is selected here.

Force RGB Processes all colors using the RGB system.

Force CMYK Processes all colors using the CMYK system.

See the separate Color Spaces section for a description of the different varieties.

Append ICC color space to images If checked, any ICC color definition will remain with
the image as it is processed.

Example If an image contains an embedded ICC profile and it is then transformed

using real ICC profiles (not a built-in CMYK profile) or not transformed at all, the
current ICC profile is written to the spool file together with the image data which
makes the image device-independent.

See the separate section ICC Profiles.

Image Format Tab

This tab enables you to set advanced options related to image format configuration.

1421
12 Production

Options Description

Image Type Conversion

Images Supported by Printer Enables you to select the image formats (EPS, TIF, JPG,
BMP, PCX, PDF) supported by your printer.

If the additional option Use image source code is checked for any image type, it
will be processed without altering its coding, i.e. without rasterization.

The PDF option enables you to further specify:

Use image source code If selected, the image is processed without altering
its coding.

Convert to vector EPS If selected, the image is converted to vector EPS format.

Make separated one-page PDFs If selected, one-page PDF files are created
from the original file.

Note If Insert images into spool file has been selected for Create Images on the
Images tab then it is only possible to select EPS, TIF, JPG and PDF with Convert to
vector EPS for this option.

Suppress native loading of images Enables you to globally suppress native loading
of images set by selecting the Load natively check-box on the Advanced tab of the
Image Layout Properties dialog.

The advantages and disadvantages of native loading of images are summarized in

the Native Loading of Images section; see also the information on handling of PDF/EPS
images, which is part of the ICC Profiles section of this User Manual.

Convert unsupported image types into Enables you to you to convert any unsupported
images that are found into supported ones.

1422
 12.4 Engine Configuration

Select to which image type unsupported images types will be converted. The following
image types are available: EPS, TIF, JPG, BMP, PCX.

Note Select an image type that is supported by your printer.

JPG compression quality Enables you to enter the percentage of JPG compression
quality. This option is available only when the JPG option is checked in the Images
Supported by Printer section.

Put transparent monochromatic images into fonts (internal EPS only) If checked,
transparent monochromatic images are converted to fonts for faster processing.

Tip When printing black and white, it is recommended to turn on transparency in Layout
for all images and set them to black and white and then enable this option. This will help
the job run faster.

Cached images If checked, images are loaded at one time and stored for repeated use
throughout the job.

Using this option makes printing faster if many variable images are being used, but requires
more printer memory.

Image location prefix If you are using external images, enter the path to the image file
location.

VIPP Settings Tab

This tab enables you to set advanced options related to segments and EPS images configuration.
Segments are created when the X and Y scale of an image set in Layout differs.

1423
12 Production

Options Description

Segments & Overlays

Use overlays If checked, overlays will be used. Employing this option significantly reduces
the production time for jobs, that contain a lot of static objects.

Segments and EPSs Enables you to select how the creation of segments and EPSs
should be handled:

Insert into spool file as TIF If selected, it creates segments and EPS files that
will be inserted into the spool file as TIFs.

This option is useful to avoid generating numerous external images when

processing workflows containing sophisticated graphics.

Generate into same directory as images If selected, it creates segments and

EPS files that will be stored in the same directory as image files.

Generate into same directory as spool file If selected, it creates segments

and EPS files that will be stored in the same directory as the spool file.

Generate into directory If selected, it creates segments and EPS files that will
be stored in the directory set in the field beside this option.

Segments & EPS location prefix If you are using external segments and EPS files, enter
the path to the file location.

Always insert segments into spool file as TIF If checked, segments are always inserted
into spool file as TIF files.

VPF Project File This section concerns VIPP projects where the document components
(images, graphics) can be stored locally on the disk drives or accessed from networked
disk drives. A VPF file (in XML format) contains information about the VIPP Project
and its components.

Project name is taken from the name of the generated job (specified in the Driver
Configuration in the main Production window), folder name is taken from the location,
that images are generated to (specified in the Segments and EPSs section of this
tab).

Generate VPF file If checked, a VPF file is created together with the VIPP file in
the same compressed folder.

The check-box is disabled by default.

PJL Commands Tab

After checking the Include PJL commands check-box, you can enter PJL (Printer Job Language
of Hewlett-Packard) commands into the Start PJL Commands and End PJL Commands fields
for the beginning and end of a job file. This can be useful when you are running a printer that
supports some finishing operations such as stitching, stapling etc.

1424
 12.4 Engine Configuration

Engine Tab
This tab enables you to set advanced options related to the engine configuration.

Options Description

Output Files Enables you to set how the output files should be handled. The following options
are available:

Zip all files generated into directory same as spool If checked, all of the output files
that have been generated into the same directory as the spool file will be zipped (after
they have been processed).

Copy all files to output directories at once when all files are processed If checked,
all of the output files are copied from the temporary directory to their respective dir-
ectories together and at one time, after all of the files have been processed.

Example This option can be used to prevent the following situation:

A RIP starts processing each resource file as soon as it has been created and
placed (one by one) into a directory. Spooling continues and if the processing
of a file ends before the next one required has been created then there will be
no available file and spooling will stop.

Temporary Files If the option Compress temporary files is checked, temporary files created
during spooling are compressed to reduce disk space usage.

1425
12 Production

Page Extent Most printers have a preset limitation defining the length of a page that they
can print on. By entering a limitation value in the Maximum page length field, the
spooling of any larger pages will be prevented. By default this option is set to 10000 mm
(page extent in the direction of the paper feed). Check your printers capabilities before
you change this dimension. The measurement units can be changed by clicking on the
unit symbol.

Resize Barcodes See the separate Resize Barcodes section.

ICC Profile Setting Tab

See the separate ICC Profile Setting section.

12.5 Printer Configuration

12.5.1 Printer Configuration Overview
In this section:
Printer Configuration Dialogs

Printer Configuration enables the setting of additional parameters for the printing device that
will be used to print the job. You do this by editing or creating a profile.

You can create multiple profiles and they will be saved for selection from the Profile combo-
box menu, whenever they are required for any job using the same engine type.

Note Printer Configuration is not available for every engine type.

Options Description

Edit Launches the configuration dialog for the printer selected.

View Launches the configuration dialog, in read only mode, for the printer selected.

Save Saves the profile.

Save as Saves the profile with a new name or location that you specify.

New Creates a new profile. A copy of the currently selected one which can be further edited
independently.

Remove Deletes the current profile.

1426
 12.5 Printer Configuration

12.5.1.1 Printer Configuration Dialogs

For details about configuration dialogs for each printer, refer to the sections below:

Adobe PostScript2

Adobe PostScript3

AFP

Creo VPS

HP PPML

IPDS

Metacode

PCL

PDF

Podi PPML

12.5.2 AFP Printer Configuration

See also:
Printer Configuration Overview
AFP Engine Configuration
AFP Device Profiles

The AFP printer configuration dialog allows the setting of finishing operations commands.
These will be communicated to the AFP printing device so that they can be performed on any
job that is printed using the printer profile.

Options Description

Apply variable finishing operations Determines that any operations that are further defined
in the table below will be applied.

1427
12 Production

Actions and operations should be added to the table in this area.

An 'action' is a grouping for the operations that will be activated by a sheet name.
It can also be just a single operation. To start the action, the sheet name must return
a value that matches the value in the Begin Name column; and to stop it, the
sheet name must return a value that matches the value in the End Name column.

To add a new finishing action, click on the Create New icon.

An 'operation' is dependent on the action and performed at the same time.

To add a new finishing operation, click on the Create New Operation icon.

Tip Set the UP3I finishing operations in the correct order according to the printer setup.
The printer will not work properly otherwise.

The term 'variable' means that the finishing operations can change as the job progresses
and that the point at which they change is defined by sheet names that are assigned in
Layout and nominated again here in this dialog.

See the separate Pages section for how to assign sheet names in Layout.

Begin Name Determines which value will be returned by the sheet name in order to
indicate that the action should start.

End Name Determines which value will be returned by the sheet name in order to indicate
that the action should end.

Level Defines the level of the operation.

The level is a method of identification for the operations that are taking place at any
one time, e.g. if there are 3 operations being performed on any one page then those
operations would be automatically assigned levels 1, 2 and 3.

The purpose of defining a level would be for cases where 2 operations might need
to be in a certain order and, therefore you need to set up a priority. You can enter a
priority number or Auto in this column.

This should be assigned particularly if you will set Page level threshold (see below).

Example It might be necessary to determine that operation: Fold comes before

Staple/Stitch. In which case you would make sure that a higher number is always
given to the operation Staple/Stitch.

Finishing Type Selects a finishing operation from the drop-down menu.

These are standardized AFP physical operations that are not performed by Inspire De-
signer and further details of these finishing operations should be available in docu-
mentation either from the printing device or the printer extension that is used to
perform them.

For your information some of the basic finishing operations are described in the sep-
arate section Finishing Operations Illustration.

Finishing Parameter Selects which variation of Finishing Type is required.

1428
 12.5 Printer Configuration

Each Finishing Type has differing selections available from the drop-down menu.

Reference Corner/Edge Selects a reference location on the page from where the pos-
ition, in which these operations should be performed, will be measured.

Each operation offers its own relevant options but selecting Device default defers the
decision to whether and how an operation will be executed to the settings of the
printing device.

Axis Offset (mm) Determines the position of the operation as an offset from the position
selected in Reference corner/edge.

-1 is default and means that the position is not set.

Parameters Assigns additional parameters if required; e. g. the distance between staples

for edge stitch, etc.

Toolbar

Create New Adds a new action to the table.

Create New Operation Adds a new operation to the table.

Move Up / Move Down Moves the selected action/operation up or down

one position at a time.

Delete Deletes the selected operation.

Delete All Deletes all of the operations within the single action that the selected
operation belongs to.

Used sheet names Assigns which sheet names will return the values that are expected for
the Begin Name and End Name of the defined actions.

Enter the index numbers of the sheet names. A list of sheet names should use commas
as separators (e.g. 3, 5, 7) or a range of sheet names should use a hyphen (e.g. 3-6).

Page level threshold Determines that all operations with higher levels than the value entered
here will be performed on each page within the range (determined by Begin Name and
End Name).

For all operations that must be performed on each single page, enter a higher value (e.g.
6) in the Level column of that operation and then enter here the lowest value for Level
that has been assigned to them.

Note Finishing operations can also be defined as part of the workflow (WFD file) in the
Output module AFP Device Profiles area. Any finishing operations configured there will be
ignored in the event that they have been set here in the Production environment of Inspire De-
signer.

The possibilities as to which finishing operations are available in Output module and here are
the same. Simplier to set and recommended to use is the configuration here in AFP Printer
Configuration. Basic finishing operations can be selected in the Finishing Parameter drop-
down menu after Traditional has been selected in the Finishing Type drop-down menu. Ad-
vanced finishing operations are the other ones but Traditional in the Finishing Type, their
specific variation is set by the Finishing Parameter.

1429
12 Production

12.5.3 IPDS Printer Configuration

See also:
Printer Configuration Overview
IPDS Engine Configuration
IPDS Device Profiles

The IPDS printer configuration dialog has two tabs; the Variable Operation tab is used for setting
finishing operations that will be performed by the printing device, the Printer Config tab provides
information on printer settings.

12.5.3.1 Variable Operation Tab

The Variable Operation tab of IPDS printer configuration dialog allows the setting of finishing
operations commands. These will be communicated to the IPDS printing device so that they
can be performed on any job that is printed using the printer profile. The screenshot above
shows the Variable Operation tab after selecting the Apply variable finishing operations
check-box and creating a series of finishing operations.

The options available on the IPDS Variable Operations tab are identical to those available on
the AFP Printer Configuration tab and are described in the AFP Printer Configuration section.

12.5.3.2 Printer Config Tab

The Printer Config tab provides information concerning the settings of the printer. It is for
reading only. It can be saved and reused later.

One of the possible uses of this window is that it allows for checking the size of the printable
area of IPDS printers. Users may want to check this size when experiencing problems during
printing either an error message is displayed or parts of the job to be printed are not printed
because the size of the job exceeds the size of the printers printable area.

1430
 12.5 Printer Configuration

Example The three values needed for calculating the printable areas size can be found
in the following lines:

mPAMediaDescriptorsList[index].mUnitsPerUnitBase = 3000 (the fifth line of the

screenshot below).

The value 3000 = DPI (dots per inch) of the printer * 10.

mPAMediaDescriptorsList[index].mMediumPresentSpaceWidth = 11906 (the

fifth line of the screenshot below).

The value 11906 = Width of the printable area * DPI.

mPAMediaDescriptorsList[index].mMediumPresentSpaceLength = 16838 (the

sixth line of the screenshot below).

The value 16838 = Length of the printable area * DPI.

Once you have found the values you can easily calculate the size of the printers printable
area:

1. Divide the value of UnitsPerUnitBase by 10 for the DPI value.

In this example 3000 / 10 = 300.

2. Divide the value of MediumPresentSpaceWidth by the DPI value.

In this example 11906 / 300 = 39.7 inches

3. Divide the value of MediumPresentSpaceLength by the DPI value.

In this example 16838 / 300 = 56.1 inches.

Thus, the printable area of this particular IPDS printer is 39.7 x 56.1 inches.

1431
12 Production

12.5.4 Metacode Printer Configuration

See also:
Printer Configuration Overview
Metacode Engine Configuration
Metacode Device Profiles

In the Metacode Printer Configuration dialog you can define positions of texts and/or images.
You need to consider what the printer will print as texts and what as images, as some texts
may be printed as images and some images as texts (using fonts). This feature may be needed
to adjust positioning of text in correlation with images or the other way round.

The [0,0] reference point is placed differently:

For texts it is in the left bottom corner of the page.

For images it is in the left upper corner of the page.

1432
 12.5 Printer Configuration

Options Description

Page Size Defines the name of the page size, for which you want to change the text or images
positions. The page size for each medium can be defined in the Output module. For more
information see the section Metacode Device Profiles.

By default there are DFLT (US Letter) and A4 sizes predefined. You can create new page
size names by clicking on the Create new page size icon.

Horizontal Shift Text Defines the horizontal shift of the reference point for texts (in dots).
If you increase the value of the horizontal shift, the texts move to the right.

Vertical Shift Text Defines the vertical shift of the reference point for texts (in dots). If you
increase the value of the vertical shift, the texts move up.

Horizontal Shift Images Defines the horizontal shift of the reference point for images (in
dots). If you increase the value of the horizontal shift, the images move to the right.

Vertical Shift Images Defines the vertical shift of the reference point for images (in dots).
If you increase the value of the vertical shift, the images move down.

Move up Moves the line with definition for the page size up.

Move down Moves the line with definition for the page size down.

Create new page size Creates a new line for definition for a new page size.

Remove page size Deletes the selected line with definition for the new page size.

12.5.4.1 How to Determine the Shift Values

If a text or image is in an undesired position (e. g. text underlining is not in the correct position),
you need to change the settings for horizontal or vertical shift.

To set the correct values, follow this procedure:

1. Create a layout where you have a flow area with a static text the (s) symbol next to
the name of the flow area in its Layout Properties indicates that it is a static object. It
will be printed as an image on the printer.

2. Place the same text in another flow area which is placed exactly at the same position.
The text in this flow area should be made variable by clicking on the Keep out of

1433
12 Production

overlay icon in the Layout Properties panel of the flow area and its color should be
changed to e.g. blue. It will be printed as text on the printer.

3. Print this layout out.

If the black and blue letters do not cover, change e.g. the text shift values and print it
out again and check it again. Shifting the text by 1 mm equals 12 dots.

If you have correct values, the blue will cover the black text perfectly.

Incorrect settings:

Correct settings:

1434
 12.5 Printer Configuration

12.5.5 PCL Printer Configuration

See also:
Printer Configuration Overview
PCL Engine Configuration
PCL Device Profiles

The PCL Printer configuration dialog is for defining operations that will be performed by the
printing device.

Clicking on the Import GPD button allows you to load a GPD file, which contains some device
specific settings, and then modify these settings in this dialog.

Sometimes it might be difficult to choose the correct GPD file. Instead, open the INF definition
file for the printer you want to use. The file should contain the information, which GPD file or
files need to be loaded and in that case they are loaded automatically.

For more details about GPD Import see section PCL Device Profile Dialog.

The following tabs are available:

Printer Property Tab

Job & Document Property Tab

Variable Operations Tab

Full View Tab

The Put GPD commands combo-box selects whether the GPD commands will be placed before
PJL commands or after PJL commands in the PCL spool file that is created.

The settings from the GPD file will be applied to the whole job. If you want to set different
GPD features for individual sheets, you need to load the GPD file in the Output module.

1435
12 Production

Note

GPD files loaded in the Output module have priority and so any GPD file loaded here
in the PCL Printer Configuration dialog will be ignored. If this happens you will receive
a warning in Production.

The result may also differ based on the fact if variable operations are / are not defined
on the Variable Operations tab here and also, occasionally, it may be useful to make
settings in both Output module (Device Profiles) and Production (Printer Configuration).
For more information about the possibilities and priorities see the section Settings in
PCL Device Profiles vs. in Printer Configuration.

If a GPD file contains some setting for Duplex, PaperSize, InputBin and OutputBin, that
contains no command, a warning is generated in Production, as the setting will take
no effect.

12.5.5.1 Printer Property Tab

Options Description

Feature Lists features applicable for the printer.

Selected Option Selects the value of the GPD feature. The drop-down menu lists alternative
selections that are applicable to the printing device and available in the GPD file. Alternat-
ively, you can select Do not use.

If you select an invalid combination, you will receive a warning and the conflicting features
are marked red. The invalid combinations can be checked on the Full View tab.

Show only used GPD features When certain GPD features are not used you can hide them
from the list in order to get more synoptic overview.

Show symbolic names Displays an alternative name of the GPD feature. The name of a
GPD feature is typically taken from the GPD section name. If this option is checked, the
name of the GPD feature is taken from the feature name, provided that it is set for the
feature in the GPD file.

Reset all options to default values Sets all GPD features to their default values, i.e. values
defined in the GPD file.

Reset all options to value: do not use Sets options for all GPD features to Do not use
value.

1436
 12.5 Printer Configuration

12.5.5.2 Job & Document Property Tab

This tab lists all features that are applicable for jobs and documents. Its usage is the same as
Printer Property tab.

12.5.5.3 Variable Operations Tab

This tab allows the setting of finishing operation commands. These will be communicated to
the PCL printing device so that they can be performed on any job that is printed using the
printer profile.

Actions and operations should be added to the table:

An 'action' is a grouping for the operations that will be activated by a sheet name. It
can also be just a single operation. To start the action, the sheet name must return a
value that matches the value in the Begin Name column; and to stop it, the sheet
name must return a value that matches the value in the End Name column.

To add a new finishing action, click on the Create New icon.

An 'operation' is dependent on the action and performed at the same time.

To add a new finishing operation, click on the Create New Operation icon.

Tip Set the finishing operations in the correct order according to the printer setup. The
printer will not work properly otherwise.

1437
12 Production

The term 'variable' here means that the finishing operations can change as the job progresses
and that the point at which they change is defined by sheet names that are assigned in Layout
and nominated again here in this dialog.

The columns that are shown here are dependent on any loaded GPD file. Alternatively, when
no GPD file is loaded, an independent set of advanced finishing operations are provided to
choose from. The GPD independent options are described below.

Note It is possible to set finishing operations also in the Output module, PCL Device Profiles.
For more information about the possibilities and priorities see the section Settings in PCL Device
Profiles vs. in Printer Configuration.

Options Description

Begin Name Determines the value that should be returned by the sheet name in order to
indicate that the action should start.

End Name Determines the value that should be returned by the sheet name in order to in-
dicate that the action should end.

Level Determines the priority (level) of the operation.

The level of an operation is a method of identification for the operations that are taking
place at any one time, e.g. if there are three operations being performed on any one page
then those operations would be automatically assigned levels 1, 2 and 3.

The purpose of defining a level would be for cases where two operations might need to
be in a certain order and, therefore you need to set up a priority. You can enter a priority
number or Auto in this column.

This should be assigned particularly if you will set Page level threshold (see below).

Example It might be necessary to determine that operation: Fold comes before

Staple/Stitch. In which case you would make sure that a higher number is always
given to the operation Staple/Stitch.

Finishing Type Selects a finishing operation from the drop-down menu.

These are standardized operations that are not performed by Inspire Designer and further
details of these finishing operations should be available in documentation either from the
printing device or the printer extension that is used to perform them.

Some of the basic finishing operations are described in the separate section Finishing Op-
erations Illustration.

Finishing Parameter Selects which variation of the Finishing Type is required.

Each type has it own selection available from this drop-down menu.

Reference Corner/Edge Selects a reference location on the page from where the position,
in which these operations should be performed, will be measured.

Each operation offers its own relevant options but selecting Device default defers the de-
cision to whether and how an operation will be executed to the settings of the printing
device.

1438
 12.5 Printer Configuration

Axis Offset (mm) Determines the position of the operation as an offset from the position
selected in Reference corner/edge.

-1 is default and means that the position is not set.

Parameters Allows the entry of additional parameters if required, e.g. the distance between
staples for edge stitch.

Used sheet indexes Determines the index numbers of all of the sheet name that will return
the values that are expected for the Begin Name and End Name of the defined actions.

A list of sheet numbers should use commas as separators (e.g. 3, 5, 7) or a range of sheet
names should use a hyphen (e.g. 3-6).

Create New Adds a new action to the table.

Create New Operation Adds a new operation to the table.

Move Up / Move Down Moves the selected action/operation up or down one position
at a time.

Delete Deletes the selected operation.

Delete All Deletes all of the operations within the action.

12.5.5.4 Full View Tab

This tab displays the whole GPD file organized into a tree structure. If the option Collapse all
nodes is checked, only the first level of the tree will shown.

1439
12 Production

12.5.6 PDF Printer Configuration

See also:
Printer Configuration Overview

The PDF Printer Config dialog is for setting device parameters in a job description file that will
be read by the device.

Options Description

JDF

Create JDF If checked, a Job Definition Format (JDF) file will be created when the job is
run in Production.

JDF files can be used by some devices to determine physical parameters for printing
RIPs. The parameters that appear below this option are for configuring the JDF file
and are also activated by the check-box.

Generate to Locates the directory where the JDF file will be generated to.

This is for cases where the JDF should be in a separate location from the spool file.
The path can be absolute (e.g. Z:\Resources\JDFs) or relative to the spool file (which
has its location determined by File name in the Main Production window). If no path
is defined the JDF will be generated to the same directory as the spool file.

Conformance to Selects the standard that the JDF file will conform to.

1440
 12.5 Printer Configuration

Printer RIP manufacturers use different specification subsets of the JDF format. De-
pending on the selected value, some JDF settings may not be accessible for editing.

Select from:

Creo

HP

Xerox

User defined

The User defined option is automatically selected if a configuration file has

been loaded using the Import Configuration button next to the Conform-
ance to combo-box. Otherwise it is not accessible.

A custom configuration file may be used if printer settings differ from standard
manufacturer's specifications, e.g. if a new device model is concerned.

Used sheet names Determines which sheets will cause exceptions to the JDF.

Pages in Layout can be given sheet names so that they cause exceptions to the
standard job description. Enter the indexes of those sheet names here. Exceptions
can be defined for Run List, Layout Preparation Params and Digital Printing Params.

Example You have two types of media (white and yellow paper) and you want
to create a landscape sheet on yellow paper duplex and a portrait sheet on white
paper simplex. To do this:

1. Define sheet names (e.g. sheet name 2) for each page.

2. Add media to the Media node to define Size and Color for both the
landscape-yellow and portrait-white medium.

1441
12 Production

3. Add two exceptions to the Layout Preparation Params; enter the values
of the sheet name in the Sheet name edit-box; select the media (created
in step 2) for Medium; and edit any other parameters.

4. Enter the index of the sheet name where the landscape/portrait layout
is defined (i.e. sheet name with index 2) in the Used sheet name in-
dexes field.

A list of sheet names should use commas as separators (e.g. 3, 5, 7) or a range of

sheet names should use a hyphen (e.g. 3-6). If left empty, all sheet names are pro-
cessed. If the sheet name matches Sheet name for an exception, then that exception
is used.

Show/Hide Disabled Processes Shows or hides disabled processes in the tree. Pro-
cesses can be disabled by the Enable process check-box available when the respective
node is selected (Rendering, Interpreting or LayoutPreparation).

Move Up Moves the selected node up. The order of processes in the tree defines the
order in the JDF file.

Move Down Moves the selected node down. The order of processes in the tree
defines the order in the JDF file.

Open File Opens an Open dialog in order to load a previously saved Job Definition
Format configuration (in the XML format).

Save File Opens a Save As dialog in order to save the current configuration to a XML
file.

1442
 12.5 Printer Configuration

Selecting a node in the tree structure on the left reveals corresponding options on the right:

JDF

Resource

Media

Run List

Customer Info

Processes

Pre Press Processes

Rendering Params

Interpreting Params

Layout Preparation Params

Press Processes

Digital Printing Params

The option descriptions below only briefly introduce the selection of parameters available. The
naming of the options corresponds to the official JDF specification released by www.cip4.org
in which a fuller description can be found.

12.5.6.1 JDF

Options Description

Target route Describes the path to the directory where the JDF file will be copied after pro-
cessing, e.g. D:\Output would give <NodeInfoTargetRoute="file:///D:\Out
put"/>.

Number of copies Determines how many copies of the JDF file will be printed.

12.5.6.2 Media

1443
12 Production

Options Description

Add New Medium Adds a medium.

The medium is displayed in the tree structure and when selected reveals the Media panel
that is described below.

New Medium

Media resources describe a physical element that represents a printable surface.

Options Description

Descriptive name Names the medium here.

Size Selects the size of the medium. The options are: A3, A4, A5, B5, Letter, Legal, Tabloid,
Compact Disc and Custom.

With the exception of Custom, when a selection is made, the corresponding width and
height of the medium are set in the Width and Height edit-boxes below.

The Custom option appears after you set your own page size directly in the Width and
Height edit-boxes

The Portrait and Landscape icons rotate the medium selected in the Size combo-
box so that the value entered in Width becomes the value entered in Height and vice-
versa.

Width / Height Defines the width/height of the medium.

Color Selects the color of the medium. Select from: Black, Blue, Brown, Buff, Cyan, Gold,
Goldenrod, Gray, Green, Ivory, Magenta, MultiColor, Mustard, NoColor, Orange, Pink,
Red, Silver, Turquoise, Violet, White or Yellow.

Alternatively you can enter your own value.

Type Selects the type of the medium. Select from: Paper or Transparency.

Alternatively you can enter your own value.

1444
 12.5 Printer Configuration

Weight Defines the weight of the medium.

Location name Selects the tray where the medium can be found. Select from: AutoSelect,
Tray-n or InsertTray-n.

Alternatively you can enter your own value.

Front coatings / Back coatings Selects the preprocess coating for the front/back surface
of the medium. Select from: None, Coated, Glossy, HighGloss, InkJet, Matte, Satin, Semi-
gloss.

Alternatively you can enter your own value.

Delete Current Medium Removes the medium definition.

12.5.6.3 Run List

RunList resources describe which elements should be printed.

Options Description

Spool file prefix Describes the path from the JDF file to the directory where the PDF spool
file (i.e. the print job) will be created.

Print from Determines which sheet will be first sheet of the print job.

Print to Determines which sheet will be last sheet of the print job.

Add Exception Adds an alternative set-up for sheets that are identified by a specific sheet
name.

The exception is displayed in the tree structure and when selected reveals the RunList ex-
ception panel that is described below.

1445
12 Production

Run List Exception

Options Description

Sheet name Determines which sheet name value will identify a particular sheet as being an
exception.

Insert Sheet When the sheet name entered above is returned, an extra sheet (an InsertSheet)
will be inserted by the device. The following options define the type of sheet that will be
inserted:

Sheet type Selects the type of the sheet that will be inserted. Select from: Accounting-
Sheet, ErrorSheet, FillSheet, InsertSheet, JobSheet or SeparatorSheet.

Alternatively you can enter your own value.

Sheet usage Selects the purpose of the sheet. Select from: FillForceBack, FillForceFront,Fill-
Sheet, FillSignature, FillService, Header, Interleaved, InterleavedBefore, OnError, Slip,
SlipCopy or Trailer.

Alternatively you can enter your own value.

Is waste If checked, determines that the inserted sheet is to be discarded when finishing
the document.

Page copies Determines the number of InsertSheets that will be inserted.

Media Selects the medium to be used for the copies.

The combo-box menu offers a list of the media that have been created in the Media part
of the JDF structure. Alternatively, No media selected determines that the default medium
will be used.

1446
 12.5 Printer Configuration

12.5.6.4 Customer Info

The CustomerInfo resource contains information about the customer who orders the job.

Options Description

Customer job name Names the job for the customer's reference.

Customer ID Determines an identification for the customer using a unique code. This is
usually the internal customer number of the MIS system that created the job.

Billing code Determines a unique code to which to bill any charges incurred.

Street / City / Postal code / Country / Country code Enter the details of the customer's
address.

First name / Family name / Name prefix Enter the details of the customer's name.

Organization name Enters the name of the company or organization to which the customer
belongs.

Note This field has to be filled for the HP RIP otherwise the JDF file is ignored.

Communication channels Lists the different ways in which the customer can be communic-
ated with and provides corresponding addresses. Enter new communication channels to
the table using the Create New icon.

Channel Type Selects the type of communication channel using the drop-down menu.
The options are: Phone, Email, Fax, WWW, JMF, Private directory, Instant messaging.

Locator Enters the address to be used via the communication channel.

1447
12 Production

12.5.6.5 Rendering Params

Rendering params can be enabled or disabled using the Enable process check-box that is
available when the Rendering node is selected in the tree.

Rendering params describe the format of the byte maps to be created.

Options Description

Overprint black line-art If True is selected, overprint of black line art is applied regardless
of any values in the PDL.

Overprint black text If True is selected, overprint of black text is applied regardless of any
values in the PDL.

Anti-aliasing Selects whether anti-aliasing will be applied to the rendered output images.
You can use Z-Modulation or you can enter your own value.

Resolution X / Y Define the horizontal (X) and vertical (Y) output resolution in DPI.

12.5.6.6 Interpreting Params

Interpreting params can be enabled or disabled using the Enable process check-box that is
available when the Interpreting node is selected in the tree.

Interpreting params are parameters needed to interpret PDL pages.

Options Description

Print quality Selects a quality setting for the device. Select from: High, Normal or Draft.

Alternatively you can enter your own value.

Anti-aliasing Selects whether anti-aliasing must be applied to the rendered output images.
Select from: AntiAlias or None.

1448
 12.5 Printer Configuration

Alternatively you can enter your own value.

Resolution X / Y Define the horizontal (X) and vertical (Y) output resolution in DPI.

Source objects Selects the class of graphical objects to be rendered at the specified resolution.
Select from: All, ImagePhotographic, ImageScreenShot, LineArt, SmoothShades or Text.

Alternatively you can enter your own value.

12.5.6.7 Layout Preparation Params

LayoutPreparation params can be enabled or disabled using the Enable process check-box
that is available when the LayoutPreparation node is selected in the tree.

LayoutPreparation params describe the impositioning to be performed by the device.

Options Description

Sheet name Determines which sheet name value will identify a particular sheet as being an
exception.

This option is only active when defining an exception.

Sides Selects whether content is to be printed on one or both sides of the media. Select
from: OneSidedBackFlipX, OneSidedBackFlipY, OneSidedFront, TwoSidedFlipX or TwoS-
idedFlipY.

Alternatively you can enter your own value.

Rotate Selects the orthogonal rotation to be applied to the content (PageCell elements).
Select from: Rotation0 or Rotation180.

Alternatively you can enter your own value.

1449
12 Production

Medium Selects the medium to be used for the sheets affected by these LayoutPreparation
params.

The combo-box menu offers a list of the media that have been created in the Media part
of the JDF structure. Alternatively, No medium selected determines that the default medium
will be used.

Fit Policy FitPolicy specifies how to fit content (PageCell elements) to the medium (Surface-
ContentsBox).

Size policy Selects an action to be applied if the size does not match. Select from:
ClipToMaxPage, Abort, FitToPage, ReduceToFit or Tile.

Alternatively you can enter your own value.

Rotate policy Selects a rotation to be automatically performed to fit content. Select

from: NoRotate, RotateOrthogonal, RotateClockwise or RotateCounterClockwise.

Alternatively you can enter your own value.

Image Shift ImageShift specifies how the content grid (PageCell elements) will be arranged.

Shift back X / Y Defines the amount in X/Y direction by which the content is to be
shifted on the back side of the medium.

Shift front X / Y Defines the amount in X/Y direction by which the content is to be
shifted on the front side of the medium.

Add Exception Adds an alternative set-up for sheets that are identified by a specific sheet
name.

12.5.6.8 Screening Params

Screening params can be enabled or disabled using the Enable process check-box that is
available when the Screening node is selected in the tree.

Specifies the halftone screen frequency in lines per inch (lpi) of the screen when AM screening
is used.

Options Description

Frequency Sets the frequency value (lpi).

1450
 12.5 Printer Configuration

12.5.6.9 Digital Printing Params

DigitalPrinting params can be enabled or disabled using the Enable process check-box that
is available when the DigitalPrinting node is selected in the tree.

DigitalPrinting params contain attributes and elements used in the digital printing process.

Options Description

Sheet name Determines which sheet name value will identify a particular sheet as being an
exception.

This option is only active when defining an exception.

Collate Selects the sequencing of the sheets in the document and the documents in the job
when multiple copies of a document or a job are requested. Select from: None, Sheet,
SheetAndSet, SheetSetAndJob.

Alternatively you can enter your own value.

Manual feed If True is selected, the media will be fed manually.

Output bin Selects the bin to which the finished document is to be sent. Select from: Top,
Stacker-N, Center, Middle, BypassTray, Booklet or AutoSelect.

Alternatively you can enter your own value.

Page delivery Selects how pages are to be delivered to the output bin or finisher. Select
from: SameOrderFaceUp, SameOrderFaceDown, ReverseOrderFaceUp or ReverseOrderFace-
Down.

Alternatively you can enter your own value.

Medium Selects the medium to be used for the sheets affected by these DigitalPrinting
params.

The combo-box menu offers a list of the media that have been created in the Media part
of the JDF structure. Alternatively, No medium selected determines that the default medium
will be used.

Add Exception Adds an alternative set-up for sheets that are identified by a specific sheet
name.

1451
12 Production

12.5.7 PostScript Printer Configuration

See also:
Printer Configuration Overview

The PostScript Printer Configuration dialog is for setting device parameters in a job description
file that will be read by the device. The Select description format combo-box determines the
format in which the description will be made. Select from:

None - No description format will be used.

JDF - Job Definition Format. Creates a JDF file when the job is run in Production.

The JDF file parameters appear in the dialog for configuration. The configuration of the
JDF file is identical to that which can be created when using the PDF engine and is de-
scribed in the separate section PDF Printer Configuration.

PPD - PostScript Printer Description. Adds PPD commands to the spool file when the
job is run in Production.

The PPD parameters appear in the dialog for configuration. These are described below.

Tip PPD parameters can also be defined in the PostScript Device Profiles of the Output
module. If any PPD settings are defined either there or here in the Printer configuration,
then PPD must be selected in the Select description format combo-box.

However, PPD settings defined in the Output module will take priority over the settings
made here in the Printer configuration.

1452
 12.5 Printer Configuration

12.5.7.1 PPD
When PPD is selected in the Select description format combo-box, further parameters for
the PPD file appear in the dialog:

Options Description

Load PPD Opens an Open Dialog to enables you to browser for and load a PPD (PostScript
Printer Description) file.

A PPD file contains information on screen angle, resolution, page size and device-specific
information for a file to be printed on a PostScript device.

When a PPD file has been loaded, the 'ModelName' contained in the Product Version In-
formation section of the loaded PPD will be displayed behind the Machine: text.

No constraint conflict The 'No constraint conflict' text will be replaced by a red-colored
text informing about constraint conflicts should these occur. See the description of the
Constraints tab for more details on constraints.

Include PPD commands to spool only on change There are certain PPD commands (like
mediaType) that can be inserted into the spool file on each page start and/or finish.

When this option is checked, the PS driver inserts the PPD commands only when
needed, i.e. it checks if the last value of the PPD command and if the value that is
to be inserted now is the same, it is not inserted. This can reduce the spool file
size.

When the option is unchecked then the PPD command are always inserted.

There follows several groups of associated attributes divided between tabs. The tabs are:

On Start Document

On Finish Document

1453
12 Production

Variable Operations

Full View

On Start/Finish Document Tabs

The On Start Document tab defines commands that are inserted into the document setup
section (the section placed before all the pages in the spool file).

The On Finish Document tab specifies commands that are inserted into end of spool file.

Options Description

PPD Key Lists PPD keys applicable for the start/end of the document.

Note The Warning icon displayed next to some PPD keys indicates that the options
will have no impact on output.

The absence of impact may be due to two reasons; either the PPD command does not
contain any string, or it is a commented command.

Selected option Displays the value of the PPD key and enables you to edit it (by selecting
from a combo-box).

The Auto values of PPD custom page size options can be manually replaced with numerical
values expressed in points.

Show only used PPD keys When certain PPD keys are not used you can hide them from
the list in order to get more synoptic overview.

Show translation values Some PPD files may contain translated PPD keys and values so
you can switch between the original and translated ones using this checkbox.

1454
 12.5 Printer Configuration

Use JCL Commands If checked, any Job Control Language (JCL) commands that have been
defined in the PPD file can be identified and will be used to manipulate the printing device.

Reset all options to default values If you have changed some of the values you can reset
them to default values defined in the PPD file by pressing this button.

Reset all options to value: Do not use Values of each PPD key in the file will be set to Do
not use.

Note When the PPD key is set to Do not use, then it will NOT be inserted into spool
file.

Note The settings made on these tabs are valid for the whole document regardless of the
specific media which is used.

Media dependent settings can be set separately for each media definition in the Output module
in the PostScript Device Settings where similar tabs are available. The fact that only media de-
pendent settings can be made there is reflected by the different names of these two tabs
there they are called On Start Page and On Finish Page instead of On Start Document and
On Finish Document as they are here.

Variable Operations Tab

The Variable Operations tab allows the setting of operation commands. These will be commu-
nicated to the PostScript printing device so that they can be performed on any job that is
printed using this printer profile.

The term 'variable' here means that the operations can change as the job progresses and that
the point at which they change is defined by sheet names that are assigned in Layout and
nominated again here in this dialog.

Options Description
First a PPD file must be loaded and then actions and operations can be assigned in the table:

An 'action' is a grouping for the operations that will be activated by a sheet name. It
can also be just a single operation. To start the action, the sheet name must return a
value that matches the value in the Begin Name column; and to stop it, the sheet
name must return a value that matches the value in the End Name column.

To add a new finishing action, click on the Create New icon.

An 'operation' is dependent on the action and performed at the same time.

1455
12 Production

To add a new finishing operation, click on the Create New Operation icon.

Begin Name Enter here the value that should be returned by the sheet name in order to in-
dicate that the action should start.

End Name Enter here the value that should be returned by the sheet name in order to indicate
that the action should end.

Actions end automatically when another action starts. This option is only necessary if the
operation has to end at a defined point, e.g. before the end of the job or before another
operation with the same value set for Level starts.

Level The level of an operation is a method of ordering the operations that are taking place
at any one time, e.g. if there are 3 operations being performed on any one page then
those operations should be assigned levels 1, 2 and 3.

If Auto is selected in this column, then the priority and dependency of the operation will
be according to the order in which they appear in the table. E.g. 1 will be given to the
first operation, 2 to the second etc.

One reason for defining a level would be for cases where operations need to be in a certain
order and, therefore you need to set up a priority.

Example To determine that operation Page Size comes before EF Stapler, you
would make sure that a higher number is always given to the operation EF Stapler.

Another reason for defining a level would be for cases where operations need to be per-
formed on sequential sets of sheets of a single print job.

Example We want to determine that an operation with Begin Name as ActionA

(with dependent operations Action02 and Action03) will be done on sheets 1-50
and that another operation (Begin Name: ActionB) will be done on the following
sheets 51-100.

So we assign ActionA and ActionB to the same level (1) and when ActionB is started
(by a sheet name that returns the value ActionB when sheet 51 is reached) then Ac-
tionA will be stopped.

Action02 and Action03 are dependent on (i.e. performed on the same set of sheets
as) ActionA and so are placed in the rows in between ActionA and ActionB and have
Level as Auto and so will be given levels of 2 and 3 according to their order in the
table.

Start Option Select here the printer operation that should be performed.

The list of operations found in the drop-down menu are those that are defined in the
loaded PPD file.

1456
 12.5 Printer Configuration

Start Value Select the required value for the Start Option printer operation here. Alternatively
select Do not use.

The list of values found in the drop-down menu are those that are defined in the loaded
PPD file.

An operation must have first been selected in the Start Option column.

End Option Select here the printer operation that should be performed to finish the operation,
i.e. when the value defined in the End Name column is returned by one of the sheet
names.

Usually this would be the same operation as set in Start Option because, even though
the sheet name is different for this last sheet of the operation, the operation is usually
required to be the same on this sheet as for the other sheets.

The list of operations found in the drop-down menu are those that are defined in the
loaded PPD file.

End Value Select the required value for the End Option printer operation here. Alternatively
select Do not use.

The list of values found in the drop-down menu are those that are defined in the loaded
PPD file.

An operation must have first been selected in the End Option column.

Toolbar

Create New Adds a new action to the table.

Create New Operation Adds a new operation to the table.

Move Up / Move Down Moves the selected action/operation up or down one

position at a time.

Used sheet indexes Defines the index numbers of all of the sheet names that will return
the values that are expected for the Begin Name and End Name of the actions.

Full View Tab

This tab enables you to explore all the keys of the PPD file in the Full view mode (not all the
PPD keys are displayed in On Start/Finish Document tabs). This is useful for checking that the
PPD file was loaded correctly.

A PPD file is organized in logical sections of PPD keys. These logical sections are shown here
on separate tabs:

User Interfaces

Constraints

Global Values

1457
12 Production

User Interfaces Tab

This tab lists all the PPD keys related to User Interfaces from the loaded PPD file.

Options Description

Collapse all nodes If checked, all nodes are collapsed.

Order dependency Displays the order number. The order of PPD keys needs to be kept.

Section index Informs you where the PPD key can be used:

PageSetup Can be used for pages.

DocumentSetup Can be used for the whole document.

AnySetup Can be used both for pages and document.

Tip Options for PPD keys with the Section index PageSetup and AnySetup can also be
set in the Output module in the Device Profiles area. PPD keys with the value Document-
Setup can be set only on the On Start/Finish Document tabs available in this configuration.

Value of selected option Shows the PostScript command for the selected PPD key.

Constraints Tab
On this tab all possible constraint conflicts contained in the PPD file are listed:

1458
 12.5 Printer Configuration

These conflicts can occur when making settings for PPD keys on the On Start/Finish Document
and On Start/Finish Page tabs.

The following logic is used: If, for the item in the First UI Name column, the value displayed
in the First Option column is selected, then, for the item in the according Second UI Name
column, the value in the Second Option column should not be selected.

Example In the screenshot above, when EFColorMode is set to GRAY, EFOverprint

should not be set to True.

If there is no value listed in the First Option or Second Option column, it means that the
constraint applies to any value except None or False.

Example In the screenshot above, if there is any value except None or False set for EF-
Stapler, then EFFinisher should not be set to False.

Tip Keep in mind that Do not use, which can also be selected for all PPD keys on the On
Start/Finish Document and On Start/Finish Page tabs, is not a value and thus cannot cause a
constraint conflict. Rather, selecting Do not use simply determines that the according PPD key
will not be inserted to the spool file at all.

If settings which result in constraint conflicts are made on the On Start/Finish Document or On
Start/Finish Page tabs, they will be indicated by Inspire Designer by a red-colored message
above the tabs and the according PPD keys will also be marked in red within the according tab
itself:

1459
12 Production

Global Values Tab

Options Description

Collapse all nodes If checked, all nodes are collapsed.

Value of selected option Shows the PostScript command for the selected PPD key.

12.5.8 PPML Printer Configuration

See also:
Printer Configuration Overview

There are two tabs available for configuring PPML printers:

Page Media/Impositioning Tab

Fonts Tab

12.5.8.1 Page Media / Impositioning Tab

On this tab you can define whether resources, images and media configuration will be included
to the spool file and whether global impositioning will be used.

1460
 12.5 Printer Configuration

Options Description

Page Section of Spool File These options are only found on the Printer Configuration dialog
of the PodiPPML engine.

Create media resources If checked, media resources for each output file will be created.

External media directory If the option Create media resources is enabled, you can
define here where the resources will be stored:

Same as spool file

User defined

Global Impositioning

Use global impositioning If checked, the impositioning type selected below will be
applied for the whole job. If you need to use different impositioning types within one
job, use the settings in the Output module.

Use predefined command If the option Use global impositioning is checked, you
can select from these predefined commands:

Simplex 1-UP

Duplex 1-UP short edge

Duplex 1-UP long edge

Simplex 2-UP

Duplex 2-UP short edge

Duplex 2-UP long edge

Duplex 2-UP bundled

1461
12 Production

Declare imposition commands in PPML scope If checked, all imposition commands,

including those that have been determined in the PPML Device Profile in the Output
module of a workflow, will be declared inside the PPML scope instead of elsewhere
in the spool file, e.g. in the page section.

This option helps prevent certain errors caused by imposition commands on some
devices.

Custom command In this field the commands for predefined options show. If you un-
check the option Use predefined command, you can edit them or insert in this field
your own impositioning.

JDF

Create JDF If checked, a Job Definition Format (JDF) file will be created.

JDF files can be used by some devices to determine physical parameters for printing.

Edit JDF Opens the JDF Configuration dialog in which the device parameters can be
configured. The configuration of the JDF file is identical to that which can be created
when using the PDF engine and is described in the separate section PDF Printer Con-
figuration.

12.5.8.2 Fonts Tab

The purpose of this tab is to link fonts used in Inspire Designer with fonts used by the RIP. This
is needed when you use SVG as page description language.

Options Description

Design Font Name Lists fonts used in Inspire Designer.

RIP Font Name Lists fonts used by the RIP.

HP Opens a list of fonts used by the RIP.

Move Up Move Down Moves the selected font up or down.

Create New Creates a new font item where you can enter the name of the used font.

Delete Deletes the selected font.

Open File Enables you to load a font configuration file (*.PPC) with assigned font pairs.

Save File Enables you to save the assigned font pairs into a font configuration file (*.PPC).

1462
 12.6 Driver Configuration

How to link fonts on this tab:

Option 1: Click on the HP icon and you will get a list of fonts used by the RIP in the
RIP Font Name column. If a matching font name is found on the current machine, it is
listed in the Design Font Name column and linked to the RIP font. Having a complete
list of font pairs does not ensure that the correct fonts were linked. It is recommended
to check it manually.

Option 2: Click on the Create New icon and enter the font name used in Inspire De-
signer and the corresponding font name on the RIP.

12.6 Driver Configuration

12.6.1 Driver Configuration Overview
In this section: See also:
Driver Config Profile Engine Configuration Overview
Create Driver Profile Dialog Printer Configuration Overview
Driver Types
Driver Configuration Dialogs

The Driver Configuration defines additional printer driver parameters, such as connection and
file naming.

The first time that you use any given Engine type you should create new driver configuration
profiles or edit the Default profile to your requirements. The profiles that you create will be
saved within the Inspire Designer application to select from, using the Profile combo-box
menu, each time you use that same engine.

If you want to permanently change an existing profile then you must save the changes. If you
changed the configuration, a dialog appears after clicking on OK in the configuration dialog.
It asks you whether you would like to save the changes, click on Yes or No accordingly.

12.6.1.1 Driver Config Profile

Options Description

Profile Selects a driver configuration profile.

All created profiles for the engine configuration profile, selected in the Engine Config area,
will be listed.

Edit Opens the configuration dialog for the selected driver profile.

View Opens the configuration dialog for the selected driver profile, in read only mode.

1463
12 Production

Save Saves the configuration of the profile if it has been edited.

Save as Opens the Save Profile with Name dialog which allows you to enter a new name for
the selected driver configuration and save it as new profile.

New Opens the Create Driver Profile Dialog allowing you to define a new driver profile.

Remove Deletes the profile currently selected in the Profile combo-box.

12.6.1.2 Create Driver Profile Dialog

Options Description

Name Names the profile to be created.

Type Selects a driver type for the profile.

All of the available driver types for the selected engine are offered in the drop-down menu.
For each engine type there is a different selection of driver types available, see the table
Driver Types.

Copy settings from current profile If checked, ensures that the configuration of the profile
that is currently selected in the Profile combo-box will be used as template for the new
profile, i.e. the new profile will initially have the same settings as the current one but can
be subsequently edited.

12.6.1.3 Driver Types

Below is a table that summarizes the types of drivers available for each engine (see the Driver
Types column). It also lists the configurations that should be set for each driver type when
they are selected:

Engine Driver Types Configuration Dialogs

AFP, Image, IJPDS, Metaco- Spool file File Driver Config

de, PDF Fixed Resolution,
HP PPML, MIBF, Multi,
PodiPPML, Raster, Simple
HTML, SWF, SX/AP, Text
NexPressVDX, PDF, In- Spool file File Driver Config
spireNative
LPR printer LPR Config
Adobe Postscript 2/3, Spool file File Driver Config
CreoVPS, PCL, VIPP

1464
 12.6 Driver Configuration

Engine Driver Types Configuration Dialogs

Desktop printer Desktop Printer Driver Config

LPR printer LPR Config

Desktop Printer Desktop printer Desktop Printer Driver Config
IPDS Spool file File Connection Configuration

TCP/IP connection TCP/IP Connection Configuration

SCSI connection SCSI Connection Configuration

DataWare 2100 connec- DataWare 2100 Connection Con-

tion figuration

DataWare 2000 connec- DataWare 2000 Connection Con-

tion figuration

Barr connection Barr Connection Configuration

Each of the driver configurations has an independent set of attributes that can be adjusted
according to the requirements of the job. These options are presented both on the Production
panel and in the dialogs that open when you click on the Edit button.

All of the available driver configuration options are described below in the Driver Configuration
Dialogs section.

12.6.1.4 Driver Configuration Dialogs

The above table Driver Types lists the configuration dialogs that will appear for each driver type
when Edit is clicked on.

These dialogs configure the currently selected profile. Most of the options of each dialog can
also be found directly presented in the Production window.

All of the available dialogs are described below:

File Driver Config Dialog

Desktop Printer Driver Config Dialog

LPR Config Dialog

File Connection Configuration Dialog

TCP/IP Connection Configuration Dialog

SCSI Connection Configuration Dialog

DataWare 2100 Configuration Dialog

DataWare 2000 Configuration Dialog

Barr Connection Configuration Dialog

1465
12 Production

File Driver Config Dialog

This dialog will appear when Edit is clicked on for any Spool File type Driver Config Profile of
all engine types except Desktop Printer and IPDS.

The same options can also be seen and edited directly on the production panel.

Options Description

File name Determines the directory and name of the spool file that will be created.

Spool file names can be created automatically using substitution characters. These enable
you, for instance, to have split files named in the same convention without having to set
it manually for each file.

Many of these substitution characters may be combined in one file name, e.g.
%n%s%j.pdf.

For a list of the available characters, see the separate section Substitution Characters.

Job name Names the job.

This name should be displayed by the printer software as it is being processed. The job
name is for identification on the printer only and does not affect the WFD file name or
the output File name entered above.

This option is not available for all engine types as it is only supported by some of them.

For the VIPP and PostScript output files the Job name is used as the project name para-
meter in the files' metadata.

Split by group If checked, each group is saved as a separate output file.

By default, each group is defined by and is identical to a record, unless the impositioning
modules are used to change the group definition.

Tip In order to distinguish between the files and avoid consecutive split files being
overwritten as they are produced, use the naming conventions %g or %j in the File Name
edit box.

1466
 12.6 Driver Configuration

When only splitting by group is used, then all the individual split files contain the resources,
so that they are printable independently on other files created during the splitting.

Split by size If checked, the output gets split into more files when it reaches the defined
size. You can define this size in the Size edit-box. Default units are bytes. Maximum size
is 9,007,199,254,740,991 bytes, which is approx. 9 petabytes.

Every output spool files split by this feature contain all necessary resources.

Tip In order to distinguish between the files and avoid consecutive split files being
overwritten as they are produced, use the option naming conventions %I or %j in the
File name edit box for file names.

For IJPDS you can set the file splitting in two ways:

In the main Production window All spool files contain resources.

In Engine Configuration dialog Where you can choose whether resources will be
split or kept in the first file.

ICM Comment If spooling a job to Inspire Content Manager (VCS), you can enter a file
comment in this edit-box.

Desktop Printer Driver Config Dialog

This dialog appears when you click on Edit for Desktop Printer type of Driver Config Profiles
or when the Desktop Printer (driver) engine has been selected.

The same options can also be seen and edited directly on the production panel.

The Driver Config is modified when the Variable Printer is selected from the printers list. An
extra edit-box appears for inserting the appropriate substitution character(s).

1467
12 Production

Options Description
You can select from the printer drivers currently accessible from your station using the combo-
box menu, i.e. from your desktop Printers.

Properties Opens the properties dialog for the printer selected.

This button is inactive when the Variable Printer is selected from the list of printers.

Variable Printer Prints selected sheets on different printers.

This can be useful in jobs, where some sheets need to be printed differently, e.g., some
in color and some black and white.

Assign a printer's name as a value of a sheet name. Then insert the sheet name index in
the variable printer edit-box using the substitution characters, e.g. %h[3], to print sheets
on the chosen printer. Hover the mouse pointer over the edit-box to see a hint on the
naming convention.

This edit-field is active only when Variable Printer is selected from the Desktop printer
list.

Note For this option to work the Split file by group check-box has to be enabled. See
the File Driver Config Dialog section for more details.

Print to file If checked, activates the File name edit box so that you can name the file to
be created, as an alternative to printing to paper.

The other options are the same as are available for File Driver Config Dialog. For field descriptions
click on the link to the section above.

LPR Config Dialog

This dialog will appear if LPR Printer is the type of Driver Config Profile selected.

The same options can also be seen and edited directly on the production panel.

1468
 12.6 Driver Configuration

Options Description

Address Sets the IP address of the printer to be used.

Port Opens the configuration dialog for the selected driver profile.

Queue name Sets the port number to be used.

Job name Sets the name of the job under which the job will be identified on the printer.

LPR Extra Commands Checking the Print banner page option ensures that the extra
command -L will be sent. This command may help when the job name is not displayed on
the printer correctly.

All fields' values can be filled in automatically using substitution characters. These enable you,
for instance, to take IP addresses from sheet names so that different files can be sent to different
printers.

For a list of the available characters, see the separate section Substitution Characters.

Note The other options are the same as are available for File Driver Config Dialog. For field
descriptions click on the link to the section above.

File Connection Configuration Dialog

This dialog appears when you click on Edit for a Spool File type Driver Config Profile if the IPDS
Engine is selected.

The same options can also be seen and edited directly on the production panel.

Options Description

File name Determines location path and name for your output file.

Spool file names can be created automatically using substitution characters. For a list of
the available characters, see the separate section Substitution Characters.

Split file If checked, the output will be split into smaller files.

1469
12 Production

The split files will be named according to any variable specified in the File name edit field.
If no variable is in the file name is specified, any new split file will overwrite the one selected
in the Output file edit field.

Trace If checked, produces a trace file that lists all of the IPDS commands used in the output
file.

The trace file is a history of all communication between the host and the printer. It is in-
tended to make it easier to trace issues with IPDS printer communication. You should
further enter a desired location and name for this file in the Trace File Name field which
becomes active.

Trace file name Determines the location path where the trace file will be created.

Tip If you place the mouse pointer over this field, a hint containing file naming convention
will display.

Exception levels The List button opens the IPDS Exceptions Level Configuration dialog.

That dialog lists IPDS run-time exceptions that can occur and allows you to re-assign level
of importance (Default level) and whether Auto restart of printing should occur after
such an exception has stopped production.

TCP/IP Connection Configuration Dialog

This dialog appears when you click on Edit for a TCP/IP connection type of Driver Config Profile.
This type is only available if the IPDS Engine is selected. TCP/IP is the default connection for IPDS
Engine.

General Tab

1470
 12.6 Driver Configuration

Options Description

TCP address Defines the IP address of the printer.

IP Port Specifies the IPDS IP Port of the printer. Default value is 5001.

Page buffer Determines the amount of pages that will be stored in the printer memory at
a time, in order to avoid printer stops during transmission of print data.

Recommended values for fast printing:

for Oc printers: 10-64

for Nipson TED printers: 200-300

for Nipson SED printers: less than 128

for IBM, XEROX and other printers: 10-60

Note If exceeded, communication problems with the printer will arise.

TM
Send next pages once committed This option is intended only for the Xerox CiPress
500 Production Inkjet System printer and is available only if XEROX is selected as the
Printer type below.

If checked for the new printer, the page buffer is calculated as 'sent pages minus committed
pages' (committed pages are those processed by the printer already), as the new Xerox
printer does not raise any exceptions after the page is committed.

If left unchecked, then the page buffer calculation is 'sent pages minus printed pages'
and the Page buffer recommendation according to the printer type should be followed,
not to overload the printer and to handle reprints after exception(s) properly.
TM
Note If this option is used on the Xerox CiPress 500 Production Inkjet System printer
without the 'RIP Ahead' mode, the Page buffer option above has to be increased to
500.

Printer type The available options are: OCE, IBM, NIPSON, XEROX, XEIKON, IMPIKA.

Start with PURGE If checked, the PURGE command is sent during printer initialization. Re-
commended values are:

enabled for IBM and NIPSON printers.

disabled for OCE. (If enabled for OCE printers, the connection is immediately
closed after sending the PURGE command).

Discard buffer after connected If checked, sends the DBD (discard buffered data) command
in the moment after connection to the printer is completed and deletes any data that are
in the printer buffer.

A-twin printer If checked, prints simultaneously on two printers for duplex purposes etc.
The A-Twin Back Printer is added where you can configure the other printer. See below
for a description of the options on it.

This feature is licensed separately and applicable only for OCE printers.

1471
12 Production

Trace If checked, the trace file a file containing the trace of communication between the
host and the printer will be created in the directory specified in the Trace file name
edit field.

Simultaneously, a printer configuration is exported to an XML file in the same folder as

the trace file, i.e. if the trace file is saved to PATH/FILE.EXT, the printer configuration file
is saved to PATH/FILE-pcfg.xml.

The purpose of the files is to allow the supporter/developer to find out information neces-
sary for the debugging process. When reporting an issue, it is important to include both
the trace and the printer configuration files.

Tip If you place the mouse pointer over the Trace file name field, a hint containing file
naming convention will display.

Discard buffered data Selects what should be done if data remains in a printer buffer (be-
cause printing has been stopped when a job was being printed):

Always on stop Sends the DBD (discard buffered data) command to the printer
that cleans the buffer everytime when printing is stopped (either automatically due
to an exception or manually by pressing the Stop button).

On manual stop Sends the DBD command in case the Stop button is clicked on
in Production. This is useful in cases you want to decide when the buffer should
be cleaned.

Never The DBD command is not sent and the printer continues printing until all
data loaded in the buffer is printed.

Exceptions levels The List button opens the IPDS Exceptions Level Configuration dialog
which allows the viewing and adjusting of actions that should occur if certain exceptions
take place during printing.

A-Twin Back Printer Tab

This tab appears only when the option A-twin printer on the General tab is checked. It enables
you to configure another printer that will be used simultaneously with the first one. The options
here are the same as found on the General tab except one:

Options Description

Draining length Specifies the distance (in meters) between the printers. This helps you to
decide how many empty pages should be inserted at the first printer so that the job finishes
completely at the second printer.

1472
 12.6 Driver Configuration

SCSI Connection Configuration Dialog

This dialog appears when you click on Edit in the Driver Config if the IPDS Engine is selected
and the Driver Config Profiles is SCSI connection type.

General Tab

Options Description

Host adapter Sets the number of the host adapter through which the device is connected.
It depends on the total number of host adapters.

Target ID Sets the address of the device (from 0 to 32). It is set on the printer.

LUN (Logical Unit Number) Sets logical order. Usually 0 for all printers. Can be from 0 to
7.

Page buffer Determines the amount of pages that will be stored in the printer memory at
a time, in order to avoid printer stops during transmission of print data.

Recommended values for fast printing:

for Oc printers: 10-64

for Nipson TED printers: 200-300

for Nipson SED printers: less than 128

for IBM, XEROX and other printers: 10-60

Note If the page buffer is exceeded, communication problems with the printer will
arise.

A-twin printer If checked, you can print simultaneously on two printers for duplex purposes
etc. The A-Twin Back Printer appears where you can configure the other printer.

This feature is licensed separately and applicable only for OCE printers.

Trace If checked, the trace file a file containing the trace of communication between the
host and the printer will be created in the directory specified in Trace file name edit field.

1473
12 Production

The purpose of the file is that the supporter/developer can find out the information neces-
sary for debugging process.

Example Production has been stopped due to network communication error but
the user does not detect any network problem. In this case the trace file, which has
to be generated at the moment when error occurs, is sent to software support. A
software support person can then read this file and discover the reason for stopped
production.

Discard buffered data after stop If checked while a job is being printed and the operator
stops printing, there are still pages in the buffer to be printed.

Normally in such cases the printer continues printing until all pages loaded in the buffer
are printed. By enabling this option the application sends DBD (discard buffered data)
command to the printer that cleans the buffer and printer stops immediately.

A-Twin Back Printer Tab

This tab appears only when the option A-twin printer on the General tab is checked. It enables
you to configure another printer that will be used simultaneously with the first one. The options
here are the same as found on the General tab except one:

Options Description

Draining length Specifies the distance (in meters) between the printers. This helps you to
decide how many empty pages should be inserted at the first printer so that the job finishes
completely at the second printer.

DataWare 2100 Configuration Dialog

This dialog appears when you click on Edit in the Driver Config if the IPDS Engine is selected
and the Driver Config Profiles is SCSI connection type.

1474
 12.6 Driver Configuration

Options Description

Channel number Sets the number of the device (from 1 to 255). It is set on the printer.

Page buffer Determines the amount of pages that will be stored in the printer memory at
a time, in order to avoid printer stops during transmission of print data.

Trace If checked, the trace file a file containing the trace of communication between the
host and the printer will be created in the directory specified in Trace file name edit field.

The purpose of the file is that the supporter/developer can find out the information neces-
sary for debugging process.

Example Production has been stopped due to network communication error but
the user does not detect any network problem. In this case the trace file, which has
to be generated at the moment when error occurs, is sent to software support. A
software support person can then read this file and discover the reason for stopped
production.

Discard buffered data after stop If checked while a job is being printed and the operator
stops printing, there are still pages in the buffer to be printed.

Normally in such cases the printer continues printing until all pages loaded in the buffer
are printed. By enabling this option the application sends DBD (discard buffered data)
command to the printer that cleans the buffer and printer stops immediately.

Exception levels The List button opens the IPDS Exceptions Level Configuration dialog.

The IPDS Exceptions Level Configuration dialog lists IPDS run-time exceptions that can
occur and allows you to re-assign level of importance (Default level) and whether Auto
restart of printing should occur after such an exception has stopped production. You can
also add new exceptions.

DataWare 2000 Configuration Dialog

This dialog appears when you click on Edit in the Driver Config if the IPDS Engine is selected
and the Driver Config Profiles is SCSI connection type.

For options description see the previous section for DataWare2001 Configuration Dialog.

Barr Connection Configuration Dialog

This dialog appears when you click on Edit in the Driver Config if the IPDS Engine is selected
and the Driver Config Profiles is SCSI connection type.

For options description see the previous section for DataWare2001 Configuration Dialog.

1475
12 Production

12.7 Jobs Window

This window lists jobs that have been produced during the current session. You can control
execution (printing) of the job using Pause and Stop buttons. You can also pause printing
programmatically using pauseAfterCurrentSheet method.

Note This window is common for all engines. There is no difference in a job running locally
or on remote server.

If the IPDS engine is selected, a part of the window changes as follows:

Description

PreparedPage Numbers of the pages in IPDS format ready to be sent to the IPDS printer.
The number of the prepared pages should be higher than the number of the sent pages.
If not, clutching occurs. Possible reason for clutching may be a slow PC, which causes that
Inspire Designer cannot generate enough pages and send them to the printer.

SentPage Numbers of the pages sent to the printer. From the IPDS point of view, this is re-
ceived page counter: This counter contains the number of pages that were received, ac-
cepted, and syntax-checked. (Cited from IPDS Reference by David E. Stone)

PrintedPage Numbers of the printed pages. From the IPDS point of view, this is operator
viewing page counter: This counter contains the number of pages that have passed the
view of the printer operator. This counter is incremented by the number of pages on a
sheet when the last copy of the sheet passes the view of the printer operator. (Cited from
IPDS Reference by David E. Stone)

1476
 12.7 Jobs Window

PrintedCopy Counts of the page copies printed.

StackedPage Numbers of the stacked pages. From the IPDS point of view, this is stacked
page counter: This counter contains the number of pages that were successfully stacked.
This counter is incremented by the number of pages on a sheet when the last copy of the
sheet is successfully stacked. (Cited from IPDS Reference by David E. Stone)

12.7.1 Workflow Section

Fields Description

Workflow Path of the workflow being executed

Module Identifies the workflow output file name.

Status Status of the job

Sheets Sheets printed (1-End) from the first to the end of the job

Copy Number of copies crated

12.7.2 Selected Job Status

Informational area that identifies the selected job status:

Workflow path for each step

Module name

Status if job is finished

Number of Total pages printed

Number of copies

Status of the job

Time it took to run the job

Allows the operator to:

Pause and resume the job.

Stop the job. This option is available only when job is spooling. It is not available when
the job is printing.

Move the paper from the printer into a stack (NPRO button) limited to IPDS engine
only.

Remove the job from the workflow section and show the job queue as empty in the
status panel (Acknowledge button).

Abort the job. This option is available also when the job is paused.

1477
12 Production

Reload the job after the job has finished.

Proof the job.

The message area at the bottom allows you to view the individual steps that took place when
running the job.

It identifies:

Time step processed

Severity level

Event Description step being executed or error

Workflow path for each step.

Code of the log

For description of Jobs Window options see the section Production Window Menu.

12.8 Drivers Window

This window lists drivers being used.

1478
 12.9 Multiple Jobs Window

12.8.1 Selected Driver Status

Informational area that identifies the selected driver status.

Status of driver

Time

Job assigned to the driver

Allows the operator to:

Reset

Disconnect

Find the Job assigned to the driver

The message area at the bottom allows you to view the individual steps that took place when
running the job.

It identifies:

Time step processed

Severity level

Event Description step being executed or error

Workflow path for each step.

For description of Drivers Window options see the section Production Window Menu.

12.9 Multiple Jobs Window

On this tab you can make a list of jobs, configure them for production and run them one by
one just by clicking one button. Multiple jobs can also run in parallel (this can be set in Produc-
tion Options Dialog).

You can save the Multiple Jobs configuration (along with the WFD files' paths). See the Produc-
tion Window Menu section. When loading such Multiple Jobs configuration (also from the
Main Production window), the Multiple Jobs window opens with all saved WFDs listed.

1479
12 Production

12.9.1 Running Multiple Jobs

1. In Production (sub-tab Main) open a workflow.

2. Move to the Multiple Jobs sub-tab and by clicking on the Add job icon add this
workflow to the multiple jobs list.

3. Select the output, configure the engine and set Workflow Parameters (fields Output,
Config and Parameters).

4. Repeat the steps 1-3 for any other workflow you wish to include in the multiple jobs.

5. Press the Start button.

Options Description

Workflow Path and name of the added workflow.

Output If there are multiple outputs) Selects the Output module (or Layout module) you
want to produce.

Config Enables you to set job config, select engine and set printer and driver configuration,
path and name of the file to be generated. For more details see Main Production Window.

Parameters Enables the adjustment of certain workflow parameters.

Clicking on the 3 dots button opens the Edit Workflow Parameters dialog which has
the same options as the Workflow Parameters window-pane.

Add the currently selected workflow on the Main sub-tab to the multiple jobs list.

Removes the selected workflow from the multiple jobs list.

1480
 12.10 Workflow Parameters Window-Pane

Removes all workflows from the multiple jobs list.

Moves the selected workflow up or down in the multiple jobs list.

Start Starts printing all listed jobs, one after another.

Run on remote server Checking this option enables you to spool jobs on remote machines
by connecting to them and running Inspire Production Server. See also the Main Production
Window section.

12.10 Workflow Parameters

Window-Pane
See also:
Main Production Window

The Workflow Parameters window-pane allows the adjustment of certain properties of the
workflow that is currently loaded to production. These properties are usually parameters that
have been set in the workflow and have been especially selected so that they can also be seen
in production. This process is called propagating the parameters to Production from the
workflow.

The window-pane is opened via the Production Window menu (Window | Show Workflow
Parameters) and appears, by default, on the right-hand side of the Main Production window.

Options Description

Parameter Lists the parameters that have been propagated from the workflow that is currently
loaded to Production.

The module, which the parameter is a property of, is noted (in brackets) after the parameter
name. Some of the parameters are automatically propagated whenever a particular
module is used, some must be selected to propagate when setting-up a module; and
others can be added to a workflow as variables using the Param Input module in order to

1481
12 Production

set extra criteria for Production. To find a description of any of the parameters listed here,
go to the section in this user manual that relates to the module noted.

Value Displays the current value or setting of the corresponding Parameter and allows a
new value to be entered.

Depending on the type of parameter, the new value can be either typed in or selected
from a drop-down menu. Alternatively, if an external file is required, the 3 dots button
opens an Open dialog to aid its location.

Tip

Changes of parameters are not saved as part of the workflow. However, you can save
them as part of the production configuration, i.e. in a JOB file. To do this go to the
Production Window menu: Production | Save Production Configuration.

If you want to have a look at the job that you are processing via Inspire Production
Console in Proof or Inspire Native Viewer (or Production window GUI), it is no longer
necessary to run the application GUI and set the workflow parameters in this window-
pane manually according to the command line. The workflow module parameters for
PNetTC.exe work also for PNetT.exe (with -proof, -ap, -sp parameters) and
PNetTView.exe, so you can change just the beginning of the command line according
to what application you want to check your job in.

Example If you want to have a look at the job from the command line
PNetTC.exe Workflow.wfd -difDataInput Data.csv in Proof, you can
run PNetT.exe in proof mode instead and the workflow will be shown with the
different data: PNetT.exe -proof Workflow.wfd -difDataInput
Data.csv.

12.11 Report File Config Dialog

This dialog is opened via the Report File button on the Main Production window and allows
the production of a separate report file for each job that is run. The XML file will contain ele-
ments that describe the values of all of the options in the Main Production window at the time
the job was printed (e.g. Workflow, Copies and Engine) and the workflow parameters that
can be viewed in the Workflow Parameters window-pane.

1482
 12.11 Report File Config Dialog

Example The first few elements of the XML file would be:

Options Description

Enabled If checked, a XML report file will be created when a job is run.

Report file name Names the XML report file.

A small selection of substitution characters can be used to return variable data about the
workflow being processed and the job. For a list of the available characters for this option,
move the mouse pointer over the edit-box. For a description of those characters see the
separate section Substitution Characters.

The default directory is the same as that of the Inspire Designer EXE file unless another
path is described here.

Include engine config If checked, elements describing the values of the options of the se-
lected engine configuration will also be in the report file.

Include printer config If checked, elements describing the values of the options of the se-
lected printer configuration will also be in the report file.

Include diver config If checked, elements describing the values of the options of the selected
driver configuration will also be in the report file.

1483
12 Production

12.12 Production Options Dialog

In this section: See also:
Production Options Workflow Options Dialog
Simple Production Options Layout Options Dialog
Run on Remote Server Options Proof Options Dialog

This dialog can be accessed from any of the Production windows by going to the Production
menu and selecting Options Dialog. Select the panel you would like to edit from the tree
structure on the left side of the window.

1484
 12.12 Production Options Dialog

12.12.1 Production Options

On the Production Options panel you can make basic settings concerning the production process.

Options Description

Log to file If checked, all production actions, status, warnings and errors are written to an
external LOG file, as well as in the Log window-pane.

Log file Enables you to set the name and location of the production log file.

By default the log is saved as default.log to the same directory with PNetT.exe.

If there are more instances of Inspire Designer opened, a separate log file is created for
each of them (named default_1.log, default_2.log, etc.).

Append log file If checked, all new entries will be appended to the LOG file.

If unchecked, new entries overwrite the old ones.

Endless page loop limit Specifies how many times a page will be processed before Inspire De-
signer reports an endless loop. Limit is 10 million pages.

Production of workflow can result in endless loop for example if you have repeated row
in table and you try to display content of one variable for the whole array into one cell by
mistake.

In such a case, Inspire Designer keeps reporting warning 0035 Content of flow too big to
fit. If you set Endless Page Loop Limit to a smaller number than default, e.g. 30 pages,
Inspire Designer will report warning 0034 Pagecount per document exceeded 30. Possible
endless loop after preprocessing 30 pages which gives the user sooner the information
that endless loop is possible.

Run workflows parallel If checked, you can run the same WFD file in more engines at the
same time (either on the Multiple Jobs sub-tab or in the Main window).

If this option is unchecked, a second run will be scheduled (jobs will run one by one).

1485
12 Production

Single driver mode If checked, usage of IPDS drivers is simplified it disconnects the driver
automatically, user does not have to do it manually.

If unchecked, user runs IPDS and before running another job and connecting driver it is
necessary to disconnect the previous one manually.

Example If the option Single driver mode is not checked, the following situation
may happen: You connect to IPDS driver, start production and after printing you
decide to change the driver configuration. After you edit the driver configuration, it
will not be possible to connect the newly set driver because the driver with old settings
is still registered as connected. You would have to disconnect the driver first, change
its configuration and then connect it again.

When the option Single driver mode is enabled, you avoid the situation described
above. When you edit the driver configuration, the driver is disconnected and re-
connected automatically after you confirm the changes. If you try to edit the driver
configuration while a job is printed, you get a warning that the driver cannot be
disconnected and you have to do it manually.

Log debug messages If checked, special IPDS debug messages will also be logged.

After editing config Sets what action should be performed after you edit some settings in
configs. Options are:

Ask After every change in config there will be a message shown which asks if
you want to save the changes.

Auto save If selected, the message will not show and the changes will be saved
automatically, i.e. it equals pressing Save button. Use this option with care not
every time you change something during your tests you want to have it saved.

Dont save If selected, the message will not show. Users can determine manually
by clicking Save / Save as button which changes will be saved.

Warn on modified configs before saving jobconfig If checked, the message shown below
pops up in case that there exists any unsaved configuration in Production during saving
Production configuration (JOB file).

1486
 12.12 Production Options Dialog

Example Situation in which the message can be displayed:

1. Set After editing config option to Dont save (no change you make will be
saved).

2. Check the option Warn on modified configs before save jobconfig.

3. Change a setting in Engine Config (e.g. another image output in Raster).

4. Try to save JOB file (Menu Production | Save Production Configuration

). The message shown above will be displayed.

Load default job config after opening WFD/TNO If checked, opening a WFD or TNO file
via the Open button located on the Production window will always reset the values of
the Job config (values such as Start, End, Copies, Offset, Scale etc. found in the Job
config area of the Production window) to their default value.

Example Imagine you have loaded a WFD file and make a change to the Job config
settings. For instance, as an exception you need several copies, so you set Copies to
3 (instead of the default value 1).

Afterwards, you load another WFD file using the Open button. If the Load default
job config after open WFD/TNO option is not selected, Copies would stay set to
3. But if you had selected this option, the fact that you had opened a new WFD file
would set Copies back to 1, which is this default value in this example.

Tip You can save a default job config by making the desired settings and then selecting
Save Default Job Config in the Production menu.

See the description of the option Save Default Job Config in the Production menu section
for details.

Load snapshot of engine config with profile names If checked, opening a JOB file, which
has been saved with only the option Include snapshot of current engine config checked
on the Save As dialog, will result in the engine of that saved config being selected in Engine
combo-box and the profile names (Engine, Printer and Driver Config profiles) appearing
as selected in the Production window as well as the settings that were saved. This allows
you to save the loaded profile with the original names.

If left unchecked, the engine of that saved config will be selected in Engine combo-box
but no profile names will appear so that you can save them as another profile.

1487
12 Production

Lock Configs Opens the Lock Configs with Password dialog where you can enter a password
to protect your configuration from unauthorized changes.

Password Determines a password.

Re-enter password Confirms the password that you have entered. The entry here must
be exactly the same as the one in the Password edit-box.

Format config If checked, the Enter Config Password dialog will appear when trying
to edit any Engine Config profile in order for you to enter the password.

Printer config If checked, the Enter Config Password dialog will appear when trying to
edit any Printer Config profile in order for you to enter the password.

Driver config If checked, the Enter Config Password dialog will appear when trying to
edit any Driver Config profile in order for you to enter the password.

After locking the configuration profiles, this button changes to Unlock Configs. To be
able to unlock the configuration profiles (i.e. to abolish the password protection) you will
have to enter the correct password.

Generate TNO Keys Creates encryption and decryption keys for TNO files. These keys have
to be part of the PNetT.config file to work. Using them you can encrypt spooled TNO files
and read encrypted TNO files. For details see the section Encrypted TNO Files.

12.12.2 Simple Production Options

Options Description

After spooling Allows you to set an action to occur after spooling files with Simple Production
has been completed. The following options are available:

Do nothing No action will be performed.

Move When selected, the following combo-boxes are available allowing you to
specify a location where to place JOB files and TNO files:

Move Job file to Browse and select a location where JOB files are to be
placed after spooling has been completed.

Move TNO file to Browse and select a location where TNO files are to be
placed after spooling has been completed.

This can be useful to avoid accidental reprinting of jobs.

1488
 12.12 Production Options Dialog

Example Imagine you are using a specific folder (e.g. hot folder) where jobs
to be processed are placed. An operator monitors this folder and spools any
files that appear here.

Thanks to the automatic movement of the file after spooling the operator
does not need to keep track of which jobs he has already processed, as all
spooled jobs will be sent to the predefined location (which could be a storage
server etc.).

Execute script You can enter a script which will be executed after spooling has
finished. Alternatively, you can also use the Event Script module for this purpose.

Example
if(not JobFileLocation.isEmpty())
{//add a suffix to the Job file name
File.move(JobFileLocation,JobFileLocation+"_processed");
}
if(not TNOFileLocation.isEmpty())
{//move the TNO file to another folder
File.move(TNOFileLocation,"D:\processed\"+TNOFileLocation.ReverseP
art[0,"/"]);
}

12.12.3 Run on Remote Server Options

Fill in this panel when you plan to use the command Run on remote server, available in the
Simple Production and Production windows, to spool jobs on a remote machine. Files will then
be uploaded to the specified server, spooled and the spool file downloaded back to the local
drive (or to a remote location).

Options Description

Address Specifies the address of the Inspire Production Server to be used for spooling.

Port Determines the port to be used for communication with the specified server.

Remote paths Defines remote paths to file servers (e.g. used for storing fonts or images)
located in places accessible both to Inspire Designer and Inspire Production Server.

This will save time as these files will not have to be included in the WFD file when it is
uploading to the server for spooling. Data which is available only locally (or whose path

1489
12 Production

is not specified in this field) will automatically be included and uploaded when running a
job on a remote server (which will enlarge the amount of data being uploaded).

If you would like to save the spool file to a location other than the local workstation you
initiated the spooling process from, you must, in addition to specifying this location in the
File name (when using Production) or Output file name (when using Simple Production)
edit-box, enter the remote path to this location in this field.

Add path Adds a row to the list of remote paths.

Remove path Removes the selected row from the list of remote paths.

12.12.4 PostScript RIP Speed Estimation

RIP Speed Estimation analyzes a number of jobs that are run via the PostScript engines in order
to predict speeds of Creo RIPs on a printing device and returns an estimate for how long it
would take for the current job to be processed by those RIPs. The intention is to allow for
planning of printing the spool file on the PostScript device.

A JDF file is required which has already been used by Creo RIPs during the processing of some
print jobs and, therefore, contains some times that allow the calculation of RIP speed.

The resulting estimation is listed in the Log window-pane of the Production environment and
displayed below the progress bar in the Jobs window after the job is complete.

Options Description

Enabled Calculates RIP speed every time that a job is run via the Adobe PostScript 2 or Adobe
PostScript 3 engine.

Other settings must be made so that the calculation is performed properly.

Data directory Locates a directory where the data files for the calculation will be created
and read from.

These are files of differing formats which will be created by this feature and contain the
calculations and their history. Many data files may be created and used, therefore this
should be a separate directory that is used for this purpose only.

JDF directory Locates the directory where the JDF file can be found.

RIP speed estimation can only be performed in combination with a Creo conforming JDF
file that has been processed by Creo RIPs. When a PS spool file is first processed by a RIP,

1490
 12.13 Secure Printing

it returns processing info to the JDF and this is read by Inspire Designer, in order to base
the calculation upon.

In the first instance, JDFs are created for the spool file via the PostScript Printer Configur-
ation (where Select description format must be JDF and Conformance to should be
set to Creo) and then these JDFs are used by the RIPs during processing and placed else-
where. Therefore, the location entered here must be the location where the JDF file can
be found after the RIPs have processed it.

Creo AgentName Defines the name of the expected agent software used for RIP speed es-
timation based on the data in the JDF file. By default it is set to Creo_Spire.

The agent name is verified against the one in the JDF file. If not matching, a warning is
displayed.

Enable logging Logs the calculation and diagnostic tracking information to a TXT file in the
Data directory.

The info in this log file may be useful in cases where problems occur.

Export Config Saves the configuration of the options here to an XML file.

Import Config Loads a previously saved configuration file.

12.13 Secure Printing

In this section: See also:
Designing and Proofing Simple Production
Creating a Secure JOB File
Printing a Secure Job
Additional Information on PGP

Secure printing feature enables users to create a secure job containing encrypted data files, to
print this job only once and only by authorized persons. This printing mode is suitable for
printing sensitive documents (bank statements, checks etc.).

The control over printing is maintained through PGP that provides file encryption and keys.
After you install PGP create a new key pair that will be used later in Inspire Designer. PGP is
also used to encrypt the data input file(s). See also the Additional Information on PGP chapter
at the end of this section.

Jobs with encrypted data files can be designed and proofed. However, once the secure JOB
file is created, it cannot be printed from Proof if you load it there. The output has to be direct
IPDS print (spooling is not permitted) and the secure job can be printed only from Simple Pro-
duction.

1491
12 Production

Secure printing is available for the following data input modules:

Data Input

Script Input

Internal Input

The process of creating and printing a secure job follows:

1. Designing and proofing (either with sample data or encrypted data). Protection: You
need to have the secure part of the key to decrypt the data.

2. Creating a secure job file in Production. The outcome is a JOB file (with an additional
<SecuredJobDescription> element) which is then loaded and printed in Simple Produc-
tion. Protection: Public and secure keys need to be used. Administrator assigns an op-
erators password.

3. Printing the job from Simple Production. Protection: Public and private keys need to be
used. Administrator authorizes every start of printing (after pause too) when the job is
loaded. Operators password is used after clicking on Start job.

Note This feature is not supported by the Mac version of Inspire Designer.

12.13.1 Designing and Proofing

If you design and proof the job with sample data, there is no difference in comparison to cre-
ating non-secure jobs.

If you work with encrypted data files, you need to set keys in the Workflow Options dialog
first these settings are saved to the CFG file and are encrypted. If everything is set correctly,
data displays decrypted in Preview on the Properties tab of Data Input and in Proof. Without
correct settings in the Workflow Options dialog the data is taken as if not encrypted and are
read natively and will be displayed only as an unreadable row of characters.

Note If you e.g. do not enter the right password, you get no notification and data displays
in an unreadable form.

All other aspects of working with the job are the same as for non-secure jobs except:

The job is kept in memory; it is not stored temporarily on the disk.

The option Print from Proof is disabled if you load the secure JOB file to Proof.

12.13.2 Creating a Secure JOB File

Direct IPDS printing via Simple Production is the only possible way of printing a secure job with
legible data. If you wanted to e.g. spool the job to a PDF file, the data would be displayed as
an incomprehensible row of characters.

1492
 12.13 Secure Printing

Go to Production and select the IPDS engine. There are two options in the Driver configuration
that must be set in a certain way so that the secure job can be created. If set differently, you
will receive a message advising what is necessary to do.

Trace option needs to be unchecked.

Discard buffered data option needs to be set to Never.

From the Production window menu select Create Secure Job and follow the wizard that will
take you through the following steps:

1. Select the encrypted data input file to be used in the secure job, i.e. the file which will
be used in Production.

2. Select the public and secure key rings.

3. Select the key for the encrypted file and enter the administrator's pass phrase (set for
the key during PGP installation).

1493
12 Production

4. Enter the administrators key and password and enter a password for the operator who
will run the job in Simple Production. You can also set here a range of sheets to be
printed. This range cannot be increased in Simple Production.

5. In the following step you can have the passwords verified. Verification can be skipped
if e.g. you will run the production on a different machine and the keys are installed
there and verification on the current machine would fail.

6. In the last step a JOB file with secure content is created and you are asked to choose
its file name and location.

1494
 12.13 Secure Printing

12.13.3 Printing a Secure Job

On the machine where the secure job is going to be printed PGP needs to be installed.

1. Open Simple Production and click on the Open workflow file icon and choose in
the Files of type combo box the option Production Job Configs (*.job). Then browse
for the secure JOB file you have created.

2. When you select the secure JOB file, you are asked to enter the administrators password.

3. After the workflow is opened, the driver configured and connected via the Driver
toolbar, you can start printing the job.

When you click on the Start job icon, you are asked to enter the operators password.

4. Then the Configure Job dialog opens. The sheet range from what you set when creating
the JOB file is displayed here and you can only decrease the number of pages to be
printed.

If you print the job in more parts, no page can be printed twice the start page number
is pre-set according to what range was already printed and cannot be changed.

Note After printing, the JOB file is not reusable. If you need to reprint some pages or the
whole job, you need to create a new secure JOB file in Production.

12.13.4 Additional Information on PGP

PGP (Pretty Good Privacy) is a software used for encryption and decryption of data. More in-
formation can be found at Symantec Corporation's web sites. You can find further details
about the tested version in the Release Notes document.

1495
12 Production

When installing PGP, the necessary keys are generated and the password is entered, which will
be used as the Administrator pass phrase in Inspire Designer when working with secure printing.

The PGP key rings are also generated during installation and can be found under the user's
account Documents in the PGP folder. You can find the exact path or export the keyrings again
if you open the PGP Desktop application and select the menu File | Export | Keyring. The
public keyring used in secure printing is pubring.pkr file and the private keyring used is
secring.skr file.

If you want to encrypt a single file (e.g. a data file), follow these steps: First use the tray icon,
select Options and on the NetShare tab check the option Protect individual files. Then copy
the file to be encrypted to clipboard and use the tray icon menu Clipboard | Encrypt.

12.14 Encrypted TNO Files

See also:
CONFIG File Customizations

This feature enables you to create encrypted TNO files that can be opened only by users that
have the right decryption key.

Both the encryption and decryption keys can be generated by Inspire Designer and they are
intended to be stored in special elements in the PNetT.config file. To create a pair of encrypting
and decrypting configuration files containing these elements and to implement them into the
configuration file, do the following:

1. In the Production Options dialog click on the Generate TNO Keys button. You will
be prompted to select a folder where the configuration files will be created. They are
created immediately after you confirm the selected directory by clicking on the Select
button in the dialog.

2. Now, two configuration files are created: PNetT.config.encrypt and PNetT.config.decrypt.

They contain XML elements that need to become a part of the applications configura-
tion file. You will find the file (if you have one) in the same directory as the PNetT.exe
file.

If you already have a PNetT.config file, copy the relevant element there, after the
existing elements: <TNOEncryptionKey> for file encryption and/or <TNODecryp
tionKey> for file decryption.

If there is no PNetT.config file yet, just delete the 'encrypt' or 'decrypt' extension
and the file is ready to use. If you need to use both the encryption and the decryp-
tion key, it is necessary to merge these two config files into one by simply copying
the content of one of them into the other.

3. Make sure the configuration file is placed in the directory where the Inspire Designer
executable is located and restart Inspire Designer.

If you place the <TNOEncryptionKey> element into your configuration file, all TNO files
generated by the application will be encrypted. These files can only be opened if the configur-

1496
 12.14 Encrypted TNO Files

ation file of the instance of Inspire Designer you want to use to open these files contains the
<TNODecryptionKey> element with the corresponding key.

This means that if you want another person to work with your encrypted TNO file you have to
provide them with the decryption key, i.e., the configuration file element which they have to
copy into their PNetT.config file.

It is possible to have multiple decryption keys in one element (separated by comma) so that
the user can decrypt files generated by more instances of Inspire Designer.

1497
13 Simple Production

13.1 Driver Toolbar

13.2 Job Toolbar
13.3 ICM Toolbar
13 Simple Production

In this section:
Driver Toolbar
Job Toolbar
ICM Toolbar

The Simple Production environment is useful for quick production of single workflows. To work
with multiple workflows, use the Production environment, which also offers a wider range of
options for the configuration of the job.

There are several ways to run Simple Production in Inspire Designer:

You can start Simple Production from the Workflow window. Go to the File menu and
select the command Show Simple Production.

Also it is possible to click the according icon in the Startup dialog displayed when In-
spire Designer is started to go directly to Simple Production.

Use the command-line parameter sp

You can also start Simple Production with an opened workflow.

Example PNetT.exe "C:\MyProject\Sample_Letter3.wfd" -sp

The Simple Production window consists of the Driver and Job toolbars, the information area
at the top of the window and the messages area in the bottom part of the window:

Tip Like the standard Production environment, Simple Production can create a log file con-
taining processing messages from the status panel.

See the description of the Production Options panel for details on possible settings concerning
log files.

1500
 13.1 Driver Toolbar

13.1 Driver Toolbar

Options Description

Connect current driver Using this button you can connect to the previously defined
driver with the specified connection type, format and printer configuration. When the
driver is connected, this button is inactive.

Disconnect current driver You can disconnect the current driver (for example when you
want to change its configuration) by clicking this button.

Reset current driver When the driver is reset, it reconnects this means that the connec-
tion is closed and then re-established.

Configure driver Click this icon to open the Configure Output dialog where you can
specify the engine and [driver] you would like to use and where you can alter the config-
urations.

Options Description

Engine Selects the engine that will produce the job.

Driver Selects the driver.

Availability of drivers depends on the output engine selected in the Engine combo-
box.

Engine Config Opens the configuration dialog for the output engine selected in the
Engine combo-box.

See the section Engine Configuration Overview for details.

Printer Config Opens the Printer Config dialog for the engine selected in the Engine
combo-box.

This button is only active if printer configuration is possible for the selected engine
type, see the section Printer Configuration Overview for details.

Driver Config Opens the configuration dialog for the driver selected in the Driver
combo-box.

1501
13 Simple Production

See the section Driver Configuration Overview for details.

Note When IPDS is selected in the Engine combo-box, the Configure driver button is
only enabled when the driver is disconnected.

View driver configuration Shows the same configuration dialog as for Configure, but
parameters are read only.

13.2 Job Toolbar

Options Description

Open File When clicked on, the Open File dialog is shown where you can select the file
that you want to open.

After clicking on the Open File button the file is loaded and the Start job and Unload
workflow buttons are enabled.

Note If the Open file icon is not available, you need to unload the currently loaded file
using the Unload workflow icon before you will be able to open a new file.

Start Job After clicking on the Start job icon the Configure Job dialog will be opened:

Options Description

Start page Sets the first page to be printed. This option can also be used with negative
values.

Example -1 = last page of the job, -2 = second last page of the job etc.

End page Sets the last page to be printed. This option can also be used with negative
values (see the example given just above for the Start page option).

Only available when Print to end has been disabled.

Copies Sets the number of copies to be printed.

1502
 13.3 ICM Toolbar

Print to end If checked, all pages of the layout are printed.

Collate If checked and if multiple copies have been requested, the job is printed from
the first to the last page and then from the beginning to the end again as many times
as the number of copies requested.

If left unchecked, all copies of the first page are printed first, then all copies of the
second page etc.

Output file name Allows you to specify the output file name and location where it
should be saved.

Run on remote server For a description of this option see the section Main Production
Window.

Start with multiple data See the description of this option in the Production Window
Menu section where it is called Run Multiple Data.

Stop Job Allows you to stop a running job and allows it to be run again later.

This icon is enabled after clicking on the Start button on the Configure Job dialog.

Unload Workflow Unloads the currently loaded workflow.

Only active when a workflow has been loaded.

Run Proof Proofs the currently loaded workflow and displays it in the Proof window.

13.3 ICM Toolbar

Options Description

Log in to ICM Opens the User Login dialog of the Inspire Content Manager (VCS), which
asks for Username and Password in order to log into the Inspire Content Manager (VCS).

Log out of ICM Logs the current user out of the Inspire Content Manager (VCS).

Open ICM Explorer Launches the Inspire Content Manager Explorer (VCS Explorer) window
from where you can manage version controlled documents.

1503
14 Global Features

14.1 Access Rights

14.2 Customizable Toolbars
14.3 Dithering
14.4 Docking
14.5 File Import
14.6 Find & Replace Dialog
14.7 ICC Profile Setting
14.8 Language Codes
14.9 Log Window-Pane
14.10 Open File Dialog
14.11 Resize Barcodes
14.12 Sheet Names
14.13 Text Encoding
14.14 Title Bar Menu
14.15 Video Capture Feature
14.16 Warnings
14.17 White Processing
14.18 Workspaces
14 Global Features

14.1 Access Rights

In this section:
Access Rights for All Workflow Modules
Access Rights for Single Workflow
Modules
Access Rights for Layout Tree Objects
Edit Access Rights Dialog

Setting access rights is based on users set up in the User Admin Dialog of Inspire Content
Manager (VCS) and can be used to protect: Files managed in Content Manager; workflow
modules; or Layout objects.

Access rights can be defined in two different environments:

Inspire Content Manager (VCS) In the Access Rights dialog available in Inspire Content
Manager Explorer (VCS Explorer) you can set up access rights for users/groups concerning
the handling of any file or directory added there.

Workflow/Layout Here you can set access rights for users/groups concerning individual
Layout Tree objects and workflow modules. This allows you to control which users/groups
will be allowed to perform which modifications and who will not be allowed to do so.
Or you can set access rights which apply to all of the workflow modules and not just
single ones.

This type of access rights uses the users/groups set up in Inspire Content Manager (VCS),
but it is not necessary for the file to be version-controlled by Inspire Content Manager
(VCS). This second type of access right is described in this section.

As mentioned above, access rights concerning parts of workflows can be applied to the following
objects:

All workflow modules

Single workflow modules

Layout Tree objects

Note To be able to set access rights in the Workflow and Layout environments, you must be
logged in to Inspire Content Manager (VCS). To do so, go to File | Inspire Content Manager
| Login to ICM in either the Workflow or Layout window.

14.1.1 Access Rights for All Workflow Modules

To apply access rights to all of the modules of a workflow, go to File | Workflow Access
Rights in the Workflow Window Menu.

After selecting Workflow Access Rights the Edit Access Rights dialog is opened.

Note Access rights granted to a specified user/group for all workflow modules can be over-
ridden by a setting made for a single workflow module.

1506
 14.1 Access Rights

Example Even if a user is granted an access right, e.g. Edit content, for all workflow
modules, it can still be impossible for this user to edit a specific workflow module if the
same access right, in this case Edit content, has been denied for that single workflow
module.

I.e. a right denied to a single workflow module will always be denied, even if the same right
has been granted for all workflow modules.

See the following section for details on setting access rights for single workflow modules.

14.1.2 Access Rights for Single Workflow

Modules
To apply access rights to a single module placed in the Workflow Area, right-click on it and
select Access Rights from the context menu:

After selecting Access Rights the Edit Access Rights dialog is opened.

Note Access rights granted to a specified user/group for a single workflow module can be
overridden by a setting made for all workflow modules.

Example Even if a user is granted an access right, e.g. Edit content, for a specific
workflow module, it can still be impossible for this user to edit this specific workflow
module if the same access right, in this case Edit content, has been denied for all workflow
modules.

I.e. a right denied for all workflow modules will always be denied for all of these modules, even
if this right has been granted for a single workflow module.

See the section just above for details on setting access rights for all workflow modules of a
WFD file.

14.1.3 Access Rights for Layout Tree Objects

To apply access rights to an object of the Layout Tree, right-click on it and select Access Rights
from the context menu:

1507
14 Global Features

After selecting Access Rights the Edit Access Rights dialog is opened.

14.1.4 Edit Access Rights Dialog

The Edit Access Rights dialog allows you to determine the access rights details for the Layout
Tree object or workflow module(s) you have selected. It is the same for all Layout Tree objects,
single workflow modules and when setting access rights for all workflow modules of a WFD
file at one time.

Note Users who are defined as administrators (i.e. the Admin check-box in the User Admin
dialog has been enabled for these users) cannot be denied any access rights, i.e. they can per-
form all actions even if they are denied an access right in this dialog or if a group they belong
to is denied an access right.

Options Description

Permissions In the combo-box at the top of this field, select the access right aspect you
would like to control. The following options are available:

Add child If this right is denied to a user/group, the user or the members of this
group will not be able to:

Add a new workflow module to the workflow area or create a label there if
this right has been denied for all workflow modules.

Clone a node if this right has been denied to the family the node belongs to
in the Layout Tree.

1508
 14.1 Access Rights

Example When the Add child right is denied for the FillStyle family,
the option Clone will not be available from the context menu opened
when right-clicking on any of the nodes grouped below this family.

Add a new family or new object below the according family if this right has
been denied for a family in the Layout Tree.

Example When the Add child right is denied for the FillStyle family,
the options Insert Fill Style and Insert Family will not be available from
the context menu opened when right-clicking on the family.

Note This setting has no effect when applied to single workflow modules or
when applied to a Layout Tree object which is not a family.

Remove child If this right is denied to a user/group, the user or the members of
this group will not be able to:

Remove any workflow modules or labels from the workflow area if this right
has been denied for the complete workflow.

Delete any nodes or families grouped directly below a Layout Tree family if
this right has been denied for a family.

Example When this right is removed for the FillStyle family, the option
Delete will not be available from the context menu opened when right-
clicking on any node grouped directly below this family.

Note This setting has no effect when applied to single workflow modules or
when applied to a Layout Tree object which is not a family.

Edit content If this right is removed for a user/group, the user or the members
of this group will not be able to:

Use the Use for Production and Use for Proof options available in the context
menu for workflow modules, edit or move labels if this right has been denied
for the complete workflow.

Modify the Current Workflow Options and AFP Import, PCL Import and PDF
Import tabs available from the menu File | Options in the workflow environ-
ment if this right has been denied for the complete workflow.

Edit or rename a workflow module if this right has been denied for a single
workflow module.

Edit any of the tabs of the Layout Properties of an object if this right has been
denied to an object in the Layout Tree.

1509
14 Global Features

Example If you deny this permission for a flow area to a user, that user
will still be able to alter the content of the flow inside of it (as the flow
is an independent object on the Layout Tree), however it will not be
possible to select a different flow as content for the flow area or to alter
any other of the flow area's layout properties.

Change order If this right is denied to a user/group, the user or the members of
this group will not be able to:

Change the order of objects within a family in the Layout Tree if this right has
been denied to a family.

But, if this family contains a further family, then changes can be made in that
family and it is possible to move nodes from the family for which Change order
has been denied to a different family.

Note This right has no effect when applied to workflow modules or when applied
to a Layout Tree object which is not a family.

Set access rights If this right is denied to a user/group, the user or the members
of this group will not be able to:

Set the access rights for the workflow module(s)/Layout Tree object this right
has been denied for.

Note Keep in mind that if you deny other permissions to a user/group, but
leave this permission granted, that user or a member of the group who is
logged in will be able to open the Edit Access Rights dialog and grant himself
rights for actions which had before been removed by someone else. Thus, if
you want to be sure a user cannot change the rights granted to him, this
permission must also be denied.

Change object transformation If this right is denied to a user/group, the user or

the members of this group will not be able to:

Move a workflow module around in the workflow area if this right has been
denied to a single workflow module.

Move, scale and rotate objects in the Layout Area if this right has been denied
for an object in the Layout Tree. This affects only objects which have a Position
tab in their properties panel; there, the according edit-boxes are greyed out
and will be unavailable for modification.

Note This setting has no effect when denied for the complete workflow.

User Name Displays the users and groups for which you can add or remove rights for
the permission type selected in the combo-box just above. The users/groups available
can vary depending on the permission selected. By default, only the group Everyone
is present in the list.

Add new users/groups to the list by dragging and dropping users/groups from the
Users and Groups areas located on the right side of the Edit Access Rights dialog,
remove selected users/groups from the list by clicking on the Remove User icon.

1510
 14.1 Access Rights

Note If users are represented in this field more than once (e.g. as members of sev-
eral groups or as a single member and as a member of a group), then the first setting
regarding a user starting from the bottom of the list will determine the way the access
rights are handled.

Example If you deny a right to Everyone, but place a user name into the list
below Everyone and grant the right to this user, the user will be able to perform
the action despite being a member of the group Everyone. On the other hand,
if you have granted a right to several users/groups, but move Everyone to a po-
sition below them in the User Name list and deny this right to Everyone, then
no one will be granted this right.

Thus, it is not recommended to move Everyone to the bottom of a list, as this will
override all other settings made for users/groups placed in the User Name list.

Right Displays if the selected permission has been granted to the according user/group
or not:

If the right has been granted, "+" is displayed.

If the right has not been granted, "-" is displayed.

By default "+" is selected for all users/groups in the list.

Add/Remove Right Changes the right of the selected user/group from "+" to "-"
or vice versa.

Move Up / Move Down Moves the selected user/group up/down one row in the
list.

Note The position of users and groups in the list is vital as this determines the
hierarchy of the access rights granted. See the note included in the description of
User Name just above for details.

Remove Removes the selected user/group from the list.

Users and Groups

Users

User Name Lists all users available in Inspire Content Manager (VCS). Drag and
drop users from this list to the Permissions field to be able to specify access rights
for these users.

Tip Users with administration rights in Inspire Content Manager (VCS) can ad-
ministrate users (e.g. create new users)in Inspire Content Manager Explorer.

1511
14 Global Features

Groups

Group Name Lists all groups available in Inspire Content Manager (VCS). Drag and
drop groups from this list to the Permissions field to be able to specify access
rights for these groups.

Tip Users with administration rights in Inspire Content Manager (VCS) can ad-
ministrate groups (e.g. create new groups or add/delete members of groups) in
Inspire Content Manager Explorer.

Users Lists all users which belong to the according group.

Recursive If checked, any rights settings changes you make apply to all objects that
belong to the selected family. Objects that are only linked to a given family (displayed
in blue in the Layout Tree) need to have their access rights edited in their respective
families.

Note This option has no effect when applied to workflow modules or when applied
to a Layout Tree object which is not a family.

14.2 Customizable Toolbars

If you need to add new functions to the existing toolbars or even create a new toolbar, right-
click on the gray toolbar area in any application window and select the displayed Customize
option. The Customize Toolbars dialog appears.

First, it is necessary to specify the toolbar you wish to customize. You can select an existing
toolbar from the Toolbar combo-box, or create a new one using the button New.

In the Available actions area you can choose among the actions which are available for adding
to the selected toolbar. Multiselection of actions is possible using the standard keys: <Shift>
for items placed consecutively and <Ctrl> for the ones in various spots of the list. The Assigned
actions area displays all of the actions which are currently assigned to that toolbar.

1512
 14.2 Customizable Toolbars

Options Description

Toolbar This combo-box lists all available toolbars.

Toolbar visible When unchecked, the selected toolbar is not visible in the window.

Visible in mode This combo-box has two options: Default and Edit Line Properties. The Default
mode means that the toolbar is always visible and most toolbars are set to this mode. The
Line Properties toolbar is, by default, visible in the Edit Line Properties mode, i.e. the toolbar
is displayed only if a path object has been selected. In this combo-box, you can change
the visibility mode of any toolbar according to your needs.

Note The Edit Line Properties option is available only in Layout.

New Creates a new toolbar. In the Add New Toolbar dialog that pops up, enter a name for
the new toolbar and click on OK.

Remove Removes the selected toolbar from the Toolbar combo-box.

Reset Removes all actions assigned to the selected toolbar. For default toolbars, only the
added actions will be removed.

Note It is not possible to remove or reset default toolbars.

Rename Enables you to edit the toolbar's name in the Rename Toolbar dialog that opens.

Move selected action up Moves the action(s) selected in the Assigned actions area
one line up. This changes the position of the action in the toolbar accordingly.

Add selected action to toolbar Moves the action selected in the Available actions
area to the Assigned actions area. The action will be added to the toolbar. The same
effect has a double-click on an action.

Remove selected action from toolbar Removes the selected action from the Assigned
actions area. It is also removed from the toolbar. The same effect has a double-click on
an action.

Move selected action down Moves the action selected in the Assigned actions area
one line down. This changes the position of the action in the toolbar accordingly.

Action appearance Determines whether the selected action is displayed as an icon, text or
both.

1513
14 Global Features

14.3 Dithering
In this section: See also:
Dithering Tab Position Tab
Edit Dithering Dialog Images
Dithering Type Examples
LUT Curve Examples
Dithering Recommendations

Dithering is the process of arranging pixels of two colors to create the illusion that a third color
is present. For example, an image with only black and white in the color palette can have its
pixels positioned in a certain pattern so that it creates the illusion of grey values.

In Inspire Designer this positioning can be done when processing the workflow, i.e. in Proof
or Production, where the Dithering tab can be found for the Proof or Engine Profile.

14.3.1 Dithering Tab

For certain engine configurations, and when creating a profile for Proof, you can define
dithering type and look-up tables for different types of color component black and white
graphics, black and white text etc. This is done via the Dithering tab that summarizes all of the
handling groups and their components.

The tab also allows quick viewing of what dithering types have already been selected for each
component and what the values are for LPI and Angle.

1514
 14.3 Dithering

Options Description

Component All of the color components that can be set for the currently selected output-
color model are listed here, grouped in a dependency tree format.

The groups (numbered 1 to 8) represent each of the possible handling groups that objects
in the layout design can be assigned to. Images and position-defining objects can be as-
signed to handling groups in Layout (see the separate sections Images and Position tab).
Then, for each individual group, it is possible to define different dithering properties for
color components.

The set of components that is shown depends upon the color model that has been selected
via the Output colors option in the configuration of a particular engine (usually found
on the General tab of an engine's configuration dialog). The possible sets of components
are:

This set of components appears if Black and white, Spot color or CMYK (CIELab)
spot color has been selected for Output colors.

This set of components appears if Full color has been selected for Output colors.

This set of components appears if Dithered spot color has been selected for Output
colors.

1515
14 Global Features

This set of components appears if Dithered colorants or Indexed colorants has been
selected for Output colors.

In summary there are three categories of components:

Text - Sets the dithering pattern for the fonts of variable text.

If text is static (i.e. not variable) it is processed as an overlay and the dithering
method that is selected for the corresponding graphics component is applied.

See also the separate section Static objects order.

Graphic Sets the dithering pattern for graphics.

Alpha graphic Sets the pattern for transparency and semi-transparency.

Alpha graphic dithering is applied in the following cases:

1. If the image is transparent, it specifies how the alpha channel (transparency)

of the image is dithered.

It is usually only important if the image is semi-transparent.

2. If a vector object (line, box, circle, triangle, etc.) has been rasterized (not kept
as a vector graphic) and the calculated width of the line is not aligned to pixels.

Then the border of such an object is rasterized with semi-transparency (with

added internal alpha channel), therefore alpha dithering is also applied. Excep-
tions to this rule include simple vertical and horizontal lines, where the width
of the line is automatically aligned to pixels (rounded to the nearest full pixel).

Next to each component (on the left) a preview of the curve created by the look-up table
(LUT) can be seen. This view alters if the LUT changes, e.g. .

Type The assigned type of dithering for the component is listed in this column.

Dithering type can be assigned via the Edit Dithering dialog.

LPI The density of dithering, in lines per inch, for the component is listed in this column.

LPI should be assigned via the Edit Dithering dialog.

Alternatively, LPI can be edited by pressing <F2>.

Angle The angle of the dithering matrix, for the component is listed in this column.

Angle should be assigned via the Edit Dithering dialog.

Alternatively, angle can be edited by pressing <F2>.

Toolbar

Open Loads pre-defined dithering settings that have been saved to a DTC file.

Save Saves the selected component's or group's dithering settings to a separate DTC
file.

Selection and saving of multiple component or groups in one file is possible.

1516
 14.3 Dithering

Copy Copies the selected component's or group's dithering settings.

Paste Pastes the last copied component's or group's dithering settings.

Edit Opens the Edit Dithering dialog enabling the editing of dithering settings for the
selected component.
All of the functions of the above icons are also available upon right-clicking on any item
in the tree. However, each item has a different selection of options.

14.3.2 Edit Dithering Dialog

To edit the dithering setting for a component, select that component and click the Edit icon
.

Alternatively double-click on the component.

The Edit Dithering dialog opens:

The left part of the dialog is used for setting the dithering type and its properties. In the right
part you can see the LUT curve and related options.

Options Description

Type In simple terms, dithering types are different ways to correct the graphic or text.

Non-matrix dithering types are suitable for images that were reduced in grayscale. These
types (Floyd Steinberg and all sierras) enable you to correct the difference between black
and grey in different ways.

1517
14 Global Features

Select a suitable dithering type for the component from the combo-box menu:

Threshold RGB values less than 128 do not get printed and values higher than
128 get printed in black.

Dots either get printed in black or not at all. This is suitable for Alpha graphic
components where the aim is to reach either opacity or transparency or for black
and white images where you do not need any grayscales.

This is a matrix type.

Floyd Steinberg Applies an algorithm to the individual pixels to diffuse error.

Algorithm for error diffusion:

Error is divided by 16 and its parts are placed around the dot: 7/16 on the right,
5/16 below, etc.

This is a non-matrix type.

Dispersed Dot Suitable for low DPI and non-chalking ink. It does not diffuse errors
but places dots regularly.

This is a matrix type.

Clustered Dot Prints bigger and smaller clusters of dots, with safe distance
between each other. Prevents ink chalking. This type is typically used in newspapers.

This is a matrix type.

If Clustered Dot is selected, it is possible to set matrix, angle and LPI values in the
left part of the dialog.

Custom Matrix Enables you to load your own dithering type. A custom matrix
needs to be created manually and once it is loaded to Inspire Designer, it cannot
be edited there.

This is a matrix type.

Load a custom matrix by clicking on the Import button.

Once the file is imported, its name is displayed in the Name field. Overwrite the
name here if you wish to rename the custom matrix used. When the setting is
confirmed by clicking on the OK button, the dithering type and name will also
appear on the Dithering tab.

Sierra Lite Applies a simple algorithm to the individual pixels to diffuse errors.

1518
 14.3 Dithering

Algorithm for error diffusion:

Error is divided by 4 and its parts are placed around the dot: 2/4 on the right, 1/2
below, etc.

This is a non-matrix type.

Sierra 2 Applies a more complex algorithm to the individual pixels to diffuse errors.
Can be rather slow.

Algorithm for error diffusion:

Error is divided by 16 and its parts are placed around the dot: 4/16 on the right,
3/16 below etc.

This is a non-matrix type.

Sierra 3 Applies a more complex algorithm to individual pixels to diffuse errors.

Can be slow.

Algorithm for error diffusion:

Error is divided by 32 and its parts are placed around the dot: 5/32 on the right,
5/32 below, etc.

This is a non-matrix type.

Floyd Steinberg ZigZag, Sierra Lite ZigZag, Sierra 2 ZigZag and Sierra 3 ZigZag
These dithering types use the same algorithms as Floyd Steinberg and sierras.
However, lines of the zigzagged matrixes do not start from the left only but one
line starts from the left and the following one from the right.

These are non-matrix types.

Floyd Steinberg Randomized ZigZag Based on Floyd Steinberg ZigZag but applies
a randomizing pattern which helps improve the dithering result compared to a
regular Floyd Steinberg dithering method.

This is a non-matrix type.

See the section Dithering Type Examples (below) for an example of each dithering type.

Matrix The shape of the dots that make up the matrix. Select from:

1519
14 Global Features

Round Square Diamond

Cross Ellipse Line

Angle The angle of the dots as they make up the matrix. The angle value is used for CMYK
profiles to optimize the color results. Enter a value (in degrees) into the edit-box.

45 degrees is most commonly used (in newspapers, etc.). It is recommended to use 45

degrees for black color. E.g.:

1520
 14.3 Dithering

90 degrees is often used for less visible colors (yellow, etc.). E.g.:

For each color there should be different angle so that the colors do not overlap. The op-
timal properties for CMYK are reflected by the default settings.

LPI (Lines per inch) The density of the matrix. Enter a value in lines per inch.

Recommended value for black color for 600 dpi is 106 lines per inch and for 300 dpi 53
lines per inch.

Grays Displays the maximum number of gray tones used in the matrix.

Size Displays the size of the matrix in pixels.

Load/Save LUT Opens the Open / Save As dialog, enabling you to load/save a LUT file.

Preset Opens the Preset LUT dialog so that you can specify the linearization curve. E.g.:

The LUT (Look-Up Table) is a table of values that are used for device linearization and
controlling the amount of ink that is actually printed on a media.

You can also edit the LUT values by clicking on the line/curve and dragging it into desired
shape using the mouse.

Coef Determines the coefficient of the LUT Curve.

When set to 1, the line is straight, if set to value other than 1, it becomes a curve.

1521
14 Global Features

For more details see the LUT Curve Examples section below.

Min and Max Specifying RGB values in these edit-boxes determines the range of the
colors that will be printed.

For more details see the section LUT Curve Examples below.

14.3.3 Dithering Type Examples

Original image Threshold

Dispersed dot Clustered dot (45, 53 LPI)

Floyd Steinberg Sierra Lite

Sierra 2 Sierra 3

1522
 14.3 Dithering

14.3.4 LUT Curve Examples

14.3.5 Dithering Recommendations

Ink

IJPDS When printing black and white text or CMYK text, use the dithering
type Floyd Steinberg or one of the sierras.

When printing simple images (large one color areas) use the dithering
type Clustered Dot.

When printing small and/or detailed images use the dithering type
Floyd Steinberg or one of the sierras.

When printing Alpha graphics use the dithering type Threshold.

Further settings should be:

Matrix: Round

Angle: 45

LPI: 53

1523
14 Global Features

Digital

OCE Settings should be:

Type: Clustered Dot

Matrix: Round

Angle: 45

LPI: 85

Resolution setting for PDF /EPS is set automatically to printer resolu-

tion in production.
IBM Settings should be:

Type: Clustered Dot

Matrix: Round

Angle: 45

LPI: 85

Nipson Matrixes with optimal settings from the manufacturer can be obtained
on request.
AFP Settings should be:

Type: Clustered Dot

Matrix: Round

Angle: 45

LPI: 85

If Grayscale image support is checked, dithering is not performed,

only linearization.

14.4 Docking
The working environment is fully customizable. You can grab any panel, window-pane, toolbar
or menu in the Workflow, Layout, Proof or Production window and dock it to a place you find
more convenient.

The guiding marks, that appear every time a panel is grabbed, ensure easy docking. When you
hover a panel over a guiding mark, the area, where the panel will be placed, is colored.

1524
 14.4 Docking

The arrows point to the area where the panel can be docked. The mark indicates that
the panel will be docked as a tab of the corresponding panel (as in the screenshot below).

1525
14 Global Features

14.5 File Import

14.5.1 File Import Overview
In this section
Native Files
Data Import
Design Related Import
Configuration Import

The section is focused on files that can be imported to a workflow in Inspire Designer. It presents
their overview with information where the import is used within the Inspire Designer environ-
ment and, in some cases, additional links to sections where the usage is described in this user
manual. Behind this overview, there are sections that contain import related information.

The four categories into which the possible imports have been divided are suggested based on
the environment or type of the import as well as the usage of the imported files. It is no precise
division; it merely serves to get a synoptic overview and help you find information about the
file you intend to import quickly.

The imported files, typically fonts, images or data files, can be made part of the workflow, i.e.
included, using the Used Files dialog.

14.5.1.1 Native Files

AFP, DOC, DOCX, EPS, HTML, INDD, PCL, PDF, PS, RTF and TNO files are referred to as native
files. Native files are a special category that are processed not as raster images but as separate
commands of the page description language (PDL). They also belong to the Design Related
section because they can be inserted as images.

File Import Location & Related Options Limitations & Notes

Type Description

DOC / See the list of four pos- Workflow Options dia- MS Word (2007 or later)
DOCX sible import locations log: DOC/RTF Native Im- must be installed locally.
below the table. port (Conversion DOC and RTF Files Import
method) Known Limitations apply if
Use TNO as intermediate
If the file is imported via format is used as Conver-
Layout menu or Inspire sion method in the Work-
Native module, you can flow Options dialog.
select the Conversion
RTF method in the Work- MS Word (2007 or later)
flow Options dialog. must be installed locally only
if Use PDF as intermediate
When loaded via Proof format is selected as Conver-
menu or Production sion method in the Work-
menu, Use TNO as inter- flow Options dialog.
mediate format conver-
sion method is used. DOC and RTF Files Import
Known Limitations apply if

1526
 14.5 File Import

File Import Location & Related Options Limitations & Notes

Type Description

Use TNO as intermediate

format is used as Conver-
sion method in the Work-
flow Options dialog.
INDD See the list of four pos- n/a Adobe InDesign must be in-
sible import locations stalled locally; the file is pro-
below the table. cessed as a PDF file.
PDF See the list of four pos- Workflow Options dia- PDF/PS/EPS Native Import
sible import locations log: PDF/PS Native Im- Known Limitations
below the table. port
PS See the list of four pos-
sible import locations
below the table.
EPS See the list of four pos-
sible import locations
below the table.
AFP See the list of four pos- Workflow Options dia- AFP Import Known Limita-
sible import locations log: AFP Native Import tions
below the table.
PCL See the list of four pos- Workflow Options dia- PCL Native Import Known
sible import locations log: PCL Native Import Limitations
below the table.
HTML See the list of four pos- Workflow Options dia- HTML Native Import Known
sible import locations log: HTML Native Import Limitations
below the table.
See also HTML Import
section for more inform-
ation about different
ways of importing HTML
files.
TNO See the list of four pos- n/a TNO is Inspire Designer's own
sible import locations native output file and is an
below the table. efficient format to use if you
are intending to produce
documents for import into
another workflow. See the
Inspire Native engine.

All file types listed in the Native Import table can be imported or processed via the following
locations. Links to description sections are added for some of the possibilities:

Layout menu: File | Import | Native

& Native Import section

Inspire Native module

& How to Use Inspire Native example section

1527
14 Global Features

Proof menu: Proof | Open

Production menu: Production | Open Workflow

If imported via the Layout menu, you can use these files to create your design (make changes
to the imported file) in the Layout module. If you use the Inspire Native module, you can pass
many pages for printing, e.g. this can be useful for reprints. For some of them there are also
further settings available in the Workflow Options dialog and it is advised you check the limit-
ations of the import.

Native files can also be processed in the Proof environment or Inspire Native Viewer for viewing
of their designs; or processed in the Production environment for transformation to another file
format.

14.5.1.2 Data Import

This category lists those files that can be imported via data input modules of Inspire Designer.

File Type Import Location & Description

CSV Data Input module

TXT
DBF
PGP (data file encrypted via PGP)
ASC (ASCII file)
TSD (Inspire Designer structured data file) Internal Data Input module

Data Proof: Save favorite items

XML XML Data Input module
RDI SAP Data Input module
IDO, IDOC

14.5.1.3 Design Related Import

This category lists those files that can be imported via Layout module of Inspire Designer and
make a part of the pages design.

1528
 14.5 File Import

File Type Import Location & Limitations & Notes

Description

TTF, TTC, OTF (True Type Layout menu: Insert | In- n/a
fonts) sert Font
FON (Windows Raster
fonts) & Fonts section

PFB (Type1 fonts)

GSR fonts, AFP fonts

PNG, JPG, JPEG, JIF, TIF, Layout menu: Insert | In- Can be loaded as images (raster im-
TIFF, BMP, TGA, ICB, sert Image ages).
VDA, VST, PCX, CXRI,
GIF, IMG & Images section
Native files: PDF, EPS, PS, Images family in the Lay- Can be loaded as images (raster im-
AFP, PCL, HTML, INDD, out Tree: Insert Variable ages) or as images with the option
DOC, DOCX and RTF Image right-click option Load natively selected (as vector ob-
jects). See also the Native Loading of
& How to Create Image Images section.
Page Counter section
Native import can be used as well.

See also HTML Import section for

more information about different
ways of importing HTML files.
TNO (Inspire Designer Can be loaded as an image, but as it
Native Output) is native, it is always processed as if
the option Load natively was selected
(as a vector object).

Native import can be used as well.

RTF Layout menu: File | Im- This is a direct method of importing
port | RTF/DOC and has limitations, see DOC and RTF
DOC, DOCX
Files Import Known Limitations. Al-
& RTF and DOC Import ternatively, import them as native
section files (see Native Import) or insert
them as images.

The Conversion method that is set

in the Workflow Options dialog has
no effect when using this direct im-
port; it applies to Native Import only.
PLS (PrintNet 3 Print Lay- Workflow menu: File | Importing PrintNet 3 Jobs Overview
out Source) Import | PLS

& Importing PrintNet 3

Jobs Overview section
PTF (PrintNet 3 Text Workflow menu: File | Importing PrintNet 3 Jobs Overview
Format) Import | PTF
PTF related options can be set in
& Importing PrintNet 3 Workflow Options dialog: PTF Import.
Jobs Overview section

1529
14 Global Features

File Type Import Location & Limitations & Notes

Description

XML Workflow menu: File | XML exported from Adobe InDesign

Import | XML using the Adobe InDesign Plug-in
For more information about the ex-
port and limitations please see the
Release Notes document related to
the plug-in version you are using.
Layout menu: Format | n/a
Import Language
Flows

& Language Flows And

Texts section
Layout menu: Insert | In- n/a
sert External Object

& External Objects sec-

tion
WFD Workflow menu: File | WFD exported from Adobe InDesign
Open Workflow using the Adobe InDesign Plug-in or
from QuarkXPress using the QuarkX-
Press Plug-in
For more information about the ex-
port and limitations please see the
Release Notes document related to
the plug-in type and version you are
using.
Layout menu: Insert | In- n/a
sert External Object

& External Objects sec-

tion
FO XSLFO module n/a
HTML, SWF (Flash) Embedded Object Areas n/a
section
HTM, HTML, TXT, XML Template Merger module n/a
HTML, XML External flow For HTML containing basic elements
and attributes. See also HTML Con-
& HTML Content Import tent Import Known Limitations.
section

14.5.1.4 Configuration Import

This category lists those files that can be used to configure certain features of Inspire Designer.

1530
 14.5 File Import

File Type Import Location & Description

FCV Data Transformer module dialog: Save conversions to

FCV file icon
PrintNet 3 FCV field converter in Data Transformer
module or on the Conversion tab of a variable in the
Layout Tree
DTD XML Data Input module
XSD XML Data Input module
Data Remapper module
WD Data Remapper module
XML Workflow menu: File | Manage Workspaces

Proof menu: Proof | Manage Workspaces

Production menu: Production | Manage Workspaces

& Workspaces section
Others family in the Layout Tree: Insert Wrapping Rule
right-click option

& Wrapping Rule Editor section

Region Binder module
DOT Workflow menu: File | Cross Reference Browser

& Cross Reference Browser section

JOB Proof menu: Proof | Load Job Config

Production menu: Production | Load Production

Configuration

& JOB File Structure section

WPR (Warning Preferences File) Proof menu: Proof | Edit Warning Config

Production window: Warnings button

& Warnings

14.5.2 Native Import to Layout

In this section: See also:
How to Import Native Files to Layout Glyph Area
Native Import Advanced Options Dialog File Import Overview

If native files are imported into Layout, one page is created for every page that is present in
the imported file. Each pages name is composed of the imported file name and the page
number.

1531
14 Global Features

However, when importing HTML natively, you have to select in the Options dialog if it should
be imported as multi-page or single-page document.

In addition, the content of those imported pages appears on the newly created pages inside
glyph areas, element areas, object groups, image areas or shapes depending on the original
format.

14.5.2.1 How to Import Native Files to Layout

To import native files into Layout, do the following:

1. Go to File | Import | Native in the Layout window.

This option will open the Open dialog.

2. Select one or more files in the Open dialog.

After clicking on the Open button all pages will be imported and no font will be re-
placed.

1532
 14.5 File Import

Alternatively, if you want to set advanced options, check Show advanced options.
After clicking on the Open button the Native Import Advanced Options dialog will be
displayed.

3. Each page of the original file will be imported onto a separate page in Layout. The
objects of the original file will be imported according to the following rules:

If the object in the original file is a text, it is imported into the layout as a glyph
area.

If the object in the original file is a vector graphic, it is imported into the layout as
a shape.

If the object in the original file is an image, it is imported into the layout as an image
placed in an image area.

Complex documents may be imported differently than described above.

Example The Result of Importing a TNO Document into Inspire Designer

Note Depending on the original file, the imported file (i.e. glyph areas, shapes and images)
might be placed into elements instead of directly on a page.

14.5.2.2 Native Import Advanced Options Dialog

1533
14 Global Features

Options Description

Begin Sets the starting page number, i.e. the first page of the file which is required to be
imported.

End Sets the end page number, i.e. the last page of each file which is required to be imported.

If one file is imported it displays the total number of pages in the file. If more files have
been selected for import the value displayed by default is 1,000,000 as the total number
of pages of all files cannot be calculated. If you intend to import the whole file, the default
value does not need to be adjusted.

Font Replacement Selects any previously created font replacement. This is then used for
the native file during import.

The font replacement is applied only if the fonts referenced in the imported file are not
embedded or are not present in the library in the resource directory. During the font re-
placement process the application first searches for the font name together with code
page name, then just for the font name (these values should be entered into the Name
field of the Font Replacement Layout Properties panel).

If font replacement is not successful (i.e. the font name is not found) the proportional
system font is used (in case of AFP files the font definition is searched before using the
proportional system font).

Note When importing PS or EPS files natively, the fonts not embedded in them are em-
bedded or replaced in Normalizer (during the internal conversion to the PDF format) and
any font replacement set here to be done by Inspire Designer has no effect.

The Go To icon displays the selected font replacement in the Layout Tree.

For more information see the separate section Others.

Optimize clipping paths If checked, the native file removes any unnecessary clipping paths.

This can result in fewer objects being created, in Layout, from the content of the file.
However, this process increases import time in proportion to the size of the native file.

Use dynamic variables If checked, any text that has been marked as variables in the native
file will be matched to variables in the Data family.

Text in the native file should be marked in the format <<VariableName>> to indicate that
it is a variable. See the section Layout Objects from Imported Files for more info.

To save file processing time, disable this option. This option is also available for native files
used as Images.

Create elements from overlays If checked, overlays in the imported file will become elements
on the page created in Layout.

Each element will contain groups of objects (images and shapes) that are created from
the content of an overlay. Text (not included in overlays) is placed in glyph areas.

If unchecked, the objects will be placed directly on the page.

1534
 14.5 File Import

14.5.3 Layout Objects from Imported Files

In this section: See also:
Format of the Imported File Native Import Advanced Options Dialog
File Import Overview
External Flow

When designing a document in RTF, DOC, DOCX or HTML you can predefine places for objects.
Then, when these documents are imported to Layout (via File | Import | RTF or File | Import
| DOC, these placeholders are matched with objects that have already been created in the
Layout Tree and those objects will be inserted into the design at that place. These placeholders
can also be used in RTF and HTML files which will be read into an external flow.

The placeholders have to be in the format <<PathToObject.Objectname>> where the text

between the <<>> marks must exactly match the path to the object and the name of object
that is required to appear as it is shown in the Layout Tree. It is case sensitive:

For flows, images, elements, tables and anchors, the Layout-Tree path to the object is
entered (i.e. <<ObjectFamily.Object>>) and the object is then placed in that position in
the parent flow, e.g. <<Elements.AddressElement>> will place an element called Ad-
dressElement into the design providing it exists.

For variables that are in the array that has been selected for Records by in the Data
Layout Properties; and those variables that are on the first level of the Data family (e.g.
DATA.Variable1) can be identified by using the variable name on its own (e.g. <<Vari-
able1>>).

Variables at other levels should include the path to the variable (e.g. <<Transac-
tions.Value.Time>>), but it is possible to leave out the Value subtree which appears in
arrays (e.g. <<Transactions.Time>>).

Variables can also be defined in this way when preparing a text or HTML file for inserting
into Template Merger module or in native files for import into Layout.

Example In Layout, the Records by array contains variables that relate to cus-
tomers names and addresses:

1. In the native, RTF or DOC/DOCX file, create an address box and type in the
placeholders for the variables.

2. Import the file to Layout via the File menu (File | Import).

For native files, the option Use dynamic variables must be checked in the
Native Import Advanced Options dialog (it is by default).

1535
14 Global Features

Alternatively, native files can be inserted into Layout as Images. If so, the option
Use dynamic variables must be checked in the Image Layout Properties.

3. Inspire Designer searches for the specified variables in the Data and, if they
exist, the variables appear on the imported pages.

4. When the workflow is processed, the imported pages are repeated by the
data array and the variables are replaced with their values as is usual for vari-
ables.

For variable images, use the prefix var4img:// so that it is known that the values being
returned by the variable are actually paths to an image. When the document is imported
to Layout, a variable image will be created and placed on the page inside the flow which
has been created for any text in the import. The named variable will be selected for the
option Variable on the Image tab of the variable image.

Example Writing the text Look at this picture: <<var4img://Variable 2>> in an

RTF document and then importing that file will result in ;

providing that the variable named Variable 2 already exists in Layout.

Variable 2 will be selected for Variable for this image.

Object placeholders that are not matched, or are not recognized, will remain as text.

14.5.3.1 Format of the Imported File

Inspire Designer must be able to recognize the text in order to match it to objects, which is
dependent on how the imported file was produced. Few problems should be encountered with
the text within RTF, DOC/DOCX, PDF and TNO files, however with other native files it will depend
on the settings used at the time they were produced. In particular, make sure that text encoding
was used and that the text was not placed into an overlay.

In particular, the values of variables are returned in the same font as used by the text in the
imported file, the imported files must have access to all of the glyphs of the font that are re-
quired to return the values of the variables. For example, if the variable is <<Surname>> and
one value returned should be Lexis the native file needs to have the glyphs for L, e, x, i and s.
This also depends on how the imported file has been produced:

If the file has been produced with embedded fonts, then it will only use the glyphs that
are in the file.

1536
 14.5 File Import

In this case it is possible that characters will be missing from the values returned by
variables in the print, e.g. Le is if there isn't any x in the imported file.

If the file has been produced to use external fonts then system fonts will be used which
should help ensure that fonts are matched and the glyphs found.

The settings that have to be used to achieve this glyph access differ for each file format and
what tool is used to produce the file.

As a solution to having files with missing glyphs, you can create Font Replacements via the
Others family in the Layout Tree. Then it is possible to select these in the Font replacement
combo-box that can be found in either the Native Import Advanced Options dialog or in the
Image Layout Properties.

14.5.4 RTF and DOC Import

DOC, DOCX (both referred to as DOC type files hereafter) and RTF files can either be imported
into Layout natively (see Native Import to Layout) or directly.

The direct import method brings the content of the DOC or RTF into flow areas in the Layout
and enables you to edit text (in flows), images (as images in image areas) and tables (as tables).
This is in contrast to native import, which reads them into the workflow and adjusts them using
glyph areas etc. at the time of processing.

To import directly, go to File | Import | DOC or File | Import | RTF in the Layout Window
menu. Alternatively, dragging and dropping DOC or RTF files directly into the Layout Area from
any file explorer also imports by this direct method.

Based on the file type, the RTF or DOC Import dialog opens and shows the progress of the
import. Then you can select one of the options in this dialog , i.e. what operation should be
performed.

Options Description

Operation The following options are available in the drop-down menu:

Don't perform action The document is imported into one flow on one page, no
flowing is set up.

Set up text flowing The document is imported on one page and flowing is set
up for this page.

Split into pages The document is imported on more pages (as many pages as
necessary get created; section breaks in RTF result in page breaks in Inspire Design-
er).

1537
14 Global Features

Tip You can set the default way of importing the DOC/RTF files in the Layout Options Dialog
File Import.

Note

Only basic DOC and RTF features are supported so see the list of DOC and RTF Files
Import Known Limitations before you decide whether to use this direct import method.

Check also some further settings related to RTF/DOC import in the Layout Options
Dialog File Import section.

The Conversion method that is set in the Workflow Options dialog has no effect when
using this direct import; it applies to Native Import only.

DOC import is not supported by Mac version of Inspire Designer.

DOC import via this method can only be carried out only if MS Word 2000 version or
later is installed locally. Otherwise a warning is displayed when trying to import DOC
files.

14.5.4.1 Font/Image Replacement

If you import RTF or DOC files (or others like XML, PLS, PTF) containing fonts or images not
installed (located) on the current machine, there is a Font (resp. Image) Replacement dialog
displayed, allowing you to replace such a font/image with another one.

The last used combinations of uninstalled fonts and their replacements are stored and offered
automatically the next time the same uninstalled font is found.

Note Font files must physically exist (not only as a link) in the fonts directory (e.g. Windows
fonts directory or other directory pointed to by CX_FONT_DIRECTORY environment variable)
of the local computer that Inspire Designer is running on, in order to be found.

14.5.4.2 DOC and RTF Files Import Known Limitations

The following list of limitations contains MS Word 2007 features currently not supported when
imported into Inspire Designer and also describes the results of import of features which are
not fully supported.

These known limitations apply to:

direct DOC/RTF import described in this section

and DOC/RTF files imported natively, for which the Use TNO as intermediate format is
selected as Conversion method in the Workflow Options dialog.

1538
 14.5 File Import

If Use PDF as intermediate format is selected, the DOC to PDF conversion is done by MS Word
and these known limitations do not apply.

Note It may happen that you find an unsupported feature which is not listed below. The
reason why there cannot be a complete list is that the RTF specification is open and new features
are developed and added into the specification. However, the implementation of new features
into the import functionality in Inspire Designer does not occur in parallel to this process and
new features in RTF/DOC are not enabled in the import automatically. In case you find a feature
that is neither implemented nor listed among these known limitations, please report the issue
you have found, so that it can be either fixed (implemented) or included in this known list.

Text font format style:

Double strikethrough is imported as Strikethrough.

Shadow (as pattern or gradient) is imported as plain style (without shadow). Solid
color shadows are supported.

Emboss, Engrave is not imported, i.e. the text to which these styles have been applied
is missing.

Text underline style:

Words only is imported as plain underline style (continuous, including spaces).

Wavy is imported as plain double underline.

Text other features:

Column format is imported as plain text without columns.

Initials the initial letter (in the size as defined in the document) is imported one line
above the text.

Decimal tabulator works with all kinds of decimal delimiters except for the space.

Justify is imported as "Justify paragraph left". Workaround: Manually change to "Align

paragraph left".

Tables:

Nested tables are not imported. Only the basic table (level 1) is imported. The text
from the nested table, if there has been any, is kept in the basic table.

Rotated text in tables is imported as non-rotated.

Borders only solid borders applied to cells or the whole table are imported.

Shading only solid colors are imported.

Wrap anywhere is unsupported for long texts in cells (and in text boxes).

1539
14 Global Features

Lines and shapes:

Lines and shapes are unsupported. The import results in showing only the bounding
box (rectangle of the line or shape size) and the line-style used, i.e. only rectangles with
solid borders can be imported correctly.

AutoShape is unsupported. The import results in showing only the bounding box
(rectangle of the shape size).

WordArt is unsupported. Word Art objects can be imported as PNG images if storing
as PNG was allowed in the DOC file.

Images:

Image types Import of images is restricted to image types supported by Inspire Designer.
Import of any other image type (e.g. EMF) results in showing the sample image in Layout
and the note that this image is "invalid" on the Image tab of the sample image.

Image position Images (and other kinds of objects) may change their position after
import into Inspire Designer.

Crop from is unsupported. The import results in showing the whole image.

Image control (post-processing of images) is unsupported. This feature can be used

e.g. for setting an image to greyscale or black&white. The import results in showing
the original image. Inspire Designer features in Layout (Advanced tab for the image)
and in output engine must be used.

Wrapping style (Runaround) "In front of text" style is imported as "Behind text",
which is the default Inspire Designer style.

Z-order:

Z-order The order of two overlapping objects (e.g. text and image) is not kept during
import. The way that Inspire Designer and MS Word use to render the objects is different.

Pages:

Page size If there is a document with more pages of different size, the import results
in importing the pages all in one size only. The size of the first page of the document
is used.

Page breaks If there are several pages in the imported document that are the result
of using enters (empty paragraphs) behind the text instead of using the "Page Break"
functionality, the import may result in splitting the pages differently than in MS Word.
If accurate splitting into pages is required, "Page Breaks" must be used in the resource
DOC/RTF file.

Equations:

Equations are unsupported. Equation objects can be imported as PNG images if storing
as PNG was allowed in the DOC file.

1540
 14.5 File Import

Text boxes and frames:

Text boxes are imported as anchors. Supported features: border lines, dashing, line
style, filling with color.

Wrap anywhere is unsupported for long texts in text boxes (and table cells).

Frames are unsupported. The import results in expanding the text with a border to
the usable page width.

Forms:

Text Form Field, Check Box Form Field, Drop-Down List can be imported. Other form
controls are unsupported.

Option button (ActiveX control) will be imported as PNG image if storing as PNG is
allowed in the DOC file.

Foot note:

Foot note is not imported at all.

Page numbers:

Page numbers are inserted as static numbers based on the number calculated in MS
Word. It may happen that this number does not correspond with the page number in
Layout (after import).

Fields (variables):

Fields are not recognized as variables during the import to Inspire Designer and that
is why they cannot be connected to variables. The import results in showing the 'X'
characters (which in MS Word represent the field).

Fields that contain document properties, e.g. FileName, are not updated correctly
during the import. You can save the DOC to PDF and import the PDF to Inspire Designer,
which is then displayed correctly.

OLE functionality:

OLE functionality (e.g. images rendered by external COM objects) including ActiveX
is unsupported. The linked object is missing after the import.

Layout Options:

All of the options in Word Options (available after clicking on the MS Word icon) |
Advanced | Layout Options (at the very bottom of the Word Options dialog) are
unsupported.

For example, the feature "Split apart page break and paragraph mark" by which you
can choose, if the paragraph mark will be displayed on the same line as the page break
or below it, is also unsupported.

Invalid RTF/DOC:

Importing invalid RTF or DOC files, e.g. using a color that is not defined within the file,
is not supported. Such invalid files cannot be imported.

1541
14 Global Features

14.5.5 HTML Import

See also:
File Import Overview
Template Merger Module
Embedded Object Areas
External Flow

There are several options related to HTML import throughout Inspire Designer. The File Import
Overview section lists it among native files as well as design related, even twice in the latter
category.

This section should help you find out the right scenario suitable for your needs if you are inter-
ested in importing (or creating) HTML files based on what the intended action and output are.

Input Action in Module Output See

Inspire Designer below

designed personalization, no other Template Merger HTML 1

HTML file + changes Simple
data
data only HTML creation (by entering Template Merger HTML
tags), personalization Simple
data only design for HTML creation, Layout, main flow HTML 2
personalization Simple
designed load HTML as image nat- Layout, object position- any, incl.
HTML file + ively, personalization ing on pages (with dy- HTML
data namic height)
HTML file embed external objects Layout, Embedded Ob- HTML or
(or also ject Areas SWF
Flash SWF
file)
HTML file personalization or other Native import to Layout any 3
(e.g. from changes (glyph areas, element
online areas)
source)
HTML file no changes Inspire Native any
(e.g. from
online
source)
designed no changes or only person- Layout, external flow any 4
HTML file or alization using placehold-
HTML in a ers (e.g. <<Clients.Ac-
variable + count>>)
optionally
data

1542
 14.5 File Import

14.5.5.1 1 HTML in Template Merger

Use the Template Merger module in case that you want to insert an already created HTML (or
TXT) and personalize it, i.e. place the variables coming from your data into it. It is also possible
to use the module for creation of the HTML by entering the HTML tags. The intended output
is typically e-mails or SMS messages. HTML Simple must be used together with it as production
engine as well as Proof profile.

14.5.5.2 2 Design in Layout for HTML Output

Use the Layout module in case that you want to create an HTML or HTML Simple output, i.e.
to create personalized e-mails. Find out about the difference between HTML and HTML Simple
outputs so that you start designing into the main flow only (for HTML Simple) or create pages
with fixed or dynamic height (for HTML).

You can load HTML files natively using variable images, based on conditions from data, to
achieve personalization.

You can also embed external objects (HTML or Flash), based on conditions from data, to produce
personalized HTML or Flash output.

14.5.5.3 3 HTML Native Import

Use the HTML native import feature if you want to create any output out of the input HTML
file. The HTML native import into Layout enables you to change the HTML content displayed
in glyph areas and element areas after the import.

Use the Inspire Native module if you do not intend to make any changes to the HTML and
want to import it to create a different output out of it. Please note that if HTML is loaded natively
and then processed to create HTML output, the result will look similar as for the design, but
the coding will change significantly.

14.5.5.4 4 HTML Content Import

Use the external flows in case that you have existing HTML content (mainly text, basic elements
used) that you want to easily include as variable-selected paragraphs into your designs.

A typical usage scenario can be a bank or an insurance company composing the content of a
contract out of already pre-defined paragraphs. As a progressive enterprise they have their
contract content stored in HTML (as an alternative to RTF) to avoid conversion and formatting
problems as well as enabling direct accessibility of the contracts on their websites.

Additionally, the HTML content import feature enables personalizing the HTML, i.e. mapping
of variables coming from the data to the HTML content via placeholders.

How it Works
To make your HTML content part of a design, do the following:

1. Create a flow area. Set the flow to External. Assign a variable that will provide the
content to the Location field of the flow Layout Properties.

1543
14 Global Features

The variable assigned to the Location field should be of the String type and either
contain the path to the HTML file, or directly the HTML code.

2. According to your needs you can create multiple external flows and either place them
one behind the other or switch between them based on a condition.

3. Optionally, you can set up overflow between flow areas or pages and font replacement.
Mapping of variables can be achieved by having the <<>> placeholders in the HTML
and variables of the same name coming as data to Layout.

4. When the design is set up, proof your workflow to view the result. If satisfied, select
the engine of your choice to get the desired output.

HTML Content Import Known Limitations

The current basic implementation of HTML content import via an external flow is a technolo-
gical preview and at present only basic HTML elements and their basic attributes are supported
(for reference, please see TinyMCE demo). The implementation of more HTML elements will
continue in the next versions of Inspire Designer.

The following HTML features are not supported at all:

JavaScript is unsupported.

Tables are unsupported. Only simple tables with one column (without span and border)
are supported, e.g. <table><tr><td>First row</td></tr><tr><td>Second
row</td></tr></table>. When importing tables with more columns, e.g. the one
in TinyMCE demo, the columns will not keep their width but will stretch to the full
width of the page.

Positioning is unsupported.

CSS styles are unsupported, except if set by a formatted element using the style=''
attribute.

Form elements are unsupported.

The <frame> element is unsupported.

Nested <sup> and <sub> elements may not be displayed in the same way as in
browsers.

Justify settings are applied incorrectly to paragraphs that contain the <br> element.

If reading HTML files via an external flow by their names, the HTML files must be encoded
to UTF-8. If a different encoding is applied, the result displayed in proof and in the
output will be incorrect.

Workaround: Use the File content conversion in Data Transformer or Layout to read
the HTML content to the variable that will be used in the external flow.

Note We very much appreciate your contribution to the improvement of this functionality
by providing feedback on its usage and any issues arising when doing so.

1544
 14.6 Find & Replace Dialog

HTML Content Import Supported Elements

This is the list of basic HTML elements that are supported: <a>, <address>, <b>, <body>,
<div>, <em>, <font>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, <head>, <html>, <i>,
<img>, <li>, <ol>, <p>, <span>, <strong>, <sub>, <sup>, <u>, <ul>.

14.6 Find & Replace Dialog

The Find and Replace dialog can be invoked in all multiline edit-boxes in Inspire Designer (e.g.
script editors, variable value) by pressing <Ctrl> +<F> (for Find) or <Ctrl> +<H> (for Replace),
or by clicking on the Find icon where available.

Options Description

Find what Type the string that you want to search for.

Replace with Type the string that you want to use instead of the string in the Find what
edit-box.

Tip The Find what and Replace with edit-boxes have drop-down lists, which contain
recently used strings. These strings are displayed in the Find & Replace dialog invoked
anywhere within one Inspire Designer session.

Match whole word only If checked, only matching whole words are looked for.

Match case If checked, searching is case sensitive.

Up If selected, searching is performed from the current position upwards.

Down If selected, searching is performed from the current position downwards.

Find Next Searches for the specified string in the specified direction.

Replace Replaces the found string.

Replace All Replaces all strings found in the multiline edit-box at once.

Close Closes the dialog.

1545
14 Global Features

14.7 ICC Profile Setting

See also:
ICC Profiles

ICC profiles can be selected as part of many Engine Configuration dialogs in Production and
of the Vector and Raster Proof Profile dialogs. They map the colorspace that will be used for
printing on the chosen printing device. Settings made here in Production or Proof will override
any settings you might have made for CMYK profile etc. in the Layout Options dialog.

Options Description

CMYK profile Selects a CMYK profile for the according proof/production engine. The follow-
ing options are available by default:

Current CMYK profile (Layout CMYK profile) This option is set by default. It shows
the currently set profile in brackets (by default Layout CMYK profile is selected; see
the description below).

Note This option is helpful when you have loaded a workflow using a profile not
installed on the machine you are using. If you decide to change this profile to a
profile installed on your computer the profile originally contained in the workflow
will be overwritten and cannot be reselected. Even if you have a profile of the same
name installed on your machine, this option can be helpful as only the profile
names are displayed; it is not verified if profiles of the same name are really
identical.

Layout CMYK profile This setting leads to the CMYK color profile you have set
in the Layout Options dialog being used. If you have not specified a CMYK ICC
profile in the Layout Options dialog, the built in 1- CMYK color profile will be
used.

Using CMYK Profiles for Output colors in Proof:

1. CMYK + CMYKSplit

1546
 14.8 Language Codes

The CMYK Profile is used in Proof for CMYK images so that they are displayed
correctly on display/monitor. See also the ICC Profiles section.

2. Black and white, Spot colors, Dithered spot colors:

It is not possible to compute the grayscale representation of images directly from

CMYK, it needs to be converted to RGB first. For this CMYK-to-RGB conversion
the selected CMYK Profile is used.

Default CMYK intent Selects the default method for transforming colors from one color
space into another, one for all eight handling groups listed in the CMYK intent panel below.
There are four methods to create a color rendering: Perceptual, Relative colorimetric, Sat-
uration, and Absolute colorimetric.

For more information see the Rendering Intents section.

CMYK intent This panel allows to specify rendering intents for individual handling groups.
By default all handling groups' intents are set to Perceptual. That setting you can change
for all handling groups at once in the Default CMYK intent combo-box described above.
It is also possible to set intents for individual handling groups. To do so, click on the re-
spective handling group's combo-box and select one of the four possible rendering intents
as described in Default CMYK intent above.

Add Profile Opens a standard Open dialog allowing you to add new CMYK color profiles
(ICC and ICM files) which can then be selected from the above CMYK Profile combo-
box.

Save Profile Saves the currently selected CMYK profile to disk location with the extension
ICM. This is to further reuse the ICC profile.

14.8 Language Codes

In this section:
Language Codes for Styles
Language Codes for Scripting

Language codes are used in some places to select the language in which text is written. The
codes are based on ISO 639-1.

14.8.1 Language Codes for Styles

The following list contains the supported language codes, which can be used for hyphenation
exception files for a paragraph style. Those composed of more than two letters have been added
outside of the ISO 639-1 standard, e.g. es_mx:

bg Bulgarian

cs Czech

1547
14 Global Features

da Danish

de German

el Greek

en English (UK)

en_us English (US)

es Spanish

es_mx Spanish (Mexican)

et Estonian

fi Finish

fr French

he Hebrew

hu Hungarian

it Italian

ja Japanese

lt Lithuanian

lv Latvian

nl Dutch

no Norwegian

pl Polish

pt Portuguese

ru Russian

sk Slovak

sl Slovenian

sv Swedish

tr Turkish

zh Chinese (Traditional)

zhcn Chinese (Simplified)

1548
 14.8 Language Codes

14.8.2 Language Codes for Scripting

Some scripting methods use Language codes: the DateTime.toString, DateTime.from
String and DateTime.format DateTime methods; the toSpell method for converting
Int, Int 64, Double and Currency data-types to string; and the Number to spell and Spell to
number field conversions. I.e. String aLocale or String aP1 suggested by the Script
Assistant for these methods refers to a language code.

The supported codes are:

cs Czech

da Danish

de German

en English

eo Esperanto

es Spanish

fa Farsi Persian

fi Finnish

fr French

it Italian

ja Japanese

mt Maltese

nl Dutch

pl Polish

pt Portuguese

ru Russian

th Thai

uk Ukrainian

Also some additional codes for regional variations, taken from ICU (International Components
for Unicode) locales, are supported but are not often required because numbers are mostly
spelled the same ways in different locales, e.g. de_DE, de_LU, de_AT, en_AU, en_UK, en_US,
es_MX, nl_BE or pt_BR.

Note Unsupported language codes used in DateTime methods cause Warning 0102 which
aborts processing, but can be set to Ignore in the Warnings Config dialog. With the other
methods, a warning will not appear but the value returned by the field will be wrong.

1549
14 Global Features

14.9 Log Window-Pane

In this section:
Log Window-Pane Context Menu

The message area at the bottom of the Proof and Production windows allows you to view the
individual steps that took place when proofing a workflow or running a job. In Proof you can
display/hide this Log window-pane via the Window menu, in Production it always displays.

Tip While log messages are generated, a click on a particular message holds the log. Selecting
Autoscroll to end from the log window-pane's context menu or pressing the <End> key re-
enables scrolling down to the newest message.

Options Description

Time Shows when the action took place.

Severity Shows the importance of the event described in Event Description field:

Status message Only for information purposes.

Warning Identifies less severe problems and design issues in Layout (e.g., hori-
zontal overflow) and does not cause interruption of the job.

Recoverable error Identifies severe problems that do not cause job abortion.

This is shown when the Abort level has been set to Recoverable in the Warnings
Config dialog for warnings when using the error recovery functionality or to Ignore
for errors.

Fatal error Identifies severe problems and the job does not process further.

The Abort level can be set to Ignore in the Warnings Config dialog, so that the
job can be processed.

Critical error Identifies severe problems and the job cannot be proofed or run.

This is shown after the Abort level for a warning or an error has been changed to
Abort.

For the complete list of Severity and Abort values and the resulting behavior see the
Warnings/Errors Behavior section.

1550
 14.9 Log Window-Pane

Example

An error message informs you about the problem and its location. In scripts, the exact
position of the problem is indicated by the line number and character position. For
instance (as shown above), Source(1:9)-(1:13) means that the error in script
was found on the 1st line from character 9 to character 13.

Note

Double-clicking on the error line or selecting the Go To Error option from the
context menu, takes you to the section in Layout (or Script Data Input module)
where the error was identified. In the example above, both error lines refer to the
same error the first line refers to the wrong script for Variable1, the second one
to the flow area where this variable has been used.

For HTML engines Production, double-clicking on a warning in the log window-

pane takes you directly to the spot, where the corresponding issue occurs. In Layout
the according flow area is highlighted.

Event Description Describes individual steps that take place when proofing the job.

Workflow Only for Production. Displays the path to the workflow and its file name.

Code Displays the ID for each message. This can be useful for Warning configuration.

14.9.1 Log Window-Pane Context Menu

When you right-click on a message line in the Log window-pane, a context menu appears.

Options Description

Edit Warning Config Displays the Warnings Config dialog with the message, that is currently
selected, highlighted.

Go to Error Moves you to the place in Layout or other modules where the error was detected.
This option is only available if the message is about an error.

Alternatively, you can go to an error by double-clicking on the message line.

Clear All Clears all of the messages from the Log window-pane, i.e., they don't display on
the screen (but they are still kept in the LOG file).

1551
14 Global Features

Copy Description Places the content of the message into the clipboard and it can be then
pasted as text.

Open Spool File Opens the spool file with the appropriate viewer (if assigned). The option
is displayed only after right-clicking on the log-message naming the engine used (PDF in
the screenshot above). The spool file is also opened after double-clicking on the log-mes-
sage.

Before generating jobs with the Split by group option selected, enable the File logging
check-box in the Warnings Config Dialog to list each generated separate spool file in the
log window-pane. Double-clicking on a log-message with the ID 0995, or selecting Open
Spool File from its context menu, opens the spool file.

Info Reveals another menu, to the right, that provides a little more detail, e.g., about the
location of the error or the time that the process took.

Autoscroll to End Scrolls down the log window-pane to the last message.

Click on this option, or hit the <End> key, to scroll down to the newest log message. Click
on the required log message to stop scrolling.

14.10 Open File Dialog

In this section: See also:
File Opening File Open Dialog in the Workflow Options
Favorite Folders

In addition to all of the standard features, the Open file dialog offers a few advanced ones.

Note For Macs: If the Aqua skin is selected, the Open file dialog has Mac OS X native appear-
ance. This changes to Original skin appearance, when a connection to Inspire Content Manager
(VCS) is established. It changes back to Mac OS X native appearance, when the connection is
closed.

1552
 14.10 Open File Dialog

14.10.1 File Opening

When opening a file, the following features are available:

Possibility to select files both with the mouse or using the keyboard only:

The arrows search through and select files.

The combination of the left arrow and the <Alt> keys opens the previous folder.

<Backspace> opens the folder a level up.

Possibility to drag and drop files directly to the File name edit field.

A tool-tip with information on the indicated files and a preview (of fonts, pictures and
WFD workflows), which helps in faster file identification.

Example WFD file

1553
14 Global Features

Example Font file

Example Image file

1554
 14.10 Open File Dialog

14.10.2 View Menu

You can define the form of the Open dialog. Click on the View Menu icon to specify the
required settings. Apart from the standard view menu settings, you can choose to display
metadata. See the screenshot below.

If With Metadata option is enabled, click on a file to display all metadata included into the
respective file.

If View Font Name option is enabled, a full font name is displayed in the dialog.

14.10.3 Favorite Folders

You can create shortcuts to frequently used folders to speed up your work. Click on the Favor-
ites folder menu icon in the right-hand top corner of the dialog and add or configure
shortcuts to your favorite folders. These folders can then be quickly accessed from the drop-
down menu whenever you need them.

1555
14 Global Features

Options Description

Add Current Folder Adds a shortcut to the current folder to the drop-down menu. The
dialog that appears enables you to edit the shortcuts name.

Configure Opens a dialog listing all favorite folders where both the name of the shortcut
and the path to the folder can be modified.

14.11 Resize Barcodes

See also:
Barcodes
How to Align Barcodes to Pixels

Barcodes may need to be resized when printing using inks in order to increase the readability,
particularly if the ink is being absorbed to some extent by the medium it is being printed on.
They may also need to be re-aligned to the pixels for printing accurately using raster engines
such as AFP.

Many conditions can affect how the ink finally appears on the paper and the size of the bars
(elements) in the barcode may have to be altered here so that it can still be read correctly by
a barcode scanner. Typically the size of a barcode is reduced by a small amount (i.e. less than
5 %) so that, when the barcode is printed and the feathering of the ink increases the barcode
size, its original intended size is maintained. The re-sizing is applied to the individual elements
of a barcode, as opposed to the overall size of the barcode.

For more on aligning to pixels see How to Align Barcodes to Pixels.

Options Description

Relative in % Decreases/increases the size the elements of any barcode along the X and Y
axis of the page (not the axis of the barcode, which may have been rotated) as a percentage
of their original size.

Example If there are two Code 39 barcodes:

1. Across the page with 0 degrees Rotation on its Position tab.

2. Down the page with 90 degrees Rotation on its Position tab.

1556
 14.11 Resize Barcodes

Then Relative in %: 99% in the first (X) edit-box results in:

1. Reduction in size of 1% to the Module width that was entered on the Code
39 tab of the barcode.

2. Reduction in size of 1% to the Height that was entered on the Code 39 tab
of the barcode.

Absolute Decreases/increases the size of the barcode elements along the X and Y axis (axis
of page, not barcode) using measurement units, e.g. 0.01 mm.

This is applied to each element as a whole.

Example

1. An element in a barcode is three modules wide, with Module width:

0.19mm, i.e. its total width is 0.57 mm.

2. The barcode is positioned across the page (0 degrees Rotation) and given
a Absolute decrease of 0.05 mm for X.

3. The resulting width of the element is 0.52 mm.

This avoids rounding errors that could occur when using Relative in %. If Relative in %
is set too, absolute resize is applied in addition to that. Measurement units can be changed
by clicking on the unit symbol.

Alignment Sets the alignment of the barcode in relation to the DPI set (DPI of the printer)
using the Module width of the barcode.

This is an alternative way of barcode alignment to the option Align to Pixels in Layout.

You can choose from:

No alignment No alignment is applied. This may cause incorrect print of barcode.

Align to pixels - round normal Recalculates the barcode's Module width in

pixels, rounding them up or down depending on whether the value it has been
given is higher or lower than 2.5 pixels.

Example If Module width is 4.33 pixels this option will have the same
behavior as Align to pixels - round down and in the case that the Module
width is 4.60 pixels the behavior will be the same as Align to pixels - round
up.

Align to pixels - round up Recalculates the barcode module size in pixels (always
up) depending on the actual value.

1557
14 Global Features

Example The Module width: 4.33 will be rounded to 5.00 pixels, the next
module will start at position 5 pixels and finish at position 10 pixels, etc.

Align to pixels - round down Recalculates barcode module size in pixels (always
down) depending on the actual value.

Example The Module width: 4.33 will be rounded to 4.00 pixels, the next
module will start at position 4.00 pixels and finish at position 8 pixels, etc.

Align to pixels and align bar position Recalculates the width of each element in
pixels and places the individual elements as close as possible to their original posi-
tion.

I.e., instead of rounding down accumulatively across the width of the barcode,
each element will be aligned to the nearest pixel (to the left, if the code has 0 de-
grees Rotation) and rounded down in size to the closest full pixel width.

Example An element is 3 modules wide and Module width: 4.33, therefore

its total width is 12.99 pixels. This element will be rounded down so that it
is 12.00 pixels wide.

Example Comparing the pixel positions of four elements of a barcode:

No Alignment: 2.3; 4.6; 6.9; 9.2

Align to pixels - round down: 2.0; 4.0; 6.0; 8.0

Align to pixels and align bar position: 2.0; 4.0; 6.0; 9.0

Notice how the biggest difference is in the forth element's start position. Instead of
8 (Align to pixels - round down), it keeps the position from the original No Alignment
position (9.2) to give 9.0.

Example of Alignment for Code 128:

Size as given in the design in Layout.

The Module width is 0.19 mm which is 4.49 pixels,

a size which is not very good for printing raster
Align to pixels - round normal.

The Module width has been rounded down to 4.00

pixels, i.e. the same result as Align to pixels - round
down. As shown here, this can result in a much
smaller barcode.

1558
 14.12 Sheet Names

Example of Alignment for Code 128:

Align to pixels - round up.

The Module width has been rounded up to 5.00

pixels. The barcode is significantly bigger and it may
not fit into the place designated for the barcode
during design.
Align to pixels - round down.

The size of module was rounded down to 4.00 pixels.

Align to pixels and align bar position.

The barcode as a whole is almost the same as its

original size, but some elements are thinner because
they have been rounded down to their nearest full-
pixel width.

Tip

Make sure that both the DPI of any raster engine that will be used for production (or
the Raster proof profile) is the same as the DPI for pixel units set in the General Options
section of the Workflow Options dialog.

Ways to control the amount of ink used for barcodes:

Use a fill style for barcodes and select different tones of grey.

Set up a special handling group for your barcodes. In Production on the Dithering
tab you can work with the LUT tables and modify the amount of ink that way.

14.12 Sheet Names

In this section: See also:
Sheet Names Tab Pages Family
Individual Pages
Template Merger Module

A sheet name is an identifier given to pages via the Layout module; texts via the Template
Merger module and sheets imported from native files via the Inspire Native module or Text In
Rect module. When a workflow is processed in Proof or Production, all of these objects are
treated as sheets as they pass through (and out of) the workflow and the names given to each
sheet can be read by various modules and production engines.

If sheets have differing sheet names, they can be manipulated in different ways by impositioning
modules, output modules or Production. Sheet name 1 should be used exclusively for the
purpose of media selection. Typically, sheet name 1 is used by an output module in a workflow
in order to identify different media, allowing for pages of the same design to be given the
same sheet name (a constant value) so that one design is always printed on the same media.

1559
14 Global Features

Alternatively, sheet name values can be returned by variables so that pages of the same design
are manipulated in different ways according to data being read from an input or any other
calculation or script.

Example You can assign sheet name 3 to a variable that returns ZIP codes (from a set
of customer records) to the Pages family in the Layout module; and then use the Sheet
Sorter module to sort the repetitions of pages (groups) by customer address.

14.12.1 Sheet Names Tab

This tab is used to define sheet names for Layout pages and Template Merger texts.

Individual pages or groups of pages or texts can have many sheet names assigned to them so
that they can be manipulated in differing ways at different stages of processing. It is possible
for many different pages or texts to have the same sheet name, in which case they can be
manipulated in the same way. If you need to assign more than two sheet names, you can create
new sheet names using the Create New icon.

Options Description

Index Lists the index number of the respective sheet name.

Index numbers are automatically assigned in order.

Go To Finds the node of the selected Variable in the Layout Tree.

Create New Adds a new sheet name to the list.

Delete Deletes the selected sheet name from the list.

Variable Selects the variable that will return the sheet name value.

Constant Value Enters text that will be the constant value for the sheet name.

The sheet name with Index 1 (sheet name 1) has the default value set to Main and it is
editable. If a Variable is selected the Constant Value field is not editable or, if a variable
of constant kind is selected, it displays the constant value from that variable.

For other sheet names, if you enter a constant value in this field, a new constant variable
containing this value is created and used for the respective sheet name.

Note In the Layout module, you can only set sheet names 3 and higher for the Pages family.
Sheet names 1 and 2 are reserved for individual pages.

1560
 14.13 Text Encoding

14.13 Text Encoding

In this section:
Editing Single-byte Encoding Types
Editing Double-byte or Mixed-byte
Encoding Types
Setting Up Custom Text Encoding For
Data Input
File Structure of an Exported Codec

Options Description

Text encoding Selects the codec to be used for encoding of text.

ISO-8859-1 is recommended for Latin (western) style fonts, but the complete range of
codecs from the International Components for Unicode are available.

To find any particular codec faster, press <F3> and type a few letters of the encoding
name into the special edit field which appears.

Go to Previous Moves backward through the codec list.

Go to Next Moves forward through the codec list.

Edit Opens the Edit Codec dialog which enables you to edit the rules of the selected codec.
This dialog differs according to the type of selected text encoding:

single-byte

double-byte or mixed-byte

Clone Creates a new file codec type based on a file codec type already existing in the File
Codec drop-down menu. The cloned codec inherits the attributes of the original codec.
These attributes can be further modified without changing the attributes of the original
codec.

The cloned file codec type will be displayed in the User Defined group in the File Codec
drop-down menu.

Note

If a name entered for a cloned text encoding is identical with an already existing
one, a warning prompts you to enter another name. The new encoding is not
saved until you change the name to a unique one. The default name for newly

1561
14 Global Features

cloned codecs has the form: Clone of OriginalCodec, i.e., if you clone the US-ASCII
codec, the clone will by default be named Clone of US-ASCII.

If a single-byte font is cloned, all characters are displayed. If a double- or mixed-

byte font is cloned, nothing is displayed, because the list of all characters is too
long. It is necessary to add the characters that need to be modified.

Delete Deletes the selected codec.

Import Adds a new codec file type to the list of existing codecs. The following codec file
types can be imported:

CDC

TXT

CNV (for version 4.5 or later)

Define New Adds a new codec using a unicode mapping table (in the UCM format). This
way you can easily adjust your text encoding directly in Inspire Designer without any further
conversion. E.g. you can map characters above 65535 (Unicode) or map characters with
the same code in different font extension files.

The UCM files can be further converted to CNV files which Inspire Designer loads using
the Import icon above. However, using the Define New icon you can avoid this
conversion and create/load UCM files directly.

In the opened dialog you can create a unicode mapping table that contains text encoding
according to your needs. You can either create it from the scratch or load it from a file
using the Load icon.

The table has to be in the valid format, for details see http://userguide.icu-project.org/con-
version/data#TOC-.ucm-File-Format. The format is validated when saving the table using

1562
 14.13 Text Encoding

the Save As icon, showing errors using the Show/Hide Errors icon or confirming
the dialog.

Note Text encodings created with the help of this feature cannot be based on other
text encodings. Thus, the key <icu:base> is not supported in the unicode mapping tables
used in Inspire Designer.

Tip If there is a user defined text encoding used in Data Input, it can either be saved in the
WFD file or be opened as an external file. If the codec is saved in the WFD file, it does not appear
in the list of used files. The codec can be exported later or changed.

14.13.1 Editing Single-byte Encoding Types

If a single-byte ASCII or single-byte EBDCIC encoding type has been selected or imported, the
following dialog is displayed after clicking on the Edit button.

Options Description

Input Displays the decimal and hexadecimal values in the codec.

Unicode Specifies the Unicode values for the appropriate byte values.

Character Displays the character that is assigned to the input values.

To change the specific character either click on the button or press the <F2> key and
enter the character you want to be shown as a result.

Load Loads another codec and overwrites the current codec with it.

Save Saves the currently defined set of characters into a CDC file.

1563
14 Global Features

14.13.2 Editing Double-byte or Mixed-byte

Encoding Types
If a double-byte or mixed-byte encoding type has been selected or imported, the following
dialog is displayed after clicking on the Edit button.

Options Description

Base Codec Shows the codec upon which the custom defined encoding is based. In the
bottom part of the dialog it is possible to specify modifications or exceptions to this codec.

Default byte type Specifies how the base codec is treated:

All single-byte All input values are treated as single-byte values.

0-7F single-byte, 80-FF double-byte Input values from 0 to 127 are treated as
single-byte values, values from 128 to 255 as double-byte values.

All double-byte All input values are treated as double-byte values.

Beg Sets the input value from which the change is applied. By clicking on the appropriate
radio button select whether the input value is single-byte or double-byte. See the example
below.

End Sets the number of the input character up to which the change is applied. By clicking
on the appropriate radio button select whether the input value is single-byte or double-
byte. See the example below.

Map to Sets the starting value of the new range where the range specified by the Beg and
End fields will be mapped to. By clicking on the appropriate radio button select whether
the input value is single-byte or double-byte. See the example below.

Add Opens the Edit codec rule dialog which enables creating a codec rule:

1564
 14.13 Text Encoding

In the Beg and End fields you specify the range of input values that should be changed.
In the Map To field you specify the starting value (a value that will be assigned to the first
value in the specified range). For example, double-byte values from 0001 to 0002 will be
mapped to double-byte values starting with 0010. That means that the value 0001 will
be mapped to 0010 and 0002 will be mapped to 0011.

Delete Deletes the selected codec rule.

Edit Opens the Edit codec rule dialog where you can change the rules created before. For a
description of this dialog, see the Add button description just above.

Load Loads another codec and overwrites the current codec with it.

Save Saves the currently defined set of characters into a CDC file.

The text encoding feature occurs in several dialogs throughout the Inspire Designer GUI. The
name of the Encoding drop-down box varies (other variants: Text Encoding, File Codec,
Text Codec) throughout the Inspire Designer GUI but the function is the same. This feature
can be found as a part of the following dialogs:

Data Input Module

XML Data Input Module

SAP Data Input

Data Output

Job Reporter Module

Sheet Statistic Module

AFP Engine Configuration

Barcodes

MIBF Engine Configuration

14.13.3 Setting Up Custom Text Encoding For

Data Input
Using the text encoding dialog it is possible to define a custom encoding that is based on an
already existing encoding. You can clone all single-byte ASCII, single-byte EBDCIC, double-byte
and mixed-byte encoding types. Follow the steps below in order to create a new user defined
encoding:

1. Select a text codec Select the base encoding that you want to use as a template.

2. Clone the text codec Click on the Clone button and enter a name for the newly
created custom codec.

3. Edit the user defined text codec Click on the Edit button to change the settings. The
editing options depend on the encoding type.

1565
14 Global Features

4. Save and load the text codec Click on the Save button to save the currently defined
set of characters into the Codec Definition File format (CDC). To load a saved CDC file
click either on the Load button in the Edit Codec dialog or on the Import button in
the Edit Codec dialog.

5. If you use the Import button for loading a file saved on your computer, after selecting
the file to be loaded and confirming the action in the Open dialog, a message offering
the possibility to open the codec as an external one will appear. Clicking on the Yes
button will save the link to the file saved on your computer. If you click on the No
button, the file will be included into the workflow.

If you choose to open a codec file from an external location, its path is displayed in the
list of available codecs. The path can be either absolute or relative. Clicking on the Edit
button when a custom external codec is selected opens a dialog enabling to change
the file.

Note The option Open as external codec is only applicable to CDC and CNV files. It does
not apply to PrintNet 3 fontmaps.

Note The external codec will not appear in the Used files list, however, it can be added
manually.

14.13.4 File Structure of an Exported Codec

Below there is a sample of the binary format of a single-byte codec. The description is useful
for users who want to edit a codec manually without using the Inspire Designer text encoding
dialog.

1566
 14.14 Title Bar Menu

14.13.4.1 Header

Length Content Meaning

4 bytes TCDC Identifier of the file

1 byte 1 Version
1 byte 0 Type: 0 single-byte

14.13.4.2 Character Replacement Table

Length Meaning

256 x 2 bytes = 512 256 Unicode values (each 2 bytes long), in Little endian format.
bytes
Unicode character set for the appropriate position in the custom
encoding.

I.e., there are 256 double-byte values; each of them specifies one
Unicode character.

While converting the data file, each character (byte) coming from
the data file is "translated" using this Unicode character table.

Example A data-file byte with (decimal) value of 21 will be

replaced by the 21st double-byte Unicode character (from the
256 double-byte character replacement table).

In our case, the Unicode character is computed from the 49th

and 50th bytes values of the codec definition file (6 header
length + 212 = 48).

Total length = 518 bytes

14.14 Title Bar Menu

Right-clicking on the title bar of which ever environment, window or dialog, reveals the Title
Bar context-menu.

1567
14 Global Features

Options Description

Restore If the window or dialog has been maximized, returns it to its previous size.

Minimize Reduces the window or dialog so that it only appears on the operating system
taskbar.

Maximize Increases the window or dialog in size, so that it fills the screen of the monitor.

Reset Environment Sets the size, position and visibility of the various menus, window-panes
or panels back to their original default settings, i.e. ignoring any previously saved environ-
ment.

However, should you close and re-open Inspire Designer then the last saved environment
will be restored.

Select Language Reveals a further menu, to the right, which allows you to choose a language
for the GUI.

The menu will only show languages that are available to your installation of Inspire Designer.

Start Recording Starts recording for the Video Capture feature.

Not available if recording has previously been started.

Stop Recording Stops recording for the Video Capture feature.

Only available if recording has previously been started.

Close Closes the window or dialog.

You will be prompted to save any unsaved workflows.

14.15 Video Capture Feature

In this section:
Recording Your Work
Playing a Recording
Player Description

You can visually capture any Inspire Designer or Inspire Content Manager Explorer (VCS Explorer)
activity (e.g. cursor movements, menu selections, pop-up windows, typing) with the Inspire De-
signer recording feature. This is an excellent way to communicate with other Inspire Designer
users, because you can:

Create a video showing how something should be done, when training other users.

Record your work for someone troubleshooting an issue for you.

Inspire Designer saves the recorded activity to a CMR file. This file can be played using the
Player.exe installed along with Inspire Designer.

1568
 14.15 Video Capture Feature

14.15.1 Recording Your Work

To record your work, choose one of the following:

Keyboard Shortcut

1. Press <Scroll Lock> and <Space> simultaneously.

2. Do the work you wish to record.

3. Press <Scroll Lock> and <Space> simultaneously to end the recording.

Note Some keyboards do not have an independent <Scroll Lock> key (e.g. some
HP laptops require that you press <Fn> and <F11> to replicate the <Scroll Lock>).
You should consult your hardware documentation if this feature does not work.

Title Bar Context-Menu

1. Right-click on any window/dialog title bar and select Start Recording.

2. Do the work you wish to record.

3. Right-click on the window/dialog's title bar and select Stop Recording.

The video file will be saved in the MyDocuments/CMRs directory under a file name consisting
of the exact date and time when the file was created, i.e. %USERPROFILE%/MyDocuments/CM-
Rs/yyyyMMddhhmmss.cmr.

Example If the CMR file was created on 1st August 2011 at 08:49:45, the file name
will be 20110801084945.cmr.

It can be useful to rename the file according to the feature or issue you have recorded.

Note In the Mac version of Inspire Designer:

The Start/Stop Recording option is available in the menu displayed by right-clicking

on the window toolbar.

The native Open dialog is not visible in the recorded video. Use the applications custom
dialog instead.

Tip If your system sounds are turned on, you should hear a sound at the beginning/end of
your recording.

14.15.2 Playing a Recording

To play a recording, do the following:

1. Run the file Player.exe which is located in the directory where Inspire Designer was in-
stalled.

2. Go to File | Open to select the CMR file that you wish to play. You can also select
directly the CMR files last viewed.

1569
14 Global Features

3. Select the play rate (Play, Play Half Rate, Play Double Rate, Play Quadruple Rate)
in the Play menu to play the selected CMR file, or click on one of the icons
at the bottom of the window.

14.15.3 Player Description

14.15.3.1 File Menu

Options Description

Open Opens the Open dialog where you can browse for a file that you want to play.

Close Closes the CMR file that has been opened in the Player.

Recent Files Displays the last CMR files that have been played.

Note The Recent Files option name is visible in the File menu only if no CMR files have
been played in the Player before. Otherwise the file names will be displayed instead.

Exit Closes the Player.

1570
 14.15 Video Capture Feature

14.15.3.2 Play Menu

Options Description

Play / Play Half Rate / Play Double Rate / Play Quadruple Rate Plays the CMR file at
the original, or other selected, rate.

Alternatively, you can click on one of the icons: .

Pause Pauses the CMR file.

Alternatively you can click on the icon .

To continue playing select one of the Play options described above.

Stop Stops the CMR file.

Alternatively you can click on the icon .

The icon enables you to change the video focus to show the whole recorded window.

Example The upper screenshot shows the resulting display focus when the icon is
used.

The lower screenshot shows the resulting display focus when the icon is not used.

1571
14 Global Features

14.16 Warnings
In this section: See also:
Warnings Config Dialog Metacode White Processing Error
Warnings/Errors Behavior How to Use Error Recovery

Warning Config dialog lists all messages that get displayed in the Proof or Production Log
window-pane. In this dialog you can edit their level of severity (if they lead to job abortion or
not) and logging status (when they appear).

14.16.1 Warnings Config Dialog

To display the Warnings Config dialog, you can choose one of the following ways:

In the Main Production window click on the Warnings button.

In the Proof windows click on the Edit Warnings icon or select Edit Warning
Config from the Proof window menu.

In the Proof or Production Log window-pane right-click on the message line and select
Edit Warning Config. This way the Warnings Config dialog will open and also highlight
the message selected in the Log window-pane.

The Warnings configuration window displays.

1572
 14.16 Warnings

The status of messages in italics is set to Default in the Abort field and to Always in the
Warning field and cannot be modified.

Options Description

Code Gives a unique identification number for the warning message.

Message Shows the text of the warning.

If the text is shown in italic type face, it is a critical error and Abort or Warning cannot
be set.

Abort Selects the level of severity of the warning or error:

Default The severity of the error/warning will be set according to rules defined
as the default.

Abort When the error/warning occurs, the production job will be aborted.

Ignore When the error/warning occurs, the job will not be aborted but processing
will continue.

For errors: This selection is required when using the Use error recovering option
of the Data Layout Properties in the Layout module and you do not want the job
to be aborted for an error, but instead to log the error to the TXT file.

Recoverable When an error with this severity occurs, the production job will be
aborted.

For warnings: This selection is required when using the Use error recovering
option of the Data Layout Properties in the Layout module and you do not want
the job to be aborted for a warning, but instead to log the warning to the TXT file.

This option is specifically for job recovery with the IPDS engine which spools the
job directly to a printer for live production.

1573
14 Global Features

For the complete list of Severity and Abort values and the resulting behavior see the
Warnings/Errors Behavior section below.

Warning Selects the logging status for when the warnings will appear in the Log window-
pane:

Always The message is always appended to the log when the error/warning occurs.

Once The message is appended to the log the 1st time the error/warning occurs,
but not logged on subsequent occasions.

Never The message is not appended to the log when the error/warning occurs.

Note Avoid selecting Never when Abort is set to Abort. If it is set to Never, the
job will be aborted but you will get no information about the cause.

Load Loads a previously saved warning config (WPR) file.

Save Saves the warning config as a WPR file so that it can be shared, for example, with
other installations of Inspire Designer or called from the Inspire Production Console.

Save as default Saves the current setting as default.

Reset Sets the Abort field to Default and the Warning field to Always for all messages.

Ignore all Sets the Abort field to Ignore for all messages.

Sort by code Sorts the messages according to the code number.

Sort by text Sorts the messages alphabetically.

File logging If checked, messages informing the user about external files opened for a given
job are logged in the Proof/Production Log window-pane. There are no log messages for
fonts and for script files opened in the Script Library.

Enable this option before generating split files, to be able to open individual documents
directly from the Log window-pane.

Image logging If checked, messages about loaded images (path, color space, size, DPI and
if they have been loaded natively) and their color space conversions where ICC profiles
are used are logged in the Proof/Production Log window-pane. Hovering the mouse-
pointer over an image entry in the log, shows a preview of the indicated image in the
state the log-message informs about.

Note In Vector Proof, when changing the display (resizing the window, zooming in/out
or selecting another page of the proofed document), the document is re-proofed, but the
previously displayed image log-messages are not shown, as the image is re-loaded from
cache and no further processing is done. To display them, exit the Proof window and proof

1574
 14.16 Warnings

the workflow again or right-click on the log window-pane to select Edit Warning Config
(and make sure the Image logging option is enabled).

14.16.2 Warnings/Errors Behavior

The table below lists all combinations of settings for warnings and errors in the Abort column
of the Warnings Config dialog and the error recovery functionality usage and specifies the
result, i.e. if the warning/error with the specific settings ends as a warning, as a recovered error,
or if it aborts the job.

Warning/Error In Error Abort Settings Severity Result

Recovery Displayed in
Log
window-pane

Warning No Default Warning Warning

Ignore
Recoverable
Abort Critical error Abort job
Yes Default Warning Warning
Ignore
Recoverable Recoverable er- Recovered er-
ror ror
Abort Critical error Abort job
Error No Default Fatal error Abort job
Ignore Recoverable er- Ignored error,
ror behaves like
warning
Recoverable Fatal error Abort job
Abort Critical error
Yes Default Fatal error Abort job
Ignore Recoverable er- Recovered er-
ror ror
Recoverable Fatal error Abort job
Abort Critical error

Table 14.1 Results of Warnings and Errors with Different Abort and Error Recovery Settings

The entries in the table shown in bold indicate the Abort settings if you want to mark the
warning/error for error recovery.

'Recovered error' means that the record, for which the warning or error has been issued and
error recovery has been applied, is not printed. In case that the Use error recovery is enabled
in the Data family Layout Properties and the Error file name is specified, the records that need
fixing are listed in the file. Otherwise, if error recovery is used in XML Data Input or Data

1575
14 Global Features

Transformer modules and no settings are made in Layout, values of the Boolean variables used
for detecting error recovery in the modules have the true value for the records. For more in-
formation see the How to Use Error Recovery section.

14.17 White Processing

The White processing option can be found in the settings for raster engine configurations
and raster proof profiles. It defines if the colors of text and images should be printed over any
background or if the background should be cut out where any text or images are to be printed,
in order to maintain color integrity. Backgrounds are objects that are lower in the Z-order.

Options Description

White processing Select from:

Yes Determines that corresponding parts of background layers (where text, images
etc. are to be printed) are not printed.

Example Final print 1st layer 2nd layer:

Note If using spot colors and Mix spot color is selected on the Color dialog for
any color used in the foreground (higher in the Z-order) then white processing will
not be applied where that color is used.

No Overwrites the background.

No cutting is made in the background layer for any objects in the foreground. Re-
commended for black text.

Example Final print 1st layer 2nd layer:

This is dependent on the formation of overlays during processing: Static objects

are grouped into overlays and, depending on how the overlays are created, it may
happen that white processing appears to have been applied because two or more
overlapping objects have already been merged into a single overlay. Different
static objects are merged into overlays according to differing options that can be
set as part of an engine configuration.

1576
 14.18 Workspaces

Example We can demonstrate this exception by comparing variable text

and static text used in flow areas that are placed over a filled rectangle:

If White processing is set to No and Merge static objects into overlay is

checked for the Raster engine configuration.

The cut-out is not made for variable text, i.e. white processing does not
happen:

In this case, the text will be printed over the background in the next step.

The static text has already been merged with its background to create a
single overlay, i.e. white processing is not applicable:

In this case, the text has already been painted as part of an image in the
overlay.

As another example of the effect of overlay creation, if a static object is in

between two variable objects in the Z-order then it is not merged with another
static object and in this case No has its intended effect.

Auto Determines that parts of the background layer, where text and images are
to be printed, is only not printed if required, e.g. it is not necessary to cut any white
image content under text.

Text Determines that parts of the background layer (only where text is to be
printed) is not printed.

Note White processing makes spooling considerably slower, because each resource is
saved as a separate image.

14.18 Workspaces
In this section: See also:
Manage Workspaces Dialog Workspace Command Line Parameters
Select Workspace Dialog
Paths to the Workspace

A workspace is a set of default directories that are used by Inspire Designer to store resources
that it uses, e.g. workflows, data input files, images and fonts. Using this feature you can also
set the paths for resources using variables.

1577
14 Global Features

Workspaces can be used for better organization. There can be several workspaces and a user
selects the workspace depending on the workflow. For example, for one set of workflows
(when there is a set for each customer) it is possible to define a workspace and then save it as
an XML file. Then you can load this workspace definition to all the installations of Inspire De-
signer that will work with that set of workflows so that they all use the same folders. This
avoids mixing of non-related workflows, data input files, fonts etc. in a single directory.

It is also possible to share workspaces across users via Inspire Content Manager (VCS) while
storing the configurations on a server.

Typical use cases:

To establish a set of resource directories across an internal network.

A workflow is designed in one location and Production will be run in another and
therefore the paths differ and yet you do not want to include files in to workflow.

In this case, a variable would be used as the path to the resource by the workflow and
the real value of the path will be determined by selecting a new workspace in Inspire De-
signer before running Production.

For changing directories more simply using the Inspire Production Console.

14.18.1 Manage Workspaces Dialog

In the Workflow Window menu go to File | Manage Workspaces and the Manage Workspaces
dialog opens:

Options Description

Workspace Lists the defined workspaces.

1578
 14.18 Workspaces

Workspace Auto exists by default and saves the last directories that were used. For example,
when opening a workflow the directory that is shown in the Open dialog is the same dir-
ectory as was used the last time that a workflow was opened.

Create New Creates a new workspace.

Delete Deletes the selected workspace.

Open Imports a previously saved workspace.

Save Saves the selected workspace as a separate XML file.

Workflows Selects a directory for WFD and XML files (workflows can be exported as XML
files).

For example, it is used when File | Open Workflow is selected from the Workflow Window
menu.

External Selects a directory for external workflows and workflows from which external objects
are used.

For example, it is used when opening an External workflow from the External Workflow
module or when using the option Insert | Insert External Object from the Layout Window
menu.

Data Inputs Selects a directory for data files.

For example, it is used when opening an Input file from the Data Input module or XML
Data Input module.

Production Selects a directory for production configuration (JOB) files.

For example, it is used when selecting Production | Save Production Configuration

from the Production Window menu.

Other Selects a directory for XSD, DTD and FCV configurations.

For example, it is used when using the Read button in the XML Data Input module.

Images Selects a directory for images.

For example, it is used when selecting Insert | Insert Image from the Layout Window
menu.

Fonts Selects a directory for fonts.

For example, it is used when selecting Insert | Insert Font from the Layout Window menu.

Display system fonts If checked, the system fonts of the computer are shown in the Font
combo-box of the Text Format toolbar in Layout.

Workspace Fonts Lists the Workspace Font directories.

1579
14 Global Features

Workspace fonts are shown in the Font combo-box of the Text Format toolbar in Layout.

Create New Adds a new workspace font directory.

The number of directories is limitless.

Delete Deletes the selected directory.

Comment Enables you to enter a comment for each workspace.

This comment shows as a tool tip in the Select Workspace dialog.

14.18.2 Select Workspace Dialog

The Select Workspace dialog determines the workspace that Inspire Designer will use. To select
a workspace:

1. From the Workflow Window menu go to File | Select Workspace to open the dialog.

2. Select from the predefined workspaces.

Any Comment that has been entered in the Manage Workspaces dialog shows when you hold
your mouse pointer over a workspace name.

14.18.3 Mapped Directories

14.18.3.1 Paths to the Workspace
In certain cases when creating a workflow or using production, it is needed to describe a path
to resources or a directory to store produced files in. When a workspace has been defined it
can be used as the central reference point for these paths, i.e. a set of directories can be decided,
then a workspace created for those directories and then paths that refer to that workspace
can be used throughout Inspire Designer.

In the following table, the paths to the currently selected workspace are listed. The actual value
for the path used by Inspire Designer is then the one described in the Manage Workspaces
dialog or by a command line parameter.

Mapping Entry Description

map://workflow/ The path to the Workflow directory of the workspace.

map://external/ The path to the External directory of the workspace.
map://data/ The path to the Data directory of the workspace.

1580
 14.18 Workspaces

Mapping Entry Description

map://produc- The path to the Production directory of the workspace.

tion/
map://other/ The path to the Other directory of the workspace.
map://images/ The path to the Images directory of the workspace, e.g. used as a value
by the variable selected in the Variable combo-box of Variable Images.
map://fonts/ The path to the Fonts directory of the workspace, e.g. used as font loca-
tion when changing the font in the script of a variable formatted flow.

A common use for the paths is from a script that has been written for some function of the
workflow, but variables can also be made to return the path so that, for example, a different
path is used for each record of a database.

A common use for path-returning variables is for variable images.

Example How to Map a Workspace for Variable Images

In the following example we want to have an image in our design that will change each
time that a new workspace is selected in the Select Workspace dialog:

1. Create a new variable: Right-click on the Data family in the Layout Tree and select
Insert Variable.

2. Give the variable a name, e.g. ImageDirectory.

3. Open the variable's Layout Properties, go to the Type tab and fill in the Value
field with the path to the workspace's Images directory and the image itself, e.g.
map://images/test.jpg.

If the Images workspace directory has not been specified, then, when the work-
flow is processed, a warning message will appear saying that the image has not
been found.

4. Create a Variable image: Right-click on the Images family in the Layout Tree and
select Insert Variable Image.

1581
14 Global Features

5. Open its Layout Properties and go to the Image tab. Select the variable you have
just created in the Variable combo-box.

6. Manage the workspace, i.e. define the directory from which the picture is to be
taken:

If using the Inspire Designer GUI:

Create a new workspace and set the path to the desired directory in the Im-
ages field like in the Manage Workspace dialog. Then select the created
workspace in the Select Workspace dialog.

If using command line Inspire Production Console (PNetTC) or Inspire Produc-

tion Server Console Client (PNetTCNetClient):

Set the directory from which the images are to be taken when spooling the
job.

E.g.,
c:\PNetTC.exe c:\filename.wfd -e PDF wsmimages c:\images\

or,
c:\PNetTCNetClient.exe s ip_netserver c:\filename.wfd -e PDF
wsmimages c:\images\

Alternatively, the path-returning variable created in steps 1 to 3 could be from a data file
that is read in to the workflow, in which case the image could be changed with each record
in that data file.

14.18.3.2 Paths to Other Directories

There are also additional possibilities to use mapped directories apart from workspaces.

The ones below are not connected to workspaces and the Manage Workspaces Dialog. They
can be used throughout Inspire Designer, whereever a path can be entered (e.g. map://out-
put/test.jpg could be used in the example above for an image from the Inspire Designer install-
ation directory) and also in scripting (e.g. as aLocation parameter of many methods).

1582
 14.18 Workspaces

Mapping Entry Description

map://temp/ Returns the path to the OS temp directory, e.g. c:\Users\user

name\AppData\Local\Temp on Windows (as defined by the environ-
ment variables TEMP, TMP) or /tmp on UNIX systems.

Note If you run Inspire Production Server with the -tempdir parameter,
then it will return the path to the directory specified by the parameter.

For Inspire Designer you can specify the path to the temp directory by the
option Temporary directory in General Options dialog.
map://sysfonts/ For Windows (common usage), it returns the path to the system
font directory, i.e. c:\Windows\Fonts.

For Mac, it returns the path to the system font directory, i.e.
/System/Library/Fonts, which is one of the font directories
available. However, the other ones (/Library/Fonts,
<homedir>/Library/Fonts and /Network/Lib
rary/Fonts) are not considered when the mapping entry is
used.

For other UNIX systems the CX_DATA directory is returned, or the

Inspire Designer directory.

Note If CX_FONT_DIRECTORY environment variable was set, then it

would return the directory set in it (on all platforms).
map://wfd/ Returns the path to the directory where the WFD file with map://wfd/
used is located (only the path, not the WFD file name).
map://output/ Returns the path to the directory from which the application (Inspire De-
signer or a related application) has been run.

Example If you ran Inspire Designer from the default installation

directory and open a WFD with map://output/ used in the script, the
returned path would be c:\Program Files\GMC\Inspire De
signer.

If you ran Inspire Designer using a desktop or Taskbar shortcut, the

returned path would be the one from the Start in edit-box of the
shortcut.

Please note that for WFD files associated with Inspire Designer it will return
the path to the directory where the WFD file is located (and not to the
directory of the associated Inspire Designer application).

Note If you run Inspire Production Server with the -dir parameter,
then it will return the path to the directory specified by the parameter.

1583
15 Projects

15.1 Projects Overview

15.2 Workflows
15.3 Public Objects
15.4 Resolving Conflicts
15 Projects

In this section
Projects Overview
Workflows
Public Objects
Resolving Conflicts

Files that are linked together by a common purpose can be joined in projects. The project en-
vironment in Inspire Designer is managed via a dedicated window where you can work on and
share not only whole WFD files but also parts of your workflows, such as modules or layout
objects.

Projects in Inspire Designer bring the following advantages:

more people can edit one workflow at a time

modules and layout objects with all their settings can be shared among workflows

when editing more workflows simultaneously in a single instance of Inspire Designer,

all changes to shared modules made in one workflow are instantly visible in all other
workflows where these shared modules are used

15.1 Projects Overview

15.1.1 Working with a Project
To start working with projects:

1. Select the option File | Show Project Browser in the Workflow window menu. This
opens the Project Browser window, where you can:

Create a new project. In the Project Browser, go to menu File | New Project. In
the Save As dialog save the project under a name of your choice. The newly created
project is automatically selected in the Project combo-box and is ready for editing.

Open an existing project via the menu option File | Open Project or select one of
the previously used in the Project combo-box. You can also drag and drop a
pnettwsp folder into a Inspire Designer window.

Before you start, update the content of the project by clicking on the Update
button.

Projects are saved in the specified destination as folders (projectname.pnettwsp) con-

taining meta files. However, if you browse the project folders in the Open File dialog
from Inspire Designer, regular and openable WFD files will appear.

1586
 15.1 Projects Overview

The project files and public objects can be accessed and modified by anyone who is
entitled to access and modify the directory where the project is stored there is no
rights management. In this way more people can work on one workflow at a time.

2. Once the project is open, you can work with your WFD files. If it is useful to have the
same modules or layout objects in more workflows they can be made public and shared
among workflows within the project. Then, you only need to change your public object
once in one workflow without having to change it in all workflows.

After editing it is necessary to commit the changes (by clicking on the Commit button)
so that they are available for other project users. If there are conflicts with commits
from other users you will be alerted and you can resolve these conflicts.

Tip Changes are indicated by an exclamation mark added to the file and folder
icons.

Example The following example presents a basic procedure: there are two users, two
different workflows and one public object.

1. User A opens the Project Browser and creates a new project. In this project he
opens Workflow1 a letter. In the Layout module he inserts a company logo into
layout and makes the object public. Afterwards he saves the workflow and commits
the changes.

2. User B opens the same project but creates another workflow (Workflow2). This
is a document for the same client so she wants to use the logo previously made
public by her colleague. She adds a Layout module and inserts the logo as a
public object to the layout. She also edits Workflow1 adding one paragraph to
the letter. Then she saves both workflows and commits the changes.

3. User A wants to continue working on Workflow1 but before he starts he updates

the project to apply the changes committed by user B.

4. User A receives an updated logo from the customer and changes it in Workflow1.
It is not necessary to change it also in Workflow2 as the logo is a public object.

15.1.2 Project Browser Window Overview

The Project Browser window gives you an overview of files and public objects belonging to
each project. You can switch among projects using the Projects combo-box.

Project files are organized in a tree structure of folders and subfolders displayed in the left-
hand section of the window. The content of each folder is revealed, after it has been selected,
in the right-hand section of the window.

The window has three tabs: Files for workflow files management, Public Objects and Conflicts
for resolving conflicted commits. The Status bar at the bottom of the window provides inform-
ation on the status of the project.

1587
15 Projects

Legend

1. The Project Browser window menu.

2. A path to the currently open project. You can select a different project in this combo-
box. Buttons Commit, Update, Revert and Show Changes have the same function
as the menu items bearing the same name.

3. The folder tree enabling you to browse the project structure.

4. This section of the window displays the content of the folder selected in the tree.

5. The status bar provides information about the current status of the project.

For the description of the Public Objects and Conflicts tabs see the respective sections.

15.1.3 Project Browser Window Menu

There are three Project Browser window menus: File, Edit and Help.

15.1.3.1 File Menu

New Project Opens the Save As dialog where you can save a new project in the directory
of your choice.

Shortcut: <Ctrl>+<N>

Open Project Opens the Select folder dialog where you can browse for the project folder
you want to open.

Shortcut: <Ctrl>+<Shift>+<O>

1588
 15.1 Projects Overview

Commit Commits all changes made within the project. First the Commit History Info dialog
pops up where you can add a comment to the commit which can later be checked via
File | History. Thereafter a list of committed changes is displayed.

Changes are indicated by an exclamation mark added to the file and folder icons.

Update Updates the project (i.e. downloads changes committed by other users).

Revert Reverts all changes you have made since the last commit.

Show Changes Displays the Precommit Changes Info dialog which lists all public objects
and files that have been added or modified since the last commit. In the dialog it is also
possible to revert any of the individual changes.

History Shows the complete history of the project as a list of all commits. It is possible to
display detailed info for each commit (click on the Show Details button).

Sanity Check Checks the validity of all commits and lists files with invalid checksums.

Export Project Exports the current commit as a new project. Specify its name and location
in the Save As dialog that appears.

Shortcut: <Ctrl>+<E>

Open Shows the Open dialog where you can browse for WFD files that you want to open
in the project. Files can also be dragged and dropped into the Project Browser window.

Shortcut: <Ctrl>+<O>

Show Proof Opens the empty Proof window from where you can preview Inspire Designer
output.

Show Production Opens the empty Production window from where you can control In-
spire Designer output.

Inspire Content Manager These options are related to Inspire Content Manager. See the
Workflow Window Menu section for explanation of these options.

Exit Browser Closes the Project Browser window.

15.1.3.2 Edit Menu

Before Commit Script Enables you to enter a script that is executed right before you commit
your changes (after the intended commit is confirmed).

Example The script can be used for checking if files of undesired types (images in
this example) are not committed.
Util.StringIntMap invalidFileTypes;
invalidFileTypes["jpg"]=1;
invalidFileTypes["tiff"]=1;
invalidFileTypes["png"]=1;

Int cnt=ChangesCount;
String invalidFiles;

1589
15 Projects

for(Int i=0; i<ChangesCount; i++)

{
if(ChangeType[i]!=ChangeEnum.NewFile) continue;
String fileName=ChangeDetail[i];
Int pos=fileName.findBackwards('.');
if(pos!=-1)
{
fileName=fileName.mid(pos+1);
fileName.makeLowerCase();
if(invalidFileTypes.contains(fileName))
invalidFiles+="<p>"+ChangeDetail[i];
}
}
if(not invalidFiles.isEmpty())
{
logError("Do not insert image files into project: "+invalidFiles);
}

After Commit Script Enables you to enter a script that is executed immediately after your
changes are committed.

Example The script can be used for inserting information about the commit to a
database.
String connect="DATABASE=test;DSN=local_mysql_test;OP
TION=0;PWD=test;PORT=0;SERVER=127.0.0.1;UID=test";

ODBC.Database db;
db.connect(connect);
if(db.isError())
logError("Database connection error: "+db.Error);
String insert='INSERT INTO test (text) VALUES ("';

//write desired log content

String log="User: "+User;
log.append(" commited his changes");

insert.append(log);
insert.append('");');
db.execute(insert);
if(db.isError())
logError("Database insert error: "+db.Error);

15.1.3.3 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

Getting Started Opens the Getting Started guide, which offers a step-by-step introduction
to Inspire Designer.

About Displays the version number of Inspire Designer.

1590
 15.2 Workflows

15.1.4 Status Bar

The status bar at the bottom of the window provides information about the status of the project.

Modified Indicates, whether you have made any changes to the project since the last commit
(the displayed value is ether Yes or No). You can either commit or revert these changes.

Commit Id Displays the ID of the current commit.

Updates Indicates whether there are changes to the project that have been committed by
another user (the name of the user is displayed). Click Update to apply the changes.

U Shows the logged user. If Inspire Content Manager (VCS) is running, the user logged to
Inspire Content Manager is displayed. Otherwise the user logged to the system is shown.

15.2 Workflows
Workflow files (or other file types) are managed on the Files tab that provides the user the
complete overview of the projects structure. It displays all workflow files (WFD) that are included
in the project.

On this tab you can:

create new workflow files

open existing workflow files

edit workflow files

make parts of workflow files public or use other public objects

find out what public objects are used in workflow files

check the history of the project and its files

15.2.1 Working with Workflows

The usual procedure of working with WFD files will have the following pattern:

1. Before you start working make sure the project is up-to-date. Any changes made by
other users would be indicated on the status bar (Updates) by the name of the user
who made the last commit.

2. Browse through the tree to locate the workflow file you wish to work with. It can be
opened by double-clicking.

3. Now you can edit your workflow. You can also make modules or layout objects in the
workflow files public and/or modify them. See the section Public Objects for details.

1591
15 Projects

4. Save the workflow. (Workflow files where changes have been made but have not been
saved yet are marked with an asterisk next to their name on the tab at the bottom of
the application window).

5. After making your modifications go back to the Project Browser window and commit
your changes so that they are accessible by other users. (Changes are indicated by an
exclamation mark added to the file and folder icons.)

15.2.2 Files Tab Context Menu

Context Menu of a Folder
Create Workflow Opens the Create New Workflow dialog where you can name the newly
created workflow. It is automatically saved in the project folder.

Create Folder Adds a new folder to the tree.

Add Folder Imports an existing folder to the tree. The folder can be browsed for in the Add
Folder dialog that appears. It is possible to select if also subfolders should be imported.

Add Files Enables you to add a new file to the folder via the Open dialog.

Copy Copies the folder into the selected location.

Rename Enables you to rename the folder. The folder can also be moved to a different pos-
ition with the possibility to overwrite an existing folder.

Remove Deletes the selected folder.

Context Menu of a File

Open File Opens the selected file.

Copy Copies the file into the selected location. Files can also be copied by dragging and
dropping.

Rename Renames the selected file.

Remove Deletes the selected file.

History Shows the History dialog for the selected file.

Find Usage Opens the File Usage dialog which lists all workflow files and public objects
where the selected file is used.

Show Used Objects Shows the Used Objects dialog which lists all public and external objects
used in the workflow file.

1592
 15.2 Workflows

Approve or Comment Enables you to tag the object as approved and add a comment to
the approval. The status Approved is bound up with the value of the object, meaning that
if the object is changed, the status Approved is dropped.

15.2.3 File History

The History dialog lists all commits (their IDs) where changes have been made to the file.

Options Description

Commit Id Displays the ID of the commit in which the change has been submitted.

User Displays the name of the user who submitted the commit.

Value Displays the identifier of the respective commit.

Approval The expression 'Approved' appears in this column if the file has been tagged so
using the Approve or Comment context menu option.

Comment Indicates, if the file comment was changed in that revision.

15.2.4 Inspire Content Manager

You can work on your project also via Inspire Content Manager (Version Control System). Export
the project to Inspire Content Manager by using the menu option File | Export Project and
specifying an Inspire Content Manager location in the Save As dialog. In the Inspire Content
Manager Explorer (VCS Client Explorer) go to the Options Dialog (File | Options Dialog) and
check the Evaluate project option. Then you can browse the content of the project regular
WFD files are visible and openable.

1593
15 Projects

15.3 Public Objects

Public objects are objects that can be shared together with their settings by multiple workflows.
It can be a module or just a layout object (image, text style, etc.). As the object is shared it
changes simultaneously in all workflows where it is used, which ensures consistency across
workflows within the whole project.

Public objects are managed on the Public Objects tab.

15.3.1 Creating Public Objects

To make an object public:

1. Select a module in the Workflow window or an objects node in the Layout Tree. Bear
in mind that making objects public is possible only in workflows that are saved in a
project.

2. In the right-click menu select the option Make Module Public in case of a module or
Make Node Public in case of a layout object.

3. In the dialog that appears (in fact the Public Object tab) select the folder where you
want to place the public object and name the object. You can also rewrite an existing
public object by this new one. After clicking OK, the object is available for public use.

Now you can use this object in any other workflow within the given project. Just right-click in
the Workflow window to add a module (option Insert Public Module) or on a node in the
Layout Tree under which you want to insert a layout object (option Insert Public Node).

Things to remember when inserting public objects into layout:

A public object can be present just once in a Layout Tree node. If you want, for example,
to have the same public object twice on a page, place one of them into an object group.

A public object is saved with all other necessary nodes (e.g. fill styles) and their paths.
When it is inserted into another layout all its dependant nodes will keep the paths they
had in the original layout. For example, if the fill style used by a public object has the
path FillStyles/MyFillStyles/BlackFill it will always have the same path in the new layout
(if this path does not exist, it will be created).

Variables used in a public object are saved as disconnected. When the public object is
used in another layout, the variables try to map to the present data structure (their

1594
 15.3 Public Objects

saved data structure is compared with the data structure of the layout). If mapping is
unsuccessful, a warning is logged.

If properties of a variable are modified in layout and this variable is a part of a public
object, this conversion is applied to the mapped variable in the layout where the public
object is inserted. If the mapped variable already has its own conversion defined, it is
overwritten.

Modifying Public Objects

Public objects (including all other objects used by the public object, e.g. fill styles) are by default
locked to prevent accidental changes. To unlock a module, right-click on it and select the Unlock
option. To unlock a layout object select it in the Layout Tree and click on the Unlock node
icon in the Layout Properties.

Modifications of public objects (in case of modules) are instantly visible in all other WFD files
within the project where they are used (even in the opened ones). Changes to public objects
in Layout are propagated to other workflows after saving the workflow where the changes
have been made.

Note This feature works only if the workflow files are opened in the same instance of In-
spire Designer. If not, it is necessary to commit the project and update in the other instance of
the application.

When saving a workflow after having modified a public object a warning appears reminding
you of changes to public objects you have made. The dialog contains information about the
path to the object in the tree, the type of the object, its identifier, and lists workflows where
it is used (with a complete path to the object).

After confirming the changes the WFD closes and you have to commit the project to make the
changes in the public object available for other users. This updates also the public object in all
workflows where it is used.

1595
15 Projects

15.3.2 Public Objects Tab

Public Objects tab enables you to organize public objects and view their history, usage and
content.

Right-click on a folder or file to reveal the context menu options.

15.3.2.1 Tree Context Menu

Create Folder Adds a new folder to the tree.

Copy Copies the folder with its content to the defined position in the tree. The folder can
also be moved to a different position with the possibility to overwrite an existing folder.

Rename Renames the selected folder. The folder can also be moved to a different position
with the possibility to overwrite an existing folder.

Remove Deletes the selected folder.

15.3.2.2 Objects Context Menu

Copy Copies the selected object to the defined location. The directory can also be moved to
a different position with the possibility to overwrite an existing file.

Rename Renames the selected object. The object can also be moved to a different folder
with the possibility to overwrite an existing file.

Remove Deletes the selected object.

History Shows the history of the object in a dialog.

Find Usage Opens the Public Object Usage dialog which lists all workflow files and public
objects where the selected object is used.

1596
 15.4 Resolving Conflicts

Show Content Displays an XML definition of the selected object.

Show Used Objects Lists all objects that are used within the selected object (typically layout
objects in a Layout module).

Approve or Comment Enables you to tag the object as approved and add a comment to
the approval. The status Approved is bound up with the value of the object, meaning that
if the object is changed, the status Approved is dropped.

15.4 Resolving Conflicts

When there are more users working on one workflow file simultaneously, conflicts of the
content may arise, which need to be resolved.

In a situation when someone else changed and committed a file or public object that you have
just finished editing and try to commit, the Resolve Conflict dialog displaying details about the
conflicts appears. It enables you to resolve the conflict immediately or you can decide to post-
pone it. The Resolve Conflict dialog can be recalled at any later time by going to the Conflicts
tab and clicking on the Merge button.

The Resolve Conflict dialog identifies the workflow concerned, path to the object in conflict
inside the workflow, its original state, the change made by another user and your change.
Click on the appropriate button (Use Mine, Use Theirs or Use Original) and check the content
of the Result field to make sure it is the desired outcome. Then click OK to confirm your choice.

1597
15 Projects

If you need a wider context of the conflict to be able to make a correct decision, click on the
Resolve Later button for displaying the full XML definition of each version of the object with
highlighted differences.

The Content tab informs you about who and when made the commit causing the conflict and
about the individual conflicts themselves. It is up to you to consider which version you want
to use and which one to discard. Realize your decision with either the Use Mine or the Use
Theirs button. If you accept the changes made by other user, your version will be unrecoverably
overwritten. If you want to override the commit with your version, the current version in the
project folder will be overwritten by your version and will be available as a new version for
other users.

Options Description

Conflicted Commit Info This section displays details about the conflicted commit: the author,
time and commit file.

Conflicted Items Lists all conflicted files and objects.

Details Shows details (the path to the object or file) about the conflicted item selected above.

Merge Automatically merges the changes. If automatic merger is not possible (due to different
changes at the same place), the Resolve Conflict dialog (see above) with detailed inform-
ation about the conflict is displayed.

Use Mine Resolves the conflict by giving preference to the users version.

Use Theirs Resolves the conflict by giving preference to the version created and committed
by the other user.

1598
16 Related Applications

16.1 Inspire Content Manager

16.2 Inspire Production Server and Inspire Production Server Client
16.3 PNetT.exe Command Line Parameters
16.4 PNetTC.exe Console Application
16.5 Dithering Picker
16.6 Flow Translator
16.7 Inspire Native Viewer
16.8 TNO Writer
16 Related Applications

16.1 Inspire Content Manager

16.1.1 Inspire Content Manager Overview
Inspire Content Manager (previously known as Version Control System or VCS) manages
workflows, native files and resources by saving their version history to a database.

When you add a file to Inspire Content Manager (VCS), that file can be backed up and made
available to other people. All changes made to a file are saved as a new version; therefore, you
can recover old versions of a file at any time. Members of your team, for example, can see the
latest version of any file, make additional changes and then save another newer version to the
database. If these changes are later not accepted the version could be deleted and you can
revert to the previous version.

Different users can be given different roles and permissions by an administrator; a check out
protocol ensures that conflicts do not arise among multiple users working on the same file;
approval states can be applied to file versions to help share the workflow creation process
between different roles; and the complete version history of any file can be managed via History
Trees.

All operations above the files stored in Inspire Content Manager can be logged into the oper-
ations.dat log. This file includes the performed operation, user name and timestamp and can
be used for tracking the operations.

16.1.1.1 Getting Started with Inspire Content Manager

Inspire Content Manager is a server-client solution where individual clients access an installed
Inspire Content Manager via a desktop (Inspire Content Manager Explorer) or web application
(Inspire Content Manager Web). To start with make sure your ICM server is running and you
know its hostname, then for:

Inspire Content Manager Explorer (VCS Explorer), go to File | Inspire Content Manager
| Login to ICM in Inspire Designer or double-click on the Inspire Content Manager
(VCS) connection status area in the lower right-hand corner of the Workflow, Layout
or Proof window.

Log in and enter the Inspire Content Manager Explorer via File | Inspire Content
Manager | ICM Explorer. Alternatively, you can run PNetTVCSExplorer.exe which is a
standalone executable usually placed in the installation directory with the PNetT.exe.

Inspire Content Manager Web (DAM), open your web browser and go to the specified
web page where enter your user name and password (provided by your administrator).

For further details see the Inspire Content Manager Web section.

1600
 16.1 Inspire Content Manager

Inspire Content Manager Explorer

If you open the Inspire Content Manager Explorer (VCS Explorer) from the Inspire Designer
application, the Inspire Content Manager Explorer (VCS Explorer) window will open as a new
tab of Inspire Designer, as shown in the screenshot below. If you run PNetTVCSExplorer.exe,
a new window will launch.

ICM-root The left part displays the ICM-root tree which contains the tree structure of available
folders and files. The right part displays the content (available version controlled files) of
the folder selected in the tree.

Local rights You can set ICM rights to local files or folders, e.g. to c:\temp.

Then, if you access the folder from Inspire Designer while you are logged in to ICM, these
rights will apply. However, for easier management, files availability, back-up procedures
etc., it is recommended to store all your files in the ICM storage and not on your local
drive.

Search results Provides results of searches performed via the Search dialog. It is empty by
default.

For a description of all Inspire Content Manager Explorer (VCS Explorer) menu items please see
the section Inspire Content Manager Window Menu.

If you use Inspire Content Manager Explorer (VCS Explorer) as a tab of Inspire Designer, you
can open any of the WFD files or native files in the Inspire Content Manager Explorer (VCS

1601
16 Related Applications

Explorer) file list by double-clicking on a file or right-clicking and selecting Open from the
context menu.

Alternatively, you can open that file from the Inspire Designer Workflow window, see the section
Opening Workflow Files.

To work on a version controlled file, it is recommended that you check it out first by selecting
the Check Out option. This file will now be in your user name and the details of the check out
in the database. See the section Checking Out a File in Basic Use of Inspire Content Manager
chapter.

Remember to check your file back in after you have made your alterations, or at least at regular
intervals, especially if the document is also to be updated by others. To do this select the Check
In option. If this is not done then recent changes become more difficult to track and merge
and the file history becomes more difficult to manage. If no changes have been made to the
file, you can simply undo your check out by selecting the Undo Check Out option, the file will
return with the same unmodified details as existed before you checked it out.

1602
 16.1 Inspire Content Manager

16.1.2 Inspire Content Manager Window

Menu
In this section: See also:
File Menu Administrators Options
Users Menu Basic Use of Inspire Content Manager
Tools Menu How to Create and Use Branches
View Menu How to Create and Use Labels
Help Menu
Context Menus

To display the Inspire Content Manager Explorer (VCS Explorer) window, go to File | Inspire
Content Manager | ICM Explorer in the Inspire Designer Workflow window. The Inspire
Content Manager Explorer (VCS Explorer) window enables users to manage versions of files
added to Inspire Content Manager (VCS) and to administrate Inspire Content Manager (VCS).

16.1.2.1 File Menu

Login Logs in to Inspire Content Manager (VCS).

See the separate section Logging In to Inspire Content Manager for more details.

Shortcut: <Ctrl>+<,>

Logout Logs out from Inspire Content Manager (VCS).

Shortcut: <Ctrl>+<.>

Preferred Branches Selects which branches of a file should be worked with.

See the section How to Create and Use Branches for explanation.

Search Searches for files according to specific criteria.

You can view the results under the Search Results element at the bottom of the ICM tree.
You can see the full paths to the found files there or select the right-click menu option
Go to File to go to the directory where the file is located.

1603
16 Related Applications

Name Enters the name (or partial name) that will be searched.

Label Searches for files with a specific label.

Branch Searches in a specified branch.

Comment Searches for files with a specified comment.

Including directories If checked, names of directories are also included in the search.

Recursive If checked, subdirectories are searched too.

Match case If checked, searching is case sensitive.

Whole word If checked, only matching whole words are looked for.

Min size [kb] / Max size [kb] If checked, define the minimum / maximum size of
searched files.

Modified after / Modified before If checked, you can search files according to a
defined modification period.

Metadata key / Metadata value Searches for files according to their metadata keys
(name)/values.

To view the metadata of the files in Inspire Content Manager (VCS) select the context
menu option Metadata.

Refresh File List Updates the list of files in Inspire Content Manager (VCS).

Shortcut: <F5>

Options Opens the Options dialog.

There you can select the required font type, linked font and switch between the GUI skins.
For details see Fonts and General Options in Workflow Options Dialog section or Options
Dialog in Inspire Production Server Client Description section.

1604
 16.1 Inspire Content Manager

Using this option you can also set the possibility to browse through project files in Inspire
Content Manager (VCS). See the Inspire Content Manager section in Projects.

Using this option you can also set the possibility to have inactive users and user groups
hidden by default. However, this can be changed directly in the Users Admin and Groups
Admin dialogs.

Import Package Imports a previously created package (PKG file) of versions of a file which
may also include resources for the file.

Packages can be exported from other ICM servers via the Export Package option of the
Context menus of ICM Explorer.

This option is only available if you have the user permission Package import/export as-
signed to you by an administrator via the Edit User dialog.

Exit Closes the Inspire Content Manager Explorer (VCS Explorer) window.

16.1.2.2 Users Menu

Change Password Changes the password of the currently logged user via the Change
Password dialog.

Old password Enters the current password.

New password Determines the new password.

Passwords are case sensitive.

Confirm password Enters the New password again, to ensure that you have entered
the correct password in the above field.

This edit-box is available only if the option Hide password (see below) is enabled.

Hide password If checked, the characters of the password are displayed as asterisks.

If it is unchecked, the actual typed characters are shown and the new password does
not need to be confirmed.

Users / Groups / Sync Points Manages user accounts/user groups/synchronization points.

Only available for users with administrators rights; see the User Administration section
for details.

1605
16 Related Applications

16.1.2.3 Tools Menu

Server Settings Configures the server.

Available for users with administrators rights; see the Administrators Options section for
details.

Server Maintenance Manages a set of pre-defined tasks on the Inspire Content Manager
(VCS) server.

Available for users with administrators rights; see the Administrators Options section for
details.

Data Centers Creates and maintains data centers via the Data Center Admin dialog.

Approval States Defines and maintains approval states via the Approval States dialog.

Show Job Reports Lists details about executed jobs, i.e. the times that workflows (stored
in Inspire Content Manager) have been used for production.

Jobs are only logged if the option Log extended job reports to ICM in the Edit Server
Settings dialog (Tools | Server Settings) is checked.

The information about the jobs is current; if you scroll down, the information on any
other jobs is retrieved as they appear in the dialog.

WFD Shows the path to the workflow file used to produce the job.

Engine Shows the engine used to produce the job.

User Shows the user who executed the job.

Start Time / End Time Shows the date and time when the job started/ended.

Status Shows the status of the job.

Sheet Begin / Sheet End Shows the page-counter value of the first/last printed sheet.

Printed Page Shows the number of printed pages.

Params Lists the parameters used in the job.

Config Displays the complete job configuration in XML format in the Show Job Config
dialog.

The job configuration can be exported as a JOB file using the Export Job Config
button in the dialog.

1606
 16.1 Inspire Content Manager

Refresh Refreshes the list of job reports.

Export Job Reports Exports the listed job reports to a CSV file or job reports with
or without job configuration to a XML file.

You can also export the job reports to a XML file using the command -download
jobreports filename in the command line.

Cache Lists the content of the local cache used by Inspire Content Manager (VCS) and allows
it to be cleared.

See the Inspire Content Manager Cache section for more information.

16.1.2.4 View Menu

The View menu enables you to switch among different ways of displaying files and folders
contained in the selected folder.

Small Icons Displays icons of files and folders and the name of each file and folder.

List Displays a simple list of files and folders.

Details Besides the name of the file or folder displays also the user name of the person who
has checked out the file or folder, date and time of its last modification and its size.

Thumbnails Displays thumbnails (reduced size previews) of image files. For all file types,
when the mouse cursor is hovered above a thumbnail, detailed information is displayed
in a hint.

Sort By Sorts the files or folders according to one of the following criteria:

Filename

Checked Out By

Date-Time

Size

Reverse Order Reverses the sorting order selected in the previous option.

16.1.2.5 Help Menu

User Manual Opens the User Manual, which offers an option-by-option description of
Inspire Designer.

About Displays the version number of Inspire Designer, copyright information and licensing
related information: IP address of the server where GMC License Manager is running (in
case of Net licensing), computer License IDs and dongle ID (in case a dongle is used for li-
censing). See the document Public Licensing Guide for details on licensing and guidelines
how this information can be used.

1607
16 Related Applications

16.1.2.6 Context Menus

There are context menus that appear when right clicking on files or directories in the explorer
tree or file list:

File Context Menu

Directory Context Menu

Note Most options in context menus can only be used if you have the correct access rights
to the file or directory. Access rights are applied via the Access Rights dialog.

File Context Menu

Options Description

Go to File Goes to the directory where the file is located. Only available for search results.

Check Out Checks a file out from Inspire Content Manager (VCS).

Inspire Content Manager (VCS) then copies the file from the database into your working
folder. If another user attempts to check out the same file for editing, Inspire Content
Manager (VCS) generates a message, stating that the file is already checked out.

Check In Checks a file in to Inspire Content Manager (VCS).

A modified file is then copied from your working folder into the Inspire Content Manager
(VCS) database, making your changes accessible to other users.

Undo Check Out Undoes the last check-out.

Note If this option is selected, any changes made to a local copy of the file will be lost.

1608
 16.1 Inspire Content Manager

Remote Undo Check Out Undoes check-outs made by other users.

For administrators only. The user whose check out is to be revoked is selected in a dialog
that is opens.

Open Opens native files in the Sheet Proof window or WFDs in the Workflow window.

This option is available only if the Content Manager Explorer is opened as a tab of Inspire De-
signer.

Show History Displays a record of the changes made to a file since it was added to Inspire
Content Manager (VCS). The History includes a record of significant events in a chronolo-
gical order (version, user name, date and time of saving, branches and labels). See the
section History.

Shortcut: <Shift>+<F9>

Show History Tree Displays the Inspire Content Manager (VCS) history of a file in a structured
tree form. See the section History Tree.

Shortcut: <F9>

Label Adds a label and a label comment to the latest version of a selected file. See the section
How to Create and Use Labels.

Alias Label Adds an alias to the selected label. See the section Creating and Using Alias Labels.

Branch Creates parallel versions of the file.

See the section How to Create and Use Branches for details.

Set Validity Dates Limits the validity of the selected file by setting a date range.

Export Latest Version of File To Copies the latest version of a selected file into the specified
directory.

It opens the Export Latest Version dialog:

Export Displays the path to the file that will be exported.

It is possible to export many (multiple-selected) files at one time.

Destination Locates the directory where the file will be exported to.

Export checked version If checked, the version of the selected file that is checked out
will be exported.

1609
16 Related Applications

Note If no version is currently checked out, the latest version will be exported.

Get version and check it out If checked, the last version of the selected file will be
exported and then checked out.

If some other version is checked out, the last version of the selected file will be expor-
ted and the version that has been checked will be left checked out instead.

Change location If checked, the path to the used files (e.g. images, fonts) will be
changed in relation to the workflow file. If an absolute path is set for the used files
in a workflow file, the Export Latest Version of File To option has to be selected
for these files, too, so that they are accordingly exported to the appropriate location.

Example The workflow uses the arial.ttf font saved in a root directory together
with the workflow and an absolute path is set for this font. If the Change loca-
tion check-box is checked and both the workflow file and the arial.ttf font have
been exported with Export Latest Version of File To option to a different
directory (e.g. C:\Folder), Inspire Designer will search for the font in C:\Folder
when the exported workflow is used then.

Export metadata If checked, edited or added metadata is exported as a separate file.

Metadata in a separate file can be imported together with the respective file back to
Inspire Content Manager (VCS) (a check-box in the Open dialog).

Export Labeled Version of File To Exports a labeled version of the selected file from Inspire
Content Manager (VCS) and saves it in the specified directory.

It opens the Export Labeled Version dialog, with the same options as the Export Latest
Version dialog above and Label which determines that only version of the file with the
selected label will be exported.

Export Package Exports multiple versions of the selected file and its resources that are de-
termined by approval state and creation date.

This creates a PKG file via the Export Package dialog:

1610
 16.1 Inspire Content Manager

This is similar to the Export Latest version dialog with the additional options:

With resources If checked, any resources (used files for workflows) used by the files
selected in Export will be included in the PKG file.

If any of these resources cannot be found (i.e. are not in the location referenced by
the versions) they will not be exported.

Approval states Determines the approval states the versions must be marked with to
be included in the PKG file.

From / To Determines the period in which the selected version must have been created
to be included in the PKG file.

Note If both Approval states and From / To are set, the versions to which the
set states were assigned during the set time range will be included in the PKG file.
I.e. the From / To then determines when the state was assigned to the version. The
validity of the state is not considered.

Packages can be then imported to any other installation of Inspire Content Manager using
the Import Package option in the File menu of ICM Explorer. The intention is that some
ICM servers (e.g. production only servers) do not require all versions of a file to be stored
there, so when transferring files between servers you can select just the relevant versions.

When synchronizing versions on two servers, the versions created on the destination
server between two imports will not be overwritten, but the imported version will be added
as a new one. The VERSION_GUID metadata entry is used for recognizing the exported/im-
ported versions and should not be altered.

Update File Replaces the content of the selected file with the content of an imported file.

It opens the Update File dialog:

Destination Displays the path to the file that will be replaced. The file was already se-
lected in the Inspire Content Manager Explorer (VCS Explorer) window.

Source Selects the file you want to import to Inspire Content Manager (VCS).

Comment Adds a comment to the imported file (optional).

Import external metadata If checked, the metadata of the original file will be replaced
with the metadata of a new file.

Copy File Copies a file to the specified folder in Inspire Content Manager (VCS).

Shortcut: <Ctrl>+<C>

1611
16 Related Applications

It opens the Copy dialog.

From Displays the path to the original file. The file has already been selected in the Inspire
Content Manager Explorer (VCS Explorer) window.

To Specifies a location for the copy of the file.

Overwrite If checked, the content and history of a file with identical name, that is
already in the destination folder, will be overwritten.

Tip You can also copy a file by dragging and dropping it into the desired folder.

It is also possible to copy multiple files. To do so, select the files you wish to copy, drag
and drop them into the desired folder or press <Ctrl>+<C>. This action opens the Copy
Multiple Files dialog.

Source Displays the paths to the selected files.

Destination Specifies a location where the files will be copied to.

Overwrite If checked, the content and history of files with identical names, that are
already in the destination folder, will be overwritten.

Rename Renames the selected file, i.e. retaining the file's history.

Shortcut: <F2>

It opens the Rename dialog.

From Displays the path to the selected file, i.e. the one that will be renamed.

To Enters a new name for the file specified in the From field.

1612
 16.1 Inspire Content Manager

Note It is not possible to rename a file to a file name that is already used in the
same folder, unless Overwrite is checked.

Overwrite If checked, the history and the content of the file selected in the From field
will overwrite the history and the content of any file entered in the To edit-box.

Example The file CustomerRecords.wfd is renamed to CustomerAddress.wfd. If

the Overwrite option is checked, there will be a file called CustomerAddress.wfd
with the content of the file CustomerRecords.wfd in Inspire Content Manager (VCS).

Remove Removes (deletes) a file from Inspire Content Manager (VCS).

Shortcut: <Delete>

Access Rights Sets permissions to the selected file for individual users and groups via the
Access Rights dialog. For details, see the section Administrators Options.

Dependency Browser Shows which workflows (WFD files) are using the selected file via
the Dependency Browser. Alternatively, if you have selected a workflow, it will show which
other files that workflow is using as resources.

Metadata Views and edits the metadata of the file and adds new, user metadata.

It opens the Metadata dialog:

It displays all metadata and the thumbnail view of the file. The user can edit the existing
entries or add new metadata of their choice. Edited system metadata is highlighted in
blue, metadata added by the user in bold. This changed and added metadata is not written
in the file but is kept in Inspire Content Manager (VCS). When a file with user metadata
is exported a *.metadata file is created (optionally) in the same directory. This data can
be imported back with the respective file.

Create new version on change If checked, a new file version is created when any of
the metadata is modified or new is created.

Create New Creates a new metadata label.

The data can be entered to the item by selecting either the Name or Value entry and
using the <F2> shortcut.

1613
16 Related Applications

Reset Resets the selected data item to its original value (the added metadata are reset
to an empty value).

Delete Deletes the selected item (available only for user-added metadata).

Folder Context Menu

Many of the options here are similar to those for the File context menu except that they will
be applied to all the files inside the selected directory. In cases where the option Recursive is
also checked, then all directories within the selected one will also be included in the action.

The options unique to directories are described below.

Options Description

Add Folder Creates a new directory inside the selected one.

You can also move existing folders (with all subfolders) to Inspire Content Manager (VCS)
by dragging and dropping.

Add Files Adds files to Inspire Content Manager (VCS), e.g., images, fonts, data.

Files are copied from the location they are selected from (in the Open dialog that appears)
and the copy is kept in Content Manager. If Import external metadata is also checked,
the metadata for files that have been previously exported from Inspire Content Manager
(VCS) is also kept with the file.

1614
 16.1 Inspire Content Manager

You can also drag and drop files to the Inspire Content Manager Explorer (VCS Explorer).

Add MediaBin Link Creates a connection to the MediaBin application where digital assets
can be stored. For details, see the section MediaBin.

Add EMC Documentum Link Creates a connection to the EMC Documentum application.
For details see the section EMC Documentum.

Add SharePoint Link Creates a connection to the SharePoint application. For details see
the section SharePoint.

Add Database Link Enables you to work with data stored in a file system or ODBC database.
See the section Database Link.

Edit Link Changes a MediaBin, EMC Documentum, SharePoint or Database link configuration.

This option is only available if one of these links has been created.

Search Searches for a specific folder or file inside the directory selected in the tree. See the
Tools Menu section.

16.1.3 Basic Use of Inspire Content Manager

In this section: See also:
Logging In to Inspire Content Manager Inspire Content Manager Overview
Checking Out a File Inspire Content Manager Window Menu
Opening Workflow Files How to Create and Use Branches
Checking In a File MediaBin
Logging Out from Inspire Content EMC Documentum
Manager SharePoint
Adding Images and Fonts in to Inspire
Content Manager

16.1.3.1 Logging In to Inspire Content Manager

To log in to Inspire Content Manager (VCS):

1. Select Login to ICM from the Inspire Designer Workflow or Layout window menu File
| Inspire Content Manager or Production window menu Production | Inspire Content
Manager or double-click on the Inspire Content Manager (VCS) connection status area
in the lower right-hand corner of the Workflow, Layout or Proof window.

Inspire Content Manager (VCS) can also be accessed by using the ICM toolbar options
of the Simple Production.

1615
16 Related Applications

Alternatively you can open the executable PNetTVCSExplorer.exe which should have
been installed together with Inspire Designer (it is most often located in the same pro-
gram folder as the PNetT.exe).

2. Complete the User Login dialog that appears, using your personal information provided
to you by your Inspire Content Manager (VCS) administrator. See the description of
the required fields below.

3. Click on the Login button.

Options Description

Server Enters the IP address or name of the server running Inspire Content Manager (VCS).

If this field is blank, the computer where the current instance of Inspire Designer is running
is used.

Port Enters the number of the port that the Inspire Content Manager (VCS) server will mon-
itor.

The default port number is 30353; the available range is 1-65535.

Log as current user If checked, you will log in to the Inspire Content Manager (VCS) as the
user under whom Inspire Designer is currently running.

Inspire Content Manager (VCS) supports company's user definitions via LDAP. Windows
authentication will obtain the name and password used for logging into the current Win-
dows session and use them for logging into Inspire Content Manager (VCS).

This feature is not supported by Mac version of Inspire Designer, it is for Windows only.

User name Enters the user name for logging in to Inspire Content Manager (VCS).

User names are case insensitive. You have to use the correct casing only in the case that
there is another user with the same name which only differs in casing.

Note A predefined User name is admin with Password as pass.

Password Enters the password that is used in conjunction with the user name for logging
in to Inspire Content Manager (VCS).

Passwords are case sensitive.

Autologin next time If checked, Inspire Designer will automatically log in to Inspire Content
Manager (VCS) each time that you run PNetT.exe or PNetTVCSExplorer.exe.

The user name and password that you specify this time will be used in the future.

1616
 16.1 Inspire Content Manager

16.1.3.2 Checking Out a File

Before modifying a version controlled file, it is recommended to check out the file from Inspire
Content Manager (VCS), so that it is properly managed. When you check out a file, Inspire
Content Manager (VCS) copies the file from the database into your working folder. If anyone
else attempts to check out the same file for editing, Inspire Content Manager (VCS) generates
a message stating that the file is already checked out. This checkout protocol ensures that
conflicts do not arise among multiple users working on the same file.

To check out a file in the Inspire Content Manager Explorer (VCS Explorer) window:

1. Select a file that you would like to check out.

2. Right-click on the file and choose the option Check Out.

1617
16 Related Applications

To check out a file from the Inspire Designer Workflow window:

1. Open your version controlled file in Inspire Content Manager (VCS). See the section
Opening a File in Inspire Content Manager (VCS) below.

2. Go to File | Inspire Content Manager | Check Out.

16.1.3.3 Opening Workflow Files

Once you have logged in to Content Manager you can open workflows (WFD files) that are
stored there by:

Via Inspire Production Server using paths to files in Content Manager entered in a
command-line interface (CLI), e.g. MS Windows Command Prompt console. This
method is for production of workflow without GUI.

Searching for and double-clicking on it in the Content Manage Explorer.

This will open the workflow in Inspire Designer. Alternatively, right-click on the file and
select Open there.

Via the Workflow Window menu of Inspire Designer:

1. Go to File | Open Workflow.

2. In the Open dialog, browse for Inspire Content Manager in the Look in combo-
box.

1618
 16.1 Inspire Content Manager

3. Select the file you want to open from a folder

4. If you want to select a previous version (i.e. not the latest version) or a version with
a specific approval state, check Enhanced ICM open.

5. Click on the Open button.

If you checked the Enhanced ICM open check-box, the Enhanced Open dialog opens
(before the file is opened) in order to select a version of the file:

Note The file that you wish to work with in Inspire Content Manager (VCS) must be located
in Inspire Content Manager (VCS). If it is, for instance, on a different drive, it needs to be im-
ported to Inspire Content Manager (VCS) first. This is done using the Add Files option available
in the context menu of the desired directory in the Inspire Content Manager Explorer (VCS
Explorer). You can also drag and drop files and folders to the Inspire Content Manager Explorer
(VCS Explorer).

Tip In the Warnings Config you can activate warning Opened checked out file (by default
set to being displayed Never) that would appear when any resources checked out from Inspire
Content Manager (VCS) are used for the WFD being currently opened.

16.1.3.4 Checking In a File

After you finished working on a file, it needs to be checked back in to Inspire Content Manager
(VCS).

1619
16 Related Applications

Inspire Content Manager (VCS) then performs these operations:

Copies the modified document from your folder into the Inspire Content Manager (VCS)
database, making your changes accessible to other users.

Stores all the changes that have been made to the document. The most recent copy is
always available, but earlier versions can be retrieved as well.

To check in a file in the Inspire Content Manager Explorer (VCS Explorer) window:

1. Select the file that you wish to check in.

2. Right-click on the file and choose the option Check In from the context menu.

To check in a file from Inspire Designer Workflow window:

1. Open your version controlled file in Inspire Content Manager (VCS). See Opening a File
in Inspire Content Manager.

2. Go to File | Inspire Content Manager | Check In.

It is possible to save a file directly to Inspire Content Manager (VCS), and it is also automatically
checked in. If there is such a file stored on the server already, the file is overwritten and checked
in as a new version.

Note If there are still files checked out in your name when you try to close your Inspire De-
signer session a warning dialog will appear.

16.1.3.5 Logging Out from Inspire Content Manager

To log out from Inspire Content Manager (VCS), go to File | Inspire Content Manager |
Logout from ICM in the Inspire Designer Workflow or Layout window or double-click on the
Inspire Content Manager (VCS) connection status area in the lower right-hand corner of the
Workflow, Layout or Proof window.

16.1.3.6 Adding Images and Fonts in to Inspire Content

Manager
To add images and/or fonts to Inspire Content Manager (VCS):

1. Right-click on the desired directory in the Inspire Content Manager Explorer (VCS Ex-
plorer) window and choose the option Add files.

2. Select a file (e.g. image, font) in the Open dialog.

Another way of working with images is to use the MediaBin application. For more details, see
the section MediaBin.

1620
 16.1 Inspire Content Manager

16.1.4 Inspire Content Manager Server

Management
In this section:
Server
Command Line Parameters
Commands Used Within the Server
Window
Inspire Content Manager Running as
Service

16.1.4.1 Server
The server file name is PNetTVCS.exe. One of these is located in the Inspire Designer directory
for use on a single computer. However, the intention is that Content Manager be used across
a network. In which case, it should be installed on a server that is accessible by all the required
installments of Inspire products.

Running the EXE file starts the server, alternatively you can install it so that it runs as a service.

Note The server must be running before Inspire Designer instances (clients) can be logged
in and information retrieved, i.e. an administrator has to have executed PNetTVCS.exe which
should have been installed somewhere on the same network as Inspire Designer.

For more information about what is necessary for the PNetTVCS.exe to work from a different
directory than the installation directory, see the section Installation Directory Content.

16.1.4.2 Command Line Parameters

-h, -?, -help Displays the Help screen.

-i, -install Installs Inspire Content Manager (VCS) as a service on Windows.

Note Before installing Inspire Content Manager (VCS) as a service, all the parameters
are checked. If there are any errors, the application is not installed and a warning is dis-
played.

-D Launches Inspire Content Manager (VCS) as a demon. Available for Unix platforms only.

Note On Mac platform the demon is launched using a special procedure. See the chapter
Launching Inspire Production Server (PNetTNetServer) or Inspire Content Manager (VCS)
Server as a demon in Inspire Designer Installation Guide for Mac for more information.

-u, -uninstall Uninstalls the service.

-override_name Overrides service name used for Inspire Content Manager (VCS).

-recoverytime Sets recovery time (in milliseconds) of a crashed Inspire Content Manager
(VCS) server that has run as a service. The default time is set to 500 milliseconds. Depending
on the crash cause, the server will be launched or will be restarted repeatedly after the
set recovery time.

1621
16 Related Applications

-p port Specifies the port number to be monitored. The available range is 1-65535.

By default (when no -p parameter is specified), the server starts listening to (i.e., monitor-
ing) port 30353.

-disablelog Toggles off the Inspire Content Manager (VCS) log. Using this command can
increase server speed.

-dir directory Specifies a directory used for storing Inspire Content Manager (VCS) files.
If this parameter is omitted, then the same directory where PNetTVCS.exe is located is
used.

-tempdir directory Specifies a name of a temporary directory. This option is useful

when an ICM server is on the Unix platform and a user does not have access to the Temp
directory. Using this command it is possible to specify a directory that the user can access.

-l logname Creates a new log file with the same name, overwrites the content of the ori-
ginal log file.

-la logname Appends new log entries to the specified log file, creates it when it does not
exist.

-ls Specifies the maximum size of log file (in kB).

-vcssettingsonly or -icmsettingsonly Enables you to use the Inspire Content

Manager (VCS) server as user settings instead of file storage, i.e. activates a mode in which
only the settings for users concerning usage of the specific Inspire Designer parts (Layout,
Proof, Production etc.) are applied.

-connectstring connectstring Specifies a connection to a database.

-tablename tablename Specifies a name of a table in a database. The default table name
is "vcs".

-dbtype type Specifies a database type. The default database type is Microsoft SQL and
other possible database types are MySQL, DB2 and Oracle.

-shareable Enables you to run two or more Inspire Content Manager (VCS) servers on
one database or a file repository.

-importdir Imports a file repository into a database repository or a file repository.

Note

To import a file repository in to MySQL or MSSQL database, it is recommended to

use a backup of a file repository instead of a working directory due to the data
consistence.

To import large files into MySQL, it is necessary to change a file size limit in MySQL.
The default file size limit in MySQL is set to 1MB.

1622
 16.1 Inspire Content Manager

16.1.4.3 Commands Used Within the Server Window

From the Server Window, you can enter the following commands:

h Displays the help screen.

i Displays information about users who are currently logged into Inspire Content Manager
(VCS).

q Shuts down the server.

16.1.4.4 Running Servers as a Service

If you install Inspire Content Manager (or a Data Center server) as a service, it can run automat-
ically as a service on your computer everytime the computer is running, even if no user is logged
into Windows.

Inspire Content Manager (VCS) server running as a service can be monitored via the Microsoft
Computer Management console: Right click on My Computer icon (for Windows XP) or
Computer icon (for Windows Vista or Windows 7) on your desktop (or in Windows Explorer
etc.) and select the Manage option.

Alternatively, click on Start; type Computer Management in the Start Search box and then
press Enter:

In the Computer Management console you can: Look at the System Logs (System Tools | Event
Viewer | Windows Logs | System) in order to check events related to services; or check the
complete list of services (Services and Applications | Services) in order to Start, Stop or Restart
them, which may be necessary if communication with the server fails.

Restart Service after Failure

When Inspire Content Manager (VCS) is run for the first time as a service, it is installed with
Recovery properties set to "Restart service after failure" every time. Service is restarted 500 ms
after failure.

1623
16 Related Applications

16.1.5 Inspire Content Manager

Administration
16.1.5.1 Administrators' Options
See also
Server Administration
User Administration

Administrators are users that have Admin checked on the User Admin dialog.

They can:

Use the User menu in the Inspire Content Manager Explorer to edit users and user
groups. See the section User Administration.

Administrate the Content Manager server via the Server Settings and Server Main-
tenance on the Tools menu. See the section Server Administration.

Edit approval states and the users that are able to apply them, via the Tools menu.

Add EMC Documentum, MediaBin and SharePoint links to folders via the Folder Context
Menu.

16.1.5.2 Server Administration

In this section See also
Server Maintenance Inspire Content Manager Server
Server Settings Management
Cache

Server Maintenance
In the Inspire Content Manager Explorer (VCS Explorer) dialog, go to Tools | Server Mainten-
ance and the Server Maintenance Admin dialog opens. The dialog enables you to manage a
set of pre-defined tasks that maintain the history of version controlled files on your Inspire
Content Manager (VCS) server and operations logging.

1624
 16.1 Inspire Content Manager

Options Descriptions

Create New Opens the Edit Task dialog in order to add a new task to the list.

Options displayed in the Edit Task dialog depend on type of a task selected in the Task
type combo-box.

Task name Displays the current task name that can be edited. If a new task is created,
a default name New Task is inserted.

Start date Enables you to set a day and time when the task starts for the first time. The
default time is present time, i.e. the task will start immediately. Enter the date and
time to the Start date combo-box or use drop-down menu of the combo-box to
select the date.

Period Enables you to set a period between repeated performances of the task. The
following periods are available:

Once If selected, the task will be performed only once.

Days If selected, the task will be repeated by the number of days selected
in the Days field.

Task type Selects a task to be performed from the following types:

Backup Saves copies of the version controlled files to a location of your

choice so that all changes made since the last back up are safe.

The following options appear:

Destination Enables you to enter a destination folder of your backup files.

Exclude mask Determines which file extensions (e.g. images, fonts) will not
be backed-up, in order to save memory.

Separators are commas, if you have more than one file type that you
want to exclude.

Example Your files might include JPG images that you do not
need in the back up file and you would rather have smaller files, in
which case type here *.jpg.

1625
16 Related Applications

The backup files can be simply copied back to the Inspire Content Manager
(VCS) folders should there be a need to restore the Inspire Content Manager
(VCS) documents.

Clean up Deletes versions of files.

The following options appear:

Nr. of versions to keep Enables you to enter the maximum number of

versions that you want to keep, counting back from the current version.

Example The current number of versions is 10 and you want to

keep 6 last versions so versions 1 to 4 will be deleted. The number
of versions that should be kept is set to 6.

Nr. of days to keep Enables you to determine how old versions (in days)
you want to keep.

Always keep labeled versions If checked, labeled versions will be kept

permanently, e.g. important versions can be labeled as major and these
will not then be deleted by the clean up task.

For a description of version labeling see the section How to Create and
Use Labels.

Exclude mask Determines which file extensions (e.g. images, fonts) will not
be cleaned-up.

Separators are commas, if you have more than one file type that you
want to exclude.

The versions that meet the requirements of the Nr. of versions to keep option
or the Nr. of days to keep option (or both) are kept and the rest of versions
will be deleted.

Example There are 10 versions of a file and all of the versions are 10
days old. If you set the Nr. of versions to keep to 3 and the Nr. of
days to keep to 10, all of the versions will be kept because each version
satisfies either the Nr. of versions to keep option or Nr. of days to
keep option.

Clean up job reports Deletes stored job reports.

The following options appear:

Nr. of job reports to keep Enables you to enter the maximum number of
job reports that you want to keep, counting back from the last job report.

Nr. of days to keep reports Enables you to determine the oldest job reports
(in days) that you want to keep.

Always keep failed job reports If checked, reports of failed jobs will be
kept permanently.

1626
 16.1 Inspire Content Manager

Edit Opens the Edit Task dialog (see above) where you can edit the selected task.

The dialog can also be opened by double-clicking on the selected task.

Delete Removes a selected task from the list in the Server Maintenance Admin dialog.

Refresh Refreshes the list of tasks in the Server Maintenance Admin dialog.

Server Settings
To set server configuration, define scripts executed on various actions or switch on logging to
operations.dat log, go to Tools | Server Settings in the Inspire Content Manager Explorer
(VCS Explorer) window.

General Tab
On the General tab you can make settings related to the configuration file, production config-
uration file storage, multiple check out and set up logging of all operations users do above the
files.

Options Description

Store config in ICM If checked, a configuration file is saved in the Inspire Content Manager
(VCS) server. This can be used when you log in from a different computer and want to
use the same configuration.

If unchecked, a configuration file is saved to your working directory, i.e. the same folder
where PNetT.exe is located by default.

Store production configs locally If checked, a production configuration is saved to your

working directory, i.e. the same folder where PNetT.exe is located by default.

If unchecked, a production configuration is saved in the Inspire Content Manager (VCS)

server.

Note This option is enabled if the Store config in ICM option is checked.

Allow multiple check out If checked, it is possible to check out a version that has been
already checked out by another user.

Log extended job reports to ICM If checked, comprehensive job reports are logged to Inspire
Content Manager (VCS). They can be viewed in the Job Reports Dialog.

1627
16 Related Applications

Allow LDAP authentication for synchronized users against If checked, users without a
set password are authenticated against the selected synchronization point. For this option
to work, the users must have synchronization enabled (check-box Synchronize in the
Edit User dialog) and they have to be members of a group that is also synchronized (check-
box Synchronize in the Edit Group dialog).

Log ICM operations If checked, Inspire Content Manager (VCS) operations (add file, check
in, check out, (remote) undo check out, label, alias label, branch, remove, move, remove
content of a file) are logged in the ICM log file called 'operations.dat' located in the In-
spire Designer application folder. For each operation the following parameters are logged;
date, username, command, filename, versionID.

For the following operations, additional parameters are available:

"remote undo check out" P1 parameter stands for the user for which the remote
operation is performed

"label" P1 parameter stands for a label name, P2 parameter stands for preferred
branches (separated by comma)

"alias label" P1 parameter stands for the original label name, P2 parameter stands
for a new label name

"branch" P1 parameter stands for a new branch name, P2 parameter stands for
preferred branches (separated by comma)

"move" P1 parameter stands for a path where the file is moved

"copy" P1 parameter stands for a path where the file is copied

The operations.dat log is useful for tracking any operation any user does above the files,
including the timestamp, e.g.:

27.7.2011 12:42:06.013;admin;ADD_FILE;diff.txt;;;;
27.7.2011 12:42:08.815;admin;CHECKOUT;diff.txt;1;;;
27.7.2011 12:42:10.958;admin;CHECKIN;diff.txt;1;;;

If you want to download the operations.dat file in the CSV format use the command
-downloadoperationslog for PNetTC.exe.

Example

pnettc.exe -downloadoperationslog operations.csv -vcsaddress localhost

-vcsuser admin -vcspassword pass

If you want to download and clear the operations.dat file in one step use the command
-downloadoperationslogandclear for PNetTC.exe.

Example

pnettc.exe -downloadoperationslogandclear operations.csv -vcsaddress

localhost -vcsuser admin -vcspassword pass

1628
 16.1 Inspire Content Manager

Include get file operation in log If checked, in addition to the Inspire Content Manager
(VCS) operations above, the "get file" operation is also logged in the operations.dat file.
The "get file" operation stands for the operation which "gets" a file from Inspire Content
Manager (VCS), e.g. when a file is downloaded to a local cache memory during opening,
exporting the latest or labeled version of a file.

This option is enabled only if Log ICM operations is checked.

ICM Scripts Tab

The ICM Scripts tab enables you to run scripts on various actions performed by the users of
Inspire Content Manager (VCS). Depending on the conditions set, a specific action (a certain
user makes a change or some file is given a specific label, etc.) can trigger another action (an
email can be sent, a file created, etc.). Check the Inspire Content Manager (VCS) server log for
information about script execution and errors.

Options Description

Action Select here the action on which the defined script will always be run. For each action
there is a set of properties available for creating a condition. The script properties reflect
the options for Inspire Content Manager (VCS) server settings available in the GUI.

On check in The script is run when a file is checked in.

There are special properties available when this option is selected: Comment,
ConnectedFrom (IP address), Location (of the file), UserName, VersionId.

On check out The script is run when a file is checked out.

There are special properties available when this option is selected: Branch (name),
ConnectedFrom, Location, UserName, VersionId.

On label The script is run when a label is added to a file.

There are special properties available when this option is selected: Comment (label
comment), ConnectedFrom, FileComment, Label, LocationList, PreferredBranches,
UserName, VersionId.

On branch The script is run when a new branch is created.

There are special methods available when this option is selected: Branch, Comment,
ConnectedFrom, Location, PreferredBranches, UserName, VersionId.

1629
16 Related Applications

On maintenance task

There are special properties available when this option is selected: Status (integer
value, 0=Finished, 1=Failed), ErrorMessage, TaskType (integer value, 0=Backup,
1=Clean up, 2=Clean up job reports). See the section Server Maintenance.

On add file/folder The script is run when a file or folder is added to Inspire Content
Manager (VCS).

There are special properties available when this option is selected: Comment,
ConnectedFrom, Location, UserName.

On remove file/folder The script is run when a file or folder is removed from Inspire
Content Manager (VCS).

There are special properties available when this option is selected: ConnectedFrom,
Location, UserName, VersionId.

On rename file/folder The script is run when a file or folder is renamed.

There are special properties available when this option is selected: ConnectedFrom,
SourceName, TargetName, UserName.

Example This script sends an email when a file or folder is added to Inspire Content
Manager (VCS). It informs the recipient about the location of the newly added file or
folder and the user who made this change. Select On add file/folder as the Action. See
also Util.MailServer and Util.Mail scripting methods.
Util.MailServer ms;
ms.ServerName="mailserver";
Util.Mail message;
message.setFrom("[email protected]");
message.addTo("[email protected]");
message.setSubject("ICM: File/Folder Added");
message.setTextBody("The file/folder " + Location + " has been added to
the ICM by user: " + UserName);
ms.sendMail(message);

Cache
The cache is a location where the files from server are copied so that they can be opened. It is
created in either the directory:

where the EXE file is situated,

or which is specified using the PNETT_DIR environment variable or -c command-line

parameter.

Parameters Overview

-c Sets the working directory.

-vcscache Sets the directory for the shared files.

1630
 16.1 Inspire Content Manager

Note The parameter cannot point to a cache directory that is already used by another
instance of Inspire Designer (for example, when you run two instances of Inspire Designer,
a combination of Inspire Designer and Inspire Content Manager Explorer (VCS Explorer),
Inspire Designer and Inspire Production Server (PNetTNetServer), etc.).

-vcscachechecked Sets the directory for the checked out files.

To view cache information, go to Tools | Cache in the Inspire Content Manager Explorer (VCS
Explorer) window and the Cache Info dialog will be opened. The dialog displays an overview
of a cache usage and lists of:

Common files that are not checked out.

Checked out files of the individual user that is currently logged in Inspire Content
Manager (VCS) (e.g. admin and user on the screenshot below).

The size of the cache can be defined by Cache size in Inspire Content Manager (VCS) section
of the Workflow Options dialog. Although, the actual cache size might still be greater than
the one defined because it is calculated as follows:

When the sum of the size of checked out files and the size of common files is smaller
than the limit, the cache file size is equal to the sum of the two.

When the sum of the size of checked out files and the size of common files is greater
than limit, Inspire Content Manager (VCS) tries to unload some of the common files
from the cache to reduce its size. Files that have been inactive for the longest time are
unloaded first.

If the size of checked out files is greater than the limit, cache size can be greater that
the size defined in the Options dialog because there are no files to unload from the
cache.

1631
16 Related Applications

16.1.5.3 User Administration

In this section See also
User Admin Dialog Inspire Content Manager Window Menu
Group Admin Dialog
Synchronization Points
Access Rights Dialog

User Admin Dialog

To open the User Admin dialog go to Users | Users in the Inspire Content Manager Window
Menu. The dialog enables you to manage user accounts, edit user details and set user access
permissions.

You can manage user accounts, edit user details and set user access permissions via the menu
Users or the icons at the bottom of the dialog.

Alternatively you can right click on a selected user or click on the following icons at the bottom
of the User Admin dialog to get the corresponding functionality.

Note You should have different user accounts for logging-in to Inspire Content Manager
(VCS) and for logging-in to Inspire Production Server (PNetTNetServer). Only if you do so, you
will be able to access your version controlled file with most recent changes, which was not
checked in so far, from a different computer.

Options Description

Hide inactive If checked, inactive users are not displayed in the list.

Inactive users are those that have the Active option unchecked in the Edit User dialog.
The default setting of this option can be changed in File | Options.

1632
 16.1 Inspire Content Manager

Add User Opens the Add User dialog where you can add a new user.

A new user will be added to the list of authorized users and become a member of the
default group Everyone. After the new user is successfully added, the Edit User dialog
pops up automatically.

User name is case insensitive, unless you specifically create two or more user names with
same characters but differing casing. In which case, the casing will be respected.

Password is case sensitive.

Note It is not possible to remove a user. A user can only be deactivated by unchecking
Active user via Edit User.

Edit User Opens the Edit User dialog where you can edit user properties as described below.

For each check-box here (with the exception of Synchronize with sync points), there
are three states: Checked, unchecked and greyed out. A Greyed-out check-box means
that the permissions will be inherited from any group which the user belongs to or, if they
are not assigned to any group, the default user permissions.

1633
16 Related Applications

The default user permissions are: Active user, Normal Login, Edit production configs,
Edit simple production configs, Package-user export as active user and Print from
Proof. You can view the current inherited permissions of the user via the Evaluate button.

Active user If checked, the user can perform all the tasks he is allowed to by the other
options in this dialog.

You cannot delete a user from Inspire Content Manager (VCS) and so instead, if a
user is no longer permitted to work in Inspire Content Manager (VCS), uncheck this
option.

Admin If checked, the user can add users and groups, set their properties, change
passwords, set access rights.

Select a login type for the user from the following radio buttons:

Normal login Logs the user in without any restrictions upon which environ-
ment they can use, i.e. they can access Workflow, Proof and Production envir-
onments.

Force simple production Logs the user directly in to the Simple Production
environment without access to any other part of Inspire Designer.

Force production Logs the user directly in to the Production environment

without access to any other part of Inspire Designer.

Force proof Logs the user directly in to the Proof environment without access
to any other part of Inspire Designer.

Inherit from default or group permissions Determines that the login type is
inherited from any group which the user belongs to or, if they are not assigned
to any group, the default user permissions.

The above login types are usually used in combination with the Force login option.

Depending on the selected login type the relevant options will become active:

Edit production configs If checked, the user can edit production configurations.

If unchecked, the buttons Edit, View, Save, Save As, New and Remove are disabled
for engine configuration, printer configuration and driver configuration in the Main
Production window.

Edit simple production configs If checked, the user can edit simple production config-
urations.

If unchecked, the buttons Format Config, Printer Config and Driver Config are
disabled in the Configure Output dialog of the Simple Production environment.

Manage data centers If checked, the user can create data centers and manage which
users are allowed access to each of them.

If unchecked, the user can only edit data sets in data centers which he has been
specifically assigned by somebody with the Manage data centers permission.

Manage workspaces If checked, the user can manage workspaces.

1634
 16.1 Inspire Content Manager

If unchecked, the option File | Manage Workspaces is disabled in the Workflow,

Proof and Production environments.

Manage validity dates If checked, the user can manage validity dates of files.

If unchecked, the option Set Validity Dates is disabled in context menus of the Inspire
Content Manager Explorer (VCS Explorer).

Package import/export If checked, the user can import and export packages of versions
of files, even if they do not have the correct permissions (set via the Access Rights
dialog) for some of those files.

The import of packages (via the option Import Package in the File menu of ICM ex-
plorer) is not possible without this option checked. The export of packages (via the
option Export Package in the Context Menus of ICM explorer) is possible providing
that the user has the correct access rights to the file being exported. Access rights
are applied to files via the Access Rights dialog.

Package-user export as active user If checked, when exporting packages the user
will export any users (who are listed in the version history of files) with the package
and they will be active (have Active checked in this Edit User dialog) on the destination
server.

Different Content Manager servers can have differing sets of users: People on the
server a package is being exported from may have particular access rights to file ver-
sions; and then on the other server (where the package is being imported to) they
might not exist or may be deactivated. If this option is checked, the user will be cre-
ated, reactivated on the import server with the same rights as on the export server.

If left unchecked, users will be exported with permissions but those users will not be
activated if they are not already active on destination server.

Warning Exporting users will overwrite existing-user permissions on destination

server.

Print from proof If checked, the user can print to a desktop printer from Proof.

If unchecked, the Print and Pre-Flight icons (and the options Proof | Print and
Proof | Pre-Flight from the Sheet Proof window menu) are disabled in the Sheet
Proof window.

Show files outside of validity period If checked, the user can see files whose validity
has expired.

Invalid files are displayed in gray color in the Inspire Content Manager Explorer (VCS
Explorer).

Synchronize with sync points If checked, the user can connect to the defined local
synchronization point and have their information updated.

Synchronization enables integration of your local LDAP directory entries (user properties
set at a central location for a network of users) into Inspire Content Manager (VCS)
and perform regular synchronization updates.

If unchecked, no synchronization is applied and users will also be able to log in with
an empty password. Also, leave this option unchecked for the administrator.

1635
16 Related Applications

See Synchronization Points for more information.

User impersonation If checked, the user can be impersonated by an Inspire Interactive

user (intended to be the same user) so that access can be gained to ICM from Inspire
Interactive.

Change Password Changes the current password of the user selected here in the User
Admin dialog, via the Change Password dialog.

Force Login Functionality Settings

When this option is set, you have to enter a user name and a password to login to Inspire De-
signer.

There are two possible ways to set Force login:

1. Create a text file called forcelogin (with no extension) in your Inspire Designer program
folder. The file should contain:

Inspire Content Manager (VCS) server address on the first line;

the port number on the second line. When default port is used, the port number
does not have to be specified.

Y or YF on the third line (only in case LDAP is used). Y selects logging in as the
current user in Windows and if it fails, user is asked to enter user name and pass-
word. YF selects logging in as the current user in Windows and if it fails, the ap-
plication aborts.

Note If this file is present in the Inspire Designer directory, it is not possible to
enter Inspire Designer without specifying a valid Inspire Content Manager (VCS)
login name and password. If a user has these, it then allows them to enter only
the part of Inspire Designer for which they have access rights.

2. Instead of creating the forcelogin text file run PNetT.exe with the following parameters
in the command line:

-fl
-vcsserver servername (e.g. localhost, 192.168.42.95)
-vcsport portnumber

Executing the command line displays the Inspire Designer splash screen with a login
dialog with the Username and Password edit-boxes and the check-box Log as current
user. For the description of these options see the section Logging In to Inspire Content
Manager.

Example PNetT.exe -fl -vcsserver localhost -vcsport 30353

1636
 16.1 Inspire Content Manager

Group Admin Dialog

The dialog enables you to manage which users are in which groups. To open the Group Admin
dialog go to Users | Groups in the Inspire Content Manager Explorer (VCS Explorer) window.

To add a group or edit a group, select menu Groups in the Group Admin dialog. Alternatively,
you can right click on a selected group or click on the following icons at the bottom of the
Group Admin dialog to get the same functionality.

Note Everyone is the default group for all users. Its properties cannot be altered, but it can
be used to apply default access rights to individual files and folders via the Access Rights Dialog.

Options Description

Hide inactive If checked, inactive groups are not displayed in the list. Inactive groups are
those that have the Active option unchecked in the Edit Group dialog. The default setting
of this option can be changed in File | Options.

Add Group Opens the Add Group dialog where you can enter a name of a group into
the Group name field. A new group will be added to the list of authorized groups.

Remember that after creation it is not possible to remove a group, however, you can remove
all members from it.

Type a group name in the Group name text-box.

After the new group is successfully added, the Edit Group dialog pops up automatically.

Note It is not possible to remove a group. A group can only be deactivated by unchecking
Active user via Edit Group Permissions.

Edit Group Edits the group members.

1637
16 Related Applications

You can also open this dialog by double-clicking on a selected group.

The left text area at the upper part of the dialog displays a list of group members and the
right text area displays a list of available users.

To add a user to the list of group members select the desired user and click on the left
arrow .

To remove a member from the group, select the desired user and click on the right arrow
.

Name Names the group.

Active If unchecked, the group becomes inactive. Synchronized users can log into Inspire
Content Manager (VCS) only if they are members of an active group.

LDAP

Note For LDAP interface, only Active Directory is supported.

Synchronize Synchronization enables the integration of your local LDAP (Lightweight

Directory Access Protocol) directory entries (user properties set at a central location
for a network of users) into Inspire Content Manager (VCS) and allows regular
updates to synchronize the user information between them. See Synchronization
Points for more details on how to set these updates. If Synchronize is checked,
the synchronization parameters can be set for this group in the following combo-
boxes:

Source Selects a synchronization point. See Synchronization Points for more inform-
ation.

Search base Browses for the LDAP file.

1638
 16.1 Inspire Content Manager

Filter Selects a type of an object from LDAP tree. These objects will be added to
the group. The following types are available:

objectclass=person

objectclass=organizationalPerson

objectclass=inetOrgPerson

objectclass=top

You can also enter your own object class definition.

Attribute Selects an attribute containing data used to create a user name (used
for logging in to Inspire Content Manager (VCS)) that will be added to the group.
The following attributes are available:

sAMAccountName

MailNickName

UserPrincipalName

You can also enter your own attribute.

Search scope Selects the level from which the information about a user is taken.
The following options are available:

One level If selected, information about the user is taken only from the
selected directory.

Sub-tree level If selected, information about the user is taken also from
sub-directories one level below the selected one.

Source Selects a synchronization point. See Synchronization Points for more inform-
ation.

Company This section propagates information from Inspire Content Manager (VCS) to
Inspire Content Manager Web (DAM). See also the applications user manual.

1639
16 Related Applications

Is company group If checked, the group is marked as a company group users can
work with in Inspire Content Manager Web (DAM).

Company logo Use the Upload Logo button to upload a logo (in JPG format) that
will be visible in Inspire Content Manager Web (DAM).

Company root directory Defines the directory of the company in Inspire Content
Manager (VCS) that is displayed as a user's root directory in Inspire Content
Manager Web (DAM).

Note

It is not possible to remove any created group. This is to avoid losing data or tasks
assigned to them.

New users added automatically via Sync Points cannot log in any other way than
Log As Current User, unless the administrator marks them as unsynchronized or
assigns them a password. See also Edit user's properties above. Synchronized users
can only log in if they belong to at least one synchronization group.

Edit Group Permissions Opens the Edit Group Permission dialog, which is the same as
the Edit User dialog except that it applies the chosen permissions to all members of the
group.

If any permission is set to Inherit then the permissions of each individual user in the group
are applied.

Synchronization Points
Sync (or synchronization) Points are usually locations on your local network at which, for ex-
ample, an LDAP server exists that has user settings for a large group of people stored, such as
a company's user base. LDAPs (Lightweight Directory Access Protocols) are internet protocols
that various programs use to look up information from a server. Synchronization enables Inspire
Content Manager (VCS) to integrate with the set user access properties in your local LDAP
directory and perform regular updates to synchronize those properties.

1640
 16.1 Inspire Content Manager

In the Inspire Content Manager Explorer (VCS Explorer) window go to Users | Sync Points
and the Synchronize Points Admin dialog opens.

To add, edit or remove synchronization point or to perform synchronization, select the Service
menu in the Synchronize Points Admin dialog. Alternatively, you can right click on a selected
synchronization point or click on the icons at the bottom of the dialog to get the corresponding
functionality.

Options Description

Create New Opens the Add Synchronization Service dialog where you can add a new
synchronization point.

After the new synchronization point is successfully added, the Edit Synchronization Service
dialog pops up automatically.

Edit Opens the Edit Synchronization Services dialog, where you can edit the settings of
the selected synchronization point. This dialog can also be opened by double-clicking on
a selected synchronization point.

1641
16 Related Applications

Options Description

Name Displays the current name of the synchronization point. The name can be edited.

Type Enables you to select the type of the protocol that Inspire Content Manager (VCS)
is to integrate with from the following types:

LDAP

LDAP SSL

Active Directory

Active Directory SSL

Note Select a type according to the service set in the server you are connecting
to.

Port Displays the default values for the port number of the protocol selected in Type.
The port number can be changed.

Server Enables you to enter the IP address or a name of the server (computer) where
the protocol is running.

Log as current user If checked, you will be able to log into Edit Synchronization Service
as the user under whose credentials you are currently running Inspire Content Manager
(VCS).

Note If Inspire Content Manager (VCS) is currently running as a service, this option
should not be selected because a service runs by default as a local system that has
no access rights for the directory protocol (LDAP). In this case an existing user name
and password should be entered in the field User name and Password below this
option.

User name Enables you to enter an exiting user name.

Note This option is enabled if the Log as current user option is not checked.

Password Enables you to enter the password for the user entered in the User name
field.

Note This option is enabled if the Log as current user option is not checked.

Last update Displays the date when the last synchronization was performed.

Update frequency Enables you to set the period between repeated synchronizations,
allowing for automatic updates to be performed at these intervals. The default update
frequency is set to 0, i.e. it is never automatically updated.

Test Clicking on this button enables you to verify whether the connection settings that
you have entered are valid.

Delete Removes the selected synchronization point from the list in the dialog.

Synchronize Connects to the Sync point and updates the information about all users that
have been marked for synchronization. See the section User Administration for details on
how to mark the user.

1642
 16.1 Inspire Content Manager

Access Rights Dialog

Access rights can be set for individual files and folders; for approval states; and for data centers.
They give an owner of an object control over who else can edit it.

For file or directory, select Access Rights in the context menu. You do not need to be an ad-
ministrator to do this.

For approval states and data centers, click on the Access Rights icon. You have to have the
appropriate permissions set in the User Admin dialog in order to access these features, but no
additional permission is necessary to edit the access rights.

Options Description

Name Lists users and groups that have access permissions to the file or directory.

Select a user or group here to edit their Permissions. Everyone is always present allowing
you to set default settings for logged-in ICM users.

Add Adds users to the Name list via the Add Group dialog.

To add a group or user, select it and click on OK.

1643
16 Related Applications

Remove Removes the selected group or user from the Name list.

The button is not available in case there are rights set for the group in the parent
directory.

Evaluate Opens the Show Evaluated Rights dialog where an overview of users listed in
the Access Rights dialog and user permissions to the file are displayed.

Only available for files and folders.

Permissions Lists the actions available to the user or group selected in the Name list.

For files and folders cases, these correspond to the standard MS Windows security settings:

Read Allows them to read a file.

Check Allows them to check out and check in a file.

Add file Allows them to add a file to a directory.

Remove Allows them to delete the file or directory.

Branch Allows them to make a branch of the file or directory.

Label Allows them to label the file or directory.

Proof Allows them to view workflows (WFD files) and native files in the Proof
environment.

Production Allows them to run workflows (WFD files) and native files in the Pro-
duction environment.

Modify rights Allows them to modify these access rights for the file or directory.

If Status is set to Deny, they can only view the permissions, i.e. only the Evaluate
button is available.

Add folder Allows them to add a folder inside a directory.

List Allows them to view the content of a directory.

For data centers:

Read Allows them to read data from the selected data center, e.g. via the Data
Center Input module.

Write Allows them to write data to the selected data center, e.g. via the Data
Center Output module.

For approval states:

Set state Allows them to set the selected approval state to a file version.

Allow state date in the past Allows them to set a validity period (i.e. Valid from
and Expired) at a time that is in the past. This is a task that is not typical usage of
file history and is intended for administration only.

Status Selects the level of Permission for the user or group: Allow, Deny, Inherit or Not set.

1644
 16.1 Inspire Content Manager

Not Set is the default for any user added to the Name list. It is similar to Allow because
the user has permission to perform the action, however the Status will change to Inherit
if permissions are changed for any parent directory.

Inherit cannot be selected, it appears for a user when permissions for them have been
applied to a parent directory or feature, e.g. if Status: Deny is selected for a parent directory
then Inherit (Deny) will appear for all child directories.

Selecting Allow or Deny ensures the Status will not change when changing the Status
of any parent directory or feature, unless Set inherit recursively has been checked while
applying that change to a parent directory.

Set inherit recursively If checked, the Status: Inherit is applied to all child directories and
files for all users or groups.

Only available for files and folders.

16.1.6 Approval States

In this section: See also:
Approval States Dialog Inspire Content Manager Window Menu
Version Approval States Dialog

Approval states can be applied to files for version control. If a company employs an approval
process to certain files that will be distributed or used for printing (e.g. the design, design ap-
proval and production of a workflow), different users can apply differing approval states ac-
cording to their role in that approval process. Then the files can be manipulated accordingly,
e.g. a manager may only have access to files that are waiting requesting their approval and he
can give those files a status of ready for production if they are good enough.

First the different approval states must be created and assigned to users by an administrator
in the Approval States dialog; and then they can be applied to individual files via the History
or History Tree using the Version Approval States dialog. Files can be later searched for and
opened according to their approval state via the Enhanced Open dialog.

16.1.6.1 Approval States Dialog

To open the Approval States dialog go to Tools | Approval States in the Inspire Content
Manager Window Menu. Approval states can be added and edited using the icons.

1645
16 Related Applications

Options Description

Add Adds an approval state to the list and names it.

Edit Changes the name of the approval state.

Access Rights Selects Content Manager users and sets their permissions to employ the
approval states via the Access Rights dialog.

Remove Deletes the selected approval right.

Deletion cannot be reversed.

16.1.6.2 Version Approval States Dialog

To open the Version Approval States dialog, go to the History or History Tree dialogs and right-
click on a version to select Set Approval State.

In the dialog, the history of approval states that have been applied to that version are listed.
To set a new approval state, select it from the Name combo-box and click on OK.

Options Description

Name Selects the approval state to be applied.

The available states are those created by an administrator in the Approval States dialog.

Valid from / Expires Set a validity period for the approval state using date pickers.

Click on the O icon to edit the date. The default value of Now enters the current day
and time as the Valid from time.

Comment Enters a comment to the approval action for other users to read and act upon.

1646
 16.1 Inspire Content Manager

16.1.7 Database Link

In this section
Working with a Database
Working with a Disc File System

Database link enables you to set up a link to a file system or an ODBC database and list and
get data from there so you can work with them in Inspire Content Manager (VCS).

You can set up a connection in a dialog that is opened by right-clicking on a directory in the
Inspire Content Manager Explorer (VCS Explorer) window and selecting the option Add
Database Link. The dialog has three different tabs for scripts that list data stored in a file
system or database, open them and find out the latest file version. The scripts are not predefined
and have to be written by the user.

Options Description

Link name Sets the name of the directory in the Inspire Content Manager Explorer (VCS Ex-
plorer) window that will display the content of the file system or database.

List Script This tab contains a script that will, under the above specified directory, list data
contained in the file system or database.

Open File Script This tab contains a script that gets data from the file system or database
so that they can be opened in Inspire Content Manager (VCS). The script should return
data in binary format.

Query Last Version Script This tab can contain a script that checks the latest version and
modification time of a file in the database or file system. If there is no script, caching of
data is not performed and the file is retrieved from the file system or database every time
it is opened in Inspire Content Manager (VCS).

For the explanation of the rest of options see the Script Editor Dialog section.

The following special methods are available. Check the sample scripts in the sections Working
with a Database and Working with a Disc File System for examples of usage.

1647
16 Related Applications

List Script Methods

addListItem It is used for listing data items from the file system or database in the
Inspire Content Manager Explorer (VCS Explorer).

CurrentDir Returns the name of the directory whose content should be listed.

Open File Script Methods

ExpectedModifyTime It is the modification time of the file that is to be opened

(returned by the server). It is useful when you want to make sure that the version of
the opened file is really the latest one its value is compared with the ModifyTime
value. If there is a discordance (the file has been changed meanwhile), the openFailed
method should be called.

ExpectedVersion The same principle applies as for the ExpectedModifyTime

method.

FileName Returns the name and path of the file that is currently being opened.

justLatest Returns true if the version or modified time of a file is not specified.
The concordance between ModifyTime and ExpectedModifyTime is therefore
not tested.

openFailed Indicates that opening of a file has failed. In that case the Query Last
Version script is run again.

Query Last Version Script Methods

FileName Returns the name and path of the file that is currently being opened.

ModifyTime Its value is set in the script on the Query Last Version Script tab. It is
the modification time of the latest version detected.

Version The same principle applies as for the ModifyTime method.

Static variables can be defined and used across all three tabs.

16.1.7.1 Working with a Database

The sample scripts below can be used to retrieve data from an ODBC database.

List Script

ODBC.Database db;
db.connect("DATABASE=bugs;DRIVER={MySQL ODBC 3.51 Driver};OP
TION=0;PWD=pass;PORT=0;SERVER=server1;UID=bugs_ro");
ODBC.RecordSet rs;
rs=db.createRecordSet("SELECT realname FROM profiles");
while(rs.fetchNextRow())
{

1648
 16.1 Inspire Content Manager

addListItem(rs.StringValue[0],false,0,DateTime(),DateTime());
}

Open File Script

ODBC.Database db;
db.connect("DATABASE=bugs;DRIVER={MySQL ODBC 3.51 Driver};OP
TION=0;PWD=pass;PORT=0;SERVER=server1;UID=bugs_ro");
ODBC.RecordSet rs;
rs=db.createRecordSet("SELECT userid FROM profiles where realname="+'"'+Fi
leName+'"');
if(not rs.fetchNextRow())
{
logMessage("failed to find user "+FileName); //logs to ICM server log
openFailed();
}
Int userId=rs.IntValue[0];
rs=db.createRecordSet("SELECT image FROM gmcuserimages where
userid="+userId.toString());
if(not rs.fetchNextRow())
{
logMessage("failed to find image for "+userId.toString());
openFailed();
}
return rs.BinaryValue[0];

16.1.7.2 Working with a Disc File System

The sample scripts below can be used to retrieve data from a file system.

List Script

String currentDir="C:\"+CurrentDir;
File.FileInfoList fil;
File.list(fil,File.ListParam.All,currentDir);
for(Int i=0;i<fil.Size;i++)
{
addListItem(fil[i].NameExt,fil[i].isDirectory(),fil[i].Size,fil[i].Creat
eTime,fil[i].ModifyTime);
}

Open File Script

String file="C:\"+FileName;
File.FileInfoList fil;
File.listWithMask(fil,File.ListParam.All,file.Directory,file.FileNameExt);
logMessage("T1 "+fil[0].ModifyTime.toString());

1649
16 Related Applications

logMessage("T2 "+ExpectedModifyTime.toString()+" expected");

if(fil[0].ModifyTime!=ExpectedModifyTime and not justLatest())
{//checks whether the version of the downloaded file is the version that
is considered to be the latest one
openFailed();
return Binary();
}
File.Stream str=File.open(file,File.Mode.ReadOnly);
Int size=str.Size.toInt();
return str.readBinary(size);

Query Last Version Script

String file="C:\"+FileName;
File.FileInfoList fil;
File.listWithMask(fil,File.ListParam.All,file.Directory,file.FileNameExt);
ModifyTime=fil[0].ModifyTime;
Version=1;

16.1.8 Dependency Browser

See also:
History
How to Create and Use Labels

The Dependency Browser shows which workflows (WFD files) are using the selected file and
which other files any selected workflow is using itself.

If the file is a resource, this can be used to discover which workflows are using it. If the file is
a workflow, this can be used to discover which resources it uses. It searches for references in
the metadata item Dependencies of all files in the Search in location. Dependencies metadata
is added to workflows (WFD files) when they are placed in Content Manager.

Right-click on a file in the Content Manager Explorer and select Dependency Browser in the
File Context menu to open the dialog.

1650
 16.1 Inspire Content Manager

Options Description

Search in Locates a directory where referencing workflows will be searched for.

This must be a directory within Content Manager.

Search for Identifies the file which the search is being performed for.

This is the file that was selected when the browser was opened via the option Dependency
Browser in the File Context menu.

Referenced By Lists all workflows in the Search in directory which use the Search for file.

Only workflows that are in Content Manager will be listed here. Double-clicking on any
file in the list will make it the Search for file.

Refers To Lists all files that the Search for file is using as a resource.

These files are not necessarily in Content Manager. Double-clicking on any file in the list
will make it the Search for file.

Tip Other types of files than workflows can have their dependencies checked if the resources
have been listed in the file's metadata item Dependencies (via Metadata File Context menu).

16.1.9 EMC Documentum

In this section
Adding an EMC Documentum Link
Working with Files
Limitations

EMC Documentum is a system for content management, sharing and reusing. You can use
Inspire Content Manager (VCS) to work with the content stored on an EMC Documentum
server. A directory in Inspire Content Manager (VCS) can be linked to a directory in EMC Doc-
umentum, and the user can access the files stored on an EMC Documentum server via Inspire
Content Manager (VCS), modify them and save these modifications.

1651
16 Related Applications

Inspire Content Manager (VCS) currently supports EMC Documentum version 5.3.

16.1.9.1 Adding an EMC Documentum Link

To add an EMC Documentum link you need to have administrators rights.

In the Inspire Content Manager Explorer (VCS Explorer) in the directory tree right-click on the
folder where you wish to insert the EMC Documentum link. Select the Add EMC Documentum
link option. The EMC Documentum link is a virtual directory in Inspire Content Manager (VCS)
and the data is stored on the EMC Documentum server.

After you select this option, the following dialog opens:

1652
 16.1 Inspire Content Manager

Options Description

Link name Allows you to enter a name for the EMC Documentum link (visible as a directory
in Inspire Content Manager Explorer (VCS Explorer)).

Docbase Enters the name of the docbase (EMC Documentum feature, usually the name of
the server).

Path Allows you to define a path to a subdirectory in EMC. If left empty, the server opens
from the root.

User, Password Enters the user name/password for logging in to the EMC Documentum
server.

Login as current user The functionality is the same as when creating a MediaBin link. See
the section Adding a MediaBin Link for details.

The link configuration can be changed in the same dialog that can be displayed by selecting
the Edit Link option in the folders contextual menu.

16.1.9.2 Working with Files

Working with files is done in the same way as if they were stored in Inspire Content Manager
(VCS). The files are displayed in Inspire Content Manager Explorer (VCS Explorer) under the
folder that has been linked to EMC Documentum. See the section Basic Use of Inspire Content
Manager for details on how to work with Inspire Content Manager Explorer (VCS Explorer).

It is possible to set four types of file metadata (author, title, subject and keywords) for files
stored in EMC Documentum using commands in the ICM Comment edit area in the File Driver
Config dialog. The commands have the following format:

.Author:Value

.Title:Value

.Subject:Value

.Keyword:Value

16.1.9.3 Limitations
You can use all the functions that Inspire Content Manager (VCS) offers (file history, file com-
ments, labeling) with the exception of branches, which are not supported due to a difference
in implementation method between the applications.

Note Inspire Content Manager (VCS) server must run on Windows to be able to access EMC
Documentum, clients can be also on Macintosh computers.

1653
16 Related Applications

16.1.10 Enhanced Open Dialog

See also:
Open File Dialog
Approval States

The Enhanced Open dialog appears if you check Enhanced ICM open in the Open File dialog
when opening a file from Inspire Designer. It allows you to choose between the different versions
of a single file that have been created throughout its history.

All of the attributes in this dialog are searched for, backwards through time from the As of
date (the current date by default) and the first version which matches the attributes entered
in this dialog will be opened. However, some attributes must be matched (i.e. are mandatory)
and others will be ignored if they are not found, see the individual options' descriptions below.

Options Descriptions

Version Selects the version to be opened:

Latest Opens the latest version of the file which also conforms to any of the further
attributes specified in the dialog.

Use selection Opens the version of the file selected in the combo-box. The file
should also conform to any of the further attributes specified in the dialog.

Label If checked, selects a label which the file (of selected Version) should have.

Labels are only a preference. If a file has a label and the version meets the other parameters
in this dialog, that version will be opened as opposed to a version that does not have the
label. If no version is found with the specified label, a file will still be opened that conforms
to the other parameters.

Approval states If checked, specifies approval states which the file (of selected Version)
should have.

There can be many approval states listed here so that either a version with one approval
state or another can be opened, click on the 3 dots icon to select from any pre-defined
states. Approval states are mandatory, i.e. there must be at least one of the listed approval

1654
 16.1 Inspire Content Manager

states assigned to the version in order for the file to be open. If none of the listed states
are matched, no file will open.

As of date If checked, selects a date before which the search for versions will start.

The search for versions is done backwards through the history starting at (and including)
the time entered, e.g. the latest version is checked first. By default the search is started at
the current time but by, for example, selecting a past time in the combo-box here, any
versions between that time and the present will be ignored.

This can be used for re-prints, where many changes might have happened to a workflow
since a certain print job was produced. You simply want to return to the state the workflow
was at the time of that print job, so that the print can be reproduced accurately. By selecting
the date of that print job here, you can be sure that changes made after that date will not
be printed.

Preferred branches Determines which branches will be checked first for matching the other
attributes in this dialog.

All branches that have been made for all files in Content Manager are listed in Branches.
Move any desired branches, which apply to the file you want to open, across to this Pre-
ferred branches list with the Move Left icon. You can change the order that any
Preferred branches will be searched using the Move Up / Move Down icons.

16.1.11 History
See also:
History Tree

The History dialog lists changes made to a file while it has been in Inspire Content Manager.

To see the history of a selected file, right-click on that file in the Content Manager Explorer
and select Show History in the File Context menu.

To see the history of a file that is currently opened in Inspire Designer (e.g. a workflow), go to
File | Inspire Content Manager | History in the Workflow Window menu.

Right-clicking on any version reveals a context menu which has the same options as the History
Tree and Compare Versions appears if two versions are selected. Compare Versions opens
both versions in Inspire Designer with the Compare Workflows window-pane open which lists
the differences between the versions.

1655
16 Related Applications

16.1.12 History Tree

See also:
History
How to Create and Use Labels

The History Tree dialog displays the version history of a file in a dependency tree format.

To see the history tree of a selected file, right-click on the file in the Content Manager Explorer
window and select the Show History Tree in the File Context menu. The shortcut to this option
is <F9>.

To see the History Tree of a file that is currently opened in Inspire Designer (e.g. a workflow),
go to File | Inspire Content Manager | History Tree in the Workflow Window menu.

The items in the tree represent different versions of the selected file and any labels. The Checked
Out icon appears for versions that are checked out.

Clicking on a version or label displays related information below the tree, i.e. the Version
number; Branch name; any Branch Comment or Label Comment; any File Comment; and
any history of Approval States (see the section Approval States).

Checking Show deleted versions will display details of any versions that have been deleted
in addition to those that are still in VCS.

1656
 16.1 Inspire Content Manager

16.1.12.1 History Tree Context Menu

Right-clicking on a version opens a context menu which has options that are the same as the
File Context menu and some other options.

Options Description

Roll Back to Returns a file to a previous version. All changes and versions made since the
selected version was saved are erased.

Example There are 5 versions in the history tree. Click on version 2 and then select
Roll back to. All changes since version 2 are lost (only version 1 and 2 are kept).

Set Approval State Assigns a predefined approval state to the version via the Version Ap-
proval State dialog.

Remove Contents Removes the contents of the version and just keeps the version history.

The intention is to free-up space on the server, or to remove workflows that should never
be produced because they would cause a misprint.

16.1.13 Paths to Files in Content Manager

Paths to files stored in Inspire Content Manager can contain information about which version
or branch of a file you want to manipulate or simply open.

Such information can be used in paths in the Inspire Production Console and File Method scripts
(especially ICM methods). In case the path contains colons or backslashes, these need to be
preceded by the backslash \ escape character to be interpreted correctly.

Paths Description

B:String Opens the file version that belongs to the specified branch. If such branch does
not exist or the file is not found there, the last version of the file (main version) is opened.

Example The following sample searches for the file test.wfd with "branch1". If it
is not found there, it searches for "branch2". And if it is also not found there, the
main version is used.

vcs:B:branch1:B:branch2//test.wfd

1657
16 Related Applications

D:string yyyyMMddHHmmss Opens the version of the file according to its approval state
validity dates.

If the file has approval states applied, there is also a validity period for that approval state.
This path opens a version which has any approval state but which is valid at the time de-
scribed by yyyyMMddHHmmss.

If there are no approval states set, then it opens a version of the file that was checked-in
before the described date (and is still checked in).

Example
vcs:D:20090519120000//Froodeco/FroodecoEmail.wfd
This path opens all versions of FroodecoEmail.wfd which have any approval state
valid at midday on the 19th May 2009, e.g. it has Valid from 03/03/2009 and Expires
06/06/2009 set via the Version Approval States dialog.

FB:String Opens the file version that belongs to the specified branch, also the file resources
have to belong to that branch. If such branch does not exist or the file is not found there,
an error is generated and the file is not opened. The FB parameter can be placed in before
any branch name in the path (see the example).

Example The following sample searches for the file test.wfd with "branch1". If it
is not found there, it searches for "branch2". And if it is also not found there, an
error is displayed and the file is not opened.

vcs:B:branch1:FB:branch2//test.wfd

or

vcs:FB:branch1:B:branch2//test.wfd

FBNI:String Opens the file version that belongs to the specified branch.

In contrast to FB, only the WFD file has to belong to that branch and not also its resources.
The FBNI parameter can be placed before any branch name in the path (see the example
below).

Example The following sample searches for the file test.wfd with "branch1". If it
is not found there, it searches for "branch2". And if it is also not found there, an
error is displayed and the file is not opened. However, it is enough to find the file in
one of those branches. The file resources can be used from the main version (if they
are not in any of those branches).

vcs:B:branch1:FBNI:branch2//test.wfd

or

vcs:FBNI:branch1:B:branch2//test.wfd

1658
 16.1 Inspire Content Manager

FL:String Opens the file version with the specified label. If such a label does not exist, an
error is generated.

FLNI:String Opens the file version with the specified label. In contrast to FL, only the
WFD file has to have that label and not also its resources.

L:String Opens the file version with the specified label. If such a label does not exist, the
last file version is opened.

Example The following sample searches for the test.wfd with "first" label to create
a PDF out of it.

pnettc vcs:L:first//test/test.wfd -vcsaddress localhost -vcsuser admin

-vcspassword pass -e PDF

or

pnettc vcs:L:first://test/test.wfd -vcsaddress localhost -vcsuser ad

min -vcspassword pass -e PDF

Note Both possibilities are possible, with the colon behind the label or without.

S:String Opens the version of the file according to the approval status.

V:String Opens the specified file version according to the version ID.

Example vcs:L:MyLabel:B:MyBranch1:B:MyBranch2:V:1//test.wfd

16.1.14 Inspire Data Centers

16.1.14.1 Data Centers
In this section: See also:
Data Centers Admin Dialog Data Center Servers
Edit Data Center Dialog Expressions for Splits
Edit Data Sets Dialog Decision Trees
Edit Splits Dialog Data Center Config Module
Data Center Input Module
Data Center Merger Module
Data Center Output Module
Data Output Module

Inspire Data Centers are data storages that are specifically for analysis and manipulation per-
formed by GMC Software Technology products such as Inspire Designer, Inspire Campaign Man-
ager and Inspire Tracker (Click-Through Server). In Inspire Designer, workflows can read data

1659
16 Related Applications

from a data center, manipulate it then use the data to produce personalized documents; or
write it back to the same data center, another data center or any data output you require.

Data centers use databases (such as Microsoft SQL Server) to hold the data, but they are
managed from Content Manager Explorer. Therefore, you must be logged in to Content
Manager to be able to use any data center. Content Manager controls communication with
individual databases via Data Center servers, of which there can be many installed on different
machines. Having multiple data centers can be useful: Maybe to keep separate data for different
clients; or to have differing amounts of data stored on different servers.

A data center is made up of data sets, each set may have a different structure of fields and an
independent number of records, it is the equivalent of a data file. However, each data set has
to be given a field named Id which contains unique values for identification purposes.

Data sets can be further split into groups of records (called splits) according to certain criteria.
The criteria can be specified by expressions, workflow modules, or scripts in a workflow. The
intention is that these records can be used for a specific purpose, e.g. to target an advertising
campaign at people of a certain age group; or at people who have clicked-through on a certain
advertisement in the past.

To be able to read that data into a workflow, add the Data Center Config module and nominate
which of the data sets or splits are to be used. Then add either the Data Center Input module
or Data Center Merger module.

To create and edit data centers, go to Tools | Data Centers in the Inspire Content Manager
Explorer menu and the Data Centers Admin dialog opens.

Data Centers Admin Dialog

In order to be able to create data centers and manage which users are allowed access to each
of them using this dialog, you must have the access permission Manage data centers assigned
to you in the User Admin dialog. However, if you have been assigned as a user of a particular
data center (by someone with that correct permission) via the Access Rights dialog, then you
will be able to see those data centers listed here and edit data sets in them.

Select a data center and choose options from either: the Data Centers menu; by right-clicking;
or using the icons at the bottom of the dialog. The options are the same in each place.

Options Description

Add Data Center Adds a new data center via the Edit Data Center dialog.

Edit Data Center Edits the selected data center via the Edit Data Center dialog.

1660
 16.1 Inspire Content Manager

Edit Data Sets Creates and edits data sets in the selected data center via the Edit Data
Sets dialog.

Edit Access Rights Selects Inspire Content Manager users and sets their permissions to
access and use the selected data center via the Access Rights dialog.

Restart Data Center Stops and restarts the data center.

Restart the data center after changing some setting (e.g. access rights) in order to apply
those changes. During restart all running operations are cancelled, all connected clients
are disconnected and the data center is initialized with the new settings.

Remove Deletes the selected data center.

Deletion cannot be reversed.

Data Centers can be sorted by clicking on the column titles.

Edit Data Center Dialog

This dialog is opened by clicking on the Edit Data Center icon in the Data Centers Admin
dialog. It controls parameters of the database where the data center will be.

Options Description

Name Names the data center.

The Name will be how the data center is identified or selected (via the Data Center Config
module) if data centers will be read from (or written to) by a workflow.

Server Determines the host server for the Data Center server, e.g. if the server is running as
a service on the local computer then you can enter localhost.

Port Determines which port the data center will listen to in order to access the Data Center
server that will be used to contact the database.

Storage type Selects the type of database the Data Center server will communicate with:

BTDB, SQLite or Memory.

BTDB and SQLite build their own external, key-value database as a BTDB/DB data
file. They do not require a database to be installed and are faster than relational
databases.

Memory does not require a database or Data Center server, allowing you to manip-
ulate data if you don't have access to a database, e.g. use workflow to read data

1661
16 Related Applications

from a CSV file (via a Data Input module) to a data center and create some splits,
and save the records from the splits to another CSV file. However, if the data
center or your computer is restarted the content of the data center is permanently
deleted.

SQLServer, MySQL or Oracle.

For sharing data between different users, it is recommended to use these commer-
cially-available relational databases which must be installed separately.

Connection string Assigns the code to be used for connection to the database via the Data
Center server.

For Storage type: SQLServer, MySQL or Oracle this is a connection string that contains
the information how to access the database. A connection string is database specific, it
contains info about the name of the database and the user and so it is dependent on the
Storage type and individual requirements.

Example

SQLServer connection string could

Data Source=JIMENEZ\SQLEXPRESS;UID=r.jimenez;Trusted_Connec
tion=Yes;APP=InspireDesigner;WSID=JIMENEZ;DATABASE=dba

MySQL connection string could be:

Persist Security Info=False;database=datacenter7;serv
er=bev-bev;user id=datacenter7;Password=pass

Tip Connection strings can be created in the ODBC Data Input module. See the example
in the separate section Data Center Servers.

For Storage type: BTDB or SQLite enter the path to the BTDB/DB file. Entering a file that
does not exist will create a new one. The path is better defined as absolute (e.g. Z:\Re-
sources\Data\DataCenterA.btdb), but a relative path (e.g. \Data\DataCenterA.btdb) will
lead from where Data Center server has been started, e.g. from c:\Windows\System32 if
it is running as a service.

For Storage type: Memory leave this edit-box empty.

1662
 16.1 Inspire Content Manager

Edit Data Sets Dialog

This dialog is opened by clicking on the Edit Data Sets icon in the Data Centers Admin
dialog. It manages the many data sets that can be created in a single data center.

Options Description

Create New Creates an empty data set.

The New Data Set dialog opens where a Name can be entered. The Name will be how
the data set is identified or selected (via the Data Center Config module) if data centers
will be read from or written to by a workflow.

Data sets contain one structure of related fields that contain differing values for each record.

Import Imports previously saved data and its structure from an XML file into the selected
data set.

Export Exports the selected data set to a separate XML file.

Show Data Definition Views the data structure of the selected data set.

Edit Splits Creates and edits splits in the selected data set via the Edit Splits dialog.

Edit Decision Tree Creates and edits decision trees.

Decision trees are data-analysis tools that apply attributes to data sets and display how
many records match them (and how many do not) as a dependency tree. This tool can
help decide which records are the best fit to a question that is applied to one field, e.g.
the best customers to target for a marketing campaign.

Recalculate Definition Recalculates the structure of the selected data set.

With repeated use (e.g. different workflows writing to the data set) it can happen that
some fields or arrays become empty of data. Recalculation removes such fields.

Clear Data Set Removes all data from the data set.

Remove Deletes the selected data set.

1663
16 Related Applications

Deletion cannot be reversed.

Data Sets can be sorted by clicking on the column titles.

Edit Splits Dialog

This dialog is opened by clicking on the Edit Split icon in the Edit Data Sets dialog. It manages
the many splits that can be defined in a single data set.

Options Description

Create New Defines a split using a conditional expression.

The New Split dialog opens where a Name and Expression can be entered. The Name
will be how the split is identified or selected (via the Data Center Config module) if data
centers will be read from or written to by a workflow.

Splits are lists of Ids for the records that match the corresponding Expression. Then, if a
split is subsequently used by a workflow to process data, the Ids are matched with the
corresponding records in the data set and all of the data from those records can be used.
The Expression is the condition that the data must meet in order for its Id to be included
in the split. Expressions have their own specific syntax which is described in the following
section Expressions for Splits.

To remember which fields are present in a data set while trying to use them in expressions,
the Data Definition is listed to the left of the New Split dialog. Then, after entering an
expression, check whether it is valid by clicking on the Check icon.

It may happen that an expression is valid but unable to be calculated (e.g. because of a
field missing in some record), so check the State column to ensure that it does not read
Not defined.

Export Exports the Ids of the records from the selected split to a separate CSV file.

Calculate Calculates the selected split by using its Expression.

This applies the defined expression to the data set and retrieves the Ids of those records
which meet the conditions of it. Calculation is done automatically when a new split is
created, however they are not recalculated automatically (check the date in the Calculated
column) and if more data has been added to the data set in the mean time then the Ids
in the split may not be current. If more data has been added to a data set since the last
calculation was made the State of the data center is should be Expired.

Refresh Refreshes the split data from the database.

It can happen that new splits are added to the data set; or new record ids are added to
individual splits during the time that this dialog is open, clicking on this synchronizes all

1664
 16.1 Inspire Content Manager

of the info seen in this dialog with the actual data in the server. Refreshing is done auto-
matically at regular intervals and every time Calculate is performed.

Remove Deletes the name of the selected split.

If a split is deleted, its Name is removed but the expression is kept temporarily. This is
because, if two or more users create two or more separately named splits using the same
expression, only one instance of the expression exists in the data center. The expressions
are monitored automatically on a regular basis and will be removed: If they are not used
by any nominated splits; and have not been used for a long period of time.

Splits can be sorted by clicking on the column titles.

Access Rights Dialog

This dialog is opened by clicking on the Edit Access Rights icon in the Data Centers Admin
dialog. It manages which users can access the data centers.

Options Description

Name Shows which Inspire Content Manager users have access to the selected data center.

Add users to the list using the Create New icon. This opens the Add Users dialog which
lists all users and groups that have been created via the User Admin dialog for Inspire
Content Manager. There you can select which users will have access to the data center.

Having access to the data center means that the user will be able to access and edit the
data sets.

Permission Lists the access permissions that the selected user can be granted: Read and
Write.

Status Selects whether the corresponding Permission should be allowed (Allow) or denied
(Deny) to the selected user.

Allow means that the user will see the data center in the Edit Data Center dialog (but not
edit it) and be able to access the Edit Data Sets dialog (via the Edit Data Sets icon) in
order to edit any set in that data center.

1665
16 Related Applications

16.1.14.2 Data Center Servers

In this section: See also:
Command Line Parameters Data Centers
Commands Used Within the Server
Window

A Data Center server must be installed so that Inspire Content Manager can communicate with
the data center, except when using Storage type: Memory (see Edit Data Center dialog).

One Data Center server is required for each installed database or BTDB/DB file. The server ex-
ecutable is ServerService.exe which is distributed separately to Inspire Designer along
with its other component files. All the component files should be placed in the same directory,
either locally to the database or across a network.

It is recommended to install ServerService.exe so that it runs as a service.

Example How to Set Up the Server

To create a data center and connect it to a commercially-available, relational database
(e.g. Microsoft's SQL Server Express) on your local computer:

1. After installing the external database application (e.g. SQL Server Express), create
a new database there and name it.

2. Install the Data Center server as a service using the command line parameters -i,
-p and -n , e.g. >"Z:\Program Files\ServerService.exe" -i -p
50505 -n DataCenterA

3. Go to Content Manager Explorer, select Tools | Data Centers and Add Data
Center in the Data Centers Admin dialog.

4. Fill in the Edit Data Center dialog:

Server will be localhost.

Port must be the same as entered in step 2, e.g. 50505.

Storage type for SQL Server Express would be SQLServer.

Connection string must be created in the SQL Server syntax, which can be
done via Create Connection String in the ODBC Data Input module.

However, the string returned by that module includes the driver type which
is here determined by Storage type and so must be deleted, e.g. for connec-
tion string
DRIVER=SQL_Server;SERVER=JIMENEZ\SQLEXPRESS;UID=r.jimenez;Trus
ted_Connection=Yes;APP=InspireDesigner;WSID=JIMENEZ;DATABASE=dba

delete the DRIVER=SQL_Server; and enter Connection string:

SERVER=JIMENEZ\SQLEXPRESS;UID=r.jimenez;Trusted_Connec
tion=Yes;APP=InspireDesigner;WSID=JIMENEZ;DATABASE=db23

1666
 16.1 Inspire Content Manager

You should now be able to continue building you data center (e.g. editing data sets via
Edit Data Sets in the Edit Data Center dialog), however some changes can make the
Data Center server stop running as a service and you might need to restart. See the sep-
arate section Running Servers as a Service.

Command Line Parameters

From your system console (e.g. MS Windows Command Prompt console cmd.exe) you can
enter the following command lines:

-h, -?, -help Displays the Help screen.

-i, -install Installs the Data Center server as a service.

-p, -port Specifies the port number to be monitored.

This should be the same as entered for Port in the Edit Data Center Dialog. The available
range is 165535.

-n-override_name Renames the server. e.g. for viewing in the list of services that can be
viewed in the Microsoft Management console.

-u, -uninstall Uninstalls the service.

Commands Used Within the Server Window

In the Server application itself, you can enter the following commands:

h Displays the help screen.

i Displays information about the status of the server.

q Shuts down the server.

16.1.14.3 Decision Trees

See also:
Edit Data Sets Dialog
Expressions for Splits

1667
16 Related Applications

Decision trees are a tool for data analysis that works in cooperation with Inspire Campaign Man-
ager (another Inspire software application).

They categorize records by applying attributes to data sets and then display which records
match those attributes (and which do not) as a dependency tree. The attributes ask which re-
cords have differing matching values in a series of chosen fields. As a result, a breakdown is
displayed in a dependency-tree format, which guides you through which records fit which at-
tributes and provides corresponding statistics on how well they fit it.

One intention is that decision trees will help decide which records are the best fit to a set of
preferences that have been expressed (e.g. in a survey) and identify the best customers to target
for a marketing campaign. The current functionality is aimed at administration for Inspire Cam-
paign Manager (where chosen nodes of the decision tree can be directly used as expressions
for creating splits) and you can alter advanced parameters of the data analysis methods which
cannot be adjusted in that application. However, it is not possible here to view or directly use
the records that are represented by the leaf nodes of the tree.

Decision Trees can be created and edited from the data sets that they analyze, i.e. via the Edit
Data Sets dialog. Click on the Edit Decision Trees icon to Open the Decision Trees dialog.

Decision Trees Dialog

Options Description

Create New Creates a new decision tree.

The New Decision Tree dialog opens where a Name can be entered.

Edit Edits the selected decision tree via the Edit Decision Tree dialog.

Calculate Calculates the selected decision tree using the attributes defined via the Edit
Decision Tree dialog.

Calculation is not automatic when a new decision tree is created, so this icon must be
clicked on each time the Edit Decision Tree dialog is updated. Also check the date in the
Calculated column, if more data has been added to the data set in the mean time then
the decision tree may not be up-to-date. If more data has been added, the State of the
data center is Expired, whereas Failed means that the calculation cannot be done on the
data set with the parameters entered in the Edit Decision Tree dialog and so they need to
be adjusted.

Not defined in the Calculated column means that no calculation has been performed.

1668
 16.1 Inspire Content Manager

Show Model Shows the calculated decision tree and its related analysis results in the
Decision Tree Model dialog.

Refresh Synchronizes the list of decision trees with the actual state of the data center.

It may occur that other users are creating or editing decision trees. Clicking on this icon
checks the current state of the data center and any trees and updates the list in this dialog.

Remove Removes the selected decision tree.

Deletion cannot be reversed.

Edit Decision Tree Dialog

Options Description

Data definition Displays the data structure of the data set which the decision tree will be
analyzing.

Clicking on the Export icon, will save the data structure to a new RD file so that it may
be replicated, e.g. imported into a workflow via the Data Center Input module.

Split for model Enters an expression to split the data set, in order to determine which records
should be analyzed by the decision tree.

This can reduce the data set to a smaller set of records when it is not required to analyze
the whole data set, however entering true here determines all records in the data set
will be used.

See the separate section Expressions for Splits for the syntax for expressions. The Check
icon checks if the syntax of the split is valid.

Split for fit Enters an expression to split the data set, in order to test whether the data ana-
lyzed by the decision tree (i.e. selected by Split for model) is representative of the rest
of the data set.

1669
16 Related Applications

This can reduce the data set to a smaller set of records when it is not required to test the
whole data set, however entering true here determines all records in the data set will
be tested and entering false means that none will be. It is recommended that the data
selected by this expression does not include the records that are selected by the split
entered for Split for model.

This test is known as fitting, the results of this test are seen on the Fit tab of the Decision
Tree Model dialog.

See the separate section Expressions for Splits for the syntax for expressions. The Check
icon checks if the syntax of the split is valid.

Describe Enters an expression that selects which data from the data set will be used as the
root of the decision tree, i.e. which field contains the decisions that you want to analyze
in comparison with the attributes listed in the Attribute column.

See the separate section Expressions for Splits for the syntax for expressions, however the
most common expression is to enter a field name (from the Data definition area and
case sensitive) to determine that the whole field should be analyzed. Not necessarily all
values in that field are analyzed, because the range depends on the expressions which are
entered for Split for model. The Check icon checks if the syntax of the split is valid.

This expression is applied to both the data resulting from Split for model and Split for
fit. As a result, the model and statistics in the Decision Tree Model dialog are calculated
using the statistical method selected for Analysis method.

Attribute Lists the attributes that determine which data will be further represented in the
decision tree, in comparison to the data that has already been selected by the expression
entered in the Describe edit-box.

Create New Adds a new attribute.

This opens the New Attribute dialog:

Expression Enters an expression to select which data the attribute will consist of.

Typically the expression will select another field (as opposed to one selected by
Describe) and entering a field name (as seen in the Data definition area) de-
termines that the whole field should be analyzed. See the separate section Ex-
pressions for Splits for the syntax for expressions.

1670
 16.1 Inspire Content Manager

This expression is applied to both the data resulting from Split for model and
Split for fit. As a result, the model and statistics in the Decision Tree Model
dialog are calculated using the statistical method selected for Analysis method.

Divide into intervals If checked, allows values of numerical data-types (int, int64,
double, currency or date-time) to be grouped in order to avoid having many
branches to the decision tree.

You can further enter Max intervals and Min intervals to help determine how
many intervals there will be, however the actual number of intervals depends on
how many different values there are in the data. For example, if there are only
three different values (5, 9 and 12) there can only be a maximum of three inter-
vals.

In most cases, there are many different values and some need to be merged so
that there are less intervals. Which values fall in to which interval is calculated
by an algorithm which starts with as many intervals as there are different values,
then merges neighboring intervals until a number of intervals within the chosen
range is achieved. In each step, the algorithm chooses the closest and best inter-
vals to merge and the steps are continued until the number of intervals fall
somewhere within the range set by Max intervals and Min intervals.

Example In a field called Age (of integer data-type), there are as many
possible values as there are peoples' Ages (1-100). But, for the purpose of
the decision tree, you do not want there to be 100 different branches res-
ulting from any one leaf node.

Therefore, you can enter Max intervals as 5 in order to determine that

there are only five (or less) possible values for the attribute, each of which
represent a range of values (that could approximate to 1-20, 20-40, 40-60
etc., if there are enough different values for the attribute and they are
evenly weighted).

However, if there were only records with values 65, 65, 65, 65, 50, 50 and
22, then this could only be one, two or three intervals which is below the
Max intervals. It follows that, no further division would be done and there
would be the same three intervals that would have existed without applying
Divide into intervals.

Min intervals is not a strict minimum, it only sets the lower limit of when the
algorithm should be applied. Therefore, if Min intervals is set to 4 but there
are only two possible values (e.g. 1 or 2) then there will only be two intervals.

Edit Edits the selected attribute via the Edit Attribute dialog, which has the same
options as the New Attribute dialog.

Remove Removes the selected attribute.

Deletion cannot be reversed.

Alternatively, select a field in the Data definition area and click on the Move Right
icon to create an attribute which uses all values of the selected field.

1671
16 Related Applications

Model Parameters

Analysis method Selects which statistical method will be used to decide which records
fit the attributes:

Gini index

Entropy

In the equations shown above, K is the number of different values of an attribute

(often referred to as classes) where p is the probability of the value with index i.

Both methods are algorithms that look at attributes (e.g. fields) and compare the
number of occurrences of any given value to the total number of records. They
measure impurity or chaos, e.g. high entropy is chaotic (no relationship between
values) and low entropy is ordered (a direct relationship between values). Experience
will show that the algorithm selected here is not very important and the resulting
decision trees are very similar. However, Gini index is commonly considered a better
method.

The selected algorithm is applied to all attributes (that have not yet been used in the
decision tree) at each level of the decision tree in order to determine which one will
be represented at that level, e.g. the attribute with the lowest entropy value will be
the next decision in the tree. The resulting tree should cover all possible attribute
values (within the Split for model) with the least number of branches and fewest
levels.

Example Here we will describe how entropy works in order to roughly illustrate
how both algorithms work, without describing the math of either.

The following data set describes a decision that was taken (i.e. what to do in
the evening) and some other factors about that evening that may have had (or
may not have had) some influence on that decision.

Weather Friends Available? Spare Cash? Decision

Conditions

Hot Yes Yes Pub

Hot No Yes Sport
Mild Yes Yes Pub
Cold Yes No Pub
Cold No Yes Televi-
sion
Cold Yes No Pub
Mild No No Pub
Mild No Yes Shops

1672
 16.1 Inspire Content Manager

Weather Friends Available? Spare Cash? Decision

Conditions

Mild Yes Yes Pub

Hot No Yes Sport

Here in the Edit Decision Tree dialog, we can choose to analyze the 'Decision'
field by entering the expression Decision (to refer to the field name) in the
Describe combo-box.

Later, the value of the decision (Pub, Sport, Shops or Television) can be selected
in the Values combo-box in the Decision Tree Model dialog. This will reduce
the analysis of 'Decision' to two possible outcomes: True or false (e.g. Pub or
not Pub) and the entropy of that value can be calculated.

Next, the other fields in this data set are described as expressions in the Attrib-
utes table. This means that they will be analyzed by taking each possible value
of that field and calculating its overall entropy. This is then compared to the
entropy of the decision value selected for Values.

If we take 'Friends Available?', there are two possible values (Yes or No) and
two possible outcomes (Pub or not Pub). First the entropy is calculated for Yes
which is returned by 5 records:

Friends Available? Decision

Yes Pub
Yes Pub
Yes Pub
Yes Pub
Yes Pub

It can be seen that this has the lowest possible entropy because every time that
friends were available the decision was to go to the pub, i.e. no chaos here.
However, to know the entropy for any attribute as a whole, all possible values
have to be considered, so:

Friends Available? Decision

No Sport
No Television
No Pub
No Shops
No Sport

It can be seen that the decision of going to the pub when friends were not
available has a much higher entropy, i.e. there is no clear correlation. Yet the

1673
16 Related Applications

entropy of the attribute (as a whole) is the weighted average* of all values, e.g.
both Yes and No.

This calculation of averages is done for all fields (attributes) and the resulting
entropies are compared to the entropy of the Describe split (the field 'Decision').
They should all have smaller values than the Describe split and the attribute
with the smallest value of them all is chosen for the next level of the tree.

In fact, of the above three attributes ('Weather Conditions', 'Friends Available?'

and 'Spare Cash?') it is 'Weather Conditions' that has the lowest entropy and
so it would appear in the next level.

The algorithm is recalculated for each level, therefore the entropy for 'Friends
Available?' and 'Spare Cash?' are calculated on each branch in relation to
'Weather Conditions' (not Decision). In this example, it can be seen that 'Friends
Available?' has the next lowest entropy for two of the three possible 'Weather
Conditions' branches (Mild and Hot), but the attributes on this level could have
been different for each branch (if the values of Friends Available? and Spare
Cash? had differing entropies). A description of all the information displayed by
the tree can be found in section Model Tab.

In summary, the biggest difference in entropies will help make the fastest de-
1)
cision, therefore less levels in the tree.

Max. model depth Determines the maximum number of levels of nodes that the decision
tree will contain.

1)
*Weighted average considers the number of occurrences while calculating the mean value.

1674
 16.1 Inspire Content Manager

Example If 3 is entered here, the decision tree will have the root node and
three levels of leaf nodes.

Notice that (Age>=32.0) & (Age<38.0) on the left could easily be further
analyzed, but the branch is stopped because it is on the third level.

Min. number of values Determines the minimum number of records with any value*
in order to continue analysis of that branch of the tree.

*This means the value of any single attribute, e.g. if 2 is entered here and an attribute
which specifies the gender of people only has two females then it will not be analyzed
further.

Example If 100 is entered here, the decision tree will not continue a branch
if there are less than 100 records that match an attribute value or value range.

Notice the Credit_cards attribute in the screenshot. The values in square

brackets (e.g. [86]) indicate the number of records, it can be seen that if the
number is less than 100 (as it is for Credit_cards<2) then the Cred
it_cards attributes is not analyzed further.

Max. frequency of value Determines the maximum frequency of a value* in order for
the attribute to stop being analyzed. The units are percent.

*This means the value of any single attribute, e.g. if 99 is entered here, then if 99%
of the values are the same then it will not be analyzed further.

Frequency is used because it is not possible to know how many records there will be
in a split, and so a 'maximum number of values' would not be easy to apply.

Min. relevancy of attribute Sets a minimum level of relevancy for any attribute in order
for it to be used in the analysis. The units are percent.

1675
16 Related Applications

The calculated percentages for the relevancy of each attribute can be seen on the
Relevancy tab. If the value of any attribute (as listed there) is less than the value
entered here, then that attribute will not appear in the decision tree on the Model
tab of the Decision Tree Model dialog.

Decision Tree Model Dialog

The Decision Tree Model dialog shows the results of the decision tree calculations that have
been entered in the Edit Decision Tree dialog.

It is opened by clicking on the Show Model icon and has the following tabs:

Model

Relevancy

Fit

Model Tab

The Model tab shows the decision tree. The decision (the field selected for Describe in the
Edit Decision Tree dialog) is at the root and the attributes appear in the following levels of
nodes according to the results of the statistical method selected for Analysis method and the
other parameters set.

Options Description

Values Selects which value (returned by the expression set for Describe in the Edit Decision
Tree dialog) will be the root decision that will be analyzed by the tree.

1676
 16.1 Inspire Content Manager

Example A data set lists when a person played golf and some related conditions.
There are 14 records of which three of them are:

outlook temperature humidity windy class

overcast 72 90 true play

overcast 83 78 false play
rain 65 70 true don't
play

In the Edit Decision Tree dialog, the expression for Split for model is true (i.e. all
data in the data set will be used) and class (the field) has been selected by the
Describe expression. The field 'class' has only two possible values, play or don't play.

In the above screen shot of the Model tab, it can be seen that play has then been
selected for Values. This means that we are asking: Of all the values in the 'class'
field, which ones have the value play?

is the root node of the tree. It tells us that: true is the expression for
Split for model; there are 14 records in Split for model; and that 64.29 percent
of those records are play.

is a leaf node in the tree. It tells us that: for the outlook field with the
value rain, there are 5 records and that 60% of those 5 records (i.e. 3 records) also
have the value play in the class field.

Relevancy Tab

The Relevancy tab shows the overall relevancy of each of the attributes defined (entered in the
Attribute column) in the Edit Decision Tree dialog.

The relevancy of an attribute depends on whether it has any influence on the final decision.
For example, for an office worker (who works indoors) we could assume 'tasks they do at work'
has no relevance to the 'weather outside'. However, here relevancy is calculated with an al-
gorithm that does not have any knowledge of experience and compares values of the attribute
to those of the resulting decision (from the Describe expression in the Edit Decision Tree dialog)
in order to return relevancy as a percentage. 0% being irrelevant and 100% meaning that
every decision was based on the appearance of a corresponding value of an attribute.

1677
16 Related Applications

Fit Tab

The Fit tab breaks down whether the data defined by Split for model in the Edit Decision Tree
dialog is representative of other data from the same data set. This 'other' data is defined by
Split for fit, which is intended to be a different set of records to those used for Split for
model in order for this tab to have some meaning.

The columns represent the values that are predicted by the model and the rows are the actual
results.

Example Looking at the screenshot above, it can be seen that, for the expression set
for Describe in the Edit Decision Tree dialog: 5300 values of 0 were found as predicted;
116 values of 1 were found, when 0 was predicted; 152 values of 0 were found, when
1 was predicted; and 228 values of 1 were found as predicted.

We can also see that 26 values were found that are unable to be predicted by the current
model, i.e. values 0 and 1 have been found for Describe, but they were a result of attrib-
utes that were not analyzed and so could not have been predicted.

Notice that the number of unclassified values (26) is very small in comparison to the total
number of records (over 5000) and so it can be said that Split for model is a good fit to
the data in the data set.

Options Description

Correctly classified / Unclassified Shows the accuracy of the Split for fit data in compar-
ison to the Split for model in terms of percentage.

Correctly classified shows how many values were correctly predicted, therefore the
higher the percentage the better the fit of the data used in the model.

16.1.14.4 Expressions for Splits

See also:
Edit Splits Dialog

An expression is the condition used to determine which data will be in a split.

Expressions can refer to a single field (e.g. Age); or they can manipulate fields, e.g. Age > 20
means that if the value in field Age (Int) is greater than 20 then return its Id to the split; and
they can be created for fields of any of these data-types: String, Int, Int64, Double, DateTime,
Bool, Currency.

1678
 16.1 Inspire Content Manager

In the below list of expression syntax, we refer to any complete expression using E.

Binary Operations
E & E is Boolean AND; E | E is Boolean OR; E = E is equal to; E != E is not equal to;
E > E is greater than; E >= E is greater than or equal to; E < E (less than); E <= E (less
than or equal to).

Conditional Operator
? can be used to evaluate a condition, e.g. to select the field with the smaller value: a < b
? a : b which means if a is less than b return a, else return b.

Convert Data-Type
String(E); Bool(E); Currency(E); DateTime(E); Double(E); Int(E); Int64(E)
convert

Data Selection
true returns all records in a data set or an array that it is applied to, false does not return
any.

To return the first set of records for which the sub-expression is true:

Take(E, count) for a specific number of items, e.g. Take(true, 5) selects the
first 5 items.

TakePart (E, percent) for a number of items defined as a percentage of the

whole number of items, e.g. TakePart(Age>20, 33) selects first 33 percent of
items with field Age having a value less than 20.

Alternatively, to randomly select records for which the sub-expression is true:

Random(E, count, seed) pseudo-randomly selects a fixed number of items using

a seed number.

RandomPart(E, percent, seed) pseudo-randomly selects a percentage of the

total number of items using a seed number.

The seed can be any number and if you use the same seed for the same sub-expression (E)
then the same items will be selected, e.g. RandomPart(true, 10, 111) selects random
10% using the seed 111.

Find a Sub-String in a Value

Contains(E, string, case), e.g. Contains(Status, "vip", Ignorecase)
looks for the string VIP in a field named Status.

1679
16 Related Applications

Negate
! E negates the expression, i.e. if expression is not met then it returns true.

Optional Fields
If you are not sure if a field exists in all records use: Exists(E)

Example (Exists(ZIPcode)) & (Contains(ZIPcode, 'nsw', Ignore

case)) means that if the field ZIPcode exists and the ZIPcode field contains the string
'nsw' then return the record's Id to the split.

Alternatively, if a field does not exist, you can return an empty string instead to avoid the split
calculation failing: E ??''

Example The previous example could be expressed as: Contains(ZIPcode ??

'', 'nsw', Ignorecase)

Reference Other Splits

Split(data6split7), where data6split7 is the DB Name of the split.

Split('mySplitName'), where mySplitName is the Name of the split.

Sorting
Sort(E1, E2, Ascending) or Sort(E1, E2, Descending) sort records by sub-ex-
pression E2 when sub-expression E1 is true, e.g. Sort(Split('Men'), Age, Descend
ing) sorts by age if they meet the condition that they are men.

Special Characters in Field Names

Field("fieldname") if a field name contains special characters (( ) ! = | & < > [ ] ? : + - /
* % ^ @ # $ ; | \), e.g. Contains(Field("my&field"), 'a', Ignorecase) where
& is a special character.

Strings
"""hello""" identifies the string "hello" where the double-quotes are part of the
string (its the same as '"hello"' if using single quotes), i.e. if using double quotes

1680
 16.1 Inspire Content Manager

to identify a string, any double quote characters which are part of that string must be
doubled.

'\'hello\'' identifies the string 'hello', i.e. if using single quotes ' ' to identify a
string, use backslash \ to escape special characters. E.g., 'boy\\girl' for string
boy\girl.

But remember, with double quotes "" to identify a string, backslash \ has no special meaning
and so escape sequences cannot be used.

Time
Now() gives time when calculation started.

Today() returns time of start of day when calculation started.

Working with Arrays

ArrayItem(Months,0) ; Array[0] reference records/items within an array.

ArrayCount(E) returns the count of items in the array determined by E.

Array.Item[10] selects an array item.

Array.Item[10].Field selects the value of a field from an array item.

Example ArrayCount(Accounts.Item)>1 & Accounts.Item[1].Clos

ingBalance>20000.00

Means: If the second value returned by the field Accounts.ClosingBalance is

greater than 20 000 (double data-type), then return the record's Id to the split.

FindFirst(Array, E) returns the index number of first match to the condition in

an array, but with no matches the value is -1.

FindLast(Array, E) returns the index number of last match to the condition in

an array, but with no matches the value is -1.

TrueForAll (Array, E) true if all items in an array satisfy the condition.

TrueForAny(Array, E) true if any items in an array satisfy the condition.

Example

1681
16 Related Applications

For the above record definition, we want to know if some of the Months contain
more than 10 calls, i.e. the equation will return true if array Months, contains any
Calls array with more than 10 items:

TrueForAny(Months, ArrayCount(item.Calls)>10).

This above expression could also be:

TrueForAny(Months, (i)=>ArrayCount(i.Calls)>10)

Aggregate(Array, accumulator, (value, item, index)=>E) returns a

single value calculated from an array of items using the given expression E.

The expression is evaluated on each item of the specified array. The accumulator stores
the intermediate result: Use a large value for storing single results; or a small value for
storing sums, e.g. if trying to find a minimum value you want to know only lowest value
found and so 999999 might be used; but if calculating the sum of many fields you
should use 0 because it needs to store the subtotal of all previous items. To multiply,
use the accumulator 1 because 0 will always result in zero.

Example

For the above record definition, we want to sort by the sum of duration of all calls:

Sort(true, Aggregate(Months, 0, (mv, mi, midx)=>(mv + Aggreg

ate(mi.Calls, 0, value + item.Seconds))), Descending)

To sort by the shortest call:

Sort(true, Aggregate(Months, 999999, (mv, mi, midx)=>(mv < Aggreg
ate(mi.Calls, 999999, value < item.Seconds ? value : item.Seconds )
? mv : Aggregate(mi.Calls, 999999, value < item.Seconds ? value :
item.Seconds ))), Ascending)

To select the customer which has an average call length in second month of > 0.5:
Aggregate(Months[1].Calls, 0, value + item.Seconds) / Array
Count(Months[1].Calls) > 0.5

In the above expression, notice how the index operator [1] is used to determine
the second value in the array (the first value in an array has the index 0), i.e.
Months[1] is second month.

1682
 16.1 Inspire Content Manager

16.1.15 MediaBin
In this section:
Adding a MediaBin link
Access Rights
Retrieval Tasks for MediaBin Files
Inserting MediaBin Images
Using Retrieval Tasks for Variable Images

MediaBin is a digital asset management system connected to Inspire Content Manager (VCS)
in Inspire Designer and it is used for working with digital assets (images, videos, Photoshop
files). MediaBin is hidden behind Inspire Designer and all logged Inspire Content Manager
(VCS) users can just use the stored assets and retrieval tasks without having to work with Me-
diaBin Explorer. Inspire Designer in cooperation with MediaBin enables you to:

perform predefined retrieval tasks on MediaBin images (e.g. all images can be displayed
as black and white previews in Layout but in Production they are resized, in full color,
with correct DPI, etc.)

see metadata associated with MediaBin digital assets

see versions for each file

Note Inspire Content Manager (VCS) server must run on Windows to be able to access Me-
diaBin, clients can be also on Macintosh computers.

16.1.15.1 Adding a MediaBin Link

To add a link to a MediaBin you need to have to be an administrator.

In the directory tree of the Inspire Content Manager Explorer (VCS Explorer), right-click on the
folder where you wish to insert the MediaBin link. From the contextual menu, select the option
Add MediaBin Link. The MediaBin link is a virtual directory in Inspire Content Manager (VCS)
and the data is stored on the MediaBin server.

After you select this option the following dialog opens:

1683
16 Related Applications

Options Description

Link name Allows you to enter a name for the MediaBin link.

Server Selects DNS name or IP address.

Port Selects port (by default set to MediaBin port).

Path Allows you to define a path to a subdirectory. If left empty, the server opens from the
root.

User, Password, Domain Enters the user name/password/domain for logging in to the
MediaBin server.

Login as current user If checked, Inspire Content Manager (VCS) server will log in the Me-
diaBin under the current user who has opened Inspire Content Manager (VCS) (always as
the same user). That is: MediaBin will use credentials of the user running Inspire Content
Manager (VCS).

Note If you have defined different access rights for different users in MediaBin, they will
not be valid since Inspire Content Manager (VCS) will login to MediaBin under the one
user. This users rights set in Inspire Content Manager (VCS) will be valid instead.

If not checked, every Inspire Content Manager (VCS) user will be asked to login to MediaBin.

Accounts for users are set in MediaBin.

16.1.15.2 Access Rights

Access rights are specified on two levels:

For the MediaBin link it is set in Inspire Content Manager (VCS). See the section Admin-
istrators Options.

For folders and files in the MediaBin access rights are defined in the MediaBin. Inspire
Content Manager (VCS) rights setting does not apply here.

16.1.15.3 Retrieval Tasks for MediaBin Files

Retrieval task is an action predefined on MediaBin server that can be used in Inspire Designer
on MediaBin images at different stages of the process. Retrieval tasks can combine operations
with these parameters: color, size, rotation, DPI, layers, etc.

MediaBin retrieval tasks can be used for:

Currently opened WFD file. In Workflow Properties in Workflow Options Dialog you
can specify a different retrieval task for each stage of the job: for Layout, Proof and
Production. This retrieval task will be applied to all MediaBin images in the currently
opened WFD file.

All new WFD files in ICM. In Inspire Content Manager (VCS) in Workflow Options
Dialog you can specify a different retrieval task for each stage of the job: for Layout,

1684
 16.1 Inspire Content Manager

Proof and Production. This retrieval task will be applied to all MediaBin images in all
new WFD files in Inspire Content Manager (VCS).

Variable images in Layout. For more information see the following chapter Using
retrieval tasks for variable images.

Tip All used MediaBin images can be included (in File | Used Files the State is set to Included)
but if there is a retrieval task applied in Layout, the image gets included with this task performed
(e. g., if you have selected Thumbnail retrieval task for Layout, the image gets included in the
WFD file as a preview of the original image). To include the image in its original format you
need to use it in Layout without any retrieval tasks.

16.1.15.4 Inserting MediaBin Images

In the Layout right click on the Image node and select Insert Image. In the Open file dialog
choose Inspire Content Manager, open your MediaBin link and select a MediaBin image.

Metadata
Metadata is information about the file that is collected automatically by MediaBin server. It
gives you a quick overview of file properties and it can be also used in scripting (File.read-
MetaData()).

To view the files with metadata select from the View Menu the option With Metadata.

The File Open dialog will look like the in the screenshot above with the Metadata displayed in
the right column.

1685
16 Related Applications

16.1.15.5 Using Retrieval Tasks for Variable Images

To set a retrieval task for any variable image go to Image Layout Properties Tab and fill in the
following fields:

Variable Selects the variable image.

Task Selects the variable in which a retrieval task is used.

The full description of this tab is in the section Images.

The Inspire Content Manager Explorer (VCS Explorer), Cache info panel, contains an overview
of used images with/without retrieval task identified. As you can see, images for which a re-
trieval task was applied get stored in the cache with the task and with (none) when a retrieval
task is not used.

1686
 16.1 Inspire Content Manager

Example The screenshot below represents a variable image in Proof for which no re-
trieval task was used.

The following panel shows the setting required for selecting a Variable image in Layout
Properties tab:

The variable BgAsset is defined in the following way:

function bgId(String aB):String
{
aB.replace("Flower","CRW_4781.jpg");
aB.replace("Mushroom","CRW_4800.jpg");
aB.replace("Car","IMG_4715.jpg");
return aB;
}
return "vcs://assets/Backgrounds/" + bgId(Background);

The function bgId replaces files names of the images and the variable then finds the images
in the MediaBin link (assets in this sample) in Inspire Content Manager (VCS).

Now we apply a retrieval task for the variable image:

1687
16 Related Applications

The result in Proof looks like this:

The variable RetrieveLogo is defined this way:

function bankId(String aB):String
{
if(aB=="Fleet") return "0?0?1";
if(aB=="A") return "0?1?0";
return "1?0?0";
}
return "Frame - Select Visa Logo + Name" //name of task in MediaBin
+ "?" + bankId(BankId) //parameters of task: type of bank
+ "?" + FirstName.toUpperCase() //card holder's first name
+ " " // space
+ LastName.toUpperCase(); //card holder's last name

The task "Frame - Select Visa Logo + Name" from the variable RetrieveLogo gets applied
to the variable image and does the following: makes the image to look like a card, rounds
the corners, adds numbers and Visa logo, creates a shadow, etc.

The retrieval task has 2 parameters in this case:

type of bank

name of cardholder (first name + last name).

See the example above where they are introduced by question marks.

Summary
What is taken from the Inspire Designer input data is the name of the card holder, type
of a bank and variable card background. What is taken from Media Bin is the retrieval
task applied on the image. This way you can combine functionality of both Inspire Designer
and MediaBin.

1688
 16.1 Inspire Content Manager

16.1.16 SharePoint
In this section
Adding a SharePoint Link
Working with Files
Limitations

Microsoft Office SharePoint is a system for content management, business processes imple-
mentation and sharing information. You can use Inspire Content Manager (VCS) (a folder linked
to a SharePoint server) to work with the content stored on a SharePoint server, modify this
content and save these modifications.

16.1.16.1 Adding a SharePoint Link

To add a SharePoint link to Inspire Content Manager (VCS) you need to have administrators
rights.

In Inspire Content Manager Explorer (VCS Explorer) in the directory tree right-click on the folder
where you wish to insert the SharePoint link. Select the Add SharePoint Link option and fill
in the connection and other details in the dialog that appears (see below). Inside this folder a
sub-folder is created representing the link to the SharePoint server and displaying the content
of the server. Please note, that the SharePoint link is only a virtual directory in Inspire Content
Manager (VCS) and the real data is stored on the SharePoint server.

The dialog for creating a SharePoint link looks as follows:

Options Description

Login Properties

Link name Enter here the name of the SharePoint link (visible as a directory in Inspire
Content Manager Explorer (VCS Explorer)).

Server with path Enter here the path to the SharePoint server.

User name Enter here the user name for logging in to the SharePoint server.

Password Enter here the password for logging in to the SharePoint server.

1689
16 Related Applications

Optional Properties

Folder Allows you to create a folder within the SharePoint link.

Time pattern Allows you to enter the date and time pattern that is used by the Share-
Point server. This pattern enables Inspire Content Manager (VCS) to parse the date
and time of creation or modification of files and to display this information correctly
in Inspire Content Manager Explorer (VCS Explorer). Setting the date and time pattern
also significantly speeds up communication with the SharePoint server.

Tip To find out the actual pattern used by the SharePoint server, display the History
Tree of any file in the SharePoint link directory the correct creation time is in the
file comment.

Test Allows to test whether a connection has been established with the server. If the test is
unsuccessful, an HTTP error code will be displayed.

16.1.16.2 Working with Files

Working with files is done in the same way as if they were stored in Inspire Content Manager
(VCS). The files are displayed in Inspire Content Manager Explorer (VCS Explorer) under the
folder that has been linked to SharePoint. See the section Basic Use of Inspire Content Manager
for details on how to work with Inspire Content Manager Explorer (VCS Explorer).

16.1.16.3 Limitations
You can use all the functions that Inspire Content Manager (VCS) offers (file history, file com-
ments etc.) with the exception of labels and branches, which are not supported by SharePoint.

Note Inspire Content Manager (VCS) server must run on Windows to be able to access
SharePoint, clients can be also on Macintosh computers.

16.1.17 How to Create and Use Branches

In this section: See also:
Preferred Branches History Tree

Branching duplicates a version of a file so that modifications can happen in parallel in the dif-
ferent branches. Once a branch has been created, two versions of the same file have a shared
history up until that branch creation point, but subsequently any modifications made are saved
to just that branch. In effect, this is like having two different files with the same name but with
added version-controlling advantages. For example, you can trace the history of many different
branched file versions to a common point and Roll back to that point if necessary via the
History Tree context menu.

1690
 16.1 Inspire Content Manager

Branches are often used to separate approved and 'ready for production' versions of files from
versions that are being worked on, in order to ensure that incomplete versions are not sent to
production. To create a branch:

1. Right-click on a file in Content Manager Explorer.

2. Select Branch from the File context menu to open the Branch File dialog:

3. Name your branch in the Branch combo-box and enter a Comment to inform others
of the purpose of the branch.

Branch comments are visible in the History Tree.

Alternatively, Branch is available in the History Tree context menu.

You can also select any Branch that has been previously defined for another file in order to
assign the same branch for the purpose of version retrieval, e.g. when searching for a file. The
comment entered at the time of creation of that previously defined branch is then adopted as
the branch comment for this file version as well.

Subsequently, a branch can be chosen when opening a file using the Enhanced Open dialog
or when writing the path to a file by using the identifier B: (see Paths to Files in Content
Manager). Further, it is possible to define preferred branches for the whole ICM server.

If preffered branches are not defined, the Main branch of file is opened. Main is the default
title given to any new file added to Content Manager and any subsequent saved versions of
that file that are not specifically opened from another branch. Therefore, there is always a Main
branch.

Example The following screenshot is taken from the History Tree of a file with three
versions, i.e. it has been saved to Content Manager three times.

1691
16 Related Applications

1. Version 1 was created when the file was added to Content Manager.

2. The Production branch was created via Branch on the File context menu in order
to designate that files from that branch can be used for production. This created
version 2.

3. The file was then opened via Open on the File context menu, then modified,
saved and checked in to Content Manager. This created version 3, but because
when the file was opened the Production branch was not specified then version
3 belongs to the Main branch.

16.1.17.1 Preferred Branches

Preferred branches define the priority of branches to be used when opening file versions, i.e.
which is the most important branch to be used for modification or production.

Because different files in Content Manager have differing branches, if you open a file and the
'most important' branch does not exist for that file then the next branch in the list will we tried
(and so on) until a branch is found to which the file belongs. Preferred branches can be reques-
ted when opening individual files via Open Workflow (Workflow, Proof and Production envir-
onments) in the Enhanced Open dialog.

Alternatively, they can be set for the whole ICM server via File | Preferred Branches the Pre-
ferred Branches dialog:

All branches that have been made for any of the files in Content Manager are listed in Branches.
Move branches across to the Preferred branches list with the Move Left icon. You can
change the order of priority using the Move Up / Move Down icons.

These very same settings can also be adjusted via Inspire Content Manager section of the
Workflow Options Dialog.

1692
 16.1 Inspire Content Manager

16.1.18 How to Create and Use Labels

In this section: See also:
Creating Labels History
Using Labels History Tree
Creating and Using Alias Labels Basic Use of Inspire Content Manager
Inspire Content Manager Window Menu

Labelling enables you to attach a code name of your choice to a specific version number of
a file. You can see these labels in the History and History Tree.

16.1.18.1 Creating Labels

1. Right-click on a file or directory in the Inspire Content Manager Explorer (VCS Explorer)
window and select the Label option.

1693
16 Related Applications

Tip If a file you want to label is opened in Inspire Designer, you can go to File | Inspire
Content Manager | Label in the Workflow Window menu.

2. Add a label to the latest version of a selected file in the Label dialog described below.
A label comment and a file comment can be also added to the version of a selected
file. The version to which the label comment and file comment will be added depends
on the options selected in the Label File dialog.

Label File Dialog

Options Description

Label Names the label that will be added to the latest version of the selected file and will be
displayed in the History and History Tree of the file.

Label comment Determines the text of the label that will be added to the version(s) of the
file(s) according to the option selected in the combo-box below the Label comment field.
The label comment will be displayed in the History Tree of the file. The comment can be
created in one of the following ways:

Apply comment only on new label If selected, the comment is added to a newly
created label. This option is selected by default.

1694
 16.1 Inspire Content Manager

If you create a label with a name that has already been used, the original comment
of the old label is used for the new label. If two labels with the same name are
created within one workflow, the original label with its label comment is deleted
as it is not possible to have more than one label of the same name in one workflow.

Example The Workflow1.wfd file has two versions (version 1 and version
2). Version 1 contains a label (Label1) with a label comment (label_com-
ment_1). When you create a label for version 2 and name this label also
"Label1" and add a label comment "label_comment_2" (using the Apply
comment only on new label option), the "label_comment_1" of the label
"Label1" of version 1 is used and the label "Label1" is displayed for version
2 only, i.e. the label "Label1" for version 1 is deleted.

Apply comment If selected and a new label with a name that has already been
used is created, the comment of the newly created label will be applied to any label
with the same name, i.e. the new label comment will replace the original comments.

If two labels with the same name are created within one workflow, the original
label with its label comment is deleted as it is not possible to have more than one
label of the same name in one workflow.

Example The Workflow1.wfd file has two versions (version 1 and version
2). Version 1 contains a label (Label1) with a label comment (label_com-
ment_1). When you create a new label for version 2 and name it also "Label1"
and add a label comment "label_comment_2" (using the Apply comment
option), the "label_comment_2" of the "Label1" of version 2 is used and the
label "Label1" is displayed for version 2 only, i.e. the label "Label1" for version
1 is deleted.

Append comment If selected and a new label with a name that has already been
used is created, the comment of the newly created label will be appended to the
comments of the label with the same name.

If two labels with the same name are created within one workflow, the original
label with its label comment is deleted as it is not possible to have more than one
label of the same name in one workflow.

Example The Workflow1.wfd file has two versions (version 1 and version
2) and the Workflow2.wfd file has one version (version 1). Versions 1 of the
Workflow1.wfd and Workflow2.wfd contain "Label1" with "label_com-
ment_1". When you create a new label named also "Label1" with "label_com-
ment_2" for Workflow1.wfd version 2 (using the Append comment option),
the "label_comment_2" is added to the "label_comment_1" of the Work-
flow2.wfd version 1 for the "Label1" and the version 2 of the Workflow1.wfd
contains the "label_comment_1" and "label_comment_2" for the "Label1".

Note If a file with a certain label and comment is exported and later the same label is
used for a different file, the same comment will be added automatically.

1695
16 Related Applications

Label also used files If checked, the label will be assigned to the used files (e.g. fonts, images)
as well and after opening a labelled version of the file using the Enhanced VCS Open option,
all correspondingly labelled used files will also be loaded to the workflow.

If unchecked, only the workflow is labelled. Files used in a workflow (fonts, images etc.)
are searched dynamically when the workflow is loaded. The searching sequence is defined
by the Preferred branches list.

Example The workflow uses the arial.ttf font and the Label also used files check-
box is left unchecked. The next time the workflow is loaded, the program will have
to find the appropriate arial.ttf file. It searches progressively, branch by branch,
through the list of Preferred branches until it finds the arial.ttf file (the first matching
file in the Preferred branches list is used).

Note If the Label dialog is opened from the Inspire Content Manager Explorer (VCS Ex-
plorer) window, the check-box Label also used files is not displayed.

File comment Determines the text that will be added as a file comment to the labelled version
of the selected file and will be displayed in the History Tree of the file after clicking on the
selected label or file version. The file comment can be created in one of the following
ways:

Apply new comment If selected, the file comment will be applied to the file version
that has been labelled, i.e. the file comment will replace the original file comments
of the labelled file version displayed in History Tree after clicking on the appropriate
file version.

Note

If a label is created with the same name as one that has been used before
within one workflow, the option is performed as described above and the
original label with the same name as the newly created label will be deleted.

If a label is created that has the same name as one that has been used before
in a different workflow, the option is performed in the selected file (as described
above) and, in addition, the newly created file comment will replace the existing
file comments of the labels with that same name in those different workflows.

However, the new file comment will be displayed after clicking on the appro-
priate label in the History Tree only, not after clicking on the appropriate file
version.

Example The Workflow1.wfd file has one version (version 1). The Work-
flow2.wfd file has one version (version 1) containing "Label1" with the
"file_comment_1". When you create a new label named "Label2" with
"file_comment_2" for the Workflow1.wfd version 1 (using the Apply new
comment option), the "file_comment_2 will replace the "file_comment_1 of
the Workflow2.wfd version 1 for the "Label1". This change is only displayed
after clicking on the appropriate label in the History Tree. When you click on

1696
 16.1 Inspire Content Manager

the appropriate file version in the History Tree, the "file_comment_1" is dis-
played.

Append new comment If selected, the file comment will be added to the existing
file comments of the version that has been labelled. This is the default option.

Note

If a label is created that has the same name as one that has been used before
within one workflow, the option is performed as described above and the
original label with the same name as the newly created label will be deleted.

If a label is created that has the same name as one that has been used before
in a different workflow, the option is performed in the selected file (as described
above) and in addition the newly created file comment will be added to the
existing file comments of the labels with the same name in different workflows.

However, the new file comment will be displayed after clicking on the appro-
priate label in the History Tree only, not after clicking on the appropriate file
version.

16.1.18.2 Using Labels

To see the labels of a selected file in chronological order, right-click on the file in the Inspire
Content Manager Explorer (VCS Explorer) window and select the Show History option. For
more details, see the section History.

To see the labels of a file in a structured tree form, right-click on the file in the Inspire Content
Manager Explorer (VCS Explorer) window and select the Show History Tree option. The grey
items represent different versions of a selected file and green items represent their labels.
Clicking on a preferred version or a label will display related comments.

1697
16 Related Applications

Right-clicking on a selected version of a file in the History Tree dialog enables users to add a
label, label comment and a file comment to any version of a file displayed in the History Tree.
For more details, see the section History Tree.

16.1.18.3 Creating and Using Alias Labels

Alias label is a feature useful especially for approval processes. By alias label you can determine
which version of files will be used in a specified action (e.g. you can only send to Production
files that have a defined alias).

You can add an alias label to any file which already has a label. Right-click on a file in the Inspire
Content Manager Explorer (VCS Explorer) window and select the Alias Label option.

When you use the option Alias Label Directory in a directorys context menu, the alias label
is added to all files that have the selected label. If any files with different labels already have
this alias label, it is deleted from these files. See also the example below.

1698
 16.1 Inspire Content Manager

Alias label Selects the label to which this alias label will be added.

Label Names the alias label.

Recursive If checked, this alias label will also be added to files in subfolders. Only available
in directory context menu.

Label comment See explanation in the Creating Labels section above.

File comment See explanation in the Creating Labels section above.

Example

1. First you add a label (Version1) to a newly created file version. When this version
is approved, the label is given an alias label (Production). Then you can send to
production only the files that have the alias label "Production".

2. Later, when a new version (Version2) is created and approved, you add the alias
label "Production" to all files that have label Version2. Simultaneously, this alias
label is deleted from all files that are labelled Version1.

1699
16 Related Applications

16.1.19 Inspire Content Manager Web

In this section: See also:
Working with Inspire Content Manager ICM Overview
Web Administrators Options
Inspire Content Manager Web Config
Tool
Settings in Inspire Content Manager
(Server Side)

Inspire Content Manager Web is a web client of Inspire Content Manager (VCS) where files
(mainly images), that are intended to be used in documents with variable content, can be
managed. Using Inspire Content Manager Web, people who are responsible for content of
documents can preview, upload or delete files, edit some of their properties (metadata) and
send the files to production.

The files themselves are stored on a Inspire Content Manager server. On the server side there
is always a group of users set for each company. Each of the groups has a root directory defined
that is accessible by its members via Inspire Content Manager Web. The accessibility of content
can be further limited by setting user's access rights. Further, a company logo can be uploaded
on the server for each group; this logo is then visible in Inspire Content Manager Web.

16.1.19.1 Working with Inspire Content Manager Web

Logging In
To access Inspire Content Manager Web, open your web browser and go to the specified web
page. Enter your user name and password.

The address and user account should be provided by your administrator.

Inspire Content Manager Web connects to the Inspire Content Manager and makes the appro-
priate content available for the logged user.

Working with Files

The main screen that is shown after a successful login displays the content of the user's root
directory as it is defined in the Inspire Content Manager. Your main screen will look similar to

1700
 16.1 Inspire Content Manager

the screenshot below. For description of the marked features check the corresponding number
in the legend in the section.

Viewing
In the main screen you can sort, upload and search for files, see under what user name you
are signed in, display help and log out from the application.

Legend

1. When you browse through the content, enter folders, the grey toolbar at the top always
shows the current path. It is clickable which enables you to return fast one or more
levels up.

2. Clicking on the company logo takes you back directly to the main screen.

3. Files and folders can be sorted alphabetically or by the date of the last modification.

4. Icons available for a selected file:

Click on the Go to detail icon to edit file's properties. For details see the Editing
Properties section.

Click on the Delete icon to permanently delete the file. Multiselection of files
(not folders) is available (<Ctrl>+click) for deleting.

Click on the Download icon to save the file to your computer.

5. You can search for files according to their names and keywords.

1701
16 Related Applications

Editing Properties
To view file properties, select the file and click on the Go to detail icon that appears on the
right-hand side of the file preview. There are two tabs with file metadata.

The Basic tab displays the file type followed by metadata that are editable. You can add
keywords, GPS coordinates and notes.

To do that hover the mouse cursor over the area where the values should be entered
it will be highlighted with a gray rectangle. Click on the icon so that the fields be-
come editable.

When you are finished, click on the Save button at the bottom to save the changes.

The Advanced tab displays info from the Inspire Content Manager (version, label, time
of insertion and modification) and metadata concerning the file (dimensions, resolution,
color space, etc.). This data cannot be modified.

From this view it is possible to go to previous or next image directly by clicking on the arrow
icons next to the file name. In case the user enters the properties from search results, the arrows
allow to browse only within the search results.

You can also delete or download the file from here.

1702
 16.1 Inspire Content Manager

Uploading New Files

To upload a file (or more files at a time), click on the Upload button in the top right corner of
the main screen. The files will be uploaded to the current folder. The Upload Files dialog is
simple and intuitive.

Click on the Add button to browse for files you wish to upload, multiselecton is available. After
you select a file, its name and size appear in the dialog.

It is possible to remove files from the upload list using the Remove button. When you are
ready to upload your files, click on the Upload button. The progress bar will inform you about
the advance of the uploading process (by individual files).

Note For users who do not have Adobe Flash installed a classic HTML upload dialog will be
displayed.

Once the user updates the content via Inspire Content Manager Web, the files can be used in
production by the print service provider.

16.1.19.2 Inspire Content Manager Web Config Tool

The Inspire Content Manager Web Config tool enables users to change the current configuration
of Inspire Content Manager Web.

The configuration tool can be optionally launched right after the installation. If you need to
access the tool at a later time, you can do so via the Start menu (Start | Inspire Content
Manager Web | Config).

The tool has two tabs: IIS and Application.

1703
16 Related Applications

IIS Tab
The IIS tab configures Internet Information Services (IIS) properties and allows setting or testing
permissions for directories.

IIS Configuration

Virtual directory name Sets the name of the virtual directory into which the application
is installed. If there are several virtual directories on the same local path, you can select
the proper one after clicking on the ... button.

IIS path Determines the IIS path to the virtual directory.

Local path Determines the path of the currently opened configuration file.

Test Directories Permissions Checks whether there are sufficient disk permissions for
the user who is running the application. If some permissions are missing, the user
can choose to create them.

The user under whom the application is running depends on the used operating sys-
tem, see the table below for default users for the English OS variant:

User Operating System

ASPNET Windows XP
NETWORK SER- Windows Server Windows Server Windows Vista
VICE 2003 2008

As the default settings can be changed, it is recommended to verify under which user
the application is set to run on your operating system.

1704
 16.1 Inspire Content Manager

The given user needs to have the following permissions set:

The Read permission for the \wwwroot\ContentManager directory.

The Read permission for the \wwwroot\ContentManager\bin directory.

The Modify permission for the \wwwroot\ContentManager\App_Data direct-

ory.

Note Make sure that all sub-directories inherit the given permissions or set the
above stated permissions manually for all sub-directories.

Configure IIS Opens the Internet Information Services (IIS) Manager window.

Session Configuration

Request execution timeout [sec] Sets the request timeout in seconds. After this time
period has elapsed the request will be shut down automatically by ASP.NET if it has
not been executed.

Maximum request length [kB] Sets the limit for the input stream buffering threshold
in kilobytes. This setting is sufficient if you run Inspire Content Manager Web on IIS6,
however on IIS7 it is also necessary to change the setting below.

Note Setting up a larger limit for uploading bigger files might also require extending
the request execution timeout (see above) in case of a slow network connection.

Maximum allowed content length for IIS 7.0 [B] Sets the maximum length of the
content in a request for IIS 7.0 in bytes.

Application Tab
The Application tab configures the connection to Inspire Content Manager and related settings.

Global Application Settings

ICM server address Sets the Inspire Content Manager server host name or IP address.

ICM port Sets the port number where the Inspire Content Manager server runs.

ICM client cache folder Sets the path to the client cache folder. With the Test button
it is possible to check if the user has sufficient permissions for this folder.

ICM client log file Sets the path to the client log file.

1705
16 Related Applications

16.1.19.3 Settings in Inspire Content Manager (Server Side)

On the server side in Inspire Content Manager (a part of Inspire Designer) there is always a
group of users set for each company. Then each company has its unique URL where its members
can log in to Inspire Content Manager Web.

To set up users and a company, perform the following steps in Inspire Content Manager:

1. Go to the Users | Users menu and create users that will be later added to a company.

2. Go to the Users | Groups menu and either create a new group or edit an existing one.

Perform the following settings:

a. Enter the name of the group. This name will be used as the company name in the
URL of Inspire Content Manager Web.

b. Add existing users to this group.

c. Check the option Is company group to associate the group with Inspire Content
Manager Web. This ensures that users belonging to this group can work with Inspire
Content Manager Web.

d. Optionally, upload a logo of the company. This logo will be visible in the web pages
of Inspire Content Manager Web.

e. Optionally, enter a root directory for the company. This directory will be the default
one when users log in.

1706
 16.2 Inspire Production Server and Inspire Production Server Client

The directory has to exist and has to be on the Inspire Content Manager (VCS)
path.

Then, enter the URL containing the company (group) name in browser. In this example, it would
be http://localhost/contentmanager/Marketing/. Users belonging to this group can now log in.

16.2 Inspire Production Server and

Inspire Production Server
Client
16.2.1 Inspire Production Server Description
In this section: See also:
Starting Inspire Production Server Inspire Production Server Client
Connecting to Inspire Production Server Description
Inspire Production Server Console Client
Description
Commands
Find Engine Command Line Parameters
Info Engine Command Line Parameters

The Inspire Production Server (PNetTNetServer) functions like a "remote web console of In-
spire Designer"; it runs on a server with an IP address and listens to a port. The server can be
started either as an application or as a service. You can connect to the server and control it by
sending commands to it.

The following options are available for connecting to the server via:

telnet

Inspire Production Server Client (PNetTNetClient) application

Inspire Production Server Console Client (PNetTCNetClient)

16.2.1.1 Starting Inspire Production Server

The server file name is PNetTNetServer.exe. By default, it is located in the Inspire Designer dir-
ectory. Running the PNetTNetServer.exe file starts the server. By default (when no p parameter
is specified), the server starts listening at (i.e., monitoring) port 30354 and waits for connections.

Note Inspire Production Server (PNetTNetServer) works with the directory from which it was
launched. By default, the installer puts it into the main Inspire Designer directory. It is recom-
mended to dedicate the server a special directory.

For more information about what is necessary for the PNetTNetServer.exe to work from a dif-
ferent directory than the installation directory, see the section Installation Directory Content.

1707
16 Related Applications

The server can be started as:

Application Inspire Production Server (PNetTNetServer) is executed without -i para-

meter

Service

Available Commands for Inspire Production Server

General Options Description

-D Launches Inspire Production Server (PNetTNetServer) as a demon. Available for Unix plat-
forms only.

Note On Mac platform the demon is launched using a special procedure. See the chapter
Launching Inspire Production Server (PNetTNetServer) or Inspire Content Manager (VCS)
Server as a demon in Inspire Designer Installation Guide for Mac for more information.

-dir directory Specifies the servers working directory.

-disablelog Disables server logging.

-h,-help Displays the help screen.

-l Creates a new log file with the same name, overwrites the content of the original log file.

-la Appends new log entries to the specified log file, creates it when it does not exist.

-lang Specifies the language for messages.

Note This option only works for licenced languages.

1708
 16.2 Inspire Production Server and Inspire Production Server Client

-ls Specifies the maximum size of log file (in kB).

-p port Specifies the port number to be monitored. You can override the server port
number (default is 30354).

-reportjobfinishedmessage If used, Inspire Production Server (PNetTNetServer) returns

the message Job finished. after a job is finished.

-runwcachelimit Specifies the maximum number (Int) of workflows that can be in cache
at a time. It is used for parallel processing of workflows using the runw command. It is
set to 20 for 32-bit processors and to 40 for 64-bit processors by default.

If the limit is reached, the workflow which has been opened via the runw command and
which has not been used for the longest time will be closed. Workflows that have been
opened via the open command will not be affected.

Set the cache limit to 0, if you do not wish to enable parallel processing of workflows, i.e.
the behavior of the runw command will be the same as for versions prior to 7.0.

-runforweb Runs Inspire Production Server (PNetTNetServer) with the licence limited for
web products usage. If you have only the 'PNet T Net Server Web' licence and you try to
run the server without this option, the server is not launched.

Alternatively, this option can be specified in the CONFIG file for Inspire Production Server
(PNetTNetServer).

-tempdir Specifies the name of the temporary directory.

-threadcount number Specifies the number of working threads on the server. It is set
to 2 by default.

-vcsaddress or -icmaddress Specifies the address for logging-in to the Inspire Content
Manager (VCS) server.

-vcsloginsetup or -icmloginsetup Specifies existing user name and password to

Inspire Content Manager (VCS) and saves these parameters into the PNetTNetServ
er.config file (created at the same location as PNetTNetServer.exe resides). This
command avoids using the commands -vcsuser and -vcspassword and ensures se-
curity of this information because it is not available in operating system processes.

By default, the information about Inspire Content Manager (VCS) user and password is
taken from the PNetTNetServer.config file but if you further specify it also with
commands -vcsuser and -vcspassword, it is overwritten with the information specified
in these commands.

Note To remove the user name and password from the CONFIG file, specify no (empty)
user name in command line (when you are prompted by the command line).

-vcscache or -icmcache Specifies the location of the Inspire Content Manager (VCS)
cache.

-vcslogascurrent or -icmlogascurrent Logs-in to Inspire Content Manager (VCS)

server as the current user.

1709
16 Related Applications

-vcspassword or -icmpassword Specifies the password for logging-in to the Inspire

Content Manager (VCS) server.

-vcsuser or -icmuser Specifies the username for logging-in to the Inspire Content
Manager (VCS) server.

Note You should have different user accounts for logging-in to Inspire Content Manager
(VCS) and for logging-in to Inspire Production Server (PNetTNetServer). Only if you do so, you
will be able to access your version controlled file with most recent changes, which was not
checked in so far, from a different computer.

Inspire Production Server (PNetTNetServer) writes to a log file (named serverlog1.txt by default).
The log file is stored in the directory where Inspire Production Server (PNetTNetServer) executable
is stored. It is also possible to overwrite the default log file path and name using l or la
parameters.

Log file name is created from the base name (specified by l or la command) + suffix 1.txt.
For example, when the following command line is entered: pnettnetserver l c:\server
log the filename is c:\serverlog1.txt.

Note There is a size limitation for the log file as soon as it reaches the limit of 10 MB, a
new log file with the suffix 2.txt is created and the entries are written there. When the new
log file reaches the limit, the original log file, ending with 1.txt, is used for logging the mes-
sages.

Options for Inspire Production Server Running as a Service

-i, -install Installs the service.

Example
PNetTNetServer.exe -override_name "PrintNetT Server WD 4240" -p 34240 i

Note Before installing Inspire Production Server (PNetTNetServer) as a service, all the
parameters are checked. If there are any errors, the application is not installed and a
warning is displayed.

-u, -uninstall Un-installs the service.

-override_name Overrides the service name.

-recoverytime Sets the time (in ms) in which the server will try to restart a failure (default
is 500 ms).

Options for Inspire Production Server Running as an Application

q Stops the server.

it Gets information about running tasks.

1710
 16.2 Inspire Production Server and Inspire Production Server Client

Example

>it
Thread 0 0;Idle.
Thread 1 1;Idle.
Thread count:2

iw Gets a list of opened workflows.

ic Gets a list of opened connections.

Example

>ic
Connected from: 127.0.0.1:1339
Connection count:1

Restrictions
There is a similar limitation as in Inspire Designer production: workflows with the same ID
cannot run at the same time. If you run the same workflow with the same ID for the second
time, the second job will be scheduled after the first run is finished regardless of how many
threads on the server are idle.

This is not an issue since you can open the same workflow more than once and for example
spool to different engines simultaneously if needed.

16.2.1.2 Connecting to Inspire Production Server

Tools to connect:

Telnet

Inspire Production Server Client (PNetTNetClient GUI) or Command line

TCP/IP connection

Available commands
Job/Workflow Manipulation
Using these commands you can manipulate with the job or the workflow. (Job is an action
that is performed on a workflow.)

Commands Description

open Opens a workflow or a native file.

run Runs a workflow.

1711
16 Related Applications

close Closes a workflow or a native file.

abort Aborts a job.

ackj Acknowledges a job.

Request Info
Using these commands you can receive the information about the job or the thread.

Commands Description

qj Queries the job.

qjm Queries job messages.

qt Queries the thread.

Advanced Message
Using these commands you can receive complex information about all jobs.

Command Description

qallj Complex job query.

Maintenance
Using these commands you can get information about the connection to the server.

Command Description

ping Checks if the connection is alive.

For more details about all commands see the section Commands.

Connecting via Telnet

When using telnet, no login is needed, you just connect to the server address. The server listens
by default to port 30354:

telnet <server_IP_address> <port>

Example telnet localhost 30354

1712
 16.2 Inspire Production Server and Inspire Production Server Client

All commands return a single string terminated by CR LF (carriage return + line feed characters).

If the command was correct, the server returns a string beginning with ok; followed
by return value(s) separated by semicolon.

If the command was not correct, the server returns error; followed by description of
the error.

16.2.2 Inspire Production Server Console Client

Description
See also:
Inspire Production Server Description
Inspire Production Server Client
Description
Inspire Production Console Description
Commands

Inspire Production Server Console Client (PNetTCNetClient) can be used in two modes:

As a command line version of Inspire Production Server Client (PNetTNetServer), to

connect to Inspire Production Server. The same commands as for Inspire Production
Server Client are used (preceded with parameter -api or -apibatch).

As Inspire Production Console (PNetTC), the console version of Inspire Designer. The
same command line parameters as for Inspire Production Console are used, except that
it is not possible to log in to Inspire Content Manager (VCS) using the Inspire Production
Console commands -server -username and -password.

The console application file name is PNetTCNetClient.exe. By default, it is located in the In-
spire Designer directory.

Note For more information about what is necessary for the PNetTCNetClient.exe to work
from a different directory than the installation directory, see the section Installation Directory
Content.

1713
16 Related Applications

Available Commands for Inspire Production Server Console Client (PNetTCNetClient)

-s Enables you to specify the server to connect to (if Inspire Production Server runs on a dif-
ferent server than localhost).

-p Enables you to specify the port to connect to (if different than the default one).

-api Precedes the individual Inspire Production Server Client (PNetTNetClient) commands.

-apibatch Precedes the series of Inspire Production Server Client (PNetTNetClient) com-
mands. These commands are placed in any text format file, each of them placed on sep-
arate line.

-open file.wfd;alias Opens the given file, assigns an alias to it and acknowledges
this job. The optional parameter alias name specifies textual ID usable with "runw" and
"closew" commands.

Note the difference:

pnettcnetclient -open file.wfd;alias opens the file and acknowledges this

job (i.e. parameters for the "open" job are not stored at the server). Opening the workflow
is either successful or you receive an error message.

pnettcnetclient -api open file.wfd;alias sends the "open" command to

the server. You get no information whether the file opening was successful unless you
use some query commands.

The following commands sequence must be kept:

pnettcnetclient -s server_name -open c:\file_name.wfd;alias

The "open" command needs to be entered as the last one because all strings after the
semicolon are regarded as alias.

Example
pnettcnetclient -s server_name -open c:\file_name.wfd;alias -s
168.192.42.1

This sequence causes that the whole string "alias -s 192.168.42.1" is taken
for alias.

-close file.wfd or -close alias Closes the given file(specified by its file name or
alias) and acknowledges this job.

-au Automatically uploads a file to the server if it is not there and needs to be present for
processing.

-ad Automatically downloads file from the server if they are not present locally but need to
be.

-multi Sets multiple jobs to run (one after another). See also Multiple Output section.

-par If used with the command -noclose, it sets multiple jobs to run parallel.

-noclose Keeps the file open after it is printed, then it can be re-used, e.g. in a BAT file.

1714
 16.2 Inspire Production Server and Inspire Production Server Client

When used with -apibatch then files are kept open, ready for the next command, even
after the batch is finished. The intention is to eliminate the need to keep re-opening files
and reduce the processing time it takes to do this.

-retiw Ignores warning exit codes.

-retadv Obtains advanced exit codes.

-shbeg 1 Selects starting sheet in the Job configuration (default 1). This parameter can be
used with negative values, e.g. -1 = last page of the job, -2 = last but one page of the job
etc.

-shend 1 Selects ending sheet in the Job configuration. This parameter can be used with
negative values, e.g. -1 = last page of the job, -2 = last but one page of the job etc.

For information about other available commands see the section Commands.

Note Only supported file types can be used with the parameters above, e.g. WFD, TNO, AFP,
EPS, PDF.

Example PNetTCNetClient.exe s MyServerIP au ad MyTnoFile.tno

-e PDF

The command PNetTCNetClient a.wfd -e PDF is executed using runw parameter that
closes the workflow after production. If you wish to keep the workflow open, use the -noclose
parameter. But if you use directly the -api runw command, the workflow stays open and you
need to close it using -close or -closew.

16.2.2.1 Inspire Production Server Console Client

(PNetTCNetClient) Configuration
Inspire Production Server Console Client (PNetTCNetClient) can be configured by a file named
PNetTCNetClient.txt and placed next to PNetTCNetClient executable. The content of the con-
figuration file is following:

Line Parameter Value

1 -s Name of the server or IP address

2 -p Port number
3 -par YES/NO

This setting has no impact on -api mode.

4 -au YES/NO

This setting has no impact on -api mode.

5 -ad YES/NO

This setting has no impact on -api mode.

6 -noclose YES/NO

1715
16 Related Applications

Line Parameter Value

7 -retiw YES/NO
8 -retadv YES/NO

16.2.3 Inspire Production Server Client

Description
In this section: See also:
Server Queue Window-Pane Inspire Production Server Description
Console Window-Pane Inspire Production Server Console Client
Command Syntax Window-Pane Description
Window Options Commands
Inspire Production Server Client Batch
Mode
Context Menu
Typical use of Inspire Production Server
Client

The purpose of the Inspire Production Server Client (PNetTNetClient) application is to help users
to connect to Inspire Production Server (PNetTNetServer) where they can upload, run and
download jobs. You can also use a console application PNetTCNetClient.exe to connect to Inspire
Production Server (PNetTNetServer).

The application file name is PNetTNetClient.exe. By default, it is located in the Inspire Designer
directory.

Note For more information about what is necessary for the PNetTNetClient.exe to work from
a different directory than the installation directory, see the section Installation Directory Con-
tent.

1716
 16.2 Inspire Production Server and Inspire Production Server Client

Legend

1. Server Queue window-pane

2. Console window-pane

3. Command Syntax window-pane

4. Command line

Inspire Production Server Client (PNetTNetClient GUI) consists of three window-panes. The
Server Queue window-pane includes detailed information about jobs and their progress. The
Console window-pane displays all commands from GUI or menu and return messages. The
Command Syntax window-pane contains the correct syntax of commands. Commands are in-
serted to GUI command line and when the Send button is pressed they are sent to the server.

Before you start using Inspire Production Server Client (PNetTNetClient), you need to connect
to the Inspire Production Server (PNetTNetServer). In the File menu select Login and in the
following dialog enter information about server and port:

1717
16 Related Applications

After a successful login, there is a green square and Server IP address displayed at the bottom
of the window: If you are not logged in, there is a red square
and no IP address.

16.2.3.1 Server Queue Window-Pane

The Server Queue window-pane shows basic information about all the processed workflows.

Options Description

JobId Identifies the job. The job is an action that is performed on a workflow.

WorkflowId Identifies the workflow.

In case of parallel processing via the runw command, the WorkflowId may not be assigned
(and that is why not visible) till the previous jobs with the workflow are finished.

Name Specifies path and file name of the workflow.

CmdType Specifies the type of the used command.

Added Shows the time when the job was added into queue.

Status Indicates the status of the job.

ProgressStatus Shows additional information for each Status type.

Progress Shows the progress indicator.

Errors Indicates the number of errors for the selected workflow.

Warnings Indicates the number of warnings for the selected workflow.

16.2.3.2 Console Window-Pane

In the Console window-pane you can view detailed information about all performed actions
on workflows, return codes and messages. For more information see the Typical use of Inspire
Production Server Client example.

1718
 16.2 Inspire Production Server and Inspire Production Server Client

16.2.3.3 Command Syntax Window-Pane

The Command Syntax window-pane presents the correct syntax of commands. All commands
listed here are explained in detail in Commands section. The window-pane is optional and can
be displayed or hidden by selecting or deselecting the Show Commands Help option in the
Help menu.

16.2.3.4 Window Options

File Menu
Login Opens a dialog where you specify a server name or IP to connect to, as well as the
port that the server listens to. Inspire Production Server (PNetTNetServer) runs on this
server.

When Autologin next time is checked, the specified Server and Port values are used
automatically when the application is started next time.

Logout Logs out from the server.

1719
16 Related Applications

Upload Using this option, you can select a file for upload to the server.

Source defines the path to the source WFD file in this case; Target specifies the path to
the location where the job will be uploaded and its file name.

The status of uploading can be checked in the Console window-pane. After a successful
upload you will see the following message there:

upload C:\PNetTNetServer\cert2.wfd;90112
ok;upload-start
ok;upload-finish

Download Using this option, you can select a file to download from the server.

Source defines the path to the WFD file on the server; Target specifies the path to the
location where the job will be downloaded and its file name.

To check the status of downloading, go to the Console window-pane. After a successful

download you will see the following message there:

download C:\PNetTNetServer\cert3.wfd
ok;972800
ok;download-finish

Options Dialog Using the Options Dialog, you can select the required font type, linked font
and switch between the GUI skins. For details see Fonts and General Options in Workflow
Options Dialog section.

1720
 16.2 Inspire Production Server and Inspire Production Server Client

Exit Quits the Inspire Production Server Client (PNetTNetClient) application.

Tools Menu
SendBatch After choosing this menu option, you can create a batch file (a set of commands
executed in sequence).

After clicking on OK, the batch is sent to the server. The result will be displayed in the
Server Queue window-pane:

See also the content of Console window-pane when the SendBatch option was used:

Help Menu
User Manual Opens the Inspire Designer User Manual.

Show Commands Help Displays or hides the Command Syntax window-pane.

About Displays the version number of Inspire Designer and copyright information.

1721
16 Related Applications

Inspire Production Server Client Batch Mode

You can also use an external batch file and run it in the following way:

PNetTNetClient.exe [-s "servername"] [-p portnumber] [-f "filename"]

Options Description

-s DNS name or IP address of the server where you want to connect to Inspire Production
Server (PNetTNetServer).

-p Port where the server listens.

-f Batch file name. This file contains a sequence of commands which are sent to the server.
When the commands are executed, Inspire Production Server Client (PNetTNetClient GUI)
is closed. Note that during commands execution, the progress is not shown in the
PNetTNetClient window.

Tip You can now use Inspire Production Server Console Client (PNetTCNetClient) to run batch
files and to have other functionality available too.

16.2.3.5 Context Menu

You can also execute commands using the context menu available by right-click.

Options Description

Query job messages The qjm command enables you to read messages logged by the In-
spire Designer engine during the production. The information about the selected workflow
displays in the Console window-pane:

1722
 16.2 Inspire Production Server and Inspire Production Server Client

Query job properties The qjp command is used to list the properties of a job. Properties
(SheetCount) of the selected job are displayed in the Console window-pane.

Abort job Aborts the selected job. This option is available only when the job is currently
running and has status Working.

Pause job Pauses the selected job. This option is available only when the job is currently
running and has status Working.

Resume job Resumes the paused job. This option is available only when the job is paused.

Close job Closes the selected job.

Acknowledge job The ackj command is used when the job parameters are to be deleted
from the server where they are stored for query purposes. Also, the job no longer appears
in the job list in the Server Queue window-pane.

Acknowledge all jobs This option is used when the parameters of all jobs (including finished
jobs) are to be deleted from the server. The jobs no longer appear in the Server Queue
window-pane.

Example Typical Use of Inspire Production Server Client (PNetTNetClient)

We run a server setup with two threads. The server is idle (no running jobs) and we have
three workflows:

long.wfd

short.wfd

short2.wfd

We subsequently send these commands to the server (either with Inspire Production
Server Client command line field or with telnet):

Command Response Comment

open ok;0;0 Job ID is 0, Workflow ID is 0.

long.wfd
run 0 -e ok;1 Server was idle, so job 1 (= processing workflow 0)
PDF can start immediately on thread 0. You can query
it with "qt" command.
qt 0 ok;1;0;Run Thread 0 is running (job 1, workflow 0) and is
Work working.
Flow;Work
ing
qt 1 ok;1;Idle. Thread 1 is idle. It is not necessary to have a com-
plete overview of the threads when sending com-
mands to the server, however it may be useful so

1723
16 Related Applications

Command Response Comment

that you can determine what jobs the server is

processing and what is its load.
open ok;2;1 Job ID is 2, Workflow ID is 1.
short.wfd
run 1 -e ok;3 Job 1 is still processed, but as the server has two
PDF threads job 3 starts running on thread 1 at once.
open ok;4;2 Job ID is 4, Workflow ID is 2.
short2.wfd
run 2 -e ok;5 Both threads are busy, job 5 (= processing of
PDF workflow 2) will remain scheduled until thread 0
or 1 finishes its job (it depends on the job processing
time). At any moment you can query jobs with "qj"
or "qallj" commands to track the job processing;
you can also abort the jobs using the abort
command.
abort 1 This command aborts job 1 (which is running
workflow 0). Thread 0 is idle and the server will
check the job queue and start processing scheduled
jobs (in our case job 5 = processing workflow 2). It
is possible now to 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 information about
the jobs, you can remove the workflows from In-
spire Production Server Client (PNetTNetClient) using
"ackj" command.
ackj 0 ok;
ackj 1 ok;

For more information about the used commands, see the section Commands.

16.2.4 Inspire Production Server Commands

All of the commands listed in this section can be sent to Inspire Production Server (PNetTNet-
Server) using Inspire Production Server Client (PNetTNetClient) or Inspire Production Server
Console Client (PNetTCNetClient). For a sample of command usage see Typical use of Inspire
Production Server Client.

As for Inspire Production Server Console Client (PNetTCNetClient), it can be used in two modes:

As a command line version of Inspire Production Server Client (PNetTNetClient), to

connect to Inspire Production Server (PNetTNetServer).

1724
 16.2 Inspire Production Server and Inspire Production Server Client

The same commands as for Inspire Production Server Client (PNetTNetClient) are used
(preceded with parameter -api or -apibatch).

As PNetTC.exe, the console version of Inspire Designer.

The same commands as for Inspire Production Console (PNetTC) are used.

The term "job" in this section refers to each task that is sent to the server. There are two types
of jobs:

Jobs added to the job queue on the server. These jobs are executed in due time and a
record is kept about them on the server.

Example open, run, close etc.

Jobs executed immediately. These jobs (typically query commands) are not added to
the job queue and there is no record kept about them.

Example qallj, qjm, qt, qw etc.

Parameters are separated with semicolons, however, you can also use semicolons within
parameters (e.g. as a part of a directory or file name). In that case the parameter has to be in-
cluded in single or double quotation marks. If the parameter contains besides a semicolon also
quotation marks, they have to be doubled. For example, the parameter xx;y"y will have to
be modified to "xx;y""y".

1725
16 Related Applications

16.2.4.1 Command Purposes

Check if connection is alive
Open WFD or PDF File
Open workflow for editing
Edit workflow
Export workflow
Export workflow to XML
Run workflow
Run workflow by name
Save and close workflow
Close workflow
Close workflow by name
Abort job
Acknowledge job
Download within Inspire Production Server Console Client (PNetTCNetClient)
Download when communicating with server directly (using TCP/IP)
Upload within Inspire Production Server Console Client (PNetTCNetClient)
Upload when communicating with server directly (using TCP/IP)
Convert image
Remove
Move
Pause job
Resume job
Query job
All job query
All job query for workflow
Query job messages
Query job properties
Query workflows
Query thread
Query all threads
Query latest version
Obtaining server version
Conversion of WFD files to XML
Conversion of XML files to WFD
Wait for job
Wait for job with return code
Alias Label
Label
Get labels and history
Dir
Dir extended
Make directory
Server diagnostics

Check if connection is alive

Command ping

Parameter none

Return Value ok or error message.

1726
 16.2 Inspire Production Server and Inspire Production Server Client

Open WFD or native file

Command open

Parameter workflowName [;aliasName] Specifies a name for the workflow or native

file that is usable with runw and closew commands.

PDF name

Return Value ok;jobID;workflowID or error message.

ok value returned only means the command is correct, it does not mean the workflow
was opened. This can be checked with query type commands, e.g. qw. When using this
command the job is added to the server job queue with identifier jobID.

Example open test.wfd

Response:

ok;0,0

Note

Any native file is opened in a newly created workflow.

Workflow and all files used by a workflow must be placed locally so that the server can
access them.

If there is no free thread on the server, the job status is Scheduled and the job is ex-
ecuted later when a server thread is free again.

Opened workflows can be accessed later using the identifier workflowID or alias
name.

On Unix systems the file name and alias must be used in quotation marks: -open
"file.wfd;alias"

Open workflow for editing

Opens a workflow for modification.

Command openforedit

Parameter workflowName

Return Value ok or error message.

Edit workflow
Modifies an open workflow using XML commands.

1727
16 Related Applications

This option was intended for specific use by system architects, not for general use.

Command editf

Parameter workflowID input.xml;output.xml; The input file should contain

commands to be executed and the output will return status and error messages.

Return Value ok or error message.

XML output file.

Example The following XML file (input.xml) imports the sample.xml file to the Layout1
module. This is an alternative to File | Import | XML.

<Coms>
<ImportLayoutXml>
<ModuleName>Layout1</ModuleName>
<FileName>c:\sample.xml</FileName>
</ImportLayoutXml>
</Coms>

Export workflow
Exports the opened job as a WFD file. Available only for files opened for editing.

Command export

Parameter workflowID;outputname

Return Value ok or error message

Export workflow to XML

Command exportxml

Parameter workflowID;outputname

Return Value ok or error message

Run workflow

Command run

Parameter workflowID Determines which workflow to run.

console commandline Means that commands for Inspire Production Console (PNetTC)
command line can be entered here.

Return Value ok; JobID or error message.

Example run 0 -e PDF -flush

Response:

1728
 16.2 Inspire Production Server and Inspire Production Server Client

ok;1

The -flush command line parameter returns the workflow to the state it was before
the run, e.g. unloads an external workflow or a source TNO.

Note This command is added to the job queue and executed in turn.

Run workflow by name

Command runw

This command opens and processes a workflow. It enables parallel processing of workflows,
i.e. running the same workflow in more threads at the same time.

Note Parallel processing, i.e. processing split if more processors or a multi-core processor
is used, is a different feature of Inspire Designer.

Parameter workflowName Determines which workflow to run (the first found workflow
with a given name).

aliasName If assigned while opening the workflow (the command open), determines
which workflow to run.

console commandline Means that commands for Inspire Production Console (PNetTC)
command line can be entered here.

Return Value ok; JobID or error message.

The runw command first checks the status of the workflow that you have specified by the
workflowName or aliasName parameter, the action that follows depends on the status:

If the workflow is not found among workflows opened via runw command, it is opened
and processed.

If the workflow has been opened via runw command, it is processed.

If the workflow has been opened and is already being processed, it is opened again in
a new thread. Thanks to this feature there is no need to wait till the other run is finished,
i.e. parallel processing of workflows is enabled. If the number of threads (specified by
the threadcount parameter) has been exceeded, the job is scheduled and will be run
as soon as one of those in process is finished.

The runwcachelimit parameter specifies the number of workflows that can be in

cache at a time.

Note

If the limit is reached, the workflow which has been opened via the runw command
and which has not been used for the longest time will be closed. Workflows that
have been opened via the open command will not be affected.

Set the runwcachelimit to 0, if you do not wish to enable parallel processing

of workflows, i.e. the behavior of the runw command will be the same as for ver-
sions prior to 7.0.

1729
16 Related Applications

Example runw "c:\workflow.wfd" -e PDF -f Z:\Resources\Spool

Files\workflow.pdf

Response:

ok;1

Save and close workflow

Saves the changes made in the file. Available only for files opened with the command open
foredit.

Command saveandclose

Parameter workflowID

Return Value ok or error message

Close workflow

Command close

Parameter workflowID

Return Value ok; JobID or error message.

Example close 0

As a response, the opened workflow is closed.

Close workflow by name

Closes the first found workflow with the given name. Alias name can be assigned while
opening the workflow (command open).

Command closew

Parameter workflowName or aliasName

Return Value ok; JobID or error message.

Example

closew "c:\workflow.wfd"
closew "aliasName"

1730
 16.2 Inspire Production Server and Inspire Production Server Client

Abort job

Command abort

Parameter jobID

Return Value ok or error message.

Note Abort command returns an error only in case invalid JobID is entered. You can abort
jobs waiting for execution (scheduled) and jobs currently running.

Acknowledge job
Removes all job parameters that are stored on the server, thus saving server memory. Query
commands described below will be then executed faster. This command can be applied to
finished jobs too.

Command ackj

Parameter jobID

Return Value ok or error message.

Download within Inspire Production Server Console Client (PNetTCNetClient)

Command download

Parameter Name of the file to be downloaded. If you want to save the file on the client
under a different name, write the desired name behind the name of the file to be down-
loaded and separate them by a semicolon.

Return Value ok; JobID or error message.

ok;download-finish

Example pnettcnetclient -api download test.wfd;test1.wfd

Response:

download test.wfd
ok;12345

Response confirming that test.wfd has been downloaded under the name test1.wfd:

ok;download-finish

Note

This command is here used within Inspire Production Server Console Client
(PNetTCNetClient), see the example above. If you need to download a file using Inspire
Production Server Client (PNetTNetClient), use the Download option from the
PNetTNetClient menu.

test.wfd name of the file on the server, which is to be downloaded

test1.wfd optional name of the file on the client

1731
16 Related Applications

Download when communicating with server directly (using TCP/IP)

Command download

Parameter filename followed by semicolon

Return Value ok; JobID or error message.

ok;download-finish

Example download test.wfd;

Response:

ok;12345
ok;download-finish

Upload within Inspire Production Server Console Client (PNetTCNetClient)

Command upload

Parameter Name of the file to be uploaded. If you want to save the file on the server under
a different name, write the desired name followed by a semi-colon which is followed by
the name of the file to be uploaded.

Return Value upload; JobID or error message.

ok;upload-start, ok;upload-finish

Example pnettcnetclient -api upload test1.wfd;test.wfd

Response:

upload test1;12345
ok;upload-start

Response confirming that test.wfd has been uploaded under the name test1.wfd:

ok;upload-finish

Note

This command is here used within Inspire Production Server Console Client
(PNetTCNetClient), see the example above. If you need to upload a file using Inspire
Production Server Client (PNetTNetClient), use the Upload option from the
PNetTNetClient menu.

test.wfd name of the file on the client, which is to be uploaded

test1.wfd optional name of the file on the server

1732
 16.2 Inspire Production Server and Inspire Production Server Client

Upload when communicating with server directly (using TCP/IP)

Command upload

Parameter filename

filesize in bytes (separated by semicolon)

Return Value upload; JobID or error message.

After the upload command, server has to send binary data with specified size.

ok;upload-start, ok;upload-finish

Example upload test.wfd;12345

Response:

ok;upload-start

OR

error;unable to upload file test.wfd

send binary 12345 bytes

Response:

ok;upload-finish

1733
16 Related Applications

Convert image
Converts an image from one format to another and/or changes other image properties, such
as color depth, dpi etc.

Command imageconvert

Parameter

-i inputFile
-f outputFile
-imagepalette 1,8,24,gray
-imageformat jpg,png etc.
-dimx
-dimy
-scale
-scalex
-scaley
-dpi
-dpix
-dpiy
-page pageNumber
-queryonly Opens an image and returns its size and page count, it does not save the
image.
-page N Selects a page in multi-page formats, like PDF (first page = 1).
-ignoreaspectratio
-keepaspectratio

Return Value ok; JobID or error message.

Remove
Removes the specified file from the server.

Command remove

Parameter filename followed by semicolon

Return Value ok; JobID or error message.

Remove Recursively
Removes the specified directory and its content from the server.

Command remove

Parameter directory

Return Value ok; JobID or error message.

1734
 16.2 Inspire Production Server and Inspire Production Server Client

Move
Moves the specified file to the new destination. It can be saved under a different name.

Command move

Parameter source; destination

Return Value ok; JobID or error message.

Pause job

Command pause

Parameter jobID

Return Value ok or error message

Resume job

Command resume

Parameter jobID

Return Value ok or error message.

Query job

Command qj

Parameter jobID

Return Value List of information about the job: job ID, name of the workflow that is being
processed, job status etc.

While the workflow run is in progress, we receive some additional information: workflow
status, progress (in percentage and as the number of the currently processed page/total
page count), error count, warning count.

Example

qj 0

Response: ok;0;0;test.wfd;Open WorkFlow;Finished

Response description: Job ID was provided (ok); job ID is 0; job 0 operates with
workflow 0; name of workflow is test.wfd; command type is Open workflow; job
was executed without errors and is finished.

qj 1

Response: ok;1;0;test.wfd;RunWorkFlow;Working; Prepro

cessing;17%;E0;W0

1735
16 Related Applications

Response description: Job ID was provided (ok); job ID is 1; job is operating in

workflow ID 0; job is still in progress (Working); currently preprocessing 17%
complete; without any errors or warnings. These additional return values are the
same as progress information in Inspire Designer production.

Note This command is not added to queue, it is executed immediately.

All job query

Command qallj

Parameter none

Return Value length of list

CRLF

List of all jobs with the files they used and their type, time, status, warning counts etc.

Example XML structure:

"<?xml version=\"1.0\" encoding=\"UTF-8\"?>

<JobsInfo>
<Job>
<JobId>12</JobId>
<WorkFlowId>4</WorkFlowId>
<JobType>OpenWorkFlow</JobType>
<AddedDate>2004-11-01T11:13:18Z</AddedDate>
<Progress>0</Progress>
<ProgressInfo/>
<Status>Failed</Status>
<User/>
<ErrorCount>0</ErrorCount>
<WarningCount>0</WarningCount>
<WorkFlowName>c:\\__works\\source\\
Clients_stock</WorkFlowName>
</Job>
</JobsInfo>

All job query for workflow

Command qjbyw

Parameter workflowId

Return Value List of all jobs related performed with a specific workflow, with the files they
used and their type, time, status, warning counts etc.

1736
 16.2 Inspire Production Server and Inspire Production Server Client

Query job messages

Inspire Designer logs messages during production and this command enables you to read them.
Typically it is used when the qj command returns non-zero values for error count and warning
count.

Command qjm

Parameter jobID

Return Value length of message log

CRLF

List of all messages in the production log.

Query job messages range

Command qjmr

Parameter jobID first last The indexes of the first and last messages in the range
that should be returned. The value -1 for the last message means till end.

Return Value Length of XML file.

CRLF

XML list of messages from production log that are in the given range.

Query job properties

Command qjp

Parameter jobId

Return Value List of job properties including: SheetCount (all engines); foundOnSheetX Path
(Find engine, X is page index, Path is path description); SheetDimX,Y (only Info engine).

Query workflows

Command qw

Parameter none

Return Value List of opened workflows.

Query thread

Command qt

Parameter thread index (beginning from 0)

Return Value Status of the server thread with the given index. It can be idle or running a
job. In this case the ID of the running job is returned.

1737
16 Related Applications

Query all threads

Command qallt

Parameter none

Return Value Status of all server threads. A thread can be idle or running a job. In this case
the ID of the running job is returned.

Query latest version

Command qlv

Parameter filename

Return Value Number of the latest version of the specified file on the Inspire Content
Manager (VCS) server.

Example qlv vcs://sampleworkflow.wfd

Response:

qlv vcs:\\sampleworkflow.wfd
OK
ok;4

There are 4 versions of the "sampleworkflow.wfd document on the Inspire Content

Manager (VCS) server.

Obtaining server version

Command version

Parameter none

Return Value Number of the server version.

Example ok;4.2.100.0,beta

1738
 16.2 Inspire Production Server and Inspire Production Server Client

Conversion of WFD files to XML

Command wfd2xml

Parameter

inputfilename; outputfilename There has to be a semicolon between the input

file name and the output file name.
-od Specifies output directory (default is the output file name directory).
-pd Specifies preview directory (default is the output file name directory).
-imagedpi
-generatepreview Generates previews of all objects in layout (they can be later used
in Inspire Approval).
-exportusedfiles Exports also all used files. The default value is true.

Return Value ok; jobID or error message.

Example wfd2xml test.wfd; test.xml

Conversion of XML files to WFD

Command xml2wfd

Parameter

inputfilename; outputfilename There has to be a semicolon between the input

file name and the output file name.
-includeall Includes all files used by the WFD file. The default value is false.

Return Value ok; jobID or error message.

Example xml2wfd test.xml; sample.wfd

Wait for job

Stops the connection until a command with jobId is processed (finished or failed).

Command wfj

Parameter

jobId
timeout (in seconds; optional)

Return Value When the job is processed before timeout expires, then it returns finished,
when the timeout is specified and the job does not finish within the timeout period, then
the connection is resumed and the command returns the string expired. 0 means infinite
timeout, when not specified, infinite is assumed.

1739
16 Related Applications

Wait for job with return code

Command wfjrc

Parameter none

Return Value Same as the wfj command but returns also the jobs exit code.

Alias Label
For all files that have alias labels, this command replaces the alias label with a new one.

Command aliaslabel

Parameter location (String); oldlabel (String); newlabel (String);

labelcomment (String); labelcommenttype (Append, Apply, ApplyOn
New); filecomment (String); filecommentupdatetype (Append, Ap
ply); recursive (Bool)

Return Value ok or error message.

Label

Command label

Parameter vcs://filename/; versionid; labelname; labelcomment; la

belcommenttype (Append, Apply, ApplyOnNew); filecomment; filecom
mentupdatetype (Append, Apply); recursive (Bool); preferred
branches

Return Value ok or error message.

Note If a directory is labeled, the versionid parameter has to be -1. The value -1 means
the last version in the branch. For directories it is not possible to determine the version ID.

Get labels and history

Command getlabels

Parameter filename

Return Value Complete history of the chosen Inspire Content Manager (VCS) file: Version,
user name, date and time of saving, branches, labels and file size. The content is similar
to that of the History dialog in the Inspire Content Manager Explorer (VCS Explorer).

Note If the returned file size value is -1, the file version has been deleted or you are
connected to an old version of Inspire Content Manager (VCS) server without file size
support.

1740
 16.3 PNetT.exe Command Line Parameters

Dir

Command dir

Parameter path

Return Value XML list of file information such as file name, size, date and time of creation
and modification, attributes.

Dir extended

Command direx

Parameter path

Return Value In addition to the information retrieved by the dir command, this command
returns also labels of the latest file version and date and time of creating the directory.

Make directory
Creates a new directory.

Command mkdir

Parameter path

Return Value ok or error message.

Server diagnostics

Command diag

Parameter none

Return Value XML list containing the following information: server version, date and time
of starting the server, server uptime, number of threads, number of connections, server
log file location, path to the redist directory, path to the directory from which the server
was launched, commandline that launched the server, hostname, host IP, operating system,
Inspire Content Manager (VCS) login status.

16.3 PNetT.exe Command Line

Parameters
16.3.1 Parameters Overview
Using the following command line parameters (e.g. in the MS Windows Command Prompt
console cmd.exe) you can open Inspire Designer in various ways:

1741
16 Related Applications

Action Command

Open Inspire Design- PNetT.exe

er in the Workflow
environment: E.g.: "C:\Program Files\Inspire Designer\PNetT.exe"
Open the Proof envir- PNetT.exe proof
onment:
Opens the specified WFD or native file in Proof.
Open the Production Simple Production using parameter PNetT.exe sp
environment:
Production using parameter PNetT.exe ap

You can also open a WFD file and corresponding production config-
uration JOB file at the same time in combination with the commands
-sp or -ap. Referencing only the JOB file in the command line will
open the corresponding WFD file as well.

E.g.:

"C:\Program Files\Inspire Designer\PNetT.exe" -ap

Z:\Resources\ProductionConfigs\sample.job

Import file into Lay- PNetT.exe -import

out and open:
Imports the specified native, RTF, DOC or DOCX file. The file is im-
ported to the Layout of a newly created workflow.
Open Inspire Content -fl -vcsserver servername (e.g. localhost, 192.168.42.95)
Manager (VCS) Login -vcsport portnumber
screen:

Tip The workflow module parameters for PNetTC.exe work also for PNetT.exe (with -proof,
-ap, -sp parameters). This is useful if you want to have a look at the job that you are processing
via console application Inspire Production Console (PNetTC) in Proof (or Production window
GUI). It is no longer necessary to run the application GUI and set the workflow parameters in
the Workflow Parameters window-pane manually according to the command line, you can
change just the beginning of the command line according to what application you want to
check your job in.

Example If you want to have a look at the job from the command line
PNetTC.exe Workflow.wfd -difDataInput Data.csv in Proof, you can run
PNetT.exe in proof mode instead and the workflow will be shown with the different data:
PNetT.exe -proof Workflow.wfd -difDataInput Data.csv.

1742
 16.3 PNetT.exe Command Line Parameters

16.3.2 Specifying the Folder for Configuration

and Cache Files
The command format is:

PNetT.exe c directory

where directory specifies the full path to the directory that will contain:

The PNetT.cfg file (configuration file).

The fontcache.dat file.

Cache files, i.e. TSD (Tamino Schema Definition) files that are saved from Inspire Designer
as an internal file format.

Example PNetT.exe c C:\PNetTCFG

PNetT.exe c C:\PNetT Configuration

This can be used over a network, e.g. in order to save these config and cache files on a server.

Alternatively, PNetT.exe cc can be used to store them in the current directory, i.e. the
same directory as the PNetT.exe file.

Note These parameters override the PNETT_DIR environment variable.

16.3.3 Specifying the Language for the GUI

It is possible to select the language for the GUI in the command line. The command format is:

PNetT.exe lang

where lang needs to be followed by a space and the code of the language chosen. The op-
tions are:

en for English (default)

cs for Czech

de for German

fr for French.

The interface language can also be selected from the list in Workflow Window menu.

16.3.4 Using Workflow File Name(s) as

Parameter
You can launch one or more workflow files (*.WFD) simultaneously with Inspire Designer.

1743
16 Related Applications

The command format is:

PNetT.exe [workflow_path/]workflow_filename

Note Enclose filenames containing spaces in quotes.

Tip When you want to launch several workflow files at once, separate them by space:
PNetT.exe myworkflow.wfd nextworkflow.wfd

16.4 PNetTC.exe Console

Application
16.4.1 Inspire Production Console
In this section:
General Parameters
Exit Code Processing Parameters
Inspire Content Manager Parameters
Logging Parameters
Multiple Jobs Processing Parameters
Multiple Outputs Processing Parameters
Workflow Comparison Parameters
Workflow Modules Parameters
Workflow Processing Parameters
Workflow Script Checking Parameters
Workflow to XML Conversion Parameters
Workspace Parameters
XML to Workflow Conversion Parameters
List of Exit Codes

The main purpose of Inspire Production Console is to process workflows and native files, but
it can also perform other tasks. Each task can be controlled by different parameters being
entered in a command-line interface (CLI), e.g. in the MS Windows Command Prompt console.

The console's application file name is PNetTC.exe. By default, it is located in the Inspire Designer
directory.

General syntax (if the CLI is run in the same directory as PNetTC.exe):

PNetTC.exe [inputFilePath] [parameterName [parameterValue]] ...

or PNetTC [inputFilePath] [parameterName [parameterValue]] ...

1744
 16.4 PNetTC.exe Console Application

Rules for Parameters

A valid input file is any of Inspire Designer formats: WFD, native files or JOB files for
production configuration.

Specified parameters override the values stored in the JOB file.

Parameter values that contain spaces must be placed inside quotation marks.

If a parameter is used more than once, only the last occurrence is used.

The phrase <ModuleName> used as the part of the parameter name has to be replaced
with the given module name.

For parameters of the type Bool any of the values true/false, T/F, yes/no, Y/N or 1/0 are
accepted (case insensitive).

For parameters of the type dimension the specified number can be extended by one of
the following units m (default), mm, cm, in, di, pt.

Example PNetTC Z:\WFDs\FroodecoLetter.wfd -difDataInputData.csv

-c JobFile.job -o OutputAFP -f Output.afp -autoskipmissing

PNetTC "Z:\Todays Data Reports\NativeData.tno" -e PDF

PNetTC Production.job -difDataInput Data.csv -f Output.afp

PNetTC multiple multi.txt -l log.txt

PNetTC -wfd2xml Workflow.wfd -exportusedfiles false

PNetTC -xml2wfd Workflow.xml -includeall false

PNetTC Z:\WFDs\Base.wfd -compare Workflow.wfd -f Differences.xml

PNetTC "Z:\Test WFDs\Test42.wfd" -checkscripterrors

PNetTC Z:\WFDs\Workflow.wfd -nssyoffSplitter 10mm

Note For information about what is necessary for the PNetTC.exe to work from a different
directory than the installation directory, see the section Installation Directory Content.

Tip If you want to have a look at the job that you are processing via console application Inspire
Production Console (PNetTC) in Proof or Inspire Native Viewer (or Production window GUI), it
is no longer necessary to run the application GUI and set the workflow parameters in the
Workflow Parameters window-pane manually according to the command line. The workflow
module parameters for PNetTC.exe work also for PNetT.exe (with -proof, -ap, -sp parameters)
and PNetTView.exe, so you can change just the beginning of the command line according to
what application you want to check your job in.

16.4.1.1 Relation to GUI

The relation between the command line parameters and the settings in GUI is demonstrated
on a sample below.

1745
16 Related Applications

PNetTC.exe Sample_Letter_Lyon.wfd -difDataInput1 C:\FIIIclients.csv -o A4 -c

test.job -e PodiPPML -f C:\test.ppml -ec color -dc color

Number Command Description

1 PNetTC.exe Runs the console version of Inspire Designer.

2 Sample_Letter_Ly The selected WFD file to be printed.
on.wfd
3 -difDataInput1 The selected data input file is FIIIclients.csv.
C:\FIIIclients.csv
4 -o A4 The selected output object is A4.
5 -c test.job The settings will be loaded from the test.job file.
In GUI go to Production | Load Production
Configuration.
6 -e PodiPPML The selected engine is PodiPPML.
7 -f C:\test.ppml The output file name is set to test.ppml.
8 -ec Color The engine configuration to be loaded from the
config file is Color.
9 -dc Color The driver configuration to be loaded from the
config file is Color.

16.4.1.2 General Parameters

Parameters Description

-lang String Specifies a language for messages using the ISO 639-1 language code.

Note All languages except English have to be licensed so that they can be used in
PNetTC.exe version 4.3 and higher.

-tempdir folderPath Specifies a directory for temporary files.

1746
 16.4 PNetTC.exe Console Application

The following parameters are entered on their own, i.e. can be combined only with the -lang
parameter.

-? or -h [filePath] Displays a help with the usage of Inspire Production Console (PNetTC).
If a path to the WFD file is specified, displays the list of all workflow module parameters
and output modules available in that file.

-checklicence Checks the validity of a license. No input file parameter is required.

It also returns current values of sheet counters used by volume licensing.

16.4.1.3 Exit Code Processing Parameters

Parameters Description

-retiw Ignores the exit code 2 "Warnings logged".

-retadv2 Obtains advanced exit codes.

Example If the following command is used pnettc chart.wfd -E PDF -f

chart.pdf and then an exit code is listed using the command echo %errorlevel%,
the error code 1 is displayed (Command line not executed).

In case of using -retadv2 parameter the resulted error code is 85 (Invalid engine because
-E was used instead of -e).

16.4.1.4 Inspire Content Manager Parameters

See also:
Inspire Content Manager Overview

Paths to files and directories in Content Manager can also include branch and version inform-
ation in order to access a specific version of that file. See the separate section Paths to Files in
Content Manager.

Parameters Description

-server String Sets a hostname for Inspire Content Manager (VCS) login.

-username String Sets a username for Inspire Content Manager (VCS) login.

-password String Sets a password for Inspire Content Manager (VCS) login.

-logascurrent Logs into Inspire Content Manager (VCS) as current user.

-vcspreferredbranches String or -icmpreferredbranches String Specifies

the preferred Inspire Content Manager (VCS) branches (comma separated).

1747
16 Related Applications

-vcslabel String or -icmlabel String Specifies a label marking the file to get from
Inspire Content Manager (VCS).

-vcscache folderPath or -icmcache folderPath Specifies a path to Inspire Manager

(VCS) cache location.

Note The parameter cannot point to a cache directory that is already used by another
instance of Inspire Designer (for example, when you run two instances of Inspire Designer,
a combination of Inspire Designer and Inspire Content Manager Explorer (VCS Explorer),
Inspire Designer and Inspire Production Server, etc.).

-downloadoperationslog Downloads the operations.dat file in the CSV format from

Inspire Content Manager (VCS).

Example

pnettc.exe -downloadoperationslog operations.csv -vcsaddress localhost

-vcsuser admin -vcspassword pass

-downloadoperationslogandclear Downloads and clears the operations.dat file from

Inspire Content Manager (VCS).

Example

pnettc.exe -downloadoperationslogandclear operations.csv -vcsaddress

localhost -vcsuser admin -vcspassword pass

16.4.1.5 Logging Parameters

Parameters Description

-l filePath Specifies a log file (overwrites the existing one).

-la filePath Specifies a log file (appends the existing one).

-logtime Specifies whether also date and time will be logged together with messages.

-filelogging Specifies whether also information about all external files opened for a
given job will be logged.

-nowarnings Suppresses logging warnings to the console. They will be logged only to a
log file.

-warningconfig filePath Specifies a file containing saved warning configuration (a

WPR file).

See the Warnings section for more information.

1748
 16.4 PNetTC.exe Console Application

-messagedonotlog String Specifies what warning messages will not be logged (comma
separated message codes).

-enableerrorconsole Logs all errors into an error console.

As by default the error console is the same as the default log file it is necessary to specify
a log file just for logging errors as in the example below.

Example PNetTC test.wfd e AFP enableerrorconsole >nor

mal.txt 2>error.txt

Besides the default.log file containing all log messages this example will create two
further files with the specified names into which the entries from the default.log file
will be split up:

normal.txt this file contains all "non-error" log messages

error.txt this file contains only error messages

16.4.1.6 Multiple Jobs Processing Parameters

As a valid input only a multiple jobs configuration file is accepted.

Other parameters (for example -difDataInput1) can be used, if they are applicable to all
workflows used in the multiple job file.

Parameters Description

-jobindex Integer Specifies the index of a job in the multiple jobs configuration file
which will be processed.

Example PNetTC.exe jobfile.job

All jobs set in the production configuration file will be processed.

PNetTC.exe jobfile.job -jobindex 2

Only the second job will be processed.

-abortonfirsterror Aborts the processing of the rest of jobs when an error has occurred.

16.4.1.7 Multiple Outputs Processing Parameters

No input file parameter is required.

Parameters Description

-multiple filePath Specifies a Multiple Outputs batch file.

-abortonfirsterror Aborts the processing of the rest of commands when an error has
occurred.

1749
16 Related Applications

16.4.1.8 Workflow Comparison Parameters

Parameters Description

-compare filePath Compares the specified workflows. The result can be saved in XML
or TXT format using -f parameter.

Example PNetTC base.wfd -compare workflow.wfd -f differ

ences.xml

16.4.1.9 Workflow Modules Parameters

Tip These workflow module parameters for PNetTC.exe work also for PNetT.exe (with
-proof, -ap, -sp parameters) and PNetTView.exe. This is useful if you want to have a look
at the job that you are processing via Inspire Production Console (PNetTC) in Proof (or Production
window GUI) or Inspire Native Viewer. It is no longer necessary to run the application GUI and
set the workflow parameters in the Workflow Parameters window-pane manually according
to the command-line, you can change just the beginning of the command-line according to
what application you want to check your job in.

Example If you want to have a look at the job from the command-line
PNetTC.exe Workflow.wfd -difDataInput Data.csv in proof, you can run
PNetT.exe in proof mode instead and the workflow will be shown with the different data:
PNetT.exe -proof Workflow.wfd -difDataInput Data.csv.

Tip These parameters can be used for Workflow.Parameter, e.g. WorkFlow.Paramet

er["DataInput1","dif"]. They are used the following way: WorkFlow.Paramet
er["<ModuleName>","parameter"], the parameter without the dash.

Data Input Modules Parameters

Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difDataInput1 data.csv.

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difDataInput1ExtWorkflow1 Clients.csv.

-diUseRangeForProduction<ModuleName> Bool Specifies whether to enable the

Range for Production option.

1750
 16.4 PNetTC.exe Console Application

Example

PNetTC.exe C:\Workflow.wfd -diUseRangeForProductionDataInput1 true -diS

tartRecordDataInput1 10 -diEndRecordDataInput1 15 -e PDF

-diStartRecord<ModuleName> Integer Sets the starting record for Production. Re-

quires the Range for Production option enabled.

Example

PNetTC.exe Workflow.wfd -diUseRangeForProductionDataInput1 true -diS

tartRecordDataInput1 10 -e PDF

-diEndRecord<ModuleName> Integer Sets the ending record for Production. Requires

the Range for Production option enabled.

Example

PNetTC.exe Workflow.wfd -diUseRangeForProductionDataInput1 true -diEndRe

cordDataInput1 15 -e PDF

-diCodePage<ModuleName> String Specifies an encoding for the data input file. It is

possible to use any codepage name that can be found in the ICU library.

Example PNetTC.exe Workflow.wfd -diCodePageDataInput1

ibm-1250 -e PDF

Internal Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difInternalDataInput1 data.tsd.

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difDataInput1ExtWorkflow1 Clients.csv.

Script Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difScriptDataInput1 data.txt.

1751
16 Related Applications

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difDataInput1ExtWorkflow1 Clients.csv.

XML Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difXMLDataInput1 data.xml.

-forcepreservespaces<ModuleName> Bool Specifies whether to preserve spaces in

all the elements (except the mixed content).

ODBC Data Input Module Parameters

Parameters Description

-con<ModuleName> String Specifies a connection string.

-sql<ModuleName> String Specifies an SQL query.

Param Input Module Parameters

Parameters Description

-<ParamInputVariableName><ModuleName> String Assigns values to variables

defined in the Param Input module, e.g. -greetingsParamInput1 "Hello World".

External Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difExtDataInput1 data.xml.

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difDataInput1ExtWorkflow1 Clients.csv.

SAP Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difSAPDataInput1 data.xml.

1752
 16.4 PNetTC.exe Console Application

The SAP data input module requires the same file format of the input data as that specified
in the workflow. E.g., if the workflow uses a RDI file, you can specify only RDI files in this
parameter.

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difDataInput1ExtWorkflow1 Clients.csv.

Data Generator Module Parameters

Parameters Description

-dgfrom<ModuleName> Integer Sets the starting value of the number range.

-dgto<ModuleName> Integer Sets the ending value of the number range.

Line Data Input Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difLineDataInput1 data.txt.

Data Processing Modules Parameters

Record Filter Module Parameters

Parameters Description

-rfif<ModuleName> filePath Specifies an input file.

-rfps<ModuleName> String Specifies a string pattern with records which pass through
each time.

-rfinvert<ModuleName> Bool Specifies whether all records, except those identified in

the defined module, will pass through the filter.

This is an alternative to the GUI option Don't pass through records which are in file.

Note When using Record Filter module parameters in a script (e.g. the -rfps<ModuleName>
parameter), then the Record Filter module has to be placed before the module using this script
(e.g. Data Transformer) in the workflow.

1753
16 Related Applications

MinMax Generator Module Parameters

Parameters Description

-hidechar<ModuleName> Bool Specifies whether to replace all real characters with the
character defined by the -replchar parameter.

-enable<ModuleName> Bool Specifies whether to enable the Generator.

-replchar<ModuleName> Character Specifies a replacement character (the asterisk

by default).

Data Pass Through Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies a file path that overrides a default data input
file in the workflow, e.g. -difDataPassThrough1 data.xml.

Note If the data input file is in an external workflow, the syntax has to have the following
format: -dif<DataInputModuleName><ExternalWorkflowModuleName> filename, e.g.
-difdifDataPassThroughExtWorkflow1 Data.xml.

Personalized URL Module Parameters

Parameters Description

-key<ModuleName> String Sets the client key for the web service.

-pwd<ModuleName> String Sets the password used for access to the FTP or HTP where
data is stored.

-cache<ModuleName> filePath Sets the location of the local cache file.

-mode<ModuleName> Integer Sets the module's running mode (0 Offline Demo, 1

Run, 2 Clear and Run).

Layout Module Parameters

Parameters Description

-useerrorrecovering<ModuleName> Bool Specifies whether to enable the Use error

recovering option.

-errorfilename<ModuleName> filePath Specifies an error file name.

-commitprintedmessages<ModuleName> Bool Creates an XML file with all printed

messages.

It is related to Messages in the Layout module.

1754
 16.4 PNetTC.exe Console Application

-uselogictracking<ModuleName> Bool Specifies whether to enable the Logic

tracking mode for effective proofing or printing of large jobs.

-evaluationstatistic<ModuleName> Bool Specifies whether to enable generating

of statistics in the log file.

Statistics cover usage of flows, rows, fills, images, pages and variables in the given job
and bring detailed information about conditional objects usage.

XSLFO Module Parameters

Parameters Description

-xslfof<ModuleName> filePath Specifies an XSLFO input file.

Impositioning Modules Parameters

Simple N-Upper Module Parameters
The following parameters are available only if the Propagate params to production option
in the Simple N-Upper module dialog is checked.

Parameters Description

-snupxcnt<ModuleName> Integer Sets the number of pages to be printed across the

sheet.

-snupxoff<ModuleName> dimension Sets the space between the X the pages being
printed across the sheet.

-snupycnt<ModuleName> Integer Sets the number of pages to be printed down on

the sheet.

-snupyoff<ModuleName> dimension Sets the space between the Y pages being printed
down the sheet.

-duplextype<ModuleName> String Sets the duplex type (Simplex, DuplexX, DuplexY).

Sheet Transformer Module Parameters

The following parameters are available only if the Propagate params to production option
in the Sheet Transformer module dialog is checked.

Parameters Description

-stransscalex<ModuleName> Double Scales the input sheet on the axis X.

-stransscaley<ModuleName> Double Scales the input sheet on the axis Y.

-stransrot<ModuleName> Double Applies rotation (in given degrees) to the input

sheet. The rotation point is in the upper left corner of the sheet.

1755
16 Related Applications

-stransxoff<ModuleName> dimension Sets the offset on the axis X.

-stransyoff<ModuleName> dimension Sets the offset on the axis Y.

Sheet NS Splitter Module Parameters

The following parameters are available only if the Propagate params to production option
in the Sheet NS Splitter module dialog is checked.

Parameters Description

-nssxcnt<ModuleName> Integer Sets the number of pages to be printed across the

sheet.

-nssxoff<ModuleName> Integer Sets the space between the X pages being printed
across the sheet.

-nnsycnt<ModuleName> Integer Sets the number of pages to be printed down on the

sheet.

-nssyoff<ModuleName> dimension Sets the space between the Y pages being printed
down the sheet.

-nsssoff<ModuleName> dimension Sets split offset.

Requires the Split type option in the Sheet NS Splitter module dialog set to Simple.

-nsspackagecnt<ModuleName> Integer Sets a sheet count.

Requires the Split type option in the Sheet NS Splitter module dialog set to any value
except to Simple.

Group Filter Module Parameters

Parameters Description

-g<ModuleName> Bool Specifies whether to enable the Group Oriented filter.

-f<ModuleName> Integer Sets the starting value for the range.

-e<ModuleName> Integer Sets the ending value for the range.

-r<ModuleName> String Sets a custom range (comma or dash separated integers, e.g.
1,4-6).

-dif<ModuleName> filePath Sets a path to a plain text file containing a custom group
range (the same rules as for the -r parameter).

1756
 16.4 PNetTC.exe Console Application

Region Binder Module Parameters

Parameters Description

-rbif<ModuleName> filePath Specifies an output file.

-rbcf<ModuleName> filePath Specifies a config file.

-rbrf<ModuleName> filePath Specifies a report data file.

-rbpn<ModuleName> Integer Specifies a pass number.

Select N Groups Module Parameters

Parameters Description

-nselect<ModuleName> Integer Specifies the number of groups.

Output Modules Parameters

General Production Parameters

Parameters Description

-e String Specifies an engine in Production.

One of the following list: AdobePostScript2 or PS2, AdobePostScript3 or PS3,

AFP, CreoVPS, Desktop Printer (driver), Docx, HP PPML, HTML, HTML Simple
or HTMLSimple or Simple Html or SimpleHTML, IJPDS or Scitex, IPDS, Image,
Metacode, MIBF or MJP or MJP, Multi, NexPressVDX, NULL, PDF, PDF Fixed
Resolution or PDFFix, PodiPPML, Raster, SWF, SX/AP, Text, VIPP.

The above listed engines are all accessible via the Production environment of the Inspire De-
signer GUI and a description of each can be found via the separate section Engine Config-
uration Overview.

-shbeg Integer Specifies the starting sheet in the Job configuration.

This parameter can be used also with negative values, e.g. -1 = last page of the job, -2 =
two last pages of the job etc.

-shend Integer Specifies the ending sheet in the Job configuration.

This parameter can be used also with negative values, e.g. -1 = all the pages of the job, -
2 = all the pages of the job except the last one etc.

Note -shbeg Integer and -shend Integer parameters can be combined.

-toend Bool Specifies whether the job will be printed to end.

-cc Integer Sets the number of copies.

-pug1 Bool Specifies whether to enable the Print user group 1 option.

1757
16 Related Applications

-pug2 Bool Specifies whether to enable the Print user group 2 option.

-pug3 Bool Specifies whether to enable the Print user group 3 option.

-col Bool Specifies whether to enable the Collate option.

-offsetx dimension Sets horizontal offset (x).

-offsety dimension Sets vertical offset (y).

-scalex Double Sets horizontal scaling.

-scaley Double Sets vertical scaling.

-ec String Loads engine configuration of the specified name from the config file.

See an example of usage in the introduction to this section.

-dc String Loads driver configuration of the specified name from the config file.

See an example of usage in the introduction to this section.

-pc String Loads printer configuration of the specified name from the config file.

See an example of usage in the introduction to this section.

-runbyrecord Bool Specifies whether to enable the Run by record mode. This parameter
cannot be used for natively imported HTML files.

-profdata Profiles data while processing a job in console.

If enabled, there are the same log messages available as in the proof or production log
palette windows in the output.

-parallelprocessing Integer Sets the parallel processing level (0 = no parallel pro-

cessing, 1 = parallel processing).

-keepdataconfidential Integer Allows you to display data as confidential in Produc-

tion. 0-Never, 1-Always, 2-Proof only.

-allowrecordatonce Bool Specifies whether to disable reading and storing whole record
data into application memory. It serves the same purpose as Read complete record data
into memory check-box in the Current Workflow Options dialog. The command overrides
this setting in the GUI. However, if there is a different setting in the config file, the setting
from the config file will be applied.

1758
 16.4 PNetTC.exe Console Application

Engine Specific Parameters

AFP Engine Parameters

Parameters Description

-afpXMLSummaryFile Bool Specifies whether to create a job summary as an XML file.

The summary will include the version number of Inspire Designer, the name of the processed
WFD file, the number of pages (and sheets etc.) and the size of the AFP file.

-afpXMLSummaryFileName filePath Specifies a file path for the summary XML file.

Image Parameters

Parameters Description

-imagedpi Integer Sets an image DPI.

-imageformat String Specifies an image type (PNG, JPEG, BMP etc.).

-imagepalette Integer Sets an image depth in bits (1, 8, 24) or gray for 8-bit gray
scale.

-highlightvariables Bool Specifies whether to obtain the highlight variables info.

Raster Engine Parameters

Parameters Description

-cropsizex Integer Sets a cropping on the X axis in pixels.

-cropsizey Integer Sets a cropping on the Y axis in pixels.

-postprocessscale String Sets an image scaling in pixels or percentage value.

Example -postprocessscale 100,100 or -postprocessscale 100 (if

the value is the same for both dimensions)

-postprocessscale 50%,50% or -postprocessscale 50%

-imagedpi Integer Sets an image DPI.

-highlightvariables Bool Specifies whether to obtain the highlight variables info.

1759
16 Related Applications

PDF Engine Parameters

Parameters Description

-pdfcompress Switches the PDF compression on (the non-image PDF file content will be
compressed).

-pdfautoprint Bool Specifies whether to print the PDF file after opening in a PDF
viewer (if this feature is supported).

-pdfnoprint Bool Specifies whether to protect the PDF file from printing in a PDF viewer
(if this feature is supported).

-pdfformprint Bool Specifies whether to use alternative images for displaying in a PDF
viewer (if this feature is supported).

-pdfnosave Bool Specifies whether to protect the PDF file from saving the changes in a
PDF viewer (if this feature is supported).

-pdfusrpsw String Sets an user password.

-pdfownpsw String Sets an owner password.

-pdfshowprintdlg Bool Specifies whether to show the print dialog in a PDF viewer (if
this feature is supported). If that dialog is disabled, the document is printed to the default
printer.

-pdfshrinktofit Bool Specifies whether to scale a PDF page to fit paper when printing.

-jdf String Sets the path to the directory (either absolute path or relative directory) where
a JDF file is generated.

This is the alternative way for the GUI option Target route directory in the PDF Printer
Config and can be used e.g. in Inspire Automation. The command line setting overrides
setting in the Printer dialog.

PDF Fixed Resolution Engine Parameters

Parameters Description

-pdfcompress Switches the PDF compression on (the non-image PDF file content will be
compressed).

-pdfautoprint Bool Specifies whether to print the PDF file after opening it in a PDF
viewer (if this feature is supported).

-pdfshowprintdlg Bool Specifies whether to show the print dialog in a PDF viewer (if
this feature is supported). If that dialog is disabled, the document is printed to the default
printer.

-pdfshrinktofit Bool Specifies whether to scale a PDF page to fit paper when printing.

1760
 16.4 PNetTC.exe Console Application

InspireNative Engine Parameters

Parameters Description

-tngcompress Bool Specifies whether to compress the InspireNative output.

-tngincludeall Bool Specifies whether to include all images and fonts.

-tnggenmetadata Bool Specifies whether to add metadata to the TNO file.

Desktop Printer Parameters

Parameters Description

-winndrv String Specifies a printer driver.

-f filePath Specifies an output file name in the Driver Configuration.

Find Engine Parameters

Parameters Description

-findtext String Specifies text to be found. Returns the position of the found text, the
text itself and 20 preceding and following characters.

-findwholewordonly Bool Specifies whether to search for whole words only.

-findmatchcase Bool Specifies whether to match the case.

-findabortonfind Bool Specifies whether to abort searching when the first occurrence
has been found.

Info Engine Parameters

Parameters Description

-imagedpi Integer Specifies an image DPI that is used for rasterizing of vector objects.

MIBF Engine Parameters

Parameters Description

-mibfNonResImgs filePath Specifies the path to a plain text file with a list of non-
resident images.

SX/AP Engine Parameters

Parameters Description

-sxapconfig filePath Specifies the path to a file with additional configuration details
which may be required depending on the printer being used.

1761
16 Related Applications

Data Output Module Parameters

Parameters Description

-datacodec String Specifies an encoding for the output file.

-dataoutputtype String Specifies a data output type (CSV, XML, FLAT, TSD, PureFlat,
Null).

Advanced Data Output Module Parameters

Parameters Description

-dof<ModuleName> String Specifies the default value of the File Modifier String workflow
parameter.

Sheet Statistic Module Parameters

Parameters Description

-datacodec String Specifies an encoding for the statistic data.

Script Library Module Parameters

Parameters Description

-dif<ModuleName> filePath Specifies the location of the external file with scripts.

Example

pnettc workflow.wfd -difScriptLibrary1 map://wfd/script.txt

In this example the script file is taken from the same directory as the workflow.

External Workflow Module Parameters

Parameters Description

-extwfd<ModuleName> filePath Specifies the location of an external workflow.

1762
 16.4 PNetTC.exe Console Application

Data Center Config Module Parameters

Parameters Description

-repo<RepositoryConfig><ModuleName> String Specifies a data center.

-data<RepositoryConfig><ModuleName> String Specifies a data set within the

data center.

-split<RepositoryConfig><ModuleName> String Specifies a split within the data

center.

16.4.1.10 Workflow Processing Parameters

Parameters Description

-c filePath Specifies what Production configuration file should be used.

Parameter -c must be used to point to the JOB file from which the name of configuration
is taken. If no JOB file is selected, default settings will be used. If you are trying to select
e.g. engine config (-ec parameter) in commandline and you did not use parameter -c
for JOB file before, it will always use default settings.

Note Any configuration created in the Multiple Jobs window and saved to a JOB file has
to be loaded instead of WFD file (e.g., PNetTC.exe multi.job).

Note If you save a configuration file in Production with options Include all engines
config and Include current engine config checked, and later call this configuration file
via Inspire Production Console (PNetTC) without using the -ec command, the first engine
configuration from the file will be used. However, if you use the same engine for production
(e.g., -e AFP) as is stored in the file as current, this engine configuration will be used.

If the configuration file is saved with only the option Include all engines config checked,
the first engine config from the list will always be used.

-createjobconfigonly filePath Processes the specified workflow (without actually

opening it) and extracts the parameters set for the workflow to include them in a JOB file
saved in the specified location. The file will contain all set parameters, with the exception
of parameters, that are not supported in JOB files, e.g. Inspire Content Manager (VCS)
parameters, -autoskipmissing, -multiple.

Example

PNetTC.exe Sample_Letter_Lyon.wfd -difDataInput1 C:\FIIIclients.csv -c

test.job -o A4 -e PDF -f C:\test.PDF -createjobconfigonly C:\jobcon
fig.job

-f filePath Specifies an output file name.

-o String Specifies an output workflow module name.

1763
16 Related Applications

If no module is selected, the module which has been inserted to the workflow as the
earliest one will be used.

-jobindex Integer Specifies the index of a job in the multiple jobs configuration file
which will be processed.

-autoskipmissing Skips missing files (images, fonts etc.) during opening a workflow.

-messageignoreabort String Specifies what messages will not abort job (comma
separated message codes).

-useincluded [String] Prefers included files when there is a choice between included
and external files. You can specify to what file type this option will apply: Data, Image,
Font or any of them (*).

This command is useful when you have a file both included in the WFD and saved on your
hard drive (this can be checked in the Used Files dialog, where the State of the file will
read Both). By default, the file on the hard drive is used.

PNetTC.exe C:\Workflow.wfd -useincluded Data -c C:\pdf.job

Note On Unix systems the asterisk must be placed inside quotation marks: -usein
cluded "*"

-includedonly Allows to read only those files stored on the hard disk, which are included
in the workflow.

-flush Returns the workflow to the state it was before the run (e.g. unloads an external
workflow or a source TNO).

Tip This parameter can also be used in the multiple commandline or Inspire Production
Server run sequence.

-splitbygroup Saves each group as a separate output file.

See the File Driver Config Dialog section for more information.

-endlesslooplimit Integer Specifies the number of page processing iterations before

an endless loop is reported.

The default value is 1000, the maximum is 10 million.

-exportjobproperties Exports an XML file with the same structure as the qjp command
on Inspire Production Server.

-exportpaattributes Exports a TXT file in the format key=value on each line. The TXT
file contains only properties with the "_PA" prefix.

Note The properties are stored on Inspire Production Server and can be retrieved using
the qjp command.

1764
 16.4 PNetTC.exe Console Application

Parameters for Internal Use with Server

Parameters Description

-tempspool Spools and stores files in a temporary folder on the server under different,
generated names. Using the qjp command returns a field named "_SpoolFilesForDown-
load", which lists temporary and original file names separated by "<".

-forcedjobname String Renames the specified WFD file on the server with its original
name.

16.4.1.11 Workflow Script Checking Parameters

Parameters Description

-checkscripterrors Lists all modules containing scripts that cannot be compiled due
to an error.

Basically, it has the same function as the Workflow Edit menu option Find All Script Er-
rors. See the section Workflow Window Menu.

Example PNetTC test.wfd -checkscripterrors

16.4.1.12 Workflow to XML Conversion Parameters

Parameters Description

-wfd2xml Converts a WFD file to XML format.

-exportusedfiles Bool Specifies whether to export resources in wfd2xml. They are

exported to the same directory where the XML is created.

Example PNetTC -wfd2xml Workflow.wfd -exportusedfiles false

-generatepreview Bool Specifies whether to generate object preview in wfd2xml.

1765
16 Related Applications

16.4.1.13 Workspace Parameters

See also:
Workspaces

Parameters Description

-wsm String Specifies which workspace will be used.

Workspace definitions are stored in the PNetT.cfg and Inspire Production Console (PNetTC)
can only access that config if it is stored in the Inspire Content Manager (VCS). Therefore
you must either: be logged in to VCS with Store config in VCS checked in the Server
Settings dialog; or (if not logged-in to Inspire Content Manager (VCS)) first import a
workspace definition via -wsmimport.

-wsmimport filePath Imports any previously saved XML definition of workspaces to the
config file PNetTC.cfg.

-wsmimages folderPath Specifies the path for inserting images.

-wsmdata folderPath Specifies the path to a data input modules.

-wsmexternal folderPath Specifies the path to external objects.

-wsmfonts folderPath Specifies the path for inserting fonts.

-wsmworkflow folderPath Specifies the path to workflow files and to XML import/export.

-wsmproduction folderPath Specifies the path for loading and saving production
configuration.

-wsmother folderPath Specifies the path to XSD, DTD and FCV configuration.

-wsmafprd folderPath Specifies the path to the AFP resource directory.

-wsmafpfdd folderPath Specifies the path to the AFP font definition directory.

Tip The specified path can link e.g. to the directory with font definitions for AFP Work-
bench (an AFP file viewer provided by IBM).

-wsmafpfd filePath Specifies the path to the AFP formdef (form definition) file.

This file contains a media definition (simplex/duplex, used tray etc.) and one or more me-
dium maps (media size definitions) defined for each page.

Note This parameter has the highest priority, i.e. if used, it will override the formdef in-
cluded in the imported AFP file or the default formdef set in the Workflow or Layout Op-
tions dialogs.

-wsmafppd filePath Specifies the path to the AFP pagedef (page definition) file.

Note This parameter has the highest priority, i.e. if used, it will override the pagedef in-
cluded in the imported AFP file or the default pagedef set in the Workflow or Layout Op-
tions dialog.

1766
 16.4 PNetTC.exe Console Application

Workspace Import/Export Parameters

Parameters Description

-wsmimport String Imports the specified workspace from Inspire Content Manager
(VCS).

-wsmexport String Exports the specified workspace to Inspire Content Manager (VCS).

16.4.1.14 XML to Workflow Conversion Parameters

Parameters Description

-xml2wfd Converts XML files to WFD files.

-includeall Bool Specifies whether to include resources during xml2wfd conversion.

They are searched for in the same directory where the XML is placed, or as defined in the
XML.

If not found (e.g. arial.ttf is not in the directory), you are notified by a message in the
commandline.

Example PNetTC -xml2wfd Workflow.xml -includeall false

16.4.1.15 List of Exit Codes

Basic Exit Codes
To display basic exit codes, it is necessary to use the command echo %errorlevel%.

Example If the following command is used: pnettc chart.wfd -E PDF -f

chart.pdf together with the echo %errorlevel% command, the basic exit code 1
is displayed (Command line not executed).

Code Descriptions

0 Ok, no errors.

1 Command line not executed (wrong input parameters, cannot open file etc.).

2 Warnings logged.

3 Errors logged.

4 Error during processing (unnoticed exception etc.).

1767
16 Related Applications

Advanced Exit Codes

To display advanced exit codes, it is necessary to use the parameter -retadv2.

Example If the following command is used: pnettc chart.wfd -E PDF -f

chart.pdf together with the -retadv2 parameter, the advanced exit code 85 is dis-
played (Invalid engine because -E was used instead of -e).

Code Descriptions

0 Success.

20 Warnings logged.

30 Errors logged (general case).

31 Open file error.

32 Write file error.

33 Script compile error.

34 Script runtime error.

35 Context error.

36 Cannot open printer.

37 Aborted by user.

40 Errors during processing.

70 Commandline not executed (general case).

71 Open file error.

72 Write file error.

73 Wrong parameters.

74 Cannot login into VCS.

75 Cannot read VCS info.

76 Missing workflow location in job config.

77 Workflow not specified.

78 Workflow cannot be opened.

79 Missing some resource files used in workflow.

80 Workflow load has failed.

81 Cannot open log file.

82 Login to server has failed.

1768
 16.4 PNetTC.exe Console Application

83 Unmatched parameters.

84 Licensing problem.

85 Invalid engine.

86 Cannot print secure job.

87 Config file invalid.

88 Engine config not found.

89 Driver config not found.

90 Printer config not found.

91 Unexpected parameter type in commandline.

92 Unknown or no output.

93 Invalid warning config.

94 Invalid warning config in commandline.

95 Unable to connect to printer.

96 Invalid parameter value.

97 Connection lost (PNetTCNetClient).

16.4.2 Multiple Output

The Multiple Output feature enables you to request batch production of workflows from the
Inspire Production Console version (PNetTC.exe).

The first command line call specifies the file where the set of parameters for command lines
are stored. As each command line is processed, the next command line is executed.

Syntax
The command line has to contain the parameter multiple and the path to a TXT file with
command lines that will be consecutively processed. The only optional parameters for this
command line are: l (-l logfilename.log, for selecting a log file) and -abortonfirs
terror (in case of error during processing one of the command lines, the whole job is aborted
and the rest of command lines is not processed).

Note When the same workflow (WFD file), output module (specified by the o parameter),
workflow parameters and print groups are used in several consecutive lines of the file specified
by the multiple parameter, the file is loaded and preprocessed only once, which can signi-
ficantly decrease spooling time.

Example Example of a command line:

pnettc.exe multiple textfile.txt -abortonfirsterror

1769
16 Related Applications

Example Example of a called multi.txt file:

c:\Workflows\gm.wfd -e PDF -f d:\gm\Local.pdf -o Local -warning

config 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
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 " -warning
config 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" -warn
ingconfig d:\testignore.wpr -l d:\gm\AFPOutput.txt
c:\Workflows\gm.wfd -e Scitex -f d:\gm\Scitex2up -o Scitex -warn
ingconfig d:\testignore.wpr -l d:\gm\Scitex.txt
c:\Workflows\gm.wfd -f d:\gm\DataOutput.dat -o DataOutput -warn
ingconfig d:\testignore.wpr -l d:\gm\DataOutput.txt
c:\Workflows\gm.wfd -f d:\gm\PDF_Index.pdf -o PDF_Index -warn
ingconfig d:\testignore.wpr -l d:\gm\PDF_Index.txt

16.5 Dithering Picker

See also:
Dithering

Note This application is not supported by Mac version of Inspire Designer.

Dithering Picker (DitheringPicker.exe, located in the Inspire Designer directory by default) is an

auxiliary application that allows you to apply all the available dithering types to the selected
image and get a quick overview of the effect of each respective dithering.

Note For more information about what is necessary for the DitheringPicker.exe to work from
a different directory than the installation directory, see the section Installation Directory Con-
tent.

The application interface consists of three tabs:

Image

Presets

Add Dithering

1770
 16.5 Dithering Picker

16.5.1 Image Tab

The Image tab defines general parameters of the dithering process. Here you define the source
image, parameters of the result images, dithering mode and the output directory for the result
images.

Options Description

Image Specifies the full path and filename of the source image, i.e. the image that will be
dithered.

Original Displays the parameters of the original image. The parameters are read-only.

Width Width of the image (in pixels).

Height Height of the image (in pixels).

DPI X Horizontal resolution of the image (pixels per inch).

DPI Y Vertical resolution of the image (pixels per inch).

Result Here you can set the parameters for the output images. The parameters are inherited
from the Original by default.

For instance, you can resize a picture by specifying other than original values for the width
and height of the result image.

Width Width of the image (in pixels).

Height Height of the image (in pixels).

DPI X Horizontal resolution of the image (pixels per inch).

DPI Y Vertical resolution of the image (pixels per inch).

1771
16 Related Applications

Black And White When checked, it defines that the Black And White dithering mode will
be used; i.e. one monochrome image will be rendered for each dithering type.

The result image filename is constructed in this way:

Original image filename + _ + dithering type name + _ + original extension.

Example When the original filename is leaf.png, then for the Sierra1 dithering type
the result filename is leaf_Sierra1_.png.

CMYK Split When checked, it defines that the CMYK Split dithering mode will be used. In
this case, four images, one for each CMYK color channel are rendered for each dithering
type.

The result image filename is constructed in this way:

Original image filename + _ + dithering type name + _ + LUT Setting name (empty
if no LUT setting is used) + _ + first letter of the CMYK color channel type + original
extension.

Example When the original filename is leaf.png, then for the Threshold encoding
dithering type and for Magenta color channel the result filename is
leaf_Threshold__M.png.

For the CMYK Split mode, contrary to the Black And White, the ICC Profile can be defined.

ICC Profile Settings

CMYK Profile Here you can define the CMYK Profile used for CMYK images so
that they are displayed correctly on a particular target device (display/monitor). See
also ICC Profiles section.

CMYK Intent Selects a method for transforming colors from one color space
into another one. There are four methods to create a color rendering: Perceptual,
Relative Colorimetric, Saturation, and Absolute Colorimetric. For more information
see the section Rendering Intents.

Add Profile You can browse for a new ICC Profile to be added into list of the
available CMYK profiles.

Output Directory Here you define the directory where the result images will be created.

Generate This button starts generation of the dithered images (disabled when no source
image is set).

Close Closes the Dithering Picker application.

16.5.2 Presets Tab

The Presets tab lists all the available LUT (Look up table) settings and dithering types.

1772
 16.5 Dithering Picker

Options Description

LUT Settings List of available LUT settings that were previously defined in the Add Dithering
tab of the Dithering Picker.

If the specific LUT Setting is checked it will be applied when creating dithered pictures,
otherwise the setting will not be used.

See also LUT Settings and LUT Illustrations.

Dithering Types Lists the available dithering types.

If the specific Dithering Type is checked it will be applied when creating dithered pictures,
otherwise the setting will not be used.

See also Dithering Types section.

16.5.3 Add Dithering Tab

The Add Dithering tab lists all dithering groups and their components. You can quickly see
what dithering types are to be used for each component and what are the values for LPI and
Angle.

1773
16 Related Applications

For description see the All and Groups Node section of the Dithering chapter.

16.5.3.1 Editing
Each option of the individual components can be edited see the Editing Dithering section of
the Dithering chapter.

16.6 Flow Translator

In this section
Working Environment
Flow Translator Menu
How to Translate in Flow Translator

Note This application is not supported by Mac version of Inspire Designer.

GMC Flow Translator is a tool designed for easy translation and editing of XML documents
exported from Inspire Designer. See the section Language Flows and Texts to find out how to
create language flows and export them to a XML document.

All of the tags typical for XML format remain hidden as Flow Translator displays only the text
for translation with icons that represent paragraph and text styles specifications and objects in
the text.

The editor also enables to add new or delete the existing language versions of flows. When
the edited file is imported back into Inspire Designer, the language flows in the Layout are
changed or added automatically.

1774
 16.6 Flow Translator

16.6.1 Working Environment

The editors window is divided into two main parts. The left area lists all language flows that
have been imported from a XML file. The areas on the right display the content of the language
flows for each of the language versions contained in the imported XML file.

The application menu offers functions for editing the XML document opened in the application.

Legend

1. List of all language flows in the opened XML file.

2. Editing panels with the content of language flows. In our example, there is English in
the upper panel as the default (source) language and the content of the flow is trans-
lated into French in the lower panel.

3. The Flow Translator menu. All the options are described in the Flow Translator Menu
section below.

16.6.2 Flow Translator Menu

This section describes the features and functionality of the application accessible via the main
menu.

1775
16 Related Applications

16.6.2.1 File Menu

Options Description

Open Opens a XML file for editing.

Save Saves the opened XML file.

Save As Saves the opened XML file to the specified location.

Split Splits the file by flows, into the number of files specified in the Split File dialog.

Export Language Exports the language(s) selected in the Languages export dialog that opens
into a XML file.

Append Imports new flows from another XML file to the opened file. You first select a file
and then the language(s) you want to import. The new flows are added to the opened
file.

Close Closes the currently opened file.

Options Dialog Displays the General Options dialog which allows the altering of some
general parameters (font and theme settings).

Exit Quits Flow Translator. If there are any unsaved files, you will be prompted to save them
before exiting.

16.6.2.2 Edit Menu

Options Description

Undo Undoes the last action made.

Redo Redoes the action previously undone.

Cut Removes selected object(s) and adds them to the clipboard, replacing the previous
clipboard contents.

Copy Copies selected object(s) to the clipboard, replacing the previous clipboard contents.

Paste Pastes the content that has been copied to the clipboard.

Enhanced Paste Opens the Enhanced Paste dialog, which offers three options:

Paste - Pastes the whole content that has been copied to the clipboard. The
paragraph style definition is not affected.

Simple text paste - Pastes only plain text without any text or paragraph style
definition even if it was copied to the clipboard together with the text.

Paste text and its paragraph style - Pastes the text copied to the clipboard and
overwrites the style of the paragraph where it is pasted to with its own paragraph
style.

1776
 16.6 Flow Translator

Select All Selects the entire contents of the active panel.

Find Opens the Find dialog that enables you to find the specified text string. It is possible
to define search direction (up or down) and conditions (case matching, looking up whole
words only).

The search is conducted for all flows of the language where the cursor is currently placed.

16.6.2.3 Language Menu

These options enable you to select the languages to be displayed, add new languages or remove
the current ones from the XML file.

Options Description

Select Language Enables you to choose the language(s) to be displayed in the editor.

Add Language Enables you to add a new language in the Add Languages dialog that opens.

Remove Language Enables you to select the language you want to delete in the Languages
dialog that opens.

16.6.2.4 Settings Menu

Options Description

Word Wrap Applies word wrapping to all editing panels - the text will stay within the margins
of the editing panel.

16.6.2.5 Help Menu

Options Description

Contents Displays the Inspire Designer help file.

About Displays the About dialog with the version number of Flow Translator.

16.6.3 How to Translate in Flow Translator

Typically, when you open a XML file in the editor you will have just one language (the source
language named as default language) displayed.

To be able to perform the translation, you have to create a new language version. Go to menu:
Language | Add Language and in the Language edit field of the Add languages dialog that
pops up enter a code or name of the new language (e.g., FR for French). In the Copy content
from combo-box, select the language the content of which will be copied to the added language
flows.

1777
16 Related Applications

The content of the editing panels consists mainly of text but also includes icons representing
text and paragraph style specifications and objects.

The icons are the same as in the Inspire Designer Layout Tree. There is also a hint available
when you place the mouse pointer over the icon - the information provides the type and the
name of the style/object.

It is possible to copy, paste and delete these icons in order to change the text style or move
objects.

Paragraph style can only be changed by using the option Paste text and its paragraph style
in the Enhanced Paste dialog. For object icons it might sometimes be necessary to move them
to a different place in the text to adhere to specific grammar rules or conventions (e.g., you
might need to move a variable representing price as in some languages the symbol precedes
the price, while in other languages it comes after it). This can be done using the cut/copy and
paste functions. You have to select the icon to be able to delete it.

The editor can display all of the languages saved in the XML file and does so when the file with
multiple language content is opened.

You can customize the editing areas by selecting only the languages you need. Go to menu
Language | Select Language. The Languages dialog that opens lets you to select the desired
languages. In this dialog you can also change the sequence of editing panels using the Moves
item up and Moves item down icons.

When you finish the translation of one flow, move to the next one by clicking on the flow
name in the left panel. You do not need to save the file before switching among flows.

After completing the translation of all flows and saving the file, it is ready to be imported back
to Inspire Designer.

1778
 16.7 Inspire Native Viewer

16.7 Inspire Native Viewer

Inspire Native Viewer enables viewing of workflows, TSD data files and native files. It is a
standalone version of Inspire Designer Proof environment, hence all its features and options
are identical to those described in the Proof chapter of this manual.

The PNetTView.exe (located in the Inspire Designer directory by default) can be executed from
any location, no installation is required. One intention is that it can be used by people who
would like to see the results of a workflow design, but should not be allowed to edit the
workflow.

Note

Without licensing, only TNO files can be viewed. WFD files can be viewed if you have
a valid license for Inspire Designer and all other file formats have to be specifically per-
mitted by that Inspire Designer license.

For more information about what is necessary for the PNetTView.exe to work from a
different directory than the installation directory, see the section Installation Directory
Content.

16.8 TNO Writer

With TNO Writer, a virtual printer, you can create TNO files from any printable document. You
can then:

Open the created TNO files in a workflow using the Inspire Native module.

Note TNO Writer also saves information about the created file (e.g. format, DPI, file
name, etc.) into its own sheet names. It can also create a metafile (with the name pattern
filename.meta) which contains a document name, the name of the user who printed
the document, time when the document was submitted, and total page count. This
information can be used for sorting TNO files, for example for various printers according
to the format or DPI of files.

Use them in Inspire Interactive or Inspire Storefront (PortalBuilder) web pages to fill
forms. This way, TNO Writer can be easily integrated into business solutions such as
Inspire HybridMail. For details see the separate document Inspire HybridMail installation
guide.

The printer driver is a part of the Inspire Designer installer. For more information on how to
install TNO Writer as a printer and how to make the appropriate settings see the document
TNO Writer Installation Guide.

Note This functionality is not supported by Mac version of Inspire Designer.

16.8.1 Adjusting TNO Writer Settings

Printer settings can be adjusted in the standard printer properties dialog: Go to Start | Control
Panel | Printers and Faxes (on Windows XP), or Printers (on Windows Vista), or go to Start

1779
16 Related Applications

| Devices and Printers (on Windows 7). Right-click on the TNO Writer icon, select Properties
(on Windows XP and Windows Vista) or Printer properties (on Windows 7) and go to the
Device Settings tab.

Options Description

Form To Tray Assignment Displays trays and enables assigning forms (paper formats) to
them. Both trays and forms can be pre-defined in the configuration of the TNO driver
before installing it. For more information please see the document TNO Writer Installation
Guide.

External Fonts Click on the Properties button to import external fonts.

Installable Options

TrueType support The options available are:

Off Does not include any glyphs in the TNO file.

Only used glyphs Includes only used glyphs in the TNO file.

Complete font included Includes the complete font in the TNO file.

JPEG compression Switches off or on JPEG images compression. The options available
are: Off, On.

Convert to image Selects what parts of the file will be converted to an image. The
options available are:

Yes Converts the complete file to an image.

All but text Converts all non-text parts of the file to an image.

No Does not convert any part of the file to an image.

16.8.2 Using TNO Writer

When printing a file, select the TNO Writer printer from the list of printers in the Print dialog.

Depending on the way you selected when configuring the driver you can:

Use hot folder directory The file is converted to a TNO file and placed into the Hot
folder directory together with metadata file (if set).

1780
 16.8 TNO Writer

You can further use the TNO file in Inspire Designer using the Inspire Native module.

Upload TNO to web The file is converted to a TNO file and uploaded to the specified
Inspire Interactive/Inspire Storefront (PortalBuilder) web site where TNO data is used for
filling a form.

1781
17 Scripting

17.1 Scripting Features

17.2 General Information
17.3 General Content Model
17 Scripting

17.1 Scripting Features

17.1.1 Script Debugger
In this section:
Script Debugger Window
Script Debugger in Proof
Script Debugger in Production

The Script Debugger function allows you to see the values of variables, as they are calculated
during runtime, by connecting to a script and enabling you to closely follow its execution. By
debugging scripts you can find and eliminate errors and ensure that scripts will perform the
way they are intended to.

Debugging is performed during the processing which occurs prior to spooling (in Production)
or while proofing (in Proof) a workflow. You can determine if and when the Script Debugger
should be used in Proof and/or in Production.

17.1.1.1 Script Debugger Window

The Script Debugger window is the same for Proof and Production. It is split into three parts:

Script area - displays the script which is being debugged.

Note The green line in the script window indicates the line being debugged, the red
line indicates that there is a breakpoint on this line.

Variables area - see the description below for details.

Call stack area - see the description below for details.

1784
 17.1 Scripting Features

Options Description

Continue Detaches the Script Debugger from the current script.

The script continues to execute outside of the Script Debugger until the next breakpoint
occurs (if Stop on breakpoints or Debug breakpoints has been set in Proof or Produc-
tion) or the beginning of the next script is reached (if Stop on start on or Debug all has
been set in Proof or Production).

You can also use the key <F5> instead of this icon. You can change this key shortcut to-
gether with shortcuts for other Script Debugger functions in the Scripting Shortcuts section
of the Workflow Options dialog.

Note Closing the Script Debugger window causes the same behavior as clicking on the
Continue icon; the script will continue, but outside of the Script Debugger.

If you would like to reopen the Script Debugger window after having closed it, select
Window | Break Script in Proof while the script is still being processed.

Break All Forces all scripts to attach to the Script Debugger during execution (i.e. when
they are running).

When no script is running workflow processing continues until the beginning of the next
script.

This icon is available when you are not connected to a script (indicated by the connection
flag at the bottom right of the Script Debugger window).

You can also use the key shortcut <Alt>+<Pause> instead of this icon.

Step Into Enters a function call. Also, when a calculated variable gets the content of an-
other calculated variable the debugger enters the evaluation of that other variable.

You can also use the key <F11> instead of this icon.

Step Over Moves to the next line of the function without entering function calls.

You can also use the key <F10> instead of this icon.

Step Out Continues the execution of the script until the current function return.

You can also use the key shortcut <Shift>+<F11> instead of this icon.

Stop Stops the debugging process.

You can also use the key shortcut <Shift>+<F5> instead of this icon.

Note Stopping the debugging process can lead to the abortion of the action being
performed (i.e. Proof or Production).

Stop On Start Here you can specify in which cases the Script Debugger should be displayed.

1785
17 Scripting

Right-click on this icon to change the stop on start settings:

Stop on start on - The Script Debugger will stop on starting any script even if
no breakpoints have been inserted or no exception occurs.

Stop on start except here - The current script will be skipped if it reoccurs.
This can be useful for scripts reoccurring many times whose functionality has been
verified.

Stop on start off - The Script Debugger will attach to the script only on
breakpoints or exceptions. This is the default setting.

If you would like to attach to the Script Debugger even if no breakpoints or excep-
tions occur, select Window | Break Script in Proof while the script is being pro-
cessed (an option other than No Debug must be selected in Proof).

Insert / Remove Breakpoint Allows you to insert a breakpoint on a specified line. If this
line already has a breakpoint, use this icon to remove the breakpoint.

You can also use the key <F9> instead of this icon.

Variables In the variables area there are the following columns:

Name Displays a list of the data and variables available in the script ordered in a tree
form.

Additionally, variables created within the script will be listed here. Click on the
symbol located on the left of the variable to display a sub-tree ordered below the
variable and to display the variables' values in the Value column.

Value Displays the values of the variables listed in the Name column.

Call Stack The Call Stack area offers several types of information:

Local function calls (the parameter values are displayed)

Currently evaluated variables

Job status of the script being evaluated/executed

Note The function displayed in the source code window and in the Variables area always
corresponds with the first line of the Call Stack area (displayed with bold typeface).

By double-clicking the entries in the Call Stack area you can change the function which
is displayed (not available for the information on the Job status).

Connection flag The connection flag is displayed in the bottom right corner of
the Script Debugger window.

If the flag is green, the Script Debugger is connected to a script, if the connection flag is
red there is no script connected and the Break all option will be available..

1786
 17.1 Scripting Features

Example Simple Usage of the Script Debugger

The following example shows how the Script Debugger can be used to follow the execution
of a script. In this particular case, there is a data file/record ("Date") containing one variable
("Month") which has a single value "December". This data input has been connected to
a Data Transformer module and the Script field converter is used to convert the variable
using the script visible in the below screenshot. The purpose of this script is to transform
any occurrence of the word "December" to "January" and to transform all variable content
to upper case.

The following explanation consists of four screenshots showing how the Script Debugger
evaluates each line of the used script:

1. In this case (as the script does not contain any breakpoints) the option Stop on
start (in Proof) or Debug all (for Production) must be selected for the Script Debug-
ger to connect to this script. When you now proceed to proof or produce the
workflow, the Script Debugger will automatically open during the processing
phase.

The line currently being evaluated by the Script Debugger is marked by a green
background:

In this first screenshot the following information can be seen:

In the script area at the top the script which is being executed is displayed.

In the Variables area the input value coming from the variable ("December")
is shown in the Input row .

In the Call Stack area there are two rows displaying the following information:

In the first row "FCV" stands for "field converter" and refers to the loc-
ation where the script has been entered. "Date" is the name of the record
where the variable used in this script, "Month", is located.

The second row shows the status of the job, in this case "Trace Data".

1787
17 Scripting

After clicking on the Step Into icon the Script Debugger moves to the next
line of the script.

2. In this screenshot, you can see that the first line of the script has been executed:

The Input value ("December") is now associated with the variable "s". This is visible
in the Variables area.

Again, clicking on the Step into icon moves the Script Debugger to the next
line of the script.

3. Now you can see that the second line of the script has been executed:

For the variable "s", the input value "December" has been replaced by the value
"January" as specified in the script; this change is visible in the Variables area.

Once more, clicking on the Step into icon moves the Script Debugger to the
next and final line of the script.

4. The result of the third line of the script is now visible:

1788
 17.1 Scripting Features

You can see that the casing of the value associated with the variable "s" has been
changed to upper case according to the script. Again this change can be seen in
the Variables area.

Note Clicking the Step into or Continue icon would move the Script
Debugger to the next variable contained in the record. If there is no further record
and no further script in the workflow then the proof/production process will be
executed.

17.1.1.2 Script Debugger in Proof

In Proof you can set the usage of the Script Debugger in the toolbar on the left of the Sheet
Proof window. By right-clicking on the Stop on start icon you can open a context menu:

Options Description

No Debug No debugging is performed.

Stop On Breakpoints If breakpoints have been inserted into the used script(s) or if excep-
tions occur, the script(s) will be debugged when you run proof.

Note Breakpoints can be inserted into scripts when creating these in the Script editor
window (e.g. available in the Script Data Input Module) and are used to determine positions
where you would like the Script Debugger to connect to the script you are running.

You can also remove or insert breakpoints while debugging a script using the Insert/Remove
breakpoint icon available in the Script Debugger window.

Stop on start The script(s) will be debugged when you run Proof, regardless if there are
breakpoints in the used script(s).

1789
17 Scripting

17.1.1.3 Script Debugger in Production

In Production, you can set the script debugging level prior to running your job. From the Debug
combo-box located on the Main Production window select the debugging level required:

Options Description

No debug No debugging is performed. This option is set by default.

Debug breakpoints If breakpoints have been inserted into the used script(s) or if exceptions
occur, the script(s) will be debugged when you run Production.

Note Breakpoints can be inserted into scripts when creating these in the Script editor
window (e.g. available in the Script Data Input Module) and are used to determine positions
where you would like the Script Debugger to connect to the script you are running.

You can also remove or insert breakpoints while debugging a script using the Insert/Remove
breakpoint icon available in the Script Debugger window.

Debug all The script(s) will be debugged when you run Production, regardless if there are
breakpoints in the used script(s) .

17.1.2 Script Editor Dialog

In this section: See also:
Script Assistant Scripting Shortcuts
Script Editor Context Menu
Simple Expression Dialog

The Script Editor dialog is a separate dialog for writing and editing scripts.

The dialog is opened after clicking on the Open Script Editor icon. This icon is available in
most places in the application where script can be entered, e.g. in the Script Data Input module,
Scripted Areas in Layout and the Imposition Script module.

Note If the entered script returns a Boolean value and is simple enough, Simple Expression
dialog is opened instead.

To always open Script Editor directly, disable the Use Simple Expression dialog check-box
in the Options dialog.

1790
 17.1 Scripting Features

The Script Edit area provides intelligent text indentation, text highlighting (colors can be set in
Scripting section of the Workflow Options dialog) and matching brackets highlighting.

Options Description

Find Script Opens the Find & Replace dialog, which can be used for searching for a spe-
cific piece of script and possibly replacing it with another text.

The Find what and Replace with edit-boxes of the Find & Replace dialog have drop-
down lists which contain recently used strings. These strings are displayed in all instances
of script editors within one Inspire Designer session.

If you want to repeat your last search in a script editor, press <F3>. The last searched string
is remembered in all script editors within one Inspire Designer session.

Wizard Opens the Script Wizard.

Breakpoint Inserts a breakpoint at the point that is currently selected in the script. If this
line already has a breakpoint use this icon to remove the breakpoint.

Breakpoints are employed to help with debugging of a script. Processing stops at a break
point to allow a user to check the syntax. See the separate section Script Debugger for
more details.

Show Warnings Displays the Warnings table that lists errors in the script.

The Find Error button should first be clicked on in order to detect errors, however some
errors are detected automatically. If there are any errors, each list item contains a brief
Description of the error and the Module, Line and Column where it occurs.

Note The Module column shows a value only in case the error is in a Script Library that
is referenced. There can be two possible types of value:

Name of the Script Library If the Script Library is referenced by the keyword #use
in the script, the name of the Script Library is displayed.

AutoInclude If the Auto include option is checked in the Script Library.

If no value is displayed, it means that the error is in the current script.

1791
17 Scripting

You should click on Find Error to refresh the list when changes are made to the script.

Find Error Searches for problems in the script. These include:

Errors found in the script syntax.

Statements that have no effect on the result of the script.

Statements that attempt to change the content of a variable that cannot be mod-
ified.

If any errors are detected, the Warnings table will be shown listing them.

There are a number of hot key shortcuts that can be used when scripting. See the separate
section Scripting Shortcuts.

It is also possible to use multi-clicks to quickly select parts of a script:

double-click selects the current word,

triple-click selects the current line,

quadruple-click selects the part of script contained within current pair of brackets,

quintuple-click selects the whole script.

17.1.2.1 Script Assistant

The Script Assistant lists all members of a class or the parameters available for a specific function.

To display classes and methods, press the keys <Ctrl>+<Space>. To display available parameters,
press the keys <Ctrl>+<Shift>+<Space>. These shortcuts are customizable in the Scripting
Shortcuts section of the Workflow Options dialog.

Icons used by the script assistant:

Function
Method of the active object
Namespace
Property of the active object
Read-only property of the active object
Static method of the active object

1792
 17.1 Scripting Features

Type name
Variable

17.1.2.2 Script Editor Context Menu

The context menu is available in the script panel after clicking with the right mouse button.

Options Description

Cut, Copy, Paste, Delete These are standard features. See the section Copy and Paste via
Context Menus.

Insert/Remove Breakpoint This option has the same functionality as the above described
Breakpoint icon.

Reformat Script Improves the appearance of the script by indenting the relevant lines.

Alternatively, select a piece of script and press the keys <Alt>+<F8>. See also the Scripting
Shortcuts section.

17.1.2.3 Simple Expression Dialog

The Simple Expression dialog enables you to edit simple conditions which return Boolean value,
e.g. for the Select by inline condition type of variable selection. If the condition is more complex
or should return another value type, the Script Editor dialog is used instead to enter the script.

The Use Simple Expression dialog check-box in the Options dialog must be checked, otherwise
the Script Editor dialog is opened even for the simple conditions.

1793
17 Scripting

Options Description

Match all / Match any Selects if the conditions defined below should be applied at the same
time (AND relation), or if it is enough that one of them applies for the script to return true
(OR relation).

Variable The first combo-box enables you to select the variable, on which you want to base
your condition.

Is / Is Not Is is selected by default. By clicking on this button the value Is Not is selected and
inverts the condition.

Condition Selects the actual condition. The possible values (different according to the data-
type of the Variable) are: equal to, beginning with, beginning with (case insensitive),
containing, containing (case insensitive), less than, ending with, ending with (case insens-
itive), empty, greater than, less than or equal to, greater than or equal to, in range of.

Value Enables to enter a value when the condition concerns comparison. It changes based
on what you have selected in the Condition combo-box, e.g. for in range condition you
need two values (each is entered into one of the two edit-boxes), for empty it is not
available.

Add Condition Adds one more condition row.

Remove Condition Removes the selected condition row.

Go to Script Editor After clicking on this button the Script Editor dialog opens and you can
modify your script there.

For examples of Simple Expression dialog usage see sections Data Caser Module and How to
Make Conditional Flow.

17.1.3 Scripting Shortcuts

There are several keyboard shortcuts available in scripting that speed up work. These shortcuts
are customizable in the Scripting Shortcuts section of the Workflow Options dialog.

Shortcut Description

<Ctrl>+<F>, <Ctrl>+<H> Opens the Find & Replace dialog.

<Ctrl>+<G> Moves the cursor to the beginning of the line
selected in the Go to Line dialog that appears.
<Ctrl>+<]> Finds the other bracket of the pair. The cursor
has to be placed right before a bracket.
<F3> Finds the next occurrence of the searched
expression.
<Ctrl>+<Shift>+<8> Shows or hides dots in place of spaces.
<F2> Shows the character palette below the script
edit field.
<Ctrl>+<Space> Shows the Script Assistant listing available
classes and methods.

1794
 17.1 Scripting Features

Shortcut Description

<Ctrl>+<Shift>+<Space> Shows the script parameter assistant listing

available parameters.
<Alt>+<F8> Improves the appearance of the selected
piece of code by indenting the relevant lines.

17.1.4 How to Use Script Wizard

See also:
Scripting Notes
How to Declare Script Functions
How to Reference a Current Variable

The script wizard automates the script writing process. To use this feature, do the following:

1. Click the Wizard icon to display the Script Wizard.

2. Select the code fragment type you wish to use. Code fragments are available for
commands if/else, for, while, function, expression and is switch. Click
on Next to continue.

3. Provide the appropriate information for that fragment. (The example below is for
Function definition.)

1795
17 Scripting

4. Continue entering script until complete, then press Finish .

Each item in the Structure part of the dialog window can be renamed (by pressing
<F2>), deleted, moved up and down within the structure using appropriate icon and
moved into the script source (the right part of the dialog window) by right clicking and
choosing Insert to script from the context menu.

17.2 General Information

17.2.1 Data Types
Inspire Designer supports a number of data types, which can be divided into two main categor-
ies:

Value data types:

The table below lists the value data types and presents their range:

1796
 17.2 General Information

Data Minimum Value Maximum Value Notes

Type

Bool false true Only two values: false (0) or

true (1)
Char 0 65,535
Int -2,147,483,648 2,147,483,647 4-byte integer
Int64 -9,223,372,036,854,775,808 9,223,372,036,854,775,807 8-byte integer
Cur- -922,337,203,685,477.5808 922,337,203,685,477.5807 Recommended to be used
rency where accuracy is required,
i.e. with monetary calcula-
tions.
Double approx. -1.79E+308 approx. 1.79E+308 For decimal values, Double
with accuracy of with accuracy of data type is generally the
about 15 digits about 15 digits default choice, but it should
never be used where precise
accuracy is required.
Date- N/A N/A Values internally stored in
Time days as Double data type.
Based on Gregorian calen-
dar, so the range of years
you get correct results for is
1582 9999.

Reference data types:

Binary the range is 0 approx. 2 billion bytes.

String the range is 0 approx. 2 billion characters. Each character is a 16-bit unsigned
number (0-65535). Usually, the used encoding is UTF-16.

TypeKeeper represents type declarations, used with ODBC.

17.2.2 Assignment Statements

An assignment statement assigns the value of the general expression on the right side to the
variable or array element given on the left side.

Assignment Description
Value

= 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
-= Subtracts 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

1797
17 Scripting

Assignment Description
Value

*= 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

17.2.3 Expressions
An expression may be:

numeric constant

string constant

an array reference

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 preced-
ence 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

*, /, %

+, -

1798
 17.2 General Information

&, ^

< > <= >=

== != is

and, xor

or

17.2.4 Operators
The script language supports the usual:

Arithmetic operators which take operands of any numeric data type.

Comparison operators which take operands of any data type with the data type result
always boolean.

boolean operators taking boolean operands and also resulting in a boolean.

17.2.4.1 Arithmetic Operators

Operator Operand Result Operation

+ Numeric Numeric Add

- Numeric Numeric Subtract, 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
++ 1 Numeric Adds 1
-- 1 Numeric Subtracts 1

1799
17 Scripting

17.2.4.2 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

17.2.4.3 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

17.2.5 Functions
See also:
How to Declare Script Functions

A function is a piece of code that is declared once in a script and sits dormant until it is later
called upon to do its job. This means that the function can be used repeatedly throughout the
script, without the necessity to type the same chunk of code multiple times. Functions can take
parameters and they can return a value. They are defined using the function keyword.

function stringIsLong(String Parameter1) : Bool

{
return Parameter1.Length > 20;
}

17.2.5.1 Function Parameters

There are two ways of passing a parameter to a function: by value and by reference.

1800
 17.2 General Information

Passing by Value
When the parameter is passed by value, the function will work with a copy of this value. All
changes to the value of the parameter are local to the function. You can use a constant , an
expression, a variable or a function result to set a parameter passed by value.

Example
function foo(Int val)
{
val = 10;
}
foo(30); // using a constant
foo(1+2); // using an expression
Int x=20;
foo(x);
// x is 20

Passing by Reference
When the parameter is passed by reference, the function will work directly with the variable,
which was used for this parameter. Any changes to the value of the parameter will change the
original variable. You can use only a variable to set a parameter passed by reference.

Example
function bar(Int & val)
{
val = 10;
}
//bar(30); // this won't compile
//bar(1+2); // this won't compile
Int x=20;
bar(x);
// x is 10

17.2.6 Running Script Within Another Script

Eval functionality
The eval functionality enables users to run a script within another script. It takes as an argument
the return value type of the script and the script content to be compiled and executed. It returns
the return value of the script. The nested script has to be compilable by itself; it cannot reference
variables from outside the script.

Syntax
do.eval (Type aResultType, String aScript);

Return Value
Type (depends on the first input parameter of eval)

1801
17 Scripting

Example Double val=do.eval(Double,"1+2");

Example
if (do.eval(Bool,"true or not true")) logMessage("ok at least one of the
operands is true");
else logMessage("both operands are false");

17.2.7 Static Variables in Scripting

Declaring a variable with the keyword static keeps the variable valid and accessible from all
scripts during the whole run of a workflow. This can be used for sharing data among all scripts
in the workflow.

Syntax
static Int myNumber;

Example
//If we need to do some operation only once per workflow run, before
//running one of two different scripts but we don't know the order of
//their execution in advance, we can do it as follows:
//script one
static Bool operationDone;
if (not operationDone)
{
doOperation();
operationDone = true;
}
.... some other code
//script two
static Bool operationDone;
if (not operationDone)
{
doOperation();
operationDone = true;
}
.... some other code

Note Static variables defined inside a function are automatically prefixed with the function
name, e.g. logIfMapContains.Map for the following example.

Example
function logIfMapContains(String S)
{
static Util.StringIntMap Map;

1802
 17.2 General Information

//...
}

17.2.8 Namespaces
Inspire Designer uses different types of namespaces, e.g. SYS, DATA, CR, FLOW, UP1, etc.
These namespaces are used to reference the right fields (variables) in the correct context in
scripts. Some of the namespaces are available only under certain conditions e.g. the ROWSETS
(or FLOWS) namespace is available after a repeated rowset (flow) is created, etc. The following
sections will describe the SYS, CR and UP1 (UP2) namespaces.

SYS Namespace
This namespace enables access to system variables in any script in Layout. You can then reference
e.g. GlobalPageCounter in variables placed on any level of the data structure. The reference
SYS.GlobalPageCounter is a shorter way of referencing DATA.SystemVariable.Glob
alPageCounter.

1803
17 Scripting

Example Here is an example how to use a script with system variable referenced by
SYS namespace for the page selection.

not SYS.PageCounter.isEven()

If the value of current PageCounter (number of pages for one record) is odd, the filling
page (e.g. advertising) can be added.

CR Namespace
The CR namespace can be used in scripts in Layout and it refers to the value of the current re-
cord. For the first record, the expression CR.CustName equals DATA.Records[0].Cust
Name, for second record DATA.Records[1].CustName, etc. up to last record DATA.Re

1804
 17.2 General Information

cords[n].CustName. You can then easily reference the content of a certain variable for all
records without referencing via indexes.

UP1 (UP2) Namespace

The namespaces UP1 (and UP2 up to UPn) are useful when referencing variables from a different
level of the data structure. It is used in Data Transformer and its usage is related to the option
Mark Array for Save or Mark Root for Save. Using one of these options and the UP1 (UPn)
namespace enables you to reference the fields from a higher level of the data tree structure.

1805
17 Scripting

To reference the content of a field from a higher level do the following:

1. Select the "Mark Array for Save" (e.g. Banks in the example above) or "Mark Root for
Save" option according to the intended usage. See also an example if necessary.

2. In the Trans_Amount variable you are now able to reference the UP1 namespace (up
one level) to work with fields under the Customers array.

3. You can also use UP2 up to UPn according to the number of levels in the data structure.

17.2.9 Flow Control Conditional Constructs

The 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:

while which tests at the top of the loop

do convenient for simple sequential operations on arrays

for the most general repetitive construct

1806
 17.2 General Information

Conditional constructs:

if

if...else

is

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

17.2.9.1 If and If...else Statements

The if and if else constructs are shown below.

The expression 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 (expression)
{
else if (expression)
statement
}
{
else (expression)
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.

Example
Int n=300;
if (n > 0) // IF construction WITHOUT else
//condition: n has to be greater or equal than 0

1807
17 Scripting

{
logWarning("Value of n has to be greater than 0.");
return n.toString();
}

Example
Int n=300;
if (n > 0) // IF construction WITH else;
//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.");
}

17.2.9.2 Switch-like Construct "is" Keyword

If you want to select an appropriate action depending on a variable value, you can use the se-
quence of if/else statements or the construct is.

Syntax

Int variable;
is(variable)
{
1 : action1();
2, 3 : action23();
4::8 : action45678();
9::* : action9orGreater();
else
someOtherAction();
}

Conditions are separated by a comma. A condition can be:

Simple expression. This is then checked for equality.

Range. The range is written as "::". The range can be marked as open by adding the
asterisk *.

Example The range 8*::* is valid for 9, 10, 11, 12, etc. In this example the end of the
range is missing, so it must be marked as open.

For values that do not match any condition the optional else branch can be used. The is
keyword can be used for all types for which the operators assign, equal, less are defined (almost
all types).

1808
 17.2 General Information

Example
Char abcdefg;
abcdefg = 'e';
is (abcdefg)
{
'a'::*'c', 'e' : logMessage("a,b or e");
'f'::* : logMessage("f or greater char");
else logMessage("other character");
}

17.2.9.3 For Statement

The for construct consists of:

Initialization part Initialization part consists of a statement which is executed once before
entering the loop.

Test part Test part is a boolean expression, which is tested before each iteration of the loop.

Loop control part. 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.

Statement part Statement to be executed

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
}
return "Summary in FOR cycle is: "+ f.toString();

17.2.9.4 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

1809
17 Scripting

it is possible for the statement not to be executed at all (see also a do while statement for
comparison).

while (expression)
{
statement
}
or
while (expression)
{
statement1
}
else
{
statement2
}

Example
Int n=300; //summary in WHILE cycle
Int i=1;
Int f=0;
while (i<=n)
{
f=f+i; //variable f is incremented
i++; // i++ means incrementation of i of value of 1
}

17.2.9.5 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 (expression);

17.2.9.6 Break Statement

The break statement causes an immediate exit from the loop, by jumping to the statement
following the loop.

17.2.9.7 Continue Statement

The continue statement shifts control to the next iteration of a loop without executing re-
mainder of the current loop.

1810
 17.2 General Information

17.2.9.8 Goto Statement

The goto statement unconditionally branches to another point in a procedure. The target
statement is specified by a label followed by a colon:

goto label
label:

17.2.9.9 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.

17.2.10 Scripting Notes

Non-Alphanumerical Characters in Variables Names
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 Busi
ness_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).

Tip 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:

Business plan summary

Business plan-summary

Business plan+summary

Backslashes in File Paths

Inspire Designer displays only backslashes in file paths. Problems may arise with WFDs created
in versions 6.1 and earlier where parsing patterns use forward slashes. In such cases where the
file name is parsed from the whole path by searching for characters behind the last forward
slash, it is recommended to use the FileNameExt function which is platform independent
and does not distinguish between slash types.

1811
17 Scripting

Hexadecimal Numbers in Scripts

It is possible to use numbers in hexadecimal form directly in scripts, i.e. without conversion.
Such a number needs to start with 0x.

return 0xf0 // will return 240

17.2.11 Substitute Characters

You can specify any character in scripts (for example the non-printable one) using their values.
The value has to be enclosed in single quotes.

Any Unicode character \u#### Backslash followed by u and Unicode hexa-

decimal value.
Eg. \u263A for
character
Any single-byte charac- \x## Backslash followed by x and hexadecimal
ter value.
E.g. \xA9 for
character
Carriage return \r Inserts a Carriage Return character. Equals
\x0D.
New line \n Inserts a Line Feed character. Equals \x0A.
Apostrophe \' Used for specifying an apostrophe character
within the string enclosed in apostrophes.
See example.

Data Input - Specifying a delimiter between fields in data file:

Any single-byte \x## Backslash followed by x and hexadecimal value.

character
E.g. \xA9 for
character
Tabulator \t Tabulator. Equals \x09.
Backslash \\ Since backslash character is used for denoting
special characters, it is necessary to use two
backslashes for specifying the backslash itself as
a delimiter.

17.2.11.1 Enclosing String Values

To specify a string values in scripts, it is necessary to enclosed it:

in quotation marks "sample string"

or in apostrophes 'another sample string'

1812
 17.2 General Information

However, there are differences of handling strings enclosed in quotation marks and in apo-
strophes.

The strings enclosed in apostrophes are checked for presence of the substitute characters
( \n , \', \x## etc.) and the substitute character are processed (i.e. replaced by their
equivalents).

On the contrary, the strings enclosed in quotation marks are not checked for presence
of the substitute characters ( \n , \x## etc.), the string is left as "it is" and the substitute
character are not processed (i. e. replaced by their equivalents).

To use apostrophe or quotation mark in the strings, follow these rules:

1. Use apostrophe in a string value enclosed in quotation marks: String s = "My father's
car"

2. Use substitute character for apostrophe in a string value enclosed in apostrophes: String
s = 'My father\'s car' or String s = 'Eva\'s book'

3. Use quotation mark apostrophe in a string value enclosed in apostrophes: String s =

'This is a quotation mark: "'

Figure 17.1 Proof Sample of Usage of Substitute Characters Used in String Variables

1813
17 Scripting

17.2.12 How to Declare Script Functions

See also:
Functions
Script Data Input
Script Library
How to Use Script Wizard

A function is a piece of code that it declared once in a script and sits dormant until it is later
called upon to do its job. This means that the function can be used repeatedly throughout the
script, without having to type that same chunk of code multiple times.

Example The following example creates a script that shows the number of days remain-
ing in a month. The script is a function called DaysInMonth.

The function has to be declared and should be the first instruction in the script. You
cannot call the function without first declaring it.

See the script commands with comments in the lines marked //:
function DaysInMonth(Int month):Int
//this is the declaration for this function. DaysInMonth is the function
name.
//(Int month) month is the Int value passed into the function.
//The function will also return an integer based on the ":Int"
{
if (month = 1) return 31;
if (month = 2) return 28;
if (month = 3) return 31;
if (month = 4) return 30;
if (month = 5) return 31;
if (month = 6) return 30;
if (month = 7) return 31;
if (month = 8) return 31;
if (month = 9) return 30;
if (month = 10) return 31;
if (month = 11) return 30;
if (month = 12) return 31;
}
return(DaysInMonth(6) - 10);
//the final answer of the script is 20 since June (month 6) has
//30 days and we subtract 10 from it.

Example The following example creates a script that shows the number of days remain-
ing to Christmas in text form.

The name of the function CountTillXMas: it counts the remaining days and returns an
integer value that is further processed in the script itself.

See the script commands with comments in the lines marked //:
String SPassedDate="Passed date is: ";
//Declaration of string constants
String SOnly="Only ";

1814
 17.2 General Information

String SDay=" day";

String SDays=" days";
String STillXmas=" till Christmas.";
DateTime dt=Given_date;
//Given_date is a DateTime variable coming from DataInput (as string) and
//DataTransformer connected to Layout
logMessage("The given date is: "+dt.toString());
//we want to see the input date in the log
function CountTillXMas(DateTime date): Int
//declaration of function counting days until next Christmas from the date
given
{
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.Day=24;
cdt.Month=12;
if (cdt.Day==date.Day
//Christmas is today
and
cdt.Month==date.Month) return 0;
else if (cdt.Day<date.Day
//date from December 25th till 31st
and
cdt.Month==date.Month)
{
Int i=358;
//number of days from January 1st till December 24th
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;
}
Int d;
//Declaration of variables: day
Int m;
//Declaration of variables: month
Int y; //Declaration of variables: year
dt.getDMY(d, m, y);
String StringDate=SPassedDate+d.toString()+"/"+m.toString()+"/"+y.to
String();
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;

1815
17 Scripting

17.2.13 How to Reference a Current Variable

1. To reference "Current Variable, use the name Input.

2. You can reference the length of a variable using variable.Length as opposed to

variable.getlength()

3. To add an array to the input stream, use the Array.commit function.

4. To display a dropdown list of functions and variables, do the following:

Press <Ctrl>+<Space>

(After typing/selecting a variable) type a period ( . ).

17.3 General Content Model

Binary Methods
Binary methods can be used for manipulation with binary data.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Binary Methods

assign
Assigns binary data to the given binary variable. The same result can be achieved using the
equal sign =.

assign(Binary) : Void

Binary binaryData;
binaryData.assign(Binary.fromStringWithCodec("Hello World!", "UTF-8"));

Scripting API | Binary Methods

calcSHA
Calculates 20 bytes long SHA-1 hash for the binary data.

calcSHA() : Binary

Binary content = Binary.fromStringWithCodec("abc","UTF-8");

Binary hash = content.calcSHA();
logMessage(hash.toHex());

1816
 17.3 General Content Model

Scripting API | Binary Methods

decrypt
Decrypts encrypted binary data using the parameters. Both parameters' length must be 16
bytes.

decrypt(Binary aKey, Binary aInitialVector) : Binary

Scripting API | Binary Methods

encrypt
Encrypts binary data using the parameters key and initial vector to achieve even higher level
of complexity. Both parameters' length must be 16 bytes.

encrypt(Binary aKey, Binary aInitialVector) : Binary

function createInitializationVector() : Binary

{
Binary b;
b.Length=16;
for(Int i=0; i<b.Length; i++)
{
b[i]=i;
}
return b;
}

Binary plain=Binary.fromStringWithCodec("Hello", "ASCII");

logMessage("Plain: "+plain.toStringWithCodec("ASCII"));

Binary key = Binary.fromStringWithCodec("SecretKey1234567", "ASCII");

Binary iv = createInitializationVector();

Binary encrypted = plain.encrypt(key, iv);

logMessage("Encrypted: "+encrypted.toStringWithCodec("ASCII"));

Binary decrypted = encrypted.decrypt(key, iv);

logMessage("Decrypted: "+decrypted.toStringWithCodec("ASCII"));

Scripting API | Binary Methods

fillByte
assign(Int aFillByte, Int aNewLength) : Void

Fills the given binary variable with the specified byte value and sets the variable length to the
specified value.

Binary binaryVariable;
binaryVariable.fillByte(128, 15);

1817
17 Scripting

Scripting API | Binary Methods

fromBase64
fromBase64(String aString) : Binary

Returns binary data from the specified string encoded in Base64 encoding.

Binary binaryData = Binary.fromBase64("SGVsbG8gV29ybGQh");

Scripting API | Binary Methods

fromHex
fromHex(String aString) : Binary

Returns binary data from the specified string encoded in hexadecimal encoding.

Binary binaryData = Binary.fromHex("48656C6C6F20576F726C6421");

Scripting API | Binary Methods

fromStringWithCodec
fromStringWithCodec(String aString, String aCodecName) : Binary

Returns binary data from the specified string encoded in the specified encoding.

Binary binaryData;
binaryData = Binary.fromStringWithCodec("Hello World!", "UTF-8");

Scripting API | Binary Methods

get
get(Int aInt) : Int

Returns a byte value at the specified zero based position in the given binary variable.

If that position is greater than the length of the binary data, an error is shown when processing.

Binary binaryData = Binary.fromHex("48656C6C6F20576F726C6421");

Int theFirstByte = binaryData.get(0);
Int theLastByte = binaryData[binaryData.Length - 1];

1818
 17.3 General Content Model

Scripting API | Binary Methods

Length
Length() : Int
getLength() : Int
setLength(Int aNewLength) : Void

Returns or sets the number of bytes in the given binary variable.

Binary binaryData = Binary.fromHex("20");

Int dataLength = binaryData.Length; // dataLength = 1

Scripting API | Binary Methods

set
set(Int aInt, Int aInt) : Void

Sets the specified byte value at the specified zero based position in the given binary variable.

If that position is greater than the length of the binary data, an error is shown when processing.

Binary binaryData = Binary.fromHex("0000");

binaryData.set(0, 127);
binaryData[1] = 255;
String hexResult = binaryData.toHex();
// hexResult = "7FFF"

Scripting API | Binary Methods

toBase64
toBase64() : String

Returns a string that represents the Base64 notation of the given binary data.

File.Stream imageStream = File.open("C:\image.png", File.Mode.ReadOnly);

Binary binaryData = imageStream.readToEnd();
imageStream.close();
String base64Data = binaryData.toBase64();

Scripting API | Binary Methods

toHex
toHex() : String

Returns a string that represents the hexadecimal notation of the given binary data.

1819
17 Scripting

Binary binaryData;
binaryData = Binary.fromStringWithCodec("Hello World!", "UTF-8");
String hexData = binaryData.toHex();
// hexData = "48656C6C6F20576F726C6421"

Scripting API | Binary Methods

toStringWithCodec
toStringWithCodec(String aCodecName) : String

Returns a string that represents the given binary data encoded using the specified encoding.

Binary binaryData = Binary.fromBase64("SGVsbG8gV29ybGQh");

String decodedText = binaryData.toStringWithCodec("UTF-8");
// decodedText = "Hello World!"

Bool Methods
Bool methods can be used for manipulation with Boolean values.

Scripting API | Bool Methods

assign
assign(Bool aP1) : Void

Assigns a Boolean value to the given Boolean variable. The same result can be achieved using
the equal sign =.

Bool isFileExists;
isFileExists.assign(File.exist("C:\test.txt"));

Scripting API | Bool Methods

booleanAnd2
booleanAnd2(Bool aP1) : Bool

Returns the result of the Boolean conjunction of the given Boolean variable with the specified
value.

The same result can be achieved using the and operator.

1820
 17.3 General Content Model

Bool finished = true;

Bool isResultOk = false;
Bool finishedSuccessfully = finished.booleanAnd2(isResultOk);
// finishedSuccessfully = false

Scripting API | Bool Methods

booleanNot
booleanNot() : Bool

Returns the result of the Boolean negation of the given Boolean variable.

The same result can be achieved using the not operator.

Bool isGrayscale = false;

Bool isFullColor = isGrayscale.booleanNot();
// isFullColor = true

Scripting API | Bool Methods

booleanOr2
booleanOr2(Bool aP1) : Bool

Returns the result of the Boolean disjunction of the given Boolean variable with the specified
value.

The same result can be achieved using the or operator.

Bool isWeekend = false;

Bool isNationalHoliday = true;
Bool isDayOff = isWeekend.booleanOr2(isNationalHoliday);
// isDayOff = true

Scripting API | Bool Methods

booleanXor2
booleanXor2(Bool aP1) : Bool

Returns the result of the exclusive Boolean disjunction of the given Boolean variable with the
specified value.

The same result can be achieved using the xor operator.

Bool isRegistered = true;

Bool isAddressProvided = false;

1821
17 Scripting

Bool isDataIncorrect = isRegistered.booleanXor2(isAddressProvided);

// isDataIncorrect = true
// both items must be either true or false

Scripting API | Bool Methods

equal
equal(Bool aP1) : Bool

Returns the Boolean value true if the specified value equals to the given Boolean variable.

The same result can be achieved using the equality operator ==.

Bool isInRange = true;

Bool needToBeClipped = isOutOfRange.equal(false);
// Bool needToBeClipped = not isOutOfRange;
// needToBeClipped = false

Scripting API | Bool Methods

less
less(Bool aP1) : Bool

Returns the Boolean value true if the given Boolean variable is lower than the specified value.

The same result can be achieved using the less than operator <.

Bool a = true;
Bool b = false;
Bool result = a.less(b); // result = false

Scripting API | Bool Methods

toInt
toInt() : Int

Returns an integer representation of the given Boolean value.

Double sum;
Bool toBeIncluded = true;
sum += 1 * Int(toBeIncluded);
// sum = 1

1822
 17.3 General Content Model

Scripting API | Bool Methods

toString
toString() : String

Returns a string representation of the given Boolean value.

logMessage(File.exist("C:\test.txt").toString());

Currency Methods
Currency methods can be used for manipulation with currency values.

Scripting API | Currency Methods

assign
assign(Currency aP1) : Void
assign(Double aP1) : Void
assign(Int aP1) : Void
assign(Int64 aP1) : Void

Assigns the specified number to the given currency variable. The same result can be achieved
using the equal sign =.

Currency currencyValue;
currencyValue.assign(12.123456);
// currencyValue = 12.1235

Scripting API | Currency Methods

equal
equal(Currency aP1) : Bool

Returns the Boolean value true if the specified number equals to the given currency value. The
same result can be achieved using the equality operator ==.

Currency currencyValue = 12.1234;

Bool isTheSame = currencyValue.equal(12.12);
// isTheSame = false

1823
17 Scripting

Scripting API | Currency Methods

less
less(Currency aP1) : Bool

Returns the Boolean value true if the specified number is lower than the given currency value.
The same result can be achieved using the less than operator <.

Currency currencyValue = 12.1234;

Bool isLess = currencyValue.less(12.12);
// isLess = true

Scripting API | Currency Methods

minus
minus() : Currency
minus(Currency aP1) : Void
minus(Int aP1) : Void

Returns the negative value of the given currency variable if no parameter is specified.

Subtracts the specified number from the given currency value.

Currency currencyValue = 12.1234;

Currency negativeValue = currencyValue.minus();
// negativeValue = -12.1234

Currency currencyValue = 12.1234;

currencyValue.minus(12);
// currencyValue = 0.1234

Scripting API | Currency Methods

multiply
multiply(Currency aP1) : Void
multiply(Int aP1) : Void

Multiplies the given currency value by the specified number.

Currency currencyValue = 12.1234;

currencyValue.multiply(1.1);
// currencyValue = 13.3357

1824
 17.3 General Content Model

Scripting API | Currency Methods

plus
plus() : Currency
plus(Currency aP1) : Void
plus(Int aP1) : Void

Returns the positive value of the given currency variable if no parameter is specified.

Adds the specified number to the given currency value.

Currency currencyValue = 12.1234;

Currency positiveValue = currencyValue.plus();
// positiveValue = 12.1234

Currency currencyValue = 12.1234;

currencyValue.plus(-12);
// currencyValue = 0.1234

Scripting API | Currency Methods

toDouble
toDouble() : Double

Returns a double-precision floating-point number representation of the given currency value.

Currency currencyValue = 12.1234;

Double doubleValue = currencyValue.toDouble();
// doubleValue = 12.1234

Scripting API | Currency Methods

toInt
toInt() : Int

Returns an integer representation of the given currency value.

Currency currencyValue = 12.1234;

Int integerValue = currencyValue.toInt();
// integerValue = 12

Scripting API | Currency Methods

toInt64
toInt64() : Int64

1825
17 Scripting

Returns a 64-bit integer representation of the given currency value.

Currency currencyValue = 12.1234;

Int integer64Value = currencyValue.toInt();
// integer64Value = 12

Scripting API | Currency Methods

toSpell
toSpell(String aP1) : String

Returns a lexical representation of the given currency value in the language specified by the
corresponding language code.

Currency currencyValue = -12.1234;

String valueInWords = currencyValue.toSpell("en");
// valueInWords = "minus twelve point one two three four"

Scripting API | Currency Methods

toString
toString() : String
toString(Int aP1) : String
toString(Int aP1, Int aP2) : String

Returns a string representation of the given currency value. Optionally, the maximum and the
minimum number of digits after the decimal point can be specified.

Currency currencyValue = 12.1234;

String result = currencyValue.toString();
// result = "12.1234"

Currency currencyValue = 12.1234;

String result = currencyValue.toString(2);
// result = "12.12"

Currency currencyValue = 12;

String result = currencyValue.toString(4, 2);
// result = "12.00"

1826
 17.3 General Content Model

Data Input Methods

In this section: See also:
Read Methods Script Data Input Module
isEOF XML Reader Methods
rewind
ungetChar

The methods are for reading characters from a data file or creating records in the Script Data
Input module. Using them, you are able to parse the content of the input text file.

Read Methods
Reading always starts at the pointer position. The pointer identifies the location for the next
read operation. It moves automatically when you read from the file. If you read a character
e.g. from position 3456, the pointer automatically moves to position 3457.

Warning If the 'read' methods, except for readLine, come to the end of the file (i.e. no
further character or string can be read), an error occurs when running the script.

Scripting API | DataInput Methods | DataInput Methods

readChar
readChar () : Char

Reads the next character from the current input file, starting at the current pointer position.

If you want to test the value of a certain character using readChar() method and use another
read method afterwards depending on the tested value, you can move the pointer one position
backwards using the ungetChar method. You can also set the pointer to zero (which indicates
that the next operation will be on the first character) using the rewind method.

For an example see the readLine method description below.

Scripting API | DataInput Methods | DataInput Methods

readLine
readLine () : String
readLine (Char aP1) : String

Reads the characters up to the line break from the current input file, starting at the current
pointer position. Or, when used with the parameter (Char aP1), it reads the characters until
the specified character is reached.

The line break is any one of a line feed (0x0A), a carriage return (0x0D), or a carriage return
followed immediately by a line feed. If the line break is not detected, it reads the rest of the
string value from the given file, starting at the current pointer position.

1827
17 Scripting

Example

String MyLine;
MyLine = readLine('\x3B');

Note When a file with UTF-8 text encoding is used, the BOM (byte order mark), if present
at the beginning of the data file, will be kept in the data when using this method. This is a
different behavior than when using the data input module, where it is removed automatically.
To skip it also in script data input, use the following line at the beginning of the script and after
that the readLine method to read the file:

//skip BOM if it is the first character; if not, rewind

if (readChar()!=Char(0xfeff)) rewind();

When a file with UTF-16 text encoding is used, the BOM character used for indicating the en-
dianness (byte order) is not present in the read data. To keep it, the file would have to have
UTF-16BE or UTF-16LE text encoding.

Scripting API | DataInput Methods | DataInput Methods

readString
readString (Int aP1) : String

Reads the number of characters specified by the parameter from the current input file, starting
at the current pointer position.

Scripting API | DataInput Methods | DataInput Methods

readStringBM
readStringBM (Int aP1) : String

Reads the specified number of characters (specified by the parameter) in byte mode. Single-
byte characters are read as one character, double-byte characters are read as two characters.

Scripting API | DataInput Methods | DataInput Methods

readStringS
readStringS (Int aP1) : String

Reads the specified number of characters specified by the parameter from the current input
file, starting at the current pointer position. In addition to the readString functionality,
readStringS reads a surrogate pair (consisting of two characters) as one character, if it occurs
in the input file.

1828
 17.3 General Content Model

Scripting API | DataInput Methods

commit
commit () : Void

Returns the set of values to a repetition of an array, e.g. to create a single record.

Example

Accounts.Id="12356956";
Acoounts.FirstName="Lars";
Accounts.LastName="Mykland";
Accounts.Balance=132.31;
Accounts.commit();

Scripting API | DataInput Methods

isEOF
isEOF () : Bool

The isEOF function returns true only when the end of the input file is reached.

Example

while( not isEOF()) // cycles until EndOfFile

{
MyLine = readLine(); //Reading line
...
...
}

Scripting API | DataInput Methods

rewind
rewind () : Void

Resets the position of the pointer to zero (beginning of the input file).

Scripting API | DataInput Methods

ungetChar
ungetChar (Char aP1) : Void

Stores the previously read character (specified as the parameter) back and moves the pointer
one position backwards. The next usage of a 'read' method will return the character.

1829
17 Scripting

DateTime Methods
DateTime methods can be used for manipulation with date and time variables.

If any date or time component is set into the invalid range, date or time is automatically con-
verted into a valid value.

DateTime date = DateTime.fromDate(1, 1, 2000);

date.Day = 40;
String strDate = date.toString("yyyy-MM-dd", "en");
// strDate = "2000-02-09"

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | DateTime Methods

assign
assign(DateTime aP1) : Void
assign(Double aP1) : Void
assign(Int aDay, Int aMonth, Int aYear, Int aHour, Int aMinute, Int
aSecond) : Void

Assigns the specified value(s) to the given DateTime variable.

If that value is DateTime variable, the same result can be achieved using the equal sign =.

The specified value can also be passed as the double-precision floating-point number or set of
integer values in the following order: day, month, year, hour, minute and second.

DateTime currentDate, exactDate, annualDate;

currentDate.assign(DateTime.NowGMT);
exactDate.assign(36526.123);
annualDate.assign(21, 6, DateTime.NowGMT.Year, 0, 0, 0);

Scripting API | DateTime Methods

Day
Day : Int
getDay() : Int
setDay(Int aDay) : Void

Returns or sets an integer value that represents the day of the month for the given DateTime
variable.

DateTime date = DateTime.fromDate(1, 3, DateTime.Now.Year);

date.Day--;
Bool isLeapYear = (date.Day == 29);

1830
 17.3 General Content Model

DateTime date = DateTime.fromDate(1, 1, 2000);

date.Day = 31;
String strDate = date.toString("yyyy-MM-dd", "en");
// strDate = "2000-01-31"

Scripting API | DateTime Methods

DayOfWeek
DayOfWeek : Int
getDayOfWeek() : Int

Returns a zero based integer value that represents the day of the week for the given DateTime
variable, starting from Sunday.

DateTime date = DateTime.fromDate(1, 1, 2000);

Int dayOfWeek = date.DayOfWeek;
// dayOfWeek = 6 (Saturday)

Scripting API | DateTime Methods

DayOfYear
DayOfYear : Int
getDayOfYear() : Int
setDayOfYear(Int aDayOfYear) : Void

Returns or sets an integer value that represents the day of the year for the given DateTime
variable.

DateTime date = 36526; // 2000-01-01

Int dayOfYear = date.DayOfYear();
// dayOfYear = 1

Scripting API | DateTime Methods

Days
Days : Int
getDays() : Int
setDays(Int aDays) : Void

Returns or sets an integer value that represents the number of days passed since December
30th, 1899, 00:00:00.

1831
17 Scripting

DateTime date = DateTime.fromDate(1, 1, 2000);

Int days = date.Days();
// days = 36526

Scripting API | DateTime Methods

equal
equal(DateTime aP1) : Bool

Returns the Boolean value true if the given DateTime variable equals the specified value. The
same result can be achieved using the equality operator ==.

DateTime date_01 = DateTime.fromDate(1, 1, 2000);

DateTime date_02 = 36526;
Bool isEqual = date_01.equal(date_02);
// isEqual = true

Scripting API | DateTime Methods

format
format(String aPattern, String aLocale) : String

Returns a string representation of the given DateTime variable, formatted according to the
specified pattern and using the specified language code.

For the pattern reference see the Parse Date Time section. Additionally, one of the following
keywords can also be used: FullDate, LongDate, MediumDate, ShortDate, FullTime,
LongTime, MediumTime and ShortTime.

DateTime date = 36526.123;

String strFullDate = date.format("FullDate", "en");
// strFullDate = "Saturday, January 1, 2000"
String strCustomDate = date.format("yyyy-MM-dd", "en");
// strCustomDate = "2000-01-01"
String strShortTime = date.format("ShortTime", "en");
// strShortTime = "2:57 AM"

Scripting API | DateTime Methods

fromDate
fromDate(Int aDay, Int aMonth, Int aYear) : DateTime

Returns a DateTime value that represents the specified day, month and year.

DateTime date = DateTime.fromDate(1, 1, 2000);

1832
 17.3 General Content Model

Scripting API | DateTime Methods

fromString
fromString(String aDateTime, String aPattern, String aLocale, Bool
aLenient) : DateTime

Returns a DateTime value that corresponds with the specified string formatted using the specified
pattern in the language specified by the language code. If the Boolean value of the specified
lenient parameter is set to true, parsing succeeds even if the input string does not match the
pattern but can still be parsed as a date.

For details about using patterns see the format method.

DateTime date, time;

date = DateTime.fromString("Jan 01, 2000", "MMM dd, yyyy", "en", true);
date = DateTime.fromString("1. ledna 2000", "dd. MMMM yyyy", "cs", true);
time = DateTime.fromString("2:57 AM", "hh:mm a", "en", true);
time = DateTime.fromString("2:57 AM", "ShortTime", "en", true);

Scripting API | DateTime Methods

fromTime
fromTime(Int aHour, Int aMinute, Int aSecond) : DateTime
fromTime(Int aHour, Int aMinute, Int aSecond, Int aMillisecond) :
DateTime

Returns a DateTime value that represents the specified hours, minutes, seconds and optionally
also milliseconds.

DateTime time_01 = DateTime.fromTime(13, 30, 0);

DateTime time_02 = DateTime.fromTime(0, 0, 0, 3600000);

Scripting API | DateTime Methods

getDMY
getDMY(Int & aDay, Int & aMonth, Int & aYear) : Void

Updates the specified day, month and year variables passed by reference with the current values
of the given DateTime variable.

Int day, month, year;

DateTime date = 36526;
DateTime.getDMY(day, month, year);

1833
17 Scripting

Scripting API | DateTime Methods

getHMS
getHMS(Int & aHour, Int & aMinute, Int & aSecond) : Void

Updates the specified hour, minute and second variables passed by reference with the current
values of the given DateTime variable.

Int hours, minutes, seconds;

DateTime date = 36526.5;
DateTime.getHMS(hours, minutes, seconds);

Scripting API | DateTime Methods

Hour
Hour : Int
getHour() : Int
setHour(Int aHour) : Void

Returns or sets an integer value that represents the hour of the given DateTime variable.

DateTime date = 36526.5;

Int hour = date.Hour;
// hour = 12

Scripting API | DateTime Methods

less
less(DateTime aP1) : Bool

Returns the Boolean value true if the given DateTime variable is lower than the specified value.
The same result can be achieved using the less than operator <.

DateTime date = DateTime.fromDate(1, 1, 2000);

Bool isLess = date.less(DateTime.Now);
// isLess = true

Scripting API | DateTime Methods

Millisecond
Millisecond : Int
getMillisecond() : Int
setMillisecond(Int aMillisecond) : Void

1834
 17.3 General Content Model

Returns or sets an integer value that represents the fraction of a second of the given DateTime
variable expressed in milliseconds.

DateTime date = 36526.123;

Int millisecond = date.Millisecond;
// millisecond = 200

Scripting API | DateTime Methods

MillisecondOfDay
MillisecondOfDay : Int
getMillisecondOfDay() : Int
setMillisecondOfDay(Int aMillisecondOfDay) : Void

Returns or sets an integer value that represents the number of milliseconds that passed from
the beginning of the given day.

DateTime date = 36526.123;

Int millisecondOfDay = date.MillisecondOfDay;
// millisecondOfDay = 10627200

Scripting API | DateTime Methods

minus
minus() : DateTime
minus(DateTime aP1) : Void

Returns the negative value of the given DateTime variable when no parameter is specified.

Subtracts the specified value from the given DateTime variable and when necessary, converts
the result into a valid date.

DateTime date = DateTime.Now;

DateTime initDate = DateTime.fromDate(1, 1, 2000);
date.minus(initDate);
Int elapsedDays = date.Days;

Scripting API | DateTime Methods

Minute
Minute : Int
getMinute() : Int
setMinute(Int aMinute) : Void

Returns or sets an integer value that represents the minute number of the given DateTime
variable.

1835
17 Scripting

DateTime date = 36526.123;

Int minute = date.Minute;
// minute = 57

Scripting API | DateTime Methods

Month
Month : Int
getMonth() : Int
setMonth(Int aMonth) : Void

Returns or sets an integer value that represents the month number of the given DateTime
variable.

DateTime date = DateTime.fromDate(28, 2, DateTime.Now.Year);

date.Day++;
Bool isLeapYear = (date.Month == 2);

Scripting API | DateTime Methods

Now
Now : DateTime
getNow() : DateTime

Returns the current local date and time.

Note It is recommended to use GMT time (Greenwich Mean Time) instead if possible, see
NowGMT method.

DateTime date = DateTime.Now;

Scripting API | DateTime Methods

NowGMT
NowGMT : DateTime
getNowGMT() : DateTime

Returns the current GMT date and time.

GMT (Greenwich Mean Time) is the ideal base for date and time manipulations as it is inde-
pendent from any local time shifts (e. g. the daylight saving time in many countries).

Note Greenwich Mean Time (GMT) is commonly used to refer to Coordinated Universal Time
(UTC), although strictly UTC is an atomic time scale which only approximates GMT with a tol-
erance of 0.9 second.

1836
 17.3 General Content Model

DateTime date = DateTime.NowGMT;

Scripting API | DateTime Methods

plus
plus() : DateTime
plus(DateTime aP1) : Void

Returns the positive value of the given DateTime variable if no parameter is specified.

Adds the specified value to the given DateTime variable and if necessary, converts the result
into a valid date.

DateTime date = DateTime.fromDate(1, 1, 2000);

DateTime difference = 1;
date.plus(difference);
String strDate = date.toString("YYYY-MM-DD", "en");
// strDate = "2000-01-02"

Scripting API | DateTime Methods

Second
Second : Int
getSecond() : Int
setSecond(Int aSecond) : Void

Returns or sets an integer value that represents the number of seconds of the given DateTime
variable.

DateTime time = DateTime.fromTime(1, 2, 3);

Int seconds = time.Second;
// seconds = 3

Scripting API | DateTime Methods

SecondOfDay
SecondOfDay : Int
getSecondOfDay() : Int
setSecondOfDay(Int aSecondOfDay) : Void

Returns or sets an integer value that represents the number of seconds that passed from the
beginning of the given day.

1837
17 Scripting

DateTime time = DateTime.fromTime(1, 2, 3);

Int seconds = time.SecondOfDay;
// seconds = 3723

Scripting API | DateTime Methods

toDouble
toDouble() : Double

Returns a double-precision floating-point number representation of the given DateTime variable.

DateTime date = DateTime.fromDate(1, 1, 2000);

Double dateDifference = DateTime.Now.toDouble() - date.toDouble();

Scripting API | DateTime Methods

toString
toString() : String
toString(String aPattern, String aLocale) : String

Returns a string representation of the given DateTime variable, optionally formatted according
to the specified pattern and using the specified language code.

For details about using patterns see the format method.

DateTime date = 36526.123;

String strRawDate = date.toString();
// strRawDate = "1.1.2000 2:57:07.200"
String strFullDate = date.toString("FullDate", "en");
// strFullDate = "Saturday, January 1, 2000"
String strCustomDate = date.toString("yyyy-MM-dd", "en");
// strCustomDate = "2000-01-01"
String strShortTime = date.toString("ShortTime", "en");
// strShortTime = "2:57 AM"

Scripting API | DateTime Methods

Year
Year: Int
getYear() : Int

Returns or sets an integer value that represents the year of the given DateTime variable.

DateTime date = DateTime.fromDate(1, 1, 2000);

date.Day--;

1838
 17.3 General Content Model

Int year = date.Year;

// year = 1999

Double Methods
Double methods can be used for manipulation with double-precision floating-point numbers.

Scripting API | Double Methods

assign
assign(Double aP1) : Void
assign(Int aP1) : Void
assign(Int64 aP1) : Void

Assigns the specified value to the given double variable. The same result can be achieved using
the equal sign =.

Double diameter, area;

diameter.assign(10);
area.assign(Math.PI * (Math.pow(diameter, 2) / 4);
// area = 78.5398163397448

Scripting API | Double Methods

divide
divide(Double aP1) : Void
divide(Int aP1) : Void
divide(Int64 aP1) : Void

Divides the given number by the specified value.

If zero is entered, an error is shown when processing.

Double number = 25;

number.divide(100);
// number = 0.25

Scripting API | Double Methods

equal
equal(Double aP1) : Bool

Returns the Boolean value true when the specified value equals the given number. The same
result can be achieved using the equality operator ==.

1839
17 Scripting

Double dividend = 1;
Double divisor = 8;
Double quotient = 0;
if (divisor.equal(0)) {
logError("Division by zero");
} else {
quotient = dividend / divisor;
}
// quotient = 0.125

Scripting API | Double Methods

less
less(Double aP1) : Bool

Returns the Boolean value true if the given number is lower than the specified value. The same
result can be achieved using the less than operator <.

Double minValue = 100;

Double maxValue = 150;
Double value = 125;
Bool isInRangeExclusive = minValue.less(value) and
value.less(maxValue);
// isInRangeExclusive = true

Scripting API | Double Methods

minus
minus() : Double
minus(Double aP1) : Void
minus(Int aP1) : Void
minus(Int64 aP1) : Void

Returns the negative value of the given number if no parameter is specified.

Subtracts the specified value from the given number.

Double number = 100;

number.minus(number * 0.9);
// number = 10

1840
 17.3 General Content Model

Scripting API | Double Methods

multiply
multiply(Double aP1) : Void
multiply(Int aP1) : Void
multiply(Int64 aP1) : Void

Multiplies the given number by the specified value.

Double number = 100;

number.multiply(0.1);
// number = 10

Scripting API | Double Methods

plus
plus() : Double
plus(Double aP1) : Void
plus(Int aP1) : Void
plus(Int64 aP1) : Void

Returns the value of the given variable when no parameter is specified.

Adds the specified value to the given number.

Double number = 100;

number.plus(number * 0.1);
// number = 110

Scripting API | Double Methods

toCurrency
toCurrency() : Currency

Returns a currency representation of the given number.

Double number = 12.12345678;

Currency currencyValue = number.toCurrency();
// currencyValue = 12.1235

Scripting API | Double Methods

toInt
toInt() : Int

1841
17 Scripting

Returns an integer representation of the given number.

Double positiveNumber = 1.8;

Int positiveInt = positiveNumber.toInt();
// positiveInt = 1
Double negativeNumber = -1.8;
Int negativeInt = negativeNumber.toInt();
// negativeInt = -1

Scripting API | Double Methods

toInt64
toInt64() : Int64

Returns a 64-bit integer representation of the given number.

Double number = 1.8;

Int64 integer = number.toInt64();
// integer = 1

Scripting API | Double Methods

toSpell
toSpell(String aP1) : String

Returns a lexical representation of the given currency value in the language specified by the
corresponding language code.

Double number = -12.1234;

String valueInWords = number.toSpell("en");
// valueInWords = "minus twelve point one two three four"

Scripting API | Double Methods

toString
toString() : String
toString(Int aMaxDecimalPlaces, Int aMinDecimalPlaces) : String
toString(Int aPrecision) : String

Returns a string representation of the given number, optionally with the specified precision.

That precision can be determined either by the maximum and the minimum number of digits
after the decimal point or by the total number of significant digits.

1842
 17.3 General Content Model

Double number = 12.123456;

String strNumber = number.toString();
// strNumber = "12.123456"
strNumber = number.toString(4, 2);
// strNumber = "12.1235"
strNumber = number.toString(4);
// strNumber = "12.12"

number = 123456;
strNumber = number.toString();
// strNumber = "123456"
strNumber = number.toString(4, 2);
// strNumber = "123456.00"
strNumber = number.toString(4);
// strNumber = "1.235e+005"

Scripting API | Double Methods

toStringWithoutE
toStringWithoutE(Int aPrecision) : String

Returns a string representation of the given number with the specified precision, omitting the
exponent part.

That precision is determined by the total number of significant digits.

Double number = 123456;

String strNumber = number.toString(4);
// strNumber = "1.235e+005"
strNumber = number.toStringWithoutE(4);
// strNumber = "123500"

File Methods
File methods can be used for accessing both local and temporary file systems or a network and
manipulating file objects of any kind. These methods need to be licensed separately.

The temporary file system specified by memory:// protocol offers the similar functionality as
the ordinary file system, but it is discarded on the application close. Because the speed of RAM
is so much faster for most kinds of storage, files in the temporary file system can be accessed
much more quickly.

Example The following script creates a temporary file and then reads its content.
File.TextStream outputStream;
String filePath = "memory://readLine.txt";
File.Mode outputMode = File.Mode.TruncateOrCreate;
String encoding = "UTF-8";

// open a file and write some lines

outputStream = File.openText(filePath, outputMode, encoding);

1843
17 Scripting

outputStream.writeLine("Hello ");
outputStream.writeLine("World!");
outputStream.close();

// open the same file and read the first line

File.TextStream inputStream;
File.Mode inputMode = File.Mode.ReadOnly;
inputStream = File.openText(filePath, inputMode, encoding);
String firstLine = inputStream.readLine();
// firstLine = "Hello "
inputStream.close();

Scripting API | File Methods

cacheHttpLocation
cacheHttpLocation(String aLocation) : Void

Caches the content of the file located at the given URL address. The caching must be enabled
first, see the enableHttpCache method.

File.enableHttpCache(true, 8);
File.cacheHttpLocation(urlToCache);

Scripting API | File Methods

copy
copy(String SourceLocation, String TargetLocation) : Bool

Returns the Boolean value true if copying of an existing file to a new location has been finished
successfully. If the file in the target location already exists, it is overwritten.

Bool isCopied = File.copy("C:\input.txt", "C:\temp\input.txt");

Scripting API | File Methods

DriveType
A set of named constants determining the drive type.

CDRom Optical disc drive. Compact discs, DVDs and Blu-ray discs are common types of op-
tical media which can be read and recorded by such drives.

Fixed Hard disk drive.

RamDisk A RAM disk. It is a block of RAM that a computer's software is treating as if the
memory were a disk drive.

Remote A shared storage area on a networked computer's hard drive.

1844
 17.3 General Content Model

Removable Removable storage media. Examples include external optical drives, floppy disks
or USB flash drives.

Unknown An unknown drive type.

VCSDrive A storage of the Inspire Content Manager (VCS).

File.FileInfoList driveList;
File.FileInfoList hardDriveList;
File.listDrives(driveList);

for(Int i=0;i<driveList.Size;i++)
{
if (driveList[i].DriveType == File.DriveType.Fixed)
hardDriveList.add(driveList[i]);
}

for(Int i=0;i<hardDriveList.Size;i++)
{
logMessage(hardDriveList[i].DriveName);
}

Scripting API | File Methods

enableHttpCache
enableHttpCache(Bool aP1) : Void
enableHttpCache(Bool aP1, Int aThreadCount) : Void

Enables caching of the HTTP and HTTPS content.

The parameter aThreadCount specifies the total number of threads used for simultaneous
download. The default thread count is 4, the maximum is 100.

File.enableHttpCache(true);
File.cacheHttpLocation("http://www.domain.com/");

ExecuteContext Methods
ExecuteContext methods can be used for executing external executables, data exchange and
synchronization with them.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | ExecuteContext Methods

assign
assign(ExecuteContext aP1) : Void

1845
17 Scripting

Assigns an ExecuteContext object to the given executing context. The same result can be
achieved using the equal sign =.

File.ExecuteContext baseExecuteContext, clonedExecuteContext;

clonedExecuteContext.assign(baseExecuteContext);

Scripting API | File Methods | ExecuteContext Methods

canReceive
canReceive() : Bool

Returns a Boolean value true if there is any stream where an executed process writes its output
data.

// Executes an utility which tests whether a particular IP address

// is reachable and captures all the output
File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("ping", "10.10.10.10");
Int64 canDoSomethingElse = 0;
String capturedOutput;
while(process.isRunning())
{
if (process.canReceive())
{
capturedOutput += process.receiveLine() + '\n';
}
else
{
canDoSomethingElse++;
}
}

Scripting API | File Methods | ExecuteContext Methods

execute
execute(String aCmd, String aParams) : Void

Executes the specified command with the specified parameters.

The path to the executable is taken relatively to the working directory.

Note In Inspire Designer version 8.0 and lower the path to the directory containing the WFD
file, in which it was used, was added as a prefix to the executable. To achieve the behavior
prior to 8.1 version use "map://wfd/" in the parameter before the executable name, which
adds the path to the WFD.

// Opens the specified file in the text editor

File.ExecuteContext process;
process.execute("notepad", "C:\output.txt");

1846
 17.3 General Content Model

Scripting API | File Methods | ExecuteContext Methods

Hidden
Hidden : Bool
getHidden() : Bool
setHidden(Bool aP1) : Void

Returns or sets a Boolean value representing the appearance of any window of the executed
process. If the Boolean value is set to true, all windows are hidden.

// Executes an external command to obtain a Java version

File.ExecuteContext process;
process.Hidden = true;
process.MyInputOutput = true;
process.execute("java", "-version");
String javaVersionInfo, line;
while(process.receiveLine(line))
{
javaVersionInfo += line + '\n';
}

Scripting API | File Methods | ExecuteContext Methods

isRunning
isRunning : Bool

Returns a Boolean value true if there is a running process in the given executing context.

// Increases a variable value till the process finishes

File.ExecuteContext process;
process.execute("ping", "10.10.10.10");
Int64 iterationCount;
while(process.isRunning())
{
iterationCount++;
}

Scripting API | File Methods | ExecuteContext Methods

LastResult
LastResult : Int
getLastResult() : Int

Returns an exit code of the finished process in the given executing context. To get the correct
value the waitForFinish method must be applied first.

// Executes an external command and returns an exit code

File.ExecuteContext process;
process.execute("java", "-version");

1847
17 Scripting

process.waitForFinish();
Int exitCode = process.LastResult; // exitCode = 0

Scripting API | File Methods | ExecuteContext Methods

MyInputOutput
MyInputOutput : Bool
getMyInputOutput() : Bool
setMyInputOutput(Bool aP1) : Void

Returns or sets a Boolean value representing a state of redirection of both the standard input
and output streams to the given executing context.

// Captures a value of the JAVA_HOME environment variable

File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("cmd", "/c echo %JAVA_HOME%");
String javaHomeVariable = process.receiveLine();

Scripting API | File Methods | ExecuteContext Methods

receiveChar
receiveChar() : Char

Returns a character value from the standard output stream of the executed process. It blocks
the script execution until the character value is returned.

To use this method, a redirection of the standard output stream must be set, see the MyIn-
putOutput method.

// Captures the output of an external command, character by character

File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("cmd", '/c echo "Hello World!"');
String capturedOutput;
while(process.isRunning())
{
if (process.canReceive())
{
capturedOutput += process.receiveChar();
}
}

1848
 17.3 General Content Model

Scripting API | File Methods | ExecuteContext Methods

receiveLine
receiveLine() : String
receiveLine(String & aLine) : Bool

Returns either a string value representing one line of the standard output stream of the executed
process or a Boolean value true if that value is available.

While the first method blocks the script execution until either the string value is returned or
the process ends, the second one does not actively wait.

To use this method, a redirection of the standard output stream must be set, see the MyIn-
putOutput method.

// Captures the output of an external command, line by line

File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("tasklist", "/FO CSV");
String listOfProcesses, line;
while(process.receiveLine(line))
{
listOfProcesses += line + '\n';
}

Scripting API | File Methods | ExecuteContext Methods

sendNewLine
sendNewLine : Void

Writes the line break to the standard input stream of the executed process.

To use this method, a redirection of the standard input stream must be set, see the MyInputOut-
put method.

// Executes an external command and sends

// a line break to the standard input stream
File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("cmd", "/c pause");
process.sendNewLine();
String capturedOutput = process.receiveLine();

Scripting API | File Methods | ExecuteContext Methods

sendString
sendString(String aP1) : Void

Writes the given string to the standard input stream of the executed process.

1849
17 Scripting

To use this method, a redirection of the standard input stream must be set, see the MyInputOut-
put method.

// Executes an external command and sends

// a string to the standard input stream
File.ExecuteContext process;
process.MyInputOutput = true;
process.execute("choice", '/M "Are you sure you want to continue"');
process.sendString("N");
process.waitForFinish();
Int exitCode = process.LastResult; // exitCode = 2

Scripting API | File Methods | ExecuteContext Methods

waitForFinish
waitForFinish() : Void

Waits for the executed process to be finished.

// Executes an external command and waits till it finishes

File.ExecuteContext process;
process.execute("cmd", "/c nonExistingCommand");
process.waitForFinish();
Int exitCode = process.LastResult; // non-zero value

Scripting API | File Methods

exist
exist(String aLocation) : Bool

Returns the Boolean value true if the specified location exists.

Bool fileExists = File.exist("C:\input.txt");

FileInfo Methods
FileInfo methods can be used for reading of individual properties of the given file object. The
file object represents a file, a directory or a drive.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

1850
 17.3 General Content Model

Scripting API | File Methods | FileInfo Methods

AccessTime
AccessTime : DateTime
getAccessTime() : DateTime

Returns the last access time of the given file object.

File.FileInfoList fileList;
DateTime accessTime;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
accessTime = fileList[i].AccessTime;
}

Scripting API | File Methods | FileInfo Methods

assign
assign(FileInfo aP1) : Void

Assigns a FileInfo object to the given file object. The same result can be achieved using the =
assignment statement.

File.FileInfoList fileList;
File.FileInfo fileInfo;
String filePath;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
fileInfo.assign(fileList[i]);
filePath = fileInfo.Location;
}

Scripting API | File Methods | FileInfo Methods

Attributes
Attributes : String
getAttributes() : String

Returns a string value representing attributes of the given file object. Zero or more of the fol-
lowing characters can be returned:

Character Attribute

d directory
a archive
r read only
h hidden

1851
17 Scripting

Character Attribute

s system
c compressed
e encrypted
o offline

File.FileInfoList fileList;
String attributes;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
attributes = fileList[i].Attributes;
// e.g. attributes = "-arhs---"
}

Scripting API | File Methods | FileInfo Methods

CheckedUsers
CheckedUsers : String

Returns a comma separated list of all users that have the given file object checked out from
Inspire Content Manager (VCS).

File.FileInfoList fileList;
String checkedOutBy;
File.listWithMask(fileList, File.ListParam.Files, "C:\", "*.wfd");
for(Int i=0;i<fileList.Size;i++) {
checkedOutBy = fileList[i].checkedUsers;
// e.g. checkedOutBy = "John Doe"
}

Scripting API | File Methods | FileInfo Methods

CreateTime
CreateTime : DateTime
getCreateTime() : DateTime

Returns the creation time of the given file object.

File.FileInfoList fileList;
DateTime dateCreated;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
dateCreated = fileList[i].CreateTime;
}

1852
 17.3 General Content Model

Scripting API | File Methods | FileInfo Methods

Drive
Drive : String
getDrive() : String

Returns a string value representing the letter assigned to the given physical or logical drive.

File.FileInfoList driveList;
String driveLetter;
File.listDrives(driveList);
for(Int i=0;i<driveList.Size;i++) {
driveLetter = driveList[i].Drive;
// e.g. driveLetter = "C"
}

Scripting API | File Methods | FileInfo Methods

DriveLabel
DriveLabel : String
getDriveLabel() : String

Returns the customized label of the given drive.

File.FileInfoList driveList;
String driveLabel;
File.listDrives(driveList);
for(Int i=0;i<driveList.Size;i++) {
driveLabel = driveList[i].DriveLabel;
}

Scripting API | File Methods | FileInfo Methods

DriveName
DriveName : String
getDriveName() : String

Returns a string value representing the name of the given drive.

File.FileInfoList driveList;
String driveName;
File.listDrives(driveList);
for(Int i=0;i<driveList.Size;i++) {
if (driveList[i].DriveType == File.DriveType.Remote) {
driveName = driveList[i].DriveName;
// e.g. driveName = "\\pc\folder"
}
}

1853
17 Scripting

Scripting API | File Methods | FileInfo Methods

DriveType
DriveType : DriveType
getDriveType() : DriveType

Returns the drive type of the given drive.

File.FileInfoList driveList;
File.listDrives(driveList);
for(Int i=0;i<driveList.Size;i++) {
if (driveList[i].DriveType == File.DriveType.Fixed) {
logMessage(driveList[i].Drive);
}
}

Scripting API | File Methods | FileInfo Methods

Ext
Ext : String
getExt() : String

Returns the extension of the given file object.

File.FileInfoList fileList;
String extension;
File.listWithMask(fileList, File.ListParam.Files, "C:\", "*.jp*");
for(Int i=0;i<fileList.Size;i++) {
extension = fileList[i].Ext;
}

Scripting API | File Methods | FileInfo Methods

isDirectory
isDirectory() : Bool

Returns the Boolean value true if the given file object is a directory.

File.FileInfoList fileList;
Bool isDirectory;
File.list(fileList, File.ListParam.All, "C:\");
for(Int i=0;i<fileList.Size;i++) {
isDirectory = fileList[i].isDirectory();
}

1854
 17.3 General Content Model

Scripting API | File Methods | FileInfo Methods

isDrive
isDrive() : Bool

Returns the Boolean value true if the given file object is a drive.

File.FileInfoList driveList;
File.listDrives(driveList);
Bool isDrive;
for(Int i=0;i<driveList.Size;i++) {
isDrive = driveList[i].isDrive(); // isDrive = true
}

Scripting API | File Methods | FileInfo Methods

isExecutable
isExecutable() : Bool

Returns the Boolean value true if the given file object can be executed. Meaningful on non-
Windows platforms only, where this kind of rights can be modified.

File.FileInfoList fileList;
File.FileInfoList execFileList;
File.list(fileList, File.ListParam.All, "C:\");
for(Int i=0;i<fileList.Size;i++) {
if (fileList[i].isExecutable()) {
execFileList.add(fileList[i]);
}
}
logMessage(execFileList.Size.toString());

Scripting API | File Methods | FileInfo Methods

isFile
isFile() : Bool

Returns the Boolean value true if the given file object is a file.

File.FileInfoList fileList;
Bool isFile;
File.list(fileList, File.ListParam.All, "C:\");
for(Int i=0;i<fileList.Size;i++) {
isFile = fileList[i].isDirectory();
}

1855
17 Scripting

Scripting API | File Methods | FileInfo Methods

isReadable
isReadable() : Bool

Returns the Boolean value true if the given file object has the read only attribute switched on
(has no permission for writing).

File.FileInfoList fileList;
File.FileInfoList readOnlyFileList;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
if (fileList[i].isReadable()) {
readOnlyFileList.add(fileList[i]);
}
}
logMessage(readOnlyFileList.Size.toString());

Scripting API | File Methods | FileInfo Methods

isSymLink
isSymLink() : Bool

Returns the Boolean value true if the given file is a symbolic link that contains a reference to
another file object.

File.FileInfoList fileList;
File.FileInfoList symLinkList;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
if (fileList[i].isSymLink()) {
symLinkList.add(fileList[i]);
}
}
logMessage(symLinkList.Size.toString());

Scripting API | File Methods | FileInfo Methods

isWritable
isWritable() : Bool

Returns the Boolean value true if the given file object has permissions for writing.

function appendTextToFile(String filePath, String text) {

File.TextStream outputStream;
outputStream = File.openText(filePath, File.Mode.Append, "UTF-8");
outputStream.writeString(text);
outputStream.close();
return;

1856
 17.3 General Content Model

File.FileInfoList fileList;
File.listWithMask(fileList, File.ListParam.Files, "C:\", "settings.txt");
// if the specified file is found
if (fileList.Size > 0) {
// and if it has permissions for writing
if (fileList[0].isWritable()) {
// call an user defined function for appending data to this file
appendTextToFile(fileList[0].Location, "textToAppend");
}
}

Scripting API | File Methods | FileInfo Methods

Location
Location : String
getLocation() : String

Returns a full path to the given file object.

File.FileInfoList fileList;
String filePath;
File.ListParam listMode = File.ListParam.Files;
File.listWithMask(fileList, listMode, "C:\Windows", "win.ini");
for(Int i=0;i<fileList.Size;i++) {
filePath = fileList[i].Location;
// filePath = "C:\Windows\win.ini"
}

Scripting API | File Methods | FileInfo Methods

ModifyTime
ModifyTime : DateTime
getModifyTime() : DateTime

Returns the time of the last modification of the given file object.

File.FileInfoList fileList;
DateTime lastModifiedTime;
File.list(fileList, File.ListParam.Files, "C:\");
for(Int i=0;i<fileList.Size;i++) {
lastModifiedTime = fileList[i].ModifyTime;
}

1857
17 Scripting

Scripting API | File Methods | FileInfo Methods

Name
Name : String
getName() : String

Returns the name of the given file object without an extension.

File.FileInfoList fileList;
String baseName;
File.ListParam listMode = File.ListParam.Files;
File.listWithMask(fileList, listMode, "C:\Windows", "win.ini");
for(Int i=0;i<fileList.Size;i++) {
baseName = fileList[i].Name;
// baseName = "win"
}

Scripting API | File Methods | FileInfo Methods

NameExt
NameExt : String
getNameExt() : String

Returns the name of the given file object.

File.FileInfoList fileList;
String fileName;
File.ListParam listMode = File.ListParam.Files;
File.listWithMask(fileList, listMode, "C:\Windows", "win.ini");
for(Int i=0;i<fileList.Size;i++) {
fileName = fileList[i].NameExt;
// fileName = "win.ini"
}

Scripting API | File Methods | FileInfo Methods

Size
Size : Int64
getSize() : Int64

Returns the size of the given file in bytes.

File.FileInfoList fileList;
Int64 totalFolderSize;
File.list(fileList, File.ListParam.AllRecursive, "C:\Temp");
for(Int i=0;i<fileList.Size;i++) {
totalFolderSize += fileList[i].Size;
}
logMessage(totalFolderSize.toString());

1858
 17.3 General Content Model

FileInfoList Methods
FileInfoList methods can be used for creating and modifying lists of file or directory objects.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | FileInfoList Methods

add
add(FileInfo aP1) : Void

Adds the specified FileInfo member to the given list.

File.FileInfoList originalList;
File.FileInfoList filteredList;
if (File.list(originalList, File.ListParam.Files, "C:\"))
{
for (Int i=0;i<originalList.Size;i++) {
if (originalList[i].ModifyTime.equal(DateTime.Now))
// includes only files modified today
filteredList.add(originalList[i]);
}
}

Scripting API | File Methods | FileInfoList Methods

assign
assign(FileInfoList aP1) : Void

Assigns a FileInfoList object to the given list. The same result can be achieved using the = as-
signment statement.

File.FileInfoList baseFileInfoList, clonedFileInfoList;

clonedFileInfoList.assign(baseFileInfoList);

Scripting API | File Methods | FileInfoList Methods

clear
clear() : Void

Removes all FileInfo members from the given list.

File.FileInfoList baseFileInfoList, clonedFileInfoList;

if (File.list(baseFileInfoList, File.ListParam.Files, "C:\")) {
clonedFileInfoList.assign(baseFileInfoList);

1859
17 Scripting

baseFileInfoList.clear();
}

Scripting API | File Methods | FileInfoList Methods

get
get(Int aP1) : FileInfo

Returns a FileInfo member from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

File.FileInfoList resultList;
if (File.list(resultList, File.ListParam.Files, "C:\"))
{
for (Int i=0;i<resultList.Size;i++) {
logMessage(resultList.get(i).Location);
}
}

Scripting API | File Methods | FileInfoList Methods

insert
insert(Int aP1, FileInfo aP2) : Void

Inserts a FileInfo member at the specified position in the given list.

If that zero based position is out of the available range, an error will be shown when processing.

File.FileInfoList resultList;
if (File.list(resultList, File.ListParam.Files, "C:\"))
{
if (resultList.Size > 1) {
// duplicates the last FileInfo member and inserts it
// into the beginning of the list
resultList.insert(0, resultList[resultList.Size - 1]);
}
}

Scripting API | File Methods | FileInfoList Methods

remove
remove(Int aP1) : Void

Removes a FileInfo member from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

1860
 17.3 General Content Model

File.FileInfoList resultList;
if (File.list(resultList, File.ListParam.Files, "C:\"))
{
for (Int i=resultList.Size;i>=0;i--) {
if (resultList[i].ModifyTime.equal(DateTime.Now))
// keep only files modified today
resultList.remove(i);
}
}

Scripting API | File Methods | FileInfoList Methods

resize
resize(Int aP1, FileInfo aP2) : Void

Changes the total number of FileInfo members in the given list. If the new size is larger, the
default value of all new members is set to the specified FileInfo object.

File.FileInfoList txtFiles;
File.FileInfoList xmlFiles;
File.FileInfoList allFiles;
if (File.listWithMask(txtFiles, File.ListParam.Files, "C:\", "*.txt"))
{
if (txtFiles.Size > 0) {
Int originalSize = allFiles.Size;
allFiles.resize(allFiles.Size + txtFiles.Size, txtFiles[0]);
for (Int i = 0;i<txtFiles.Size;i++) {
allFiles[originalSize + i] = txtFiles[i];
}
}
}
if (File.listWithMask(xmlFiles, File.ListParam.Files, "C:\", "*.xml"))
{
if (xmlFiles.Size > 0) {
Int originalSize = allFiles.Size;
allFiles.resize(allFiles.Size + xmlFiles.Size, xmlFiles[0]);
for (Int i = 0;i<xmlFiles.Size;i++) {
allFiles[originalSize + i] = xmlFiles[i];
}
}
}

Scripting API | File Methods | FileInfoList Methods

set
set(Int aP1, FileInfo aP2) : Void

Sets a FileInfo member at the specified position in the given list to the specified FileInfo object.

If that zero based position is out of the available range, an error will be shown when processing.

1861
17 Scripting

File.FileInfoList txtFiles;
File.FileInfoList xmlFiles;
File.ListParam listMode = File.ListParam.Files;
Bool txtResult = File.listWithMask(txtFiles, listMode, "C:\", "*.txt");
Bool xmlResult = File.listWithMask(xmlFiles, listMode, "C:\", "*.xml");
if (txtResult and xmlResult) {
if (txtFiles.Size > 0) and (xmlFiles.Size > 0)) {
// swaps the first items of both lists
File.FileInfo tempFileInfo = xmlFiles[0];
xmlFiles.set(0, txtFiles[0]);
txtFiles.set(0, tempFileInfo);
}
}

Scripting API | File Methods | FileInfoList Methods

Size
Size : Int
getSize() : Int

Returns the total number of FileInfo members in the given list.

File.FileInfoList resultList;
if (File.list(resultList, File.ListParam.Files, "C:\")) {
Int listSize = resultList.Size;
}

Scripting API | File Methods | FileInfoList Methods

sort
sort() : Void

Sorts all FileInfo members in the given list by their location.

Individual characters are compared using their Unicode code points.

File.FileInfoList resultList;
if (File.list(resultList, File.ListParam.FilesRecursive, "C:\Windows\"))
{
resultList.sort();
for (Int i=0;i<resultList.Size;i++) {
logMessage(resultList.get(i).Location);
}
}

1862
 17.3 General Content Model

Scripting API | File Methods

ImagePageCount
ImagePageCount [Binary BinarySource] : Int
getImagePageCount (Binary BinarySource) : Int
ImagePageCount [Binary BinarySource, Bool ReadEpsAsPostScript] : Int
getImagePageCount (Binary BinarySource, Bool ReadEpsAsPostScript)
: Int
ImagePageCount [String SourceLocation] : Int
getImagePageCount (String SourceLocation) : Int
ImagePageCount [String SourceLocation, Bool ReadEpsAsPostScript] :
Int
getImagePageCount (String SourceLocation, Bool ReadEpsAsPostScript)
: Int

Returns the number of pages for the image defined by the parameter (as binary source or path
to the image).

It has the same functionality as the Image Page Counter field converter.

The variants with two parameters offer an additional possibility for PS files with multiple pages:
As Inspire Designer is unable to distinguish between EPS and PS formats and EPS files can have
only one page, the ImagePageCount always returns the value 1, even in case of multipage PS
files. If the second parameter is used, the file is first read as PS file and the script returns a
correct value.

Int imagePageCountFromBinary = File.getImagePageCount(Input); //where Input

is a variable with binary data coming from e.g. Data Input
logMessage(imagePageCountFromBinary.toString());

Int imagePageCountFromLocation = File.getImagePageCount("c:\Post

Script\sample.ps",true);
logMessage(imagePageCountFromLocation.toString());

Scripting API | File Methods

list
list(FileInfoList & aP1, ListParam aP2, String aDirectory) : Bool

Returns the Boolean value true if a list containing files found in the given scope starting from
the specified directory has been created successfully.

File.FileInfoList fileList;
if (File.list(fileList, File.ListParam.Files, "C:\")) {
for(Int i=0;i<fileList.Size;i++) {
logMessage(fileList[i].Location);
}
}

1863
17 Scripting

Scripting API | File Methods

listDrives
listDrives(FileInfoList & aP1) : Void

Creates a list of drives. For Windows platform only.

File.FileInfoList driveList;
File.listDrives(driveList);
for(Int i=0;i<driveList.Size;i++)
{
if (driveList[i].DriveType == File.DriveType.Fixed)
logMessage(driveList[i].DriveName + " [Hard Disk]");
else
logMessage(driveList[i].DriveName);
}

Scripting API | File Methods

ListParam
A set of named constants determining the scope for file or directory listing.

All Applies to all files and subdirectories of the current directory.

AllRecursive Applies recursively to all files and directories of the current directory.

Directories Applies to all subdirectories of the current directory.

DirectoriesRecursive Applies recursively to all subdirectories of the current directory.

Files Applies to all files of the current directory.

FilesRecursive Applies recursively to all files and subdirectories of the current directory.

File.FileInfoList fileInfo;
File.list(fileInfo, File.ListParam.FilesRecursive, ".");
String totalSize;
for (Int i=0;i<fileInfo.Size;i++)
{
totalSize += fileInfo[i].Size);
}

Scripting API | File Methods

listWithMask
listWithMask(FileInfoList & aP1, ListParam aP2, String aDirectory,
String aMask) : Bool

Returns the Boolean value true if a list containing files found in the given scope starting from
the specified directory and matching the given criteria has been created successfully.

1864
 17.3 General Content Model

The parameter aMask allows to filter files using the following wildcard characters:

* substitutes for any zero or more characters

? substitutes for any one character

File.FileInfoList fileList;
if (File.listWithMask(fileList, File.ListParam.Files, ".", "*.wfd"))
{
for(Int i=0;i<fileList.Size;i++)
{
logMessage(fileList[i].Location);
}
}

MetaDataInfo Methods
See also:
readMetaData()
ODBC Data Input Module Command Line
Parameters

MetaDataInfo methods provide access to a file's metadata, which extends the default file in-
formation. The content of metadata depends on the file type.

The metadata can be viewed in the Open File dialog, e.g. when browsing for an image to insert
it into Layout or in the MediaBin.

There is a special metadata item called Type, which represents the following file types:

Type Value Object Description

1 Folder
2 Image*
3 WFD
4 Font
5 TNO

*Along with the common image formats, Inspire Designer detects as images most Inspire De-
signer native formats: AFP, EPS, INDD, PCL, PDF, and PS. The TNOs have their own type value
(5).

There is a partial support for the Exif and the IPTC type of metadata contained in JPEG images.
In case of the IPTC metadata the author, the copyright and the keywords are supported. In
case of Exif, GPS info can be retrieved.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

1865
17 Scripting

Example Basic Usage

File.FileInfoList fileList;
File.MetaDataInfo metaInfo;
File.list(fileList, File.ListParam.FilesRecursive, "C:\temp");
/*
the following structure is filled in the code below:

files : Array
|_ fileName : String
|_ filePath : String
|_ metaData : Array
|_ name : String
|_ value : String
*/
for(Int i=0; i<fileList.Size; i++)
{
files.fileName = fileList[i].NameExt;
files.filePath = fileList[i].Location;

File.readMetaData(metaInfo, fileList[i].Location);

for(Int j=0;j<metaInfo.Count;j++)
{
files.metaData.name = metaInfo.Name[j];
files.metaData.value = metaInfo.Value[j];
files.metaData.commit();
}
files.commit();
}

Example Reading Exif Metadata

The following script allows to read and process Exif data and feed GPS data (geographic
coordinates) through a link to a selected web map. That map would open in the default
web browser marking the spot defined by the GPS data.
File.FileInfoList fileList;
File.listWithMask(fileList, File.ListParam.All, "C:\", "*.jp*g");
/*
the following structure is filled in the code below:

files : Array
|_ filePath : String
|_ isGeotagged : Bool
|_ longitude : String
|_ latitude : String
|_ elevation : String
|_ mapLink : String
*/
for (Int i=0;i<fileList.Size;i++)
{
if (not fileList[i].isDirectory())
{
File.MetaDataInfo fileMetaData;
File.readMetaData(fileMetaData, fileList[i].Location);
files.filePath = fileList[i].Location;
files.isGeotagged = false;

1866
 17.3 General Content Model

for (Int j=0;j<fileMetaData.Count;j++)

{
if (fileMetaData.Name[j] == "Exif.GPS.Location")
{
Util.StringList geoDataList;
String rawGeoData = fileMetaData.Value[j];
rawGeoData.parseLine('##\x0D\x0A', "", geoDataList);
files.latitude = geoDataList[0];
files.longitude = geoDataList[1];
if (geoDataList.Size > 2) {
files.elevation = geoDataList[2];
}
String link = "http://maps.google.com/maps?q=";
link.append(files.latitude);
link.append(",");
link.append(files.longitude);
files.mapLink = link;
files.isGeotagged = true;
}
}
files.commit();
}
}

Scripting API | File Methods | MetaDataInfo Methods

Count
Count : Int
getCount() : Int

Returns the total number of metadata items.

File.MetaDataInfo fileMetaData;
File.readMetaData(fileMetaData, "C:\input.wfd");
Int metaDataCount = fileMetaData.Count;

Scripting API | File Methods | MetaDataInfo Methods

get
get(String aP1) : String

Returns a string value of the specified metadata item name.

File.MetaDataInfo fileMetaData;
File.readMetaData(fileMetaData, "C:\input.wfd");
String fileType = fileMetaData.get("Type");

1867
17 Scripting

Scripting API | File Methods | MetaDataInfo Methods

Name
Name[Int aP1] : String
getName(Int aP1) : String

Returns the name of the metadata item at the specified position.

File.MetaDataInfo fileMetaData;
File.readMetaData(fileMetaData, "C:\input.wfd");
String metaDataName = fileMetaData.Name(0);

Scripting API | File Methods | MetaDataInfo Methods

readMetaData
readMetaData(MetaDataInfo & aP1, String aLocation) : Void

Reads metadata information of the given file object. It can be useful for digital assets used in
MediaBin.

Scripting API | File Methods | MetaDataInfo Methods

setMetaData
setMetaData(String aFileName, File.MetaDataInfo &aNewMetadata) : Void

Adds a new metadata item and its related information to the given file. It can be useful for
adding meta data to files in Inspire Content Manager.

Scripting API | File Methods | MetaDataInfo Methods

updateMetaData
setMetaData(String aFileName, File.MetaDataInfo &aNewMetadata) : Void

Overwrites the information in the named Metadata item. It can be useful for updating meta
data to files in Inspire Content Manager.

Scripting API | File Methods | MetaDataInfo Methods

Value
Value[Int aP1] : String
getValue(Int aP1) : String

Returns a string value of the metadata item at the specified position.

1868
 17.3 General Content Model

File.MetaDataInfo fileMetaData;
File.readMetaData(fileMetaData, "C:\input.wfd");
String metaDataValue = fileMetaData.Value(0);

Scripting API | File Methods

Mode
A set of named constants specifying the file access mode.

Append Opens the file and sets the current pointer position to the end of the file, i.e. your
text will be added behind the original content of the file.

The file you use it for must exist, otherwise an error occurs when processing.

This mode can only be used when writing to a file.

AppendOrCreate Opens the file if it exists and sets the current pointer position to the end
of the file, or creates a new empty file together with all necessary folders. When appending
your text, it will be added behind the original content of the file.

This mode can only be used when writing to a file.

ReadOnly Opens the file so that you can read from it.

The file you use it for must exist, otherwise an error occurs when processing.

This mode can only be used when reading from a file.

ReadWrite Opens the file so that you can read from it and/or write into it. When writing
into it, the text is added from the beginning over the original content, which is being
overwritten. If there was more original text than you add, the original text remains behind
the new text.

The file you use it for must exist, otherwise an error occurs when processing.

This mode can be used with both reading from and writing to a file.

Truncate Opens the file and sets its size to zero bytes, i.e. the original content is deleted and
you start adding new text from the beginning.

The file you use it for must exist, otherwise an error occurs when processing.

This mode can only be used when writing to a file.

TruncateOrCreate Opens the file if it exists and sets its size to zero bytes, or creates a new
empty file together with all necessary folders. If there was any, the original content of the
file is deleted and you start adding new text from the beginning.

This mode can only be used when writing to a file.

WriteOnly Opens the file so that you can write into it. The text is added from the beginning
over the original content, which is being overwritten. If there was more original text than
you add, the original text remains behind the new text.

The file you use it for must exist, otherwise an error occurs when processing.

1869
17 Scripting

This mode can only be used when writing to a file.

File.TextStream inputStream;
File.TextStream outputStream;
// read and modify a file content
File.Mode inputMode = File.Mode.ReadOnly;
inputStream = File.openText("C:\input.txt", inputMode, "UTF-8");
String fileContent = inputStream.readToEnd();
fileContent.replace("@", "<at>");
inputStream.close();
// save the modified file content
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.openText("C:\output.txt", outputMode, "UTF-8");
outputStream.writeString(fileContent);
outputStream.close();

Scripting API | File Methods

move
move (String SourceLocation, String TargetLocation) : Bool

Returns the Boolean value true if moving of an existing file to a new location has finished suc-
cessfully. If the file in the target location already exists, it is overwritten.

Bool isMoved = File.move("C:\input.txt", "C:\temp\input.txt");

Scripting API | File Methods

open
open(String aLocation, Mode aP2) : Stream

Returns a stream of the given file opened in the specified file access mode.

File.Stream outputStream;
outputStream = File.open("C:\output.txt", File.Mode.TruncateOrCreate);
File.TextStream encodedStream = outputStream.CodeTextStream["UTF-8"];
encodedStream.writeString(" ");
encodedStream.close();
outputStream.close();

Scripting API | File Methods

openText
openText(String aLocation, Mode aP2, String aCodec) : TextStream

Returns a text stream of the given file opened in the specified file access mode and encoded
using the valid text encoding.

1870
 17.3 General Content Model

File.TextStream inputStream;
String filePath = "C:\input.txt";
inputStream = File.openText(filePath, File.Mode.ReadOnly, "UTF-8");
String fileContent = inputStream.readToEnd();

Scripting API | File Methods

openTextWithUserCodec
openTextWithUserCodec(String aLocation, Mode aP2, String CodecFile
Name) : TextStream

Returns a text stream of the given file opened in the specified file access mode and encoded
using the user defined text encoding (stored in CDC format).

File.TextStream inputStream;
String filePath = "C:\input.txt";
File.Mode mode = File.Mode.ReadOnly;
String encoding = "C:\codec.cdc";
inputStream = File.openTextWithUserCodec(filePath, mode, encoding);
String fileContent = inputStream.readToEnd();

Scripting API | File Methods

remove
remove(String aP1) : Bool

Returns the Boolean value true if removing of the specified file has been finished successfully.

Bool isRemoved = File.remove("C:\input.txt");

Stream Methods
Stream methods allow opening, modifying and saving a binary file content. For text manipula-
tions it is better to use TextStream methods instead.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Example Opening a Stream and Writing to It

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeInt(123456);

1871
17 Scripting

Scripting API | File Methods | Stream Methods

assign
assign(Stream aP1) : Void

Assigns a stream object to the given stream. The same result can be achieved using the equal
sign =.

File.Stream inputStream;
inputStream.assign(File.open("C:\data.bin", File.Mode.ReadOnly));

Scripting API | File Methods | Stream Methods

close
close() : Void

Closes the given stream.

Note When scripting in Inspire Designer it is not necessary to close an open stream unless
you want to open it again. The stream closes automatically.

File.Stream inputStream;
inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);
Binary binaryContent = inputStream.readToEnd();
inputBinaryStream.close();

Scripting API | File Methods | Stream Methods

CodeTextStream
CodeTextStream[String aP1] : TextStream
getCodeTextStream(String aP1) : TextStream

Encodes the given stream. A parameter is either a valid text encoding or a path to the custom
codec.

File.Stream outputStream;
File.TextStream encodedTextStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
encodedTextStream = outputStream.CodeTextStream["UTF-8"];
encodedTextStream.writeString(" ");

1872
 17.3 General Content Model

Scripting API | File Methods | Stream Methods

DecodeTextStream
DecodeTextStream[String aP1] : TextStream
getDecodeTextStream(String aP1) : TextStream

Decodes the given stream. A parameter is either a valid text encoding or a path to the custom
codec.

File.Stream inputStream;
File.TextStream decodedTextStream;
inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);
decodedTextStream = inputStream.DecodeTextStream["UTF-8"];
String decodedContent = decodedTextStream.readToEnd();

Scripting API | File Methods | Stream Methods

isEOF
isEOF() : Bool

Returns a Boolean value true if the end of the given stream has been reached.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Int weakCheckSum;
while (not inputStream.isEOF()) {
weakCheckSum += inputStream.readByte();
}
inputStream.close();

Scripting API | File Methods | Stream Methods

isOpen
isOpen() : Bool

Returns a Boolean value true if the given stream is open.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

if (inputStream.isOpen()) inputStream.close();

Scripting API | File Methods | Stream Methods

Position
Position : Int64
getPosition() : Int64
setPosition(Int64 aP1) : Int64

1873
17 Scripting

Returns or sets the current pointer position within the given stream.

If the new pointer position exceeds the size of the stream, an error will be shown when pro-
cessing.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

inputStream.Position = 1;
Int secondByteValue = inputStream.readByte();

Scripting API | File Methods | Stream Methods

readBinary
readBinary(Int aLength) : Binary

Reads the specified number of bytes from the given stream, starting at the current pointer
position.

If that number of bytes exceeds the remaining length of the stream, an error will be shown
when processing.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Binary binaryChunk = inputStream.readBinary(8);

Scripting API | File Methods | Stream Methods

readBool
readBool() : Bool

Reads a Boolean value from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Bool isFlagSet = inputStream.readBool();

Scripting API | File Methods | Stream Methods

readByte
readByte() : Int

Reads a byte value (a number within the range from -127 to 128) from the given stream,
starting at the current pointer position. See also readUByte.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Int currentByteValue = inputStream.readByte();

1874
 17.3 General Content Model

Scripting API | File Methods | Stream Methods

readCurrency
readCurrency() : Currency

Reads a currency value from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Currency debit = inputStream.readCurrency();

Scripting API | File Methods | Stream Methods

readDouble
readDouble() : Double

Reads a double value from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Double monthAverage = inputStream.readDouble();

Scripting API | File Methods | Stream Methods

readInt
readInt() : Int

Reads an integer value from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Int userID = inputStream.readInt();

Scripting API | File Methods | Stream Methods

readInt64
readInt64() : Int64

Reads a 64-bit integer value from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Int64 binaryChunkSize = inputStream.readInt64();

1875
17 Scripting

Scripting API | File Methods | Stream Methods

readString
readString() : String

Reads a string value from the given stream, starting at the current pointer position, where a
record of both the length of the string and its UTF-16 encoded content is expected.

Warning If the readString method is invoked at the pointer position in a stream where
no appropriate string record is present, it will read meaningless data because of improperly
detected string length. If that length exceeds the remaining length of the stream, an error will
be shown when processing.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

inputStream.Position = 8;
String utf16EncodedString = inputStream.readString();

Scripting API | File Methods | Stream Methods

readStringWithCodec
readStringWithCodec(Int aP1, String aP2) : String

Reads the specified number of bytes from the given stream, starting at the current pointer
position, and decodes them to text using the specified text encoding.

If that number of bytes exceeds the remaining length of the stream, an error will be shown
when processing.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

String decodedString = inputStream.readStringWithCodec(16, "UTF-8");

Scripting API | File Methods | Stream Methods

readStringWithUserCodec
readStringWithUserCodec(Int aP1, String aP2) : String

Reads the specified number of bytes from the given stream, starting at the current pointer
position, and decodes them to text using the user defined text encoding (stored in CDC format).

If the number of bytes exceeds the remaining length of the stream, an error will be shown
when processing.

String decodedString;
File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);
decodedString = inputStream.readStringWithCodec(16, "C:\userCodec.cdc");

1876
 17.3 General Content Model

Scripting API | File Methods | Stream Methods

readToEnd
readToEnd() : Binary

Reads the rest of data from the given stream, starting at the current pointer position.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Binary binaryContent = inputStream.readToEnd();

Scripting API | File Methods | Stream Methods

readUByte
readUByte() : Int

Reads an unsigned byte value (a number within the range 0-255) from the given stream,
starting at the current pointer position. See also readByte.

File.Stream inputStream = File.open("C:\data.bin", File.Mode.ReadOnly);

Int currentUByteValue = inputStream.readUByte();

Scripting API | File Methods | Stream Methods

Size
Size : Int64
getSize() : Int64
setSize(Int64 aP1) : Int64

Returns or sets the given stream size in bytes. If the new size is smaller, the stream is truncated.
Otherwise it is filled with null characters.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.Size = 1024;

Scripting API | File Methods | Stream Methods

writeBinary
writeBinary(Binary aP1) : Void

Writes a binary value on the given stream, starting at the current pointer position.

1877
17 Scripting

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
Binary binaryData = Binary.fromHex("03BC006D"); // m
outputStream.writeBinary(binaryData);

Scripting API | File Methods | Stream Methods

writeBool
writeBool(Bool aP1) : Void

Writes a Boolean value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeBool(true);

Scripting API | File Methods | Stream Methods

writeByte
writeByte(Int aP1) : Void

Writes a byte value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeByte(169); //

Scripting API | File Methods | Stream Methods

writeCurrency
writeCurrency(Currency aP1) : Void

Writes a currency value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeCurrency(12.1234);

Scripting API | File Methods | Stream Methods

writeDouble
writeDouble(Double aP1) : Void

1878
 17.3 General Content Model

Writes a double value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeDouble(12.123456);

Scripting API | File Methods | Stream Methods

writeInt
writeInt(Int aP1) : Void

Writes an integer value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeInt(0x7FFFFFFF); // max. Int value
outputStream.writeInt(-1234);

Scripting API | File Methods | Stream Methods

writeInt64
writeInt64(Int64 aP1) : Void

Writes a 64-bit integer value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeInt64(0x7FFFFFFFFFFFFFFF); // max. Int64 value
outputStream.writeInt64(-1234);

Scripting API | File Methods | Stream Methods

writeRawString
writeRawString(String aP1) : Void

Writes a string value on the given stream, starting at the current pointer position.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeRawString("Hello World!");

1879
17 Scripting

Scripting API | File Methods | Stream Methods

writeString
writeString(String aP1) : Void

Writes a string value on the given stream, starting at the current pointer position.

A record stored in the stream consists of the length of the string followed with the content itself.

File.Stream outputStream;
outputStream = File.open("C:\data.bin", File.Mode.TruncateOrCreate);
outputStream.writeString("Hello World!");

TextStream Methods
TextStream methods allow opening, modifying and saving a text file content. For binary content
manipulations it is better to use Stream methods instead.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | TextStream Methods

assign
assign(TextStream aP1) : Void

Assigns a TextStream object to the given text stream. The same result can be achieved using
the equal sign =.

File.TextStream inputStream;
String filePath = "C:\input.txt";
inputStream.assign(File.openText(filePath, File.Mode.ReadOnly, "UTF-8"));

Scripting API | File Methods | TextStream Methods

close
close() : Void

Closes the given text stream.

Note When scripting in Inspire Designer it is not necessary to close an open text stream unless
you want to open it again. The text stream closes automatically.

File.TextStream outputStream;
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.openText("C:\output.txt", outputMode, "UTF-8");
outputStream.close();

1880
 17.3 General Content Model

Scripting API | File Methods | TextStream Methods

isEOF
isEOF() : Bool

Returns the Boolean value true when the end of the given text stream has been reached.

File.TextStream inputStream;
String filePath = "C:\input.txt";
inputStream = File.openText(filePath, File.Mode.ReadOnly, "UTF-8");
String fileContent;
while (not inputStream.isEOF()) {
fileContent += inputStream.readLine();
}
inputStream.close();

Scripting API | File Methods | TextStream Methods

isOpen
isOpen() : Bool

Returns the Boolean value true if the given text stream is open.

File.TextStream inputStream;
String filePath = "C:\input.txt";
inputStream = File.openText(filePath, File.Mode.ReadOnly, "UTF-8");
if (inputStream.isOpen()) inputStream.close();

Scripting API | File Methods | TextStream Methods

readChar
readChar() : Char

Reads a character value from the given text stream, starting at the current pointer position.

File.TextStream outputStream;
String filePath = "C:\readChar.txt";
File.Mode outputMode = File.Mode.TruncateOrCreate;
String encoding = "UTF-8";
// open a file and write a line
outputStream = File.openText(filePath, outputMode, encoding);
outputStream.writeLine("abc");
outputStream.close();
// open the same file and read the first character
File.TextStream inputStream;
File.Mode inputMode = File.Mode.ReadOnly;
inputStream = File.openText(filePath, inputMode, encoding);
Char firstCharacter = inputStream.readChar();
// firstCharacter = "a"
inputStream.close();

1881
17 Scripting

Scripting API | File Methods | TextStream Methods

readLine
readLine() : String

Reads a string value up to the line break from the given text stream, starting at the current
pointer position.

If the line break is not detected, it reads the rest of the string value from the given stream,
starting at the current pointer position.

The line break is any one of a line feed (0x0A), a carriage return (0x0D), or a carriage return
followed immediately by a line feed.

File.TextStream outputStream;
String filePath = "memory://readLine.txt";
File.Mode outputMode = File.Mode.TruncateOrCreate;
String encoding = "UTF-8";
// open a file and write some lines
outputStream = File.openText(filePath, outputMode, encoding);
outputStream.writeLine("Hello ");
outputStream.writeLine("World!");
outputStream.close();
// open the same file and read the first line
File.TextStream inputStream;
File.Mode inputMode = File.Mode.ReadOnly;
inputStream = File.openText(filePath, inputMode, encoding);
String firstLine = inputStream.readLine();
// firstLine = "Hello "
inputStream.close();

Scripting API | File Methods | TextStream Methods

readString
readString(Int aP1) : String

Reads the specified number of characters from the given text stream, starting at the current
pointer position.

File.TextStream inputStream = File.openText("c:\read

String.txt", File.Mode.ReadOnly, "UTF-8");
String s = inputStream.readString(10);

Scripting API | File Methods | TextStream Methods

readStringBM
readStringBM(Int aP1) : String

Reads a string value representing the specified number of bytes from the given text stream,
starting at the current pointer position.

1882
 17.3 General Content Model

If that number of bytes exceeds the remaining length of the stream, or it is insufficient for
building a complete double-byte character, an error will be shown when processing.

File.TextStream outputStream;
String filePath = "C:\readStringBM.txt";
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.openText(filePath, outputMode, "UTF-8");
outputStream.writeString("12");
outputStream.close();
File.TextStream inputStream;
File.Mode inputMode = File.Mode.ReadOnly;
inputStream = File.openText(filePath, inputMode, "UTF-8");
String result = inputStream.readStringBM(4);
// inputStream.readStringBM(3) would cause an error when processing,
// a Euro sign is a double-byte character
inputStream.close();

Scripting API | File Methods | TextStream Methods

readStringS
readStringS(Int aP1) : String

Reads the specified number of characters from the given text stream, starting at the current
pointer position. In addition to the readString functionality, readStringS reads a surrogate
pair (consisting of two characters) as one character, if it occurs in the input file.

Scripting API | File Methods | TextStream Methods

readToEnd
readToEnd() : String

Reads the rest string value from the given text stream, starting at the current pointer position.

File.TextStream inputStream;
String filePath = "C:\input.txt";
inputStream = File.openText(filePath, File.Mode.ReadOnly, "UTF-8");
String fileContent = inputStream.readToEnd();

Scripting API | File Methods | TextStream Methods

writeChar
writeChar(Char aP1) : Void

Writes a character value on the given text stream, starting at the current pointer position.

File.TextStream outputStream;
File.Mode outputMode = File.Mode.TruncateOrCreate;

1883
17 Scripting

outputStream = File.openText("C:\output.txt", outputMode, "UTF-8");

outputStream.writeChar("");

Scripting API | File Methods | TextStream Methods

writeLine
writeLine(String aP1) : Void

Writes a string value, followed by a line break, on the given text stream, starting at the current
pointer position.

The line break is any one of a line feed (0x0A), a carriage return (0x0D), or a carriage return
followed immediately by a linefeed.

File.TextStream outputStream;
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.openText("C:\output.txt", outputMode, "UTF-8");
outputStream.writeLine("");
outputStream.writeLine(" ");
outputStream.writeLine("");
outputStream.close(); // three separate lines in the output

Scripting API | File Methods | TextStream Methods

writeString
writeString(String aP1) : Void

Writes a string value on the given text stream, starting at the current pointer position.

File.TextStream outputStream;
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.openText("C:\output.txt", outputMode, "UTF-8");
outputStream.writeString("");
outputStream.writeString(" ");
outputStream.writeString("");
outputStream.close(); // a single line in the output

VCS Methods
See also:
Inspire Content Manager Overview

ICM methods manage files that are in Inspire Content Manager. To be able to use these
methods (e.g. in the Script Data Input module), you need to be logged into Inspire Content
Manager.

1884
 17.3 General Content Model

Paths to files and directories in Content Manager can also include branch and version inform-
ation in order to access a specific version of that file. See the separate section Paths to Files in
Content Manager.

Example

File.VCS.getVersionId("vcs:L:MyLabel:B:MyBranch1//FroodecoMail.wfd");

Scripting API | File Methods | VCS Methods

aliasLabel
aliasLabel(String aLocation, String AliasName, String LabelName,
String aComment, String FileComment, Bool AppendNewFileComment, La
belComment LabelCommentType, Bool Recursive) : String

Labels the specified file or directory with the specified alias if its label matches the specified
label name. Such operation can be complemented by the specified comment.

This method can also modify the current file comment. In such case the new comment must
be specified and the next parameter set to the Boolean value true. It either replaces or appends
the current value, regarding to the specified label comment type. In case of directory the last
Boolean value specifies whether such operation will be applied also to all children of that dir-
ectory.

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

logMessage(File.VCS.aliasLabel("vcs://folder",
"released",
"approved",
"2009-10-15",
"",
false,
File.VCS.LabelComment.Apply,
true));

ApprovalState Methods
File.VCS.ApprovalState declares an approval state object for inclusion in an Approval-
States list, which is used inside a History Info object to read approval states from versions of
files.

It is used inside a list because there can be more than one approval state applied to any single
file version. See HistoryInfoList for an example of use. Once declared, the following methods
can be applied to the object:

1885
17 Scripting

Scripting API | File Methods | VCS Methods | ApprovalState Methods

assign
assign(ApprovalState aP1) : Void

Assigns the object (in brackets) to the current object. The same result can be achieved using
the = assignment statement.

Scripting API | File Methods | VCS Methods | ApprovalState Methods

Comment
Comment : String
getComment() : String
setComment(String aP1) : Void

Returns or sets a comment of the approval state applied to the file version.

Scripting API | File Methods | VCS Methods | ApprovalState Methods

CreationTime
CreationTime : DateTime
getCreationTime() : DateTime

Returns the time that the approval state was applied to the file version.

Scripting API | File Methods | VCS Methods | ApprovalState Methods

Name
Name : String
getName() : String
setName(String aP1) : Void

Returns or sets the name of the approval state applied to a file version.

Scripting API | File Methods | VCS Methods | ApprovalState Methods

UserName
Username : String
getUserName() : String
setUserName(String aP1) : Void

Returns or sets the name of the user who is linked to the change of the approval state to a file
version.

1886
 17.3 General Content Model

Scripting API | File Methods | VCS Methods | ApprovalState Methods

ValidFrom
ValidFrom : DateTime
getValidFrom() : DateTime
setValidFrom(DateTime aP1) : Void

Returns or sets an initial validity date of the approval state applied to a file version.

Scripting API | File Methods | VCS Methods | ApprovalState Methods

ValidTo
ValidTo : DateTime
getValidTo() : DateTime
setValidTo(DateTime aP1) : Void

Returns or sets a final validity date of the approval state applied to a file version.

Scripting API | File Methods | VCS Methods

branch
branch(String aLocation, String LabelName, String aComment, Bool Re
cursive) : String

Splits the specified file or directory into two parallel versions. Such operation can be comple-
mented with the specified label name and comment. In case of directory the last Boolean value
specifies whether such operation will be applied also to all children of that directory.

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

logMessage(File.VCS.branch("vcs://folder", "v2.0", "New design", true));

Scripting API | File Methods | VCS Methods

checkIn
checkIn(String aLocation, String aComment) : String
checkIn(String aLocation, String aComment, Stream aStream) : String

Updates the content of the specified file in Inspire Content Manager (VCS) server. Such operation
can be complemented with the specified comment. A new content is taken from previously
checked out and updated file or passed as a specified stream.

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

1887
17 Scripting

File.Stream outputStream;
File.Mode outputMode = File.Mode.TruncateOrCreate;
outputStream = File.open("memory://output.txt", outputMode);
outputStream.CodeTextStream["UTF-8"].writeString("Hello World!");
logMessage(File.VCS.checkIn("vcs://file.txt", "v1.0", outputStream));

Scripting API | File Methods | VCS Methods

checkOut
checkOut(String aLocation) : String

Copies the specified file or directory into a temporary location on local disc.

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

logMessage(File.VCS.checkOut("vcs://file.txt"));
File.TextStream stream;
stream = File.openText("vcs://file.txt", File.Mode.Append, "UTF-8");
stream.writeString(" ");
stream.close();
logMessage(File.VCS.checkIn("vcs://file.txt", "Greek version added"));

DataValue
DataValue declares a value for use in a DataValueList.

See MetadataValueList for an example of use. Once declared, the following methods can be
applied to the value:

Scripting API | File Methods | VCS Methods | DataValue Methods

assign
assign(DataValue aP1) : Void

Assigns the specified DataValue object to the given DataValue object. The same result can be
achieved using the = assignment statement.

Scripting API | File Methods | VCS Methods | DataValue Methods

BoolValue
BoolValue : Bool
getBoolValue() : Bool
setBoolValue(Bool aP1) : Void

Returns or sets a Boolean value of the DataValue object.

1888
 17.3 General Content Model

Scripting API | File Methods | VCS Methods | DataValue Methods

DateTimeValue
DateTimeValue : DateTime
getDateTimeValue() : DateTime
setDateTimeValue(DateTime aP1) : Void

Returns or sets a DateTime value of the DataValue object.

Scripting API | File Methods | VCS Methods | DataValue Methods

DoubleValue
DoubleValue : Double
getDoubleValue() : Double
setDoubleValue(Double aP1, Int aPrecision) : Void

Returns or sets a Double value of the DataValue object. When a precision is specified, it sets
the number of decimal places.

Scripting API | File Methods | VCS Methods | DataValue Methods

IntValue
IntValue : Int
getIntValue() : Int
setIntValue(Int aP1) : Void

Returns or sets a Int value of the DataValue object.

Scripting API | File Methods | VCS Methods | DataValue Methods

StringValue
StringValue : String
getStringValue() : String
setStringValue(String aP1) : Void

Returns or sets a String value of the DataValue object.

Scripting API | File Methods | VCS Methods | DataValue Methods

Type
Type : DataValueType
getType() : DataValueType

Returns a DataValueType of the DataValue object.

1889
17 Scripting

DataValueList Methods
DataValueList methods can be used for storing, manipulating and retrieving DataValue objects.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | VCS Methods | DataValueList Methods

add
add(DataValue aP1) : Void

Adds a list item with the specified value to the given list.

Scripting API | File Methods | VCS Methods | DataValueList Methods

assign
assign(DataValueList aP1) : Void

Assigns a DataValueList object to the given list. The same result can be achieved using the
equal sign =.

Scripting API | File Methods | VCS Methods | DataValueList Methods

clear
clear() : Void

Removes all the list items from the given list.

Scripting API | File Methods | VCS Methods | DataValueList Methods

get
get(Int aP1) : DataValue

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | DataValueList Methods

insert
insert(Int aP1, DataValue aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

1890
 17.3 General Content Model

Scripting API | File Methods | VCS Methods | DataValueList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | DataValueList Methods

resize
resize(Int aP1, DataValue aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Scripting API | File Methods | VCS Methods | DataValueList Methods

set
set(Int aP1, DataValue aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | DataValueList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Scripting API | File Methods | VCS Methods | DataValueList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

1891
17 Scripting

Scripting API | File Methods | VCS Methods

DataValueType
Returns data-types, for use in naming Types for DataValues.

File.VCS.MetadataValue mdv;
File.VCS.DataValue size;

function valueTypeToString(File.VCS.DataValueType aValue) : String

{
is(aValue)
{
File.VCS.DataValueType.Bool:return "Bool";
File.VCS.DataValueType.DateTime:return "DateTime";
File.VCS.DataValueType.Double:return "Double";
File.VCS.DataValueType.Int:return "Int";
File.VCS.DataValueType.String:return "String";
}
logError("No Data Type");
}

mdv.Name="Int(301)-Type:" + valueTypeToString(size.Type);

Scripting API | File Methods | VCS Methods

getReferencedBy
getReferencedBy(String aSearchInLocation, String aSearchForLocation,
Bool aRecursive, StringList) : String

Lists any files in the aSearchInLocation that reference the files (i.e. use the file as a resource)
at the aSearchForLocation.

If the file is a resource, this can be used to discover which workflows are using it. It searches
for references in the metadata item Dependencies of all files in the aSearchInLocation.
Dependencies is added to workflows (WFD files) when they are placed in Content Manager.

The Boolean aRecursive determines whether it will also search for referencing external
workflows to any workflows found in aSearchInLocation, even if they are not in that
directory.

Scripting API | File Methods | VCS Methods

getReferences
getReferences(String aLocation, Bool aRecursive, StringList) : String

Lists files which the file String aLocation references, i.e. any references that are listed in
the metadata item Dependencies of the file at aLocation.

HistoryInfo
File.VCS.HistoryInfo declares a HistoryInfo object for use in HistoryInfoLists.

1892
 17.3 General Content Model

The file from which the history is read is determined with readFileHistory.

Example In the Script Data Input module, this structure of fields has been created:

And this script is used to read history from the file to the fields:

FileName="vcs://GFBankSummerOffer11.wfd"; // gives value to Filename field

File.VCS.HistoryInfoList list; // declares HistoryInfoList
File.VCS.readFileHistory(FileName,list); // Determines that file his
tory will be read from file to list

for(Int i=0;i<list.Size;i++) // loop for History array

{
File.VCS.HistoryInfo cur=list[i]; // Declares HistoryInfo object

History.Branch=cur.Branch; // reads to fields

History.Comment=cur.Comment;
History.CreationTime=cur.CreationTime;
History.UserName=cur.UserName;
History.VersionDeleted=cur.VersionDeleted;

for(Int j=0;j<cur.Labels.Size;j++) // loop for Labels array

{
History.Labels.Label=cur.Labels[j]; // reads to field
History.Labels.commit();
}

for(Int j=0;j<cur.ApprovalStates.Size;j++) // loop for ApprovalState

array
{
File.VCS.ApprovalState curAS=cur.ApprovalStates[j]; // declares Ap
provalState object called Approved
History.ApprovalState.CreationTime=curAS.CreationTime; // reads to
fields
History.ApprovalState.Name=curAS.Name;
History.ApprovalState.UserName=curAS.UserName;
History.ApprovalState.ValidTo=curAS.ValidTo;
History.ApprovalState.commit();
}
History.commit();
}

1893
17 Scripting

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

ApprovalStates
ApprovalStates : ApprovalStatesList
getApprovalStates() : ApprovalStatesList

Returns a list of ApprovalStates.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

assign
assign(HistoryInfo aP1) : Void

Assigns the specified HistoryInfo object to the given object. The same result can be achieved
using the = assignment statement.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

Branch
Branch : String
getBranch() : String

Returns the branch name from the version of the file.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

Comment
Comment : String
getComment() : String

Returns any comments made to the version of the file on check-in or check-out.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

CreationTime
CreationTime : DateTime
getCreationTime() : DateTime

Returns the creation time of the version of the file.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

Labels
Labels : StringList
getLabels() : StringList

1894
 17.3 General Content Model

Returns a list of labels from the version of the file. Each version can have multiple labels.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

Metadata
Metadata : Metadata
getMetadata() : Metadata

Returns the Metadata object from the version of the file.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

UserName
Username : String
getUsername() : String

Returns the user name (i.e. creator of the file) from the file declared by readFileHistory.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

VersionDeleted
VersionDeleted : Bool
getVersionDeleted() : Bool

Returns true if the version is a deleted version of the file.

Scripting API | File Methods | VCS Methods | HistoryInfo Methods

VersionId
VersionId : Int
getVersionId()

Returns the version Id from the version of the file.

HistoryInfoList Methods
HistoryInfoList methods can be used for storing, manipulating and retrieving HistoryInfo objects.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

add
add(HistoryInfo aP1) : Void

1895
17 Scripting

Adds a list item with the specified value to the given list.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

assign
assign(HistoryInfoList aP1) : Void

Assigns a HistoryInfoList object to the given list. The same result can be achieved using the
equal sign =.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

clear
clear() : Void

Removes all the list items from the given list.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

get
get(Int aP1) : HistoryInfo

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

insert
insert(Int aP1, HistoryInfo aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

1896
 17.3 General Content Model

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

resize
resize(Int aP1, HistoryInfo aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

set
set(Int aP1, HistoryInfo aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Scripting API | File Methods | VCS Methods | HistoryInfoList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Scripting API | File Methods | VCS Methods

label
label (String aLocation, String LabelName, String aComment, String
FileComment, Bool AppendNewFileComment, LabelComment LabelComment
Type, Bool Recursive) : String

Tags the specified file or directory with the specified label name. Such operation can be com-
plemented with the specified comment.

This method can also modify the current file comment. In such a case the new comment must
be specified and the next parameter set to the Boolean value true. It either replaces or appends
the current value, regarding of the specified label comment type. In case of directory the last
Boolean value specifies whether such operation will be applied also to all children of that dir-
ectory.

1897
17 Scripting

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

logMessage(File.VCS.label("vcs://file.txt",
"approved",
"2009-10-10",
"",
false,
File.VCS.LabelComment.Append,
false));

Scripting API | File Methods | VCS Methods

LabelComment
A set of named constants determining the method of applying the label comments.

Append Appends a new label comment to the current one.

Apply Replaces the current label comment with the new one.

ApplyOnNew Applies a new label comment only if the current one is empty.

Metadata
File.VCS.Metadata declares an object that stores various file metadata.

Example In the Script Data Input module, this structure of fields has been created:

And this script is used to read metadata from the file to the fields:
FileName="vcs://GFBankSummerOffer11.wfd"; // reads the file path to Fi
leName field
File.VCS.Metadata md;
// declares Metadata object
File.VCS.readMetadata(FileName,md);
// reads the metadata from file to object

for(Int i=0;i<md.SystemValues.Size;i++)
// loop for array

1898
 17.3 General Content Model

{
File.VCS.MetadataValue mdv=md.SystemValues[i];
// declares MetadataValues for SystemValues array
Metadata.SystemValues.Name=mdv.Name;
// reads MetadataValue to field
for(Int j=0;j<mdv.DataValues.Size;j++)
// loop for dependant array
{
File.VCS.DataValue dv=mdv.DataValues[j];
// declares DataValues for DataValues array
Metadata.SystemValues.DataValues.Type=valueTypeToString(dv.Type);
// reads DataValue's Type as string to field Type
Metadata.SystemValues.DataValues.Value=dv.toString();
Metadata.SystemValues.DataValues.commit();
}
Metadata.SystemValues.commit();
}

for(Int i=0;i<md.UserValues.Size;i++)
{
File.VCS.MetadataValue mdv=md.UserValues[i];
// declares MetadataValues are user-defined metadata
Metadata.UserValues.Name=mdv.Name;
for(Int j=0;j<mdv.DataValues.Size;j++)
{
File.VCS.DataValue dv=mdv.DataValues[j];
Metadata.UserValues.DataValues.Type=valueTypeToString(dv.Type);
Metadata.UserValues.DataValues.Value=dv.toString();
Metadata.UserValues.DataValues.commit();
}
Metadata.UserValues.commit();
}

Scripting API | File Methods | VCS Methods | Metadata Methods

assign
assign(Metadata aP1) : Void

Assigns the specified Metadata object to the given Metadata object. The same result can be
achieved using the = assignment statement.

Scripting API | File Methods | VCS Methods | Metadata Methods

SystemValues
SystemValues : MetadataValueList
getSystemValues() : MetadataValueList

Returns the MetadataValueList object that stores system-defined metadata of the given file.

1899
17 Scripting

Scripting API | File Methods | VCS Methods | Metadata Methods

UserValues
UserValues : MetadataValueList
getUserValues() : MetadataValueList

Returns the MetadataValueList object that stores user-defined metadata of the given file.

MetadataValue
File.VCS.MetadataValue declares a value for use in a MetadataValueList. See
MetadataValueList for an example of use.

Scripting API | File Methods | VCS Methods | MetadataValue Methods

assign
assign(MetadataValue aP1) : Void

Assigns the specified MetadataValue object to the given MetadataValue object. The same result
can be achieved using the = assignment statement.

Scripting API | File Methods | VCS Methods | MetadataValue Methods

DataValues
DataValues : DataValueList
getDataValues() : DataValueList
setDataValues(DataValueList) : Void

Returns or sets a DataValueList object of the given MetadataValue.

Scripting API | File Methods | VCS Methods | MetadataValue Methods

Name
Name() : String
getName() : String
setName(String aP1) : Void

Returns or sets the name of the given MetadataValue.

MetadataValueList Methods
MetadataValueList methods can be used for storing, manipulating and retrieving MetadataValue
objects.

1900
 17.3 General Content Model

The following example creates a MetadataList and writes it to a file's metadata.

File.FileInfoList fil; //declare

FileInfoList
File.list(fil,File.ListParam.FilesRecursive,"vcs://images/"); //nomin
ate directory vcs://images/ for recursive file manipulation

String temp,gps_x,gps_y,ID; //declare

strings for naming properties of file
File.VCS.DataValueList values; //declare
DataValueList

readLine();

while (not isEOF()) //read each file

{
temp = readLine(); //determ
ine which lines of file are which properties
ID = temp.Part[0,";"];
gps_x = temp.Part[1,";"];
gps_y = temp.Part[2,";"];

for (Int i=0; i<fil.Size;i++) //loop

for assigning items to list
{
if (fil[i].NameExt == ID)
{
File.VCS.DataValue gpsDataX; //declare
DataValue
gpsDataX.setDoubleValue(gps_x.toDouble(),8); //assign
value to DataValue
values.add(gpsDataX); //add
value to DataValueList

File.VCS.DataValue gpsDataY;
gpsDataY.setDoubleValue(gps_y.toDouble(),8);
values.add(gpsDataY);

File.VCS.MetadataValue mdv; //de

clare MetadataValue
mdv.Name="Exif.GPS.Location"; //name
MetadataValue
mdv.DataValues=values; //as
sign complete DataValueList to single MetadataValue

File.VCS.MetadataValueList mdvl; //de

clare MetadataValueList
mdvl.add(mdv); //add
MetadataValue to list
File.VCS.writeUserMetadata(fil[i].Location,mdvl,true); //write
data in MetadataList to file.

mdvl.clear(); //reset
MetadataList for next loop
values.clear(); //reset
DataValueList for next loop
break;
}
}
}

1901
17 Scripting

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

add
add(MetadataValue aP1) : Void
add(String aName, DateTime aValue) : Void
add(String aName, Int aValue) : Void
add(String aName, String aValue) : Void

Adds a list item with the specified value to the given list.

File.VCS.MetadataValue mdv;
mdv.Name = "Exif.GPS.Location";
mdv.DataValues = values;

File.VCS.MetadataValueList mdvl;
mdvl.add(mdv);

File.VCS.MetadataValueList mdlist;
String User = Util.OSUserName;
mdlist.add("Time", DateTime.Now.toString());
mdlist.add("User Name","time" + User);

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

assign
assign(MetadataValueList aP1) : Void

Assigns a MetadataValueList object to the given list. The same result can be achieved using
the equal sign =.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

clear
clear() : Void

Removes all the list items from the given list.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

get
get(Int aP1) : MetadataValue

Returns a value of a list item from the specified position of the given list.

1902
 17.3 General Content Model

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

insert
insert(Int aP1, MetadataValue aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

resize
resize(Int aP1, MetadataValue aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

set
set(Int aP1, MetadataValue aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

1903
17 Scripting

Scripting API | File Methods | VCS Methods | MetadataValueList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Scripting API | File Methods | VCS Methods

readFileHistory
readFileHistory(String aLocation, HistoryInfoList) : String

Reads history from the ICM file String aLocation so that it can be used in the History
InfoList. See HistoryInfoList for an example of use.

Scripting API | File Methods | VCS Methods

readMetadata
readMetadata(String aLocation, Metadata) : String

Reads metadata from the ICM file String aLocation to be used in the Metadata object.

Scripting API | File Methods | VCS Methods

setPreview
setPreview(String aLocation, Binary aImage) : Void

Sets a new preview image to the file at String aLocation.

Scripting API | File Methods | VCS Methods

setVersionApprovalState
setVersionApprovalState(String aLocation, ApprovalState aApproval
State) : Void

Sets a predefined approval state to the file at String aLocation.

Scripting API | File Methods | VCS Methods

undoCheckOut
undoCheckOut(String aLocation) : String

Reverts the specified file or directory into the original, not the checked out state. Any changes
made to the local copy of the file will be lost.

1904
 17.3 General Content Model

Returns a string value representing the Inspire Content Manager (VCS) server response to the
operation. Either OK as a confirmation that the operation succeeded, or an error code indicating
the error type.

logMessage(File.VCS.checkOut("vcs://file.txt"));
logMessage(File.VCS.undoCheckOut("vcs://file.txt"));

Scripting API | File Methods | VCS Methods

UserName
UserName : String
getUserName() : String

Returns the name of the user that is currently logged into Inspire Content Manager (VCS).

String currentUserName = File.VCS.UserName;

Scripting API | File Methods | VCS Methods

VersionId
VersionId[String aLocation] : Int
getVersionId(String aLocation) : Int

Returns the version Id of the specified file in Inspire Content Manager (VCS).

Int versionID = File.VCS.VersionId["vcs://file.txt"];

Scripting API | File Methods | VCS Methods

writeUserMetadata
writeUserMetadata(String aLocation, MetadataValueList, Bool aMerge)
: String

Adds a new metadata from MetadataValueList and its related information to the file
aLocation in Content Manager.

The Boolean value determines whether it will overwrite any current metadata items, e.g. if file
has 10 metadata items and new MetadataValueList has only 1 item then false will result in
only 1 item, however true will replace any metadata item with the same name or add the
new item so the result is either 10 or 11 metadata items.

FileName="vcs://GFBankSummerOffer11.wfd"; // value of FileName field in

the Script Data Input module

1905
17 Scripting

File.VCS.MetadataValueList mdvl;
mdvl.add("NameString","Value");
mdvl.add("NameInt",32);
mdvl.add("NameDateTime",DateTime(5,5,2010,0,0,0)); //adds 3 items to list
File.VCS.writeUserMetadata(FileName,mdvl,false); //writes 3 items to
metadata

WebRequest Methods
See also:
WebResponse Methods

WebRequest methods enable creating, modifying and sending HTTP and HTTPS requests to
web servers.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | WebRequest Methods

assign
assign(WebRequest aP1) : Void

Assigns a WebRequest object to the given web request. The same result can be achieved using
an equal sign =.

File.WebRequest request;
request.assign(File.WebRequest.create("http://www.w3.org/"));

Scripting API | File Methods | WebRequest Methods

create
create(String aP1) : WebRequest

Creates a web request to the specified URL.

File.WebRequest request;
request = File.WebRequest.create("http://www.w3.org/");

1906
 17.3 General Content Model

Scripting API | File Methods | WebRequest Methods

Property
Property : String
setProperty(String aP1, String aP2) : Void

Sets the specified request header property to the specified value.

File.WebRequest request;
request = File.WebRequest.create("http://www.w3.org/");
request.setProperty("Accept-Language", "en-gb");

Scripting API | File Methods | WebRequest Methods

Response
Response : WebResponse
Response[Stream aP1] : WebResponse
Response[String aContent, String aCodec] : WebResponse
getResponse() : WebResponse
getResponse(Stream aP1) : WebResponse
getResponse(String aContent, String aCodec) : WebResponse

Returns a web response on the request sent to the server. If it is necessary to send any additional
data via the POST method, it can be passed in the form of stream or encoded text.

File.WebRequest request;
request = File.WebRequest.create("http://www.website.com/form.jsp");
Int statusCode = request.Response["userid=1234", "UTF-8"].StatusCode;

Scripting API | File Methods | WebRequest Methods

Timeout
Timeout: Int
setTimeout(Int aMilliseconds) : Void

Sets the timeout for receiving data from a server. The default value is 30 seconds.

File.WebRequest wr=File.WebRequest.create("http://www.data.com/long");
wr.Timeout=100000; //100 sec
File.WebResponse resp = wr.Response;
if(resp.StatusCode!=200)
logError("Request has failed.");

1907
17 Scripting

Scripting API | File Methods | WebRequest Methods

treatConnectionErrorAsStatus590
treatConnectionErrorAsStatus590() : Void

Returns a status 590 error (standard web calling status) if a requested connection fails. This
avoids the script failing and causing the abortion of processing of the workflow, which would
otherwise happen in such an event.

File.WebRequest wr = File.WebRequest.create("http://nonsence.non");
wr.treatConnectionErrorAsStatus590();
Field0=wr.Response.StatusCode;

Scripting API | File Methods | WebRequest Methods

WaitForContinue
WaitForContinue : Bool

Adds Expect: 100-continue\r\n to the http header during request, i.e. a Code 100 status request.
Upon receiving a request which includes an Expect request-header field with the "100-continue"
expectation, an origin server will either respond with 100 (Continue) status and continue to
read from the input stream, or respond with a final status code. If the server returns 100 then
the Boolean is true and the rest of the request will be read by the server, thus avoiding pro-
cessing of requests if the server is not accepting them.

Note This method is essential for Facebook posting requests.

WebResponse Methods
See also:
WebRequest Methods

WebResponse methods enable parsing web server responses.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Example You can use the XML Data Input module for calling a web server and using
the downloaded data in the workflow. In this example, a XML file is retrieved from a
website, then the script template of the XML Data Input module reads the XML input and
copies it to the output.

File.XMLReader reader;
File.WebRequest request;
File.WebResponse response;
request = File.WebRequest.create("http://www.website.com/file.xml");
response = request.Response;
// if the request has not been successful, an error message is logged

1908
 17.3 General Content Model

if (response.StatusCode != 200) logError(response.StatusDescription);

File.Stream xmlStream = response.ResponseStream;
String encoding = response.CharacterSet;
reader.initInputStream(xmlStream, encoding, true);
while(reader.read())
{
is(reader.NodeType)
{
File.XMLNodeType.Element:
{
elementBegin(reader.Name);
for(Int i=0;i<reader.AttributeCount;i++)
{
attribute(reader.AttributeName[i], reader.Attribute[i]);
}
}
File.XMLNodeType.EndElement:
elementEnd();

File.XMLNodeType.Text:
unparsed(reader.Value);

File.XMLNodeType.CDATA:
unparsed(reader.Value);
}
}

Scripting API | File Methods | WebResponse Methods

assign
assign(WebResponse aP1) : Void

Assigns a WebResponse object to the given web response. The same result can be achieved
using an equal sign =.

File.WebRequest request;
File.WebResponse response;
request = File.WebRequest.create("http://www.w3.org/");
response.assign(request.Response);

Scripting API | File Methods | WebResponse Methods

CharacterSet
CharacterSet : String
getCharacterSet() : String

Returns a string value representing the character set of the given response content.

File.WebRequest request;
File.WebResponse response;
request = File.WebRequest.create("http://www.w3.org/");

1909
17 Scripting

response = request.Response;
String characterSet = response.CharacterSet;
// characterSet = "utf-8"

Scripting API | File Methods | WebResponse Methods

ContentType
ContentType : String
getContentType() : String

Returns a string value representing the Internet media type of the given response content.

File.WebRequest request;
request = File.WebRequest.create("http://www.w3.org/");
String contentType = request.Response.ContentType;
// contentType = "text/html; charset=utf-8"

Scripting API | File Methods | WebResponse Methods

HeaderProperty
HeaderProperty[String aP1] : String
getHeaderProperty(String aP1) : String

Returns a string value of the specified header property of the given response.

File.WebRequest request;
File.WebResponse response;
request = File.WebRequest.create("http://www.w3.org/");
response = request.Response;
String serverName = response.HeaderProperty["Server"];
// serverName = "Apache/2"

Scripting API | File Methods | WebResponse Methods

ResponseHeader
ResponseHeader : String
getResponseHeader() : String

Returns a string value representing the entire header of the given response.

File.WebRequest request;
File.WebResponse response;
request = File.WebRequest.create("http://www.w3.org/");
response = request.Response;
String responseHeader = response.ResponseHeader;

1910
 17.3 General Content Model

Scripting API | File Methods | WebResponse Methods

ResponseStream
ResponseStream() : Stream
getResponseStream() : Stream

Returns a stream representing the content of the given response.

File.WebRequest request;
request = File.WebRequest.create("http://w3.org/Icons/w3c_home");
Binary imageData = request.Response.ResponseStream.readToEnd();

Scripting API | File Methods | WebResponse Methods

StatusCode
StatusCode() : Int
getStatusCode() : Int

Returns a status code from the status line of the given response.

File.WebRequest request;
request = File.WebRequest.create("http://www.w3.org/");
Int statusCode = request.Response.StatusCode;
// statusCode = 200

Scripting API | File Methods | WebResponse Methods

StatusDescription
StatusDescription() : String
getStatusDescription() : String

Returns a status description from the status line of the given response.

File.WebRequest request;
request = File.WebRequest.create("http://www.w3.org/");
String statusDecription = request.Response.StatusDescription;
// statusDescription = "200 OK"

1911
17 Scripting

Scripting API | File Methods

XMLNodeType
A set of named constants determining the node type.

Attribute An element attribute.

CData A character data section, used to escape blocks of text that would otherwise be recog-
nized as markup.

Comment A comment.

Document An entire XML document.

DocumentFragment A portion of an existing document tree.

Document Type A document type declaration.

Element An element.

EndElement A closing tag of the element.

EndEntity A type returned when XmlReader gets to the end of the entity replacement as a
result of a call to ResolveEntity.

Entity An entity declaration.

EntityReference A reference to an entity.

None A type returned by the XmlReader if a Read method has not been called.

Notation A notation in the document type declaration.

ProcessingInstruction A processing instruction.

SignificantWhitespace A white space between markup in a mixed content model or white

space within the xml:space="preserve" scope.

Text A text content of a node.

Whitespace A white space between markup.

XMLDeclaration The XML declaration.

XMLReader Methods
XMLReader methods can be used for reading the content from a XML file.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

1912
 17.3 General Content Model

Scripting API | File Methods | XMLReader Methods

Attribute
Attribute[Int aP1] : String
Attribute[String aP1] : String
getAttribute(Int aP1) : String
getAttribute(String aP1) : String

Returns the value of the attribute with the specified name or index from the current element.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String isbn = reader.Attribute["ISBN"];
// isbn = "1-861003-78"
xmlStream.close();

<book genre="novel" ISBN="1-861003-78" pubdate="1987"/>

Scripting API | File Methods | XMLReader Methods

AttributeCount
AttributeCount : Int
getAttributeCount() : Int

Returns the number of attributes of the current element.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String attributeCount = reader.AttributeCount;
// attributeCount = 3
xmlStream.close();

<book genre="novel" ISBN="1-861003-78" pubdate="1987"/>

Scripting API | File Methods | XMLReader Methods

AttributeName
AttributeName[Int aP1] : String
getAttributeName(Int aP1) : String

1913
17 Scripting

Returns the attribute name on the specified position of the current element.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String attributeName = reader.AttributeName[0];
// attributeName = "genre"
xmlStream.close();

<book genre="novel" ISBN="1-861003-78" pubdate="1987"/>

Scripting API | File Methods | XMLReader Methods

Depth
Depth : Int
getDepth() : Int

Returns an integer value representing the depth of the current node in the given XML document.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
reader.readStartElement();
reader.readStartElement();
String subitemDepth = reader.Depth;
// subitemDepth = 3
xmlStream.close();

<root>
<item>
<subitem>Hello World!<subitem>
</item>
</root>

Scripting API | File Methods | XMLReader Methods

initInputStream
initInputStream(Stream aP1, String Codec, Bool IgnoreNamespaces) :
Void

Initializes the specified stream encoded with the specified encoding and with namespaces
treated according to the specified Boolean value. If that value is true, namespaces are ignored.

1914
 17.3 General Content Model

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String elementContent = reader.readOuterXML();
xmlStream.close();

Scripting API | File Methods | XMLReader Methods

initFromString
initFromString(String aP1) : Void
initFromString(String aP1, Bool IgnoreNamespaces) : Void

Initializes the given reader with the specified string.

If the second parameter is used, namespaces are treated according to the specified Boolean
value. If that value is true, namespaces are ignored.

File.XMLReader reader;
reader.initFromString("<root><node id='first'/></root>");
reader.moveToContent();
String xmlContent = reader.readOuterXML();
// xmlContent = "<root><node id='first'/></root>"

Scripting API | File Methods | XMLReader Methods

isEOF
isEOF() : Bool

Returns the Boolean value true when the end of the given stream has been reached.

File.XMLReader reader;
Int elementCount;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
while (not reader.isEOF()) {
reader.read();
if (reader.NodeType == File.XMLNodeType.Element) {
elementCount++;
}
}
// elementCount = 2
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root "root.dtd">
<root>
<!-- comment -->

1915
17 Scripting

<?insert-toc?>
<item/>
</root>

Scripting API | File Methods | XMLReader Methods

isStartElement
isStartElement() : Bool

Returns the Boolean value true if the current content node is a start tag or empty element tag.
The content node is one of the following node types: Text, CData, Element, EndElement, Enti-
tyReference or EndEntity.

File.XMLReader reader;
String currentElementName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
if (reader.isStartElement()) {
currentElementName = reader.Name;
// currentElementName = "root"
reader.readStartElement();
if (reader.isStartElement()) {
currentElementName = reader.Name;
// currentElementName = "item"
}
}
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root "root.dtd">
<root>
<!-- comment -->
<?insert-toc?>
<item/>
</root>

Scripting API | File Methods | XMLReader Methods

moveToContent
moveToContent() : XMLNodeType

Moves the reading position to the next content node in the given stream. The content node
is one of the following node types: Text, CData, Element, EndElement, EntityReference or En-
dEntity.

File.XMLReader reader;
String currentElementName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);

1916
 17.3 General Content Model

reader.initInputStream(xmlStream, "UTF-8", false);

reader.moveToContent();
currentElementName = reader.Name;
// currentElementName = "root"
reader.readStartElement();
reader.moveToContent();
currentElementName = reader.Name;
// currentElementName = "item"
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root "root.dtd">
<root>
<!-- comment -->
<?insert-toc?>
<item>
<subitem>Hello World!<subitem>
</item>
</root>

Scripting API | File Methods | XMLReader Methods

Name
Name : String
getName() : String

Returns the name of the current node, if applicable.

File.XMLReader reader;
String currentElementName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.read();
currentElementName = reader.Name;
// currentElementName = "";
reader.read();
currentElementName = reader.Name;
// currentElementName = "root";
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root/>

Scripting API | File Methods | XMLReader Methods

NodeType
NodeType : XMLNodeType
getNodeType() : XMLNodeType

1917
17 Scripting

Returns the node type of the given node.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
while(reader.read()) {
is(reader.NodeType) {
File.XMLNodeType.Element: {
logMessage("Element: " + reader.Name);
}
File.XMLNodeType.XMLDeclaration: {
logMessage("XML declaration: " + reader.Value);
}
}
}
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root "root.dtd">
<root>
<!-- comment -->
<?insert-toc?>
<item/>
</root>

Scripting API | File Methods | XMLReader Methods

read
read() : Bool

Returns the Boolean value true if reading of the next node from the given stream has finished
successfully.

File.XMLReader reader;
Bool containsPI = false;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
while(reader.read()) {
if (reader.NodeType == File.XMLNodeType.ProcessingInstruction) {
containsPI = true;
}
}
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root "root.dtd">
<root>
<!-- comment -->
<?insert-toc?>
<item/>
</root>

1918
 17.3 General Content Model

Scripting API | File Methods | XMLReader Methods

readElementString
readElementString() : String

Returns a text value of the current text-only element. For reading the text values from a mixed
content, use the readString method instead.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
reader.readStartElement();
reader.moveToContent();
String itemContent = reader.readElementString();
// itemContent = "Hello World!"
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root>
<item>Hello World!</item>
</root>

Scripting API | File Methods | XMLReader Methods

readEndElement
readEndElement() : Void

If the current content node is an end element, it moves the reading position in the given stream
to the next node.

File.XMLReader reader;
String currentElementName;
String personName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
currentElementName = reader.Name;
// currentElementName = "person"
reader.readStartElement();
currentElementName = reader.Name;
// currentElementName = "name"
personName = reader.readElementString();
reader.readEndElement();
currentElementName = reader.Name;
// currentElementName = "surname"
personName += " " + reader.readElementString();
// personName = "John Doe"
reader.readEndElement();
xmlStream.close();

1919
17 Scripting

<?xml version="1.0" encoding="UTF-8"?>

<person>
<name>John</name>
<surname>Doe</surname>
</person>

Scripting API | File Methods | XMLReader Methods

readInnerXML
readInnerXML() : String

Returns the content, including markup, representing all children of the current node.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String innerElementContent = reader.readInnerXML();
xmlStream.close();

Scripting API | File Methods | XMLReader Methods

readOuterXML
readOuterXML() : String

Returns the content, including markup, representing the current node and all its children.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
String outerElementContent = reader.readOuterXML();
xmlStream.close();

Scripting API | File Methods | XMLReader Methods

readStartElement
readStartElement() : Void

If the current content node is a start element, it moves the reading position in the given stream
to the next node.

File.XMLReader reader;
String currentElementName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);

1920
 17.3 General Content Model

reader.initInputStream(xmlStream, "UTF-8", false);

reader.moveToContent();
currentElementName = reader.Name;
// currentElementName = "person"
reader.readStartElement();
currentElementName = reader.Name;
// currentElementName = "name"
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<person>
<name>John</name>
<surname>Doe</surname>
</person>

Scripting API | File Methods | XMLReader Methods

readString
readString() : String

Returns the content of an element or text node.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
reader.readStartElement();
reader.moveToContent();
String itemContent = reader.readString());
// itemContent = "Hello"
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root>
<item>Hello <emphasis>World!</emphasis></item>
</root>

Scripting API | File Methods | XMLReader Methods

skip
skip() : Void

Skips the children of the current node.

In the following XML input, if the reader is positioned on the <a> node or any of its attributes,
calling skip positions the reader to the <b> node.

1921
17 Scripting

If the reader is positioned on a leaf node already (such as the <x> node or the text node abc),
calling skip is the same as calling read.

<a name="John" surname="Doe">

<x/>abc<y/>
</a>
<b>...</b>

File.XMLReader reader;
String currentElementName;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.moveToContent();
reader.read();
reader.skip(); // skip the first message element
String currentMessage = reader.readString();
// currentMessage = " "
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<messages>
<message lang="en">Hello World!</message>
<message lang="gr"> </message>
</messages>

Scripting API | File Methods | XMLReader Methods

Value
Value : String
getValue() : String

Returns the value of the current node, if applicable.

File.XMLReader reader;
File.Stream xmlStream = File.open("C:\input.xml", File.Mode.ReadOnly);
reader.initInputStream(xmlStream, "UTF-8", false);
reader.read();
String xmlPrologContent = reader.Value;
// xmlPrologContent = 'version="1.0" encoding="UTF-8"?'
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root/>

XMLWriter Methods
XMLWriter methods can be used for writing the content to a XML file.

1922
 17.3 General Content Model

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | File Methods | XMLWriter Methods

addAttribute
addAttribute(String aP1, String aP2) : Void

Adds an attribute with the corresponding value to the current element.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
xmlWriter.beginElement("root");
xmlWriter.addAttribute("id", "id_001");
xmlWriter.endElement();
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root id="id_001"/>

Scripting API | File Methods | XMLWriter Methods

addPCData
addPCData(String aP1) : Void

Adds a text content to the current element.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
xmlWriter.beginElement("root");
xmlWriter.addPCData("<message>Hello World!</message>");
xmlWriter.endElement();
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root>&lt;message&gt;Hello World!&lt;/message&gt;</root>

Scripting API | File Methods | XMLWriter Methods

addXMLFragment
addXMLFragment(String aP1) : Void

1923
17 Scripting

Adds a fragment of XML code. It is the only method for inserting document type, comments
or processing instructions.

Warning The XMLWriter does not validate the data that is passed to the addXMLFragment
method. You should not pass arbitrary data to this method.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
// insert document type
xmlWriter.addXMLFragment("<!DOCTYPE root SYSTEM 'root.dtd'>");
// insert root element
xmlWriter.beginElement("root");
// insert comment
xmlWriter.addXMLFragment("<!-- welcome message -->");
// insert processing instruction
xmlWriter.addXMLFragment("<?font color='blue'?>");
// insert complete child element
xmlWriter.addXMLFragment("<message>Hello World!</message>");
// insert closing tag of the root element
xmlWriter.endElement();
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE root SYSTEM 'root.dtd'>
<root>
<!-- welcome message -->
<?font color='blue'?>
<message>Hello World!</message>
</root>

Scripting API | File Methods | XMLWriter Methods

beginElement
beginElement(String aP1) : Void
beginElement(String aP1, Bool PreserveSpaces) : Void

Adds an opening tag of the element aP1 to the given stream. If the Boolean value of the
parameter PreserveSpaces is set to true, an attribute xml:space with value set to preserve is
added.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
xmlWriter.beginElement("root", true);
xmlWriter.endElement();
xmlStream.close();

1924
 17.3 General Content Model

<?xml version="1.0" encoding="UTF-8"?>

<root xml:space="preserve"/>

Scripting API | File Methods | XMLWriter Methods

endElement
endElement() : Void

Adds a closing tag of the current element to the given stream.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
xmlWriter.beginElement("root");
xmlWriter.beginElement("rule");
xmlWriter.endElement();
xmlWriter.addPCData("Hello world!");
xmlWriter.endElement();
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root><rule/>Hello World!</root>

Scripting API | File Methods | XMLWriter Methods

initStream
initStream(Stream aP1, string Codec) : Void

Assigns a stream encoded with a specified codec to the given XMLWriter. The parameter Codec
is either a valid text encoding or a path to a custom codec.

File.Stream xmlStream;
File.XMLWriter xmlWriter;
xmlStream = File.open("c:\output.xml", File.Mode.TruncateOrCreate);
xmlWriter.initStream(xmlStream, "UTF-8");
xmlWriter.addXMLFragment("<root id='id_001'/>");
xmlStream.close();

<?xml version="1.0" encoding="UTF-8"?>

<root id='id_001'/>

1925
17 Scripting

Scripting API | File Methods | XMLWriter Methods

initStringOutput
initStringOutput() : Void

Initializes the given XMLWriter in a way that it serializes all the output into string.

File.XMLWriter xmlWriter;
xmlWriter.initStringOutput();
xmlWriter.beginElement("root", true);
xmlWriter.endElement();
String writerContent = xmlWriter.StringOutput;
// writerContent = "<root/>"

Scripting API | File Methods | XMLWriter Methods

StringOutput
StringOutput() : String
getStringOutput() : String

Returns a string output of the given XMLWriter, if that XMLWriter was initialized using the
initStringOutput method. Otherwise an error is shown when processing.

File.XMLWriter xmlWriter;
xmlWriter.initStringOutput();
xmlWriter.addXMLFragment("<root id='id_001'/>");
String writerContent = xmlWriter.StringOutput;
// writerContent = "<root id='id_001'/>"

Char Methods
Char methods can be used for manipulation with characters.

Scripting API | Char Methods

assign
assign(Char aP1) : Void
assign(Int aP1) : Void

Assigns the specified value to the char variable. The same result can be achieved using the
equal sign =.

String message = "Hello World!";

Char character;
character.assign(message[0]);
// character = "H"

1926
 17.3 General Content Model

character.assign(64);
// character = "@"

Scripting API | Char Methods

equal
equal(Char aP1) : Bool

Returns the Boolean value true when the specified value equals to the given char variable. The
same result can be achieved using the equality operator ==.

String message = "***Hello World!";

while (message[0].equal("*")) {
message.remove(0, 1);
}
// message = "Hello World!"

Scripting API | Char Methods

less
less(Char aP1) : Bool

Returns the Boolean value true when the Unicode code point of the given char variable is lower
than the Unicode code point of the specified value. The same result can be achieved using the
less than operator <.

Char A = "A";
Char a = "a";
Bool isLess = A.less(a);
// isLess = true (65 < 97)

Scripting API | Char Methods

toInt
toInt() : Int

Returns an integer that represents an Unicode code point of the given char variable.

Char one = "1";

Int oneInUnicode = one.toInt();
// oneInUnicode = 49

1927
17 Scripting

Scripting API | Char Methods

toString
toString() : String

Returns a string that represents the given char variable.

Char character = 128;

String strCharacter = character.toString();
// strCharacter = ""

Int Methods
Int methods can be used for manipulation with integer variables.

Scripting API | Int Methods

assign
assign(Int aP1) : Void

Assigns the specified value to the given integer variable. The same result can be achieved using
the equal sign =.

Int currentYear;
currentYear.assign(DateTime.Now.Year);

Scripting API | Int Methods

binaryAnd
binaryAnd(Int aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical AND operation on each pair of the corresponding bits.

In each pair, the result is 1 if the first bit is 1 and the second bit is 1.

Int number = 25; // 11001

number.binaryAnd(13); // 01101
// number = 9 // 01001

1928
 17.3 General Content Model

Scripting API | Int Methods

binaryNot
binaryNot() : Int

Takes the binary representation of the given number and performs logical negation on each
bit.

Digits which were 0 become 1, and vice versa.

Int number = 25; // 0...11001 (32 bits)

number = number.binaryNot(); // 1...00110 = -11010
// number = -26 // -11010

Scripting API | Int Methods

binaryOr
binaryOr(Int aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical OR operation on each pair of the corresponding bits.

In each pair, the result is 1 if the first bit is 1 or the second bit is 1 or both bits are 1, and oth-
erwise the result is 0.

Int number = 25; // 11001

number.binaryOr(13); // 01101
// number = 29 // 11101

Scripting API | Int Methods

binaryXor
binaryXor(Int aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical XOR operation on each pair of the corresponding bits.

The result in each position is 1 if the two bits are different, and 0 if they are the same.

Int number = 25; // 11001

number.binaryXor(13); // 01101
// number = 20 // 10100

1929
17 Scripting

Scripting API | Int Methods

divide
divide(Int aP1) : Void

Divides the given number by the specified value.

If the zero value is specified, an error is shown when processing.

Int number = 30;

number.divide(20);
// number = 1;

Scripting API | Int Methods

equal
equal(Int aP1) : Bool

Returns the Boolean value true if the specified value equals to the given number. The same
result can be achieved using the equality operator ==.

Int day = DateTime.Now.DayOfWeek;

Bool isMonday = day.equal(1);

Scripting API | Int Methods

isEven
isEven() : Bool

Returns the Boolean value true if the given number is even.

Int number = 4;
Bool isNumberEven = number.isEven();
// isNumberEven = true

Scripting API | Int Methods

less
less(Int aP1) : Bool

Returns the Boolean value true if the given number is lower than the specified value. The same
result can be achieved using the less than operator <.

1930
 17.3 General Content Model

Int day = DateTime.Now.DayOfWeek;

Bool isSunday = day.less(1);

Scripting API | Int Methods

minus
minus() : Int
minus(Int aP1) : Void

Returns the negative value of the given number if no parameter is specified.

Subtracts the specified value from the given number.

Int number = 10;

number = number.minus();
// number = -10
number.minus(2);
// number = -12

Scripting API | Int Methods

multiply
multiply(Int aP1) : Void

Multiplies the given number by the specified value.

Int number = 3;
number.multiply(3);
// number = 9

Scripting API | Int Methods

plus
plus() : Int
plus(Int aP1) : Void

Returns the value of the given variable if no parameter is specified.

Adds the specified value to the given number.

Int number = 3;
number.plus(5);
// number = 8

1931
17 Scripting

Scripting API | Int Methods

remainder
remainder(Int aP1) : Void

Updates the given variable with the remainder on division of the given number by the specified
value.

Int number = 26;

number.remainder(8);
// number = 2

Scripting API | Int Methods

toCurrency
toCurrency() : Currency

Returns a currency representation of the given number.

Int number = 26;

Currency price = number.toCurrency();
// price = 26.0000

Scripting API | Int Methods

toDouble
toDouble() : Double

Returns a double-precision floating-point representation of the given number.

Int number = 26;

Double price = number.toDouble();
// price = 26

Scripting API | Int Methods

toInt64
toInt64() : Int64

Returns a 64-bit integer representation of the given number.

Int number32 = 26;

Int64 number64 = number32.toInt64();
// number64 = 26

1932
 17.3 General Content Model

Scripting API | Int Methods

toSpell
toSpell(String aP1) : String

Returns a lexical representation of the given integer value in the language specified by the
corresponding language code.

Int number = 150;

String valueInWords = number.toSpell("en");
// valueInWords = "one hundred and fifty"

Scripting API | Int Methods

toString
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) : String

Returns a string of the specified length that represents the given number and sets all the empty
positions to the zero value when the specified aZeroFill parameter is set to the Boolean value
true.

Optionally converts the given number according to the specified base of the numeral system,
truncates the resulting string if its length is greater than the specified length, aligns all the
characters to the left or converts all alphabetic characters to their upper case equivalents.

Int number = 1234567;

String strNumber = number.toString(10, true);
// strNumber = "0001234567"

Int number = 5;
String strNumber = number.toString(5, true, 2);
// strNumber = "00101"
// binary representation of number 5

Int number = 5;
String strNumber = number.toString(5, true, 2, true);
// strNumber = "101"
// truncated binary representation of number 5

Int number = 5;
String strNumber = number.toString(5, false, 2, true, true);
// strNumber = "101 "
// truncated and left justified binary representation of number 5

Int number = 1550;

String strNumber = number.toString(5, false, 16, true, true, true);

1933
17 Scripting

// strNumber = "60E "

// hexadecimal representation with upper case characters

Int number = 1550;

String strNumber = number.toString(5, false, 16, true, true, false);
// strNumber = "60e "
// hexadecimal representation with lower case characters

Int64 Methods
Int64 methods can be used for manipulation with 64-bit integer variables.

Scripting API | Int64 Methods

assign
assign(Int aP1) : Void
assign(Int64 aP1) : Void

Assigns the specified value to the given int64 variable. The same result can be achieved using
the equal sign =.

Int64 currentYear;
currentYear.assign(DateTime.Now.Year);

Scripting API | Int64 Methods

binaryAnd
binaryAnd(Int64 aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical AND operation on each pair of the corresponding bits.

In each pair, the result is 1 if the first bit is 1 and the second bit is 1.

Int64 number = 25; // 11001

number.binaryAnd(13); // 01101
// number = 9 // 01001

Scripting API | Int64 Methods

binaryNot
binaryNot() : Int64

1934
 17.3 General Content Model

Takes the binary representation of the given number and performs logical negation on each
bit.

Digits which were 0 become 1, and vice versa.

Int64 number = 25; // 0...11001 (64 bits)

number = number.binaryNot(); // 1...00110 = -11010
// number = -26 // -11010

Scripting API | Int64 Methods

binaryOr
binaryOr(Int aP1) : Void
binaryOr(Int64 aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical OR operation on each pair of the corresponding bits.

In each pair, the result is 1 if the first bit is 1 or the second bit is 1 or both bits are 1, and oth-
erwise the result is 0.

Int64 number = 25; // 11001

number.binaryOr(13); // 01101
// number = 29 // 11101

Scripting API | Int64 Methods

binaryXor
binaryXor(Int aP1) : Void
binaryXor(Int64 aP1) : Void

Takes binary representations of the given number and the specified value and performs the
logical XOR operation on each pair of the corresponding bits.

The result in each position is 1 if the two bits are different, and 0 if they are the same.

Int64 number = 25; // 11001

number.binaryXor(13); // 01101
// number = 20 // 10100

Scripting API | Int64 Methods

divide
divide(Int aP1) : Void
divide(Int64 aP1) : Void

1935
17 Scripting

Divides the given number by the specified value.

If the zero value is specified, an error is shown when processing.

Int64 number = 30;

number.divide(20);
// number = 1;

Scripting API | Int64 Methods

equal
equal(Int64 aP1) : Bool

Returns the Boolean value true if the specified value equals to the given number. The same
result can be achieved using the equality operator ==.

Int64 day = DateTime.Now.DayOfWeek;

Bool isMonday = day.equal(1);

Scripting API | Int64 Methods

isEven
isEven() : Bool

Returns the Boolean value true if the given number is even.

Int64 number = 4;
Bool isNumberEven = number.isEven();
// isNumberEven = true

Scripting API | Int64 Methods

less
less(Int64 aP1) : Bool

Returns the Boolean value true if the given number is lower than the specified value. The same
result can be achieved using the less than operator <.

Int64 day = DateTime.Now.DayOfWeek;

Bool isSunday = day.less(1);

1936
 17.3 General Content Model

Scripting API | Int64 Methods

minus
minus() : Int64
minus(Int aP1) : Void
minus(Int64 aP1) : Void

Returns the negative value of the given number if no parameter is specified.

Subtracts the specified value from the given number.

Int64 number = 10;

number = number.minus();
// number = -10
number.minus(2);
// number = -12

Scripting API | Int64 Methods

multiply
multiply(Int aP1) : Void
multiply(Int64 aP1) : Void

Multiplies the given number by the specified value.

Int64 number = 3;
number.multiply(3);
// number = 9

Scripting API | Int64 Methods

plus
plus() : Int64
plus(Int aP1) : Void
plus(Int64 aP1) : Void

Returns the value of the given variable if no parameter is specified.

Adds the specified value to the given number.

Int64 number = 3;
number.plus(5);
// number = 8

1937
17 Scripting

Scripting API | Int64 Methods

remainder
remainder(Int aP1) : Void
remainder(Int64 aP1) : Void

Updates the given variable with the remainder on division of the given number by the specified
value.

Int64 number = 26;

number.remainder(8);
// number = 2

Scripting API | Int64 Methods

toCurrency
toCurrency() : Currency

Returns a currency representation of the given number.

Int64 number = 26;

Currency price = number.toCurrency();
// price = 26.0000

Scripting API | Int64 Methods

toDouble
toDouble() : Double

Returns a double-precision floating-point representation of the given number.

Int64 number = 26;

Double price = number.toDouble();
// price = 26

Scripting API | Int64 Methods

toInt
toInt() : Int

Returns a 32-bit integer representation of the given number.

Int64 number64 = 26;

Int number32 = number64.toInt();

1938
 17.3 General Content Model

// number32 = 26
number64 = 0x7FFFFFFFFFFFFFFF;
number32 = number64.toInt();
// number32 = -1 (out of the range)

Scripting API | Int64 Methods

toSpell
toSpell(String aP1) : String

Returns a lexical representation of the given 64-bit integer value in the language specified by
the corresponding language code.

Int64 number = 150;

String valueInWords = number.toSpell("en");
// valueInWords = "one hundred and fifty"

Scripting API | Int64 Methods

toString
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) : String

Returns a string of the specified length that represents the given number and sets all the empty
positions to the zero value if the specified aZeroFill parameter is set to the Boolean value true.

Optionally converts the given number according to the specified base of the numeral system,
truncates the resulting string if its length is greater than the specified length, aligns all the
characters to the left or converts all alphabetic characters to their upper case equivalents.

Int64 number = 1234567;

String strNumber = number.toString(10, true);
// strNumber = "0001234567"

Int64 number = 5;
String strNumber = number.toString(5, true, 2);
// strNumber = "00101"
// binary representation of number 5

Int64 number = 5;
String strNumber = number.toString(5, true, 2, true);
// strNumber = "101"
// truncated binary representation of number 5

1939
17 Scripting

Int64 number = 5;
String strNumber = number.toString(5, false, 2, true, true);
// strNumber = "101 "
// truncated and left justified binary representation of number 5

Int64 number = 1550;

String strNumber = number.toString(5, false, 16, true, true, true);
// strNumber = "60E "
// hexadecimal representation with upper case characters

Int64 number = 1550;

String strNumber = number.toString(5, false, 16, true, true, false);
// strNumber = "60e "
// hexadecimal representation with lower case characters

Scripting API

logError
logError(String aString) : Void

Writes the specified error message to the application log and terminates the script execution.

if (not File.exist("C:\input.txt")) {
logError("The specified file could not be found.");
}

Scripting API

logMessage
logMessage(String aString) : Void

Writes the specified information message to the application log.

String strCities = "Tokyo|Seoul|Mexico City";

Util.StringList cities;
strCities.parseLine("|", "", cities);
logMessage("Total number of parsed cities: " + cities.Size.toString());

Scripting API

logWarning
logWarning(String aString) : Void

Writes the specified warning message to the application log.

1940
 17.3 General Content Model

String strPrice = "$300";

Double price;
Int currentPosition = 0;
if (strPrice.parseDouble(currentPosition, price) != 0) {
logWarning("The specified value could not be parsed. The value of zero
will be used instead.");
}

Math Methods
Math methods can be used for mathematical computation.

Note Note: If you do not see the get methods during scripting in Inspire Designer, it is because
the option Show getters in Workflow Options Dialog is not checked.

Scripting API | Math Methods

abs
abs(Double aP1) : Double
abs(Int aP1) : Int

Returns the absolute value of the given value.

Double number = Math.abs(-10.2);

// number = 10.2

Scripting API | Math Methods

acos
acos(Double aP1) : Double

Returns the inverse cosine of the specified value, expressed in radians.

If the specified value is out of the valid interval between -1 and 1, an error is shown when
processing.

Double angle = Math.acos(-1);

// angle 3.142 (+ )

Scripting API | Math Methods

asin
asin(Double aP1) : Double

1941
17 Scripting

Returns the inverse sine of the specified value, expressed in radians.

If the specified value is out of the valid interval between -1 and 1, an error is shown when
processing.

Double angle = Math.asin(-1);

// angle -1.571 (- / 2)

Scripting API | Math Methods

atan
atan(Double aP1) : Double

Returns the inverse tangent of the specified value, expressed in radians.

Double angle = Math.atan(1 / Math.sqrt(3));

// angle 0.524 (+ / 6)

Scripting API | Math Methods

atan2
atan2(Double aP1, Double aP2) : Double

Returns the inverse tangent of the specified y-axis and x-axis coordinates, expressed in radians
in the interval between - and +.

It takes into account the signs of both vector components, and places the angle in the correct
quadrant.

Double angle;
angle = Math.atan2(2, 0); // angle 1.571 (+ / 2)
angle = Math.atan2(3, 3); // angle 0.785 (+ / 4)
angle = Math.atan2(0, 3); // angle = 0
angle = Math.atan2(-5, 5); // angle -0.785 (- / 4)
angle = Math.atan2(0, 0); // angle = 0

Scripting API | Math Methods

ceil
ceil(Double aP1) : Double

Returns a real number that represents the next largest integer of the specified real number.

Double number;
number = Math.ceil(-5.9); // number = -5

1942
 17.3 General Content Model

number = Math.ceil(-5); // number = -5

number = Math.ceil(5); // number = 5
number = Math.ceil(0); // number = 0
number = Math.ceil(0.2); // number = 1

Scripting API | Math Methods

cos
cos(Double aP1) : Double

Returns the cosine of the specified angle.

Double number;
number = Math.cos(-2 * Math.PI); // number = 1
number = Math.cos(-Math.PI); // number = -1
number = Math.cos(0); // number = 1
number = Math.cos(Math.PI / 2); // number = 0

Scripting API | Math Methods

E
E : Double
getE() : Double

Returns the base of the natural logarithm.

Double e = Math.E;
// e 2.718

Scripting API | Math Methods

exp
exp(Double aP1) : Double

Returns e (the base of natural logarithm) raised to the specified power.

Double number;
number = Math.exp(0); // number = 1
number = Math.exp(-1); // number 0.368
number = Math.exp(1); // number 2.718 (e)
number = Math.exp(2); // number = 7.389

1943
17 Scripting

Scripting API | Math Methods

floor
floor(Double aP1) : Double

Returns a real number that represents the next smallest integer of the specified real number.

Double number;
number = Math.floor(-5.9); // number = -6
number = Math.floor(-5); // number = -5
number = Math.floor(5); // number = 5
number = Math.floor(0); // number = 0
number = Math.floor(0.8); // number = 0

Scripting API | Math Methods

fromin
fromin(Double aP1) : Double

Returns a real number that represents the specified value converted from inches to meters.

Double result = Math.fromin(1); // result = 0.0254

Scripting API | Math Methods

frommm
frommm(Double aP1) : Double

Returns a real number that represents the specified value converted from millimeters to meters.

Double result = Math.frommm(1000); // result = 1

Scripting API | Math Methods

frompt
frompt(Double aP1) : Double

Returns a real number that represents the specified value converted from typographical points
to meters.

Double result = Math.frompt(72); // result = 0.0254 (72 pt = 1 inch)

1944
 17.3 General Content Model

Scripting API | Math Methods

log
log(Double aP1) : Double

Returns the natural logarithm of the specified number.

If the specified number is less than or equal to the zero value, an error is shown when processing.

Double result;
result = Math.log(0.1); // result -2.30
result = Math.log(1); // result = 0
result = Math.exp(Math.E); // result = 1

Double meanLifetime = 200;

Double halfLife = meanLifetime * Math.log(2);
// halfLife 138.629

Scripting API | Math Methods

max
max(Double aP1, Double aP2) : Double
max(Int aP1, Int aP2) : Int

Returns the greater of two values.

Double maxValue = Math.max(-5, 3); // maxValue = 3

Scripting API | Math Methods

min
min(Double aP1, Double aP2) : Double
min(Int aP1, Int aP2) : Int

Returns the smaller of two values.

Double minValue = Math.min(-5, 3); // minValue = -5

Scripting API | Math Methods

PI
PI : Double
getPI() : Double

1945
17 Scripting

Returns the mathematical constant whose value is the ratio of a circle's circumference to its
diameter.

Double diameter = 10;

Double area = Math.PI * Math.pow(diameter, 2) / 4;
// area 78.540

Scripting API | Math Methods

pow
pow(Double aP1, Double aP2) : Double

Returns the value of the first argument raised to the power of the second argument.

Double result = Math.pow(2, 3); // result = 8

Scripting API | Math Methods

random
random() : Double

Returns a random real number less than 1 but greater than or equal to 0.

Double randomDiceValue = Math.floor(6 * Math.random()) + 1;

Scripting API | Math Methods

round
round (Double aP1) : Double
round (Double aP1, Int aNrOfDecimalPlaces) : Double

Returns a rounded variant of the specified number, optionally rounded to the specified number
of decimal places.

Double result;
result = Math.round(1.2); // result = 1
result = Math.round(1.5); // result = 2
result = Math.round(-1.5); // result = -2
result = Math.round(-1.2); // result = -1
result = Math.round(Math.PI, 3); // result = 3.142

1946
 17.3 General Content Model

Scripting API | Math Methods

sin
sin(Double aP1) : Double

Returns the sine of the specified angle.

Double result;
result = Math.sin(-Math.PI); // result 0
result = Math.sin(0); // result = 0
result = Math.sin(Math.PI/2); // result = 1

Scripting API | Math Methods

sqrt
sqrt(Double aP1) : Double

Returns the square root of the specified number.

Double result = Math.sqrt(9); // result = 3

Scripting API | Math Methods

tan
tan(Double aP1) : Double

Returns the tangent of the specified angle.

Double result;
result = Math.tan(-Math.PI / 4); // result = -1
result = Math.tan(Math.toRadians(30)); // result 0.577

Scripting API | Math Methods

toDegrees
toDegrees(Double aP1) : Double

Returns a real number that represents the specified value converted from radians to degrees.

Double result = Math.toDegrees(Math.PI); // result = 180

1947
17 Scripting

Scripting API | Math Methods

toin
toin(Double aP1) : Double

Returns a real number that represents the specified value converted from meters to inches.

Double result = Math.toin(0.0254); // result = 1

Scripting API | Math Methods

tomm
tomm(Double aP1) : Double

Returns a real number that represents the specified value converted from meters to millimeters.

Double result = Math.tomm(1); // result = 1000

Scripting API | Math Methods

topt
topt(Double aP1) : Double

Returns a real number that represents the specified value converted from meters to typograph-
ical points.

Double result = Math.topt(Math.fromin(1)); // result = 72

Scripting API | Math Methods

toRadians
toRadians(Double aP1) : Double

Returns a real number that represents the specified value converted from degrees to radians.

Double result = Math.toRadians(-90);

// result -1.571 (- / 2)

1948
 17.3 General Content Model

ODBC Methods
ODBC methods can be used for connecting to a database, determining available tables,
querying of the stored data and its manipulation.

Database Methods
Database methods can be used for connecting to a database, determining available tables and
executing queries over them.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | ODBC Methods | Database Methods

connect
connect(String aP1) : String

Returns a connection string if connecting to the given database using the specified connection
string has been finished successfully, otherwise returns an empty value.

The connection string is a set of attributes used to connecting to the database and depends
on the given ODBC driver. Details can be obtained from ODBC driver vendor.

Note There are connection string samples available on the internet, see for example
www.connectionstrings.com.

ODBC.Database db;
String connectionString = "Driver=SQL Server;" +
"Server=myServerAddress;" +
"Database=myDataBase;" +
"Trusted_Connection=True;";
logMessage(db.connect(connectionString));
db.disconnect();

Scripting API | ODBC Methods | Database Methods

createRecordSet
createRecordSet(String aP1) : RecordSet
createRecordSet(String aP1, DBVariantList & aP2) : RecordSet

Returns a recordset of the specified query to the given database.

If the query is parametrized, the second parameter refers to the list of parameter values. See
the section ODBC DBVariantList Methods.

The recordset is used to hold a set of records from a database table. It consists of records and
columns matching the given criteria.

1949
17 Scripting

ODBC.Database db;
ODBC.RecordSet recordset;
db.connect("Driver={Microsoft Text Driver (*.txt; *.csv)};DBQ=C:\");
recordset = db.createRecordSet("SELECT * FROM data.csv");
while(recordset.fetchNextRow())
{
logMessage(recordset.StringValue[0]);
}
db.disconnect();

If you want to close the recordset and read other data from a database table, you can use the
following example:

ODBC.Database db;
db.connect("connection string");
ODBC.RecordSet rs=db.createRecordSet("SELECT * FROM users"); //creating
a recordset
rs.fetchNextRow();
logMessage(rs.StringValue["Name"]);
rs=ODBC.RecordSet(); //this row is used for closing and a new select can
start (you are assigning a new recordset to rs)
rs=db.createRecordSet("SELECT * FROM groups");

Scripting API | ODBC Methods | Database Methods

disconnect
disconnect() : Void

Terminates the connection to the given database.

ODBC.Database db;
logMessage(db.connect("DSN=Excel Files;DBQ=C:\data.xls"));
db.disconnect();

Scripting API | ODBC Methods | Database Methods

Error
Error : String
getError() : String

Returns an error message.

ODBC.Database db;
db.connect("DSN=Excel Files;DBQ=C:\data.xls");
if (db.isError()) {
logError(db.Error);
}
db.disconnect();

1950
 17.3 General Content Model

Scripting API | ODBC Methods | Database Methods

execute
execute(String aP1) : Bool
execute(String aP1, DBVariantList & aP2) : Bool

Returns a Boolean value true if the specified command has been executed successfully.

If the command is parametrized, the second parameter refers to the list of parameter values.
See the section ODBC DBVariantList Methods.

ODBC.Database db;
db.connect("DSN=Excel Files;DBQ=C:\data.xls");
db.execute("CREATE TABLE names (name TEXT, surname TEXT)");
db.execute("INSERT INTO names (name, surname) VALUES ('John', 'Doe')");
db.disconnect();

Scripting API | ODBC Methods | Database Methods

isError
isError() : Bool

Returns a Boolean value true if an database related error has occurred when processing.

ODBC.Database db;
ODBC.RecordSet rsNames;
db.connect("DSN=Excel Files;DBQ=C:\data.xls");
if (not db.isError()) {
rsNames = db.createRecordSet("SELECT COUNT(*) FROM names");
rsNames.fetchNextRow();
Int64 itemCount = rsNames.getInt64Value(0);
}
db.disconnect();

Scripting API | ODBC Methods | Database Methods

readTablesInfo
readTablesInfo(StringList & aP1) : Void

Creates a list of table names of the given database.

ODBC.Database db;
ODBC.StringList sheetNames;
db.connect("DSN=Excel Files;DBQ=C:\data.xls");
db.readTablesInfo(sheetNames);
for(Int i;i<sheetNames.Size;i++) {
logMessage(sheetNames[i]);
}
db.disconnect();

1951
17 Scripting

ODBC DBVariant Methods

For general information about variants and variant lists see the section ODBC DBVariantList
Methods.

Note If you do not see the get method during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | ODBC Methods | DBVariant Methods

assign
assign(Binary aP1)
assign(Bool aP1) : Void
assign(DateTime aP1) : Void
assign(DBVariant aP1) : Void
assign(Double aP1) : Void
assign(Int aP1) : Void
assign(Int64 aP1) : Void
assign(String aP1) : Void

Assigns a DBVariant object to the the given variant variable. The same result can be achieved
using the equal sign =.

ODBC.DBVariant dbVariant;
dbVariant.assign("Hello World!");

Scripting API | ODBC Methods | DBVariant Methods

BinaryValue
BinaryValue : Binary
getBinaryValue() : Binary
setBinaryValue(Binary aP1) : Void

Returns or sets a binary value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.BinaryValue = Binary.fromBase64("SGVsbG8gV29ybGQh");

Scripting API | ODBC Methods | DBVariant Methods

BoolValue
BoolValue : Bool
getBoolValue() : Bool
setBoolValue(Bool aP1) : Void

Returns or sets a Boolean value of the given variant variable.

1952
 17.3 General Content Model

ODBC.DBVariant dbVariant;
dbVariant.BoolValue = true;

Scripting API | ODBC Methods | DBVariant Methods

DateTimeValue
DateTimeValue : DateTime
getDateTimeValue() : DateTime
setDateTimeValue(DateTime aP1) : Void

Returns or sets a date-time value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.DateTimeValue = DateTime.fromDate(1, 1, 2000);

Scripting API | ODBC Methods | DBVariant Methods

DoubleValue
DoubleValue : Double
getDoubleValue() : Double
setDoubleValue(Double aP1) : Void

Returns or sets a double value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.DoubleValue = 12.12345678;

Scripting API | ODBC Methods | DBVariant Methods

Int64Value
Int64Value : Int64
getInt64Value() : Int64
setInt64Value(Int64 aP1) : Void

Returns or sets a 64-bit integer value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.Int64Value = 1234;

1953
17 Scripting

Scripting API | ODBC Methods | DBVariant Methods

IntValue
IntValue : Int
getIntValue() : Int
setIntValue(Int aP1) : Void

Returns or sets an integer value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.IntValue = 1234;

Scripting API | ODBC Methods | DBVariant Methods

isNull
isNull : Bool

Returns the Boolean value true if the variant has the marker Null (used in SQL).

Scripting API | ODBC Methods | DBVariant Methods

StringValue
StringValue : String
getStringValue() : String
setStringValue(String aP1) : Void

Returns or sets a string value of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.StringValue = "Hello World!";

Scripting API | ODBC Methods | DBVariant Methods

Type
Type : TypeKeeper

Returns the data type of the given variant variable.

ODBC.DBVariant dbVariant;
dbVariant.assign(1234);
if (not (dbVariant.Type is Int)) logError("Value is not integer.");

1954
 17.3 General Content Model

DBVariantList Methods
Variants and variant lists are intended for creating parametrized SQL statements. This is a useful
feature for preventing SQL injection attacks. Variable values are not entered directly into the
SQL statement but are represented by a parameter which is defined elsewhere.

In the script, the SQL statement always remains the same and the user input comes via a variant
(which is a kind of variable). The variant is represented in the statement by a parameter, which
has the form of a question mark. These parameters are replaced by the values of variants from
a variant list in the order of occurrence the first parameter is replaced by the first variant, etc.

In the following piece of script there is a variant list (variants always have to be included in a
variant list) that contains two variants: viString and viInt. The SQL statement inserts values to
the columns named Name and Number. The first question mark in the statement is replaced
by the value of the viString variant and the second one by that of the viInt variant.

ODBC.DBVariantList varList;
varList.add(viString);
varList.add(viInt);
db.execute("insert into MyTable (Name, Number) values (?, ?)", varList);

Example This is an example of script that inserts values into a database using a para-
metrized SQL statement.
ODBC.DBVariant viInt;
viInt = Clients.OrderNum;
if (not (viInt.Type is Int)) logError("Value is not integer.");

ODBC.DBVariant viString;
viString = Clients.Names;
if (not (viString.Type is String)) logError("Value is not string.");

ODBC.Database db;
db.connect("OCI:UID=user;PWD=pass;SERVER=serv
er/orcl;PREFETCH_ROW_COUNT=50;");

db.execute("drop table MyTable");

if(db.isError())
logWarning(db.Error);
else
logMessage("drop table OK");

db.execute("create table MyTable (Name VARCHAR(50), Number INTEGER)");

if(db.isError())
logError(db.Error);
else
logMessage("create table OK");

ODBC.DBVariantList varList;
varList.add(viString);
varList.add(viInt);
db.execute("insert into MyTable (Name, Number) values (?, ?)", varList);
if(db.isError())
logError(db.Error);
else
logMessage("create table OK");
db.disconnect();

1955
17 Scripting

Parameters can also be used for reading data from a database. The part of the script de-
fining the SQL statement will then look as follows:
ODBC.RecordSet rs;
varList.clear();
varList.add(viString);
rs = db.createRecordSet("SELECT Name, Number FROM MyTable WHERE Name =
?", varList);
while (rs.fetchNextRow())
{
logMessage(rs.StringValue[0]);
logMessage(rs.DoubleValue[1].toString());
}

Scripting API | ODBC Methods | DBVariantList Methods

add
add(DBVariant aP1) : Void

Adds a variant list item to the given variant list.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariant;
dbVariant.IntValue = 1234;
dbVariantList.add(dbVariant);

Scripting API | ODBC Methods | DBVariantList Methods

assign
assign(DBVariantList aP1) : Void

Assigns a DBVariantList object to the the given list. The same result can be achieved using the
equal sign =.

ODBC.DBVariantList originalList, clonedList;

ODBC.DBVariant dbVariant;
dbVariant.StringValue = "Hello World!";
originalList.add(dbVariant);
clonedList.assign(originalList);

Scripting API | ODBC Methods | DBVariantList Methods

clear
clear() : Void

Removes all the list items from the given list.

1956
 17.3 General Content Model

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbEnglish, dbGreek;
dbEnglish.StringValue = "Hello World!";
dbGreek.StringValue = " ";
dbVariantList.add(dbEnglish);
dbVariantList.add(dbGreek);
stringList.clear();

Scripting API | ODBC Methods | DBVariantList Methods

get
get(Int aP1) : DBVariant

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbEnglish, dbGreek;
dbEnglish.StringValue = "Hello World!";
dbGreek.StringValue = " ";
dbVariantList.add(dbEnglish);
dbVariantList.add(dbGreek);
for (Int i=0;i<dbVariantList.Size;i++) {
logMessage(dbVariantList.get(i).StringValue);
// alternative syntax:
logMessage(dbVariantList[i].StringValue);
}

Scripting API | ODBC Methods | DBVariantList Methods

insert
insert(Int aP1, DBVariant aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariant;
dbVariant.StringValue = "Hello World!";
dbVariantList.add(dbVariant);
dbVariant.StringValue = " ";
dbVariantList.insert(0, dbVariant);

1957
17 Scripting

Scripting API | ODBC Methods | DBVariantList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariant;
dbVariant.IntValue = 1234;
dbVariantList.add(dbVariant);
dbVariantList.remove(0);

Scripting API | ODBC Methods | DBVariantList Methods

resize
resize(Int aP1, DBVariant aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariant;
dbVariant.IntValue = 1234;
dbVariantList.resize(3, dbVariant);

Scripting API | ODBC Methods | DBVariantList Methods

set
set(Int aP1, DBVariant aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariantDefault, dbVariant;
dbVariantDefault.StringValue = "";
dbVariantList.resize(1, dbVariantDefault);
dbVariant.StringValue = "Hello World!";
dbVariantList.set(0, dbVariant);
// alternative syntax:
dbVariantList[0] = dbVariant;

1958
 17.3 General Content Model

Scripting API | ODBC Methods | DBVariantList Methods

Size
Size : Int

Returns the total number of list items in the given list.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariantDefault, dbVariant;
dbVariantDefault.StringValue = "";
dbVariantList.resize(2, dbVariantDefault);
Int listSize = dbVariantList.Size;

Scripting API | ODBC Methods | DBVariantList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Number values are sorted in ascending order, while individual characters of the string are
compared using their Unicode code points.

ODBC.DBVariantList dbVariantList;
ODBC.DBVariant dbVariant;
dbVariant.StringValue = "b";
dbVariantList.add(dbVariant);
dbVariant.IntValue = 100;
dbVariantList.add(dbVariant);
dbVariant.StringValue = "a";
dbVariantList.add(dbVariant);
dbVariant.IntValue = 10;
dbVariantList.add(dbVariant);
dbVariantList.sort();
for (Int i=0;i<dbVariantList.Size;i++) {
logMessage(dbVariantList[i].StringValue);
// the final order will be 10, 100, "a", "b"
}

RecordSet Methods
RecordSet methods can be used for manipulation with data stored in the recordset. The recordset
is used to hold a set of records from a database table.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

1959
17 Scripting

Scripting API | ODBC Methods | RecordSet Methods

assign
assign(RecordSet aP1) : Void

Assigns a RecordSet object to the given recordset. The same result can be achieved using an
equal sign =.

ODBC.Database db;
ODBC.RecordSet recordset;
String connectionString = "Driver=SQL Server;" +
"Server=myServerAddress;" +
"Database=myDataBase;" +
"Trusted_Connection=True;";
db.connect(connectionString);
if (not db.isError()) {
recordset.assign(db.createRecordSet("SELECT * FROM myTable"));
}
else {
logError(db.Error);
}
db.disconnect();

Scripting API | ODBC Methods | RecordSet Methods

BinaryValue
BinaryValue[Int aP1] : Binary
BinaryValue[String aP1] : Binary
getBinaryValue(Int aP1) : Binary
getBinaryValue(String aP1) : Binary

Returns a binary value of the specified column (specified by index or by name) of the current
record in the given recordset.

ODBC.RecordSet recordset;
Util.BinaryList imageDataList;
recordset = db.createRecordSet("SELECT imageData FROM myTable");
while (recordset.fetchNextRow()) {
imageDataList.add(recordset.BinaryValue["imageData"]);
}

Scripting API | ODBC Methods | RecordSet Methods

BoolValue
BoolValue[Int aP1] : Bool
BoolValue[String aP1] : Bool
getBoolValue(Int aP1) : Bool
getBoolValue(String aP1) : Bool

1960
 17.3 General Content Model

Returns a Boolean value of the specified column (specified by index or by name) of the current
record in the given recordset.

ODBC.RecordSet recordset;
recordset = db.createRecordSet("SELECT isProcessed FROM myTable");
while (recordset.fetchNextRow()) {
if (not recordset.BoolValue[isProcessed]) {
// do something
}
}

Scripting API | ODBC Methods | RecordSet Methods

ColumnCount
ColumnCount : Int
getColumnCount() : Int

Returns the total number of columns in the given recordset.

ODBC.RecordSet recordset;
recordset = db.createRecordSet("SELECT * FROM myTable");
Int columnCount = recordset.ColumnCount;

Scripting API | ODBC Methods | RecordSet Methods

ColumnName
ColumnName[Int aP1] : String
getColumnName(Int aP1) : String

Returns a column name of the specified index in the given recordset.

ODBC.RecordSet recordset;
recordset = db.createRecordSet("SELECT * FROM myTable");
String firstColumnName = recordset.ColumnName[0];

Scripting API | ODBC Methods | RecordSet Methods

ColumnType
ColumnType[Int aP1] : TypeKeeper
getColumnType(Int aP1) : TypeKeeper

Returns a TypeKeeper value of the specified column index in the given recordset.

The TypeKeeper value can only be evaluated using 'is' operator.

1961
17 Scripting

ODBC.RecordSet recordset;
recordset = db.createRecordSet("SELECT * FROM myTable");
if (recordset.ColumnType[1] is String) {
// do something
}

Scripting API | ODBC Methods | RecordSet Methods

DateTimeValue
DateTimeValue[Int aP1] : DateTime
DateTimeValue[String aP1] : DateTime
getDateTimeValue(Int aP1) : DateTime
getDateTimeValue(String aP1) : DateTime

Returns a DateTime value of the specified column (specified by index or by name) of the current
record in the given recordset.

ODBC.RecordSet recordset;
Util.DateTimeList birthDateList;
recordset = db.createRecordSet("SELECT * FROM myTable");
while (recordset.fetchNextRow()) {
birthDateList.add(recordset.DateTimeValue[0]);
}

Scripting API | ODBC Methods | RecordSet Methods

DoubleValue
DoubleValue[Int aP1] : Double
DoubleValue[String aP1] : Double
getDoubleValue(Int aP1) : Double
getDoubleValue(String aP1) : Double

Returns a double value of the specified column (specified by index or by name) of the current
record in the given recordset.

ODBC.RecordSet recordset;
Double averageAge;
recordset = db.createRecordSet("SELECT AVG(age) FROM myTable");
if (recordset.fetchNextRow()) {
averageAge = recordset.DoubleValue[0];
}

Scripting API | ODBC Methods | RecordSet Methods

fetchNextRow
fetchNextRow() : Bool

1962
 17.3 General Content Model

Returns a Boolean value true if moving to the next record in the given recordset has been fin-
ished successfully.

ODBC.Database db;
ODBC.RecordSet recordset;
db.connect("Driver={Microsoft Text Driver (*.txt; *.csv)};DBQ=C:\");
recordset = db.createRecordSet("SELECT name, birthdate FROM data.csv");
/*
the following structure is filled in the code below:

PersonInfo : Array
|_ Name : String
|_ BirthDate : DateTime
*/
while (recordset.fetchNextRow()) {
PersonInfo.Name = recordset.StringValue[0];
PersonInfo.BirthDate = recordset.DateTimeValue[0];
PersonInfo.commit();
}
db.disconnect();

Scripting API | ODBC Methods | RecordSet Methods

Int64Value
Int64Value[Int aP1] : Int64
Int64Value[String aP1] : Int64
getInt64Value(Int aP1) : Double
getInt64Value(String aP1) : Double

Returns a 64-bit integer value of the specified column (specified by index or by name) of the
current record in the given recordset.

ODBC.RecordSet recordset;
Int64 fileSize;
recordset = db.createRecordSet("SELECT fileSize FROM myTable");
while (recordset.fetchNextRow()) {
fileSize = recordset.Int64Value[0];
}

Scripting API | ODBC Methods | RecordSet Methods

IntValue
IntValue[Int aP1] : Int
IntValue[String aP1] : Int
getIntValue(Int aP1) : Int
getIntValue(String aP1) : Int

Returns an integer value of the specified column (specified by index or by name) of the current
record in the given recordset.

1963
17 Scripting

ODBC.RecordSet recordset;
Int age;
recordset = db.createRecordSet("SELECT age FROM myTable");
while (recordset.fetchNextRow()) {
age = recordset.IntValue[0];
}

Scripting API | ODBC Methods | RecordSet Methods

isOpen
isOpen() : Bool

Returns a Boolean value true if the given recordset is open.

ODBC.Database db;
ODBC.RecordSet recordset;
db.connect("Driver={Microsoft Text Driver (*.txt; *.csv)};DBQ=C:\");
recordset = db.createRecordSet("SELECT * FROM notExisting.csv");
if (not recordset.isOpen()) {
logError(db.Error);
}
db.disconnect();

Scripting API | ODBC Methods | RecordSet Methods

StringValue
StringValue[Int aP1] : String
StringValue[String aP1] : String
getStringValue(Int aP1) : String
getStringValue(String aP1) : String

Returns a string value of the specified column (specified by index or by name) of the current
record in the given recordset.

ODBC.RecordSet recordset;
String fullName;
recordset = db.createRecordSet("SELECT name, surname FROM myTable");
while (recordset.fetchNextRow()) {
fullName = recordset.StringValue["name"] +
recordset.StringValue["surname"];
}

StringList Methods
StringList methods can be used for storing, manipulating and retrieving string values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

1964
 17.3 General Content Model

Scripting API | ODBC Methods | StringList Methods

add
add(String aP1) : Void

Adds a list item with the specified value to the given list.

ODBC.StringList stringList;
stringList.add("Hello World!");

Scripting API | ODBC Methods | StringList Methods

assign
assign(StringList aP1) : Void

Assigns a StringList object to the given list. The same result can be achieved using the equal
sign =.

ODBC.StringList originalList, clonedList;

originalList.add("Hello World!");
clonedList.assign(originalList);

Scripting API | ODBC Methods | StringList Methods

clear
clear() : Void

Removes all the list items from the given list.

ODBC.StringList stringList;
stringList.add("Hello World!");
stringList.add(" ");
stringList.clear();

Scripting API | ODBC Methods | StringList Methods

get
get(Int aP1) : String

Returns the value of the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

1965
17 Scripting

ODBC.StringList stringList;
stringList.add("Hello World!");
stringList.add(" ");
for (Int i=0;i<stringList.Size;i++) {
logMessage(stringList.get(i));
// alternative syntax:
logMessage(stringList[i]);
}

Scripting API | ODBC Methods | StringList Methods

insert
insert(Int aP1, String aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.StringList stringList;
stringList.add("Hello World!");
stringList.insert(0, " ");

Scripting API | ODBC Methods | StringList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.StringList stringList;
stringList.add("Hello World!");
stringList.remove(0);

Scripting API | ODBC Methods | StringList Methods

resize
resize(Int aP1, String aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

1966
 17.3 General Content Model

ODBC.StringList stringList;
stringList.add("Hello World!");
stringList.resize(3, "default value");

Scripting API | ODBC Methods | StringList Methods

set
set(Int aP1, String aP2) : Void

Sets the value of the list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

ODBC.StringList stringList;
stringList.resize(2, "");
stringList.set(0, "Hello World!");
// alternative syntax:
stringList[0] = "Hello World!";

Scripting API | ODBC Methods | StringList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

ODBC.StringList stringList;
stringList.resize(2, "");
Int listSize = stringList.Size;

Scripting API | ODBC Methods | StringList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Individual characters are compared using their Unicode code points.

ODBC.StringList stringList;
stringList.add("Tokyo");
stringList.add("Seoul");
stringList.add("Mexico City");
stringList.sort();

1967
17 Scripting

for (Int i=0;i<stringList.Size;i++) {

logMessage(stringList[i]);
}

Scripting API

pauseAfterCurrentSheet
pauseAfterCurrentSheet(String aString) : Void

Pauses the production and writes the specified message to the log.

Example If pausing of production on every 100th sheet is required, it can be accom-

plished using the new calculated Bool variable placed somewhere on the layout page.
The code is:
if (SYS.GlobalSheetCounter % 100 == 0)
{
pauseAfterCurrentSheet('Paused. Current sheet is #' + SYS.GlobalSheet
Counter.toString());
}

RRect Methods
RRect methods can be used for retrieving or setting the properties of rectangle objects.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in the Workflow Options Dialog is not checked.

Scripting API | RRect Methods

Area
Area : Double
getArea() : Double

Returns the area of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double area = rect.Area; // area = 5000

1968
 17.3 General Content Model

Scripting API | RRect Methods

assign
assign(Double aP1, Double aP2, Double aP3, Double aP4) : Void
assign(RRect aP1) : Void

Assigns either the specified x and y coordinates of the upper-left and bottom-right corners or
the specified RRect object to the given rectangle. The same result of the latter method can be
achieved using the equal sign =.

RRect originalRect, clonedRect;

originalRect.assign(0, 0, 100, 50);
clonedRect.assign(originalRect);

Scripting API | RRect Methods

Bottom
Bottom : Double
getBottom() : Double
setBottom(Double aP1) : Void

Returns or sets the y-coordinate that is the sum of the Top and Height values of the given
rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double bottom = rect.Bottom; // bottom = 50

Scripting API | RRect Methods

Center
Center : RVector
getCenter() : RVector
setCenter(RVector aP1) : Void

Returns or sets the coordinates of the center of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector center = rect.Center;
Double centerX = center.X; // centerX = 50
Double centerY = center.Y; // centerY = 25

1969
17 Scripting

Scripting API | RRect Methods

Dim
Dim : RVector
getDim() : RVector
setDim(RVector aP1) : Void

Returns or sets the size of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector size = rect.Dim;
Double sizeX = size.X; // sizeX = 100
Double sizeY = size.Y; // sizeY = 50

Scripting API | RRect Methods

equal
equal(RRect aP1) : Bool

Returns the Boolean value true if the specified rectangle equals to the given rectangle.

RRect rect_01, rect_02;

rect_01.assign(0, 0, 100, 50);
rect_02.assign(100, 50, 0, 0);
Bool isEqual = rect_01.equal(rect_02); // isEqual = false

Scripting API | RRect Methods

Height
Height : Double
getHeight() : Double
setHeight(Double aP1) : Void

Returns or sets the height of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double height = rect.Height; // height = 50

Scripting API | RRect Methods

include
include(RRect aP1) : Void
include(RVector aP1) : Void

1970
 17.3 General Content Model

Incorporates the specified point or rectangle to the given rectangle and if necessary, changes
the size of the original rectangle.

RRect rect_01, rect_02;

rect_01.assign(0, 0, 100, 50);
rect_02.assign(50, 50, 150, 100);
rect_01.include(rect_02);
RVector size = rect_01.Dim;
Double sizeX = size.X; // sizeX = 150
Double sizeY = size.Y; // sizeY = 100

Scripting API | RRect Methods

isEmpty
isEmpty() : Bool

Returns the Boolean value true if either the width or the height of the given rectangle has the
value of zero.

RRect rect;
rect.assign(0, 0, 100, 50);
rect.Bottom = 0;
Bool isEmpty = rect.isEmpty(); // isEmpty = true

Scripting API | RRect Methods

isInside
isInside(RRect aP1) : Bool
isInside(RVector aP1) : Bool

Returns the Boolean value true if the specified point or rectangle lies within the given rectangle.

RRect rect;
RVector point;
rect.assign(0, 0, 100, 50);
point.assign(50, 25);
Bool isPointInside = rect.isInside(point);
// isPointInside = true

Scripting API | RRect Methods

Left
Left : Double
getLeft() : Double
setLeft(Double aP1) : Void

Returns or sets the x-coordinate of the left edge of the given rectangle.

1971
17 Scripting

RRect rect;
rect.assign(0, 0, 100, 50);
Double left = rect.Left; // left = 0

Scripting API | RRect Methods

LowerLeft
LowerLeft : RVector
getLowerLeft() : RVector
setLowerLeft(RVector aP1) : Void

Returns or sets the coordinates of the bottom-left corner of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector bottomLeft = rect.LowerLeft;
Double bottomLeftX = bottomLeft.X; // bottomLeftX = 0
Double bottomLeftY = bottomLeft.Y; // bottomLeftY = 50

Scripting API | RRect Methods

LowerRight
LowerRight : RVector
getLowerRight() : RVector
setLowerRight(RVector aP1) : Void

Returns or sets the coordinates of the bottom-right corner of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector bottomRight = rect.LowerRight;
Double bottomRightX = bottomRight.X; // bottomRightX = 100
Double bottomRightY = bottomRight.Y; // bottomRightY = 50

Scripting API | RRect Methods

normalize
normalize() : Void

Resets the coordinates of the given rectangle so the upper-left corner has lower values than
the bottom-right corner.

RRect rect;
rect.assign(100, 50, 0, 0);
rect.normalize();

1972
 17.3 General Content Model

String coords = rect.toString();

// coords = "[[0,0],[100,50]]"

Scripting API | RRect Methods

Right
Right : Double
getRight() : Double
setRight(Double aP1) : Void

Returns or sets the x-coordinate that is the sum of the Left and Width values of the given
rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double right = rect.Right; // right = 100

Scripting API | RRect Methods

Top
Top : Double
getTop() : Double
setTop(Double aP1) : Void

Returns or sets the y-coordinate of the top edge of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double top = rect.Top; // top = 0

Scripting API | RRect Methods

toString
toString() : String

Returns a string that represents coordinates of the upper-left and bottom-right corner of the
given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
String coords = rect.toString();
// coords = "[[0,0],[100,50]]"

1973
17 Scripting

Scripting API | RRect Methods

transform
transform(Transformation aP1) : Void

Applies the specified transformation to the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Transformation scaleDown;
scaleDown.scale(0.5);
rect.transform(scaleDown);
String coords = rect.toString();
// coords = "[[0,0],[50,25]]"

Scripting API | RRect Methods

translate
translate(RVector aP1) : Void

Moves the given rectangle by the value of the specified vector. The same result can be achieved
using the += operator.

RRect rect;
RVector shift;
rect.assign(0, 0, 100, 50);
shift.assign(100, 50);
rect.translate(shift);
String coords = rect.toString();
// coords = "[[100,50],[200,100]]"

Scripting API | RRect Methods

UpperLeft
UpperLeft : RVector
getUpperLeft() : RVector
setUpperLeft(RVector aP1) : Void

Returns or sets the coordinates of the upper-left corner of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector upperLeft = rect.UpperLeft;
Double upperLeftX = upperLeft.X; // upperLeftX = 0
Double upperLeftY = upperLeft.Y; // upperLeftY = 0

1974
 17.3 General Content Model

Scripting API | RRect Methods

UpperRight
UpperRight : RVector
getUpperRight() : RVector
setUpperRight(RVector aP1) : Void

Returns or sets the coordinates of the upper-right corner of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
RVector upperRight = rect.UpperRight;
Double upperRightX = upperRight.X; // upperRightX = 100
Double upperRightY = upperRight.Y; // upperRightY = 0

Scripting API | RRect Methods

Width
Width : Double
getWidth() : Double
setWidth(Double aP1) : Void

Returns or sets the width of the given rectangle.

RRect rect;
rect.assign(0, 0, 100, 50);
Double width = rect.Width; // width = 100

String Methods
See also:
Scripting notes
Using substitute characters

A string represents a sequence of characters.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Methods that deal with surrogate pairs or processes characters in byte mode must be enabled
first using the option Suggest also byte mode and surrogate functions in Workflow Options
Dialog.

1975
17 Scripting

Scripting API | String Methods

append
append(String aString) : Void

Appends the specified string to the end of the given string. The same result can be achieved
using the addition operator +.

String message = "Hello";

message.append(" World!");
// message = "Hello World!"

Scripting API | String Methods

appendPath
appendPath(String aString) : String

Appends the specified path fragment to the end of the given string that represents a path.

String inputPath = "C:\Temp\input.txt";

String outputPath = inputPath.Directory.appendPath("output.txt");
// outputPath = "C:/Temp/output.txt"

Scripting API | String Methods

assign
assign(String aString) : Void

Assigns the specified string to the given string. The same result can be achieved using the equal
sign =.

String message;
message.assign("Hello World!");
// message = "Hello world!";

Scripting API | String Methods

beginWith
beginWith(String aString) : Bool

Returns the Boolean value true if the given string begins with the specified string. This function
is case-sensitive.

1976
 17.3 General Content Model

String message = "hello world!";

Bool beginsWithHello = message.beginWith("Hello");
// beginsWithHello = false

Scripting API | String Methods

beginWithCaseInsensitive
beginWithCaseInsensitive(String aString) : Bool

Returns the Boolean value true if the given string begins with the specified string. This function
is case-insensitive.

String message = "hello world!";

Bool beginsWithHello = message.beginWithCaseInsensitive("Hello");
// beginsWithHello = true

Scripting API | String Methods

compare
compare(String aString) : Int

Returns the value of zero when compared strings are equivalent.

Returns the difference of the Unicode code points at the first position where characters do not
match.

This function is case-sensitive.

String message = "Hello World!";

Int difference = message.compare("Hello World!");
// difference = 0

String message = "Hello World!";

Int difference = message.compare("Hello WORLD!");
// difference = 32

String message = "Hello World!";

Int difference = ("Hello WORLD!").compare(message);
// difference = -32

Scripting API | String Methods

compareCaseInsensitive
compareCaseInsensitive(String aChar) : Int

Returns the value of zero when compared strings are equivalent.

1977
17 Scripting

Returns the difference of the Unicode code points at the first position where characters do not
match.

This function is case-insensitive.

String message = "Hello World!";

Int difference = message.compareCaseInsensitive("Hello WORLD!");
// difference = 0

String message = "Hello World!";

Int difference = message.compareCaseInsensitive("Hello Europe!");
// difference = 50

Scripting API | String Methods

contains
contains(String aString) : Bool
contains(Char aChar) : Bool

Returns the Boolean value true if the given string contains the specified string or character.
This function is case-sensitive.

String message = "hello world!";

Bool containsWorld = message.contains("World");
// containsWorld = false

Scripting API | String Methods

containsCaseInsensitive
containsCaseInsensitive(String aString) : Bool
containsCaseInsensitive(Char aChar) : Bool

Returns the Boolean value true if the given string contains the specified string or character.
This function is case-insensitive.

String message = "hello world!";

Bool containsWorld = message.containsCaseInsensitive("World");
// containsWorld = true

Scripting API | String Methods

convertIntelligentMailBarcode
convertIntelligentMailBarcode(String aString) : String

Returns a string that represents the four types of Intelligent Mail barcodes bars (T, D, A, H)
which corresponds to the specified input data.

1978
 17.3 General Content Model

The result string can be used in layout for drawing a barcode, typically using a font containing
just the four types of bars.

String inputData = "5078965412301236545613827399801";

String convertedData = String.convertIntelligentMailBarcode(inputData);
// convertedData = "DFADTDTDTTDADFDTTFFDADFTTDADTTADTDDDDTDDDADTTTFATFFFAD
FAATFFFTATD"

Scripting API | String Methods

countOccurrences
countOccurrences(Char aChar) : lnt
countOccurrences(String aString) : lnt

Returns the number of occurrences of the specified string or character in the given string. This
function is case-sensitive.

String message = "SINGLE ENVIRONMENT, all-in-one SOFTWARE";

Int countOfLowerCaseE = s.countOccurrences("e");
// countOfLowerCaseE = 1

String message = "SINGLE ENVIRONMENT, all-in-one SOFTWARE";

Int countOfLowerCaseIn = s.countOccurrences("in");
// countOfLowerCaseIn = 1

Scripting API | String Methods

countOccurrencesCaseInsensitive
countOccurrencesCaseInsensitive(Char aChar) : lnt
countOccurrencesCaseInsensitive(String aString) : lnt

Returns the number of occurrences of the specified string or character in the given string. This
function is case-insensitive.

String message = "SINGLE ENVIRONMENT, all-in-one SOFTWARE";

Int countOfLowerCaseE = s.countOccurrencesCaseInsensitive("e");
// countOfLowerCaseE = 5

String message = "SINGLE ENVIRONMENT, all-in-one SOFTWARE";

Int countOfLowerCaseIn = s.countOccurrencesCaseInsensitive("in");
// countOfLowerCaseIn = 2

Scripting API | String Methods

Directory
Directory : String
getDirectory() : String

1979
17 Scripting

Returns a string that represents the parent directory of the given path.

String inputPath = "C:\Temp\input.txt";

String inputDirectory = inputPath.Directory;
// inputDirectory = "C:/Temp"

Scripting API | String Methods

endWith
endWith(String aString) : Bool

Returns the Boolean value true if the given string ends with the specified string. This function
is case-sensitive.

String message = "hello world!";

Bool endsWithWorld = message.endWith("World!");
// endsWithWorld = false

Scripting API | String Methods

endWithCaseInsensitive
endWithCaseInsensitive(String aString) : Bool

Returns the Boolean value true if the given string ends with the specified string. This function
is case-insensitive.

String message = "hello world!";

Bool endsWithWorld = message.endWithCaseInsensitive("World!");
// endsWithWorld = true

Scripting API | String Methods

equal
equal(String aString) : Bool

Returns the Boolean value true if the given string equals to the specified string. The same result
can be achieved using the equality operator ==.

String message = "Hello World!";

Bool isEqual = message.equal("Hello World!");
// isEqual = true

1980
 17.3 General Content Model

Scripting API | String Methods

FileExt
FileExt : String
getFileExt() : String

Returns a string that represents the file extension of the given path.

String inputPath = "C:\Temp\input.txt";

String fileExtension = inputPath.FileExt;
// fileExtension = "txt"

Scripting API | String Methods

FileName
FileName : String
getFileName() : String

Returns a string that represents the base file name of the given path.

String inputPath = "C:\Temp\input.txt";

String baseName = inputPath.FileName;
// baseName = "input"

Scripting API | String Methods

FileNameExt
FileNameExt : String
getFileNameExt() : String

Returns a string that represents the complete file name of the given path.

String inputPath = "C:\Temp\input.txt";

String fileName = inputPath.FileNameExt;
// fileName = "input.txt"

Scripting API | String Methods

fill
fill(Char aChar) : Void
fill(Char aChar, Int aNewLength) : Void

Fills the given string with the specified character and optionally sets the new length of the
string.

1981
17 Scripting

String message = "Hello World!);

message.fill("*", 15);
// message = "***************"

Scripting API | String Methods

find
find(String aString) : Int
find(Char aChar) : Int
find(String aString, Int aIndex ) : Int
find(Char aChar, Int aIndex) : Int

Returns the position of the first occurrence of the specified character or string in the given
string, optionally starting from the specified position.

Returns -1 when the specified string or character could not be found.

This function is case-sensitive.

String message = "single environment, all-in-one software";

Int firstOccurrence = message.find("e");
// firstOccurrence = 5

String message = "single environment, all-in-one software";

Int firstOccurrence = message.find("in");
// firstOccurrence = 1

String message = "single environment, all-in-one software";

Int firstOccurrence = message.find("e", 10);
// firstOccurrence = 15

String message = "single environment, all-in-one software";

Int firstOccurrence = message.find("in", 10);
// firstOccurrence = 24

String message = "single environment, all-in-one software";

Int firstOccurrence = message.find("q");
// firstOccurrence = -1

Scripting API | String Methods

findS
findS(Char aChar) : Int
findS(Char aChar, Int aIndex) : Int
findS(String aString) : Int
findS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the find method which, however, if applied for these strings, would yield unex-
pected results.

1982
 17.3 General Content Model

Scripting API | String Methods

findBackwards
findBackwards(String aString) : Int
findBackwards(Char aChar) : Int
findBackwards(String aString, Int aIndex) : Int
findBackwards(Char aChar, Int aIndex ) : Int

Returns the position of the last occurrence of the specified character or string in the given
string, optionally starting in the reverse order from the specified position.

Returns -1 when the specified string or character could not be found.

This function is case-sensitive.

String message = "single environment, all-in-one software";

Int firstOccurrence = message.findBackwards("e");
// firstOccurrence = 38

String message = "single environment, all-in-one software";

Int firstOccurrence = message.findBackwards("in");
// firstOccurrence = 24

String message = "single environment, all-in-one software";

Int firstOccurrence = message.findBackwards("e", 10);
// firstOccurrence = 7

String message = "single environment, all-in-one software";

Int firstOccurrence = message.findBackwards("in", 10);
// firstOccurrence = 1

Scripting API | String Methods

findBackwardsCaseInsensitive
findBackwardsCaseInsensitive(String aString) : Int
findBackwardsCaseInsensitive(Char aChar) : Int
findBackwardsCaseInsensitive(String aString, Int aIndex) : Int
findBackwardsCaseInsensitive(Char aChar, Int aIndex) : Int

Returns the position of the last occurrence of the specified character or string in the given
string, optionally starting in the reverse order from the specified position.

Returns -1 when the specified string or character could not be found.

This function is case-insensitive.

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findBackwardsCaseInsensitive("E");
// firstOccurrence = 38

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findBackwardsCaseInsensitive("on");
// firstOccurrence = 27

1983
17 Scripting

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findBackwardsCaseInsensitive("e", 10);
// firstOccurrence = 7

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findBackwardsCaseInsensitive("On", 15);
// firstOccurrence = 12

Scripting API | String Methods

findBackwardsCaseInsensitiveS
findBackwardsCaseInsensitiveS(Char aChar) : Int
findBackwardsCaseInsensitiveS(Char aChar, Int aIndex) : Int
findBackwardsCaseInsensitiveS(String aString) : Int
findBackwardsCaseInsensitiveS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the findBackwardsCaseInsensitive method which, however, if applied for these
strings, would yield unexpected results.

Scripting API | String Methods

findBackwardsS
findBackwardsS(Char aChar) : Int
findBackwardsS(Char aChar, Int aIndex) : Int
findBackwardsS(String aString) : Int
findBackwardsS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the findBackwards method which, however, if applied for these strings, would
yield unexpected results.

Scripting API | String Methods

findCaseInsensitive
findCaseInsensitive(String aString) : Int
findCaseInsensitive(Char aChar) : Int
findCaseInsensitive(String aString, Int aIndex) : Int
findCaseInsensitive(Char aChar, Int aIndex) : Int

Returns the position of the first occurrence of the specified character or string in the given
string, optionally starting from the specified position.

Returns -1 when the specified string or character could not be found.

This function is case-insensitive.

1984
 17.3 General Content Model

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findCaseInsensitive("E");
// firstOccurrence = 5

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findCaseInsensitive("on");
// firstOccurrence = 12

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findCaseInsensitive("e", 10);
// firstOccurrence = 15

String message = "single ENVIRONMENT, all-in-one SOFTWARE";

Int firstOccurrence = message.findCaseInsensitive("On", 15);
// firstOccurrence = 27

Scripting API | String Methods

findCaseInsensitiveS
findCaseInsensitiveS(Char aChar) : Int
findCaseInsensitiveS(Char aChar, Int aIndex) : Int
findCaseInsensitiveS(String aString) : Int
findCaseInsensitiveS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the findCaseInsensitive method which, however, if applied for these strings,
would yield unexpected results.

Scripting API | String Methods

findNonWhiteSpace
findNonWhiteSpace(Int & aFromIndex) : Bool

Returns the Boolean value true if any non-white space character has been found in the given
string starting from the specified position.

The position is stored in variable passed by reference. If searching has been finished successfully,
the position is updated with the position of the first occurrence of the non-white space char-
acter.

String message = " Hello World! ";

Int firstOccurrence = 0;
Bool isNonWhiteSpaceFound = message.findNonWhiteSpace(firstOccurrence);
// isNonWhiteSpaceFound = true, firstOccurrence = 1

1985
17 Scripting

Scripting API | String Methods

findNonWhiteSpaceS
findNonWhiteSpaceS(Char aChar) : Int
findNonWhiteSpaceS(Char aChar, Int aIndex) : Int
findNonWhiteSpaceS(String aString) : Int
findNonWhiteSpaceS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the findNonWhiteSpace method which, however, if applied for these strings,
would yield unexpected results.

Scripting API | String Methods

findWhiteSpace
findWhiteSpace(Int & aFromIndex) : Bool

Returns the Boolean value true if any white space character has been found in the given string
starting from the specified position.

The position is stored in variable passed by reference. If searching has been finished successfully,
the position is updated with the position of the first occurrence of the white space character.

String message = " Hello World! ";

Int firstOccurrence = 4;
Bool isWhiteSpaceFound = message.findWhiteSpace(firstOccurrence);
// isWhiteSpaceFound = true, firstOccurrence = 6

Scripting API | String Methods

findWhiteSpaceS
findWhiteSpaceS(Char aChar) : Int
findWhiteSpaceS(Char aChar, Int aIndex) : Int
findWhiteSpaceS(String aString) : Int
findWhiteSpaceS(String aString, Int aIndex) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the findWhiteSpace method which, however, if applied for these strings, would
yield unexpected results.

Scripting API | String Methods

fromUTF32
fromUTF32(Int aInt) : String

Returns a string that represents the specified Unicode code point.

1986
 17.3 General Content Model

String convertedFromUtf8 = String.fromUTF32(0x20AC);

// convertedFromUtf8 = ""

Scripting API | String Methods

get
get(Int aInt) : Char

Returns the character at the specified zero based position of the given string.

String message = "Hello World!";

Char secondCharacter = message.get(1);
// secondCharacter = "e"

Scripting API | String Methods

insert
insert(Int aIndex, String aString) : Void

Inserts the specified string into the specified position of the given string.

String message = "HelloWorld!";

message.insert(5, " ");
// message = "Hello World!"

Scripting API | String Methods

insertS
insertS(Int aIndex, String aString)

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the insert method which, however, if applied for these strings, would yield
unexpected results.

Scripting API | String Methods

isEmpty
isEmpty() : Bool

Returns the Boolean value true if the given string is empty.

1987
17 Scripting

String message = "Hello World!";

Bool isMessageEmpty = message.isEmpty();
// isMessageEmpty = false

Scripting API | String Methods

isNumeric
isNumeric(Currency & aInt) : Bool
isNumeric(Double & aInt) : Bool
isNumeric(Int & aInt) : Bool
isNumeric(Int64 & aInt) : Bool

Returns the Boolean value true if the conversion of the given string to the specified variable of
the given type, passed by reference, has been finished successfully.

String strMonthAverage = "0.567";

Double monthAverage;
Double yearSum;
if (strMonthAverage.isNumeric(monthAverage))
// if applicable, the given string is converted into Double
yearSum = 12 * monthAverage;
else
// otherwise this message appears in the log file
logError("Invalid double format: " + strMonthAverage);

Scripting API | String Methods

left
left(Int aLength) : String

Returns a string that represents the specified number of characters from the beginning of the
given string.

If that number is greater than the number of characters in the given string, the entire string is
returned.

String strPrice = "1234";

String result = strPrice.left(1); // result = ""

Scripting API | String Methods

leftBM
leftBM(Int aLength) : String

Returns a string that represents the specified number of bytes from the beginning of the given
string.

1988
 17.3 General Content Model

If that number is greater than the number of bytes in the given string, the entire string is re-
turned.

If a Unicode code point of the given character is greater than 255, that character represents
two bytes in the string.

String strPrice = "1234";

String result = strPrice.leftBM(1); // result = " "

Scripting API | String Methods

leftJustify
leftJustify (Int aWidth, Char aFill, Bool aTruncate) : Void

Sets the length of the given string to the specified value and if it is greater than the original
length, justifies the current content to the left and fills the remaining space with the specified
character. If the new length is smaller than the original length, the given string is truncated
only if the specified parameter is set to the Boolean value true.

String message = "Hello World!";

message.leftJustify(15, "*", true); // message = "Hello World!***"

String message = "Hello World!";

message.leftJustify(5, "*", true); // message = "Hello"

String message = "Hello World!";

message.leftJustify(5, "*", false); // message = "Hello World!"

Scripting API | String Methods

leftJustifyS
leftJustifyS(Int aWidth, Char aFill, Bool aTruncate)

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the leftJustify method which, however, if applied for these strings, would yield
unexpected results.

Scripting API | String Methods

leftS
left(Int aLength) : String

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the left method which, however, if applied for these strings, would yield unex-
pected results.

1989
17 Scripting

Scripting API | String Methods

Length
Length : Int
getLength() : Int
setLength(Int aNewLength) : Void

Returns or sets the length of the given string. If the length is changed, the string is either
truncated or appended with trailing spaces.

For enhanced control, two additional methods leftJustify and rightJustify can be used.

String strPrice = "1234";

Int result = strPrice.Length; // result = 5

String message = "Hello World!";

message.Length = 5; // message = "Hello"

Scripting API | String Methods

LengthBM
LengthBM : Int
getLengthBM() : Int

Returns the number of bytes of the given string.

If a Unicode code point of the given character is greater than 255, that character represents
two bytes in the string.

String strPrice = "1234";

Int result = strPrice.LengthBM; // result = 6

Scripting API | String Methods

LengthS
LengthS : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the Length method which, however, if applied for these strings, would yield
unexpected results.

String testString = String.fromUTF32(0x10000);

Int stringLength = testString.Length; // stringLength = 2
Int stringLengthS = testString.LengthS; // stringLengthS = 1

1990
 17.3 General Content Model

Scripting API | String Methods

less
less(String aString) : Bool

Returns the Boolean value true if the Unicode code point of the first different character of the
given string is less than the Unicode code point of the character at the corresponding position
of the specified string. The same result can be achieved using the less than operator <.

String baseString = "Austria";

String stringToCompare = "Belgium";
Bool isLessThanBaseString = stringToCompare.less(baseString);
// isLessThanBaseString = false

Scripting API | String Methods

makeEmpty
makeEmpty() : Void

Removes the content of the given string.

String message = "Hello World!";

message.makeEmpty(); // message = ""

Scripting API | String Methods

makeLowerCase
makeLowerCase() : Void

Converts all alphabetic characters of the given string to lowercase.

String message = "Hello World!";

message.makeLowerCase(); // message = "hello world!"

Scripting API | String Methods

makeTitleCase
makeTitleCase() : Void

Converts the first character of the given string to uppercase.

String message = "Hello World!";

message.makeTitleCase(); // message = "Hello world!"

1991
17 Scripting

Scripting API | String Methods

makeTitleCaseWords
makeTitleCaseWords() : Void

Converts the first character of each word in the given string to uppercase.

String message = "hello world!";

message.makeTitleCaseWords(); // message = "Hello World!"

Scripting API | String Methods

makeUpperCase
makeUpperCase() : Void

Converts all alphabetic characters of the given string to uppercase.

String message = "Hello World!";

message.makeUpperCase(); // message = "HELLO WORLD!"

Scripting API | String Methods

mid
mid(Int aIndex) : String
mid(Int aIndex, Int aLength) : String

Returns a substring from the given string, starting at the zero based specified position. If that
position is greater than the length of the given string, a zero-length string is returned.

If the optional parameter that represents the length of the substring is not specified or it is
greater than the available length of the given string, all characters from the specified start po-
sition to the end of the given string are returned.

String message = "Hello World!";

String result = message.mid(6); // result = "World!"

String message = "Hello World!";

String result = message.mid(2, 5); // result = "llo W"

String message = "Hello World!";

String result = message.mid(2, 20); // result = "llo World!"

String message = "Hello World!";

String result = message.mid(15, 2); // result = ""

String strPrice = "1234";

String result = message.mid(0, 1); // result = ""

1992
 17.3 General Content Model

Scripting API | String Methods

midBM
midBM(Int aIndex, Int aLength) : String
midBM(Int aInt) : String

Returns a substring from the given string, starting at the zero based specified byte number. If
that number is greater than the total number of bytes in the given string, a zero-length string
is returned.

If the optional parameter that represents the number of bytes in the substring is not specified
or it is greater than the available number of bytes in the given string, all characters from the
specified start position to the end of the given string are returned.

Note If a Unicode code point of the given character is greater than 255, that character rep-
resents two bytes in the string.

String strPrice = "1234";

String result1 = message.midBM(0, 1); // result = " "
String result2 = message.midBM(0, 2); // result = ""

Scripting API | String Methods

midS
mid(Int aIndex) : String
mid(Int aIndex, Int aLength) : String

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the mid method which, however, if applied for these strings, would yield unex-
pected results.

Scripting API | String Methods

parseBoolS
parseBoolS(Int & aFromIndex, Bool & aBool) : Int

Sets the Boolean variable to the value of string from the specified position. Returns 0 if a per-
mitted value is found: true, false, yes, no, 1, 0, t, f, y, n (case insensitive). In other cases -1 is
returned.

It is designed for dealing with strings that use surrogate pairs.

Scripting API | String Methods

parseChar
parseChar(Int & aFromIndex, Char aChar) : Int

1993
17 Scripting

Returns the value of zero if the character at the specified position in the given string matches
the specified character. This function is case-sensitive.

The position is stored in the variable passed by reference and incremented by one if parsing
has been finished successfully.

String message = "Hello World!";

Char characterToSearch = "o";
Int currentPosition = 4;
Bool isFound = (message.parseChar(currentPosition,
characterToSearch) == 0);
// isFound = true, currentPosition = 5

Scripting API | String Methods

parseCharCaseInsensitive
parseCharCaseInsensitive(Int & aFromIndex, Char aChar) : Int

Returns the value of zero if the character at the specified position in the given string matches
the specified character. This function is case-insensitive.

The position is stored in the variable passed by reference and incremented by one if parsing
has been finished successfully.

String message = "Hello World!";

Char characterToSearch = "L";
Int currentPosition = 2;
Bool isFound = (message.parseCharCaseInsensitive(currentPosition,
characterToSearch) == 0);
// isFound = true, currentPosition = 3

Scripting API | String Methods

parseCharCaseInsensitiveS
parseCharCaseInsensitiveS(Int & aFromIndex, Char aChar) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseCharCaseInsensitive method which, however, if applied for these
strings, would yield unexpected results.

Scripting API | String Methods

parseCharS
parseCharS(Int & aFromIndex, Char aChar) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseChar method which, however, if applied for these strings, would yield
unexpected results.

1994
 17.3 General Content Model

Scripting API | String Methods

parseDouble
parseDouble(Int & aFromIndex, Double & aDouble) : Int

Returns the value of zero if the string that starts at the specified position of the given string
represents a number of type double.

The position and number are stored in variables passed by reference. If parsing has been finished
successfully, the position is incremented by the length of the string that represents the parsed
number and the number variable is updated with the parsed value.

String strPrice = "$-238.50";

Double price;
Int currentPosition = 1;
Bool isFound = (strPrice.parseDouble(currentPosition, price) == 0);
// isFound = true, currentPosition = 8, price = -238.5

Scripting API | String Methods

parseDoubleS
parseDoubleS(Int & aFromIndex, Double aDouble) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseDouble method which, however, if applied for these strings, would
yield unexpected results.

Scripting API | String Methods

parseInt64
parseInt64(Int & aFromIndex, Int64 & aInt64, Int aBase) : Int

Returns the value of zero if the string that starts at the specified position of the given string
represents a number of type 64-bit integer.

The position and number are stored in variables passed by reference. If parsing has been finished
successfully, the position is incremented by the length of the string that represents the parsed
number and the number variable is updated with the parsed value with regard to the specified
base of the numeral system.

String message = "decimal value -32 is -20 in hexadecimal";

Int64 value;
Int currentPosition = 21;
Bool isFound = (message.parseInt64(currentPosition, value, 16) == 0);
// isFound = true, currentPosition = 24, value = -32

1995
17 Scripting

Scripting API | String Methods

parseInt64S
parseInt64S(Int & aFromIndex, Int64 & aInt64, Int aBase) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseInt64 method which, however, if applied for these strings, would yield
unexpected results.

Scripting API | String Methods

parseLine
parseLine(String aSeparator, String aTextQualifier, StringList &
aP3) : Bool

Returns the Boolean value true if splitting of the given string using the specified delimiter and
the specified text qualifier to the specified string list variable passed by reference has been
finished successfully.

A delimiter containing more than one character must be preceded with the double number
sign.

The text qualifier represents the character that encloses individual text values in the given string.
All of the text that follows that character and precedes the next occurrence of that character
is parsed as one value, even if the text contains the delimiter character.

String strCities = "Tokyo<br/>Seoul<br/>Mexico City";

Util.StringList cities;
strCities.parseLine("##<br/>", "", cities);
// cities[0] = "Tokyo", cities[1] = "Seoul", ...

String strCities = "'Tokyo,jp','Seoul,kr','Mexico City,mx'";

Util.StringList cities;
strCities.parseLine(",", "'", cities);
// cities[0] = "Tokyo,jp", cities[1] = "Seoul,kr", ...

Scripting API | String Methods

parseString
parseString(Int & aFromIndex, String aString) : Int

Returns the value of zero if the string that starts at the specified position of the given string
matches the specified string. This function is case-sensitive.

The position is stored in the variable passed by reference and incremented by the length of the
specified string if parsing has been finished successfully.

1996
 17.3 General Content Model

String message = "Hello World!";

String stringToSearch = "OR";
Int currentPosition = 7;
Bool isFound = (message.parseString(currentPosition,
stringToSearch) == 0);
// isFound = false, currentPosition = 7

Scripting API | String Methods

parseStringCaseInsensitive
parseStringCaseInsensitive(Int & aFromIndex, String aString) : Int

Returns the value of zero if the string that starts at the specified position of the given string
matches the specified string. This function is case-insensitive.

The position is stored in the variable passed by reference and incremented by the length of the
specified string if parsing has been finished successfully.

String message = "Hello World!";

String stringToSearch = "OR";
Int currentPosition = 7;
Bool isFound = (message.parseStringCaseInsensitive(currentPosition,
stringToSearch) == 0);
// isFound = true, currentPosition = 9

Scripting API | String Methods

parseStringCaseInsensitiveS
parseStringCaseInsensitiveS(Int & aFromIndex, String aString) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseStringCaseInsensitive method which, however, if applied for these
strings, would yield unexpected results.

Scripting API | String Methods

parseStringS
parseStringS(Int & aFromIndex, String aString) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseString method which, however, if applied for these strings, would
yield unexpected results.

1997
17 Scripting

Scripting API | String Methods

parseUInt64
parseUInt64(Int & aFromIndex, Int64 & aInt64, Int aBase) : Int

Returns the value of zero if the string that starts at the specified position of the given string
represents a positive number of type 64-bit integer.

The position and number are stored in variables passed by reference. If parsing has been finished
successfully, the position is incremented by the length of the string that represents the parsed
number and the number variable is updated with the parsed value with regard to the specified
base of the numeral system.

String message = "decimal value -32 is -20 in hexadecimal";

Int64 value;
Int currentPosition = 21;
Bool isFound = (message.parseUInt64(currentPosition, value, 16) == 0);
// isFound = false, currentPosition = 21, value = 0
currentPosition++;
Bool isFound = (message.parseUInt64(currentPosition, value, 16) == 0);
// isFound = true, currentPosition = 24, value = 32

Scripting API | String Methods

parseUInt64S
parseUInt64(Int & aFromIndex, Int64 & aInt64, Int aBase) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the parseUInt64 method which, however, if applied for these strings, would
yield unexpected results.

Scripting API | String Methods

parseUntilWhiteSpace
parseUntilWhiteSpace(Int & aFromIndex, String & aString) : Void

Searches for the white space character in the given string starting from the specified position
and stores all the parsed text in the specified variable.

The position and parsed text are stored in variables passed by reference. If parsing has been
finished successfully, the position is updated with the position of the first occurrence of the
white space character.

String message = " Hello World! ";

Int currentPosition = 1;
String textFound;
message.parseUntilWhiteSpace(currentPosition, textFound);
// currentPosition = 6, textFound = "Hello"

1998
 17.3 General Content Model

Scripting API | String Methods

Part
Part[Int apartIdx, Char aSeparator] : String
Part[Int apartIdx, String aSeparator] : String
getPart(Int aPartIdx, Char aSeparator) : String
getPart(Int aPartIdx, String aSeparator) : String

Returns a part of the given string at the specified zero based index. Parts are substrings, that
have been split from the given string using the specified delimiter.

If that index is greater than number of parts, the zero-length string is returned.

If substrings are delimited by the space character, the Word function can be used instead.

String strCities = "Tokyo<br/>Seoul<br/>Mexico City";

String secondCity = strCities.Part[1, "<br/>"];
// secondCity = "Seoul"

Scripting API | String Methods

plus
plus(Char aChar) : Void
plus(String aString) : Void

Appends the specified character or string to the given string.

String message = "Hello";

message.plus(" World!"); // message = "Hello World!"

Scripting API | String Methods

prepend
prepend (String aString) : Void

Attaches the specified string to the beginning of the given string.

String message = "World!";

message.prepend("Hello "); // message = "Hello World!"

Scripting API | String Methods

reduceDirectorySymbols
reduceDirectorySymbols(Int aNotReduceBelow) : Void

1999
17 Scripting

Reduces all the relative symbols of the given string that represents a relative path to the file or
directory.

The specified number determines how many characters from the beginning of the given string
will be left intact.

String strPath = "C:/Documents and Settings/./../My Virtual Machines";

strPath.reduceDirectorySymbols(1);
// strPath = "C:/My Virtual Machines"

Scripting API | String Methods

reduceWhiteSpace
reduceWhiteSpace() : Void

Reduces all white space characters of the given string to a single space.

String message = " Hello World! ";

message.reduceWhiteSpace(); // message = " Hello World! "

Scripting API | String Methods

remove
remove(Int aIndex, Int aInt) : Void

Removes a substring from the given string that starts at the specified zero based position and
represents the specified number of characters.

If that starting position is greater than the length of the string, no characters are deleted.

If the specified number of characters is greater than remaining number of characters in the
given string, only the rest of the string if removed.

String message = "Hello World!";

message.remove(9, 1); // message = "Hello Word!"

Scripting API | String Methods

removeS
remove(Int aIndex, Int aInt)

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the remove method which, however, if applied for these strings, would yield
unexpected results.

2000
 17.3 General Content Model

Scripting API | String Methods

replace
replace(Char aToFind, Char aReplaceWith) : 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

Replaces the specified character or string in the given string with the specified character or
string, optionally starting at the specified zero based position and executed up to the specified
number of matching occurrences.

String message = "single environment, all-in-one software";

message.replace("e", "E");
// message = "singlE EnvironmEnt, all-in-onE softwarE"

String message = "single environment, all-in-one software";

message.replace("e", "E", 15);
// message = "single environmEnt, all-in-onE softwarE"

String message = "single environment, all-in-one software";

message.replace("e", "E", 15, 2);
// message = "single environmEnt, all-in-onE software"

Scripting API | String Methods

replaceBM
replaceBM(Int aFromIndex, Int aLength, String aReplaceWith) : Void

Replaces a substring in the given string. The substring, which starts at the specified zero based
position and represents the specified number of bytes, is replaced with the specified string.

If the length of the specified string does not fit the specified length, that string is either truncated
or appended with space characters.

If a Unicode code point of the given character is greater than 255, that character represents
two bytes in the string.

String strPrice = "1234";

// Euro sign is double-byte while dollar sign only single-byte
strPrice.replaceBM(0, 1, "$$$"); // strPrice = "$ 1234"

String strPrice = "1234";

strPrice.replaceBM(0, 2, "$$$"); // strPrice = "$$1234"

2001
17 Scripting

Scripting API | String Methods

replacePart
String.replacePart(String aSeparator, Int aIndex, String aReplace
Text, Bool aAddPartsIfNeeded)

This method replaces parts of strings. The aIndex parameter (position) uses 0 based index.

The fourth parameter (aAddPartsIfNeeded) is for cases, when the defined position does
not exist in the string:

If set to false, en error will be thrown,

If set to true, the missing separators are inserted to create the field at the defined position
and the replacement value is inserted.

String test="JF2028;simplex;portrait;;0;0;0;0";
test.replacePart(";",1,"duplex",false);

Scripting API | String Methods

replaceS
replaceS(Int aFromIndex, Int aInt, String aString)
replaceS(String aToFind, String aReplaceWith)
replaceS(String aToFind, String aReplaceWith, Int aFromIndex)
replaceS(String aToFind, String aReplaceWith, Int aFromIndex, Int
aTimes)

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the replace method which, however, if applied for these strings, would yield
unexpected results.

Scripting API | String Methods

ReversePart
ReversePart[Int apartIdx, Char aSeparator] : String
getReversePart(Int aPartIdx, Char aSeparator) : String

Returns a part of the given string at the specified reverse ordered zero based index. Parts are
substrings, that have been split from the given string using the specified delimiter.

If that index is greater than the number of parts, the zero-length string is returned.

String strCities = "Tokyo<br/>Seoul<br/>Mexico City";

String lastCity = strCities.ReversePart[0, "<br/>"];
// lastCity = "Mexico City"

2002
 17.3 General Content Model

Scripting API | String Methods

right
right(Int aLength) : String

Returns a string that represents the specified number of characters from the right side of the
given string.

If that number is greater than the number of characters in the given string, the entire string is
returned.

String mesage = "Hello World!";

String result = message.right(6); // result = "World!"

String strPrice = "4321";

String result = strPrice.right(1); // result = ""

Scripting API | String Methods

rightBM
rightBM(Int aLength) : String

Returns a string that represents the specified number of bytes from the right side of the given
string.

If that number is greater than the number of bytes in the given string, the entire string is re-
turned.

If a Unicode code point of the given character is greater than 255, that character represents
two bytes in the string.

String strPrice = "4321";

String result = strPrice.right(1); // result = " "

Scripting API | String Methods

rightJustify
rightJustify(Int aWidth, Char aFill, Bool aTruncate) : Void

Sets the length of the given string to the specified value and if it is greater than the original
length, justifies the current content to the right and fills the remaining space with the specified
character. If the new length is lower than the original length, the given string is truncated only
if the specified parameter is set to the Boolean value true.

String message = "Hello World!";

message.rightJustify(15, "*", true); // message = "***Hello World!"

String message = "Hello World!";

2003
17 Scripting

message.rightJustify(5, "*", true); // message = "Hello"

String message = "Hello World!";

message.rightJustify(5, "*", false); // message = "Hello World!"

Scripting API | String Methods

rightJustifyS
rightJustifyS(Int aWidth, Char aFill, Bool aTruncate)

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the rightJustify method which, however, if applied for these strings, would
yield unexpected results.

Scripting API | String Methods

rightS
rightS(Int aLength) : Int

This method is designed for dealing with strings that use surrogate pairs. It has the same
functionality as the right method which, however, if applied for these strings, would yield un-
expected results.

Scripting API | String Methods

S
getS(Int aInt) : Char
setS(Int aInt, Int aChar) : Void
S[Int aInt] : Int

Returns or sets the Unicode code point of the character on the specified zero based position
in the given string.

It is designed for dealing with strings that use surrogate pairs.

String testString = String.fromUTF32(0x10000);

String firstUnicodeCodePoint = testString[0].toInt().toString(0,false,16);
// firstUnicodeCodePoint = "d800"
String secondUnicodeCodePoint = testString[1].toInt().toString(0,false,16);
// secondUnicodeCodePoint = "dc00"

Scripting API | String Methods

set
set(Int aInt, Char aChar) : Void

2004
 17.3 General Content Model

Sets the character at the specified zero based position of the given string to the specified
character.

String strRatio = "0,25";

strRatio.set(1, "."); // strRatio = "0.25"

String strRatio = "0,25";

strRatio[1] = "."; // strRatio = "0.25"

Scripting API | String Methods

singleJapanToUni
singleJapanToUni() : String

Returns a string with all characters of the given string replaced with their alternatives of the
uniform width, if these are available.

Note This functionality is implemented as mapping of two ranges of Unicode code points
0x210xAC and 0xFF610xFF9C into uniform width character alternatives in ranges
0xFF010xFFE2 and 0x3002-0x309C.

To display these characters correctly in the final output they must be available in the used
font.

String message="Hello World!";

String result = message.singleJapanToUni(); // result = "Hello World!"

If both variables message and result are used in the layout and any suitable font is used, they
can appear similarly like on the following image.

Scripting API | String Methods

toBool
toBool() : Bool

Returns a value that represents a Boolean value of the given string.

String strResult = "false";

Bool result = strResult.toBool(); // result = false

2005
17 Scripting

Scripting API | String Methods

toCurrency
toCurrency() : Currency

Returns a number that represents a currency value of the given string.

String strMonthAverage = "0.1234";

Currency yearSum = 12 * strMonthAverage.toCurrency();
// yearSum = 1.4808

Scripting API | String Methods

toDouble
toDouble() : Double

Returns a number that represents a double value of the given string.

String strMonthAverage = "0.123456";

Double yearSum = 12 * strMonthAverage.toDouble();
// yearSum = 1.481472

Scripting API | String Methods

toInt
toInt() : Int

Returns a number that represents an integer value of the given string.

String strResult = "12345";

Int result = strResult.toInt(); // result = 12345

Scripting API | String Methods

toInt64
toInt64 () : Int64

Returns a number that represents a 64bit integer value of the given string.

String strResult = "12345";

Int64 result = strResult.toInt64(); // result = 12345

2006
 17.3 General Content Model

Scripting API | String Methods

toLowerCase
toLowerCase() : String

Returns a string with all alphabetic characters of the given string converted to lowercase.

String message = "Hello World!";

String result = message.toLowerCase(); // result = "hello world!"

Scripting API | String Methods

toReplaced
toReplaced() : String

Replaces all instances of a character with another character.

String Input = "A123|B456|C789";

return Input.toReplaced("|","_"); // result = "A123_B456_C789"

Scripting API | String Methods

toReversed
toReversed() : String

Returns a string with the reverted order of all characters in the given string.

Tip This scripting method is useful for reverting the sequence of binary data for OMR bar-
codes.

String sequence = "A123 B456 C789";

String result = sequence.toReversed(); // result = "987C 654B 321A"

Scripting API | String Methods

toTitleCase
toTitleCase() : String

Returns a string with the first character of the given string converted to uppercase.

String message = "Hello World!";

String result = message.toTitleCase(); // result = "Hello world!"

2007
17 Scripting

Scripting API | String Methods

toTitleCaseWords
toTitleCaseWords() : String

Returns a string with the first character of each word in the given string converted to uppercase.

String message = "hello world!";

String result = message.toTitleCaseWords(); // result = "Hello World!"

Scripting API | String Methods

toUpperCase
toUpperCase() : String

Returns a string with all alphabetic characters of the given string converted to uppercase.

String message = "Hello World!";

String result = message.toUpperCase(); // result = "HELLO WORLD!"

Scripting API | String Methods

toWhiteSpaceLeftTrimmed
toWhiteSpaceLeftTrimmed() : String

Returns a string with all leading white space characters removed from the given string.

String message = " Hello World! ";

String result = message.toWhiteSpaceRighLeftTrimmed();
// result = "Hello World! "

Scripting API | String Methods

toWhiteSpaceReduced
toWhiteSpaceReduced() : String

Returns a string with all white space characters of the given string reduced to a single space.

String message = " Hello World! ";

String result = message.toWhiteSpaceReduced();
// result = " Hello World! "

2008
 17.3 General Content Model

Scripting API | String Methods

toWhiteSpaceRightTrimmed
toWhiteSpaceRightTrimmed() : String

Returns a string with all trailing white space characters removed from the given string.

String message = " Hello World! ";

String result = message.toWhiteSpaceRightTrimmed();
// result = " Hello World!"

Scripting API | String Methods

toWhiteSpaceTrimmed
toWhiteSpaceTrimmed() : String

Returns a string with all leading and trailing white space characters removed from the given
string.

String message = " Hello World! ";

String result = message.toWhiteSpaceTrimmed();
// result = "Hello World!"

Scripting API | String Methods

toWhiteSpaceTrimmedAndReduced
toWhiteSpaceTrimmedAndReduced() : String

Returns a string with all trailing white space characters removed from the given string and with
all remaining white space characters reduced to a single space.

String message = " Hello World! ";

String result = message.toWhiteSpaceTrimmedAndReduced();
// result = "Hello World!"

Scripting API | String Methods

trimAndReduceWhiteSpace
trimAndReduceWhiteSpace() : Void

Removes all leading and trailing white space characters from the given string and reduces all
remaining white space characters to a single space.

2009
17 Scripting

String message = " Hello World! ";

message.trimAndReduceWhiteSpace(); // message = "Hello World!"

Scripting API | String Methods

trimLeftWhiteSpace
trimLeftWhiteSpace() : Void

Removes all leading white space characters from the given string.

String message = " Hello World! ";

message.trimLeftWhiteSpace(); // message = "Hello World! "

Scripting API | String Methods

trimRightWhiteSpace
trimRightWhiteSpace() : Void

Removes all trailing white space characters from the given string.

String message = " Hello World! ";

message.trimRightWhiteSpace(); // message = " Hello World!"

Scripting API | String Methods

trimWhiteSpace
trimWhiteSpace() : Void

Removes all leading and trailing white space characters from the given string.

String message = " Hello World! ";

message.trimWhiteSpace(); // message = "Hello World!"

Scripting API | String Methods

truncate
truncate(Int aNewLength) : Void

Reduces the length of the given string to the specified value.

2010
 17.3 General Content Model

String message = "Hello World!";

message.truncate(5); // message = "Hello"

Scripting API | String Methods

uniToSingleJapan
uniToSingleJapan() : String

Returns a string with all uniform width characters of the given string replaced with their default
alternatives.

Note This functionality is implemented as mapping of two ranges of Unicode code points
0xFF010xFFE2 and 0x3002-0x309C into non-uniform width character alternatives in ranges
0x210xAC and 0xFF610xFF9C.

Further details can be found in the description of the singleJapanToUni method.

Scripting API | String Methods

Word
Word[Int apartIdx] : String
getWord(Int aPartIdx) : String

Returns a word of the given string at the specified zero based index. Words are substrings,
that have been split from the given string using the space character.

If that index is greater than number of words, a zero-length string is returned.

For substrings delimited by a different character the Part function can be used instead.

String message = " Hello World! ";

String firstWord = message.Word[0]; // firstWord = "Hello"

String message = " Hello" + '\xA0' + "World! ";

String firstWord = message.Word[0]; // firstWord = "Hello World!"

Scripting API

TypeKeeper
For TypeKeeper description see the appropriate part of the ODBC chapter.

Util Methods
Util methods cover miscellaneous areas useful for scripting.

2011
17 Scripting

BinaryList Methods
BinaryList methods can be used for storing, manipulating and retrieving binary values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | BinaryList Methods

add
add(Binary aP1) : Void

Adds a list item with the specified value to the given list.

Util.BinaryList binaryList;
binaryList.add(Binary.fromStringWithCodec("Hello World!", "UTF-8"));

Scripting API | Util Methods | BinaryList Methods

assign
assign(BinaryList aP1) : Void

Assigns a BinaryList object to the given list. The same result can be achieved using the = assign-
ment statement.

Util.BinaryList originalList, clonedList;

originalList.add(Binary.fromHex("FF0000"));
clonedList.assign(originalList);

Scripting API | Util Methods | BinaryList Methods

clear
clear() : Void

Removes all the list items from the given list.

Util.BinaryList binaryList;
binaryList.add(Binary.fromBase64("SGVsbG8gV29ybGQh"));
binaryList.add(Binary.fromHex("48656C6C6F20576F726C6421"));
binaryList.clear();

2012
 17.3 General Content Model

Scripting API | Util Methods | BinaryList Methods

get
get(Int aP1) : Binary

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BinaryList binaryList;
binaryList.add(Binary.fromBase64("SGVsbG8gV29ybGQh"));
binaryList.add(Binary.fromHex("48656C6C6F20576F726C6421"));
for (Int i=0;i<binaryList.Size;i++) {
logMessage(binaryList.get(i).toStringWithCodec("UTF-8"));
// alternative syntax:
logMessage(binaryList[i].toStringWithCodec("UTF-8"));
}

Scripting API | Util Methods | BinaryList Methods

insert
insert(Int aP1, Binary aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BinaryList binaryList;
binaryList.add(Binary.fromHex("48656C6C6F20576F726C6421"));
binaryList.insert(0, Binary.fromBase64("SGVsbG8gV29ybGQh"));

Scripting API | Util Methods | BinaryList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BinaryList binaryList;
binaryList.add(Binary.fromBase64("SGVsbG8gV29ybGQh"));
binaryList.remove(0);

2013
17 Scripting

Scripting API | Util Methods | BinaryList Methods

resize
resize(Int aP1, Binary aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.BinaryList binaryList;
binaryList.add(Binary.fromHex("A0"));
binaryList.resize(3, Binary.fromHex("20"));

Scripting API | Util Methods | BinaryList Methods

set
set(Int aP1, Binary aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BinaryList binaryList;
binaryList.resize(2, Binary.fromHex("20"));
binaryList.set(0, Binary.fromHex("A0"));
// alternative syntax:
stringList[0] = Binary.fromHex("A0");

Scripting API | Util Methods | BinaryList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.BinaryList binaryList;
binaryList.resize(2, Binary.fromHex("20"));
Int listSize = binaryList.Size;

Scripting API | Util Methods | BinaryList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

2014
 17.3 General Content Model

The value of true (1) is greater than the value of false (0).

Util.BinaryList binaryList;
binaryList.add(Binary.fromHex("FF"));
binaryList.add(Binary.fromHex("20"));
binaryList.sort();
for (Int i=0;i<binaryList.Size;i++) {
logMessage(binaryList[i].toHex());
}

BoolList Methods
BoolList methods can be used for storing, manipulating and retrieving Boolean values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | BoolList Methods

add
add(Bool aP1) : Void

Adds a list item with the specified value to the given list.

Util.BoolList boolList;
boolList.add(true);

Scripting API | Util Methods | BoolList Methods

assign
assign(BoolList aP1) : Void

Assigns a BoolList object to the given list. The same result can be achieved using the equal sign
=.

Util.BoolList originalList, clonedList;

originalList.add(true);
clonedList.assign(originalList);

Scripting API | Util Methods | BoolList Methods

clear
clear() : Void

Removes all the list items from the given list.

2015
17 Scripting

Util.BoolList boolList;
boolList.add(true);
boolList.add(false);
boolList.clear();

Scripting API | Util Methods | BoolList Methods

get
get(Int aP1) : Bool

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BoolList boolList;
boolList.add(true);
boolList.add(false);
for (Int i=0;i<boolList.Size;i++) {
logMessage(boolList.get(i).toString());
// alternative syntax:
logMessage(boolList[i].toString());
}

Scripting API | Util Methods | BoolList Methods

insert
insert(Int aP1, Bool aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BoolList boolList;
boolList.add(true);
boolList.insert(0, false);

Scripting API | Util Methods | BoolList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

2016
 17.3 General Content Model

Util.BoolList boolList;
boolList.add(true);
boolList.remove(0);

Scripting API | Util Methods | BoolList Methods

resize
resize(Int aP1, Bool aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.BoolList boolList;
boolList.add(true);
boolList.resize(3, false);

Scripting API | Util Methods | BoolList Methods

set
set(Int aP1, Bool aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.BoolList boolList;
boolList.resize(2, false);
boolList.set(0, true);
// alternative syntax:
stringList[0] = true;

Scripting API | Util Methods | BoolList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.BoolList boolList;
boolList.resize(2, false);
Int listSize = boolList.Size;

2017
17 Scripting

Scripting API | Util Methods | BoolList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

The value of true (1) is greater than the value of false (0).

Util.BoolList boolList;
boolList.add(true);
boolList.add(false);
boolList.add(true);
boolList.sort();
for (Int i=0;i<boolList.Size;i++) {
logMessage(boolList[i].toString());
}

CharList Methods
CharList methods can be used for storing, manipulating and retrieving char values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | CharList Methods

add
add(Char aP1) : Void

Adds a list item with the specified value to the given list.

Util.CharList charList;
charList.add("A");

Scripting API | Util Methods | CharList Methods

assign
assign(CharList aP1) : Void

Assigns a CharList object to the given list. The same result can be achieved using the = assign-
ment statement.

Util.CharList originalList, clonedList;

originalList.add("A");
clonedList.assign(originalList);

2018
 17.3 General Content Model

Scripting API | Util Methods | CharList Methods

clear
clear() : Void

Removes all the list items from the given list.

Util.CharList charList;
charList.add("A");
charList.add("");
charList.clear();

Scripting API | Util Methods | CharList Methods

get
get(Int aP1) : Char

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CharList charList;
charList.add("A");
charList.add("");
for (Int i=0;i<charList.Size;i++) {
logMessage(charList.get(i));
// alternative syntax:
logMessage(charList[i]);
}

Scripting API | Util Methods | CharList Methods

insert
insert(Int aP1, Char aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CharList charList;
charList.add("A");
charList.insert(0, "");

2019
17 Scripting

Scripting API | Util Methods | CharList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CharList charList;
charList.add("A");
charList.remove(0);

Scripting API | Util Methods | CharList Methods

resize
resize(Int aP1, Char aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.CharList charList;
charList.add("A");
charList.resize(3, "");

Scripting API | Util Methods | CharList Methods

set
set(Int aP1, Char aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CharList charList;
charList.resize(2, "");
charList.set(0, "A");
// alternative syntax:
charList[0] = "A";

Scripting API | Util Methods | CharList Methods

Size
Size : Int
getSize() : Int

2020
 17.3 General Content Model

Returns the total number of list items in the given list.

Util.CharList charList;
charList.resize(2, "");
Int listSize = charList.Size;

Scripting API | Util Methods | CharList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Individual characters are compared using their Unicode code points.

Util.CharList charList;
charList.add("a");
charList.add("A");
charList.add("");
charList.sort();
for (Int i=0;i<charList.Size;i++) {
logMessage(charList[i]);
}

COM Methods
Microsoft COM (Component Object Model), also called ActiveX, is a technology that enables
software components to communicate.

Warning Using the COM technology produces platform dependend solutions as it is supported
on the Windows platform only.

Example This sample script creates a new empty Word document.

if (Util.COM.isSupported()) {
Util.COM.Variant app, doc;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
doc = app.Prop["Documents"];
doc.invoke("Add");
}

Scripting API | Util Methods | COM Methods

isSupported
isSupported() : Bool

Returns a Boolean value true if the COM technology is supported.

2021
17 Scripting

Variant Methods
Variant methods can be used for manipulating COM instances.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in the Workflow Options Dialog is not checked.

Scripting API | Util Methods | COM Methods | Variant Methods

assign
assign(Bool aP1) : Void
assign(Currency aP1) : Void
assign(DateTime aP1) : Void
assign(Double aP1) : Void
assign(Int aP1) : Void
assign(Int64 aP1) : Void
assign(String aP1) : Void
assign(Variant aP1) : Void

Assigns the specified value to the given Variant object. The same result can be achieved using
the equal sign =.

Util.COM.Variant app, docs;

app.createInstance("Word.Application");
docs.assign(app.Prop["Documents"]);

Scripting API | Util Methods | COM Methods | Variant Methods

createInstance
createInstance(String aP1) : Void

Creates an instance of an application that is registered in the system under the specified instance
name.

Util.COM.Variant app;
app.Prop["Visible"] = true;
app.createInstance("Excel.Application");

Scripting API | Util Methods | COM Methods | Variant Methods

invoke
invoke(String aP1, ...) : Variant

Returns a Variant object if invoking of the specified method together with all the specified
comma separated parameters of the given Variant object has been finished successfully.

2022
 17.3 General Content Model

// Opens the specified MS Word document

if (Util.COM.isSupported()) {
Util.COM.Variant app, docs, doc;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
docs = app.Prop["Documents"];
doc = docs.invoke("Open", "C:\test.doc");
}

Scripting API | Util Methods | COM Methods | Variant Methods

Null
Null : Variant
getNull() : Variant

Returns a Variant object representing the null value.

The null value can be used in place of the method's optional parameters.

// Opens the specified document in the read-only mode

Util.COM.Variant app, docs;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
docs = app.Prop["Documents"];
doc = docs.invoke("Open", "C:\test.doc", docs.Null, true);

Scripting API | Util Methods | COM Methods | Variant Methods

Prop
Prop[String aP1, ...] : Any
Prop[String aP1, ...] : Variant
Prop[String aP1] : Variant
getProp(String aP1) : Variant
getProp(String aP1, ...) : Variant
setProp(String aP1, ...) : Void

Returns or sets the specified property of the given Variant object.

// Returns the version of the MS Word instance

if (Util.COM.isSupported()) {
Util.COM.Variant app;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
String appVersion = app.Prop["Version"].toString();
app.invoke("Quit");
}

2023
17 Scripting

Scripting API | Util Methods | COM Methods | Variant Methods

toBool
toBool() : Bool

Converts the given Variant object to a Boolean value.

// Tests the visibility of the MS Word instance

Util.COM.Variant app;
app.createInstance("Word.Application");
Bool isVisible = app.Prop["Visible"].toBool();
app.invoke("Quit");

Scripting API | Util Methods | COM Methods | Variant Methods

toCurrency
toCurrency() : Currency

Converts the given Variant object to a currency value.

// Returns the currency value of the specified cell in a MS Excel file

if (Util.COM.isSupported()) {
Util.COM.Variant app, workbooks, workbook, worksheets, worksheet;
// Opens a MS Excel instance
app.createInstance("Excel.Application");
app.Prop["Visible"] = true;
// Retrieve the collection of opened files
workbooks = app.Prop["Workbooks"];
// Adds a new file to that collection
workbook = workbooks.invoke("Open", "C:\test.xls");
// Retrieves the collection of sheets in the active file
worksheets = workbook.Prop["Worksheets"];
// Selects the first sheet
worksheet = worksheets.Prop["Item", 1];
// Returns the cell value in the second column of the first row
Currency price = worksheet.Prop["Cells", 1 , 2].toCurrency();
}

Scripting API | Util Methods | COM Methods | Variant Methods

toDateTime
toDateTime() : DateTime

Converts the given Variant object to a date-time value.

// Reads the date value from the specified cell in a MS Excel sheet
if (Util.COM.isSupported()) {
Util.COM.Variant app, workbooks, workbook, worksheets, worksheet;
app.createInstance("Excel.Application");
app.Prop["Visible"] = true;

2024
 17.3 General Content Model

workbooks = app.Prop["Workbooks"];
workbook = workbooks.invoke("Open", "C:\test.xls");
worksheets = workbook.Prop["Worksheets"];
worksheet = worksheets.Prop["Item", 1];
DateTime myDate = worksheet.Prop["Cells", 1 , 1].toDateTime();
}

Scripting API | Util Methods | COM Methods | Variant Methods

toDouble
toDouble() : Double

Converts the given Variant object to a double value.

// Reads the floating-point number from the specified cell in a MS Excel

sheet
if (Util.COM.isSupported()) {
Util.COM.Variant app, workbooks, workbook, worksheets, worksheet;
app.createInstance("Excel.Application");
app.Prop["Visible"] = true;
workbooks = app.Prop["Workbooks"];
workbook = workbooks.invoke("Open", "C:\test.xls");
worksheets = workbook.Prop["Worksheets"];
worksheet = worksheets.Prop["Item", 1];
Double average = worksheet.Prop["Cells", 1 , 3].toDouble();
}

Scripting API | Util Methods | COM Methods | Variant Methods

toInt
toInt() : Int

Converts the given Variant object to an integer value.

// Returns the number of paragraphs in a MS Word document

if (Util.COM.isSupported()) {
Util.COM.Variant app, docs, doc, paragraphs, firstParagraph;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
docs = app.Prop["Documents"];
doc = docs.invoke("Open", "C:\test.doc");
paragraphs = doc.Prop["Paragraphs"];
Int paragraphsCount = paragraphs.Prop["Count"].toInt();
}

Scripting API | Util Methods | COM Methods | Variant Methods

toInt64
toInt64() : Int64

2025
17 Scripting

Converts the given Variant object to a 64bit integer value.

// Reads the 64-bit integer from the specified cell in a MS Excel sheet
if (Util.COM.isSupported()) {
Util.COM.Variant app, workbooks, workbook, worksheets, worksheet;
app.createInstance("Excel.Application");
app.Prop["Visible"] = true;
workbooks = app.Prop["Workbooks"];
workbook = workbooks.invoke("Open", "C:\test.xls");
worksheets = workbook.Prop["Worksheets"];
worksheet = worksheets.Prop["Item", 1];
Int64 fileSize = worksheet.Prop["Cells", 1 , 4].toInt64();
}

Scripting API | Util Methods | COM Methods | Variant Methods

toString
toString() : String

Converts the given Variant object to a string value.

// Reads the content of the first paragraph in a MS Word document

if (Util.COM.isSupported()) {
Util.COM.Variant app, docs, doc, paragraphs, firstParagraph;
app.createInstance("Word.Application");
app.Prop["Visible"] = true;
docs = app.Prop["Documents"];
doc = docs.invoke("Open", "C:\test.doc");
paragraphs = doc.Prop["Paragraphs"];
firstParagraph = paragraphs.invoke("Item", 1);
String firstParagraphContent = paragraph.Prop["Range"].toString());
}

Scripting API | Util Methods | COM Methods | Variant Methods

TypeInfo
TypeInfo : String
getTypeInfo() : String

Returns a string value representing the lists of all the methods and parameters available for
the given Variant object.

// Lists all of the methods available for the given object

if (Util.COM.isSupported()) {
Util.COM.Variant app;
Util.StringList methodList;
app.createInstance("Word.Application");
app.TypeInfo.parseLine('\x0A', "", methodList);
app.invoke("Quit");
for (Int i=0;i<methodList.Size;i++) {
logMessage(methodList[i]);

2026
 17.3 General Content Model

}
}

CurrencyList Methods
CurrencyList methods can be used for storing, manipulating and retrieving currency values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | CurrencyList Methods

add
add(Currency aP1) : Void

Adds a list item with the specified value to the given list.

Util.CurrencyList currencyList;
currencyList.add(12.1234);

Scripting API | Util Methods | CurrencyList Methods

assign
assign(CurrencyList aP1) : Void

Assigns a CurrencyList object to the given list. The same result can be achieved using the equal
sign =.

Util.CurrencyList originalList, clonedList;

originalList.add(12.1234);
clonedList.assign(originalList);

Scripting API | Util Methods | CurrencyList Methods

clear
clear() : Void

Removes all the list items from the given list.

Util.CurrencyList currencyList;
currencyList.add(12.1234);
currencyList.add(23.1234);
currencyList.clear();

2027
17 Scripting

Scripting API | Util Methods | CurrencyList Methods

get
get(Int aP1) : Currency

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CurrencyList currencyList;
currencyList.add(12.1234);
currencyList.add(23.1234);
for (Int i=0;i<currencyList.Size;i++) {
logMessage(currencyList.get(i).toString());
// alternative syntax:
logMessage(currencyList[i].toString());
}

Scripting API | Util Methods | CurrencyList Methods

insert
insert(Int aP1, Currency aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CurrencyList currencyList;
currencyList.add(23.1234);
currencyList.insert(0, 12.1234);

Scripting API | Util Methods | CurrencyList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CurrencyList currencyList;
currencyList.add(12.1234);
currencyList.remove(0);

2028
 17.3 General Content Model

Scripting API | Util Methods | CurrencyList Methods

resize
resize(Int aP1, Currency aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.CurrencyList currencyList;
currencyList.add(12.1234);
currencyList.resize(3, 0);

Scripting API | Util Methods | CurrencyList Methods

set
set(Int aP1, Currency aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.CurrencyList currencyList;
currencyList.resize(2, 0);
currencyList.set(0, 12.1234);
// alternative syntax:
stringList[0] = 12.1234;

Scripting API | Util Methods | CurrencyList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.CurrencyList currencyList;
currencyList.resize(2, 0);
Int listSize = currencyList.Size;

Scripting API | Util Methods | CurrencyList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

2029
17 Scripting

Util.CurrencyList currencyList;
currencyList.add(12.1234);
currencyList.add(23.1234);
currencyList.add(-12.1234);
currencyList.sort();
for (Int i=0;i<currencyList.Size;i++) {
logMessage(currencyList[i].toString());
}

DateTimeList Methods
DateTimeList methods can be used for storing, manipulating and retrieving date and time values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | DateTimeList Methods

add
add(DateTime aP1) : Void

Adds a list item with the specified value to the given list.

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.fromDate(31, 12, 1999));

Scripting API | Util Methods | DateTimeList Methods

assign
assign(DateTimeList aP1) : Void

Assigns a DateTimeList object to the given list. The same result can be achieved using the equal
sign =.

Util.DateTimeList originalList, clonedList;

originalList.add(DateTime.Now);
clonedList.assign(originalList);

Scripting API | Util Methods | DateTimeList Methods

clear
clear() : Void

Removes all the list items from the given list.

2030
 17.3 General Content Model

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.fromDate(31, 12, 1999));
dateTimeList.add(DateTime.fromDate(1, 1, 2000));
dateTimeList.clear();

Scripting API | Util Methods | DateTimeList Methods

get
get(Int aP1) : DateTime

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.fromDate(31, 12, 1999));
dateTimeList.add(DateTime.fromDate(1, 1, 2000));
for (Int i=0;i<dateTimeList.Size;i++) {
logMessage(dateTimeList.get(i).toString());
// alternative syntax:
logMessage(dateTimeList[i].toString());
}

Scripting API | Util Methods | DateTimeList Methods

insert
insert(Int aP1, DateTime aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.fromDate(31, 12, 1999));
dateTimeList.insert(0, DateTime.Now);

Scripting API | Util Methods | DateTimeList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

2031
17 Scripting

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.Now);
dateTimeList.remove(0);

Scripting API | Util Methods | DateTimeList Methods

resize
resize(Int aP1, DateTime aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.Now);
dateTimeList.resize(3, DateTime(0));

Scripting API | Util Methods | DateTimeList Methods

set
set(Int aP1, DateTime aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DateTimeList dateTimeList;
dateTimeList.resize(2, DateTime(0));
dateTimeList.set(0, DateTime.Now);
// alternative syntax:
stringList[0] = DateTime.Now;

Scripting API | Util Methods | DateTimeList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.DateTimeList dateTimeList;
dateTimeList.resize(2, DateTime(0));
Int listSize = dateTimeList.Size;

2032
 17.3 General Content Model

Scripting API | Util Methods | DateTimeList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Util.DateTimeList dateTimeList;
dateTimeList.add(DateTime.Now);
dateTimeList.add(DateTime.fromDate(31, 12, 1999));
dateTimeList.add(DateTime.fromDate(31, 12, 2009));
dateTimeList.sort();
for (Int i=0;i<dateTimeList.Size;i++) {
logMessage(dateTimeList[i].toString());
}

DoubleList Methods
DoubleList methods can be used for storing, manipulating and retrieving double values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | DoubleList Methods

add
add(Double aP1) : Void

Adds a list item with the specified value to the given list.

Util.DoubleList doubleList;
doubleList.add(12.1234567);

Scripting API | Util Methods | DoubleList Methods

assign
assign(DoubleList aP1) : Void

Assigns a DoubleList object to the given list. The same result can be achieved using the equal
sign =.

Util.DoubleList originalList, clonedList;

originalList.add(12.1234567);
clonedList.assign(originalList);

2033
17 Scripting

Scripting API | Util Methods | DoubleList Methods

clear
clear() : Void

Removes all the list items from the given list.

Util.DoubleList doubleList;
doubleList.add(12.1234567);
doubleList.add(23.1234567);
doubleList.clear();

Scripting API | Util Methods | DoubleList Methods

get
get(Int aP1) : Double

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DoubleList doubleList;
doubleList.add(12.1234567);
doubleList.add(23.1234567);
for (Int i=0;i<doubleList.Size;i++) {
logMessage(doubleList.get(i).toString());
// alternative syntax:
logMessage(doubleList[i].toString());
}

Scripting API | Util Methods | DoubleList Methods

insert
insert(Int aP1, Double aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DoubleList doubleList;
doubleList.add(23.1234567);
doubleList.insert(0, 12.1234567);

2034
 17.3 General Content Model

Scripting API | Util Methods | DoubleList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DoubleList doubleList;
doubleList.add(12.1234567);
doubleList.remove(0);

Scripting API | Util Methods | DoubleList Methods

resize
resize(Int aP1, Double aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.DoubleList doubleList;
doubleList.add(12.1234567);
doubleList.resize(3, 0);

Scripting API | Util Methods | DoubleList Methods

set
set(Int aP1, Double aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.DoubleList doubleList;
doubleList.resize(2, 0);
doubleList.set(0, 12.1234567);
// alternative syntax:
stringList[0] = 12.1234567;

Scripting API | Util Methods | DoubleList Methods

Size
Size : Int
getSize() : Int

2035
17 Scripting

Returns the total number of list items in the given list.

Util.DoubleList doubleList;
doubleList.resize(2, 0);
Int listSize = doubleList.Size;

Scripting API | Util Methods | DoubleList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Util.DoubleList doubleList;
doubleList.add(12.1234567);
doubleList.add(23.1234567);
doubleList.add(-12.1234567);
doubleList.sort();
for (Int i=0;i<doubleList.Size;i++) {
logMessage(doubleList[i].toString());
}

Scripting API | Util Methods

Environment
Environment[String aP1]
getEnvironment(String aP1) : String

Returns a value of the specified environment variable.

String environmentPath = Util.Environment["path"];

Int64List Methods
Int64List methods can be used for storing, manipulating and retrieving 64-bit integer values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | Int64List Methods

add
add(Int64 aP1) : Void

Adds a list item with the specified value to the given list.

2036
 17.3 General Content Model

Util.Int64List int64List;
int64List.add(12345);

Scripting API | Util Methods | Int64List Methods

assign
assign(Int64List aP1) : Void

Assigns a Int64List object to the given list. The same result can be achieved using the equal
sign =.

Util.Int64List originalList, clonedList;

originalList.add(12345);
clonedList.assign(originalList);

Scripting API | Util Methods | Int64List Methods

clear
clear() : Void

Removes all the list items from the given list.

Util.Int64List int64List;
int64List.add(12345);
int64List.add(67890);
int64List.clear();

Scripting API | Util Methods | Int64List Methods

get
get(Int aP1) : Int64

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.Int64List int64List;
int64List.add(12345);
int64List.add(67890);
for (Int i=0;i<int64List.Size;i++) {
logMessage(int64List.get(i).toString());
// alternative syntax:
logMessage(int64List[i].toString());
}

2037
17 Scripting

Scripting API | Util Methods | Int64List Methods

insert
insert(Int aP1, Int64 aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.Int64List int64List;
int64List.add(67890);
int64List.insert(0, 12345);

Scripting API | Util Methods | Int64List Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.Int64List int64List;
int64List.add(12345);
int64List.remove(0);

Scripting API | Util Methods | Int64List Methods

resize
resize(Int aP1, Int64 aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.Int64List int64List;
int64List.add(12345);
int64List.resize(3, 0);

Scripting API | Util Methods | Int64List Methods

set
set(Int aP1, Int64 aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

2038
 17.3 General Content Model

If that zero based position is out of the available range, an error will be shown when processing.

Util.Int64List int64List;
int64List.resize(2, 0);
int64List.set(0, 12345);
// alternative syntax:
stringList[0] = 12345;

Scripting API | Util Methods | Int64List Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.Int64List int64List;
int64List.resize(2, 0);
Int listSize = int64List.Size;

Scripting API | Util Methods | Int64List Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Util.Int64List int64List;
int64List.add(12345);
int64List.add(67890);
int64List.add(-12345);
int64List.sort();
for (Int i=0;i<int64List.Size;i++) {
logMessage(int64List[i].toString());
}

IntIntMap Methods
IntIntMap methods can be used for storing, manipulating and retrieving integer values mapped
by integer keys.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

2039
17 Scripting

Scripting API | Util Methods | IntIntMap Methods

assign
assign(IntIntMap aP1) : Void

Assigns a IntIntMap object to the given map. The same result can be achieved using the equal
sign =.

Util.IntIntMap originalMap, clonedMap;

originalMap.set(0, 12345);
clonedMap.assign(originalMap);

Scripting API | Util Methods | IntIntMap Methods

clear
clear() : Void

Removes all the map items from the given map.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
intIntMap.set(20, 67890);
intIntMap.clear();

Scripting API | Util Methods | IntIntMap Methods

contains
contains(Int aP1) : Bool

Returns the Boolean value when the specified key has been found in the given map.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
intIntMap.set(20, 67890);
Bool isZeroKeyPresent = (intIntMap.contains(0));
// isZeroKeyPresent = false

Scripting API | Util Methods | IntIntMap Methods

get
get(Int aP1) : Int

Returns a map item value that corresponds with the specified key of the given map.

If the specified key does not exist, an error will be shown when processing.

2040
 17.3 General Content Model

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
intIntMap.set(20, 67890);
Int result = intIntMap.get(10); // result = 12345
// alternative syntax:
// Int result = intIntMap[10];

Scripting API | Util Methods | IntIntMap Methods

increment
increment(Int aP1) : Void
increment(Int aP1, Int aP2) : Void

Increments the map item value that corresponds with the specified key of the given map.

The value is incremented either by one or by the integer value passed as the second parameter.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
intIntMap.increment(10, 5);
Int result = intIntMap[10]; // result = 12350

Scripting API | Util Methods | IntIntMap Methods

Key
Key[Int aP1] : Int
getKey(Int aP1) : Int

Returns the map item key at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.IntIntMap intIntMap;
intIntMap.set(20, 12345);
intIntMap.set(10, 67890);
Int result = intIntMap.Key[0]; // result = 10

Scripting API | Util Methods | IntIntMap Methods

remove
remove(Int aP1) : Void

Removes the map item that corresponds with the specified key of the given map.

2041
17 Scripting

If the specified key does not exist, this method has no effect.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
if (intIntMap.contains(10)) {
intIntMap.remove(10);
}
Int result = intIntMap.Size; // result = 0

Scripting API | Util Methods | IntIntMap Methods

set
set(Int aP1, Int aP2) : Void

Sets the map item value that corresponds with the specified key in the given map to the specified
value.

If that key does not exist, a new map item is created automatically.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);

Scripting API | Util Methods | IntIntMap Methods

Size
Size : Int
getSize() : Int

Returns the total number of map items in the given map.

Util.IntIntMap intIntMap;
intIntMap.set(10, 12345);
Int result = intIntMap.Size; // result = 1

Scripting API | Util Methods | IntIntMap Methods

Value
Value[Int aP1] : Int
getValue(Int aP1) : Int
setValue(Int aP1, Int aP2) : Void

Returns or sets the map item value at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

2042
 17.3 General Content Model

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.IntIntMap intIntMap;
intIntMap.set(20, 12345);
intIntMap.set(10, 67890);
Int result = intIntMap.Value[0]; // result = 67890

IntList Methods
IntList methods can be used for storing, manipulating and retrieving integer values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | IntList Methods

add
add(Int aP1) : Void

Adds a list item with the specified value to the given list.

Util.IntList intList;
intList.add(12345);

Scripting API | Util Methods | IntList Methods

assign
assign(IntList aP1) : Void

Assigns a IntList object to the given list. The same result can be achieved using the equal sign
=.

Util.IntList originalList, clonedList;

originalList.add(12345);
clonedList.assign(originalList);

Scripting API | Util Methods | IntList Methods

clear
clear() : Void

Removes all the list items from the given list.

2043
17 Scripting

Util.IntList intList;
intList.add(12345);
intList.add(67890);
intList.clear();

Scripting API | Util Methods | IntList Methods

get
get(Int aP1) : Int

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.IntList intList;
intList.add(12345);
intList.add(67890);
for (Int i=0;i<intList.Size;i++) {
logMessage(intList.get(i).toString());
// alternative syntax:
logMessage(intList[i].toString());
}

Scripting API | Util Methods | IntList Methods

insert
insert(Int aP1, Int aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.IntList intList;
intList.add(67890);
intList.insert(0, 12345);

Scripting API | Util Methods | IntList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

2044
 17.3 General Content Model

Util.IntList intList;
intList.add(12345);
intList.remove(0);

Scripting API | Util Methods | IntList Methods

resize
resize(Int aP1, Int aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.IntList intList;
intList.add(12345);
intList.resize(3, 0);

Scripting API | Util Methods | IntList Methods

set
set(Int aP1, Int aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.IntList intList;
intList.resize(2, 0);
intList.set(0, 12345);
// alternative syntax:
stringList[0] = 12345;

Scripting API | Util Methods | IntList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.IntList intList;
intList.resize(2, 0);
Int listSize = intList.Size;

2045
17 Scripting

Scripting API | Util Methods | IntList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Util.IntList intList;
intList.add(12345);
intList.add(67890);
intList.add(-12345);
intList.sort();
for (Int i=0;i<intList.Size;i++) {
logMessage(intList[i].toString());
}

IntStringMap Methods
IntStringMap methods can be used for storing, manipulating and retrieving string values mapped
by integer keys.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | IntStringMap Methods

assign
assign(IntStringMap aP1) : Void

Assigns a IntStringMap object to the given map. The same result can be achieved using the
equal sign =.

Util.IntStringMap originalMap, clonedMap;

originalMap.set(0, "Hello World!");
clonedMap.assign(originalMap);

Scripting API | Util Methods | IntStringMap Methods

clear
clear() : Void

Removes all the map items from the given map.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");
intStringMap.set(20, " ");
intStringMap.clear();

2046
 17.3 General Content Model

Scripting API | Util Methods | IntStringMap Methods

contains
contains(Int aP1) : Bool

Returns the Boolean value true when the specified key has been found in the given map.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");
intStringMap.set(20, " ");
Bool isZeroKeyPresent = (intStringMap.contains(0));
// isZeroKeyPresent = false

Scripting API | Util Methods | IntStringMap Methods

get
get(Int aP1) : String

Returns a map item value that corresponds with the specified key of the given map.

If the specified key does not exist, an error will be shown when processing.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");
intStringMap.set(20, " ");
String result = intStringMap.get(10); // result = "Hello World!"
// alternative syntax:
// String result = intStringMap[10];

Scripting API | Util Methods | IntStringMap Methods

Key
Key[Int aP1] : Int
getKey(Int aP1) : Int

Returns the map item key at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.IntStringMap intStringMap;
intStringMap.set(20, "Hello World!");
intStringMap.set(10, " ");
Int result = intStringMap.Key[0]; // result = 10

2047
17 Scripting

Scripting API | Util Methods | IntStringMap Methods

remove
remove(Int aP1) : Void

Removes the map item that corresponds with the specified key of the given map.

If the specified key does not exist, this method has no effect.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");
if (intStringMap.contains(10)) {
intStringMap.remove(10);
}
Int result = intStringMap.Size; // result = 0

Scripting API | Util Methods | IntStringMap Methods

set
set(Int aP1, String aP2) : Void

Sets the map item value that corresponds with the specified key in the given map to the specified
value.

If that key does not exist, a new map item is created automatically.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");

Scripting API | Util Methods | IntStringMap Methods

Size
Size : Int
getSize() : Int

Returns the total number of map items in the given map.

Util.IntStringMap intStringMap;
intStringMap.set(10, "Hello World!");
Int result = intStringMap.Size; // result = 1

2048
 17.3 General Content Model

Scripting API | Util Methods | IntStringMap Methods

Value
Value[Int aP1] : String
getValue(Int aP1) : String
setValue(Int aP1, String aP2) : Void

Returns or sets the map item value at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.IntStringMap intStringMap;
intStringMap.set(20, "Hello World!");
intStringMap.set(10, " ");
String result = intStringMap.Value[0]; // result = " "

IntTable Methods
IntTable methods can be used for storing, manipulating and retrieving two-dimensional data
of the type Int.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | IntTable Methods

addRow
addRow() : Void

Adds a new row to the given table.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.addRow();
IntTable[0, 0] = 1;
IntTable[0, 1] = 5;

Scripting API | Util Methods | IntTable Methods

assign
assign(IntTable aP1) : Void

Assigns a IntTable object to the given table. The same result can be achieved using the equal
sign =.

2049
17 Scripting

Util.IntTable originalTable, clonedTable;

originalTable.ColumnCount = 2;
originalTable.addRow();
originalTable[0, 0] = 26;
originalTable[0, 1] = 180;
clonedTable.assign(originalTable);

Scripting API | Util Methods | IntTable Methods

clear
clear() : Void

Removes all the rows from the given table.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.addRow();
IntTable[0, 0] = 71;
IntTable[0, 1] = 12;
IntTable.clear();

Scripting API | Util Methods | IntTable Methods

ColumnCount
ColumnCount : Int
getColumnCount() : Int
setColumnCount(Int aP1) : Void

Returns or sets the number of columns in the given table.

This value must be set before any filling of the table with appropriate values and must not be
changed later, otherwise an error will be shown when processing.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.RowCount = 1;
IntTable[0, 0] = 500;
IntTable[0, 1] = 550;

Scripting API | Util Methods | IntTable Methods

get
get(Int aRow, Int aColumn) : Int

Returns a table cell value that corresponds with the specified row and column of the given
table.

2050
 17.3 General Content Model

If either the specified row or column is out of the available range, an error will be shown when
processing.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
Int row = IntTable.RowCount;
IntTable.addRow();
IntTable[row, 0] = 4001;
IntTable[row, 1] = 3333;
Int result = IntTable.get(0, 0); // result = 4001
// alternative syntax:
// Int result = IntTable[0, 0];

Scripting API | Util Methods | IntTable Methods

insertRow
insertRow(Int aRow) : Void

Inserts a new row to the specified position of the given table.

If the specified row index is out of the available range, an error will be shown when processing.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.addRow();
IntTable[0, 0] = 888;
IntTable[0, 1] = 999;
IntTable.insertRow(0);
IntTable[0, 0] = 777;
IntTable[0, 1] = 686;
Int result = IntTable[1, 1]; // result = 999

Scripting API | Util Methods | IntTable Methods

removeRow
removeRow(Int aRow) : Void

Removes the row from the specified position of the given table.

If the specified row index is out of the available range, an error will be shown when processing.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.addRow();
IntTable[0, 0] = 888;
IntTable[0, 1] = 999;
IntTable.removeRow(0);
Int result = IntTable.RowCount; // result = 0

2051
17 Scripting

Scripting API | Util Methods | IntTable Methods

RowCount
RowCount : Int
getRowCount() : Int
setRowCount(Int aP1) : Void

Returns or sets the number of rows in the given table.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.RowCount = 1;
IntTable[0, 0] = 123;
IntTable[0, 1] = 546;

Scripting API | Util Methods | IntTable Methods

set
set(Int aRow, Int aColumn, Int aP3) : Void

Sets the value Int aP3 at the specified row Int aRow and column Int aColumn of the
given table.

If either the specified row or column is out of the available range, an error will be shown when
processing.

Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.addRow();
IntTable.set(0, 0, 35);
IntTable.set(0, 1, 36);

Scripting API | Util Methods | IntTable Methods

sortRows
sortRows(Int aColumn) : Void

Sorts the table rows in the ascending order according to the values of the specified column.

If the specified column index is out of the available range, an error will be shown when pro-
cessing.

Int result;
Util.IntTable IntTable;
IntTable.ColumnCount = 2;
IntTable.RowCount = 2;
IntTable[0, 0] = 10;
IntTable[0, 1] = 8;

2052
 17.3 General Content Model

IntTable[1, 0] = 76;
IntTable[1, 1] = 34;
IntTable.sortRows(0);
result = IntTable[0, 0]; // result = 10
IntTable.sortRows(1);
result = IntTable[0, 0]; // result = 76

Mail Methods
Mail methods can be used for creating email messages.

Scripting API | Util Methods | Mail Methods

addAttachment
addAttachment(Binary Binary, String AttachmentName) : Mail
addAttachment(Binary Binary, String AttachmentName, String MIMEType)
: Void
addAttachment(String FileName) : Void
addAttachment(String FileName, String AttachmentName) : Void
addAttachment(String FileName, String AttachmentName, String MIME
Type) : Void

Adds an attachment to the given email. The attachment can be passed in the form of binary
data or specified as an absolute path to the file. The displayed file name can be overridden by
the specified title. The file content can be tagged with the specified MIME Type, an Internet
Media Type file format identifier for internet protocols.

Util.Mail mail;
mail.addAttachment("C:\\jones09032152.pdf", "Statement_March09.pdf");
Binary binaryData = Binary.fromBase64("SGVsbG8gV29ybGQh");
mail.addAttachment(binaryData, "message.txt", "text/plain");

Scripting API | Util Methods | Mail Methods

addBccTo
addBccTo (String EmailAddress): Void
addBccTo (String Email Address, String FriendlyName): Void

Adds the specified email address to the list of Bcc (blind carbon copy) recipients. Only the re-
cipient's own address will appear in To field.

If FriendlyName is also defined, the email address will be given this name for display purposes.

Util.Mail newMail;
newMail.addTo("[email protected]");
newMail.addBccTo ("[email protected]", "Lucy Johnson");
newMail.setFrom("[email protected]");

2053
17 Scripting

Scripting API | Util Methods | Mail Methods

addCopyTo
addCopyTo(String EmailAddress) : Void
addCopyTo(String EmailAddress, String FriendlyName) : Void

Adds the specified email address to the list of copie(s) recipient(s). This email address will appear
in the CC field.

If FriendlyName is also defined, the email address will be given this name for display purposes.

Util.Mail mail;
mail.addTo("[email protected]", "John Smith");
mail.addCopyTo("[email protected]", "Lucy Johnson");

Scripting API | Util Methods | Mail Methods

addReplyTo
addReplyTo (String EmailAddress): Void
addReplyTo (String EmailAddress, String FriendlyName): Void

Adds the specified email address as the addressee of a reply if other than the sender.

If FriendlyName is also defined, the email address will be given this name for display purposes.

Util.Mail mail;
mail.setFrom("[email protected]");
mail.addReplyTo("[email protected]", "John Smith");
mail.addTo("[email protected]", "Lucy Johnson");

Scripting API | Util Methods | Mail Methods

addTo
addTo(String EmailAddress) : Void
addTo(String EmailAddress, String FriendlyName) : Void

Adds the specified email address to the list of original recipients. This email address will appear
in the TO field.

If FriendlyName is also defined, the email address will be given this name for display purposes.

Util.Mail mail;
mail.addTo("[email protected]", "John Smith");

2054
 17.3 General Content Model

Scripting API | Util Methods | Mail Methods

assign
assign(Mail mail) : Void

Assigns the specified Mail object to the given mail. The same result can be achieved using the
equal sign =.

Util.Mail originalMail, clonedMail;

originalMail.addTo("[email protected]");
originalMail.setSubject("Hello World!");
clonedMail.assign(originalMail);

Scripting API | Util Methods | Mail Methods

clearAttachments
clearAttachments (): Void

Clears attachments.

Scripting API | Util Methods | Mail Methods

clearBcc
clearBcc (): Void

Clears Bcc (blind carbon copy) recipients.

Scripting API | Util Methods | Mail Methods

clearCopyTo
clearCopyTo (): Void

Clears copy recipients.

Scripting API | Util Methods | Mail Methods

clearTo
clearTo (): Void

Clears the recipient(s) email adddress(es).

2055
17 Scripting

Scripting API | Util Methods | Mail Methods

getBccCount
getBccCount (): Int

Returns the number of Bcc (blind carbon copy) recipients.

for (Int i=0; i<CurrentRecord.getBccCount();i++)

{
//String name = CurrentRecord.getToMail(i);
}

Scripting API | Util Methods | Mail Methods

getBccMail
getBccMail (Int Index)

Returns the email address of a Bcc recipient's specified by index.

Scripting API | Util Methods | Mail Methods

getBccName
getBccName (Int Index)

Returns the name of a Bcc recipient specified by index.

Scripting API | Util Methods | Mail Methods

getCopyToCount
getCopyToCount (): Int

Returns the number of the copy recipients.

Scripting API | Util Methods | Mail Methods

getCopyToMail
getCopyToMail (Int Index)

Returns the email addresses of a copy recipient specified by index.

Scripting API | Util Methods | Mail Methods

getCopyToName
getCopyToName (Int Index)

2056
 17.3 General Content Model

Returns the name of a copy recipient specified by index.

Scripting API | Util Methods | Mail Methods

getDeliveryConfirmationTo
getDeliveryConfirmationTo (): String

Returns the delivery confirmation target address.

Scripting API | Util Methods | Mail Methods

getFromMail
getFromMail (): String

Returns the sender's address.

Scripting API | Util Methods | Mail Methods

getFromName
getFromName (): String

Return the sender's name.

Scripting API | Util Methods | Mail Methods

getReadConfirmationTo
getReadConfirmationTo (): String

Returns the read confirmation message target address.

Scripting API | Util Methods | Mail Methods

getReplyToCount
getReplyToCount (): Int

Returns the number of the reply recipients.

Scripting API | Util Methods | Mail Methods

getReplyToMail
getReplyToMail (Int Index)

Returns the address of the reply recipient specified by index.

2057
17 Scripting

Scripting API | Util Methods | Mail Methods

getReplyToName
getReplyToName (Int index)

Returns the name of the reply recipient specified by index.

Scripting API | Util Methods | Mail Methods

getReturnPathMail
getReturnPathMail (): String

Returns the address used for returning of undeliverable messages.

Scripting API | Util Methods | Mail Methods

getReturnPathName
getReturnPathName (): String

Returns the names used as the addressee for returning undeliverable messages.

Scripting API | Util Methods | Mail Methods

getSubject
getSubject (): String

Returns the message's subject.

Scripting API | Util Methods | Mail Methods

getToCount
getToCount (): Int

Returns the number of the email recipients.

Scripting API | Util Methods | Mail Methods

getToMail
getToMail (Int Index)

Returns the email address of the recipient specified by index.

2058
 17.3 General Content Model

Scripting API | Util Methods | Mail Methods

getToName
getToName (Int Index)

Returns the name of the recipient specified by index.

Scripting API | Util Methods | Mail Methods

loadHTMLBodyFromFile
loadHTMLBodyFromFile (String FileName): Void

Loads the HTML body from a file according to the specified path.

Util.Mail mail;
mail.setSubject("Your Account Statement");
mail.loadHTMLBodyFromFile("C:\DOCUMENTS\AccountStatement01.html");

Scripting API | Util Methods | Mail Methods

loadTextBodyFromFile
loadTextBodyFromFile (String FileName): Void

Loads the TXT body from a file according to the specified path.

Util.Mail mail;
mail.setSubject("Your Account Statement");
mail.loadTextBodyFromFile("C:\DOCUMENTS\AccountStatement01.txt");

Scripting API | Util Methods | Mail Methods

saveToEML
saveToEML (Stream stream): Bool

Saves the email to the EML format.

String fileName="result/"+String(recordID,0)+".eml";
File.Stream s = File.open(fileName,File.Mode.TruncateOrCreate);
if (not CurrentRecord.saveToEML(s))

Note The internal structure of an email sent by Inspire Designer (using the sendMail and
saveToEML methods) has been changed. Due to this change, the text part of emails, that
contain both text and HTML parts, might be displayed in email clients (after switching on the
option Show plain text only in an email client) differently than in previous versions. The display

2059
17 Scripting

is handled by the used mailing server and email client. See the influence of single server and
clients after the internal change:

Server

Exchange Server replaces the text part with HTML and HTML part is displayed correctly.

Clients

Outlook shows the HTML part only. The text part is skipped

Thunderbird shows both text part and HTML.

Web mail (e.g. Hotmail.cz, YahooMail, Gmail.com, Seznam.cz, Volny.cz) and Apple
Mail do not have the global option Show plain text only so the user is not influenced
by this change.

Thus, it is recommended to avoid having text parts together with HTML in an email because
every mailing server and email client handle emails differently and the text part may increase
the size of the email and cause slower sending.

Scripting API | Util Methods | Mail Methods

setDeliveryConfirmationTo
setDeliveryConfirmationTo(String EmailAddress) : Void

Sets up a delivery confirmation request, the result of which is sent to the specified email address.

Util.Mail mail;
mail.setFrom("[email protected]", "John Smith");
mail.setDeliveryConfirmationTo("[email protected]");
mail.addTo("[email protected]", "Lucy Johnson");

Scripting API | Util Methods | Mail Methods

setEncoding
setEncoding(String Encoding) : Void

Overrides the default UTF-8 encoding of the given email message. The specified parameter is
either a valid text encoding or a path to the custom codec.

Util.Mail mail;
mail.setEncoding("ISO-8859-2");

2060
 17.3 General Content Model

Scripting API | Util Methods | Mail Methods

setFrom
setFrom(String EmailAddress) : Void
setFrom(String EmailAddress, String FriendlyName) : Void

Defines a sender using the specified email address. This email address will appear in the FROM
field.

If FriendlyName is also defined, the email address will be given this name for display purposes.

Util.Mail mail;
mail.setFrom("[email protected]", "John Smith");

Scripting API | Util Methods | Mail Methods

setHTMLBody
setHTMLBody(String EmailText) : Void
setHTMLBody(String EmailText, String Encoding) : Void

Defines the HTML content of the email body that is encoded in the specified text encoding.

Util.Mail mail;
mail.setHTMLBody("<html><body><h1>Hello
World!</h1></body></html>", "ISO-8859-1");

Scripting API | Util Methods | Mail Methods

setReadConfirmationTo
setReadConfirmationTo(String EmailAddress) : Void

Sets up a read receipt confirmation request, the result of which is sent to the specified email
address.

Util.Mail mail;
mail.setFrom("[email protected]", "John Smith");
mail.setReadConfirmationTo("[email protected]");
mail.addTo("[email protected]", "Lucy Johnson");

Scripting API | Util Methods | Mail Methods

setReturnPath
setReturnPath (String EmailAddress): Void
setReturnPath (String EmailAddress, String FriendlyName): Void

2061
17 Scripting

Sets the address for returning undeliverable messages.

FriendlyName can also be defined.

Util.Mail mail;
mail.setReturnPath ("[email protected]");

Scripting API | Util Methods | Mail Methods

setSubject
setSubject(String Subject) : Void

Sets the subject of the given email message.

Util.Mail mail;
mail.setSubject("Your Account Statement");

Scripting API | Util Methods | Mail Methods

setTextBody
setTextBody(String EmailText) : Void
setTextBody(String EmailText, String Encoding) : Void

Defines the plain text content of the email body that is encoded in the specified text encoding.

Util.Mail mail;
mail.setTextBody("Hello World!", "ISO-8859-1");

MailServer Methods
MailServer methods can be used for configuring the connection to the SMTP server.

Tip If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | MailServer Methods

clearCommunicationLog
clearCommunicationLog() : Void

Clears the log of the communication between the server and the client.

2062
 17.3 General Content Model

Util.Mail mailDefault, mailCustomized;

Util.MailServer mailServer;
mailServer.ServerName = "mail.gfbank.com";

Util.StringList recipients;
recipients.add("[email protected]");
recipients.add("[email protected]");

mailDefault.setFrom("[email protected]", "Mail Daemon");

mailDefault.setSubject("Greetings");
mailDefault.setTextBody("Hello World!");

for (Int i=0;i<recipients.Size;i++) {

mailCustomized = mailDefault;
mailCustomized.addTo(recipients[i]);
mailServer.sendMail(mailCustomized);
logMessage(mailServer.CommunicationLog);
// clears the communication log with each iteration
mailServer.clearCommunicationLog();

Scripting API | Util Methods | MailServer Methods

CommunicationLog
CommunicationLog : String
getCommunicationLog() : String

Returns a log tracking the versioned communication between the client and the server.

Util.Mail mail;
Util.MailServer mailServer;
mailServer.ServerName = "mail.gfbank.com";

mail.setFrom("[email protected]", "Mail Daemon");

mail.addTo("[email protected]");
mail.setSubject("Hello!");
mailServer.sendMail(mail);

// writes the communication log into the text file

File.TextStream logStream;
logStream = File.openText("C:\log.txt", File.Mode.TruncateOrCreate, "UTF-8");
logStream.writeString(mailServer.CommunicationLog);
logStream.close();

Scripting API | Util Methods | MailServer Methods

connect
connect() : Bool

Returns a Boolean value true if the connection to the server has been established.

2063
17 Scripting

Using this method is not compulsory as the connection is always established automatically with
the connection details provided.

Util.MailServer mailServer;
mailServer.ServerName = "mail.gfbank.com";
mailServer.PortNumber = 25;
mailServer.LoginName = "j.smith";
mailServer.Password = "Yz8gFjk6wq2B";
Bool isConnected = mailServer.connect();

Scripting API | Util Methods | MailServer Methods

LoginName
LoginName : String
getLoginName() : String
setLoginName(String UserName) : Void

Returns or sets the login name of the user.

The connection details can also be retrieved automatically from the operating system if this is
allowed by the settings of the mail server.

Util.MailServer mailServer;
mailServer.LoginName = "j.smith";

Scripting API | Util Methods | MailServer Methods

Password
Password : String
getPassword() : String
setPassword(String Password) : String

Returns or sets the password of the user.

The connection details can also be retrieved automatically from the operating system if this is
allowed by the settings of the mail server.

Util.MailServer mailServer;
mailServer.Password = "Yz8gFjk6wq2B";

Scripting API | Util Methods | MailServer Methods

PortNumber
PortNumber : Int
getPortNumber() : Int
setPortNumber(Int aP1) : Void

2064
 17.3 General Content Model

Returns or sets the number of the port on which the SMTP server listens.

Util.MailServer mailServer;
mailServer.PortNumber = 25;

Scripting API | Util Methods | MailServer Methods

sendMail
sendMail(Mail & Mail) : Bool

Returns a Boolean value true when the specified email has been sent successfully.

Note This method does not change the content of the Mail parameter.

The internal structure of an email sent by Inspire Designer (using the sendMail and saveToEML
methods) has been changed. Due to this change, the text part of emails, that contain both
text and HTML parts, might be displayed in email clients (after switching on the option Show
plain text only in an email client) differently than in previous versions. The display is handled
by the used mailing server and email client. See the influence of single server and clients after
the internal change:

Server

Exchange Server replaces the text part with HTML and HTML part is displayed correctly.

Clients

Outlook shows the HTML part only. The text part is skipped

Thunderbird shows both text part and HTML.

Web mail (e.g. Hotmail.cz, YahooMail, Gmail.com, Seznam.cz, Volny.cz) and Apple
Mail do not have the global option Show plain text only so the user is not influenced
by this change.

Thus, it is recommended to avoid having text parts together with HTML in an email because
every mailing server and email client handle emails differently and the text part may increase
the size of the email and cause slower sending.

Util.Mail mail;
Util.MailServer mailServer;
mailServer.ServerName = "mail.gfbank.com";
mailServer.PortNumber = 25;

mail.setFrom("[email protected]", "Mail Daemon");

mail.addTo("[email protected]");
mail.setSubject("Hello!");
mailServer.sendMail(mail);

2065
17 Scripting

Scripting API | Util Methods | MailServer Methods

ServerName
ServerName : String
getServerName() : String
setServerName(String ServerName) : Void

Returns or sets the name or IP address of the SMTP server.

Util.MailServer mailServer;
mailServer.ServerName = "mail.gfbank.com";

Scripting API | Util Methods

OSName
OSName : String
getOSName() : String

Returns the name of the operating system.

String osName = Util.OSName;

Scripting API | Util Methods

OSUserName
OSUserName : String
getOSUserName() : String

Returns the name of the user currently logged in the operating system.

String userName = Util.OSUserName;

StringIntMap Methods
StringIntMap methods can be used for storing, manipulating and retrieving integer values
mapped by string keys.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

2066
 17.3 General Content Model

Scripting API | Util Methods | StringIntMap Methods

assign
assign(StringIntMap aP1) : Void

Assigns a StringIntMap object to the given map. The same result can be achieved using the
equal sign =.

Util.StringIntMap originalMap, clonedMap;

originalMap.set("en", 1033);
clonedMap.assign(originalMap);

Scripting API | Util Methods | StringIntMap Methods

clear
clear() : Void

Removes all the map items from the given map.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.set("de", 1031);
stringIntMap.clear();

Scripting API | Util Methods | StringIntMap Methods

contains
contains(String aP1) : Bool

Returns the Boolean value true if the specified key has been found in the given map.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.set("de", 1031);
Bool isCzechCodePresent = (stringIntMap.contains("cs"));
// isCzechCodePresent = false

Scripting API | Util Methods | StringIntMap Methods

get
get(String aP1) : Int

Returns a map item value that corresponds with the specified key of the given map.

If the specified key does not exist, an error will be shown when processing.

2067
17 Scripting

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.set("de", 1031);
Int result = stringIntMap.get("en"); // result = 1033
// alternative syntax:
// Int result = stringIntMap["en"];

Scripting API | Util Methods | StringIntMap Methods

increment
increment(String aP1) : Void
increment(String aP1, Int aP2) : Void

Increments the map item value that corresponds with the specified key of the given map.

The value is incremented either by one or by an integer value passed as the second parameter.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.increment("en", 7);
Int result = stringIntMap["en"]; // result = 1040

Scripting API | Util Methods | StringIntMap Methods

Key
Key[Int aP1] : String
getKey(Int aP1) : String

Returns the map item key at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.set("de", 1031);
String result = stringIntMap.Key[0]; // result = "de"

Scripting API | Util Methods | StringIntMap Methods

remove
remove(String aP1) : Void

Removes the map item that corresponds with the specified key of the given map.

2068
 17.3 General Content Model

If the specified key does not exist, this method has no effect.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
if (stringIntMap.contains("en")) {
stringIntMap.remove("en");
}
Int result = stringIntMap.Size; // result = 0

Scripting API | Util Methods | StringIntMap Methods

set
set(String aP1, Int aP2) : Void

Sets the map item value that corresponds with the specified key in the given map to the specified
value.

If that key does not exist, a new map item is created automatically.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);

Scripting API | Util Methods | StringIntMap Methods

Size
Size : Int
getSize() : Int

Returns the total number of map items in the given map.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
Int result = stringIntMap.Size; // result = 1

Scripting API | Util Methods | StringIntMap Methods

Value
Value[Int aP1] : Int
getValue(Int aP1) : Int
setValue(Int aP1, Int aP2) : Void

Returns or sets the map item value at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

2069
17 Scripting

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.StringIntMap stringIntMap;
stringIntMap.set("en", 1033);
stringIntMap.set("de", 1031);
String result = stringIntMap.Value[0]; // result = 1031

StringList Methods
StringList methods can be used for storing, manipulating and retrieving string values.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | StringList Methods

add
add(String aP1) : Void

Adds a list item with the specified value to the given list.

Util.StringList stringList;
stringList.add("Hello World!");

Scripting API | Util Methods | StringList Methods

assign
assign(StringList aP1) : Void

Assigns a StringList object to the given list. The same result can be achieved using the = assign-
ment statement.

Util.StringList originalList, clonedList;

originalList.add("Hello World!");
clonedList.assign(originalList);

Scripting API | Util Methods | StringList Methods

clear
clear() : Void

Removes all the list items from the given list.

2070
 17.3 General Content Model

Util.StringList stringList;
stringList.add("Hello World!");
stringList.add(" ");
stringList.clear();

Scripting API | Util Methods | StringList Methods

get
get(Int aP1) : String

Returns a value of a list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

Util.StringList stringList;
stringList.add("Hello World!");
stringList.add(" ");
for (Int i=0;i<stringList.Size;i++) {
logMessage(stringList.get(i));
// alternative syntax:
logMessage(stringList[i]);
}

Scripting API | Util Methods | StringList Methods

insert
insert(Int aP1, String aP2) : Void

Inserts a list item at the specified position in the given list and sets its value to the specified
value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.StringList stringList;
stringList.add("Hello World!");
stringList.insert(0, " ");

Scripting API | Util Methods | StringList Methods

remove
remove(Int aP1) : Void

Removes the list item from the specified position of the given list.

If that zero based position is out of the available range, an error will be shown when processing.

2071
17 Scripting

Util.StringList stringList;
stringList.add("Hello World!");
stringList.remove(0);

Scripting API | Util Methods | StringList Methods

resize
resize(Int aP1, String aP2) : Void

Changes the total number of list items in the given list. If the new size is larger, the default
value of all new list items is set to the specified value.

Util.StringList stringList;
stringList.add("Hello World!");
stringList.resize(3, "default value");

Scripting API | Util Methods | StringList Methods

set
set(Int aP1, String aP2) : Void

Sets a value of a list item at the specified position in the given list to the specified value.

If that zero based position is out of the available range, an error will be shown when processing.

Util.StringList stringList;
stringList.resize(2, "");
stringList.set(0, "Hello World!");
// alternative syntax:
stringList[0] = "Hello World!";

Scripting API | Util Methods | StringList Methods

Size
Size : Int
getSize() : Int

Returns the total number of list items in the given list.

Util.StringList stringList;
stringList.resize(2, "");
Int listSize = stringList.Size;

2072
 17.3 General Content Model

Scripting API | Util Methods | StringList Methods

sort
sort() : Void

Sorts all list items in the given list by their values.

Individual characters are compared using their Unicode code points.

Util.StringList stringList;
stringList.add("Tokyo");
stringList.add("Seoul");
stringList.add("Mexico City");
stringList.sort();
for (Int i=0;i<stringList.Size;i++) {
logMessage(stringList[i]);
}

StringStringMap Methods
StringStringMap methods can be used for storing, manipulating and retrieving string values
mapped by string keys.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | StringStringMap Methods

assign
assign(StringStringMap aP1) : Void

Assigns a StringStringMap object to the given map. The same result can be achieved using the
equal sign =.

Util.StringStringMap originalMap, clonedMap;

originalMap.set("en", 1033);
clonedMap.assign(originalMap);

Scripting API | Util Methods | StringStringMap Methods

clear
clear() : Void

Removes all the map items from the given map.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");

2073
17 Scripting

stringStringMap.set("el", " ");

stringStringMap.clear();

Scripting API | Util Methods | StringStringMap Methods

contains
contains(String aP1) : Bool

Returns the Boolean value true if the specified key has been found in the given map.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
stringStringMap.set("el", " ");
Bool isCzechCodePresent = (stringStringMap.contains("cs"));
// isCzechCodePresent = false

Scripting API | Util Methods | StringStringMap Methods

get
get(String aP1) : String

Returns a map item value that corresponds with the specified key of the given map.

If the specified key does not exist, an error will be shown when processing.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
stringStringMap.set("el", " ");
String result = stringStringMap.get("en"); // result = "Hello World!"
// alternative syntax:
// String result = stringStringMap["en"];

Scripting API | Util Methods | StringStringMap Methods

Key
Key[Int aP1] : String
getKey(Int aP1) : String

Returns the map item key at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

2074
 17.3 General Content Model

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
stringStringMap.set("el", " ");
String result = stringStringMap.Key[0]; // result = "el"

Scripting API | Util Methods | StringStringMap Methods

remove
remove(String aP1) : Void

Removes the map item that corresponds with the specified key of the given map.

If the specified key does not exist, this method has no effect.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
if (stringStringMap.contains("en")) {
stringStringMap.remove("en");
}
Int result = stringStringMap.Size; // result = 0

Scripting API | Util Methods | StringStringMap Methods

set
set(String aP1, String aP2) : Void

Sets the map item value that corresponds with the specified key in the given map to the specified
value.

If that key does not exist, a new map item is created automatically.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");

Scripting API | Util Methods | StringStringMap Methods

Size
Size : Int
getSize() : Int

Returns the total number of map items in the given map.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
Int result = stringStringMap.Size; // result = 1

2075
17 Scripting

Scripting API | Util Methods | StringStringMap Methods

Value
Value[Int aP1] : String
getValue(Int aP1) : String
setValue(Int aP1, String aP2) : Void

Returns or sets the map item value at the specified position of the given map.

If that zero based position is out of the available range, an error will be shown when processing.

Note Map items are internally sorted by their keys, so the final order does not necessarily
correspond with the order in which individual items have been added to the map.

Util.StringStringMap stringStringMap;
stringStringMap.set("en", "Hello World!");
stringStringMap.set("el", " ");
String result = stringStringMap.Value[0]; // result = " "

StringTable Methods
StringTable methods can be used for storing, manipulating and retrieving two-dimensional
data of the type string.

Note If you do not see the get methods during scripting in Inspire Designer, it is because the
option Show getters in Workflow Options Dialog is not checked.

Scripting API | Util Methods | StringTable Methods

addRow
addRow() : Void

Adds a new row to the given table.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.addRow();
stringTable[0, 0] = "John";
stringTable[0, 1] = "Smith";

Scripting API | Util Methods | StringTable Methods

assign
assign(StringTable aP1) : Void

Assigns a StringTable object to the given table. The same result can be achieved using the equal
sign =.

2076
 17.3 General Content Model

Util.StringTable originalTable, clonedTable;

originalTable.ColumnCount = 2;
originalTable.addRow();
originalTable[0, 0] = "John";
originalTable[0, 1] = "Smith";
clonedTable.assign(originalTable);

Scripting API | Util Methods | StringTable Methods

clear
clear() : Void

Removes all the rows from the given table.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.addRow();
stringTable[0, 0] = "John";
stringTable[0, 1] = "Smith";
stringTable.clear();

Scripting API | Util Methods | StringTable Methods

ColumnCount
ColumnCount : Int
getColumnCount() : Int
setColumnCount(Int aP1) : Void

Returns or sets the number of columns in the given table.

This value must be set before any filling of the table with appropriate values and must not be
changed later, otherwise an error will be shown when processing.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.RowCount = 1;
stringTable[0, 0] = "Japan";
stringTable[0, 1] = "Tokyo";

Scripting API | Util Methods | StringTable Methods

get
get(Int aRow, Int aColumn) : String

Returns a table cell value that corresponds with the specified row and column of the given
table.

2077
17 Scripting

If either the specified row or column is out of the available range, an error will be shown when
processing.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
Int row = stringTable.RowCount;
stringTable.addRow();
stringTable[row, 0] = "John";
stringTable[row, 1] = "Smith";
String result = stringTable.get(0, 0); // result = "John"
// alternative syntax:
// String result = stringTable[0, 0];

Scripting API | Util Methods | StringTable Methods

insertRow
insertRow(Int aRow) : Void

Inserts a new row to the specified position of the given table.

If the specified row index is out of the available range, an error will be shown when processing.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.addRow();
stringTable[0, 0] = "John";
stringTable[0, 1] = "Smith";
stringTable.insertRow(0);
stringTable[0, 0] = "Lucy";
stringTable[0, 1] = "Johnson";
String result = stringTable[1, 1]; // result = "Smith"

Scripting API | Util Methods | StringTable Methods

removeRow
removeRow(Int aRow) : Void

Removes the row from the specified position of the given table.

If the specified row index is out of the available range, an error will be shown when processing.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.addRow();
stringTable[0, 0] = "John";
stringTable[0, 1] = "Smith";
stringTable.removeRow(0);
Int result = stringTable.RowCount; // result = 0

2078
 17.3 General Content Model

Scripting API | Util Methods | StringTable Methods

RowCount
RowCount : Int
getRowCount() : Int
setRowCount(Int aP1) : Void

Returns or sets the number of rows in the given table.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.RowCount = 1;
stringTable[0, 0] = "Japan";
stringTable[0, 1] = "Tokyo";

Scripting API | Util Methods | StringTable Methods

set
set(Int aRow, Int aColumn, String aP3) : Void

Sets a value at the specified row and column of the given table to the specified value.

If either the specified row or column is out of the available range, an error will be shown when
processing.

Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.addRow();
stringTable.set(0, 0, "John");
stringTable.set(0, 1, "Smith");

Scripting API | Util Methods | StringTable Methods

sortRows
sortRows(Int aColumn) : Void

Sorts the table rows in the ascending order according to the values of the specified column.

If the specified column index is out of the available range, an error will be shown when pro-
cessing.

String result;
Util.StringTable stringTable;
stringTable.ColumnCount = 2;
stringTable.RowCount = 2;
stringTable[0, 0] = "at";
stringTable[0, 1] = "Wien";
stringTable[1, 0] = "sk";
stringTable[1, 1] = "Bratislava";

2079
17 Scripting

stringTable.sortRows(0);
result = stringTable[0, 0]; // result = "at"
stringTable.sortRows(1);
result = stringTable[0, 0]; // result = "sk"

URL Methods
URL methods are used for manipulating URL addresses in links.

The characters used in URL addresses should be encoded with US-ASCII everywhere in an HTML
document that a URL is referenced to import an object, e.g. in links.

Scripting API | Util Methods | URL Methods

decodeURL
decodeURL() : String

Decodes previously encoded strings (URL address) from US-ASCII, i.e. reserved characters that
were expressed in hexadecimal are decoded.

Reserved characters are: $, @, +, ,, /, :, ;, =, ?, &

String param="a%2Bc+%2F+d%2Be";
String expression = Util.decodeUrl(param);
return expression;
//script returns: a+c / d+e

Scripting API | Util Methods | URL Methods

encodeURL
encodeURL() : String

Encodes strings (URL address) to US-ASCII, i.e. reserved characters are encoded.

Reserved characters are: $, @, +, ,, /, :, ;, =, ?, &

String param="a+c / d+e";

String url="http://www.abc.cz/process expression a="+Util.encodeUrl(param);
logMessage(url);
//Script processing(message): http://www.abc.cz/process expression
a=a%2Bc+%2F+d%2Be

2080
 17.3 General Content Model

Scripting API | Util Methods | URL Methods

escapeURL
escapeURL() : String

Escapes the use of unsafe characters in an URL address.

Unsafe characters are: space, ", <, >, #, %, {, }, |, ^, ~, [, ], `

String url="http://www.abc.cz/process expression a=a%2Bc+%2F+d%2Be";

url = Util.escapeUrl(url);
logMessage(url);
//Script processing(message): http://www.abc.cz/process%20expres
sion%20a=a%252Bc+%252F+d%252Be

Scripting API | Util Methods | URL Methods

unescapeURL
unescapeURL() : String

Reverses the function of escapeURL(), i.e. unsafe characters in an URL address are decoded
from hexadecimal values.

Unsafe characters are: space, ", <, >, #, %, {, }, |, ^, ~, [, ], `

String url="http://www.abc.cz/process%20expres
sion%20a=a%252Bc+%252F+d%252Be";
url = Util.unescapeUrl(url);
return url;
//script returns: http://www.abc.cz/process expression a=a%2Bc+%2F+d%2Be

Workflow Methods
See also:
Data
How to Use the Insert Param Variable
Wizard

Scripting API | Workflow Methods

clickThroughUrl
clickThroughUrl(String aP1) : String

Returns an encrypted and Base64 encoded representation of the specified UTF-8 encoded
string.

2081
17 Scripting

String encryptedString = WorkFlow.clickThroughUrl("Hello World!");

Scripting API | Workflow Methods

CurrentOutputFileName
CurrentOutputFileName : String
getCurrentOutputFileName() : String

Returns the name of the currently generated file.

It can only be used in the after creating File event listener of the Event script module, otherwise
an error will be shown when processing.

String currentOutputFileName = WorkFlow.CurrentOutputFileName;

Scripting API | Workflow Methods

detectDependencies
detectDependencies(String aP1, StringList & aP2) : Bool

Returns the Boolean value true if the dependencies (used files) of the specified workflow have
been obtained correctly. In addition, a list of used files of a workflow is returned in the para-
meter aP2. This is the script alternative to Cross Reference Browser.

File.FileInfoList fiv;
File.list(fiv, File.ListParam.Files, "vcs://test");
for(Int i=0; i<fiv.Size; i++)
{
Util.StringList deps;
if(not WorkFlow.detectDependencies(fiv[i].Location, deps))
continue;
Files.commit();
Files.File = fiv[i].Location;
for(Int j=0; j<deps.Size; j++)
{
Files.Depends.commit();
Files.Depends.Location=deps[j];
}
}

Scripting API | Workflow Methods

EngineName
EngineName : String
getEngineName() : String

Returns the name of the currently used engine.

2082
 17.3 General Content Model

String engineName = WorkFlow.EngineName;

Scripting API | Workflow Methods

IsJobAborted
IsJobAborted : Bool
getIsJobAborted() : Bool

Returns the Boolean value true if the job has been aborted by the user or finished with an error.

Bool isJobOk = not WorkFlow.IsJobAborted;

Scripting API | Workflow Methods

IsProof
IsProof : Bool
getIsProof() : Bool

Returns the Boolean value true if the Layout is being proofed.

String message;
if (WorkFlow.IsProof) message = "This workflow is now proofed.";
else message = "This workflow is in production.";

Scripting API | Workflow Methods

JobReportProperty
JobReportProperty[String aName] : String
setJobReportProperty(String aName, String aValue) : Void

Sets the specified job report property to the specified value. This information is logged into
Inspire Content Manager (VCS) job report.

WorkFlow.JobReportProperty["User"] = "admin";

Scripting API | Workflow Methods

OutputName
OutputName : String
getOutputName() : String

2083
17 Scripting

Returns the name of the output module.

String outputModuleName = WorkFlow.OutputName;

Scripting API | Workflow Methods

PAAttribute
PAAttribute[String aP1] : String
setPAAttribute(String aP1, String aP2) : Void

Sets the specified job report property to the specified value. The prefix _PA is assigned to the
property name. This information is logged into Inspire Content Manager (VCS) job report in
Inspire Designer and can be further saved to attributes (either system or user attributes) in In-
spire Automation (PrintNet PA).

WorkFlow.PAAttribute["job.descriptor"] = "job OK";

Scripting API | Workflow Methods

Parameter
Parameter[String aP1, String aP2] : String
getParameter(String aP1, String aP2) : String
setParameter(String aP1, String aP2, String aP3) : Void

Returns or sets a parameter of the specified module. The parameter is specified by its name.
If the parameter is set, the specified value is passed.

String productID = WorkFlow.Parameter["Products", "ID"];

WorkFlow.setParameter("Reports", "DateRange", "200901-200912");
WorkFlow.Parameter["Reports", "Template"] = "landscape";

Tip You can use the Inspire Production Console (PNetTC) Workflow modules parameters as
parameters for Workflow.Parameter, e.g. WorkFlow.Parameter["DataIn
put1","dif"]. They are used the following way: WorkFlow.Parameter["<Module
Name>","parameter"], the parameter without the dash.

Scripting API | Workflow Methods

ProductVersion
ProductVersion : String
getProductVersion() : String

Returns a string that represents the version number of the product.

2084
 17.3 General Content Model

String productVersion = WorkFlow.ProductVersion; // productVersion =

"6.1.35.0"

Scripting API | Workflow Methods

showDialog
showDialog(String aMessage, Int aDialogType) : Int

Returns a code that indicates which button of the dialog box with the specified message and
of the specified type was pressed.

There are two types of dialog boxes available:

0 - An information dialog box with the OK button only. Returns always the value of 1.

1 - An optional dialog box with the Yes and No buttons. Returns the value of 2 or 3 if
the Yes or No button was pressed respectively. If the dialog is cancelled, the value of
zero is returned.

if (File.exist("C:\output.pdf")) {
if (WorkFlow.showDialog("Save the original file?", 1) == 2) {
File.move("C:\output.pdf", "C:\output_original.pdf");
} else {
logMessage("Original file has been overwritten.");
}
}

Scripting API | Workflow Methods

trackLogic
trackLogic(Bool aP1) : Void
trackLogic(Currency aP1) : Void
trackLogic(DateTime aP1) : Void
trackLogic(Double aP1) : Void
trackLogic(Int aP1) : Void
trackLogic(Int64 aP1) : Void
trackLogic(String aP1) : Void

Sets the specified value as the tracking condition. All records that do not match the condition
can be logged into an external file. For more details see the Logic tracking section.

Example We have a limited space for address and we want to see in Proof only customers
with different name lengths to check if all names fit there. To do so, we can run proofing
with logic tracking based on the customer name variable.

We create a new calculated variable Tracking of int 64 type (on the same level as customer
name variable CustName) with the following code:

2085
17 Scripting

WorkFlow.trackLogic(CustName.Length);

In Data Layout Properties we enable the Use logic tracking option, select the variable
Tracking and fill in the Error file name field:

After we run proof, we will only see those records where customers names have different
lengths.

Note If this is the first time Logic tracking is used, it will be necessary to change the
status of the duplicate records message in Warnings config (set message 0616 to Ignore)
before proofing takes place.

Scripting API | Workflow Methods

WorkFlowLocation
WorkFlowLocation : String
getWorkFlowLocation() : String

Returns the file path of the current workflow.

String filePath = WorkFlow.WorkFlowLocation;

// filePath = "C:\test.wfd"

Scripting API | Workflow Methods

WorkFlowVersionID
WorkFlowVersionId : Int
getWorkFlowVersionId() : Int

Returns an integer value that represents the version number of the given workflow if it is ver-
sioned via Inspire Content Manager (VCS). Returns -1 if the given workflow is not versioned.

Int workflowVersion = WorkFlow.WorkFlowVersionID;

2086
18 Examples of Use

18.1 Workflow Examples

18.2 Layout Module Examples
18.3 Production Examples
18.4 Complete Solution Examples
18 Examples of Use

18.1 Workflow Examples

18.1.1 How to Apply Transformations
In this section: See also:
Sheet Flipping Sheet Transformer Module
Sheet Rotation Booklet Maker Module
Output Module

You can do transformations (rotate, change scaling in both axis independently and set both
horizontal and vertical offsets) by using the Sheet Transformer and Output modules.

The content of the layout page can be designed to fit into a certain area of the page. The Sheet
Transformer module can be added between the Layout and Output modules in order to adapt
the layout to fit the page. You can specify the scale change, X and Y offsets and rotate the
layout.

18.1.1.1 Sheet Flipping

This example illustrates how it is possible to flip sheets using the Sheet Transformer module.
The transformation origin point is set to the top left corner of the sheet. When you enter a
negative scale value (such as -1), it means that sheet will be flipped.

Proof of the sheet without any transformation looks like this:

To flip the sheet, insert the Sheet Transformer module to your workflow and set the following
values:

1. Scale X is set to -1, so the sheet is flipped in horizontal axis (by its left border). If we
only set the Scale X to -1 and leave the other parameters at their original values, the
sheet will not be visible because it would be outside the printable area.

2. Set Offset X to 210 mm (in this example for A4 portrait).

2088
 18.1 Workflow Examples

Proof of the flipped sheet after transformation looks like this:

18.1.1.2 Sheet Rotation

Using the Sheet Transformer module is helpful if you cannot rotate sheets of paper in the
printer tray because of its size.

A cut sheet printer has its X axis and Y axis defined internally. Therefore, if you use a smaller
paper format ( e.g. A4), you can rotate the paper in the tray as you need. If you use a larger
paper format ( e.g. A3), you have to use the Sheet Transformer module to rotate the paper. If
you rotate the layout page in Sheet Transformer module by 90 degrees the page settings
change and it is necessary to set the size of the sheet in Output module so that they correspond
to the Layout page size.

1. The page is designed in the Layout module as A4 landscape (297mm/210mm) using

the Layout Properties panel of the page.

2. A proof of a sheet without any transformation looks like this:

2089
18 Examples of Use

3. The Sheet Transformer module has been used with the following values:

Rotate is set to 90. The sheet is rotated around the point [0,0], which is the top
left corner.

Offset X is set to 210 mm. If the Offset X is not set the sheet will not be printed
because it would be outside the printable area.

4. The Output module has been set using the Fill from Layout button and changing the
Size to portrait by clicking on the icon behind the drop-down menu.

5. A proof of the rotated sheet after transformation looks like this:

2090
 18.1 Workflow Examples

18.1.2 How to Create an Image Page Counter

In this section: See also:
Using Image Page Counter to Display a Image Page Counter
PDF PDF&PS Import
Using Image Page Counter to Display and
Recognize a PDF

This section contains two sample jobs showing how the Image Page Counter field converter
can be used for displaying the pages of a PDF file or of another image file format document
(e.g. TIFF).

Both sample jobs use Param Input in the workflow for easy path entering. Another advantage
of using Param Input is that it is generally applicable for any PDF you would like to use. Altern-
atively, it is possible to use other inputs instead.

Two possible scenarios of using the Image Page Counter are explained below. In the first sample
job, the workflow is only able to read and display the pages of a specified PDF document while,
in the second sample, the workflow is built to additionally recognize whether the input contains
a PDF document with some pages or whether it is empty (i.e. does not contain a PDF file). If
the input is empty a default page will be displayed instead.

18.1.2.1 Using Image Page Counter to Display a PDF

First create a simple workflow with the following modules:

Param Input This module is used to set the path and the name of the PDF file.

Data Transformer The Image Page Counter is set up in this module.

Layout A variable image and an according image area must be created here so that
the PDF can be displayed.

2091
18 Examples of Use

Setting Up the Param Input Module

Double-click on the Param Input module to open it. Create a new variable row by clicking on
the Create new variable icon and rename it to e.g. "PDF_source" in the Field Name and
Param Label columns. Enter the path and the PDF file name in the Default column:

Tip In this sample job, there is only one PDF source to be read. It is also possible to change
the PDF source in the Production window.

To do this, go to Production and select Window | Show Workflow Parameters to display

the Workflow Parameters window-pane:

Here you can enter a new path for a PDF source in the Value column of the row named
"PDF_source" (the row name is taken from the name entered in the Param Label column of
the Param Input dialog).

Setting Up the Data Transformer Module

Double-click on the Data Transformer module to display the Data Transformer dialog. Click on
PDF_source in the Input Data column and create a new linked field by clicking on the New
linked field icon. By linking a field you create an active duplicate of the PDF_source variable
which is necessary, as this variable will be used for two purposes:

To contain the content of the PDF you want to display

To be able to count the number of pages contained in the PDF

For this latter purpose you have to select Image Page Counter in the Field Converter column
of the linked field so that the total number of pages in the PDF document will be counted.
Rename the new linked field to "PDF_counter":

2092
 18.1 Workflow Examples

Setting Up the Layout Module

In order to use the result of the Image Page Counter for displaying all of the pages of the
specified PDF, it will be necessary to make various settings in Layout. Follow the steps described
below:

1. Set the variable selection of pages according to the PDF_counter.

2. Insert a variable image that contains the actual PDF.

Step 1 Creating Variable Selection of Pages

On the General tab of the Pages' Layout Properties panel select Variable selection in the Page
order combo-box and select PDF_counter in the Repeated by combo-box so that all of the
pages of the PDF will be displayed:

Step 2 Inserting a Variable Image

To be able to display the specified PDF source a variable image must be created.

To create a variable image, right-click on Images in the Layout Tree and select Insert Variable
Image from the context menu. A variable image will be created in the Layout Tree and its
Layout Properties will be displayed.

The content of the variable image is determined by the variable you specify in the Variable
combo-box on the Image tab of the Layout Properties. In this case select PDF_source, which
contains the path to the PDF.

2093
18 Examples of Use

Then go to the Page tab. Check Variable page selection and select PageArrayIndex from the
combo-box (see the screenshot below). Due to the variable PageArrayIndex, the variable image
(in this case the specified PDF file) will be displayed correctly; i.e. for each page in the original
PDF there will be one according page created when the job is proofed or printed.

The PageArrayIndex variable starts at 0 and keeps tracking which sub-record you are on which
enables the PDF document to be read from the first to the last page because the first page of
a PDF document also equals 0.

On the Advanced tab you can use some additional features for images, e.g. Font replacement
or Embedded profile usage. You can also select the option Load natively to enable the
Place native image in overlay and Use dynamic variables features.

2094
 18.1 Workflow Examples

Note These features on the Advanced tab cannot be used if you load the PDF natively via
Inspire Native module or the native import Layout menu option. See the chapter PDF&PS Import
for description of features available for the PDF native import.

Drag and drop the variable image from the Layout Tree to the upper left corner of the Layout
Area. Note that a new image area is created in the Layout Tree under the node of the page

that you have dragged the variable image to. The variable image space holder symbol
represents the variable image in the Layout Area. Click on the newly created image area (in
this case ImageArea1) in the Layout Tree and set its Content Tab as in the screenshot below
in order for the PDF pages to be displayed properly when proofing or printing.

Now press <F6> to proof the job and view the result of the settings applied above. For each
page of the original PDF there will be one according page in proof.

18.1.2.2 Using Image Page Counter to Display and Recognize

a PDF
In this sample job, the workflow is built to recognize whether the input is empty (i.e. does not
contain a PDF file) or whether it contains a PDF document with some pages. If the input file is
empty a default page will appear instead.

First create a simple workflow with the following modules:

Param Input This module is used to set the path and the name of the PDF file.

Data Transformer 1 The Image Page Counter is set up in this module.

Data Transformer 2 This module is used to enter a script which will make it possible
to display a default page if no PDF is detected.

Layout A variable image and an according image area must be created here so that
the PDF can be displayed and criteria must be determined to control when which page
will be displayed.

2095
18 Examples of Use

Setting Up the Param Input Module

See the section Setting up the Param Input module in the description of the first sample job
for details.

Setting Up the Data Transformer 1 Module

See the section Setting up the Data Transformer module in the description of the first sample
job for details.

Setting Up the Data Transformer 2 Module

In Data Transformer 2 click on PDF_counter and create a new linked field by clicking on the
Create linked field icon:

For this new linked field, select Script in the Field Converter column and then click on the
Expansion icon to open the Script editor and enter the script shown in the screenshot and
make sure the Output Type combo-box is set to Int:

Input in this script refers to the PDF_counter variable because PDF_counter0 is linked to it.
This script enables the default page to be shown when no PDF is detected.

If there is no PDF, the value -1 is returned by the Image Page Counter converter in Data
Transformer 1. But as the default page should be displayed in such a case, this script in Data
Transformer 2 is used, to get the value 1. After this variable is used for pages selection in Step
4 when setting up the Layout module, it causes showing the default page once, in case there
is no PDF detected.

2096
 18.1 Workflow Examples

Setting Up the Layout Module

In order to achieve the result desired in this sample job, it will be necessary to make various
settings in Layout. There is a certain logical sequence of steps according to which the job should
be created:

1. Create a new variable in the Layout Tree.

2. Insert a variable image that contains the PDF into the first page.

3. Create a second page (default page) that will be shown when no PDF file is detected.

4. Set the selection of pages i.e. under which conditions the default page should be
displayed.

All steps are explained below.

Step 1 Creating a New Variable

It is necessary to create a new variable in the Layout Tree. The script in this variable checks
whether the input contains any pages or whether it is empty. The variable will be used later in
the page selection logic to decide which page will be displayed. If it returns true the default
page will appear, otherwise the page with the PDF (displayed via a variable image) will be
shown.

To create the new variable right-click the Params node and select Insert Variable from the
context menu. Rename the newly created variable to "CheckEmptyPDF" for better handling:

Now click on the CheckEmptyPDF variable and make the following settings in the Layout
Properties:

On the Type tab select Calculated in the Kind combo-box and Bool in the Data-type
combo-box.

Go to the Script tab and enter the following script:

2097
18 Examples of Use

if (PDF_counter < 0) return true;

This script can also be simplified in the following way:

PDF_counter < 0

Step 2 Inserting a Variable Image

Insert the variable image containing the PDF into Page 1.

Step 3 Creating a Default Page

Now create a second page in your layout.

This page (named "Page 2" by default) will be the default page displayed when an empty input
has been detected. Insert some text or an image to this page so that you will be able recognize
it if it is displayed when proofing (in case that no PDF is found).

Step 4 Creating Variable Selection of Pages

On the Pages' General tab, select Variable selection in the Page order combo-box and in the
Repeated by combo-box select PDF_counter0.

The variable PDF_counter0 enables all pages of the PDF to be shown as well as the default
page to be selected once, if the input is empty according to the script entered in the Data
Transformer 2.

Now it is necessary to distinguish when which page should be displayed. To specify this beha-
vior, set Type to Select by condition. When the variable CheckEmptyPDF returns the value true,
indicating that no PDF input has been detected, the default page (Page 2) will be displayed.

2098
 18.1 Workflow Examples

The default variable covers the case that a PDF is detected and Page 1 (and thus the detected
PDF) will be displayed. Refer to the below screenshot to see the necessary settings:

Now press <F6> to proof the job and view the result of the settings applied above.

If the input file is empty the default page created will be displayed. Otherwise the PDF file will
be displayed just as in the first sample job.

18.1.3 How to Make a Booklet of Groups with

Variable Size
Very often you need to make a booklet from sheets with 4 pages printed on each of them,
and you want to stitch the sheets to groups that are of a variable size. Four pages would be
impositioned in the order 2-3-1-4, eight pages would be 2-7-1-8-4-5-3-6. Below is a sample
script to setup such impositioning in the Impositioning Script module.

It is also possible to use the Saddle Stitch module. This module automatically organizes the
sheets for duplex printing (2-UP) and performs sheet padding so that the total number of pages
is a multiple of four.

Example
function add(Int a)
{
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[a]);
}

function flushGroup(Int from,Int to)

{
Int cnt = to - from;
if(cnt%4 != 0)
{
logError("Document size must be mod 4!!!");
}
for(Int j = 0; j < cnt/2; j+=2)
{
Int idx1 = from+j;
Int idx2 = idx1 + 1;
Int idxN = to-j-1;

2099
18 Examples of Use

Int idxN_1 = idxN-1;

add(idx2);
add(idxN);
add(idxN_1);
add(idx1);
}
}

Int lastGroupBeginIdx = 0;
for(Int i=1;i<InputSheeter_0.SheetCount;i++)
{
SheetInfo s = InputSheeter_0.SheetInfo[i];
if(s.GroupBegin)
{
flushGroup(lastGroupBeginIdx,i);
lastGroupBeginIdx = i;
}
}
flushGroup(lastGroupBeginIdx,InputSheeter_0.SheetCount);

18.1.4 How to Print Pages in Reversed Order

In this section:
One Page per One Record
Multiple Pages per One Record

To print pages in reversed order, i.e. from the very last page to the very first, you can use one
of the following procedures based on the type of your job:

If you have one page for each record (e.g. a promotional letter for a customer), see the
One Page per One Record description.

If you have more pages for a record (e.g. a multi-page phone bill for a customer), see
the Multiple Pages per One Record description.

Tip In addition to the two procedures described in this section, it is also possible to use the
Imposition Script module, which works for any number of pages for a record:

Add the Imposition Script module between the Layout and Output modules with the following
script:

for(Int i=InputSheeter_0.SheetCount-1;i>=0;i--)
OutputSheeter_0.addSheetInfo(InputSheeter_0.SheetInfo[i]);

2100
 18.1 Workflow Examples

18.1.4.1 One Page per One Record

Use this sequence of steps, if you have a job with just one page for each record. There is no
limitation as for the number of records, just make sure to create a new variable for the sheet
name 3 and enter the correct code for it (as described below), if you have more than 10 records.

1. If you have less than 10 records, go to Pages family, to the Sheet Names tab and set
the sheet name with the index 3 (or any higher number) to system variable RecordIndex.
It will mark the records (and in this case also pages) with indexes 0, 1, 2, ... 9.

If you have more than 10 records and RecordIndex was used in a sheet name, it would
be processed as a string (sheet names are always strings) and sorted (if no conversion
is applied) in the following way: 0,1,10,100,1000,1001,1002 ...

So, for the correct functionality it is necessary to create a new variable that will be set
in the Pages family, on the Sheet Names tab:

Go to Data family in the Layout Tree and right-click on the SystemVariable node.
Select Insert Variable.

On the Type tab change the Kind to Calculated. Go to the Script tab and insert
the following script:

return RecordIndex.toString(3,true);

This will pad the RecordIndex variable with zeros for correct sorting: 000, 001, 002
...

If you have more records than 1000, use 4 (or a higher number) instead of 3 in
the script.

Then go to the Pages family, to the Sheet Names tab and set the sheet name with
the index 3 to the newly created variable.

2. Add the Sheet Sorter module between Layout and Output module and configure it in
the following way:

Select Sort groups, set Sheet name index to the same number as you selected in the
first step and check the Descending check-box.

2101
18 Examples of Use

18.1.4.2 Multiple Pages per One Record

Use this sequence of steps, if you have a job with more than one page for each record.

1. The first step is the same as described above for one page per one record.

2. Add the Sheet Regrouper module between Layout and Output module and select
Single group.

3. Insert the Sheet Sorter module after the Sheet Regrouper module and configure it in
the following way:

Select Sort sheets in group, set Sheet name index to the same number as you selected
in the first step and check the Descending check-box.

2102
 18.1 Workflow Examples

18.1.5 How to Set NS Splitting

In this section: See also:
Example 1: Duplex Type Option Sheet NS Splitter Module
Example 2: Split Type Option

This section presents examples of North/South splitting. They are related to the usage of spe-
cific options of the Sheet NS Splitter module: Duplex type and Split type together with Split
offset or Sheet count.

18.1.5.1 Example 1: Duplex Type Option

For each value of the Duplex type option there is an example of use presented below.

Simplex Example

Duplex X Example for both Duplex X change front page and Duplex X change back
page

Duplex Y Example for both Duplex Y change front page and Duplex Y change back
page

Simplex Example
This example presents a way to create two output sheets from seven pages in Layout using
the NS Splitter module configured in the following way:

1. Count X is set to 2 to determine that two input sheets will be printed across one output
sheet.

2. Offset X is set to a suitable value (e.g. 210 mm) so that the input sheets do not overlap.

3. Count Y is set to 2 to determine that two input sheets will be printed down one output
sheet.

2103
18 Examples of Use

4. Offset Y is set to a suitable value (e.g. 297 mm) so that the input sheets do not overlap.

5. Duplex type is set to Simplex.

0 2 1 3

4 6 5

The NS splitting is done vertically (from top to bottom). So if you imagine the first sheet on the
top of the second sheet and the NS splitting finished, you get two stacks:

On the left, pages 0 and 4 are stacked over pages 1 and 5.

On the right, pages 2 and 6 are stacked over page 3 and a blank page.

Additionally, the left stack can be placed over the right stack, cut from left to right and the top
stack placed over the bottom one, so that one single stack with pages 0, 1, 2 ... 6 (from top
to bottom) is created.

You may want to use this type of set-up for sorting the output according to postal codes. Direct
Mail shops often do a finishing procedure called a Y-Wire split e.g. A3 paper format comes
to the printer and it is vertically cut by wire into 2 A4 format papers. Then the two branches
of the Y go on and the sheets are cut horizontally into single pieces.

Duplex X Example
This example presents a way to create one output sheet (with two duplex pages) from seven
pages in Layout using the NS Splitter module configured in the same way as for the Simplex
example above, only the Duplex type option is set differently.

2104
 18.1 Workflow Examples

The duplex X (on the axis X) can be set up in two ways in the NS Splitter to print the back pages
on the other side of the correct front pages:

You can either change the page order on the front page. Select the value Duplex X
change front page for the option Duplex type.

Or you can change the page order on the back page. Select the value Duplex X change
back page for the option Duplex type.

Note To understand the example images, always compare them with the simplex example
above. It may also help to visualize the simplex example (2 sheets) but with the change that
the sheet 2 is folded from right to left (as if behind sheet 1) to get the duplex "view".

Duplex Y Example
This example presents a way to create one output sheet (with two duplex pages) from seven
pages in Layout using the NS Splitter module configured in the same way as for the Simplex
example above, only the Duplex type option is set differently.

2105
18 Examples of Use

The duplex Y (on the axis Y) can be set up in two ways in the NS Splitter to print the back pages
on the other side of the correct front pages:

You can either change the page order on the front page. Select the value Duplex Y
change front page for the option Duplex type.

Or you can change the page order on the back page. Select the value Duplex Y change
back page for the option Duplex type.

Note To understand the example images, visualize two simplex sheets below one another
(as if the sheet 2 was printed below sheet 1) and then sheet 2 was folded from the bottom
upwards (as if behind sheet 1) to get the duplex "view".

18.1.5.2 Example 2: Split Type Option

We have a workflow that will create two thousand sheets from the pages in Layout and we
want to arrange an NS split of two of these input sheets onto one simplex output sheet.

1. Set Count X to 2 to determine that two input sheets will be printed across one output
sheet.

2. Set Offset X to a suitable value (e.g. 105 mm) so that the input sheets do not overlap.

3. Set Count Y to 1 to determine that the input sheets will only be multiplied in the X
direction.

4. Set Duplex type to Simplex.

2106
 18.1 Workflow Examples

5. Now compare the following three settings of Split type:

If the option Split type is Simple and Split offset is 0, all of the input sheets will
be automatically divided into two halves that are distributed evenly between the
output sheets: The first half on the left side and the second half on the right.

1 1001

1000 2000

If the option Split type is Simple and Split offset is 500, after the first five hundred
input sheets are printed on the left side, then the NS split occurs and the right side
of the output sheets is filled with the next five hundred input sheets.

1 501

500 1000

No further input sheets will be processed, so the remaining one thousand sheets
will not be printed.

If the option Split type is By count and Sheet count is 500, after the first five
hundred input sheets are positioned on the left side, then the first NS split occurs
and the right side of the output sheets is filled with the next five hundred input
sheets.

2107
18 Examples of Use

Then the following five hundred input sheets are positioned (on the left) and the
next NS split is made and the final five hundred input sheets complete the package
(on the right).

1 501

500 1000

1001 1501

1500 2000

18.1.6 How to Use the AFP Index Module

See also:
AFP Index Module

One practical use of the AFP Index module is to add objects to an existing AFP file, for example
a barcode that represents an account number.

In the following example, we will import the indexed AFP file 'indexer.afp' as a native file. The
file has a TLE page index which identifies the pages by account number only (i.e. only one index
is in the file), e.g. pages 1-10 are for account 48921 and pages 11-17 are for account 39635
etc.

We want to add a barcode to each page that encodes the account number to which that page
belongs. However, when imported the AFP file will no longer contain variable data (i.e. its index)
and so no account number can be used as the variable for a barcode. But, by using the AFP
Index module in parallel to the Inspire Native module we can create a Layout which creates
the same number of sheets as the imported AFP file.

2108
 18.1 Workflow Examples

Then, we can use the Sheet Mixer module to overlay the layout sheets onto those from the
AFP file, thus combining them.

In addition, by placing a barcode that encodes the account numbers (read from the index of
the AFP file), the combined sheets can contain the barcode on each page.

In order to make the above described workflow:

1. Use the Param Input module to create a field that describes the path to the AFP file:

2109
18 Examples of Use

The important columns here are the Field Name (to identify the field that will be cre-
ated) and the Default (to return a string value which described the path to the AFP
file).

2. Use the Inspire Native module to import the AFP file:

By selecting Run from input data the path defined in the field created by the Param
Input module will be used to import the AFP file.

2110
 18.1 Workflow Examples

3. Use the AFP Index module to read the index from the AFP file:

By selecting the field created by the Param Input module, the path it describes will be
used to read the index from.

4. Add a Layout module after the AFP Index module and you will see that the TLE index
appears as an array in the Data family of the Layout Tree:

2111
18 Examples of Use

You can also check that the data is being repeated by the new array in the Records
by for the Layout Properties of the Data family:

5. Set the pages of the design to be Repeated by the TLE array (so that it appears every
time the TLE array returns a set of values) on the General tab of the Pages family:

For this example, it is important that there is only one index set in the AFP file so that
only one value returned for each page in the AFP file. This ensures the number of pages
produced by this Layout is the same as the number of pages in the AFP file.

6. On Page 1 (the only page of the layout design) draw a barcode using the Barcode
Tool :

2112
 18.1 Workflow Examples

Then select the AttributeValue variable (that was created by the AFP Index module) in
the Variable combo-box on the Content tab of the barcode:

The AttributeValue variable is the one that returns the index value which is the account
number in this example, and so the barcode will encode the account number on each
page and each page corresponds to a page from the AFP file.

7. Combine the sheet outputs from the Layout and Inspire Native module using a Sheet
Mixer module which does not require configuration.

However, any non transparent objects (e.g. images) from the sheets of the bottom input
of this module are placed on top of objects that arrive via the top input, therefore it is
better to connect the Layout with the barcode to the bottom input (input B) of the
Sheet Mixer module.

8. Finish the workflow with an Output module which, in this case, does not require con-
figuration.

When this workflow is run in Proof or Production, the pages from imported AFP file will contain
the barcode chosen in the Layout module. That barcode will have encoded the account number
from the index of the same AFP file.

18.1.7 How to Use Error Recovery

In this section: See also:
How to Log Errors in Layout Typical Data
Usage Warnings
How to Use Record Filter Module for
Reprint
How to Log Errors in Data Transformer
How to Log Errors in XML Data Input

The error recovery functionality is used in case that you want to forbid printing records for
which a warning (or an error) is issued, fix these issues later and print only these records again.

If error recovery is used in Layout (typical usage), the records that are subject to a warning (or
an error) can be logged into an external TXT error file. You can either use the created error log
file just for checking the records with errors and fixing them, or even to select only those pre-

2113
18 Examples of Use

viously not printed records for reprint. See the setup in the section How to Use Record Filter
Module for Reprint.

Error recovery can be set also in other modules: in XML Data Input and in Data Transformer.
Then you can either work further with the Boolean variable used for detecting the errors (it
will contain true if a warning or an error is issued), or use this error in Layout and also log the
records with issues into the error file.

18.1.7.1 How to Log Errors in Layout Typical Usage

Error recovery for a Layout module is set the following way:

1. In Layout check Use error recovering on the Data Layout Properties panel.

Define a file name and directory for the error recovering TXT file in the Error file name
edit-box.

Both these options can also be switched on and off in the Workflow Parameters window-
pane which is accessible from Proof or Production.

2. Go to the Proof or Production environments and open the Warnings Config Dialog.

To select which warnings (or errors) should be "recovered", i.e. not printed but logged
into the file for later fix and reprint, go to the Warnings Config Dialog and there make
the following settings:

For warnings (Severity in the Proof/Production Log window-pane is Warning) set

the value in the Abort combo-box to Recoverable.

For errors (Severity in the Proof/Production Log window-pane is Fatal/Critical error)

set the value in the Abort combo-box to Ignore.

Note

The error recovery functionality is typically used for warnings (e.g. overflow in
flows) leaving the errors at their default settings to abort the job.

For the complete list of Severity and Abort values and the resulting behavior see
the Warnings/Errors Behavior section.

3. Process the workflow either in Proof or Production.

4. Collect the error recovering TXT file from the directory that you defined for it and read
it. It lists the index numbers of all records that had errors. The first record's index is 0,
the second is 1 etc.

You can now fix the errors in the workflow and use the TXT file with the Record Filter
module to reprint those records again. See Record Filter Module and Error Recovery
below.

2114
 18.1 Workflow Examples

18.1.7.2 How to Log Errors in Data Transformer

The steps above will only list errors that occur during the processing of the Layout module to
the error recovering TXT file, however it is also possible to list any errors that occur in the Data
Transformer module.

1. Open the Data Transformer module.

2. Select the array which contains the fields that may contain errors and click on the Mark
array for save icon.

The Mark array for save icon is the one that is first on the left. The array name
should now be shown in red color with a pin icon indicating that it will be saved.

3. Select any field inside that marked array and click on the Create Unlinked icon and
choose Boolean data-type.

The new field should appear at the bottom of data structure but directly within the
marked array.

Note It is also possible to use an existing Boolean variable (e.g. from a previous Data
Transformer or from the XML Data Input see below). Then you can check if an error
occurs in any of the modules, i.e. once an error occurs in the record, the value of the
variable changes to true (1) and then keeps this value even if no error occurs in the
next module. This means that the default value of the Boolean variable at the start
should be false (0) so that you can distinguish the good records from those that contain
an error in one of the modules.

4. Click on the Mark for Error icon.

The new Boolean field should now be marked with an exclamation mark (!) to indicate
that it is the error variable. This variable will return true if an error occurs for any partic-
ular record.

If it is impossible to select Mark for Error then double-check that you have selected
a variable on the correct level in relation to the marked array.

5. Select the new field and rename it, e.g. to ErrorRecovery.

2115
18 Examples of Use

6. Now you can work further with the ErrorRecovery variable checking if it contains true
for any of the records, which would mean that the record contains an error.

Or you can use this variable in Layout: select the Data family and in the Data Layout
Properties select the newly created Boolean variable (e.g. ErrorRecovery) in the Data
error var. combo-box.

If you enable the Use error recovering check-box and enter the Error file name, the
records which contain errors will be recorded in the error file.

Note Any user created Boolean variable can be selected in the Data error var. combo-
box and will then work as the error checking variable.

7. Perform steps 2 (to select which warnings/errors should be "recovered"), 3 and option-
ally (if settings in Layout are used) 4 from the Layout example above.

The error recovering TXT file will now list all records with data conversion errors as well as errors
in Layout.

18.1.7.3 How to Log Errors in XML Data Input

It is also possible to track errors that occur in XML data when it is read into the workflow.

1. Open the XML Data Input module.

2. For the desired array select Error Recover in the Change column.

This could be any array with Optionality Zero or more or One or more but it should
be the array that may contain errors.

A Boolean variable (called ErrorRecovery by default) is now created in the data structure,
directly within the array that was set to Error Recover. This variable will return true if
an error occurs in the XML for any particular record.

3. Perform steps 6 and 7 from the above example How to Log Errors in Data Transformer.

2116
 18.1 Workflow Examples

The ErrorRecovery variable created in the XML Data Input Module can also be marked with
Mark for Error in the same way as shown in steps 2 to 5 in the above example How to Log
Errors in Data Transformer. If this is done, the variable will return true if an error occurs in either
the XML data or a Data Transformer conversion.

18.1.7.4 How to Use Record Filter Module for Reprint

This feature is useful if you want to continue printing a job even though some records may
contain errors. The records with errors are not printed but are logged into a file using the error
recovering options in Layout and then you can fix the records that had problems and use the
error recovering TXT file to reprint only those records that contained the errors.

To set up the workflow for reprint, make the following settings:

1. Follow the steps from the How to Log Errors in Layout chapter above to create the error
TXT file from a workflow.

2. Insert the Record Filter module between the used data input and Layout module (into
the original workflow).

3. Set the error recovering TXT file that was generated during the first run into the Input
file field of the Record Filter.

4. Use the Dont pass through records which are in file check-box to determine what
is to be printed.

If checked, all records, except the ones listed in the error file, are printed.

If unchecked, only the records listed in the error file are printed. So, leave the option
unchecked for the reprint.

18.1.8 How to Use File Content as a Variable

This example shows how to use Inspire Designer to read the content of a TXT file and return
its content in a variable.

This procedure can be used, for example, in case that you have a file with already pre-defined
spaces in text that you would like to keep, or you have a text file with a simple (marketing)
message, which you would like to update occasionally but without changing the workflow.

2117
18 Examples of Use

You set the name of the file as an input and you get a string with the file content as an output,
using the field converter File Content.

1. Create a new workflow and use the Param Input module to create a variable which
contains the path to the file the content of which you want to read, e.g. FileName
variable of the File type. You can also use a variable coming from your data.

2. Add the Data Transformer module to your workflow. Click on the variable with the file
path and create a new linked variable by clicking on the Create linked field icon.
Rename this new variable to e.g. FileContent and apply the File content converter to
it.

3. If you have more lines in the TXT file, you may like to add a script for removing the
'x0A' character (hexadecimal), because Inspire Designer automatically adds a new line
on both characters: x0A (soft enter) and x0D (hard enter).

Add the Layout module and go to the Layout Properties, Conversion tab of the FileCon-
tent variable. In the Conversion combo-box select Script and add the script there.

2118
 18.1 Workflow Examples

Note It is also possible to do Steps 2 and 3 both in Data Transformer, using the
Conversion Stack FCVs first selecting the File content conversion and then the Script
conversion.

18.1.9 How to Use the Statistic Data Module

See also:
Statistic Data Module

This example shows how to extract data from PDF files and use them for barcodes that are al-
ways added to the first page of each PDF.

The Statistic Data module is used to pass on the sheet name values as data. The data can then
be used as variables for the barcodes.

The example workflow looks like this:

To set up this workflow, follow these steps:

1. To read multiple PDF files from the same directory as the workflow is, insert the Script
Data Input module. In the Structure part create an array called e.g. PDFs and in this
array then create a String variable called e.g. PDF. Then add the following script to the
scripting area:

String dir = ".\";

File.FileInfoList list;
File.listWithMask(list,File.ListParam.Files,dir,"*.pdf");
for (Int i=0;i<list.Size;i++)
{
PDFs.PDF = list[i].Location;

2119
18 Examples of Use

PDFs.commit();
}

2. To process the PDF files add the Inspire Native module and set it to Run from input
data in this case. Make any additional settings according to your PDF files in this
module or in the Workflow Options dialog: PDF&PS Import.

Tip

You can add the Output module behind the Inspire Native module at this stage
and proof your workflow to see if the PDF files are read correctly.

Check also the PDF/PS/EPS Native Import Known Limitations to see if all features
of your PDF files can be imported.

3. To select the parts of the PDF files to become data for barcodes creation, add the Text
in Rect module to your workflow and connect it behind the Inspire Native module.

Use the module to:

Create a rectangle to select the data you need.

Select the Set as sheetname value in the Operation comb-box and enter the Sheet
name index, into which the value will be saved. (Both options are available in the
Function part of the dialog).

4. To pass the value, which has been extracted from each PDF file and set to a sheet name,
further on to the Layout so that it can be used as data for a barcode, add the Statistic
Data module into your workflow. Simply said, this module is used to "create data" out
of the sheet name values.

On the Sheet Names tab make the following settings:

Select Array of groups with array of sheets in the Data structure combo-box. This
will ensure that for each page of the input (of the PDF) there will be one record in
the data created (so for each PDF page the sheet name values can be dis-
played/used). Also the information about groups/records will be kept, i.e. if there

2120
 18.1 Workflow Examples

are more pages per one PDF (for one customer), this connection about how many
pages there are per one PDF is kept.

Select Selected sheet names in the Sheet names combo-box and add that one or
those ones into which you have extracted the data in the Text in Rect module. Add
names to the variables to be created in the Output Field Name, e.g. BarcodeData.

5. To use the sheet name values taken from the PDF files to create a barcode, add the
Layout module into your workflow.

After connecting it behind the Statistic Data module, the Data family will be fed with
data coming from the Statistic Data.

The option Records by is automatically set to the Groups array.

Use the Barcode Tool to add a barcode at the desired position of a page. Select the
Barcode type on the Content tab of the barcode Layout Properties and select the
variable containing the data from the PDF file (e.g. BarcodeData) in the Variable combo-
box.

Note If you had several data parts extracted to several sheet names in the Text in
Rect module and they were passed via Statistic Data to your Layout module as separate
variables, you can connect them into one variable to be used as the barcode variable.
To do so, add a new variable of String data-type on the same level as your original
variables (under Sheets Value in the Data family). Set its Kind to be Calculated and
add a script e.g. like this on the Script tab:

BarcodeDataPart1 + '\n' + BarcodeDataPart2

The '\n' in the example stands for a line break and can be added if you require it in
your data and if the barcode specification enables it.

2121
18 Examples of Use

6. To place the barcode on the first page for each record, i.e. to be printed over each first
page of the PDF, make the following settings in the Layout module where you have
just created the barcode:

Go to the Pages family and on its General tab set Variable selection as Page order
and Sheets array in Repeated by combo-box.

Create a new variable of Bool data-type in the System Variable node. Change the
Kind to Calculated and add the following script to return true for each first page
of the record (which corresponds with the first page of the PDF thanks to the
Statistic Data settings):

PageArrayIndex == 0

Note This Bool variable can be created also at another place (level) in the Data
node. Then it is necessary to add the reference to the system variable node:

SYS.PageArrayIndex == 0

Tip If you want to add page counting system variables (e.g. PageCounter that returns
page numbers within one record, GlobalPageCounter that returns page numbers
within all records or GlobalPageCount that returns the sum of all pages), you can add
them to the Layout with barcode and they will work correctly in this setup.

7. To mix together the output of the Inspire Native module, i.e. the PDF files, with the
output of the Layout module, i.e. the barcodes, add the Sheet Mixer module to your
workflow and connect the Inspire Native module to its upper input and the Layout to
the bottom input. This way the barcodes will be printed over the PDF content.

8. Add the Output module configured according to your needs (media size and specific
device profile settings for the intended output engine) at the end of the workflow.

18.2 Layout Module Examples

18.2.1 How to Use First Fitting
18.2.1.1 First Fitting Overview
The first fitting feature is useful when you want to adapt the content of a flow area so that
the available space is used effectively, or if you need the text in a flow to be displayed whole
(even if in smaller font).

2122
 18.2 Layout Module Examples

It might happen that the content of a flow exceeds the flow area limits (because of a large
font etc.). In such a situation, you may set either:

An alternative flow to be printed instead (see How to Use First Fitting).

Resizing of the flow content either proportionally (by specifying a percentage value),
by absolute size in points or by horizontal scaling (see How to Use First Fitting Auto).

This means that there is no list of alternative flows (as with First Fitting) but the applic-
ation tries to adapt the content automatically.

You can set the direction in which the First Fitting feature should be applied to the flow area.
Go to the flow area Layout Properties, Content tab, and there you can set the Fitting property
to either of the following values: Both (default), Horizontal or Vertical.

Please continue to:

How to Use First Fitting

How to Use First Fitting Auto

18.2.1.2 How to Use First Fitting

See also:
First Fitting Overview

When you adapt the content of the flow area to the available space you can specify several
alternative flows with different content or size. First Fitting option can be also used for:

flow areas that are set to overflow to next page

flow areas containing tables (the First Fitting option is applied to texts in cell flows in
cells with fixed or maximum height and the Fitting option for the flow area needs to
be set to Both or Vertical)

2123
18 Examples of Use

Example First, create a flow area. A new empty flow creating the content of the flow
area will be automatically created. Then mark the flow as First fitting. You can then create
a set of alternative flows (in this example Flow3, Flow4, Flow5) that can be used in pro-
duction according the available space.

During production all the flows belonging to the list will be preprocessed in ascending
order to check if they fit in the limits of the flow area. The first flow that satisfies these
criteria is printed.

IDFFGroup
Specifies 'connection' among several flow areas using the First Fitting feature. It means that
all flow areas with the same IDFF number are tested to fit until all the flow areas find the ap-
propriate flow that fits. Using this option increases processing speed and ensures all the flow
areas with the same IDFF number look consistent (see the examples below).

IDFF group set to 0 (zero) is default and means no connection.

The maximum number of iterations (to find the fitting flow) for all the flow areas with the same
IDFF number is then set as number of iterations for each corresponding flow area's flows list.

Example We have three flow areas and their flows are all set to be First fitting types
and IDFF Group is set to 1 for all of them. Each of the three flows has defined 7 alternative
flows- with gradually decreasing size.

When the processing is started, Inspire Designer finds out that the first fitting flow:

of the 1st flow is its second alternative flow in the list

of the 2nd flow is the fourth alternative flow in the list

of the 3rd flow is the second alternative flow in the list

2124
 18.2 Layout Module Examples

As the three flows have the same IDFF Group number, the fourth alternative flow will be
used for all of them (it is the fourth biggest flow and it will also fit safely into the 1st and
3rd flow). If the three flows did not have the same IDFF Group number, different altern-
ative flows would be used (the fist ones found as fitting, regardless of the other flows).

Example IDFF Number can be also used to control the combinations of alternative flows
that are used for First fitting.

We have two flows of the First fitting type with the same IDFF Group number and with
the following alternative flows:

Flow 1 Flow 2

Alternative Flow 1A - font size 12 Alternative Flow 1B - font size 14

Alternative Flow 2A - font size 10 Alternative Flow 2B - font size 12
Alternative Flow 3A - font size 8 Alternative Flow 3B - font size 10

Inspire Designer will try first Alternative Flows 1 for both flows and if they fit, they will be
used. If they do not fit, Alternative Flows 2 will be tested and if they fit, they will be used
for both flows. If they don't, Inspire Designer will try to use Alternative Flows 3. If they
do not fit either, they get used but you will receive a warning.

If you wish to avoid using for example font sizes 10 and 12 in the two flows at the same
time, you can define the alternative flows in the following order:

Flow 1 Flow 2

Alternative Flow 1A - font size 12 Alternative Flow 1B - font size 14

Alternative Flow 2A - font size 10 Alternative Flow 3B - font size 10
Alternative Flow 3A - font size 8 Alternative Flow 3B - font size 10

If the number of alternative flows is not the same, the last one is used again:

Flow 1 Flow 2

Alternative Flow 1A - font size 12 Alternative Flow 1B - font size 14

Alternative Flow 2A - font size 10 Alternative Flow 2B - font size 12
Alternative Flow 3B - font size 10

In this case the third combination of alternative flows to be assessed for First fitting is Al-
ternative Flow 3B and Alternative Flow 2A.

2125
18 Examples of Use

18.2.1.3 How to Use First Fitting Auto

See also:
First Fitting Auto
First Fitting Overview

The first fitting auto functionality is useful when you want to adapt the content of a flow area
so that the available space is used effectively and the whole content is visible. See the First Fitting
Overview for a summary of the different types of first fitting options available.

When you adapt the content of a flow area to the space available there using First fitting auto
you can use only one flow. Its size will be dynamically adjusted until it fits into the flow area.
You can set Inspire Designer to decrease the size of the content of the flow in the following
ways:

fonts can be resized either proportionally (by specifying a percentage value) or by abso-
lute size (in points).

fonts can be horizontally scaled (by specifying a percentage value).

Example To use this functionality follow the steps described below:

1. In the Layout Tree, select the flow for which you would like to use the first fitting
auto functionality and in the Type combo-box select First fitting auto.

2. Now it is necessary to define how the first fitting auto action will be performed.
The settings for this procedure can be made in the Layout Properties panel of the
flow:

There are the following possibilities of defining the nature of the first fitting auto
procedure:

Horizontal Scaling of Fonts

You can scale the content of the flow horizontally. To use only this method,
make sure that the value for % font descent / Point font descent (depend-
ing on which edit-box is being used, see the following point of this description
for details) is '0' so that no resizing of fonts is performed.

2126
 18.2 Layout Module Examples

Then, set the % value by which the horizontal scaling should be performed
at each iteration in the Hor. scale % edit-box. The % value set here refers
to the base value, i.e. the scaling performed at each iteration is constant (e.g.
when set to 10% the first iteration is 90%, the second one is 80% etc.)

Finally, it is necessary to set the maximum number of iterations which should

be performed in the Hor. scale iter. edit-box. If the amount of iterations set
in Hor. scale iter. is reached and the flow still does not fit into the flow area,
then the flow is printed using the last iteration values (i.e. not all of the text
will be visible).

For an example of the appearance of horizontally scaled text see the descrip-
tion of the Horizontal scale option on the More tab of the Text Styles layout
properties.

Resizing Fonts

Alternatively, you could choose to perform first fitting auto by resizing fonts
(font descent). To use only this method, be sure that Hor.scale iter. is set to
'0' so that no horizontal scaling is performed.

Use the Use % value option to decide whether you would like to specify the
font descent value proportionally or by absolute size. When Use % value is
checked, each iteration performs a proportional change of the font size in
the flow using the set % font descent value. The % value refers to the base
value, i.e. resizing of fonts is constant (when set to 10% the first iteration is
90%, the second one is 80% etc.). When Use % value is unchecked, the
font size is decreased in absolute steps depending on the value specified for
Point font descent.

Finally, it is necessary to set the maximum number of iterations which should

be performed in the Max iter. count edit-box. If the amount of iterations
set in Max iter. count is reached and the flow still does not fit into the flow
area, then the flow is printed using the last iteration values (i.e. not all of the
text will be visible).

Combining Both Methods

It is also possible to make settings for both methods simultaneously. If you

do so, the first fitting auto procedure will be performed in the following way:

a. Horizontal scaling is performed for as many iterations as have been set

(no resizing of fonts occurs).

b. If, after all iterations set for horizontal scaling have been performed, the
text still does not fit into the flow area, Inspire Designer will start with
the resizing of fonts. Resizing of fonts begins from the result of the last
iteration of horizontal scaling.

3. Now you can proof or produce the workflow containing the flow for which First
fitting auto has been set. The flow will be preprocessed and the first fitting actions
(i.e. resizing and/or scaling) specified in the layout properties will be employed.
The first iteration of the resizing and/or scaling of the flow which fits into the flow
area will be used.

2127
18 Examples of Use

Note If the maximum set number of iterations is reached, but the text still does
not fit into the flow area, the text will be printed using this view, i.e. not all of
the text will be visible.

18.2.2 How to Code Conditional Flow in XML

The following code illustrates a layout using a conditional flow that prints two different mes-
sages, based on current data values:

2128
 18.2 Layout Module Examples

Copy and paste this file into a text file. Save it as example.xml. Then enter it into Inspire Designer.

UTF-8
<WorkFlow>
<Layout>
<Id>Layout1</Id>
<Name>Layout1</Name>
<ModulePos X="30" Y="12"/>
<Layout>
<Variable>
<Id>0</Id>
<Name>Array</Name>
<ParentId>Def.Data</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</Variable>
<Variable>
<Id>1</Id>
<Name>Value</Name>
<ParentId>0</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</Variable>
<Variable>
<Id>2</Id>
<Name>Amount</Name>
<ParentId>1</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</Variable>
<Variable>
<Id>3</Id>
<Name>Count</Name>
<ParentId>0</ParentId>
<IndexInParent>1</IndexInParent>
<Forward/>
</Variable>
<Page>
<Id>4</Id>
<Name>Page1</Name>
<ParentId>Def.Pages</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</Page>
<FlowArea>
<Id>5</Id>
<Name>FlowArea1</Name>
<ParentId>4</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</FlowArea>
<Flow>

2129
18 Examples of Use

<Id>6</Id>
<Name>SelectionFlow</Name>
<ParentId>Def.FlowGroup</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</Flow>
<Flow>
<Id>7</Id>
<Name>Pay</Name>
<ParentId>Def.FlowGroup</ParentId>
<IndexInParent>1</IndexInParent>
<Forward/>
</Flow>
<Flow>
<Id>8</Id>
<Name>SpendEvenMore</Name>
<ParentId>Def.FlowGroup</ParentId>
<IndexInParent>2</IndexInParent>
<Forward/>
</Flow>
<Font>
<Id>9</Id>
<Name>Impact</Name>
<ParentId>Def.FontGroup</ParentId>
<IndexInParent>1</IndexInParent>
<Forward/>
</Font>
<Color>
<Id>10</Id>
<Name>Red</Name>
<ParentId>Def.ColorGroup</ParentId>
<IndexInParent>1</IndexInParent>
<Forward/>
</Color>
<TextStyle>
<Id>11</Id>
<Name>TextStyle3</Name>
<ParentId>Def.InvisibleTextStyleGroup</ParentId>
<IndexInParent>0</IndexInParent>
<Forward/>
</TextStyle>
<FillStyle>
<Id>12</Id>
<Name>RedFill</Name>
<ParentId>Def.FillStyleGroup</ParentId>
<IndexInParent>1</IndexInParent>
<Forward/>
</FillStyle>
<Root/>
<Data>
<Id>Def.Data</Id>
<RepeatedBy>0</RepeatedBy>

2130
 18.2 Layout Module Examples

</Data>
<Variable>
<Id>0</Id>
<Type>DataVariable</Type>
<VarType>Array</VarType>
<InsideFnc>0</InsideFnc>
<PresentationType>ConcatenateAll</PresentationType>
<InsertBetween>&#xa;</InsertBetween>
<EmptyText/>
<DisplayName/>
</Variable>
<Variable>
<Id>1</Id>
<Type>DataVariable</Type>
<VarType>SubTree</VarType>
<InsideFnc>-1</InsideFnc>
<PresentationType>ConcatenateAll</PresentationType>
<InsertBetween>&#x20;</InsertBetween>
<DisplayName/>
</Variable>
<Variable>
<Id>2</Id>
<Type>DataVariable</Type>
<VarType>Currency</VarType>
<Content>0</Content>
<InsideFnc>0</InsideFnc>
<PresentationType>Simple</PresentationType>
<DisplayName/>
</Variable>
<Variable>
<Id>3</Id>
<Type>DataVariable</Type>
<VarType>Int</VarType>
<Content>0</Content>
<InsideFnc>-2</InsideFnc>
<DisplayName/>
</Variable>
<Variable>
<Id>Def.SystemVariables</Id>
<Type>DataVariable</Type>
<VarType>SubTree</VarType>
<InsideFnc>-10</InsideFnc>
<PresentationType>ConcatenateAll</PresentationType>
<InsertBetween>&#x20;</InsertBetween>
<DisplayName/>
</Variable>
<Pages>
<Id>Def.Pages</Id>
<SelectionType>Simple</SelectionType>
</Pages>
<Page>
<Id>4</Id>

2131
18 Examples of Use

<ConditionType>Simple</ConditionType>
<Width>0.21</Width>
<Height>0.297</Height>
<NextPageId/>
<LogicalPageNameType>Simple</LogicalPageNameType>
<LogicalPageName>Main</LogicalPageName>
<LogicalPageName2VariableId/>
</Page>
<FlowArea>
<Id>5</Id>
<Pos X="1.5e-002" Y="1.27e-002"/>
<Size X="8.66e-002" Y="6.73e-002"/>
<Rotation>0</Rotation>
<Skew>0</Skew>
<FlipX>False</FlipX>
<Scale X="1" Y="1"/>
<IsVisible>True</IsVisible>
<IsLocked>False</IsLocked>
<VariablePosXId/>
<VariablePosYId/>
<PrintState>Always</PrintState>
<FlowId>6</FlowId>
<NextFlowAreaId/>
<BorderStyleId/>
<FlowingToNextPage>False</FlowingToNextPage>
<BorderType>Content</BorderType>
</FlowArea>
<Flow>
<Id>6</Id>
<Type>InlCond</Type>
<Variable>1</Variable>
<Condition Value="Amount &gt; Currency(0.0)">8</Condition>
<Default>7</Default>
</Flow>
<Flow>
<Id>7</Id>
<Type>Simple</Type>
<FlowContent Width="0.5">
<P Id="Def.memberStyle">
<T Id="11">PAY</T>
</P>
</FlowContent>
</Flow>
<Flow>
<Id>8</Id>
<Type>Simple</Type>
<FlowContent Width="0.5">
<P Id="Def.memberStyle">
<T Id="Def.TextStyle">Your balance is cool. Buy such and such.</T>
</P>
</FlowContent>
</Flow>

2132
 18.2 Layout Module Examples

<Font>
<Id>Def.Font</Id>
<Normal>
<FontIndex>0</FontIndex>
<FontLocation>FONT_DIR,arial.ttf</FontLocation>
</Normal>
</Font>
<Font>
<Id>9</Id>
<Normal>
<FontIndex>0</FontIndex>
<FontLocation>FONT_DIR,impact.ttf</FontLocation>
</Normal>
</Font>
<Color>
<Id>Def.Color</Id>
< RGB >0,0,0
< CMYK >0,0,0,1
< LAB >0,0,0
< HSB >0,0,0
<SpotColor>-1</SpotColor>
</Color>
<Color>
<Id>10</Id>
< RGB >1,0,0</ RGB >
< CMYK >0.00050355,0.97206074,0.83758295,0.00035096</ CMYK >
< LAB >0.5428769,0.63145846,0.54609823</ LAB >
< HSB >0,1,1</ HSB >
<SpotColor>-1</SpotColor>
</Color>
<memberStyle>
<Id>Def.memberStyle</Id>
<AncestorId/>
<LeftIndent>0</LeftIndent>
<RightIndent>0</RightIndent>
<FirstLineLeftIndent>0</FirstLineLeftIndent>
<SpaceBefore>0</SpaceBefore>
<SpaceAfter>0</SpaceAfter>
<LineSpacing>0</LineSpacing>
<LineSpacing>Aditional</LineSpacing>
<DefaultTextStyleId>Def.TextStyle</DefaultTextStyleId>
<NextmembergraphStyleId/>
<BorderStyleId/>
<NewAreaPageAfter>None</NewAreaPageAfter>
<HAlign>Left</HAlign>
<IsVisible>True</IsVisible>
<ConnectBorders>False</ConnectBorders>
<WithLineGap>False</WithLineGap>
<BullettingId/>
<IgnoreEmptyLines>False</IgnoreEmptyLines>
<TabulatorProperties>
<Default>0.0125</Default>

2133
18 Examples of Use

</TabulatorProperties>
</memberStyle>
<TextStyle>
<Id>11</Id>
<AncestorId>Def.TextStyle</AncestorId>
<FontSize>0.00705556</FontSize>
<FillStyleId>12</FillStyleId>
<IsVisible>False</IsVisible>
<FontId>9</FontId>
<InheritFlag>
<Font/>
<FontSize/>
<FillStyle/>
</InheritFlag>
</TextStyle>
<TextStyle>
<Id>Def.TextStyle</Id>
<AncestorId/>
<FontSize>0.00352778</FontSize>
<LineWidth>0.0001</LineWidth>
<MiterLimit>10</MiterLimit>
<BaselineShift>0</BaselineShift>
<InterCharacterSpacing>0</InterCharacterSpacing>
<OutlineStyleId/>
<FillStyleId>Def.BlackFill</FillStyleId>
<CapType>Butt</CapType>
<JoinType>Bevel</JoinType>
<Kerning>True</Kerning>
<BorderStyleId/>
<IsVisible>True</IsVisible>
<ConnectBorders>False</ConnectBorders>
<WithLineGap>False</WithLineGap>
<FontId>Def.Font</FontId>
<Bold>False</Bold>
<Italic>False</Italic>
<Underline>False</Underline>
<Strikethrough>False</Strikethrough>
</TextStyle>
<FillStyle>
<Id>Def.BlackFill</Id>
<ColorId>Def.Color</ColorId>
<Offset X="0" Y="0"/>
<Rotation>0</Rotation>
<Skew>0</Skew>
<FlipX>False</FlipX>
<Scale X="1" Y="1"/>
<ApplyObjectTransformation>True</ApplyObjectTransformation>
<TileImage>True</TileImage>
<AutoScale>False</AutoScale>
</FillStyle>
<FillStyle>
<Id>12</Id>

2134
 18.2 Layout Module Examples

<ColorId>10</ColorId>
<Offset X="0" Y="0"/>
<Rotation>0</Rotation>
<Skew>0</Skew>
<FlipX>False</FlipX>
<Scale X="1" Y="1"/>
<ApplyObjectTransformation>True</ApplyObjectTransformation>
<TileImage>True</TileImage>
<AutoScale>False</AutoScale>
</FillStyle>
<BorderStyle>
<Id>Def.BorderStyle</Id>
<FillStyleId/>
<ShadowStyleId/>
<Margin>
<UpperLeft X="0" Y="0"/>
<LowerRight X="0" Y="0"/>
</Margin>
<ShadowOffset X="0" Y="0"/>
<JoinType>Bevel</JoinType>
<Mitter>10</Mitter>
<UpperLeftCornerType>
<CornerType>StandardCorner</CornerType>
<CornerRadius X="0" Y="0"/>
</UpperLeftCornerType>
<UpperRightCornerType>
<CornerType>StandardCorner</CornerType>
<CornerRadius X="0" Y="0"/>
</UpperRightCornerType>
<LowerRightCornerType>
<CornerType>StandardCorner</CornerType>
<CornerRadius X="0" Y="0"/>
</LowerRightCornerType>
<LowerLeftCornerType>
<CornerType>StandardCorner</CornerType>
<CornerRadius X="0" Y="0"/>
</LowerLeftCornerType>
</BorderStyle>
</Layout>
</Layout>
<ScriptDataInput>
<Id>ScriptDataInput1</Id>
<Name>ScriptDataInput1</Name>
<ModulePos X="11" Y="12"/>
UTF-8
<Script>Array.Amount = 100;
Array.commit();
Array.Amount = -10;</Script>
<WorkFlowDefinition>
<Node Name="" Type="SubTree" Optionality="MustExist">
<Node Name="Array" Type="SubTree" Optionality="Array">
<Node Name="Amount" Type="Currency" Optionality="MustExist"/>

2135
18 Examples of Use

</Node>
</Node>
</WorkFlowDefinition>
</ScriptDataInput>
<Output>
<Id>Output1</Id>
<Name>MyOutput1</Name>
<ModulePos X="49" Y="12"/>
<SplitRecordCount>0</SplitRecordCount>
</Output>
<Connect>
<From>ScriptDataInput1</From>
<FromIndex>0</FromIndex>
<To>Layout1</To>
<ToIndex>0</ToIndex>
</Connect>
<Connect>
<From>Layout1</From>
<FromIndex>0</FromIndex>
<To>Output1</To>
<ToIndex>0</ToIndex>
</Connect>
</WorkFlow>

18.2.3 How to Create Custom Image Charts

See also:
Charts
Chart Examples
Chart Properties Dialog
How to Create a Simple Chart

There are two possibilities of using custom images in charts:

1. Insert an image into Inspire Designer and apply it as a fill to a chart's bars, cones, cylin-
ders, etc. (by selecting the image in the Fill column of the Values tab). You can control
the appearance of the image using the Fit fills to shapes option located on the Chart
Type tab.

2. Select Custom image chart in 2D only from the Chart Type tab. This allows you to go
further in customizing the look of a chart. The usage of this second option is explained
in detail below.

2136
 18.2 Layout Module Examples

18.2.3.1 Custom Image Chart

A custom image chart consists of up to three different custom images which can be specified
by the user. These images will be used for the top, middle and bottom part of the chart values.
In this example the following images will be used:

The top image will be:

named "Cap"

The middle image will be:

named "Bar"

The bottom image will be:

named "Basis"

Note Images used in custom image charts will be used as fill styles. When images are used
as fill styles, Inspire Designer adds the appendix "FillStyle" to the actual image name, e.g.
"Cap" will be referred to as "CapFillStyle" in the appropriate context.

See the steps 5 and 6 below for examples where the images are used as fill styles and thus
have "FillStyle" appended to their original names.

The resulting chart will look like this (the chart values are random):

Note The bottom and top images are always displayed regardless of the value entered for
the chart, the middle 'fill' image is repeated as often as necessary to reach the value specified
on the Values tab. As the middle image is always repeated as a whole, the top image does not
always exactly meet the value it should (especially if the middle 'fill' image is relatively large).

See step 7 for a description of how to adjust the position of the top image.

2137
18 Examples of Use

To create a custom image chart follow these steps:

1. Insert the images into your document by right-clicking the Image node in the Layout
Tree and selecting Insert image from the context menu. This will display the Open
dialog which you can use to browse for the images you want to use.

2. Now select the Chart tool icon and create a chart object in the Layout Area and
double-click the chart object to open the Chart Properties panel.

3. Here, on the Chart Type tab you can select Custom image chart in 2D only from the
thumbnail list of available chart types.

4. Now you can proceed to enter values, point labels etc. for the chart as with any other
chart. See How to Create a Simple Chart for details.

5. Then you need to make the specific settings necessary for custom charts. First, go to
the Values tab where you can specify the top image that will be used in the chart. Open
the drop-down box in the Top Picture column and select the appropriate image which
will automatically be available as a fill style in the list that opens (in this example
"CapFillStyle" is selected):

Note The image must be selected for all values and series you want to use it for (you
can select a different series in the Series combo-box at the top of the Values tab).

6. Now go to the Shades tab where you can specify the middle and bottom images to be
used in the custom chart. The image that will appear in the middle of the chart should
be entered into the Fill Picture column ("BarFillStyle" in this example), the bottom
image into the Bottom Picture column ("BasisFillStyle" in this example):

Note The image must be selected for all values and series you want to use it for (each
line in the Shades tab represents one value of the series selected in the Series combo-
box at the top of the tab).

2138
 18.2 Layout Module Examples

7. Finally, it is possible to fine tune the position of the top image in the chart by using the
Image control point edit-box located on the Series General tab. This setting allows
you to adjust the position of the top image upwards by entering a percent value con-
trolling the offset of the upper image in relation to its length.

Example This is the normal appearance of a chart with the value 0 set in the
Image control point edit-box (this screenshot is an extract from the screenshot
of the complete chart located at the beginning of this section). The top of the
image is aligned with the value (i.e. the image "Cap" ends at 3.24):

This is the appearance when the value 100 has been set in the Image control
point edit-box. Now the bottom of the image is aligned with the value (i.e. the
image "Cap" begins at 3.24):

The chart created by these actions will resemble the chart presented at the beginning of this
section.

18.2.4 How to Create Element Areas

See also:
Element Areas
Elements

Element areas present an easy way to reproduce (repeat) pre-defined elements in several
columns and rows. Element areas can be used for labels, stamps etc.

2139
18 Examples of Use

Follow the steps described below to create an element area with 12 labels ordered in 2 columns
and 6 rows.

1. Create a new element (this will be the content of all the labels). To do this, right-click
the Elements node in the Layout Tree and select Insert Element from the context
menu.

Select the inserted element (named "Element 1") in the Layout Tree and press <F2>,
now you can change the name of the element, e.g. to "Label".

2. In the properties panel for this element make the following settings:

Width - 85 mm

Height - 40 mm

Formatting - Baseline

Offset - 0 mm

3. Double-click the element "Label" you have created in the Layout Tree. The element
will be displayed in the Layout Area.

4. Insert a Flow area into the element and type some sample text inside.

5. Select the Page1 node in the Layout Tree, right-click on it and select View Page from
the context menu (alternatively you can double-click the Page1 node) to display the
page layout which will be empty at this point.

6. Select the Element Area tool icon from the Layout Toolbar and drag the cursor in
the Layout Area to create the element area.

Note Element areas have a uniform shape and size. The shape and size of the printed
object will depend on the element used in the element area.

7. Select the ElementArea 1 node (which you just created) in the Layout Tree.

8. Go to the Position tab of the properties panel and make the following settings:

X - 15 mm

Y - 15 mm

This determines the position of the top left label.

9. Go to the Content tab and select Label (i.e. the element you created in step 1) in the
Element combo-box. This tells the "ElementArea1" to use the "Label" Element as its
content.

10. Finally, on the Content tab you can specify the number and layout of reoccurrences of
the element. To create two columns with six rows set the amount of labels to be placed
in horizontal and vertical direction:

Count X - 2

Count Y - 6

2140
 18.2 Layout Module Examples

Furthermore you can specify values for the gaps between the reoccurrences of the
"Label" element, e.g.:

Gap X - 10 mm

Gap Y - 5 mm

11. The individual labels are created automatically and your page should now look like this:

18.2.5 How to Create Flow Areas Selected by

Condition
We want to print two flow areas depending on what month number comes from data, for
example the 1st area will be printed only for January, the second one for the months remaining.

Follow these steps:

1. Create the .CSV file containing month numbers, city names and average temperatures.

2. Insert a DataInput module. Select Input file (Temperatures.csv ). Type Root array name
- e. g. Weather.

3. Insert a Layout module and connect it to the DataInput module.

4. Double click the Layout module. The Layout window opens.

2141
18 Examples of Use

5. Insert a new variable named IsJanuary to the Data | Weather| Value node. In its proper-
ties, select Kind / Calculate and, Type / Bool. In the code tab, type the following code:

if (Month=="1")
{
return true;
}
else return false;

6. Create a new flow area on page 1. (Click the FlowArea Tool and drag it to define an
area.)

7. Type Month is and drag the Month variable from the layout tree (Data | Weather| Value
| Month), placing it after the text. This flow area will be there to show you the current
variable value.

8. Insert a second flow area and type This month IS not January.

9. Click on the flow you just created and, in its properties set, type Select by condition .

10. Click the New flow condition icon at the bottom of the dialog. A new row will appear.
Select the IsJanuary variable and create new flow .

11. A new flow is added to the current flow, double click it in the layout tree. Click in the
flow area displayed and type This month IS January .

You can now proof the page by pressing <F6>. W hen the month number is equal to 1 , the
first flow area is printed, and vice versa.

18.2.6 How to Create Flow Content

GroupedBy
The DataGroupBy module enables you to print groups of data organized by a variable.

Follow these steps:

1. Create the .CSV file containing month numbers, city names and average temperatures.

2. Insert and complete a DataInput module. (Double click the module to open the Data
Input dialog.)

For the Root array name, type Weather.

For the Input file, select Temperatures.csv . (Click the box on the right to browse
for the file.)

3. Insert a DataGroupBy module and connect it to the DataInput module.

4. Double click the DataGroupBy module to open the dialog window, highlight/select the
month field and type GroupByMonth (i. e., set a grouping by variable named Month).

5. Insert a Layout module and connect it to the DataGroupBy module.

6. Double click the Layout module to open the Layout window.

2142
 18.2 Layout Module Examples

7. Create new flow area on page 1. (Click the FlowArea Tool and drag in the window to
define the flow area.)

8. Open Page 1, click on Flow1 and set the type to Repeated and the variable to
GroupByMonth in the Layout Properties. (If you do not want to use a table, set the
flow to Repeated and choose GroupByMonth for that. Then drop your fields into the
text frame.)

9. From the layout tree, drag the following variables:

Month (Data | Weather | Value | Month) to the first column.

City to the second column.

Temperature to the third column.

18.2.7 How to Create Numbering Style in

Imported RTF and DOC Files
See also:
RTF and DOC Import
Number to Spell Conversion

1. Import the required RTF or DOC file (in the Layout window select File | Import | RTF
or DOC, see also DOC and RTF Import).

2. Expand the Data node in the Layout Tree and click on the displayed numbering variable.

Note If no numbering variable is displayed, add a new one (see Adding New Variables
in Data section) and in the variable's Layout Properties panel, on the Type Tab, select
Numbering option in the Kind combo-box.

3. In the variable's Layout Properties panel proceed as follows:

On the Conversion tab select Number to spell option as the Output type.

After selecting the User rules radio-button the User Rules tab appears.

Using the icons at the bottom of the User Rules tab you can define your own
numbering style or modify the current style. The newly defined or modified num-
bering style needs to be saved using the Save user rules icon.

The file name should consist of the numbering variable name and NMB extension,
e.g. if the numbering variable is NumbStyle0en_US-0.0 (this is the default number-
ing variable naming convention), the file name will be NumbStyle0en_US.nmb.

4. In the Layout Tree, select or create a paragraph style and in the paragraph style's Layout
Properties panel select the Advanced tab. In Nmb. variable combo-box select the
numbering variable used for the numbering style.

5. Then apply the paragraph style to the selected flow area. The defined or modified
numbering style will be applied.

2143
18 Examples of Use

18.2.8 How to Create or Modify a Border Style

See also:
Border Styles
Border Properties Dialog

In this example a border style with the following appearance will be created:

The settings of the above shown border style are:

For the two top corners, Corner is set to Round and Radius X and Radius Y are set
to 5 mm.

For the top, left and right borders as well as the two top corners the Line fill style is
set to NavyFillStyle and the Line width is set to 1 mm.

See Step 2 below for details.

For the bottom border, Line fill style is set to RedFillStyle and the Line width to 2
mm.

See Step 3 below for details.

The Fill set for the space inside the borders is LightGreyFillStyle, the fill style used for
the Shadow is SteelBlueFillStyle and the Sh. offset is set to 2 mm for both dimensions.

See Step 4 below for details.

To create this border style, follow the steps described below:

1. Right-click on the Border Styles family node and select Insert Border Style from the
context menu.

A new border style is created in the Layout Tree (e.g. BorderStyle1).

2144
 18.2 Layout Module Examples

Click on the border style that you have just created in the Layout Tree to display the
according layout properties:

2. In this step, the dark blue parts of the border will be created:

Since you want only the top left and top right corners to be round and only the
left, right and top borders to have the same color as these corners, it is necessary
to select the appropriate parts of the border. Then the changes made in this step
will only affect those parts of the border for which they are intended. Press and
hold <Ctrl> (to make it possible to select several of the icons simultaneously) and
select the following icons:

The Left Line icon.

The Top Line icon.

The Right Line icon.

The Upper Left Corner icon.

The Upper Right Corner icon.

All settings made while these icons are selected will only be applied to the corres-
ponding parts of the border.

On the Lines/Corners tab, open the Line fill style combo-box menu and select
the color you want to apply to the selected parts of the border. In the screenshot

2145
18 Examples of Use

below NavyFillStyle is being selected, note that the RGB values (0,0,128) are dis-
played when you hover the mouse pointer above a color).

Change the Line width from 0.20 mm (default) to 1 mm. The preview window
updates immediately after you press <Enter> or after you click somewhere else
in the Layout Properties window.

Change the setting in the Corner combo-box from Standard to Round. As soon
as the corner type has been changed, it is possible to specify values in the Radius
X and Radius Y combo-boxes. Set 5 mm for both radius values.

The layout properties should now look like this:

2146
 18.2 Layout Module Examples

3. In this step, the bottom line of the border will be defined:

Settings made in this step are to be made for the bottom line of the border style
only, thus it is necessary to be sure that only the follow icon is selected:

The Bottom Line icon.

Then, on the Lines/Corners tab, select RedFillStyle (RGB values: 255,0,0) in the Line
fill style combo-box.

In the Line width combo-box set the value 2 mm.

The layout properties should now look like this:

4. In this final step, the fill styles for the area inside the border and for the used shadow
effect as well as the shadow offset values will be set:

Go to the Shading tab and in the Fill combo-box select LightGrayFillStyle (RGB
values: 192,192,192) to set the background fill of the border style.

Note When making settings on the Shading tab, it does not matter which of the
icon(s) placed around the preview area is selected, as these icons only affect settings
made on the Lines/Corners tabs.

In the Shadow combo-box select SteelBlueFillStyle (RGB values: 153,204,255) to

determine the color of the shadow.

For the shadow to be visible, it is necessary to make appropriate settings for the
shadow offset. Set the values in the Sh. offset X and Sh. offset Y combo-boxes
to 2 mm.

2147
18 Examples of Use

The border style is now complete and should look like this:

You can test the appearance of this border style by applying it to any of the layout objects that
can use border styles (see the list at the beginning of the Border Styles section).

18.2.9 How to Create or Modify Text Styles

and Paragraph Styles
See also:
Paragraph Styles
Text Styles

Both text styles and paragraph styles are used to format the text that makes up flows in a layout
design and they both have a similar management method when applying them or dealing with
them as objects in the Layout Tree.

You can create paragraph styles and text styles in any of the ways described below.

Create a style "from scratch"

Recommended when you need a style which differs greatly from already existing ones.

1. Right-click on the Text / Paragraph Style's family in the Layout Tree.

2. Select Insert Text Style / Insert Paragraph Style.

3. Click on the new style (e.g. ParagraphStyle1) in the Layout Tree.

4. Enter the desired settings in the Text Styles Layout Properties panel / Paragraph Style
Layout Properties panel.

2148
 18.2 Layout Module Examples

Clone and modify a style

Cloning and modifying a text / paragraph style can save time when you want to create a style
differing (only in certain details) from one that has already been created. Cloning creates a
copy with all of the properties exactly the same as the copied style, but the properties are
subsequently independent.

1. Right-click on the style that most closely matches the values of the style to be created.

2. Select Clone.

3. Click on the new style (e.g. CloneOfNormal) in the Layout Tree.

4. Modify the settings in the Text Styles Layout Properties panel / Paragraph Style Layout
Properties panel.

Create a style (based on an existing one) via context menu or toolbar

Text / Paragraph styles can also be modified when text is selected by either right-clicking and
selecting Text Style / Paragraph Style to open a properties dialog (which has all of the
properties that are described in Text Styles Layout Properties / Paragraph Style Layout Properties)
or by using the icons in the toolbars.

This is the Text Format toolbar:

This is the Paragraph Style toolbar:

Changes applied these ways will modify only the selected text / paragraph, the corresponding
text style / paragraph style will NOT be modified as a whole, i.e. the style will not be changed
in all places it is used. A style modified in this way will be displayed in blue typeface in the
combo-box in the toolbar. Also, an invisible version of style will be created in the Layout Tree
and can be found in the InvisibleTextStyles / InvisibleParaStyles family.

As invisible styles cannot be applied to other text / paragraphs, it is recommended that you
turn them into proper text styles as they are created, to do this:

1. In the combo-box of the Text Format toolbar / Paragraph Style toolbar, type in a new
name for the style and press <Enter>.

2. A new, proper, style is created (directly under the Text Style / Paragraph Style family)
and it will be possible to reapply it from the same combo-box to other text / paragraphs
when they are selected.

2149
18 Examples of Use

Base a style on an already existing one

Basing a text / paragraph style on an already existing style is useful when you want to create
a link between the settings of two styles.

1. Create a new style either by Insert Text Style / Insert Paragraph Style or Clone,
e.g. ParagraphStyle1 (see above for details).

2. When editing the Text Styles Layout Properties panel / Paragraph Style Layout Properties
panel, select an existing style from the Parent combo-box, e.g. HeaderStyle.

Note Linked settings are marked by and unlinked settings by on the tabs of
the of the linked style. Only settings that have the same value in both styles when the
link is created are marked as linked.

3. Now the styles are linked (e.g. ParagraphStyle1 is linked to HeaderStyle) and any changes
made in the settings of the parent style will automatically be applied to the dependant
style as well, provided these settings are linked .

Note This does not apply vice-versa. Changes made in the linked style will not be
applied to the parent, but will cause any link for this setting to be broken.

4. Link or Unlink settings to those of the parent by clicking on the icons respectively
in Layout Properties panel of the dependant style.

Note The above description only applies when the default value for Text/Para style
parent/child link, Unlink child when modified, is set in the Global Layout Modules
Options section of the Layout Options dialog. The behavior of linked settings can be
changed there.

Note When you create or modify text / paragraph styles and apply them to some text, this
style will then automatically be used as the default all flow areas that are subsequently created
and filled with text.

18.2.10 How to Create Scripted Areas

See also:
Scripted Area
Scripted Area - Types and Methods

In this section an example will be described showing what can be done using a scripted area.
It will enable you to create the US flag using functions to order the stars and create the stripes.
The result should look like this:

2150
 18.2 Layout Module Examples

To begin with, you need to create two shapes which will be used in the functions:

First create a rectangle with a blue fill and name it "BlueBox"

Then create a small star with 5 points and a white fill and name it "WhiteStar"

Additionally, you need to create two fill styles which will be used for coloring the stripes:

A fill style with a white color named "WhiteFill"

A fill style with a red color named "RedFill"

Then create a scripted area in the Layout Area and go to its layout properties and fill in the
Used Objects tab specifying the shapes and fill styles just created and adding the according
alias as in the screenshot below:

For additional information, refer to the section on Scripted Areas.

On the Content tab of the scripted area layout properties you will now have to specify scripts
for the following tasks:

Creating stripes

Creating sets of stars

Creating sets of stripes

Creating Stripe Function

This is the definition of the function used for creating one stripe which is 5 units high. The
stripe is made by moving the pen from the coordinates [0,0] to [aWidth,0] (aWidth is a
parameter of the function), then to [aWidth,5], then to 0,5 and then back to beginning [0,0].

function createStripe(Double aWidth):Path

{
Path stripe;
stripe.moveTo(RVector(0,0));
stripe.lineTo(RVector(frommm(aWidth),0));
stripe.lineTo(RVector(frommm(aWidth),frommm(5)));
stripe.lineTo(RVector(0,frommm(5)));
stripe.lineTo(RVector(0,0));
return stripe;
}
Transformation tr; //this is the definition of a blank variable which is

2151
18 Examples of Use

needed later
drawPathObject(tr,Box);

Creating Sets of Stars

This is the definition of the function creating the first set of stars in two nested cycles.

The inner cycle for (Int i1=0;i1<6;i1++) creates a matrix of 6x5 stars (the outer stars) by ro-
tating the base of the star by 21 degrees, then moving the star to the appropriate position in
a column according to the position in the inner cycle (determined by i1 variable) and in the
row (determined by I variable) The outer cycle for (Int I=0;i<5;i++) is used for counting the row
numbers in the variable.

//Stars
for (Int I=0;i<5;i++)
{
for (Int i1=0;i1<6;i1++)
{
Transformation tr1;
tr1.rotate(-21);
tr1.translate(RVector(frommm(0.5+7*i1),frommm(3+7*I)));
drawPathObject(tr1,Star);
}
}

This is the definition of the function creating the second set of stars in two nested cycles.

The inner cycle for (Int I=0;i<4;i++) creates a matrix of 5x4 stars (the inner stars) by rotating
the base of the star by 21 degrees, then moving the star to the appropriate position in a column
according to the position in the inner cycle (determined by i1 variable) and in the row (determ-
ined by I variable)

for (Int I=0;i<4;i++)

{
for (Int i1=0;i1<5;i1++)
{

2152
 18.2 Layout Module Examples

Transformation tr1;
tr1.rotate(-21);
tr1.translate(RVector(frommm(4.5+7*i1),frommm(6+7*I)));
drawPathObject(tr1,Star);
}
}

Creating Sets of Stripes

Now the previously defined function createStripe can be used to create a set of "short stripes,
each 50 units wide.

The for (Int I=0;i<7;i++) cyclus defines the number of "short stripes.

The condition if (I%2==0) defines that every even stripe should be filled white, whereas each
odd stripe should be red. (The first stripe is the top one, with index I= 0, the second stripe has
I= 1 etc. So for the second stripe 1%2 <>0, (1mod2)<>0, so the second stripe is white.

//Stripes
Path stripe = createStripe(50);
for (Int I=0;i<7;i++)
{
Transformation tr;
tr.translate(RVector(frommm(40),I*frommm(5)));
if (I%2==0)
{
fillPath(tr,MyRed,stripe);
}
else
{
fillPath(tr,MyWhite,stripe);
}
}

This is the same function, just for the long stripes, with other parameters.

2153
18 Examples of Use

stripe = createStripe(90);
for (Int I=0;i<6;i++)
{
Transformation tr;
tr.translate(RVector(frommm(0),I*frommm(5)+frommm(35)));
if (I%2==1)
{
fillPath(tr,MyRed,stripe);
}
else
{
fillPath(tr,MyWhite,stripe);
}
}

After inserting these scripts into the Script field of the Content tab you can press <F6> to
proof your workflow and see the result produced by the scripted area you have defined.

18.2.11 How to Create a Simple Chart

See also:
Charts
Chart Examples
Chart Properties Dialog
How to Create Custom Image Charts

This example gives a step-by-step explanation on how to create a simple chart with some basic
design features. The chart values and the labels for the X-axis will be handled by variables
whose creation and usage will also be explained.

Imagine the following scenario:

You want to create a chart looking like the one just below in order to present data on the de-
velopment of the number of company employees during a period of three years (2001, 2002
and 2003).

2154
 18.2 Layout Module Examples

Legend
This chart has the following features:

1. A chart title

2. Variable controlled values (in this case represented by bars)

3. Point labels displaying the according values

4. Variable controlled labels for the X-axis

Follow the steps below to create this chart:

1. You need to create a data file as a basis for the array containing the variables which
will determine the appearance of your chart. To create a simple data file do the follow-
ing:

Open a standard spreadsheet program (e.g. Excel) which can save CSV files.

Insert the data as shown in the below screenshot and save the file in the CSV
format, e.g. with the name "EmployeeStatistics".

2. Now open Inspire Designer and create a workflow with the following modules connected
in the order shown below:

Data Input module

Data Transformer module

Layout module

Your workflow area should now look like this:

3. Open the Data Input module by double-clicking on it. On the Input File tab browse for
the data file you created in the Input file edit-box. Enter a name for the array that you
are creating from the data file in the Root array name edit-box, e.g. "ChartData":

2155
18 Examples of Use

Then go to the Properties tab and check the data contained in your array in the Preview
field. The array consists of two variables ("Employees" and "Year") containing the data
needed for the chart. It should look like this:

4. Now you need to change the type of the input data which will be used for the chart
values, because data used for chart values must be of a certain type so that it can be
used in a chart (you do not need to change the type of the data you will use for the
X-axis labels); see Using Variables in Charts for more details on data types in charts.

Open the Data Transformer module and select BC.-Double in the Field Converter field
for the "Employees" variable (which contains the values which will be used in the chart):

5. Open the Layout module by double-clicking on it and use the Chart Tool icon from
the Tools toolbar on the left side to insert a chart of the size you prefer into the Layout
Area.

6. Double-click the chart area you have created in the Layout Area to open the Chart
Properties dialog. Here it is necessary to specify the following basic settings on the
Chart Type tab:

Select the kind of chart you would like to use in the Chart Type field on the left
side of the tab. For this example a 'Bar chart in 3D' will be used.

On the right side of the Chart Type tab, in the Chart Properties field, you can
specify the exact appearance of the chart. As three values should be displayed set
Values count to 3 and because these values are available for just one company
only one series is necessary, so set Series count to 1:

2156
 18.2 Layout Module Examples

Note Your chart will probably have different bar lengths in the preview area at the
top of the Chart Properties dialog than in the screenshot above. This is due to the fact
that Inspire Designer enters random values when no values have yet been specified, so
that you can see what the general appearance of the chart will be like.

7. Now go to the Values tab and select the Input file in the Values array field (in this
case ChartData) and then the variable with the value data (in this case Employees) in
the Value variable field. Not only will the values be applied to the bars of the chart,
but the values will also be displayed in the point labels you will set up in step 9 of this
example.

Note The point label values and the bar values specified by the "Employees" variable
will not appear in the preview area of the Charts Properties dialog or in the chart in
the Layout Area. Entries specified by variables are only visible after proofing/producing
a job as the variables are only then processed by Inspire Designer.

8. To use the "Year" variable to set the X-axis labels, open the Labels tab and select the
Input file in the Labels array field (in this case ChartData) and then the variable with
the axis label data (in this case Year) in the Label variable field. Make sure you have
selected the correct axis in the Axis combo-box at the top of this tab.

2157
18 Examples of Use

Note The labels for the axis will not appear in the preview area of the Charts Properties
dialog or in the chart in the Layout Area. Entries made by variables are only visible after
proofing/producing a job as the variables are only then processed by Inspire Designer.

9. In order for point labels to be visible you must now enable the Use point labels option
on the Point Labels tab. Specify their position by selecting Bar Center in the Vert. align
combo-box. In the Label text style combo-box select a text style which uses white as
the text color (in this case WhiteTextStyle) so that the point labels will be well visible
on the dark blue background of the chart's bars. As you want the values of the bars
(specified by the "Employees" variable) to be used as point labels, no further settings
are necessary; by default Inspire Designer uses these values for point labels. Furthermore,
you can enter the chart title Number of Employees 2001-2003 in the Title field on the
right side of this tab.

10. To increase the space between the title you have entered and the chart itself, go to
the Placement tab and enter 2 into the Top margin edit-box. There is now a gap which
is 2mm wide between the chart and the title improving the appearance of the chart.

11. Now press <F6> to proof the chart. The chart should now look like the one shown at
the beginning of this description.

2158
 18.2 Layout Module Examples

18.2.12 How to Create a Table Based on a CSV

File
Follow these steps to create a simple table based on a CSV file.

1. Create the CSV file containing month numbers, city names and average temperatures.

Month;City;Temperature
1;Prague;-0,8
2;Prague;0,3
3;Prague;4,2
4;Prague;9,5
5;Prague;14,7
6;Prague;18,2
7;Prague;19,9
8;Prague;19,2
9;Prague;15,3
10;Prague;9,6
11;Prague;4
12;Prague;1
1;San Francisco;9,8
2;San Francisco;11,4
3;San Francisco;12,3
4;San Francisco;13,6
5;San Francisco;15
6;San Francisco;16,5
7;San Francisco;17,3
8;San Francisco;17,8
9;San Francisco;18
10;San Francisco;16,3
11;San Francisco;12,8
12;San Francisco;9,9
1;Buenos Aires;24,6
2;Buenos Aires;23,3
3;Buenos Aires;21,7
4;Buenos Aires;17,7
5;Buenos Aires;14,6
6;Buenos Aires;11,5
7;Buenos Aires;11,1
8;Buenos Aires;12,6
9;Buenos Aires;14,5
10;Buenos Aires;17,5
11;Buenos Aires;20,2
12;Buenos Aires;23,4

2. Insert a DataInput module. Select Input file (Temperatures.csv ). Type Root array name
- e. g. Weather.

3. Insert a Layout module and connect it to the DataInput module.

4. Double click the Layout module. The Layout window opens.

5. Create a new flow area on page 1. (Click the FlowArea Tool and drag it to define an
area.)

2159
18 Examples of Use

6. Insert a table by selecting Table | Insert Table. Set 3 columns, 1 header row, 1 body
row, 0 footer rows.

7. Drag the Month variable from the layout tree (Data| Weather| Value | Month) to the
first column. Drag the City variable to the second column. Drag the Temperature variable
into the third column.

You can now proof the page by pressing <F6>. Each row of the table will be printed
now on a single page.

We want it to print on one page so that all data will print together.

To achieve this:

a. Select (highlight) RowSet1 of the Table1 in the layout tree (Pages | Page 1 |
FlowArea1 | Flow1 | Table1 | RowSet1)

b. In the Layout Properties Window displaying RowSet1 parameters, select Type of

Repeated and Variable set to Weather

You can now proof the page by pressing <F6>. The complete table will print on
single page.

18.2.13 How to Export Design Parts for Usage

on Web
For GMC solutions including web products, such as Inspire Interactive, the functionality of ex-
porting parts of the design from Inspire Designer brings the opportunity to transfer the already
created design quickly to the web and the possibility to edit these single parts just once in
separate WFD files and see the changes in all related documents.

The idea is to simplify the posting of an already designed document to the web by exporting
single text parts as flows and optionally other design parts as elements to separate WFD files.
It is also possible to create the separate WFD files and link them to a 'master' WFD file. The
'slave' WFD files each containing a single flow or a single element can be saved to Inspire
Content Manager or Inspire Content Manager Web and you can select the parts of design
from there when working with Inspire Interactive. The functionality includes the preview of
the flow or element content when hovering your mouse over the WFD file in the Inspire De-
signer open dialog as well as on the web.

18.2.13.1 Flow Export for Web

The key functionality for cutting a master WFD into parts is the usage of flows. When you have
a document designed in Inspire Designer which you would like to post to the web, you can

2160
 18.2 Layout Module Examples

export single paragraphs from it and select them in Inspire Interactive. To perform the export,
do the following:

Select an existing flow in the 'master' workflow (or create a new one if you do not work
with an existing document) and right-click on it. Select the Save Flow into External
WFD option and choose the location and name for the new 'slave' workflow.

The flow changes its type to External and a new variable will be created and assigned
to the Location field, its content being the path to the newly created ('slave') WFD file.
The path is relative to the 'master' workflow. Only in case the 'master' workflow has
not been saved yet, it is absolute.

The flow is no longer visible in the 'master' WFD where you exported it from.

The 'slave' WFD contains only the flow that you have exported, under the Flows family
in the Layout Tree. The flow is called ExportedFlow.

In the Pages family the option Main object is used and contains ExportedFlow, indicating
which object (if there were more in the Layout) should be used in the 'master' WFD
file.

2161
18 Examples of Use

Tip In the Inspire Designer Open dialog as well as in the web application, you can see
the preview of the flow from the 'slave' workflow, e.g.:

18.2.13.2 Element Export for Web

Working with elements is similar to exporting flows. The only difference is that the element
always stays a part of the 'master' workflow and to display it from the external WFD you need
to create a new external flow and the variable with the path to the 'slave' manually. Still external
elements can simplify your work when posting parts of the design to the web by creating the
separate WFD files.

For example, if a chart is a part of a design that you want to post to the web, it has to be placed
in an element and exported with it, or optionally the element could be placed in a flow and
the flow export (described above) used.

The export of an element works the following way:

Right-click on the Elements family in the Layout Tree and create a new element with
appropriate size. Add the chart to it.

Select the right-click option Save Element Into External WFD and choose the location
and name for the new 'slave' workflow.

It becomes a part of the 'slave' workflow, but unlike a flow, it still remains a part of the
'master' workflow as well.

The 'slave' WFD contains only the element (with the chart) that you have exported,
under the Elements family in the Layout Tree. The element is called ExportedElement.

In the Pages family the option Main object is used and contains ExportedElement, in-
dicating which object (if there were more in the Layout) should be used in the 'master'
WFD file, should it be linked to one.

2162
 18.2 Layout Module Examples

Tip In the Inspire Designer Open dialog as well as in the web application, you can see
the preview of the element from the 'slave' workflow, e.g.:

Note To link an external 'slave' WFD with an element to a new master WFD, create
a flow area in the new workflow's Layout, change Type of the flow assigned to it to
External. Then create a new String variable and add to it the path to the external WFD
as its Value. Then this variable to the Location field in the properties of the flow. If
you proof this new 'master' workflow, it shows the chart.

18.2.14 How to Generate a Table of Contents

See also:
Table of Contents

To be able to add a table of contents to the pages of your layout follow these steps:

1. Text for which table of contents should be generated

On Page 1 (renamed to Page_Text) create a flow area with text for which you would
like to generate table of contents. For this purpose the text should have chapters, the
titles of which would be added to the table of contents. It can be also longer text than
the length of the page and to display it in Proof, you can use the Auto Page Flowing
Setup.

Note In the Layout Properties of the flow area with the text, the option Flowing to
next page must be checked on the Content tab so that some paragraphs (titles) can
be included in the table of contents.

2. Page, flow area and flow for table of contents placement

2163
18 Examples of Use

Add a new page and rename it to Page_ToC. Create a flow area (FlowArea_ToC) on
the page where the table of contents will be placed and rename also the flow inside
to Flow_ToC.

3. Paragraph style (with numbering) for text titles

Create new paragraph styles that will be applied to chapter titles that should appear
in the table of contents. One paragraph style is created for each title level. It is advised
to rename them as well. Numbering can be added at this step as it is a property of the
paragraph style.

A paragraph style can be created in two possible ways the first one is more suitable
if you have multiple titles and more dependency levels in your text that should be listed
in the table of contents, the second approach fits for simple cases but is faster:

For each title level create a new paragraph style in the Layout Tree and rename
the styles (e.g. ParagraphStyle_TextTitle1, ParagraphStyle_TextTitle1.1).

To define numbering, right-click on the text that represents a title and open the
Bullets and Numbering dialog. Go to the Numbering tab and by clicking on the
Create a numbering variable icon or later on the Create a dependent

2164
 18.2 Layout Module Examples

numbering variable icon you can create the desired structure of numbering
and for each title level select the type of numbers.

Make sure you choose the numbering type in the right part of the dialog. If you
leave None selected, numbering would not work.

Once you confirm the settings a new numbering flow containing a numbering
variable is created. You can find (and edit) them in the Layout Tree under Flows
family.

2165
18 Examples of Use

Now you can assign the appropriate numbering flows and variables to the para-
graph styles.

The last step in paragraph styles creation is to select the titles one by one in the
text and apply the matching paragraph styles to them from the drop-down menu
of the Paragraph Style toolbar.

To use the second way of creating a new paragraph style with numbering, select
a chapter title in the text which you would like to have numbered and to appear
in the table of contents and click on the Numbered List icon available in the
Paragraph Style toolbar. This way the line gets numbered and at the same time
the name of the paragraph style in the Paragraph Style toolbar changes to blue
color (identifying that a change has been done which has not been saved in its
properties).

To save the changes (numbering) into a new paragraph style, change the name
directly in the paragraph style name field and press <Enter>. The new name of
the paragraph style turns black and gets listed in the Paragraph styles node.

Paragraph styles created this way will automatically contain all the information
about numbering (numbering flow, numbering variable and numbering type) and
you do not have to make these settings in the paragraph style Layout Properties,
Advanced tab.

However, the numbering is only the default one and if you need to change its
type, or change the level, you would have to use the procedure described above.

The newly created paragraph style can be applied to other paragraphs (titles) from
the drop-down menu of the Paragraph Style toolbar.

4. Paragraph style (with leader) for the table of contents

Create a new paragraph style that will be used in the table of contents for the purpose
of presentation and rename it to e.g. ParagraphStyles_ToC. The purpose of creating a
special paragraph style for the table of contents presentation can be, for example, that

2166
 18.2 Layout Module Examples

you have used indents in the paragraph style applied to the text title and for the table
of contents you would like to leave them out.

For appearance of your table of contents it is also useful to set the tabulators. You can
add leaders so that e.g. dotted lines between the titles and the pages they appear on
are added.

Go to the Layout Properties of the newly created paragraph style and select the Tabs
tab. Position defines where the page numbers will appear and Leader defines how
the space between a table of contents item and related page number will be filled.

5. Table of Contents node

Right-click on Others node in the Layout Tree and select Insert Table of Contents.

See the section Table of Contents for information about all settings of the tabs available
for Table of Contents.

6. Table of Contents node General tab

Go to the Table of Contents Layout Properties and on the first tab General set the op-
tions Placement, Page and Content flow where the table of contents will be placed.

7. Table of Contents node Content tab

On the tab Content create new references for the table of contents by clicking on the
Create new icon. From the Reference para style drop-down menu select the

2167
18 Examples of Use

paragraph styles that you have used for titles that should appear in the table of contents.
The table of contents will get generated from items for which these paragraph styles
were used.

In the column Presentation select the paragraph styles (with leader) which define how
the table of contents entries will be displayed.

Note Do not select the same paragraph style for both Reference Para Style and
Presentation it can cause problems, e.g. with numbering.

8. Table of Contents node Text styles tab

On the tab Text styles you can define the appearance of the table of contents. For se-
lected text styles used in the text you can define new parameters for display in the table
of contents.

9. Proof

Now run Proof of your document by pressing <F6> key and see the result.

2168
 18.2 Layout Module Examples

18.2.15 How to Make Conditional Flow

See also:
Flows
Select by Condition
Simple Expression Dialog

Flow selected by condition can be created in an easy way. In this example we create two versions
of text (e.g. a marketing message) one for customers above the age of 25 and one for cus-
tomers under 25, using the variable 'Age' from the input data.

1. Create a flow area and enter the text for the customers under 25 into it. Then select
the whole text, right-click and select Make Conditional Flow.

The Simple Expression dialog opens.

2. Make the settings based on the 'Age' variable as shown on the following screenshot:

2169
18 Examples of Use

3. After you confirm the condition, the following structure gets created in the Layout
Tree:

Flow 2 is the conditional flow with the following settings:

Flow 3 contains the information that you have entered into the flow (for customers
under 25) before creating the condition.

Flow 2_1 is empty and you can insert here the other version of the text (for cus-
tomers of the age of 25 and above).

Variable 1 contains the following script:

Age < "25"

18.2.16 How to Mark Script for HTML Simple

See also:
HTML Simple Device Profiles
HTML Simple Engine Configuration

HTML script can be written within a flow in Layout and be executed as the workflow is processed
by the HTML Simple engine. However, when you view the HTML file the tags will usually be
visible unless you mark them as HTML.

To do this, use a specific color with the colorant name "HTML..." for the text of the script:

1. Create a new color in the Layout Tree and open the Color dialog via the Change button
in the color's properties panel.

2. Choose a shade for the color and, in the combo-box at the bottom of the dialog, select
Colorant and, in the edit-box beside that, enter a name for the colorant. The name
must begin with the letters HTML (uppercase) but can be longer. E.g.:

2170
 18.2 Layout Module Examples

This colorant name does not become the name of the color and so it is best to also
rename the color. E.g.:

3. Now, as part of the flow that is nominated as the Main flow (on the properties panel
of the Pages family), you can enter some HTML elements. E.g.:

4. Change the fill of the text style, of the text that the HTML elements are in, to the color
that you have just assigned as colorant HTML....

This is easiest performed via the Fill icon on the Text Format toolbar. E.g.:

2171
18 Examples of Use

Alternatively, this is best done by creating a specific text style via the Layout Tree (which
can be suitably named, e.g. HTMLTextStyle) and selecting the color, that you have just
assigned as colorant HTML..., to be the color of that text style. This is done via the Fill
style combo-box (Outline Style tab) on the properties panel of that text style. Then
employ this new text style for the HTML script, e.g. select HTMLTextStyle from the
combo-box on the Text Format toolbar.

5. Now, when Inspire Designer's HTML Simple Engine is used to produce the workflow,
the HTML tags that are scripted in the flow will be processed but not be printed as part
of the text, e.g.:

18.2.17 How to Repeat Layout Objects by

Integer Variables
In this section: See also:
Repeating Elements by an Integer How To Create an Image Page Counter
Variable Row Sets
Repeating a Row Set by an Integer Element Areas
Variable
How To Create Element Areas
Repeating a Flow Area by an Integer
Variable

Integer variables can be used to control the number of times you would like to repeat flows,
elements, row sets and pages. An example of using an integer variable to repeat pages is de-
scribed in the section How to Create an Image Page Counter where it is used to read up all of
the pages of multiple image file formats like PDF or TIFF. For some simple examples of how
integer variables can be used to repeat flows, elements and row sets, see the descriptions given
below.

18.2.17.1 Repeating Elements by an Integer Variable

Elements are used to make multiple copies of similar information on a form (e.g. address labels).
You create an element once and then you can specify how many times it should be repeated
using an element area.

Via the element area, the element can be repeated by an array or an integer variable. The fol-
lowing example describes a simple workflow in which the element is repeated by an integer
variable.

1. Drag and drop the Data Generator and Layout modules into the Workflow Area:

2172
 18.2 Layout Module Examples

2. In this example, you want one element to be shown on the first page and 25 elements
to be shown on the last page of the document so set the range from 1 to 25 in the
Data Generator and enter the name TestArray in the Array edit-box:

3. In Layout click on the Element Area Tool icon and create an element area in the
upper left corner. Then in the properties panel of the element area select the Content
tab and click on Create New Element in the Element combo-box and a new element
named "Element 1" will be created and placed under the Elements node in the Layout
Tree:

In the Variable combo-box select Number. This is the integer variable you created with
the Data Generator module, it is grouped under the "TestArray" node in the Data tree:

2173
18 Examples of Use

Finally, you need to specify values in the Count X and Count Y edit-boxes. The values
entered here will control how many elements can be displayed horizontally and vertically.
In this example, Count X and Count Y have both been set to 5, allowing a maximum
number of 25 elements on one page.

4. Double-click on the newly created "Element 1" in the Layout Tree and the element
will be displayed in the Layout Area and where you can determine the element's content.
In order to be able place text inside an element it is necessary to create a flow area inside
of it. Do this and then enter the desired text (e.g. "This is sample text.") into this flow
area.

5. The result when you proof the job is that you get 1 element on the first page and 25
elements on the last page of the document. The result on the last page of the document
should look like the screenshot below:

18.2.17.2 Repeating a Row Set by an Integer Variable

In this example, a simple list will be created. You can specify the number of items in the list
with the help of a row set repeated by an integer variable especially created for this purpose.

1. Drag and drop a Layout module into the Workflow Area and open it.

2. Right-click on Data in the Layout Tree and select Insert Variable from the menu. The
new variable will be given the name "Variable 1" and will automatically be highlighted
in the Layout Tree and the corresponding Layout Properties will be displayed.

2174
 18.2 Layout Module Examples

On the Type tab make sure Kind is set to Constant and Type is set to Int. When this
has been set you can also specify a number for Value. For this example set Value to
10 (this specifies the number of times you want the row set to be repeated).

Tip Other variable kinds (i.e. non-constant ones) can also be used, the constant variable
has been used here only for simplicity and easy explanation of the example.

3. In Layout, create a flow area and insert a table that contains 3 columns, 1 header row
and 2 body rows. Check the Repeat body by variable option and select the newly
created Variable 1 in the Variable combo-box.

The body row set will now be repeated by the integer variable you have just created.

4. Now fill in the newly created table so that it looks like the below screenshot. See the
section on the Table Context Menu for details on how to merge the cells of the top
row and the section on the Border Properties dialog on how to apply the border styles
to the two lower rows of the table.

The Index variable inserted into this table numbers each repetition of the body rows
beginning with 0. It can be found in the Layout Tree under the node of the repeated
row set:

2175
18 Examples of Use

5. This will be the result when you proof the job:

Note The whole list can only be displayed if the flow area, where you placed the row
set, is large enough for all rows of the table which is created.

18.2.17.3 Repeating a Flow by an Integer Variable

Repeating a flow by an integer variable may be useful when you want the flow content to be
displayed several times in the same flow area. In this example a flow area will be created and
some text will be entered. The flow containing the entered text will then be repeated by a
variable especially created for this purpose.

1. Follow the first two steps described in the section Repeating a Row Set by an Integer
Variable.

2. Create a flow area in the Layout and enter some text.

2176
 18.2 Layout Module Examples

3. Go to the Layout Tree and select the flow contained in the newly created flow area.
Then, in that flow's layout properties set Type to Repeated and Variable to Variable1.

4. When you proof/produce the job you will see that the text that you have entered into
the flow area is now repeated 10 times (in correspondence with the setting you made
for Value when you created Variable 1):

Note The text can only be displayed 10 times if the flow area which was created in
Layout is large enough for the 10 reoccurrences of the flow to be repeated.

18.2.18 How to Use Superscript in Date

Format
If you want to use the date suffixes 'st', 'nd', 'rd' and 'th' and have them in superscript you
can split your date variable into several items (variables) and use them consequently in the
Layout, where you format as superscript just the variable containing the suffix.

This approach brings much shorter processing time than if the same result was obtained using
a variable formatted flow and is therefore recommended if there are many dates in the file.

1. Create linked variables in the Data Transformer module. For example, when you want
to display day, suffix, month and year you will need to create three variables: the first

2177
18 Examples of Use

one (Date) will return the day, the second one (Suffix) the suffix and the third one
(MonthYear) the rest, i.e. the month and the year.

2. For each of the three fields, set the Field Converter to Format, click on the 3 Dots
icon and set the Formatting method to User pattern. Enter the appropriate parsing
character in the Output pattern field: d for the Day variable, t for the Suffix variable
and MMMM yyyy for the MonthYear variable.

3. In Layout place the three created variables into a flow. Select the variable Suffix and
make it a superscript using the Superscript icon in the Text Format toolbar.

4. When you proof the workflow you get the following result:

2178
 18.2 Layout Module Examples

18.2.19 How to Use System Variables

See also:
System Variables Description

Figure 18.1 Record 1

2179
18 Examples of Use

Figure 18.2 Record 2

18.3 Production Examples

18.3.1 How to Assign TLE Indexes
See also:
AFP Device Profiles
AFP Engine Configuration

Tagged Logical Element (TLE) is for indexing pages and groups of pages within a layout design
when an AFP engine will be used to produce it.

2180
 18.3 Production Examples

It can be defined in the workflow as part of device setting in the Output module or as part of
an engine configuration profile in the Production environment. In both cases, suitable sheet
names must first be defined in the Layout module of the workflow printed.

Below is a screenshot from the properties panel of the Pages node in Layout. It relates to a
workflow that prints customer records from a data file:

It can be seen that two sheet names have been assigned variables that have been read from
the data file. The variable Sur, which is a field that contains the customer surnames, has been
assigned to a sheet name with index 3.

Returning to our Indexing tab for AFP, we would simply ensure that 3 is in the Sheet Name
Index column and then type a name for it (e.g. Customer Surname) in the Index Name column:

As a result Customer Surname would become a selectable index title in the AFP output and
listed under it would be the customer surnames that correspond to the records that have been
printed on the pages. To view this you would need an AFP file viewer.

Below is a screenshot of the Index window-pane of an AFP file viewer (it is not part of Inspire De-
signer). It shows an example index that has resulted from setting the Customer Surname index:

In the top combo-box you would be able to select our examples Index Name (Customer
Surname) and then the top window lists the surnames that relate to the records of the job
(defined by the variable Sur). It will list all matching occurrences as one entry, e.g. Andrew
Miles and James Miles would both be indexed together.

2181
18 Examples of Use

If you also define other sheet names to variables and give them index names, they too would
appear as options in the combo-box menu.

If you were to select a surname in the top window, you would then be able to view the pages
of the print job that relate to this surnames record in the bottom window.

If Name is selected in the combo-box of the bottom window, it shows the Page Names of the
pages that contain data from the record that is related to the surname (by default it is actually
the page numbers of the AFP job that was run, not any page number set in the WFD file).
These names can be set to a name related to a sheet name using the option Take Page Name
from sheet name index on the Miscellaneous tab of the AFP Engine Configuration dialog in
Production .

18.3.2 How to Configure HP PPML for Indigo

Devices
See also:
HP PPML Engine Configuration
PPML Printer Configuration

The following example has been used for HP Indigo devices with a DFE (Digital Front End). The
software that this configuration has been used with includes:

HP SmartStream Production Pro Print Server v3.5.

HP Indigo 3500, 5000 & 5500 digital press software v7.4 & higher.

HP Indigo Production Manager v1.2 & higher (obsolete).

HP Production Flow v1.03 or higher (obsolete).

Fix-all solutions to printing workflows are hard to come by because each workflow file has
differing content and different properties, indeed no single set of configuration options will
be optimal for every workflow. However, the following example considers optimizations for
both a workflow and the HP PPML engine that can provide considerable improvements in
processing efficiency. The configuration here may then be used as a starting point for other
configurations that, with a little adjustment, can optimize results for other workflows.

It is instructive to remember that it is possible to produce a PPML spool file that cannot be
consumed by Indigo DFEs and so this example highlights important options in order to avoid
this.

We will consider the following adjustments that can be made via the Inspire Designer GUI:

Optimizing the Workflow

Configuring the HP PPML Engine

Configuring the Printer

Not all options are mentioned in this example. Those that are not mentioned have been tested
and will not impact in any major way on the end result and can be used if they are convenient.

2182
 18.3 Production Examples

18.3.2.1 Optimizing the Workflow

Open each workflow file in Inspire Designer and check it with an eye to the following features.
The modules to look at are:

Layout Module

Output Module

Layout Module
In the Layout module:

1. Review the number of flows that are used.

The more flows that there are in the layout, the more elements are used in the PPML
spool file. More elements result in longer processing time. Therefore, you can improve
processing by reducing the number of flows. For example, when using multiple variables
they can be placed in a single flow inside a single flow area on the page perhaps using
breaks and returns to separate them.

2. Review the Z-order of objects via the Layout Tree.

When a workflow is processed, similar objects are combined in overlays providing that
they are in consecutive layers on the page. The order of the objects in the Layout Tree
for each page represents the layers of the page and objects can be easily re-ordered
there or by using the Layout Window menu option Edit | Optimize | Static Object
Order. In particular, aim to have all flow areas that contain flows with only static text
together in the layers closest to the page, i.e. lowest in the Z-order. Then proceed to
group all flows with images in them, all image areas with static images, all flow areas
with variables inside the flows, all image areas with variable images etc.

3. Group similar objects on the page.

In addition to step 2, you can further reduce the amount of PPML elements by grouping
those similar objects together on the page, i.e. using the Group icon on the Object
Grouping toolbar.

4. Consider native images.

If you are using PDF, EPS, PS or AFP images (these are images that are native to In-
spire Designer) they can be passed through to the DFE without being processed to
improve performance. To do this, ensure that both Load natively and Load with
transparency are left unchecked on the image's Advanced tab.

However, there are some good reasons to use these options, e.g. to convert the images
to other formats and for color management.

Output Module
In the Output module:

1. Switch off PPML impositioning.

2183
18 Examples of Use

It is possible to send impositioning commands (for each medium defined) via the Output
module. This is not recommended. If PPML impositioning is required, it is preferable to
do this using the Printer Configuration in the Production environment.

18.3.2.2 Configuring the HP PPML Engine

Before you process a workflow file in the Production environment, edit the HP PPML engine
configuration. Look at the tabs of the HP PPML Engine Config dialog and ensure the following
settings are made:

1. On the PPML Output Options tab, select Advanced settings and an appropriate PPML
Version for your DFE.

2. On the Advanced Settings tab, set Reset all values to: Optimized for size and click
on Reset.

3. On the DSC tab, select DSC version 3 for Document Structuring Conventions Type
and Windows style for Directory Separator.

4. On the Images tab, 300 DPI is adequate for EPS/PDF rasterization resolution and
the default Flate Image Filter is correct.

Ensure that all three check-boxes are checked in the Patterns section of the tab, this
is the default setting. In particular, Optimize non-tiled image fill styles helps avoid
very large resource (RES) files.

5. On the Image Format tab, in the Images Supported by Printer section check all of
the formats that are supported by HP Indigo, i.e. EPS, TIFF and JPG.

These images will be rasterized (or even re-rasterized if they have been already rasterized)
if Use image source code is not also checked.

6. Still on the Image Format tab, for Convert unsupported image types select EPS.

Cached images is supported by HP Indigo if desired.

7. On the VI Elements tab, for Cache Elements select Not generate cached VI elements
if you will not be re-using job assets, i.e. if the similarities between the workflows you
are processing are negligible and so you do not want to keep the elements from one
workflow so that they can be re-used by another. Caching elements clutters the DFE.

Overwrite Cache options are not supported by HP Indigo.

Global Cache settings are supported if you are generating cached elements. But it
varies from workflow to workflow whether both of these check-boxes should be
checked. In some workflows setting Add images to global cache and leaving Add
overlays to global cache unchecked is appropriate.

8. On the PPML Settings 1 tab, Use overlays should be considered. Sometimes it can
improve processing times but if there are a lot of variable objects then this may not be
the case.

Check Use Procset, it stores fonts and fill styles in the RES file.

2184
 18.3 Production Examples

Internal Document Splitting improves memory use and reliability for HP Indigo but
do NOT select One document for whole job. Split by group is the usual recommendation
unless you are employing some PPML impositioning.

If you have an older DFE do not check Use internal data although both internal and
external font resources are supported by the latest Indigo DFEs.

9. On the PPML Settings 2 tab, for Internal Data Encoding always choose at least one
of these options. For most workflows, check Use Base64 encoding on PS command.

You can check Use SVG if the workflow is a simple variable 'mail-merge' workflow.
In this case also check Use Base64 encoding on SVG command. However for most
(more complex) workflows leave Use SVG unchecked.

If Use SVG is checked then you should set up SNAP (RIP Installed) fonts.

10. On the Engine tab, the option Zip all files that have been generated in same dir-
ectory as spool is supported by later version of the HP Indigo DFE.

Copy all files to output directories at once when all files are processed is recom-
mended if you are automating the printing process using hot folders.

18.3.2.3 Configuring the Printer

Before you process a workflow file in the Production environment, you should also check the
PPML Printer configuration. In the HP PPML Printer Config dialog:

1. On the Page Media / Impositioning tab, Create JDF should be left unchecked, it is not
supported by HP Indigo.

If you are employing PPML impositioning, check Use global impositioning. Remember
impositioning can be performed by a workflow instead of here, using impositioning
modules. PPML impositioning can only be done if you are using Production Flow v1.03
or higher or Indigo 5000/5500 7.2 or higher.

The Use pre-defined command allows a duplex command to be selected.

2. If you have checked Use SVG in step 9 of the Configuring the HP PPML Engine part
of this example (above) then you should set up SNAP fonts via the Fonts tab:

Go to the Used Files dialog by selecting File | Used Files from the Workflow
Window menu and export all TTF and PFB fonts listed there to the RIP directory
using the Export icon. This should be confirmed using the Font Manager for
the RIPs in the HP Production Pro software.

Go to the Fonts tab of the HP PPML Printer Config dialog and edit the font list to
ensure that these fonts are listed and matched there.

2185
18 Examples of Use

18.3.3 How to Configure RIPs for IJPDS

When setting up the logical printers for each of the media pages using the IJPDS Page Side
Configuration dialog and the IJPDS Physical RIP Configuration Dialog, it is useful to consider
the below diagram:

This diagram represents how colors on page sides may be divided and printed between the
RIPs and the heads of the RIPs in a printing station acting as a single logical printer for a print
job.

In the above logical printer set-up, there are two page sides to one media page. The front side
has been defined as CMYK split color and the back side as Black and White. Further to this, a
set of four Versa RIPs have been assigned to process each of the four colors and a Scitex 6300
RIP has been assigned for the single black color of the back side. Each of the RIPs has two
heads, the Versa has 2688 jets on each head and the Scitex 6300 has 1024 jets.

1. In order to set up the RIP configuration shown above (with the front page side CMYK
and the back page side in black and white), first open the Printers tab for the engine
configuration:

Load a workflow to the Production environment .

Select IJPDS from the Engine combo-box.

Select an engine profile in the Profile combo-box in the Engine Config area, then
click on Edit.

Select the Printers tab.

2. By default, the Printers tab has a page side created for black and white output colors.
To reconfigure it, select that page side and click on the Configure icon to open the
Page Side Configuration dialog.

2186
 18.3 Production Examples

3. The Page Side Configuration dialog opens.

Choose CMYK split for Output colors.

For CMYK split, it is necessary to set one RIP for each of the colors:

a. Cyan to RIP 0

b. Magenta to RIP 1

c. Black to RIP 2

d. Yellow to RIP 3

Select Cyan as the Printer color and click on RIP 0 to configure the first RIP.

2187
18 Examples of Use

4. The Physical RIP 0 Configuration dialog opens.

The Head 1 check-box is already checked. Check Head 2 also.

Click on OK.

The Physical RIP 0 Configuration dialog closes and you are returned to the Page
Side Configuration dialog. Click on OK.

5. The Logical Printer 1 Configuration dialog opens with Magenta selected as the Printer
color.

Select Printer color as Magenta.

Click on RIP 1.

2188
 18.3 Production Examples

6. The Physical RIP 1 Configuration dialog opens.

Check Head 1 and Head 2.

Click on OK.

7. The Logical Printer 2 Configuration dialog opens with Black selected as the Printer
color.

Click on RIP 2.

2189
18 Examples of Use

8. The Physical RIP 2 Configuration dialog opens.

Check Head 1 and Head 2.

Click on OK.

9. The Logical Printer 3 Configuration dialog opens with Yellow selected as the Printer
color.

Click on RIP 3.

2190
 18.3 Production Examples

10. The Physical RIP 3 Configuration dialog opens.

Check Head 1 and Head 2.

Click on OK and you are returned to the Page Side Configuration dialog.

11. Create a new page side by clicking on the Create New icon from the Page side
operations.

2191
18 Examples of Use

12. The Page Side Configuration dialog opens.

Select Black and white for Output colors.

Click on RIP 4.

13. The Physical RIP 4 Configuration dialog opens.

Select Scitex 6300 as the RIP Type.

Check Head 1 and Head 2.

Click on OK.

2192
 18.3 Production Examples

14. The result should look as follows:

Note If the configuration of a page side is aborted using a Cancel button, then the automatic
prompting for unassigned colors (with the appearance of the Logical Printer Configuration
dialog) does not occur. You must then add and assign individual logical printers using the Lo-
gical printer operations icons at the bottom of the Printers tab.

18.3.4 How to Handle Overlapping Heads

If more than one head is used for printing of one page, then the heads can be set to overlap
each other of several dots, to produce a border-free printout. In this overlapping area the
printer will bring the double amount of ink on the paper.

If simple text is printed on printer and the text is in the overlapping zone then the text looks
like bold printed in this zone. So each overlapping zone looks like a bold line in the text. This
is an unwanted effect for the customer.

The overlapping which is directly on the printer itself needs to be disabled so that this feature
works correctly.

For more description, see also Setting IJPDS Overlapping Heads.

Example for the 4-dots overlapping zone (the darker line in the middle of the text)

Magnified part of text in the overlapping zone.

2193
18 Examples of Use

To avoid this overlapping effect the text can be divided in the space between the words. Each
part of the text is then assigned to one head. For this method it is necessary to overlap the
second head over first head by setting the second head position in Physical RIP configuration
and check option partial overlapping of heads in IJPDS data stream configuration window.

Note You will lose this distance in the available printing width.

Example of the overlapping zone for text splitting (the red line inside the text marks the splitting)

Note The splitting line is also influenced by the tendency of a head to print as much of one
flow area as possible. If a word is in the overlapping zone, it is preferably printed by the head
that prints most of the flow area where this word belongs.

18.3.5 How to Produce PS Hybrid Spool Files

See also:
PostScript 2 Engine Configuration
PostScript 3 Engine Configuration

This example illustrates which options to set in order to create PS hybrid spool files and, for
details of the exact function of each option, it gives links to the relevant option descriptions.

PS Hybrid spool files have their overlays generated as external resources (EPS images). These
EPS images are known as 'back forms' by Xerox and will contain all objects that were in the
overlay, i.e. images, shapes, text and other image-like objects such as border styles.

Alternatively, a back form could just be a single image that is not in an overlay, but this depends
on the combination of layout design and production settings.

In addition, re-using images increases efficiency when running large jobs with similar images.
This example explains how to create these back forms and re-use them using either of the
PostScript engines.

2194
 18.3 Production Examples

The hybrid spool file we will create in this example was designed for use with the Xerox CF
X490/980 device:

1. Think about your Layout design: Is there variable content that would be spooled as
overlays, e.g. a table which has body rows repeated by a variable and the rows have a
colored border style?

In this case, differing overlays would need to be created for each amount of rows that
appear in that table and so there would be more unique overlays and less reusable
ones. Therefore, you should remove the variable content from them in order to allow
more images to be re-used for more than one record.

For the example of border styles, this is done in the Layout Options dialog (Current
Layout Module Options | Overlays Properties) by unchecking the option Use overlays
for borders.

2. Assign all other objects that you want generated as part of the back form, to a single
handing group (e.g. Handling group 2) in the Layout module of your workflow.

Handling groups are assigned using the Handling group edit-box on the Position
tab of image areas and other containing objects on a page such as flow areas and
shapes.

3. Save Workflow and Run Production .

4. Select AdobePostScript2 or AdobePostScript3 in the Engine combo-box of the Main

Production window.

5. Create a new Engine Config profile by clicking on the New button and give it an ap-
propriate name, e.g. PS Hybrid.

6. Click on Edit to open the PostScript Engine Config dialog.

7. Go to the Images tab in the PostScript Engine Config dialog and, in the Image Filters
section, click on AsciiHex so that it becomes one of the filters used.

There should now be just AsciiHex listed for PostScript 2, or both Flate and AsciiHex
listed for PostScript 3. These are the recommended setting for back forms, but you can
test other filter combinations which might prove better at processing certain images.

8. Check Enhancement and select Xerox in the combo-box to its right, in the Custom
Image Generation section.

2195
18 Examples of Use

9. Specify the path to the directory where you want the images to be generated to. This
is done in the External resource directory edit box.

The path can be relative, to the directory where the spool file will be created, or absolute.

10. Check Merge overlays and Merge also images.

These settings are important because there will be only one overlay that gets converted
to a back form for each page. Therefore, it is required to merge all overlays and images
(there could be many depending on how many objects there are and their Z-order) in
order to create the fullest and most efficient back form.

11. Check Reuse generated background images so that the back forms will be referenced
in a unique way so that they can be reused and to complete the settings on this tab.

2196
 18.3 Production Examples

12. Go to the Image Handling tab and, for the handling group that you used in step 1 (e.g.
Handling Group 2), select Generate externally for both Images and Internal images.

13. Click on OK to save the engine config.

14. Select a suitable destination for the spool file in the File name edit-box of the Main
Production window.

15. Enter a Job name.

This step completes the SETPROJECT VIPP command which will be added to the PS
spool file. This command is used by the VI interpreter to group the images into projects
and also includes the location that you set for External resource directory.

Example [(JobName1)(Z:\Resources\Images)] SETPROJECT

16. Click on Start to produce the PS Hybrid spool file.

18.3.6 How to Set IJPDS Overlapping Heads

In this section
Setting Overlapping Heads
Overlapping Example

When overlapping heads, text is divided in the space between words and for each of the partially
overlapping heads:

The letters are then assigned to one of the heads.

For images the head, which prints the largest part of the image, is used.

18.3.6.1 Setting Overlapping Heads

1. Check the Partial overlapping of heads check-box in the Engine Configuration dialog.

2197
18 Examples of Use

2. Double-click on the logical printer (see the highlighted area in the panel) to make the
Page Side Configuration dialog open.

3. Double-click the RIP 0 to configure it.

4. The # of jets edit field determines the width of each head (in this case 2688).

The Head 1 or Head 2 position fields determine the start position of each head.

Set the 2nd head start position to 2600, now the range for the 1st head is 1-2688, for
the second head 2600-5288.

2198
 18.3 Production Examples

There is overlapping between 2600-2688. This part of document is printed only by one
head. An algorithm decides which head will print it.

Note If you make by mistake a gap in between the heads, you will receive no warnings and
a corresponding empty stripe will be left during printing.

18.3.6.2 Overlapping Example

When you use, for example, Scitex 5300 (marked 1 at the screenshot above) head, you can
see this printer head has 832 Jets (2). If you click Toggle Stitch button (3) and if you set the
value (4) lower than the number of jets, it means that heads are overlapping by 100 dots. In
this case, in the overlapping part it is decided which part of the text will be printed by particular
head.

2199
18 Examples of Use

In MailProof you can move with printer heads and you can see the overlapping boundaries.

If you set the starting position of the second head to more than the size of head (e.g. 932),
there will be a gap in text. A part of layout will be missing as you can see on the screenshot
below:

2200
 18.3 Production Examples

In MailProof viewer you can see the same:

18.3.7 How to Set IJPDS Cue Intervals from

Size of Medium
Here we will set up cue intervals for the IJPDS engine configuration using the Medium size se-
lection for the Variable Cue Length option that appears on the Advanced tab of the IJPDS
Engine Config dialog.

2201
18 Examples of Use

As a scenario, you require two different cue intervals and there are already two pages defined
on the Printers tab of the IJPDS Engine Config dialog, e.g. page 0 and page 1 in the screenshot
below:

1. In the Layout module of the workflow, create two pages (one for each cue interval),
e.g. one with Height as 304 mm and the other with Height as 254 mm.

2. Give the two pages the Sheet name 1 values of 1 and 2 respectively on the Sheet
Names tab of the each page.

3. In the Output module, define two media that correspond to the layout pages and with
the same Medium index as one of the pages on the Printers tab. E.g. media with
sheet names 1 and 2 in the screenshot below both have Medium index set to 0 to
match media page 0:

4. Repeat step 1.

5. Similar to step 2, give these two new pages the Sheet name 1 values of 3 and 4 re-
spectively.

6. Create another pair of media, for these new layout pages, in the Output module and
give them the same Medium index as the other page on the Printers tab. E.g. media

2202
 18.3 Production Examples

with sheet names 3 and 4 in the screenshot below both have Medium index set to 1
to match media page 1:

7. Load the workflow to Production (e.g. by pressing <F5>) and re-open the correct IJPDS
profile (with the defined pages) by selecting in the Engine Config Profile edit-box and
clicking on Edit.

8. On the Advanced tab, select the Medium size radio-button for Variable Cue Length.

Now there are two cue lengths (or cue intervals) set. Notice how these same intervals must be
redefined for each page defined in the IJPDS profile.

18.3.8 How to Split PDF and Insert Bookmarks

18.3.8.1 Splitting PDF File
To split a PDF according to a variable in the data file, do the following:

1. Go to Layout; in the Layout Tree click on the node of the first page of your document.

2. Go to the Sheet Names tab in the Individual Page Layout Properties of the first page.
For a Sheet name, let's say Sheet name 4, choose in the drop-down menu a variable
to control the splitting of pages (e.g. if you wish to have separate file for each family,
choose as a variable Surname).

Tip Depending on your data structure, you might need to adjust (e.g. group) your
data. See also the Data Processing modules descriptions.

3. Press the <F5> key to go to Production and choose PDF in the Engine combo-box.

4. Include the suitable substitution character (for our Sheet name 4 it is %h04) in the file
name. This will produce a new PDF file every time the value for the Sheet name 4
changes.

5. Enable the Split by group check-box.

2203
18 Examples of Use

18.3.8.2 Inserting Bookmarks

To insert bookmarks based on a variable in the data file, do the following:

1. Click on the Pages node in the Layout Tree. Go to the Sheet Names tab of the Layout
Properties and click on the Create New icon in the bottom right corner.

2. Note the Sheet name index (usually 3 to start with). Variable values of this Sheet name
will generate a bookmark for each data record read in.

Tip To make each page number a bookmark, do not set the index on the Pages level.
Instead, go to each page in the layout and set the index on the Sheet Names tab. So,
if you set PageCounter as your variable for each page of the layout, you would get a
bookmark for each page number in your PDF.

3. Go to the Output Module in your workflow. In the Device Profiles pane, click on the
New button.

4. When the Create Device Profile dialog comes up, select PDF in the Type combo-box
and give the configuration a meaningful name, like Bookmarks.

5. In the PDF Device Profile dialog enable the Generate bookmarks check-box to activate
the area for defining your bookmarks labels and types.

6. Right-click on the Bookmarks structure root. Choose Insert Child Text. Type in the
bookmark section name. This will be a title text that will appear at the top of the
bookmarks in your PDF document. It can be e.g. Surnames, if the first level of bookmarks
consists clients surnames.

7. Right-click on the title text line and select Insert Child Text from Sheet Name. Select
the new line by clicking on it in the Label column and specify the sheet name, that
uses the variable values you want to employ for the bookmarks. In this example, it
would be 3. Insert more child items for further bookmark levels.

8. In the If Sheet Name is Empty pane, select the Skip bookmark option to avoid
having empty bookmarks.

9. Go to the Production and spool the job.

2204
 18.3 Production Examples

If you combine both of these options, you can get separate PDFs for each record (based on
the Surname variable for example) as well as bookmarks for each ZIP code in the PDF.

18.3.9 How to Use the Jog Option

See also:
Output

This feature can be used for AFP Output. In Layout there is one page defined. During printing
we want to have every 1000 sheets shifted in the output tray. To be able to use the Jog option,
we need to define two media in the Output module with sheet names, e.g. Page 0 and Page
1 and check the Jog option for both of them.

Switching between Page 0 and Page 1 (which activates Jog) is done through the variable Jog-
Control that is related to GlobalPageCounter.

In Layout we create the variable JogControl with the following script:

return String("Page ")+((SYS.GlobalPageCounter/1000)%2).toString(1);

The script returns either Page 0 or Page 1 depending on the value of GlobalPageCounter.
For pages 0-999 the variable returns Page 0, for pages 1000-1999 Page 1, for pages
2000-2999 Page 0 etc.

2205
18 Examples of Use

This variable is then used in Page Layout Properties as a variable sheet name:

As the value of sheet name changes based on the JogControl variable, the corresponding media
in Output is used (with Jog option enabled) and thus the stacks of 1000 sheets are created.

18.3.10 How to Use RIP Splitting

If you use splitting, you could print the front side using 5 heads (4 heads from RIP 0 and 1
shared head from RIP 1) while the back side is printed using only 3 heads.

1. Set up this RIP splitting example for the IJPDS engine:

Go to Production <F5>.

Select IJPDS from the Engine combo-box.

2206
 18.3 Production Examples

Select Edit in the Engine Config area.

Select the Printers tab.

2. Check the option Use RIP Splitting.

Double-click on logical printer (see the highlighted area in the above panel) to get
the Page Side Configuration dialog.

3. Page Side Configuration dialog:

Select Black and white for Output colors.

Click on RIP 0.

2207
18 Examples of Use

4. Physical RIP 0 Configuration dialog:

Select Scitex 5300 as RIP Type.

Check Head 1 through Head 4 in RIP 0.

Click OK.

5. Page Side Configuration dialog:

Click on RIP 1.

2208
 18.3 Production Examples

6. Physical RIP 1 Configuration dialog:

Check Head 4.

Click on OK.

7. You are returned to the Page Side Configuration dialog, click on OK.

8. IJPDS Engine Config dialog:

Create a back side for the page by clicking the Create New icon from the Page
side operations.

2209
18 Examples of Use

9. Page Side Configuration dialog:

Click on RIP 1.

10. Physical RIP 1 Configuration dialog:

Check Head 1 through Head 3.

Click OK.

11. You are returned to the Page Side Configuration dialog, click on OK.

2210
 18.3 Production Examples

The result is:

On the front side you are using 4 heads from RIP 0 and 1 head from RIP 1.

On the back side 3 heads from RIP 1.

The option Use RIP splitting is now grey, you cannot change it.

18.3.11 How to Use RIP Stitching

We are going to configure the following RIP formation:

1. Set up this RIP stitching example for the IJPDS engine:

Go to Production <F5>.

Select IJPDS from the Engine combo-box.

2211
18 Examples of Use

Select Edit in the Engine Config area.

Select the Printers tab.

2. Now do the following:

Check the option Use RIP stitching (see above).

Double-click on the logical printer (see the highlighted area in the above panel) to
get the Page Side Configuration dialog.

3. Page Side Configuration dialog:

Select Black and white in the Output colors combo-box.

Click on RIP 0 to configure RIP.

2212
 18.3 Production Examples

4. Physical RIP 0 Configuration dialog:

Select Scitex 5300 as RIP Type.

Check Head 1 and click on OK.

5. Page Side Configuration dialog:

Repeat step 4 for each RIP.

6. Click OK on the Page Side Configuration dialog.

2213
18 Examples of Use

The result is one logical printer made up with three heads (each from different physical
RIP).

The option Use RIP stitching is now grey, you cannot change it.

18.4 Complete Solution Examples

18.4.1 How to Auto-Follow On Twitter
See also:
Social Data Connector Module
Authentication Library Module

Auto-following is a series of queries made to the Twitter API so that: When a person starts
following you on Twitter, you start following them. This example describes the workflow required
to do that.

In order to follow your new followers, the workflow here will have to be processed and to do
that 'automatically' at certain time intervals you will require the separate application Inspire Auto-
mation (PrintNet PA). However, this workflow could simply be processed in the Production
environment every now and again, when it is required to follow new followers.

2214
 18.4 Complete Solution Examples

In order to make the workflow:

1. Add an Authentication Library module to your workflow and add a Twitter account
to the Twitter tab:

It does not matter which account you use in order to get the followers of anybody
else's account on Twitter. However, you must have already registered your installation
of Inspire Designer as an application with Twitter in order to get your Consumer key
and Consumer secret. See the section Authentication Library Module for a description
of the options on this module.

2. Authenticate the new account by clicking on the button and following the steps in
the Twitter Application Authentication dialog that opens:

3. Add a Param Input module to the workflow and add a new field using the Create new
icon.

You can leave the Name with its default value of Params.

This module is not essential to the workflow we are creating, but it will allow us to
more easily select which Twitter account we want to use in other modules. Also, it will
allow us to change user in the Workflow Parameters window pane at the time of pro-
cessing the workflow, if we should choose to do so.

4. Give the new field a Field Name, e.g. ScreenName and the Default Value of the user
name of the account you have authenticated in steps 1 and 2 as Authentication.

2215
18 Examples of Use

This default value could actually be the user name (called 'screen_name' in the Twitter
API) of any account which you want to find out who they are following, but for this
example we are using the same account that we have authenticated because it is the
account we want to use to follow other people.

5. Add a Social Data Connector module to the workflow; select Twitter as the Social
Network and the account you have authenticated in steps 1 and 2 as Authentication.

6. Select Get friends for Query.

Friends are the Twitter accounts that a user is following. We need to know who we
are following so that we do not try to follow them again, which would cause the error
Error in data transfer 403 Could not follow user: ... is already on your list.

7. Select Params (the array created by the Param Input module) for Array and ScreenName
in the Field column:

In steps 5, 6 and 7 we have determined that we will be getting the friends of the account
returned by the field we created in the Param Input module in step 4.

8. Add another Social Data Connector module to the workflow; select Twitter as the Social
Network and the account you have authenticated in steps 1 and 2 as Authentication.

9. Select Get followers for Query.

2216
 18.4 Complete Solution Examples

10. Select Params for Array and ScreenName in the Field column:

In steps 8, 9 and 10 we have determined that we will be getting the followers of the
account returned by the field we created in the Param Input module in step 4.

11. Add a 1-1 Merger Module to the workflow and connect both Social Data Connector
modules to its input connectors.

The Get friends query module must go to input A (upper) and Get followers must go
to input B.

12. Select the id field of each input as the one that is the merging key.

13. Check both Allow unmatched from A and Create unmatched output from B:

Both of the Social Data Connector modules used so far have created data structures
which will be used to return data from the same Twitter account: One contains details

2217
18 Examples of Use

of the accounts of friends and the other details of the accounts of followers. Both of
these sets of data have the id numbers of those accounts. In this module we are
matching the ids in order to find out which accounts we are both following and are
following us such accounts will be sent to the matched output.

We want to know who is following us that we are not following, therefore we need
just those accounts from Get followers that are still unmatched. That is why we check
Create unmatched output from B which will allow us to connect to the unmatched
output. However, we further need to allow unmatched accounts to come from A, be-
cause we want the workflow to process without any errors even if there are people
we are following that are not following us. That is why we check Allow unmatched
from A.

14. Add another Social Data Connector module to the workflow and connect it to the
unmatched output (B) of the 1-1 Merger Module, i.e. the bottom output of the two
outputs.

15. Select Twitter as the Social Network and the account you have authenticated in steps
1 and 2 as Authentication.

16. Select Follow by id for Query.

17. Select the ids array that has been output by the previous 1-1 Merger Module in the
Array combo-box.

18. Select the id field in the Field column of the user_id query parameter.

In steps 14, 15, 16, 17 and 18 we have determined that we will be following those
accounts, which we established were new followers that we weren't already following
using the 1-1 Merger Module in steps 11, 12 and 13.

19. In order to be able to process the workflow, finish it with a Data Output module.

In this case, we do not need to create any output file so select Null for Output type.

20. Save Workflow and Run Production .

21. In the Main Production window, click on Start to process the workflow and commu-
nicate with Twitter.

2218
 18.4 Complete Solution Examples

18.4.2 How to Create and Send Personalized

HTML Emails
In this section: See also:
Inspire Designer: Data Input File for HTML Email Mode Best Practices
Inspire Email Gateway and Personalized
HTML Files
Inspire Email Gateway: How To Send
Personalized Emails

This example shows how to use Inspire Designer and Inspire Email Gateway to:

Create personalized HTML files.

Prepare the data input file (in the CSV format) for Inspire Email Gateway.

Send the files as emails.

2219
18 Examples of Use

Suppose, you are an employee of a department store chain with stores in many cities. The
business is blooming and you keep getting new clients, who sign up for a loyalty card and your
chain's newsletter.

You want to communicate with them by email efficiently, yet not flood all of your customers
with all possible news from all over the country. You want to personalize the messages. And
that is where Inspire Designer and Inspire Email Gateway come in.

2220
 18.4 Complete Solution Examples

The schema below shows the general idea of the workflow. In our particular job the emails
are sent via SMTP server(s). The job requires no scripting.

Data Input

Inspire Designer
Prepares the data input file for Inspire Email Gateway and the email content.

Inspire Email Gateway Data

Layout + HTML Output
Module + Data Output

Data Input File

Contains email addresses and Personalized HTML Files
paths to HTML files.

Inspire Email Gateway

Sends personalized emails.

SMTP Server Script

18.4.2.1 Inspire Designer: Data Input File for

Inspire Email Gateway and Personalized HTML Files
Data Input File for Inspire Email Gateway
1. Prepare the Inspire Designer workflow. It contains 5 modules:

Data Input

Layout

Data Transformer

Email Gateway Data

Data Output (automatically connected to the Email Gateway Data module)

2221
18 Examples of Use

2. In the Data Input module define the original input data file.

Our example input file is called Clients.csv. Apart from other data, it contains the names
and email addresses of our clients. The names will be used for personalization in Layout;
the email addresses will be used for sending the messages, but also we will use them
as the names of the personalized HTML files.

3. Connect the Data Input module with the Data Transformer module.

Double-click on the transformer and you will see the data fields present in the Clients.csv.
Here a new field will be added.

4. Add a new field based on the Emails field and set the Field Converter for this field
to String manipulation. Then click on the 3 Dots icon to concatenate the '.html'
suffix to each email address.

This field will specify names of individual HTML files for each addressee listed (in the
next step) in the Inspire Email Gateway input file. This way we can be sure, that each
addressee receives a message meant for them and not for anybody else.

2222
 18.4 Complete Solution Examples

5. In the Email Gateway Data module define:

The Parrent Array In our case Records.

For the ToMail field Variable Email (this field is the only mandatory one, when
creating the input data file for Email Gateway).

For the HTMLFile field variable HTML_Names.

The selected variables define the values for the Inspire Email Gateway input file, that
will be generated in the following step.

6. In the Data Output module, specify (the location and) the name of the CSV In-
spire Email Gateway input file.

Keep the default Output type setting of CSV.

Note It is recommended to keep the default UTF-8 codec for Text encoding
throughout all the modules and both applications. Only the encoding defined for the
data input (in our example in the Data Input module) has to correspond with the actual
encoding used for the data file.

Tip The CSV file and the HTML files (with their resources) should be generated to the
same folder, so that no further location specifying is needed.

2223
18 Examples of Use

7. Mark the Data Output module with the Use for Production icon and run the workflow
in Production.

The result of this run is a CSV file (see the screenshot below) that can be fed to In-
spire Email Gateway, to tell the application to send the specified personalized HTML
files to specified email addresses.

HTML Files Design

The aim is to design a concise personalized HTML message. See the image below and its legend.

2224
 18.4 Complete Solution Examples

Legend

1. A link to the landing page (a HTML file stored on a server for reading in the case of
any troubles in viewing the HTML email message; the link can be inserted in Layout or
in the HTML Engine Configuration).

2. Personalized customer data and nearest shop locations.

3. URL links to the chain's web pages.

4. A URL link to an online map allowing route planning.

5. A variable image marking the addressee's nearest shop on a simplified map.

6. Colored background (defined in the HTML Engine Config).

Note If you need to ensure that the text in your HTML files will not be rasterized, follow the
hints in the HTML Email Mode Best Practices section.

A sheet name value with the concatenated suffix, that will be used to generate the names of
the HTML files (email address + '.html' suffix), will name the personalized HTML files like this:
[email protected].

For our example, we will use the Email field values for sheet name 3. Email addresses prove
useful as a sheet name value for naming our HTML files as each one is unique.

Tip When designing your email layout, repeatedly Proof your workflow to ensure that it the
output of the workflow will be correct in Production.

Personalized HTML Files Production

1. In Inspire Designer Production select the HTML Engine. Go for the Email Generation
mode and, depending on your preferences, set the engine to either Support text pro-
cessing or Rasterize all flows (default).

2. Specify the path to the generation folder and the name of the HTML files in the File
name edit-box.

The files will be personalized and we will use the values defined for sheet name 3 to
name them, i.e. email addresses. The %h[03] substitution character has been used to
determine that sheet name 3 will inserted in the file name. For a list of other possible
substitution characters check the tooltip which can be displayed over the edit-box.

Keep the Split by group check-box enabled (it is automatically enabled when the
HTML engine is selected in the Engine combo-box).

Tip Open several of the spooled HTML files in an HTML viewer (e.g. Internet Explorer)
to be sure that the look of the output is as it was designed and that any variable content
appears correctly from file to file.

2225
18 Examples of Use

18.4.2.2 Inspire Email Gateway: How To Send Personalized

Emails
1. Setting Inspire Email Gateway starts with specifying the input CSV file. It is the same
file we generated via Inspire Designer using the Email Gateway Data module.

The CSV has to define at least the ToMail value(s) and it can define many other para-
meters. The optional parameters set in the CSV can be overridden by entering alternative
values in the CSV Global Settings and Attachments subsections of the Sources tab
of Inspire Email Gateway.

In our example screenshot above, the Use this sender/subject for all check-boxes in
the Global Settings Overriding Input Data section are enabled. That allows to specify

2226
 18.4 Complete Solution Examples

the sender's name and address as well as the subject. The HTML messages (paths to
them) are already defined in the CSV file.

2. Define at least one SMTP server on the Settings tab.

3. With the Verify icon, check the settings. If no problems are reported on the Status
tab, send the emails by clicking on the Send Emails icon.

Tip In the case of any problems, check the log file and Error.csv file, that are generated to
the same folder as the input data CSV is loaded from (unless you change the folder in In-
spire Email Gateway GUI). For more information see also the Inspire Email Gateway User
Manual.

18.4.3 How To Spool Many PDFs to IJPDS

When combining a large number of PDF files for production with an IJPDS printer it maybe
necessary to reduce the size of the spool file, the number of fonts used and the amount of
memory required to handle the process. This is especially the case with older IJPDS printers
which have less memory at their disposal.

This example is based on a solution that was provided for a print provider that had a 4GB IJPDS
controller on the OS2 operating system and used an IJPDS proofer. They wanted to spool more
than ten thousand PDFs which were produced by differing methods and they required them

2227
18 Examples of Use

to be combined and printed together using one spool file. In such a situation difficulties with
size are common, but this optimization can also help with smaller quantities of PDFs.

1. The PDFs can be, most simply, combined using a workflow which has the Inspire Native
module, e.g.:

Click on Create New to add the files to the module. You can select multiple files
in the Open dialog that opens.

Also select Merge all native files so that all the PDFs are processed together as a
single native file.

The order of the PDFs in the file list will be the order of the eventual pages of the res-
ulting IJPDS document. The files can be re-ordered using the Move Up and Move
Down icons.

2. Connect an Output module to the Inspire Native module, i.e.:

2228
 18.4 Complete Solution Examples

This has to be done so that the workflow can be processed. However, it is not necessary
in this case to configure the Output module any further.

3. Save Workflow and Run Production .

4. Select IJPDS in the Engine combo-box.

5. Create a new Engine Config profile by clicking on the New button and give it an ap-
propriate name, e.g. MultiPDF to IJPDS.

6. Click on Edit to open the IJPDS Engine Config dialog.

7. On the Resources tab uncheck Load overlay as font.

This option has less advantage with PDFs than with other formats. While it is checked,
each created overlay is stored in a separate font. Because of the high number of PDFs
then it is likely that the same objects are repeated and similar overlays will be created.
By unchecking this option then only one copy of each overlay is kept. Duplicates are
then disregarded and instead the single copy overlay is reused as required.

There are also likely to already be many fonts from the many different PDFs and there
would also be many overlays created. If this option was left checked then it may produce
more than the maximum allowed number of 255 fonts.

Depending on the content of the PDF files (e.g. when there is not so much repeated
content), this step may not improve processing.

8. Uncheck Merge static objects into single overlay.

We don't want the static objects to be merged so that smaller objects can be evaluated
better for the purpose of the size optimization we select in the next step. We particularly
want to divide pages into smaller objects if it is known that there is a lot of unfilled
(white) space on the pages of some of the PDFs. Also smaller objects are more likely
to be of common features of the PDF and occur frequently in the page designs.

Depending on the content of the PDF files (e.g. when there is not much unused space
on pages), this step may not improve processing.

9. Select High for Size optimization.

Size optimization is needed so that any object that appears more than once throughout
the many original PDFs is stored as a single resource and used repeatedly.

10. Check Optimize overlay font size.

This option will optimize all used glyphs, ensuring that they are not duplicated.

11. Check both of the compression options: Use compression for font and Use compres-
sion for pictures.

These are the least important to check for our purposes and can increase processing
time, but, depending on the content of the PDFs, will help reduce the size of the spool
file.

2229
18 Examples of Use

The Resources tab of the IJPDS Engine Config dialog should now display the settings
shown in the below screenshot.

12. This step is optional.

Go to the Font Options tab and review the Encoding settings.

Encoding considerably increases spool file size. If possible uncheck Text encoding.
One disadvantage of doing this is that the spool file will not be readable in an IJPDS
proofer or on a Scitex controller.

13. Go to the Printers tab and double-click on the first page side that is shown in the table
in order to open the Page Side Configuration dialog.

2230
 18.4 Complete Solution Examples

14. On the General tab, check Use super font only for overlay fonts, i.e.

As super fonts have a larger capacity for glyphs, this is a method to include more of
the many glyphs used into a smaller number of fonts. However, the two super-font
options here also increase spool file size and we are also trying to keep the spool size
to a minimum. Use super font for all fonts is likely to increase spool size too much
and give us more capacity than we really need for the glyphs.

15. Repeat steps 12 and 13 for each of the page sides that make up your logical printer
definition.

The number of page sides is usually unique to the RIP set up and other printing require-
ments of a particular IJPDS printer. See the Printers Tab section of the IJPDS Engine
Config dialog description.

16. Close the Page Side Configuration dialog and the IJPDS Engine Config dialog.

17. Select a suitable destination for the spool file in the File name edit-box of the Main
Production window and click on Start.

2231
19 Appendices

19.1 Additional Information

19.2 Barcodes
19.3 Color Management
19.4 Configuration
19.5 Importing PrintNet 3 Jobs
19.6 IPDS Exceptions
19.7 Tested Configurations for Printers
19 Appendices

19.1 Additional Information

19.1.1 Mac Specific Information
The following features are not implemented in the current Mac version of Inspire Designer:

Data Precise module

External Input module

Line Data Input module

Importing PrintNet 3 jobs

DOC/DOCX import and native import

PTF and PLS import

Secure printing

Wiziway barcode

Create Connect String function in ODBC Data Input module

DirectType

Inspire Content Manager (VCS): the option Log as current user

Inspire Content Manager (VCS) Server connection to EMC Documentum, SharePoint

and MediaBin

FCV's and condproc.dll for PrintNet 3 compatibility

The IPDS interfaces ASPI, DW2000, DW2100 and Barr

WMF image format (also does not work for images included in RTF files)

DocX: the option Merge with predefined template

Open associated files in new window option in Workflow Options Dialog

The following Inspire Designer related applications are currently not available for the Mac
platform.

Dithering Picker

Flow Translator

TNO Writer

Other differences:

Fonts

Preferences file (.cfg) is saved in folder User/Library/Preferences.

2234
 19.1 Additional Information

19.1.2 Processing in Inspire Designer

It is helpful for workflow designers to be informed about the order that the components of a
workflow file are processed, so they can use them in the right place.

Example Some examples that relate to the way pages are designed in the Layout
module are:

The system variable PagesPerRecord cannot be used in any Next Page tab script
because this global variable is not yet known.

The value of SYS.PagesPerRecord is only fully calculated at the end of a pre-pro-

cessing phase. However, the Next Page tab's conditions are processed during that
pre-processing phase.

To remember a global variable from record to record, it has to be placed inside

objects which are processed during the pre-processing phase, i.e. a flow area that
flows from page to page or the Next Page tab of a page.

The following schema simplifies how Inspire Designer processes a workflow during production:

Each of the phases depicted in the diagram are described in the following sections.

19.1.2.1 Pre-Processing
The pre-processing of a workflow is done automatically when production is started. In a typical
workflow with a Layout module and variable data inputs, this is an analysis of the workflow
file in order to discover how to compile and repeat the pages that are designed in Layout.

The pre-processing phase is needed in order to get:

The sequence of pages.

The total number of pages.

There are particular features of a design that are particularly important to pre-process:

If there is variable page selection.

If text flows between pages.

If global variables are needed to be calculated.

If messages are used.

2235
19 Appendices

The following flow diagram illustrates the order of the workflow analysis when pre-processing:

Each of the phases depicted (colored red) in the diagram are described in the following sub-
sections.

2236
 19.1 Additional Information

Analyze Modules to Process Phase

The workflow is queried from the last module backwards through the workflow (right to left
as a workflow is viewed in the Workflow window). For example, the Output module calls the
Layout module, then the data processing modules then the data inputs.

Remember that, if there are several output modules in a workflow, you can select between
them in the Production environment. Only the modules relevant for the selected output are
looked at.

The query that is being relayed is, in very simple terms: How many pages are there to process?
In order to find out the answer, the query must go all the way back to the data-inputs to find
out how many records there are. Then, in the following phases, all of the data has to be pro-
cessed (via any data processing modules) and then the Layout module to find out how data
relates to pages. See the following phases described below.

Pre-Process Data Phase

Data input modules are traced and indexes of individual entries are stored as temporary results.
Data is only processed once and that is done here in pre-processing.

Simple data processing modules just trace the data through. Data processing modules that are
used for changing the record structure (e.g. Data Sorter) temporarily store their results.

To make the data processing phase quicker, it is advisable to filter unnecessary data as soon
after data input as possible. Then they are not traced or stored longer than necessary.

This data tracing does not occur when the data is already accessible in Inspire Designer's internal
data format; which is the case for the Data Cacher and Internal Data Input modules.

Pre-Process Layout Module Phase

After data tracing, the processed data is temporarily stored for use in the Layout module. At
this point it is determined whether any of the following conditions are met:

Page order is set to Variable selection or Data variable selection for the Pages family.

The design contains global variables that are not reset on each page (numbering variables
are also global variables).

The design contains any flows that flow from page to page.

Any page contains a message area.

Any page contains a variable sheet names.

Use error recovering has been set for the Data family.

2237
19 Appendices

If any of the conditions are met then, for each record (a record is determined by the option
Records by for the Data family) the following occurs:

1. The pre-processing starts on the page set as Start page for the Pages family. The fol-
lowing pages are pre-processed in the order determined by any next page conditions
that are set.

2. The sequence is repeated by any variable set for Repeated by in the Pages family
properties.

3. All Table of Contents pages are pre-processed.

4. Any pages added for messages are pre-processed.

5. Values of sheet names assigned to the Pages family are evaluated and stored.

6. Sheet names from each individual page are evaluated, in context, before pre-processing
the rest of that page.

7. The values of those global variables and flows which continue from page to page are
stored. Any values of global variables that are calculated only within the context of one
page are abandoned.

8. Objects on pages are evaluated in their Z-order, i.e. the order that defines the sequence
of individual objects from background to foreground.

Only the following objects are evaluated further:

Flow areas containing flows that overflow from page to page.

Objects that have Influence messages set on their Position tab and are placed
on a page that: either contains a message area; or will be the back side of a page
with a message area that has Is duplex message area checked.

If the object is one of the above two types of object and contains other objects then:

Flow areas, images and barcodes are evaluated fully.

Other objects are evaluated for variable visibility only.

Pre-Process for Error Recovery Phase

If Use error recovering has been set for the Data family then, after the initial pre-processing
of the Layout module, all pages are evaluated again. This time the evaluation is nearly identical
to the processing stage which follows with some minor exceptions, e.g. border styles used in
a flow are not processed.

Pre-Processing Summary
In summary, at the end of the pre-processing phase, all of the data has been processed and
stored in temporary memory and the variable objects created in the Layout module have been
identified and traced through the design ready for use in the next stage of processing.

Note The following system variables have values that are not calculable in pre-processing,
they are calculated in the actual processing phase: PagesPerRecord, GlobalSheetCounter,

2238
 19.1 Additional Information

GlobalSheetCount, GlobalPageCount, PagesPerSubRecord, GroupSheetCounter, PrintingFace,

GroupIndex.

19.1.2.2 Processing
The processing stage is when the workflow is spooled to the printer or, as in most cases, to a
spool file.

Processing defines sheets. Sheets are the units of repetition for the design (e.g. pages designed
in the Layout module, sheets read into a workflow by the Inspire Native module or Texts output
from the Template Merger module), i.e. each time a design is processed a sheet is created.

As with the pre-processing, processing is performed from the last module backwards through
the workflow until the design input module is reached. For example, the Output module is
where the definition of the first sheets to be printed starts (how sheets relate to the media
they will be printed on etc.), the definition is continued by impositioning modules describing
how the sheets will be arranged and finally the Layout module describes which design and
data will be on each sheet.

In the following sub-sections we describe the order of processing in the Layout module. We
will not describe all of the processing details here, only information that can help you to design
workflows in a more effective way.

Z-Order
The Z-order of objects in the Layout module is the order in which they are processed. It is also
the order in which those objects were analyzed in the Layout pre-processing phase.

The Z-order is determined by how objects overlap on a page or element. The first object placed
on the page establishes the bottom of the Z-order. Objects that are placed later on that same
page are higher in the Z-order and overlap lower objects.

The object Z-order can be seen in the structure of the Layout Tree for pages or elements, the
higher in the Layout Tree an object is (i.e. the closer to the page it is), the lower it is in Z-order.
This order can be changed by dragging the objects in the Layout Tree, using the Object Order
toolbar or via the Optimize options in the Edit menu of Layout.

Overlays
Static objects (i.e. those that do not use any variables) are placed into overlays in order to sim-
plify the spooled description of the design and increase processing speed.

Overlays are created as the objects are processed in their Z-order. The static objects are merged
into an overlay, one by one in that Z-order. However, if the next object is variable then it cannot
be placed in the overlay and so that overlay is finished. The next static object in the Z-order
will be placed in a new overlay and the process continues.

It is good practice to place static objects consecutively in the Z-order so that they will be pro-
cessed as a single overlay. This can be done quickly via the Edit menu of Layout, select Optimize
| Static Objects Order.

2239
19 Appendices

Flow Area Processing Method

As individual objects are processed in their Z-order, differing methods are used for different
object types. The most important to understand is the order in which flow areas are processed
because there can be large amounts of formatting included in them.

For flow areas the order of processing is:

1. The flow is formatted.

2. Any images or elements inserted in the flow are processed inline due to a need to know
their size.

3. If the used flow has First fitting selected for Type and it is too big for the flow area,
then the other assigned flows are tried to see if they fit. See the separate Flows section
for more details.

The order of 'painting' used styles and images within a flow area is:

1. Shadows, then border fills, then lines and corners.

This is applied repeatedly to the different styles used by the flow in the following order:
Paragraph style border; text style border; table border; cell border and again Paragraph
style border - repeating as deeply as needed.

2. Any used images and inserted elements are painted.

Individual elements are painted in an order similar to the page itself.

Although you can use global variables within the elements, it is not possible to
change their value within the element. Any changes in value of the global variable(s)
are forgotten (reset) after the element is painted.

3. Underline.

4. Text.

5. Strokes.

6. Cross lines from borders in the reverse order to that listed in point 1.

Example

In the above sample, the 'painting' sequence is:

1. Fill for Paragraph Style 1 (Steel Blue).

2. Border lines and corners for Paragraph Style 1 (Navy Blue).

2240
 19.1 Additional Information

3. Fill for Paragraph Style 2 (Pink).

4. Border lines and corners for Paragraph Style 2 (Red).

5. Fill for Text Style 1 (Aquamarine).

6. Fill for Text Style 2 (Sea Green).

7. Border lines for Text Style 1 (Fuchsia).

8. Border lines for Text Style 2 (Lime Green).

9. Underline for Text Style 1 (Pale Turquoise).

10. Text for Text Style 1 (Pale Turquoise).

11. Text for Text Style 2 (Pink).

12. Cross lines from borders in backwards order (i.e. for Text Styles first, then for
Paragraph Styles):

Cross lines for Text Style 1 (from top left to bottom right first blue, from
top right to bottom left second orange).

Cross lines for Text Style 2.

Cross lines for Paragraph Style 1 (Navy Blue).

Cross lines for Paragraph Style 2 (Red).

19.1.2.3 Post-Processing
There are three basic approaches to generate output, however certain outputs (PPML) or output
configurations can result in combination of those below-mentioned methods:

Inline resources spool file:

1. Generates resource and document files.

2. Merges resource and document files into one spool file.

All external resources spool file:

Resources are generated into separated files and kept separate form the spool file.

Direct printing output:

No intermediate spool file is created. All resources and the workflow are processed and
printed directly, e.g. IPDS.

2241
19 Appendices

19.1.3 Substitution Characters

See also:
Driver Configuration Overview

In certain places in Inspire Designer, substitution characters can be used to write variable data
that will be returned by a workflow when it is processed.

Many substitution characters may be combined, e.g. %n%s%j.pdf

The characters are described below:

%n workflow name:

Enters the file name of the workflow file but without the extension WFD.

%s sheetindex:

Enters sheet index (starting from 0) into the file name. The sheet index is taken from
the first page.

%a A01 group counter:

If the option Split by group is checked, the split file names will contain the number
of the group. The numbering goes: A01, A02 A99, B00, B01 B99 etc. Best suited
to IJPDS output.

%g group counter:

If the option Split by group is checked, the split file names contain the number of the
group (starting from 0).

%I split counter:

If the option Split by size is checked, enters a number into the file name which reflects
the split size.

%j global split counter:

If one of the options Split by group or Split by size is checked, enters a number into
the file name which reflects the number of splits.

%l sheet name 1:

Enters the value used in sheet name 1 into the file name.

%f sheet name 2:

Enters the value used in sheet names 2 into the file name.

%hxx sheet name xx:

Enters the value used in any other sheet name than Sheet name 1, 2 into the file name.

%h[sheet name index] sheet name:

2242
 19.1 Additional Information

Enters the value used in the sheet name with the specified index.

%e default extension:

Enters the default extension for the selected engine.

%m output name:

Enters the name of the output module selected in the Production window.

%v version of product:

Enters the version of the application used for spooling the file, e.g. 6.0.45.0.

%p[workflow parameter] workflow parameter value:

Enters the value of the specified workflow parameter. Within the square brackets type
the name of the parameter and the name of the module, e.g. %p[myparamParamInput1].
See also the sections Param Input Module and Workflow Parameters Window-Pane.

You can set/override the value of a workflow parameter in a script by simply assigning
the result of any script to the workflow parameter.

%ts(user pattern) job start:

Enters the date and time of the job start. The date and time pattern is defined within
the brackets. See the Parse Date Time section for details.

%ta(user pattern) current time:

Enters the current time. The date and time pattern is defined within the brackets. See
the Parse Date Time section for details.

You can define the number of characters of the output file name and set justifying right
or left with specified padding (zeros or spaces).

Example %-010g justified left, padding with zero, ten characters

%010g justified right, padding with zero, ten characters

%10g justified right, padding with space, ten characters

%-10g justified left, padding with space, ten characters

The defined padding will precede or follow the basic part of the file name: if in
the above example the group counter value is 1 and justifying left is chosen, then
nine zeros will follow the number 1. If justifying right is chosen, nine zeros will
precede the number 1.

When using substitution characters that return numbers, you can change the number
add or subtract a number. For example, you can use it for indexes that start from 0
to make them start from 1.

It is usable for any substitution character that returns a number: even for %n, if the
workflow name is a number, but not for %a, because 'A01' is not a number.

2243
19 Appendices

It can be combined with the definition of characters in the output file name and their
justifying, which is described above.

Example %;1g the group counter is increased by 1.

%;5s (or %;+5s) the sheet index is increased by 5. The '+' mark can be, but does
not have to be used.

%;5f 5 is subtracted from the sheet name 2 value, which you know is numer-
ical. For subtraction the '' mark is used.

%10;5g the group counter is increased by 5 and will be justified right, padding
with space, ten characters.

Example When producing a job using a workflow that has input data with a field cat-
egory called "ClientName", that contains a different entry (the client's name) for each
record, you can use that client's name as the file name for the document created by his
record:

The field category is read into the workflow and becomes a variable called "ClientName".
This variable is then available in Layout where a sheet name can be assigned that variable
(e.g. sheet name 3 assigned ClientName).

Subsequently, the sheets of the design can be split (e.g. using the Sheet Regrouper
module) so that one document is printed for each record.

Then you can enter %h03 in the File Name edit-box in Production. E.g.:

This means that sheet name 3 will return the file name as the job is processed. The result
of which would be that the name of each file produced is the respective client's name.

Notice that the substitution character %e has been used to automatically return the file
extension of the correct format of the file.

Tip In relevant places throughout the GUI, moving your mouse pointer over the area where
substitution characters can be entered will display a tool tip with the above list to help remind
you which one to use.

19.1.4 Installation Directory Content

After successful basic Inspire Designer installation on the Windows platform, the installation
directory contains the folders and files listed in the table below.

The table contains links to chapters of this user manual that describe the feature that the
file/folder is used for and it states, if this file/folder has to be placed by the EXE files (Inspire De-
signer and related applications) for them to work.

2244
 19.1 Additional Information

Example If you need to run e.g. PNetTNetServer.exe from a different directory than the
installation directory with Inspire Designer (PNetT.exe), do either of the following:

Set CX_DATA environment variable to the installation directory. Thanks to the

variable the PNetTNetServer.exe will have access to all files and folders from the
Inspire Designer installation directory.

Then it is only necessary to copy the licensing file, if needed for your licensing type,
to the same directory as the executable. It is not enough to have the licensing file
in the CX_DATA directory (i.e. installation directory).

Create a copy of the installation directory and, if short of space, delete files and
folders you are sure the application will not need for its run. Make sure you keep
the following ones:

icudt32l.dat (required for all PNetT*.exe files),

licensing file (if needed for your licensing type),

any other optional files and folders from the installation directory according
to the WFDs that will be processed (features that will be used).

If not sure which features will be used in the WFD files, copy the whole installation
directory and delete only the informative files (marked in the last column of the
table as For information only). Make sure you keep their copy at a different location.

File / Folder Usage In Directory with EXE

Files

DataPrecise Data Precise module If used, needs to be

present in the directory
DirecType Plugin Area If used, needs to be
present in the directory
Docx DOCX Import If used, needs to be
present in the directory
Getting Started Ex- WFD examples and related files, used with For information only
amples Getting Started PDF or CHM (see below)
IPDS Contains installers for IPDS drivers If used, needs to be in-
stalled
Licensing Contains HASP driver and license manager If used, needs to be in-
installers, can be used together with HW stalled
licensing (dongle)
Normalizer9 / Normal- For correct functionality of PDF-related If used, needs to be
izer9_64 features present in the directory
OCI / OCI64 ODBC Data Input module to connect If used, needs to be
natively to Oracle databases using OCI present in the directory
(Oracle Call Interfaces)
PDFLibrary91* / PD- For correct functionality of PDF-related If used, needs to be
FLibrary91*_64 features present in the directory

2245
19 Appendices

File / Folder Usage In Directory with EXE

Files

TNODriver TNO Writer, a virtual printer If used, needs to be in-

stalled
WebKitBridge HTML native import If used, needs to be in-
stalled
XRiteEyeOne Color Scanning If used, needs to be
present in the directory
PNetT.chm Inspire Designer help file For information only
PNetTGS_*.chm Getting Started documents, in English or For information only
supported languages
icudt32l.dat Conversion tables, locales etc., neces- Required for all
sary for running Inspire Designer PNetT*.exe files
uhyph*.dat Hyphenation If used, needs to be
present in the directory
*.dic Spell check If used, needs to be
present in the directory
Client API 2.dll For MediaBin, digital asset management If used, needs to be
system connected to Inspire Content present in the directory
Manager (VCS)
jsTools4.dll For MediaBin, digital asset management If used, needs to be
system connected to Inspire Content present in the directory
Manager (VCS)
LayoutComC- Importing PrintNet 3 Jobs If used, needs to be
allerDll.dll present in the directory
MBModel4.dll For MediaBin, digital asset management If used, needs to be
system connected to Inspire Content present in the directory
Manager (VCS)
MediaBinWrapper.dll For MediaBin, digital asset management If used, needs to be
system connected to Inspire Content present in the directory
Manager (VCS)
msvcp71.dll, ms- For MediaBin, digital asset management If used, needs to be
vcr71.dll system connected to Inspire Content present in the directory
Manager (VCS)
TagGener.dll Used to convert Data Matrix input data If used, needs to be
into a Wiziway barcode present in the directory
DitheringPicker.exe Related application Dithering Picker EXE file
FlowTranslator.exe Related application Flow Translator EXE file
Player.exe Related application Player used for playing EXE file
a recording, Video Capture Feature
PNetT.exe Inspire Designer application EXE file
PNetTC.exe Related console application Inspire Produc- EXE file
tion Console (PNetTC)

2246
 19.1 Additional Information

File / Folder Usage In Directory with EXE

Files

PNetTCNetClient.exe Related console application Inspire Produc- EXE file

tion Server Console Client (PNetTCNetCli-
ent)
PNetTNetClient.exe Related application Inspire Production EXE file
Server Client (PNetTNetClient)
PNetTNetServer.exe Related application Inspire Production EXE file
Server (PNetTNetServer)
PNetTVCS.exe Related application Inspire Content Man- EXE file
ager (VCS)
PNetTVCSEx- Related application Inspire Content Man- EXE file
plorer.exe ager Explorer used for managing folders
and files in Inspire Content Manager (VCS)
PNetTView.exe Related application Inspire Native Viewer EXE file
uninstall.exe Used for uninstallation of Inspire Designer EXE file
CondProc.fcv Importing PrintNet 3 Jobs If used, needs to be
present in the directory
PNetT.hif Used for the correct functionality of con- For information only
text help
*.lic If a LIC is a necessary part of your li- Required for all
censing PNetT*.exe files and
DitheringPicker.exe
uninstall.log List of installed files For information only
InspireDesigner-Get- Getting Started document, in English or For information only
ting_Started_*.pdf supported languages
InspireDesigner-Re- Release Notes document, in English For information only
lease_Notes-*.pdf
InspireDesigner- Inspire Designer user manual, in English For information only
User_Manual-*.pdf
SAPregistration.wfd SAP Data Input module To be used once for re-
gistration, if SAP mod-
ule is used

19.1.5 Troubleshooting
19.1.5.1 Log.txt description
The log file provides information about the license type, demo file expiration date, reasons of
failure etc. depending on the version of Inspire Designer you have.

This file can be found in the same directory as the PnetT.exe file (resp. PNetTC.exe). The mes-
sages listed below are very important when reporting a problem with Inspire Designer.

2247
19 Appendices

PrintNet T 4.0

Message Description

20040127 173414 Exception Hardware fail- Informs that licensing failed when opening
ure details: from:C:\root\Src\TNGMain\Work- PrintNet T GUI (incl. date and time the first
SpaceGUIImpl.cpp 75 2 strings in a message).
20040203 123410 Exception General protec- Informs about a crash, with further informa-
tion fault details: SEH 0xc0000005 tion for debugging purposes.
from:C:\root\Include\Exe.cpp 61

Messages in PrintNet T 4.1 and higher

Message Description

20040527 131209 Dongle ID: 66F23A85 Hardware license mode Shows dongle ID.
20040605 134800 License file, Id =BB34C- Software license mode Shows ID of the
BYSO5-AFBVI-L5A4F-RHXZM computer on which software licensing is
running.
20040625 073042 Demo till 30.09.2004 Software demo license mode Shows until
the demo file is valid, both for CXM license
and PNetT.lic.

2248
 19.1 Additional Information

19.1.6 Tips and Tricks

In this section:
Filtering Items
Renaming Items
Creating Non-breaking Space
Creating Soft Enter
Drag and Drop Support
Closing any of the Opened Windows
Using Non-alphanumerical Characters in
Variable Name
Quick Flip
Copy, Paste and Delete Options in Edit
Boxes
Finding Errors Listed in Proof Log
Expanding/Collapsing the Layout Tree
Selecting Objects in Flow Areas with
Overflow

19.1.6.1 Filtering Items

This feature can be very useful in case the Layout Tree contains huge number of nested objects.
It works on almost all tree controls and dialogs (such as Open File dialog) in GUI.

Just press <F3> and on the top of selected object (Layout Tree in our case) the special edit field
is displayed. Here you can type a substring of the node name that you want to localize.

In our example, we wanted to find the Black color, so we typed 'Bla' and the filtering limited
the Layout Tree only to items that contain the substring of 'Bla' in its name. If you press <Enter>
now, the Layout Tree will stay like this listing only the filtered items.

When you want to display all the items in the tree again, press <F3> and <Esc>. To expand
the whole tree or its parts (and thus have it available for filtering), use the options described
in Expanding/Collapsing the Layout Tree.

19.1.6.2 Renaming Items

You can rename almost all the tree and dialog objects. Simply select the appropriate name
(using mouse) and press <F2>. Then you can type a new name, confirm that by clicking else-
where or by pressing <Enter>.

2249
19 Appendices

19.1.6.3 Creating Non-breaking Space

By pressing <Ctrl> <Shift> <Space>, you can create a non-breaking space. If you need this
character in Script Editor, use the 0xA0 character, then convert it into String and concatenate
the strings.

19.1.6.4 Creating Soft Enter

If you need to insert a line break but the text still needs to be regarded as a single paragraph,
use <Shift> and <Enter>. In scripting the equivalent of the soft enter is the \x0D character.

19.1.6.5 Drag and Drop Support

Opening files: You can drag and drop files to the File name edit field of any Open
dialog throughout the application.

Opening WFDs: Once the program is running, you can open WFD workflow(s) (and
other files) simply by dragging and dropping them from a file manager into the Workflow
or Layout. When you drag and drop a file into the Proof or Production window, the file
is loaded for proofing or production, respectively. See the Production Window Menu
section for the list of the supported file types.

Inserting images: Instead of inserting images using menu, you can insert one or more
pictures of the supported formats into the Layout by dragging and dropping them from
a file manager into the Layout window.

19.1.6.6 Closing any of the Opened Windows

To close any opened window (Layout, Proof, etc.), you can use the middle mouse button. Just
click on the appropriate tab of the window.

2250
 19.1 Additional Information

Example Clicking here with the middle mouse button will close the Layout window.

19.1.6.7 Using Non-Alphanumerical Characters in Variable

Names
You can use the non-alphanumerical characters (e.g., +, -, #) in a variable name. However, the
variable must be referenced in the scripts in a special way: see Scripting Notes.

19.1.6.8 Quick Flip

You can flip flow area very quickly by dragging its boundary to the opposite direction (for ex-
ample, its left border to the right, so it becomes the right border then).

2251
19 Appendices

19.1.6.9 Copy, Paste and Delete Options in Edit-Boxes

For a more convenient way to work with any item in edit boxes you can right-click on the area
of an edit-box and select from these options:

Cut

Copy

Paste

Delete

19.1.6.10 Finding Errors Listed in Log

If there is an error found during proofing or production, you can go directly to the workflow
section where this error was detected by:

Double-clicking on the error line in the field Event Description in the Log window-pane.

Selecting Go to Error option from the context menu for the error line.

In the example above both error lines refer to the same error the first line refers to the wrong
script for Variable1, the second one to the flow area where this variable was used.

19.1.6.11 Expanding/Collapsing the Layout Tree

To expand or collapse the whole Layout Tree or individual nodes, you have the following options:

<Plus> Expands the selected node.

<NumPadMultiply> Expands the selected node and all its sub-nodes.
<Ctrl>+<NumPadMultiply> Expands the whole tree.

<Minus> Collapses the selected node.

<NumPadDivide> Collapses the selected node and all its sub-nodes.
<Ctrl>+<NumPadDivide> Collapses the whole tree.

To search in an expanded tree, use the key <F3> as described in Filtering items.

2252
 19.2 Barcodes

19.1.6.12 Select Objects in Flow Areas with Overflow

You can select the content of a flow area using the common shortcut <Ctrl>+<A>, but this
action selects only the content displayed within the current flow area borders. To select (and
then perhaps delete or copy) all objects, including those not displayed due to an overflow, use
the <Ctrl>+<Shift>+<A> keys combination.

19.2 Barcodes
19.2.1 2/5 Datalogic Barcode
In this section: See also:
2/5 Datalogic Layout Properties Barcodes

A numeric code with variable length. It is a numeric code in which every decimal digit is repres-
ented by 5 bars, of which 2 are large and 3 are narrow.

Character Set

10 digits

1 Start Character

1 Stop Character

Advantages

High information density

Disadvantages

Low tolerance (10 %)

19.2.1.1 2/5 Datalogic Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2253
19 Appendices

2/5 Datalogic Tab

When 2/5 Datalogic is selected in the Barcode type combo-box of the Content tab of the
barcode's properties panel, the 2/5 Datalogic tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

There are 2 bar types: narrow and large. The width of the large bar compared to the narrow
bar is controled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab.

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Use control check digit When checked, the check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

2254
 19.2 Barcodes

Advanced Tab

Options Description

White space The size for the quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are mulitples of the Module width, e.g. 10 = 10 x module width. 10 is the minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow bar and Large bar edit-boxes.

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5 mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

19.2.2 2/5 IATA Barcode

In this section: See also:
2/5 IATA Layout Properties Barcodes

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.

2255
19 Appendices

Characters Set

10 digits

1 Start Character

1 Stop Character

Advantages

The spaces are not significant

High tolerance (15%)

Disadvantages

Low information density

19.2.2.1 2/5 IATA Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2/5 IATA Tab

When 2/5 IATA is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the 2/5 IATA tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

2256
 19.2 Barcodes

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

There are 2 bar types: narrow and large. The width of the large bar compared to the narrow
bar is controled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab.

Calculated in meters using the formula: im/ ((8+2*R)*CPI) where im = inch size in meters
[0.0254] and R = barcode ratio.

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Use control check digit When checked, the check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

White space The size for the quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width, e.g. 10 = 10 x module width. 10 is the minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow bar and Large bar edit-boxes.

2257
19 Appendices

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5 mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

19.2.3 2/5 Industrial Barcode

In this section: See also:
2/5 Industrial Layout Properties Barcodes

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 than 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.

Characters Set

10 digits

1 Start Character

1 Stop Character

Advantages

The spaces are not significant

High tolerance (15%)

Disadvantages

Low information density

19.2.3.1 2/5 Industrial Layout Properties

Position Tab
See the separate section Position Tab for details.

2258
 19.2 Barcodes

Content Tab
The options on this tab can be found in the separate section Barcodes.

2/5 Industrial Tab

When 2/5 Industrial is selected in the Barcode type combo-box of the Content tab of the
barcode's properties panel, the 2/5 Industrial tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

There are 2 bar types: narrow and large. The width of the large bar compared to the narrow
bar is controled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab.

Calculated in meters using the formula: im/ ((8+2*R)*CPI) where im = inch size in meters
[0.0254] and R = barcode ratio.

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Inverted If checked, the barcode fill style is used for spaces instead of bars while bars are
left unfilled.

Use control check digit When checked, the check sum will be added to the code.

2259
19 Appendices

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

White space The size for the quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width, e.g. 10 = 10 x module width. 10 is the minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow bar and Large bar edit-boxes.

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5 mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

19.2.4 2/5 Interleaved Barcode

In this section: See also:
2/5 Interleaved Layout Properties Barcodes

2260
 19.2 Barcodes

The 2/5 Interleaved or ITF (Interleaved Two of Five) is a continuous numeric code. It has the
same coding as the '2/5 5 Bars' code, but bars and spaces represent the digits alternately. It:

Phase 1: Numbers (from the right to left) the characters to be coded (this must be an even
number)

Phase 2: Groups 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:

considers that the left character is represented by 5 dark bars

considers that the right character is represented by 5 light spaces

puts the 5 bars and 5 spaces of the two characters alternatively, starting 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.

Set of Characters

10 digits

1 Start Character

1 Check digit - computed before creating of the barcode.

The Check digit is calculated in accordance to DIN EN801.

1 Stop Character

Features

Numeric code

Continuous code

Self-checking code

Advantages

High information density

Disadvantages

Even spaces are significant

Low tolerance (10 %)

Digits can be represented only in an even number of digits

2261
19 Appendices

19.2.4.1 2/5 Interleaved Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2/5 Interleaved Tab

When 2/5 Interleaved is selected in the Barcode type combo-box of the Content tab of the
barcode's properties panel, the 2/5 Interleaved tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space) in selected units.

There are two bar types: narrow and wide. The width of the wide bar compared to the
narrow bar is controled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab or adjusted via the Direct Metric tab which is described in the separate
Barcodes section.

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0,0254].

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

2262
 19.2 Barcodes

Measurement units can be changed by clicking on the unit symbol.

Type You can choose among three types:

Free format - the standard 2/5 Interleaved format

Deutsche Post - Leitcode

Deutsche Post - Identcode

Use control check digit When checked, the check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

White space Enter here a size for quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width, e.g. 10 = 10 x module width. 10 is the minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow bar and Large bar edit-boxes.

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

Direct Metric Tab

See the Direct Metric Tab description in the separate Barcodes section.

2263
19 Appendices

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 Description

1-5 Post number

6-8 Street number
9 - 11 House number
12 - 13 Product code
14 - 14 Check digit

The Identcode consists of 12 digits.

Position Description

1-2 Transport Post Centre

3 - 5/6/7 Sender number 3, 4, or 5 characters
6/7/8 - 11 Admissions number 6,5 or 4 characters
12 - 12 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

19.2.5 2/5 Matrix Barcode

In this section: See also:
2/5 Matrix Layout Properties Barcodes

This discrete code is numeric 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.

2264
 19.2 Barcodes

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 and one Stop character only. The widest element of the
Start/Stop character is from 1.5 up to 4 times wider than the widest element of other characters.

Character Set

10 digits

1 Start Character

1 Stop Character

Advantages

High information density

Disadvantages

Low tolerance (10%)

19.2.5.1 2/5 Matrix Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2/5 Matrix Tab

When 2/5 Matrix is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the 2/5 Matrix tab appears.

2265
19 Appendices

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

There are 2 bar types: narrow and large. The width of the large bar compared to the narrow
bar is controled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab.

Calculated in meters using this formula: im/ ((4+2*R)*CPI) where im = inch size in meters
[0,0254] and R is the barcode ratio.

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Use control check digit When checked, the check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

2266
 19.2 Barcodes

Options Description

White space The size for the quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width, e.g. 10 = 10 x module width. 10 is the minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Start/stop ratio The width of the start and stop characters in ratio to the wide bars.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow bar and Large bar edit-boxes.

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

19.2.6 Australia Post Barcode

In this section: See also:
Australia Post Layout Properties Barcodes

Australia's Postal barcode is a Reed-Solomon version of the 4-State barcode (also known as
the Intelligent Mail barcode). Reed-Solomon Error Correction Bars perform a quality control
check on the barcode.

Set of Characters

Start Bars

Format Control Code Field

Sorting Code Field (DPID)

Customer Information Field (some formats only)

Filler Bar

Reed-Solomon Error Correction Parity values

Stop Bars

2267
19 Appendices

19.2.6.1 Australia Post Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Australia Post Tab

When Australia Post is selected for Barcode type on the Content tab of the barcode's properties
panel, the Australia Post tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space).

Calculated in meters using the formula: im/ (2*CPI) where im = inch size in millimeters
[0,0254] and R = barcode ratio.

Measurement units can be changed by clicking on the unit symbol.

Height Height of the tallest bars.

Measurement units can be changed by clicking on the unit symbol.

For customer information use Selects the encoding method for the customer information
field:

C encoding table Creates three-bar symbols from upper and lowercase alphanu-
merical characters, space and #.

N encoding table Creates two-bar symbols from numerical characters 0-9 only.

Use FCC 00 for zero valued barcode If checked, the format control code (FCC) will be 00
if the 8-number delivery point identifier (DPID) is 00000000.

2268
 19.2 Barcodes

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.7 Aztec Barcode

In this section: See also:
Aztec Layout Properties Barcodes

Aztec Code is a 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.
It is designed with user-selectable percentages of error correction. It supports industry standard
escape sequences to define international code pages and special encoding schemes.

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 encodes 13 numeric or 12 alphabetic
characters. The largest Aztec Code symbol is 151x151 and encodes 3832 numeric or 3067 al-
phabetic 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. Recom-
mended level is 23% of symbol capacity plus 3 codewords

Features

All 8-bit values can be encoded.

Values 0 - 127 are interpreted as the ASCII character set

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

ECI escape sequences for the standardized encoding of message interpretation in-
formation.

2269
19 Appendices

19.2.7.1 Aztec Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Aztec Tab

When Aztec is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Aztec tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (dot) in selected units.

Calculated in meters using the formula: im/ CPI where im = inch size in meters [0,0254].

Quiet zone Empty area on each side of the barcode for optimum readability in multiples of
the module width.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

2270
 19.2 Barcodes

19.2.8 Codabar Barcode

In this section: See also:
Codabar Layout Properties Barcodes

This Codabar (or NW7 Code) is a discrete, self-checking symbology that may encode 16 different
characters, plus the additional start/stop characters.

It has the following structure:

One of four possible start characters (A, B, C or D).

A narrow, inter-character space.

The data of the message, each character is coded with seven elements, four bars and
three spaces with a narrow inter-character space between each character.

One of four possible stop characters (A, B, C or D).

The symbol dimension depends upon the module width and on the printing ratio.

Set of Characters

10 digits

6 special characters

1 check sum

Placed immediately after the last data character and before the stop character. Calculated
by a numeric value assigned to each character and the values of the characters in the
bar are added, including the start/stop characters. Divide the result by 16, then subtract
the remainder from 16 to get the check sum.

4 start/stop characters

Size

Height - depends upon the application field. The minimum height for using optics wands
or contact readers 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 - 2:1 to 3:1, restricted from 2.25:1 to 3:1 if the module width is less than 0.5mm.

Advantages

High information density

High tolerance (25%)

2271
19 Appendices

Disadvantages

Spaces inside a single character are significant

19.2.8.1 Codabar Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Codabar Tab

When Codabar is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Codabar tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

Calculated in meters using these formulas:

2272
 19.2 Barcodes

if R == 1 im/ elements per char where elements per char = 15.193939

if R != 1 im/ ((2.5*R + 4.5)*CPI) and if module width < 0.5 mm R = 2.25

(im = inch size in meters [0.0254] and R is the barcode ratio).

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

White space Enter here a size for quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width entered, e.g. 10 = 10 x module width. 10 is the
minimum.

Ratio Ratio of the width of the wide bars to width of the narrow bars.

Units are multiples of the Module width.

Use check sum When checked, then the control check digit will be used.

It is placed immediately after the last data character and before the stop character.

Codabar Monarch When checked, the Monarch variation of Codabar will be used.

This version has fixed start and stop characters and a wider bar structure E.g.:

Start Character Select here either A, B, C or D as a start character for the code.

Not available if Codabar Monarch is checked.

Stop Character Select here either A, B, C or D as a stop character for the code.

Not available if Codabar Monarch is checked.

Show start and stop character When checked, the start and stop characters are displayed.
Those can be A, B, C, or D and they are shown in the lower case.

Note To display the data characters, it is necessary to choose their position on the Text
and Align tab of the Barcode Layout Properties.

The default position is None which means that no data characters are shown.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Direct Metric Tab

See the Direct Metric Tab description in the separate Barcodes section.

2273
19 Appendices

19.2.9 Code 128 Barcode

In this section: See also:
Code 128 Layout Properties Barcodes

Code 128 is a linear and bi-directional barcode that is able to code the complete set of 128
ASCII characters, plus four functional characters with numeric data encoded in a double-
density compact form, i.e. two digits for each character.

Each character consists of 11 modules which are divided into three bars and three spaces (except
for the stop character). Bars inside a single character are formed by an even number of modules
(even parity) and, as a consequence, the spaces occupy an odd number of modules.

Code 128 has three character subsets, called Code A, B and C:

A emphasizes the full set of special characters but excludes the lower case letters

B includes both upper and lower case letters as well as numbers and some special
characters

C consists of the 100 two-digit pairs 00 through 99 (the effective density of 128 to
be doubled when printing all numeric data). The total of the two digits, when added,
must be an even number.

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 cor-
respondent 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.

The whole code consists of a sequence of characters enclosed by two white spaces or "quiet
zones". The sequence begins with a start character followed by data and any special characters
(with the most significant character adjacent to the start character) then a check digit, and finally
a stop character. A decoder does not transmit the control characters, the start/stop function
or the subset selection characters.

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)

A check digit.

2274
 19.2 Barcodes

The check digit is calculated by:

1. Reading the code from the left to the right, starting with the start character. All
the characters are written as their associated value number.

2. Multiplying all numbers, except start character, by their relative positions in the
code (taking the start digit position as zero i.e. 0,1,2,3...)

3. Adding all of the values (resulting from the previous step) and then dividing 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.

Code 128 can be printed in several densities, depending upon the printing process and the
reading systems.

The significant dimension is the module width, whose minimum value is 0.19 mm.

The width of 4 different sized bars and spaces is derived from the multiplying the width
of the module by 1,2,3 or 4 respectively.

The minimum width of the quiet zone is 2.54 mm, or ten times the module width,
whichever is greater.

The minimum height of the bars is 6.35 mm, or 15% of the symbol length, again,
whichever is the greater.

Character Set

128 alphanumeric and special characters (set ASCII)

3 start characters

4 functional characters

Function character FNC1

This character is only coded in the barcode when the hexadecimal value 0xF1 (decimal
241) appears in the input data.

4 sub-set selection characters

1 stop character

1 check digit

Advantages

Representation of the complete set of ASCII characters

Coding system provides 106 different print characters (106 values)

High tolerance

2275
19 Appendices

Disadvantages

Low information density

Spaces are significant

19.2.9.1 Code 128 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Code 128 Tab

When Code 128 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Code 128 tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space) in selected units.

Minimum width = 0.19 mm.

There are 4 bar types in a Code 128 barcode. By default the width of each is a s follows:

Bar 1 = 1 module width

Bar 2 = 2 module widths

Bar 3 = 3 module widths

Bar 4 = 4 module widths

2276
 19.2 Barcodes

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab or adjusted via the Direct Metric tab which is described in the separate
Barcodes section.

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Using subsets Enables you to select the character subsets that will make up the barcode:
A, B or C or any combination of these. If your decoder supports all of the sub-sets, it is
recommended to use ABC.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

White space Enter here a size for quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are mulitples of the Module width entered on the Content tab, e.g. 10 = 10 x
module width. 10 is the minimum.

Correction of Bar Width The widths of each of the four bar types can be further adjusted
here by entering new values in the edit-boxes.

This is a correction of the default values given by the value entered in the Module width
option on the Content tab. E.g. entering 0.5 mm increases the default size of the bar by
0.5 mm or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

Don't add start, stop, checkdigit If checked, neither the start digit , the stop digit or the
check digit will be part of the barcode, making it shorter.

2277
19 Appendices

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.10 Code 128 UPS Barcode

In this section: See also:
Code 128 UPS Layout Properties Barcodes

This barcode is able to code the complete set of 128 ASCII characters, plus four functional
characters. Numeric data is encoded in a double density compact form: i.e. two digits for each
character.

Each character consists of 11 modules which are divided into three bars and three spaces (except
for the stop character). Bars inside a single character are formed by an even number of modules
(even parity) and, as a consequence, the spaces occupy an odd number of modules.

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)

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 char-
acter 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 correspondent 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.

2278
 19.2 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 nom-
inal 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.

For most common applications the minimum height of the bars is 6.35mm, or 15% of the
symbol length, again, whichever is the greater.

Set of Characters

128 alphanumeric and special characters (set ASCII)

4 functional characters

4 subset selection characters

3 start characters

1 check digit

The check character immediately precedes the stop character. The check character value
is the sum modulus 103 of the code as follows:

The check digits are added to the right of the data characters and are calculated using
modulus 103. I.e. each character is allocated an individual number, all of which (except
the sart character) are then multiplied by their relative positions in the code (taking the
start digit position as zero i.e. 0,1,2,3...). Then these totals are added together and the
result is then divided by 103.

1 stop character

Advantages

Representation of the complete set of ASCII characters

High tolerance

Disadvantages

Low information density

Spaces are significant

2279
19 Appendices

19.2.10.1 Code 128 UPS Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Code 128 UPS Tab

When Code 128 UPS is selected in the Barcode type combo-box of the Content tab of the
barcode's properties panel, the Code 128 UPS tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space) in selected units.

Minimum width = 0.19.

There are 4 bar types in a Code 128 UPS barcode. By default the width of each is a s fol-
lows:

Bar 1 = 1 module width

Bar 2 = 2 module widths

Bar 3 = 3 module widths

Bar 4 = 4 module widths

These widths can be further adjusted via the Direct Metric tab which is described in the
separate Barcodes section.

Calculated in meters using the formula: im/ (11*CPI) where im = inches in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

2280
 19.2 Barcodes

Measurement units can be changed by clicking on the unit symbol.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Direct Metric Tab

See the Direct Metric Tab description in the separate Barcodes section.

19.2.11 Code 39 Barcode

In this section: See also:
Code 39 Layout Properties Barcodes

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.

Character Set

10 digits

26 alphabetic characters always entered in upper case (CAPITALIZED).

7 special characters

1 check sum added to the right of the data characters.

The check sum is calculated using modulus 43. I.e. each character is allocated an indi-
vidual number, all of which are added together. The result is then divided by 43 and
the remainder is used to make the character.

1 start/stop character (special character "*").

The start/stop character is automatically added into the input string always occurring
as the first and last character. If a data input string contains the start/stop character, it
will be trimmed (PrintNet T version 5.1 and later).

2281
19 Appendices

Size

Height Depends upon the application field. The minimum height for using optics
wands or contact readers 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.

Width The minimum is 0.19mm for printing high density codes.

Ratio Can vary in the interval from 2:1 to 3:1, restricted from 2.25:1 to 3:1 if the
module width is smaller than 0.5mm.

Advantages

Representation of alphabetic, numeric and special characters

Disadvantages

Low information density

Spaces inside a character are significant

Low tolerance (10%)

19.2.11.1 Code 39 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Code 39 Tab

To display the Code 39 tab, go to the barcode's Layout Properties panel, click on the Content
tab and select Code 39 in the Barcode type combo-box.

2282
 19.2 Barcodes

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space) in selected units.

There are 2 bar types in a Code 39 barcode: narrow and wide. The width of the wide bar
compared to the narrow bar is controlled by the Ratio option on the Advanced tab.

These widths can be further corrected using the Correction of Bar Width options on the
Advanced tab or adjusted via the Direct Metric tab, which is described in the separate
Barcodes section.

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Use control check digit When checked, then check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

2283
19 Appendices

Options Description

Quiet zone ratio The size of the quiet zone that should be used at both ends of the barcode.
Larger quite zone increases barcode readability.

Units are multiples of the Module width entered on the Code 39 tab, e.g. 10 = 10 x
module size. 10 is the minimum.

Ratio The width of the wide bars in comparison to the Module width entered on the Code
39 tab.

Intercharacter space ratio Ratio of the width of the spaces inbetween bars in comparison
to the Module width entered on the Code 39 tab.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Thin Bar and Thick Bar edit-boxes.

This is a correction of the default value entered in the Module width option on the Code
39 tab. E.g. entering 0.5 mm increases the default size of the bar by 0.5mm or entering
-0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.12 Code 39 (Full Ascii) Barcode

In this section: See also:
Code 39 (Full Ascii) Layout Properties Barcodes

This enhanced version of the Code 39 barcode allows the coding of full ASCII table.

By combining of special characters ($, /,%, +) with the alphanumeric ones it is possible to
cover complete ASCII table.

The check sum is calculated using modulus 43. I.e. each character is allocated an individual
number, all of which are added together. The result is then divided by 43 and the remainder
is used to make the character.

Size

Height - 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

2284
 19.2 Barcodes

length. When using laser guns or scanners the bar height must be at least 20mm or
20% of the code length.

Width - minimum = 0.19mm (for printing high density codes). You can create a smaller
font, but a warning appears before creating.

Ratio - 2:1 to 3:1, restricted from 2.25:1 to 3:1 if the module width is less than 0.5mm.

Advantages

Representation of full ASCII table

Disadvantages

Low information density

Space inside a character are significant

Low tolerance (10%)

19.2.12.1 Code 39 (Full Ascii) Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Code 39 (Full Ascii) Tab

When Code 39 (Full Ascii) is selected in the Barcode type combo-box of the Content tab of
the barcode's properties panel, the Code 39 (Full Ascii) tab appears.

2285
19 Appendices

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Use control check digit When checked, then check sum will be added to the code.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

White space The size of the quiet zone that should be used at both ends of the barcode.
Larger white space increases barcode readability.

Units are multiples of the Module width entered on the Code 39 (Full Ascii) tab, e.g. 10
= 10 x module size. 10 is the minimum.

Ratio The width of the wide bars in comparision to the width of the Module width entered
on the Code 39 (Full Ascii) tab.

2286
 19.2 Barcodes

Intercharacter space ratio Ratio of the width of the spaces inbetween bars in comparison
to the Module width entered on the Code 39 (Full Ascii) tab.

Correction of Bar Width The widths of each of the two bar types can be further adjusted
here by entering new values in the Narrow Bar and Large Bar edit-boxes.

This is a correction of the default value entered in the Module width option on the Code
39 (Full Ascii) tab. E.g. entering 0.5 mm increases the default size of the bar by 0.5 mm
or entering -0.25 mm decreases the size of the bar by 0.25 mm.

Measurement units can be changed by clicking on the unit symbol.

19.2.13 Code 93 Barcode

In this section: See also:
Code 93 Layout Properties Barcodes

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.

Set of Characters

10 digits

26 alphabetic characters

7 special characters: -, ., SPACE, $, /, +, %

2 check digits

The check digits are added to the right of the data characters and are calculated using
modulus 47. I.e. each character is allocated an individual number, all of which are added
together. The result is then divided by 47.

1 start/stop character: START=( STOP=)

Size

Height 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

2287
19 Appendices

code length. When using laser guns or scanners the bar height must be at least 20 mm
or 20% of the code length.

Width minimum 0.19 mm (for printing high density codes). You can create a smaller
font but a warning appears before creating.

Self-checking code

Advantages

Representation of alphabetic, numeric and special characters

High information density

Disadvantages

The space inside a character are significant

Low tolerance (10%)

19.2.13.1 Code 93 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Code 93 Tab

When Code 93 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Code 93 tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

2288
 19.2 Barcodes

Module width Width of the narrowest code element (either bar or space).

Calculated in meters using this formula: im/ (9*CPI) where im is inch size in meters (0.0254).

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Extended mode When checked then extended code is used that covers the complete ASCII
table.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.14 Data Matrix Barcode

In this section: See also:
Data Matrix Layout Properties Barcodes

Data Matrix 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 Data
Matrix symbols can also be printed to appear as light on dark. Data Matrix symbol is capable
of encoding up to 2334 ASCII characters.

The width, height and error correction level are automatically chosen during production, de-
pending on the size of the data after conversion to codewords (unit of information coded in
the barcode), according to the AIM USA norm. This version of Data Matrix also complies to
the ECC200 standard.

Data Matrix is also able to represent any 8-Bit binary data.

Note The following features of Data Matrix are not yet supported in Inspire Designer:

Structured appendix that allows the encoding of files and represents them as multiple
data matrix barcodes.

Extended channel interpretation Arabic, Cyrillic, Greek, Hebrew support.

19.2.14.1 Data Matrix Layout Properties

Position Tab
See the separate section Position Tab for details.

2289
19 Appendices

Content Tab
The options on this tab can be found in the separate section Barcodes.

Data Matrix Tab

When Data Matrix is selected in the Barcode type combo-box of the Content tab of the bar-
code's properties panel, the Data Matrix tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space) in selected units.

Calculated in meters using this formula:

0,0044437/ CPI

Quiet zone in modules Empty area on each side of the barcode for optimum readability in
multiples of Module width.

Wiziway barcode When checked, the Wiziway version of this barcode will be created.

This barcode is similar but has its own specifications. To be able to convert Data Matrix
input data into a Wiziway barcode, you need to have the TagGener.dll file in your Inspire De-
signer application directory (the same folder as the PNetT.exe file) and the syntax for the
Wiziway barcode data needs to be following:

1 text character and 8 digits

1 text character, 8 digits, 2 text characters and 3 digits

or

1 text character, 8 digits, 1 text character and 4 digits

Text characters must be upper-case letters from A to Z.

2290
 19.2 Barcodes

Note This barcode is only for use on Windows platform.

Use PNet3 encoding If checked, the input data for the barcode is interpreted as in PrintNet
3. It is possible then to represent any 8-bit binary data using the following syntax:

\t represents tabulation (0x09).

\r represents carriage-return (0x0D).

\n represents line-feed (0x0A).

\xXX where XX represents a hexadecimal value (even 0).

\oOOO where OOO represents an octal value (even 0).

Example Input data:

\x44\x45\x41\x02\x15\x01\x72\x15\x57\x52\x01\x01\x01\x20\x20\x20\
x20\x01\x01\x01\x01\xA5\x01\x19\x23\x91\x01\x01

When the option Use PNet3 encoding is not checked, it is interpreted like this:

\x44\x45\x41\x02\x15\x01\x72\x15\x57\x52\x01\x01\x01\x20\x20\x20\
x20\x0\x01\x01\x01\xA5\x01\x19\x23\x91\x01\x01

When the option Use PNet3 encoding is checked, it is interpreted like this:

DEA[STX][NAK][SOH]r[NAK]WR[SOH][SOH][SOH][SOH][SOH][SOH][SOH]
[0xa5][SOH][ EM]#[0x91][SOH][SOH]

Barcode size Offers a selection of standard dimensions for a strict determination of the size
of the barcode.

Auto means that the size will be determined by the Module width entered. The non-
square dimensions (e.g. 12x36) can only be used for the Wiziway version of this barcode,
i.e. if Wiziway barcode has been checked.

Encoding Determines the encoding to be used for the data of the code. Select from:

Autodetect - will read the data for the barcode and chose the correct encoding
from the other available types.

Ascii - should be used for numbers and mixed case data, e.g. abcABC123.

Base11 - should be used for numbers only, e.g. 123456789.

Base41 - should be used for numbers and uppercase letters, e.g. ABC123456.

Base256 - can be used for all characters including punctuation, e.g. abc,ABC-123?.

Use tilda character If checked, the 'tilda' text character (i.e. ~) will be used to determine
the identities of special characters.

To use it in the data, the ~ character should be followed by the ID of the special character
that should appear, e.g. ~d002.

2291
19 Appendices

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.15 Dutch Post Barcode

In this section: See also:
Dutch Post Layout Properties Barcodes

The Dutch Post barcode (or KIX 4-State barcode) symbology based on the 4-State barcode (also
known as the Intelligent Mail barcode) for use in automated mail sorting processes. It has a
high data encoding density and processing speed with all types of printing systems.

Set of Characters

36 valid characters, numeric 0-9 and alpha A-Z.

Each character consisting of 4 bars (all with a track element, 2 with ascenders and 2
with descenders)

Maximum length = 18 characters.

Format Control Code Field

Sorting Code Field (DPID)

Filler Bar

19.2.15.1 Dutch Post Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2292
 19.2 Barcodes

Dutch Post Tab

When Dutch Post is selected in the Barcode type combo-box of the Content tab of the bar-
code's properties panel, the Dutch Post tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space) in selected units.

Calculated in meters using the formula: im/ 8*CPI (im = inch size in meters [0.0254])

Height Height of the tallest bars.

Measurement units can be changed by clicking on the unit symbol.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.16 EAN 128 Barcode

In this section: See also:
EAN 128 Layout Properties Barcodes
Code 128 Barcode
EAN / UCC Application Identifiers

EAN-128 uses the same barcode symbology as Code 128 with Application Identifier data en-
coded into it.

2293
19 Appendices

Character Set

128 alphanumeric and special characters (set ASCII)

3 possible start characters A, B, or C

non-data Function character FNC1

This character is only coded in the barcode when the hexadecimal value 0xF1 (decimal
241) appears in the input data.

1 stop character

1 check digit

The Check Digit for either Code 128 symbologies (Modulo 10 and Modulo 103) can
be checksums:

The modulo 10 checksum is positioned as the last digit of the data and is part of
the humanly visable presentation of data.

The modulo 103 checksum is positioned as the last digit but is not part of the hu-
manly visable presentation of data.

Advantages

One of the most complete, alphanumeric, one-dimensional symbologies.

One of the most compact linear bar code symbologies.

Can be concatenated, combining multiple Application Identifiers into a single bar code.

Enables processing software to discriminate between UCC/EAN-128 and other barcodes

to only process relevant data.

19.2.16.1 EAN 128 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2294
 19.2 Barcodes

EAN 128 Tab

When EAN 128 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the EAN 128 tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the narrowest code element (either bar or space) in selected units.

Minimum width = 0.19 mm.

There are 4 bar types. By default the width of each is as follows:

Bar 1 = 1 module width

Bar 2 = 2 module widths

Bar 3 = 3 module widths

Bar 4 = 4 module widths

These widths can be further corrected via Direct Metric tab which is described in the sep-
arate Barcodes section.

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Check digit type You can select from these options:

Don't use check digit No self-checking will be used.

Modulo 103 The modulo 103 will be used as checksum.

Modulo 10 The modulo 10 will be used as checksum.

2295
19 Appendices

Using subsets Enables you to select the character subsets that will make up the barcode:
A, B or C or any combination of these. For detailed description of the subsets see the
Code128 Barcode section.

Validate string When checked, the typed string value is validated before actual drawing of
the barcode.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.17 EAN 13 Barcode

In this section: See also:
EAN 13 Layout Properties Barcodes
EAN / UCC Application Identifiers

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).

Features

Numeric

Continuous

Self-checking

Calculated with modulus 10 weight 3. (Resp. 10 minus modulus 10, weight 3 )

The symbols are placed symmetrically around a central check character.

The bars of the central and lateral check characters are extended for 5 modules below
the bars representing the useful characters.

2296
 19.2 Barcodes

The length of the symbol is 95 modules plus 18 modules for the overflow areas.

A quiet zone around the printed area corresponds 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

Characters Set

10 digits

6 characters representing according to the coding C forming the right half

6 characters with coding A or B forming the left half of the symbol

1 start/stop character

1 central check character

A 13th character is determined by which columns the 7th to 12th (left half) characters
were selected from.

Advantages

High information density

Disadvantages

Fixed number of digits

Spaces are significant

19.2.17.1 EAN 13 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2297
19 Appendices

EAN 13 Tab

When EAN 13 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the EAN 13 tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Override defaults If checked, enables you to change the values in the Height and the Digit
offset edit-boxes.

The barcode is not in compliance with the barcodes standards if it is modified in this way.

Module width Width of the narrowest code element (either bar or space).

There are 4 bar types. By default the width of each is a s follows:

Bar 1 = 1 module width

Bar 2 = 2 module widths

Bar 3 = 3 module widths

Bar 4 = 4 module widths

These widths can be further corrected via the Advanced Tab or the Direct Metric tab which
is described in the separate Barcodes section.

Calculated in meters using this formula: 0.03597/ CPI

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Digit offset Defines the value of the digits offset from the barcode.

2298
 19.2 Barcodes

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

Write digits If checked, shows the digits of the code below the barcode.

Each digit has 2 corresponding bars. The Start, Central and Stop characters/bars have no
corresponding digits.

Left Part of EAN 13 Corrects the width of the bars relating to the digits of the left-hand
barcode, i.e. the digits before the Central bar.

Each digit has 2 bars, the 1st bar and the 2nd bar. Entering a value in one of these edit-
boxes alters the module width of all corresponding bars, in the left part of the code, by
that amount. I.e. the value entered in each of these edit-boxes here relates to 6 bars.

Right Part of EAN 13 Corrects the width of the bars relating to the digits of the right-hand
barcode, i.e. the digits after the Central bar.

Each digit has 2 bars, the 1st bar and the 2nd bar. Entering a value in one of these edit-
boxes alters the module width of all corresponding bars, in the right part of the code, by
that amount. I.e. the value entered in each of these edit-boxes here relates to 6 bars.

Start Central Stop Corrects the width of the bars relating to the Start, Central and Stop
characters.

Each of these characters has 2 bars, the 1st bar and the 2nd bar. Entering a value one of
these edit-boxes alters the module width, of those corresponding bars, by that amount.

Delta Correction of Bars Width Corrects the width of bars with respect to their original
width.

2299
19 Appendices

EAN barcodes have 4 different bar sizes: DeltaBar 1 (thinnest), DeltaBar 2, DeltaBar 3, and
DeltaBar 4 (thickest). Entering a value in the edit-boxes here alters the Module size of
those corresponding bars, throughout the whole barcode, by that amount.

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.18 EAN 8 Barcode

In this section: See also:
EAN 8 Layout Properties Barcodes
EAN / UCC Application Identifiers

EAN Coding is designed to represent the numeric code of each article submitted to the EAN
(European Article Number) specifications in a format that is automatically readable in both
directions.

The EAN Code is completely compatible with the UPC code (Universal Product Code).

Features

Numeric code

Continuous code

Self-checking code

Check calculation modulo 10 weight 3. (Resp. 10 minus modulo 10, weight 3 )

Symbols are placed symmetrically around a central check character and terminated by
lateral check character (start/stop).

The decimal digits are represented through two different codings, 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.

The bars of the central and lateral check characters are extended for 5 modules below
the bars representing the useful characters.

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.

2300
 19.2 Barcodes

The length of the symbol is 67 modules plus 14 modules for the overflow areas.

The quiet zone 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

Set of Characters

10 digits

4 characters with coding A forming the left half of the symbol

4 characters with coding C forming the right half of the symbol

1 start/stop character

1 central check character

Advantages

High information density

Disadvantages

Fixed number of digits

Spaces are significant

19.2.18.1 EAN 8 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2301
19 Appendices

EAN 8 Tab

When EAN 8 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the EAN 8 tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Override defaults If checked, enables you to change the values in the Height and the Digit
offset edit-boxes.

The barcode is not in compliance with the barcodes standards if it is modified in this way.

Module width Width of the narrowest code element (either bar or space).

There are 4 bar types. By default the width of each is a s follows:

Bar 1 = 1 module width

Bar 2 = 2 module widths

Bar 3 = 3 module widths

Bar 4 = 4 module widths

These widths can be further corrected via the Advanced Tab or the Direct Metric tab which
is described in the separate Barcodes section.

Calculated in meters using this formula: 0.03597/ CPI

Measurement units can be changed by clicking on the unit symbol.

Height Height of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Digit offset Defines the value of the digits' offset from the barcode.

2302
 19.2 Barcodes

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

Write digits If checked, shows the digits of the code below the barcode.

Each digit has 2 corresponding bars. The Start, Central and Stop characters/bars have no
corresponding digits.

Left Part of EAN 8 Corrects the width of the bars relating to the digits of the left-hand
barcode, i.e. the digits before the Central bar.

Each digit has 2 bars, the 1st bar and the 2nd bar. Entering a value in one of these edit-
boxes alters the module width of all corresponding bars, in the left part of the code, by
that amount. I.e. the value entered in each of these edit-boxes here relates to 4 bars.

Right Part of EAN 8 Corrects the width of the bars relating to the digits of the right-hand
barcode, i.e. the digits after the Central bar.

Each digit has 2 bars, the 1st bar and the 2nd bar. Entering a value in one of these edit-
boxes alters the module width of all corresponding bars, in the right part of the code, by
that amount. I.e. the value entered in each of these edit-boxes here relates to 4 bars.

Start Central Stop Corrects the width of the bars relating to the Start Central and Stop
characters.

Each of these characters has 2 bars, the 1st bar and the 2nd bar. Entering a value one of
these edit-boxes alters the module width, of those corresponding bars, by that amount.

Delta Correction of Bars Width Corrects the width of bars with respect to their original
width.

2303
19 Appendices

EAN barcodes have 4 different bar sizes: DeltaBar 1 (thinnest), DeltaBar 2, DeltaBar 3, and
DeltaBar 4 (thickest). Entering a value in the edit-boxes here alters the Module size of
those corresponding bars, throughout the whole barcode, by that amount.

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.19 EAN / UCC Application Identifiers

An application identifier is a prefix code used to identify the meaning and the format of the
data that follows it (data field).

There are application identifiers for identification, traceability, dates, quantity, measurements,
locations, and many other types of information.

For example, the application identifier for batch number is 10 and is followed by an alphanu-
meric batch code that is less tnhen 20-characters.

The EAN / UCC application identifiers provide an open standard that can be used and understood
by all companies in the trading chain, regardless of the company that originally issued the
codes.

These identifiers contain data to identify:

An article, the data field includes the EAN-8, EAN-13 or EAN-14 item identification
number. The application identifier for an article is 01 plus up to a 14-digit number.

A logistic unit, which must be given a unique serial number called the Serial Shipping
Container Code (SSCC). It provides companies with a facility to identify logistic units
(pallets, drums, rolls) for tracking and tracing purposes. The SSCC application identifier
is 00 followed by an 18-digit number identifying the individual transport packages. This
code can be used for tracking the packages and used for receipt operations.

A returnable asset, the data field includes the EAN-13 number of the asset plus an op-
tional serial number.

AI Content AI Data
Format Format

00 Serial Shipping Container Code n2 n18

01 Shipping Container Code n2 n14
02 UCC/EAN Item Number of Goods Contained in Another n2 n14
Unit
10 Batch Numbers n2 an..20
11 Production Date (YYMMDD) n2 n6
12 Due Date (YYMMDD) n2 n6
13 Packaging Date (YYMMDD) n2 n6
15 Sell By Date (YYMMDD) n2 n6

2304
 19.2 Barcodes

AI Content AI Data
Format Format

17 Expiration Date (YYMMDD) n2 n6

20 Product Variant n1 n2
21 Serial Number n2 an..20
22 HIBCC Quantity, Date, Batch and Link n2 an..29
23* Lot Number n3 n..19
240 Additional Product Identification Assigned by the Manu- n3 an..30
facturer
241 Customer Part Number n3 an..30
250 Secondary Serial Number n3 an..30
251 Reference to Source Entity n3 an..30
30 Quantity Each n2 n..8
310** Net Weight (Kilograms) n4 n6
311** Length, Meters n4 n6
312** Width or Diameter (Meters) n4 n6
313** Depths ( Meters) n4 n6
314** Area (Sq. Meters) n4 n6
315** Volume (Liters) n4 n6
316** Volume (Cubic Meters) n4 n6
320** Net Weight (Pounds) n4 n6
321(x) Product Length/1st Dimension, in inches n4 n6
322(x) Product Length/1st Dimension, in feet n4 n6
323(x) Product Length/1st Dimension, in yards n4 n6
324(x) Product Width/Diameter/2nd Dimension, in inches n4 n6
325(x) Product Width/Diameter/2nd Dimension, in feet n4 n6
326(x) Product Width/Diameter/2nd Dimension, in yards n4 n6
327(x) Product Depth/Thickness/3rd Dimension, in inches n4 n6
328(x) Product Depth/Thickness/3rd Dimension, in feet n4 n6
329(x) Product Depth/Thickness/3rd Dimension, in yards n4 n6
330(x) Container Gross Weight (Kg) n4 n6
331(x) Container Length/1st Dimension (Meters) n4 n6
332(x) Container Width/Diameter/2nd Dimension (Meters) n4 n6
333(x) Container Depth/Thickness/3rd Dimension (Meters) n4 n6
334(x) Container Area (Square Meters) n4 n6
335(x) Container Gross Volume (Liters) n4 n6
336(x) Container Gross Volume (Cubic Meters) n4 n6

2305
19 Appendices

AI Content AI Data
Format Format

337 Kilograms Per Square Meter n4 n6

340(x) Container Gross Weight (Pounds) n4 n6
341(x) Container Length/1st Dimension, in inches n4 n6
342(x) Container Length/1st Dimension, in feet n4 n6
343(x) Container Length/1st Dimension in, in yards n4 n6
344(x) Container Width/Diamater/2nd Dimension, in inches n4 n6
345(x) Container Width/Diameter/2nd Dimension, in feet n4 n6
346(x) Container Width/Diameter/2nd Dimension, in yards n4 n6
347(x) Container Depth/Thickness/Height/3rd Dimension, in n4 n6
inches
348(x) Container Depth/Thickness/Height/3rd Dimension, in feet n4 n6
349(x) Container Depth/Thickness/Height/3rd Dimension, in n4 n6
yards
350(x) Product Area (Square Inches) n4 n6
351(x) Product Area (Square Feet) n4 n6
352(x) Product Area (Square Yards) n4 n6
353(x) Container Area (Square Inches) n4 n6
354(x) Container Area (Square Feet) n4 n6
355(x) Container Area (Square Yards) n4 n6
356(x) Net Weight (Troy Ounces) n4 n6
357 Net Volume (Ounce) n4 n6
360(x) Product Volume (Quarts) n4 n6
361(x) Product Volume (Gallons) n4 n6
362(x) Container Gross Volume (Quarts) n4 n6
363(x) Container Gross Volume (Gallons) n4 n6
364(x) Product Volume (Cubic Inches) n4 n6
365(x) Product Volume (Cubic Feet) n4 n6
366(x) Product Volume (Cubic Yards) n4 n6
367(x) Container Gross Volume (Cubic Inches) n4 n6
368(x) Container Gross Volume (Cubic Feet) n4 n6
369(x) Container Gross Volume (Cubic Yards) n4 n6
37(x) Number of Units Contained n2 n..8
390 Amount Payable - Single Monetary Area n4 n..15
391 Amount Payable and ISO Currency Code n4 n3+n..15

2306
 19.2 Barcodes

AI Content AI Data
Format Format

392 Amount Payable for a Variable Measure Trade Item n4 n..15

Single Monetary Area
393 Amount Payable for a Variable Measure Trade Item and n4 n3+n..15
ISO Currency Code
400 Customer PO Number n3 an..30
401 Consignment Number n3 an..30
402 Shipment Identification Number n3 n17
403 Routing Code n3 an..30
410 Ship To (Deliver To) Location Code Using EAN 13 or DUNS n3 n13
Number With Leading Zeros
411 Bill To (Invoice To) Location Code Using EAN 13 or DUNS n3 n13
Number With Leading Zeros
412 Purchase From n3 n13
413 Ship For (Deliver For-Forward To) EAN Location/Company n3 n13
Number
414 EAN Location/Company Number For Physical Identification n3 n13
415 EAN/UCC Global Location Number of the Invoicing Party n3 n13
420 Ship To (Deliver To) Postal Code Within Single Postal n3 an..20
Authority
421 Ship To (Deliver To) Postal Code With 3-digit ISO Country n3 n3+an..9
Code Prefix
422 Country Of Origin Of a Trade Item n3 n3
423 Country of Initial Processing n3 n3+n..9
424 Country of Processing n3 n3
425 Country of Disassembly n3 n3
426 Country Covering Full Process Chain n3 n3
7001 Nato Stock Number n4 n13
7002 UN/ECE Meat Carcasses and Cuts Classification n4 an..30
703 Approval Number of Processor With Three-Digit ISO n4 n3+an..27
Country Code
8001 Roll Products - Width, Length, Core Diameter, Direction n4 n14
and Splices
8002 Electronic Serial Number for Cellular Mobile Phone n4 an..20
8006 Component of an Item n4 n14+n2+n2
8007 International Bank Account Number n4 an..30
8008 Date and Location of Processing n4 n8+n..4
8018 Service Relation Number (SRN) n4 n18

2307
19 Appendices

AI Content AI Data
Format Format

8020 Payment Slip Reference Number n4 an..25

8100 Coupon Extended Code-NSC+Offer Code n4 n1+n5
8101 Coupon Extended Code-NSC+Offer Code+End of Offer n4 n1+n5+
Code n4
8102 Coupon Extended Code-NSC n4 n1+n1
90 Mutually Agreed Between Trading Partners n2 an..30
91-99 Internal Company Codes n2 an..30

For date fields that only need to indicate a year and month, the day field is set to "00".

* Plus one digit for length indication.

** Plus one digit for decimal point indication.

Conventions for application identifier data fFormats:

a alphabetic characters

n numeric characters

an alpha-numeric characters

a3 three alphabetic characters, fixed length

n3 three numeric characters, fixed length

an3 three alpha-numeric characters, fixed length

a..3 up to alphabetic characters

n..3 up to numeric characters

an..3 up to alpha-numeric characters

19.2.20 GS1 Barcode

In this section: See also:
GS1 Layout Properties Barcodes
EAN / UCC Application Identifiers

The GS1 barcode allows the selection of one of the Databar (formerly known as RSS Reduced
Space Symbology) family of barcodes that contain linear symbologies and stacked variants.
They are closely related to the EAN series of barcodes (e.g. EAN 8 or EAN 128) and are designed
to be compatible with EAN / UCC Application Identifiers.

2308
 19.2 Barcodes

19.2.20.1 GS1 Layout Properties

Position Tab
See the separate Position Tab section.

Content Tab
See the separate Barcodes section.

Text and Align Tab

See the separate Barcodes section.

GS1 Tab

When GS1 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the GS1 tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Determines the width of the narrowest code element (either bar or space)
in selected units.

Calculated using a different formula for each of the variants selectable in the Type combo-
box.

Measurement units can be changed by clicking on the unit symbol.

2309
19 Appendices

Height Determines the barcode's height.

This option is inactive for the GS1-14 Stacked barcode variant. There the height is set
automatically depending on the module width and the height of the middle row (both
are set also in this tab).

Type Selects the variant of the GS1 barcode:

GS1-14 Encodes the full 14 digit EAN.UCC item identification in a linear symbol
that can be scanned in any direction. It is designed for use with omnidirection-
al/point of sale scanners.

Calculates Module width in meters using the formula: im/ (96/14*CPI) where im
= inches in meters [0.0254].

GS1-14 Truncated Encodes the full 14 digit EAN.UCC item identification with a
smaller width than the usual GS1-14 so that it can be used on smaller products.
However, it is not designed for omnidirectional/point of sale scanners so its use is
limited.

Calculates Module width in meters using the formula: im/ (96/14*CPI) where im
= inches in meters [0.0254].

GS1-14 Stacked Encodes the full 14 digit EAN.UCC item identification with a
shorter length than the usual GS1-14 due to the fact that the two halves are stacked
on top of one another. The width is based on the truncated GS1-14 and so this
can be used on smaller products. However, it is not designed for omnidirection-
al/point of sale scanners so its use is limited.

Calculates Module width in meters using the formula: im/ (50/14*CPI) where im
= inches in meters [0.0254].

GS1-14 Stacked Omnidirectional Encodes the full 14 digit EAN.UCC item identi-
fication with a shorter length than the usual GS1-14 due to the fact that the two
halves are stacked on top of one another. The width is based on the full GS1-14
and so it is designed for use with omnidirectional/point of sale scanners.

Calculates Module width in meters using the formula: im/ (50/14*CPI) where im
= inches in meters [0.0254].

GS1 Limited Encodes the full 14 digit EAN.UCC item identification in a way that
can be printed smaller than the other GS1 types and can be used for longer codes.
However, it is not designed for omnidirectional/point of sale scanners so its use is
limited.

Calculates Module width in meters using the formula: im/ (74/14*CPI) where im
= inches in meters [0.0254].

GS1 Expanded Encodes the full 14 digit EAN.UCC item identification and supple-
mentary information (e.g. Best Before data) and so is generally a longer code. It is
designed for omnidirectional/point of sale scanners.

Calculates Module width in meters using the formula: im/ (10*CPI) where im =
inches in meters [0.0254].

GS1 Expanded Stacked Encodes in the same way as GS1 expanded but also allows
stacking in order to reduce the overall width of the code.

2310
 19.2 Barcodes

The width of the stacked rows of the code and how many stacked rows will appear
is further controlled by the Width in segments option.

Tip In order to create the GS1 128 barcode variant, use the settings for the EAN 128
barcode type.

Height of middle rows Sets the height of the separating rows that appear between the
stacked sections of the code.

Only active if GS1-14 stacked or GS1 expanded stacked are selected for Type.

Width in segments Sets the width of the first row of any GS1 expanded stacked code,
splitting the code between its stacked rows according to number of segments.

1 segment = 26 x Module width.

Only active if GS1 expanded stacked is selected for Type.

Direct Metric Tab

See the separate Direct Mertic Tab section.

19.2.21 Intelligent Mail (4-CB) Barcode

In this section: See also:
Intelligent Mail (4-CB) Layout Properties Barcodes

The Intelligent Mail or 4-State 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), an eight-digit
number that encodes the destination of the mail. This is the only part filled by a user, the other
components are filled automatically.

2311
19 Appendices

Around the encoding of the DPID, a number of other elements are added to the customer
barcode, to provide greater robustness, and a Format Control Code (FCC) Field identifies the
barcodes format. This field always occupies bar positions 3 to 6 (inclusive) in every barcode.

Set of Characters

Start Bars

Format Control Code Field

Sorting Code Field (DPID)

Filler Bar

Stop Bars

19.2.21.1 Intelligent Mail (4-CB) Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Intelligent Mail (4-CB) Tab

When Intelligent Mail (4-CB) is selected in the Barcode type combo-box of the Content tab
of the barcode's properties panel, the Intelligent Mail (4-CB) tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Determines the width of the narrowest code element (either bar or space).

Module width is calculated in meters using the formula: im/ 2*CPI (im = inch size in milli-
meters [0.0254]).

2312
 19.2 Barcodes

Measurement units can be changed by clicking on the unit symbol.

Full bar height Determines the height of the tall bars.

Measurement units can be changed by clicking on the unit symbol.

Quiet zone horizontal Determines the size of the quiet zone (unprinted white space) at the
both ends of the barcode.

Measurement units can be changed by clicking on the unit symbol.

Quiet zone vertical Determines the size of the quiet zone (unprinted white space) above
and below the barcode.

Measurement units can be changed by clicking on the unit symbol.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.21.2 Direct Metric

The description of options in this tab can be found in the separate section Direct Metric Tab.

19.2.22 Japan Post Barcode

In this section: See also:
Japan Post Layout Properties Barcodes

19.2.22.1 Barcode Description

Japan's Postal barcode is based on the 4-State barcode (also known as the Intelligent Mail
barcode) and encodes Numerals and a Hyphen in 3-bar sequences and the Latin Alphabet in
6-bar sequences, with 2-bar Start and Stop sequences.

Set of Characters

Start Bars

36 valid characters, numeric 0-9 and alpha A-Z.

Format Control Code Field

Sorting Code Field (DPID)

Filler Bar

2313
19 Appendices

Modulo 19 check character.

Stop Bars

19.2.22.2 Japan Post Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Japan Post Tab

When Japan Post is selected in the Barcode type combo-box of the Content tab of the bar-
code's properties panel, the Japan Post tab appears.

Options Description

White space Empty area at each end of the barcode for optimum readability.

Measurement units can be changed by clicking on the unit symbol.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.23 MaxiCode Barcode

In this section: See also:
MaxiCode Layout Properties Barcodes

2314
 19.2 Barcodes

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. It has has features that make
it suitable for high speed omni-directional scanning; with an encoding capacity greater than a
linear bar code symbology.

This version of MaxiCode is based on the UPS Maxicode encoding software version 3.1. 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:

1. Structured Carrier Message beginning with '[)>(RS)01(GS)'

[)>(RS)01(GS)<YY(Year)><Zip>(GS)<Country>(GS)<Service>(GS)<Second
ary>(RS)(EOT)

2. Structured Carrier Message NOT beginning with '[)>(RS)01(GS)'

<Zip>(GS)<Country>(GS)<Service>(GS)<Secondary>(EOT)

Note

(RS) is ASCII-code 0x1e

(GS) is ASCII-code 0x1d

(EOT) is ASCII-code 0x04

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

3. Inspire Designer-Specific Input format

The input format is:

(mode, Zip Code, Country Code, Service Class, Symbol Number, Number
of Symbols) Secondary message

Parameters must be enclosed in parenthesis (). All parameters are optional. A default
value is used when they are omitted.

Parameter Description

Mode Default value is 4

2, 3: Structured Carrier Message

4: Standard Symbol

2315
19 Appendices

Parameter Description

6: Reader Programming
Zip Code Default value is <Empty>

when Numeric: up to 9 digits (Zip+4 for USA)

when Alpha-Numeric: up to 6 characters

Country Code Default value is 0

3 digits (ISO country code).

Service Class Default value is 0

3 digits.
Symbol Number Default value is 1.

Range 1-8.
Number of symbols Default value is 1.

Range 1-8.

The conversion is based on UPS MaxiCode encoding software; therefore the same re-
strictions apply.

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)

Features

33 rows - between 30 and 29 modules in width.

144 symbol characters in the primary and secondary messages.

Max. of 93 characters if the data contains only upper-case letters, digits and punctuation.

If the data contains any character in a 256 character set, the encoding capacity is de-
creased. If the data is all-numeric, then 138 digits can be encoded.

Quiet zone of approximately 1 mm (.04) on all four sides.

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.

2316
 19.2 Barcodes

Character Set

1 \Half Space\

2 Hexagons (Black/White)

90 characters to represent the finding pattern.

19.2.23.1 MaxiCode Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

MaxiCode Tab

When MaxiCode is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the MaxiCode tab appears.

Options Description

Mode from data When checked then three modes of data input are recognized as described
above. Then the mode is controlled by the leading characters, for example:
(4,0,42,0,1,1)MaxiCode TNG - Our input type.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.24 MicroPDF 417 Barcode

In this section: See also:
MicroPDF 417 Layout Properties Barcodes

2317
19 Appendices

The MicroPDF417 is a multi-row, variable-length symbology offering high data capacity and
error-correction capability. It 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 and is composed of a stack of rows (min. 4 to max. 44).

Each codeword, except Pattern Codewords, is 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 width, height and error correction level are automatically detected during production, de-
pending on the size of the data after conversion to codewords (unit of information coded in
the barcode), according to the AIM USA norm.

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

Character Set
Each row has the following structure:

Leading quiet zone

Left MicroPDF417 row address pattern

One of the following:

one PDF417 codeword

two PDF417 codewords

one PDF417 codeword, followed by a Center Row Address Pattern and two more
PDF417 codewords

two PDF417 codewords, followed by a Center Row Address Pattern and two more
PDF417 codewords

Right MicroPDF417 row address pattern

One-module stop bar

Trailing quiet zone

2318
 19.2 Barcodes

19.2.24.1 MicroPDF 417 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

MicroPDF 417 Tab

When MicroPDF 417 is selected in the Barcode type combo-box of the Content tab of the
barcode's properties panel, the MicroPDF 417 tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space).

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Module height ratio Determines the height of the elements.

A multiple of module width, i.e. Element Height = Module Width x Module Height Ratio

Quiet zone in modules Empty area on each side of the barcode to aid readability.

Units are multiples of module width.

2319
19 Appendices

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.25 OMR Barcode

In this section: See also:
OMR Layout Properties Barcodes

Optical mark reader (OMR) barcode consists of only 0's and 1's. A reader simply scans for marks
and if one is there it returns 1.

Data can also contain characters P or N (capitalized), where P is replaced by 1 when the data
contains an even number of 1's.

N= P ! (i.e. N is equal to the factorial of P)

A module is placed by the calculation: (Module width + Module shift) x Module index + Quiet
zone

19.2.25.1 OMR Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

OMR Tab

When OMR is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the OMR tab appears.

2320
 19.2 Barcodes

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Prepend str. pattern The string to be added before the data.

Module width Width of the module.

Measurement units can be changed by clicking on the unit symbol.

Module height Height of the module.

Measurement units can be changed by clicking on the unit symbol.

Module shift Adjustment of spacing between the modules.

Begin and end quiet zone Empty area on each end of the barcode for optimum readability.

Select 2/6 inch or 3/6 inch from the combo-box menu.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.26 PDF 417 Barcode

In this section: See also:
PDF 417 Layout Properties Barcodes

PDF417 is a multi-row, variable-length symbology offering high data capacity with error-correc-
tion capability. It can be scanned by either linear or rasterizing laser scanners; or two dimen-
sional 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, contains start and stop patterns, a left
and right indicator and up to thirty data symbol characters. The aspect ratio can be varied to
suit spatial requirements for printing.

Characteristics

Encodable Character: Set 8-Bit Binary Data

Code Type: Continuous, Multi-Row, Self Checking

Symbol size: Variable

2321
19 Appendices

Bidirectionnal decoding: Yes

Error correction: Characters 2 to 512

Character Set

1 Start character

36 characters to represent the data.

1 Stop character

Additional Features

Selectable levels of error corrections

Can utilize scans that cross rows

19.2.26.1 PDF 417 Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

PDF 417 Tab

When PDF417 is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the PDF417 tab appears.

Options Description

CPI If you click on the Edit button, the Set Barcode CPI dialog opens:

2322
 19.2 Barcodes

CPI Sets the number of Codewords Per Inch. The default value is set according to the
automatically generated barcode size.

Ratio Sets the ratio between the width of wide bars and the width of narrow bars.

Module width Width of the narrowest code element (either bar or space) in selected units.

Calculated in meters using the formula: im/ (17*CPI) where im = inches in meters [0,0254].

Module height ratio A multiple of module width: element height = module width * module
height ratio

Quiet zone in modules Empty area on each side of the barcode to aid readability.

Units are multiples of module width.

Truncated Shortens the barcode by removing the right indicator.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Advanced Tab

Options Description

Barcode Size Select from:

Autodetect - An optimum size will be calculated according to data size after it has
been converted to codewords (the units of information that are coded in a barcode).

Codewords per row - The size will be calculated according to how many codewords
will be placed in a single row.

Enter the required number of codewords in the edit-box.

Row count - The size will be calculated according to how many rows are to be
used.

Enter the number of rows in the edit-box (minimum 3, maximum 90).

Error correction level Defines how much of the barcode is used for saving 'check informa-
tion'.

2323
19 Appendices

A barcode contains data and check information (parity data). The check information allows
calculation of any illegible data (e.g. badly printed or smudged) from the data in the
readable part of barcode. The largest value (8) has the highest error correction capability
but the lowest data capacity.

Autodetect determines that an optimum ratio will be calculated according to data size
after it has been converted to codewords in accordance to the AIM US norm.

19.2.27 Planet Barcode

In this section: See also:
Planet Layout Properties Barcodes
PostNet Barcode

The Planet barcodes are required by the U. S. Post Office for tracking purposes. They complement
the PostNet barcode (the relative position of long and short bars is reversed).

Character Set

12 or 14 digits.

Starts with a long bar (frame bar) and ends with another frame bar.

Each character of the encoded address information is made of five bars, either long or
short.

1 check digit at the end of the address information.

The value of the check digit is modulus 10, i.e. when added to the sum of other digits
the total that is a multiple of 10.

Example The check digit for address code 40123456789 is 1 since

4+0+1+2+3+4+5+6+7+8+9=49 which adds check digit 1 result a sum 50, 5 times
of 10.

19.2.27.1 Planet Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

2324
 19.2 Barcodes

Planet Tab

When Planet is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Planet tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the module.

Measurement units can be changed by clicking on the unit symbol.

Full bar height Height of the tallest bars.

Measurement units can be changed by clicking on the unit symbol.

Half bar height Height of the shortest bars.

Measurement units can be changed by clicking on the unit symbol.

Bars pitch Distance in between the bars.

Measurement units can be changed by clicking on the unit symbol.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.28 PostNet Barcode

In this section: See also:
PostNet Layout Properties Barcodes
Planet Barcode

2325
19 Appendices

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.
It 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).

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).

Character Set

5, 9 or 11 digits (32, 52 or 62 bars respectively).

Starts with a long bar (frame bar) and ends with another frame bar.

Each character is made of five bars.

2 full and 3 half bars represent the digits 0 through 9 creating only 10 valid combinations.
These combinations apply error-recovery, because a combination that does not have 2
full and 3 short is flagged as an error.

1 check digit (5 bars) must be included immediately before the last frame bar.

The value of the check digit is modulus 10, i.e. when added to the sum of other digits
the total that is a multiple of 10.

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.

19.2.28.1 PostNet Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

PostNet Tab

2326
 19.2 Barcodes

When PostNet is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the PostNet tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the module.

Calculated in meters by: im/ (2*CPI) where im = inch size in meters [0.0254].

Measurement units can be changed by clicking on the unit symbol.

Full bar height Height of the tallest bars.

Measurement units can be changed by clicking on the unit symbol.

Half bar height Height of the shortest bars.

Measurement units can be changed by clicking on the unit symbol.

Bars pitch Distance in between the bars.

Measurement units can be changed by clicking on the unit symbol.

Type Select one from the following barcodes in the PostNet format:

American Post the standard PostNet format.

Planet Code see the section Planet Barcode.

Brazil Post the same composition as PostNet barcodes but only allows 8 digits to
be entered.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

2327
19 Appendices

19.2.29 QR Barcode
In this section: See also:
QR Layout Properties Barcodes

The QR barcode is a matrix symbology consisting of an array of square modules arranged in a

square pattern, including a unique finder pattern located at three corners which is intended
to assist the location of its position, size and inclination.

A wide range of sizes of symbol is provided for together with four levels of error correction.

Features

Numeric data (digits 09).

Alphanumeric data (digits 09; upper case letters AZ; nine other characters: space, $
% * + - . / : ).

8-bit byte data (JIS 8-bit character set (Latin and Kana) in accordance with JIS X 0201).

Kanji characters (Shift JIS character set in accordance with JIS X 0208 Annex 1 Shift
Coded Representation.

Note Kanji characters can have values 8140HEX -9FFCHEX and E040HEX - EBBFHEX,
which can be compacted into 13 bits.

A dark module is a binary 1 and a light module is a binary 0.

Symbol size (not including quiet zone) = 21 * 21 modules to 177 * 177 modules (Ver-
sions 1 to 40, increasing in steps of 4 modules per side).

Maximum symbol size (Version 40-L):

numeric data: 7,089 characters

alphanumeric data: 4,296 characters

8-bit byte data: 2,953 characters

Kanji data: 1,817 characters

19.2.29.1 QR Layout Properties

Position Tab
See the separate section Position Tab for details.

2328
 19.2 Barcodes

Content Tab
The options on this tab can be found in the separate section Barcodes.

QR Tab

When QR is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the QR tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the module.

Calculated in meters using: im/ CPI where im = inch size in meters [0.0254].

Quiet zone ratio Empty area on each side of the barcode for optimum readability.

Measurement units can be changed by clicking on the unit symbol.

Barcode size The drop-down menu allows to select the size of the barcode.

By default it is set to Auto, which means that the size is based on the number of characters
encoded; in other words, the barcode will be as large as needed and no bigger than ne-
cessary. When the selected size is larger than necessary, then any extra space (added to
enlarge the barcode) will be filled with redundant data. If the selected size is not big
enough to fit the data, a warning will appear.

Error level You can select among four levels of error correction allowing recovery of:

L 7%

M 15%

Q 25%

H 30%

Use Kanji character recognition If checked, Kanji characters will be recognized if they are
used in the data for the barcode.

2329
19 Appendices

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.30 Royal Mail Barcode

In this section: See also:
Royal Mail Layout Properties Barcodes

The Royal Mail 4-State Customer Code (RM4SCC) barcode is based on the 4-State barcode
(also known as the Intelligent Mail barcode) and is used for automated mail-sorting. It has 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 alpha-numeric character consists of 4 bars of which 2 bars have ascenders and 2 have
descenders. 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, assisting omni-directional
reading.

Character Set

36 characters: numeric (0-9) and alpha (A-Z).

Start and stop bars identify the beginning, end and orientation of the barcode.

The start bar consists of a track and ascender; the stop bar consists of an ascender, a
track and a descender.

An optional check-sum character: A valid character that is formulated using a simple

algorithm that is printed on the right-hand end of the data characters to provide a
means of error detection and correction.

Bar Set

Long Bar: 1

Semi-Long Bar, Upper: 2

Semi-Long Bar, Lower: 3

Timing Bar (Short Bar): 4

2330
 19.2 Barcodes

19.2.30.1 Royal Mail Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Royal Mail Tab

When Royal Mail is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the Royal Mail tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Determines the width of the narrowest code element (either bar or space).

Calculated in meters using the formula: im/ (8*CPI) where im = inch size in meters (0,0254).

Measurement units can be changed by clicking on the unit symbol.

Module asc./descendent Height of the ascender (the top part of the bar) or descender (the
bottom part of the bar) in selected units.

Measurement units can be changed by clicking on the unit symbol.

Module track Height of the track (the middle part of the bar) in selected units

Measurement units can be changed by clicking on the unit symbol.

Check pattern validity If set to Yes, then any string value that is returned to provide the
barcode pattern (e.g. by the variable selected in the Variable combo-box) is validated
before creation of the barcode.

Translate string If checked, the start and stop characters are added to the barcode.

2331
19 Appendices

The Check-Sum character will also be added if Use control check digit is checked.

Calculate check digit If this option is checked AND Translate string is checked, the Check-
Sum character will be added to the barcode.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

19.2.31 Super Stealth-Dots Barcode

In this section: See also:
Super Stealth-Dots Layout Properties Barcodes

Super Stealth-Dots is a multi-row, variable-length symbology offering high data capacity and
error-correction capability. It can encode up-to 70 ASCII characters into an MxN dot matrix.
The alpha-numeric information is encoded and printed in a precise location so that it can be
subsequently read by cameras and decoded by proprietary software. It represents alpha-numeric
data in a base 64 numeric system.

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, for the frame reference.

Features

64 characters to represent the data.

Each Stealth-Dots symbol consists of a matrix of dots framed by clear space.

Max. height / width = 3 rows.

Encodable Character Set: All numeric characters.

1 check character.

Uses the Hamming error correction method.

2332
 19.2 Barcodes

Width, height and error check character 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).

Conversion will fail if the syntax used is not correct, or if the input string given is longer
than 70 characters.

19.2.31.1 Super Stealth-Dots Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

Super Stealth-Dots Tab

When Super Stealth-Dots is selected in the Barcode type combo-box of the Content tab of
the barcode's properties panel, the Super Stealth-Dots tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the module.

Calculated in meters using this formula: 0,0914/ (41,5 * CPI)

Measurement units can be changed by clicking on the unit symbol.

White space Empty area on each side of the barcode for optimum readability

Units are multiples of the module width.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

2333
19 Appendices

19.2.32 UPC A Barcode

In this section: See also:
UPC A Layout Properties Barcodes
EAN 128 Barcode

UPC is completely compatible with EAN Code and represents the numeric code of each article
submitted to the UPC (Universal Product Code) in use in the United States.

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.

UPC A is the basic version of UPC for encoding 10 or 12 numeric characters. The first 5 or 6
are used for the code the manufacturer and the remaining 5 or 6 for the code the article.

The digits are coded in two different ways:

O (Odd parity) provides the coding of each digit containing an odd number of dark
modules.

Each character begins with a space and ends with a bar.

E (Even parity) represents the digits containing an even number of dark modules.

Each character begins with a bar and ends with a space.

The auxiliary check characters are coded the same way as in EAN barcodes.

Features

Numeric

Continuous

Self-checking

4 element widths

Each character is coded with 2 bars and 2 spaces with a total width of seven modules.

The nominal width of the module is 0.33mm.

2334
 19.2 Barcodes

The nominal dimensions of the label can be multiplied by 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.

Character Set

1 start character.

1 character representing the number system (in position 1).

5 or 6 characters represented according to the odd coding which form the left half of
the data field.

Central check character.

5 or 6 characters represented according to the even coding which form the right half
of the data field.

Check digit (in position 12 or 14).

1 stop character.

Advantages

High information density.

Disadvantages

Fixed number of digits.

Spaces are significant.

19.2.32.1 UPC A Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

UPC A Tab

2335
19 Appendices

When UPC A is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the UPC A tab appears.

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Width of the module.

Calculated in meters using: 0.003597/ CPI

Measurement units can be changed by clicking on the unit symbol.

Height Height of the bars.

Measurement units can be changed by clicking on the unit symbol.

Write digits If unchecked, the barcode is displayed without digits.

Get digits font from Text Style If checked, the digits displayed with the barcode take the
form defined by the text style defined in the Text and Align tab of the UPC barcode
properties. Only the font is used; other features of the selected text style are ignored. The
check-box is inactive, when the Write digits check-box is disabled.

Note By default, the digits are displayed/printed in the OCR B font embedded in the
barcode.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Direct Metric Tab

See the Direct Metric tab description in the separate Barcodes section.

19.2.33 UPC E Barcode

In this section: See also:
UPC E Layout Properties Barcodes
UPC A Barcode

2336
 19.2 Barcodes

UPC E is another version of the UPC barcode that is described in the separate UPC A barcode
section. This version is 'zero suppressing', i.e. like version A with some zeros omitted 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.

It is used for marking packages physically too small to be printed with UPC A.

Features

Nominal width of the module is 0.33mm. The size of the whole label can be magnified
by a factor between 0.8 and 2.

48 modules, plus 14 light modules to form the overflow areas.

Character Set

6 digits three with even coding (E) and three with odd coding (O).

1 start/stop character.

A check sum that is only calculated on the base of the 6 characters of the data field
and number system.

The algorithm is modulo 10 weight 3 (resp. 10 minus modulo 10, weight 3), beginning
with weight 3 at the number system.

19.2.33.1 UPC E Layout Properties

Position Tab
See the separate section Position Tab for details.

Content Tab
The options on this tab can be found in the separate section Barcodes.

UPC E Tab

When UPC E is selected in the Barcode type combo-box of the Content tab of the barcode's
properties panel, the UPC E tab appears.

2337
19 Appendices

Options Description

CPI Sets the number of Codewords Per Inch.

If you click on the Edit button, the Set Barcode CPI dialog opens, where you can enter a
new CPI value. The default value is set according to the automatically generated barcode
size.

Module width Determines the width of the narrowest code element (either bar or space)
in selected units.

Calculated in meters using: 0.003597/ CPI.

Measurement units can be changed by clicking on the unit symbol.

Height Determines the height of the bars.

Measurement units can be changed by clicking on the unit symbol.

Write digits If unchecked, the barcode is displayed without digits.

Get digits font from Text Style If checked, the digits displayed with the barcode take the
form defined by the text style selected in the Text and Align tab of the UPC barcode
properties. Only the font is used; other features of the selected text style are ignored. The
check-box is inactive, when the Write digits check-box is disabled.

Note By default, the digits are displayed/printed in the OCR B font embedded in the
barcode.

Text and Align Tab

The options on this tab can be found in the separate section Barcodes.

Direct Matric Tab

See the Direct Metric tab description in the separate Barcodes section.

2338
 19.3 Color Management

19.3 Color Management

19.3.1 Color Management Overview
See also:
Color spaces
ICC profiles

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 it is 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, HSB, 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 commu-
nicate through the rest of the Integrated Color Management (ICM) system to ensure that

2339
19 Appendices

colors are represented accurately to users, regardless of the device they use. Color man-
agement works by:

Mapping colors between devices that have different gamuts (e.g., monitors and
printers).

Transforming colors from one color space to another (e.g., RGB to CMYK).

Providing accurate on-screen or print previews that allow for corrective action.

19.3.2 ICC Profiles

In this section: See also:
Image Color Space Transformation ICC Profile Setting
Background Information Color Space Transformation Examples
Image Color Space Transformation
Detailed Description
Handling of PDF/EPS Images
Handling of AFP Images
Production Engines and Color Space
Transformation
Useful Information

The ICC color profile specification is a cross-platform industry standard that accurately and
consistently characterizes devices such as scanners, monitors and printers. ICC (ICM) profiles
(which are specific color profiles based on the ICC standard) must be installed for all of the
color devices on the user's system.

It is possible to insert images into Inspire Designer saved in two color spaces (RGB or CMYK).
Furthermore, the images can have either an embedded ICC profile (the use of embedded profiles
can be controlled; see below for details) or if no embedded profile is used the image will have
a default profile specified in Inspire Designer attached. The following chapter discusses how
the individual images with RGB or CMYK color spaces, and with or without embedded ICC
profiles, are handled in Inspire Designer after insertion and which ICC color profiles are used
when transformation occurs.

19.3.2.1 Image Color Space Transformation Background

Information
Color space transformation in Inspire Designer can occur on two individual levels. The first level
of transformation can occur after insertion of the image to Inspire Designer when the image
is transferred to an internal color space, the second level when the workflow with the image
is assigned to a specific output type.

Note Not all images will be transformed twice, for some images (depending on the settings
made) transformation will be applied only once or possibly not at all. See the Image Processing
Summary section.

2340
 19.3 Color Management

Level 1 of Transformation
Up to four facts determine the way an inserted image will initially be handled and the color
space transformed (when necessary) by Inspire Designer when the image is transferred to an
internal color space:

1. The color space of the image inserted into Inspire Designer (either CMYK or RGB).

2. The setting made in the Color Type combo-box in the Image Layout Properties specifies
the maximum color type of the inserted image and hereby determines the internal
color space the image will have.

3. The setting made in the Embedded profiles usage combo-box in the Image Layout
Properties, which sets if and when the embedded profile of the inserted image will be
used.

Note Images with an embedded color profile set to Never use profile in the Embedded
profiles usage combo-box and images without an embedded profile are handled
identically.

4. The RGB profile set in Layout and the CMYK profile set in Layout or Proof/Production
determine which profiles will be used when embedded profiles are not used.

Level 2 of Transformation
After being transferred (and when necessary transformed) to an internal color space for storage
in the workflow, the image is then again transformed (when necessary) to a color space de-
pending on the color space required by the output type that has been selected. Again, there
are four facts that determine the way the image will now be handled:

1. The internal color space of the image.

2. The output (Proof is also an output) selected determines the final color space the image
will have:

Output color space is RGB for Vector Proof, Raster Proof and Raster Outputs set
to Black and White (values for B&W are computed from the RGB representation
of the source image).

Output color space is CMYK for Raster Proof and Raster Outputs with settings
CMYK and CMYKSplit.

Note When you select CMYK or CMYK Split in the Output colors combo-box
of the Raster Proof Profile dialog this results in the Output color space being CMYK.
But, as monitors always use an RGB color space for display, this leads to all images
coded in CMYK being transformed to RGB images with the built in target ICC
color profile sRGB.

Output color space is CMYK or RGB for Vector Outputs (e.g. PDF, Postscript) it
is possible to set the output color space.

2341
19 Appendices

3. The setting made in the Embedded profiles usage combo-box in the Image Layout
Properties, which sets if and when the embedded profile of the inserted image will be
used.

4. The RGB profile set in Layout and the CMYK profile set in Layout or Proof/Production
determine which profiles will be used when embedded profiles are not used.

19.3.2.2 Image Color Space Transformation Detailed

Description
In the following descriptions color space transformation of images is described in detail with
the help of schemas followed by explanations. There are two sections:

1. The first section is concerned with the handling of images which originally have an RGB
color space.

2. The second section is concerned with the handling of images which originally have a
CMYK color space. As it is possible to reduce CMYK images to RGB after insertion into
Inspire Designer by selecting RGB in the Color Type combo-box, two separate descrip-
tions are provided covering both cases.

The description contained in each section is divided into two levels in accordance with the de-
scription of the process given in the Color Space Transformation Background Information
section above.

Understanding the Schemas

The following information will help you understand the information given in the schemas and
descriptions below:

1. When images are transformed, two ICC color profiles are necessary:

The first ICC profile describes the color space of the image before transformation.

The second ICC profile describes the target color space into which the image will
be transformed.

Thus, there will always be two of the profiles listed below mentioned in the schema
and according explanation when image transformation occurs:

E Embedded profile of an image

R1 RGB profile set for the Layout in the Options dialog. If no RGB profile has
been specified the built in sRGB ICC profile will be used.

C1 (C2) C1 refers to the CMYK profile set for the Layout in the Options dialog,
C2 to the CMYK profile set in the selected production engines ICC profile set-
ting. CMYK profiles set for the production engine always override the CMYK profiles
set for the Layout. If the CMYK profile in the production engine is set to Layout
CMYK profile than the settings used in the Layout are used. If, in this case, the
profile for the Layout is set to Built in CMYK profile, then the default 1- profile
is used.

2342
 19.3 Color Management

Note When the built in CMYK profile (1-) is used for transformation, only this
profile (which is not an ICC profile) is used. Any other profile connected with the
transformation process will be disregarded in this case.

There is the following exception to the definition of C1 (C2) stated above. When
proofing a workflow, the CMYK profile set in the according Proof profile will be
used and the CMYK profile set in Layout will be disregarded. Any CMYK profile
set in a production engine will not be taken into account when proofing a work-
flow.

2. The setting made in the Embedded profile usage combo-box influences if and when
the embedded profile of an image (if available) will be used when transformation occurs,
so the status of this combo-box has an influence on the way images are transformed.
Thus the setting made here is also a part of the schemas and is set in brackets below
the arrow representing the transformation process. The options are:

<CMYK to RGB only> Refers to the setting CMYK to RGB only (4.4 compatibility).

Tip This option simulates handling in PrintNet T 4.4 where embedded ICC profiles
were only used for transformation from CMYK to RGB during the first level of
transformation. Thus, this option will only lead to an embedded profile being used
if the image is transformed from CMYK to RGB in the first level of transformation.

<Always> Refers to the setting Always use profile.

<Never> Refers to the setting Never use profile.

Note Images without an embedded color profile are processed in the same way
as images with a profile that have been set to Never use profile.

<On Change> Refers to the setting Use on change color space.

3. When no color transformation is applied, the explanation below the schema will mention
just one color profile. This is the color profile currently connected to the image, as all
images included in a Inspire Designer workflow are described by a color profile. This
color profile can be either an embedded profile (depending on availability and the status
of the Embedded profile usage or the R1 or C1 (C2) profile (see point 1. just above
for an explanation of these profiles) set as a default in Inspire Designer.

Handling of Images with an RGB Color Space

Level 1 of Transformation
The following schema describes the first step of RGB image handling. The image is transferred
to an internal color space defined by the setting in the Color Type combo-box:

2343
19 Appendices

Explanation

Internal Color Space is RGB As the setting in the Color Type combo-box only reduces the
color space of an image, RGB images will stay RGB for the settings RGB and CMYK. (CMYK
is considered a higher color space type than RGB.)

Inspire Designer now transfers the image to the internal color space RGB. The transform-
ation applied at this step depends on the settings made in the Embedded profile usage
combo-box of the Advanced tab. The four options for this setting result in the following
behavior:

CMYK to RGB only (4.4 compatibility) No transformation is applied at this point,

the internal RGB image is currently described by the R1 color profile.

Always use profile The image is transformed from RGB with the color profile E
to RGB described by the R1 color profile.

Never use profile No transformation is applied at this point, the internal RGB
image is currently described by the R1 profile.

Use on change color space No transformation is applied at this point, the internal
RGB image is currently described by the E color profile.

Level 2 of Transformation
The following schema describes the second step of RGB image handling. The internal RGB is
transferred to the color space required by the selected output (either RGB or CMYK):

Explanation

Output Color Space RGB No transformation is applied.

Output Color Space CMYK Here, transformation handling again depends on the setting
made in the Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) The image is transformed from RGB with
the profile R1 to CMYK described by the color profile C1 (C2).

Always use profile The image is transformed from RGB with the profile R1 to
CMYK described by the color profile C1 (C2).

2344
 19.3 Color Management

Never use profile The image is transformed from RGB with the profile R1 to CMYK
described by the color profile C1 (C2).

Use on change color space The image is transformed from RGB with the profile
E to CMYK described by the color profile C1 (C2).

Handling of Images with a CMYK Color Space

As the setting made in the Color Type combo-box can lead to the color space of a CMYK
image being reduced to RGB, the following description is split into two parts:

CMYK images reduced to RGB by setting RGB in the Color Type combo-box

CMYK images kept as CMYK by setting CMYK in the Color Type combo-box

CMYK Images Reduced to RGB in Color Type

Level 1 of Transformation
The following schema describes the first step of CMYK image handling when the image is
transferred to an RGB internal color space defined by the setting in the Color Type combo-
box:

Explanation

Internal Color Space RGB As RGB has been selected in the Color Type combo-box, the
CMYK image is reduced to the internal color space RGB. The profiles applied during
transformation depend on the settings made in the Embedded profile usage combo-
box:

CMYK to RGB only (4.4 compatibility) The image is transformed from CMYK with
the profile E to RGB described by the color profile R1.

Always use profile The image is transformed from CMYK with the profile E to
RGB described by the color profile R1.

Never use profile The image is transformed from CMYK with the profile C1 (C2)
to RGB described by the color profile R1.

Use on change color space The image is transformed from CMYK with the profile
E to RGB described by the color profile R1.

Level 2 of Transformation
The following schema describes the second step of CMYK image handling. The internal color
space RGB is transferred to the color space required by the selected output:

2345
19 Appendices

Explanation

Output Color Space RGB No transformation is applied.

Output Color Space CMYK The image is transformed from RGB with the profile R1 to CMYK
described by the color profile C1 (C2) regardless of the settings made in the Embedded
profile usage combo-box.

CMYK Images Kept as CMYK in Color Type

Level 1 of Transformation
The following schema describes the first step of CMYK image handling. The image is transferred
to an internal color space defined by the setting in the Color Type combo-box:

Explanation

Internal Color Space is CMYK No transformation is applied at this stage, regardless of the
setting made in Embedded profile usage.

Level 2 of Transformation
The following schema describes the second step of CMYK image handling. The internal color
space CMYK is transferred to the color space required by the selected output:

2346
 19.3 Color Management

Explanation

Output Color Space RGB Transformation handling depends on the setting made in the
Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) The image is transformed from CMYK with
the profile C1 (C2) to RGB described by the color profile R1.

Note See the details on this option given above.

Always use profile The image is transformed from CMYK with the profile E to
RGB described by the color profile R1.

Never use profile The image is transformed from CMYK with the profile C1 (C2)
to RGB described by the color profile R1.

Use on change color space The image is transformed from CMYK with the profile
E to RGB described by the color profile R1.

Output Color Space CMYK Here, transformation handling again depends on the setting
made in the Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) No transformation is applied.

Always use profile The image is transformed from CMYK with the profile E to
CMYK described by the color profile C1 (C2).

Never use profile No transformation is applied.

Use on change color space No transformation is applied.

Image Processing Summary

The following table provides an overview of image handling and image processing within level
1 and level 2 of transformation described in detail above. Depending on the settings made,
the images can be transformed twice (on input and on output), once or possibly not at all
see the lines highlighted with the background color.

2347
19 Appendices

19.3.2.3 Handling of PDF/EPS Images

PDF/EPS images are handled differently than the other types of images described above. The
transformation applied to PDF/EPS images depends on how they are inserted to Inspire Designer.
PDF/EPS images can be inserted in two ways:

As raster images

or

As vector objects

PDF/EPS images are by default inserted as raster images; to insert them as vector objects you
must enable the option Load natively in the Images Layout Properties of the according image.

Note To read more about the advantages and disadvantages of the usage of the Load nat-
ively setting see the Native Loading of Images section.

As PDF/EPS is a page description language and consists of many text, image and vector objects,
the color of each of these objects can be specified in a different color space (i.e. it is possible
to mix RGB and CMYK color spaces on one page).

Depending on the settings made, PDF/EPS images may be transformed twice, once or possibly
not at all. See the PDF/EPS Image Processing Summary section.

The further description of the handling of EPS/PDF images is split into two parts according to
the two possible ways of inserting them to Inspire Designer.

2348
 19.3 Color Management

PDF/EPS Inserted as Raster Images

PDF/EPS images are loaded as raster images when the Load natively option has been disabled.

Level 1 of Transformation
For more information about level 1 and level 2 of transformation see the chapter: Image Color
Space Transformation Background Information.

The Adobe PDF Library handles level 1 of transformation (i.e. rasterizing of objects) and In-
spire Designer has no control over the method of internal color transformation (when applied).
All embedded profiles are disregarded due to the usage of the Adobe PDF Library, any settings
made in the Embedded profiles usage combo-box will be ignored when a PDF/EPS image is
inserted as a raster image.

The setting made in the Color Type combo-box of the Image Layout Properties determines
the internal color space the image will have (if necessary transformation is applied). The setting
in the Color Type combo-box works differently here than it does with the other image types
described above:

when CMYK is selected, the Adobe PDF Library always returns a CMYK image;

when RGB is selected, the Adobe PDF Library always returns an RGB image.

The Adobe PDF Library only converts color spaces of objects that are specified in a different
color space than the color type specified in the Color Type combo-box.

Example This means that if you know that all of the colors of your PDF file are specified
in CMYK and you select CMYK in the Color Type combo-box, the Adobe PDF Library will
not apply any color space transformation.

Objects with an RGB color space are handled in the following way:

Objects with a CMYK color space are handled in the following way:

2349
19 Appendices

Level 2 of Transformation
Level 2 of color transformation for PDF/EPS inserted as raster images is the same as for other
image types without an embedded ICC profile. This means that during level 2 of transformation
the profiles set in Inspire Designer (R1 and C1 (C2)) will be used if transformation is necessary
(i.e. if the color space specified in the Color Type combo-box differs from the required output
color space). Any ICC profiles that were originally connected to the objects will be disregarded.
See the schemas below for details:

Internal Color Space CMYK

Objects internally stored in CMYK are handled in the following way:

Explanation

Output Color Space RGB All objects are transformed from CMYK with the profile C1 (C2)
to RGB described by the color profile R1.

Output Color Space CMYK No transformation is applied.

Internal Color Space RGB

Objects internally stored in RGB are handled in the following way:

2350
 19.3 Color Management

Explanation

Output Color Space RGB No transformation is applied.

Output Color Space CMYK All objects are transformed from RGB with the profile R1 to
CMYK described by the color profile C1 (C2).

PDF/EPS Inserted as Vector Objects

PDF/EPS images are loaded natively (i.e. as vector objects) when the Load natively option has
been enabled.

Level 1 of Transformation
For more information about level 1 and level 2 of transformation see the chapter: Image Color
Space Transformation Background Information.

Any settings made in the Color Type combo-box are ignored, all objects are loaded to the in-
ternal color space they were originally defined in (i.e. no transformation is performed on level
1). If the color space of an image has been defined by an ICC profile in the original PDF/EPS
image, then this profile will be preserved and can be used for further color transformation
performed in level 2 of transformation.

Level 2 of Transformation
For images whose color space has been defined by an ICC profile in the original PDF/EPS image,
the further usage of this color profile will be controlled by the setting made in the Embedded
profiles usage combo-box. Furthermore, transformation is influenced by the internal color
space of the image (which is its original color space) and the color space required by the output
which has been selected.

Images without an embedded profile are handled exactly like images set to Never in the Em-
bedded profiles usage combo-box. See the schemas below for details:

2351
19 Appendices

Internal Color Space is CMYK

Explanation

Output Color Space RGB Transformation handling depends on the setting made in the
Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) The image is transformed from CMYK with
the profile C1 (C2) to RGB described by the color profile R1.

Note See the details on this option given above.

Always use profile The image is transformed from CMYK with the profile E to
RGB described by the color profile R1.

Never use profile The image is transformed from CMYK with the profile C1 (C2)
to RGB described by the color profile R1.

Use on change color space The image is transformed from CMYK with the profile
E to RGB described by the color profile R1.

Output Color Space CMYK Here, transformation handling again depends on the setting
made in the Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) No transformation is applied.

Always use profile The image is transformed from CMYK with the profile E to
CMYK described by the color profile C1 (C2).

Never use profile No transformation is applied.

Use on change color space No transformation is applied.

2352
 19.3 Color Management

Internal Color Space is RGB

Explanation

Output Color Space RGB Transformation handling depends on the setting made in the
Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) No transformation is applied.

Always use profile The image is transformed from RGB with the profile E to RGB
described by the color profile R1.

Never use profile No transformation is applied.

Use on change color space No transformation is applied.

Output Color Space CMYK Here, transformation handling again depends on the setting
made in the Embedded profiles usage combo-box:

CMYK to RGB only (4.4 compatibility) The image is transformed from RGB with
the profile R1 to CMYK described by the color profile C1 (C2).

Always use profile The image is transformed from RGB with the profile E to CMYK
described by the color profile C1 (C2).

Never use profile The image is transformed from RGB with the profile R1 to CMYK
described by the color profile C1 (C2).

Use on change color space The image is transformed from RGB with the profile
E to CMYK described by the color profile C1 (C2).

PDF/EPS Image Processing Summary

The following table provides an overview of PDF/EPS image handling and image processing
within level 1 and level 2 of transformation described in detail above. Depending on the settings
made, the images can be transformed twice (on input and on output), once or possibly not at
all see the lines highlighted with the background color.

2353
19 Appendices

19.3.2.4 Handling of AFP Images

Just like PDF/EPS images, images in the AFP format can be inserted natively (i.e. as vector objects)
or as raster images. But the handling of color transformations, which can be necessary depending
on the actions performed within the workflow, differs from the color transformation applied
to PDF/EPS images. Color transformation for AFP images is performed in two different ways
depending on whether:

the AFP is inserted as a raster image

or

the AFP is inserted as a vector object

AFP images are by default inserted as raster images; to insert them as vector objects the option
Load natively must be enabled on the image's Layout Properties.

Any embedded ICC profiles that AFP images might have are disregarded regardless of the
setting made in the Embedded profile usage combo-box, i.e. color transformation is performed
without taking the embedded ICC profiles of AFP images into account.

AFP Inserted as Raster Images

AFP images are loaded as raster images when the Load natively option is disabled (this is the
default setting).

2354
 19.3 Color Management

Level 1 of Transformation
When an AFP image is processed as a raster image (i.e. non-natively), the resulting image is
always rasterized as an RGB image; i.e. if you have selected CMYK in the Color type combo-
box, this setting will be disregarded. However, after rasterizing, images can be converted to
Black and white or Gray scale if these options have been selected in the Color type combo-
box.

Original Image Color Space is CMYK/RGB

Explanation

Original Image Color Space CMYK If the original color space is CMYK, the color profiles
C1 (C2) and R1 are employed to transform the image to the RGB color space.

Original Image Color Space RGB If the original color space of the image is RGB, no trans-
formation is performed in this step.

Level 2 of Transformation
At this stage, color space transformation is performed only if the output color space required
is CMYK, as all AFP images imported to Inspire Designer as raster images have RGB as an in-
ternal color space.

Internal Color Space is RGB

Explanation

Output Color Space RGB If the output color space is RGB, no transformation is performed.

Output Color Space CMYK If the output color space is CMYK, color transformation is per-
formed using the color profiles R1 and C1 (C2).

2355
19 Appendices

AFP Inserted as Vector Objects

AFP images are loaded as vector images when the Load natively option has been enabled.

Level 1 of Transformation
Any settings made in the Color type combo-box are ignored, all objects are loaded to the in-
ternal color space they were originally defined in (i.e. no transformation is performed on level
1). If the color space of an image has been defined by an ICC profile in the original AFP image,
then this profile will be disregarded and will not be used for any further color transformations
which might be performed in level 2 of transformation.

Level 2 of Transformation
If a color transformation is required (e.g. to display a CMYK image on the computer display
(when proofing) which requires RGB) the color profiles R1 and C1 (C2) are used for converting
color spaces.

Internal Color Space is CMYK

Explanation

Output Color Space RGB If the output color space is RGB, the image is transformed from
CMYK with the color profile C1 (C2) to RGB described by the color profile R1.

Output Color Space CMYK If the output color space is CMYK, no transformation is applied.

Internal Color Space is RGB

2356
 19.3 Color Management

Explanation

Output Color Space RGB If the output color space is RGB, no transformation is applied.

Output Color Space CMYK If the output color space is CMYK, the image is transformed
from RGB with the color profile R1 to CMYK described by the color profile C1 (C2).

19.3.2.5 Production Engines and Color Space Transformation

In addition to the settings influencing color space transformation which can be made in Layout,
there is also the possibility to influence the color space transformation of images by using settings
available in the various engine configuration dialogs.

Besides the option of setting CMYK profiles which is available for most engine types (referred
to as the C2 profile in the descriptions given above) the engine configuration dialogs of PDF-
like (PDF and NexPress VDX), Postscript-like (Adobe Postscript2 and 3 and CreoVPS, VIPP and
PPML) and AFP engines offer further options that influence the handling of image color space
transformation. These options are described in the sections below.

PDF and NexPress VDX

For these two output types there are several options available in the according Engine Config-
uration dialogs that can influence the way color space transformation will be performed:

1. On the Graphics tab of the engine configuration for PDF and NexPress VDX, there is
the option Apply color management conversions only on color space change.
This option is checked by default and overrides the settings made in Layout in the
Embedded profile usage combo-box. As long as this option is checked, the images
will all be treated as if Use on change has been set in the Embedded profile usage
combo-box.

2. For JPEG images transformation handling can be influenced by the following settings:

For NexPress VDX: If the Use JPEG Compression combo-box is used (i.e. the setting
is other than Never) and if the image is JPEG, then the image is written directly to
the spool file, ignoring all settings in Layout.

For PDF: On the Image Handling tab you can set the option Compression for
JPEG images to JPEG. This has the same result as the above setting for NexPress
VDX: the image is written directly to the spool file ignoring all settings in Layout.

For an embedded ICC profile to be used in RIP the option Append ICC profile to
images also has to be checked. In this case the ICC profile will be extracted from
the JPEG image and inserted into the spool file separately; if unchecked the ICC
profile will be ignored by the RIP.

See the Append ICC Profile to Images Option section below for details.

Also see the sections on NexPress VDX and PDF for more details on the settings.

2357
19 Appendices

PPML, CreoVPS and VIPP

For the PPML, VIPP and CreoVPS production engines there are several options available which
will influence the way color space transformation is performed:

1. In the Images Supported by Printer field it is possible to specify different image types
for your printer. If you additionally check the option Use image source code for the
according image, the images will be inserted as a data stream without any transforma-
tion applied.

2. When unsupported image types are converted (the target image type of the conversion
can be specified in the Convert Unsupported Images Types Into combo-box) their
embedded ICC profiles are lost.

3. Also see the Append ICC Profile to Images Option section below.

Also see the sections on HP PPML, PodiPPML, VIPP and on CreoVPS for details on these settings.

Append ICC Profile to Images Option

The check box Append ICC profile to images is available for the production engines Adobe
Postscript2 and 3, PDF, NexPress VDX, CreoVPS, VIPP and PPML.

When checked, ICC profiles are appended to the spool files if the following conditions are met:

The image originally contained an embedded ICC profile.

The image was not transformed or was transformed using ICC profiles (not the built in
1- CMYK profile).

The embedded profile was not disregarded (Embedded profile usage was set to Always
or On change) if transformation is applied in Inspire Designer.

If these conditions are met, the last ICC profile used in Inspire Designer will be appended to
the image in the spool file and the color space will then be device independent. Further trans-
formation can occur in RIP when necessary. Keep in mind that it is usually best to minimize the
number of conversions applied to images because every transformation changes some colors
because of the different gamut. See Image Color Space Transformation in RIP in the Color
Space Transformation Examples section for an example of how to postpone all transformation
until RIP.

When disabled, no ICC profiles are appended to the spool file; instead Device dependent
DeviceRGB and DeviceCMYK profiles are employed. This is the default setting. This means that
all color transformations were already performed in Inspire Designer and RIP will use the image
data unmodified.

See the sections concerning Adobe Postscript2 and 3, PDF, NexPress VDX, CreoVPS, VIPP and
PPML for more details.

Also see the Color Space Transformation Examples section for examples of the usage of this
option.

2358
 19.3 Color Management

AFP
For the AFP engine there are several options available which will influence the way color space
transformation is performed:

Processing speed can be enhanced by using the options grouped under Image Data
without Processing label located on the Images tab of the configuration dialog. The
drawback of using these options is that the image ICC profile is kept with each image
even if many images use the same profile (e.g. when they all come from the same source
such as a specific camera or scanner) which can enlarge the size of the spool file. Pro-
cessing image files, while taking more time, will avoid this problem (even if the original
color space of the images is kept). Another way of dealing with this issue is selecting
the Extract and reference image ICC profile option.

Also see the descriptions of these options in the AFP engine configuration section for
further details on using them.

In AFP, all colors are converted to a single output colorspace (i.e. to the printer colorspace
and gamut) which defines the complete print file. By using the option Attach ICC
Profiles with rendering intents located on the Color Management tab of the config-
uration dialog, an ICC profile complying with the ACMA (AFP Color Management Ar-
chitecture) standard will be attached to the spool file. This audit type profile contains
an exact definition of the input colors and allows the spool file to be used with other
devices.

Keep in mind that, in general, it is advisable to keep to the number of color conversions
as low as possible as every color conversion performed can lead to a reduction of image
accuracy and thus the loss of color fidelity (as the gamut is usually reduced during
conversion).

Tip Only newer AFP devices can handle spool files with ICC profiles attached, older
devices might reject these kind of spool files and thus this option should not be used
when producing spool files for them.

IPDS
Similarly to the AFP engine, the IPDS engine has several options which influence the way color
space transformation is performed:

The options Use original IOCA image data without processing, Use original JPEG
image data without processing and Use original TIF image data without pro-
cessing located on the Advanced tab of the IPDS engine configuration dialog can im-
prove processing speed. However, if multiple images use the same ICC profile (e.g. they
come from the same source such as a specific camera or scanner) and these options
are used, the ICC profiles are kept with each image, which enlarges the spool file size.
This drawback can be avoided by either processing the images, which is more time
consuming, or (for JPEG and TIF images) by selecting the Extract and reference image
ICC profile check-box, also located on the Advanced tab.

The option Attach ICC Profile, located on the ICC Profile Setting tab of the configuration
dialog, allows for attaching an ICC profile complying with the ACMA (AFP Color Man-
agement Architecture) standard to the spool file. This profile contains an exact definition
of the input colors and helps the spool file to be device independent.

2359
19 Appendices

Note that, in general, it is advisable to keep the number of color conversions as low as
possible as every color conversion performed can lead to a reduction of image accuracy
and consequent loss of color fidelity (as the gamut is usually reduced during conversion).

19.3.2.6 Useful Information

Using the Built In 1- CMYK Profile
This profile has the advantage of fast processing speed, but be aware that the results when
printing are not the best possible, as the transformation applied is very basic and this profile
is not an ICC profile.

Converting between RGB and CMYK using "1-" Conversion

To convert between RGB and CMYK, an intermediate CMY value is used between them. There
is a vector of color values, tCMYK the CMYK quadruple which means each value of that
vector contains values from 0 to 1.

Likewise, tCMY is the CMY triple, and tRGB is the RGB triple.

CMYK -> RGB

Converting CMYK RGB

To convert, first CMYK is converted to CMY, then the CMY value is converted to RGB.

CMYK to CMY (values in 0 1 range)

C=(C*(1-K)+K)
M=(M*(1-K)+K)
Y=(Y*(1-K)+K)

CMY to RGB (values in 0 1 range)

R=(1-C)
G=(1-M)
B=(1-Y)

RGB -> CMYK

Converting RGB CMYK

To convert, first RGB is converted to CMY, then the CMY value is converted to CMYK.

RGB to CMY (values in 0 1 range)

C=1-R
M=1-G
Y=1-B

CMY to CMYK (values in 0 1 range)

2360
 19.3 Color Management

var_K = 1

if ( C < var_K ) var_K = C

if ( M < var_K ) var_K = M
if ( Y < var_K ) var_K = Y

C = ( C - var_K ) / ( 1 - var_K )
M = ( M - var_K ) / ( 1 - var_K )
Y = ( Y - var_K ) / ( 1 - var_K )
K = var_K

Printing Black Colors

When you want to print black color or black & white images defined in an RGB color space on
a CMYK output device the black color has to be transformed to CMYK which can cause
problems.

Some ICC profiles return rich black (made up of a mix of colorants) instead of pure black (C:0,
M:0, Y:0, K:1). Although the appearance of both will usually be very similar, normally pure
black will be preferred because it only uses black ink which saves costs and shortens drying
time.

The built in 1- CMYK profile returns pure black, when using other ICC color profiles it is re-
commended to define the black color in CMYK before transformation to ensure that pure black
will be used. This can be done in the Color dialog.

CMYK Profiles in Workflows with Multiple Layouts

If you would like to work with different CMYK profiles in different Layouts using the same
output make sure the CMYK profile for that output is set to Layout CMYK profile (if a CMYK
profile were set here, it would override the settings in the individual Layouts) in the outputs
Engine Configuration Panel. The profiles set for each Layout in the according Options Dialog
will be used.

ICC Profiles Used with TNO files

When TNO files are loaded in the workflow, colors can be transformed using ICC profiles, so
it is not necessary to use the Built In 1- CMYK Profile. ICC profiles can be set in many Engine
Configuration dialogs in Production and in Proof Profile dialogs. For more information about
setting ICC profiles see the ICC Profile Setting section.

2361
19 Appendices

19.3.3 Color Space Transformation Examples

In this section: See also:
Images Color Space Transformation for ICC Profiles
PostScript, PDF-based and AFP Outputs
Handling of EPS/PDF Images in
PostScript-like Output
Handling of Colors of Non-Image Objects
Using the Pre-Flight Functionality to
Optimize Ink Usage

The following sections give information and examples of recommended settings for the following
issues related to color space transformation:

Three possibilities of performing color transformation when using PDF-like (PDF and
NexPress VDX), Postscript-like (Adobe Postscript2 and 3, CreoVPS, VIPP, HP PPML and
PodiPPML) and AFP outputs

Handling of PDF/EPS files when using PostScript-like output

Handling of non-image (i.e. text and graphics) colors in vector outputs

Optimizing ink usage using the Pre-Flight functionality

19.3.3.1 Image Color Space Transformation for PostScript,

PDF-based and AFP Outputs
As PostScript- and PDF-based outputs as well as AFP outputs are intermediate outputs and
must be rasterized by RIP (Raster Image Processor) before actual printing can occur, it is possible
to perform image color space transformation at three different stages:

Exclusively before inserting the image into Inspire Designer.

Exclusively in Inspire Designer before creating the spool file.

Exclusively in RIP preceding the output of the spool file.

All of these actions have their advantages, depending on the intention of the user; these will
be discussed in the following section as well as the settings necessary for performing color
space transformation at the desired stage.

Generally it can be said that it makes sense to perform as few color transformations as possible,
as color transformations tend to cost color fidelity. Thus, their amount should be kept to a
minimum by performing color transformations exclusively at one of the above mentioned
stages.

2362
 19.3 Color Management

Image Color Space Transformation before Insertion into

Inspire Designer
Performing color space transformation before inserting the images into Inspire Designer has
the following advantages:

Longer processing times in Inspire Designer or in RIP can be avoided, as all color trans-
formation concerning images (i.e., transformation to CMYK with an ICC profile suitable
for the output device which will be used) will have been performed beforehand and
the images will be passed through Inspire Designer (and RIP) without any further pro-
cessing.

Color transformation can be performed by a department which has experience working

with colors and performing transformations (e.g. by a graphics department); this min-
imizes issues in this stage of production.

The disadvantage of performing color transformation before inserting images into Inspire De-
signer is:

The performed color space transformation will be correct only for the printer the images
were prepared for (i.e. for the printer whose ICC profiles have been used to perform
color transformation on the images prior to their insertion into Inspire Designer); i.e. if
it becomes necessary to print on another printer, the images will have to be transformed
again (using this new device's ICC profile), inserted into Inspire Designer and the spool
file must then again be created.

When does performing color transformation of images before their insertion into Inspire De-
signer make sense?

In compliance with the above stated advantages of this method, there are two main reasons
for handling images in this way:

1. When a maximum of color fidelity needs to be achieved.

2. When minimizing processing time in Inspire Designer/RIP is an important factor.

To ensure that Inspire Designer passes through the images without any further processing or
color space transformation the following settings have to be applied:

1. The color model (CMYK) of imported images should not be changed by Inspire Designer
and no further color transformation should be performed by Inspire Designer. Both of
these actions can be specified in the Advanced tab of the Image Layout Properties of
the according image. Make the following settings here:

Specify CMYK in the Color Type combo-box. This ensures that CMYK images will
not be reduced to RGB.

Specify Never in the Embedded profile usage combo-box. This assures that there
will not be any color transformation performed in Inspire Designer or RIP.

2. For PDF and PostScript: In the Image color space (called Images in the PDF Engine
Configuration dialog) combo-box Take from Layout image must be selected.

For AFP: Select Full color in the Output colors combo-box.

Then select the options Use original JPEG image data without processing, Use
original TIF image data without processing and Use original IOCA image data

2363
19 Appendices

without processing depending on the format of the images being employed. For
limitations in connection with the use of these options see the description in the accord-
ing part of the AFP Engine Configuration section.

3. Be sure the Append ICC profile to images (called Attach ICC profile to AFP for
AFP) option in the according engine configuration dialog is not selected. This assures
that images will be written to the spool file without any ICC profiles attached and that
no color transformation will be performed at a later point, i.e. during the RIP process.

Image Color Space Transformation in Inspire Designer

Performing color space transformation in Inspire Designer has the following advantages:

The spool file will be shorter (as no profiles need to be appended)

Ripping will take less time because color transformation has already been correctly
performed (provided the appropriate ICC profiles were selected in Inspire Designer)

The disadvantage of performing color transformation in Inspire Designer is:

The performed color space transformation will be correct only for the printer it was in-
tended for (i.e. for the printer for which the ICC profiles have been selected); if it be-
comes necessary to print on another printer, new color settings for this printer must be
set in Inspire Designer and the spool file must again be created.

When does color space transformation in Inspire Designer make sense?

Employing this method makes sense if the spool file is to be used on one output device only
(as is often the case with PostScript-like outputs).

To ensure that color space transformation is performed by Inspire Designer follow the steps
described below:

1. The color model (RGB or CMYK) of an imported image should not be changed by In-
spire Designer and if there are embedded ICC profiles they should be imported to and
applied within Inspire Designer. Both of these actions can be specified in the Advanced
tab of the Image Layout Properties of the according image. Make the following settings
here:

Specify CMYK in the Color Type combo-box. This ensures that CMYK images will
not be reduced to RGB and that RGB images will stay RGB.

Specify Always use profile in the Embedded profile usage combo-box. This en-
sures the embedded profile of an image will always be used for transformation.

2. Now the target ICC profiles must be set to ensure that the transformation performed
is in compliance with the printer that will be used. The appropriate profiles can be set
in the Layout Options menu. CMYK profiles can also be set in the ICC Profile Setting
area of the used Output engine dialog. Remember that CMYK profiles set for the
Output engine override any CMYK profile settings made in the Layout Options. The
ICC profiles set here should correspond with the settings made for the according
printer in the Printer Configuration dialog in Inspire Designers Production window.

3. For PDF/PostScript: No PostScript color management should be used; i.e. ICC profiles
will not be converted to CSAs (i.e. PostScript color profiles) and will not be embedded
in the PostScript output stream (as conversion will already have been performed within

2364
 19.3 Color Management

Inspire Designer). The following settings in the according PostScript and PDF production
engines are necessary to guarantee the desired handling of the profiles:

The option Append ICC profile to images must be disabled.

In the Image color space (called Images in the PDF-like outputs) combo-box the
necessary settings depend on the purpose:

Force RGB should be selected for on-screen display.

Force CMYK should be selected for printing.

For PostScript it is also necessary to enable the DSC version 3 check-box.

For PDF it is also necessary to ensure that the option Apply color management
conversions only on color space change has been disabled as this setting will
otherwise override the Always use profile setting made in the Embedded profiles
usage combo-box.

For AFP:

The option Attach ICC profiles with rendering intents should be enabled for
AFP. This attaches ICC profiles to the whole spool file. Using these attached profiles
it is possible to check if the spool file was created for the output device (printer)
you are working with.

For output color select Full color in the Output colors combo-box and CMYK in
the Color space for text and graphic option.

Furthermore, when processing images in Inspire Designer, it is possible to compress

the images using either the Full color image format combo-box or the options
available on the Image Handling tab.

Image Color Space Transformation in RIP

Postponing color space transformation to RIP has the following advantage:

The spool file you create will be independent of the output device you finally select, as
all ICC profiles are included and can be employed by device internal transformation
processes.

Disadvantages of postponing color transformation are:

The created spool file will be larger (as the profiles are appended to it).

Ripping will take longer (as color transformation will be performed at this point).

When does postponing color transformation to RIP make sense?

Postponing color transformation makes sense when you are uncertain about the output device
which will be used or plan to use multiple output devices. This could be the case when using
PDFs, as PDFs are often used not only for printing but also for on-screen display and archiving
purposes.

2365
19 Appendices

To ensure that color transformation is postponed to RIP follow the steps described below:

1. The color model (RGB or CMYK) of an imported image should not be changed by In-
spire Designer and if there are embedded ICC profiles they should be imported to and
retained by Inspire Designer for later use in RIP. Both of these actions can be specified
in the Advanced tab of the Image Layout Properties of the according image. Make the
following settings here:

Specify CMYK in the Color Type combo-box. This ensures that CMYK images will
not be reduced to RGB and that RGB images will stay RGB.

Specify Use on change color space in the Embedded profile usage combo-box.
This prevents color transformation in Inspire Designer (due to the settings made
in step 2 just below) and retains the embedded profile for later usage.

2. For PDF and PostScript: In the Image color space (called Images in the PDF Engine
Configuration dialog) combo-box Take from Layout image must be selected.

For AFP: Select Full color in the Output colors combo-box.

Then select the options Use original JPEG image data without processing and/or
Use original TIF image data without processing depending on the format of the
images being employed (only TIFF and JPEG can be transformed in AFP RIP). For limita-
tions in connection with the use of these options see the description in the according
part of the AFP Engine Configuration section.

3. Enable the Append ICC profile to images option (called Attach ICC profiles with
Rendering Intents for AFP) in the according engine configuration dialog. This assures
that images will be written to the spool file with ICC profiles attached so that color
transformation can be performed at a later point.

For AFP you can also enable the option Extract and reference ICC profile. In this
case the ICC profile is extracted and added to the resources, if several images use the
same profile it will be referenced and only attached to the spool file once, which can
reduce the size of the spool file that is created.

Note To handle color space transformation correctly in RIP, further settings in the according
PPD (PostScript Printer Description) may be necessary.

19.3.3.2 Handling of EPS/PDF Images in PostScript-like

Output
When inserting EPS/PDF images into Inspire Designer which are intended for a PostScript-based
output there are two ways to accurately preserve the embedded color profiles defined in these
images, depending on the state of the Load natively option which can be set in the Advanced
tab of the Image Layout Properties :

1. When the option Load natively is enabled (the images will be inserted into Inspire De-
signer as vector objects and with their embedded profiles) you need to make the fol-
lowing setting in the PostScript Engine Configuration dialog:

Enable the Use separation color spaces and DeviceN colors option (this assures
that spot color definitions are preserved in the Postscript spool file).

2366
 19.3 Color Management

The further handling of images in this case is described in the PDF/EPS Inserted as
Vector Objects section of the ICC Profiles description.

2. When the option Load natively is disabled (the images will be inserted into Inspire De-
signer as raster images) you need to make the following settings in the PostScript Engine
Configuration dialog:

Enable the DSC version 3 check-box (this ensures that a maximum number of
RIPs can handle the output).

Enable the Use original PDF images and Use original EPS images options (this
assures that data (including color specifications) in imported EPS and PDF files will
be copied directly into the PostScript spool file).

See the Handling of PDF/EPS Images section in the ICC Profiles description for further details
on PDF/EPS a color space transformation.

Note The preferred setting for PostScript-like outputs is to use original EPS images (Load
natively is disabled) because Inspire Designer does not touch the image at all, processing is
faster and all features are preserved. Normally, using Load natively in Layout is necessary only
for output types other than PostScript, where it is not possible to use the original file directly.
However, some EPS files contain features that create errors when used directly on RIP and in
this case the EPS file has to be loaded natively in Layout and processed as vector objects.

19.3.3.3 Handling of Colors of Non-Image Objects

Whereas the previous discussions above have been concerned with the handling of colors in
images inserted into Inspire Designer, in this section the focus is on colors of text/graphics. The
main difference between images colors and colors of text/graphics is that the colors for the
latter are usually not imported into Inspire Designer but created within the program itself.

Defining Color Spaces and Color Space Transformations

Use the Color dialog to define the color value in the color space that is required.

Color transformations are handled depending on the color space that the print device requests,
the typical case being CMYK requested by the printer. In this case Inspire Designer performs
the following actions:

If the color space of text and graphics has been specified in CMYK, no transformation
will be performed, i.e. the colors will be device dependent.

Thus, to make colors device independent, colors need to be defined in a different color
space (LAB is recommended) so that color transformation is performed.

If the colors are defined as RGB, LAB or HSB color transformation will be performed
using either the profile set in Layout or the profile set for the production engine (if a
profile is set there, it takes priority over the profile set in Layout, just like with images).

Handling is similar if the output from Inspire Designer is RGB colors (e.g. for PDF); if you have
defined the colors in RGB no transformation will be performed, for all other color spaces color
transformation will take place.

Note ICC profiles cannot be attached to colors.

2367
19 Appendices

Defining Spot Colors

The Color dialog also offers the possibility to define spot colors that can be used for non-image
objects. These spot colors can be preserved in PostScript spool files as so-called separation
color spaces, provided that the correct settings are used. An alternate color (either defined in
an RGB or CMYK color space) can be defined in the upper part of the Color dialog. The alternate
color specification will for instance be used if the spot color is unavailable in the spot color
dictionary of the attached controller or when spot color matching is disabled.

After a spot color has been defined, it can be used in a Inspire Designer layout just like any
other color, for instance to specify the color of text or graphic objects. In order for a spot color
definition to be preserved in a PostScript spool file, the option Use separation color spaces
and DeviceN colors in the PostScript Engine Configuration dialog should be selected.

Note To handle spot colors correctly, further settings in the according PPD (PostScript Printer
Description) may be necessary.

19.3.3.4 Using the Pre-Flight Functionality to Optimize Ink

Usage
A helpful function available in Proof can be accessed by clicking on the Pre-Flight icon when
employing raster proof profiles. This function helps optimizing the amount of ink used when
printing.

See the section on the Pre-Flight Check functionality for details.

19.3.4 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 2-D, 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 Inspire 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:

Color Spaces Description

RGB 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 compon-
ents are at their maximum value.

2368
 19.3 Color Management

Like most color spaces, the RGB color space is normalized. That is, all color values are re-
stricted to the range of zero to one inclusive.

Black is (0.0, 0.0, 0.0)

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.

HSB 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 ex-
pressed as a degree between 0 and 360.

Saturation, sometimes called chroma, is the strength or purity of the color. Satura-
tion 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).

LAB 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 compon-
ents:

The a component, which ranges from green to red.

The b component, which ranges from blue to yellow.

CMYK 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

2369
19 Appendices

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.

19.3.5 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 corres-
ponding absolute coordinates.

Finding the absolute coordinates from 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.

In Inspire Designer it is possible to set different rendering intent for each of the handling groups.
See the ICC Profile Setting section for more details.

Rendering Intents Explanation

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.

2370
 19.3 Color Management

It is therefore reasonable in this case to print the printable colors (probably the great ma-
jority) 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 transform-
ation. For this type of image, the colorimetric rendering intent is suitable.

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 destinations 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.

Perceptual (Picture) For some situation, neither absolute nor relative colorimetric rendering
is suitable. This is the case when the destination gamut is narrower 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 chro-
matic 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 dif-
ference 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.

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.

2371
19 Appendices

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.

19.4 Configuration
19.4.1 CONFIG File Customizations
There are many features of Inspire Designer and its related applications that can be customized
by using a configuration (CONFIG) file, which is a simple XML file. If one or more of these
customizations are required, the CONFIG file should be created and placed in the same directory
as the EXE file of the application which should be customized. It should be named so that it
has exactly the same name as the EXE but with the CONFIG extension.

Example

PNetT.config

PNetTC.config (for console application)

The script inside the CONFIG file is structured between <Config> and </Config> tags. There
should be only one CONFIG file but many customization elements can be put into it, each
placed on a separate line.

Example
<Config>
<ZeroLineGapFix>1</ZeroLineGapFix>
<Type1FontsWithFullName>1</Type1FontsWithFullName>
</Config>

This section describes the following customizations:

Set Old Linespacing

Use Full Font Name in Type1 Fonts

Enable/Disable Using Memory Mapped Files

Ignore Engine/Driver/Printer Settings

Treat Per-User Settings Like All-Users Settings in PNetT.cfg

2372
 19.4 Configuration

Alter Raster Hinting

Auto-Confirm IPDS Job

Inspire Content Manager Client Timeout

Inspire Content Manager Server Debug Mode

Inspire Content Manager Client Debug Mode

Inspire Content Manager Cache Size Limit

Replace Space with Underscore in CSV Definition

Skip SAP Input File Header

Keep Empty Lines Containing Tabulators

Save Copy of Imported RTF File

Open Corrupted Workflow

Merge Visible Paragraph and Text Styles if Identical

Save Imposition Script Data in Memory

Enable/Disable TNO Switching to Disc Mode

Disable Reading Complete Record Data into Memory

Overwrite IPDS Exception Level

Force Run on Remote Server

Inspire Production Server Extended Logs

Native Import Image Cache Size

Native Import Max Cached Image Count

IPTC Character Set

Set Process and Thread Affinity

Override User Name

Max Count of Overlays for Merged Table Borders

Week of Year Compatibility

License for Web Products

Alternative Way of Rendering Thin Lines

Checking Checksum for All Used Files

Encrypted Command Lines

2373
19 Appendices

The CONFIG file can also contain elements for encrypting and decrypting TNO files. See the
section Encrypted TNO Files for details.

19.4.1.1 Set Old Linespacing

With some workflows created in PrintNet T versions prior to 4.2 you may observe that the line
spacing has shrunk compared to previous 4.1 releases. This is caused by the fact that in TrueType
and OpenType fonts the HHEA table is loaded this table contains ascender, descender and
line gap.

In versions 4.1 and older, when the line gap was 0 the character height was increased by ap-
proximately 15%. In versions 4.2 and newer, this 15% has been removed.

If you prefer the old "incorrect" behavior, then place the following content into the CONFIG
file:

<ZeroLineGapFix>1</ZeroLineGapFix>

19.4.1.2 Use Full Font Name in Type1 Fonts

Type1 fonts are split into sub-families. Using this customization, it is possible to force displaying
and selecting of each sub-family of the Type1 fonts instead of displaying just the family name
font.

Place the following code into the CONFIG file:

<Type1FontsWithFullName>1</Type1FontsWithFullName>

Also, delete the file fontcache.dat. This file is in the same directory as the EXE file having been
created during the first start-up of the Inspire Designer application.

19.4.1.3 Enable/Disable Using Memory Mapped Files

Usage of memory mapped files is turned off by default in PrintNet T versions 4.4 and higher
(contrary to 4.3 and lower, where it was turned on by default). On the Windows platform (32-
bit), there is 2 GB of RAM allocated for each operating system process. If this is turned off, you
have more memory available for viewing several large WFD files. This way the opened jobs do
not occupy so much memory space.

However, data reading may be slower when usage of memory mapped files is turned off.

To turn on the usage of memory mapped files, place the following code into the CONFIG file:

<AllowMemoryMappedFiles>1</AllowMemoryMappedFiles>

2374
 19.4 Configuration

Note If memory mapped files are used then Inspire Designer will crash if they are:

Across a network and that network is disconnected.

Local and an error occurs on the hard drive.

19.4.1.4 Ignore Engine/Driver/Printer Settings

Using this customization, after loading JOB production configuration file in Production and
Simple Production, all engine/driver/printer settings from the selected profiles will be ignored.
Only Job Config fields and workflow parameters will be loaded.

Place the following code into the CONFIG file:

<IgnoreAnyEngineConfigsFromJobFile>1</IgnoreAnyEngineConfigsFromJobFile>

19.4.1.5 Treat Per-User Settings Like All-User Settings in

PNetT.cfg
Using this customization, all per-user settings in PNetT.config will be treated like all-user settings.
All of the users using the same workstation will have the same PNetT.cfg.

Place the following code into the CONFIG file:

<AllowCurrentUserConfig>0</AllowCurrentUserConfig>

19.4.1.6 Alter Raster Hinting

Using this customization, hinting can be altered for raster type engines in both Proof and Pro-
duction with the following code in the CONFIG file:

<AFPLikeHintingType>Value</AFPLikeHintingType>

Where Value: 0 = hinted (default); 1 = no hinting; and 2 = autohinting.

19.4.1.7 Auto-Confirm IPDS Job

For IPDS, job confirmation is needed in order to be able to send the next job. This can cause
delays when many smaller jobs are printed and particularly with devices which are unable to
respond automatically when a the last page of a job has been printed, e.g. Nipson devices.

Using this customization, confirmation of an IPDS print job is made after the job is sent. Usual
behavior is to confirm a job when it has been printed and so this modification allows the next
job to follow quicker.

2375
19 Appendices

Place the following code into the CONFIG file:

<IPDSAutoConfirm>1</IPDSAutoConfirm>

19.4.1.8 Inspire Content Manager Client Timeout

When communicating with the Inspire Content Manager (VCS) server using TCP/IP it is possible
to change the value of the timeout elapsed for the server response, which is set to 30,000 ms
(millisecond) by default.

The default setting is expressed by the following CONFIG file code:

<VCSClientTimeout>30000</VCSClientTimeout>

Changing (increasing) the timeout value could be recommended when frequent failures occur
when communicating with the Inspire Content Manager (VCS) server.

19.4.1.9 Inspire Content Manager Server Debug Mode

When this customization is used, the log file of the Inspire Content Manager (VCS) server
contains more detailed information about running of commands.

Place the following code into the CONFIG file:

<VCSServerDebugMode>1</VCSServerDebugMode>

19.4.1.10 Inspire Content Manager Cache Size Limit

With this customization it is possible to change the default Inspire Content Manager (VCS)
cache size, which is 2 GB.

<VCSCacheLimit>size</VCSCacheLimit>

The size is entered in MB.

19.4.1.11 Inspire Content Manager Client Debug Mode

When this customization is used, a log file is created on the client's side containing information
about communication with the server.

Place the following code into the CONFIG file:

<VCSClientDebugMode>1</VCSClientDebugMode>

2376
 19.4 Configuration

19.4.1.12 Replace Space with Underscore in CSV Definition

Using this customization, spaces are replaced with underscores in CSV definition.

Place the following code into the CONFIG file:

<ReplaceSpaceWithUnderscoreInCSVDefinition>1</ReplaceSpaceWithUnderscoreInC
SVDefinition>

19.4.1.13 Skip SAP Input File Header

This customization enables you to skip reading of headers of SAP input files, if the length of
the header is not in accord with the file format specification.

Place the following code into the CONFIG file:

<SAPDataInputCheckHeader>0</SAPDataInputCheckHeader>

19.4.1.14 Keep Empty Lines Containing Tabulators

This customization allows to keep lines containing only tabulators visible in the layout in spite
of having selected the Ignore empty lines option in Paragraph Style Layout Properties dialog.

The default behavior after selecting this option is that lines containing tabulators only are
treated as empty, so they are not visible in the layout anymore.

If you wish to keep the lines with tabulators only visible, place the following code into the
CONFIG file:

<KeepEmptyLinesWithTabulators>1</KeepEmptyLinesWithTabulators>

19.4.1.15 Save Copy of Imported RTF file

Using this customization it is possible to save a copy of an RTF file imported to the workflow.
The copy is saved in the current directory (i.e., the directory where you start Inspire Designer)
and the file is named rtfimport.rtf.

The copy is useful when performing debugging following an import error.

If you wish to create a copy of the imported RTF file, place the following code into the CONFIG
file:

<RTFKeepOneCopy>1</RTFKeepOneCopy>

2377
19 Appendices

19.4.1.16 Open Corrupted Workflow

When this customization is used, it is possible to open a WFD file containing an error which
would normally prevent it from opening. However, the workflow opening proceeds only until
the error is reached.

Place the following code into the CONFIG file:

<OpenCorruptedWorkflow>1</OpenCorruptedWorkflow>

19.4.1.17 Merge Visible Paragraph and Text Styles if

Identical
If identical paragraph styles and text styles occurred in older versions of Inspire Designer and
both styles were visible, they were merged by default. This no longer happens, new behavior
was implemented in PrintNet T versions 5.1.63 and 5.2.15.

If you prefer the older behavior, place the following code into the CONFIG file:

<CompatibilityExternalTextParaStyleUpdate>1</CompatibilityExternalTextPara
StyleUpdate>

19.4.1.18 Save Imposition Script Data in Memory

Using this customization enables storing all Sheet Info data in the memory, leading to an increase
in speed. However, as this customization places more demands on memory size, it is advisable
to consider the possible risk of running out of memory.

Place the following code into the CONFIG file:

<ImpositionScriptInMemory>1</ImpositionScriptInMemory>

19.4.1.19 Enable/Disable TNO Switching to Disc Mode

When reading TNO files, it is possible to prevent the process from switching to the disc mode.
An increase in speed is the likely advantage of this customization, however, there is a risk of
running out of memory.

If you wish to ban TNO switching to disc mode, place the following code in the CONFIG file:

<TNODiscFallback>0</TNODiscFallback>

2378
 19.4 Configuration

19.4.1.20 Disable Reading Complete Record Data into

Memory
By default, the whole record is read into the application memory and is stored there while being
processed. However, reading whole data record into memory can be disabled and only those
record's items and subitems that are needed for processing can be stored. This is useful if your
records are particularly large and could cause the system to run out of memory.

If you wish to disable reading the whole record into the application memory in the CONFIG
file, use the following code:

<AllowRecordAtOnce>0</AllowRecordAtOnce>

There are two other options how to configure this setting. The Read complete record data
into memory check-box in the Current Workflow Options dialog serves the same purpose
and is currently the standard way of performing the desired action. You can also enter the
command in Inspire Production Console or Inspire Production Server. The command overrides
the setting in the GUI. The setting in the CONFIG file overrides both; the setting in the GUI and
in the command line.

19.4.1.21 Overwrite IPDS Exception Level

This customization is used for setting the level of IPDS exceptions.

If you wish to change the setting, place a code based on the following example to the CONFIG
file.

<IPDSExceptionLevelOverload>011000=5;011100=8;</IPDSExceptionLevelOverload>

The values before "=" represent IPDS exception codes.

The values after "=" represent the exception level:

StatusMessageLow = 1

StatusMessageHigh = 2

WarningLow = 3

WarningHigh = 4

RecoverableErrorLow = 5

RecoverableErrorHigh = 6

FatalErrorLow = 7

FatalErrorHigh = 8

CriticalError = 9

If the exception level equals or is greater than 8, the job will abort.

2379
19 Appendices

If the exception level is 6 or 7, the job will be stopped.

Note This is only used for connecting drivers, for example in the event of a paper jam. Do
not generate this code but from the IPDS.

If the exception level equals or is lower than 5, warning messages are generated.

Tip Apart from the CONFIG file customization it is possible to change these settings in GUI.

The IPDS exceptions level configuration dialog serves the same purpose; i.e. changing the IPDS
exception level. In this dialog, there are just three exception levels available (this limitation has
no impact on practical use; moreover, the dialog offers the Autorestart option):

Message = 5

Stop = 6

Abort = 8

The numeric values correspond to those used in the CONFIG file.

If there are differences between the CONFIG file and GUI setting, the GUI setting will take ef-
fect.

19.4.1.22 Force Run on Remote Server

This customization allows you to force the Run on remote server option of the Production en-
vironment. It may be useful if multiple users are required to spool files on one remote server.

If you wish to force running jobs on a remote server, use the following code:

<ForceRunOnRemoteServer>1</ForceRunOnRemoteServer>

Setting the configuration to 1 will force running jobs on a remote server; if any other value is
set, running jobs on a remote server will be forbidden.

19.4.1.23 Inspire Production Server Extended Logs

If this customization is used, the Inspire Production Server (PNetTNetServer) log file will contain
all messages that are normally displayed in the console or Log window-pane when a job is run.

If you wish to enable extended logging, use the following code:

<TNGNetServerEnhancedLogs>1</TNGNetServerEnhancedLogs>

2380
 19.4 Configuration

19.4.1.24 Native Import Image Cache Size

This customization allows to edit the limit for cached data while processing natively imported
files with images. The default values are:

500MB for 32-bit systems;

2GB for 64-bit systems.

If you wish to customize the cache size limit, use the following code:

<NativeImportImageCacheSize>[B]</NativeImportImageCacheSize>

where the '[B]' needs to be substituted with the desired value expressed in bytes.

For example, if you want the limit at 800MB, use the following string: <NativeImportIm
ageCacheSize>800000000</NativeImportImageCacheSize>.

Select values appropriate to the system's processing capabilities for a given job.

19.4.1.25 Native Import Max Cached Image Count

This customization allows to edit the maximum number of images that can be cached during
native import of a file. The default value is set at 20.

If you wish to customize the cached image count, use the following code:

<NativeImportMaxCachedImageCount>100</NativeImportMaxCachedImageCount>

where the selected maximum number of cached files is placed between the tags (in the example
above it is 100).

Select values appropriate to the system's processing capabilities for a given job.

19.4.1.26 IPTC Character Set

This customization allows to set character encoding used for IPTC keywords. The default
character encoding is Latin1 (ISO/IEC 8859-1).

If you wish to select a different character encoding required for your IPTC keywords, use the
following code:

<IPTCCharacterSet>Character Encoding</IPTCCharacterSet>

Example
To select the Windows-1250 character encoding, insert its name between the tags:
<IPTCCharacterSet>Windows-1250</IPTCCharacterSet>.

2381
19 Appendices

See also the Meta Data Info Methods section.

19.4.1.27 Set Process and Thread Affinity

This customizations for Inspire Production Server (PNetTNetServer) set preferred processors for
processes and threads. Use the following codes for performance optimization that reflects your
hardware configuration.

<FirstThreadAffinityMask>0001</FirstThreadAffinityMask>

This code defines the processor on which the first thread is run. The mask 0001 means that
the first thread will run on the first processor, the second thread on the second processor, etc.
The mask 0010 means that the first thread would run on the second processor, the second
thread on the third processor, etc.

<ProcessAffinityMask>1001</ProcessAffinityMask>

This code defines the preferred processors on which Inspire Designer jobs will run. The mask
1001 means that the process will run on the first and fourth processor. The mask 0110 means
that the process will run on the second and third processor.

Note This feature is available only for the Windows platform.

19.4.1.28 Override User Name

This customization allows to save the settings in the CFG file according to the actual current
user's name.

If you wish to override the user name, use the following code:

<Config><OverrideUserName>name</OverrideUserName></Config>

19.4.1.29 Max Count of Overlays for Merged Table Borders

This customization is used to set the default maximal count of overlays used for merged table
borders for all Layouts in the workflow. It is useful especially to globally limit the number of
allowed overlays for merged table borders in jobs created in PrintNet T versions earlier than
6.2. This method saves the necessity of having to open Layout Properties for each Layout and
changing the setting for each Layout manually. By default, the maximal value (99,999,999) is
applied for WFDs created in older versions.

If you wish to globally limit the overlay count, use the following code:

<MaxCountOfOverlaysForMergedTableBorders>25800</MaxCountOfOverlays
ForMergedTableBorders>

2382
 19.4 Configuration

See also the Overlays Properties description in the Layout Options chapter.

19.4.1.30 Week of Year Compatibility

Since version 6.2 the calculation of the week of year in the Parse Date Time field conversion
has changed. This customization allows to calculate the week of year the old way to assure
backward compatibility.

<WeekOfYearCompatibility>1</WeekOfYearCompatibility>

19.4.1.31 License for Web Products

If Inspire Production Server (PNetTNetServer) is intended to be used for web products (not for
production) it can be run with a licence limited for web products. If you have only the 'PNet T
Net Server Web' licence and try to run the server without this option, the server is not launched.

<RunForWeb>1</RunForWeb>

Alternatively, this option can be used via command line.

19.4.1.32 Alternative Way of Rendering Thin Lines

This customization is used to select the default way of rendering thin lines (around 1 px) for
PostScript and PDF files that are not loaded natively. If set to true, thin lines are rendered as
done in previous versions of PrintNet T (specifically in versions where PDF Library 8 and earlier
were used PrintNet T up to v6.1). If set to false, this lines are rendered in accordance with
the versions of PrintNet T that use PDF Library 9.

<LegacyThinLines>true</LegacyThinLines>

See also the Use legacy method for thin line rendering option in Workflow Options.

19.4.1.33 Checking Checksum for All Used Files

This customization is used to avoid opening corrupted Used files in Inspire Designer. To achieve
this, the checksum of a file received when including the file (e.g. a font) into Used files and
the checksum of the same file received when opening a WFD file (with such a file included)
are checked. If they do not match, a warning message is displayed and the WFD file is not
opened.

<CheckAllUsedFiles>1</CheckAllUsedFiles>

Note This behavior can be suppressed by the CONFIG option Open Corrupted Workflow.
However, it is not recommended because if a file is corrupted Inspire Designer cannot ensure
correct outputs.

2383
19 Appendices

If this option is not present in the CONFIG file, this behavior applies to font files only.

19.4.1.34 Encrypted Command Lines

Command lines that are always required to be used on the start-up of an application and/or
are also required to be encrypted (e.g. password entry) can also be placed in the CONFIG file.

<AdditionalCmdLineParams> </AdditionalCmdLineParams>

Example The following entry could be used in the PNetTNetServer.config file to log in
to the Inspire Content Manager (VCS):

<Config>
<AdditionalCmdLineParams> -vcsserver localhost -vcsport 30353 vcsuser ad
min -vcspassword pass </AdditionalCmdLineParams>
</Config>

In this way, the parameters are executed when the application is started and there is no need
to enter them in the operating system's command-line console in effect keeping them hidden
from other users. This is intended for use with UNIX operating systems in particular.

After the first run, the <AdditionalCmdLineParams> element will be converted into an
element called <AdditionalCmdLineParamsHash> and the commands that it contains
will be encrypted, i.e. will not be legible. In addition, whenever you use one of the defined
parameters via a console then the other defined parameters will be used automatically, e.g.
from the example used above, subsequently using PNetTNetServer vcsport 30353
will automatically use server localhost, user admin and password pass.

Any command-line parameter appropriate to the application to which the CONFIG file belongs
can be used this way.

2384
 19.4 Configuration

19.4.2 Environment Variables

Environment variables are strings that contain information about the environment for the system.
Inspire Designer can use the information to determine where to place files or for other purposes.

How to Set Environment Variables

For Windows XP:

1. Right-click on My Computer.

2. Choose Properties.

3. In the System Properties dialog that opens, go to the Advanced tab.

4. Click on the Environment Variables button.

5. Under System Variables, click on New.

6. Type the Variable Name (PNETT_DIR for instance).

2385
19 Appendices

7. Type the Variable Value (C:\MySharedDesignerDir for instance).

8. Click on OK.

For Windows Vista:

1. Go to Start | Control Panel | System.

2. Select Advanced System Properties from the Tasks menu.

3. Follow the above example for Windows XP from step 3 to the end.

For Windows 7:

1. Go to Start | Control Panel | System.

2. Go to the Advanced system settings menu on the left.

3. Follow the above example for Windows XP from step 3 to the end.

19.4.2.1 PNETT_DIR Variable

Using the PNETT_DIR system (environment) variable, you can define a directory containing:

the PNetT.cfg file (configuration file)

fontcache.dat file

cache files (*. TSD files) saved from Inspire Designer.

You can set the system variable using Start | Control Panel | System discussed above or using
the set command.

This system variable will not be used when c or cc command-line parameter is specified.

19.4.2.2 CX_DATA Variable

Using the CX_DATA system (environment) variable, you can define a directory (e.g. c:\Pro
gram Files\GMC\PrintNet T Designer 7.0) containing the icudt32l.dat file (conversion
tables, locales etc.) necessary for running Inspire Designer and related applications as well as
other files and folders (like e.g. PDF Library folder) that may be used for Inspire Designer features
to work correctly. Defining the CX_DATA variable enables you running Inspire Designer and
related applications also from other directories than the installation directory.

When this variable is not specified, the folder containing PNetT.exe is used.

You can set the system variable using Start | Control Panel | System discussed above or using
the set command.

19.4.2.3 CX_FONT_DIRECTORY Variable

By default, Inspire Designer looks for font in Windows Fonts directory.

2386
 19.4 Configuration

Using the CX_FONT_DIRECTORY system (environment) variable, you can change system font
directory (directory that Inspire Designer looks for fonts in) using this variable.

In case there is no font in this directory, Inspire Designer does not run and logs this message:

You don't have a system font in folder name into log file.

You can set the system variable using Start | Control Panel | System discussed above or using
the set command.

19.4.3 How to Set System Defaults

See also:
Workspaces

Inspire Designer offers users a broad range of control. You can set:

Options Customized default values (e.g., font, units of measurement).

Environment The appearance of each of the configurable windows (Workflow, Layout,

Proof and Production).

19.4.3.1 Setting Inspire Designer Options

Each major Inspire Designer window (i.e., Workflow, Layout, Proof, and Production) has a range
of options that you can configure to meet your needs. To access the dialog screen where you
set values for these options, do the following:

To access Do the following

Workflow Options Dialog Select File | Options

Layout Options Dialog Select File | Options
Proof Options Dialog Select Proof | Options
Production Options Dialog Select Production | Options

19.4.3.2 Setting Your Environment

Environment refers to how a main window will appear. You can:

Set palette sizes, visibility and positions.

Select Windows-related options.

2387
19 Appendices

Configurable environments are available for Workflow, Layout, Proof and Production. If you
want a window to open in a particular way each time you open it, do the following:

1. Set the window the way you would like it to appear.

2. Select Window | Save Environment.

3. If you always want to use the saved environment, ensure Load Environment on
startup in the General Workflow/Layout Options dialog is selected.

Additionally, you can:

Load Environment Return to the last saved environment after changes have been
made.

Reset Environment Return to the default Inspire Designer environment settings for
that window.

19.4.4 Operating System Customizations

On the Windows platform (32-bit), the virtual address space of applications is limited to 2 GB
unless a specific switch is used to increase the allowance. Inspire Designer is able to utilize up
to 3 GB and so to increase processing speed you can use that switch:

For Windows 2000/NT/XP etc. this switch /3GB should be added to the Boot.ini file
(which is usually found directly in the hard drive directory (e.g. C:\Boot.ini):

Example The following script shows the content of a Boot.ini file with /3GB
switch added to the end:

[boot loader]
timeout=30
default=multi(0)disk(0)rdisk(0)partition(2)\WINNT
[operating systems]
multi(0)disk(0)rdisk(0)partition(2)\WINNT="????" /3GB

For Windows Vista the switch should be made by entering the command BCDEDIT
/Set IncreaseUserVa 3072 (where the value 3072 = 3 GB) via the standard
cmd.exe application.

In order to check that the change has been made, enter the command BCDEDIT and
the Windows Boot Loader list is displayed with the IncreaseUserVa value.

The 64-bit version of Inspire Designer does not have the above limitations and the 32-bit version
of Inspire Designer used on a 64-bit platform is able to utilize 4 GB without any need for a
switch.

2388
 19.4 Configuration

19.4.5 JOB File

19.4.5.1 JOB File Structure
The following section describes the structure and meaning of the individual elements that can
be found in a JOB file.

A JOB file is intended for saving the settings of the Production environment so that they can
be stored and shared for later re-use. It is saved in the XML format upon selecting Production
| Save Production Configuration from the Production Window Menu.

The XML format has a tree-like structure consisting of dependent elements. These elements
may contain data and other elements.

The basic JOB configuration structure is as follows (created by PrintNet T 4.4, it may contain
additional elements in newer versions):

<?xml version="1.0" encoding="UTF-8"?>

<ProductionConfig Version="4.4">
<EngineConfigs>
<Engine EngineType="AFP">
...
</Engine>
<Engine EngineType="PDF">
...
</Engine>
<Engine EngineType="Image">
...
</Engine>
</EngineConfigs>
<Jobs>
<Job>
<WorkFlow>C:/wfds/loremipsum.wfd</WorkFlow>
<Output>Layout1</Output>
<JobConfig>
...
</JobConfig>
<Engine>AFP</Engine>
<DriverConfigType>File</DriverConfigType>
<FormatConfigName>Default</FormatConfigName>
<DriverConfigName>Default</DriverConfigName>
<FormatConfig>
...
</FormatConfig>
<DriverConfig>
...
</DriverConfig>
<WorkFlowModuleParameters/>
<WarningConfigs/>
</Job>
...
</Jobs>
</ProductionConfig>

Note It is not advised to edit the JOB file manually unless you are sure to preserve the valid
XML structure and enter valid values.

2389
19 Appendices

<EngineConfigs>
The EngineConfigs element contains the configuration of the individual engines. Each Engine
element describes one engine (that is available from the Main Production window) attribute
EngineType contains the engine name.

The elements of the individual engines are described in the following sections:

<Engine EngineType="AdobePostScript2">

<Engine EngineType="AdobePostScript3">

<Engine EngineType="AFP">

<Engine EngineType="CreoVPS">

<Engine EngineType="Desktop Printer (driver)">

<Engine EngineType="Docx">

<Engine EngineType="HP PPML">

<Engine EngineType="HTML">

<Engine EngineType="HTML Simple">

<Engine EngineType="IJPDS">

<Engine EngineType="Image">

<Engine EngineType="IPDS">

<Engine EngineType="Metacode">

<Engine EngineType="MIBF">

<Engine EngineType="Multi">

<Engine EngineType="NexPressVDX">

<Engine EngineType="NULL">

<Engine EngineType="PCL">

<Engine EngineType="PDF">

<Engine EngineType="PDF Fixed Resolution">

<Engine EngineType="PNetTNative">

<Engine EngineType="PodiPPML">

<Engine EngineType="Raster">

<Engine EngineType="Text">

<Engine EngineType="VIPP">

2390
 19.4 Configuration

<Jobs>
The element Jobs contains the job configuration including the name of the WFD file, the selected
output module and other elements that relate to the values set within the Main Production
window. For multiple jobs there will be one Job element created for each configured job.

Element JobConfig contains all information from the Job Config part of the Main Production
window.

Elements FormatConfig, DriverConfig and PrinterConfig (if relevant) are copied from the
element Engine for the engine selected in EngineConfigs.

<JobConfig>
<SheetBegin>1</SheetBegin>
<SheetEnd>1</SheetEnd>
<PrintToEnd>True</PrintToEnd>
<CopyCount>1</CopyCount>
<Collate>True</Collate>
<PrintUserGroup1>True</PrintUserGroup1>
<PrintUserGroup2>True</PrintUserGroup2>
<PrintUserGroup3>True</PrintUserGroup3>
<Offset X="0" Y="0"/>
<Scale X="1" Y="1"/>
<RunByRecord>UseOutputSetting</RunByRecord>
</JobConfig>

Most elements have the same name as their counterpart options as shown in the Main Produc-
tion window with the following exceptions:

Module <Output>

Begin <SheetBegin>

End <SheetEnd>

Copies <CopyCount>

Print Group 1 <PrintUserGroup1>

Print Group 2 <PrintUserGroup2>

Print Group 3 <PrintUserGroup3>

Advanced VCS Location in Job Configuration for Main WFD

Even though manual edition of the JOB files is not recommended, it can be applied if defining
advanced VCS location of workflows is needed. See the example below:

<?xml version="1.0" encoding="UTF-8"?>

<ProductionConfig Version="7.0.21.0">
<Jobs>
<Job>
<WorkFlow>vcs:FL:orange:\\m.wfd</WorkFlow>
...

2391
19 Appendices

A JOB file with manually added VCS location of a workflow can be used in GUI Production,
Simple Production, Proof and PNetTC.

19.4.5.2 <Engine EngineType="AdobePostScript2">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the AdobePostScript2 engine dialog
description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AdvancedFinishing

Parent: PPDSettings
Attributes: None
Subelements: FinishingOperations

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, Images, PJLCommands, PsSettings

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

2392
 19.4 Configuration

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Constraint

Parent: Constraints
Attributes: name, name1, name2, option1, option2
Subelements: None

Constraints

Parent: PPD
Attributes: None
Subelements: Constraint

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

2393
19 Appendices

CreateImages

Parent: Images
Attributes: CreateInto, Dir, Engine, GroupName, MergeAlsoImages, MergeOverlays,
ReuseBackgroundImages, Use, UseBackgrounds, UseScreenBackground, UseScreenTOP,
UseVariableParts
Subelements: None

CustomPageSizeParam

Parent: CustomPageSizeParams
Attributes: MaxValue, MinValue, Name, Option, Order, TransformName, Units
Subelements: None

CustomPageSizeParams

Parent: PpdStructure
Attributes: None
Subelements: CustomPageSizeParam

CustomPageSizeParams

Parent: SubGroup
Attributes: None
Subelements: None

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength
Subelements: None

Data

Parent: Validator
Attributes: None
Subelements: Root

DefaultQueries

Parent: PpdStructure
Attributes: None
Subelements: DefaultQuery

DefaultQueries

Parent: SubGroup
Attributes: None
Subelements: None

DefaultQuery

Parent: DefaultQueries
Attributes: Name, Value
Subelements: None

2394
 19.4 Configuration

DefaultValue

Parent: DefaultValues
Attributes: Name, Value
Subelements: None

DefaultValues

Parent: PpdStructure
Attributes: None
Subelements: DefaultValue

DefaultValues

Parent: SubGroup
Attributes: None
Subelements: None

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

Element

Parent: Root
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, MaximumOfPageLengthInMetres, ZipAllFiles
Subelements: ICCProfile, ResizeBarcodes

2395
19 Appendices

Feature

Parent: UIFeatures
Attributes: Id
Subelements: UIGroup

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: None

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, FontEncoding, Maximal-
CountOfSingleByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, PsOutputOption

FullView

Parent: PPDSettings
Attributes: None
Subelements: GlobalValues, UserInterfaces

2396
 19.4 Configuration

GlobalValues

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

HandlingGroup

Parent: HandlingGroups
Attributes: GenerateImages, GenerateNativeImages
Subelements: None

HandlingGroups

Parent: Images
Attributes: None
Subelements: HandlingGroup

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

Images

Parent: AdvancedSettings
Attributes: CachedImages, ImageBufferSize, ImageColorSpace, ImagesRenderDPI,
PutTransparentMonochromaticImagesIntoFonts, ReplacePatternByClippingPath, Sup-
pressNativeLoading, UseCCITTCompression, UseOriginalEps, UseOriginalPdf
Subelements: CreateImages, HandlingGroups, ImageFilters, Pdf2PsPrintParams

2397
19 Appendices

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JobPatchFiles

Parent: PpdStructure
Attributes: None
Subelements: None

2398
 19.4 Configuration

JobPatchFiles

Parent: SubGroup
Attributes: None
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Keys

Parent: PpdStructure
Attributes: None
Subelements: Key

Keys

Parent: SubGroup
Attributes: None
Subelements: None

Keys

Parent: UIGroup
Attributes: None
Subelements: Key

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

2399
19 Appendices

OnFinishDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize
Subelements: PpdItems

OnStartDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize, UseJCLCommands
Subelements: PpdItems

OrderDependencies

Parent: PpdStructure
Attributes: None
Subelements: None

OrderDependencies

Parent: SubGroup
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PJLCommands

Parent: AdvancedSettings
Attributes: EndPJLCommands, IncludePJLCommand, StartPJLCommands
Subelements: None

PPD

Parent: PPDSettings
Attributes: JCLBegin, JCLEnd, JCLInterpreter, ModelName
Subelements: Constraints, PpdStructure, UIFeatures

PPDSettings

Parent: PrinterConfig
Attributes: CreatePPD, IncludePPDCommandsToSpoolOnlyOnChange, ShowTransla-
tionValues
Subelements: AdvancedFinishing, FullView, OnFinishDocument, OnStartDocument,
PPD

Pdf2PsPrintParams

Parent: Images
Attributes: PsLevel
Subelements: None

2400
 19.4 Configuration

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PpdItems

Parent: OnFinishDocument
Attributes: None
Subelements: Item

PpdItems

Parent: OnStartDocument
Attributes: None
Subelements: Item

PpdStructure

Parent: PPD
Attributes: Name, TransformName
Subelements: CustomPageSizeParams, DefaultQueries, DefaultValues, JobPatchFiles,
Keys, OrderDependencies, SubGroups

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: JDFConfig, PPDSettings

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

PsOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles
Subelements: None

2401
19 Appendices

PsSettings

Parent: AdvancedSettings
Attributes: CreateFormsAsResources, CreateIccBasedColorSpaceResources, SpoolFile-
Compression, UseIccBasedColorSpaces, UseOverlays, UseSeparationColorSpaces
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

2402
 19.4 Configuration

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

2403
19 Appendices

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

SubGroup

Parent: SubGroups
Attributes: Name, TransformName
Subelements: CustomPageSizeParams, DefaultQueries, DefaultValues, JobPatchFiles,
Keys, OrderDependencies, SubGroups

SubGroups

Parent: PpdStructure
Attributes: None
Subelements: SubGroup

SubGroups

Parent: SubGroup
Attributes: None
Subelements: None

UIFeatures

Parent: PPD
Attributes: None
Subelements: Feature

2404
 19.4 Configuration

UIGroup

Parent: Feature
Attributes: DefaultOption, Name, OrderDependencyOption, OrderDependencyOrder,
OrderDependencySection, QueryValue, Section, TransformName, UIType
Subelements: Keys

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

UserInterfaces

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

19.4.5.3 <Engine EngineType="AdobePostScript3">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the AdobePostScript3 engine dialog
description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

2405
19 Appendices

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AdvancedFinishing

Parent: PPDSettings
Attributes: None
Subelements: FinishingOperations

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, Images, PJLCommands, PsSettings

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

2406
 19.4 Configuration

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Constraint

Parent: Constraints
Attributes: name, name1, name2, option1, option2
Subelements: None

Constraints

Parent: PPD
Attributes: None
Subelements: Constraint

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

CreateImages

Parent: Images
Attributes: CreateInto, Dir, Engine, GroupName, MergeAlsoImages, MergeOverlays,
ReuseBackgroundImages, Use, UseBackgrounds, UseScreenBackground, UseScreenTOP,
UseVariableParts
Subelements: None

CustomPageSizeParam

Parent: CustomPageSizeParams
Attributes: MaxValue, MinValue, Name, Option, Order, TransformName, Units
Subelements: None

CustomPageSizeParams

Parent: PpdStructure
Attributes: None
Subelements: CustomPageSizeParam

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength
Subelements: None

2407
19 Appendices

Data

Parent: Validator
Attributes: None
Subelements: Root

DefaultQueries

Parent: PpdStructure
Attributes: None
Subelements: DefaultQuery

DefaultQuery

Parent: DefaultQueries
Attributes: Name, Value
Subelements: None

DefaultValue

Parent: DefaultValues
Attributes: Name, Value
Subelements: None

DefaultValues

Parent: PpdStructure
Attributes: None
Subelements: DefaultValue

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, PrinterAddress, QueueName,
Split, SplitBySize, SplitSize

Element

Parent: Root
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

2408
 19.4 Configuration

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, MaximumOfPageLengthInMetres, ZipAllFiles
Subelements: ICCProfile, ResizeBarcodes

Feature

Parent: UIFeatures
Attributes: Id
Subelements: UIGroup

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: None

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, FontEncoding, Maximal-
CountOfSingleByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

2409
19 Appendices

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, PsOutputOption

FullView

Parent: PPDSettings
Attributes: None
Subelements: GlobalValues, UserInterfaces

GlobalValues

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

HandlingGroup

Parent: HandlingGroups
Attributes: GenerateImages, GenerateNativeImages
Subelements: None

HandlingGroups

Parent: Images
Attributes: None
Subelements: HandlingGroup

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

2410
 19.4 Configuration

Images

Parent: AdvancedSettings
Attributes: CachedImages, ImageBufferSize, ImageColorSpace, ImagesRenderDPI,
PutTransparentMonochromaticImagesIntoFonts, ReplacePatternByClippingPath, Sup-
pressNativeLoading, UseCCITTCompression, UseOriginalEps, UseOriginalPdf
Subelements: CreateImages, HandlingGroups, ImageFilters, Pdf2PsPrintParams

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

2411
19 Appendices

JobPatchFiles

Parent: PpdStructure
Attributes: None
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Keys

Parent: PpdStructure
Attributes: None
Subelements: Key

Keys

Parent: UIGroup
Attributes: None
Subelements: Key

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

OnFinishDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize
Subelements: PpdItems

2412
 19.4 Configuration

OnStartDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize, UseJCLCommands
Subelements: PpdItems

OrderDependencies

Parent: PpdStructure
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PJLCommands

Parent: AdvancedSettings
Attributes: EndPJLCommands, IncludePJLCommand, StartPJLCommands
Subelements: None

PPD

Parent: PPDSettings
Attributes: JCLBegin, JCLEnd, JCLInterpreter, ModelName
Subelements: Constraints, PpdStructure, UIFeatures

PPDSettings

Parent: PrinterConfig
Attributes: CreatePPD, IncludePPDCommandsToSpoolOnlyOnChange, ShowTransla-
tionValues
Subelements: AdvancedFinishing, FullView, OnFinishDocument, OnStartDocument,
PPD

Pdf2PsPrintParams

Parent: Images
Attributes: PsLevel
Subelements: None

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PpdItems

Parent: OnFinishDocument
Attributes: None
Subelements: Item

2413
19 Appendices

PpdItems

Parent: OnStartDocument
Attributes: None
Subelements: Item

PpdStructure

Parent: PPD
Attributes: Name, TransformName
Subelements: CustomPageSizeParams, DefaultQueries, DefaultValues, JobPatchFiles,
Keys, OrderDependencies, SubGroups

PrinterAddress

Parent: DriverConfig
Attributes: None
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: JDFConfig, PPDSettings

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

PsOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles
Subelements: None

PsSettings

Parent: AdvancedSettings
Attributes: CreateFormsAsResources, CreateIccBasedColorSpaceResources, SpoolFile-
Compression, UseIccBasedColorSpaces, UseOverlays, UseSeparationColorSpaces
Subelements: None

2414
 19.4 Configuration

QueueName

Parent: DriverConfig
Attributes: None
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

2415
19 Appendices

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

2416
 19.4 Configuration

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

SubGroups

Parent: PpdStructure
Attributes: None
Subelements: None

UIFeatures

Parent: PPD
Attributes: None
Subelements: Feature

UIGroup

Parent: Feature
Attributes: DefaultOption, Name, OrderDependencyOption, OrderDependencyOrder,
OrderDependencySection, QueryValue, Section, TransformName, UIType
Subelements: Keys

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

2417
19 Appendices

UserInterfaces

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

19.4.5.4 <Engine EngineType="AFP">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the AFP engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

AFPAdvancedFinishing

Parent: PrinterConfig
Attributes: None
Subelements: AdvancedFinishing, ApplyFinishing, PageLevelTreshold

AFPIPDS

Parent: DitheringSetting
Attributes: None
Subelements: Generic

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

2418
 19.4 Configuration

Advanced

Parent: FormatConfig
Attributes: None
Subelements: AdvancedTextOptions, AttachICCProfile, Compatibilities, CutNegative-
Coordinates, DeviceSettingsForCMR, ExternalAFPFonts, ICCProfileSetting, Maximu-
mAFPRecordLength, MaximumOfPageLength, ResizeBarcodes

AdvancedFinishing

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: FinishingOperations

AdvancedTextOptions

Parent: Advanced
Attributes: Codec, DoNotCorrectCharacterPositionsInsideWords, KeepTextAsTextInOver-
lay, TextEncoding, UseFontsFor, UseFontsForGraphics, UseTextEncoding, Varia-
bleSpaceCharacterIncrement
Subelements: None

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AnamorphicScaleForOutlineFonts

Parent: Text
Attributes: None
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

ApplyFinishing

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: None

AssignAFPColorsToColorants

Parent: General
Attributes: None
Subelements: Colorant

AssignAFPColorsToIndex

Parent: Color
Attributes: None
Subelements: SpotColor

2419
19 Appendices

AssignColorants2HighlightColors

Parent: General
Attributes: None
Subelements: HighlightColor

AssignHighlightColors

Parent: General
Attributes: None
Subelements: HighlightColor

AttachICCProfile

Parent: Advanced
Attributes: None
Subelements: None

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

CMOCA

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

CMYKColorant

Parent: CMYKColorants
Attributes: AFPColor, ColorantName, Coverage, HighlightColor, Shading
Subelements: None

CMYKColorants

Parent: General
Attributes: None
Subelements: CMYKColorant

CodePageName

Parent: OnDemandSupport
Attributes: None
Subelements: None

CodePages

Parent: ResourceType
Attributes: Directory, Extension, Status
Subelements: None

2420
 19.4 Configuration

CodedFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

CodingForPageIndexes

Parent: Indexing
Attributes: Codec, Coding, IndexingTextCodec, ReplaceUnresolvedCharactersWith
Subelements: None

Color

Parent: General
Attributes: OutputColors
Subelements: AssignAFPColorsToIndex, ColorSpaceForTextAndGraphic

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

ColorManagement

Parent: FormatConfig
Attributes: None
Subelements: MapBlackColorToOCABlack, UseMixedColorants

ColorSpaceForTextAndGraphic

Parent: Color
Attributes: ColorSpaceForTextAndGraphic
Subelements: None

Colorant

Parent: DitheringSetting
Attributes: None
Subelements: None

Colorant

Parent: AssignAFPColorsToColorants
Attributes: AFPColor, Colorant
Subelements: None

Colorant

Parent: Colorants
Attributes: None
Subelements: None

2421
19 Appendices

Colorants

Parent: General
Attributes: None
Subelements: Colorant

ColorantsType

Parent: General
Attributes: UseOldColorants
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Compatibilities

Parent: Advanced
Attributes: DPI1440Positioning, OldFormDefFormat, OldStyleOfFontUseMCF1,
UseIM1ImageFormat, UsePageSegmentsOnly, UsePageSegmentsOnlyAs, UseRelative-
FontMetric
Subelements: None

CompressBW

Parent: General
Attributes: CompressBlackAndWhiteImagesCCITTG4, DoCutOperationsUncom-
pressedIM1
Subelements: None

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

CreateCustomIndexFile

Parent: CustomIndexFile
Attributes: CreateCustomIndexFile
Subelements: None

CreateSeparateResourceDocumentAndIndexObjectFiles

Parent: Indexing
Attributes: AddPageLevelEntriesToIndexFile, CreateSeparateResourceDocumentAndIn-
dexObjectFilesSelection, IndexFileName, ResourceFileName
Subelements: None

CreateXMLSummaryFile

Parent: Misc.
Attributes: None
Subelements: None

2422
 19.4 Configuration

CustomIndexFile

Parent: Indexing
Attributes: None
Subelements: CreateCustomIndexFile, CustomIndexFileItems, ItemsSeparatorIndexFile-
Path

CustomIndexFileItems

Parent: CustomIndexFile
Attributes: None
Subelements: Item

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

CustomerResources

Parent: Resources
Attributes: AFPResourcesProcessingMethod, BackgroundResourcesFromSheetNameIn-
dex, BasicRotationSupportForAFPOverlays, ForegroundResourcesFromSheetNameIndex,
IncludeAlsoAllReferencedResources, TakeBackgroundResourcesFromSheetNameIndex,
TakeForegroundResourcesFromSheetNameIndex
Subelements: None

CutNegativeCoordinates

Parent: Advanced
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

DeviceSettingsForCMR

Parent: Advanced
Attributes: DeviceModel, DeviceType, ManufacturerName
Subelements: None

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

2423
19 Appendices

Ditherer

Parent: DitheringSetting
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Linearization,
Matrix, MatrixType, Size

Dithering

Parent: FormatConfig
Attributes: None
Subelements: DitheringSetting, ToneTransferCurveCMR

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: AFPIPDS, ColorFeature, Colorant, DefaultDitherer, Ditherer

DoubleByteFonts

Parent: Text
Attributes: UseDoubleByteFonts
Subelements: FontShortcuts, TextCodec, TextCodecShortcut, UploadOnlyUsedGlyphs

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

ExternalAFPFonts

Parent: Advanced
Attributes: DefaultCodePageForAFPFonts, IncludeOriginalAFPFonts, UseOriginalAFP-
Fonts
Subelements: None

ExternalResources

Parent: Resources
Attributes: ExternalResourcesWithRDW, ReuseExternalImageResources
Subelements: None

FinishingOperationItem

Parent: FinishingOperationRow
Attributes: None
Subelements: IntValue, StringValue

FinishingOperationRow

Parent: FinishingOperationTable
Attributes: None
Subelements: FinishingOperationItem

2424
 19.4 Configuration

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: FinishingOperationRow

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FontShortcut

Parent: FontShortcuts
Attributes: Name, Shortcut
Subelements: None

FontShortcut

Parent: SingleByteFontShortcuts
Attributes: Name, Shortcut
Subelements: None

FontShortcuts

Parent: DoubleByteFonts
Attributes: None
Subelements: FontShortcut

FormDef

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Advanced, ColorManagement, Dithering, General, Indexing, Misc.,
MultilevelImageProcessing, Resources, Text

FullColorImage

Parent: General
Attributes: FullColorImageFormat
Subelements: None

General

Parent: FormatConfig
Attributes: None
Subelements: AssignAFPColorsToColorants, AssignColorants2HighlightColors, As-
signHighlightColors, CMYKColorants, Color, Colorants, ColorantsType, CompressBW,
FullColorImage, Graphic, GrayscaleImage, JPEG, Resolution, SetupVerificationIDs,
UseOutlineFonts, WhiteProcessing

2425
19 Appendices

Generic

Parent: AFPIPDS
Attributes: None
Subelements: Generic

Generic

Parent: Generic
Attributes: Group, Halftone, TTC
Subelements: None

Graphic

Parent: General
Attributes: GraphicSupport
Subelements: None

GrayscaleImage

Parent: General
Attributes: ConvertToGrayscale, GrayscaleImageSupportSelection, GrayscaleImage-
SupportValue
Subelements: None

Group

Parent: MultilevelImageProcessing
Attributes: CompressionQuality, GroupIndex, ImageCompression, ImageFormat, Im-
ageIncludeType, ImagePlacement, ImageProcessing, MaxBilevelDPI, MaxBilevelD-
PITreshold, MaxColorDPITreshold, MaxDPI, MaxGrayscaleDPI, MaxGrayscaleDPITreshold,
OverlayProcessing
Subelements: None

HighlightColor

Parent: AssignColorants2HighlightColors
Attributes: ColorantName, Coverage, HighlightColor, Shading
Subelements: None

HighlightColor

Parent: AssignHighlightColors
Attributes: ColorName, Coverage, HighlightColor, Shading, SpotColor
Subelements: None

ICCProfileBinary

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ICCProfileSetting

Parent: Advanced
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,

2426
 19.4 Configuration

RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-

tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ImagesICCProfiles

Parent: Resources
Attributes: ExtractAndReferenceImagesICCProfiles
Subelements: None

IncludeObjectContainersIntoOverlays

Parent: Resources
Attributes: None
Subelements: None

Index

Parent: IndexesPagesUsingTLE
Attributes: IndexName, SheetNameIndex
Subelements: None

IndexPagesUsingTLE

Parent: Indexing
Attributes: UseIndexPagesUsingTLESelection
Subelements: None

Indexes

Parent: NOPComments
Attributes: None
Subelements: SheetNameIndex

IndexesPagesUsingTLE

Parent: Indexing
Attributes: None
Subelements: Index

Indexing

Parent: FormatConfig
Attributes: None
Subelements: CodingForPageIndexes, CreateSeparateResourceDocumentAndIndex-
ObjectFiles, CustomIndexFile, IndexPagesUsingTLE, IndexesPagesUsingTLE, Rein-
vokeMediumOptionsWithEveryPageGroup

IntValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

2427
19 Appendices

Item

Parent: CustomIndexFileItems
Attributes: IndexFileItem, IndexFileVariable
Subelements: None

ItemsSeparatorIndexFilePath

Parent: CustomIndexFile
Attributes: IndexFileItemsSeparator, IndexFilePath, ReplaceNonLatin1CharactersWith
Subelements: None

JPEG

Parent: General
Attributes: JPEGCompressionQuality
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

KnownResources

Parent: Resources
Attributes: AlwaysGenerateAllKnownResources
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

Linearization

Parent: Ditherer
Attributes: None
Subelements: None

LongSFNameSupport

Parent: Misc.
Attributes: None
Subelements: None

MapBlackColorToOCABlack

Parent: ColorManagement
Attributes: None
Subelements: None

2428
 19.4 Configuration

Matrix

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

MaximumAFPRecordLength

Parent: Advanced
Attributes: None
Subelements: None

MaximumOfPageLength

Parent: Advanced
Attributes: MaximumOfPageLengthInMetres
Subelements: None

Misc.

Parent: FormatConfig
Attributes: None
Subelements: CreateXMLSummaryFile, LongSFNameSupport, NOPComments,
RSDIndex, TakeNamedGroupNameFromSheetNameIndex, TakePageNameFromSheet-
NameIndex, XMLSummaryFileName

MultilevelImageProcessing

Parent: FormatConfig
Attributes: None
Subelements: Group

NOPComments

Parent: Misc.
Attributes: None
Subelements: Indexes, NOPDataEncoding, WriteNOPCommentsWithSheetNameData

NOPDataEncoding

Parent: NOPComments
Attributes: Codec, NOPDataEncoding
Subelements: None

ObjectContainer

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

2429
19 Appendices

OnDemandSupport

Parent: Text
Attributes: FollowNamingConvenction
Subelements: CodePageName, SingleByteFontShortcuts

OutlineFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Overlays

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

PageLevelTreshold

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: None

PageSegments

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: AFPAdvancedFinishing

PutOnlyMultipleUsedImagesIntoOverlays

Parent: Resources
Attributes: None
Subelements: None

RSDIndex

Parent: Misc.
Attributes: RSDDocumentNameSheetNameIndex, RSDFolderNameSheetNameIndex,
RSDWorkingDateSheetNameIndex, WriteRSDIndex
Subelements: None

2430
 19.4 Configuration

RasterFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

ReinvokeMediumOptionsWithEveryPageGroup

Parent: Indexing
Attributes: ReinvokeMediumOptionsWithEveryPageGroupSelection
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2431
19 Appendices

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

Resolution

Parent: General
Attributes: PrinterResolution, PrinterResolutionY
Subelements: None

ResourceNamesTransformation

Parent: Resources
Attributes: LowercaseResourceNames
Subelements: None

ResourceType

Parent: Resources
Attributes: None
Subelements: CMOCA, CodePages, CodedFonts, FormDef, ObjectContainer, Outline-
Fonts, Overlays, PageSegments, RasterFonts, TrueTypeFonts

Resources

Parent: FormatConfig
Attributes: None
Subelements: CustomerResources, ExternalResources, ImagesICCProfiles, IncludeOb-
jectContainersIntoOverlays, KnownResources, PutOnlyMultipleUsedImagesIntoOverlays,
ResourceNamesTransformation, ResourceType, ReuseBinarySameOverlays, ReuseBin-
arySameVariableImages, SupportTransparentTIFF, UseCustomerResourceName, Use-
OriginalResourcesWithoutProcessing

ReuseBinarySameOverlays

Parent: Resources
Attributes: None
Subelements: None

2432
 19.4 Configuration

ReuseBinarySameVariableImages

Parent: Resources
Attributes: None
Subelements: None

ReuseFontResources

Parent: Text
Attributes: None
Subelements: None

SetupVerificationID

Parent: SetupVerificationIDs
Attributes: ID
Subelements: None

SetupVerificationIDs

Parent: General
Attributes: None
Subelements: SetupVerificationID

SheetNameIndex

Parent: Indexes
Attributes: NOPLocation, SheetNameIndex
Subelements: None

SingleByteFontShortcuts

Parent: OnDemandSupport
Attributes: None
Subelements: FontShortcut

Size

Parent: Ditherer
Attributes: X, Y
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

2433
19 Appendices

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SpotColor

Parent: AssignAFPColorsToIndex
Attributes: AFPColor, SpotColor
Subelements: None

StringValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

SupportTransparentTIFF

Parent: Resources
Attributes: None
Subelements: None

TakeNamedGroupNameFromSheetNameIndex

Parent: Misc.
Attributes: NamedGroupNameFromSheetNameIndex, UseNamedGroupNameFrom-
SheetNameIndex
Subelements: None

TakePageNameFromSheetNameIndex

Parent: Misc.
Attributes: PageNameFromSheetNameIndex, UsePageNameFromSheetNameIndex
Subelements: None

Text

Parent: FormatConfig
Attributes: None
Subelements: AnamorphicScaleForOutlineFonts, DoubleByteFonts, OnDemandSupport,
ReuseFontResources, TrueTypeFonts

TextCodec

Parent: DoubleByteFonts
Attributes: None
Subelements: None

TextCodecShortcut

Parent: DoubleByteFonts
Attributes: None
Subelements: None

2434
 19.4 Configuration

ToneTransferCurveCMR

Parent: Dithering
Attributes: None
Subelements: None

TrueTypeFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

TrueTypeFonts

Parent: Text
Attributes: None
Subelements: None

UploadOnlyUsedGlyphs

Parent: DoubleByteFonts
Attributes: None
Subelements: None

UseCustomerResourceName

Parent: Resources
Attributes: None
Subelements: None

UseMixedColorants

Parent: ColorManagement
Attributes: None
Subelements: None

UseOriginalResourcesWithoutProcessing

Parent: Resources
Attributes: ConvertOriginalPDFImage, SuppressNativeLoadingOfImages, UseOriginalEP-
SImageDataWithoutProcessing, UseOriginalIOCAImageDataWithoutProcessing, Use-
OriginalJPEGImageDataWithoutProcessing, UseOriginalPDFImageDataWithoutPro-
cessing, UseOriginalPNGImageDataWithoutProcessing, UseOriginalTIFIm-
ageDataWithoutProcessing
Subelements: None

UseOutlineFonts

Parent: General
Attributes: UseOutlineFonts
Subelements: None

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

2435
19 Appendices

WhiteProcessing

Parent: General
Attributes: WhiteColorProcessing
Subelements: None

WriteNOPCommentsWithSheetNameData

Parent: NOPComments
Attributes: WriteNOPCommentsWithSheetNameDataSelection
Subelements: None

XMLSummaryFileName

Parent: Misc.
Attributes: None
Subelements: None

19.4.5.5 <Engine EngineType="CreoVPS">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the CreoVPS engine dialog descrip-
tion.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AdvancedFinishing

Parent: PPDSettings
Attributes: None
Subelements: FinishingOperations

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, ImageFormat, Images, PJLCommands, VpsSettings

2436
 19.4 Configuration

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

BMP

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

BookletSplitting

Parent: VpsSettings
Attributes: CountOfSheets, Split
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

CachedVIElements

Parent: VpsSettings
Attributes: Generate, UserName
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

2437
19 Appendices

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Constraint

Parent: Constraints
Attributes: name, name1, name2, option1, option2
Subelements: None

Constraints

Parent: PPD
Attributes: None
Subelements: Constraint

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

CorrectionOfInlineElements

Parent: VpsSettings
Attributes: TresholdValue, UseTresholdValueOfGroupObjects
Subelements: None

CreateImages

Parent: Images
Attributes: CreateInto, Dir
Subelements: None

CustomPageSizeParam

Parent: CustomPageSizeParams
Attributes: MaxValue, MinValue, Name, Option, Order, TransformName, Units
Subelements: None

CustomPageSizeParams

Parent: PpdStructure
Attributes: None
Subelements: CustomPageSizeParam

2438
 19.4 Configuration

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength
Subelements: None

Data

Parent: Validator
Attributes: None
Subelements: Root

DefaultQueries

Parent: PpdStructure
Attributes: None
Subelements: DefaultQuery

DefaultQuery

Parent: DefaultQueries
Attributes: Name, Value
Subelements: None

DefaultValue

Parent: DefaultValues
Attributes: Name, Value
Subelements: None

DefaultValues

Parent: PpdStructure
Attributes: None
Subelements: DefaultValue

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EPS

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

2439
19 Appendices

Element

Parent: Root
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, MaximumOfPageLengthInMetres
Subelements: ICCProfile, ResizeBarcodes

Feature

Parent: UIFeatures
Attributes: Id
Subelements: UIGroup

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: None

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

2440
 19.4 Configuration

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, FontEncoding, Maximal-
CountOfSingleByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, PsOutputOption

FullView

Parent: PPDSettings
Attributes: None
Subelements: GlobalValues, UserInterfaces

GlobalValues

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageFormat

Parent: AdvancedSettings
Attributes: None
Subelements: ImageTypeConversion

2441
19 Appendices

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

ImageTypeConversion

Parent: ImageFormat
Attributes: ConvertUnsupportedImagesTypeInto, JPGCompressionQuality, MakeSim-
plePdfPages, SuppressNativeLoading
Subelements: ImagesSupportByPrinter

Images

Parent: AdvancedSettings
Attributes: ImageBufferSize, ImageColorSpace, ImageNamePattern, ImagesRenderDPI,
PutTransparentMonochromaticImagesIntoFonts, ReplacePatternByClippingPath,
UseCachedImages, UseOriginalEps, UseOriginalImages, UseOriginalPdf
Subelements: CreateImages, ImageFilters

ImagesSupportByPrinter

Parent: ImageTypeConversion
Attributes: None
Subelements: BMP, EPS, JPG, PCX, PDF, TIF

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

Item

Parent: PpdItems
Attributes: Conflict, PpdKey, SelectedOption, TranslatedPpdKey, TranslatedSelected-
Option
Subelements: None

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

2442
 19.4 Configuration

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JPG

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JobPatchFiles

Parent: PpdStructure
Attributes: None
Subelements: None

JobUniqueEementNames

Parent: VpsSettings
Attributes: Generate
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Key

Parent: Keys
Attributes: Name, Option, TransformOption, TransformValue, Value
Subelements: None

Keys

Parent: PpdStructure
Attributes: None
Subelements: Key

2443
19 Appendices

Keys

Parent: UIGroup
Attributes: None
Subelements: Key

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

OnFinishDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize
Subelements: PpdItems

OnStartDocument

Parent: PPDSettings
Attributes: ShowOnlyUsedPpdKeys, UseCustomPageSize, UseJCLCommands
Subelements: PpdItems

OrderDependencies

Parent: PpdStructure
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PCX

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

2444
 19.4 Configuration

PDF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

PJLCommands

Parent: AdvancedSettings
Attributes: EndPJLCommands, IncludePJLCommand, StartPJLCommands
Subelements: None

PPD

Parent: PPDSettings
Attributes: JCLBegin, JCLEnd, JCLInterpreter, ModelName
Subelements: Constraints, PpdStructure, UIFeatures

PPDSettings

Parent: PrinterConfig
Attributes: CreatePPD, IncludePPDCommandsToSpoolOnlyOnChange, ShowTransla-
tionValues
Subelements: AdvancedFinishing, FullView, OnFinishDocument, OnStartDocument,
PPD

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PpdItems

Parent: OnFinishDocument
Attributes: None
Subelements: Item

PpdItems

Parent: OnStartDocument
Attributes: None
Subelements: Item

PpdStructure

Parent: PPD
Attributes: Name, TransformName
Subelements: CustomPageSizeParams, DefaultQueries, DefaultValues, JobPatchFiles,
Keys, OrderDependencies, SubGroups

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: JDFConfig, PPDSettings

2445
19 Appendices

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

PsOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

2446
 19.4 Configuration

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

2447
19 Appendices

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

SubGroups

Parent: PpdStructure
Attributes: None
Subelements: None

2448
 19.4 Configuration

TIF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

UIFeatures

Parent: PPD
Attributes: None
Subelements: Feature

UIGroup

Parent: Feature
Attributes: DefaultOption, Name, OrderDependencyOption, OrderDependencyOrder,
OrderDependencySection, QueryValue, Section, TransformName, UIType
Subelements: Keys

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

UserInterfaces

Parent: FullView
Attributes: CollapseAllNodes
Subelements: None

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

VpsSettings

Parent: AdvancedSettings
Attributes: CreateIccBasedColorSpaceResources, SpoolFileCompression, UseIccBased-
ColorSpaces, UseOverlays, UseSeparationColorSpaces
Subelements: BookletSplitting, CachedVIElements, CorrectionOfInlineElements,
JobUniqueEementNames

2449
19 Appendices

19.4.5.6 <Engine EngineType="DesktopPrinter">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Desktop Printer engine dialog
description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

AutoFitType

Parent: FormatConfig
Attributes: None
Subelements: None

ColorSpace

Parent: FormatConfig
Attributes: None
Subelements: None

DPI

Parent: FormatConfig
Attributes: X, Y
Subelements: None

DocumentProperties

Parent: DriverConfig
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: DocumentProperties, JobDescriptionName, JobName, PrinterName,
ShouldSplit, ShouldSplitBySize, SplitAtSize, Spool2File, VariablePrinter, VariablePrint-
erString

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AutoFitType, ColorSpace, DPI

JobDescriptionName

Parent: DriverConfig
Attributes: None
Subelements: None

2450
 19.4 Configuration

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

PrinterName

Parent: DriverConfig
Attributes: None
Subelements: None

ShouldSplit

Parent: DriverConfig
Attributes: None
Subelements: None

ShouldSplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitAtSize

Parent: DriverConfig
Attributes: None
Subelements: None

Spool2File

Parent: DriverConfig
Attributes: None
Subelements: None

VariablePrinter

Parent: DriverConfig
Attributes: None
Subelements: None

VariablePrinterString

Parent: DriverConfig
Attributes: None
Subelements: None

19.4.5.7 <Engine EngineType="Docx">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Docx engine dialog description.

2451
19 Appendices

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, FormatConfigBinary

AddObjectsToLastPage

Parent: FormatConfig
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EmbeddingFont

Parent: FormatConfig
Attributes: None
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AddObjectsToLastPage, EmbeddingFont, HeaderFooterSupport,
MergeWithTemplate, OutputType, ProtectDocument, TemplateLocation

FormatConfigBinary

Parent: Engine
Attributes: Name
Subelements: None

HeaderFooterSupport

Parent: FormatConfig
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

2452
 19.4 Configuration

MergeWithTemplate

Parent: FormatConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputType

Parent: FormatConfig
Attributes: None
Subelements: None

ProtectDocument

Parent: FormatConfig
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

TemplateLocation

Parent: FormatConfig
Attributes: None
Subelements: None

19.4.5.8 <Engine EngineType="HP PPML">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the HP PPML engine dialog descrip-
tion.

2453
19 Appendices

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, ImageFormat, Images, PPMLSettings, VIElements

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

BMP

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

2454
 19.4 Configuration

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

CachedVIElements

Parent: VIElements
Attributes: Generate, UserName
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Conformance

Parent: PPMLSettings
Attributes: SubsetGA
Subelements: None

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

CorrectionOfInlineElements

Parent: VIElements
Attributes: TresholdValue, UseTresholdValueOfGroupObjects
Subelements: None

CreateImages

Parent: Images
Attributes: CreateInto, Dir
Subelements: None

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength, UseBackSlash
Subelements: None

2455
19 Appendices

Data

Parent: Validator
Attributes: None
Subelements: Root

DefinedFonts

Parent: Fonts
Attributes: None
Subelements: Font

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DocumentSplitting

Parent: PPMLSettings
Attributes: CountOfSheets, ResetPageCounter, ResetSplitConter, Split
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EPS

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

Element

Parent: Root
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

2456
 19.4 Configuration

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, CopyAllFilesToRightDirOnFinishAtOnce,
MaximumOfPageLengthInMetres, ZipAllFiles
Subelements: ICCProfile, ResizeBarcodes

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

Font

Parent: DefinedFonts
Attributes: PrintNetTFont, RIPFont
Subelements: None

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, FontEncoding, Maximal-
CountOfSingleByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

Fonts

Parent: PrinterConfig
Attributes: DefaultFontName
Subelements: DefinedFonts

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, PsOutputOption

GlobalCache

Parent: VIElements
Attributes: AddImages, AddOverlays
Subelements: None

2457
19 Appendices

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageFormat

Parent: AdvancedSettings
Attributes: ConvertUnsupportedImagesTypeInto, JPGCompressionQuality, Location-
Prefix, MakeSimplePdfPages, SuppressNativeLoading, UseCachedImages, UseOrigin-
alPDF, UseUserDefinedImagePrefix
Subelements: ImagesSupportByPrinter

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

Images

Parent: AdvancedSettings
Attributes: ImageBufferSize, ImageColorSpace, ImagesRenderDPI, NativePdfImagesIn-
ternally
Subelements: CreateImages, ImageFilters, Patterns

ImagesSupportByPrinter

Parent: ImageFormat
Attributes: None
Subelements: BMP, EPS, JPG, PCX, PDF, TIFF

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

2458
 19.4 Configuration

Impositioning

Parent: PrinterConfig
Attributes: CustomCommand, DeclareItInDocument, SelectedCommand, UseGlob-
alImpositioning, UsePredefinedCommand
Subelements: None

InternalDataEncoding

Parent: PPMLSettings
Attributes: UseBase64OnPsCommand, UseBase64OnSvgCommand
Subelements: None

InternalOrExternalFontResources

Parent: PPMLSettings
Attributes: ExternalDir, IsExternalDirSameAsSpool, LocationPrefix, UseInternalData
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JPG

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

JobLabel

Parent: PPMLSettings
Attributes: IsUserDefined, Text
Subelements: None

2459
19 Appendices

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JobUniqueElementNames

Parent: VIElements
Attributes: Generate
Subelements: None

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OverwriteCache

Parent: VIElements
Attributes: Images, Overlays
Subelements: None

PCX

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

PDF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

2460
 19.4 Configuration

PPMLSettings

Parent: AdvancedSettings
Attributes: CreateIccBasedColorSpaceResources, UseIccBasedColorSpaces, UseOverlays,
UseProcset, UseSeparationColorSpaces
Subelements: Conformance, DocumentSplitting, InternalDataEncoding, InternalOrEx-
ternalFontResources, JobLabel, PageDescriptionLanguage

PageDescriptionLanguage

Parent: PPMLSettings
Attributes: EnlargeBoundingBox, EnlargeValue, UseSVG
Subelements: None

PageMedia

Parent: PrinterConfig
Attributes: CreateMediaResources, CreateToDirAsSpoolFile, ExternalDirectory
Subelements: None

Patterns

Parent: Images
Attributes: ReplacePatternByClippingPath, UseInlinePatternsInOverlays, UseInlinePat-
ternsInPages
Subelements: None

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: Fonts, Impositioning, JDFConfig, PageMedia

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

2461
19 Appendices

PsOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles, PPMLVersion
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

2462
 19.4 Configuration

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

2463
19 Appendices

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

TIFF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

VIElements

Parent: AdvancedSettings
Attributes: None
Subelements: CachedVIElements, CorrectionOfInlineElements, GlobalCache, JobU-
niqueElementNames, OverwriteCache

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

2464
 19.4 Configuration

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

19.4.5.9 <Engine EngineType="HTML">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the HTML engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, FormatConfigBinary

Catalogue

Parent: FormatConfig
Attributes: Generate, GenerateThumbs, PlaceThumbsInOneRow, PrimaryColor, Tem-
plateIndex, ThumbsInRow, Title
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

Font

Parent: Rasterize
Attributes: FontName
Subelements: None

Font

Parent: Support
Attributes: FontName
Subelements: None

2465
19 Appendices

Fonts

Parent: FormatConfig
Attributes: Rasterize, SupportAll
Subelements: Rasterize, Support

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Catalogue, Fonts, General, Images, Other, UserData

FormatConfigBinary

Parent: Engine
Attributes: Name
Subelements: None

General

Parent: FormatConfig
Attributes: BackgroundColor, BackgroundImage, CenterDocument, Codec, CreateEx-
ternalCSS, DownloadEmbeddedObjects, GenerationMode, Gradient, KeepWordsTo-
gether, PageSpacing, RasterizeFlows, ThreadCount
Subelements: None

Group

Parent: HandlingGroups
Attributes: ID, ImagePath, ImagePrefix
Subelements: None

HandlingGroups

Parent: Images
Attributes: ApplyOnImages
Subelements: Group

Images

Parent: FormatConfig
Attributes: GenerateImages, ImagePath, ImagePath2, ImagePrefix, ImagePrefix2,
SupportGIF, SupportJPG, SupportPNG, Treshold, UsedHandlingGroups
Subelements: HandlingGroups

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

Other

Parent: FormatConfig
Attributes: BarcodeDPI, GradientDPI, ImageDPI, ShapeDPI, TextDPI, ViewerDPI
Subelements: None

2466
 19.4 Configuration

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Rasterize

Parent: Fonts
Attributes: None
Subelements: Font

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

Support

Parent: Fonts
Attributes: None
Subelements: Font

UserData

Parent: FormatConfig
Attributes: UseUserHTMLText, UserHTMLText
Subelements: None

19.4.5.10 <Engine EngineType="HTML Simple">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the HTML Simple engine dialog
description.

2467
19 Appendices

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

ConvertUnsupportedInto

Parent: Images
Attributes: None
Subelements: None

CreateExternalCSS

Parent: General
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

FormatConfig

Parent: Engine
Attributes: Name
Subelements: General, Images

General

Parent: FormatConfig
Attributes: None
Subelements: CreateExternalCSS, IgnoreTabelWidths, TextCodec

GenerateImages

Parent: Images
Attributes: None
Subelements: None

IgnoreTabelWidths

Parent: General
Attributes: None
Subelements: None

2468
 19.4 Configuration

ImageOutputPath

Parent: Images
Attributes: None
Subelements: None

ImagePrefix

Parent: Images
Attributes: None
Subelements: None

Images

Parent: FormatConfig
Attributes: None
Subelements: ConvertUnsupportedInto, GenerateImages, ImageOutputPath, Image-
Prefix, JPGQuality, OutputResolution, ResizeImagesToOutputResolution, SupportGIF,
SupportJPG, SupportPNG, UseOriginalGIF, UseOriginalJPG, UseOriginalPNG

JPGQuality

Parent: Images
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputResolution

Parent: Images
Attributes: None
Subelements: None

ResizeImagesToOutputResolution

Parent: Images
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

2469
19 Appendices

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SupportGIF

Parent: Images
Attributes: None
Subelements: None

SupportJPG

Parent: Images
Attributes: None
Subelements: None

SupportPNG

Parent: Images
Attributes: None
Subelements: None

TextCodec

Parent: General
Attributes: None
Subelements: None

UseOriginalGIF

Parent: Images
Attributes: None
Subelements: None

UseOriginalJPG

Parent: Images
Attributes: None
Subelements: None

UseOriginalPNG

Parent: Images
Attributes: None
Subelements: None

2470
 19.4 Configuration

19.4.5.11 <Engine EngineType="IJPDS">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the IJPDS engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

AdditionalInfo

Parent: Advanced
Attributes: AdditionalInfo, EncodingForAdditionalInfo, PutAdditionalInfoIntoSpoolFile,
ShowAdditionalInfoOnTheController
Subelements: None

Advanced

Parent: FormatConfig
Attributes: None
Subelements: AdditionalInfo, CroppingOfSheet, DPIForPDFEPS, EBCDICConversion,
NativeLoadingOfImages, ResizeBarcodes, UserOutputSignal, VariableCueInterval

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

2471
19 Appendices

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

BySheetCount

Parent: StopCommand
Attributes: Count
Subelements: None

BySheetNameChange

Parent: StopCommand
Attributes: SheetNameIndex
Subelements: None

BySheetNameCondition

Parent: StopCommand
Attributes: NameIsEqualTo, SheetNameIndex
Subelements: None

Color

Parent: Printer
Attributes: None
Subelements: None

ColorFeature

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: None

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Compression

Parent: PrinterGroupForPageSide
Attributes: FontCompression, ImageCompression
Subelements: None

2472
 19.4 Configuration

Compression

Parent: Resources
Attributes: UseCompressionForFont, UseCompressionForPictures
Subelements: None

CroppingOfSheet

Parent: Advanced
Attributes: CropOfSheet
Subelements: None

CuePage

Parent: CuePages
Attributes: LengthOfPage
Subelements: None

CuePages

Parent: FormatConfig
Attributes: ApplyOnOneSheet, CropBottomOfPage, PageCommand
Subelements: CuePage

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DPIForPDFEPS

Parent: Advanced
Attributes: DPIForPDFEPSX, DPIForPDFEPSY, UseTheHighestDPIOfUsedRIPs
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

2473
19 Appendices

Ditherer

Parent: DitheringSetting
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Linearization,
MatrixType

Dithering

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: DitheringSetting

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: ColorFeature, DefaultDitherer, Ditherer

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EBCDICConversion

Parent: Advanced
Attributes: ReplaceNonEBCDICCharactersWith
Subelements: None

Encoding

Parent: FontOptions
Attributes: DoNotCorrectCharacterPositionsInsideWords, EncodingName, TextEncoding,
UseOnlyForFontsMarkedForEncodingInLayout
Subelements: None

Encoding

Parent: TextOptions
Attributes: DoNotCorrectCharacterPositionsInsideWords, EncodingName, TextEncoding
Subelements: None

FileSplitting

Parent: General
Attributes: AllowSplittingOfResources, FillBlankPages, FixedResources, SizeOfFileSplit-
ting, SplitFileBy, UseFileSplitting
Subelements: None

FollowPoint

Parent: FontOptions
Attributes: AlwaysRoundDownFollowPoint
Subelements: None

2474
 19.4 Configuration

FollowPoint

Parent: TextOptions
Attributes: AlwaysRoundDownFollowPoint
Subelements: None

FontOptions

Parent: FormatConfig
Attributes: None
Subelements: Encoding, FollowPoint, ResizeBarcodes, Warnings

FontSetting

Parent: PrinterGroupForPageSide
Attributes: FontType, SuperFont, SuperFontOnlyForOverlay
Subelements: None

FontStoring

Parent: PrinterGroupForPageSide
Attributes: DoNotDivideGlyph
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Advanced, CuePages, FontOptions, General, ICCProfile, PhysicalRIPs,
Printers, Resources, SmallConfig, StopCommand, TextOptions

General

Parent: FormatConfig
Attributes: None
Subelements: FileSplitting, IndexFiles, SpoolFileFormat

ICCProfile

Parent: FormatConfig
Attributes: None
Subelements: ICCProfileSetting

ICCProfileBinary

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ICCProfileSetting

Parent: ICCProfile
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

2475
19 Appendices

IndexFiles

Parent: General
Attributes: CreateIndexFile, OldScheme
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

Linearization

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

NativeLoadingOfImages

Parent: Advanced
Attributes: SuppressNativeLoadingOfImages
Subelements: None

NumberOfDrops

Parent: PhysicalRIP
Attributes: None
Subelements: None

NumberOfJets

Parent: PhysicalRIP
Attributes: None
Subelements: None

Other

Parent: Resources
Attributes: CreateFixedResourceSet, DoNotUseExtraWhiteProcessing, MergeStaticOb-
jectsIntoSingleOverlay, SizeOptimization, UseFixedFiles, UseFontsForGraphics,
UseTempFiles
Subelements: None

2476
 19.4 Configuration

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OverlaySetting

Parent: Resources
Attributes: LoadOverlayAsFont, OptimizeOverlayFontSize, OverlayGlyphHeight, Over-
layGlyphWidth
Subelements: None

PLRCommand

Parent: PrinterGroupForPageSide
Attributes: SuppressPLRCommand
Subelements: None

Page

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: None

PageBufferLength

Parent: PrinterGroupForPageSide
Attributes: ForbidLongerMedia, PageBufferLength
Subelements: None

PageSide

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: None

PhysicalHead

Parent: UsedPhysicalHeads
Attributes: Head, Position, RIP, Stitched
Subelements: None

PhysicalRIP

Parent: PhysicalRIPs
Attributes: None
Subelements: NumberOfDrops, NumberOfJets, RIP, RIPType

PhysicalRIPs

Parent: FormatConfig
Attributes: None
Subelements: PhysicalRIP

2477
19 Appendices

Printer

Parent: PrinterGroup
Attributes: None
Subelements: Color, UsedPhysicalHeads

PrinterGroup

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: Printer

PrinterGroupForPageSide

Parent: Printers
Attributes: None
Subelements: ColorFeature, Compression, Dithering, FontSetting, FontStoring,
PLRCommand, Page, PageBufferLength, PageSide, PrinterGroup, ResolutionX, Resol-
utionY, SheetOffset, Trapping, WhiteProcessing

Printers

Parent: FormatConfig
Attributes: PartialOverlappingOfHeads, RIPSplitting, RIPStitching
Subelements: PrinterGroupForPageSide

RIP

Parent: PhysicalRIP
Attributes: None
Subelements: None

RIPType

Parent: PhysicalRIP
Attributes: None
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2478
 19.4 Configuration

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

2479
19 Appendices

ResizeBarcodes

Parent: FontOptions
Attributes: None
Subelements: Absolute, AlignType, Relative

ResolutionX

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: None

ResolutionY

Parent: PrinterGroupForPageSide
Attributes: None
Subelements: None

Resources

Parent: FormatConfig
Attributes: None
Subelements: Compression, Other, OverlaySetting

SheetOffset

Parent: PrinterGroupForPageSide
Attributes: StartWithEmptySheets
Subelements: None

SmallConfig

Parent: FormatConfig
Attributes: ContinuousDocumentNumbering, InitialDocumentNumber
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

2480
 19.4 Configuration

SpoolFileFormat

Parent: General
Attributes: BlockSize, Format, MaxSDCPerBlock
Subelements: None

StopCommand

Parent: FormatConfig
Attributes: PutStopCommand
Subelements: BySheetCount, BySheetNameChange, BySheetNameCondition, Stop-
CommandMessage

StopCommandMessage

Parent: StopCommand
Attributes: PutMessage, SheetNameIndex
Subelements: None

TextOptions

Parent: FormatConfig
Attributes: None
Subelements: Encoding, FollowPoint

Trapping

Parent: PrinterGroupForPageSide
Attributes: SizeOfBitmapTrapping, SizeOfFontTrapping, UseTrapping
Subelements: None

UsedPhysicalHeads

Parent: Printer
Attributes: None
Subelements: PhysicalHead

UserOutputSignal

Parent: Advanced
Attributes: SheetNameIndex, UseCalculatedOutputSignal, UseSheetNameValueForOut-
putSignal, UseUserOutpuSignal
Subelements: None

VariableCueInterval

Parent: Advanced
Attributes: UserDefined, VariableCueInterval
Subelements: None

2481
19 Appendices

Warnings

Parent: FontOptions
Attributes: LogWarningIfNumberOfFontsExceeds
Subelements: None

WhiteProcessing

Parent: PrinterGroupForPageSide
Attributes: UseNeverForBlackPrinter, WhiteProcessing
Subelements: None

19.4.5.12 <Engine EngineType="Image">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Image engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

BlackAndWhite

Parent: FormatConfig
Attributes: None
Subelements: None

ColorType

Parent: FormatConfig
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

DPI

Parent: FormatConfig
Attributes: X, Y
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

2482
 19.4 Configuration

FormatConfig

Parent: Engine
Attributes: Name
Subelements: BlackAndWhite, ColorType, DPI, HighlightVariables, ImageStreamerType,
Interlace, Quality

HighlightVariables

Parent: FormatConfig
Attributes: None
Subelements: None

ImageStreamerType

Parent: FormatConfig
Attributes: None
Subelements: None

Interlace

Parent: FormatConfig
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Quality

Parent: FormatConfig
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

2483
19 Appendices

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

19.4.5.13 <Engine EngineType="IPDS">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the IPDS engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig, PrinterConfigBinary

A-twinPrinter

Parent: General
Attributes: None
Subelements: None

AFPIPDS

Parent: DitheringSetting
Attributes: None
Subelements: Generic

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Advanced

Parent: FormatConfig
Attributes: None
Subelements: AllowAnamorphicScaling, DeviceModel, DeviceType, ExtractAndRefer-
enceImageICCProfile, LoadAllFontsAsMICR, ManufacturerName, MaximumPageLength,
MergeStaticObjectsToOverlay, PauseJobAfterPage, PreferIOImageForObjectContainers,
PreferObjectContainers, PreloadResources, ResetCMT, ResizeBarcodes, TextCodec-
ForUploadFullFonts, UploadFullFonts, UseOriginalIocaImageDataWithoutProcessing,
UseOriginalJpegImageDataWithoutProcessing, UseOriginalTifImageDataWithoutPro-
cessing, UseOutlineFonts, UsedFontsForGraphic

2484
 19.4 Configuration

AdvancedFinishing

Parent: IPDSAdvancedFinishing
Attributes: None
Subelements: FinishingOperations

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AllowAnamorphicScaling

Parent: Advanced
Attributes: None
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

ApplyFinishing

Parent: IPDSAdvancedFinishing
Attributes: None
Subelements: None

AssignHighlightToOCA

Parent: General
Attributes: None
Subelements: HighlightColor

AssignIPDSColorsToIndex

Parent: General
Attributes: None
Subelements: SpotColor

AttachICCProfile

Parent: ICCProfile
Attributes: None
Subelements: None

Atwin-BackPrinter

Parent: DriverConfig
Attributes: None
Subelements: DrainingLength, IPPort, PageBuffer, TCPaddress

2485
19 Appendices

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

CMYKColorant

Parent: CMYKColorants
Attributes: ColorantName, Coverage, HighlightColor, IPDSColor, Shading
Subelements: None

CMYKColorants

Parent: General
Attributes: None
Subelements: CMYKColorant

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

ColorSpaceForTextAndGraphic

Parent: General
Attributes: None
Subelements: None

Colorant

Parent: DitheringSetting
Attributes: None
Subelements: None

Common

Parent: General
Attributes: None
Subelements: DiscardBufferedDataAfterConnected

Compression

Parent: General
Attributes: None
Subelements: None

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

2486
 19.4 Configuration

ConvertToGrayscale

Parent: GrayscaleImage
Attributes: None
Subelements: None

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

DeviceModel

Parent: Advanced
Attributes: None
Subelements: None

DeviceType

Parent: Advanced
Attributes: None
Subelements: None

DiscardBufferedDataAfterConnected

Parent: Common
Attributes: None
Subelements: None

DiscardBufferedDataAfterStop

Parent: General
Attributes: None
Subelements: None

DiscardBufferedDataAfterStopEnhanced

Parent: General
Attributes: None
Subelements: None

2487
19 Appendices

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

Ditherer

Parent: DitheringSetting
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Linearization,
Matrix, MatrixType, Size

Dithering

Parent: FormatConfig
Attributes: None
Subelements: DitheringSetting, LetPrinterApplyLUT, ShowDitheringForDpi

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: AFPIPDS, ColorFeature, Colorant, DefaultDitherer, Ditherer

DoubleByteFonts

Parent: General
Attributes: None
Subelements: None

DrainingLength

Parent: Atwin-BackPrinter
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Atwin-BackPrinter, Exceptions, General

EnablePageLog

Parent: Indexing
Attributes: None
Subelements: None

Exception

Parent: ExceptionsSetting
Attributes: AutoRest, IPDSExcId, Level, UserDef
Subelements: None

2488
 19.4 Configuration

Exceptions

Parent: DriverConfig
Attributes: None
Subelements: ExceptionsSetting

ExceptionsSetting

Parent: Exceptions
Attributes: None
Subelements: Exception

ExtractAndReferenceImageICCProfile

Parent: Advanced
Attributes: None
Subelements: None

FileName

Parent: Indexing
Attributes: None
Subelements: None

FinishingOperationItem

Parent: FinishingOperationRow
Attributes: None
Subelements: IntValue, StringValue

FinishingOperationRow

Parent: FinishingOperationTable
Attributes: None
Subelements: FinishingOperationItem

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: FinishingOperationRow

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Advanced, Dithering, General, ICCProfile, Indexing, MultilevelImagePro-
cessing

2489
19 Appendices

FullColorImageFormat

Parent: General
Attributes: None
Subelements: None

General

Parent: DriverConfig
Attributes: None
Subelements: A-twinPrinter, Common, DiscardBufferedDataAfterStop, DiscardBuf-
feredDataAfterStopEnhanced, IPPort, OutputFile, PageBuffer, PrinterType, SendPagesOn-
ceCommitted, SplitFile, StartWithPurge, TCPaddress, TraceEnabled, TraceFilename

General

Parent: FormatConfig
Attributes: None
Subelements: AssignHighlightToOCA, AssignIPDSColorsToIndex, CMYKColorants,
ColorSpaceForTextAndGraphic, Compression, DoubleByteFonts, FullColorImageFormat,
GraphicsSupport, GrayscaleImage, HiglightException, JogPageCountAOS, Max-
FontsCount, MaxIpdsDataSizeInKB, MaxOverlaysCount, MaxPageSegmentsCount,
OutputColors, PagesPerAcknowledge, PrinterResolutionForPositioning, ReportAllOther,
ReportPrintOutsitePage, ReportUndefinedCharacters, ResolutionForFontsImages, Re-
startSeparatorPagesCount, Sections0x410x44only, SplitOverlaysForNipson, StackRe-
ceivedPages, UseIOImageCmd, UseRelativeMetricPrefered, WhiteColorProcessing

Generic

Parent: AFPIPDS
Attributes: None
Subelements: Generic

Generic

Parent: Generic
Attributes: Group, Halftone, TTC
Subelements: None

GraphicsSupport

Parent: General
Attributes: None
Subelements: None

GrayscaleFormat

Parent: GrayscaleImage
Attributes: None
Subelements: None

GrayscaleImage

Parent: General
Attributes: None
Subelements: ConvertToGrayscale, GrayscaleFormat, GrayscaleImageSupportAllowed,
JpegCompressionQuality

2490
 19.4 Configuration

GrayscaleImageSupportAllowed

Parent: GrayscaleImage
Attributes: None
Subelements: None

Group

Parent: MultilevelImageProcessing
Attributes: CompressionQuality, GroupIndex, ImageCompression, ImagePreprocessing,
ImageProcessing, MaxDPI
Subelements: None

HighlightColor

Parent: AssignHighlightToOCA
Attributes: Coverage, HighlightColor, Shading, SpotColor
Subelements: None

HiglightException

Parent: General
Attributes: None
Subelements: None

ICCProfile

Parent: FormatConfig
Attributes: None
Subelements: AttachICCProfile, ICCProfileSetting, IgnoreCMYKICCProfilesForGroups,
MapBlackColorToOCABlack, UseColorantCombinations

ICCProfileBinary

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ICCProfileSetting

Parent: ICCProfile
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

IPDSAdvancedFinishing

Parent: PrinterConfig
Attributes: None
Subelements: AdvancedFinishing, ApplyFinishing, PageLevelTreshold

2491
19 Appendices

IPPort

Parent: Atwin-BackPrinter
Attributes: None
Subelements: None

IPPort

Parent: General
Attributes: None
Subelements: None

IgnoreCMYKICCProfilesForGroups

Parent: ICCProfile
Attributes: None
Subelements: None

Indexing

Parent: FormatConfig
Attributes: None
Subelements: EnablePageLog, FileName, SheetNamesCount, UpdateAfter

IntValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

JogPageCountAOS

Parent: General
Attributes: None
Subelements: None

JpegCompressionQuality

Parent: GrayscaleImage
Attributes: None
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

LetPrinterApplyLUT

Parent: Dithering
Attributes: None
Subelements: None

2492
 19.4 Configuration

Linearization

Parent: Ditherer
Attributes: None
Subelements: None

LoadAllFontsAsMICR

Parent: Advanced
Attributes: None
Subelements: None

ManufacturerName

Parent: Advanced
Attributes: None
Subelements: None

MapBlackColorToOCABlack

Parent: ICCProfile
Attributes: None
Subelements: None

Matrix

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

MaxFontsCount

Parent: General
Attributes: None
Subelements: None

MaxIpdsDataSizeInKB

Parent: General
Attributes: None
Subelements: None

MaxOverlaysCount

Parent: General
Attributes: None
Subelements: None

2493
19 Appendices

MaxPageSegmentsCount

Parent: General
Attributes: None
Subelements: None

MaximumPageLength

Parent: Advanced
Attributes: None
Subelements: None

MergeStaticObjectsToOverlay

Parent: Advanced
Attributes: None
Subelements: None

MultilevelImageProcessing

Parent: FormatConfig
Attributes: None
Subelements: Group

OutputColors

Parent: General
Attributes: None
Subelements: None

OutputFile

Parent: General
Attributes: None
Subelements: None

PageBuffer

Parent: Atwin-BackPrinter
Attributes: None
Subelements: None

PageBuffer

Parent: General
Attributes: None
Subelements: None

PageLevelTreshold

Parent: IPDSAdvancedFinishing
Attributes: None
Subelements: None

2494
 19.4 Configuration

PagesPerAcknowledge

Parent: General
Attributes: None
Subelements: None

PauseJobAfterPage

Parent: Advanced
Attributes: None
Subelements: None

PreferIOImageForObjectContainers

Parent: Advanced
Attributes: None
Subelements: None

PreferObjectContainers

Parent: Advanced
Attributes: None
Subelements: None

PreloadResources

Parent: Advanced
Attributes: None
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: IPDSAdvancedFinishing

PrinterConfigBinary

Parent: Engine
Attributes: Name
Subelements: None

PrinterResolutionForPositioning

Parent: General
Attributes: None
Subelements: None

PrinterType

Parent: General
Attributes: None
Subelements: None

2495
19 Appendices

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2496
 19.4 Configuration

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ReportAllOther

Parent: General
Attributes: None
Subelements: None

ReportPrintOutsitePage

Parent: General
Attributes: None
Subelements: None

ReportUndefinedCharacters

Parent: General
Attributes: None
Subelements: None

ResetCMT

Parent: Advanced
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

ResolutionForFontsImages

Parent: General
Attributes: None
Subelements: None

RestartSeparatorPagesCount

Parent: General
Attributes: None
Subelements: None

Sections0x410x44only

Parent: General
Attributes: None
Subelements: None

2497
19 Appendices

SendPagesOnceCommitted

Parent: General
Attributes: None
Subelements: None

SheetNamesCount

Parent: Indexing
Attributes: None
Subelements: None

ShowDitheringForDpi

Parent: Dithering
Attributes: None
Subelements: None

Size

Parent: Ditherer
Attributes: X, Y
Subelements: None

SplitFile

Parent: General
Attributes: None
Subelements: None

SplitOverlaysForNipson

Parent: General
Attributes: None
Subelements: None

SpotColor

Parent: AssignIPDSColorsToIndex
Attributes: IPDSColor, SpotColor
Subelements: None

StackReceivedPages

Parent: General
Attributes: None
Subelements: None

StartWithPurge

Parent: General
Attributes: None
Subelements: None

2498
 19.4 Configuration

StringValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

TCPaddress

Parent: Atwin-BackPrinter
Attributes: None
Subelements: None

TCPaddress

Parent: General
Attributes: xml:space
Subelements: None

TextCodecForUploadFullFonts

Parent: Advanced
Attributes: None
Subelements: None

TraceEnabled

Parent: General
Attributes: None
Subelements: None

TraceFilename

Parent: General
Attributes: None
Subelements: None

UpdateAfter

Parent: Indexing
Attributes: None
Subelements: None

UploadFullFonts

Parent: Advanced
Attributes: None
Subelements: None

UseColorantCombinations

Parent: ICCProfile
Attributes: None
Subelements: None

2499
19 Appendices

UseIOImageCmd

Parent: General
Attributes: None
Subelements: None

UseOriginalIocaImageDataWithoutProcessing

Parent: Advanced
Attributes: None
Subelements: None

UseOriginalJpegImageDataWithoutProcessing

Parent: Advanced
Attributes: None
Subelements: None

UseOriginalTifImageDataWithoutProcessing

Parent: Advanced
Attributes: None
Subelements: None

UseOutlineFonts

Parent: Advanced
Attributes: None
Subelements: None

UseRelativeMetricPrefered

Parent: General
Attributes: None
Subelements: None

UsedFontsForGraphic

Parent: Advanced
Attributes: None
Subelements: None

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

WhiteColorProcessing

Parent: General
Attributes: None
Subelements: None

2500
 19.4 Configuration

19.4.5.14 <Engine EngineType="Metacode">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Metacode engine dialog descrip-
tion.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

AdditonalDJDECommandsFromSheetName

Parent: DJDECommands
Attributes: ReplaceNonEBCDICcharactersWith, SheetNameIdxDJDECommandsForDoc-
ument, SheetNameIdxDJDEPageInlineCommands, SheetNameIdxDJDEPagePreCom-
mands, UseDJDECommandsForDocument, UseDJDEPageInlineCommands, UseDJDE-
PagePreCommands
Subelements: None

Advanced

Parent: FormatConfig
Attributes: None
Subelements: ResizeBarcodes

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AssignColorToIndex

Parent: General
Attributes: None
Subelements: SpotColor

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

2501
19 Appendices

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Compression

Parent: General
Attributes: OverlayCompression, UseCompression
Subelements: None

DJDECommands

Parent: FormatConfig
Attributes: None
Subelements: AdditonalDJDECommandsFromSheetName, DJDESyntax

DJDESyntax

Parent: DJDECommands
Attributes: DJDEEncoding, IdenPrefix, ModeJDL, ModePrefix, Offset, Skip
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

Dithering

Parent: FormatConfig
Attributes: None
Subelements: DitheringSetting

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: ColorFeature, DefaultDitherer

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

Encoding

Parent: TextOptions
Attributes: DoNotCorrectCharacterPositionsInsideWords, EncodingName, TextEncoding
Subelements: None

2502
 19.4 Configuration

FileSplitting

Parent: General
Attributes: ResourceFileName, SplitByGroup
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Advanced, DJDECommands, Dithering, General, PageLength, PrintSet-
ting, TextOptions

General

Parent: FormatConfig
Attributes: MachineName, SelectedColor
Subelements: AssignColorToIndex, Compression, FileSplitting, ICCProfile, Output,
PlaceDynamicImagesInOverlays, RSTACK, SelectableColor

ICCProfile

Parent: General
Attributes: None
Subelements: ICCProfileSetting

ICCProfileSetting

Parent: ICCProfile
Attributes: None
Subelements: BuiltInProfile, RenderingIntent, RenderingIntentHandlingGroup0, Ren-
deringIntentHandlingGroup1, RenderingIntentHandlingGroup2, RenderingIntentHand-
lingGroup3, RenderingIntentHandlingGroup4, RenderingIntentHandlingGroup5,
RenderingIntentHandlingGroup6, RenderingIntentHandlingGroup7

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

MetacodePageSize

Parent: MetacodePageSizes
Attributes: HorizontalShiftIMG, HorizontalShiftText, PageSizeName, VerticalShiftIMG,
VerticalShiftText
Subelements: None

MetacodePageSizes

Parent: PrinterConfig
Attributes: None
Subelements: MetacodePageSize

2503
19 Appendices

Output

Parent: General
Attributes: FormsFont, JDEOn, JDLOn, OutputMode
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PageLength

Parent: FormatConfig
Attributes: MaximumOfPageLength
Subelements: None

PlaceDynamicImagesInOverlays

Parent: General
Attributes: PlaceDynamicImagesInOverlaysSetting
Subelements: None

PrintSetting

Parent: FormatConfig
Attributes: LoadOverlay, MaximumNumberOfFontsPerJob, MaximumNumberOfIm-
agesPerPage, OptimizeRecordUsage, Use5WordFST, UseExternalFonts, UseFontOptim-
ize, UseFontsForGraphic, UseTempFiles, WhiteProcessing
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: MetacodePageSizes

RSTACK

Parent: General
Attributes: RSTACKHexaValue, RSTACKOn
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2504
 19.4 Configuration

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

2505
19 Appendices

SelectableColor

Parent: General
Attributes: None
Subelements: SpotColor

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SpotColor

Parent: AssignColorToIndex
Attributes: Color, Idx
Subelements: None

SpotColor

Parent: SelectableColor
Attributes: Color
Subelements: None

TextOptions

Parent: FormatConfig
Attributes: None
Subelements: Encoding

19.4.5.15 <Engine EngineType="MIBF">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the MIBF engine dialog description.

2506
 19.4 Configuration

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Advanced

Parent: FormatConfig
Attributes: None
Subelements: DPIForPDFEPS, ResizeBarcodes

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

BIP

Parent: Head
Attributes: None
Subelements: None

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

Color

Parent: Head
Attributes: None
Subelements: None

ColorFeature

Parent: PageSideConfiguration
Attributes: None
Subelements: None

2507
19 Appendices

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

Colorant

Parent: DitheringSetting
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Compression

Parent: Resources
Attributes: UseCompression, UseCompressionForFonts, UseCompressionForImages
Subelements: None

CuePage

Parent: CuePages
Attributes: LengthOfPage
Subelements: None

CuePages

Parent: FormatConfig
Attributes: CropBottomOfPage
Subelements: CuePage

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DPIForPDFEPS

Parent: Advanced
Attributes: DPIForPDFEPSX, DPIForPDFEPSY, UseResolutionOfHeads
Subelements: None

2508
 19.4 Configuration

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

Ditherer

Parent: DitheringSetting
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Matrix, MatrixType,
Size

Dithering

Parent: PageSideConfiguration
Attributes: None
Subelements: DitheringSetting

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: ColorFeature, Colorant, DefaultDitherer, Ditherer

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

Encoding

Parent: TextOptions
Attributes: DoNotCorrectCharacterPositionsInsideWords, EncodingName, TextEncoding
Subelements: None

FileFormat

Parent: General
Attributes: FileFormat
Subelements: None

FontSetting

Parent: PageSideConfiguration
Attributes: GlyphCodeLength
Subelements: None

2509
19 Appendices

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Advanced, CuePages, General, ICCProfile, ImageHandling, PageConfig-
uration, Resources, TextOptions

General

Parent: FormatConfig
Attributes: None
Subelements: FileFormat, HeadSetting, SizeLimitation

GlobalNonResidentImages

Parent: ImageHandling
Attributes: ListOfNonResidentImages, TextFileEncoding
Subelements: None

Group

Parent: ImageStoringByDitheringGroup
Attributes: ExternalStoring, GroupIndex, ImageStoring, PrimerType, ProcessNativeIm-
ages, SuppressMask
Subelements: None

Head

Parent: Printer
Attributes: None
Subelements: BIP, Color

HeadSetting

Parent: General
Attributes: ResolutionOfHeadsX, ResolutionOfHeadsY, WidthOfHeads
Subelements: None

ICCProfile

Parent: FormatConfig
Attributes: None
Subelements: ICCProfileSetting

ICCProfileBinary

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ICCProfileSetting

Parent: ICCProfile
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-

2510
 19.4 Configuration

tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-

lingGroup7

ImageHandling

Parent: FormatConfig
Attributes: None
Subelements: GlobalNonResidentImages, ImageStoringByDitheringGroup

ImageStoringByDitheringGroup

Parent: ImageHandling
Attributes: None
Subelements: Group

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

Matrix

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

Other

Parent: Resources
Attributes: MergeStaticObjectsIntoSingleOverlay, OptimalizeForSize, SizeOptimization,
UseFontsForGraphics, UseTempFiles
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Page

Parent: PageSideConfiguration
Attributes: None
Subelements: None

2511
19 Appendices

PageConfiguration

Parent: FormatConfig
Attributes: None
Subelements: PageSideConfiguration

PageSide

Parent: PageSideConfiguration
Attributes: None
Subelements: None

PageSideConfiguration

Parent: PageConfiguration
Attributes: None
Subelements: ColorFeature, Dithering, FontSetting, Page, PageSide, Primer, Printer,
Trapping, WhiteProcessing

Primer

Parent: PageSideConfiguration
Attributes: AdditionalSizeOfPrimer
Subelements: None

Printer

Parent: PageSideConfiguration
Attributes: None
Subelements: Head

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2512
 19.4 Configuration

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

Resources

Parent: FormatConfig
Attributes: None
Subelements: Compression, Other

Size

Parent: Ditherer
Attributes: X, Y
Subelements: None

2513
19 Appendices

SizeLimitation

Parent: General
Attributes: CheckSizeLimitation, LimitationSize
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

TextOptions

Parent: FormatConfig
Attributes: None
Subelements: Encoding

Trapping

Parent: PageSideConfiguration
Attributes: SizeOfBitmapTrapping, SizeOfFontTrapping, UseTrapping
Subelements: None

WhiteProcessing

Parent: PageSideConfiguration
Attributes: UseNeverForBlackPrinter, WhiteProcessing
Subelements: None

19.4.5.16 <Engine EngineType="Multi">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Multi engine dialog description.

2514
 19.4 Configuration

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

AFPAdvancedFinishing

Parent: PrinterConfig
Attributes: None
Subelements: AdvancedFinishing, ApplyFinishing, PageLevelTreshold

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Acrobat

Parent: FormatConfig
Attributes: AlternativeImageFormat, PrintAsImage, SearchForAlternativeImagesFor-
Viewing, ShowAcrobatPrintDialog, ShrinkPagesToFit
Subelements: PrintOptions

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

Advanced

Parent: FormatConfig
Attributes: None
Subelements: AdvancedTextOptions, AttachICCProfile, Compatibilities, DeviceSettings-
ForCMR, ExternalAFPFonts, ICCProfileSetting, MaximumOfPageLength, ResizeBarcodes

AdvancedFinishing

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: FinishingOperations

AdvancedTextOptions

Parent: Advanced
Attributes: DoNotCorrectCharacterPositionsInsideWords, KeepTextAsTextInOverlay,
TextEncoding, UseFontsFor, UseFontsForGraphics, UseTextEncoding
Subelements: None

2515
19 Appendices

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

ApplyFinishing

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: None

AssignAFPColorsToColorants

Parent: General
Attributes: None
Subelements: None

AssignAFPColorsToIndex

Parent: Color
Attributes: None
Subelements: SpotColor

AssignColorants2HighlightColors

Parent: General
Attributes: None
Subelements: None

AssignHighlightColors

Parent: General
Attributes: None
Subelements: None

AttachICCProfile

Parent: Advanced
Attributes: None
Subelements: None

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2516
 19.4 Configuration

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

CodePageName

Parent: OnDemandSupport
Attributes: None
Subelements: None

CodePages

Parent: ResourceType
Attributes: Directory, Extension, Status
Subelements: None

CodedFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

CodingForPageIndexes

Parent: Indexing
Attributes: Coding, ReplaceUnresolvedCharactersWith
Subelements: None

Color

Parent: General
Attributes: OutputColors
Subelements: AssignAFPColorsToIndex, ColorSpaceForTextAndGraphic

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

ColorSpaceForTextAndGraphic

Parent: Color
Attributes: ColorSpaceForTextAndGraphic
Subelements: None

Colorants

Parent: General
Attributes: None
Subelements: None

2517
19 Appendices

ColorantsType

Parent: General
Attributes: UseOldColorants
Subelements: None

Colorspace

Parent: Graphics
Attributes: ICCOnChangeOnly, Images, TextAndGraphics, UseICCColorSpaces,
UseSeparations
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Compatibilities

Parent: Advanced
Attributes: DPI1440Positioning, OldFormDefFormat, OldStyleOfFontUseMCF1,
UseIM1ImageFormat, UsePageSegmentsOnly, UsePageSegmentsOnlyAs, UseRelative-
FontMetric
Subelements: None

CompressBW

Parent: General
Attributes: CompressBlackAndWhiteImagesCCITTG4, DoCutOperationsUncom-
pressedIM1
Subelements: None

CompressionForJpg

Parent: ImageSetting
Attributes: None
Subelements: None

CompressionForOther

Parent: ImageSetting
Attributes: None
Subelements: None

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

2518
 19.4 Configuration

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

CreateCustomIndexFile

Parent: CustomIndexFile
Attributes: CreateCustomIndexFile
Subelements: None

CreateSeparateResourceDocumentAndIndexObjectFiles

Parent: Indexing
Attributes: AddPageLevelEntriesToIndexFile, CreateSeparateResourceDocumentAndIn-
dexObjectFilesSelection, IndexFileName, ResourceFileName
Subelements: None

CreateXMLSummaryFile

Parent: Misc.
Attributes: None
Subelements: None

CustomIndexFile

Parent: Indexing
Attributes: None
Subelements: CreateCustomIndexFile, CustomIndexFileItems, ItemsSeparatorIndexFile-
Path

CustomIndexFileItems

Parent: CustomIndexFile
Attributes: None
Subelements: None

CustomerResources

Parent: Resources
Attributes: AFPResourcesProcessingMethod, BackgroundResourcesFromSheetNameIn-
dex, BasicRotationSupportForAFPOverlays, ForegroundResourcesFromSheetNameIndex,
IncludeAlsoAllReferencedResources, TakeBackgroundResourcesFromSheetNameIndex,
TakeForegroundResourcesFromSheetNameIndex
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

DeviceSettingsForCMR

Parent: Advanced
Attributes: DeviceModel, DeviceType, ManufacturerName
Subelements: None

2519
19 Appendices

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DigitalSignatures

Parent: FormatConfig
Attributes: None
Subelements: StorePasswords

Dithering

Parent: FormatConfig
Attributes: None
Subelements: DitheringSetting, ToneTransferCurveCMR

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: ColorFeature, DefaultDitherer

DoubleByteFonts

Parent: Text
Attributes: UseDoubleByteFonts
Subelements: FontShortcuts, TextCodec, TextCodecShortcut, UploadOnlyUsedGlyphs

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: None

DriverConfig

Parent: TriConfig
Attributes: None
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

DriverConfigName

Parent: TriConfig
Attributes: None
Subelements: None

Engine

Parent: TriConfig
Attributes: None
Subelements: None

2520
 19.4 Configuration

ExternalAFPFonts

Parent: Advanced
Attributes: DefaultCodePageForAFPFonts, IncludeOriginalAFPFonts, UseOriginalAFP-
Fonts
Subelements: None

ExternalImages

Parent: ImageSetting
Attributes: ImagePath, Use
Subelements: None

ExternalResources

Parent: Resources
Attributes: ExternalResourcesWithRDW, ReuseExternalImageResources
Subelements: None

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: None

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

FontEncoding

Parent: FormatConfig
Attributes: None
Subelements: None

FontShortcuts

Parent: DoubleByteFonts
Attributes: None
Subelements: None

FormDef

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

2521
19 Appendices

FormatConfig

Parent: Engine
Attributes: Name
Subelements: ShouldSplit, ShouldSplitBySize, SplitAtSize, TriConfig

FormatConfig

Parent: TriConfig
Attributes: None
Subelements: Acrobat, Advanced, DigitalSignatures, Dithering, FontEncoding, General,
Graphics, ImageHandling, Indexing, MarkedContent, Misc., MultilevelImageProcessing,
Resources, Security, Text

FullColorImage

Parent: General
Attributes: FullColorImageFormat
Subelements: None

General

Parent: FormatConfig
Attributes: Compression, CreatePieceInfoFromSheetName, EmbedFonts, HighLightVari-
ables, MaximumOfPageLengthInMetres, PDFArchive, PieceInfoIndex, UseOverlays
Subelements: AssignAFPColorsToColorants, AssignColorants2HighlightColors, As-
signHighlightColors, Color, Colorants, ColorantsType, CompressBW, FullColorImage,
Graphic, GrayscaleImage, HighLightColor, JPEG, RSDIndex, ResizeBarcodes, Resolution,
SetupVerificationIDs, UseOutlineFonts, WhiteProcessing

Graphic

Parent: General
Attributes: GraphicSupport
Subelements: None

Graphics

Parent: FormatConfig
Attributes: ClippingPath, VariableEpsPdfOutputResolution
Subelements: Colorspace, ICCProfile, OPI

GrayscaleImage

Parent: General
Attributes: ConvertToGrayscale, GrayscaleImageSupportSelection, GrayscaleImage-
SupportValue
Subelements: None

Group

Parent: MultilevelImageProcessing
Attributes: CompressionQuality, GroupIndex, ImageCompression, ImageFormat, Im-
ageIncludeType, ImageProcessing, MaxBilevelDPI, MaxBilevelDPITreshold, MaxColorD-
PITreshold, MaxDPI, MaxGrayscaleDPI, MaxGrayscaleDPITreshold, OverlayProcessing
Subelements: None

2522
 19.4 Configuration

HighLightColor

Parent: General
Attributes: B, G, R
Subelements: None

ICCProfile

Parent: Graphics
Attributes: None
Subelements: BuiltInProfile, RenderingIntent

ICCProfileSetting

Parent: Advanced
Attributes: None
Subelements: BuiltInProfile, RenderingIntent

ImageHandling

Parent: FormatConfig
Attributes: None
Subelements: ImageSetting

ImageSetting

Parent: ImageHandling
Attributes: None
Subelements: CompressionForJpg, CompressionForOther, ExternalImages, JpegQuality,
PDFSource

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

ImagesICCProfiles

Parent: Resources
Attributes: ExtractAndReferenceImagesICCProfiles
Subelements: None

IndexPagesUsingTLE

Parent: Indexing
Attributes: UseIndexPagesUsingTLESelection
Subelements: None

Indexes

Parent: NOPComments
Attributes: None
Subelements: None

2523
19 Appendices

IndexesPagesUsingTLE

Parent: Indexing
Attributes: None
Subelements: None

Indexing

Parent: FormatConfig
Attributes: None
Subelements: CodingForPageIndexes, CreateSeparateResourceDocumentAndIndex-
ObjectFiles, CustomIndexFile, IndexPagesUsingTLE, IndexesPagesUsingTLE, Rein-
vokeMediumOptionsWithEveryPageGroup

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

ItemsSeparatorIndexFilePath

Parent: CustomIndexFile
Attributes: IndexFileItemsSeparator, IndexFilePath, ReplaceNonLatin1CharactersWith
Subelements: None

JDF

Parent: JDFData
Attributes: TargetRoute
Subelements: Processes, Resources

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JPEG

Parent: General
Attributes: JPEGCompressionQuality
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

2524
 19.4 Configuration

JpegQuality

Parent: ImageSetting
Attributes: None
Subelements: None

KnownResources

Parent: Resources
Attributes: AlwaysGenerateAllKnownResources
Subelements: None

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

MarkedContent

Parent: FormatConfig
Attributes: UseMarkedContent
Subelements: None

MaximumOfPageLength

Parent: Advanced
Attributes: MaximumOfPageLengthInMetres
Subelements: None

Misc.

Parent: FormatConfig
Attributes: None
Subelements: CreateXMLSummaryFile, NOPComments, RSDIndex, TakePageName-
FromSheetNameIndex, XMLSummaryFileName

MultilevelImageProcessing

Parent: FormatConfig
Attributes: None
Subelements: Group

NOPComments

Parent: Misc.
Attributes: None
Subelements: Indexes, NOPDataEncoding, WriteNOPCommentsWithSheetNameData

NOPDataEncoding

Parent: NOPComments
Attributes: NOPDataEncoding
Subelements: None

2525
19 Appendices

OPI

Parent: Graphics
Attributes: None
Subelements: None

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

OnDemandSupport

Parent: Text
Attributes: FollowNamingConvenction
Subelements: CodePageName, SingleByteFontShortcuts

OutlineFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Overlays

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

PDFSource

Parent: ImageSetting
Attributes: ReuseMethod, Use
Subelements: None

PageLevelTreshold

Parent: AFPAdvancedFinishing
Attributes: None
Subelements: None

PageSegments

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

2526
 19.4 Configuration

Permissions

Parent: Security
Attributes: AllowChangingTheDocument, AllowContentCopyingOrExtraction, Allow-
FillingOfForms, AllowPrinting
Subelements: None

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PrintOptions

Parent: Acrobat
Attributes: Set, SheetNameIndex
Subelements: None

PrinterConfig

Parent: TriConfig
Attributes: None
Subelements: AFPAdvancedFinishing, JDFConfig

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, InterpretingParams, LayoutPreparationParams,
RenderingParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

RSDIndex

Parent: General
Attributes: RSDDocumentNameSheetName, RSDFolderNameSheetName, RSDWork-
ingDateSheetName, WriteRSDIndex
Subelements: None

RSDIndex

Parent: Misc.
Attributes: RSDDocumentNameSheetNameIndex, RSDFolderNameSheetNameIndex,
RSDWorkingDateSheetNameIndex, WriteRSDIndex
Subelements: None

RasterFonts

Parent: ResourceType
Attributes: Directory, Extension, Naming, Status
Subelements: None

2527
19 Appendices

ReinvokeMediumOptionsWithEveryPageGroup

Parent: Indexing
Attributes: ReinvokeMediumOptionsWithEveryPageGroupSelection
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: None

ResizeBarcodes

Parent: Advanced
Attributes: None
Subelements: Absolute, AlignType, Relative

ResizeBarcodes

Parent: General
Attributes: None
Subelements: Absolute, AlignType, Relative

Resolution

Parent: General
Attributes: PrinterResolution
Subelements: None

2528
 19.4 Configuration

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

ResourceNamesTransformation

Parent: Resources
Attributes: LowercaseResourceNames
Subelements: None

ResourceType

Parent: Resources
Attributes: None
Subelements: CodePages, CodedFonts, FormDef, OutlineFonts, Overlays, PageSeg-
ments, RasterFonts

Resources

Parent: FormatConfig
Attributes: None
Subelements: CustomerResources, ExternalResources, ImagesICCProfiles, KnownRe-
sources, ResourceNamesTransformation, ResourceType, ReuseBinarySameOverlays,
UseCustomerResourceName, UseOriginalResourcesWithoutProcessing

Resources

Parent: JDF
Attributes: None
Subelements: Resource

ReuseBinarySameOverlays

Parent: Resources
Attributes: None
Subelements: None

Security

Parent: FormatConfig
Attributes: EncryptPasswords, PasswordToChangePermissions, PasswordToChangePer-
missionsCrypt, PasswordToChangePermissionsFromSheetNumber, Pass-
wordToChangePermissionsSource, PasswordToOpenDocument, PasswordToOpenDoc-
umentCrypt, PasswordToOpenDocumentFromSheetNumber, PasswordToOpenDocu-
mentSource
Subelements: Permissions

SetupVerificationID

Parent: SetupVerificationIDs
Attributes: ID
Subelements: None

2529
19 Appendices

SetupVerificationIDs

Parent: General
Attributes: None
Subelements: SetupVerificationID

ShouldSplit

Parent: FormatConfig
Attributes: None
Subelements: None

ShouldSplitBySize

Parent: FormatConfig
Attributes: None
Subelements: None

SingleByteFontShortcuts

Parent: OnDemandSupport
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitAtSize

Parent: FormatConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SpotColor

Parent: AssignAFPColorsToIndex
Attributes: AFPColor, SpotColor
Subelements: None

2530
 19.4 Configuration

StorePasswords

Parent: DigitalSignatures
Attributes: None
Subelements: None

TakePageNameFromSheetNameIndex

Parent: Misc.
Attributes: PageNameFromSheetNameIndex, UsePageNameFromSheetNameIndex
Subelements: None

Text

Parent: FormatConfig
Attributes: None
Subelements: DoubleByteFonts, OnDemandSupport

TextCodec

Parent: DoubleByteFonts
Attributes: None
Subelements: None

TextCodecShortcut

Parent: DoubleByteFonts
Attributes: None
Subelements: None

ToneTransferCurveCMR

Parent: Dithering
Attributes: None
Subelements: None

TriConfig

Parent: FormatConfig
Attributes: None
Subelements: DriverConfig, DriverConfigName, Engine, FormatConfig, PrinterConfig

UploadOnlyUsedGlyphs

Parent: DoubleByteFonts
Attributes: None
Subelements: None

UseCustomerResourceName

Parent: Resources
Attributes: None
Subelements: None

2531
19 Appendices

UseOriginalResourcesWithoutProcessing

Parent: Resources
Attributes: UseOriginalIOCAImageDataWithoutProcessing, UseOriginalJPEGIm-
ageDataWithoutProcessing, UseOriginalTIFImageDataWithoutProcessing
Subelements: None

UseOutlineFonts

Parent: General
Attributes: UseOutlineFonts
Subelements: None

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

WhiteProcessing

Parent: General
Attributes: WhiteColorProcessing
Subelements: None

WriteNOPCommentsWithSheetNameData

Parent: NOPComments
Attributes: WriteNOPCommentsWithSheetNameDataSelection
Subelements: None

XMLSummaryFileName

Parent: Misc.
Attributes: None
Subelements: None

19.4.5.17 <Engine EngineType="NexPressVDX">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the NexPressVDX engine dialog
description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

2532
 19.4 Configuration

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

Colorspace

Parent: FormatConfig
Attributes: ICCOnChangeOnly, Images, TextAndGraphics, UseICCColorSpaces,
UseSeparations
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

CompressionForJpg

Parent: ImageSetting
Attributes: None
Subelements: None

CompressionForOther

Parent: ImageSetting
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

ExternalImages

Parent: ImageSetting
Attributes: ExternalStreamType, ImagePath, Use, XObjectPath
Subelements: None

FormatConfig

Parent: Engine
Attributes: ANSI, Compression, MaximumOfPageLengthInMetres, Name, VariableEp-
sPdfOutputResolution
Subelements: Colorspace, ICCProfile, ImageHandling, JpegCompression, Resize-
Barcodes

2533
19 Appendices

ICCProfile

Parent: FormatConfig
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageHandling

Parent: FormatConfig
Attributes: None
Subelements: ImageSetting

ImageSetting

Parent: ImageHandling
Attributes: None
Subelements: CompressionForJpg, CompressionForOther, ExternalImages, JpegQuality,
Overprint, PDFSource

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JpegCompression

Parent: FormatConfig
Attributes: Quality, Use
Subelements: None

JpegQuality

Parent: ImageSetting
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Overprint

Parent: ImageSetting
Attributes: Fill, Mode, Stroke
Subelements: None

2534
 19.4 Configuration

PDFSource

Parent: ImageSetting
Attributes: ReuseMethod, Use
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

2535
19 Appendices

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

ResizeBarcodes

Parent: FormatConfig
Attributes: None
Subelements: Absolute, AlignType, Relative

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

19.4.5.18 <Engine EngineType="PCL">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the PCL engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

2536
 19.4 Configuration

AdvancedFinishing

Parent: PrinterConfig
Attributes: None
Subelements: FinishingOperations

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

AllowSingleFileSplitting

Parent: General
Attributes: AllowSingleFileSplitting
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

AssignColorToIndex

Parent: General
Attributes: None
Subelements: SpotColor

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

2537
19 Appendices

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: InvalidCombinations
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: RootAttributes
Attributes: SymbolicName
Subelements: Values

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

2538
 19.4 Configuration

Attribute

Parent: Attributes
Attributes: SymbolicName
Subelements: Values

Attributes

Parent: Command
Attributes: None
Subelements: Attribute

Attributes

Parent: Feature
Attributes: None
Subelements: Attribute

Attributes

Parent: Option
Attributes: None
Subelements: Attribute

Attributes

Parent: Command
Attributes: None
Subelements: Attribute

Attributes

Parent: Case
Attributes: None
Subelements: Attribute

Attributes

Parent: Command
Attributes: None
Subelements: Attribute

Attributes

Parent: Case
Attributes: None
Subelements: Attribute

Attributes

Parent: Command
Attributes: None
Subelements: Attribute

2539
19 Appendices

Attributes

Parent: Case
Attributes: None
Subelements: Attribute

Attributes

Parent: TTFS
Attributes: None
Subelements: Attribute

Attributes

Parent: Case
Attributes: None
Subelements: Attribute

Attributes

Parent: Command
Attributes: None
Subelements: Attribute

BuiltInProfile

Parent: ICCProfileSetting
Attributes: None
Subelements: None

Case

Parent: Cases
Attributes: ParentType, SymbolicName
Subelements: Attributes, Commands, Switches

Case

Parent: Cases
Attributes: ParentType, SymbolicName
Subelements: Attributes, Commands

Case

Parent: Cases
Attributes: ParentType, SymbolicName
Subelements: Attributes, Name

Case

Parent: Cases
Attributes: ParentType, SymbolicName
Subelements: Attributes, Commands, Switches

2540
 19.4 Configuration

Case

Parent: Cases
Attributes: ParentType, SymbolicName
Subelements: None

Cases

Parent: Switch
Attributes: None
Subelements: Case

Cases

Parent: Switch
Attributes: None
Subelements: Case

Cases

Parent: Switch
Attributes: None
Subelements: Case

Cases

Parent: Switch
Attributes: None
Subelements: Case

Cases

Parent: Switch
Attributes: None
Subelements: Case

Cmd

Parent: Command
Attributes: None
Subelements: None

Cmd

Parent: Command
Attributes: None
Subelements: None

Cmd

Parent: Command
Attributes: None
Subelements: None

2541
19 Appendices

Cmd

Parent: Command
Attributes: None
Subelements: None

Cmd

Parent: Command
Attributes: None
Subelements: None

ColorFeature

Parent: DitheringSetting
Attributes: None
Subelements: None

Command

Parent: Commands
Attributes: SymbolicName
Subelements: Attributes, Cmd

Command

Parent: Commands
Attributes: SymbolicName
Subelements: Attributes, Cmd

Command

Parent: Commands
Attributes: SymbolicName
Subelements: Attributes, Cmd

Command

Parent: Commands
Attributes: SymbolicName
Subelements: Attributes, Cmd

Command

Parent: Commands
Attributes: SymbolicName
Subelements: Attributes, Cmd

Commands

Parent: GPD
Attributes: None
Subelements: Command

2542
 19.4 Configuration

Commands

Parent: Option
Attributes: None
Subelements: Command

Commands

Parent: Case
Attributes: None
Subelements: Command

Commands

Parent: Case
Attributes: None
Subelements: Command

Commands

Parent: Case
Attributes: None
Subelements: Command

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

ControlType

Parent: FinishingOperations
Attributes: None
Subelements: None

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DefaultDitherer

Parent: DitheringSetting
Attributes: None
Subelements: None

2543
19 Appendices

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

Ditherer

Parent: DitheringSetting
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Linearization,
Matrix, MatrixType, Size

Dithering

Parent: FormatConfig
Attributes: None
Subelements: DitheringSetting

DitheringSetting

Parent: Dithering
Attributes: None
Subelements: ColorFeature, DefaultDitherer, Ditherer

DoNotUseOverlay

Parent: General
Attributes: DoNotUseOverlay
Subelements: None

DocumentProperties

Parent: DriverConfig
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, DocumentProperties, JobDescriptionName, JobName, Out-
putFileName, PrinterName, ShouldSplit, ShouldSplitBySize, Split, SplitAtSize, SplitBySize,
SplitSize, Spool2File

Encoding

Parent: TextOptions
Attributes: DoNotCorrectCharacterPositionsInsideWords, EncodingName, TextEncoding
Subelements: None

EndPJLCommands

Parent: PJLCommands
Attributes: Command
Subelements: None

2544
 19.4 Configuration

Feature

Parent: FeatureSetting
Attributes: Name, SelectedOption
Subelements: None

Feature

Parent: Features
Attributes: SymbolicName
Subelements: Attributes, Name, Options, Switches

FeatureSetting

Parent: PrinterConfig
Attributes: None
Subelements: Feature

Features

Parent: GPD
Attributes: None
Subelements: Feature

FinishingOperationItem

Parent: FinishingOperationRow
Attributes: None
Subelements: IntValue, StringValue

FinishingOperationRow

Parent: FinishingOperationTable
Attributes: None
Subelements: FinishingOperationItem

FinishingOperationTable

Parent: FinishingOperations
Attributes: None
Subelements: FinishingOperationRow

FinishingOperations

Parent: AdvancedFinishing
Attributes: None
Subelements: ControlType, FinishingOperationTable, UsedSheetNames

FontFormat

Parent: General
Attributes: FontFormat
Subelements: None

2545
19 Appendices

FontSubstitution

Parent: GPD
Attributes: None
Subelements: TTFS

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Dithering, General, PJLCommands, PageLength, TextOptions

FullView

Parent: UserInterfaces
Attributes: CollapseAllNodes
Subelements: None

GPD

Parent: PrinterConfig
Attributes: None
Subelements: Commands, Features, FontSubstitution, InvalidCombinations, InvalidIn-
stallableCombinations, RootAttributes, Switches

General

Parent: FormatConfig
Attributes: OutputColors, PrinterResolution, UseHighlightColors, UseOnlyCMYKColors
Subelements: AllowSingleFileSplitting, AssignColorToIndex, DoNotUseOverlay, Font-
Format, ICCProfileSetting, KerningNotSupportedByPrinter, PrintComands, ResetMar-
ginsAfterRotation, ResizeBarcodes, SuppressInitialReset, UseCompression, UsePerman-
entResources, WhiteProcessing

ICCProfileBinary

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ICCProfileSetting

Parent: General
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

IntValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

2546
 19.4 Configuration

InvalidCombinations

Parent: GPD
Attributes: None
Subelements: Attribute

InvalidInstallableCombinations

Parent: GPD
Attributes: None
Subelements: None

JobDescriptionName

Parent: DriverConfig
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

KerningNotSupportedByPrinter

Parent: General
Attributes: KerningNotSupportedByPrinter
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

Linearization

Parent: Ditherer
Attributes: None
Subelements: None

Matrix

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

2547
19 Appendices

Name

Parent: Feature
Attributes: DefaultOption, Name, NameID
Subelements: None

Name

Parent: Option
Attributes: Name, NameID
Subelements: None

Name

Parent: Case
Attributes: DefaultOption
Subelements: None

Option

Parent: Options
Attributes: SymbolicName
Subelements: Attributes, Commands, Name, Switches

Options

Parent: Feature
Attributes: None
Subelements: Option

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PJLCommands

Parent: FormatConfig
Attributes: None
Subelements: EndPJLCommands, StartPJLCommands

PageLength

Parent: FormatConfig
Attributes: MaximumOfPageLength
Subelements: None

PrintComands

Parent: General
Attributes: FinishPageWithCommandsFromSheetNameIndex, InitialPageCommandsFrom-
SheetNameIndex, TakeFinishPageWithCommandsFromSheetNameIndex, TakeInitialPage-
CommandsFromSheetNameIndex, TranslateOpenSquareBracketToEscapeCharacters
Subelements: None

2548
 19.4 Configuration

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedFinishing, FeatureSetting, GPD, PutGPDCommand, UserInter-
faces

PrinterName

Parent: DriverConfig
Attributes: None
Subelements: None

PrinterProperty

Parent: UserInterfaces
Attributes: ShowOnlyUsedFeatures, ShowSymbolicNames
Subelements: None

PutGPDCommand

Parent: PrinterConfig
Attributes: None
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSetting
Attributes: None
Subelements: None

2549
19 Appendices

RenderingIntentHandlingGroup3

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSetting
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfileSetting
Attributes: None
Subelements: None

ResetMarginsAfterRotation

Parent: General
Attributes: ResetMarginsAfterRotation
Subelements: None

ResizeBarcodes

Parent: General
Attributes: None
Subelements: Absolute, AlignType, Relative

RootAttributes

Parent: GPD
Attributes: None
Subelements: Attribute

ShouldSplit

Parent: DriverConfig
Attributes: None
Subelements: None

2550
 19.4 Configuration

ShouldSplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

Size

Parent: Ditherer
Attributes: X, Y
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitAtSize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

Spool2File

Parent: DriverConfig
Attributes: None
Subelements: None

SpotColor

Parent: AssignColorToIndex
Attributes: Color, Idx
Subelements: None

StartPJLCommands

Parent: PJLCommands
Attributes: Command
Subelements: None

2551
19 Appendices

StringValue

Parent: FinishingOperationItem
Attributes: None
Subelements: None

SuppressInitialReset

Parent: General
Attributes: SuppressInitialReset
Subelements: None

Switch

Parent: Switches
Attributes: ParentType, SymbolicName
Subelements: Cases

Switch

Parent: Switches
Attributes: ParentType, SymbolicName
Subelements: Cases

Switch

Parent: Switches
Attributes: ParentType, SymbolicName
Subelements: Cases

Switch

Parent: Switches
Attributes: ParentType, SymbolicName
Subelements: Cases

Switch

Parent: Switches
Attributes: ParentType, SymbolicName
Subelements: Cases

Switches

Parent: GPD
Attributes: None
Subelements: Switch

Switches

Parent: Feature
Attributes: None
Subelements: Switch

2552
 19.4 Configuration

Switches

Parent: Option
Attributes: None
Subelements: Switch

Switches

Parent: Case
Attributes: None
Subelements: Switch

Switches

Parent: Case
Attributes: None
Subelements: Switch

TTFS

Parent: FontSubstitution
Attributes: SymbolicName
Subelements: Attributes

TextOptions

Parent: FormatConfig
Attributes: None
Subelements: Encoding, UseBigGlyphsCompression, UsePreciseMetric

UseBigGlyphsCompression

Parent: TextOptions
Attributes: UseBigGlyphsCompression
Subelements: None

UseCompression

Parent: General
Attributes: CompressionMethod, UseCompression
Subelements: None

UsePermanentResources

Parent: General
Attributes: UsePermanentResources
Subelements: None

UsePreciseMetric

Parent: TextOptions
Attributes: UsePreciseMetric
Subelements: None

2553
19 Appendices

UsedSheetNames

Parent: FinishingOperations
Attributes: None
Subelements: None

UserInterfaces

Parent: PrinterConfig
Attributes: None
Subelements: FullView, PrinterProperty

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

2554
 19.4 Configuration

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Value

Parent: Values
Attributes: None
Subelements: None

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

2555
19 Appendices

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

2556
 19.4 Configuration

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

Values

Parent: Attribute
Attributes: None
Subelements: Value

WhiteProcessing

Parent: General
Attributes: WhiteProces
Subelements: None

19.4.5.19 <Engine EngineType="PDF Fixed Resolution">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the PDF Fixed Resolution engine
dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Acrobat

Parent: FormatConfig
Attributes: PrintAsImage, ShowAcrobatPrintDialog, ShrinkPagesToFit
Subelements: PrintOptions

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

2557
19 Appendices

AlternativeColor

Parent: SpotColor
Attributes: B, G, R
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

AssignColorants

Parent: General
Attributes: None
Subelements: SpotColor

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

ColorFeature

Parent: Dithering
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DefaultDitherer

Parent: Dithering
Attributes: None
Subelements: None

2558
 19.4 Configuration

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

Ditherer

Parent: Dithering
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, Linearization,
MatrixType

Dithering

Parent: FormatConfig
Attributes: None
Subelements: ColorFeature, DefaultDitherer, Ditherer

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

FontEncoding

Parent: FormatConfig
Attributes: AllGlyphs, Codec
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Acrobat, Dithering, FontEncoding, General, Splitting

General

Parent: FormatConfig
Attributes: ColorspaceForTextAndGraphic, Compress, GraphicSupport, GrayscaleSup-
port, JPEGCompression, JPEGQuality, MaximumOfPageLengthInMetres, OutputColors,
PrinterResolutionX, PrinterResolutionY, WhiteColorProcessing
Subelements: AssignColorants, ICCProfile, ResizeBarcodes

Head

Parent: HorizontalHeadSetting
Attributes: From, Width
Subelements: None

HorizontalHeadSetting

Parent: MediaSetting
Attributes: None
Subelements: Head

2559
19 Appendices

ICCProfile

Parent: General
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

Linearization

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

MediaSetting

Parent: Splitting
Attributes: Face, Index, Shrink
Subelements: HorizontalHeadSetting

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PrintOptions

Parent: Acrobat
Attributes: Set, SheetNameIndex
Subelements: None

2560
 19.4 Configuration

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

2561
19 Appendices

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

ResizeBarcodes

Parent: General
Attributes: None
Subelements: Absolute, AlignType, Relative

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

Splitting

Parent: FormatConfig
Attributes: None
Subelements: MediaSetting

SpotColor

Parent: AssignColorants
Attributes: ColorantName, Index
Subelements: AlternativeColor

19.4.5.20 <Engine EngineType="PDF">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the PDF engine dialog description.

2562
 19.4 Configuration

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Acrobat

Parent: FormatConfig
Attributes: AlternativeImageFormat, PrintAsImage, SearchForAlternativeImagesFor-
Viewing, ShowAcrobatPrintDialog, ShrinkPagesToFit
Subelements: PrintOptions

Address

Parent: DriverConfig
Attributes: None
Subelements: None

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

2563
19 Appendices

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

Colorspace

Parent: Graphics
Attributes: ICCOnChangeOnly, Images, TextAndGraphics, UseICCColorSpaces,
UseSeparations
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

CompressionForJpg

Parent: ImageSetting
Attributes: None
Subelements: None

CompressionForOther

Parent: ImageSetting
Attributes: None
Subelements: None

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

DItem

Parent: DPM
Attributes: Name, Type
Subelements: DItem

DItem

Parent: DItem
Attributes: Name, Type
Subelements: None

2564
 19.4 Configuration

DItem

Parent: PropertyDict
Attributes: Name, SheetName, Type
Subelements: None

DItem

Parent: PieceInfo
Attributes: Name, SheetName, Type
Subelements: None

DPI

Parent: ImageSetting
Attributes: ColorType, DPIOver, MaxDPI
Subelements: None

DPM

Parent: DocumentPartMetadata
Attributes: Type
Subelements: DItem

Data

Parent: Validator
Attributes: None
Subelements: Root

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, MediaID, OutputBin, PageDelivery,
Status, Usage
Subelements: DigitalPrintingParams

DigitalPrintingParams

Parent: DigitalPrintingParams
Attributes: Class, Collate, ID, Locked, ManualFeed, MediaID, OutputBin, PageDelivery,
SheetName, Status, Usage
Subelements: None

DigitalSignatures

Parent: FormatConfig
Attributes: None
Subelements: IdentityName, IdentitySheetNameIdx, ReasonMethod, ReasonSheet-
NameIdx, ReasonText, SignMethod, StorePasswords

DocumentPartMetadata

Parent: FormatConfig
Attributes: InsertDPM
Subelements: DPM

2565
19 Appendices

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Address, Comment, ExtraCommands, JobName, OutputFileName, Port,
QueueName, Split, SplitBySize, SplitSize

Element

Parent: Root
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

ExternalImages

Parent: ImageSetting
Attributes: ExternalStreamType, ImagePath, Use, XObjectPath
Subelements: None

ExtraCommands

Parent: DriverConfig
Attributes: None
Subelements: None

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

FontEncoding

Parent: FormatConfig
Attributes: None
Subelements: FromCodec, Predefined

FontReferenceList

Parent: FormatConfig
Attributes: None
Subelements: None

2566
 19.4 Configuration

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Acrobat, DigitalSignatures, DocumentPartMetadata, FontEncoding,
FontReferenceList, General, Graphics, ImageHandling, MarkedContent, PieceInfo,
Security, Splitting

FromCodec

Parent: FontEncoding
Attributes: None
Subelements: None

General

Parent: FormatConfig
Attributes: Compression, CompressionLevel, CreatePieceInfoFromSheetName, Embed-
Fonts, ExternalFontLocation, FontLocationType, HighLightVariables, Language, Limit-
FontReference, Linearized, MaximumOfPageLengthInMetres, PDFArchive, PDFVT,
PDFX4, PieceInfoIndex, ShowVariableNames, TaggedPDF, UseOverlays
Subelements: HighLightColor, RSDIndex, ResizeBarcodes

Graphics

Parent: FormatConfig
Attributes: ClippingPath, DetectGray, VariableEpsPdfOutputResolution
Subelements: Colorspace, ICCProfile, OPI

Head

Parent: HorizontalHeadSetting
Attributes: From, Width
Subelements: HeadProperties

HeadProperties

Parent: Head
Attributes: None
Subelements: None

HighLightColor

Parent: General
Attributes: B, G, R
Subelements: None

HorizontalHeadSetting

Parent: MediaSetting
Attributes: None
Subelements: Head

2567
19 Appendices

ICCProfile

Parent: Graphics
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

IdentityName

Parent: DigitalSignatures
Attributes: None
Subelements: None

IdentitySheetNameIdx

Parent: DigitalSignatures
Attributes: None
Subelements: None

ImageHandling

Parent: FormatConfig
Attributes: None
Subelements: ImageSetting

ImageSetting

Parent: ImageHandling
Attributes: None
Subelements: CompressionForJpg, CompressionForOther, DPI, ExternalImages,
JpegQuality, Overprint, PDFSource

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

2568
 19.4 Configuration

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JpegQuality

Parent: ImageSetting
Attributes: None
Subelements: None

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

MarkedContent

Parent: FormatConfig
Attributes: UseMarkedContent
Subelements: PropertyDict

MediaSetting

Parent: Splitting
Attributes: Face, Index, Shrink
Subelements: HorizontalHeadSetting

OPI

Parent: Graphics
Attributes: None
Subelements: None

2569
19 Appendices

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

Overprint

Parent: ImageSetting
Attributes: Fill, Mode, Stroke
Subelements: None

PDFSource

Parent: ImageSetting
Attributes: ReuseMethod, Use
Subelements: None

Permissions

Parent: Security
Attributes: AllowChangingTheDocument, AllowContentCopyingOrExtraction, Allow-
FillingOfForms, AllowPrinting
Subelements: None

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PieceInfo

Parent: FormatConfig
Attributes: None
Subelements: PieceInfo

PieceInfo

Parent: PieceInfo
Attributes: Name, Type
Subelements: DItem

2570
 19.4 Configuration

Port

Parent: DriverConfig
Attributes: None
Subelements: None

Predefined

Parent: FontEncoding
Attributes: None
Subelements: None

PrintOptions

Parent: Acrobat
Attributes: Set, SheetNameIndex
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: JDFConfig

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

PropertyDict

Parent: MarkedContent
Attributes: Group, Tag, Type
Subelements: DItem

QueueName

Parent: DriverConfig
Attributes: None
Subelements: None

2571
19 Appendices

RSDIndex

Parent: General
Attributes: RSDDocumentNameSheetName, RSDFolderNameSheetName, RSDWork-
ingDateSheetName, WriteRSDIndex
Subelements: None

ReasonMethod

Parent: DigitalSignatures
Attributes: None
Subelements: None

ReasonSheetNameIdx

Parent: DigitalSignatures
Attributes: None
Subelements: None

ReasonText

Parent: DigitalSignatures
Attributes: None
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

2572
 19.4 Configuration

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: General
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BackCoatings, BillingCode, Class, ComponentType, CustomerID,
CustomerJobName, DescriptiveName, Dimension, FrontCoatings, ID, LocationName,
Locked, MediaColorName, MediaType, MediaUnit, Name, PagesFrom, PagesTo, Prefix,
Status, StockType, Usage, Weight
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

2573
19 Appendices

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Security

Parent: FormatConfig
Attributes: EncryptPasswords, Method, PasswordToChangePermissions, Pass-
wordToChangePermissionsCrypt, PasswordToChangePermissionsFromSheetNumber,
PasswordToChangePermissionsSource, PasswordToOpenDocument, PasswordToOpen-
DocumentCrypt, PasswordToOpenDocumentFromSheetNumber, PasswordToOpen-
DocumentSource
Subelements: Permissions

SignMethod

Parent: DigitalSignatures
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

Splitting

Parent: FormatConfig
Attributes: ResolutionX, ShowErrors
Subelements: MediaSetting

StorePasswords

Parent: DigitalSignatures
Attributes: None
Subelements: None

2574
 19.4 Configuration

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

19.4.5.21 <Engine EngineType="PNetTNative">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Inspire Native engine dialog
description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

2575
19 Appendices

Compressed

Parent: FormatConfig
Attributes: None
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

ExternalFonts

Parent: FormatConfig
Attributes: None
Subelements: None

ExternalImages

Parent: FormatConfig
Attributes: None
Subelements: None

FontDirectory

Parent: FormatConfig
Attributes: None
Subelements: None

FormatConfig

Parent: Engine
Attributes: Name
Subelements: Compressed, ExternalFonts, ExternalImages, FontDirectory, Generate-
MetadataFile, ImageDirectory, ImageRenderDPI, IncludeMetadata, ReportOutOfPage-
Boundaries, StoreOnlyUsedGlyphs, UseOriginalFontLinks, UseOriginalImageLinks,
VisualizeOutOfPageBoundaries

GenerateMetadataFile

Parent: FormatConfig
Attributes: None
Subelements: None

ImageDirectory

Parent: FormatConfig
Attributes: None
Subelements: None

ImageRenderDPI

Parent: FormatConfig
Attributes: None
Subelements: None

2576
 19.4 Configuration

IncludeMetadata

Parent: FormatConfig
Attributes: None
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

ReportOutOfPageBoundaries

Parent: FormatConfig
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

StoreOnlyUsedGlyphs

Parent: FormatConfig
Attributes: None
Subelements: None

UseOriginalFontLinks

Parent: FormatConfig
Attributes: None
Subelements: None

2577
19 Appendices

UseOriginalImageLinks

Parent: FormatConfig
Attributes: None
Subelements: None

VisualizeOutOfPageBoundaries

Parent: FormatConfig
Attributes: None
Subelements: None

19.4.5.22 <Engine EngineType="PodiPPML">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the PodiPPML engine dialog descrip-
tion.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, PrinterConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

Address

Parent: Contact
Attributes: City, Country, CountryCode, PostalCode, Street
Subelements: None

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, ImageFormat, Images, PPMLSettings, VIElements

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

2578
 19.4 Configuration

Attribute

Parent: SubElements
Attributes: Name
Subelements: Value

Attribute

Parent: SubElements
Attributes: Name
Subelements: None

BMP

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

CachedVIElements

Parent: VIElements
Attributes: Generate, UserName
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

Company

Parent: Contact
Attributes: OrganizationName
Subelements: None

Conformance

Parent: PPMLSettings
Attributes: SubsetGA
Subelements: None

Contact

Parent: Resource
Attributes: ContactTypes
Subelements: Address, Company, Person

2579
19 Appendices

CorrectionOfInlineElements

Parent: VIElements
Attributes: TresholdValue, UseTresholdValueOfGroupObjects
Subelements: None

CreateImages

Parent: Images
Attributes: CreateInto, Dir
Subelements: None

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength, UseBackSlash
Subelements: None

Data

Parent: Validator
Attributes: None
Subelements: Root

DigitalPrintingParams

Parent: Process
Attributes: Class, Collate, ID, Locked, ManualFeed, OutputBin, PageDelivery, Status,
Usage
Subelements: None

DocumentSplitting

Parent: PPMLSettings
Attributes: CountOfSheets, ResetPageCounter, ResetSplitConter, Split
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EPS

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

Element

Parent: Root
Attributes: Name
Subelements: SubElements

2580
 19.4 Configuration

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Element

Parent: SubElements
Attributes: Name
Subelements: SubElements

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, CopyAllFilesToRightDirOnFinishAtOnce,
MaximumOfPageLengthInMetres, ZipAllFiles
Subelements: ICCProfile, ResizeBarcodes

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FitPolicy

Parent: LayoutPreparationParams
Attributes: RotatePolicy, SizePolicy
Subelements: None

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, FontEncoding, Maximal-
CountOfSingleByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, PsOutputOption

GlobalCache

Parent: VIElements
Attributes: AddImages, AddOverlays
Subelements: None

2581
19 Appendices

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageFormat

Parent: AdvancedSettings
Attributes: ConvertUnsupportedImagesTypeInto, JPGCompressionQuality, Location-
Prefix, MakeSimplePdfPages, SuppressNativeLoading, UseCachedImages, UseOrigin-
alPDF, UseUserDefinedImagePrefix
Subelements: ImagesSupportByPrinter

ImageShift

Parent: LayoutPreparationParams
Attributes: ShiftBack, ShiftFront
Subelements: None

Images

Parent: AdvancedSettings
Attributes: ImageBufferSize, ImageColorSpace, ImagesRenderDPI, NativePdfImagesIn-
ternally
Subelements: CreateImages, ImageFilters, Patterns

ImagesSupportByPrinter

Parent: ImageFormat
Attributes: None
Subelements: BMP, EPS, JPG, PCX, PDF, TIFF

ImpositionParams

Parent: Process
Attributes: Class, ID, Locked, Status, Usage
Subelements: None

2582
 19.4 Configuration

Impositioning

Parent: PrinterConfig
Attributes: CustomCommand, DeclareItInDocument, SelectedCommand, UseGlob-
alImpositioning, UsePredefinedCommand
Subelements: None

InternalDataEncoding

Parent: PPMLSettings
Attributes: UseBase64OnPsCommand
Subelements: None

InternalOrExternalFontResources

Parent: PPMLSettings
Attributes: ExternalDir, IsExternalDirSameAsSpool, LocationPrefix, UseInternalData
Subelements: None

InterpretingParams

Parent: Process
Attributes: Class, ID, Locked, PrintQuality, Status, Usage
Subelements: ObjectResolution

JDF

Parent: JDFData
Attributes: GenerationDirectory, SheetRange, TargetRoute
Subelements: Processes, Resources, Validator

JDFConfig

Parent: PrinterConfig
Attributes: CreateJDF
Subelements: JDFData

JDFData

Parent: JDFConfig
Attributes: None
Subelements: JDF

JPG

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

JobLabel

Parent: PPMLSettings
Attributes: IsUserDefined, Text
Subelements: None

2583
19 Appendices

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

JobUniqueElementNames

Parent: VIElements
Attributes: Generate
Subelements: None

LayoutPreparationParams

Parent: Process
Attributes: Class, ID, Locked, Rotate, Sides, Status, Usage
Subelements: FitPolicy, ImageShift

ObjectResolution

Parent: InterpretingParams
Attributes: AntiAliasing, Resolution, SourceObjects
Subelements: None

ObjectResolution

Parent: RenderingParams
Attributes: AntiAliasing, Resolution
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OverwriteCache

Parent: VIElements
Attributes: Images, Overlays
Subelements: None

PCX

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

PDF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

2584
 19.4 Configuration

PPMLSettings

Parent: AdvancedSettings
Attributes: CreateIccBasedColorSpaceResources, UseIccBasedColorSpaces, UseMasters,
UseOverlays, UseProcset, UseSeparationColorSpaces
Subelements: Conformance, DocumentSplitting, InternalDataEncoding, InternalOrEx-
ternalFontResources, JobLabel

PageMedia

Parent: PrinterConfig
Attributes: CreateMediaResources, CreateToDirAsSpoolFile, ExternalDirectory
Subelements: None

Patterns

Parent: Images
Attributes: ReplacePatternByClippingPath, UseInlinePatternsInOverlays, UseInlinePat-
ternsInPages
Subelements: None

Person

Parent: Contact
Attributes: FamilyName, FirstName, NamePrefix
Subelements: None

PrinterConfig

Parent: Engine
Attributes: Name
Subelements: Impositioning, JDFConfig, PageMedia

Process

Parent: Processes
Attributes: Name
Subelements: DigitalPrintingParams, ImpositionParams, InterpretingParams, Layout-
PreparationParams, Properties, RenderingParams, ScreeningParams

Processes

Parent: JDF
Attributes: None
Subelements: Process

Properties

Parent: Process
Attributes: Enabled, Order
Subelements: None

PsOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles, PPMLVersion
Subelements: None

2585
19 Appendices

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

2586
 19.4 Configuration

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingParams

Parent: Process
Attributes: Class, ID, Locked, OverPrintBlackLineArt, OverPrintBlackText, Status, Usage
Subelements: ObjectResolution

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Resource

Parent: Resources
Attributes: Amount, BillingCode, Class, ComponentType, CustomerID, CustomerJob-
Name, ID, Locked, Name, PagesFrom, PagesTo, Prefix, Status, Usage
Subelements: Contact

Resources

Parent: JDF
Attributes: None
Subelements: Resource

Root

Parent: Data
Attributes: None
Subelements: Element

ScreeningParams

Parent: Process
Attributes: Class, Frequency, ID, Locked, Status, Usage
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

2587
19 Appendices

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute, Element

SubElements

Parent: Element
Attributes: None
Subelements: Attribute

TIFF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

VIElements

Parent: AdvancedSettings
Attributes: None
Subelements: CachedVIElements, CorrectionOfInlineElements, GlobalCache, JobU-
niqueElementNames, OverwriteCache

Validator

Parent: JDF
Attributes: Name, Type
Subelements: Data

Value

Parent: Attribute
Attributes: Name
Subelements: None

Value

Parent: Attribute
Attributes: Name
Subelements: None

2588
 19.4 Configuration

19.4.5.23 <Engine EngineType="Raster">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Raster engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: BarcodeResizeSettings
Attributes: X, Y
Subelements: None

AlignType

Parent: BarcodeResizeSettings
Attributes: None
Subelements: None

Angle

Parent: Ditherer
Attributes: None
Subelements: None

BarcodeResizeSettings

Parent: FormatConfig
Attributes: None
Subelements: Absolute, AlignType, Relative

BuiltInProfile

Parent: ICCProfileSettings
Attributes: None
Subelements: None

ColorFeature

Parent: FormatConfig
Attributes: None
Subelements: None

ColorFeature

Parent: DitheringSettings
Attributes: None
Subelements: None

2589
19 Appendices

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

CustomMatrixComment

Parent: Ditherer
Attributes: None
Subelements: None

DPI

Parent: FormatConfig
Attributes: X, Y
Subelements: None

DPI

Parent: Ditherer
Attributes: X, Y
Subelements: None

DefaultDitherer

Parent: DitheringSettings
Attributes: None
Subelements: None

DitherType

Parent: Ditherer
Attributes: None
Subelements: None

Ditherer

Parent: DitheringSettings
Attributes: None
Subelements: Angle, CustomMatrixComment, DPI, DitherType, LPI, MatrixType

DitheringSettings

Parent: FormatConfig
Attributes: None
Subelements: ColorFeature, DefaultDitherer, Ditherer

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

2590
 19.4 Configuration

FormatConfig

Parent: Engine
Attributes: Name
Subelements: BarcodeResizeSettings, ColorFeature, DPI, DitheringSettings, GraphicFea-
ture, GrayscalePrinting, HighlightVariables, ICCProfileSettings, ImageStreamerType,
Interlace, OutputColorSpace, PDFDPI, PrimerEnabled, PrimerGrow, Quality, SpotColors,
SupportEverythingInOverlay, SupportNotOnlyCMYK, SupportPlentyOfFonts, WhitePro-
cessing, splitsetting

GraphicFeature

Parent: FormatConfig
Attributes: None
Subelements: None

GrayscalePrinting

Parent: FormatConfig
Attributes: None
Subelements: None

HighlightVariables

Parent: FormatConfig
Attributes: None
Subelements: None

ICCProfileBinary

Parent: ICCProfileSettings
Attributes: None
Subelements: None

ICCProfileSettings

Parent: FormatConfig
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ImageStreamerType

Parent: FormatConfig
Attributes: None
Subelements: None

Interlace

Parent: FormatConfig
Attributes: None
Subelements: None

2591
19 Appendices

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

LPI

Parent: Ditherer
Attributes: None
Subelements: None

MatrixType

Parent: Ditherer
Attributes: None
Subelements: None

OutputColorSpace

Parent: FormatConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PDFDPI

Parent: FormatConfig
Attributes: X, Y
Subelements: None

PrimerEnabled

Parent: FormatConfig
Attributes: None
Subelements: None

PrimerGrow

Parent: FormatConfig
Attributes: None
Subelements: None

Quality

Parent: FormatConfig
Attributes: None
Subelements: None

2592
 19.4 Configuration

Relative

Parent: BarcodeResizeSettings
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup1

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfileSettings
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfileSettings
Attributes: None
Subelements: None

2593
19 Appendices

RenderingIntentHandlingGroup7

Parent: ICCProfileSettings
Attributes: None
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

SpotColors

Parent: FormatConfig
Attributes: Visibility
Subelements: None

SupportEverythingInOverlay

Parent: FormatConfig
Attributes: None
Subelements: None

SupportNotOnlyCMYK

Parent: FormatConfig
Attributes: None
Subelements: None

SupportPlentyOfFonts

Parent: FormatConfig
Attributes: None
Subelements: None

WhiteProcessing

Parent: FormatConfig
Attributes: None
Subelements: None

2594
 19.4 Configuration

head

Parent: setting
Attributes: posx, width
Subelements: None

setting

Parent: splitsetting
Attributes: media, shrink
Subelements: head

splitsetting

Parent: FormatConfig
Attributes: None
Subelements: setting

19.4.5.24 <Engine EngineType="SWF">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the SWF engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig, FormatConfigBinary

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

AddKeys

Parent: Navigation
Attributes: None
Subelements: None

AddPanel

Parent: Navigation
Attributes: None
Subelements: None

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

2595
19 Appendices

CatalogHTML

Parent: Navigation
Attributes: None
Subelements: None

CatalogLocation

Parent: Navigation
Attributes: None
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

CompressionForJpg

Parent: ImageSetting
Attributes: None
Subelements: None

CompressionForOther

Parent: ImageSetting
Attributes: None
Subelements: None

CropPage

Parent: FormatConfig
Attributes: None
Subelements: None

DPI

Parent: ImageSetting
Attributes: DPIOver, MaxDPI
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EmbeddedObjects

Parent: FormatConfig
Attributes: None
Subelements: Enabled, Location, Prefix

2596
 19.4 Configuration

Enabled

Parent: EmbeddedObjects
Attributes: None
Subelements: None

Enabled

Parent: ExternalImages
Attributes: None
Subelements: None

ExternalImages

Parent: FormatConfig
Attributes: None
Subelements: Enabled, Location, Prefix

FormatConfig

Parent: Engine
Attributes: Name
Subelements: CropPage, EmbeddedObjects, ExternalImages, GradientResolution,
ImageHandling, Navigation, OutputResolution, ResizeBarcodes

FormatConfigBinary

Parent: Engine
Attributes: Name
Subelements: None

GradientResolution

Parent: FormatConfig
Attributes: None
Subelements: None

ImageHandling

Parent: FormatConfig
Attributes: None
Subelements: ImageSetting

ImageSetting

Parent: ImageHandling
Attributes: None
Subelements: CompressionForJpg, CompressionForOther, DPI, JpegQuality

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

2597
19 Appendices

JpegQuality

Parent: ImageSetting
Attributes: None
Subelements: None

Location

Parent: EmbeddedObjects
Attributes: None
Subelements: None

Location

Parent: ExternalImages
Attributes: None
Subelements: None

Navigation

Parent: FormatConfig
Attributes: None
Subelements: AddKeys, AddPanel, CatalogHTML, CatalogLocation, NavigationType,
PanelLocation, PanelScale

NavigationType

Parent: Navigation
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputResolution

Parent: FormatConfig
Attributes: None
Subelements: None

PanelLocation

Parent: Navigation
Attributes: None
Subelements: None

PanelScale

Parent: Navigation
Attributes: None
Subelements: None

2598
 19.4 Configuration

Prefix

Parent: EmbeddedObjects
Attributes: None
Subelements: None

Prefix

Parent: ExternalImages
Attributes: None
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

ResizeBarcodes

Parent: FormatConfig
Attributes: None
Subelements: Absolute, AlignType, Relative

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

19.4.5.25 <Engine EngineType="Text">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the Text engine dialog description.

2599
19 Appendices

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

BottomLeftCorner

Parent: Table
Attributes: BottomLeftCornerChar, BottomLeftCornerCode
Subelements: None

BottomLine

Parent: Table
Attributes: BottomLineChar, BottomLineCode
Subelements: None

BottomMiddleCrossing

Parent: Table
Attributes: BottomMiddleCrossingChar, BottomMiddleCrossingCode
Subelements: None

BottomRightCorner

Parent: Table
Attributes: BottomRightCornerChar, BottomRightCornerCode
Subelements: None

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

DataEncoding

Parent: FormatConfig
Attributes: EndOfLine, TextCodec
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

FormatConfig

Parent: Engine
Attributes: Name
Subelements: DataEncoding, General, Table

2600
 19.4 Configuration

General

Parent: FormatConfig
Attributes: GlyphsPerLine, HeightOfLine, SpaceCharacterCode, SupplementaryChar-
Support, SupportEastAsiaChars, WidthOfLine
Subelements: UrlMode

HorizontalLine

Parent: Table
Attributes: HorizontalLineChar, HorizontalLineCode
Subelements: None

InnerLinesCrossing

Parent: Table
Attributes: InnerLinesCrossingChar, InnerLinesCrossingCode
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

LeftLine

Parent: Table
Attributes: LeftLineChar, LeftLineCode
Subelements: None

LeftMiddleCrossing

Parent: Table
Attributes: LeftMiddleCrossingChar, LeftMiddleCrossingCode
Subelements: None

NoBorder

Parent: Table
Attributes: NoBorderChar, NoBorderCode
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

RightLine

Parent: Table
Attributes: RightLineChar, RightLineCode
Subelements: None

2601
19 Appendices

RightMiddleCrossing

Parent: Table
Attributes: RightMiddleCrossingChar, RightMiddleCrossingCode
Subelements: None

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

Table

Parent: FormatConfig
Attributes: None
Subelements: BottomLeftCorner, BottomLine, BottomMiddleCrossing, BottomRight-
Corner, HorizontalLine, InnerLinesCrossing, LeftLine, LeftMiddleCrossing, NoBorder,
RightLine, RightMiddleCrossing, TopLeftCorner, TopLine, TopMiddleCrossing, To-
pRightCorner, VerticalLine

TopLeftCorner

Parent: Table
Attributes: TopLeftCornerChar, TopLeftCornerCode
Subelements: None

TopLine

Parent: Table
Attributes: TopLineChar, TopLineCode
Subelements: None

TopMiddleCrossing

Parent: Table
Attributes: TopMiddleCrossingChar, TopMiddleCrossingCode
Subelements: None

TopRightCorner

Parent: Table
Attributes: TopRightCornerChar, TopRightCornerCode
Subelements: None

2602
 19.4 Configuration

UrlMode

Parent: General
Attributes: None
Subelements: None

VerticalLine

Parent: Table
Attributes: VerticalLineChar, VerticalLineCode
Subelements: None

19.4.5.26 <Engine EngineType="VIPP">

The individual nodes in the JOB config file correspond with the options that have been set in
the engine configuration dialog. For more information see the VIPP engine dialog description.

For general information about the structure and meaning of the individual items in the JOB
file see JOB File Structure section.

Engine

Attributes: EngineType
Subelements: DriverConfig, FormatConfig

Absolute

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

AdvancedSettings

Parent: FormatConfig
Attributes: ResetAllValuesTo
Subelements: DSC, Engine, Fonts, ImageFormat, Images, PJLCommands, XeroxSettings

AlignType

Parent: ResizeBarcodes
Attributes: None
Subelements: None

BMP

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

BuiltInProfile

Parent: ICCProfile
Attributes: None
Subelements: None

2603
19 Appendices

Comment

Parent: DriverConfig
Attributes: None
Subelements: None

CreateImages

Parent: Images
Attributes: CreateInto, Dir
Subelements: None

DSC

Parent: AdvancedSettings
Attributes: DocumentStructuringConventionsType, EOL, LineLength
Subelements: None

DriverConfig

Parent: Engine
Attributes: DriverConfigType, Name
Subelements: Comment, JobName, OutputFileName, Split, SplitBySize, SplitSize

EPS

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

Engine

Parent: AdvancedSettings
Attributes: CompressedTemporaryFiles, CopyAllFilesToRightDirOnFinishAtOnce,
MaximumOfPageLengthInMetres, ZipAllFiles
Subelements: ICCProfile, ResizeBarcodes

Filter

Parent: ImageFilters
Attributes: Name
Subelements: None

FontEncoding

Parent: Fonts
Attributes: AdvanceEncoding, Encoding, PredefinedEncoding, ShareFontEncoding,
UseEncodingForFonts
Subelements: None

Fonts

Parent: AdvancedSettings
Attributes: ASCIICharstringEncryption, ASCIIEexecEncrytion, MaximalCountOfSingle-
ByteFonts, TextEncodings, Use, UseEexecEncryption
Subelements: FontEncoding

2604
 19.4 Configuration

FormatConfig

Parent: Engine
Attributes: Name
Subelements: AdvancedSettings, XeroxOutputOption

ICCProfile

Parent: Engine
Attributes: None
Subelements: BuiltInProfile, ICCProfileBinary, RenderingIntent, RenderingIntentHand-
lingGroup0, RenderingIntentHandlingGroup1, RenderingIntentHandlingGroup2,
RenderingIntentHandlingGroup3, RenderingIntentHandlingGroup4, RenderingIn-
tentHandlingGroup5, RenderingIntentHandlingGroup6, RenderingIntentHand-
lingGroup7

ICCProfileBinary

Parent: ICCProfile
Attributes: None
Subelements: None

ImageFilters

Parent: Images
Attributes: None
Subelements: Filter

ImageFormat

Parent: AdvancedSettings
Attributes: CachedImages, LocationPrefix, PutTransparentMonochromaticImagesInto-
Fonts
Subelements: ImageTypeConversion

ImageTypeConversion

Parent: ImageFormat
Attributes: ConvertUnsupportedImagesTypeInto, JPGCompressionQuality, MakeSim-
plePdfPages, SuppressNativeLoading
Subelements: ImagesSupportByPrinter

Images

Parent: AdvancedSettings
Attributes: CreateIccBasedColorSpaceResources, ImageBufferSize, ImageColorSpace,
ImagesRenderDPI, UseIccBasedColorSpaces
Subelements: CreateImages, ImageFilters

ImagesSupportByPrinter

Parent: ImageTypeConversion
Attributes: None
Subelements: BMP, EPS, JPG, PCX, PDF, TIF

2605
19 Appendices

JPG

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

JobName

Parent: DriverConfig
Attributes: None
Subelements: None

OutputFileName

Parent: DriverConfig
Attributes: None
Subelements: None

PCX

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

PDF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

PJLCommands

Parent: AdvancedSettings
Attributes: EndPJLCommands, IncludePJLCommand, StartPJLCommands
Subelements: None

Relative

Parent: ResizeBarcodes
Attributes: X, Y
Subelements: None

RenderingIntent

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup0

Parent: ICCProfile
Attributes: None
Subelements: None

2606
 19.4 Configuration

RenderingIntentHandlingGroup1

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup2

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup3

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup4

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup5

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup6

Parent: ICCProfile
Attributes: None
Subelements: None

RenderingIntentHandlingGroup7

Parent: ICCProfile
Attributes: None
Subelements: None

ResizeBarcodes

Parent: Engine
Attributes: None
Subelements: Absolute, AlignType, Relative

Segments

Parent: XeroxSettings
Attributes: Directory, Generate, SegmentsAlwaysEmbeded, VPF
Subelements: None

2607
19 Appendices

Split

Parent: DriverConfig
Attributes: None
Subelements: None

SplitBySize

Parent: DriverConfig
Attributes: None
Subelements: None

SplitSize

Parent: DriverConfig
Attributes: None
Subelements: None

TIF

Parent: ImagesSupportByPrinter
Attributes: Support, UseOriginalSourceCode
Subelements: None

XeroxOutputOption

Parent: FormatConfig
Attributes: AddDebugInfoIntoSpool, OutputProfiles
Subelements: None

XeroxSettings

Parent: AdvancedSettings
Attributes: LocationPrefix, UseOverlays
Subelements: Segments

19.5 Importing PrintNet 3 Jobs

19.5.1 Importing PrintNet 3 Jobs Overview
See also:
Possible Issues when Importing from
PrintNet 3
Other Differences between PrintNet 3
and Inspire Designer
Importing Barcodes from PrintNet 3
Functionality Missing in PrintNet 3
Import options in Workflow Window
Options

Note This functionality is not supported by Mac version of Inspire Designer.

2608
 19.5 Importing PrintNet 3 Jobs

This section deals with the conditions necessary for importing PrintNet 3 jobs to Inspire Designer.

It is necessary to have installed PrintNet 3.16 with:

PrintLayout version 3.16.02 B08 or higher

condproc.fcv version 3.16.03 or higher

release version of PrintNet T 4.1 or higher

For proper functionality of PrintNet 3 jobs import, it is necessary that Playout.exe file is registered
in Windows registry which 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

Automatically by the PrintNet 3 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 Inspire Designer directory. This DLL is installed with Inspire Designer.

For customers with 3.15 installations it is necessary to have component PLCOM.EXE. This
component is called by Inspire Designer program.

Note It is not possible to run this separately. It has to be registered (in a 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).

19.5.1.1 Optional settings in Inspire Designer

Go to Options Dialog | General options | PTF Import:

Add flow area height (does not work for PTF created from Quark)

Round font size

Default data file

Import barcode as GSR Font

Embedded pictures and textures are saved as PNG files into the user temp directory.

Example "C:\Documents and Settings\user name\LocalSettings\Temp\Shape00001.PNG"

The text encoding for variables is selected from Options dialog | Default code page. Other parts
of job are in Unicode .

2609
19 Appendices

19.5.2 Importing Barcodes from PrintNet 3

See also:
Importing PrintNet 3 Jobs - Possible Issues
Barcodes

As barcodes in Inspire Designer are generated using different methods than in PrintNet 3, there
can be some inconsistencies when importing PrintNet 3 barcodes to Inspire Designer (due to
rounding problems, varying algorithms etc.).

19.5.2.1 PrintNet 3 Barcodes in Inspire Designer

The following barcodes cause specific problems when imported to Inspire Designer:

Code 39 PrintNet 3 does not use white space for the Code 39 barcode type, contrary to the
specification for this barcode type. When a PLS file containing a Code 39 barcode is im-
ported into Inspire Designer, the barcode seems to have shifted, because the white space
(set to the minimum value of 10, according to the Barcode 39 specification) has been added
during import.

However, if you select the Import barcode as GSR fonts option in the PTF Import section
of the Layout Options dialog, the white space will not be added, as the barcode will be
imported as a bitmap font.

EAN 13, EAN 8, UPC A, UPC E . The font size of numbers in these barcodes is independent
of the barcode size in Inspire Designer, so they keep their size. In PrintNet 3, the font size
of numbers changes proportionally with the barcode size.

Codabar Monarch, EAN 128, ... The algorithm for calculating control digits has several
variants, so it is possible that a barcode from PrintNet 3 will look different in Inspire De-
signer (the bars will be different) - but the barcode reader will return the same result (the
decoded string is the same).

The following barcodes cause problems concerning either their length or density:

Code 39

Code 93

Code 128

Codabar

Micro PDF

JapanPost

S.Stealth-Dots

AustraliaPost

PostNet

2610
 19.5 Importing PrintNet 3 Jobs

RoyalMail

Deutsche Post AG

For each of the above, the barcode is larger after being imported to Inspire Designer, depending
on the actual density, height and number of rows of the barcode.

The following barcodes do not exist in Inspire Designer:

EAN Add On 2/5

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

19.5.3 Functionality Missing in PrintNet 3

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

19.5.3.1 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 In-
spire Designer.

2611
19 Appendices

19.5.4 Possible Issues when Importing from

PrintNet 3
In this section the problems or inconsistencies between Inspire Designer and PrintNet 3 func-
tionality are mentioned.

List of limitations:

Pictures image filters (some of them should be implemented)

Printcommands (PrintVarFont, PrintVarDest, PrintVarCMYK) are not supported.

Connected objects are not supported.

Tables (= Dynamic Line Draw) are not supported.

System functions (Machine Name, Job Name, Data File Name, Layout Name, Current
Mailpiece, Last Page Number) are not supported

Current Page Number works correctly, there should be differences only when there
are incorrect values in PrintNet 3 (e.g. 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 names in default data file spaces etc. Spaces will
be changed to underscores in Inspire Designer. In Inspire Designer it is not possible to
use field names that have a number character in the beginning. The underscores will
be also added in front of these numbers.

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 (automatically created field
names). Numeration in PrintNet 3 starts from Field1 and in Inspire Designer starts from
Field0. Field names are case sensitive in Inspire Designer. If field is not imported and
the field uses font which is not used anywhere else, the font is not imported at all.

Importing PrintNet 3 jobs using a different code page than the current code page selected
in Inspire Designer:

2612
 19.5 Importing PrintNet 3 Jobs

Since PrintNet 3 jobs are singlecode, there may occur font errors when the code page
of the PrintNet 3 job is not equal to code page set in Options dialog | Default code
page in Inspire Designer. If the code page differ, it is necessary to set the Options
dialog | Default code page in Inspire Designer according to the PrintNet 3 job before
the import. If needed, it can be changed back after the import.

Problem with more fields on the same position in CSV and DBF data file.

Formatting Issues

Ignore Empty Lines in Inspire Designer different (end-of-line characters)

Spacing in PrintNet 3 is different. Standard / Variable formatting. Variable row

height is still the same, independent on changes of font. Could not be imported
identically into Inspire Designer.

Bottom aligned formatting: different in PrintNet 3 and Inspire Designer.

Line spacing exactly, in PrintNet 3 including first line, in Inspire Designer not including
first line.

Font handling the way of getting parameters of certain font is different in PrintNet
3 and Inspire Designer, therefore there can be some minor differences in the fol-
lowing: 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 PrintNet 3 vs. Inspire Designer depends on machine
resolution in PrintNet 3, 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 are not supported

Index file settings are not supported

Data Precise is not supported

19.5.5 PTF Import Warnings

Note This pertains only to objects imported from PrintNet 3.

Select Window | PTF Import Warnings to display (or hide) the panel listing warnings for PTF
import.

Options Description

Warnings Number Number of problems found

Line Number Identifies the line in the Layout Tree causing the warning

2613
19 Appendices

Warning Description of the potential problem

Object Type Type of object that caused the warning

19.5.6 Other Differences between PrintNet 3

and Inspire Designer
First paragraph in Multiple paragraphs is always selected in Layout. In PrintNet 3 any of
them can be selected. It is possible to select this paragraph in Inspire Designer Layout
after import. (Only displaying in Layout, in proof it is OK).

Multiple paragraphs (first fitting) should have longer frame in PrintNet 3 than the frame
that is for selection. In this case different paragraphs in Inspire Designer are selected
than in PrintNet 3.

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

2614
 19.5 Importing PrintNet 3 Jobs

In case of image smaller than a surrounding frame: origin in PrintNet 3 (left image) is
the top left corner of the surrounding frame, in Inspire Designer (right image) it is center
of the flow area

In case of image is bigger than a surrounding frame in both directions: in PrintNet 3

(left image) it is center frame, in Inspire Designer (right image) it is top left corner of
flow area

In case of image is bigger than a surrounding frame in both directions: in PrintNet 3

(left image) it is center frame, in Inspire Designer (right image) it is top left corner of
flow area

Monochrome pictures with colors different from B/W (for example 1 green and 0 pink),
result in PrintNet 3 B/W (because the printer limitations) and in Inspire Designer
green/pink.

B/W jobs that are created from colored jobs (machine changes etc), should be imported
in Inspire Designer with these colors.

Name of pictures from data file (custcode etc.) must have suffix. In PrintNet 3 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 PrintNet 3).

2615
19 Appendices

Small flow areas different understanding of row heights in Inspire Designer, if there
are smaller flows, it is possible to set enlargement of flows in the Add flow area height
edit-box in the Options dialog.

Difference between PTF from PrintNet 3 and PTF from Word and PTF from Quark.

19.6 IPDS Exceptions

19.6.1 IPDS Exceptions Summary
See also:
IPDS Exceptions Level Configuration
Dialog

An IPDS Exception is a code that reports an exception or an error that has occurred during
printing.

The following chapters contain an explanation of individual exceptions according to class:

8001..00 - 80E0..00 Command - Reject Exceptions

0100..00 - 01E4..00 Conditions Requiring Host Notification

0821..00 - 08C1..00 Data - Check Exceptions

5010..00 - 50F9..00 Equipment Check with Intervention Required Exceptions

10F1..00 - 10F5..00 Equipment-Check Exceptions

4000..00 - 40E8..00 Intervention-Required Exceptions

0200..01 - 02FF..02 Specification Check - General Exceptions

0403..00 - 0411..00 Specification Check - Barcode Exceptions

0300..01 - 03E1..00 Specification Check - Graphics Data Exceptions

0500..01 - 05A9..02 Specification Check - IO-Image Exceptions

19.6.2 Command - Reject Exceptions

See also:
IPDS Exceptions Summary

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.

2616
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

80E0..00 Invalid IPDS command length

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

2617
19 Appendices

Page Continuation Action None

Support Optional

Tip 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.

19.6.3 Conditions Requiring Host Notification

See also:
IPDS Exceptions Summary

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'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

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 self-defining 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.

2618
 19.6 IPDS Exceptions

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 in-
stalled media sources was changed.

The media identification of one or more of the installed media sources was changed.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0102..00 MICR printing status changed

Action Code X'1D'

Explanation MICR printing is now available.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0103..00 BTS/CTS status changed

Action Code X'1D'

Explanation Burster-trimmer-stacker or cutter-trimmer-stacker status has changed.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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-des-
tination ID has become available (supported) or has become unavailable (not supported).

2619
19 Appendices

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0110..00 Print Position Adjustment

Action Code X'1A'

Explanation An operator adjustment is taking place or has just taken place.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0120..00 Colorant information changed

Action Code X'1D'

Explanation One or more colorants has become available, has become unavailable, or has
changed a colorant-availability flag.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory, if indexed CMRs are supported.

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2620
 19.6 IPDS Exceptions

01E4..00 Cancel key pressed

Action Code X'15'

Explanation The Cancel key on the printer operator panel was pressed while the printer was
receiving data.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

19.6.4 Data - Check Exceptions

See also:
IPDS Exceptions Summary

A data-check exception indicates that the printer has detected an undefined character or pos-
ition 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

Action Code X'01' or X'1F'

Explanation 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 LF1-type restricted section (sections X'45' through X'FE'),
the print position is incremented using the default variable space increment. For an un-

2621
19 Appendices

defined 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

Note

1. 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.

2. This corresponds to a PTOCA exception.

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 LF1-type restricted section (sections X'45' through X'FE'),
the print position is incremented using the default variable space increment. For an un-
defined 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

Note

1. 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.

2. This corresponds to a PTOCA exception

2622
 19.6 IPDS Exceptions

0829..00 Double-byte coded font section is not activated or is invalid

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The double-byte coded font section specified in a code point is not activated.

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

Tip Reporting of this exception is controlled by the Report Undefined Character Check bit in
the XOA Exception-Handling Control command.

0860..00 Numeric representation precision check

Action Code X'01' or X'1F'

Explanation The print position cannot be represented by the printer.

Alternate Exception Action None

Page Continuation Action Ignore the command and skip to the next END command.

Support Mandatory

Tip

1. Some printers report this exception as X'0215..01' or X'0216..01'. The preferred excep-
tion is X'0860..00'.

2. 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

Action Code X'01' or X'1F'

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.

Page Continuation Action All printing outside the valid printable area is suppressed. All
data and controls continue processing. The printer continues to print within the valid

2623
19 Appendices

printable area to the 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

Note

1. 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.

2. 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.

3. Reporting of this exception is controlled by the Report Page Position Check bit in the
XOA Exception-Handling Control command.

4. 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 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.

Page Continuation 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. 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

Note

1. 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.

2. 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.

2624
 19.6 IPDS Exceptions

3. Reporting of this exception is controlled by the Report Page Position Check bit in the
XOA Exception-Handling Control command.

4. This corresponds to a PTOCA exception

19.6.5 Equipment-Check Exceptions

See also:
IPDS Exceptions Summary

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'

Explanation One or more of the following conditions occurred:

A permanent hardware failure exists.

The printer detected either a logic exception from which the printer could not re-
cover or a condition that should not have occurred. The session and conversation
should be terminated.

Alternate Exception Action None

Page Continuation Action None

Support Optional

10F2..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. 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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2625
19 Appendices

10F3..00 Magnet setting changed

Action Code X'23'

Explanation The magnet setting on the media cassette changed after a page was processed
but before the page was printed.

Alternate Exception Action None

Page Continuation Action None

Support Optional

10F4..00 Serializer parity exception

Action Code X'23'

Explanation A parity exception has occurred within the image generator (first occurrence).

Alternate Exception Action None

Page Continuation Action None

Support Optional

10F5..00 Image generator exception

Action Code X'23'

Explanation A hardware failure has occurred within the image generator.

Alternate Exception Action None

Page Continuation Action None

Support Optional

19.6.6 Equipment Check with Intervention

Required Exceptions
See also:
IPDS Exceptions Summary

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 inter-
vention 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.

2626
 19.6 IPDS Exceptions

5010..00 Printer-Hardware Exception

Action Code X'16'

Explanation A printer-hardware exception was detected.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

50F2..00 Print Overrun

Action Code X'22'

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 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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2627
19 Appendices

50F5..00 Image Generator Exception

Action Code X'16'

Explanation A hardware failure has occurred with the Image Generator.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

50F6..00 Offset Stacker Exception

Action Code X'17'

Explanation The Offset Stacker is not available (has been disabled).

Alternate Exception Action None

Page Continuation Action None

Support Optional

50F7..00 Duplex Media Path Exception

Action Code X'17'

Explanation Duplex capability is not available (has been disabled).

Alternate Exception Action None

Page Continuation Action None

Support Optional

50F8..nn Media-Source Exception

Action Code X'17'

Explanation Media Source X'nn' is not available (has been disabled).

Alternate Exception Action None

2628
 19.6 IPDS Exceptions

Page Continuation Action None

Support Optional

50F9..00 MICR printing exception

Action Code X'17'

Explanation MICR printing is not available (has been disabled).

Alternate Exception Action None

Page Continuation Action None

Support Optional

19.6.7 Intervention-Required Exceptions

See also:
IPDS Exceptions Summary

An intervention-required exception indicates that the printer has detected a condition that re-
quires 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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

4000..00 Printer not ready

Action Code X'22'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

2629
19 Appendices

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

4002..00 Media destination is full

Action Code X'1A'

Explanation The media destination (stacker) is full.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2630
 19.6 IPDS Exceptions

4004..00 Out of toner

Action Code X'1A'

Explanation The printer is out of toner.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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 specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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 spe-
cified amount of time.

Alternate Exception Action None

Page Continuation Action None

Support Optional

4010..00 Paper adjustment check

Action Code X'1A'

Explanation A paper adjustment check occurred.

2631
19 Appendices

Alternate Exception Action None

Page Continuation Action None

Support Optional

4011..00 Suppressed 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.

Alternate Exception Action None

Page Continuation Action None

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'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

4020..00 Incorrect Form Module selection

Action Code X'1A'

Explanation An incorrect form module selection was detected.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2632
 19.6 IPDS Exceptions

4031..00 Paper-Length Check

Action Code X'1A'

Explanation The printer has detected a paper-length check.

Alternate Exception Action None

Page Continuation Action None

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 operator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

Support Optional

4033..00 Paper-Width Check

Action Code X'22'

Explanation The printer has detected a paper-width check, and it has not been corrected
by the operator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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 specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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 specified amount of time.

2633
19 Appendices

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

2634
 19.6 IPDS Exceptions

Page Continuation Action None

Support Optional

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.

Alternate Exception Action None

Page Continuation Action None

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 specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

40E2..00 Transport requires corrective action

Action Code X'22'

Explanation The transport mechanism requires corrective action and no action has been
taken by the operator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2635
19 Appendices

40E3..00 Fuser requires corrective action

Action Code X'22'

Explanation The fuser requires corrective action and no action has been taken by the oper-
ator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Note Some printers report this exception as X'01E4..00'. The preferred Exception ID is
X'01E4..00'.

40E4..00 Cancel key pressed

Action Code X'15'

Explanation The Cancel key on the printer operator panel was pressed while the printer was
receiving data.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

2636
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

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 operator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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 cor-
rected by the operator after a specified amount of time.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2637
19 Appendices

19.6.8 IPDS Exceptions Level Configuration

Dialog
See also:
TCP/IP Connection Configuration Dialog
IPDS Exceptions Summary

An IPDS Exception is a code that reports an exception or an error which has occurred during
printing. The list of IPDS exceptions displayed in the IPDS Exceptions level configuration dialog
is based on a standard set by IBM. This dialog enables users to configure the behavior of IPDS
exceptions and to add and remove new IPDS exceptions.

For details concerning exception categories and the conditions under which they occur, see
the IPDS Exceptions Summary.

Options Description

IPDS Code Displays the exceptions unique identification number in xxxx..xx format.

For details concerning exception categories see the IPDS Exceptions Summary.

Message Shows the name of the IPDS exception.

For details concerning IPDS exceptions and the specific conditions under which they occur
see the IPDS Exceptions Summary.

Default level Sets the severity level of IPDS exceptions. The options are listed below:

Default The value set by Inspire Designer as a default.

Message Shows the message from the Message field if the specific conditions
for the selected exception arise. After the message is shown printing continues.

Stop Printing will be stopped if the specific conditions for the selected exception
arise. Clicking on the Continue button in the Jobs Production window enables
users to select a sheet from which printing will continue.

Abort Printing will be aborted if the specific conditions for the selected exception
arise and printing has to be restarted from the beginning.

For details concerning the specific conditions for each setting see IPDS Exceptions Summary.

2638
 19.6 IPDS Exceptions

Autorestart If the specific conditions for the selected exception arise and True is selected in
this field, Inspire Designer will automatically restart printing, i.e. the printing will start from
the first unprinted page.

This option is used when the printing is stopped in consequence of an IPDS exception.

For details concerning the specific conditions of exceptions see the IPDS Exceptions Sum-
mary.

Add exception Clicking on this button opens the Exception ID dialog, that allows to add
a new exception ID and a message.

Options Description

Exception ID in format xxxx..xx Enter the ID of the exception you want to add.

Note It is crucial to keep the correct ID format. Exceptions with IDs not matching
the pattern xxxx..xx are not added to the list.

Message Enter the message indicating the nature of the exception.

Newly added exceptions are marked green. Two clicks or pressing the <F2> key allow
to edit the message. It is possible to edit only the newly added messages, not the
default ones.

Remove exception Clicking on this button enables users to remove added exceptions.

Note It is not recommended to change the default settings for IPDS exceptions.

19.6.9 Specification Check - Barcode

Exceptions
See also:
IPDS Exceptions Summary

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.

2639
19 Appendices

0403..00 Invalid or unsupported bar code type

Action Code X'01' or X'1F'

Explanation The bar code type specified in the bar code data-descriptor self-defining field
is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Bar Code Object Content Architecture Reference

0404..00 Unsupported font local ID or font not available

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

A font local ID specified in the bar code data descriptor self-defining field is unsup-
ported.

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 substitution that preserves as many characteristics as possible of the ori-
ginally requested font while still preserving the original code page. Some bar code sym-
bologies 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 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.

Support Refer to Bar Code Object Content Architecture Reference.

Tip 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.

2640
 19.6 IPDS Exceptions

0405..00 Invalid or unsupported bar code color

Action Code X'01' or X'1F'

Explanation The color specified in the bar code data-descriptor self-defining field is invalid
or unsupported.

Alternate Exception Action Use the printer default color.

Page Continuation Action Use the printer default color.

Support Refer to Bar Code Object Content Architecture Reference

0406..00 Invalid or unsupported module width

Action Code X'01' or X'1F'

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 sup-
ported 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 sup-
ported value. For those printers having only a single (printer default) width, use the printer
default value.

Support Refer to Bar Code Object Content Architecture Reference.

0407..00 Invalid or unsupported element height

Action Code X'01' or X'1F'

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.

Support Refer to Bar Code Object Content Architecture Reference

0408..00 Invalid or unsupported height multiplier

Action Code X'01' or X'1F'

Explanation he height multiplier specified in the bar code data-descriptor self-defining field
is invalid or unsupported.

2641
19 Appendices

Alternate Exception Action The printer uses a multiplier of X'01'.

Page Continuation Action The printer uses a multiplier of X'01'.

Support Refer to Bar Code Object Content Architecture Reference.

0409..00 Invalid or unsupported wide-to-narrow ratio

Action Code X'01' or X'1F'

Explanation The wide-to-narrow ratio specified in the bar code data-descriptor self-defining
field is invalid or unsupported.

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.

Support Refer to Bar Code Object Content Architecture Reference.

040A..00 Invalid or unsupported symbol origin

Action Code X'01' or X'1F'

Explanation The symbol origin given in a WBC command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the command and continue with the next command.

Support Refer to Bar Code Object Content Architecture Reference.

040B..00 Invalid or unsupported bar code modifier

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Bar Code Object Content Architecture Reference.

040C..00 Invalid or unsupported bar code data length

Action Code X'01' or X'1F'

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 un-
supported.

Alternate Exception Action None

2642
 19.6 IPDS Exceptions

Page Continuation Action Ignore the command and continue with the next command.

Support Refer to Bar Code Object Content Architecture Reference.

040E..00 Check-digit calculation exception

Action Code X'01' or X'1F'

Explanation The first check-digit calculation resulting in a value of 10 is defined as an excep-

tion in some of the modifier options (byte 17 of the bar code data-descriptor self-defining
field) for an MSI bar code.

Alternate Exception Action None

Page Continuation Action Ignore the command and continue with the next command.

Support Refer to Bar Code Object Content Architecture Reference.

0410..00 Invalid or unsupported human-readable interpretation location

Action Code X'01' or X'1F'

Explanation The human-readable interpretation location specified in the flags byte of a WBC
command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action None

Support Refer to Bar Code Object Content Architecture Reference.

0411..00 Attempt to print portion of bar code symbol outside object area or VPA

Action Code X'01' or X'1F'

Explanation 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.

Alternate Exception Action None

Page Continuation Action Print partial bar code. Overprint a pattern to destroy readability
of a partial bar code. Continue with next command.

Support Mandatory

2643
19 Appendices

Tip

1. 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.

2. Some printers report this as exception ID X'020A..05', the preferred exeption ID is

X'0411..00'.

3. Reporting of this exception is controlled by the Report Page Position Check bit in the
XOA Exception-Handling Control command.

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.

Alternate Exception Action None

Page Continuation Action Print partial bar code. Overprint a pattern to destroy readability
of a partial bar code. Continue with next command.

Support Optional

Tip

1. 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.

2. Some printers report this as exception ID X'020A..05', the preferred exeption ID is

X'0411..00'.

3. Reporting of this exception is controlled by the Report Page Position Check bit in the
XOA Exception-Handling Control command.

2644
 19.6 IPDS Exceptions

19.6.10 Specification Check - General

Exceptions
See also:
IPDS Exceptions Summary

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 iden-
tified accordingly.

Format 0 is used for all general specification check exceptions

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

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

2645
19 Appendices

0202..02 Invalid or unsupported IPDS command length

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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

Action Code X'01' or X'1F'

Explanation A self-defining field that is less than the minimum allowable length has been
received in a WGC, WIC2, or WBCC command.

Alternate Exception Action None

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 correl-
ation ID is included).

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip 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.

2646
 19.6 IPDS Exceptions

0203..05 Invalid or unsupported object area orientation

Action Code X'01' or X'1F'

Explanation An object area orientation value specified in a self-defining field of a WGC,

WIC2, or WBCC command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

0204..01 EP command encountered before suppression ended

Action Code X'01' or X'1F'

Explanation An EP command was encountered before a text suppression ended.

Alternate Exception Action Terminate suppression as if an End Suppression had been re-
ceived.

Page Continuation Action Terminate suppression as if an End Suppression had been received.

Support Mandatory

Note This corresponds to a PTOCA exception.

0204..02 Invalid use of Acknowledgment-Continuation Bit

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The Acknowledgment-Continuation bit in the flag byte of a command was on

when the printer had no continuation data available.

The Acknowledgment-Continuation bit in the flag byte of a command was B'1',

but the ARQ bit was B'0'.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0204..05 Invalid or unsupported value for area-position reference system

Action Code X'01' or X'1F'

Explanation The reference system specified in the area-position self-defining field for a
WGC, WIC2, or WBCC command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2647
19 Appendices

0205..01 Invalid spanning sequence

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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 re-
ceived.

Alternate Exception Action None

Page Continuation Action Skip to END or END PAGE command.

Support Mandatory

0205..02 Invalid setting of the LPD ordered page flag

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

0206..01 Invalid Begin Suppression (BSU)

Action Code X'01' or X'1F'

Explanation A text BSU control sequence has been encountered in a page, page segment,
or overlay before a previous suppression ended.

2648
 19.6 IPDS Exceptions

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence

Support Mandatory

Note This corresponds to a PTOCA exception.

0206..05 Invalid or unsupported units per unit base

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

Tip 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

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

0208..05 Invalid or unsupported mapping option

Action Code X'01' or X'1F'

Explanation A mapping option value specified in the output-control self-defining field of a

WGC, WIC2, or WBCC command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2649
19 Appendices

0209..05 Invalid or unsupported axis offsets

Action Code X'01' or X'1F'

Explanation The axis offset values specified in the output-control self-defining field of a
WGC, WBCC, or WIC2 command are invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

020A..05 Data within an object area might be outside the VPA

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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

Tip

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.

2650
 19.6 IPDS Exceptions

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:

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

Tip

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.

020B..05 Invalid or missing self-defining-field identifier

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2651
19 Appendices

020C..01 Invalid or unsupported font local ID

Action Code X'01' or X'1F'

Explanation A font local ID in a text Set Coded-Font Local (SCFL) control sequence or in a
LPD command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action None

Support Refer to Presentation Text Object Content Architecture Reference.

Note This corresponds to a PTOCA exception.

020E..03 Invalid or unsupported color value

Action Code X'01' or X'1F'

Explanation One of the following conditions occurs:

The color value field in a Color Specification (X'4E') triplet contains an invalid or
unsupported value. The triplet occurs in either a LPD, WIC2, WGC, WBCC, WOCC,
or IDO command.

The color value field in a PTOCA Set Extended Text Color (SEC) control sequence
contains an invalid or unsupported value. The control sequence occurs in a Write
Text command.

The color value field in a GOCA Set Process Color (GSPCOL) drawing order contains
an invalid or unsupported value. The drawing order occurs in a Write Graphics
command.

A specified highlight color number is in the range X'0100'X'FFFF', but a host-in-

voked Indexed CMR is not found.

An Indexed CMR is selected for use with a highlight color value, but the color value
is not found in the Indexed CMR. Note that only the selected Indexed CMR is
searched for this color value.

Alternate Exception Action For SEC and GSPCOL, use a highlight color if it is supported,
else use the printer default color. For the Color Specification triplet, use a highlight color
if it is supported, else use the color of medium.

Page Continuation Action For SEC and GSPCOL, use a highlight color if it is supported,
else use the printer default color. For the Color Specification triplet, use a highlight color
if it is supported, else use the color of medium.

Support Mandatory when logical page and object area coloring, PTOCA PT3, or GOCA
GSPCOL are supported.

Note

1. This corresponds to a PTOCA and GOCA exception.

2. For printers that support color fidelity control, reporting of this exception can be con-
trolled by the Color Fidelity triplet in the PFC command.

2652
 19.6 IPDS Exceptions

020F..01 Invalid or unsupported Set Text Orientation (STO)

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The inline or baseline orientation specified in a text STO control sequence is an in-
valid 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

Note This corresponds to a PTOCA exception.

0210..01 Invalid or unsupported Set Inline Margin (SIM)

Action Code X'01' or X'1F'

Explanation The inline margin value specified in a text Set Inline Margin control sequence
or in a LPD command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence. LPD errors have no PCA.

Support Mandatory

Note This corresponds to a PTOCA exception.

0211..01 Invalid or unsupported Set Baseline Increment (SBI)

Action Code X'01' or X'1F'

Explanation The baseline increment value specified in a text Set Baseline Increment control
sequence or in a LPD command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence. LPD errors have no PCA.

Support Mandatory

0212..01 Invalid or unsupported intercharacter adjustment

Action Code X'01' or X'1F'

Explanation The intercharacter adjustment value specified in a text Set Intercharacter Adjust-
ment 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

2653
19 Appendices

smallest supported value. If the direction value is invalid or not supported, the printer uses
X'00' (increment).

Page Continuation Action Ignore the Write Text control sequence. LPD errors have no PCA.

Support Mandatory

Note This corresponds to a PTOCA exception.

0212..02 Font storage is full

Action Code X'0C'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'023A..02' or X'02AF..01'. The preferred exception
ID is X'02AF..01'.

0213..01 Invalid or unsupported Absolute Move Baseline (AMB)

Action Code X'01' or X'1F'

Explanation The position value specified in a text Absolute Move Baseline control sequence
is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

0214..01 Invalid or unsupported Absolute Move Inline (AMI)

Action Code X'01' or X'1F'

Explanation The position value specified in a text Absolute Move Inline control sequence is
invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

2654
 19.6 IPDS Exceptions

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0214..03 Unsupported baseline move

Action Code X'01' or X'1F'

Explanation Unsupported advancement of the baseline coordinate toward the I-axis.

Alternate Exception Action None

Page Continuation Action None

Support Refer to Presentation Text Object Content Architecture Reference.

Note

1. Some printers report this exception as X'0205..02'. The preferred exception is

X'0205..02'.

2. This corresponds to a PTOCA exception.

0215..01 Invalid or unsupported Relative Move Inline (RMI)

Action Code X'01' or X'1F'

Explanation The displacement value specified in a text Relative Move Inline control sequence
is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Refer to Presentation Text Object Content Architecture Reference.

Note

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.

2655
19 Appendices

0215..02 Invalid or unsupported DF command font or font-section ID

Action Code X'01'

Explanation One or more of the following conditions occurred:

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; how-

ever, 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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0216..01 Invalid or unsupported Relative Move Baseline (RMB)

Action Code X'01' or X'1F'

Explanation The displacement value specified in a text Relative Move Baseline control se-
quence is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Refer to Presentation Text Object Content Architecture Reference.

Note

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.

0217..01 Invalid or unsupported Set Variable-Space Character Increment (SVI)

Action Code X'01' or X'1F'

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.

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

2656
 19.6 IPDS Exceptions

0217..02 Invalid or unsupported value for DF command deactivation type

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0218..02 Invalid, unsupported, or unavailable font ID

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The font Host-Assigned ID in a LSS, LFC, LFI, or LFE command is invalid or unsup-
ported.

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 ori-
ginally 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

2657
19 Appendices

Note

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

Action Code X'01' or X'1F'

Explanation A text Repeat String control sequence target count is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

0219..02 Multiple occurrences of the same LFE font local ID

Action Code X'01' or X'1F'

Explanation he font local ID in a LFE command has been used more than once, making the
font Host-Assigned ID ambiguous.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

021A..01 Repeat String (RPS) or Transparent Data (TRN) exception

Action Code X'01' or X'1F'

Explanation The source-string length for a text TRN or RPS control sequence must be an
even number for double-byte coded fonts.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

021B..01 Repeat String (RPS) target-string length exception

Action Code X'01' or X'1F'

Explanation The target-string length for a text Repeat String control sequence must be an
even number for double-byte coded fonts.

Alternate Exception Action None

2658
 19.6 IPDS Exceptions

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

021C..01 Invalid escape sequence

Action Code X'01' or X'1F'

Explanation In a WT command, the second byte of what should be an escape sequence

(X'2BD3') is not X'D3'.

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.

021C..02 Invalid LFC command byte-count value

Action Code X'01'

Explanation An invalid value was specified in the byte-count field (bytes 18-20) of a Load
Font Control command.

Alternate Exception Action None

Page Continuation Action None

Support Optional

021D..02 Invalid or unsupported value for the Load Font Equivalence GRID

Action Code X'01' or X'1F'

Explanation One or more of the parameters in the GRID field (bytes 5-12) of the LFE command
are invalid, unsupported, or inconsistent.

Alternate Exception Action None

2659
19 Appendices

Page Continuation Action None

Support Optional

021E..01 Invalid text control-sequence length

Action Code X'01' or X'1F'

Explanation The length of a text control sequence in a Write Text command is invalid.

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.

021E..02 Mismatch between coded font and the XOA Print Quality Control (PQC)
command

Action Code X'01'

Explanation One or more of the following conditions occurred:

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 pre-
serve 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

Action Code X'01' or X'1F'

Explanation A text Repeat String control sequence in a WT command has a nonzero fill
count, but a zero string length.

Alternate Exception Action None

Page Continuation Action Ignore the Write Text control sequence.

Support Mandatory

2660
 19.6 IPDS Exceptions

Note This corresponds to a PTOCA exception.

021F..02 LFE command font Host-Assigned ID already assigned

Action Code X'01' or X'1F'

Explanation The HAID in a LFE command has already been assigned to a GRID that differs
from the GRID in the current LFE command.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

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.

Alternate Exception Action None

Page Continuation Action None

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'.

Alternate Exception Action None

Page Continuation Action None

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 invalid or unsupported.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2661
19 Appendices

0222..02 Invalid or unsupported Load Font Control data pattern format

Action Code X'01'

Explanation The pattern-data format value (byte 4) specified in a LFC command is invalid
or unsupported.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0226..02 Invalid or unsupported LSS or LFC X-box size

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0227..02 Invalid or unsupported LSS or LFC Y-box size

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

2662
 19.6 IPDS Exceptions

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

022A..02 Invalid or unsupported value for Load Font Control units per unit base in the
X direction

Action Code X'01'

Explanation The units per unit base for L-units in the X direction value in a LFC command
is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

2663
19 Appendices

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Page Continuation Action None

Support Mandatory

0232..01 Invalid or unsupported Load Copy Control Keyword in copy-subgroup entry

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2664
 19.6 IPDS Exceptions

Tip 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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip 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'

Explanation One or more of the following conditions occurred:

The number of bytes in the LCC command copy subgroup is not a multiple of two-
byte pairs or is invalid or unsupported.

The number of bytes in the LCC command copy subgroup causes the copy subgroup
to extend beyond the total length of the LCC command.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

2665
19 Appendices

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.

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 specific-
ation. This yields twice as many sheets for each input page as would be printed if the
printer could print duplex.

Page Continuation Action None

Support Mandatory

Tip 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.

Page Continuation Action None

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.

Page Continuation Action None

Support Mandatory

0237..04 Incompatible media source and media destination

Action Code X'09'

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.

Alternate Exception Action None

2666
 19.6 IPDS Exceptions

Page Continuation Action None

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'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2667
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

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 commu-
nications protocol level.

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2668
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

023C..02 Invalid or unsupported value in a Load Font Index command

Action Code X'01'

Explanation One or more of the following conditions occurred:

The uniform or maximum baseline offset value in a LFI command is invalid or un-
supported.

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.

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 baseline-extent value specified.

The underscore width value in a LFI command is invalid.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2669
19 Appendices

Note

1. 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'.

2. 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'

Explanation One or more of the following conditions occurred:

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 com-

mand points past the end of the raster data.

A character-pattern address in the Character Pattern-Descriptor List of a LFC com-

mand points into a previously defined character pattern.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

023F..02 STO-SCFL-LFE mismatch

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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 un-

supported within the current text orientation.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2670
 19.6 IPDS Exceptions

Note

1. 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'.

2. This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0242..01 WIC command pel count is less than the minimum required

Action Code X'01' or X'1F'

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'.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

0243..01 WIC command pel count is greater than the maximum supported value

Action Code X'01' or X'1F'

Explanation he 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2671
19 Appendices

0243..02 Invalid double-byte coded font section identifier

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0244..01 WIC command scan-line count is less than the minimum required

Action Code X'01' or X'1F'

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'.

Alternate Exception Action None

Page Continuation Action Skip to END command.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0245..01 WIC command scan-line count is greater than the maximum supported value

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

2672
 19.6 IPDS Exceptions

Page Continuation Action Skip to END command.

Support Mandatory

0246..01 Invalid WIC input image format

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

Byte 8 of a WIC command is not X'00'.

The image-format value (byte 9) of a WIC command is not X'00'.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

0246..02 Invalid parameter in a LFI command

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0247..01 Invalid or unsupported value for Write Image Control magnification factor

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2673
19 Appendices

0247..02 Invalid or unsupported value for Load Font Equivalence font-inline sequence

Action Code X'01' or X'1F'

Explanation The font-inline-sequence parameter in a LFE command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action LFE when not in home state: ignore remainder of command;
entries received prior to error take effect.

Support Mandatory

Tip 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

Action Code X'01' or X'1F'

Explanation The scan-line-direction parameter (bytes 12-13) in a Write Image Control

command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action Skip to END command.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0249..01 Invalid scan-line-sequence direction in a WIC command

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Mandatory

2674
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

024A..01 Invalid or unsupported value for Write Image Control output image location

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The reference coordinate system (byte 16) in a WIC command is invalid or unsup-
ported.

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2675
19 Appendices

024C..02 Invalid or unsupported value for Load Symbol Set data length

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

0253..01 Invalid or unsupported value for Write Image Control image color

Action Code X'01' or X'1F'

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

2676
 19.6 IPDS Exceptions

0258..03 Invalid or unsupported value for text color

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The color field in the Set Text Color (STC) control sequence is invalid or is unsup-
ported.

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 un-
supported.

Alternate Exception Action Use the printer default color.

Page Continuation Action Use the printer default color.

Support Mandatory

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

025C..02 Invalid or unsupported parameter in a DUA command

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2677
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

0262..02 Invalid or unsupported value for LPD X[p] extent or XOH-SMS X[m] extent

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

2678
 19.6 IPDS Exceptions

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

0263..02 Invalid or unsupported value for LPD Y[p] extent or XOH-SMS Y[m] extent

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

2679
19 Appendices

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 The inline-sequence-direction value in a LPD command is invalid

or unsupported.

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

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.

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

026A..01 Insufficient input image data

Action Code X'01' or X'1F'

Explanation The number of input image bytes received is less than the number implied in
a WIC command.

Alternate Exception Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2680
 19.6 IPDS Exceptions

026B..01 Excess input image data received

Action Code X'01' or X'1F'

Explanation The number of input image bytes received is greater than the number implied
in a WIC command.

Alternate Exception Action None

Page Continuation Action Skip to END 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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Note This corresponds to a PTOCA exception.

026E..01 Invalid or unsupported value in a XOH-SMM command

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2681
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2682
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

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 unsup-
ported.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

027A..01 Invalid XOH-DGB triplet length value

Action Code X'01'

Explanation The length specified in a XOH-DGB triplet is less than X'02'.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0280..02 Invalid or unsupported rule width

Action Code X'01' or X'1F'

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.

2683
19 Appendices

Alternate Exception Action Use the closest supported nonzero rule-width value.

Page Continuation Action Use the closest supported nonzero rule-width value.

Support Refer to Presentation Text Object Content Architecture Reference.

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

0282..02 Invalid or unsupported rule length

Action Code X'01' or X'1F'

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.

Support Refer to Presentation Text Object Content Architecture Reference.

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

2684
 19.6 IPDS Exceptions

Page Continuation Action None

Support Mandatory

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

028A..02 Invalid or unsupported value for Load Font Control Relative-Metric Multiplying
Factor

Action Code X'01'

Explanation The Relative-Metric Multiplying Factor value in a LFC command is invalid or

unsupported.

Alternate Exception Action None

2685
19 Appendices

Page Continuation Action None

Support Mandatory

028F..01 Invalid or unsupported AR command parameter value

Action Code X'01'

Explanation One or more of the following conditions occurred:

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 re-
source ID format specified.

The resource ID in an AR entry is invalid.

Alternate Exception Action None

Page Continuation Action None

Support Optional

0290..01 Invalid or unsupported overlay ID

Action Code X'01' or X'1F'

Explanation The overlay identifier in a BO, an IO, or a LCC command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action IO--ignore the command. BO and LCC have no PCA.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2686
 19.6 IPDS Exceptions

0291..02 Invalid or unsupported value for XOA Request Resource List entry

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action XOA RRL command when not in home or font state--ignore
command.

Support Optional

0292..01 Overlay not activated

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

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

2687
19 Appendices

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

0293..01 Recursive overlay invocation

Action Code X'01' or X'1F'

Explanation A recursive nesting loop has occurred with an IO command (for example, an
overlay has included itself).

Alternate Exception Action None

Page Continuation Action None ignore the command.

Support Mandatory

0294..01 Invalid or unsupported value for page segment Host-Assigned ID

Action Code X'01' or X'1F'

Explanation The page segment Host-Assigned ID in a BPS or an IPS command is invalid or

unsupported.

Alternate Exception Action None

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.

Alternate Exception Action None

Page Continuation Action None

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 command is invalid or unsupported.

Alternate Exception Action None

2688
 19.6 IPDS Exceptions

Page Continuation Action None

Support Mandatory

0296..01 Page segment not activated

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action IPS--ignore the command. DPS has no PCA.

Support Mandatory

0297..01 Overlay nesting limit exceeded

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action Ignore the Include command.

Support Mandatory

0298..01 Invalid or unsupported suppression number

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The suppression number in a LCC command is invalid or unsupported.

The Begin Suppression (BSU) number in a WT command is invalid or unsupported.

Alternate Exception Action None

Page Continuation Action WT--ignore the control sequence. LCC has no PCA.

Support Mandatory

2689
19 Appendices

Note This corresponds to a PTOCA exception.

0298..03 Invalid or unsupported value for Temporary Baseline Move control sequence

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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

Note This corresponds to a PTOCA exception.

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

029A..01 Invalid overstrike character increment

Action Code X'01' or X'1F'

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.

The character increment of the selected overstrike character is less than the char-
acter-box X size.

The overstrike character is not a printable character.

Alternate Exception Action None

Page Continuation Action Ignore the OVS control sequence in the Write Text command.

Support Mandatory

2690
 19.6 IPDS Exceptions

Note This corresponds to a PTOCA exception.

02A4..01 Logical-page boundary in the X-direction cannot be represented in the printer

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

02A5..01 Logical-page boundary in the Y-direction cannot be represented in the printer

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2691
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

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 re-
sources and re-transmitting the page might correct the problem.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

2692
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

Tip Some printers report this exception as X'02AF..01'. The preferred exception ID is
X'02AF..01'.

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 unsup-
ported.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

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 in-
valid 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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory when explicit page placement and orientation is supported

2693
19 Appendices

02AE..01 Invalid or unsupported parameter in an IO command

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02AF..01 Insufficient storage to continue processing

Action Code X'0C'

Explanation There is insufficient storage to continue processing. Deactivating unused fonts,

overlays, and page segments might correct the problem.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

Tip 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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

2694
 19.6 IPDS Exceptions

Page Continuation Action None

Support Mandatory

02B0..01 Invalid code page Host-Assigned ID in a LCPC command

Action Code X'01'

Explanation The code page HAID specified in a Load Code Page Control command is invalid.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..02 Invalid or unsupported encoding-scheme value in a code page

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..04 Too much or too little code page data

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

This exception ID can be reported either when the resource is being activated, or
when a printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2695
19 Appendices

02B0..05 Invalid or unsupported byte-count value in a code page

Action Code X'01' or X'1F'

Explanation The byte-count 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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..07 Code points out of order in a code page

Action Code X'01' or X'1F'

Explanation The entries in a series of LCP commands or in a resident code page were not
specified in ascending code-point order.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..0B Invalid Host-Assigned ID in a LFCSC command

Action Code X'01'

Explanation The font character set HAID specified in a Load Font Character Set Control
command is invalid.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2696
 19.6 IPDS Exceptions

02B0..0C Invalid or unsupported pattern-technology ID in a font character set

Action Code X'01' or X'1F'

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.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..0E Invalid or unsupported Load-Font count value in a font character set

Action Code X'01' or X'1F'

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.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B0..0F Invalid or unsupported map-size value in a font character set

Action Code X'01' or X'1F'

Explanation An invalid or unsupported map-size value was specified in a Load Font Character
Set command or in a resident font character set.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..01 Invalid or unsupported character ID format in a font character set

Action Code X'01' or X'1F'

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.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

2697
19 Appendices

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..02 Invalid technology-specific ID offset in a font character set

Action Code X'01' or X'1F'

Explanation An invalid technology-specific ID offset value was specified in the character ID

map in a LF3-type Load Font command or in a resident font character set.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..03 Invalid technology-specific ID length in a font character set

Action Code X'01' or X'1F'

Explanation An invalid technology-specific ID length value was specified in the character ID

map in a LF3-type Load Font command or in a resident font character set.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..04 GCGIDs out of order in a font character set

Action Code X'01' or X'1F'

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.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2698
 19.6 IPDS Exceptions

02B1..08 Invalid technology-specific object length in a font character set

Action Code X'01' or X'1F'

Explanation An invalid length value was specified in a technology-specific object found

either in a LF3-type Load Font command or in a resident font character set.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..09 Checksum mismatch in a font character set

Action Code X'01' or X'1F'

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 cal-
culated by the printer.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..0A Invalid technology-specific-object-identifier length value in a font character

set

Action Code X'01' or X'1F'

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.

This exception ID can be reported either when the resource is being activated, or when a
printer default font is selected.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B1..0B Invalid data within a LF3-type technology-specific object

Action Code X'01' or X'1F'

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.

2699
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02B3..01 MICR text string cannot be printed

Action Code X'01' or X'1F'

Explanation A string of text within a WT or WG command is to be printed with a MICR

font, but MICR printing is not available for this text string. Some printers can print MICR
text on one side of the media, but not on the other side. In this case, text data to be
printed with a MICR font that is placed on the non-MICR side of the media causes this
exception to occur.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory for MICR-supporting printers for which this exception condition can
occur.

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2700
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02C0..04 Duplexing and N-up not supported together

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.

Alternate Exception Action None

Page Continuation Action None

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.

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2701
19 Appendices

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02C2..02 More than one media-source or media-destination keyword specified in a

copy subgroup

Action Code X'01'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2702
 19.6 IPDS Exceptions

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

02C6..02 Invalid mapping type in a LE command

Action Code X'01'

Explanation The mapping type in a LE command is not valid.

Alternate Exception Action None

Page Continuation Action None

Support Mandatory

2703
19 Appendices

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.

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

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.

Alternate Exception Action None

Page Continuation Action None

Support Optional

19.6.11 Specification Check - Graphics Data

Exceptions
See also:
IPDS Exceptions Summary

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.

2704
 19.6 IPDS Exceptions

0300..01 Unallocated or unsupported graphics order or command code

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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'.

Alternate Exception Action None

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

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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'.

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.

Alternate Exception Action None

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.

Support Refer to Graphics Object Content Architecture Reference.

2705
19 Appendices

0300..03 Incorrect drawing order length

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

The Defauength 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 Lengthlt 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 l 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.

Alternate Exception Action None

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.

Support Refer to Graphics Object Content Architecture Reference.

0300..04 Invalid attribute value

Action Code X'01' or X'1F'

Explanation An attribute value for a graphics drawing order is invalid.

Alternate Exception Action Use the standard default value.

Page Continuation Action Use the standard default value.

Support Refer to Graphics Object Content Architecture Reference.

0300..08 Truncated order exception

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

2706
 19.6 IPDS Exceptions

Alternate Exception Action None

Page Continuation Action Any remaining data in the segment is ignored, processing con-
tinues with the next new segment.

Support Refer to Graphics Object Content Architecture Reference.

0300..0C Segment prolog exception

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

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.

Alternate Exception Action None

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.

Support Refer to Graphics Object Content Architecture Reference.

0300..0D Virtual graphics presentation space overflow

Action Code X'01' or X'1F'

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 ll 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.

Support Refer to Graphics Object Content Architecture Reference.

0300..0E Unsupported attribute value

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

2707
19 Appendices

0300..21 Invalid or unsupported default

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

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.

Support: Refer to Graphics Object Content Architecture Reference.

Support Refer to Graphics Object Content Architecture Reference.

0304..00 Invalid Segment Characteristics drawing order

Action Code X'01' or X'1F'

Explanation The Segment Characteristics drawing order was detected outside of a segment
prolog.

Alternate Exception Action None

Page Continuation Action None

Support Refer to Graphics Object Content Architecture Reference.

0334..00 Character angle value not supported

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

033E..00 Invalid End Prolog

Action Code X'01' or X'1F'

Explanation An End Prolog drawing order has occurred outside the prolog section of a
segment.

Alternate Exception Action None

Page Continuation Action The END PROLOG is ignored.

Support Refer to Graphics Object Content Architecture Reference.

2708
 19.6 IPDS Exceptions

0360..00 Area bracket exception

Action Code X'01' or X'1F'

Explanation An End Area drawing order has been received without a Begin Area drawing
order.

Alternate Exception Action None

Page Continuation Action The END AREA is ignored.

Support Refer to Graphics Object Content Architecture Reference.

0368..00 Begin Area received incorrectly

Action Code X'01' or X'1F'

Explanation A Begin Area drawing order has been received while another Begin Area
drawing order is already in progress.

Alternate Exception Action None

Page Continuation Action The present area is closed and filled. Any following drawing orders
until END AREA are used to define a new area.

Support Refer to Graphics Object Content Architecture Reference.

0368..01 Area truncated exception

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action The area is closed and filled. Processing continues with the next
segment.

Support Refer to Graphics Object Content Architecture Reference.

0368..02 Supported order invalid in area

Action Code X'01' or X'1F'

Explanation A supported drawing order that is not valid within an area has been detected
in an area.

Alternate Exception Action None

Page Continuation Action The drawing order is ignored. Processing continues with the
next drawing order.

Support Refer to Graphics Object Content Architecture Reference.

2709
19 Appendices

0368..03 Pattern Set not supported

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

0368..04 Undefined pattern symbol

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

0368..05 Temporary-storage overflow while drawing an area

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

0370..01 Unsupported Begin Segment Introducer segment flag

Action Code X'01' or X'1F'

Explanation The segment flag (byte 7, bits 5, 6) in the Begin Segment Introducer has a value
of B'10'.

Alternate Exception Action None

Page Continuation Action Any data in the segment is ignored. Processing continues with
the next new segment.

Support Refer to Graphics Object Content Architecture Reference.

2710
 19.6 IPDS Exceptions

0370..82 Invalid Begin Segment Introducer segment flag

Action Code X'01' or X'1F'

Explanation The segment flag (byte 7, bits 5, 6) in the Begin Segment Introducer has a value
of B'01'.

Alternate Exception Action None

Page Continuation Action Any data in the segment is ignored. Processing continues with
the next new segment.

Support Refer to Graphics Object Content Architecture Reference.

0370..C1 Invalid Begin Segment Introducer length

Action Code X'01' or X'1F'

Explanation The Begin Segment Introducer length parameter (byte 1) is invalid.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Graphics Object Content Architecture Reference.

0370..C5 Insufficient segment data

Action Code X'01' or X'1F'

Explanation The amount of data received with a segment is less than that specified in the
begin segment SEGLENGTH field.

Alternate Exception Action None

Page Continuation Action Processing continues with the next segment, or IPDS command
if the END command is received.

Support Refer to Graphics Object Content Architecture Reference.

0392..00 Graphics image order sequence exception

Action Code X'01' or X'1F'

Explanation A Begin Image drawing order was not processed before the Image Data drawing
order in the segment.

Alternate Exception Action None

Page Continuation Action The drawing order is ignored--the image data is discarded.

Support Refer to Graphics Object Content Architecture Reference.

2711
19 Appendices

0392..01 Image data discrepancy

Action Code X'01' or X'1F'

Explanation The Image Data drawing order contains either not enough or too many bytes
of data.

Alternate Exception Action None

Page Continuation Action The Image Data order is ignored.

Support Refer to Graphics Object Content Architecture Reference.

0393..00 Graphics image bracket exception

Action Code X'01' or X'1F'

Explanation An End Image drawing order has been received without a Begin Image drawing
order having been received.

Alternate Exception Action None

Page Continuation Action The END Image order is ignored.

Support Refer to Graphics Object Content Architecture Reference.

0393..01 Incorrect number of Image Data drawing orders

Action Code X'01' or X'1F'

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).

Alternate Exception Action None

Page Continuation Action If not enough data, pad remaining bytes with X'00'; else ignore
the extra orders.

Support Refer to Graphics Object Content Architecture Reference.

03C2..00 Marker Set not supported

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

2712
 19.6 IPDS Exceptions

03C2..01 Undefined marker code

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

03C2..02 Mismatched marker set exception

Action Code X'01' or X'1F'

Explanation The current marker-set-attribute value identifies a marker set that cannot support
the functions implied by the current marker attribute.

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.

Support Refer to Graphics Object Content Architecture Reference.

03C3..00 Font not available

Action Code X'01' or X'1F'

Explanation One or more of the following conditions occurred:

A Character String, or Character String at Current Position drawing order was en-
countered, 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 Pos-
ition 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 Pos-
ition 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 substitution that preserves as many characteristics as possible
of the originally requested font while still preserving the original code page. If the exception
occurs for any other reason, there is no PCA.

Support Refer to Graphics Object Content Architecture Reference.

2713
19 Appendices

03C3..01 Undefined graphics character

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

Tip Reporting of this exception is controlled by the Report Undefined Character Check bit in
the XOA Exception-Handling Control command.

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

Tip Reporting of this exception is controlled by the Report Undefined Character Check bit in
the XOA Exception-Handling Control command.

03C3..02 Mismatched character set exception

Action Code X'01' or X'1F'

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 at-
tribute, with the lowest value of precision the character set can support.

Support Refer to Graphics Object Content Architecture Reference.

03C6..01 Arc drawing check

Action Code X'01' or X'1F'

Explanation The drawing processor has detected an exception which might prevent the
drawing of the arc within the normal limits of pel accuracy.

2714
 19.6 IPDS Exceptions

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.

Support Refer to Graphics Object Content Architecture Reference.

03D1..00 Truncated graphics image exception

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action The received image data is printed. Processing continues with
the next segment.

Support Refer to Graphics Object Content Architecture Reference.

03D1..01 Invalid order in graphics image

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Any remaining data in the segment is ignored, processing con-
tinues with the next 'NEW' segment.

Support Refer to Graphics Object Content Architecture Reference.

03D1..02 Graphics image format not supported

Action Code X'01' or X'1F'

Explanation The value specified for the graphics image FORMAT parameter is not supported.

Alternate Exception Action None

Page Continuation Action Any remaining data in the segment is ignored, processing con-
tinues with the next 'NEW' segment.

Support Refer to Graphics Object Content Architecture Reference.

03D1..03 Image width greater than maximum supported

Action Code X'01' or X'1F'

Explanation The width value specified in the Begin Image drawing order exceeds the max-
imum supported image width.

Alternate Exception Action Truncate the image width at the maximum width supported.

2715
19 Appendices

Page Continuation Action Truncate the image width at the maximum width supported.

Support Refer to Graphics Object Content Architecture Reference.

03D1..04 Image height greater than maximum supported

Action Code X'01' or X'1F'

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.

Support Refer to Graphics Object Content Architecture Reference.

03E1..00 Relative line outside coordinate space

Action Code X'01' or X'1F'

Explanation A relative line starts inside the drawing order coordinate space, but then goes
outside the space.

Alternate Exception Action None

Page Continuation Action The movement that would cause the error is ignored.

Support Refer to Graphics Object Content Architecture Reference

19.6.12 Specification Check - IO-Image

Exceptions
See also:
IPDS Exceptions Summary

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

Action Code X'01' or X'1F'

Explanation An invalid or unsupported self-defining field code was encountered within an

IO-image segment.

Alternate Exception Action None

2716
 19.6 IPDS Exceptions

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0500..03 Invalid or unsupported IO-image self-defining field length

Action Code X'01' or X'1F'

Explanation The length field of one of the following is invalid or unsupported: a Begin
Segment self-defining 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0500..04 Invalid IO-image self-defining field value

Action Code X'01' or X'1F'

Explanation A field value of one of the following is invalid: a Begin Image Content self-de-
fining field, an Image Size Parameter, or an Image Data Element Size Parameter.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0570..0F IO-image Begin Segment out of sequence

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0571..0F IO-image End Segment out of sequence

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

2717
19 Appendices

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0591..0F IO-image Begin Image Content out of sequence

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0592..0F IO-image Image Data self-defining field out of sequence

Action Code X'01' or X'1F'

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-de-
fining fields must appear after image data parameters and before End Image Content.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0593..0F IO-image End Image Content out of sequence

Action Code X'01' or X'1F'

Explanation The sequence of self-defining fields within a series of WI2 commands is invalid.
Either an 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0594..01 Inconsistent Image Size Parameter value and Image Data

Action Code X'01' or X'1F'

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.

2718
 19.6 IPDS Exceptions

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.

Support Refer to Image Object Content Architecture Reference.

0594..0F IO-image Image Size Parameter missing or out of sequence

Action Code X'01' or X'1F'

Explanation The sequence of self-defining fields within a series of WI2 commands is invalid.
Either an 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0594..10 IO-image Image Size Parameter value unsupported

Action Code X'01' or X'1F'

Explanation A value within an Image Size Parameter is unsupported. An unsupported unit

base value was specified.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0594..11 IO-image Image Size cannot be determined

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0595..0F IO-image Image Encoding Parameter out of sequence

Action Code X'01' or X'1F'

Explanation The sequence of self-defining fields within a series of WI2 commands is invalid.
An Image 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.

Alternate Exception Action None

2719
19 Appendices

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0595..10 IO-image Image Encoding Parameter value unsupported

Action Code X'01' or X'1F'

Explanation A value within an Image Encoding Parameter is unsupported. An unsupported

compression algorithm, recording algorithm, or bit ordering was specified.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0595..11 IO-image decompression error

Action Code X'01' or X'1F'

Explanation An error was encountered while decompressing IO-image data under the fol-
lowing conditions:

The image data was not encoded according to the compression or recording al-
gorithm 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.

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0596..0F IO-image Image Data Element Size Parameter out of sequence

Action Code X'01' or X'1F'

Explanation The sequence of self-defining fields within a series of WI2 commands is invalid.
An Image 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

2720
 19.6 IPDS Exceptions

0596..10 IO-image Image Data Element Size Parameter value unsupported

Action Code X'01' or X'1F'

Explanation A value within an Image Data Element Size Parameter is unsupported. An un-
supported Number of Bits per Image Point value was specified.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0596..11 IO-image Image Data Element Size Parameter and Image Encoding Parameter
inconsistent

Action Code X'01' or X'1F'

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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0597..0F IO-image Image Look Up Table ID Parameter out of sequence

Action Code X'01' or X'1F'

Explanation The sequence of self-defining fields within a series of WI2 commands is invalid.
An Image 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.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference.

0597..10 IO-image Image Look Up Table ID Parameter value unsupported

Action Code X'01' or X'1F'

Explanation A value in an Image Look Up Table ID Parameter is unsupported. An unsupported

Look Up Table ID value was specified.

Alternate Exception Action None

Page Continuation Action Skip to END command.

Support Refer to Image Object Content Architecture Reference

2721
19 Appendices

05A9..02 IO-image data outside of the Image Presentation Space

Action Code X'01' or X'1F'

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 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 area.

Support Refer to Image Object Content Architecture Reference.

19.7 Tested Configurations for

Printers
19.7.1 Tested Configurations in Version 8.1
This section provides an overview of tested configurations of Inspire Designer on various
printers with version 8.1.

19.7.1.1 Validation Tests Oc Poing

CS10000 Bundle 13
Printer Configuration
Full color printer with CMR support

FC 04.14.05

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

2722
 19.7 Tested Configurations for Printers

Full color + indexed colorants

BW + indexed colorants

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Recommended Default Engine Settings

Full color CS10000_IPDS_FullColor.job

BW CS10000_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Color modes examples SampleWFDs\ColorModes_CS10000\

2723
19 Appendices

CS3500 Bundle 14
Printer Configuration
Full color printer with CMR support

FC 05.01.08 rc003

desu 09.21.97

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Grayscale image support

2724
 19.7 Tested Configurations for Printers

Recommended Default Engine Settings

Full color CS3500_IPDS_FullColor.job

BW CS3500_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

JetStream 1400 Bundle 14

Printer Configuration
High speed full color ink printer, CMR support

FC: ub280703

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

2725
19 Appendices

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Grayscale image support

Recommended Default Engine Settings

Full color JetStream_IPDS_FullColor.job

BW JetStream_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Canon C6010 Bundle 14

Printer Configuration
FC: v21071104

PRISMAsync Controller 12.20.46.10

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

BW + indexed colorants

Full color image format compression

RGB, Lab color space

Object containers / native images

2726
 19.7 Tested Configurations for Printers

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Grayscale image support

Recommended Default Engine Settings

Full color C6010_IPDS_FullColor.job

BW C6010_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VS8000 Bundle 11+

Printer Configuration
FC: 4.10.24 rc003

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Single printing

2727
19 Appendices

RPO

Handling groups

Image handling

Grayscale image support

Dithering, custom matrices

LUT

Resolution

Graphic support

White processing

Relative font metric

Double-byte fonts

Compression

Stack received pages

Position check

1000 pages in one run

Recommended Default Engine Settings

BW VS8000_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

19.7.1.2 Validation Tests Oc Venl

VP4110
Printer Configuration
Release 2.6.0 Oc VarioPrint 4000 PRISMAsync Controller 11.9.84.45

2728
 19.7 Tested Configurations for Printers

Tested Protocol
PS

Default settings Optimized for output size

Default settings Optimized for portability

Media handling

Paper sizes (standard, custom, mixed)

Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VP6320
Printer Configuration
Oc VarioPrint 6000 PRISMAsync Controller 12.20.54.21

2729
19 Appendices

Tested Protocol
PS

Media handling

Paper sizes (standard, custom, mixed)

Mixed Media Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

CS665 Pro
Printer Configuration
VarioPrint 6000 PRISMAsync Controller 11.12.83.6

Tested Protocol
PS2, PS3

Default settings Optimized for portability

Default settings Optimized for output size

Podi PPML

Creo VPS

2730
 19.7 Tested Configurations for Printers

Recommended Default Engine Settings

PS2, PS3 Default Optimized for portability

Podi PPML CS650_Pro_PPML.job

Creo VPS CS650_Pro_VPS.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

19.7.1.3 Files
JOB files containing recommended default settings of printers and print samples (WFD files)
are available on request from the GMC Support department.

19.7.2 Tested Configurations in Version 8.0

This section provides an overview of tested configurations of Inspire Designer on various
printers with version 8.0.

19.7.2.1 Validation Tests Oc Poing

CS10000 Bundle 13
Printer Configuration
Full color printer with additional custom tone, CMR support

FC 04.14.02-rc004

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

2731
19 Appendices

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Recommended Default Engine Settings

Full color CS10000_IPDS_FullColor.job

BW CS10000_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Color modes examples SampleWFDs\ColorModes_CS10000\

CS3500 Bundle 14
Printer Configuration
Full color printer with additional custom tone, CMR support

FC 05.01.04 rc21

Gui 09.21.16

desu 09.03.03

2732
 19.7 Tested Configurations for Printers

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

Map OCA black

Grayscale image support

Recommended Default Engine Settings

Full color CS3500_IPDS_FullColor.job

BW CS3500_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

2733
19 Appendices

JetStream 2200 Bundle 14

Printer Configuration
High speed full color ink printer, CMR support

FC: 4.14.01

Gui 6.19.27

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support

2734
 19.7 Tested Configurations for Printers

Map OCA black

Grayscale image support

Recommended Default Engine Settings

Full color JetStream_IPDS_FullColor.job

BW JetStream_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VS7120 Bundle 11+

Printer Configuration
FC: 4.10.21

Operator panel 07.16.07

De complete version 01.16.10

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Object containers / native images

Handling groups

Image handling

Grayscale image support

Custom matrices

Resolution

Graphic support

Relative font metric

Double-byte fonts

2735
19 Appendices

Attach ICC profile

Stack received pages

Position check

Recommended Default Engine Settings

BW VS7210_IPDS_BW.job

BW VS7210_PCL_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

19.7.2.2 Validation Tests Oc Venl

VP4110
Printer Configuration
Release 2.6.0 Oc VarioPrint 4000 PRISMAsync Controller 11.9.84.45

Tested Protocol
PS

Default settings Optimized for output size

Default settings Optimized for portability

Media handling

Paper sizes (standard, custom, mixed)

Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

2736
 19.7 Tested Configurations for Printers

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VP6250 (6320)
Printer Configuration
Release 4.3.1 Oc VarioPrint 6000 PRISMAsync Controller 11.15.1.8

Tested Protocol
PS

Media handling

Paper sizes (standard, custom, mixed)

Mixed Media Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

CS665 Pro
Printer Configuration
Release 2.1.0 VarioPrint 6000 PRISMAsync Controller 11.12.50.52

EFI IC-305 v 2.0

2737
19 Appendices

Tested Protocol
PS2, PS3

Default settings Optimized for portability

Default settings Optimized for output size

Podi PPML

Creo VPS

Recommended Default Engine Settings

PS2, PS3 Default Optimized for portability

Podi PPML CS650_Pro_PPML.job

Creo VPS CS650_Pro_VPS.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

19.7.2.3 Files
JOB files containing recommended default settings of printers and print samples (WFD files)
are available on request from the GMC Support department.

19.7.3 Tested Configurations in Version 7.0

This section provides an overview of tested configurations of Inspire Designer on various
printers with version 7.0.

19.7.3.1 Validation Tests Oc Poing

CS10000 Bundle 12 and 13
Printer Configuration
Full color printer with additional custom tone, CMR support

FC 04.12.19 (Bundle 12)

FC 04.13.02 (Bundle 13)

2738
 19.7 Tested Configurations for Printers

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support (Full with beziers)

Map OCA black

PCL

Full color printing

CMR features

Rendering intents

Indexed colorants

2739
19 Appendices

Recommended Default Engine Settings

Full color CS10000_IPDS_FullColor.job

BW CS10000_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Color modes examples SampleWFDs\ColorModes_CS10000\

VS9250 Bundle 11+

Printer Configuration
Full color printer with additional custom tone, CMR support

FC: 04.10.17 (both IPDS and PCL)

Gui 00.15.461

De complete version 05.18.30

Operator panel 08.16.05

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

2740
 19.7 Tested Configurations for Printers

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support (Full with beziers)

Map OCA black

PCL

Full color printing

CMR features

Rendering intents

Indexed colorants

Recommended Default Engine Settings

Full color VS9250_IPDS_FullColor.job

BW VS9250_IPDS_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Color modes examples SampleWFDs\ColorModes_CS10000\

JetStream 1000 Bundle 13

Printer Configuration
High speed full color ink printer, CMR support

FC: rs290604

Gui 00.19.205

2741
19 Appendices

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Simplex/duplex printing

Full color printing

Full color + indexed colorants

BW + indexed colorants

Spot colors / highlight colors

Full color image format compression

RGB, Lab color space

Object containers / native images

Basic rotation of native images

Handling groups

Resolution

Attach ICC profile

Extract and reference ICC profile

CMR passthrough

RPO

LUT

Rendering intents

Graphic support (Full with beziers)

Map OCA black

Recommended Default Engine Settings

Full color JetStream_IPDS_FullColor.job

BW JetStream_IPDS_BW.job

2742
 19.7 Tested Configurations for Printers

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VS7120 Bundle 11+

Printer Configuration
FC: 4.10.17

Operator panel 07.16.06

De complete version 07.15.04

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Object containers / native images

Handling groups

Image handling

Grayscale image support

Custom matrices

Resolution

Graphic support

Relative font metric

Double-byte fonts

Attach ICC profile

Stack received pages

Position check

Recommended Default Engine Settings

BW VS7210_IPDS_BW.job

BW VS7210_PCL_BW.job

2743
19 Appendices

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VS8000 Bundle 7
Printer Configuration
FC: 4.10.17

Operator panel 05.16.03

Operator panel 07.16.06

Gui 00.15.461

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Highlight color printing

C-twin simplex/duplex printing

Single printing

RPO

Handling groups

Image handling

Grayscale image support

Dithering, custom matrices

LUT

Resolution

Graphic support

White processing

Relative font metric

Double-byte fonts

2744
 19.7 Tested Configurations for Printers

Compression

Stack received pages

Position check

1000 pages in one run

Recommended Default Engine Settings

BW VS8000_IPDS_BW.job

BW VS8000_PCL_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VS7450 Bundle 7
Printer Configuration
FC: 3.08.74

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Highlight color printing

C-twin simplex/duplex printing

Single printing

Handling groups

Image handling

Grayscale image support

Dithering, custom matrices

LUT

Resolution

2745
19 Appendices

Graphic support

White processing

Relative font metric

Double-byte fonts

Compression

Stack received pages

Position check

1000 pages in one run

Recommended Default Engine Settings

BW VS7450_IPDS_BW.job

BW VS7450_PCL_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VP5160 Bundle 7
Printer Configuration
FC: 3.08.74

Dedo 02.05.24

Gui 02.05.304

Operator panel 02.06.25

Tested Protocol
IPDS

PrintSample job with default engine configuration

PrintSample job with recommended default engine configuration

BW printing

Highlight color printing

Finishing operations

2746
 19.7 Tested Configurations for Printers

Handling groups

Image handling

Grayscale image support

Dithering, custom matrices

LUT

Resolution

Graphic support

White processing

Relative font metric

Double-byte fonts

Compression

Position check

Recommended Default Engine Settings

BW VP5160_IPDS_BW.job

BW VP5160_PCL_BW.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

Finishing operations examples SampleWFDs\Finishing_VP5160\

19.7.3.2 Validation Tests Oc Venl

VP4120
Printer Configuration
Release 2.1.0 Oc VarioPrint 4000 PRISMAsync Controller 11.10.83.19

Tested Protocol
PS

Default settings Optimized for output size

Default settings Optimized for portability

2747
19 Appendices

Media handling

Paper sizes (standard, custom, mixed)

Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

VP6250
Printer Configuration
Release 4.0.1 Oc VarioPrint 6000 PRISMAsync Controller 11.10.2.30

Tested Protocol
PS

Media handling

Paper sizes (standard, custom, mixed)

Mixed Media Dynamic page exceptions

Finishing support

Stapling (subset, whole set)

Copies

Job management (via PPD file)

Recommended Default Engine Settings

Default Optimized for portability

2748
 19.7 Tested Configurations for Printers

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

CS665 Pro
Printer Configuration
Release 2.1.0 VarioPrint 6000 PRISMAsync Controller 11.12.50.52

EFI IC-305 v 2.0

Tested Protocol
PS2, PS3

Default settings Optimized for portability

Default settings Optimized for output size

Podi PPML

Creo VPS

Recommended Default Engine Settings

PS2, PS3 Default Optimized for portability

Podi PPML CS650_Pro_PPML.job

Creo VPS CS650_Pro_VPS.job

Other Related Files

PrintSample_test SampleWFDs\PrintSample_test\

19.7.3.3 Performance Tests Riso Printers

RISO IS900C
Printer Configuration
Firmware version 1.00R-1510.102

Adobe Level 3 RIP

2749
19 Appendices

Tested Protocol
Adobe PostScript 2

Default settings Optimized for output size

Default settings Optimized for portability

Adobe PostScript 3

Default settings Optimized for output size

Default settings Optimized for portability

PDF

Default settings

Recommended Default Engine Settings

PS Optimized for portability (default)

PDF Default settings

RISO ComColor 9050

Printer Configuration
Firmware version 7.16.3

Tested Protocol
Adobe PostScript 2

Default settings Optimized for output size

Default settings Optimized for portability

Adobe PostScript 3

Default settings Optimized for output size

Default settings Optimized for portability

PDF

Default settings

2750
 19.7 Tested Configurations for Printers

Recommended Default Engine Settings

PS Optimized for portability (default)

PDF Default settings

19.7.3.4 Files
JOB files containing recommended default settings of printers and print samples (WFD files)
are available on request from the GMC Support department.

19.7.4 Recommendations and Special Settings

19.7.4.1 Creo Spire Front End
CREO Dynamic Page Exceptions
In order to switch trays/feeders dynamically from a job on Creo, you need to use Dynamic
Page Exceptions.

The way these Dynamic Page Exceptions are specified differs between the CXP (DocuColor
family) DFE and the Igen3 DFE. For both versions of DFE you need to create a queue with the
Support dynamic page exceptions option enabled. For the CXP DFE you create a Paper Set
containing the details of each tray you wish to switch between and then add each Paper Set
name as a Dynamic Page Exception entry for that queue. In both cases the trays may be switched
dynamically from the job by using the /MediaType operator in the PostScript setpagedevice
dictionary.

E.g. for CXP:

Create Paper Sets with names a4_red and a4_blue (see below) then add these as dynamic
page exception entries in the job queue.

Switch trays using:

<</MediaType (a4_red)>>setpagedevice
<</MediaType (a4_blue)>>setpagedevice

Creating Paper Sets on CXP DFE:

Create a Paper Set with the name a4_red and the following other options:

Size: a4
Color: red
Weight: 81-105
GSM Coat: uncoated
Type: Paper

Then create a paper set with the name a4_blue with the same options except for Color: blue.

Note It should also possible to switch trays using the other Media Attributes Colour and
Weight.

2751
19 Appendices

Example In the earlier example for the CXP DFE you could also use the following com-
mands:

<</MediaColor (red)>>setpagedevice
<</MediaColor (blue)>>setpagedevice
providing there are no other stocks or paper sets loaded with the same colours.

Note that the /MediaType operator does not actually reference the Type attribute in this
implementation but instead references the Stock or Paper Set name.

Example Example for CXP DFE:

Paper Set a4_red has Media Type attribute of Paper but the command <</Media
Type (a4_red)>>setpagedevice is used to select the required feeder and not
<</MediaType (Paper)>>setpagedevice.

19.7.4.2 Xerox Igen Printer

CREO Dynamic Page Exceptions
In order to switch trays / feeders dynamically from a job on Creo you need to use Dynamic
Page Exceptions.

The way these Dynamic Page Exceptions are specified differs between the CXP (DocuColor
family) DFE and the Igen3 DFE. For both versions of DFE you need to create a queue with the
Support dynamic page exceptions option enabled. For the Igen3 DFE you then add the
Stock Name for each printer tray you need to switch between as a Dynamic Page Exception
entry for that queue. In both cases the trays may be switched dynamically from the job by using
the /MediaType operator in the PostScript setpagedevice dictionary.

E.g. for Igen3:

Use stock names XeroxColotech+ 90 ! A4 and XeroxColotech+ S 120 ! A4 as dynamic

page exception entries in the job queue.

Switch trays using:

<</MediaType (XeroxColotech+ 90 ! A4)>>setpagedevice

<</MediaType (XeroxColotech+ S 120 ! A4)>>setpagedevice

Note It should also possible to switch trays using the other Media Attributes Colour and
Weight.

Example In the earlier example for the Igen3 DFE you could also use the following
commands:

<</MediaWeight 90>>setpagedevice
<</MediaWeight 120>>setpagedevice

2752
 19.7 Tested Configurations for Printers

providing there are no other stocks or paper sets loaded with the same weights.

Note that the /MediaType operator does not actually reference the Type attribute in this
implementation but instead references the Stock or Paper Set name.

Example Example for Igen3 DFE:

Stock XeroxColotech+ 90 ! A4 has a Media Type attribute of Plain but the command
<</MediaType (XeroxColotech+ 90 ! A4)>>setpagedevice is used to select
the required feeder and not <</MediaType (Plain)>>setpagedevice.

19.7.4.3 Xerox X490/780 Printer

From version 6.2 PrintNet T offers new features for Xerox X490/780 printer, such as:

PS Hybrid spool file,

automatic creation of the external images,

borders included or not,

image options,

implementation of the VI Interpreter command SETPROJECT for the external images.

PS Hybrid spool file From version 6.2 PrintNet T automatically creates the PS Hybrid spool
file with all the necessary commands to take advantage of this configuration. It is an option
of the JOB configuration and it requires an additional license. These options are available
on the Images tab in Custom Images Generation section and on the enhanced Image
Handling tab.

Automatic creation of the external images From version 6.2 all images used for the
PostScript spool file are created automatically. The main advantages are these:

The images meet the standard of Back Form required for the PS Hybrid config-
uration.

No preview pre-composition image is required.

All of the individual images that compound a page are integrated into only one
image called Back Form.

There are 3 possible options to select:

Merge overlays All overlays per page will be merged into 1 image per page (like table
borders).

Merge also images All images per page will be merged into 1 image per page (like
multiple logos).

2753
19 Appendices

Reuse generated background images Each external "Back Form" image will be named
by unique hash code. Inspire Designer will go through the folder with hash named
images and in case there is already the same image, it will not be generated again
and will be reused. This will work also for multiple production runs of the same WFD
design and different data. The only condition is to have same directory with external
images.

Include borders or not In Inspire Designer you can select to include or not to include the
borders as a part of the Back Form image by checking or unchecking the option Use
overlays for borders in Layout.

The use of one option depends on the design of the application. If most of the borders
are fixed, then it is better to include them into the Back Form image.

By default any borderstyle is inserted as an overlay (reusable resource). This can be switched
on/off in Inspire Designer Layout module.

Possible problems:

If you have repeated table with unknown count of lines per table this can cause
problems with large count of Back Form images.

2754
 19.7 Tested Configurations for Printers

So in some cases it is useful to switch this off, not to have it in overlay. This means
fewer Back Form images and larger PS spool file containing this graphic info
repeated.

Possible design optimization:

Put static tables into one Layout with overlays switched on.

In another Layout module create just dynamic (repeated) tables with overlays
switched off.

Finally mix sheets from both Layouts together.

Advantages:

Static borders will be reused and the count of Back Form images will not be in-
creased.

Only dynamic borders will be inserted to spool PS file.

Disadvantage:

More complex WFD design.

Image Options Images are typically filtered for compression purposes. You can choose the
filter type you prefer also for external images.

More info can be found for example in this Wikipedia article for PDF: http://en.wikipe-
dia.org/wiki/Portable_Document_Format#Raster_images

We support ASCIIHex, Flate and ASCII85.

Implementation of the VI Interpreter command SETPROJECT for the external im-

ages You can use the VI Interpreter SETPROJECT command to separate the images by
projects. By simple setting the names of the folder into Inspire Designer the output will
contain the correct VIPP commands to reference the images during the caching process.

2755
19 Appendices

19.7.4.4 HP PPML Output Settings

HP PPML output settings and general recommendations:

PPML Engine Tab Option Name Tested Option

Configuration Value

PPML Output Option Output Profiles Advanced Settings

PPML Version PPML ver. 2.10
Advanced Settings PPML Settings 1 Use internal data True

19.7.4.5 IBM 4100

Image quality recommendations (information from Jeff DeVoyd):

The easiest way to get the best quality of photographic images is to use InfoPrint Manger to
control the printer. You should be able to send gray-scale or color JPG or TIF images to IPM
and it will use optimized half-tones and screening to print them.

Recommended setting for dithering in Inspire Designer is the following:

600 DPI

Use 106 LPI linescreen, 45 degree angle and diamond pattern.

You can tweak the angle and pattern but if you change LPI too much, you will
probably see random lines starting to appear in the pictures.

300 DPI

Use 53 LPI linescreen instead 106 LPI.

Test

Use threshold dithering.

Connection settings recommendations (information from Jaroslav Halamka):

Settings used on customer side.

Driver config:

Page buffer = 100

Printer type = IBM

2756
 19.7 Tested Configurations for Printers

Engine config:

Use default settings (change DPI as requested)

Make sure that the option Max IPDS data packet size in kB is set to 8.

2757
Index
Index

Symbols ~ linedata, 71
~ MODCA, 70
1-1 merger module, 221
~ pagedef, 71
1-many merger module, 220
~ shift-out/shift-in, 71
2/5
~ SOSI, 71
~ datalogic (barcode type), 2253
AFP index module, 224
~ IATA (barcode type), 2255
~ how to use, 2108
~ industrial (barcode type), 2258
AFP native import
~ interleaved (barcode type), 2260
~ formdef, 67
~ matrix (barcode type), 2264
aligning objects, 366
anchors
A ~ in layout, 396
access permissions (see access rights) ~ line data input module, 163
access rights ~ runaround, 399
~ for layout objects, 1507 approval states, 1645
~ for workflow modules, 1507 arabic
~ Inspire Content Manager ~ language support, 856
~ ~ group administration, 1637 ~ to roman numbers, 302
~ ~ permissions to individual files and arithmetic operators (scripting), 1799
features, 1643 arranging objects, 364
~ ~ synchronization points, 1640 arrow icons usage, 881
~ ~ user administration, 1632 assignment statements (scripting), 1797
~ modules and objects, 1506 australia post (barcode type), 2267
~ quick access rights, 883 authentication library module, 1086
adding fields ~ example, 2214
~ data combiner module, 232 automatic first fitting, 2126
additional information automatic saving, 49
~ environment variables (see environment aztec (barcode type), 2269
variables)
~ language codes, 1547
~ processing in Inspire Designer, 2235
B
barcodes, 403
~ tips and tricks (see tips and tricks)
~ align to pixels feature, 408
~ troubleshooting, 2247
~ available types, 407
administrator
~ conversion and methods, 775
~ definition, 1624
~ import from PrintNet 3, 2610
Adobe PostScript2
~ IPDS exceptions, 2639
~ engine configuration, 1175
~ resizing, 1556
Adobe PostScript3
~ setting handling groups, 1559
~ engine configuration, 1188
barr connection configuration dialog, 1475
~ example
bezier tool (drawing), 787
~ ~ how to produce PS hybrid spool
booklet maker module (see impositioning
files, 2194
modules)
AFP
bookmarks insertion, 2203
~ driver configuration, 1464
boolean operators (scripting), 1800
~ engine configuration, 1188
border
~ example
~ styles
~ ~ how to assign TLE indexes, 2180
~ ~ modification, 2144
~ images
border properties dialog, 806
~ ~ color transformation, 2354
border styles
~ ~ import settings, 67
~ creation, 412
~ import, 1090, 1531
~ ~ example, 2144
~ ~ native, 67
~ in cells, 816
~ output device profiles, 1015
~ in flow areas, 610
~ printer configuration, 1427
~ in layout, 412
AFP import
~ in paragraph styles, 727

2760
 ~ in tables, 806 ~ dialog, 491
~ in text styles, 834 ~ properties, 490
~ variable, 421 color management
branches ~ color spaces, 2368
~ Inspire Content Manager, 1690 ~ image transformation with ICC pro-
break statement (scripting), 1810 files, 2340
bullets ~ overview, 2339
~ example, 863 color space transformation
~ general information, 859 ~ examples, 2362
~ settings tab, 860 ~ in PDF-based output, 2362
~ toolbar, 859 ~ in PostScript-based output, 2362
business rules, 697 ~ of images in Inspire Designer, 2364
~ of images in RIP, 2365
C ~ of objects, 2367
cache ~ of text, 2367
~ Inspire Content Manager, 1630 color spaces, 2368
cells colors
~ border styles, 816 ~ color management, 50
~ in layout, 815 ~ creating and naming, 498
~ setting properties in tables, 808 ~ in layout, 489
characters substitution (scripting), 1812 ~ in non-image objects, 2367
charts ~ spot colors (see spot colors)
~ creating simple, 2154 columns
~ examples and hints ~ in tables, 814
~ ~ chart with variable number of val- ~ in text, 698-699
ues, 466 command line parameters
~ ~ general information, 476 ~ GUI language selection, 1743
~ ~ highlighting pie slice, 477 ~ overview, 1741
~ ~ stripes and lines, 482 ~ simple production
~ features description, 424 ~ ~ driver toolbar, 1501
~ general information, 422 ~ ~ general information, 1499
~ making settings ~ ~ ICM toolbar, 1503
~ ~ for the axis, 444 ~ ~ job toolbar, 1502
~ ~ for the general appearance, 427 ~ ~ VCS toolbar, 1503
~ ~ for the legend, 471 ~ specifying folder for configuration and
~ ~ for the series, 456 cache files, 1743
~ ~ general information, 426 ~ using workflow filename(s) as paramet-
~ with custom images, 2136 er, 1743
client for Inspire Content Manager, 1700 comparison
cloning selected objects, 865 ~ operators (scripting), 1800
CMYK comparison of data merging modules, 336
~ description, 2369 comparison of workflows, 99
~ image transformation from/to, 2340 condition
~ intent (rendering), 2370 ~ flow area selected by, 2141
~ to CMYK transformation, 65 conditional appearance of objects (see variable
codabar (barcode type), 2271 selection of objects)
code conditional flow
~ 128 (barcode type), 2274 ~ coding in XML, 2128
~ 128UPS (barcode type), 2278 ~ creating, 2169
~ 39 (barcode type), 2281 configuration
~ 39(FullASCII) (barcode type), 2284 ~ config file customization
~ 93 (barcode type), 2287 ~ ~ alternative way of rendering thin
codecs lines, 2383
~ text encoding, 1561 ~ ~ checking checksum for all used
color files, 2383

2761
Index

~ ~ encrypted command lines, 2384 ~ Inspire Production Server Console Client

~ ~ force run on remote server, 2380 (see Inspire Production Server Console Cli-
~ ~ Inspire Production Server extended ent)
logs, 2380 ~ PNetTCNetClient (see PNetTCNetClient)
~ ~ iptc character set, 2381 context menu
~ ~ license for web products, 2383 ~ used files, 104
~ ~ max count of overlays for merged continue statement (scripting), 1810
table borders, 2382 converters, 273
~ ~ native import image cache copy/paste
size, 2381 ~ general information, 868
~ ~ native import max cached image ~ in edit-boxes, 2252
count, 2381 correlation marks, 620
~ ~ override user name, 2382 creating
~ ~ PNetTNetServer extended logs, 2380 ~ a secure job file, 1492
~ ~ set process and thread affinity, 2382 ~ barcodes, 403
~ ~ week of year compatibility, 2383 ~ border styles, 412
~ CONFIG file customizations, 2372 ~ ~ example, 2144
~ ~ alter raster hinting, 2375 ~ business rules, 697
~ ~ auto-confirm IPDS job, 2375 ~ colors, 498
~ ~ disable reading complete record data ~ conditional flow, 2169
into memory, 2379 ~ custom image charts, 2136
~ ~ enable/disable memory mapped ~ driver configuration profile, 1464
files, 2374 ~ duplex messages, 685
~ ~ enable/disable tno switching to disc ~ element areas with elements, 2139
mode, 2378 ~ fill styles, 563
~ ~ ignore engine/driver/printer set- ~ flow areas, 604
tings, 2375 ~ flow areas selected by condition, 2141
~ ~ Inspire Content Manager client debug ~ flow content groupby, 2142
mode, 2376 ~ font replacement, 701
~ ~ Inspire Content Manager client ~ gradients, 628
timeout, 2376 ~ image page counter, 2091
~ ~ Inspire Content Manager server de- ~ images, 651
bug mode, 2376 ~ line styles, 666
~ ~ keep empty lines containing tabulat- ~ messages, 684
ors, 2377 ~ pages, 705
~ ~ merge visible paragraph and text ~ paragraph styles, 2148
styles if identical, 2378 ~ scripted area, 2150
~ ~ open corrupted workflow, 2378 ~ sections, 697
~ ~ overwrite IPDS exception level, 2379 ~ shapes, 783
~ ~ replace space with underscore in csv ~ simple charts, 2154
definition, 2377 ~ table based on CSV file, 2159
~ ~ save copy of imported rtf file, 2377 ~ table of contents, 694, 2163
~ ~ save impositioning script data in ~ tables, 799
memory, 2378 ~ text on curve, 823
~ ~ set old linespacing, 2374 ~ text styles, 2148
~ ~ treat per user settings like all user ~ workflow, 105
settings in PNetT.cfg, 2375 Creo VPS
~ ~ use full font name in Type1 ~ engine configuration, 1219
fonts, 2374 ~ printer configuration, 1452
~ JOB file structure, 2389 cross reference browser, 100
~ operating system customizations, 2388 CSV files
console application (see Inspire Production ~ creating a table based on, 2159
Console) ~ data input properties, 117
custom image charts, 2136
customer code files, 133

2762
CX_DATA variable (environment), 2386 ~ ~ sequences, 158
CX_FONT_DIRECTORY variable (environ- ~ ODBC input
ment), 2386 ~ ~ general information, 181
~ overview, 112
D ~ param input, 188
DAM, 1700 ~ PNetTC parameters, 1750
data ~ SAP input, 193
~ data center input, 190 ~ script input, 199
~ in layout, 500 ~ ~ scripting methods, 1827
~ internal input, 145 ~ XML input
~ line data input module, 146 ~ ~ general fields, 204
~ ~ example, 176 ~ ~ general information, 203
~ populating variables with, 513 data matrix (barcode type), 2289
~ structure in workflow, 90 data output
~ working with, 522 ~ from layout, 532
data adding, combining, merging, 336 data output module, 1000
data areas data processing modules
~ line data input module, 166 ~ 1-1 merger, 221
data center input module, 190 ~ ~ comparison of data mergers, 336
data center merger module, 327 ~ 1-many merger, 220
data center output module, 1069 ~ ~ comparison of data mergers, 336
data centers, 1659 ~ AFP index module, 224
~ access rights, 1665 ~ check21 reader, 229
~ admin, 1660 ~ comparison of data mergers, 336
~ data center config module, 1099 ~ data add, 230
~ data center input module, 190 ~ ~ comparison of data mergers, 336
~ data center merger module, 327 ~ data cacher, 230
~ data center output module, 1069 ~ data caser, 261
~ data sets, 1663 ~ data center merger, 327
~ decision trees, 1667 ~ data combiner, 232
~ installation, 1666 ~ data concatenator, 233
~ server management, 1666 ~ ~ comparison of data mergers, 336
~ split expressions, 1678 ~ data filter, 235
~ splits, 1664 ~ data group by
data family ~ ~ general information, 237
~ properties, 501 ~ data groupby
data histogram module, 239 ~ ~ creating flow content, 2142
data input modules ~ data histogram module, 239
~ data center input, 190 ~ data mixer
~ data generator, 114 ~ ~ comparison of data mergers, 336
~ data input ~ data precise, 242
~ ~ general information, 115 ~ data remapper, 254
~ ~ multiple record type files, 135 ~ data repeater, 257
~ ~ settings, 62 ~ data sorter, 258
~ external input, 144 ~ data transformer
~ internal input, 145 ~ ~ field converters list, 273
~ line data input ~ ~ field order, 271
~ ~ anchors, 163 ~ ~ general information, 262
~ ~ data areas, 166 ~ ~ logic tracking, 530
~ ~ first steps, 176 ~ ~ orphans, 271
~ ~ gui, 146 ~ data ungroup, 307
~ ~ line data formatting, 303 ~ minmax generator, 312
~ ~ pages, 157 ~ overview, 216
~ ~ pages family, 153 ~ PCL data, 319
~ ~ position tab, 173 ~ PDF data, 314

2763
Index

~ personalized URL, 322 ~ engine configuration, 1232

~ PNetTC parameters, 1753 double-byte encoding types, 1564
~ record filter, 325 DPI
~ text replacer, 335 ~ EXIF in JPEG, 65
data profile tool (see profile data tool) drag and drop
data proof window, 1142 ~ construction, 106
data sets ~ support, 2250
~ decision trees, 1667 drawing
~ edit data sets dialog, 1663 ~ bezier, 787
data sorter module ~ freehand, 786
~ data processing modules, 258 driver configuration
data transformer ~ available for engines
~ error recovery, 2115 ~ ~ other engines, 1464
data types (scripting), 1796 ~ creating profile, 1464
DataBar, 2308 ~ dialogs
DataWare 2000 configuration dialog, 1475 ~ ~ barr connection, 1475
DataWare 2100 configuration dialog, 1474 ~ ~ DataWare 2000 connection, 1475
DBF files, 132 ~ ~ DataWare 2100 connection, 1474
debug ~ ~ desktop printer, 1467
~ data, 90 ~ ~ file connection, 1469
~ script, 1784 ~ ~ file driver, 1466
decision trees, 1667 ~ ~ general information, 1465
declaring script functions, 1814 ~ ~ LPR, 1468
dependency browser, 1650 ~ ~ SCSI connection, 1473
desktop printer driver configuration dia- ~ ~ TCP/IP connection, 1470
log, 1467 ~ ignore settings, 2375
desktop printer engine ~ list of available types, 1464
~ engine configuration, 1231 ~ overview, 1463
dithering ~ profile, 1463
~ examples, 1522 drivers window in production, 1478
~ general information, 1514 duplexing
~ LUT ~ examples (NS splitter), 2103
~ ~ editing, 1517 ~ sheet module, 955
~ ~ Examples, 1523 duplicating sheet module, 957
~ picker, 1770 dutch post (barcode type), 2292
~ recommendations, 1523
~ setting groups for barcodes, 1559 E
~ setting groups for variable images, 656 EAN
~ setting groups for various objects, 384 ~ 128 (barcode type), 2293
~ setting handling groups for images, 640 ~ 13 (barcode type), 2296
~ type, 1517 ~ 8 (barcode type), 2300
do...while statement (scripting), 1810 ~ UCC application identifers, 2304
DOC edit access rights dialog
~ import ~ workflow module and layout ob-
~ ~ native, 75 jects, 1508
DOC files import editing one workflow by more users, 1585
~ limitations, 1538 effect areas, 535
~ number to spell example, 2143 ~ convolution filter, 546
DOCX ~ Gaussian blur, 546
~ import ~ highlighted emboss, 546
~ ~ direct, 1537 ~ perspective, 541
~ ~ native, 75, 1090, 1531 ~ warp, 541
~ lock element
~ ~ flow, 568 ~ repeated by integer variables, 2172
Docx element area, 551

2764
 ~ content panel types, 554 ~ main window appearance, 2387
element areas with elements, 2139 environment variables
elements ~ CX_DATA, 2386
~ export for web, 2160 ~ CX_FONT_DIRECTORY, 2386
~ in layout, 548 ~ general information, 2385
~ used with element areas, 2139 ~ PNETT_DIR, 2386
email EPS
~ HTML, 2219 ~ import, 1090, 1531
~ personalize EPS images
~ ~ generating of, 2219 ~ handling, 2348
~ sending, 2219 ~ in PS-like output, 2366
email composition error recovery
~ example ~ data transformer, 2115
~ ~ how to add variables to HTML, 1110 ~ general information, 2113
~ template merger module, 1102 ~ record filter, 2117
Email Gateway ~ warning config, 2114
~ data input file, 2219 ~ XML data input, 2116
Email Gateway event script module, 1088
~ CSV, 2219 example
embedded object areas, 554 ~ aligning barcodes to pixels, 409
enclosing string values (scripting), 1812 ~ chart with variable number of val-
encoding text (see text encoding) ues, 466
encryption ~ charts in general, 476
~ encrypted command lines, 2384 ~ cloning objects, 866
engine configuration ~ columns in text, 699
~ Adobe PostScript2, 1175 ~ creating a border style, 2144
~ Adobe PostScript3, 1188 ~ exporting design parts for web, 2160
~ AFP, 1188 ~ flow break before/after option, 733
~ Creo VPS, 1219 ~ ~ column, 737
~ desktop printer engine, 1231 ~ ~ flow area or pages, 734
~ Docx, 1232 ~ flow order tool, 598
~ HP PPML, 1240 ~ generating a table of contents, 2163
~ HTML engine, 1242 ~ how to add variables to HTML, 1110
~ HTML Simple engine, 1255 ~ number to spell in RTF/DOC, 2143
~ ignore settings, 2375 ~ resizing barcodes, 1556
~ IJPDS, 1259 ~ undo/redo palette, 889
~ image engine, 1289 ~ variable formatted tagged data, 592
~ Inspire native, 1376 EXIF
~ IPDS, 1292 ~ JPEG DPI, 65
~ Metacode, 1309 expressions (scripting), 1798
~ MIBF, 1321 expressions for splits, 1678
~ multi engine, 1331 ~ in decision trees, 1669
~ NexPress VDX, 1333 external input module, 144
~ overview, 1174 external object
~ PCL, 1336 ~ dialog, 558
~ PDF engine, 1349 external objects
~ PDF fixed resolution engine, 1343 ~ in layout, 557
~ PNetT native, 1376 ~ logging updates, 562
~ Podi PPML, 1379 ~ used layouts dialog, 561
~ raster engine, 1395 ~ working with, 559
~ SWF engine, 1404 external workflow module, 1118
~ SX/AP engine, 1409 ~ introduction, 1113
~ text engine, 1411 ~ usage with data, 1115
enhanced open dialog, 1654 ~ usage with sheets, 1116
environment

2765
Index

F ~ ~ PCL, 1041
~ variable operation
facebook
~ ~ AFP, 1427
~ authentication library module, 1086
~ ~ IPDS, 1430
~ social data connection module, 329
~ ~ PCL, 1437
field converters, 273
first fitting
file connection configuration dialog, 1469
~ auto - usage, 2126
file driver configuration dialog, 1466
~ overview, 2122
file history, 1655
~ usage, 2123
~ approval states, 1645
fixed length fields files, 121
~ history tree, 1656
flipping
file import
~ flow areas, 2251
~ configuration, 1530
~ sheets, 2088
~ data, 1528
flow
~ design related, 1528
~ lock
~ native, 1090, 1526, 1531
~ ~ DOCX, 568
~ overview, 1526
~ properties, 567
file types
~ repeated by integer variables, 2176
~ CSV, 117
flow area
~ customer code, 133
~ conversion and methods, 775
~ DBF, 132
~ first fitting (see first fitting)
~ fixed length fields, 121
~ inserting a table into, 799
~ multiple record type
~ overflow management, 598
~ ~ general information, 135
~ quick flip, 2251
~ ~ with CSV, 136
~ runaround, 607
~ ~ with fixed length fields, 139
~ selected by condition, 2141
file version management (see Inspire Content
~ setting handling groups, 384
Manager)
flow areas, 604
files
flow order
~ content as variables, 2117
~ alternative set up, 599
~ opening
~ between flow areas, 598
~ ~ enhanced open dialog, 1654
~ between pages, 601
~ ~ open dialog, 1552
~ repeating pages, 602
~ ~ paths to Content Manager, 1657
~ tool, 598
~ ~ workflows from Content Man-
flows
ager, 1618
~ conditional (see conditional flow)
~ opening existing WFD, 21
~ control conditional constructs, 1806
~ used files dialog, 102
~ conversion and methods, 775
~ used files update dialog, 22
~ creating content with data groupby
fill styles
module, 2142
~ in layout, 563, 628
~ export for web, 2162
filtering
~ first fitting (see first fitting)
~ group module, 906
~ first fitting auto, 2126
~ items, 2249
~ highlighting, 355
~ sheet module, 958
~ in layout, 566
finding
~ overflow management, 598
~ find & replace dialog, 1545
~ variable formatted, 573
~ find/replace text palette, 876
font
~ unused objects, 877
~ inserting, 618
~ used objects, 874
~ inserting replacement, 701
finishing operation
~ limitations for Mac, 622
~ illustration for output, 1066
~ open dialog, 1553
~ settings
~ replacement, 1538
~ ~ AFP, 1024
~ settings for workflow, 49
~ ~ IPDS, 1035
~ special imaging text effects, 620

2766
 ~ transfer from Mac to PC, 622 ~ IJPDS, 1289
~ use full name for Type1 fonts, 2374 hebrew language support, 856
fonts hexadecimal numbers (scripting), 1812
~ applying text styles, 825 highlight
~ in layout, 616 ~ flow, 355
footer row (in tables), 801 ~ object, 355
for statement (scripting), 1809 history of file versions, 1655
force history tree, 1656
~ proof profile, 1014 how to
formatting ~ auto-follow on twitter, 2214
~ options ~ use AFP index module, 2108
~ ~ arabic to roman numbers, 302 HP Indigo
~ ~ bullets and numbering, 859 ~ configuration of PPML, 2182
~ ~ line data formatting, 303 HP PPML
~ ~ number to spell, 299 ~ engine configuration, 1240
~ ~ numbers to letters, 302 HTML
~ ~ spell to number, 301 ~ design
~ superscript in date, 2177 ~ ~ template merger module, 1102
~ variable flows (see variable formatted ~ how to add variables to HTML, 1110
flows) ~ import, 89
freehand tool (drawing), 786 ~ ~ native, 1531
functions (scripting) ~ ~ overview, 1542
~ declaring script, 1814 ~ ~ template merger module, 1102
~ general information, 1800 ~ metadata, 1027
~ output
G ~ ~ HTML engine, 1242
gamut ~ ~ HTML Simple engine, 1255
~ check option, 52 ~ output device profiles, 1027
~ types, 2339 HTML email body
~ warning color selection, 52 ~ personalize, 2219
global features HTML Simple
~ text encoding, 1561 ~ output device profiles, 1029
glossmarks, 620 HTML simple engine
glyph area, 623 ~ restrictions, 1257
~ converting, 627 hyphenation, 731
goto statement (scripting), 1811
gradient I
~ fill style, 628 ICC profiles
gradients ~ color space description, 2368
~ in layout, 628 ~ general information, 2340
group filter module, 906 ~ image transformation in proof/produc-
grouping objects, 365 tion, 2357
GS1 (barcode type), 2308 ~ setting of, 1546
~ with EPS images (see EPS images)
H ~ with PDF images, 2348
head positions if and if...else statements (scripting), 1807
~ pdf engine configuration, 1373 IJPDS
header row (in tables), 801 ~ driver configuration, 1464
heads ~ engine configuration, 1259
~ display tab, 717 ~ heads info dialog, 1289
~ handling overlapping, 2193 ~ how to configure RIPs, 2186
~ setting IJPDS overlapping, 2197 ~ how to set cue intervals from size of me-
~ show heads option, 355 dium, 2201
heads info dialog ~ how to spool many PDFs, 2227
~ output device profiles, 1031

2767
Index

~ page side configuration dialog, 1280 ~ ~ as image, 2091

~ physical RIP configuration dialog, 1287 ~ ~ natively, 84
~ printing system components, 1278 ~ PTF warnings, 2613
~ setting overlapping heads, 2197 ~ RTF files
~ size optimization, 2227 ~ ~ direct import, 1537
image ~ ~ limitations, 1538
~ advanced tab, 646 ~ ~ native import, 1090, 1531
~ as fill style, 565 ~ ~ objects, 1535
~ color space transformation with ICC pro- impositioning
files (see ICC profiles) ~ in PPML output device profiles, 1058
~ conversion and methods, 775 impositioning modules
~ effects, 535 ~ booklet maker
~ insertion and usage, 651 ~ ~ definition modes, 899
~ native loading, 650 ~ ~ general information, 897
~ open dialog, 1553 ~ group filter, 906
~ replacement, 1538 ~ imposition script, 907
~ setting handling groups, 640 ~ marks inserter, 934
~ transparency, 644 ~ media pattern filter, 937
~ with runaround, 658 ~ overview, 894
image area ~ PNetTC parameters, 1755
~ setting handling groups, 384 ~ saddle stitch, 943
image areas, 657 ~ Select N Groups, 946
image engine ~ sheet aligner, 947
~ driver configuration, 1464 ~ sheet backgrounder, 948
~ engine configuration, 1289 ~ sheet concatenator, 949
image page counter creation, 2091 ~ sheet content modifier, 949
image page counter usage, 2091 ~ sheet duplexer, 955
images ~ sheet duplicator, 957
~ in layout, 638 ~ sheet filter, 958
~ variable, 653 ~ sheet inserter, 961
import ~ sheet mixer, 963
~ AFP native (see AFP import) ~ sheet NS splitter, 965
~ basic information, 1526 ~ sheet padder, 969
~ DOC files ~ sheet regrouper, 970
~ ~ direct import, 1537 ~ sheet sorter, 975
~ ~ limitations, 1538 ~ sheet transformer
~ ~ native import, 1090, 1531 ~ ~ flipping/rotating sheets, 2088
~ DOC/RTF ~ ~ general information, 978
~ ~ natively, 75 ~ simple N-upper, 980
~ files, 1531 ~ text in rect
~ ~ DOC/RTF direct, 1537 ~ ~ general information, 981
~ ~ native, 1090 impositioning script methods
~ ~ overview, 1526 ~ CaptureSkipOverlays, 913
~ HTML, 1542 ~ InputSheeter, 913
~ ~ natively, 89 ~ LogPageInfo, 914
~ native, 1526 ~ LogPageInfoWithSet, 918
~ ~ Inspire native module, 1090 ~ OutputSheeter, 919
~ ~ Layout module, 1531 ~ pauseAfterCurrentSheet, 922
~ ~ objects, 1535 ~ SheeterMethods, 923
~ ~ PNetT native module, 1090 ~ SheeterWithSet, 923
~ of PrintNet 3 jobs (see PrintNet 3 import ~ SheetInfo, 924
issues) ~ SheetInfoWithSet, 931
~ overview, 1526 INDD
~ PCL, 76 ~ import, 1531
~ PDF index

2768
 ~ TLE (see TLE indexes) ~ data center output module, 1069
indic languages support, 856 ~ decision trees, 1667
insert ~ split expressions, 1678
~ bookmarks, 2203 Inspire Data Centers (see data centers)
insert character palette, 879 Inspire Email Gateway
Inspire Content Manager ~ data input file, 2219
~ administration Inspire native engine
~ ~ access permissions to individual ~ driver configuration, 1464
files, 1643 ~ engine configuration, 1376
~ ~ groups, 1637 Inspire native module, 1090
~ ~ on action scripts, 1629 ~ example
~ ~ options, 1624 ~ ~ of two workflows in one Inspire nat-
~ ~ server, 1624 ive module, 1096
~ ~ server maintenance, 1624 ~ replacing path to external re-
~ ~ synchronization points, 1640 sources, 1094
~ ~ user admin dialog, 1632 ~ usage, 1095
~ ~ users, 1632 Inspire Production Console, 1744
~ approval states, 1645 ~ data input modules parameters, 1750
~ basic use ~ data processing modules paramet-
~ ~ adding images and fonts, 1620 ers, 1753
~ ~ checking in a file, 1619 ~ exit code processing parameters, 1747
~ ~ checking out a file, 1617 ~ external workflow module paramet-
~ ~ general information, 1615 ers, 1762
~ ~ logging in, 1615 ~ general parameters, 1746
~ ~ logging out, 1620 ~ impositioning modules parameters, 1755
~ ~ opening a file, 1618 ~ layout module parameters, 1754
~ cache, 1630 ~ list of exit codes, 1767
~ connect to Inspire Content Manager from ~ multiple jobs processing paramet-
simple production environment, 1503 ers, 1749
~ creating and using branches, 1690 ~ multiple output
~ creating and using labels, 1693 ~ ~ syntax, 1769
~ data centers, 1659 ~ multiple outputs processing paramet-
~ ~ decision trees, 1667 ers, 1749
~ ~ split expressions, 1678 ~ output modules parameters, 1757
~ database integration, 1647 ~ server parameters, 1765
~ dependency browser, 1650 ~ using profile data tool with, 1758
~ desktop, 1601 ~ workflow comparison parameters, 1750
~ enhanced open dialog, 1654 ~ workflow modules parameters, 1750
~ explorer, 1601 ~ workflow processing parameters, 1763
~ getting started, 1600 ~ workflow script checking paramet-
~ history, 1655 ers, 1765
~ Inspire Data Center ~ workflow to xml conversion paramet-
~ ~ decision trees, 1667 ers, 1765
~ ~ split expressions, 1678 ~ workspace import/export paramet-
~ log of operations, 1628 ers, 1767
~ mediabin, 1683 ~ workspace parameters, 1766
~ operations.dat log, 1628 ~ xml to workflow conversion paramet-
~ overview, 1600 ers, 1767
~ scripting methods, 1884 ~ XSLFO module parameters, 1755
~ server management, 1621 Inspire Production Server
~ SharePoint, 1689 ~ commands, 1724
~ web, 1700 ~ connecting to, 1711
~ window menu, 1603 ~ general information, 1707
Inspire Data Center ~ starting, 1707
~ data center config module, 1099 Inspire Production Server Client

2769
Index

~ GUI L
~ ~ batch mode, 1722
label
~ ~ general information, 1716
~ context menu, 94
Inspire Production Server Console Client
~ edit label dialog, 95
~ console application
~ tool, 93
~ ~ available commands, 1714
language
~ ~ configuration, 1715
~ codes, 1547
~ ~ general information, 1713
~ spell check, 886
~ GUI
language support
~ ~ batch mode, 1722
~ arabic, 856
~ ~ context menu, 1722
~ hebrew, 856
~ ~ window options, 1719
~ indic, 856
Inspire Email Gateway
layout
~ CSV, 2219
~ logic tracking in, 529
installation directory content, 2244
~ navigation, 880
integer variables
~ objects
~ repeating layout objects, 2172
~ ~ position tab, 381
intelligent mail (4-CB) (barcode type), 2311
~ ~ repeated by integer variables, 2172
intents, rendering, 2370
~ objects overview, 378
internal input module, 145
~ objects tooltips, 881
IPDS
~ options dialog, 836
~ driver configuration, 1464
~ PNetTC parameters, 1754
~ engine configuration, 1292
~ populating variables, 513
~ exceptions
~ properties toolbar, 377
~ ~ barcodes, 2639
~ toolbars, 361
~ ~ command-reject, 2616
~ tree (see layout tree)
~ ~ conditions requiring host notifica-
~ window menu, 347
tion, 2618
~ window overview, 344
~ ~ data-check, 2621
layout objects
~ ~ equipment-check, 2625
~ access rights, 1507
~ ~ equipment-check with intervention
layout tree
required, 2626
~ expanding/collapsing, 2252
~ ~ general, 2645
~ general information, 373
~ ~ graphics data, 2704
~ go to object, 881
~ ~ intervention-required, 2629
~ objects
~ ~ IO-image, 2716
~ ~ quick access rights, 883
~ ~ level configuration dialog, 2638
line data input module (see data input mod-
~ ~ summary, 2616
ules)
~ output device profiles, 1034
line styles
~ printer configuration, 1430
~ in charts, 440, 455, 467
is keyword (scripting), 1808
~ in layout, 666
items
lines, 665
~ filtering, 2249
lock
~ renaming, 2249
~ flow
~ ~ DOCX, 568
J ~ objects
japan post (barcode type), 2313 ~ ~ quick access rights, 883
job log of ICM operations, 1628
~ view, 1779 log window-pane, 1550
job reporter module, 1005 ~ context menu, 1551
jobs window in production, 1476 ~ finding errors, 2252
jog option usage, 2205 ~ message colors setting, 58
log.txt description, 2247
logic tracking

2770
 ~ general information, 529 microtext marks, 620
~ in data transformer, 530 minmax generator module, 312
~ in layout, 529 mixed-byte encoding types, 1564
LPR configuration dialog, 1468 modifying
LUT, 1517 ~ border styles, 2144
~ shapes, 794
M ~ tables, 804
Mac ~ text on curve, 794
~ fonts limitations, 622 module(s)
~ specific information, 2234 ~ data center config, 1099
~ transferring fonts to PC, 622 ~ data input (see data input modules)
main window in production, 1163 ~ data output, 1000
mapped directories ~ data processing (see data processing
~ other, 1582 modules)
~ workspaces, 1580 ~ external workflow, 1118
marks inserter module, 934 ~ impositioning (see impositioning modules)
maxicode (barcode type), 2314 ~ Inspire Native (see Inspire native module)
media pattern filter module, 937 ~ job reporter, 1005
mediabin, 1683 ~ layout (see layout)
memory ~ output, 992, 1008 (see output modules)
~ read data into, 65 ~ PNetT native (see PNetT native module)
menu ~ script library, 1100
~ Inspire Content Manager, 1603 ~ sheet statistic, 1074
~ layout window, 347 ~ statistic data (see statistic data module)
~ production window, 1169 ~ tree, 44
~ title bar, 1567 ~ workflow gate, 1117
~ workflow window, 31 ~ XSLFO (see XSLFO module)
merge modules(s)
~ sheets, 948, 963 ~ event script module, 1088
messages multi engine
~ assigning categories, 686 ~ driver configuration, 1464
~ creation, 684 ~ engine configuration, 1331
~ duplex, 685 multiple jobs window in production, 1479
~ in layout, 672
~ individual message layout proper- N
ties, 673 namespaces (scripting), 1803
~ message areas, 689 native files
~ scripting, 686 ~ import, 1526
~ tracker methods, 688 ~ ~ Inspire native module, 1090
Metacode ~ ~ Layout module, 1531
~ driver configuration, 1464 ~ ~ PNetT native module, 1090
~ engine configuration, 1309 native import
~ output device profiles, 1036 ~ AFP
~ printer configuration, 1432 ~ ~ related options, 67
metadata, 1027 ~ DOC/RTF
~ project name parameter, 1466 ~ ~ related options, 75
~ viewing, 1555 ~ HTML, 89
methods (scripting) ~ PCL
~ data input, 1827 ~ ~ related options, 76
MIBF ~ PDF, 84
~ driver configuration, 1464 ~ PS
~ engine configuration, 1321 ~ ~ related options, 84
~ output device profiles, 1037 navigation
~ page side configuration, 1328 ~ go to object icon, 881
microPDF417 (barcode type), 2317 ~ in layout, 880

2771
Index

~ layout objects tooltips, 881 ~ ~ embedded object areas, 554

~ show node option, 882 ~ ~ flow areas, 604
~ through pages, 880 ~ ~ glyph areas, 623
~ with arrow icons, 881 ~ ~ image areas, 657
new workflow dialog, 107 ~ ~ lines, 665
NexPress VDX ~ ~ message areas, 689
~ driver configuration, 1464 ~ ~ plugin areas, 738
~ engine configuration, 1333 ~ ~ scripted areas, 742
~ output device profiles, 1038 ~ ~ shapes, 783
node(s) ~ ~ text on curve, 822
~ find in layout tree, 881 ~ external (see external objects)
~ show, 882 ~ families
~ using arrow icons with, 881 ~ ~ anchors, 396
non-alphanumerical characters (script- ~ ~ border styles, 412
ing), 1811 ~ ~ cells, 815
non-breaking space, 2250 ~ ~ colors, 489
numbering ~ ~ data, 500
~ arabic to roman conversion, 302 ~ ~ data output, 532
~ conversion to letters, 302 ~ ~ elements, 548
~ example, 863 ~ ~ fill styles, 563, 628
~ general information, 859 ~ ~ flows, 566
~ number to spell, 299 ~ ~ fonts, 616
~ settings tab, 861 ~ ~ images, 638
~ spell to number, 301 ~ ~ line styles, 666
~ toolbar, 859 ~ ~ messages, 672
~ ~ others, 694
O ~ ~ pages, 705
objects ~ ~ paragraph styles, 721
~ access rights, 883 ~ ~ row sets, 819
~ aligning, 366 ~ ~ tables, 810
~ arranging, 364 ~ ~ text styles, 825
~ cloning, 865 ~ overview, 378
~ color space transformation, 2367 ~ via imported files, 1535
~ conversion and methods, 775 ODBC data input
~ find in layout tree, 881 ~ module (see data input modules)
~ Find Object Uses dialog, 874 OMR (barcode type), 2320
~ find uses, 874 open file dialog, 1552
~ grouping, 365 opening existing WFD files, 21
~ highlighting, 355 ~ used files update dialog, 22
~ layout module ~ version conflicts, 22
~ ~ position tab, 381 operators (scripting), 1799
~ line data input module optimizing objects, 350
~ ~ position tab, 173 options dialog
~ optimizing, 350 ~ for layout, 836
~ quick access rights, 883 ~ for production, 1484
~ removing unused, 877 ~ for proof, 1145
~ repeated by integer variables, 2172 ~ for template merger, 1109
~ replacement, 875 ~ for workflow, 45
~ tooltips, 881 ~ overview, 2387
objects in layout orphan/widow
~ areas on page ~ in paragraph styles, 727
~ ~ barcodes, 403 ~ in row sets, 822
~ ~ charts, 422 others
~ ~ effect areas, 535 ~ layout objects, 694
~ ~ element areas, 551 output

2772
 ~ example ~ first fitting, 2122
~ ~ bookmarks insertion, 2203 ~ impositioning modules, 894
~ ~ handling overlapping heads, 2193 ~ Inspire Content Manager, 1600
~ ~ jog option, 2205 ~ layout window, 344
~ ~ RIP splitting, 2206 ~ options dialogs, 2387
~ ~ RIP stitching, 2211 ~ output modules, 992
~ ~ setting IJPDS overlapping ~ printer configuration, 1426
heads, 2197 ~ PrintNet 3 import issues, 2608
~ ~ simple HTML creation, 2170 ~ production, 1162
~ ~ splitting PDF, 2203 ~ proof, 1128
~ module (see output module) ~ tables, 798
output module ~ tips and tricks, 2249
~ AFP device profiles (see AFP) ~ workflow window, 26
~ edit proof profile, 1014 ~ XML, 212
~ finishing operations illustration, 1066
~ force proof profile, 1014 P
~ general information, 1008 page side configuration
~ HTML device profiles (see HTML) ~ IJPDS, 2186
~ HTML Simple device profiles (see HTML ~ MIBF, 1328
Simple) page side configuration dialog
~ IJPDS device profiles (see IJPDS) ~ IJPDS, 1280
~ IPDS device profiles (see IPDS) pages
~ Metacode device profiles (see Metacode) ~ image counter creation, 2091
~ MIBF device profiles (see MIBF) ~ in layout, 705
~ NexPress VDX device profiles (see NexPress ~ ~ family, 707
VDX) ~ ~ individual, 712
~ PCL device profiles (see PCL) ~ line data input module
~ PDF device profiles (see PDF engine) ~ ~ family, 153
~ PostScript device profiles (see PostScript) ~ ~ individual, 157
~ PPML device profiles, 1056 ~ navigation, 880
~ proof engine, 1014 ~ overflow management, 601
~ rotation samples, 1067 ~ printed in reversed order, 2100
~ VIPP device profiles (see VIPP) paragraph
output modules ~ styles
~ data center output, 1069 ~ ~ creation, 2148
~ Inspire Production Console paramet- paragraph styles
ers, 1757 ~ in layout, 721
~ overview, 992 ~ orphan/widow, 727
~ PNetTC parameters, 1757 ~ setting default, 733
overflow ~ with borders, 727
~ between flow areas, 598 param
~ between pages, 601 ~ variable insert wizard, 521
~ management, 598 param input module
overlapping ~ example, 2214
~ of heads handling, 2193 parameters
~ of IJPDS heads setting, 2197 ~ param input module, 188
overview ~ workflow parameters window-
~ color management, 2339 pane, 1481
~ command line parameters, 1741 parameters for command line (see command
~ conversions and methods for ob- line parameters)
jects, 775 parsing content of input text files, 1827
~ data input modules, 112 password protection
~ data processing modules, 216 ~ encrypted command lines, 2384
~ driver configuration, 1463 paste
~ engine configuration, 1174 ~ enhanced, 870

2773
Index

~ general information, 868 ~ ~ of two workflows in one PNT native

~ multiple, 872 module, 1096
path ~ replacing path to external re-
~ conversion and methods, 775 sources, 1094
~ runaround, 614 ~ usage, 1095
paths to Content Manager files, 1657 PNetT.cfg user settings, 2375
PCL PNETT_DIR variable (environment), 2386
~ driver configuration, 1464 PNetTC (see Inspire Production Console)
~ engine configuration, 1336 ~ data input modules parameters, 1750
~ import, 76, 1090, 1531 ~ data processing modules paramet-
~ output device profiles, 1039 ers, 1753
~ printer configuration, 1435 ~ exit code processing parameters, 1747
PCL data ~ external workflow module paramet-
~ module, 319 ers, 1762
~ ~ example of use, 321 ~ general parameters, 1746
PDF ~ impositioning modules parameters, 1755
~ combine many PDFs, 2227 ~ layout module parameters, 1754
~ how to spool many PDFs to IJPDS, 2227 ~ list of exit codes, 1767
~ import, 84, 1090, 1531 ~ multiple jobs processing paramet-
PDF bookmarks ers, 1749
~ insertion, 2203 ~ multiple output
PDF data ~ ~ general information, 1769
~ module, 314 ~ ~ syntax, 1769
PDF engine ~ multiple outputs processing paramet-
~ driver configuration, 1464 ers, 1749
~ engine configuration, 1349 ~ output modules parameters, 1757
~ output device profiles ~ server parameters, 1765
~ ~ general information, 1045 ~ using profile data tool with, 1758
~ ~ setting bookmarks, 1049 ~ workflow comparison parameters, 1750
~ printer configuration, 1440 ~ workflow modules parameters, 1750
PDF fixed resolution engine ~ workflow processing parameters, 1763
~ driver configuration, 1464 ~ workflow script checking paramet-
~ engine configuration, 1343 ers, 1765
PDF images ~ workflow to xml conversion paramet-
~ handling, 2348 ers, 1765
~ in PS-like output, 2366 ~ workspace import/export paramet-
PDF417 (barcode type), 2321 ers, 1767
personalize ~ workspace parameters, 1766
~ email sending, 2219 ~ xml to workflow conversion paramet-
~ HTML email body, 2219 ers, 1767
personalized URL module ~ XSLFO module parameters, 1755
~ data processing modules, 322 PNetTCNetClient
~ pre-filled settings, 62 ~ console application
perspective and warp ~ ~ available commands, 1714
~ effect areas, 535 ~ ~ configuration, 1715
physical RIP configuration dialog ~ ~ general information, 1713
~ IJPDS, 1287 ~ GUI
planet (barcode type), 2324 ~ ~ batch mode, 1722
playing a recording, 1569 ~ ~ context menu, 1722
plugin areas, 738 ~ ~ general information, 1716
PNetT native engine ~ ~ window options, 1719
~ driver configuration, 1464 PNetTNetServer
~ engine configuration, 1376 ~ commands, 1724
PNetT native module, 1090 ~ connecting to, 1711
~ example ~ general information, 1707

2774
 ~ starting, 1707 PrintNet 3 import issues
Podi PPML ~ barcodes, 2610
~ engine configuration, 1379 ~ missing functionality, 2611
position tab ~ other differences between PNT 3 and In-
~ layout module, 381 spire Designer, 2614
~ line data input module, 173 ~ overview, 2608
post-processing in Inspire Designer, 2241 ~ possible problems, 2612
postnet (barcode type), 2325 ~ problems in PTF, 2611
PostScript processing in Inspire Designer
~ engine configuration ~ general information, 2235
~ ~ Adobe PostScript2 (see Adobe Post- ~ overlays, 2239
Script2) ~ post-processing, 2241
~ ~ Adobe PostScript3 (see Adobe Post- ~ pre-processing
Script3) ~ ~ data, 2237
~ hybrid spool files (how to pro- ~ ~ error recovery, 2238
duce), 2194 ~ ~ general information, 2235
~ native import, 84 ~ ~ layout, 2237
~ output device profiles, 1054 ~ ~ modules analysis, 2237
~ printer configuration, 1452 ~ ~ summary, 2238
PPML ~ processing, 2239
~ how to configure HP PPML for Indigo ~ white processing, 1576
devices, 2182 ~ z-order, 2239
~ PPML (Podi and HP) common engine set- production
tings, 1379 ~ driver configuration (see driver configura-
PPML (Podi and HP) tion)
~ HP PPML specific settings (see HP PPML) ~ drivers window, 1478
~ output device profiles ~ encrypted TNO files, 1496
~ ~ general information, 1056 ~ engine configuration (see engine config-
~ ~ impositioning, 1058 uration)
~ ~ page media, 1057 ~ environment, 1163
~ ~ PPD file, 1060 ~ example
~ Podi PPML specific settings (see Podi ~ ~ configuration for HP Indigo
PPML) PPML, 2182
~ printer configuration, 1460 ~ ~ RIP configuration for IJPDS, 2186
pre-processing in Inspire Designer (see pro- ~ image transformation in, 2357
cessing in Inspire Designer) ~ jobs window, 1476
print state ~ main window, 1163
~ display selection, 353 ~ ~ report file config dialog, 1482
~ setting, 385 ~ modes from command line
printer configuration ~ ~ simple, 1499
~ AFP, 1427 ~ multiple jobs window, 1479
~ Creo VPS, 1452 ~ options dialog, 1484
~ ignore settings, 2375 ~ overview, 1162
~ IPDS, 1430 ~ page side configuration (see page side
~ list of engines, 1427 configuration)
~ Metacode, 1432 ~ printer configuration (see printer configur-
~ overview, 1426 ation)
~ PCL, 1435 ~ secure printing (see secure printing)
~ PDF engine, 1440 ~ simple production, 1499
~ PostScript, 1452 ~ ~ driver toolbar, 1501
~ PPML, 1460 ~ ~ job toolbar, 1502
printing ~ ~ VCS toolbar, 1503
~ from proof, 1157 ~ tab
~ pages in reversed order, 2100 ~ ~ drivers, 1478
~ preview, 1157 ~ ~ jobs, 1476

2775
Index

~ ~ main, 1163 Q
~ ~ multiple jobs, 1479
QR (barcode type), 2328
~ TNO keys, 1496
quick access rights
~ window menu, 1169
~ for layout tree objects, 883
~ workflow parameters window-
quick flip, 2251
pane, 1481
profile data tool
~ general information, 95 R
~ usage in Inspire Production Con- raster engine
sole, 1758 ~ driver configuration, 1464
~ usage in PNetTC, 1758 ~ engine configuration, 1395
profiles raster proof profile dialog, 1153
~ for proof, 1147 record filter module
~ ICC color (see ICC profiles) ~ error recovery, 2117
projects, 1585 ~ general information, 325
~ conflicts, 1597 recording your work, 1569
~ general information, 1586 recovery of errors (see error recovery)
~ project browser window, 1587 redo, 889
~ public objects, 1594 referencing current variable, 1816
~ working with workflows, 1591 renaming items, 2249
proof rendering intents, 2370
~ data window, 1142 repeating layout objects
~ dithering (see dithering) ~ by integer variables, 2172
~ image transformation in, 2357 replacement
~ job, 1779 ~ of fonts, 1538
~ options dialog, 1145 ~ of images, 1538
~ overview, 1128 ~ of objects, 875
~ printing from, 1157 report file config dialog, 1482
~ profiles repositories (see data centers)
~ ~ editing raster profile, 1153 reprint (see error recovery)
~ ~ editing spot colors in, 1153 resize barcodes, 1556
~ ~ editing vector profile, 1150 resources
~ ~ general information, 1147 ~ dependency browser, 1650
~ ~ HTML, 1156 return statement (scripting), 1811
~ ~ HTML Simple, 1156 reversed order of printing pages, 2100
~ ~ splitting in, 1401 RGB
~ resizing barcodes, 1556 ~ description, 2368
~ sheet ~ image transformation from/to, 2340
~ ~ toolbars, 1134 rights of access (see access rights) (see quick
~ ~ window menu, 1130 access rights)
~ sheet proof window, 1130 RIP
~ shortcuts, 1147 ~ configuration for IJPDS, 2186
~ warnings ~ image color space transformation
~ ~ general information, 1572 in, 2365
~ white processing, 1576 ~ splitting, 2206
proof profile ~ stitching, 2211
~ force, 1014 roman numbers converted from arabic, 302
protection rotation
~ sensitive documents, 620 ~ of sheets, 2089
PS ~ samples for output, 1067
~ import, 84, 1090, 1531 row sets
PTF ~ defining, 820
~ import settings, 55 ~ header and footer, 801
~ import warnings, 2613 ~ in layout, 819
~ problems with PrintNet 3 jobs, 2611 ~ orphan/widow control, 822

2776
 ~ repeated by integer variables, 2174 ~ script assistant, 1792
~ types, 821 ~ script editor, 1790
royal mail (barcode type), 2330 ~ settings for workflow, 53
RSS, 2308 ~ static variables in, 1802
RTF ~ substitute characters
~ import ~ ~ enclosing string values, 1812
~ ~ direct, 1537 ~ ~ overview, 1812
~ ~ native, 75, 1090, 1531 ~ ~ used in string variables (ex-
RTF files ample), 1813
~ limitations, 1538 ~ wizard, 1795
~ number to spell example, 2143 scripting API
rule ~ activeX (see scripting API, COM)
~ wrapping, 702 ~ arrays
rules ~ ~ one dimensional (see scripting API,
~ text wrapping, 702 lists)
runaround ~ ~ two dimensional (see scripting API,
~ path, 614 tables)
~ with anchors, 399 ~ COM, 2021
~ with flow areas, 607 ~ ~ browsing available methods, 2026
~ with images, 658 ~ ~ checking if supported, 2021
running application ~ ~ creating instance, 2022
~ from different directory, 2244 ~ ~ invoking external method, 2022
~ data input, 1827
S ~ data types
SAP data input module, 193 ~ ~ creating arrays (see scripting API, lists)
scanning ~ database access
~ measuring colors, 499 ~ ~ connecting to database, 1949
script ~ ~ executing queries, 1949, 1951
~ input module (see data input modules) ~ ~ retrieving records, 1959
~ library module, 1100 ~ ~ SQL injection attack preven-
scripted area, 742 tion, 1952, 1955
~ conversion and methods, 775 ~ date and time
~ creation, 2150 ~ ~ addition and subtraction, 1835,
~ object method access, 745 1837
~ types and methods, 747 ~ ~ formatting, 1832, 1838
scripting ~ ~ parsing from text, 1833
~ assignment statements, 1797 ~ ~ retrieving current date and
~ data types, 1796 time, 1836
~ declaring, 1814 ~ debugging messages, 1940
~ expressions, 1798 ~ dictionaries (see scripting API, maps)
~ flow control conditional con- ~ executing external programs, 1845
structs, 1806 ~ files and folders
~ functions, 1800 ~ ~ copying files, 1844
~ hexadecimal numbers in, 1812 ~ ~ deleting files, 1871
~ imposition module, 907 ~ ~ determining file properties, 1850
~ messages, 686 ~ ~ listing drives, 1864
~ namespaces, 1803 ~ ~ managing text encoding, 1870,
~ notes, 1811 1872-1873, 1914, 1925
~ operators ~ ~ moving files, 1870
~ ~ arithmetic, 1799 ~ ~ page count for images, 1863
~ ~ boolean, 1800 ~ ~ reading file content, 1871, 1880,
~ ~ comparison, 1800 1912
~ ~ general information, 1799 ~ ~ reading file metadata (exif), 1865
~ referencing current variable, 1816 ~ ~ searching for files, 1863-1864
~ running script with another script, 1801 ~ ~ test if path exists, 1850

2777
Index

~ ~ writing to file, 1871, 1880, 1922 SCSI connection configuration dialog, 1473
~ Inspire Content Manager, 1884 sections, 697
~ lists, 1890, 1895, 1900, 1952, 1955, secure printing
2012, 2015, 2018, 2027, 2030, 2033, ~ creating secure job file, 1492
2036, 2043, 2070 ~ designing and proofing, 1492
~ mail ~ general information, 1491
~ ~ connecting to mail server, 2062 ~ options dialog, 58
~ ~ creating, 2053 ~ printing from Simple Production, 1495
~ ~ sending, 2065 select
~ maps, 2039, 2046, 2066, 2073 ~ objects beyond flow area borders, 2253
~ mathematical functions, 1941 select by variable, 388
~ module dependent methods sensitive documents, 620
~ ~ workflow methods, 2081 sequences
~ numbers ~ line data input module, 158
~ ~ formatting, 1826, 1842-1843, server
1933, 1939 ~ Inspire Content Manager
~ ~ parsing from text, 1995-1996, ~ ~ administration, 1624
1998, 2006 ~ ~ management, 1621
~ strings shading (see border styles)
~ ~ changing casing, 1991-1992, 2007- shapes, 783
2008 ~ modification, 794
~ ~ converting to numbers, 1988, 1995- ~ perspective and warp, 535
1996, 1998, 2006 ~ setting handling groups, 384
~ ~ dealing with file paths, 1976, 1979, SharePoint, 1689
1981, 1999 sharing objects among workflows, 1585
~ ~ determining length, 1990 sheet
~ ~ managing whitespaces, 2008-2010 ~ backgrounder module, 948
~ ~ replacing characters, 1981, 2001- ~ concatenator module, 949
2002 ~ duplexer module, 955
~ ~ replacing string part, 2002 ~ duplicator module, 957
~ ~ retrieving substring, 1988-1989, ~ filter module, 958
1992-1993, 1999, 2002-2004, 2011 ~ flipping, 2088
~ ~ searching for text, 1978, 1982-1985 ~ info window-pane, 1156
~ ~ splitting into array using delim- ~ inserter module, 961
iter, 1996, 1999, 2002, 2011 ~ mixer module, 963
~ system information ~ NS splitter module, 965
~ ~ determining operating system, 2066 ~ padder module, 969
~ ~ determining user name, 2066 ~ regrouper module, 970
~ ~ retrieving environment vari- ~ rotation, 2089
ables, 2036 ~ sorter module, 975
~ tables, 2049, 2076 ~ statistic module, 1074
~ url sheet content
~ ~ encoding url addresses, 2080 ~ merging, 948, 963
~ web access sheet content modifications
~ ~ caching web files, 1844 ~ sheet content modifier module, 949
~ ~ creating requests, 1906 sheet content modifier, 949
~ ~ error status 590, 1908 sheet names, 1559
~ ~ processing responses, 1907-1908 sheet sorter module, 975
~ ~ request status 100, 1908 sheet transformer module (see impositioning
~ ~ setting property, 1907 modules)
~ ~ setting timeout, 1907 simple HTML engine
~ XML files ~ creation, 2170
~ ~ create new file, 1922 ~ driver configuration, 1464
~ ~ determining node type, 1912, 1917 simple N-upper module, 980
~ ~ parsing file content, 1912 simple production, 1499

2778
 ~ driver toolbar, 1501 ~ ~ gradient, 628
~ ICM toolbar, 1503 ~ line, 666
~ job toolbar, 1502 ~ paragraph, 721
~ VCS toolbar, 1503 ~ text, 825
single-byte encoding types, 1563 substitute characters (scripting), 1812
sms messages substitution characters, 2242
~ template merger module, 1102 superstealth-dots (barcode type), 2332
social data connector module, 329 SWF engine
~ example, 2214 ~ engine configuration, 1404
social networks switch-like construct is keyword (script-
~ authentication library module, 1086 ing), 1808
~ social data connection module, 329 SX/AP engine
soft enter, 2250 ~ engine configuration, 1409
special characters syntax
~ nonbreaking space, 879 ~ multiple output (PNetTC), 1769
~ soft hyphen, 879 ~ static variables (scripting), 1802
special characters (scripting), 1811 ~ variable formatted flows, 574
spell check, 886 system defaults
splits ~ environment settings, 2387
~ edit splits dialog, 1664 ~ general information, 2387
~ expression syntax, 1678 ~ options dialogs, 2387
splitting system variables
~ PDF, 2203 ~ count, 526
~ raster, 1401 ~ exists, 527
~ RIP, 2206 ~ general information, 522
~ sheet NS splitter module ~ index, 528
~ ~ duplex type option example, 2103 ~ list of, 522
~ ~ general information, 965 ~ type and kind indicators, 525
~ ~ setting duplex examples, 2103 ~ usage, 2179
~ ~ split type option example, 2106
spot colors T
~ definition, 494 table of contents
~ dithered, 495 ~ creation, 2163
~ in proof profiles, 1153 ~ general information, 694
starting the application, 19 tables
startup dialog, 20 ~ based on CSV files, 2159
statements (scripting) ~ basic structure, 801
~ assignment, 1797 ~ border, 806
~ break, 1810 ~ cell properties dialog, 808
~ continue, 1810 ~ cells, 815
~ do...while, 1810 ~ columns, 814
~ for, 1809 ~ context menu, 804
~ goto, 1811 ~ creating, 799
~ if and if...else, 1807 ~ first header, 801
~ return, 1811 ~ formatting, 803
~ while, 1809 ~ general information, 798
statistic data module ~ helpful hints, 803
~ completing the panel, 1079 ~ inserting into flow area, 799
~ general information, 1076 ~ last footer, 801
~ how to use, 2119 ~ layout properties, 810
stitching RIP, 2211 ~ modifying, 804
string values - enclosing (scripting), 1812 ~ row sets, 819
styles TCP/IP connection configuration dialog, 1470
~ border, 412 template merger module, 1102
~ fill, 563 ~ example, 1110

2779
Index

~ options dialog, 1109 ~ quick flip, 2251

templates ~ renaming items, 2249
~ new workflow dialog, 107 ~ select objects in flow area, 2253
~ window-pane, 97 ~ soft enter, 2250
text title bar
~ color space transformation, 2367 ~ menu, 1567
~ effects, 535 TLE indexes
~ encoding, 1561 ~ how to assign, 2180
~ ~ editing double-byte or mixed-byte TNO
types, 1564 ~ import, 1090, 1531
~ ~ editing single-byte types, 1563 TNO virtual printer, 1779
~ ~ file structure of exported co- TNO Writer, 1779
dec, 1566 tool
~ ~ setting up custom for data in- ~ label, 93
put, 1565 toolbar(s)
~ on curve tool, 822 ~ bullets and numbering, 859
~ replacer module, 335 ~ layout, 361
~ styles ~ layout properties, 377
~ ~ creation, 2148 ~ navigation in nodes, 881
~ ~ setting default, 835 ~ navigation in pages, 880
~ ~ variable, 835 ~ sheet proof, 1134
~ ~ with border, 834 ~ simple production
text encoding ~ ~ driver toolbar, 1501
~ global feature, 1561 ~ ~ ICM toolbar, 1503
text engine ~ ~ job toolbar, 1502
~ driver configuration, 1464 ~ ~ VCS toolbar, 1503
~ engine configuration, 1411 ~ workflow window, 40
text in rect transformation
~ barcode reading, 987 ~ of data, 273
~ bounding box calculation, 988 ~ of sheets, 2088
~ setting cross-rectangle condition, 987 transparency of image, 644
~ white space management, 988 tree
text in rect module (see impositioning mod- ~ layout (see layout tree)
ules) ~ module, 44
text messages (see sms messages) troubleshooting, 2247
text on curve, 822 twitter
text perspective ~ authentication library module, 1086
~ how to use perspective effect, 541 ~ how to auto-follow, 2214
text shape ~ social data connection module, 329
~ how to use warp effect, 541 types of variable selection, 388
text styles
~ in layout, 825 U
tips and tricks undo, 889
~ closing opened windows, 2250 UPC E (barcode type), 2336
~ copy/paste and delete in edit UPCA (barcode type), 2334
boxes, 2252 used files
~ drag and drop support, 2250 ~ context menu, 104
~ expanding/collapsing the layout ~ dependency browser, 1650
tree, 2252 ~ dialog, 102
~ filtering items, 2249 ~ setting conditions, 56
~ finding errors in log, 2252 ~ update dialog, 22
~ non-alphanumerical characters in variable used layouts dialog, 561
names, 2251 user administration, 1632
~ non-breaking space, 2250 user permissions (see access rights)
~ overview, 2249

2780
 ~ files, modules and objects (see access ~ output device profiles, 1061
rights) ~ VIPP finishing operations, 1063

V W
variable formatted flows warning config
~ comparison with overflowable ~ error recovery, 2114
flows, 574 warnings
~ general information, 573 ~ in proof, 1572
~ syntax, 574 ~ PTF import, 2613
variable image web editing, 883
~ setting handling groups, 656 WFD file
~ using retrieval task in mediabin, 1686 ~ open dialog, 1553
variable images, 653 WFD files
variable selection of objects, 388 ~ opening existing, 21
variables while statement (scripting), 1809
~ CX_DATA, 2386 white processing, 1576
~ CX_FONT_DIRECTORY, 2386 widow/orphan
~ environment (see environment variables) ~ in paragraph styles, 727
~ for selecting images, 653 ~ in row sets, 822
~ global, 514 window-pane
~ ~ conditions of usage, 517 ~ log
~ insert param variable wizard, 521 ~ ~ general information, 1550
~ modified and remembered, 514 wizard
~ non-alphanumerical characters in ~ param variables insertion, 521
names, 2251 ~ script, 1795
~ PNETT_DIR, 2386 ~ workflow, 109
~ populating with favorite data, 513 workflow
~ properties, 507 ~ area, 28
~ referencing current, 1816 ~ comparing, 99
~ static in scripting, 1802 ~ creating, 105
~ substitute characters in string vari- ~ module; access rights, 1507
ables, 1813 ~ options dialog, 45
~ system (see system variables) ~ shortcuts, 64
~ to select objects, 388 ~ templates, 97, 107
~ type and kind indicators, 525 ~ verifying, 98
~ using file content as, 2117 ~ view, 1779
~ via imported files, 1535 ~ window menu, 31
vector proof profile dialog, 1150 ~ window overview, 26
verification of workflows, 98 ~ window settings, 61
version conflicts, 22 ~ window toolbars, 40
version control system (VCS) (see Inspire Con- ~ wizard, 109
tent Manager) workflow access rights, 1506
~ basic use workflow gate module, 1117
~ ~ logging in, 1615 ~ introduction, 1113
versioning ~ usage with data, 1115
~ approval states, 1645 ~ usage with sheets, 1116
video capture feature workflow parameters
~ general information, 1568 ~ add to workflow, 188
~ playing a recording, 1569 ~ window-pane, 1481
~ recording work, 1569 workspace management
view ~ Inspire Production Console paramet-
~ job, 1779 ers, 1766
viewer, 1779 ~ PNetTC parameters, 1766
VIPP workspaces
~ output device profile, 1062 ~ general information, 1577

2781
Index

~ manage dialog, 1578

~ paths to
~ ~ general information, 1580
~ select dialog, 1580
~ usage
~ ~ example, 1581
worldwide support features, 858

X
Xerox
~ X490/980, 2194
XML
~ attributes, 213
~ coding conditional flow, 2128
~ data
~ ~ error recovery, 2116
~ ~ input module (see data input mod-
ules)
~ elements, 212
~ JOB file, 2389
~ overview, 212
~ PCDATA, 214
~ tags, 213
XSLFO module
~ general information, 1123
~ limitations, 1124
~ PNetTC parameters, 1755
~ used terms, 1123

2782