OpenText Communications Center Enterprise 16.0 - Project Configuration Guide English (CCMPRJ160000-CGD-EN-03)

OpenText™ Communications Center
Enterprise
Project Configuration Guide
This guide describes how to configure Design Center Projects.
CCMPRJ160000-CGD-EN-03
OpenText™ Communications Center Enterprise
Project Configuration Guide
Rev.: 2016-Dec-27
This documentation has been created for software version 16.0.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
Copyright © 2016 Open Text. All Rights Reserved.

Trademarks owned by Open Text.
Disclaimer
No Warranties and Limitation of Liability
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
Part 1 Design Center fundamentals 23
1 Understanding the Design Center interface ......................... 25

1.1 Project browser ............................................................................... 26
1.2 Main window ................................................................................... 27
1.2.1 Platform view .................................................................................. 29
1.2.2 Message view ................................................................................. 30
1.2.3 Runtime configuration view .............................................................. 31
1.2.4 Resource set view ........................................................................... 36
1.3 Property window ............................................................................. 37
1.4 Search results window ..................................................................... 38
1.5 Log window .................................................................................... 38
2 Getting started in Design Center ........................................... 41

2.1 Creating Projects from scratch ......................................................... 41
2.1.1 Reusing Project components ........................................................... 45
2.2 Packing and unpacking Projects ....................................................... 48
2.3 Creating a Project using a template .................................................. 49
2.4 Saving and opening Projects ............................................................ 49
2.5 Connecting a Project to a management gateway ............................... 50
2.6 Using the CAS to manage Design Center files .................................. 51
2.6.1 Checking in a Project to the CAS ..................................................... 52
2.6.2 Opening a Project from the CAS ...................................................... 53
2.6.3 Comparing, downloading, and promoting individual files .................... 54
2.6.4 Disconnecting a Project from the CAS .............................................. 55
2.6.5 Managing unresolved files ............................................................... 55
2.6.6 Creating a release ........................................................................... 56
2.7 Increasing the Project version number .............................................. 56
2.8 Exporting Projects ........................................................................... 57
3 Working with Projects ............................................................. 59

3.1 Structuring Projects ......................................................................... 59
3.2 Scripting Projects ............................................................................ 61
3.3 Using aliases .................................................................................. 61
3.3.1 Script alias ...................................................................................... 62
3.3.2 Lookup alias ................................................................................... 63
3.4 Using custom commands and keywords ........................................... 65
3.5 Scheduling ..................................................................................... 66
3.6 Managing startup arguments ............................................................ 67
3.7 About job execution phases ............................................................. 68
3.8 Listing fonts used in a Project .......................................................... 70
OpenText Communications Center Enterprise – Project Configuration Guide iii

Table of Contents
4 Message management ............................................................ 71

4.1 Managing Events ............................................................................ 71
4.1.1 Adding and deleting Events ............................................................. 71
4.1.2 Configuring Events .......................................................................... 72
4.1.3 Ordering Events triggered by the same pattern ................................. 72
4.1.4 Concatenating Events ..................................................................... 72
4.2 Managing Processes ....................................................................... 76
4.2.1 Adding and deleting Processes ........................................................ 76
4.2.2 Configuring Processes .................................................................... 77
4.2.3 Ordering Processes ........................................................................ 77
4.2.4 Defining rules for triggering Processes ............................................. 77
4.2.5 Enabling/disabling Processes .......................................................... 78
4.3 Connecting a Message configuration to a runtime job ........................ 78
4.3.1 Adding and removing Message configurations .................................. 78
4.3.2 Enabling/disabling Message configurations ....................................... 78
4.3.3 Linking input connectors to Events ................................................... 79
4.3.4 Linking Processes to output connectors ............................................ 80
5 Input connector management ................................................ 85

5.1 Creating and configuring input connectors ........................................ 85
5.2 Setting the job priority for the input connector .................................... 86
5.3 Sorting input connectors .................................................................. 87
5.4 Input Analyzer ................................................................................. 88
6 Output connector management ............................................. 93

6.1 Creating and configuring output connectors ...................................... 93
6.2 Setting the job priority for the output connector .................................. 95
6.3 Sorting output connectors ................................................................ 96
6.4 Copying/pasting generic output connector runtime settings ................ 97
6.5 Enabling/disabling output connectors ............................................... 98
6.6 Output modes ................................................................................. 98
6.6.1 Output mode Process ...................................................................... 98
6.6.2 Output mode Document ................................................................... 99
6.6.3 Output mode Job .......................................................................... 101
6.7 Using Document triggers ............................................................... 101
6.8 Adding exception rules to the output connector ............................... 102
7 Connector reference ............................................................. 105

7.1 Command output connector ........................................................... 105
7.2 Custom Java connectors ............................................................... 106
7.3 Device input connector .................................................................. 107
7.4 Directory input connector ............................................................... 107
iv OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
7.5 EasyLink connectors ..................................................................... 109

7.5.1 Batch sending of messages ........................................................... 110
7.5.2 Creating a connection profile for EasyLink ...................................... 112
7.5.2.1 Obtaining and adding a certificate to the resource set ...................... 112
7.5.2.2 Setting up a web service connection profile for EasyLink ................. 114
7.5.3 EasyLink Email output connector ................................................... 115
7.5.3.1 Broadcasting messages ................................................................ 117
7.5.3.2 Adding attachments to emails ........................................................ 119
7.5.4 EasyLink Fax output connector ...................................................... 121
7.5.5 EasyLink SMS output connector ..................................................... 122
7.5.5.1 EasyLink job status reporting ......................................................... 124
7.6 EmailIN input connector ................................................................. 126
7.6.1 Additional scripting functions for attachment handling ...................... 129
7.7 Email output connectors ................................................................ 131
7.7.1 Using an SMTP (MIME) output connector ....................................... 131
7.7.1.1 Connecting to the SMTP mail server .............................................. 132
7.7.1.2 Configuring runtime settings .......................................................... 134
7.7.1.3 Editing the email ........................................................................... 135
7.7.1.4 Adding attachments to the email .................................................... 136
7.7.1.5 Attaching output from other Processes ........................................... 136
7.7.1.6 Attaching resources ...................................................................... 137
7.7.1.7 Using attachment script functions ................................................... 138
7.7.1.8 Zipping attachments ...................................................................... 138
7.7.1.9 Using an Attachment connector ..................................................... 139
7.7.1.10 Configuring the SMTP connection pool ........................................... 140
7.7.2 Using an SMTP (MIME) (Legacy) output connector ......................... 140
7.7.2.1 Connecting to the SMTP mail server .............................................. 141
7.7.3 Using a MAPI output connector ...................................................... 144
7.7.3.1 Connecting to the MAPI mail server ................................................ 145
7.7.4 GUI reference ............................................................................... 147
7.7.4.1 Attachment output connector ......................................................... 147
7.7.4.2 SMTP (MIME) output connector ..................................................... 147
7.7.4.3 SMTP (MIME) (Legacy) output connector ....................................... 152
7.7.4.4 MAPI output connector .................................................................. 156
7.8 Fax connectors ............................................................................. 158
7.8.1 Fax Connect output connector ....................................................... 159
OpenText Communications Center Enterprise – Project Configuration Guide v

Table of Contents
7.8.1.1 Fax (Generic) ................................................................................ 160

7.8.1.2 RightFax and RightFax Unicode ..................................................... 160
7.8.1.3 Zetafax ......................................................................................... 161
7.9 File output connector ..................................................................... 161
7.9.1 Generating output files for StoryTeller attachments ......................... 161
7.10 FTP connectors ............................................................................ 162
7.10.1 FTP input connector ...................................................................... 162
7.10.2 FTP output connector .................................................................... 164
7.11 Generic Archive output connector .................................................. 166
7.12 HTTP connectors .......................................................................... 168
7.12.1 HTTP(S) input connector ............................................................... 168
7.12.1.1 HTTP Access tab .......................................................................... 170
7.12.1.2 HTTP Realms tab ......................................................................... 171
7.12.1.3 Custom HTTP(S) connector settings .............................................. 172
7.12.2 HTTP(S) Poll input connector ......................................................... 173
7.12.3 HTTP(S) Submit output connector .................................................. 175
7.12.4 HTTP Response output connector .................................................. 179
7.12.5 HTTP connector scenarios ............................................................ 180
7.13 Internal connectors ........................................................................ 180
7.14 JDBC connectors .......................................................................... 181
7.14.1 JDBC input connector .................................................................... 182
7.14.1.1 Creating an SXD file ...................................................................... 185
7.14.2 JDBC output connector ................................................................. 186
7.15 JMS connectors ............................................................................ 189
7.15.1 Concepts ...................................................................................... 189
7.15.1.1 Queues an topics .......................................................................... 189
7.15.1.2 JNDI Settings ................................................................................ 189
7.15.1.3 Message formats .......................................................................... 190
7.15.1.4 Metadata from input connectors ..................................................... 190
7.15.1.5 Header properties ......................................................................... 190
7.15.1.6 Message properties ....................................................................... 190
7.15.1.7 Durable subscriptions .................................................................... 191
7.15.1.8 Connection factory ........................................................................ 191
7.15.2 Connector reference ...................................................................... 191
7.15.2.1 JMS Queue Receiver input connector ............................................. 191
7.15.2.2 JMS Topic Subscriber input connector ............................................ 193
7.15.2.3 JMS Queue Sender output connector ............................................. 194
7.15.2.4 JMS Topic Publisher output connector ............................................ 195
7.16 Job Resource output connector ...................................................... 196
7.17 LiveCycle output connector ............................................................ 197
7.18 Null Connector output connector .................................................... 198
7.19 OpenText Archive output connector ................................................ 198
vi OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
7.20 Pipe connectors ............................................................................ 199

7.21 Resource output connector ............................................................ 200
7.22 Service Call output connector ........................................................ 201
7.22.1 Service Call connector settings ...................................................... 202
7.23 Service Request input connector .................................................... 204
7.24 SNMP trap output connector .......................................................... 206
7.24.1 Collection configuration ................................................................. 207
7.24.2 Process configuration .................................................................... 207
7.25 Spool output connector .................................................................. 207
7.26 Standard input and Standard output connectors .............................. 207
7.27 StreamServe External Viewer output connector .............................. 208
7.28 TCP/IP connectors ........................................................................ 208
7.29 TOPCALL output connector ........................................................... 209
7.30 WebSphere MQ connectors ........................................................... 210
7.30.1 Concepts ...................................................................................... 210
7.30.1.1 The IBM WebSphere MQ environment ........................................... 210
7.30.1.2 Server connection channel ............................................................ 210
7.30.1.3 Segmented messages ................................................................... 211
7.30.1.4 Message groups ........................................................................... 211
7.30.1.5 Synchronization ............................................................................ 211
7.30.1.6 Message formats .......................................................................... 212
7.30.1.7 Message properties – input connectors ........................................... 212
7.30.1.8 Message properties – output connectors ........................................ 213
7.30.1.9 Metadata from input connectors ..................................................... 214
7.30.1.10 Queues and topics ........................................................................ 215
7.30.1.11 TCP/IP profile ............................................................................... 216
7.30.2 Enabling WebSphere MQ V8 ......................................................... 216
7.30.3 Enabling SSL for Java 8 and WebSphere MQ V8 ............................ 217
7.30.4 Connector reference ...................................................................... 218
7.30.4.1 WebSphere MQ Queue Receiver input connector ........................... 218
7.30.4.2 WebSphere MQ Queue Sender output connector ............................ 219
7.30.4.3 WebSphere MQ Reply Queue Sender output connector .................. 221
7.30.4.4 WebSphere MQ Topic Subscriber input connector .......................... 222
7.30.4.5 WebSphere MQ Topic Publisher output connector .......................... 224
7.31 Sending output to Vista Plus Output Manager ................................. 225
7.31.1 About status tracking for Output Manager jobs and devices ............. 226
7.31.1.1 Output Manager job status ............................................................. 227
7.31.1.2 Output Manager device status ....................................................... 228
7.31.2 Configuration steps to send Communications Center output to
Output Manager ............................................................................ 229
7.31.2.1 Creating a web service profile for Output Manager .......................... 229
7.31.2.2 Setting up HTTPS communication with Output Manager .................. 230
OpenText Communications Center Enterprise – Project Configuration Guide vii

Table of Contents
7.31.2.3 Setting up a web service connection profile for Output Manager ....... 231
7.31.2.4 Vista Plus Output Manager connector settings ................................ 233
7.31.3 Configuration steps to set up job tracking ........................................ 239
7.31.4 Configuration steps to set up device tracking .................................. 241
8 Queue management .............................................................. 243

8.1 Configuring queues ....................................................................... 243
8.2 Creating and renaming queues ...................................................... 243
8.3 Specifying the default input and output queue ................................. 244
8.4 Enabling transactional support ....................................................... 244
8.5 Enabling sorting of queue items ..................................................... 245
8.6 Setting up the queue spooling options ............................................ 245
8.7 Enabling sharing of queues ............................................................ 246
8.8 Storing queued documents on disk ................................................. 247
8.9 Deleting queues ............................................................................ 248
9 Resource set management ................................................... 249

9.1 Connecting a resource set to a Project component .......................... 249
9.2 Adding resources to a resource set ................................................ 249
9.2.1 Copying and pasting resources ...................................................... 251
9.3 Editing resources .......................................................................... 252
9.4 Extracting a resource to file ............................................................ 253
9.5 Showing resource dependencies .................................................... 253
10 Sorting .................................................................................... 255

10.1 Sort keys ...................................................................................... 257
10.2 Sorting before Process .................................................................. 258
10.3 Sorting after Process ..................................................................... 260
10.4 Sorting Documents ........................................................................ 261
11 Concepts and glossary ......................................................... 263

11.1 Message ...................................................................................... 263
11.2 Design Center Projects .................................................................. 263
11.3 Platforms ...................................................................................... 263
11.4 Message configurations ................................................................. 264
11.4.1 Events .......................................................................................... 264
11.4.2 Processes .................................................................................... 265
11.5 Runtime configurations .................................................................. 265
11.5.1 Runtime jobs ................................................................................ 266
11.5.2 Post-processors ............................................................................ 266
11.6 Input connectors ........................................................................... 267
11.7 Output connectors ......................................................................... 267
11.8 Input queues ................................................................................. 268
viii OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
11.9 Output queues .............................................................................. 268

11.10 Output modes ............................................................................... 268
11.11 Resources .................................................................................... 269
11.12 Resource sets ............................................................................... 269
11.13 Platform layers .............................................................................. 269
11.14 Project export and deployment ....................................................... 270
11.15 Glossary ....................................................................................... 271
12 Design Center dialog boxes ................................................. 275

12.1 Main window reference .................................................................. 275
12.1.1 Customize dialog box .................................................................... 275
12.1.2 Design Center Settings dialog box .................................................. 276
12.2 Project dialog boxes ...................................................................... 277
12.2.1 Project Settings dialog box ............................................................ 278
12.2.2 Project Package information dialog box .......................................... 278
12.2.3 Unpack Project dialog box ............................................................. 279
12.2.4 Create Project from Template dialog box ........................................ 279
12.2.5 Project Export Settings dialog box .................................................. 280
12.2.5.1 InputAnalyzer tab .......................................................................... 280
12.2.6 Font Dependencies dialog box ....................................................... 281
12.2.7 Edit Custom Fields dialog box ........................................................ 282
12.2.8 Export and Export for release dialog boxes ..................................... 282
12.2.8.1 Scripts dialog box .......................................................................... 283
12.3 Platform dialog boxes .................................................................... 284
12.3.1 Configure Platform dialog box ........................................................ 284
12.3.2 Configure Platform dialog box – Generic layer mode ....................... 285
12.3.2.1 Job Status tab ............................................................................... 285
12.3.2.2 Advanced tab ................................................................................ 286
12.3.3 Configure Platform dialog box – Physical layer mode ...................... 286
12.3.3.1 Recording Mode tab ...................................................................... 287
12.3.3.2 File Cache tab .............................................................................. 287
12.3.4 Manage Queues dialog box ........................................................... 288
12.3.4.1 Queuing tab .................................................................................. 289
12.3.4.2 Advanced tab ................................................................................ 289
12.3.5 Manage Physical Layers dialog box ................................................ 291
12.3.6 Configure Platform Export dialog box ............................................. 291
12.3.7 Input Connector Settings dialog box ............................................... 292
12.3.8 Input Connector Settings dialog box – Generic layer mode .............. 292
12.3.8.1 Queue tab .................................................................................... 293
12.3.8.2 Filter chain tab .............................................................................. 293
12.3.8.3 General tab ................................................................................... 294
12.3.9 Input Connector Settings dialog box – Physical layer mode .............. 295
OpenText Communications Center Enterprise – Project Configuration Guide ix

Table of Contents
12.3.9.1 Connector Settings tab .................................................................. 295

12.3.9.2 HTTP Access tab .......................................................................... 295
12.3.9.3 General Settings tab ...................................................................... 296
12.3.10 Output Connector Settings dialog box ............................................. 296
12.3.11 Output Connector Settings dialog box – Generic layer mode ............ 297
12.3.11.1 Code page Settings tab ................................................................. 298
12.3.11.2 Device Driver Settings tab ............................................................. 298
12.3.11.3 Symbol Set tab ............................................................................. 299
12.3.11.4 Filter Chain Settings tab ................................................................ 300
12.3.11.5 Queue tab .................................................................................... 301
12.3.11.6 Output mode tab ........................................................................... 301
12.3.12 Output Connector Settings dialog box – Physical layer mode ........... 302
12.3.12.1 Connector tab ............................................................................... 303
12.3.12.2 General tab ................................................................................... 303
12.4 Message dialog boxes ................................................................... 303
12.4.1 Event Settings dialog box .............................................................. 303
12.4.1.1 Agent Settings tab ......................................................................... 303
12.4.1.2 Event Order tab ............................................................................ 304
12.5 Runtime configuration dialog boxes ................................................ 305
12.5.1 Edit Event Sort Definition dialog box ............................................... 305
12.5.2 Set Job Sender dialog box ............................................................. 306
12.5.3 Runtime Output Connector Settings dialog box ............................... 306
12.5.4 Runtime Output Connector Settings dialog box – Generic layer mode ...
306
12.5.4.2 Post-processor tab ........................................................................ 307
12.5.4.3 Document Trigger tab .................................................................... 307
12.5.4.4 Device driver settings tab ............................................................... 307
12.5.4.5 Device Driver Symbol Set tab ........................................................ 308
12.5.4.6 Sheet Layout tab ........................................................................... 308
12.5.4.7 Side by Side tab ............................................................................ 309
12.5.4.8 OMR tab ....................................................................................... 309
12.5.4.9 Labels tab ..................................................................................... 309
12.5.4.10 Stored Variables tab ...................................................................... 311
12.5.4.11 Document Broker Plus tab ............................................................. 312
12.5.4.12 Process Sort Definition tab ............................................................ 312
12.5.4.13 Archiving tab ................................................................................. 313
12.5.4.14 Enveloping tab .............................................................................. 313
12.5.4.15 Document Sort tab ........................................................................ 314
12.5.5 Runtime Output Connector Settings dialog box – Physical layer
mode ............................................................................................ 314
12.5.5.1 Connector type (File, Spool, etc.) tab .............................................. 314
x OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
12.5.5.2 Receiver tab ................................................................................. 314

12.5.6 Runtime Event Settings dialog box ................................................. 315
12.5.6.1 General tab ................................................................................... 315
12.5.6.2 Code Page tab .............................................................................. 316
12.5.7 Runtime Process Settings dialog box ............................................. 316
12.5.7.1 Rule tab ........................................................................................ 317
12.5.7.2 General tab ................................................................................... 317
12.5.7.3 Delivery channels tab .................................................................... 318
12.5.8 Edit Output Connector Settings dialog box ...................................... 319
12.5.9 Connector Selection Method dialog box .......................................... 319
12.5.10 Process Link Target Settings dialog box ......................................... 320
12.5.11 Runtime Message Settings dialog box ............................................ 320
12.5.11.1 Service tab ................................................................................... 320
12.5.11.2 Job scaling tab .............................................................................. 322
12.6 Resource set dialog boxes ............................................................. 323
12.6.1 Select Fonts dialog box ................................................................. 323
12.6.2 Resource Type Settings dialog box ................................................ 323
12.6.3 Set Resource Editor dialog box ...................................................... 325
12.6.4 Select CAS resources dialog box ................................................... 326
12.6.5 Show Dependencies dialog box ..................................................... 327
13 Startup argument reference ................................................. 329

13.1 -a ................................................................................................. 329
13.2 -alternativebarcode ....................................................................... 329
13.3 -args ............................................................................................ 330
13.4 -asynchronqueue .......................................................................... 330
13.5 -demo .......................................................................................... 331
13.6 -detectcompccharset ..................................................................... 331
13.7 -disableasynchronqueuing ............................................................. 331
13.8 -disablesortedqueuing ................................................................... 332
13.9 -dumpvars .................................................................................... 332
13.10 -education .................................................................................... 333
13.11 -evaluation .................................................................................... 334
13.12 -evcollectmt .................................................................................. 334
13.13 -failinputfilteronerror ...................................................................... 335
13.14 -grb .............................................................................................. 335
13.15 -grbcodepage ............................................................................... 335
13.16 -ignorejobdefs ............................................................................... 336
13.17 -includejobdefs .............................................................................. 336
13.18 -java-options ................................................................................. 337
13.19 -java-user-class-path ..................................................................... 337
13.20 -langfile ........................................................................................ 338
OpenText Communications Center Enterprise – Project Configuration Guide xi

Table of Contents
13.21 -ldapsslcertdb ............................................................................... 338

13.22 -ldapSslKeyDb .............................................................................. 339
13.23 -licfile ........................................................................................... 339
13.24 -localpersistpath ............................................................................ 340
13.25 -logcp ........................................................................................... 340
13.26 -logfilecp ....................................................................................... 341
13.27 -lxfcachedynamic .......................................................................... 341
13.28 -lxfcachesize ................................................................................. 342
13.29 -maxinfiles .................................................................................... 342
13.30 -maxsortnodes .............................................................................. 343
13.31 -mbytefile ..................................................................................... 343
13.32 -msgsource ................................................................................... 344
13.33 -norecgrb ...................................................................................... 344
13.34 -nstack ......................................................................................... 345
13.35 -odbcpool ..................................................................................... 345
13.36 -odbctimeout ................................................................................. 345
13.37 -optalias ....................................................................................... 346
13.38 -parse .......................................................................................... 346
13.39 -pid .............................................................................................. 347
13.40 -preloadmorefontdata .................................................................... 347
13.41 -prn .............................................................................................. 347
13.42 -prnalias ....................................................................................... 348
13.43 -quealias ...................................................................................... 348
13.44 -rec .............................................................................................. 349
13.45 -reconly ........................................................................................ 350
13.46 -reducenotifications ....................................................................... 350
13.47 -rmlog .......................................................................................... 351
13.48 -shareddatapath ............................................................................ 351
13.49 -smtppoolsizemax ......................................................................... 351
13.50 -smtppoolsizemin .......................................................................... 352
13.51 -smtppooltempdisable ................................................................... 352
13.52 -sortdef ......................................................................................... 353
13.53 -sprog .......................................................................................... 353
13.54 -statusreporter .............................................................................. 353
13.55 -stdin ............................................................................................ 354
13.56 -streamcache ................................................................................ 354
13.57 -streamcachetimetolive .................................................................. 355
13.58 -sync ............................................................................................ 355
13.59 -tbl ............................................................................................... 356
13.60 -td ................................................................................................ 356
13.61 -tmpcompress ............................................................................... 356
13.62 -v ................................................................................................. 357
xii OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
13.63 -var .............................................................................................. 357

13.64 -wsin ............................................................................................ 358
13.65 -xmlunusedattributes ..................................................................... 358
13.66 -xmlwhitespacenodes .................................................................... 359
13.67 -xsdimport .................................................................................... 360
Part 2 Metadata management 361
14 About metadata models ........................................................ 363
15 Creating a model in Describer .............................................. 365

15.1 Getting started with Describer ........................................................ 365
15.1.1 Setting up a management gateway connection ............................... 366
15.1.2 Opening a model ........................................................................... 366
15.1.3 Checking in and out models ........................................................... 367
15.2 Concepts of modelling properties and types .................................... 368
15.3 Creating properties and types in the model ..................................... 369
15.3.1 Adding properties to the model ....................................................... 369
15.3.2 Creating the types tree .................................................................. 370
15.3.3 Using properties in the types .......................................................... 371
15.3.4 Deleting types and properties ......................................................... 373
15.3.5 Versioning of models and types ..................................................... 373
15.3.6 Deleting a local model ................................................................... 374
15.3.7 Copying a model, types, or properties from another tenant ............... 374
15.4 Controlling access to the types ....................................................... 376
16 Using a metadata model in Design Center .......................... 379

16.1 Selecting the model for a Design Center Project .............................. 379
16.2 Applying types to documents or Messages ..................................... 380
16.3 Finding the types used in a Project ................................................. 382
16.4 Updates to models ........................................................................ 382
16.5 Assigning values to properties ....................................................... 383
16.5.1 Finding the GUID of a property ....................................................... 384
16.5.2 getMetadataMessage .................................................................... 385
16.5.3 getMetadataMessageFrom ............................................................ 386
16.5.4 setMetadataMessage .................................................................... 387
16.5.5 getMetadataDBroker ..................................................................... 388
16.5.6 getMetadataDbrokerFrom .............................................................. 389
16.5.7 setMetadataDBroker ..................................................................... 390
16.5.8 getMetadataInput .......................................................................... 391
16.5.9 getMetadataOutput ....................................................................... 391
16.5.10 setMetadataOutput ........................................................................ 392
17 Importing and exporting models .......................................... 395
OpenText Communications Center Enterprise – Project Configuration Guide xiii

Table of Contents
Part 3 Profile configurations 399
18 About profile configurations ................................................ 401
19 Creating profiles .................................................................... 403

19.1 TCP/IP profiles .............................................................................. 404
19.2 Web service profiles ...................................................................... 405
19.2.1 Generic web service profiles .......................................................... 405
19.2.2 Media Management connection profiles .......................................... 406
19.3 Authentication profiles ................................................................... 407
19.4 Secure channel profiles ................................................................. 407
19.5 Certificate store profiles ................................................................. 408
19.6 Repository profiles ........................................................................ 409
Part 4 Drivers and fonts 413
20 AFP driver .............................................................................. 415

20.1 Configuring the AFP driver ............................................................. 417
20.1.1 Job Begin AFP driver settings ........................................................ 417
20.1.2 Document Begin AFP driver settings .............................................. 426
20.1.3 Page Begin AFP driver settings ...................................................... 427
20.1.4 Configuration file AFP driver settings .............................................. 428
20.2 Modes for managing AFP resources ............................................... 429
20.3 Fonts and code pages ................................................................... 433
20.3.1 Generating font resources ............................................................. 433
20.3.2 Code pages .................................................................................. 434
20.3.3 Mapping fonts and code pages ...................................................... 435
20.4 Images and overlays ..................................................................... 439
20.4.1 Generating image resources .......................................................... 440
20.4.2 Generating overlay resources ........................................................ 440
20.4.3 Specifying color profiles for external images ................................... 441
20.4.4 Mapping images, overlays and color profiles ................................... 442
20.5 Form definitions ............................................................................ 445
20.6 Color management ........................................................................ 445
20.6.1 Specifying a color profile for the AFP data stream ........................... 447
20.6.2 Specifying a color profile for a page ................................................ 447
20.7 Variables and properties ................................................................ 447
20.8 Page identification parameters included in the generated AFP data
stream file ..................................................................................... 448
20.9 Optimizing performance ................................................................. 448
21 DOCX driver ........................................................................... 451

21.1 DOCX driver settings ..................................................................... 451
xiv OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
21.2 DOCX output structure .................................................................. 452

21.3 Word driver considerations ............................................................ 453
21.4 Defining Table of Contents for DOCX output ................................... 459
22 HTML unpaginated driver ..................................................... 461

22.1 HTML considerations .................................................................... 468
23 Layout driver .......................................................................... 471
24 PCL 6 driver ........................................................................... 473
25 PDF driver .............................................................................. 477

25.1 PDF driver settings ........................................................................ 478
25.2 Encryption .................................................................................... 486
26 PostScript driver .................................................................... 489
27 XPS driver .............................................................................. 493
28 Zebra Label Printer driver ..................................................... 495

28.1 Driver files and printer resolution .................................................... 495
28.2 Getting the label size right ............................................................. 495
28.3 Fonts ............................................................................................ 496
28.3.1 Mapping fonts to Zebra fonts .......................................................... 497
28.3.2 Font sizes ..................................................................................... 497
28.3.3 Downloading TrueType and Unicode fonts to the Zebra printer ........ 499
28.4 Printing white text on black background .......................................... 500
28.5 Barcodes ...................................................................................... 501
28.6 Graphics ....................................................................................... 502
28.7 Enabling hexadecimal character values .......................................... 503
28.8 Zebra Label Printer driver settings .................................................. 503
29 RFID ........................................................................................ 507

29.1 Supported air protocols and printer models ..................................... 508
29.2 RFID settings ................................................................................ 509
30 Managing fonts ...................................................................... 511

30.1 Using Type Manager ..................................................................... 511
30.2 Font entries in driver files and substitution tables ............................. 512
30.3 Editing font entries ........................................................................ 513
30.4 TTF fonts ...................................................................................... 514
30.4.1 PostScript, PDF, and raster drivers ................................................ 515
30.4.2 PCL 5 drivers ................................................................................ 515
30.5 Type 1 fonts .................................................................................. 517
30.5.1 Adding character encodings to Type1 font entries ........................... 518
30.6 Embedding fonts and downloading soft fonts .................................. 518
OpenText Communications Center Enterprise – Project Configuration Guide xv

Table of Contents
30.6.1 Embedding fonts in PDF documents ............................................... 519

30.6.2 Embedding fonts in output to PCL printers ...................................... 520
30.6.3 Downloading soft fonts to PCL printers ........................................... 520
31 Device drivers and tools ....................................................... 523

31.1 Windows Driver Tool ..................................................................... 523
31.2 Device Tool .................................................................................. 525
31.2.1 Adding customized device drivers .................................................. 525
31.2.2 Modifying customized device drivers .............................................. 529
31.2.3 Device Tool GUI reference ............................................................ 529
31.2.3.1 Internal name and display name settings ........................................ 530
31.2.3.2 Device class settings ..................................................................... 531
31.2.3.3 Device configurator settings ........................................................... 531
31.2.3.4 Device driver file settings ............................................................... 532
31.2.3.5 Device options settings .................................................................. 532
31.2.3.6 Option parameter settings .............................................................. 533
Part 5 Filter management 537
32 Filters and filter chains ......................................................... 539

32.1 Creating filter chains ...................................................................... 539
32.2 Adding filter chains ........................................................................ 540
32.3 Filter reference .............................................................................. 541
32.3.1 Bypass filter .................................................................................. 543
32.3.2 Content Server filter ...................................................................... 544
32.3.3 DAQ filter ..................................................................................... 547
32.3.4 File filter ....................................................................................... 551
32.3.5 GenericArchive filter ...................................................................... 553
32.3.6 Internal filter .................................................................................. 554
32.3.7 Java filter ...................................................................................... 555
32.3.8 JavaScript filter ............................................................................. 556
32.3.9 Job filter ....................................................................................... 557
32.3.10 LiveCycle filter .............................................................................. 558
32.3.11 PDF signature filter ....................................................................... 559
32.3.12 Resource filter .............................................................................. 561
32.3.13 Service call filter ............................................................................ 562
32.3.14 XML stylesheet filter ...................................................................... 563
33 AFPIN filter ............................................................................. 565

33.1 Notes about the AFPIN filter .......................................................... 565
33.2 Supported barcodes ...................................................................... 566
33.3 Configuring the AFPIN filter ........................................................... 567
33.3.1 Font mapping ................................................................................ 567
xvi OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
33.3.2 Character set mapping .................................................................. 568

33.3.3 Typeface mapping ......................................................................... 570
33.3.4 Coded font mapping ...................................................................... 571
33.3.5 FGID mapping .............................................................................. 571
33.3.6 Code page mapping ...................................................................... 571
33.3.7 CPGID mapping ............................................................................ 572
33.3.8 GCGID mapping ........................................................................... 572
33.3.9 Creating a GCGID mapping file ...................................................... 572
33.3.10 Specifying GCGID generic masks .................................................. 573
33.3.11 Extracting NOP records ................................................................. 574
33.3.12 Capturing and reusing AFP objects ................................................ 575
33.3.13 Medium Map variables .................................................................. 575
33.4 AFPIN filter settings ...................................................................... 576
33.4.1 AFPIN filter settings file ................................................................. 577
33.4.2 AFPIN filter GUI reference ............................................................. 577
34 PDFIN filter ............................................................................. 583

34.1 Notes about the PDFIN filter .......................................................... 583
34.2 Configuring the PDFIN filter ........................................................... 589
34.3 Font handling ................................................................................ 590
34.4 Retrieving metadata from input documents ..................................... 593
Part 6 Codepage management 595
35 About code pages and Unicode support ............................ 597

35.1 Code pages and Unicode support in Communications Center .......... 597
36 Code pages for input data .................................................... 603

36.1 Identifying the code page used to encode input data ....................... 603
36.2 Specifying code pages per input connector ..................................... 604
36.3 Specifying code pages per input type ............................................. 605
36.4 Dynamically selecting code pages for the input to an Event ............. 606
37 Code pages for output data .................................................. 609
38 Code pages for support files and logs ................................ 611
39 Bidirectional text ................................................................... 613

39.1 Reordering visually ordered input ................................................... 613
39.2 Reordering output to visual order ................................................... 614
Part 7 Post-processing 617
40 Document Broker .................................................................. 619

40.1 Document Broker concepts ............................................................ 620
OpenText Communications Center Enterprise – Project Configuration Guide xvii

Table of Contents
40.2 Creating a central Document Broker repository ............................... 622

40.3 Storing documents in a Document Broker repository ....................... 623
40.3.1 Configuring types and properties .................................................... 624
40.3.2 Configuring a Document Broker Plus output connector .................... 624
40.3.2.1 Storing variables with the documents ............................................. 626
40.3.2.2 Storing Document Broker Plus blobs on a disk ................................ 626
40.3.3 Storing only documents from successful jobs .................................. 627
40.4 Collecting documents from a Document Broker repository ............... 627
40.4.1 Creating queries for a Post-processor ............................................. 628
40.4.2 Configuring input connectors to collect queries ................................ 628
40.4.3 Configuring Post-processors .......................................................... 629
40.5 Creating PPQs .............................................................................. 630
40.5.1 PPQ syntax .................................................................................. 630
40.5.1.1 Action ........................................................................................... 631
40.5.1.2 Update ......................................................................................... 632
40.5.1.3 Job selection ................................................................................ 633
40.5.1.4 Document selection ....................................................................... 634
40.5.2 Creating document property filters .................................................. 635
40.5.3 Creating property filters ................................................................. 637
40.5.4 Auto-generating PPQs ................................................................... 638
40.5.4.1 Scenarios for auto-generated PPQs ............................................... 639
40.5.4.2 Connector settings for auto-generated PPQs .................................. 639
41 Sorting and bundling ............................................................ 641

41.1 Asynchronous and synchronous sorting and bundling ...................... 641
41.2 Sorting documents ........................................................................ 642
41.3 Bundling ....................................................................................... 644
41.3.1 Defining mailing machines ............................................................. 644
41.3.2 Bundling documents ...................................................................... 646
41.3.3 Splitting documents ....................................................................... 647
41.3.4 Managing inserts ........................................................................... 649
41.4 OMR codes .................................................................................. 650
41.4.1 Defining OMR codes ..................................................................... 650
41.4.2 STD strokes .................................................................................. 651
41.4.3 Bar functions ................................................................................ 652
41.4.4 OMR examples ............................................................................. 655
41.5 Labels .......................................................................................... 655
41.6 Sorting and bundling scripts ........................................................... 657
41.6.1 Generating statistics reports .......................................................... 658
41.6.2 Adding a document sorting and bundling script ............................... 659
42 Sheet Layouts ........................................................................ 661

42.1 Creating sheet layout resources ..................................................... 661
xviii OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
42.2 Assigning sheet layouts to output connectors .................................. 666

42.3 Side-by-side printing ...................................................................... 666
42.4 Sheet layout examples .................................................................. 667
42.5 Sheet layout editor GUI reference .................................................. 668
42.5.1 Sheet Layout menu ....................................................................... 668
42.5.2 Tools menu ................................................................................... 668
42.5.3 Categories .................................................................................... 668
42.5.3.1 Sheet layout settings ..................................................................... 669
42.5.3.2 Media settings .............................................................................. 671
42.5.3.3 Image settings – sheet level ........................................................... 672
42.5.3.4 Image settings – partition level ....................................................... 673
42.5.3.5 Overlay settings ............................................................................ 673
42.5.3.6 Repeat settings ............................................................................. 674
42.5.3.7 Signature settings ......................................................................... 674
42.5.3.8 Partition settings ........................................................................... 675
42.5.3.9 Horizontal fold marks settings ........................................................ 676
42.5.3.10 Vertical fold marks settings ............................................................ 676
42.5.3.11 Horizontal gutters settings ............................................................. 677
42.5.3.12 Vertical gutters settings ................................................................. 677
Part 8 Correspondence management 679
43 About correspondence management .................................. 681
44 Managing templates, themes, and documents ................... 683

44.1 Making a Message available as a template ..................................... 684
44.2 Connecting types to the Message .................................................. 684
44.3 Configuring output connectors for delivery ...................................... 684
44.4 Service-enabling the Message ....................................................... 685
44.5 Preview enabling themes ............................................................... 686
44.5.1 Using custom preview connectors .................................................. 686
44.6 Creating rules ............................................................................... 687
45 Reviewing documents ........................................................... 689

45.1 Setting property values .................................................................. 689
45.2 Configuring exception rules ............................................................ 690
45.3 Adding exception rules to the Message ........................................... 692
46 Modifying configurations ...................................................... 693

46.1 Modifications and template versions ............................................... 693
46.2 Deploying updated configurations .................................................. 694
46.2.1 Redeploying the existing version of the Project ............................... 695
46.2.2 Deploying a new version of the Project ........................................... 696
OpenText Communications Center Enterprise – Project Configuration Guide xix

Table of Contents
Part 9 Document tracking framework 699
47 About the document tracking framework ........................... 701
48 Configuring the document key ............................................. 703

48.1 Assigning the document key to the Messages and output
connectors .................................................................................... 703
48.2 Setting the value of the document key ............................................ 704
48.3 Mapping the document key ............................................................ 705
49 Configuring custom tracking attributes (Optional) ............ 707
Part 10 Security management 709
50 About encryption and authentication .................................. 711

50.1 Digital certificates .......................................................................... 711
50.2 Security configurations .................................................................. 712
50.3 Entropy ........................................................................................ 712
50.4 Trust Server administration ............................................................ 713
51 Creating security configurations ......................................... 715

51.1 Trust Server security configurations ................................................ 715
51.1.1 Security configuration for an SSL server ......................................... 716
51.1.2 Security configuration for an SSL client ........................................... 716
51.1.3 Security configuration for signing emails ......................................... 717
51.1.4 Security configuration for rejecting emails from non-trusted
addresses ..................................................................................... 717
51.1.5 Security configuration for encrypting emails .................................... 718
51.1.6 Security configuration for receiving encrypted emails ....................... 718
51.2 Trust Server scenarios .................................................................. 718
51.2.1 SSL server and SSL client ............................................................. 719
51.2.2 Encrypted emails .......................................................................... 720
51.2.3 Signed emails ............................................................................... 721
51.2.4 Encrypted and signed emails ......................................................... 723
51.3 Legacy security configurations ....................................................... 724
51.3.1 Security configuration for an SSL server (with client authentication) .. 725
51.3.2 Security configuration for an SSL server (without client
authentication) .............................................................................. 726
51.3.3 Security configuration for an SSL client (with client authentication) ... 726
51.3.4 Security configuration for an SSL client (without client
authentication) .............................................................................. 727
51.3.5 Security configuration for signing emails ......................................... 728
51.3.6 Security configuration for rejecting emails from non-trusted
addresses ..................................................................................... 729
xx OpenText Communications Center Enterprise – Project Configuration Guide

Table of Contents
51.3.7 Security configuration for encrypting emails .................................... 729

51.3.8 Security configuration for receiving encrypted emails ....................... 730
51.4 Legacy scenarios .......................................................................... 730
51.4.1 SSL server and SSL client with client authentication ........................ 730
51.4.2 SSL server and SSL client without client authentication ................... 732
51.4.3 Encrypted emails .......................................................................... 734
51.4.4 Signed emails ............................................................................... 735
51.4.5 Signed and encrypted emails ......................................................... 736
51.5 Security configuration GUI reference .............................................. 737
51.5.1 Trust Server settings ..................................................................... 738
51.5.2 Legacy settings ............................................................................. 739
Part 11 Utilities 741
52 I/O Delegator .......................................................................... 743

52.1 Running I/O Delegator ................................................................... 743
52.1.1 Running I/O Delegator in service request mode .............................. 744
52.1.1.1 Configuring a StreamServer application to handle service requests .. 744
52.1.1.2 Running I/O Delegator ................................................................... 745
52.1.2 Running I/O Delegator in HTTP mode ............................................ 746
52.1.3 Running I/O Delegator in File mode ................................................ 747
52.1.4 Time-outs ..................................................................................... 750
52.2 I/O Delegator arguments ............................................................... 750
52.2.1 Mode selection arguments ............................................................. 750
52.2.1.1 -servicerequestmode ..................................................................... 751
52.2.1.2 -httpmode ..................................................................................... 751
52.2.1.3 -filemode ...................................................................................... 751
52.2.1.4 -err ............................................................................................... 752
52.2.2 Arguments applicable to all modes ................................................. 752
52.2.2.1 -a ................................................................................................. 752
52.2.2.2 -td ................................................................................................ 753
52.2.2.3 -verbose ....................................................................................... 753
52.2.2.4 -log .............................................................................................. 753
52.2.2.5 -ll ................................................................................................. 754
52.2.2.6 -ato .............................................................................................. 754
52.2.3 Service request mode arguments ................................................... 754
52.2.3.1 -url ............................................................................................... 755
52.2.3.2 -servicename ................................................................................ 755
52.2.3.3 -serviceversion .............................................................................. 755
52.2.3.4 -submittype ................................................................................... 756
52.2.3.5 -sslversion .................................................................................... 756
52.2.3.6 -sslauthentication .......................................................................... 757
OpenText Communications Center Enterprise – Project Configuration Guide xxi

Table of Contents
52.2.3.7 -input ............................................................................................ 757

52.2.3.8 -output .......................................................................................... 757
52.2.3.9 -outputdir ...................................................................................... 758
52.2.3.10 -var .............................................................................................. 758
52.2.4 HTTP mode arguments ................................................................. 759
52.2.4.1 -url ............................................................................................... 759
52.2.4.2 -urlf .............................................................................................. 759
52.2.4.3 -user ............................................................................................ 760
52.2.4.4 -pwd ............................................................................................. 760
52.2.4.5 -realm .......................................................................................... 760
52.2.4.6 -cto .............................................................................................. 761
52.2.4.7 -input ............................................................................................ 761
52.2.4.8 -output .......................................................................................... 761
52.2.4.9 -var .............................................................................................. 762
52.2.5 File mode arguments ..................................................................... 762
52.2.5.1 -fto ............................................................................................... 763
52.2.5.2 -sid ............................................................................................... 763
52.2.5.3 -sod ............................................................................................. 763
52.2.5.4 -pre .............................................................................................. 764
52.2.5.5 -post ............................................................................................. 764
52.2.5.6 -efpost .......................................................................................... 764
52.2.5.7 -idfile ............................................................................................ 765
52.3 Return codes ................................................................................ 765
52.4 Error codes on StdErr .................................................................... 765
53 Print Processor ...................................................................... 767

53.1 Processing EMF data using Print Processor ................................... 767
53.2 Setting up Print Processor ............................................................. 769
53.2.1 Configuring the LXF Writer printer for Print Processor ...................... 769
53.2.2 Configuring Print Processor ........................................................... 770
53.2.3 Handling font mismatch ................................................................. 773
53.2.4 Editing the font settings file ............................................................ 774
53.3 Print Processor registry keys .......................................................... 775
54 Previewer ................................................................................ 777

54.1 Using Previewer ............................................................................ 777
xxii OpenText Communications Center Enterprise – Project Configuration Guide

Part 1
Design Center fundamentals
Chapter 1
Understanding the Design Center interface
This chapter describes the work environment and the interface elements of Design
Center. You will find a comprehensive reference of all Design Center dialog boxes in
“Design Center dialog boxes“ on page 275.
The Design Center graphical user interface (GUI) consists of four windows, and one
view per Project component (Platform, Message, Runtime configuration, and
resource set). The component views are displayed in the main window.
Figure 1-1: The Design Center GUI
• 1. Project browser
The “Project browser” is where you create and structure your Project.
• 2. Main window
The “Main window” is where you configure the Project components.
• 3. Property window
The “Property window” displays properties for the active view in the Main
window.
• 4. Search results window
The “Search results window” displays the search results after submitting Edit >
Find.
OpenText Communications Center Enterprise – Project Configuration Guide 25

Chapter 1 Understanding the Design Center interface
• 5. Log window
The “Log window” on page 38 displays the Design Center log.
Showing/hiding windows
You can use the View menu to show/hide windows (you cannot hide the Main
window).
1.1 Project browser

The Project browser is where you create and structure the Project. The Project is
displayed as a tree, and all Project components are added as nodes to the Project
tree.
Figure 1-2: The Project browser.
Folders
You can use folders to structure the Project nodes.
Project nodes
You add the Project nodes either at root level, or to the appropriate folders.
Moving nodes
You can drag and drop Project nodes between the folders.
26 OpenText Communications Center Enterprise – Project Configuration Guide

1.2. Main window
Activating Project component views

You can double-click a Project node to activate the corresponding view in the
Main window. This applies to the following types of Project nodes:
• Platform node – Activate the generic layer in the Platform view.
• Physical Platform layer node – Activate the corresponding physical layer in
the Platform view.
• Message node – Activate the corresponding Message configuration in the
Message view.
• Runtime configuration node – Activate the generic layer in the Runtime
configuration view.
• Physical Runtime configuration layer node – Activate the corresponding
physical layer in the Runtime configuration view.
• Resource set node – Activate the corresponding resource set in the resource
set view.
1.2 Main window

The Main window is where the component views are displayed.

Figure 1-3: The Main window.
You can open the following component views in the Main window:
• “Platform view”
• “Message view”
• “Runtime configuration view”
• “Resource set view”
Activating component views

To open and activate a component view, you can double-click the corresponding
node in the Project browser. If several component views are open in the Main
window, you can use the window tabs to activate a component view. The tabs
are displayed below the main window, and can be enabled/disabled from the
View menu.

1.2. Main window
1.2.1 Platform view

The Platform view is where you configure the Platform settings.
Figure 1-4: The Platform view.
Connectors
All connectors used in the Project are added to the Platform view. The
connectors are displayed as shown in Figure 1-4. The connector contains labels
that helps you identify the main features specified for the connector. The
connector labels are described below.
• Name - The name given to the connector.

• Type - The connector type. For example Directory input connector and File
output connector.
• Queue - The name of the queue used by the connector.
• Driver - The type of device driver used by the output connector.
Navigating between layers

The generic layer and all physical layers are activated in the same Platform
view. The banner at the top of the view shows which layer is active. You can use
the drop-down list in the banner to navigate between the different layers.
Figure 1-5: Drop-down list for navigation between layers.

1.2.2 Message view

The Message view is where you configure Messages.
Figure 1-6: The Message view.
Events and Processes

Each Event and Process is displayed as a separate object in this view. You can
open the Event/Process tool by double-clicking the corresponding Event/
Process.
Message
The actual Message is displayed between the Events and Processes.
Script indicators
You can add different types of scripts in the Message view. Script indicators on
the Event, Message, and Process objects indicate where scripts are added.
Figure 1-7: Script indicators.

1.2. Main window
Event order indicators

Event order indicators on the Event objects indicate the Event order (First,
Repeating, or Last) for each Event in the Message.
Figure 1-8: Event order indicators.
1.2.3 Runtime configuration view

The Runtime configuration view is where you connect Message configurations to the
Platform, and configure Runtime configuration specific settings.
Figure 1-9: The Runtime configuration view.

Input connectors
The input connectors are created in the Platform and displayed in the Runtime
configuration view. The connections between input connectors and Events are
indicated by lines in the Runtime configuration view.
Figure 1-10: Connection between input connector and Event.
Output connectors
The output connectors are created in the Platform and displayed in the Runtime
configuration view. The connections between Processes and output connectors
are indicated by lines in the Runtime configuration view.
Figure 1-11: Connection between Process and output connector.
Runtime jobs
A Runtime job is created by default when you create a Runtime configuration.
You can add new jobs to the Runtime configuration if you need to.

1.2. Main window
Figure 1-12: Runtime job.
Message configurations
You add a Message configuration to a Runtime job, and connect its Events and
Processes to the appropriate input and output connectors.
Figure 1-13: A Message configuration in a Runtime job.
Post-processors
You must add a Post-processor to the Runtime configuration in order to retrieve
documents from a Post-processor repository.
Figure 1-14: Post-processor.

Script indicators
You can add different types of scripts in the Runtime configuration view. Script
indicators on the Runtime jobs and Post-processors indicate where scripts are
added.
Figure 1-15: Script indicators on a Runtime job.
Navigating between layers

The generic layer and all physical layers are activated in the same Runtime
configuration view. The banner at the top of the view shows which layer is
active. You can use the drop-down list in the banner to navigate between the
different layers.
Figure 1-16: Drop-down list for navigation between layers.
Adding, renaming, and deleting Runtime jobs

By default, a Runtime configuration contains one Runtime job. If you need to, you
can add new Runtime jobs.
To add a Runtime job
1. Activate the generic layer.
2. Right-click the Runtime configuration view and select New Job. A new Runtime
job is added to the Runtime configuration view.
To rename a Runtime job
2. Right-click the job, select Rename, and enter the new name.

1.2. Main window
To delete a Runtime job
2. Right-click the job, and select Delete Job.
Adding, renaming, and deleting Post-processors
To add a Post-processor
2. Right-click the Runtime configuration view and select New Post-processor. A

new Post-processor is added to the Runtime configuration view.
To rename a Post-processor
2. Right-click the Post-processor, select Rename, and enter the new name.
To delete a Post-processor
2. Right-click the Post-processor, and select Delete Post-processor.
Collapsing/expanding Runtime jobs and Post-processors

You can collapse or expand the Runtime jobs and Post-processors displayed in the
Runtime configuration view. When expanded, all Events, Processes, and connector
links are displayed. When collapsed, all Events, Processes, and connector links are
hidden.
To collapse or expand a single job
2. In the top-left corner of the job, click - to collapse or + to expand the job.
To collapse all jobs
2. Select Runtime > Collapse all jobs & Post-processors.
To expand all jobs
2. Select Runtime > Expand all jobs & Post-processors.

1.2.4 Resource set view

The resource set view is where you administer the resources in a resource set.
Figure 1-17: The resource set view.
Resource set node

When you create a resource set, it only contains a resource set node. This is the
root node of the resource set, and you add all resources and folders below this
node.
Folders
You can use folders to organize the resources in the resource set. A folder can
contain any number of resources and sub folders.
Local resources
Local resources are resources created from within the resource set. These
resources are stored in the Project directory.
Shortcuts to resources
You can add resources from other Project directories to a resource set. The icons
for these resources contain shortcut symbols to indicate that they are not local
resources. If you create a local resource, and then move it to another folder in the
resource set, the corresponding resource file stored on disk will not be moved.
The icon for a moved resource will also contain a shortcut symbol.

1.3. Property window
1.3 Property window

When you activate a view in the Main window, the view's properties are displayed
in the Property window.
Figure 1-18: The Property window.
Active view and selected item

The Active view is the active view in the Main window, and the Selected item is
the item selected in the active view. In the Property window example above, the
Active view is a Runtime configuration, and the Selected item is a Process
selected in that Runtime configuration view.
If no item is selected in the active view, the Selected item refers to the active
view, i.e. the corresponding node in the Project browser.
Note tab
On the Notes tab, you can add notes to the Selected item.
Dependencies tab
There are dependencies between the nodes in the Project browser. For example,
a Runtime configuration is related to settings in the Platform, resource sets,
Messages, and physical layers. On the Dependencies tab, you can see the
dependencies for the Active view, i.e. the corresponding node in the Project
browser.
File properties tab

Each node in the Project browser is stored as a Design Center file in a Project
directory. When you activate a node, its file properties are displayed on the File
properties tab. These properties include the absolute path to the file, and version
control status if the Project is connected to the CAS via Design Center.

1.4 Search results window

The Search Results window displays the search results after submitting Edit > Find.
Figure 1-19: The Search results window.
The search results are displayed in a list. You can double-click a line to activate the
corresponding view.
1.5 Log window

If Design Center logging is enabled you can see the Design Center log in this
window. You can use the filter buttons (toggle on/off) to specify which level of
information to display.
Figure 1-20: The Log window
You can enable logging to record the events which happen while you work with
your Design Center Projects. To enable logging you must specify the appropriate log
level and the path to the log file.
To enable logging
1. Select Tools > Configure Design Center Log.
2. Select the appropriate log level.

1.5. Log window
3. Specify the Log file path and click OK.
The log can be examined in the Log window in Design Center. You can use filters to
increase/decrease the level of information displayed.
To open the Log window
• Select View > Log window.
To filter the log
• Toggle the appropriate filter buttons on/off.

Chapter 2
Getting started in Design Center
2.1 Creating Projects from scratch

You can create a new Project from scratch, or you can use a Project template. See
“Creating a Project using a template” on page 49 for more information about
templates.
To create a new Project
1. Select File > New > Project. The Project Settings dialog box opens.
2. Specify the settings.
• Project name – The name of the Project.
• Default code page – The default code page you specify here will be the
default code page in all code page drop-down lists in the Project.
• Default Resource set – The default resource set of the Project. This resource
set is automatically connected to all Platforms, Message configurations, and
Runtime configurations you create from within the Project.
3. Click OK.
At this stage, the Project contains the Project node and a resource set node. You must
now add a Platform, Runtime configurations, and Message configurations to the
Project.
Naming Project components

You can use any name for the components in your Design Center Project with the
exceptions shown below.
Maximum number of characters

The maximum number of characters in a name is 63.
Invalid ASCII characters

0-31 (null to unit separator), 34 ("), 42 (*), 47 (/), 58 (:), 60 (<), 62 (>), 63 (?), 92 (\),
124 (|)
Invalid strings
AUX, CLOCK$, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8,
COM9, CON, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9, NUL,
PRN

Chapter 2 Getting started in Design Center
Adding folders to the Project tree

You can add folders to the Project tree. The folders help you organize the Project
components, i.e. you can create folders for Project components that are logically
connected.
To add a new folder
1. Right-click the Project node where you want to insert the folder, and select New
> Folder.
2. Rename the folder.
Adding a Platform to a Project

You can create a Platform from within the Project, and you can also link an existing
Platform from another Project to your Project. See “Sharing components into a
Project” on page 44 for information on how to link a Platform to your Project, and
“Structuring Projects” on page 59 for information on when to do so.
To create a new Platform
1. Right-click the Project node where you want to insert the Platform, and select
New > Platform. A new Platform node and a physical layer node are added to
the Project tree.
2. Rename the Platform and physical layer node.
Naming the Platform and physical layers

The name of the Platform should follow the naming standard used in your
organization, for example include company name, OS, etc. The name of the
physical layer should reflect the target environment in which it should be used –
Development, Test, etc.
Configuring a Platform
Now you have an empty Platform with one physical layer. To complete the
Platform, you must add and configure connectors, specify Platform settings, etc.
Adding new physical layers

To be able configure Platform settings for other target environments, you must
create a new physical layer for each target environment. See “Adding a physical
layer” on page 44 for information on how to add a new physical layer to your
Project.
Adding a Message configuration to a Project

You can create a Message configuration from within the Project, and you can also
link an existing Message configuration from another Project to your Project. See
“Sharing components into a Project” on page 44 for information on how to link a
Message configuration to your Project, and “Structuring Projects” on page 59 for
information on when to do so.

2.1. Creating Projects from scratch
To create a new Message configuration
1. Right-click the Project node where you want to insert the Message
configuration, and select New > Message. A new Message node is added to the
Project tree.
2. Rename the Message node.
Naming Message configurations

The name of the Message configuration should follow the naming standard used
in your organization.
Configuring a Message
Now you have an empty Message configuration. To complete the Message
configuration, you must add and configure the Events and Processes. See
“Message management“ on page 71 for information on how to configure a
Message.
Adding a Runtime configuration to a Project

You can create a Runtime configuration from within the Project, and you can also
link an existing Runtime configuration from another Project to your Project. See
“Sharing components into a Project” on page 44 for information on how to link a
Runtime configuration to your Project, and “Structuring Projects” on page 59 for
information on when to do so.
To create a new Runtime configuration
1. Right-click the Project node where you want to insert the Runtime
configuration, and select New > Runtime. The Select Platform dialog box opens.
2. Select the Platform you want to use for your Runtime configuration, and click
OK. A new Runtime configuration node and one or more physical layer nodes
are added to the Project tree.
3. Rename the Runtime configuration node.
Naming Runtime configurations

The name of the Runtime configuration should follow the naming standard used
in your organization. The physical layers are created in the Platform, and
inherited by the Runtime configuration. If, for example, the Platform contains a
Development and Test layer, the Runtime configuration will also contain a
Development and Test layer.
Configuring a Runtime configuration
Now you have an empty Runtime configuration. To complete the Runtime
configuration, you must add the appropriate Message configurations, connect
the Message configurations to the connectors, etc.
Adding a resource set to a Project

When you create a Project, a resource set is created by default. This resource set is
automatically connected to all components you create from within the Project. This

means all Project components will have access to all resources in the default resource
set.
You can also create additional resource sets. For example, you can create a resource
set that contains resources used by a number of Message configurations in the
Project. In this case, you must manually connect the resource set to the Message
configurations.
To create a new resource set

1. Right-click the Project node where you want to insert the resource set, and select
New > Resource set. A new resource set node is added to the Project tree.
2. Rename the resource set node.
Naming resource sets

The name of the resource set should follow the naming standard used in your
organization.
Adding resources to a resource set
Now you have an empty resource set, and you must add and configure the
resources. See “Resource set management“ on page 249 for information on how
to add resources to a resource set.
Adding a physical layer

When you create a Platform, one physical layer is created by default. This physical
layer is normally used for the Development environment. To be able configure
Platform settings for other target environments, you need to create a physical layer
for each target environment.
Platform and Runtime configuration

You add new physical layers to the Platform. When you add a new layer to the
Platform, a new layer is automatically added to the Runtime configurations in
the Project. For example, if you add a layer called Test to the Platform, a layer
called <Runtime configuration name> (Test) is automatically added to the
Runtime configurations.
Copy of existing layer
When you create the new layer, you create a copy of an existing layer. This
means all settings in the existing layer are copied to the new layer.
To add a new physical layer

1. In the Project browser, right-click the Platform node and select New Physical
Layer. The Select base dialog box opens.
2. Select the physical layer you want to copy, and click OK. The new physical
layer is added to the Platform and to the Runtime configurations.
Sharing components into a Project

Project components stored in the CAS can be shared by several Projects. For
example, you can create a Global Project that contains a Platform and resource set

shared by several Projects (see “Structuring Projects” on page 59). To use an

external Project component in your Project, you have to add the component from the
CAS to your Project. For more information, see “Reusing Project components”
on page 45.
2.1.1 Reusing Project components

You can reuse Project components in the following ways:
• Copy a Project component
There are two ways to copy a Project component:
• Copy from the CAS
You can browse the CAS, make a copy of a Message, Platform, runtime
configuration, or resource set, and then add it to the Project.
• Copy from the Project node
From the Project node, you can make a copy of a Message, Process, Platform,
or runtime configuration and paste it into the same Project.
• Share a Project component from the CAS
You can share a component from the CAS into different Projects. In order to
share a component, you must check the Project with the original component into
the CAS.
Changes made to a shared component in one Project are not automatically
applied to the other Projects. Instead you must choose whether you want to
download the latest version of the component. You can identify when changes
are made in shared components by looking at the status indicators. For more
information see “File status indicators” on page 51.
• Export and import individual resources
You can extract a resource to a file from a source Project and import the file to a
resource set in another Project. For more information, see “Extracting a resource
to file” on page 253 and “Creating resources by importing source files”
on page 250
In this section
• “Sharing a component between Projects” on page 46
• “Finding reused components” on page 47
• “Verifying that Project components have unique keys” on page 47
Copying a component
To copy a component within the same Project
1. In the Project browser, right-click the Project node, and then click Add copy to
Project.

2. Select the component you want to copy and then click OK.
To copy a component from another Project
1. In the Project browser, right-click the Project node, and then click Add copy to
Project.
2. In the Add to Project dialog box, click Browse, and if prompted log on to the
tenant.
3. In the Select CAS resources dialog box, enter your search criteria in the Find
box and then click Find.
4. In the Selectable resources list in the area on the left-side of the dialog box,
double-click the component or components you want to copy to the Project.
In the Selected resources area on the right-side of the dialog box, you see the
selected component(s) as well as all the dependencies, which are the Project
components that depend on the selected component(s).
5. Click OK to copy the selected component and the dependencies to the Project.
See also “To search for a specific type of Project component (Platform, runtime,
etc.)“ on page 47.
Notes
• You should not copy Processes that are used with, or will be used with,
StoryBoard.
Sharing a component between Projects

You can share the following types of components: Messages, Platforms, runtime
configurations, resource sets, Processes, and individual resources.
To share a component in several Projects
1. Do one of the following:
• To share a Platform, Message, runtime configuration, or resource set, right-

click the Project, and then select Add to Project.
• To share a Process, open the Message you want to add the Process to, right-
click the Process, and then select Add Process > Existing Process.
• To share a resource, right-click the resource set, and then select Add
Resource.
2. Click Browse and if prompted log on to the tenant.
3. In the Select CAS resources dialog box, enter your search criteria in the Find
box and then click Find.
4. In the Selectable resources list in the area on the left-side of the dialog box,
double-click the component or components you want to add to the Project.

In the Selected resources area on the right-side of the dialog box, you see the
selected component(s) as well as all the dependencies, which are the Project
components that depend on the selected component(s).
5. Click OK to add the selected component and the dependencies to the Project.
To search for a specific type of Project component (Platform, runtime, etc.)
1. In the Select CAS resources dialog box, click Change below the Find box.
2. Select the component types you want to search for and click OK.
Finding reused components

Before making a change to a Project component, you can verify whether the
component is used in another Project.
To find out which Project(s) a component is used in
1. In the Project browser, right-click the component node, and then click File
Properties.
2. Click List projects referencing this component.
Verifying that Project components have unique keys

Design Center uses internal keys to identify the following components used in the
Design Center Projects:
• Platform (*.dcplatform)
• Physical Platform layer (*.dcphyspf)
• Runtime configuration (*.dcruntime)
• Physical runtime configuration layer (*.dcphysrt)
• Message configuration (*.dcmessage)
• Process (*.dcprocess)
• Resource (*.dcres)
• Resource set (*.dcrset)
All Design Center Project files must have unique keys. If several files have the same
key, Design Center cannot identify which file to use where. When you copy a
component in a Design Center Project, and use it in the same Project or in another
Project that has any relations to the original Project, Design Center assigns a new to
key to the component.
You can perform a sanity check to see if any components in the Design Center
Project have the same keys, i.e. if there are any key conflicts. Please contact
OpenText Support if you experience any duplicate key related issues.

To perform a sanity check
• Select Tools > Perform system sanity check.
2.2 Packing and unpacking Projects

A Design Center Project consists of several Project files. To move a Project to another
environment, you pack all Project files into a single package file (*.dcpackage).
Then you move the package file to the new location, and unpack it there.
Packing a Project
You can pack any type of Project, and create a package file where all Project files and
resource files used in the Project are included.
If the Project includes linked components or a metadata model is used in the Project,
the linked Project files and metadata model are also included in the package file.
To pack a Project
1. Select File > Pack Project. The Project Package information dialog box opens.
2. Click Save as Project Package. A file browser opens.
3. Browse to the folder where you want to save the package, enter a File name for
the package, and click Save.
Unpacking a Project
When you unpack a Project, the Project files are stored in a predefined directory.
You cannot change the location of this directory.
Custom drivers
If you unpack a Project that contains custom drivers, the corresponding driver
files are unpacked as well. If there is a naming conflict, you are prompted to
overwrite the driver file you already have, rename the unpacked driver file, etc.
This means you must decide whether to overwrite existing driver files before
you unpack the Project.
To unpack a Project
1. Select File > Unpack Project. A file browser opens.

2. Browse to and open the package file.
3. Enter the appropriate options. See “Unpack Project dialog box”.
Creating a template
You can save a Project as a template. When you create a template, you should enter a
category and description of the template. This will make it easier to identify the
template.

2.3. Creating a Project using a template
To create a new Project template
1. Select File > Pack Project. The Project Package Information dialog box opens.
2. Enter a Category and Description and click Save as Project Template. The
Enter Project Template Name dialog box opens.
3. Enter a name for the template and click OK.
2.3 Creating a Project using a template

You can use templates when you create Projects. Design Center searches for
available templates in the directory specified by Project Templates location in the
Design Center Settings dialog box (Tools > Design Center Settings).
To open a Project template
1. Select File > New > Create Project from Template. The Create Project From
Template dialog box opens.
2. Select the appropriate category. All available templates in the selected category
are displayed in the Available templates list.
3. Select the template you want to open, and click OK. The Unpack Project dialog
box opens.
4. In Unpack to, specify the appropriate options, and then click OK.
Downloading templates from OpenText

The Create Project From template dialog box has a web link that you can use to
download templates from OpenText.
2.4 Saving and opening Projects

Project files are saved in a predefined directory. You cannot change the location of
this directory.
To save a Project
• Select File > Save Project.
To open a local Project
1. Select File > Open Project.

2. In the Locally available projects area, double-click the Project you want to
open.
To delete a local copy of a Project
Important
You cannot recover local Projects that you delete. Changes that you have
made in the Project that are not checked in are lost.

• In the Open Project dialog box, below the Locally available projects area, click
the Delete icon.
2.5 Connecting a Project to a management gateway

To link a metadata model to your Project or use the CAS to manage Project files or
export packages, you must connect the Project to a management gateway.
In distributed environments, you can connect to any management gateway that is

connected to the Communications Center environment. If you work with multiple
tenants that belong to one Communications Center environment, you enter the
tenant name when you connect to the management gateway.
Setting up a management gateway connection

Control Center, Design Center, and Describer use the same settings to connect to the
management gateway. If you have already set up a management gateway
connection in another one of these applications, it is available here.
1. On the MGW menu, click Log in.
2. In the Select Management Gateway dialog box, click Add new MGW
connection.
3. Enter a name for the connection, and the host and port for the management
gateway:
• Host
The address of the computer with the management gateway. For example:
https://localhost.
• Port
The port used for communication with the management gateway. The
default port is 28300.
4. Optional Change the default time-out settings:
• Connect time-out (milliseconds)

The time Design Center, Describer, and Control Center wait when trying to
establish a new connection to the management gateway.
• Send and receive time-out (milliseconds)
The time Design Center, Describer, and Control Center wait for responses
from the management gateway after the initial connection is established.
Tip: To edit the connection details, click Edit or to remove a connection,

click .

2.6. Using the CAS to manage Design Center files
Connecting to the management gateway

1. On the MGW menu, click Log in.
2. In the Select Management Gateway dialog box, click the connection, and then
click OK.
3. Enter your tenant name, user name, and password.
2.6 Using the CAS to manage Design Center files

The CAS is the central repository in the Communications Center environment. You
can use the CAS to manage Design Center Project files and release packages (export
files). Each Design Center file is one resource in the CAS.
Tip: OpenText recommends that you use the CAS to manage your Project files
and create packages. This is because not all functionality is available if you
store your files on disk and export to disk.
Design Center files and release packages are not added to the CAS automatically. To
use this functionality, you must connect Design Center to the management gateway
and manually check in your Project or create a release. After this, all Design Center
users who have access to the same tenant can access the files.
Design Center files and release packages in the CAS are versioned. This means that
each time a Project is checked in, a new version of the Project is added to the CAS.
And each time a release is created, a new version of both the Project and the export
file are added to the CAS.
The version of the Project file in CAS does not correspond to the Project version. For
example, you can check in several versions of a Project file without changing the
Project version.
File status indicators

Projects stored in the CAS have indicators that show the status of each Design
Center file in the CAS compared with the status of the file in your local directory. A
tick next to a node indicates that the file is stored in the CAS.
Tip: To refresh the file status, press F5.
Each file can have the following status:

• Current
The status of the file in the CAS is the same as the status of the file in your Project
directory.
• Modified
You have modified the file in your Project directory, but you have not checked in
the Project. To update the version in the CAS, you must check in the Project.

• Not in view
The file exists in your local Project directory, but is not in the CAS. You must
check in the Project to add the file to the CAS.
• Out of Date
Another user has modified a file and checked in the Project. This means you
must update the Project component in order to get the latest version. See “To
compare and then download or promote individual files“ on page 54.
• Conflict
Both you and another user have modified the same file. The other user has
checked in the Project. You have two options:
• You can promote your version of the file to the latest. This overwrites the
other persons changes.
• You can download the version of the file from the CAS. This overwrites your
changes.
For more information, see “To compare and then download or promote
individual files“ on page 54.
• Unresolved
The file exists both in your local Project directory and in the CAS. However
Design Center cannot identify if the local version corresponds to one of the
versions in the CAS.
For more information, see “Managing unresolved files ” on page 55.
Lock status indicators

Projects and Project files stored in the CAS can be locked to prevent several users
from making changes to the same file. Each file can have the following lock status:
Green lock icon You have the locked the file.

Red lock icon Another user has locked the file. You cannot edit the file.
No lock icon The file is not locked.
2.6.1 Checking in a Project to the CAS

The Project is connected to the CAS via the management gateway connection in
Design Center. Before you can check in a Project, you must connect to the
management gateway. For more information, see “Connecting a Project to a
management gateway” on page 50.
You use check in to both these things:

• Add a Project to the CAS for the first time.
• Add an updated version of a Project to the CAS.

Files to Force check in

Sometimes you and another user may modify the same file in a Project. When
you make a check in, you can make a force check in of these files. This will
overwrite the files in the CAS with your versions.
If you do not want to overwrite one or more of the files in the CAS, you must
download the latest version of each file before you check in the Project. For more
information about how to do this, see “Comparing, downloading, and
promoting individual files” on page 54.
In the Check in dialog box, you can see any files that have been modified by
both you and another user by looking for the Conflict status in the Components
to check in area.
To check in a Project
1. On the toolbar, click the Check in icon.

2. In the Check in dialog box, enter a label.
3. Optional In the Check in dialog box, enter a label and description.
4. Click OK. A new version of the Project is added to the CAS.
2.6.2 Opening a Project from the CAS

To open a Project from the CAS, you select the management gateway connection and
tenant you want to connect to. After you open the Project, any changes you make to
the files are stored in a copy of the Project in a directory on the disk.
Locking files
Before you make changes to a Project or Project component, you should lock the
file to prevent other users from making changes at the same time. When you
have finished working, you should unlock the file and check in your work.
To open a Project from the CAS
Note: Design Center files must be manually checked in to the CAS.
1. Select File > Open Project.

2. In the Connections area, do one of the following:
• Click the Add new MGW connection icon to create a new connection to a
management gateway. See “Connecting a Project to a management gateway”
on page 50.
• Click an existing management gateway connection.
3. Enter the tenant name, user name, and password to connect to the tenant
environment.
4. In the Select project and label to open dialog box, do the following:
• In the Select Project area, click the Project you want to open.

• In the Select commit area, click the revision of the Project you want to open.
To lock a Project or component
1. In the Project tree, select the entire Project or individual component you want to
lock.
2. On the toolbar, click the Lock icon.
To save your changes locally
You cannot change the location of where the local Project files are saved.
• On the toolbar, click the Save icon to save the active Project component, or the
Save All icon to save all the components in the Project.
To unlock a Project or component
1. In the Project tree, select the entire Project or individual component you want to
unlock
2. On the toolbar, click the Unlock icon.
2.6.3 Comparing, downloading, and promoting individual files

You can compare your local version of each Project file with the version of the
Project file in the CAS.
This is useful if you are working on the same Project as others, and someone else
checks in a newer version of the Project than you are currently working on.
If differences exist between your local version of a file and the version in the CAS,
you can choose what course of action to take for each file. The following options are
available:
• Download latest version – Retrieves the version of the file from the CAS. This
will overwrite your local version with the version from the CAS. Any changes
you made to the file are lost.
• Promote this version to the current – This will make your version of the file the
most recent version in the CAS. This will overwrite the version of the file in the
CAS with your version. This change is applied in the CAS after you check in the
Project.
• Leave as-is – No action is taken. The next time you check in the Project, you will
have the option to make a force check in, which will overwrite the version of the
file in the CAS with your version.
To compare and then download or promote individual files
1. On the toolbar, click the Update the state of the Project components icon.
2. For each file under the Files with "conflict" status and Out of date lists in the
Update components area, select the action to take:

• Leave as-is
• Download latest version
• Promote this version to the current
Note: If there are no files with the conflict or out of date status, you can close the
dialog box.
3. Click OK.
Design Center downloads any files marked for Download latest version. This
may take some time. Files marked for Promote this version to the current are
promoted the next time you check in the Project.
2.6.4 Disconnecting a Project from the CAS

Each Project can only be connected to one CAS (or tenant) at one time. If you work
with several tenants, you may want to move a Project into the CAS for another
tenant. To do this you must first disconnect the Project from the CAS. After this, you
can log on to the management gateway as another tenant and check in the Project to
the CAS belonging to that tenant.
To disconnect a Project from the CAS
1. In the Project tree, right-click the Project node, and then click Settings.
2. Beside the Connected to CAS box, click Disconnect.
2.6.5 Managing unresolved files

When you disconnect a Project from the CAS and then reconnect to the same CAS,
the Project files will have the status unresolved.
You can try to resolve this issue with the Update components > Attempt to resolve
version option.
If the local version of a file can be matched to a version in the CAS (for example, if
the component has not been changed), Design Center updates the file with the
appropriate status (current, out of date, etc.).
If the version of the file cannot be resolved, you have the following options:
• You can promote your version of the file to the latest. This will make your
version of the file the latest version in the CAS.
• You can download a version of the file from the CAS. This overwrites your file
with the version you download from the CAS.
For more information, see “To compare and then download or promote individual
files“ on page 54.

2.6.6 Creating a release

When you create a release, the Project is exported, all Project files are checked in to
the CAS, and the export file is added to the CAS. The export generates a file
(*.export) that contains all the Platform layers in the Project.
The export file is based on the current versions of the Project components that you
have open in Design Center. If the CAS contains a more recent version of a Project
component that you want to include in the export, you must download it before
creating the release. For more information about how to do this, see “Comparing,
downloading, and promoting individual files” on page 54.
Each time you create a release, a new version the export file is stored in the CAS.
Release packages you create in Design Center can be deployed to StreamServer
applications from Control Center. When you deploy the Project in Control Center,
you must connect to the CAS, select the Project, select the appropriate release
package based on the label, and then specify which physical layer to deploy.
To create a release
1. On the toolbar, click the Create release icon.
2. In the Export for release dialog box, specify the export settings. See “Export and
Export for release dialog boxes” on page 282.
3. In the Create release dialog box, enter a label and description.
4. Click OK.
See also
• “Increasing the Project version number” on page 56
2.7 Increasing the Project version number

Project version
When you export a Project, the Project is assigned a version number. Unless you
update the number manually, this is always version number 1.
Service version equals Project version

If a Project includes Service Request input connectors or service-enabled
Messages and you deploy the Project to a StreamServer application, the
StreamServer application automatically exposes services. The services are used
for creating, previewing, and releasing documents and are assigned the same
version number as the deployed Project.
Several service versions in parallel

Several services of different versions can run in parallel in the same domain. By
increasing the Project version number and deploying the new version to a
separate StreamServer application, you can run an updated Project version in
parallel with a previous Project version. For example, when using Reviewer,

2.8. Exporting Projects
already paused documents in the Message store repository are previewed and
released using the previous Project version, while new documents are created
using the updated Project version.
To increase the version number
• When you export the Project, increase the Version number.
Note: When increasing the Project version number, the version numbers
of all templates included in the Project are also increased.
2.8 Exporting Projects

You can export the Project to disk. The export generates a file (*.export) that
contains all the Platform layers in the Project. When you deploy the Project in
Control Center, you must specify which physical layer to deploy.
Tip: Because not all functionality is available when you export a Project to disk,
OpenText recommends you check in your Project to the CAS and create a
release rather than exporting to disk.
See also
• “Increasing the Project version number” on page 56
To export a Project to disk
1. Select Tools > Export. The Export dialog box opens.
2. Specify the export settings. See “Export and Export for release dialog boxes”
on page 282.
3. Click OK.

Chapter 3
Working with Projects
3.1 Structuring Projects

When you create a Project, you may come to a point where the Project is too large to
handle – too many components are displayed in the same Design Center view, it is
difficult for several developers to work with the same Project, etc. The best way to
solve this problem is to divide the Project into several sub Projects, and then link the
sub Projects to a common main Project.
One global Project

All Projects that are to be run by the same StreamServer application must be
based on the same Platform. You should create a separate global Project that
only contains the Platform and corresponding resource set. Then you link this
Platform to the other Project modules. This ensures that all Project modules are
based on the same Platform.
One sub Project per developer

Several developers should never work with the same Project at the same time.
You must therefore divide the Project into sub Projects, where each sub Project is
handled by one developer at a time. A sub Project contains Message
configurations that are logically connected to each other. For example, there can
be one sub Project for invoices, another for shipping documents, etc. The same
Platform is linked from the global Project to all sub Projects, and the appropriate
Message configurations, Runtime configurations, and resource sets are created
in each sub Project.

Chapter 3 Working with Projects
One main Project

The main Project includes the global Project and all sub Projects.

3.2. Scripting Projects
3.2 Scripting Projects

You can add scripts to Events, Processes etc. if you need to. You can add scripts at
different levels:
• Retrieved scripts (Events)

• Before and After Message scripts
• Before and After Process scripts
• Before and After Job scripts
To add a script
1. Right-click the object (Event, Process, Message or Job) and select Script.
2. In the Script editor, select a Trigger, then edit the script and click OK
See part I “Scripting in Communications Center” in OpenText Communications Center

Enterprise - Scripting Reference Guide (CCMPRJ-RSC) for information about scripting.
3.3 Using aliases

You can use aliases to configure settings dynamically. You can do this for various
features, such as selection of overlays, output connectors, driver settings, etc.
Several alternatives
An alias includes several alternatives. The alias also includes the conditions for
when to select a specific alternative. For example, an alias for output connector
selection contains several connector alternatives, and the conditions for when to
select a specific connector.
Two types of aliases

There are two types of aliases:
• Script alias, where you use scripting to determine which alternative to select.
See “Script alias” on page 62 for more information.
• Lookup alias, where you use lookup tables to determine which alternative to
select. See “Lookup alias” on page 63 for more information.
Default alternative
You must specify a default alternative. This alternative is used if there is no
matching condition specified in the alias. For example, a script alias includes
conditions for &countryCode="SWE" and &countryCode="FIN". If &
countryCode is neither SWE nor FIN, the default alternative is used.
When to use script alias, and when to use lookup alias

There are no general rules for when to use script alias, or when to use lookup
alias. There are however some features, for example font size and font color, that
do not support lookup alias.

Where to set the alias

You set aliases in the Design Center user interface at the same place as you set
fixed values. Instead of setting a fixed value, you select a default alternative,
specify the type of alias (script or lookup), and specify the alias parameters.
3.3.1 Script alias

A script alias consists of a key, a script, and an alias variable.
Key
The key is used in the script conditions. You can use a field reference
(&fieldname) or a variable ($variable) as key.
Script
In the script, you use the key to specify conditions for when to select a specific
alternative.
Alias variable
The alias variable is the variable you use when you set the alias in the Design
Center user interface. Note that the alias variable must be a variable
($variable). It must not be a field reference (&fieldname).
Setting a script alias

To set a script alias for a feature, you select the alias type Variable and specify
an alias variable.
Script alias example

In this example, a script alias is used to select the appropriate output connector:
• spoolSWE – output connector used for invoices with country code SWE. This is
also the default connector alternative.
• spoolFIN – output connector used for invoices with country code FIN.
Key
The country code is used to determine which connector to select. In this
example, the field reference &countryCode is used as key. This is a reference to
the Event field countryCode.
Script
The script is a Before Message script that uses &countryCode to determine
which connector to select, and sets the value of the alias variable $connector to
the name of the selected connector.
//Select the appropriate output connector

if(&countryCode = "SWE")
{
$connector = "spoolSWE";
}
if(&countryCode = "FIN")
{

3.3. Using aliases
$connector = "spoolFIN";
}
Setting the alias

The alias is set in the Connector Selection Method dialog box (Variable =
$connector).
How it works
1. The StreamServer application processes an invoice.
2. The field reference &countryCode in the current invoice equals SWE.
3. The Before Message script is run, and $connector is set to spoolSWE.
4. The connector alias is set to spoolSWE, and the invoice is sent to the connector
spoolSWE.
3.3.2 Lookup alias

A lookup alias consists of a key and a lookup table.
Key
The key is used to find the appropriate alternative in the lookup table. You must
use a variable ($variable) as key, for example $countryCode.
Lookup table
The lookup table is a resource that you add to the appropriate resource set. The
lookup table contains two columns:
• The first column contains the key value.

• The second column contains the alternative associated with the key value.
Setting a lookup alias

To set a lookup alias for a feature, you select the alias type Lookup and specify a
key variable and lookup table.

Lookup alias example

In this example, a lookup alias is used to select the appropriate output connector:
• spoolSWE – output connector used for invoices with country code SWE. This is
also the default connector alternative.
• spoolFIN – output connector used for invoices with country code FIN.
Key
The country code is used to determine which connector to select. In this
example, the variable $countryCode is used as key. This is a variable created for
the Event field countryCode.
Lookup table
The lookup table is called connectors.tbl. It contains two rows, where each
row consists of a key value (the value of $countryCode) and an alternative
associated with the key value:
SWE spoolSWE
FIN spoolFIN
Setting the alias

The alias is set in the Connector Selection Method dialog box (Key =
$countryCode and Table = connectors.tbl).
How it works
1. The StreamServer application processes an invoice.
2. The field variable $countryCode in the current invoice equals SWE.
3. The StreamServer application finds the key value SWE and the corresponding
connector alternative spoolSWE in the lookup table.
4. The connector selection alias is set to spoolSWE, and the invoice is sent to the
connector spoolSWE.

3.4. Using custom commands and keywords
3.4 Using custom commands and keywords

You can add custom commands and keywords in order to use StreamServer
functionality that cannot be configured via the standard Design Center GUI
properties. You can add custom commands and keywords to the following Platform
and Runtime configuration objects:
• Platform
• Connectors (Platform)
• Queues (Platform)
• Output connectors (Runtime configuration)
• Events and Processes (Runtime configuration)
Where to configure custom commands and keywords

You configure custom commands and keywords in the Edit Custom fields
dialog box (Edit> Custom Settings). You specify which access point (Platform,
connector, queue, etc.) to configure, and then you enter the custom commands
and keywords on the Custom sheet.
Figure 3-1: The Edit Custom fields dialog box.
Access points browser

The Access points browser contains all configurable objects (connector, Message,
etc.). Each object is divided into one node for the generic (Logical in the GUI)
layer, and one node for each physical layer (Development, Test, etc.). This means
you can create different commands and keywords for each layer.
To add custom commands and keywords
1. Select Edit > Custom Settings. The Edit custom fields dialog box opens.
2. In the Access points browser, browse to and select the node you want to
configure.
3. Enter your commands on the Custom sheet and click OK.

3.5 Scheduling
You can define schedules for different types of actions, for example, how frequently
to collect input, spool queues, etc. You can set a single time interval, or create more
complex schedules.
Figure 3-2: Example: Schedule that triggers an action once every second
Monday to Wednesday, and once every hour Thursday to Sunday.
To add an interval
1. Click New (Intervals area). A new item is added to the list.
2. In Define Interval, select a unit and enter the value.

3.6. Managing startup arguments
To set a time frame for a specific interval
1. Select the interval.
2. Click New (Apply selected interval area). A new item is added to the area.
3. Select a unit (Year, Month, etc.) for the item and enter a Start and, optionally, an
End value for the time frame.
To set a time frame for all intervals
You can set a time frame for when to apply all intervals in the list.
• In the Apply all intervals area, use Date and Time for Start and Stop to set the
frame for all intervals.
3.6 Managing startup arguments

Startup arguments are exported from Design Center to an argument file. The
argument file is read by the StreamServer at server startup, and used when running
the StreamServer application. In Design Center, you can specify arguments to add to
the argument file.
Standard arguments and administrator arguments

There are two categories of arguments:
• Standard arguments exported to the argument file start.arg. To change
these arguments, you must change the arguments in Design Center, export
and redeploy the Project, and restart the StreamServer application.
• Administrator arguments exported to the argument file sysadmin.arg. To
change these arguments, the administrator can edit sysadmin.arg and
restart the StreamServer application. Note that if you export and redeploy
the Project, sysadmin.arg is recreated with the arguments exported from
Design Center.
Physical Platform layer

The StreamServer application to which the Project is deployed has one working
directory per physical layer (you specify which layer to use when you deploy
the Project). This means you specify startup arguments for each physical layer.
Where the startup arguments are configured

The startup arguments are configured in the Configure Platform Export dialog
box. In this dialog box, there is one Arguments tab for standard arguments, and
one Administrator Arguments tab for administrator arguments.
To open the Configure Platform Export dialog box
1. Activate the appropriate physical layer.
2. Right-click the Platform view and select Configure Export. The Configure
Platform Export dialog box opens.

3. Select the Arguments tab or Administrator Arguments tab.
Argument lists
Each argument tab contains a list of available arguments, and each argument in
the list has a check-box attached.
All arguments that you check will be included in the argument file. Some
arguments, for example -langfile, have values that you must specify. To
specify these values, you must select the argument and specify the values.
Figure 3-3: Specifying the value for the -langfile argument.
Custom arguments
The StreamServer can use special arguments that are not included in the
argument lists. To add these arguments to the argument files, you must add
them as custom arguments:
1. In the Configure Platform Export dialog box, click Edit Custom. The
Custom Arguments dialog box opens.
2. Specify the arguments and click OK.
Reference
“Startup argument reference“ on page 329
3.7 About job execution phases

Job processing is divided into three phases: first the input phase, then the formatting
phase, and finally the output phase.
Input phase
The input phase starts when an input connector finds data, and ends when the
complete input job is stored in the input queue.
Formatting phase
The formatting phase starts when a job is picked from an input queue for
processing, and ends when the complete input job has been processed, and all
output jobs are successfully stored in the output queues. See “Formatting phase”
on page 69.
Output phase
The output phase starts when all output jobs are stored in the output queues,
and ends when all the output jobs are delivered.

3.7. About job execution phases
Formatting phase
During the formatting phase, all transformations and formatting is done. All scripts
are also run during this phase. The formatting phase starts when a job is picked from
an input queue for processing, and ends when the complete input job has been
processed, and all output jobs are successfully stored in the output queues.
The primary tasks during the formatting phase are as follows:

• Detect documents (Events) in the input job.
• Extract information from the documents and create Messages.
• Run Processes to create the desired output.
• Store this output in output queues.
Conditional formatting using scripts is also applied during this phase. The
formatting phase is separated into three phases:
• Collect phase
• Pre-process phase
• Process phase
Collect phase
In the collect phase, StreamServer analyzes the incoming data, detects
documents (Events), and creates the Messages. Sorting of incoming documents
is also done during the collect phase. When StreamServer analyses the incoming
data, and detects a document, the job begins internally in StreamServer.
StreamServer will now start to scan the input for fields and new documents. All
fields found are stored in a Message associated with the current Event. If a field
is configured to create a variable, this is done at this stage. If a new Event is
found, it will be added to a list of found Events, and any fields found after this
will be associated with the Message for the new Event. This procedure continues
until a list of all Events, with all fields, in the input job is created. The Messages
are stored in sequence in a temporary storage. As the last step in the collect
phase, the stored Messages can be sorted. Sorting is based on the values of the
script variables. To add more logic to sorting, a Retrieved script can be executed
after each Event has been collected. At this stage, the variables for the Event are
already created, and can be updated in the script, which in turn affects the result
of sorting.
Pre-process phase
The pre-process phase starts when the collect phase ends. During the pre-
process phase, all Events and Processes in the input job are executed without
producing any output data. For example, during the pre-process phase, the
number of pages are calculated, page breaks are located, overlays are added, etc.
The pre-processing order is as follows:
1. The first Event is pre-processed, followed by the Processes for this Event.
2. The next Event is pre-processed, followed by the Processes for this Event.

This continues until all Events are pre-processed.

StreamServer reads Messages stored in the temporary storage one Message at a
time. For each Message, the internal Message structure is recreated in memory,
and then all Processes and scripts related to that Event are executed. Each
Message, including the information gathered during the pre-process phase, is
again written to the temporary storage.
Process phase
The process phase starts when the pre-process phase ends. All information
needed to create the desired output is available during this phase. The Processes
and scripts are run as in the pre-process phase, but now the information
retrieved during the pre-process phase is used to create the output. Before the
process phase starts, all variables are rolled back to the values they had before
the pre-process step – this since all scripts in are run in the pre-process phase.
The same applies to all external data sources the scripts have updated. For
example, databases updated using ODBC script functions.
StreamServer reads Messages stored in the temporary storage one Message at a
time. For each Message, the internal Message structure is recreated in memory,
and then the Processes and scripts are executed. The output is sent from the
Processes, and stored in the output queues.
3.8 Listing fonts used in a Project

You can list all fonts used in the Project. The fonts are listed in the Font
Dependencies dialog box, and you can see in which Processes each font is used.
To open the Font Dependencies dialog box
• Select View> Font Dependencies.
Grouping fonts by Process and overlays

By default, the fonts are grouped by font name, and in each font group you can
see all Processes using the font. If you click the Dependencies column label, the
fonts are grouped by Process and overlay. In this case you will see all fonts used
in a specific Process.
Navigating to Processes and overlays

If you want to change a font in a Process, you can navigate to the Process from
the Font Dependencies dialog box:
1. Select the list item of the Process, and click Go to selected item. The Message
view opens with the Process highlighted.
2. Open and edit the Process.

The same procedure applies to overlays, where the resource set view opens with
the selected overlay resource highlighted.

Chapter 4
Message management
4.1 Managing Events

4.1.1 Adding and deleting Events
A Message configuration normally contains one Event, but if you need to
concatenate several Events in the same Message configuration you can do so (see
“Concatenating Events” on page 72). In most cases you add an Event to a Message
configuration by creating the Event from scratch, but you can also copy an existing
Event and paste it to the Message configuration.
To add an Event
1. Right-click the Message view, select Add Event, and select the Event type. A
new Event is added to the Message view.
2. Rename the Event.
3. Configure the Event (see “Configuring Events” on page 72).
To copy an Event
1. Right-click the Event you want to copy and select Copy.
2. Right-click the Message view and select Paste. The Event is pasted to the
Message.
3. Rename the Event.
4. Configure the Event (see “Configuring Events” on page 72).
To delete an Event
• Right-click the Event and select Delete.

Chapter 4 Message management
4.1.2 Configuring Events

After you add a new Event to a Message configuration, you must configure the
Event. Each Event type has its own Event tool. See the corresponding sections in
OpenText Communications Center Enterprise - Event tools Configuration Guide
(CCMEVT-CGD) for more information.
To open the Event tool
1. Double-click the Event. The Event tool opens.
2. Configure the Event and close the tool.
4.1.3 Ordering Events triggered by the same pattern

If several Events are triggered by the same pattern, they are run in the order (top
down) they are displayed in the Runtime configuration view. You can drag and
drop the Message configurations to change the order, and you can also specify
priorities for the Events to change the order.
To specify a priority for an Event
2. Right-click the Event and select Settings. The Runtime Event Settings dialog
box opens.
3. On the General tab, select a Priority (the higher the number, the lower the
priority).
4.1.4 Concatenating Events

If you have several Events of the same type that form a logical entity, you can
concatenate the Events in the same Message configuration.
PageIN example
If input data contains multi-page documents with different page layout, for
example one layout on the first page and another layout on following pages, you
can concatenate Events, i.e. create one PageIN Event for each page type in the
same Message configuration .
Figure 4-1: Input with three different page layouts (page 1, 2, and 3).

4.1. Managing Events
Figure 4-2: Message configuration with three concatenated PageIN Events.
The fields defined in the concatenated Events will be appended to the same
Message structure. When all fields are appended to the Message structure, it is
passed on to the Process(es) in the Message.
Patterns
You must use different patterns, or multiple patterns, to specify when to trigger
which Event.
Non-recurring fields
If non-recurring fields are defined in several Events, the StreamServer tries to
add the same field to the Message structure several times.
If all documents in the input contains all page types defined by the concatenated
Events, you should only define non-recurring fields once in all concatenated
Events, and not once per Event.
If there are documents in the input that do not contain all page types, you need
to define non-recurring fields in several Events. For example, if a non-recurring
field normally is defined in the first of the concatenated Events, and the input
document only contains the page type specified by the second Event, this field
must also be defined, with the same name, in the second Event.
Recurring fields and blocks

You can use recurring fields and blocks from all concatenated Events when you
configure the Process(es) in the Message configuration. Note though that all
fields and blocks must have unique names.
Block priority
If you use block priorities to group blocks, you must make sure blocks of the
same type have the same priorities in all concatenated Events.

To concatenate Events
1. Add the Events to the Message view and configure the Events.
2. Configure the Process(es).
3. Click the first Event and select Settings. The Event Settings dialog box opens.
4. On the Event Order tab, select the appropriate option (First, Repeating, or Last).
See “Ordering the concatenated Events”.
5. Repeat Step 3 and Step 4 for all other Events.
Overriding Event order settings using scripts

You can use the “EndMessage” scripting function in a Retrieved script to
override the Event order settings.
Ordering the concatenated Events

You must specify how to order the concatenated Events. The output from the Events
are appended to the same Message structure in the order specified on the Event
Order tab. The Message structure is then passed on to the Process(es).

4.1. Managing Events
Figure 4-3: Ordering three concatenated Events
First
Output from a First Event starts the Message structure.
If there are no more Events in the Message configuration, or if the following
Event in the Message configuration is also a First Event, the Message structure
only includes output from this Event.
Repeating
Output from a Repeating Event is appended to the Message structure.
• If there are no preceding Events in the Message configuration, this option is

the same as the First option.
• If there are no following Events in the Message configuration, this option is
the same as the Last option.
Last
Output from a Last Event is appended at the end of the Message structure.

If there are no preceding Events in the Message configuration, the Message

structure only includes output from this Event.
4.2 Managing Processes

4.2.1 Adding and deleting Processes
A Message configuration can contain one or more Processes. In most cases, you add
a Process to a Message configuration by creating the Process from scratch, but you
can also reuse existing Processes:
• Copy-paste – copy an existing Process and paste it to the Message configuration.
In this case you create a separate instance of the Process, and there is no link
between the original Process and the copy.
• Link in a Process – link an existing Process to the Message configuration. If you
modify the Process, it will be modified in all Message configurations using it.
To add a new Process
1. Right-click the Message view, select Add Process, and select the Process type. A
new Process is added to the Message view.
2. Rename the Process.
3. Configure the Process (see “Configuring Processes” on page 77).
To copy a Process
1. Right-click the Process you want to copy and select Copy.
2. Right-click the Message view and select Paste. The Process is pasted to the
Message.
3. Rename the Process.
4. Configure the Process (see “Configuring Processes” on page 77).
To link in an existing Process
• Right-click the Message view, select Add Process > Existing Process, and
browse to and select the Process. The Process is added to the Message view.
To delete a Process
• Right-click the Process and select Delete.

4.2. Managing Processes
4.2.2 Configuring Processes

After you add a new Process to a Message configuration, you must configure the
Process. Each Process type has its own Process tool. See the corresponding sections
in OpenText Communications Center Enterprise - Process Tools Configuration Guide
(CCMPTO-CGD) for more information.
To open the Process tool
1. Double-click the Process. The Process tool opens.

2. Configure the Process and close the tool.
4.2.3 Ordering Processes

Processes are run in the order (top down) they are displayed in the Runtime
configuration view. You can drag and drop the Processes within a Message
configuration to change the order.
4.2.4 Defining rules for triggering Processes

You can define rules (operators AND, OR, and NOT) for when to run a Process.
To define rules
1. Right-click the Process and select Settings. The Runtime Process settings dialog
box opens.
2. On the “Rule tab”, enter the rule.
Example 4-1: Use patterns in the Event to trigger the Process
Rule: idInvoice1 AND idInvoice2
Result: The Process is run only if the Event contains both patterns
idInvoice1 and idInvoice2.
Example 4-2: Use variables in the Process to trigger the Process
Rule: $page=3 OR $page=4
Result: The Process is run only if the variable $page equals 3 or 4.
Example 4-3: Use a connector name to trigger the Process
The before script $InConnector=InConnectorName(); is added to the

Event.
Rule: $InConnector=Input1

Result: The Process is run only if input comes from the connector Input1.
4.2.5 Enabling/disabling Processes

If you want to disable a Process in a Runtime configuration, you can do so. The
StreamServer application ignores all disabled Processes when running the Project.
You enable/disable Processes per physical layer.
To enable/disable a Process
2. Right-click the Process and select Enabled.
4.3 Connecting a Message configuration to a

runtime job
4.3.1 Adding and removing Message configurations
When you add a Message configuration to a Runtime configuration, you must add it
to the appropriate Runtime job. If you want to remove a Message configuration from
a Runtime configuration, you can do so. The Message configuration will be removed
from the Runtime configuration, but it will not be removed from the Project.
To add a Message configuration
1. Right-click the Runtime job and select Add Message. The Add Messages dialog
box opens.
2. Select the Message configuration and click OK.
To remove a Message configuration
• Right-click the Message configuration and select Remove Message.
4.3.2 Enabling/disabling Message configurations

If you want to disable a Message configuration in a Runtime configuration, you can
do so. The StreamServer application ignores all disabled Message configuration
when running the Project. You enable/disable Message configurations per physical
layer.
To enable/disable a Message configuration
2. Right-click the Message configuration and select Enabled.

4.3. Connecting a Message configuration to a runtime job
4.3.3 Linking input connectors to Events

When the Message configuration is added to the Runtime configuration, you must
link the Event to the appropriate input connectors. For example, if you have a
Message configuration that handles invoices, you must link the Event to the input
connector that retrieves the invoices from the source application.
One input connector, several Events

An input connector can be linked to several Events. For example, an input
connector can deliver page formatted input to a PageIN Event, and XML
structured input to an XMLIN Event.
Figure 4-4: One input connector linked to two Events.
One Event, several input connectors

An Event can be linked to several input connectors. For example, a StreamIN
Event can retrieve input from two separate directories via two separate
Directory input connectors.
Figure 4-5: Two input connectors linked to the same Event.
To link an input connector to an Event
• Draw a line between the connector and the Event (click-draw-release).
To unlink an input connector from an Event
• Right-click the link and select Delete Link.

If you cannot connect

Some input types, for example Agent on a StreamIN Event, cannot share the
connector with other Events.
4.3.4 Linking Processes to output connectors

When the Message configuration is added to the Runtime configuration, you must
link the Processes to the appropriate output connectors. For example, if you have a
Message configuration that handles invoices, you must link the Processes to the
output connectors that deliver the invoices to the target devices (printers, faxes, etc.).
Figure 4-6: Processes linked to output connectors.
Static and dynamic connections

When you link a Process to an output connector, you can either create a static
connection or a dynamic connection.
• If you create a static connection, the output is always delivered via the same
output connector. Note that you cannot create static links from a Process to
several connectors.
• If you create a dynamic connection, variables in the processed data
determine which output connector to use.
Figure 4-7: Dynamic connection to three output connectors.
To create a static link
• Draw a line between the connector and the Process (click-draw-release).

To disconnect a static link
• Right-click the link and select Delete Link.
To create a dynamic link
1. Right-click the Process and select Connector Selection.
2. In the Connector Selection Method dialog box, select the appropriate method,
specify the settings, and click OK.
To disconnect a dynamic link
1. Right-click the Process and select Connector Selection.
2. In the Connector Selection Method dialog box, select None and click OK.
Multi-channel delivery
You can connect a Process to several output connectors (without using the callproc
script function), and deliver the output from the Process via several channels at the
same time. To do this, you must create a before Process script that includes an array
variable for all connectors to use, and use a script alias to connect the Process to the
connectors.
To create the script
1. In the Message view, right-click the Process and select Script.
2. In the Script editor, create the array variable. For example:
$channel[0]="connector_1";
3. Click OK.
To connect the Process to the output connectors
1. In the Runtime configuration view, right-click the Process and select Connector
Selection.
2. In Connection type, select Variable.
3. In the Variable field, enter the array variable used in the script. For example:
$channel[*]
4. Click OK.
Multi-channel delivery example

In this example, the Process delivers the same output via three output connectors
(Out_1, Out_2 and Out_3).

Figure 4-8: One Process connected to three connectors
The script
The following script is added before Process:
$channel[0]="Out_1";

Figure 4-9: Before Process script
Connector selection
A script alias is used to select the three connectors. The selection variable is the
array variable $channel[*].

Figure 4-10: Connector selection using an array variable

Chapter 5
Input connector management
5.1 Creating and configuring input connectors

You can create a connector from scratch or copy-paste an existing, already
configured, connector.
Input queue
You can connect an input queue to the input connector. The input queue stores
input jobs before they are processed by StreamServer.
Connector type
You must specify a connector type for each connector, and configure the settings
for the selected connector type. You can use different connector types and
settings in the physical layers. This means you must specify and configure the
connector type for each physical layer.
To create and configure an input connector
1. Right-click the Platform view and select New Input Connector.
2. Rename the input connector.
3. Double-click the connector.
4. Optional Activate the generic layer, click the Queue icon and then select the
appropriate Queue.
5. Activate the first physical layer.
6. On the Connector Settings tab, select the appropriate Connector type and then
configure the settings. See “Connector reference“ on page 105.
7. Repeat the previous step for all physical layers.
To copy an existing input connector
1. Select a connector and copy-paste using standard procedures.
2. Rename the input connector.

Chapter 5 Input connector management
5.2 Setting the job priority for the input connector

If you have several connectors in your StreamServer application, you can assign a
priority to each connector that determines the order in which the application
processes jobs processed by the connector. There are five different priority levels:
highest, high, normal, low, and lowest.
To use the priorities, each connector must be connected to a queue with sorting
enabled. The queue can be a shared queue or a separate queue.
Example 5-1: Prioritizing the jobs received by two connectors
An application has two input connectors that share an input queue with
sorting enabled. Connector A has normal priority and Connector B has high
priority.
Connector A receives the first job (job 1). Connector B receives the second
and third jobs (job 2 and job 3).
In this scenario, the application will retrieve Job 2 first, then job 3, and finally
job 1.
To enable sorting for the queue and set the job priority of the connector
2. Right-click the connector and select Settings.
3. On the Queue tab, click Manage Queues....
4. In the Queue area, click the queue to configure, and then click the Advanced
tab.
5. Select the Sorted queue check box and then click OK.
6. On the Queue tab, in the Priority list, click the appropriate priority.

5.3. Sorting input connectors
5.3 Sorting input connectors

Sorting connectors in the Platform view
You can sort the input connectors in the Platform view using drag and drop, or sort
them in alphabetical order (ascending or descending).
To sort connectors in ascending/descending order
• Right-click a connector and select Sort Connectors Ascending or Sort

Connectors Descending.
To move a connector
• Drag the connector to the desired position.
Sorting connectors in the Runtime configuration view

The connectors in a Runtime configuration view are by default displayed in the
same order as they are added to the Platform view. If you want to, you can organize
the connectors as you like in each Runtime configuration view.
You can sort the connectors using drag and drop, sort them in alphabetical order
(ascending or descending), or sort them in the same order as they are organized in
the Platform view.


To sort connectors as they are displayed in the Platform view
• Right-click a connector and select Sort Connectors As In Platform.
To move a connector
5.4 Input Analyzer

An input connector can be used for different input types, and deliver data to several
Events. For example, the same input connector can receive XML structured, page
formatted, and record based input, and deliver data to an XMLIN Event, a PageIN
Event, and a StreamIN Event.
The Input Analyzer is the component responsible for delivering data to the
appropriate Event type. For example, if an input connector is connected to an
XMLIN Event and a PageIN Event, the Input Analyzer ensures that XML structured
input is delivered to the XMLIN Event, and that page formatted input is delivered to
the PageIN Event.

5.4. Input Analyzer
Figure 5-1: The Input Analyzer directs XML structured input to an XMLIN
Event.
How the Input Analyzer works

Each input connector is associated with a list of input types. This list includes all
input types handled by the input connector, and is used by the Input Analyzer
to find a matching Event for the input data.
The following steps describe how the Input Analyzer finds a matching Event:
1. An input job is received by an input connector.
2. The Input Analyzer checks the input type list associated with the input
connector.
3. The Input Analyzer starts with the first input type in the list, and sends the
data to the corresponding Event.
4. The Event tries to identify the input data to see if it is the right input type.
• If it is the right input type, the Input Analyzer is notified, and the Event
starts processing the data.
• If it is not the right input type, the Input Analyzer is notified and
continues with the next input type in the list.
5. The Input Analyzer continues through the input type list until it finds a
matching Event.
How the input type list is defined

You define the input type list when you link the input connector to Events in the
Runtime configuration. Each time you link the connector to a new Event, the list
is updated with the corresponding input type. For example, if a connector is
linked to a StreamIN Event (input type RecordIN) and an XMLIN Event, the
input type list includes the input types RecordIN and XMLIN. If you link this
connector to a PageIN Event, the input type list is updated with the input type
PageIN.
Input types supported by the Input Analyzer

The following input types are supported by the Input Analyzer:

• FieldIN (StreamIN)
• RecordIN (StreamIN)
• MessageIN
• XMLIN
• PageIN
Input types not supported by the Input Analyzer

The following input types are not supported by the Input Analyzer:
• PreformatIN
• Agent (StreamIN)
• Movex (StreamIN)
• StrsXML (StreamIN)
• XML (StreamIN)
This means that if you link an Event using any of these input types, you cannot
link any other type of Event to the same input connector.
Configuring the Input Analyzer

The Input Analyzer enables input connectors to receive any type of input. When the
connector receives input, the Input Analyzer checks if the input matches any of the
input types listed for the connector. It starts with the first input type in the list, and
continues until it finds a match.
Where to configure Input Analyzer settings

You configure the Input Analyzer settings in the Project Export Settings dialog
box (Edit> Project Export Settings). When you select an input connector in the
Available connectors list, the input type list is displayed in the Input Analyzer
configuration list.
Figure 5-2: Input type list.

5.4. Input Analyzer
Input types grouped into categories

The input types are grouped into the following categories:
• StreamIN (FieldIN, RecordIN, and Input Analyzer enabled Agents).
• XML (PreformatIN, MessageIN, StrsXML, and XMLIN).
• PageIN.
Figure 5-3: Input type categories.
How the categories are ordered

By default, the StreamIN category is the first category in the list, followed by the
XML category. You can use the option Handle XML-based input before
StreamIN to change the order of these categories.
Figure 5-4: StreamIN handled before XML – option not selected.

Figure 5-5: XML handled before StreamIN – option selected.
The PageIN category is always last – you cannot change this.
How the input types are ordered within each category

You can order the input types as you like within each category. The only
restriction is that if the input type list includes XMLIN, then XMLIN must be
the last item in the XML category. You can change the order within a category
by moving an input type up or down using the Move arrows.

Chapter 6
Output connector management
6.1 Creating and configuring output connectors

You can create a connector from scratch, or copy-paste an existing, already
configured, connector.
Output connector categories

You can select different connector types in each physical layer, but the connector
types must belong to the same category. The output connectors are divided into
the following categories:
• MailOUT-dependent – connectors to use with a MailOUT Process.
• Fax Connect – Fax Connect connector only.
• Document Broker Plus – Document Broker Plus connector only.
• Attachment – Attachment connector only.
• Generic – All other types of connectors.
Device driver
If the output connector delivers page formatted output to the target application,
you must add the appropriate device driver to the output connector. For
example, if the target application is a PCL printer, you must add the appropriate
PCL device driver to the output connector.
Output queue
You can connect an output queue to the output connector. The output queue
stores the output jobs before they are delivered to the target application.
Output mode
You must specify the appropriate output mode. See “Output modes”
on page 98 for more information about output mode.
Connector type
You must specify a connector type for each connector, and configure the settings
for the selected connector type. You can use different connector types (of the
same category) and settings in the physical layers. This means you must specify
and configure the connector type for each physical layer.
To create and configure an output connector
1. Right-click the Platform view and select New Output Connector > <category>.
2. Rename the output connector.
3. Double-click the connector and then activate the generic layer.

Chapter 6 Output connector management
4. Optional Click the Driver icon, select a Device and edit the settings.
5. Optional Click the Queue icon and select the appropriate Queue.
6. Click the Output mode icon and specify the output mode.
7. Activate the first physical layer.
8. On the Connector Settings tab, select the appropriate Connector type and
configure the settings. See “Connector reference“ on page 105.
9. Repeat the previous step for all physical layers.
To copy a connector
1. Select a connector and copy-paste using standard procedures.
2. Rename the connector.
Configuring device driver runtime settings

In the Platform, you specify which driver type to add to the output connector, and
the default settings for the selected driver type. In the Runtime configuration, you
can override the default driver settings and specify Job Begin and Document Begin
specific driver settings. Where to configure driver settings (Process Begin, Document
Begin, or Job Begin) depends on the driver type.
To configure device driver settings
2. Double-click the output connector.
3. Select context and click OK.
4. Click the Process Begin or Document Begin or Job Begin icon.
5. On the Device Driver Settings tab, edit the device driver options.
Configuring physical runtime output connector settings

In the Platform, you specify which connector type to use, and the default settings for
the selected connector type. In the Runtime configuration, you can override the
default connector settings in each physical layer.
You configure the connector settings at either Process Begin, Document End, or Job
End. The option to use depends on the output mode specified for the connector.
To configure the output connector settings
1. Activate the appropriate physical layer and double-click the output connector.
2. Select context and click OK.

6.2. Setting the job priority for the output connector
3. On the connector type tab, edit the connector settings.
6.2 Setting the job priority for the output connector

If you have several connectors in your StreamServer application, you can assign a
priority to each connector that determines the order in which the application
delivers jobs received by the connector. There are five different priority levels:
highest, high, normal, low, and lowest.
To use the priorities, each connector must be connected to a queue with sorting
enabled. The queue can be a shared queue or a separate queue.
Example 6-1: Prioritizing the jobs received by two connectors
An application has two output connectors that share an output queue with
sorting enabled. Connector A has normal priority and Connector B has high
priority.
Connector A receives the first job (job 1). Connector B receives the second
and third jobs (job 2 and job 3).
In this scenario, the application will deliver Job 2 first, then job 3, and finally
job 1.
To enable sorting for the queue and set the job priority of the connector
2. Right-click the connector and select Settings.
3. On the Queue tab, click Manage Queues....
4. In the Queue area, click the queue to configure, and then click the Advanced
tab.
5. Select the Sorted queue check box and then click OK.

6. On the Queue tab, in the Priority list, click the appropriate priority.
6.3 Sorting output connectors

Sorting connectors in the Platform view
You can sort the output connectors in the Platform view using drag and drop, or sort
them in alphabetical order (ascending or descending).

To move a connector
Sorting connectors in the Runtime configuration view

The connectors in a Runtime configuration view are by default displayed in the
same order as they are added to the Platform view. If you want to, you can organize
the connectors as you like in each Runtime configuration view.
You can sort the connectors using drag and drop, sort them in alphabetical order
(ascending or descending), or sort them in the same order as they are organized in
the Platform view.

6.4. Copying/pasting generic output connector runtime settings

To sort connectors as they are displayed in the Platform view
• Right-click a connector and select Sort Connectors As In Platform.
To move a connector
6.4 Copying/pasting generic output connector

runtime settings
You can copy the generic output connector settings from one output connector
(source connector), and paste them to another output connector (target connector).
For example, if you create a new output connector with complex runtime settings
(AFP driver, OMR codes, enveloping, etc.), and already have another output
connector with similar settings, you can copy the settings from the existing
connector, and paste them to the new connector.
To copy/paste output connector settings
2. Right-click the source connector, and select Copy Connector Settings.

3. Right-click the target connector, and select Paste Connector Settings.
6.5 Enabling/disabling output connectors

If you want to disable an output connector in a Runtime configuration, you can do
so. The StreamServer application ignores all disabled connectors when running the
Project. You enable/disable output connectors per physical layer.
To enable/disable an output connector
2. Right-click the output connector and select Enabled.
6.6 Output modes

The output mode specifies how to group documents before they are delivered via
the output connector to the target application. There are three different output
modes:
• Process - see “Output mode Process” on page 98.

• Document - see “Output mode Document” on page 99.
• Job - see “Output mode Job” on page 101.
Which output mode to use depends on the type of output and target application.
The default output mode Process can be used in different types of scenarios. In other
scenarios you may have to use output mode Document or Job.
6.6.1 Output mode Process

In output mode Process, the output connector delivers the output as it arrives from a
Process. This means each output document is delivered separately.
Process mode scenario

In this scenario, you have a Runtime job that contains one Process that delivers
invoices to a printer via a Spool output connector. If you select output mode
Process, the output connector delivers each invoice separately.
Figure 6-1: Output mode Process.

6.6. Output modes
6.6.2 Output mode Document

What is a Document?
A Document is an output job sent via an output connector to the target
application. It includes output from Processes in the same Runtime job, and the
scope of the Document is specified using a “Document trigger”. The Document
enables you to group documents per customer number, delivery address, etc.
before delivering the output to the target application.
What is output mode Document?

In output mode Document, the output is delivered as Documents. This means
the output connector waits until the Document is complete before it delivers the
output. Use this mode if you want to group documents per customer number,
delivery address, etc.
Document mode scenario

In this scenario, you have a Runtime job with two Processes that create
hardware invoices and software invoices:
• procHardware
• procSoftware
Both Processes deliver output via the same fax output connector. If you select
output mode Document, the hardware and software invoice are grouped per
customer before they are faxed. This means each customer will receive one fax.
Figure 6-2: Output mode Document – one fax per customer.
Same scenario using output mode Process

If you select output mode Process instead of Document, each invoice is faxed
separately. This means each customer will receive two faxes.

Figure 6-3: Output mode Process – two faxes per customer.
Document trigger
A Document trigger is a variable that determines the scope of the Document. For
example, if you assign the variable $customerNumber to the Event field
customerNumber, you can use $customerNumber as Document trigger. In this case,
all documents with the same customer number in the input job are included in the
same Document.
Beginning and end of a Document

The Document trigger determines the beginning and end of a Document. The
current Document ends, and a new Document begins, when the Document
trigger variable changes.
Sorting the input

Since a Document ends when the Document trigger changes, the input must
come in the right sequence. For example, if customer number is used as
Document trigger, all documents with the same customer number must be
handled in sequence. This means you may have to sort the input before the
Documents are created. See “Sorting“ on page 255.
Output from several Runtime jobs

If the output connector handles output from several Runtime jobs, you must
specify a Document trigger for each Runtime job. This means a connector can
have several Document triggers – one trigger per Runtime job. Note though that
you can use the same trigger variable (customer number, customer name, etc.)
for all Runtime jobs.

6.7. Using Document triggers
6.6.3 Output mode Job

In output mode Job, the output connector waits until the whole Runtime job is
finished before it delivers the output. Use this mode if you want to create one group
for the output from all Processes in a Runtime job.
Job scenario
In this scenario, you have a Runtime job that contains one Process that prints
invoices to an AFP file via a File output connector. The AFP file is used for
production printing, and all invoices in the Runtime job should be printed to the
same AFP file. To achieve this, you must select output mode Job.
Figure 6-4: Output mode Job.
6.7 Using Document triggers

In output mode Document, the output connector waits until the output documents
are grouped per customer number, delivery address, etc. See “Output mode
Document” on page 99 for more information about output mode Document. To
enable output mode Document, you must:
• Select output mode Document in the generic Platform layer for the connector.
• Define the document, i.e. the document trigger, for the Runtime job and output
connector.
To create a Document trigger
1. In the Runtime configuration view, activate the generic layer and then double-
click the connector.
2. Double-click the job for which you want to define the Document.
3. Click the Document Trigger icon and enter the Document trigger variable.

6.8 Adding exception rules to the output connector

You must add an exception rule to the output connector if you want to use
Supervisor to review the output jobs before releasing them.
Exception rules use the Communications Center script syntax to set up conditions
that specify when to pause a job in the output connector. The conditions are
evaluated as either true or false, and can be based on variables or on property values
retrieved with the metadata script functions (see section 19 “Metadata functions” in
OpenText Communications Center Enterprise - Scripting Reference Guide (CCMPRJ-
RSC)).
Configuring exception rules

You configure exception rules in the resource set (resource type Rule) before adding
the rules to the output connector. If you add several exception rules to the output
connector, the rules are evaluated, one by one, until one rule is fulfilled or all rules
are evaluated.
Example 6-2: Rule pausing jobs based on the order value
In this example, an exception rule pauses the jobs with a total order value
greater than 5000 dollars. The jobs that are paused can then be released in
Supervisor. Jobs with a total order value less than 5000 dollars are delivered
without being paused.
In the resource set, a new rule resource called Pause Large Orders is
created.
In the Rule Editor, the rule function below is created.
getMetadataMessage("5fb1c989-ae0b-4c98-8a15-c592af6db25c",
$totalOrderValue);
If (num($totalOrderValue) > 5000) {
return "true";
else { return "false";
Tip: If you update a rule function in an already deployed Project, the updated
function is used the next time the exception rule is evaluated.
Adding rules to the output connector

1. In Design Center, open the Output Connector Settings dialog box.

6.8. Adding exception rules to the output connector
2. Select the General tab.

3. In the Rule field, browse to the rule or rules in the resource set you want to use
on the output connector.
4. Click OK.

Chapter 7
Connector reference
7.1 Command output connector

The Command output connector enables you to use commands to specify the output
destination. The connector settings are described below.
• Command
The command to execute. You can use a one-line command, or enter the path to a
batch file or a script.
When passing output to an external application, use %1 in the command string to
specify the temporary path to the file containing the output data.
Example 7-1: One-line command example

Physical "<[cmd=cat %1 > kv.$destination]>"
Example 7-2: Path example

C:\project\myname.bat
• Timeout
The time (seconds) to wait for a result. Timeout = 0 means wait forever.
Specifying an exit code for successful jobs

You can use the custom keyword CmdValidExitCode <num> to set the exit code
for successful jobs. The number <num> is interpreted as the exit code for a
successful job, and all other exit codes are interpreted as failure. You can add
CmdValidExitCode <num> to either the logical or physical Platform layer of the
Command connector in the Edit Custom fields dialog box in Design Center. See
“Using custom commands and keywords” on page 65 for more information
about how to add custom commands and keywords.

Chapter 7 Connector reference
7.2 Custom Java connectors

To create custom java connectors you must first pack the java class, libraries and
configuration files into one single jar file (standard zip format), and import the jar
file to a Java resource in a resource set. When you configure the custom java
connector in Design Center, the Java resource is available as a Java class property in
the Java connector settings dialog box. The Java resource is also included in the
Design Center export, and used by StreamServer when running the deployed
Project.
Creating a Java resource

When you create a Java resource you must first add all java class files, libraries and
configuration files to a zip archive, and then import the zip archive to a resource set.
The zip archive must include the appropriate *.i, *.o and *.or files at root level:
<java_class_name>.i
Definition of input connector settings.
<java_class_name>.o
Definition of output connector platform settings.
<java_class_name>.or
Definition of output connector runtime settings.
The zip archive must also include a lib folder with all required *.jar and *.class
files.
To create a Java resource
1. Add all files to a zip archive.

2. Rename the zip archive to <name>.jar
3. Right-click the appropriate node in the resource set and select Import. A file
browser opens.
4. Browse to and open the jar file. The Resource Type Settings dialog box opens.
5. Keep the default resource type (Java) and click OK.
Creating a custom Java connector

When you have the Java resource for the custom Java connector in place, you can
create your custom Java connector.
To create a custom Java input connector
1. Create an input connector and select Connector type > Java.

2. In the Java class field, click ... and select your java class.
3. Configure the settings and click OK.

7.3. Device input connector
To create a custom Java output connector
1. Create a Generic output connector and select Connector type > Java.
2. In the Java class field, click ... and select your java class.
3. Configure the settings and click OK.
7.3 Device input connector

This connector scans a UNIX FIFO (First-In-First-Out queue) for incoming jobs. The
connector settings are described below.
• Device path
The file path to the FIFO. For example:
./fifos/My_Fifo
• Schedule
Opens the Scheduler Configuration dialog where you specify when and how
often to scan the FIFO. See “Scheduling” on page 66for more information about
scheduling.
• Time-out
Specifies a time-out (seconds) for the connector. StreamServer uses job-end
sequences in the input data to determine when all data in an input job is
received. If there are no job-end sequences in the input data, StreamServer will
not know when to stop waiting for more input. To prevent this from happening,
you can define a time-out for the input connector.
7.4 Directory input connector

This connector retrieves files from a named directory. The source application sends
files to this directory, and StreamServer retrieves the files.
Comments
Several connectors can scan the same directory for input. The connectors can
belong to different StreamServer instances running on the same machine or on
different machines. The Directory connector that first finds a match moves the
file to a temporary directory. The reason is to prevent the file from being
processed more than once. After the file is moved it is opened and processed.
A temporary directory streamserve_proc is automatically created under the
scanned directory. The default behavior is to move the files to this directory. If
StreamServer scans a directory located on a remote machine, it is safer to move
the files to the tmp directory of the StreamServer application (normally export/
tmp). The reason is that if the network goes down, StreamServer may also go
down if the file is not stored locally.

Connector settings
• Folder
The folder to scan for input. Use an absolute path, or a path relative to the
working directory of the StreamServer application. Two sub directories
(streamserve_lock and streamserve_proc) are created when you run the
Project. These directories ensure that a file is processed only once. These
directories should not be tampered with.
• File name pattern
The match criterion for the files to retrieve. For example, to match all *.txt files
you can use the following pattern:
*.txt
• Interval for file size check
This interval specifies how frequently to check the file size. The file is not moved
to the temporary directory immediately after it is found. First the file size is
checked, and the file is moved only if the file size remains the same after this
time interval. If the file size has changed, the connector waits for yet another
interval to pass before it tries to move the file. This prevents the connector from
moving the file before it is completed.
• Sort by
StreamServer generates a list of all the files found in the scanned directory, and
uses this list to find files that match File name pattern above. You can sort this
list by:
• Name
• Date and time
• File extension
• File size
The files are by default sorted in descending order.

• Sort ascending
Select to change the order in the sort list to ascending.
• Save path
When a file is retrieved by StreamServer it is removed from the scanned
directory. If you want to save copies of the retrieved files you must specify a Save
path. Use an absolute path, or a path relative to the working directory of the
StreamServer application.
• Create Folder
If the input folder (path specified in Folder above) does not already exist, it is
created by StreamServer if Create Folder is enabled.
• Delete scanned files

7.5. EasyLink connectors
If enabled, files are deleted from the scanned folder after they are retrieved by
StreamServer. This ensures that an input file is not processed more than once.
If disabled, StreamServer will retrieve the files over and over again, using the
polling interval specified (see Schedule below). This can be used, for example, to
scan a database for changes once per polling interval.
• Use spool directory as temporary storage
Select to use streamserve_proc as the temporary directory for the retrieved
files. If the scanned directory is located on a remote machine, it is safer to use the
tmp directory of the StreamServer application (normally export/tmp). In this
case you should not select this option.
• Synchronize scanning
Select to enable synchronized scanning for the connector. The connector runs
single-threaded and retrieves files one by one from the input folder.
If you do not select this option, the connector scans the input folder
asynchronously. The connector runs multi-threaded and retrieves several files in
parallel.
• Schedule
often to scan the directory. See “Scheduling” on page 66 for more information
about scheduling.
7.5 EasyLink connectors

The EasyLink connectors let you send output via the OpenText EasyLink cloud-
based fax and notification services. By using these connectors, you can send output
via the following channels:
• Fax
• Text message (SMS)
• Email
EasyLink account details

To set up an EasyLink connector you need your EasyLink account details, such
as, your user name, password, and billing code.
Java Runtime Environment requirements

We recommend you use Java Runtime Environment version 1.8 with the
EasyLink connectors.
Tracking the status of EasyLink jobs

EasyLink provides a reporting service which Communications Center
applications can use to track the status of jobs sent to EasyLink and create status
reports for EasyLink jobs. For more information, see “EasyLink job status
reporting” on page 124

Steps to set up the EasyLink connectors
1. In Design Center, create a connection profile for EasyLink. See “Creating a

connection profile for EasyLink” on page 112.
2. In Design Center, add and configure the appropriate connector:
• “EasyLink Email output connector” on page 115

• “EasyLink Fax output connector” on page 121
• “EasyLink SMS output connector” on page 122
3. Export and deploy your Project.

4. In Control Center, right-click the StreamServer application, click Java
Configuration and on the Value list, click your Java vendor.
5. Optionally, set up status reporting for EasyLink jobs. See “EasyLink job status
reporting” on page 124.
7.5.1 Batch sending of messages

In scenarios where a single Communications Center input job generates multiple
emails, SMS, or faxes for EasyLink, the EasyLink output connector can group the
output and send it in batches to EasyLink.
Performance considerations
Sending emails, SMS, or faxes to EasyLink in batches typically improves the
performance of the EasyLink delivery services. Batches of 10 are recommended
in most cases, however you should consider the average size of each fax, email,
or SMS. Sending too many emails, SMS, or faxes in one batch will mostly likely
have negative impact on performance. For example, sending one batch that
contains 20 emails that are 5 MB each may cause a network time-out or mean
additional overhead for EasyLink to process the batch.
Examples - Sending output for EasyLink in batches

These examples show how invoices are grouped into batches based on the batch
setting in the EasyLink output connector.
In all three examples, the input file contains twenty-five invoices.
Example 7-3: Using a batch setting of 1
In this scenario, each invoice is sent individually to EasyLink.

Example 7-4: Using a batch setting of 0
When a batch setting of 0 is used, all the invoices are sent in one batch to
EasyLink. Use this option with care.
Batch settings
You specify the number of emails, SMS, or faxes sent in each batch when you set up
the connector (Batch size box in the Platform Connector Settings). For descriptions of
the connector settings, see the following sections:
• “EasyLink Email output connector” on page 115
• “EasyLink Fax output connector” on page 121
• “EasyLink SMS output connector” on page 122

7.5.2 Creating a connection profile for EasyLink

You can use the same connection profile to send SMS, Email, and Fax output to
EasyLink.
StreamServer applications use HTTPS communication with EasyLink.
Steps to set up HTTPS communication
Follow the steps in these sections to set up HTTPS communication:
1. “Obtaining and adding a certificate to the resource set” on page 112

2. “Setting up a web service connection profile for EasyLink” on page 114
7.5.2.1 Obtaining and adding a certificate to the resource set

You can help secure the communication with EasyLink by using SSL version 3 or
TLS version 1.
The following steps are required:
1. Obtain a public key certificate from EasyLink. See “Getting a certificate from
EasyLink” on page 112.
2. Add the certificate to a Java KeyStore. See “Importing the certificate to a Java
KeyStore” on page 113.
3. In the resource set in Design Center, import the KeyStore file and set up a
certificate store profile resource for the certificate. See “Importing the KeyStore
file and creating a Certificate store profile resource” on page 113.
4. In the resource set, set up a secure channel profile resource. See “Creating a
Secure channel profile resource” on page 113.
Getting a certificate from EasyLink

For information about EasyLink certificates, see the EasyLink documentation on the
EasyLink API forums at https://apiforums.easylink.com/.
The procedures for downloading certificates differ for each web browser. For
information, see the documentation for your Web Browser.
Example on how to download a certificate from EasyLink
This section describes one method of using Internet Explorer 9.0.13 to export a
certificate from EasyLink.
1. Browse to https://messaging.easylink.com/
2. In the right side of the Address bar, click Security Report (lock) icon.
3. In the Website Identification page, click View certificates.
4. Click the Details tab and then click Copy to File…

5. Follow the wizard to export the certificate:
1. Select DER encoding.

2. Enter a name and location where you want to save the file.
3. Click Finish to export the certificate.
Importing the certificate to a Java KeyStore

Before you can import the certificate to the resource set in Design Center, you must
import the certificate to a Java KeyStore on the computer where you run Design
Center. To do this you need the keytool.exe file, which is part of the Java Runtime
Environment.
To import the EasyLink certificate to a Java KeyStore
1. Add the path to keytool.exe to the Path system environment variable.
2. At the command prompt, move to the directory containing the EasyLink

certificate file.
3. Enter the command: keytool -importcert -file easylink.cer -keystore

easylink.jks -alias easylink
4. At the Enter keystore password: prompt, enter a password to protect your

keystore.
5. At the Trust this certificate? prompt, enter yes

The certificate is added to the KeyStore.
Importing the KeyStore file and creating a Certificate store profile

resource
1. In Design Center, in the resource set, import the EasyLink KeyStore file as a
Certificate type resource.
2. In the resource set, add a new Certificate store profile resource.
3. Open the Certificate store profile resource.
4. Click Add and then browse to and select the EasyLink certificate resource.
5. In the Trusted authorities certificates list, double-click the certificate.
6. Enter the certificate password and click OK.
Creating a Secure channel profile resource

1. In the resource set, add a new Secure channel profile resource.
2. Open the secure channel profile resource.
3. On the Channel type list, click SSL (version 3) or TSL (version 1).

4. On the Certificate store profile list, click the certificate store profile you created
in the previous step.
Next step
• Create an EasyLink web service profile that uses HTTPS communication. See
“Setting up a web service connection profile for EasyLink” on page 114.
7.5.2.2 Setting up a web service connection profile for EasyLink

Prerequisites
You need your EasyLink user name and password to set up the connection
profile.
To set up a web service connection profile
1. In the resource set, add a new Web service profile resource.
2. Open the web service profile resource and enter a name.
3. On the Profile sub-type list, click EasyLink.
4. Enter the URL for EasyLink.
5. Specify the recovery actions.
6. On the Authentication profile list, click <Create new...>, and enter your
EasyLink user name and password.
7. On the Secure channel profile list, click the secure channel profile you set up
previously. For information about setting this up, see “Obtaining and adding a
certificate to the resource set” on page 112
8. Optionally, enter the EasyLink proxy host and port.
EasyLink Web service profile property descriptions

• Name - The name of the connection profile cannot include underscore characters
(“_”) and must be unique in the domain where the Communications Center
application will run.
• Profile sub-type - EasyLink
• URL - The URL to EasyLink. For example: https://messaging.easylink.com/
soap/synch
• Attempt recovery - Specifies whether Communications Center software should
try to reconnect to EasyLink if it does not respond. Available options are Never,
Limited times and Forever.
• Number of Retries - The number of times Communications Center software
should try to reconnect if the computer does not respond. (Applicable if Attempt
recovery = Limited times)

• Retry Interval - The interval (seconds) between retries. (Applicable if Attempt

recovery = Limited times or Forever)
• Authentication profile - Select the authentication profile to use.
• Secure channel profile - Select the secure channel profile to use. For information
about setting up a secure channel profile, see “Creating a Secure channel profile
resource” on page 113.
• Proxy host - The host name or IP address of the proxy host. (Optional)
• Proxy port - The proxy port number. (Optional)
• Connect timeout - The connection timeout for the web service.
• Request time-out - The time the Communications Center application waits for a
response from the web service.
7.5.3 EasyLink Email output connector

You can use the EasyLink Fax output connector to send HTML or text-based output
via the EasyLink cloud delivery services.
Note: You cannot add watermarks to emails sent via the EasyLink email
output connector.
UTF-8 code page

The EasyLink connectors support the UTF-8 code page.
Attachments
You can use the Attachment output connector together with the EasyLink
output connector to add attachments to emails. See “Adding attachments to
emails” on page 119.
Inline images sent as attachments

You cannot add attachments with a MIME content type that is multipart/related
in emails sent via EasyLink, which prevents you from adding HTML inline
images in the email body. Instead inline images are automatically added as
attachments to emails.
If you use StoryTeller, you can use linked images in the emails. For more
information about adding linked images, see the StoryTeller documentation.
Platform connector settings

• Web Service Profile
Click and select the web service profile. For information about setting up a
web service profile, see “Creating a connection profile for EasyLink” on page 112.
• Email Type
• Point To Point - Select to send emails point-to-point. With this option you
specify email addresses to each recipient.

• Broadcast - Select to broadcast messages. With this option you use a

destination table to specify email addresses and personalized information to
the recipients. See “Broadcasting messages” on page 117 for more
information.
• Document Format
• Auto - The StreamServer application determines whether the document

format is text or HTML based on the driver.
• Text - For sending text-based output.
• HTML - For sending HTML-based output.
• External Job Completion
• True - StreamServer applications wait for a job completion notification from

EasyLink before marking the top job as completed.
• False - StreamServer applications mark the job as completed after the
Communications Center job is successfully delivered from the output
connector.
• Batch size
The number of emails the connector groups into a batch to send to EasyLink. The
connector only sends batches in scenarios where a single input job generates
many emails. If an input job generates an incomplete batch, the batch is sent at
job end.
Setting this to 0 means that the batch size is unlimited and the connector groups
all the messages in an input job into one batch. Unlimited batch sizes should be
used with care.
For more information about how messages are grouped into batches and
performance considerations, see “Batch sending of messages” on page 110.
Settings available in the Platform and runtime

• To
Only applicable to Point To Point.
The email address of the recipient. You can use a variable in the runtime
connector settings. You can specify multiple addresses by separating them with a
semicolon.
For example: jsmith@streamserve.com; rbrown@streamserve.com
• Destinations
Only applicable to Broadcast
Destinations table containing email addresses and personalized information to
the recipients. You can use a variable in the runtime connector settings. See
“Broadcasting messages” on page 117 for more information.
• From

The name displayed in the From field of the emails. You can use a variable in the
runtime connector settings.
• Subject
The email subject. You can use a variable in the runtime connector settings.
• Customer Reference
Your customer reference with EasyLink. You can use a variable in the runtime
connector settings.
• Billing Code
The EasyLink billing code. You can use a variable in the runtime connector
settings.
7.5.3.1 Broadcasting messages

When running the EasyLink Email connector in Point To Point mode (Email Type >
Point To Point), StreamServer can send multiple point-to-point emails. To send for
example an email to ten different recipients, StreamServer has to create ten output
jobs (personalized to each recipient), and the EasyLink service has to deliver ten
individual emails, just as received from StreamServer. In Point To Point mode there
is also an option to use a comma separated recipient list, where the same email can
be sent to multiple recipients, but no personalization of the email content is possible.
When running the EasyLink Email connector in Broadcast mode (Email Type >
Broadcast), StreamServer can broadcast the same email content to multiple
recipients specified in a destinations table. The destinations table can contain
personalized information, and this information can be included in the emails in
order to do simple personalization of the email content (variable replacement) on
Easylink side. In Broadcast mode, only one email is sent to the EasyLink service, and
this email is broadcast to all recipients specified in the destinations table.
Destinations table
The destinations table contains one row for each recipient, and each row
contains a number of tab separated information items. The destinations table can
be a fixed table resource that you reference as Destinations value in the
connector settings, and it can also be generated dynamically by scripts at
runtime. When using a dynamic destinations table you must use a variable as
Destinations value in the runtime connector settings.
The items in a row must come in the following order:
1. The reference number of the recipient, for example 0003.
2. The email address.
3. Any other items used for personalization.
Example 7-5: Destinations table

//!CodePage UTF8!
001 joeboe@example.com "Joe Boe" "Kingston" "Jamaica"
002 belair@abc.com "Bella Air" "Jokkmokk" "Sweden"
003 svravd@def.com "Svante Raavdalen" "Oslo" "Norway"

Output to the EasyLink service

The output to the EasyLink service is a SOAP envelope. The SOAP envelope
contains, among other things, the following data:
• The email body (HTML). This is the output from the Process and the driver
assigned to the connector, for example a Template Engine Process with no
driver, or a StoryTeller Process with an HTML unpaginated driver.
• The information defined in the destinations table. This information is
automatically added to separate sections in the SOAP envelope.
Example 7-6: Destinations table information in SOAP envelope

Row in destinations table:
001 joeboe@example.com "Joe Boe" "Kingston" "Jamaica"
Corresponding section in SOAP envelope:
<Internet ref="001">
<InsertList>
<Insert number="1">Joe Boe</Insert>
<Insert number="2">Kingston</Insert>
<Insert number="3">Jamaica</Insert>
</InsertList>
<Email>joeboe@example.com</Email>
</Internet>
Personalization
All items in the insert list in the SOAP envelope can be used to personalize the
content of the email body.
When you configure the Process that generates the email body you can add
placeholders for the items in the insert list. A placeholder has the format (I<n>),
where <n> is the value of the number attribute in the insert list. For example, use
the placeholder (I2) to reference the value of the element <Insert
number="2"> in the insert list.
Note: The first two items in the destinations table (reference number and
email address) are not part of the insert list. This means the placeholder
(I1) corresponds to the third item in the destinations table. If you, for
example, want to have the email address in the insert list, you must create
a new item for the email address in the destinations table.
Example 7-7: Template Engine snippet with placeholder

In this example, the placeholder (I1) references the customer name in
the insert list.

<p>Dear (I1), due to the recent severe weather and

flooding...</p>
Using dynamic destinations tables

It would be time consuming and error prone to create large destinations tables
manually, and it is better to create them dynamically using scripts.
All elements to use as items in the destinations table should be extracted into
variables. These variables and substitution table script functions are used in a
Before Message script to create the destinations table dynamically. A variable
that references the destinations table is then used as Destinations value in the
runtime connector settings to select the destinations table.
See the section 28 “Substitution table functions” in OpenText Communications
Center Enterprise - Scripting Reference Guide (CCMPRJ-RSC) for more information
about substitution table script functions.
Skipping all Processes but the last

The input to StreamServer may contain thousands of messages, where each
message is targeted for a specific recipient. The output to the EasyLink service is
one single SOAP envelope containing destination and insert information for all
recipients and one single email body (Process output).
In a standard processing chain in StreamServer, each triggered Event also
invokes the Process. Since all Process calls will result in the same output (data
including placeholders), it is only necessary to run the Process once in a job. You
can therefore use the “Skip” script function to skip all Processes but the last.
7.5.3.2 Adding attachments to emails

You can attach output from other Processes to emails delivered via an EasyLink
Email connector by retrieving the attachments with an Attachment connector.
To create the attachment you connect the Process to an Attachment connector. In the
Attachment connector, you specify which driver to use for the attachment (e.g. PDF)
and the name of the attachment. You can also specify the name of the attachment by
using the “MIMESetPartProperty” script function.
Note: The Attachment connector must run in output mode Process.
Process order and the Attachment connector

The Process or Processes that create the attachments must be run before the
Process that invokes the EasyLink Email connector. The email is sent to
EasyLink when the Process that invokes the EasyLink Email connector is
completed, so any attachment intended for the email must be created before that
time.
By default the Processes are executed in the order they are displayed in the
runtime configuration view (top to bottom). You can use scripting to change this
order.

All output from Processes that are connected to the Attachment connector and
run before the Process connected to the EasyLink email connector are
automatically added to the email.
No physical layer settings
There are no physical layer settings for the Attachment connector. The generic layer
settings are the same as for other output connectors with two exceptions:
• Queuing is not applicable.

• A section for attachment settings is added.
To create an Attachment connector
1. Right-click the Platform view and select New Output Connector > Attachment.
A new Attachment connector is added.
2. Rename the connector and open the Output Connector Settings dialog box
(generic layer).
3. Select the appropriate driver.
4. Click the Attachment icon and enter a Name for the attachment.
5. Specify the Attachment content type:
• Auto – the content type is derived from the driver used by the Attachment
connector.
• Predefined – select the content type from the Predefined content type drop-
down list.
• Custom – enter a custom content type in the Custom content type field.
6. Click OK.
Script functions
You can use the following script functions to handle attachments:
• “AttachmentBegin”– normally called from a Before Process script on the first

Process to include in an attachment.
• “AttachmentEnd”– ends the AttachmentBegin function, and is called from an
After Process script on the last Process to include in an attachment.
• “MIMEAddPart”– adds a file on the local file system as an attachment to an
output connector. When you use this script function with the EasyLink Email
Connector, you cannot use attachments in the body of the email.
• “MIMESetPartProperty”– specifies additional options for attachments added by
a MIMEAddPart call.

7.5.4 EasyLink Fax output connector

You can use the EasyLink Fax output connector to send PDF output via the
EasyLink cloud delivery services.
Prerequisites
• You must use the PDF driver with the EasyLink Fax output connector.
• The EasyLink connectors support the UTF-8 code page.
Platform and runtime settings

The Phone Number, Billing Code, and Customer Reference properties are
available in both the platform connector settings and runtime connector settings.
You can only enter variables for these properties in the runtime connector
settings. If you enter different values for the same option in both places, the
runtimes settings are used.
Platform Connector settings

• True – StreamServer applications wait for a job completion notification from
• False – StreamServer applications mark the job as completed after the
connector.
Note: External job completion cannot be used if batches of message are sent
to EasyLink. When these settings are used together, unexpected results are
returned.
• Batch size
The number of faxes the connector groups into a batch to send to EasyLink. The
connector only sends batches in scenarios where a single input job generates
many faxes. If an input job generates an incomplete batch, the batch is sent at job
end.
used with care.

• Phone Number

The phone number of the recipient. You can use a variable in the runtime
connector settings.
Specify the phone number using the following format:
+<country_code><phone_number>
For example:
+46704117011
You can specify multiple phone numbers by separating them with a semicolon.
For example: +46704117011; +46704117011
connector settings.
• Billing Code
settings.
7.5.5 EasyLink SMS output connector

You can use the EasyLink SMS output connector to send text messages (SMS) via the
EasyLink cloud SMS delivery services.
Output format, Process, and driver prerequisites

• This output connector supports text-based output.
• You can use any Process with this connector except for SMSOUT.
• If you use a Process that creates page-formatted output you must use the Matrix
Printer / Text file driver.
• The EasyLink connectors support the UTF-8 code page.
Platform and runtime Connector settings

The Phone Number, Customer Reference, and Billing Code properties are
available in both the platform connector settings and runtime connector settings.
You can only enter variables for these properties in the runtime connector
settings. If you enter different values for the same option in both places, the
runtimes settings are used.

• Maximum Characters
The maximum number of characters that can be sent in the SMS. The maximum
number of characters you can send depends on the language of the SMS and the

mobile network operator provider. We recommend you use a maximum of 160

characters for English and 70 for Unicode. If you want to use more characters,
contact EasyLink for more information.
• True – StreamServer applications wait for a job completion notification from
• False – StreamServer applications mark the job as completed after the
connector.
Note: External job completion cannot be used if batches of message are sent
to EasyLink. When these settings are used together, unexpected results are
returned.
• Batch size
The number of SMS messages the connector groups into a batch to send to
EasyLink. The connector only sends batches in scenarios where a single input job
generates many messages. If an input job generates an incomplete batch, the
batch is sent at job end.
used with care.

• Phone Number
The phone number to send the SMS to. You can use a variable in the runtime
connector settings.
Specify the phone number using the following format:
+<country_code><phone_number>
For example:
+46704117011
You can specify multiple phone numbers by separating them with a semicolon.
For example: +46704117011; +46704117011
connector settings.
• Billing Code
settings.

7.5.5.1 EasyLink job status reporting

The EasyLink reporting service generates reports with status information for jobs
sent via EasyLink. The Communications Center Task Scheduler application can
retrieve status information from EasyLink, and StreamServer applications can use
the status information for the following purposes:
• To create status reports for EasyLink jobs or generate custom actions based on
the status information received.
• To update the Communications Center top job status with the status from the
EasyLink job.
EasyLink account requirements

To use the EasyLink reporting service, you need to contact EasyLink Customer
service and request that the scheduled reporting functionality be added to your
account.
Steps overview
Follow these steps to set up status reports for EasyLink jobs or update the top
job status with the EasyLink job status:
• In Control Center, set up a connection to the EasyLink reporting service. Link
the connection profile to the domain where you will create the Task
Scheduler. See “Setting up a connection to the EasyLink reporting service”
on page 124.
• Set up a Task Scheduler application. See “Creating a Task Scheduler to
retrieve the EasyLink reports” on page 125.
• (Optional) If you want to update the Communications Center top job status
with the EasyLink job status, enable External Job Completion for the
EasyLink output connector. See “Enabling EasyLink to update the top job
status” on page 125.
• (Optional) If you want to generate custom actions or format the reports, set
up a StreamServer application with a Service Request input connector,
MessageIN Event, and an appropriate Process. See “Setting up a Project to
the format the reports or generate custom actions” on page 126.
Setting up a connection to the EasyLink reporting service

You must create a new web service profile in Control Center for the EasyLink
reporting service with a new Authentication profile and a new Secure Channel
profile. You must also import the Certificate file to the new profile.
1. In Control Center, from the Repositoriesnode, create a new repository with the
type EasyLink Reports.
2. Enter the URL for EasyLink and specify the recovery actions. The URL for the
EasyLink reporting service is the same as the URL for the web service profile

used by the connectors. For descriptions of the parameters, see “EasyLink Web
service profile property descriptions” on page 114.
3. Create a new Authentication profile for your EasyLink user name and
password.
4. Create a new Secure channel profile.
5. In the Secure Channel profile, create a new Certificate store profile, add a new
trusted authorities certificate and import the certificate file.
6. Link the EasyLink repository to the domain with the Task Scheduler.
Creating a Task Scheduler to retrieve the EasyLink reports

Because EasyLink generates reports with the status information every 15 minutes,
we recommend that you use intervals longer than 15 minutes for the Task Scheduler
application.
1. In Control Center, create a new Task Scheduler application.

2. In the Configuration dialog box, in the Tasks box click..., and then add an
EasyLink Reports tasks.
3. Enter a name and description for the task.
4. Set up the schedule for retrieving the status information.
5. If you want to use a StreamServer application to format the status reports or
generate custom actions based on the reports, in the Service name box, enter the
name of the service that will receive the reports. This must match the Service
namein the Service Request input connector.
If you only want to update the top job status, leave the Service name box blank.
Enabling EasyLink to update the top job status

You must enable External Job Completion in the output connector if you want to
update the Communications Center top job status with the EasyLink job status.
Considerations for using external job completion

• When you use the External Job Completion option for an EasyLink output
connector, the Customer Reference is replaced with the GUID for the job ID.
• External job completion cannot be used if batches of message are sent to
EasyLink. When these settings are used together, unexpected results are
returned.
• If a top job is never marked as completed by EasyLink, you must use Database
Administration Tool to cancel the top job.
To enable External job Completion
• In the EasyLink connector, click True for External Job Completion.

Setting up a Project to the format the reports or generate custom

actions
To set up a StreamServer application to format the status information from EasyLink
or generate custom actions based on the status information, you add a Service
Request input connector, MessageIN Event, and an appropriate Process to your
Project.
Note: Only one Service Request input connector (or service) can be used for
each EasyLink account.
To set up a Project to format the status reports or generate custom actions
1. Add a Service Request input connector to your Project. In the Request type list,
click Notification.
2. In the Service name box, enter the Service name you entered in the Task
Scheduler.
3. Add the EasyLinkNotification SXD file to the resource set. This file is found
in the OpenText Communications Center installation directory.
4. Add a MessageIN Event to your Project.
5. Connect the SXD file to the MessageIN Event.
6. Set up an appropriate Process and output connector to format and deliver the
reports or generate custom actions based on the reports.
7.6 EmailIN input connector

This connector retrieves input sent via email. The connector settings are described
below.
• Mailbox type
The type of mailbox on the mail server.
• Port
The port StreamServer will use to communicate with the mail server.
• Mail folder
The mail folder to scan for input. Leave this empty if you want to select the
Inbox.
• Mail server
The mail server IP address or host name.
• User name
A user name for accessing the mailbox. If several StreamServer instances retrieve
input from the same mail server, each instance must use a unique user name.

7.6. EmailIN input connector
• Password
A password for accessing the mailbox.
• Read email body text
Select to enable processing of the email body. You can disable this option if you
only want to process email attachments.
• Retrieve email
• Retrieve all – Retrieve all emails in the mailbox.
• Advanced – Use the filter parameters below to specify which emails to
retrieve. You can use wildcards.
• From – Retrieve emails with specific From addresses.
• To – Retrieve emails with specific To addresses.
• Cc – Retrieve emails with specific Cc addresses.
• Date – Use a time frame to specify which emails to retrieve. The time
frame corresponds to the date and time the email was received. Use YYYY-
MM-DD as format.
• Subject – Retrieve emails with specific subjects.
• Reply to – Retrieve emails with specific Reply to addresses.
• Request encryption – Select to reject unencrypted emails.
• Request signature – Select to reject unsigned emails.
Example 7-8: Using the filter parameter Date

Date: 2002-01-**
Emails dated January 2002 will be retrieved.
• Read attachment
Specifies which attachments to process.
Example 7-9: Read attachment

An email contains the attachments INVOICE_101.xml, INVOICE_101.txt
and COPY_101.xml.
If Read attachment file is *.xml, the attachments INVOICE_101.xml and
COPY_101.xml will be processed.
If Read attachment file is INVOICE*.xml, only INVOICE_101.xml will be
processed.
• Delete mail
• No – Do not delete emails.

• Delete Processed – Delete all retrieved and processed emails.

• Delete all – Delete all retrieved emails.
• Advanced – Use the filter parameters below to specify which retrieved emails
to delete.
• Delete From – Delete emails with specific From addresses.

• Delete To – Delete emails with specific To addresses.
• Delete Cc – Delete emails with specific Cc addresses.
• Delete Date – Use a time frame to specify which emails to delete. The time
frame corresponds to the date and time the email was received. Use YYYY-
MM-DD as format.
• Delete Subject – Delete emails with specific subjects.
• Delete Reply to – Delete emails with specific Reply to addresses
Example 7-10: Using the filter parameter Delete Date

Delete Date: 2002-01-**
Emails dated January 2002 will be deleted.
• Save attachment
Select to save attachments to disk. The attachment files saved to disk will be
given new unique names. The reason for this is to prevent files from being
overwritten. You must use the following scripting functions where you map the
original file names to the corresponding names of the files saved to disk:
• “GetAttachmentFile”
• “GetAttachmentOriginalFile”
• “GetAttachmentCount”
Example 7-11: Mapping file names
$i=1;
$count = GetAttachmentCount();
while(num($i)<=num($count))
{
$original = GetAttachmentOriginalFile(num($i));
if($original = "streamserve.gif")
{
$file = GetAttachmentFile(num($i));
}
$i++;
}

7.6. EmailIN input connector
Attachments saved to disk are not removed automatically. One way to delete the
attachments is to call an After Event script using the “FileDelete” scripting
function.
Example 7-12: Deleting attachments

$i=1;
$count = GetAttachmentCount();
while(num($i)<=num($count))
{
$delete = GetAttachmentFile(num($i));
FileDelete($delete);
$i++;
}
• Attachment directory
The directory where to save the attachments.
• Schedule
often to try to retrieve emails. See “Scheduling” on page 66 for more information
about scheduling.
• Ignore email content
Select to ignore the email body and attachments. You can use this option to
trigger an Event when an email is received, but not process any information in
the email. In this case, you must use an all matching pattern in the Event (e.g.
“?”).
For example, use this option in "auto reply Projects", and use the
“GetConnectorValue” script function to retrieve the appropriate email attributes
(From, Reply To, etc.).
7.6.1 Additional scripting functions for attachment handling

Current attachment
You can use the “CurrInFileName” scripting function to fetch the file name of
the current attachment sent through StreamServer.
Content type and encoding of attachments
To retrieve content type and encoding of attachments you can use the following
scripting functions.
• “GetAttachmentContentEncoding”
• “GetAttachmentContentType”
EmailIN attributes
You can use the scripting function “GetConnectorValue” to fetch EmailIN attributes.

• From
GetConnectorValue("From")
• To
GetConnectorValue("To")
• Cc
GetConnectorValue("Cc")
• Reply To
GetConnectorValue("Reply To")
• Subject
GetConnectorValue("Subject")
• Date
GetConnectorValue("Date")
• Body encoding
GetConnectorValue("Encoding")
• Body type
GetConnectorValue("Type")
• Attachment encoding
GetConnectorValue("AttEncoding<n>")
where <n> is the attachment number.

• Attachment type
GetConnectorValue("AttType<n>")
where <n> is the attachment number.

• AttCount
GetConnectorValue("AttCount")
Returns the number of attachments in the current email that have been saved to
disk.

7.7. Email output connectors
7.7 Email output connectors

SMTP (MIME) connector
The SMTP (MIME) connector is used to deliver output via SMTP email. The
output is retrieved from the Process connected to the SMTP (MIME) connector
and/or added as attachments to the email. See “Using an SMTP (MIME) output
connector” on page 131.
SMTP (MIME) (Legacy) connector

The SMTP (MIME) (Legacy) connector is used to attach output from a Process to
an SMTP email. The output is retrieved from the Process connected to the SMTP
(MIME) (Legacy) connector, and attached to the email delivered via the same
connector. See “Using an SMTP (MIME) (Legacy) output connector”
on page 140.
Note: If you create new Design Center Projects you should use the new
SMTP (MIME) connector.
MAPI connector
The MAPI connector is used to attach output from a Process to a MAPI email.
The output is retrieved from the Process connected to the MAPI connector, and
attached to the email delivered via the same connector. See “Using a MAPI
output connector” on page 144.
MailOUT Process and MailOUT connector

You can use a MailOUT Process and an SMTP (MIME) for MailOUT or MAPI for
MailOUT output connector to send emails. See Part V “MailOUT” in OpenText
Communications Center Enterprise - Process Tools Configuration Guide (CCMPTO-
CGD) for more information.
EasyLink Email connector

You can use the EasyLink Email output connector to send HTML or text-based
output using the EasyLink cloud delivery services. For more information, see
“EasyLink connectors” on page 109.
7.7.1 Using an SMTP (MIME) output connector

The SMTP (MIME) connector is used to deliver output via SMTP email. The output
is retrieved from the Process connected to the SMTP (MIME) connector and/or
added as attachments to the email. The email editor is included in the runtime
output configuration of the SMTP (MIME) connector.
Email body
You can use rich HTML formatting in the email body. You can create a static
email body or use an attachment as email body. The attachment can either be a
file stored on disk or HTML output from a StoryTeller or Template Engine
Process.

Alternative email body

You can create an alternative email body to be used in case the email client does
not support rich HTML formatting. You can create a static alternative email
body or use an attachment as alternative email body.
Attaching output from other Processes

You can attach output from Processes connected to Attachment connectors to
the email. The attachment can be used as an attachment, email body or
alternative email body.
Certificate store
A certificate store is used to sign and encrypt emails. The certificate store is a
resource that includes all certificates needed to sign and encrypt emails.
Zipping attachments
You can zip all attachments into a single zip archive, and add the zip-archive as
attachment to the email.
Storing emails to disk

You can store the emails to disk, and use the appropriate tool to archive the
stored email files.
SMTP (MIME) connector configuration in brief
In brief, the connector configuration includes the following steps:
1. Connect to the mail server. See “Connecting to the SMTP mail server”
on page 132.
2. Configure runtime settings for the connector. See “Configuring runtime

settings” on page 134.
3. Edit the email. See “Editing the email” on page 135.
4. Add attachments to the email. See “Adding attachments to the email”

on page 136.
7.7.1.1 Connecting to the SMTP mail server

To connect to the mail server you must create an SMTP (MIME) connector:
1. Right-click the Platform view and select New Output Connector > Generic.
2. Double-click the connector. The Output Connector Settings dialog box opens.
3. In the physical layer, select Connector type > SMTP (MIME).
4. Configure the settings (see below) and click OK.

• TCP/IP profile
Use TCP/IP profile to specify the connection settings to the mail server. The
connection settings are specified in a TCP/IP profile resource. You must first
create the TCP/IP profile resource, and then browse to and select this resource as

value for TCP/IP profile. See “TCP/IP profiles” on page 404 for information
about how to create TCP/IP profiles.
The only mandatory setting for the TCP/IP profile is the host. If you need to use
another port number than 25 you must also specify the port number in the TCP/
IP profile.
• Authentication profile
Use Authentication profile to specify the logon credentials to the mail server.
The logon credentials are specified in an Authentication profile resource. You
must first create the Authentication profile resource, and then browse to and
select this resource as value for Authentication profile. See “Authentication
profiles” on page 407 for information about how to create Authentication
profiles.
• Alternate TCP/IP profile
Use Alternate TCP/IP profile to specify the connection settings to an alternate
mail server. The connection settings are specified in a TCP/IP profile resource.
You must first create the TCP/IP profile resource, and then browse to and select
this resource as value for Alternate TCP/IP profile. See “TCP/IP profiles”
on page 404 for information about how to create TCP/IP profiles.
• Domain name
Use Domain name to specify the domain of the StreamServer application that
creates the email. A mail server is normally configured to serve a specific
domain, and Domain name must be a name accepted by the mail server.
• Certificate store profile
Use Certificate store profile to specify which certificates and private keys to use
to sign and encrypt emails. Certificates and private keys are specified in a
Certificate store profile resource. You must first create the Certificate store profile
resource, and then browse to and select this resource as value for Certificate
store profile. See “Certificate store profiles” on page 408 for information about
how to create Certificate store profiles.
• Sign
If you want to sign the emails, you must select a Certificate store and select Sign.
• Encrypt
If you want to encrypt the emails, you must select a Certificate store and select
Encrypt.
• DSN On Failure
You can specify how much of the original message to return in case of a delivery
failure.
• Headers Only - Select to only return the headers.

• Full Context - Select to include the complete message in the error message.

7.7.1.2 Configuring runtime settings

In the physical Runtime settings for the SMTP (MIME) connector you must specify a
code page and MIME encoding for the email. You can also enable/disable signing
and encryption and select to store the email to disk.
• Code page
Use Code page to specify the code page for the email.
• MIME encoding
Use MIME encoding to specify the MIME encoding for subject, body, and
attachments. You have the following options:
• Default – Quoted Printable for subject and body. Base64 for attachments.
• None – No encoding for the subject. The maximum number of characters in
the subject is 65. No encoding for the body. Base64 for attachments.
• Quoted Printable – Quoted Printable for subject, body, and attachments.
• Base64 – Base64 for subject, body, and attachments.
• S/MIME Sign
Use S/MIME Sign to enable/disable signing of emails. Use static value or
variable to enable (value=1) or disable (value=0).
• S/MIME Encrypt
Use S/MIME Encrypt to enable/disable encryption of emails. Use static value or
• Store MIME envelope to disk
Use Store MIME envelope to disk and Store to path to store emails to disk:
1. Select Store MIME envelope to disk.
2. In Store to path, enter the path to the file. For example:
C:\storedEmails\$custno.mht
The email, including all attachments attached to the email, is stored as a MIME
envelope in the save path specified. You can use this functionality to, for
example, store emails to disk and then archive the emails using the appropriate
tool.

7.7.1.3 Editing the email

You start the email editor by clicking Edit Mail in the physical Runtime settings for
the SMTP (MIME) connector.
Address and subject

• Use From, To, Cc and Bcc to specify From, To, Cc and Bcc addresses.
• Use Subject to specify the email subject.
• Use Display name to specify a display name. The From address is replaced by
this name when the email is delivered to the recipient. This functionality must be
supported by the email client.
• Use Reply to to specify an address to be used by the email recipient instead of
the From address when responding to an email.
• Use Request receipt to request a delivery receipt. A notification is received when
the email is delivered. This functionality must be supported by the email servers
and clients.
Defining how to use the Process output

Use Use process content as to specify how to use the output from the Process
connected to the SMTP (MIME) connector:
• Not used – the Process is only used to trigger the email without adding any
output to the email.
• Body – the output is used as email body.
• Alternative body – the output is used as alternative email body.
• Attachment – the output is attached to the email.
If you select Body, Alternative Body or Attachment you must select the
appropriate Output MIME type option for the output:
• Autoselect – the MIME type is derived from the driver used by the SMTP
(MIME) connector.
• Predefined – Select the MIME type from the Predefined MIME Type drop-
down list.
• Custom – Enter a custom MIME type in the Custom MIME Type field.
If you select to attach the output to the email you must also specify an
Attachment name and optionally to Compress the attachment.
Creating a static body definition
You can create a static body definition to be used as body or alternative body:
1. Click Edit static body definition. The Static email body editor opens.
2. Edit the body and click OK.

Defining how to use the static body definition
Use Use static body definition as to specify how to use the static body definition:
• Body – use as email body.

• Alternative body – use as alternative email body.
• Not used – do not use a static body.
Defining what to use as email body

As described above, you can use the output from the Process connected to the
SMTP (MIME) connector or a static body definition as email body. You can also
use attachments as email body. See “Adding attachments to the email”
on page 136.
Defining what to use as alternative email body

As described above, you can use the output from the Process connected to the
SMTP (MIME) connector or a static body definition as alternative email body.
You can also use attachments as alternative email body. See “Adding
attachments to the email” on page 136.
7.7.1.4 Adding attachments to the email

You can add resources and output from Processes to the email. The resource or
Process output can be used as attachment, email body or alternative email body.
7.7.1.5 Attaching output from other Processes

You can attach output from other Processes to an email delivered via an SMTP
(MIME) connector. The Process output must be retrieved from an Attachment
connector (see “Using an Attachment connector” on page 139). The attachment can
be used as attachment, email body or alternative email body. The attachment must
be finished before the email is sent via the SMTP (MIME) connector. When the
attachment has to be finished depends on the output mode defined for the SMTP
(MIME) connector.
• Output mode Process - The email is sent when the Process that invokes the
SMTP (MIME) connector is completed. Any attachment intended for the current
email must be created before that time, i.e. all attachments from other Processes
must be run before the SMTP (MIME) connector Process is run.
• Output mode Document - The email is sent when the document ends, i.e. the
document containing the Process that invoked the SMTP (MIME) connector. Any
attachment intended for the current email must belong to a Process run before
the SMTP (MIME) connector Process, or after the SMTP (MIME) connector
Process but before the document trigger changes value.
• Output mode Job - Any attachment from Processes within the same job as the
SMTP (MIME) connector Process can be attached to the email.

To add an attachment
1. In the email editor, click . The Mail Attachment dialog box opens.
2. From the Attachment type drop-down list, select Output from attachment
connector.
3. Enter the Attachment name.
4. From the Use attachment as drop-down list, select how to use the attachment:
• Attachment – use as attachment.

5. Specify whether the Attachment is mandatory. If specified and the attachment

cannot be added to the email, the job will fail.
6. Select the Attachment connector from which to retrieve the attachment and
click OK.
7.7.1.6 Attaching resources

You can attach resources to an email. The resource can be used as attachment, email
body or alternative email body.
When you specify the Attachment path you can either specify the path to a file on
disk, a URI to an Open Text Media Management (OTMM) asset or a URI to a
resource stored in the repository via a Resource filter or Resource output connector.
To be able access OTMM assets you must first create a Media Management
connection profile (see “Media Management connection profiles” on page 406).
When you have the connection profile you can reference an asset using the following
syntax:
otmm://<profileName>/<reference>
Attachment path examples

• C:\att\gold.pdf
• otmm://otmm-gbg/?id=6708ba967b9b4dbd94f01fd6457a781c3e98e173
• resource:/?name=offer
To attach a resource
2. From the Attachment type drop-down list, select Static attachment.

4. From the Use attachment as drop-down list, select how to use the attachment:

5. Specify whether the Attachment is mandatory. If specified and the resource

cannot be attached to the email, the job will fail.
6. In Attachment path, specify the path or URI to the resource.
7. Specify the Content type of the attachment:
• Predefined – Select the content type from the Predefined type drop-down
list.
• Custom – Enter a custom content type in the Custom type field.
8. Use Convert PCL to PDF if you need to convert PCL files to PDF attachments.
9. Specify whether to Compress the attachment and click OK.
7.7.1.7 Using attachment script functions

You can use the following script functions to handle attachments:
• “AttachmentBegin” – normally called from a Before Process script on the first

Process to include in an attachment.
• “AttachmentEnd” – ends the AttachmentBegin function, and is called from an
After Process script on the last Process to include in an attachment.
• “MIMEAddPart” – adds a file on the local file system as an attachment to an
output connector.
• “MIMESetPartProperty” – specifies additional options for attachments added by
a MIMEAddPart call.
7.7.1.8 Zipping attachments

If you add several attachments to an email, you have the option to zip all
attachments and attach the zip file to the email. This applies to all attachments used
as attachment (not body or alternative body) including attachments added using
script functions.
To zip attachments
1. In the email editor, select Compress attachments into one Zip-archive.
2. In Zip-archive name, enter the name of the zip file to attach to the email.

7.7.1.9 Using an Attachment connector

The Attachment output connector is used together with the SMTP (MIME) output
connector. It enables you to add output from any Process as attachment to an email
delivered via the SMTP (MIME) output connector.
To create the attachment you connect the Process to an Attachment connector. In the
Attachment connector you specify which driver to use for the attachment (e.g. PDF),
and the name and content type of the attachment. All Attachment connectors in a
Design Center Project are available from a drop-down list in all SMTP (MIME)
connectors in the same Design Center Project.
settings are the same as for other output connectors with two exceptions:
• Queueing is not applicable.
To create an Attachment connector
1. Right-click the Platform view and select New Output Connector > Attachment.
A new Attachment connector is added.
2. Rename the connector and open the Output Connector Settings dialog box
(generic layer).
3. Select the appropriate driver.
4. Click the Attachment icon and enter a Name for the attachment.
5. Specify the Attachment content type:
connector.
down list.
6. Click OK.

7.7.1.10 Configuring the SMTP connection pool

SMTP (MIME) output connectors use a connection pool when sending emails to the
SMTP server. If you have several SMTP (MIME) output connectors in your Project,
they share the same connection pool. By default the connection pool only uses
temporary objects, which means a new connection is created for each email that is
sent. You can reduce the time the output connector spends creating new connections
and allow multiple emails to be sent with one connection by configuring the SMTP
connection pool.
You use the following startup arguments to configure the connection pool:
• “-smtppoolsizemin”
• “-smtppoolsizemax”
• “-smtppooltempdisable”
7.7.2 Using an SMTP (MIME) (Legacy) output connector

The SMTP (MIME) (Legacy) connector is used to attach output from a Process to an
SMTP email. The output is retrieved from the Process connected to the SMTP
(MIME) (Legacy) connector, and attached to the email delivered via the same
connector. The email editor is included in the runtime output configuration of the
SMTP (MIME) (Legacy) connector.
Note: This connector is only used in upgraded Design Center Projects where
the old version of the Project included SMTP (MIME) connectors. If you create
new Design Center Projects you should use the new SMTP (MIME) connector.
See “Using an SMTP (MIME) output connector” on page 131.
Email body
You create the email body in a body editor. You can use plain text or HTML in
the email body.
Attaching files on disk to the email
You can attach files on disk (static attachments) to the email.
Scripting functions for attachments
You can use the scripting functions “AttachmentBegin” and “AttachmentEnd”
to handle attachments.
SMTP (MIME) (Legacy) connector configuration in brief
1. Connect to the mail server. See “Connecting to the SMTP mail server”
on page 141.


on page 143.
7.7.2.1 Connecting to the SMTP mail server

To connect to the mail server you must create an SMTP (MIME) (Legacy) connector:
3. In the physical layer, select Connector type > SMTP (MIME) (Legacy).

• Mail server - Use Mail server to specify the IP address or host name of the mail
server.
• Mail server user name - Use Mail server user name to specify a user name to
access the mail server.
• Mail server password - Use Mail server password to specify a password to
access the mail server.
• Alternate mail server - Use Alternate mail server to specify the IP address or
host name of an alternate mail server (used if the Mail server does not respond).
• Domain name - Use Domain name to specify the domain of the StreamServer
application that creates the email. A mail server is normally configured to serve a
specific domain, and Domain name must be a name accepted by the mail server.
• Number of retries - Use Number of retries to specify the number of times to try
to reconnect if the mail server does not respond.
• Retry interval - Use Retry interval to specify the interval (seconds) between the
retries.
• Sign - Use Sign to sign emails (S/MIME). You must have created a security
configuration for this purpose. See “About encryption and authentication“
on page 711.
• Encrypt - Use Encrypt to encrypt emails (S/MIME). You must have created a
security configuration for this purpose. See “About encryption and
authentication“ on page 711.


In the physical Runtime settings for the SMTP (MIME) (Legacy) connector you must
specify a code page and MIME encoding for the email. You can also enable/disable
signing and encryption.
• Ignore missing attachments

Use Ignore missing attachments to specify whether to send an email if an
attachment is missing. This applies to all attachments – the Process output as
well as static attachments.
• If enabled, StreamServer tries to send the email even if an attachment cannot

be found.
• If disabled, the job will fail if an attachment cannot be found.
• Code page
• MIME encoding
• S/MIME Sign
Use S/MIME Sign to enable/disable signing of emails. Use static value or
• S/MIME Encrypt
Use S/MIME Encrypt to enable/disable encryption of emails. Use static value or

the SMTP (MIME) (Legacy) connector.
• Attachment name
Use Attachment name to specify the name of the Process attachment.
• Output MIME type
Use Output MIME type to specify the MIME type for the Process attachment:

(MIME) (Legacy) connector.
• Predefined – Select the MIME type from the Predefined MIME Type drop-
down list.
• Custom – Enter a custom MIME type in the Custom MIME Type field.
• Address and subject
• Use From, To, Cc and Bcc to specify From, To, Cc and Bcc addresses.
• Use Display name to specify a display name. The From address is replaced
by this name when the email is delivered to the recipient. This functionality
must be supported by the email client.
• Use Reply to to specify an address to be used by the email recipient instead of
the From address when responding to an email.
• Use Request receipt to request a delivery receipt. A notification is received
when the email is delivered. This functionality must be supported by the
email servers and clients.
To create the email body

You can attach files on disk to an email delivered via an SMTP (MIME) (Legacy)
connector.
3. In Attachment path, specify the path to the file to attach.
4. Specify the Content type of the attachment:
• Predefined – Select the content type from the Predefined type drop-down
list.
• Custom – Enter a custom content type in the Custom type field.
5. Use Convert PCL to PDF to convert PCL files to PDF attachments.

7.7.3 Using a MAPI output connector

The MAPI connector is used to attach output from a Process to a MAPI email. The
output is retrieved from the Process connected to the MAPI connector, and attached
to the email delivered via the same connector. The email editor is included in the
runtime output configuration of the MAPI connector.
Note: MAPI is not suitable for HTML messages. See http://

support.microsoft.com/?id=268440 ( http://support.microsoft.com/?id=268440)
Email body
You create the email body in a body editor. You can use plain text or HTML in
the email body.
Attaching files on disk to the email

You can attach files on disk (static attachments) to the email.
Scripting functions for attachments

You can use the scripting functions “AttachmentBegin” and “AttachmentEnd”
to handle attachments.
Logon options
In Control Center, the logon options for the StreamServer application must not
be set to System account. Use the logon option This account and specify an
account with permissions to use the Windows Messaging Profile specified for
the MAPI for MailOUT connector. To change the logon options, right-click the
StreamServer application in Control Center and select Service Startup.
MAPI connector configuration in brief
1. Connect to the mail server. See “Connecting to the MAPI mail server”
on page 145.


on page 146.

7.7.3.1 Connecting to the MAPI mail server

To connect to the mail server you must create a MAPI connector:
3. In the physical layer, select Connector type > MAPI.

• Default profile
Use Default profile to specify the default Windows Messaging Profile.
A Windows Messaging Profile identifies a specific user and the mail server. To
find the profiles available, open the Mail setup dialog box from the Control Panel
and click Show Profiles.
The email address that will be used is the address specified as the From address
in the user's profile. To be able to use alternative From addresses, you must set
up a profile for each address. You do this in the runtime configuration of the
connector.
• Number of retries
Use Number of retries to specify the number of times to try to reconnect if the
mail server does not respond.
• Retry interval
Use Retry interval to specify the interval (seconds) between the retries.

In the physical Runtime settings for MAPI connector you must specify a name for
the Process attachment, a code page and MIME encoding for the email.
Use Ignore missing attachments to specify whether to send an email if an
attachment is missing. This applies to all attachments – the Process output as
well as static attachments.
be found.
• Code page
• MIME encoding

• Profile name
Use Profile name to specify which Windows Messaging Profile to use:
• Use default Profile of connector – Use the profile specified in the Platform
configuration of the connector.
• Static profile – Use an alternative static profile.
• Variable profile – Use a variable to determine the alternative profile.
• Lookup profile – Use a lookup table to determine the alternative profile.

the MAPI connector.
Address and subject

• Use To, Cc and Bcc to specify To, Cc and Bcc addresses.
• Use Request receipt to request a delivery receipt. A notification is received when
the email is delivered. This functionality must be supported by the email servers
and clients.
To create the email body

You can attach files on disk to an email delivered via a MAPI connector.
3. In Attachment path, specify the path to the file to attach.
4. Use Convert PCL to PDF to convert PCL files to PDF attachments.

7.7.4 GUI reference

7.7.4.1 Attachment output connector
The Attachment output connector is used together with the SMTP (MIME) output
connector. It enables you to add output from any Process as attachment to an email
delivered via the SMTP (MIME) output connector.
settings are the same as for other output connectors, but with two exceptions:
• Queueing is not applicable.
Attachment settings
• Name
The name of the attachment.
• Attachment content type
The content type of the attachment:
connector.
down list.
7.7.4.2 SMTP (MIME) output connector

The SMTP (MIME) connector is used to deliver output via SMTP email.
Platform settings
• TCP/IP profile
The TCP/IP profile resource that contains the connection settings to the mail
server. See “TCP/IP profiles” on page 404 for information about how to create
TCP/IP profiles.
The only mandatory setting for the TCP/IP profile is the host. If you need to use
another port number than 25 you must also specify the port number in the TCP/
IP profile.

The Authentication profile resource that contains the logon credentials to the
mail server. See “Authentication profiles” on page 407 for information about
how to create authentication profiles.
• Alternate TCP/IP profile
The TCP/IP profile resource that contains the connection settings to an alternate
mail server. Used if the first mail server does not respond.
• Domain name
The domain of the StreamServer application that creates the email. A mail server
is normally configured to serve a specific domain, and the Domain name must be
a name accepted by the mail server. For example:
opentext.com
The Certificate store profile resource that contains the certificates and private
keys used to sign and encrypt emails. See “Certificate store profiles” on page 408
for information about how to create Certificate store profiles.
• Sign
Select to sign emails.
• Encrypt
Select to encrypt emails.
• DSN On Failure
Delivery status notification on failure. Specifies how much of the original
message to return in case of a delivery failure.
• Headers Only - Select to only return the headers.
• Full Context - Select to include the complete message in the error message.
Runtime settings
• Edit Mail
Opens the email editor. See Edit mail settings on page 149.
• Code page
The code page for the email.
• MIME encoding
The MIME encoding for subject, body, and attachments.


• S/MIME sign
Enable/disable signing of emails. Use static value or variable to enable (value=1)
or disable (value=0).
• S/MIME encrypt
Enable/disable encryption of emails. Use static value or variable to enable
(value=1) or disable (value=0).
• Store MIME envelope to disk
Select to store the email, including attachments, as a mime envelope. You can use
this e.g. to store the email on disk, and then archive the email using the
appropriate tool.
• Store to path
The save path, including file name, of the mime envelope. For example:
C:\storedEmails\$custno.mht
Edit mail settings

• Use process content as
Specifies how to use the output from the Process connected to the SMTP (MIME)
connector:
• Not used – the Process is only used to trigger the email without adding any
output to the email.
• Body – the output is used as email body.
• Alternative body – the output is used as alternative email body.
• Attachment – the output is attached to the email.
• Attachment name
(Applicable only if Use Process content as = Attachment.)
The name of the attached Process output. You can use variables in the name.
• Convert PCL to PDF
Used if the Process output needs to be archived as PCL and also attached as PDF
to the email. The driver used by the connector is in this case a PCL driver, and
the attachment is converted from PCL to PDF.
• Compress
Select to compress the attached Process output.
The MIME type of the Process output:

(MIME) connector.
• Predefined – select the MIME type from the Predefined MIME Type drop-
down list.
• Custom – enter a custom MIME type in the Custom MIME Type field.
• Use static body definition as
Specifies how to use static body definition:
• Not used – do not use a static body.
• From
Standard email attribute.
• Display name
The display name. The From address is replaced by this name when the email is
delivered to the recipient. This functionality must be supported by the email
client.
• Reply to
The address to reply to. Used by the email recipient instead of the From address
when responding to an email.
• To
• Cc
• Bcc
• Subject
• Request receipt
Select to request a delivery receipt. A notification is received when the email is
delivered. This functionality must be supported by the email servers and clients.
• Edit static body definition
Opens the Static email body editor where you can create a static email body.
• Attachments
Attachment to the email. Use the Add/Edit/Delete buttons to add, edit or delete
attachments. See Mail Attachment dialog box on page 151 for information on
how to add or edit attachments.

• Compress attachments into one Zip-archive

Select to compress all attachment into one zip archive, and attach the zip archive
to the email.
• Zip-archive name
The name of the zip-archive.
Static email body editor
In the static email body editor you edit the static body text. You can use the editor in
Plain Text or HTML mode. In HTML mode you can define the following for selected
text fragments:
• Font type
• Font size
• Font weight
• Italic
• Underline
• Text color
• Alignment
Mail Attachment dialog box

• Attachment type
The type of attachment to add to the email:
• Static attachment – a file on disk, an Open Text Media Management (OTMM)
asset or a resource stored in the repository via a Resource filter or Resource
output connector.
• Output from attachment connector – attachment collected from an
Attachment output connector.
• Attachment name
The name of the attachment. You can enter a static name or use a variable.
• Use attachment as
Specifies how to use the attachment:
• Attachment is mandatory
Specifies the attachment as a mandatory attachment. If the attachment is not
added to the email, and if Attachment is mandatory is enabled, the job will fail.

Static attachment settings

• Attachment path
The path or URI to the resource to attach. The following three examples show
attachment paths for files on disk, OTMM assets and runtime resources:
C:\att\gold.pdf
otmm://otmm-gbg/?id=6708ba967b9b4dbd94f01fd6457a781c3e98e173
resource:/?name=offer
• Content Type
• Predefined – select the content type from the Predefined type drop-down
list.
• Custom – enter a custom content type in the Custom type field.
Select to convert a PCL attachment to PDF.
• Compress
Select to compress the attachment.
Attachment connector settings

• Attachment Connector
The Attachment connector from which to collect the attachment.
7.7.4.3 SMTP (MIME) (Legacy) output connector

The SMTP (MIME) (Legacy) connector is used to attach output from a Process to an
SMTP email.
Note: This connector is only used in upgraded Design Center Projects where
the old version of the Project included SMTP (MIME) connectors. If you create
new Design Center Projects you should use the new SMTP (MIME) connector.
Platform settings
• Mail server
The IP address or host name of the mail server.
• Mail server user name
A user name to access the mail server.
• Mail server password
A password to access the mail server.
• Show password

When enabled (checked), Mail server password is displayed in plain text in the
output connector dialog box. When disabled, each character in Mail server
password is displayed as an asterisk (*). Note that this setting only affects how
the password is displayed in the GUI.
• Alternate mail server
The TCP/IP profile resource that contains the connection settings to an alternate
mail server. Used if the Mail server does not respond.
• Domain name
The domain of the StreamServer application that creates the email. A mail server
is normally configured to serve a specific domain, and the Domain name must be
a name accepted by the mail server. For example:
opentext.com
The number of times to try to reconnect if the mail server does not respond.
• Retry interval
The interval (seconds) between the retries.
• Sign
Select to sign emails (S/MIME). You must have created a security configuration
for this purpose. See “About encryption and authentication“ on page 711.
• Encrypt
Encrypt emails (S/MIME). You must have created a security configuration for
this purpose. See “About encryption and authentication“ on page 711.
Runtime settings
• Edit Mail
Specifies whether to send an email if an attachment is missing. This applies to all
attachments – the Process output as well as static attachments.
be found.
• Code page
• MIME encoding
The MIME encoding for subject, body, and attachments.


• S/MIME sign
Enable/disable signing of emails. Use static value or variable to enable (value=1)
or disable (value=0).
• S/MIME encrypt
Enable/disable encryption of emails. Use static value or variable to enable
(value=1) or disable (value=0).
Edit mail settings

• Attachment name
• Compress
The MIME type of the Process output:
(MIME) connector.
• Predefined – select the MIME type from the Predefined MIME Type drop-
down list.
• Custom – enter a custom MIME type in the Custom MIME Type field.
• From
• Display name
The display name. The From address is replaced by this name when the email is
delivered to the recipient. This functionality must be supported by the email
client.
• Reply to
The address to reply to. Used by the email recipient instead of the From address
when responding to an email.
• To


• Cc
• Bcc
• Subject
• Request receipt
Opens the Static email body editor where you create the email body.
• Attachments
Supplementary files to add as attachment to the email. These attachments are
files stored on disk, and not output from a Process. Use the Add/Edit/Delete
buttons to add, edit or delete attachments. See Mail Attachment dialog box
on page 155.
text fragments:
• Font type
• Font size
• Font weight
• Italic
• Underline
• Text color
• Alignment

• Attachment name
• Attachment path
The path to the file to attach.
• Content Type


• Predefined – select the content type from the Predefined type drop-down
list.
• Custom – enter a custom content type in the Custom type field.
• Compress
7.7.4.4 MAPI output connector

The MAPI connector is used to attach output from a Process to a MAPI email.
Note: MAPI is not suitable for HTML messages. See http://

support.microsoft.com/?id=268440 ( http://support.microsoft.com/?id=268440)
Platform settings
• Default profile
Specifies the default Windows Messaging Profile.
A Windows Messaging Profile identifies a specific user and the mail server. To
find the profiles available, open the Mail setup dialog box from the Control Panel
and click Show Profiles.
The email address that will be used is the address specified as the From address
in the user's profile. To be able to use alternative From addresses, you must set
up a profile for each address. You do this in the runtime configuration of the
connector.
The number of times to try to reconnect if the mail server does not respond.
• Retry interval
The interval (seconds) between the retries.
Runtime settings
• Edit Mail
Specifies whether to send an email if an attachment is missing. This applies to all
attachments – the Process output as well as static attachments.
be found.


• Attachment name
• Compress
• Code page
• Profile name
Specifies which Windows Messaging Profile to use:
• Use default Profile of connector – Use the profile specified in the Platform
configuration of the connector.
• Static profile – Use an alternative static profile.
• Variable profile – Use a variable to determine the alternative profile.
• Lookup profile – Use a lookup table to determine the alternative profile.
Edit mail settings

• To
• Cc
• Bcc
• Subject
• Request receipt
Opens the Static email body editor where you create the email body.
• Attachments
Supplementary files to add as attachment to the email. These attachments are
files stored on disk, and not output from a Process. Use the Add/Edit/Delete

buttons to add, edit or delete attachments. See Mail Attachment dialog box
on page 158.
text fragments:
• Font type
• Font size
• Font weight
• Italic
• Underline
• Text color
• Alignment

• Attachment name
• Attachment path
The path to the file to attach.
• Compress
7.8 Fax connectors

Output via fax can be sent using the following connectors:
• “Fax Connect output connector”
• “TOPCALL output connector”
Third party products

Communications Center cannot take responsibility for the performance of third
party products, or for any changes that might be made to those products by
their respective manufacturers. For these reasons, this document does not
provide specific information, illustrations or instructions for the use of third
party products.
For specific information about any third party product, please refer to the
manufacturer instructions for that product.

7.8. Fax connectors
EasyLink Fax connector

You can use the EasyLink Fax output connector to faxes via the EasyLink cloud
delivery services. For more information, see “EasyLink connectors” on page 109.
7.8.1 Fax Connect output connector

This connector sends output via different types of fax servers. You select the fax
server when you specify the device driver. You can use the following fax servers:
• “Fax (Generic)”
• “RightFax and RightFax Unicode”
• “Zetafax”
The connector settings are described below

• Type
• Command – Use a DOS / UNIX command, batch file, or script to specify the
output destination.
• Spool – Send the output to a fax device.
• File – Send the output to a directory.
• Command
The command specifying the destination for the output. Used with the type
Command.
Example 7-13: Command

C:\project\myname.bat
• Printer
The fax device. Used with the type Spool.
• Directory
The output directory from which the fax device retrieves the output. Used with
the type File.

7.8.1.1 Fax (Generic)

Fax (Generic) is a generic Communications Center fax driver.
Runtime settings
• Fax Number
The fax number.
• Priority
The priority of the output. The lower the number, the higher the priority. If you
specify nothing, output will be delivered on a first-in, first-out basis.
• Comment 1-3
Comments to add to the cover page.
• Cover Page
The path to the cover page. Maximum 8 characters.
• Alt. Destination
The fax number to an alternate destination. Used if StreamServer cannot connect
using the standard fax number.
• User
The name of the sender.
• Send Time
The time when to send the fax. Use the format HH[:MM:SS]. If you specify
nothing, the fax will be sent immediately.
7.8.1.2 RightFax and RightFax Unicode

RightFax Unicode
RightFax Unicode enables printing of all TrueType fonts that have been
specified in the RightFaxUC.drs file. The fonts do not have to be installed on
the fax system. Unicode is only supported for the fax body, not for cover pages
etc.
Runtime settings
See your RightFax documentation.

7.9. File output connector
7.8.1.3 Zetafax
Note: Zetafax® is a registered trademark of Equisys.
Runtime settings
See your Zetafax documentation.
7.9 File output connector

This connector writes output to files on the file system. The connector settings are
described below.
• File
The file to write the output to, for example C:\projects\myfile.txt. If the file
does not exist, it will be created. You can specify the file using the “SetDestPath”
scripting function.
• Append
Select whether to append output to existing files.
• Yes – append the output to the file.
• No – overwrite the file.
• Create directories
Select whether to create directories specified in the File path.
• Yes – If any of the directories in the File path does not exist, they are created.
• No – If any of the directories in the File path does not exist, an error message
is generated.
7.9.1 Generating output files for StoryTeller attachments

You can generate output files for embedded attachments used in StoryTeller
Processes.
Output files can be generated for the following types of attachments:

• Embedded images
• Cascading Style Sheet (CSS) files
Prerequisites
HTML unpaginated driver is used.
To generate output files for attachments in StoryTeller Processes
1. Create a file output connector in the Platform.
2. In the generic platform layer, select the Driver tab.

3. In the Device drop-down list, select HTML unpaginated.
4. In the runtime configuration, open the Physical Runtime Output Connector

settings dialog for the output connector.
5. In the File field, enter the path and file name for the output.
Tip: Each output file must have its own folder, otherwise the attachment
files are overwritten.
6. Select Enable attachments.
7. In the Attachment relative path field, enter the name of folder where you want
the attachment files created.
Physical Runtime Output Connector settings
• File
The path and file where the output is created (overrides the settings in the
Platform). Each file generated must have its own folder, otherwise the
attachment files are overwritten.
• Enable attachments
Select to create output files for attachments.
• Attachment relative path
The folder where the attachment files are created (relative to the File directory). If
the Create directories option in the Platform is Yes, then the directories are
created automatically.
7.10 FTP connectors

The “FTP input connector” and “FTP output connector” enables StreamServer to
transfer files to and from an FTP server.
7.10.1 FTP input connector

This connector retrieves files from an FTP server. TCP/IP profile and Authentication
profile resources are used to specify the connection settings and logon credentials. In
the TCP/IP profile resource you can also select to use a secure channel between the
connector and FTP server.
Comments
When a file has been retrieved, it is deleted from the FTP server. If a Project has
several connectors (FTP input or FTP output) per user account, the number of
concurrent connections specified on the FTP server must be equal to, or more
than, the number of FTP connectors. For example, if a Project has one FTP input
connector and one FTP output connector that use the same user account, the
number of concurrent connections specified on the FTP server must be at least 2.

7.10. FTP connectors
Settings
• TCP/IP profile
The TCP/IP profile resource that contains the connection and recovery settings
for the channel between the FTP connector and FTP server. See “TCP/IP profiles”
on page 404.
The Authentication profile resource that contains the logon credentials to the FTP
server. See “Authentication profiles” on page 407.
• Remote directory
The directory to be accessed on the FTP server. If you leave this blank, the root
directory will be set as remote directory. The FTP server software determines
whether to use slash or back-slash.
Example:
/invoices/pdfout/area2
• File mask
The match criterion for the files to be retrieved.
Example:
*.pdf
• Save path
If you want to save copies of the retrieved files you must specify a Save path. Use
an absolute path, or a path relative to the StreamServer application working
directory.
• Data transfer mode
Specifies the transfer mode for the data.
• Active – use active mode.

• Passive – use passive mode. This mode is used when communicating through
firewalls. It opens a control connection to the FTP server, tells the FTP server
to expect a control connection and a second connection. Then it opens the
data connection to the FTP server on a randomly chosen high-numbered port.
This works with most firewalls unless the firewall restricts outgoing
connections on high-numbered ports.
• File transfer type
Specifies the transfer mode for the files.
• ASCII – use ASCII, Type A, transfer method. Control and formatting data is
converted to local equivalents.
• Binary – use FTP Image, Type I, transfer method. The file is transferred
without any changes.

• Schedule
often to try to retrieve files.
• Time-out
Specifies a time-out for the connector. StreamServer uses job-end sequences in
the input data to determine when all data in an input job is received. If there are
no job-end sequences in the input data, StreamServer will not know when to stop
waiting for more input. To prevent this from happening, you can define a time-
out for the input connector.
7.10.2 FTP output connector

This connector transfers files to an FTP server. TCP/IP profile and Authentication
profile resources are used to specify the connection settings and logon credentials. In
the TCP/IP profile resource you can also select to use a secure channel between the
connector and FTP server.
Comments
If a Project has several connectors (FTP input or FTP output) per user account,
the number of concurrent connections specified on the FTP server must be equal
to, or more than, the number of FTP connectors. For example, if a Project has one
FTP input connector and one FTP output connector that use the same user
account, the number of concurrent connections specified on the FTP server must
be at least 2.
Settings
• TCP/IP Profile
The TCP/IP profile resource that contains the connection and recovery settings
for the channel between the FTP connector and FTP server. See “TCP/IP profiles”
on page 404.
• Authentication Profile
The Authentication profile resource that contains the logon credentials to the FTP
server. See “Authentication profiles” on page 407.
• Remote directory
The directory to be accessed on the FTP server. If you leave this blank, the root
directory will be set as remote directory. The FTP server software determines
whether to use slash or back-slash.
Example:
/invoices/pdfout/area2
• Create Directories
Select whether to create the Remote directory if it does not exist.
• Yes – If any of the directories in the remote path does not exist, they are
created.

7.10. FTP connectors
• No – If any of the directories in the remote path does not exist, the file is put
in the undeliverables folder.
• File
The file to write the output to, and to upload to the FTP server. You can use
variables, but only in the runtime connector settings.
Example:
• Script before process: $file = getdate() + "_" + $invo + ".pdf";
• Runtime FTP connector settings: $file
• Tmp File
A temporary filename for the file to upload.
You must use a file name pattern different from the filename pattern used by the
receiving application. This prevents the receiving application from downloading
the file before the upload is completed. When the upload is completed, the file is
renamed to the name specified in File above, and the receiving application can
download the file.
If external files are uploaded (see External files below) all files will be uploaded,
one by one, with the same temporary file name. After a successful upload, each
file will be renamed to its final file name.
• External files
Enables upload of external files, together with the generated output file, to the
Remote directory specified.
You can use an absolute path to the external file, or a path relative to the working
directory of the StreamServer application.
You can add several external files if you separate the file paths with semicolon.
For example:
<path1>;<path2>;<path3>
• Data transfer mode
Specifies the transfer mode for the data.
• Passive – use passive mode. This mode is used when communicating through
firewalls. It opens a control connection to the FTP server, tells the FTP server
to expect a control connection and a second connection. Then it opens the
data connection to the FTP server on a randomly chosen high-numbered port.
This works with most firewalls unless the firewall restricts outgoing
connections on high-numbered ports.
• Active – use active mode.
• File transfer type
Specifies the transfer mode for the files.
• ASCII – use ASCII, Type A, transfer method. Control and formatting data is
converted to local equivalents.

• Binary – use FTP Image, Type I, transfer method. The file is transferred
without any changes.
Runtime settings
• If you use a variable to override the Platform setting for the TCP/IP Profile
resource or the Authentication Profile resource, you must make sure the
resource name only contains the following characters:
• a-z
• 0-9
• “-” (hyphen)
Uppercase letters (A-Z) are replaced with lowercase letters (a-z) in the URI.
All other characters are replaced by “-” (hyphen).
• The <Default> options for Passive Mode and Transfer Mode means the
Platform settings will be used.
7.11 Generic Archive output connector

This connector archives output (output data and corresponding index files) in an
external archiving system. The output is temporarily stored in directories before it is
sent to the archiving system. Each index file contains the path to the output data in
relation to the directory where the index file is stored.
Comments
What settings to specify depends on the requirements from the archiving
system. For example, if an archiving client scans the directory for index files
with a certain extension, you must specify this extension. As the extension is
added at job end, you prevent the archiving client from accessing an index file
before it is completed.
The connector settings are described below.
Settings
• Index directory
The root directory for the output. The directory is specified in relation to the
working directory. You can use the SetDestPath() scripting function.
One sub directory is automatically created per job, containing the output data
and the index file. As an alternative to these automatically generated directories,
you can specify separate directories for the output data and the index files in the
Runtime settings.
Runtime settings
• Index entry

7.11. Generic Archive output connector
The characters (hexadecimal values) used to separate the Archive attributes

within an index line.
• Index line separator
The characters (hexadecimal values) used to separate index lines.
• Index command
A command to execute when all files are added to the Index directory in the
Platform connector settings.
Example 7-14: Index command
programname -st %l -dt %
where programname retrieves the index file (%1) in the Index directory (%)
for further processing.
• Remove job directory

Removes the job directory (in the Index directory in the Platform connector
settings) after successful completion of the Index command.
• Index directory
A separate directory for the index files. The directory is specified in relation to
the Index directory in the Platform connector settings. You can use variables. If
no directory is specified, the job sub directory in the Index directory in the
Platform connector settings is used.
• Index name
The name of the index file. You can use variables. If no name is specified, a name
is automatically generated.
• Index extension
An extension, to be added to the index file. You can use variables. If no extension
is specified, the *.idx extension is used.
• Data directory
A separate directory for the output data. The directory is specified in relation to
the Index directory in the Platform connector settings. You can use variables. If
no directory is specified, the output data is stored in the same directory as the
index file.
• Data name
The name of the output data. You can use variables. If no name is specified, a
name is automatically generated.
• Archive attributes
The archive attributes. These attributes consist of an attribute name and a value.
The value can be a static text or a variable. By default, there is an attribute for the
Process output file name.

You must manually add any other attributes. The order in which the attributes
are listed is important since StreamServer outputs the attributes in this order.
You can enter the attribute name <idxcodepage> and the appropriate code page
as attribute value to specify a code page for the index file. The attribute name
must include the < and> characters.
7.12 HTTP connectors

7.12.1 HTTP(S) input connector
The HTTP and HTTPS connectors enable StreamServer to act as an HTTP server.
Comments
• An HTTP(S) connector must have an input queue.
• You can use the custom startup argument -startallinconnectors to start
connectors that are not connected to any Event.
Settings
• Security configuration
The security configuration to add to the HTTPS connector. See “About
encryption and authentication“ on page 711for more information about security
configurations. The security configuration must be included in a resource set
connected to the Platform.
• Version
The HTTP version to use. Auto means the version is determined by the client.
• SSL version
The SSL version to use with the HTTPS connector. The server and the clients
must use the same SSL version.
• Reprocess type
The output channel for the reprocess service.
• Address
An alternative network address for the StreamServer application, for example the
IP address to a specific network card. You can leave this empty if you want to
use the default network address for the workstation.
• Port
The port the connector listens to for HTTP requests. If the Project contains several
HTTP(S) connectors, you must select a unique port for each connector. Instead of
using several HTTP(S) connectors, you can use one HTTP(S) input connector and
different URIs to other types of input connectors. See “HTTP Realms tab”
on page 171.
• Maximum concurrent requests

7.12. HTTP connectors
The maximum number of concurrent connections. When all connections are

busy, and a new client tries to connect to the StreamServer application, the
connection may fail. Increasing the number can decrease performance.
• Idle time-out
A time-out (milliseconds) applied when StreamServer has finished processing a
request, and no more data related to the request will be received or sent. This
time-out sets the maximum time the connection will remain open, and enables
the client to send a new request without having to set up a new connection.
• Time-out
A time-out (milliseconds) applied when StreamServer sends or receives data. If
no data is sent or received during the time specified (dead connection), the
connection will be closed.
• Response time-out
The maximum time (milliseconds) the client is expected to wait for a response.
This time-out starts ticking as soon as StreamServer has received all data from
the client. The size of the time-out depends on whether the client needs to wait
for StreamServer to process the job:
• If the client expects StreamServer output in the response, this time-out must
be large enough to cover the processing by, and delivery from, StreamServer.
• If the client does not expect any StreamServer output in the response, you can
set this time-out to 0 to immediately return 200 OK after all data is received
from the client.
The response-timeout can also be set by the client using an HTTP header field. To
enable this, you must add the custom HTTPResponseTimeOut command (see
“Custom HTTP(S) connector settings” on page 172) to the Logical connector
access point. For example, if the client uses the header field x-timeout to set the
response time-out, you can use the following HTTPResponseTimeOut command
to enable the client to set the time-out:
HTTPResponseTimeOut "x-timeout" "" "" END;
Note: This will override the Response time-out set on the HTTP(S) input
connector.
When processing a job, StreamServer will not check if the connection to the client
is still open. A response time-out triggered by the client or StreamServer is not
regarded as an error and will not stop StreamServer from processing the job.
• Authentication
The type of authentication scheme (RFC 2617 (http://www.ietf.org/rfc/
rfc2617.txt)) to use for password authentication. The authentication scheme you
specify here applies to all HTTP realms you specify for the HTTP(S) connector.
See “HTTP Realms tab” on page 171.
• None - Do not use authentication.

• Basic - Send authentication parameters as clear text. This is the only scheme
supported in HTTP/1.0.
• Digest - Send authentication parameters as a checksum over the network.
Requires HTTP/1.1.
• Publish directory
The root directory for stored files. If you want to enable clients to access stored
files via HTTP(S), you must specify a publish directory.
• Publish extension file
A file that associates file formats and content-types (RFC 2045 (http://
www.ietf.org/rfc/rfc2045.txt)). Applies to files in the Publish directory.
StreamServer accepts html, htm, gif, jpg, txt, zip by default. To use other
formats, you must specify a publish extension file.
File syntax:
Target ContentType CustomHeader
Where Target is the format to associate with a content type, ContentType is the
content type, and CustomHeader is an optional custom header (Name:Value).
Example 7-15: Publish extension file

.pdf application/pdf
/qwerty.tbl text/plain
Line 1 associates all *.pdf files with content type
application/pdf.
Line 2 associates the file qwerty.tbl with content type
text/plain.
• Job resource URI

Not applicable.
7.12.1.1 HTTP Access tab

On this tab you specify the HTTP connector and URI to access the connector. See
“HTTP Access tab” on page 295 for more information about HTTP Access.
• HTTP connector
Select this connector from the drop-down list.
• URI
Specify the URI to access the connector.

7.12.1.2 HTTP Realms tab

On the HTTP Realms tab you can specify several realms for the HTTP(S) connector.
A realm is defined by one or more URIs. To access a realm, clients must provide a
valid user name and password. All these user names and passwords are specified in
a password file. Click Add or Edit to specify the settings for each realm.
• Name
The name of the realm.
• URI(S)
The URI or URIs for the realm. Multiple URIs are separated by comma.
Example 7-16: Password protecting parts of the publish directory

(single URI)
Enter /Sales to protect the folder Sales and all its sub-folders.
Example 7-17: Password protecting parts of the publish directory

(multiple URIs)
Enter /Sales/Secret,/Sales/TopSecret to protect the folders Secret
and TopSecret, including all sub-folders.
Example 7-18: Password protecting connectors - 1

Enter /Alba to protect a connector with HTTP access via the URI /Alba.

Example 7-19: Password protecting connectors - 2

Enter /Alba to protect two connectors with HTTP access via the URIs /
Alba/Service and /Alba/Core.
• Password file
The password file resource that contains the user names and corresponding
passwords. The password file has the following syntax:
user_name [tab] password
Use ASCII and do not include blank spaces.
7.12.1.3 Custom HTTP(S) connector settings

You can add custom keywords to HTTP and HTTPS connectors. See “Using custom
commands and keywords” on page 65 for more information about how to add
custom commands and keywords.
HTTPExtJobIdField “ID_name”;
Retrieves the external ID from an application that sends input to StreamServer.
The application that sends the input must include the external ID as HTTP
header information (ID_name:ID_value).
HTTPMaxContentLength limit;
Limits the size (in bytes) of the body in an HTTP request. If a request contains a
body that exceeds this limit, an error response will be returned.
HTTPResponseTimeOut “timeout” “path” “custom” END;
Specifies custom response time-out options.
timeout
A time-out set by the client to override the response time-out. For example,
the client header field "x-timeout:60000" sets the response time-out to one

minute. To enable the client to set the response time-out, you can enter
Leave the timeout argument empty if you do not want to allow clients to
set the response time-out.
path
A time-out set by the client to override the response time-out. For example,
the client header field "x-timeout:60000" sets the response time-out to one
minute. To enable the client to set the response time-out, you can enter
Leave the timeout argument empty if you do not want to allow clients to
set the response time-out.
custom
Custom fields (name:value) added to the response header. For example:
HTTPResponseTimeOut "" "timeout.txt" "content-type:text/

plain" END;
You can separate several name:value pairs with <0d><0a>.
7.12.2 HTTP(S) Poll input connector

The HTTP Poll and HTTPS Poll connectors enable StreamServer to function as an
HTTP client that polls an HTTP server.
Comments
• You can use the custom startup argument -startallinconnectors to start
connectors that are not connected to any Event.
Settings
The security configuration to add to the HTTPS Poll connector. See “About
encryption and authentication“ on page 711 for more information about security
configurations. The security configuration must be included in a resource set
connected to the Platform.
• HTTP method
The method to use when polling the HTTP server.
• HEAD – Requests a HEAD header from the HTTP server. If the Last-
Modified entity-header field has changed, StreamServer will fetch and
process the data. If there is no Last-Modified field in the header, the
connector will switch to the GET method instead. If the Last-Modified field
is not updated correctly this method will fail.
• GET – Downloads the data once during each poll interval, and calculates a
checksum to see if the data has been updated. StreamServer will process the
data only if the checksum has changed.

• POST – Posts a file to the HTTP server, downloads the response and
calculates a checksum. StreamServer will process the data only if the
checksum has changed.
• URL
The URL to the HTTP server.
• Content-type
This property depends on the HTTP method:
• POST – The content type of the posted file.
• HEAD and GET – The media types the client accepts in the response. For
example text/*, text/xml, text/xml;level=1, */*. All formats will be
accepted if this field is empty.
• Post file name
The file to post when using HTTP method POST. The file must be included in a
resource set connected to the Platform.
• HTTP time-out
The maximum time (milliseconds) to wait before aborting a transfer.
• HTTP version
The HTTP version to use.
• SSL version
The SSL version to use with the HTTPS Poll connector. The server and the clients
must use the same SSL version.
• HTTP authentication
rfc2617.txt)) to use for password authentication.
Requires HTTP/1.1.
• HTTP realm
The name of the realm to access. Used only if authentication is required.
• User name
A user name to access the realm. Used only if authentication is required.
• Password
A password to access the realm. Used only if authentication is required.
• Cache file

The cache file that stores communication checksums between StreamServer start/
stop.
• Schedule
often to poll the HTTP server. See “Scheduling” on page 66 for more information
about scheduling.
• Time-out
7.12.3 HTTP(S) Submit output connector

The HTTP Submit and HTTPS Submit connectors enable StreamServer to function as
an HTTP client submitting output to an HTTP server.
Settings
• Use security configuration
Select whether to use a security configuration or a CA certificate for the HTTPS
Submit connector. If the HTTPS server requires client authentication, you must
use a security configuration. If the HTTPS server does not require client
authentication, you can use a CA certificate instead.
• CA certificate
The CA root certificate that confirms the identity of the SSL server. See “About
encryption and authentication“ on page 711 for more information about security
configurations. The certificate must be included in a resource set connected to the
Platform.
PEM encoded x 509 certificates are supported.
The Security configuration to use with the HTTPS Submit connector. See “About
encryption and authentication“ on page 711 for more information. The security
configuration must be included in a resource set connected to the Platform.
• Method
The method to use when submitting output to the HTTP server.
• POST – Send output to the HTTP server for further processing.
• PUT – Send output to the HTTP server. For example, if output is a web page,
select PUT to put it on a web server. Requires scripting and specific access
rights to the server.
• URL

The URL to the HTTP server.

• Content-type
The content-type of the output to send to the HTTP server. For example:
text/html; charset="ascii"
• Time-out
The maximum time (milliseconds) StreamServer waits before cancelling a
transfer.
• Version
The HTTP version to use.
• SSL version
The SSL version to use with the HTTPS Submit connector. The server and the
clients must use the same SSL version.
• Authentication
rfc2617.txt)) to use for password authentication.
Requires HTTP/1.1.
• Realm
The name of the realm to access. Used only if authentication is required.
• User name
A user name to access the realm. Used only if authentication is required.
• Password
A password to access the realm. Used only if authentication is required.
• Cache file
The cache file that stores communication checksums between StreamServer start/
stop.
Runtime settings
• Custom header
A custom header to add to the output. Use the following syntax:
Name:Value
You can separate Name:Value pairs with <0d><0a>.

• Response place connector

The name of the connector that receives the response from the HTTP server.
Used only if a response is required. This connector is either an HTTP Response
output connector, or any type of queue enabled input connector.
Example 7-20: Using an HTTP Response connector as Response

place connector
1. A client sends input to StreamServer via an HTTP input connector.

2. StreamServer processes the data.
3. The processed data is sent via an HTTP Submit connector to an HTTP
server.
4. The HTTP Response connector collects the response from the HTTP
server.
5. The HTTP connector retrieves the response from the HTTP Response
connector, and sends it to the client.
Example 7-21: Using an input connector as Response place

connector

3. The processed data is sent via an HTTP Submit connector to an HTTP
server.
4. The input connector collects the response from the HTTP server.
5. The response data is queued as a separate job.
• Response custom header

A custom header to add to the response from the HTTP server. Use the following
syntax:
Name:Value
• On failure file
The path to a file to be used if output cannot be delivered to the HTTP server.
• On failure place connector
The connector that retrieves the On failure file specified above. This connector is
either an HTTP Response output connector, or any type of queue enabled input
connector. For example, if StreamServer receives input from a client, and sends
output to an HTTP server, an error message (the on failure file) can be sent back
to the client via an HTTP Response connector.
Example 7-22: Using an HTTP Response connector as On failure

place connector

3. StreamServer tries, but fails, to send the processed data via an HTTP
Submit connector to an HTTP server.
4. The HTTP Response connector collects the On failure file.
5. The HTTP connector retrieves the On failure file from the HTTP
Response connector, and sends it to the client.
Example 7-23: Using an input connector as On failure place

connector


3. StreamServer tries, but fails, to send the processed data via an HTTP
Submit connector to an HTTP server.
4. The input connector collects the On failure file.
5. The On failure file is queued as a separate job.
• On failure content-type
The content type of the On failure file. For example:
• On failure custom header
A custom header to add to the response with the On failure file. Use the
following syntax:
Name:Value
7.12.4 HTTP Response output connector

This connector enables StreamServer to respond to HTTP requests.
Settings
• Content-type
The content-type of the response. For example:
Runtime settings
• Custom header
A custom header to add to the output. Use the following syntax:
Name:Value
You can separate Name:Value pairs with <0d><0a>.

7.12.5 HTTP connector scenarios

Responding with processed data via an HTTP Response
connector
The HTTP(S) connector enables StreamServer to act as an HTTP server that receives
and processes input from an HTTP client. You can configure StreamServer to
automatically return processed output to the client. In most cases you will use an
HTTP Response output connector to handle the response.
3. The processed data is sent back to the client via the HTTP Response and HTTP
connectors.
Configuring the HTTP Response connector

On the HTTP Response connector, you must specify which driver to use, and
corresponding content-type (RFC 2045 (http://www.ietf.org/rfc/rfc2045.txt)) for
the response. You can do this in the Platform or in the Runtime configuration.
7.13 Internal connectors

The “Internal input connector” enables StreamServer to transfer data internally and
the “Internal output connector” enables StreamServer to loop back output to an
Internal input connector for further processing.
Internal input connector

This connector enables StreamServer to transfer data internally. For example to loop
back output via an Internal output connector for further processing, or to pick up
input received via an HTTP input connector. This connector has no settings.
Note: If you loop back output via an Internal output connector, you must use
the UTF-8 code page for both connectors.
Internal output connector

This connector enables StreamServer to loop back output to an Internal input
connector for further processing.

7.14. JDBC connectors
Notes
• Data sent from the Internal output connector must not contain any
formatting information.
• You must use the UTF-8 code page for both the Internal input and output
connectors.
• An Internal output connector always runs in output mode Job.
Settings
• Destination (input connector name)

The Internal input connector to loop back the output to.
7.14 JDBC connectors

The JDBC input and output connectors provide a read-write interface for relational
databases. The “JDBC input connector” is used to retrieve information from the
database, and the “JDBC output connector” is used to insert or update information
in the database.
In the configuration of the JDBC input and output connector you specify the
appropriate JDBC driver and Connection URL settings to connect to the database,
and the SQL query to execute on the selected database.
Prerequisites
• The following environment variable must be set:
STRS_JAVA_HOME="C:\Program Files\Java\jre1.5.0_14"
• The appropriate JDBC driver must be available to connect to the database.
JDBC drivers included in the Communications Center installation
The following JDBC drivers are included in the Communications Center installation:
• JDBC-ODBC bridge
• DataDirect SQL Server driver
• DataDirect Oracle driver
• DataDirect DB2 driver
Downloading JDBC drivers

You can also download java packages with other drivers, and set the classpath
to the downloaded *.jar file. You use the argument “-java-user-class-path” in
the Configure Platform Export dialog box (Administrator Arguments) to set the
classpath.

7.14.1 JDBC input connector

The JDBC input connector retrieves data from relational databases. In the connector
configuration you specify the appropriate JDBC driver and Connection URL settings
to connect to the database, and the SQL query to execute on the selected database.
The SQL query is executed at a time interval (Polling interval) specified in the
connector settings. This means the JDBC input connector uses the same time interval
when retrieving data from the database.
Comments
• This connector must be used together with a MessageIN Event.
• The MessageIN Event must use an SXD file with one field element for each
column in the database table stated in the SQL query.
Settings
• Connector type
Select Java.
• Java class
Select JDBCInConnector. When you click the button attached to this field, all
available Java input connector classes are displayed. To activate the JDBC input
connector settings you must select the java class JDBCInConnector.
• JDBC driver
The JDBC driver to use to connect to the database. You can select the following
drivers from the drop-down list:
sun.jdbc.odbc.JdbcOdbcDriver
com.streamserve.www.jdbc.sqlserver.SQLServerDriver
com.streamserve.www.jdbc.oracle.OracleDriver
com.streamserve.www.jdbc.db2.DB2Driver
If you are using other drivers than the above, you can enter the corresponding
driver expression in this field.
• Connection URL
The connection URL to connect to the database. You can select and edit the
following Connection URLs from the drop-down list:

Option - jdbc:odbc:DB
Example - jdbc:odbc:myDatabase
Option - jdbc:streamserve:sqlserver://
server[:port];databaseName=DB
Example - jdbc:streamserve:sqlserver://localhost:1433;
databaseName=myDatabase
Option - jdbc:streamserve:oracle://server[:port];SID=DB
Example - jdbc:streamserve:oracle://localhost:1433;
SID=myDatabase
Option - jdbc:streamserve:db2://server[:port];DatabaseName=DB
Example - jdbc:streamserve:db2://localhost:50000;
DatabaseName=myDatabase
Connection URL in this field.
• User name
A user name to access the database. Overrides any other user names specified in
the Connection URL.
• Password
A password to access the database. Overrides any other passwords specified in
the Connection URL.
• SQL file
You can create an SQL file where you enter the query to submit to the database.
This query overrides any query specified in the SQL command field described
below.
If you use the SQL file option to specify the query, you can create more complex
queries using several lines of statements.
Example 7-24: Query in SQL file
SELECT *
FROM CustomerData
WHERE CustNo>200
• SQL command
You can enter a one-line query in the SQL command field.

Example 7-25: Query in SQL command
SELECT * FROM CustomerData WHERE CustNo>200
• Event name
The name of the MessageIN Event that retrieves the data via this input
connector.
• Mode
Specifies what to do with each table row in the database table after it is read.
• Move (with delete)

Delete the table row after it is read.
• Copy (no delete)
Do not delete the table row after it is read.
• Row level
Specifies how to handle each table row retrieved from the database table when
delivering data to the MessageIN Event.
• Objects as blocks
Each row is added as a block instance to the MessageIN Event.
Using this option, the input job starts when the first row is retrieved and ends
when the last row is retrieved. All rows are added as block instances to the
same MessageIN Event.
• Objects as events
Each row triggers a new MessageIN Event.
Using this option, the input job also starts when the first row is retrieved and
ends when the last row is retrieved. Each row triggers a new MessageIN
Event.
• Objects as jobs
Each row starts a new input job.
Using this option, each row represents a separate input job and triggers a new
MessageIN Event.
• Create SXD
Used when creating an SXD file. Enter the path to the SXD file to create, for
example:
C:\resources\SXD\JDBCretrieve.sxd
See “Creating an SXD file” on page 185 for more information.

• License Password

Password for the JDBC driver (if required). If you are using any of the DataDirect
JDBC drivers included in the Communications Center installation you should
leave this field blank.
• Time-out
• Polling interval
The interval at which the SQL query is submitted to the database, and at which
this connector retrieves data from the same database.
7.14.1.1 Creating an SXD file

The MessageIN Event that retrieves data via the JDBC input connector must use the
appropriate SXD file to be able to handle the data. This SXD file must include one
field element for each column in the database table from which data is retrieved.
You can let the JDBC input connector retrieve the table information, and create this
SXD file for you. You can create a separate Project for this purpose. This Project must
contain a JDBC input connector, a MessageIN Event, and any Process and output
connector.
When you run the Project, the SXD file is created in the path you specify in the
connector settings. You must then import the SXD file to the appropriate resource
set, and connect it to the MessageIN Event in the real Project.
JDBC input connector configuration
When you configure the connector to create an SXD file, you must specify the
connection settings (JDBC driver, Connection URL, User name, and Password) to
connect to the database with the table from which to retrieve the information. You
can use the same connection settings as in the real Project, but if you need to you can
connect to another database that contains a table with identical columns as the one
you will use in the real Project.
To create the SXD file, you must also specify the following:
• SQL file or SQL command

The SQL query must select all columns in the database table. For example, to
select all columns in the table CustomerData you can use the following SQL
command:
SELECT * FROM CustomerData

• Event name
The same Event name as in the real Project.

• Mode
Select Copy (no delete). This will make sure no data is removed from the
database table.
• Row level
The same row level as in the real Project.
The row level affects the output in the SXD file. For example, if you select row
level Output as blocks, block elements will be included in the SXD file.
• Create SXD
The path to the SXD file.
MessageIN Event configuration

The name of the MessageIN Event must be the same as Event name specified in
the JDBC input connector. Since the Event does not use any SXD file in this case,
you must specify a pattern for the Event (open the Event tool and enter the
Pattern). For example, if Event name is CustomerData you can also use
CustomerData as Pattern.
7.14.2 JDBC output connector

The JDBC output connector is used to insert or update data in relational databases.
In the connector configuration you specify the appropriate JDBC driver and
Connection URL settings to connect to the database, and the SQL query to execute
on the selected database.
XMLOUT Process
The output sent via the JDBC output connector is configured using an XMLOUT
Process. The XML structure is shown in the example below.
<?xml version="1.0"?>
<document>
<job>
<event>
<block>
<field name="column_1">value_1</field>
<field name="column_2">value_2</field>
....
<field name="column_N">value_N</field>
</block>
</event>
</job>
</document>
• The <event> element contains all the rows to be added to the database table.
• Each row in the database table is represented by a <block> element.
• Each column in a table row is represented by a <field> element.

• The name attribute represents the column (column_1, column_2, etc.). The
attribute value must be the same as the column name in the database.
• The field value represents the value to add to the corresponding column
(value_1, value_2, etc.). The field value is retrieved from a field or variable
defined in the Event.
JDBC output connector settings

• Connector type
Select Java.
• Java class
Select JDBCOutConnector. When you click the button attached to this field, all
available Java output connector classes are displayed. To activate the JDBC
output connector settings you must select the java class JDBCOutConnector.
• JDBC driver
The JDBC driver to use to connect to the database. You can select the following
drivers from the drop-down list:
sun.jdbc.odbc.JdbcOdbcDriver
com.streamserve.www.jdbc.sqlserver.SQLServerDriver
com.streamserve.www.jdbc.oracle.OracleDriver
com.streamserve.www.jdbc.db2.DB2Driver
driver expression in this field.
• Connection URL
The connection URL to connect to the database. You can select and edit the
following Connection URLs from the drop-down list:
Option - jdbc:odbc:DB
Example - jdbc:odbc:myDatabase
Option - jdbc:streamserve:sqlserver://
server[:port];databaseName=DB
Example - jdbc:streamserve:sqlserver://localhost:1433;
databaseName=myDatabase


Option - jdbc:streamserve:oracle://server[:port];SID=DB
Example - jdbc:streamserve:oracle://localhost:1433;
SID=myDatabase
Option - jdbc:streamserve:db2://server[:port];DatabaseName=DB
Example - jdbc:streamserve:db2://localhost:50000;
DatabaseName=myDatabase
Connection URL in this field.
• User name
A user name to access the database. Overrides any other user names specified in
the Connection URL.
• Password
A password to access the database. Overrides any other passwords specified in
the Connection URL.
• SQL file
You can create an SQL file where you enter the query to submit to the database.
This query overrides any query specified in the SQL command field described
below.
If you use the SQL file option to specify the query, you can create more complex
queries using several lines of statements.
Example 7-26: Query in SQL file
INSERT INTO myTable *
• SQL command
You can enter a one-line query in the SQL command field.
Example 7-27: Query in SQL command
INSERT INTO myTable *
• License Password
Password for the JDBC driver (if required). If you are using any of the DataDirect
JDBC drivers included in the Communications Center installation you should
leave this field blank.

7.15. JMS connectors
7.15 JMS connectors

The Java Messaging Service (JMS) input and output connectors are used for
transferring data via any JMS provider by using the standardized JMS interfaces.
The JMS environment

The connectors uses the JMS API. Since this is only an interface, you need to add
the jar library files to the StreamServer classpath. See the documentation from
your JMS provider for information about where to find the jar files.
7.15.1 Concepts
7.15.1.1 Queues an topics
Queues
A message that is put on a message queue always has one receiver only. If there
are more than one application listening to the same queue, still only one of them
will receive the message.
Topics
Topics works with publish/subscribe semantics. There can be many publishing
applications that publishes messages for a topic and there can be many
subscribing applications that all will receive the same message.
7.15.1.2 JNDI Settings

JMS uses Java Naming and Directory Interface (JNDI) for configuration. When you
configure JMS connectors, you specify how to connect to your JNDI directory and
which named objects to use. The rest of the configuration is done in your JNDI
directory.
There are two connector settings that are used to specify how to connect to your
JNDI provider:
• java.naming.factory.initial – Specifies the JNDI provider class to use.
• java.naming.provider.url – Specifies where to find the JNDI directory.
If your JNDI provider needs other initial context parameters you can specify these
parameters as additional java system properties when starting java.

7.15.1.3 Message formats

The JMS connectors support the following message formats:
• Binary messages. The content is not altered by transmission. The sequence of
bytes that are sent are received in the same way at the other end. There is no
encoding connected to the message.
• Text messages. The content is treated as text and is automatically converted by
JMS if the message passes between two environments where the text encoding is
not the same. For example, a message sent from Windows can be read on a Main
Frame computer with native methods.
Binary messages are slightly more efficient since no transformation is involved.
Input connectors automatically read both binary and text messages and writes the
data to the input queue.
Output connectors must to be configured to either send data as text or as binary

data. It is possible to send text data in a binary message, but in that case the JMS
provider will not transform the data. It is however not possible to send binary data
in a text message without corrupting the information.
7.15.1.4 Metadata from input connectors

You can use the script function GetConnectorValue to fetch metadata attributes.
7.15.1.5 Header properties

If there are header properties of an incoming message, the header properties are
stored as metadata values with the same name. All header values are converted to
string values using standard java conversion before they are stored as metadata.
7.15.1.6 Message properties

A JMS message contains pre-defined properties. Some of these attributes can be
accessed through metadata attributes according to the table below.
x-streamserve.com-jms-correlation-id
The correlation identifier of the message to be retrieved. Either provider-specific
message IDs or application-specific String values.
x-streamserve.com-jms-message-id
Value that uniquely identifies each message sent by a provider.
x-streamserve.com-jms-priority
The message priority level.
The JMS API defines ten levels of priority value, with 0 as the lowest priority
and 9 as the highest. In addition, clients should consider priorities 0-4 as
gradations of normal priority and priorities 5-9 as gradations of accelerated
priority.

x-streamserve.com-jms-reply-to
The name of the destination to which a reply should be sent.
x-streamserve.com-jms-timestamp
The time a message was handed off to a provider to be sent. It is not the time the
message was actually transmitted, because the actual send may occur later due
to transactions or other client-side queueing of messages.
7.15.1.7 Durable subscriptions

The JMS API allows clients to create durable subscriptions. Durable subscriptions
can receive messages sent while the subscribers are not active. Durable subscriptions
provide the flexibility and reliability of queues but still allow clients to send
messages to many recipients. To enable this, subscribers need to register themselves
with a unique durable subscriber name.
Note: A durable subscription can have only one active subscriber at a time.
7.15.1.8 Connection factory

A connection factory is an object that a JMS client uses to create a connection with a
JMS provider. Connection factories are stored in a JNDI namespace, which is a
defined location within the naming and directory service. The initial context defines
the root of the JNDI namespace.
7.15.2 Connector reference

7.15.2.1 JMS Queue Receiver input connector
This connector enables StreamServer to receive messages from a named queue in a
point-to-point messaging system.
Connector settings
• java.naming.factory.initial
Specifies the JNDI provider class to use. See “JNDI Settings” on page 189. You
can use the drop-down list to select a provider (see below) or type in the full
JNDI class name if you want to use another provider.
• File system JNDI (Sun)
File based JNDI directory provided by Sun. Full JNDI class name:
com.sun.jndi.fscontext.RefFSContextFactory
• LDAP (Sun)
LDAP based JNDI directory. Full JNDI class name:
com.sun.jndi.ldap.LdapCtxFactory
• java.naming.provider.url

The path to the JNDI directory. See “JNDI Settings” on page 189.
• Context
The JNDI context. If you leave this empty, the initial context will be used.
It is possible to specify nested JNDI directories. To do this you use this setting to
specify the name, within the initial context of the JNDI directory, to actually use.
• Connection factory
The JNDI name of the connection factory to use. See “Connection factory”
on page 191.
• Authentication
The authentication profile (user name and password) to use to access the JMS
provider. See “Authentication profiles” on page 407.
• Queue
The JNDI name of the queue to use.
• Selector
You can use a message selector to apply filters to the received messages. A
message selector is a string that contains an expression. The syntax of the
expression is based on a subset of the SQL92 conditional expression syntax.
Example - Type = 'Invoice' OR Type = 'Order'
This message selector selects messages where Type is set to either Invoice or
Order.
often to retrieve messages. See “Scheduling” on page 66 for more information
about scheduling.
• Time-out

7.15.2.2 JMS Topic Subscriber input connector

This connector enables StreamServer to receive messages from a named topic in a
publish-subscribe messaging system.
Connector settings
Specifies the JNDI provider class to use. See “JNDI Settings” on page 189.
You can use the drop-down list to select a provider (see below) or type in the full
• LDAP (Sun)
• Context
on page 191.
• Authentication
• Topic
The JNDI name of the topic to use.
• Selector
You can use a message selector to apply filters to the received messages. A
message selector is a string that contains an expression. The syntax of the
expression is based on a subset of the SQL92 conditional expression syntax.
Example - Type = 'Invoice' OR Type = 'Order'
This message selector selects messages where Type is set to either Invoice or
Order.

• Durable subscriber name

If you specify a durable subscriber name, the subscription will become durable
with the supplied name. See “Durable subscriptions” on page 191.
often to retrieve messages. See “Scheduling” on page 66 for more information
about scheduling.
• Time-out
7.15.2.3 JMS Queue Sender output connector

This connector enables StreamServer to deliver messages to a named queue in a
point-to-point messaging system.
Platform settings
• LDAP (Sun)
• Context
on page 191.

• Authentication
• Queue
The JNDI name of the queue to use.
• Send as text
Select whether to send messages as text (True) or in binary format (False). See
“Message formats” on page 190.
Runtime settings
Queue
See platform settings above.
Custom Properties
Custom message properties. Custom message properties can be used for
selecting messages, or for providing information about contents or message
types.
Example - Set a custom header to "color='blue'"
Correlation Id
A correlation id for the message. Correlation IDs can be used to link one
message to another, for example to link a response message to the
corresponding request message.
7.15.2.4 JMS Topic Publisher output connector

This connector enables StreamServer to deliver messages to a named topic in a
publish-subscribe messaging system.
Platform settings
• LDAP (Sun)

• Context
on page 191.
• Authentication
• Topic
The JNDI name of the topic to use.
• Send as text
Select whether to send messages as text (True) or in binary format (False). See
“Message formats” on page 190.
Runtime settings
Queue
See platform settings above.
Custom Properties
Custom message properties. Custom message properties can be used for
selecting messages, or for providing information about contents or message
types.
Example - Set a custom header to "color='blue'"
Correlation Id
A correlation id for the message. Correlation IDs can be used to link one
message to another, for example to link a response message to the
corresponding request message.
7.16 Job Resource output connector

Not supported.

7.17. LiveCycle output connector
7.17 LiveCycle output connector

StreamServer can use a LiveCycle output connector to invoke LiveCycle processes
that are deployed within Adobe LiveCycle ES and exposed through web services.
These web services can be used to integrate LiveCycle processes into the
StreamServer pipeline when processing documents.
Settings
• Host
The host name or IP address of the server hosting LiveCycle ES.
• Port
The port used by the LiveCycle ES server.
• Web service name
The name (case sensitive) of the service to invoke. This name must be the same as
the corresponding process created in LiveCycle Workbench ES.
• User name
User name to connect to the server hosting LiveCycle ES. Used in case of basic
HTTP authentication.
• Password
Password to connect to the server hosting LiveCycle ES. Used in case of basic
• Enable asynchronous communication
• Yes
Make asynchronous calls to the service. This option is used when invoking
long-lived LiveCycle services.
• No
Make synchronous calls to the service. This option is used when invoking
short-lived LiveCycle services.
• Asynchronous poll interval
Only used together with asynchronous calls. This is the interval (milliseconds)
used to check for a response to the invocation request.
• Root certificate for SSL communication
The root certificate used when HTTPS is used as web service protocol (secure
communication). The certificate must be available from a resource set connected
to the Platform.
• Custom options
A list of custom keys (key-value pairs) to include in the invocation request.

To be able to handle custom keys, the service must have a variable named
optionsMap of the type map. All custom keys defined here will be added to the
optionsMap variable in the invoked service.
The values provided can be extracted in the receiving LiveCycle process by using
an XPath expression in the LiveCycle process.
Examples of custom keys are passwords for creating password encrypted PDF
files. For example:
Key: pdfpassword
Value: encrypted
7.18 Null Connector output connector

This connector enables StreamServer to send output to a dummy connector that does
not direct output to any file or printer. There are no connector settings for this type
of connector.
7.19 OpenText Archive output connector

This connector writes output to a OpenText Archive transfer directory. It was named
LiveLink ECM in R3 in previous releases, but the connector name is now changed to
OpenText Archive.
• OpenText Archive transfer directory
The path to the OpenText Archive transfer directory.
• Meta documents
Specifies whether to enable the use of meta documents.
• Max. no of documents in meta
The maximum number of documents to be stored in each meta document
directory. When the maximum number of documents have been added, a new
document directory is created.
• Fixed directory name
• Yes – StreamServer adds all documents to the fixed directory (see Directory
Name below).
• No – StreamServer generates unique directories, with a maximum of 1000
documents in each directory.
Runtime settings
• IXATTR file lines
The lines to add to the IXATTR control file.
• Commands file lines
The lines to add to the Commands control file.

7.20. Pipe connectors
• Autodetect document type

Select to let the document type for the output be set by the driver being used.
• Document type
Specify the document type manually.
• Autodetect file extension
Select to let the file extension for the output be set by the document type
specified.
• File extension
Specify the file extension manually.
• Directory name
The name of the fixed directory.
• Component name
The name to be inserted in the Commands file.
7.20 Pipe connectors

The “Named Pipe input connector” is used for retrieving input from a named pipe,
and the “Pipe output connector” (UNIX only) is used for sending output to a named
pipe.
Named Pipe input connector

This connector retrieves input from a named pipe.
• Named Pipe
The named pipe.
• Schedule
often to try to retrieve data. See “Scheduling” on page 66 for more information
about scheduling.
• Time-out
Pipe output connector

This connector sends output to a named pipe (UNIX only).
• Pipe

The command to execute.
Example 7-28: Pipe

cat
7.21 Resource output connector

The Resource output connector stores output as resources in the repository. The
stored resources can be accessed from, for example, Template Engine, SMTP (MIME)
connector and MIMEAddPart script function.
For example, a StoryTeller document can be stored as a resource via a Resource

output connector, and this resource can then be wrapped into the output from a
Template Engine Process.
Platform settings
• Resource name
The name of the resource. This name, or the GUID of the resource, can later be
used to access the resource.
• Content type
The content type of the resource.
• Expire by time
Specifies whether to set an expiry time for the resource.
Yes – Use Duration and Time unit below to specify for how long to store the
resource in the repository.
No – Do not set an expiry time for the resource.
• Duration
The number of <Time units> to store the resource.
• Time unit
The time unit for the Duration.
Runtime settings
• Resource name
See Platform settings above.
• Content type
Resource connector and Resource filter

You can use a Resource output connector or a Resource filter (see “Resource
output connector” on page 200) to store output as resources in the repository.

7.22. Service Call output connector
For example, you can use the connector if you only want to store the output as
resources, and use the filter if you want to deliver output via a standard output
connector and driver (e.g. a File connector and PDF driver) and at the same time
store the output as resources.
Accessing stored resources

A resource stored in the repository can be accessed by referencing the GUID or
name of the resource. The following types of URIs can be used to access a
resource:
resource://guid=<GUID>
resource://name=<Name>
resource:/?guid=<GUID>
resource:/?id=<GUID>
resource:/?name=<Name>
resource:/v1/resources/<GUID>
resource:/v1/resources?name=<Name>
For example, Template Engine can use the #include directive to include the
resource in the output:
#include('resource://name=my_text')
7.22 Service Call output connector

The Service Call output connector can be used to send IDoc data to a SAP system or
to send output to other StreamServer applications.
Sending IDoc data to a SAP system

In the SAP IDoc inbound - Communications Center IDoc outbound scenario, a
StreamServer application receives data from any data source, and processes the
data as an XMLOUT Process. The Service Call output connector stores the XML
in the repository, where the IDoc Client picks it up for converting and sending
to SAP.
For more information about using the Service Call output connector in the
Business Processes solution, see OpenText Document Presentment for SAP
Solutions - Connect for SAP Customization Guide (CCMSAPC-CGD).
Sending output to other StreamServer applications

The Service Call output connector can send output to StreamServer applications
exposed as services via Service Request input connectors (see “Service Request
input connector” on page 204). Depending on how you configure the Service
Call connector, the receiver can return the status of the job and the output from
the job.

7.22.1 Service Call connector settings

• Service Type
• General – select to send data to another StreamServer application.
• IDocClient – select to send IDoc data to SAP.
• Service name
If Service Type = General
The service name of the receiving Service Request input connector.
If Service Type = IDocClient
The Service name specified on the IDoc Client in the RFC Gateway. On the IDoc
client, the Service name setting is found under the StreamServe Connection
settings.
• Timeout
Timeout can be set to -1, 0 or a value >0 milliseconds. How it affects the Service
Call connector depends on the Append and Response place connector settings.
• Timeout = -1
Append and Response place connector not enabled
Wait "forever" for the response from the receiver before marking the output
job as successful or failed. The response includes the status of the job
processed by the receiver (successful or failed).
Append enabled
Timeout is ignored.
Response place connector enabled
Wait "forever" for the response from the receiver before marking the output
job as successful or failed. The response includes output from the receiver and
the status of the job processed by the receiver (successful or failed).
• Timeout = 0
Do not wait for a response from the receiver. The output job is marked as
successful when it is successfully delivered to the input queue of the receiver.
Append enabled
Timeout is ignored.
Timeout must be either -1 or>0 if Response place connector is enabled.
• Timeout> 0

7.22. Service Call output connector
Wait the specified time (milliseconds) for the response from the receiver
before marking the output job as successful or failed. The response includes
the status of the job processed by the receiver (successful or failed).
If the status is not returned within the time specified, an error is reported and
the output job is marked as failed.
Append enabled
Timeout is ignored.
Wait the specified time (milliseconds) for the response from the receiver
before marking the output job as successful or failed. The response includes
output from the receiver and the status of the job processed by the receiver
(successful or failed).
If the status is not returned within the time specified, an error is reported and
the output job is marked as failed.
• Service version
The version of the service (StreamServer application) to call. If you leave this
empty, the latest version of the service is called.
• Append
Select to append the output job to the top job. This enables StreamServer
applications to receive the result produced by chained StreamServer
applications. See Example 7-29, “Using Append” on page 204.
Note: Append is ignored if a “Response place connector” is specified.
Runtime connector settings

• Service Type
See “Service Type” in Platform connector settings above.
• Service name
See “Service name” in Platform connector settings above.
• Timeout
See “Timeout” in Platform connector settings above.
• Service version
See “Service version” in Platform connector settings above.
• Append
See “Append” in Platform connector settings above.
• Response place connector
The name of an input connector. The response to the service call is passed on to
this connector for further processing.

Note: OpenText recommends you to use separate input queues for the
Response place connector and the input connector for the original input job
if queues are used on both connectors.
Example 7-29: Using Append
This example includes three StreamServer applications:

• ST1 with a Service Call connector. Append is disabled.
• ST2 with a Service Request input connector and a Service Call output
connector. Append is enabled.
• ST3 with a Service Request input connector and a File output connector.
"Include result in service response" is enabled on the File connector.
ST1 sends output to ST2. ST2 processes the ST1 input and delivers new
output to ST3. ST3 processes the ST2 input and returns the result in the
response to ST1.
7.23 Service Request input connector

This connector exposes the StreamServer application as a web service to the client,
and is used in the following scenarios:
• To retrieve output from other StreamServer applications via Service Call output
connectors or Service Call filters.
• To retrieve input from Adobe LiveCycle ES processes.
• To retrieve IDoc data from SAP.
• To retrieve data from SAP over the XOM interface.
• To receive the following types of notifications from Vista Plus Output Manager:
• Job status notifications from that trigger custom actions, such as sending
emails or updating SAP Delivery Manager. For information about using the
connector in this type of scenario, see “Configuration steps to set up job
tracking” on page 239.
• Device status notifications. For information about using the connector in this
type of scenario, see “Configuration steps to set up device tracking”
on page 241.

7.23. Service Request input connector
Note: The connector must be connected to an input queue.
Adobe LiveCycle ES scenario

In an Adobe LiveCycle ES scenario, any type of document can be sent via a
Service Request connector to the StreamServer application for further
processing. LiveCycle ES invokes the StreamServer application by issuing a
service request, and delivers the input data in the request. The service name
specified on the Service Request connector is the name of the web service
LiveCycle ES must call to invoke the StreamServer application.
SAP IDoc scenario

In a SAP outbound - Communications Center inbound scenario, your SAP
system sends IDoc data to StreamServer via a Service Request input connector
(for the ALE interface).
SAP XOM scenario

If you run the Delivery Manager Server/Client level of integration, you can use
the Service Request input connector for receiving input from SAP.
Returning output in the response
If you want the StreamServer application to be able to return the output in the
response you must enable this in the Design Center Project:
1. Activate the generic Platform layer.
2. Double-click the output connector that delivers the output (must be queue
enabled). The Output Connector Settings dialog box opens.
3. Click the General icon and select Include result in service response.
4. Click OK.
Connector settings
• Request type
• Generic – select this option to receive data from another StreamServer
application, or if the client is Adobe LiveCycle ES.
• IDoc – select this option to receive IDoc data.
• XOM – select this option to receive data from the Delivery Manager Sender.
• Notification – select this option to receive notifications from an external
system, such as job or device notifications from Vista Plus Output Manager.
• Service name
The name of the service a client must call to invoke the StreamServer application
via this connector.
For information about setting up the Service name in Vista Plus Output Manager
scenarios, see the following sections:

• “Configuration steps to set up job tracking” on page 239

• “Configuration steps to set up device tracking” on page 241
7.24 SNMP trap output connector

This connector sends SNMP traps to Network Management Systems (NMS) that use
SNMP v1.
SNMP trap information

The SNMP trap can include the following type of information:
• Message – a description of the message that is sent.

• JobSource – a description of the source that triggered the message.
• Type – must be one of the following: Job, Event, Process, input
connector, output connector, or other.
• Status – must be one of the following: Started, Running, Warning, Success,
Fail, or Unknown.
StreamServe MIB
The content of the SNMP trap is defined by the StreamServe MIB (Management
Information Base) in ...\Common\Data\MIBS\StreamServe-MIB.txt.
StreamServer configuration
Configuring StreamServer to create SNMP traps includes:
• SNMP trap output connector configuration.

• “Collection configuration”.
• “Process configuration”.
Settings
• Trap destination
The IP address or hostname of the NMS.
• Trap destination IP port
The port on which the NMS receives SNMP traps.
• Community string
The password to access the NMS.
• Source description
A description of the source sending the notifications.

7.25. Spool output connector
7.24.1 Collection configuration

StreamServer creates SNMP traps based on notifications generated by the source
application (ERP system etc.). To collect and extract notifications from a source
application you must use the appropriate input connector and Event.
7.24.2 Process configuration

You can use the appropriate type of Event to collect and extract notifications, and an
XMLOUT Process to configure the output. The XMLOUT configuration must
contain the fields to include in the SNMP trap.
Example 7-30: XML structure used for sending SNMP traps
<?xml version=\"1.0\"?>
<strs-xml version="1.0">
<job>
<event name="Garlic">
<block>
<field name="Message" path="">message</field>
<field name="JobSource" path="">source</field>
<field name="Type" path="">job</field>
<field name="Status" path="">fail</field>
</block>
</event>
</job>
</strs-xml>
7.25 Spool output connector

This connector sends output to a printer.
• To
The printer to send the output to.
7.26 Standard input and Standard output connectors

The “Standard input connector” enables external applications to send data to
StreamServer via StdIn, and the “Standard output connector” enables external
applications to receive output from StreamServer via StdOut.
Standard input connector

This connector enables external applications to send data to StreamServer via StdIn.
There are no settings for this type of connector.

Standard output connector

This connector enables external applications to receive output from StreamServer via
StdOut. There are no settings for this type of connector.
7.27 StreamServe External Viewer output connector

This connector sends output to a Previewer. The Previewer reads the file extension
and opens the output file in the corresponding application (*.pdf in Acrobat
Reader, etc.). The Previewer recognizes the following formats: pdf, ps, tif, dcx,
html, xml, pcl. It tries to open other formats as *.txt.
See “Previewer“ on page 777for more information about Previewer.
Example 7-31: Previewer
You have one default Process that you connect to an output connector, and
one identical preview Process that you connect to a StreamServe External
Viewer connector. An Event script determines which Process to use:
if($var = "Preview")
callproc("PreviewProcess");
else
callproc("DefaultProcess");
Settings
• Host
The Previewer host.
• Port
The port the Previewer listens to. The default port is 9343.
7.28 TCP/IP connectors

The “TCP/IP input connector” enables external applications to sent input to
StreamServer over TCP/IP, and the “TCP/IP output connector” is used for sending
output to a TCP/IP address.
TCP/IP input connector

This connector enables external applications to send input to StreamServer over a
TCP/IP socket. You can use the custom startup argument
-startallinconnectors to start connectors that are not connected to any Event.
• Host
The StreamServer host.
• Port

7.29. TOPCALL output connector
The port number on which to receive input.
TCP/IP output connector

This connector sends output to a TCP/IP address.
• Host
The receiving host.
• Port
The port the host listens to. The default port is 9343.
7.29 TOPCALL output connector

Note: TOPCALL® is a registered trademark of TOPCALL International AG.
A Stream Serve configuration for TOPCALL includes a MailOUT Process, a Process

for page formatted output and a Topcall output connector. The page formatted
output (PDF or PCL) is attached to the MailOUT Process and sent via the Topcall
connector to the attachment directory specified in the Topcall connector settings.
TOPCALL collects the attachment from the attachment directory and sends it via fax
or email.
Output directories
TOPCALL and StreamServer use two directories to exchange information: one
directory that contains the attachments, and one directory that contains address
information. You specify these directories when you configure the Topcall
connector.
MailOUT tool
In the MailOUT tool you must specify a To and From address. You can use
dummy values.
Attaching processed output to the email
The attachment Process (e.g. StoryTeller) is connected to some kind of output

connector. The driver options (PDF or PCL) on that connector determines the format
of the attachment.
1. In the Runtime configuration view, right-click the MailOUT Process and select
Settings. The Runtime Process Settings dialog box opens.
2. On the Attach Process tab, click Add New. The Process Attachment dialog box
opens.
4. From the Select Process drop-down list, select the attachment Process and click
OK.

Topcall output connector Platform settings

• TOPCALL To Directory
The destination for address information.
• TOPCALL Attachment Directory
The destination for StreamServer output files.
Topcall output connector Runtime settings

See your TOPCALL documentation for information.
7.30 WebSphere MQ connectors

The WebSphere MQ input and output connectors are used for transferring data via
IBM WebSphere MQ messaging systems.
7.30.1 Concepts
7.30.1.1 The IBM WebSphere MQ environment
The IBM WebSphere MQ environment does not have to be on the same host as
StreamServer as long as the WebSphere MQ connector can use a server connection
channel (see “Server connection channel” on page 210) to connect to WebSphere
MQ.
7.30.1.2 Server connection channel

To enable WebSphere MQ connectors to connect to WebSphere MQ, you must make
sure there is a server connection channel in WebSphere MQ that uses TCP as
transmission protocol. If no server connection channel exists, you must create one.
See the IBM WebSphere MQ documentation for information on how to create a
server connection channel.
Direct server connection

You can use a direct server connection instead of a server connection channel in
order to shortcut the connection between a WebSphere MQ connector and
WebSphere MQ. You might gain some performance by doing so, but the
downside is that WebSphere MQ needs to be installed on the same host as
StreamServer, and WebSphere MQ must be of the same version as the java JAR
files used by the connector.

7.30. WebSphere MQ connectors
7.30.1.3 Segmented messages

A message can be segmented by WebSphere MQ if it is too large for one
transmission. The application that sends the message can also segment the message.
All WebSphere MQ input connectors aggregates segmented messages before the

messages are passed on to StreamServer. This means StreamServer will treat all
incoming messages as unsegmented regardless of the number of segments that
WebSphere MQ used while transmitting the message.
WebSphere MQ Queue output connectors may segment messages. Whether

messages are segmented depends on the data size and on how data is produced. The
receiving application at the other end of WebSphere MQ must therefore be able to
handle segmented messages.
WebSphere MQ Topic output connectors cannot segment messages. This means

there is an upper limit of the size of the messages delivered from this type of
connector. See the IBM WebSphere MQ documentation for information about the
limit that applies to your platform.
7.30.1.4 Message groups

Messages with the same IBMMQGroupId can be grouped as message groups. You can
configure how the WebSphere MQ input connectors should handle message groups
before they are sent to the input queue:
• Each individual message within a message group is treated as one job. This is the
default option.
• Message groups are aggregated into one message the same way as segmented
messages are aggregated.
If the WebSphere MQ input connector is configured to aggregate message groups, it

must wait for the last message in the group before it can start to process the input.
This in order to make sure all messages are aggregated in the correct order. This
implies that the throughput of large messages will drop compared to when each
message is treated as a separate job.
7.30.1.5 Synchronization
StreamServer uses MQGMO_SYNCPOINT to make sure the message remains in the
queue if the WebSphere MQ input connector fails to read a message. The WebSphere
MQ input connector retries to read the message until it succeeds to do so. If it
continuously fails to read the message, you must remove the message from the
queue by using WebSphere administration tools.

7.30.1.6 Message formats

The WebSphere MQ connectors support two message formats:
• Text messages
• Binary messages
WebSphere MQ input connectors read both binary messages and text messages, and
writes the data to the input queue.
WebSphere MQ output connectors need to be configured to send data as text or as

binary data. It is possible to send text data in a binary message, but the WebSphere
MQ will not transform the data. It is not possible to send binary data in a text
message without corrupting the information.
Text messages
In text messages, the content is treated as text and is automatically converted by
WebSphere MQ if the message passes between two environments where the text
encoding is not the same. For example, a message sent from a Windows
environment can be read on a Main Frame computer with native methods.
Binary messages
In binary messages, the content is not altered by transmission. The sequence of
bytes that are sent are received in the same way in the other end. There is no
encoding connected to the message. Binary messages are slightly more efficient
since no transformation is involved.
7.30.1.7 Message properties – input connectors

If there are header properties in an incoming message, these header properties are
stored as metadata values with the same name. All header values are converted to
string values by using standard java conversion before written to metadata.
The message properties in the table below affect StreamServer job data. By setting
these properties from the sender, you can change the job characteristics of the
StreamServer job.
jobName
Sets the job of the new job.
extJobId
Sets the external job id of the new job.
jobOwner
Sets the job owner of the new job.
jobPriority
Sets the job priority of the new job.

7.30.1.8 Message properties – output connectors

Messages from WebSphere MQ output connectors will contain the message
properties described in the table below (if these properties are available in the
StreamServer job).
extJobId
The external job ID.
strsJobId
The StreamServer job ID.
Custom properties
You can also set custom properties in the Custom Properties field in the runtime
configuration settings for the WebSphere MQ output connector. This means you can
assign additional message properties to the message. In this field you can add a list
of properties separated by white space. All properties you define here will be added
to the message header. The syntax is as follows:
<propertyName> = [(<propertyType>)] <Property> <whitespace> ...

• <propertyName>
Name of the property to set.
• <propertyType>
Type of the property to set. Available types are: boolean, byte, short, int, long,
string and float. Default is string.
• <Property>
Value of the property to set.
• boolean can take value true or false.
• Strings that contain whitespace or any of the characters (,),; or = must be
surrounded by single quotes.
Example 7-32: Custom properties

DocumentType=PDF Customer='The Big Company' CustomerId=12
IsInvoice=(boolean)true Counter=(long)1
This example contains the following properties:

• DocumentType is a string property and the value is PDF.
• Customer is a string property and the value is The Big Company. Since it
contains spaces, it needs to be surrounded by single quotes.
• CustomerId is a string property and the value is 12.
• IsInvoice is a boolean property and the value is true.
• Counter a long property and the value is 1.

7.30.1.9 Metadata from input connectors

You can use the script function GetConnectorValue to fetch metadata attributes.
Additional headers
In WebSphere MQ, a message can contain additional headers. If there are
additional headers, the values are stored as metadata like the message
properties, but each metadata name will be prefixed with the name of the
header.
For example, MQRFH2.Version=17, where MQRFH2 is the name of the header,
Version is the name of the property and 17 is the value.
Message metadata
Apart from the message properties, a WebSphere MQ message also has pre-defined
metadata. The properties described in the table below can be accessed through
metadata.
IBMMQApplicationIdData
Application ID data. This is part of the identity context of the message –
information defined by the application suite. It can be used to provide
additional information about the message or its originator.
IBMMQApplicationOriginData
Data about the originating application. This can be used by the application to
provide additional information about the origin of the message.
IBMMQCorrelId
Specifies the correlation identifier of the message to be retrieved. A string
containing hexadecimal numbers
IBMMQGroupId
The ID of the message group. This identifies the message group to which the
message belongs. A string containing hexadecimal numbers.
IBMMQMessageSequenceNumber
Sequence number of logical messages within a message group.
IBMMQMsgId
Specifies the message identifier of the message to be retrieved. A string
containing hexadecimal numbers.
IBMMQPriority
The message priority.
IBMMQPutDateTime
The time and date when the message was put. Uses ISO 8601 date time form
plus additional millisecond and time zone offset information.

IBMMQPutApplicationName
The name of the application that put the message.
IBMMQReplyToQ
The name of the queue to which a reply should be sent.
IBMMQReplyToQMgr
The name of the queue manager to which reply or report messages should be
sent.
IBMMQUserId
The user ID. It is part of the identity of the message and identifies which user
originated it.
7.30.1.10 Queues and topics

Messages can be transmitted via message queues, or be handled as topics using
publish/subscribe semantics.
Queues
A message put on a message queue has only one receiver. If more than one
application is listening to the same queue, only one of them can receive the message.
The following WebSphere MQ queue connectors are available:
• “WebSphere MQ Queue Receiver input connector”

• “WebSphere MQ Queue Sender output connector”
• “WebSphere MQ Reply Queue Sender output connector”
Topics
Several publishing applications can publish messages for a topic, and several
subscribing applications can receive the same message. The following WebSphere
MQ queue connectors are available:
• “WebSphere MQ Topic Subscriber input connector”

• “WebSphere MQ Topic Publisher output connector”
Replying to a received message

It is possible to make StreamServer act upon a WebSphere MQ message received
from a queue, and return a reply to the sender. To be able to send the reply to the
sending application, the following runtime properties must be defined:
• Queue - The name of the queue to post the reply.

• Remote Queue manager - The name of the queue manager that hosts the queue
above.
• Correlation id - An ID used to connect the request to the reply

If you use any of the queue sender output connectors, you must assign these
runtime properties based on information in the metadata in the incoming message.
Proceed with the following steps:
1. Create a script (preferably before the job) where you assign variables based on
the metadata from the incoming message. For example:
$correlationId=GetConnectorValue("IBMMQMsgId");
$replyToQueue=GetConnectorValue("IBMMQReplyToQ");
$replyToQueueManager=GetConnectorValue("IBMMQReplyToQMgr");
2. Assign the variables to the corresponding runtime properties (Runtime output

connector settings dialog box):
Queue: $replyToQueue
Correlation Id: $correlationId
Remote Queue manager: $replyToQueueManager
In the script you have a choice to assign either the message ID of the incoming
message as shown in the example, or to use the correlation ID of the incoming
message. You might even want to apply a formula in order to generate the
correlation ID. This can all be done in the script. See Message metadata on page 214
for available metadata values.
7.30.1.11 TCP/IP profile

You must use a TCP/IP profile (see “TCP/IP profiles” on page 404) for the
connection settings. In the connection profile you can also select to use a secure
channel.
7.30.2 Enabling WebSphere MQ V8

To enable TLS support for the WebSphere connectors, WebSphere MQ V8 must be
supported.
MQ Client jar files

To complete the WebSphere MQ V8 support you must obtain and install the
following MQ Client jar files:
• com.ibm.mq.commonservices.jar
• com.ibm.mq.headers.jar
• com.ibm.mq.jar
• com.ibm.mq.jmqi.jar
• com.ibm.mq.pcf.jar
You can obtain these files from an existing MQ server or MQ Client installation
or downloaded them from IBM. When you have the files you must install them
in the following directory:

<Installation_directory>\Platform\Core\<version>\bin\javaclasses
\core
Authentication for WebSphere MQ V8

WebSphere MQ V8 requires authentication details (user name and password) by
default. The WebSphere MQ connectors must therefore provide authentication
details when connecting to WebSphere MQ using a server connection channel.
To be able to provide authentication details you must add an Authentication
profile to the WebSphere MQ connector, and enter the appropriate user name
and password in this profile.
Making authentication optional

The Queue Manager connection authority (CONAUTH) configuration refers to an
authentication information (AUTHINFO) and has the default value SYSTEM.
DEFAULT.AUTHINFO.IDPWOS. To make authentication optional, and not required,
you can run the following command:
ALTER AUTHINFO(SYSTEM.DEFAULT.AUTHINFO.IDPWOS) AUTHTYPE(IDPWOS)

CHCKCLNT(OPTIONAL)
After you run the command above you must refresh the queue manager.
7.30.3 Enabling SSL for Java 8 and WebSphere MQ V8

Enabling SSL for Java 8
Java 8 is TLS enabled by default. To be able to use an SSL connection you must
enable SSL in the file java.security in Java runtime. The default location of
this file is:
<JAVA_HOME>\jre<version>\lib\security
To enable SSL for Java 8
1. Open java.security in an editor.
2. Comment out the lines with the following keys:
jdk.certpath.disabledAlgorithms
jdk.tls.disabledAlgorithms
jdk.tls.legacyAlgorithms
3. Save and close java.security.
Enabling SSL for WebSphere MQ V8

WebSphere MQ V8 is TLS enabled by default. To be able to use an SSL
connection you must enable SSL in the file qm.ini for the queue manager. The
default location of this file is:
<WSMQ_installation_directory>\qmgrs\<QM_Name>
You must also create the system/environment variable wsmq.ssl_cipher_suite

to be able to use SSL. The value of this variable should be the cipher suites you
prefer.

To enable SSL for WebSphere MQ V8
1. Open qm.ini in an editor and add the following lines to the SSL section:
AllowSSLV3=Y
AllowWeakCipherSpec=ALL
You can also specify a specific cipher instead of ALL. For example,
AllowWeakCipherSpec= RC4_MD5_EXPORT
2. Save and close qm.ini.
7.30.4 Connector reference

7.30.4.1 WebSphere MQ Queue Receiver input connector
This connector receives input via an IBM WebSphere MQ message queue.
• Queue manager
The queue manager that owns the message queue.
• Queue
The message queue to listen to.
• Channel
The name of the server connection channel to use to connect to WebSphere MQ.
Leave this empty if you want to use direct server connection. See “Server
connection channel” on page 210.
• TCP/IP Profile
A TCP/IP profile (see “TCP/IP profiles” on page 404) that contains the
connection settings (host and port) and secure channel settings.
Note: The recovery settings in the connection profile are not applicable to
WebSphere MQ.
An authentication profile (see “Authentication profiles” on page 407) that
contains user name and password to access WebSphere MQ. Used only if
authentication is required.
• Aggregate message groups
Select True to aggregate all messages in a message group before sending the data
to StreamServer. See “Message groups” on page 211.

7.30.4.2 WebSphere MQ Queue Sender output connector

This connector delivers output via an IBM WebSphere MQ message queue.
Platform settings
• Queue manager
• Queue
• Channel
• TCP/IP Profile
WebSphere MQ.
• Send as text
Select whether to send data as text (True) or binary (False). See “Message
formats” on page 212.
• Send properties
Select whether to send properties (see “Message properties – output connectors”
on page 213) in the message.
• Message persistence
• Queue defined
Use the message persistency specified for the message queue
• Persistent
Write the message to disk. The message will be recoverable in case of system
failure.
• Non persistent
Process the message in memory. This will improve performance at the
expense of security

• Message segmentation
Select whether to enable message segmentation (see “Segmented messages”
on page 211)
Runtime settings
• Queue manager
• Queue
• Channel
• Custom Properties
List of name-value pairs to use as message properties for the out going message.
See “Message properties – output connectors” on page 213.
• Message Id
A message identifier. Enables sending and receiving applications to correlate
messages. Maximum length is 24 characters.
• Correlation Id
The correlation Id for the outgoing message. Used when sending a reply to an
earlier received WebSphere MQ message. See “Replying to a received message”
on page 215.
• Remote Queue manager
The name of a remote queue manager. Used when sending a reply to an earlier
received WebSphere MQ message. See “Replying to a received message”
on page 215.
See Platform settings above. <Default> means use Platform settings.

7.30.4.3 WebSphere MQ Reply Queue Sender output connector

This connector replies to a message retrieved via a WebSphere MQ queue receiver
input connector.
Platform settings
• Queue manager
• Channel
• TCP/IP Profile
WebSphere MQ.
• Send as text
• Send properties
• Queue defined
Use the message persistency specified for the message queue.
• Persistent
failure.
• Non persistent
expense of security.

Select whether to enable message segmentation (see “Segmented messages”

on page 211)
Runtime settings
• Queue manager
• Queue
• Channel
• Message Id
A message identifier. Enables sending and receiving applications to correlate
messages. Maximum length is 24 characters.
• Correlation Id
The correlation Id for the outgoing message. Used when sending a reply to an
earlier received WebSphere MQ message. See “Replying to a received message”
on page 215.
• Remote Queue manager
The name of a remote queue manager. Used when sending a reply to an earlier
received WebSphere MQ message. See “Replying to a received message”
on page 215.
7.30.4.4 WebSphere MQ Topic Subscriber input connector

This connector subscribes to an IBM WebSphere MQ message topic.
• Queue manager
• Topic
The topic to listen to. You may use either character based wildcards or topic
based wildcards – but not a combination of both.
If you do not want to use the characters %, ? and * as wildcard characters, they
must be escaped by a % character.

See the WebSphere MQ manual for more information on how to use wildcards in
topic subscriptions.
• Topic object
The topic object to listen to. At least one of the settings Topic object and Topic
must contain a value. If both values are set, Topic specifies the topic relative to
the Topic object.
• Channel
• TCP/IP Profile
WebSphere MQ.
• Aggregate message groups
Select True to aggregate all messages in a message group before sending the data
to StreamServer. See “Message groups” on page 211.
• Durable subscription
Select True to make sure StreamServer will not miss any messages if it is not
running. This will increase robustness but decrease performance and requires
more storage on the server. Please note that there are differences between the
WebSphere MQ versions in how durable and non durable subscriptions are
treated.
• Subscription name
The subscription name.

7.30.4.5 WebSphere MQ Topic Publisher output connector

This connector publishes to an IBM WebSphere MQ message topic.
Platform settings
• Queue manager
• Topic
The topic to listen to. You may use either character based wildcards or topic
based wildcards – but not a combination of both.
If you do not want to use the characters %, ? and * as wildcard characters, they
must be escaped by a % character.
See the WebSphere MQ manual for more information on how to use wildcards in
topic subscriptions.
• Topic object
The topic object to listen to. At least one of the settings Topic object and Topic
must contain a value. If both values are set, Topic specifies the topic relative to
the Topic object.
• Channel
• TCP/IP Profile
WebSphere MQ.
• Send as text
• Send properties

7.31. Sending output to Vista Plus Output Manager
• Queue defined
Use the message persistency specified for the message queue.
• Persistent
failure.
• Non persistent
expense of security.
Runtime settings
• Queue manager
• Topic
• Topic object
• Channel
7.31 Sending output to Vista Plus Output Manager

You can send output from Communications Center jobs to Vista Plus Output
Manager, which is part of the OpenText Report and Output Management Suite.
Output Manager provides management and control infrastructure to ensure

delivery of Communications Center output to printers or other output devices for
both on-demand and production printing.
Some examples of the options available with the Vista Plus Output Manager
connector include:
• Specifying which device the output from Communications Center is sent to – be
it a printer, fax, email, or Vista Plus server.
• Assigning priority to output jobs.
• Linking the Communications Center output to schedules and calendars in
Output Manager, which control when printing occurs.

• Grouping output from Communications Center jobs before sending it to a device.

• Controlling the printing options for the output, such as page orientation, sorting,
and binding options.
For more information about Vista Plus Output Manager, see the documentation
available on My Support.
Tracking the status of Output Manager jobs and devices

You can track the status of Communications Center jobs sent to Output Manager
and the status of Output Manager devices. For more information see, “About
status tracking for Output Manager jobs and devices” on page 226.
7.31.1 About status tracking for Output Manager jobs and

devices
You can receive two types of status notifications from Output Manager:
• Job status notifications
• Device status notifications
Job status notifications

You can use job status notifications to find out if an Output Manager job is printed
successfully, queued, partially printed, etc.
Tracking the job status

You can configure StreamServer applications to wait until Output Manager
returns a completed status notification before marking the Communications
Center top job as completed in the repository. You can also configure
StreamServer applications to trigger custom actions based on the notifications,
such as sending emails, SMS, etc.
Document Presentment Connect for SAP – Delivery Manager

Communications Center applications can send Output Manager job status
notifications to Delivery Manager by using the automatic XOM notifications or
the SAP Delivery Manager script functions. For information about setting up
Delivery Manager to receive job status notifications from Communications
Center, see OpenText Document Presentment for SAP Solutions - Connect for SAP
Customization Guide (CCMSAPC-CGD).
Device status notifications

You can use the device status notifications to see whether a particular device is
available before sending jobs. When using device notifications, Output Manager
sends updates to Communications Center when the status of a device changes or
when the details of the device status change (i.e. the status attribute changes). For
example, when the device goes from up to down, or when the status details change
from lid open to jammed. StreamServer applications can trigger custom actions
based on the notifications, such as sending emails, etc.

Document Presentment Connect for SAP – Delivery Manager

Communications Center can send the Output Manager device notifications to
Delivery Manager by using the automatic XOM notifications or the SAP
Delivery Manager script functions. For information about setting up Delivery
Manager to receive device status notifications from Communications Center, see
OpenText Document Presentment for SAP Solutions - Connect for SAP Customization
Guide (CCMSAPC-CGD).
7.31.1.1 Output Manager job status

Some examples of Output Manager job status include:
• JOBPENDING
• JOBHELD
• JOBRUNNING
• JOBSTOPPED
• JOBERRORCOMPLETE
• JOBREQUEUE
• JOBCONTINUE
• JOBRESTART
• JOBORPHAN
• JOBSPOOLING
• JOBOFFLINE
• JOBCORRUPT
• JOBCOMPLETE
• JOBREMOVED
• JOBKILLED
Completed jobs
StreamServer applications mark the top job as completed in the repository when
they receive any of the following statuses from Output Manager:
• JOBSTOPPED – Completed with warnings.
• JOBCOMPLETE – Completed successfully.
• JOBERRORCOMPLETE – Completed with errors.
• JOBKILLED – Completed with errors.
• JOBREMOVED – Completed with warnings.
• JOBCORRUPT – Completed with errors.

Mapping Output Manager and Output Center status codes

Some Output Manager job status codes can be mapped to Output Center codes.
Mapping example:
Output Output Center job status

Manager jobs
status
JOBPENDING OC code 1 – Queued
JOBRUNNING OC code 2 – Printing
JOBCOMPLETE OC code 3 – Printed
JOBERRORCOMP OC code 4 – Error
LETE
However, it is not possible to map all the codes directly. Output Manager has many
types of devices (printers, Vista Plus servers, etc.) and returns the status details of
each type of device as attributes. You will need to test the job and device codes and
attributes to make a mapping that is relevant in your environment.
7.31.1.2 Output Manager device status

The device status notification from Output Manager contains the following
information:
• Device status – For example DEVICEUP, DEVICEDOWN, or DEVICERESERVED*.
• Status attribute – Depending on the device status, this field may contain
additional details of the device status. For example, for a printer with the status
DEVICEDOWN it may contain details such as Jammed or Load Paper.
Reserved devices (*DEVICERESERVED)

To receive additional information about why a device is reserved, you must
enable the Device Probe option in Output Manager. The type of reserved
information a device sends depends on the Probing settings and the protocol of
the device. For more information about Probing, see Output Manager
documentation.

7.31.2 Configuration steps to send Communications Center

output to Output Manager
You must create a web service connection profile and a Vista Plus Output Manager
connector to send output to Output Manager.
Prerequisites
• The Vista Plus Output Manager web service must be running before you can
submit jobs to Output Manager.
To create a connection profile for Output Manager and a Vista Plus Output
Manager connector
1. In Design Center, create a connection profile for Output Manager. See “Creating
a web service profile for Output Manager” on page 229.
2. In Design Center, add a Generic output connector to the Platform.
3. Activate the physical Platform layer, open the connector, and select the type
Vista Plus Output Manager.
4. Enter the platform settings for the connector. See “Platform connector settings”
on page 233.
5. If required, enter the runtime settings for the connector. See “Runtime connector
7.31.2.1 Creating a web service profile for Output Manager

You can use HTTP or HTTPS communication with Output Manager.
Steps to set up HTTP communication
Follow the steps in this section to set up HTTP communication:

• “Setting up a web service connection profile for Output Manager” on page 231
Steps to set up HTTPS communication
Follow the steps in these sections to set up HTTPS communication:
1. “Setting up HTTPS communication with Output Manager” on page 230
2. “Setting up a web service connection profile for Output Manager” on page 231

7.31.2.2 Setting up HTTPS communication with Output Manager

If you use a self-signed server certificate or a certificate signed by a private certificate
authority for the Vista Plus Output Manager web service, you must complete Step 1
to Step 4.
If you use a certificate signed by a trusted root certificate authority, you can skip
Step 1 to Step 3.
1. Obtain a server certificate for the Vista Plus web service.
2. Add the certificate to a Java KeyStore. See “Importing the certificate to a Java
KeyStore” on page 230.
3. In the resource set in Design Center, import the certificate and set up a
certificate store profile resource for the certificate. See “Importing the certificate
and creating a Certificate store profile resource” on page 231.
4. In the resource set, set up a secure channel profile resource. See “Creating a
Secure channel profile resource” on page 231.
Importing the certificate to a Java KeyStore

You must import the certificate to a Java KeyStore on the computer where you run
Design Center before you can import the certificate into the resource set. To do this
you need the keytool.exe file, which is part of the Java Runtime Environment.
To import the Output Manager certificate to a Java KeyStore
1. Add the path to keytool.exe to the Path system environment variable.
2. At the command prompt, move to the directory containing the Output Manager
certificate file.
3. Enter the command:
keytool -importcert -file <file_name>.cer -keystore vpom.jks -

alias vpom
where:
<file_name> – Is the file name of the certificate.
4. At the Enter keystore password: prompt, enter a password to protect your

keystore.
5. At the Trust this certificate? prompt, enter yes

The certificate is added to the KeyStore.

Importing the certificate and creating a Certificate store

profile resource
1. In Design Center, in the resource set, import the Output Manager certificate as a
Certificate type resource.
2. In the resource set, add a new Certificate store profile resource.
3. Open the Certificate store profile resource.
4. Click Add and then browse to and select the Output Manager certificate
resource.
5. In the Trusted authorities certificates list, double-click the certificate.
6. Enter the certificate password and click OK.
Creating a Secure channel profile resource

1. In the resource set, add a new Secure channel profile resource.
2. Open the secure channel profile resource.
3. On the Channel type list, click the protocol.
4. On the Certificate store profile list, click the certificate store profile you created
in the previous step.
Next step
Create a Vista Plus Output Manager web service profile that uses HTTPS
communication. See “Setting up a web service connection profile for Output
Manager” on page 231.
7.31.2.3 Setting up a web service connection profile for Output Manager

Output Manager user name and password
You need your Output Manager user name and password to set up the
connection profile.
To set up a web service connection profile
1. In the resource set, add a new Web service profile resource.
2. Open the web service profile resource and enter a name.
3. On the Profile sub-type list, click Vista Plus Output Manager.
4. Enter the URL for Output Manager.
5. Specify the recovery actions.

6. On the Authentication profile list, click <Create new...>, and enter your Output
Manager user name and password.
7. On Secure channel profile list, do one of the following:
• To use HTTPS communication, click the secure channel profile you set up
previously. For information about setting this up, see “Setting up HTTPS
communication with Output Manager” on page 230.
• To use HTTP communication, use None.
8. Optionally, enter the connect timeout and the request timeout.
Vista Plus Output Manager Web service profile property descriptions
• Name - The name of the connection profile cannot include underscore characters
(“_”) and must be unique in the domain where the Communications Center
application will run.
• Profile sub-type - Vista Plus Output Manager
• URL - The URL and port to Output Manager in the format http://
server:port. To use HTTPS communication, you must use the https prefix.
try to reconnect to Output Manager if it does not respond. Available options are
Never, Limited times and Forever.
• Number of Retries - The number of times Communications Center software
• Retry Interval - The interval (seconds) between retries. (Applicable if Attempt
• Authentication profile - Select the authentication profile to use.
• Secure channel profile - Leave this blank to use HTTP communication. If you
want to use HTTPS communication, select the secure channel profile to use. For
information about setting up a secure channel profile, see “Creating a Secure
channel profile resource” on page 231.
• Proxy host - The host name or IP address of the proxy host. (Optional)
• Proxy port - The proxy port number. (Optional)
• Connect timeout - The connection timeout for the web service during the job
submission.
• Request time-out - The time the Communications Center application waits for a
response from the web service.

7.31.2.4 Vista Plus Output Manager connector settings

Output Manager web service
The Vista Plus Output Manager web service must be running before you can
submit jobs to Output Manager. For more information about this web service,
see the Vista Plus Output Manager documentation.

Note: Some settings for the connector are available in both the platform and
runtime configuration. If you specify the same option in both places, the
runtime setting is used.
web service profile, see “Creating a web service profile for Output Manager”
on page 229.
• Queue
The queue to add the job to. You must specify the queue in either the platform or
• Account Code
The account number for billing or tracking the job.
• Device
The name of the printer or device.
Maximum field length = 31 characters.
• JME Hosts
The Job Manage (JME) hosts to assign the job to. You can specify multiple hosts
using the format: host1,host3,host3
• Callback Notifications
Indicates whether Output Manager sends notifications about the job status back
to the StreamServer application. This is required to track the Output Manager job
status.
• Callback Service Name
The service name that will receive the job status notifications. You must also
enter this name in the Service name box of the Service Request input connector
that receives the job status notifications.
True – StreamServer applications wait for a job completion notification from
Output Manager before marking the top job as completed in the repository.

False – StreamServer applications mark the job as completed in the repository

after the Communications Center job is successfully delivered from the output
connector.
Runtime connector settings

• Job Name
A name for the job. This does not have to be unique.
• Queue
The queue to add the job to. You must specify the queue in either the platform or
• Comments
A description of the job.
• Print Range
The parts of the output you want to print. If you leave this blank, the entire
output is printed.
You can specify pages, percentages, characters, or a combination of these:
• p<page_number> – For specifying a single page.
• p<page_number>-<page_number> – For specifying a page range.
• #{-#}% – For specifying percentages.
• b <start_character>-<end_character> – For specifying a character range.
For example: p1-10,p20,95-100%,b2400-36000

• Queue Priority
The queue priority between 25 (highest priority) and 255 (lowest priority).
Note: This has no effect on the Output Manager runtime nice level.
• Account Code
The account number for billing or tracking the job.
• Spool File Type
Specifies how the print file is spooled:
• BINARY – No CR-LF translation is done. Use this option for files with internal
formatting characters, such as word processing documents.
• TEXT – The print file is spooled as text.
We recommend you specify the Spool File Type when transferring files between
Windows and UNIX environments.

• Device
The name of the printer or device.
• Retention Time
The time a print file is held in a retention queue after it is printed. For
information about automatically extracting this by using a script, see Vista Plus
Output Manager documentation.
The format can be either a relative time (e.g. +24:00 – hold for 24 hours) or an
absolute time (e.g. 20:00 – hold until 8 p.m.). For a description of the formats, see
“Deferral Time” on page 236 property.
• Page Count
A page count that overrides the calculated value.
• Copies
The number of copies to print. The default is 1.
• Max. Conc. Jobs
Specifies the maximum number of jobs with the same job name that the Queue
Manager (QME) can run concurrently. This applies for both print and batch
queues.
If you submit several jobs with the same job name and different values for this
option, then the QME uses the lowest value.
• Printer Form
The name of the form to print the job on.
• Device Bind
Use this option to specify a printer, but submit the job to a preliminary queue for
pre-processing before it is moved to the queue for printing. If you do not use this
option, when a printer is specified for a job, the job waits for that printer until it
is available.
• COMMAND – The device is bound if $PRINTER is given in the Queue Process of

the queue. The job only runs if the associated device is available.
• DEVICE – The device is bound if the printer is specified on submission.
• NONE – The device is not bound.
• REQUIRED – The device being bound is already defined in Output Manager,
see Vista Plus Output Manager documentation for more information about
defining devices. If the device is defined, the job is sent to the selected device
and all the other bind options, such as COMMAND and DEVICE, that are
specified are applied.
• Device Class Option
The device class option for the job:

• CLASSFIRSTAVAIL – Uses the first available device.

• CLASSIGNORE – Ignores the class of the device and sends it to any available
device.
• CLASSFAILOVER – Sets the job recovery for automatic failover so that the
system automatically resubmits failed jobs when an error occurs.
• Compress
Compresses the output that is sent to Output Manager. Output Manager
automatically decompresses the output when it is received.
• Encrypt
Encrypts the output that is sent to Output Manager.
• Group
The name of the Output Manager group that the job belongs to.
• JME Hosts
The JME hosts to assign the job to. You can specify multiple hosts using the
format: host1,host3,host3
• Output Destination
The destination to send the output to. The default destination is determined by
the “Queue” on page 234 property.
You can specify multiple destinations by separating them with semicolons.
• Deferral Time
The time and date to run the job.
You can use a number of formats and keywords to specify the time and date:
• HH – Delays the job until the hour specified.
• HH:MM – Delays the job until this time. You can add AM or PM. Otherwise, a
24-hour clock is the default.
• MM/DD/YYYY – The date to run the job. The year is optional.
• MM/DAY – Where DAY is the day or an abbreviation of the day to run the job.
For example, both 03FRI and 03FRIDAY run the job on the first Friday in
March.
• today
• tomorrow
If no date is specified and the time is later than the current time, the job is run
today. If the time is earlier than the current time, the job is run tomorrow.
If the given month is earlier in the year than the current month and no year is
specified, the job is run next year.
• Current Time

The submission time for the job. For information about the format of this time,
see “Deferral Time” on page 236 property.
If you leave this blank, the system time is used as the submission time.
• User Name
Submits the job under another user name.
Format: <user name>/<password>
• Calendar Name
Attaches a predefined calendar to the job. You must have already created and
uploaded the calendar to Output Manager by using the calendar utility (qmcal
command) or the Windows Administration client.
• Schedule Name
Attaches a predefined schedule to the job. You must have already created and
uploaded the schedule to Output Manager by using the schedule utility
(schedule command) or the Windows Administration client. This option
overrides any calendar assigned.
• Schedule Options
When to reschedule a repeating job. This is only valid if you use a schedule or a
repeat interval. You can use one of the following:
• IMMEDIATE – The job is resubmitted after the first job run starts (default).
• AFTERSUCCESS – The job is resubmitted after it successfully completes. If it
fails, it is removed from the queue.
• AFTERCOMPLETION – The job is resubmitted after the first run completes
regardless of whether it succeeds or fails.
• Orientation
The page orientation for printing the output:
• PORTRAIT – The default.
• LANDSCAPE
• UNDEFINEDORIENT
• Plex
Specifies how the printer prints successive pages:
• SIMPLEX – On one side of the paper (default).
• DUPLEX – Double-sided for binding along the long edge of the paper.
• TUMBLE – Double-sided for binding along the short edge of the paper.
• Input Tray
The feed tray from which the printer paper is drawn:
• UNDFINEDTRAY (Default)

• AUTOMATIC
• ENVELOPE
• MANUAL
• TRAY<number> – The tray number, which must be between 1 and 9.
• Output Tray
The output tray for the printed pages:
• 0 – Undefined (default).
• 1 to 50 – The output tray number.
• File type
By default the connector determines the file type based on the driver. You can
also specify the file type.
• Finishing
The type of binding that the printer uses:
• NOFINISH or NONE – Does not bind the pages (default).
• STAPLE
• SINGLEPORTRAITSTITCH
• DUALPORTRAITSTITCH
• SINGLELANDSCAPESTITCH
• DUALLANDSCAPESTITCH
• SADDLESTITCH
• BIND
• UNDEFINEDFINISH
• Page Sort
Indicates the order in which the pages are printed:
• 1TON – Print from page one to the last page (default).
• NTO1 – Print from the last page backwards to page one.
• UNDEFINED
• Collated
Enables collation, which sends each copy of a multiple-copy job to a separate
output tray.
• Header
Indicates that a header file must be attached to the beginning of the print file
before it is sent to the printer. You can attach the header by using a qmlpd script,
or by using another script or program. The location of the header file must be
determined by the script or program.

• Trailer
Indicates that a trailer file must be attached to the end of the print file before it is
sent to the printer. You can attach the trailer file by using a qmlpd script, or by
using another script or program. The location of the trailer file must be
determined by the script or program.
• Reference Directory
The path where the job executes. The default is the directory where the JME
process that executes the job runs.
• Job Variables
For custom variables and metadata, such as an external job ID, which are used to
run the job on the JME host. Use the following format:
<variablename1>=<value1>;<variablename2>=<value2>
StreamServe Connect for SAP – Delivery Manager

To use the SAP Delivery Manager script functions for job tracking, you must set
up job variables for the Spool ID, RMG ID, and Device ID. For example:
sap_spoolid=$spoolid;sap_rmg_id=$rmgid;sap_device=$device
You must create these variables in a script that comes before the output
connector, for example before Process.
• Queue Entry Access
Specifies the access level for a queue entry in Output Manager. By default,
Private is set. This will not enable all web client users to access queue entries
when security is enabled for connecting with the web client.
• Private – Access is restricted to the user who submitted the job.
• Read – All web client users have read access to the job.
• Update – All web client users have update access to the job.
• Read Update – All web client users have read and update access to the job.
7.31.3 Configuration steps to set up job tracking

To update the repository with the Output Manager job status, you enable a setting in
the Vista Plus Output Manager output connector.
To receive job status notifications and trigger custom actions, such as sending emails
or updating SAP Delivery Manager, you must also set up a Service Request input
connector and a MessageIN Event.
Prerequisites for receiving job status notifications

• The Vista Plus Output Manager web service is running.
• A service gateway application is running in your domain.

• The repositorytopjobcompletionservice.xml file exists in the packages

folder in the working directory of the service gateway.
When you create a new service gateway, this file is automatically copied to the
packages folder. If you have an existing service gateway without this file, you
can manually copy it from the Communications Center installation directory.
Windows paths:
• Source: <Communications Center installation directory>
\applications\management\<version>\etc\config\<version>
\STRSSG\packages\repositorytopjobcompletionservice.xml
• Destination: <ManagementGateway root directory>\<version>
\root\applications\<service gateway application name>\wd\packages
\
To update the repository with the Output Manager job status
Note: These steps assume the Output Manager connector is already set up.
• In the Vista Plus Output Manager output connector, in the External Job
Completion box, click True.
To create custom actions based on job status notifications
1. In the Vista Plus Output Manager output connector, set up the following
properties in the Platform or runtime configuration:
a. In the Callback Notifications box, click True.

b. In the Callback Service Name box, enter the service name of the Service
Request input connector that receives the notifications. See Step 2 below.
c. In the External Job Completion box, click True or False.
2. Add a Service Request input connector to your Project.
a. In the Request type list, click Notification.

b. In the Service name box, enter the Callback Service Name you entered in
Step 1.
3. Add the VPOMJobNotification SXD file to the resource set. This file is found in
the following directory: <Communications Center installation directory>
\Applications\Tools\<version>\System\data\sxd

6. The action you want to trigger determines what additional configuration you
must make in the Project.
Tip: Job variables are found in the env field of the MessageIN Event. To
retrieve job variables you can create a script function in a function file and

import it to the resource set. For an example, see Example 7-33, “Function
to retrieve the job variables” on page 241.
Example 7-33: Function to retrieve the job variables

CodePage UTF8
func GetVPOMJobVariable ()
{
StrTok(#2, ";", $attr);
$size = ArraySize($attr);
for ($i = 0; $i < $size; $i++){
StrTok($attr[$i], "=", $pair);
if ($pair[0] = #1) {
return $pair[1];
}
}
}
7.31.4 Configuration steps to set up device tracking

To receive device status notifications, you must configure Output Manager to send
device notifications to Communications Center.
In Communications Center, you must set up a Service Request input connector and a
MessageIN Event to receive the notifications.
Prerequisites for receiving device status notifications

• The Vista Plus Output Manager web service is running.
• A service gateway application is running in your domain.
To configure Output Manager to send device notifications to Communications

Center
1. In Output Manager, in the Device Administration dialog box, click the

Notification tab, and in the Notification area click Enable.
2. In the Notification Type list, click STRMSRV.
3. In the Service name box, enter the name of the service that receives the
notifications. This must match the service name in the Service Request input
connector, see Step 3 below.
4. In the Service Gateway URL box, enter the URL to the service gateway. Use the
format: http://<host name or IP address>:<port number>
To create a Service Request input connector and MessageIN Event for device
tracking
1. Add a Service Request input connector to your Project.

2. In the connector settings, in the Request type list, click Notification.

3. In the Service name box, enter a name for the service that receives the
notifications. This must match the service name entered for the device in Output
Manager, see Step 3 above.
4. Add the VPOMDeviceNotification SXD file to the resource set. This file is
found in the following directory: <OpenText Communications Center
installation directory>\
Applications\StreamServer\<Version>\Tools\System\data\sxd
Next steps
To send the notifications in an email or SMS you must also set up an appropriate
Process.

Chapter 8
Queue management
8.1 Configuring queues

To be able to queue an input job, you must connect a queue to the input connector
that retrieves the input job. To be able to queue an output job, you must connect a
queue to the input connector that retrieves the corresponding input job, and to the
output connector that delivers the output job.
By default, the Platform includes two pre-configured input and output queues. You
can connect any of these queues to your input and output connectors. You can use
the pre-configured queue settings, and you can also edit the queue settings if you
need to.
Generic Platform layer

The queue settings must be the same for all physical layers. This means you
must configure queues in the generic Platform layer.
Where to configure queues
You configure the queues in the Manage Queues dialog box:

2. Right-click the Platform view and click Manage Queues. The Manage Queues
dialog box opens.
In this dialog box, you can configure the settings for all existing queues. You can also
create new queues, rename queues, and delete queues using this dialog box.
8.2 Creating and renaming queues

The Platform includes the two default queues Input and Output. You can use these
queues, but it is recommended to create queues with unique names in each Design
Center Project if you do not want to share the queues with other Projects
(StreamServer applications).
To add a queue
1. In the Manage Queues dialog box, click Add. A new queue is added to the list
of available queues.
2. Rename the queue.
To rename a queue
1. In the Manage Queues dialog box, right-click the queue you want to rename,
and select Rename.

Chapter 8 Queue management
2. Enter a new name for the queue, and press ENTER.
8.3 Specifying the default input and output queue

You can specify which input queue to use as default input queue, and which output
queue to use as default output queue. When you add a queue to an input/output
connector, and select the option (Use default), the default input/output queue you
specify here will be selected.
To specify the default input queue
• Right-click the queue and select Set as default input queue.
To specify the default output queue
• Right-click the queue and select Set as default output queue.
8.4 Enabling transactional support

A single job can generate and deliver several output items, such as documents,
Messages, document broker documents, resources, etc. By default, job output is
delivered on the fly, as each item of the job is created . When using transactional
support, the output items from a job are delivered after all the items in the job are
completed successfully.
Figure 8-1: Output items delivered as they are created (default)
Figure 8-2: Using transactional support to deliver all output when the job is
complete

8.5. Enabling sorting of queue items
To enable transactional support

2. Right-click the Platform view and click Manage Queues.
3. In the Queue area, click the queue to configure.
4. Click the Advanced tab.
5. Select the Transactional support check box.
8.5 Enabling sorting of queue items

By default items in the queue are not sorted and are processed by the StreamServer
application in random order. You can enable sorting for the queue to control the
order in which items are picked from the queue. When sorting is enabled, items are
sorted by priority followed by the order in which they are received.
For more information about setting up priorities, see “Setting the job priority for the
input connector ” on page 86 or “Setting the job priority for the output connector”
on page 95.
To enable sorting of the queue items

5. Select the Sorted queue check box.
8.6 Setting up the queue spooling options

By default the queues are spooled automatically each time a new item is added. You
can switch off the automatic spooling and set up a schedule to control when
spooling occurs. For example, if an output queue contains fax jobs, you can schedule
the queue to wait until 6 PM before delivering the jobs. You can also use scheduled
spooling together with automatic spooling.
Both scheduled spooling and automatic spooling can be disabled. For example, if
you use one StreamServer application to queue input jobs and another application to
process jobs, you can switch off both scheduled spooling and automatic spooling in
the application that receives the input jobs.
To set up a schedule for spooling the queue


5. Select the Schedule spooling check box.
6. Set up the schedule, see “Scheduling” on page 66.
7. Optionally, select Spool for a limited time and enter the time period.
To disable automatic spooling of the queue
5. Clear the Automatic spooling check box.
8.7 Enabling sharing of queues

If several StreamServer applications in the same domain are used for load balancing
and failover, they must be able to share queues.
Sharing is by default disabled for the queues. This to prevent from unintentional
queue sharing, where one StreamServer application consumes another StreamServer
application's jobs.
If several StreamServer applications should be able to share a queue, the Platform

and queue names must be exactly the same in the Design Center Projects for all
StreamServer applications. This because the name of the queue used by the
StreamServer applications consists of both the Platform and queue name defined in
Design Center. Sharing must also be enabled for the queue in all Projects.
Note: If you disable sharing for a queue in Project A, and enable sharing for
the same queue in Project B, then StreamServer B can consume
StreamServer A's jobs. StreamServer A cannot consume StreamServer B's
jobs in this case.
To enable sharing
2. Right-click the Platform view and select Manage Queues.
4. Click the Queueing tab.
5. Select Enable sharing.

8.8. Storing queued documents on disk
8.8 Storing queued documents on disk

Documents in queued input/output jobs are by default stored as blobs (Binary Large
Objects). You can, for each queue, select to store the blobs as files on disk instead.
The repository will in this case include references to the blobs stored on disk.
There are several reasons to store blobs on disk, for example to:
• Improve performance.
• Decrease the amount of repository data to backup.
• Minimize the risk to reach maximum database and tablespace limits.
Storing blobs on a network share

To store blobs on a network share, you must use UNC (Uniform Naming
Convention) when you specify the path – you cannot use drive letters. For
example, you can use \\wtvs01\data\queues but not H:\data\queues when
you specify the path.
When not to store blobs on disk

• If you intend to share the queue between several StreamServer applications (load
balancing and fail over), you cannot store blobs on disk.
Note: Archiving must be disabled for the output connector if you select to
store blobs on disk.
To store blobs on disk
2. Right-click the Platform view and select Manage Queues.
5. Select Store blobs on disk.
6. In Blob path, specify the path to the folder where to store the files.

8.9 Deleting queues

If the Platform includes queues that you do not need in your Design Center Project
you can delete them. Note that the queues are deleted from the Platform in your
Project, but not from the repository. To delete queues from the repository, you must
use the Database Administration Tool.
To delete a queue
1. In the Manage Queues dialog box, select the queue you want to delete and click
Delete. A dialog box opens.
2. Click Yes to confirm. The queue is deleted, and all connectors that used the
queue is no longer connected to a queue.

Chapter 9
Resource set management
9.1 Connecting a resource set to a Project

component
The Project's default resource set is automatically connected to all Project
components (Platform, Runtime configuration, and Message configuration). If you
need to, you can connect other resource sets to a Project component.
To connect a resource set to a Project component
1. Activate the Project component view in the Main window (for example, double-
click the corresponding node in the Project browser).
2. Right-click the component view, and select Add Resource Set.
3. In the Select Resource Sets dialog box, select the resource set to connect, and
click OK.
To disconnect a resource set from a Project component
1. Activate the Project component view in the Main window.
2. Right-click the component view, and select Remove Resource Set.
3. In the Remove Resource Sets dialog box, select the resource set to disconnect,
and click OK.
9.2 Adding resources to a resource set

When you add a resource to a resource set, you create a link from the resource set to
a physical resource file. This means the same resource file can be linked to several
resource sets. You can add resources to a resource set in different ways:
• Create a new resource file using a resource editor, and link the resource file to the
resource set. See “Creating resources using resource editors” on page 250.
• Create a new resource file by importing a source file, and link the resource file to
the resource set. See “Creating resources by importing source files” on page 250.
• Link an existing resource file to the resource set. See “Linking existing resources”
on page 251.
• Create a new font resource file by importing a font, and link the resource file to
the resource set. See “Importing fonts” on page 251.

Chapter 9 Resource set management
Adding folders to a resource set

You can structure the resources in a resource set by inserting folders and sub folders.
You can then add the resources to the appropriate folders. You can also drag and
drop resources within the resource set tree.
To create a resource set folder
1. Right-click the node (root node or folder) where you want to add the folder, and
select New > Folder. A new folder is added.
2. Rename the folder.
Creating resources using resource editors

Using this method, you create a resource file in your Project directory, and link the
resource file to the resource set. To edit the resource, you must use the resource
editor.
To create a resource using a resource editor
1. Right-click the resource set, select New and the resource type. A new resource is
added to the resource set.
2. Rename the resource.
3. Double-click the resource. The resource editor opens.
4. Configure the resource, save the resource, and close the editor.
Creating resources by importing source files

Using this method, you create a resource file in your Project directory, and link the
resource file to the resource set.
To edit the resource, you can edit the source file, and then update the resource. See
“Editing imported resources” on page 252. If you have specified a resource editor
for the resource, you can also use the resource editor to edit the resource.
To create a resource by importing a source file
1. Right-click the resource set, select Import and browse to and select the source
file. The Resource Type Settings dialog box opens.
2. Specify the resource type and click OK. A new resource is added to the resource
set.
3. Rename the resource.

9.2. Adding resources to a resource set
Linking existing resources

Using this method, you can link an existing resource file from the CAS, to the
resource set. For example, you can link a logotype shared by several Projects to the
resource set.
To link in an existing resource
1. Right-click the resource set, select Add Resource.
2. In the Select CAS resources dialog box, browse to and select the resource file. A
new resource is added to the resource set.
Importing fonts
This is a special case of importing source files. Using this method, you can manually
import fonts from the Fonts directory to the resource set.
To import fonts
1. Right-click the resource set, and select Import Font. The Select Fonts dialog box
opens.
2. Specify the fonts to import, and click OK. The new resources are added to the
resource set.
Importing all used fonts

There is also an alternative to import fonts manually. You can select to add all
used fonts to a resource set when you export the Project. This ensures that all
fonts are available if you move the Project to a new machine.
You do this in the Export dialog box by selecting the option Add exported fonts
to Platform's default resource set.
9.2.1 Copying and pasting resources

1. In the resource set, right-click the resource you want to copy, and then click
Copy.
2. Right-click the resource set where you want to insert the resource, and then
click Paste.
3. If copying within the same Project, rename the resource.

9.3 Editing resources

Some resource types have resource editors that you can use when editing the
resource. If a resource type does not have a default resource editor you must specify
which editor to use. See “Specifying resource editors” on page 252.
To edit a resource using a resource editor
1. Double-click the resource. The resource editor opens.
2. Edit the resource file, save it, and close the editor.
Editing imported resources

If you have created a new resource using Import, you can edit the source file, and
then apply the changes to the resource.
To edit an imported resource
1. Edit the source file.
2. Right-click the resource and select Update From Origin.
Changing the resource type

When you create a resource using New, you select which resource type to create.
When you create a resource using Import, you specify the resource type for the
imported resource. In both cases, you can change the resource type afterwards.
To change the resource type
1. Right-click the resource and select Resource Type. The Resource Type Settings
dialog box opens.
2. Select the resource type, and click OK.
Specifying resource editors

When you create a resource using Import, you must specify a resource type for the
imported resource. Some resource types, for example Image, do not have default
resource editors. In this case, you can specify a editor for the imported resource.
When you create a resource using New, you select which resource type to create. All
these resource types have default resource editors. You can change the resource
editor for all resource types but the following:
• Filter Chain
• RDI Setting
• StoryTeller document

9.4. Extracting a resource to file
To select a resource editor
1. Right-click the resource and select Resource Editor. The Set Resource Editor
dialog box opens.
2. Select Pick resource editor, browse to and select the resource editor, and click
OK.
9.4 Extracting a resource to file

You can extract the data embedded in a resource file. For example, if you have an
image resource, you can extract the image data to an image file. Note that you
cannot extract data from all resource types. For example, you cannot extract data
from filter chains or security configurations.
To extract the resource contents
1. Right-click the resource and select Extract To File. A file browser opens.
2. Specify the file path, including file name and extension, and click OK.
9.5 Showing resource dependencies

You can retrieve information about which objects (Processes, overlays, etc.) are
affected when you modify a resource. This applies to the following resource types:
• Image
• Overlay
• Sheet Layout
• Rule
The objects are listed in the Show Dependencies dialog box.
Figure 9-1: The Show Dependencies dialog box.

To open the Show Dependencies dialog box
• Right-click the resource, and select Show Dependencies.
Navigating to the objects
You can navigate to the objects from the Show Dependencies dialog box:
1. Select the object, and click Go to selected item. The corresponding view opens
with the object highlighted.
2. Open the object.

Chapter 10
Sorting
An input job contains several documents (invoices, delivery notes, etc.). If no sorting
is applied, the documents are processed in the order they are received. In some
situations you need to sort the documents. For example, to be able to use a
Document trigger, you may have to sort the input documents before they are
processed.
Sort keys
You use sort keys to specify how to sort documents. See “Sort keys”
on page 257.
Sorting before or after Process

You can sort documents either before or after they are handled by the Processes.
When to sort before Process

You should always try to sort documents before Process, due to performance
reasons. See “Sorting before Process” on page 258.
When to sort after Process
You must sort after Process if the sort key variables are defined in a Process. See
“Sorting after Process” on page 260.
Sorting Documents
You can sort the output after it is grouped as Documents (using a Document
trigger). This also applies to documents retrieved from a Post-processor
repository. See “Sorting Documents” on page 261.
Scenario – No sorting
The figure below illustrates a simple scenario where the input job contains four
documents:
• One hardware invoice (hw) and one software invoice (sw) to customer 01.
• One hardware invoice and one software invoice to customer 02

Chapter 10 Sorting
Figure 10-1: Processing a job – no sorting applied.
1. The StreamServer application receives the input job.

2. No sorting is done, and the Processes handle documents in the same order as
they are received.
3. The documents are delivered in the same order as they are received.
Output mode Document

In this scenario, it is not possible to group hardware and software invoices by
customer, since the Document trigger changes after each processed document.
This would result in four Documents (one invoice per Document) instead of two
Documents (one hardware and software invoice per Document).

10.1. Sort keys
Figure 10-2: Using $customerNumber as Document trigger – no sorting

applied.
To be able to create Documents by customer, the invoices must first be sorted by

customer.
10.1 Sort keys

You use sort keys to specify how to sort documents. For example, if you assign a
variable $customerNumber to the Event field customerNumber, you can use
$customerNumber as sort key.
Multiple sort keys

You can use multiple sort keys. For example, if you use $customerNumber as the
first sort key, and $documentType as the second sort key, the documents are first
sorted by $customerNumber, and then by $documentType.
Numeric or string variables

When you specify a sort key, you must select the appropriate type. If the sort
key is a string variable you must select Type> String, and if the sort key is a
numeric variable, you must select Type> Numeric.
Sorting ascending or descending

The default sort order is descending. But if you need to, you can change the sort
order to ascending.

Chapter 10 Sorting
Changing the order of the sort keys

The sort keys are applied in the order they are displayed in the Edit Sort
Definition dialog box. You can select any sort key, and use the Move arrows to
move the sort key to the appropriate position.
10.2 Sorting before Process

You should always try to sort documents before Process. To sort documents before
Process, you must add one or more sort keys to the Runtime job.
To add a sort key
2. Right-click the Runtime job and select Edit Sort Definition. The Edit Event Sort
Definition dialog box opens.
3. Click Add New. The Add Sort Key dialog box opens.
4. Add the sort key and click OK.
Scenario – Sorting before Process using one sort key

The figure below illustrates a simple scenario, where $customerNumber is used as
sort key.
Figure 10-3: Sort before Process using $customerNumber as sort key.

2. The documents are sorted using $customerNumber as sort key:
3. All customer 01 documents are delivered before the customer 02 documents.
In this scenario, the documents are not delivered in the same order.
• Document order for Customer 01:
1 – Software invoice
2 – Hardware invoice

10.2. Sorting before Process

In this scenario, you can use $customerNumber as Document trigger to group
hardware and software invoices per customer. The documents are not in the
same order in all Documents. This is corrected in “Scenario – Sorting before
Process using multiple sort keys” on page 259.
Figure 10-4: Creating Documents using $customerNumber as sort key and

Document trigger.
Scenario – Sorting before Process using multiple sort keys

The figure below illustrates a simple scenario, where two sort keys are used:
• $customerNumber
• $documentType
Figure 10-5: Sort before Process using $customerNumber and $documentType

as sort keys.

2. The documents are sorted using $customerNumber the first sort key.
3. The documents are sorted using $documentType as the second sort key.
4. All customer 01 documents are delivered before the customer 02 documents.

Chapter 10 Sorting
In this scenario, the hardware invoices are delivered before the software invoices.

In this scenario, you can use $customerNumber as Document trigger to group
hardware and software invoices per customer.
Figure 10-6: Creating Documents using $customerNumber and

$documentType as sort keys, and $customerNumber as Document trigger.
10.3 Sorting after Process

You must sort after Process if the sort key variables are defined in the Process. To
sort documents after Process, you must add one or more sort keys to the output
connector in the generic Runtime configuration layer.
To add a sort key
2. Double-click the connector. The Edit Output Connector Settings dialog box
opens.
3. Double-click the Runtime job that contains the Document. The Runtime Output
Connector Settings dialog box opens.
4. Click the Document End icon.
5. On the Process Sort Definition tab, click Edit Process Sort Definition. The Edit
Process Sort Definition dialog box opens.

10.4. Sorting Documents
6. Click Add New. The Add Sort Key dialog box opens.
Scenario – Sorting after Process using one sort key

The figure below illustrates a simple scenario where documents are sorted before
Process using $customerNumber as sort key, and after Process using $documentType
as sort key. In this scenario, $documentType is defined in the Processes (Process1
and Process2).
Figure 10-7: Sort before Process using $customerNumber as sort key, and
after Process using $documentType as sort key.

2. Sorting is done before Process using $customerNumber as sort key.
3. Sorting is done after Process using $documentType as sort key.
10.4 Sorting Documents

You can sort the output after it is grouped as Documents (using a Document
trigger). This also applies to documents retrieved from a Post-processor repository,
and can be used to sort documents within envelopes if enveloping is enabled.
To sort Documents, you must add one or more sort keys to the output connector in
the generic Runtime configuration layer.
To add a sort key
2. Double-click the connector. The Edit Output Connector Settings dialog box
opens.
3. Double-click the Runtime job or Post-processor job that contains the documents.
The Runtime Output Connector Settings dialog box opens.
4. Click the Job End icon.
5. On the Document Sort tab, click Add New. The Add Sort Key dialog box opens.

Chapter 11
Concepts and glossary
11.1 Message
A Message is a tree structure of tagged fields and blocks that is used internally by
StreamServer when transforming input documents into output documents. The
Message is independent of the input and output format which means StreamServer
can receive input in any format, transform the input into a Message, and then
transform the Message into any output format.
11.2 Design Center Projects

A Design Center Project constitutes the configuration used by a StreamServer
application to collect, transform, and deliver data. In Design Center, you create and
configure the Project. Then you export the Project, and deploy it to the appropriate
StreamServer application. A Design Center Project contains the following main
components:
• Platform (see “Platforms” on page 263)
• Message configuration (see “Message configurations” on page 264)
• Runtime configuration (see “Runtime configurations” on page 265)
• Resource set (see “Resource sets” on page 269)
11.3 Platforms
The Platform represents the StreamServer application to which the Project is
deployed, and contains the environment settings for that StreamServer application.
This includes available connectors, queues, and paths used to find local resources.
The Platform is divided into one generic layer (settings that apply to all physical
environments) and one physical layer per target environment (development, test,
etc.). See “Platform layers” on page 269 for more information about layers.

Chapter 11 Concepts and glossary
11.4 Message configurations

A Message configuration defines:
• How to identify documents in the input job.
• Which parts of an input document to extract.
• How to create a Message.
• How to use the Message to create the output documents.
The part of the Message configuration that extracts the input documents and creates
the Message is called Event, and the part that creates output documents is called
Process.
A Project normally contains several Message configurations, where each Message

configuration corresponds to a specific type of document. For example, one Message
configuration for invoices, another for orders, etc.
References
• “Message” on page 263
• “Events” on page 264
• “Processes” on page 265
11.4.1 Events
An Event defines how to identify documents in the input job, which parts of an
input document to extract, and how to create the Message.
Trigger patterns
An Event is triggered by patterns in the input data. When a matching pattern is
found, the Event starts to extract data from the input and creates the Message.
Message definition
The instructions on how to create the Message, i.e. a tree structure of named
fields and blocks, are defined in the Event. When the data is extracted from the
input, the Event uses these instructions to map non-recurring input data to
fields at root level, and recurring data to fields in blocks.
Different input formats

There are different types of Events adapted to different types of input:
• Page based
• Field based
• Record based
• XML based
• Pre-formatted (e.g. PDF)

11.5. Runtime configurations
11.4.2 Processes
A Process defines which fields and blocks in the Message to use, and how to
organize the fields and blocks in the output documents.
Different output formats

There are different types of Processes adapted to different types of output:
• Page based
• Record based
• XML based
Page layout and text formatting

Processes for page based output also defines the page layout (position of text,
graphics, etc.) and text formatting (font, font size, hyper links, etc.).
11.5 Runtime configurations

A Project can contain several Runtime configurations, for example one Runtime
configuration per document type (Message configuration). The Runtime
configurations in a Project connect Message configurations to the Platform.
The Runtime configuration view

Each Runtime configuration is represented by a Runtime configuration view in
Design Center. This view includes all connectors created in the Platform, and all
Message configurations added to the Runtime configuration.
Collection of input jobs

For each Message configuration, you must specify from where to collect the
input job. You do this in the Runtime configuration view by connecting the
input connector that retrieves the input job, to the Event that extracts documents
from the input job.
Delivery of output documents

For each Process in a Message configuration, you must specify where to deliver
the output. You do this in the Runtime configuration view by connecting the
Processes to the appropriate output connectors.
Runtime jobs and Post-processors

See “Runtime jobs” on page 266 and “Post-processors” on page 266.

11.5.1 Runtime jobs

A Runtime job is a grouping of one or several Message configurations in a Runtime
configuration.
Job scope
A Runtime job starts when the first of its documents is found in the input job, i.e.
when the first Event in the Runtime job is triggered. A Runtime job ends when
the last of its documents retrieved from the input job has been processed and
delivered from the Processes.
Document definitions
For each Runtime job and output connector, you can define Documents. A
Document includes output from Processes in the same Runtime job. See “Output
mode Document” on page 99 for more information.
Connector settings
The Runtime job enables you to configure connector settings that apply to all
included Processes:
• Job Begin settings – applied before the Runtime job starts.

• Job End settings – applied after the Runtime job ends.
• Document Begin settings – applied before each Document.
• Document End settings – applied after each Document.
Sorting
The Runtime job enables you to sort the documents extracted from the input job
before the output jobs are created. For example, when using output mode
Document, you may have to sort the input documents before the output
documents are created. See “Sorting“ on page 255 for more information about
different types of sorting.
11.5.2 Post-processors
A StreamServer can store page formatted documents in a Post-processor repository.
These documents can later be retrieved and processed by any StreamServer with
access to the repository. To retrieve documents from a Post-processor repository,
you must add a Post-processor to the Runtime configuration.
Process links
A Post-processor always includes a default Process Link, which is used as the
connection point to the output connector. To enable Process specific or Page
specific output connector settings, you must add a new Process Link to the Post-
processor job. This Process Link must be linked to the Process that stored the
corresponding document in the Post-processor repository.

11.6. Input connectors
11.6 Input connectors

Input connectors are the channels through which input jobs are received. You create
the input connectors in the Platform, and in the Runtime configuration you specify
to which Events to deliver the input jobs.
Connector type
There are different types of input connectors. Which type to select depends on
how the input jobs are retrieved from the source application. For example, if the
source application stores output files in a directory, you can use a Directory
input connector to retrieve the files from the same directory.
Queue
You can connect input queues to the input connectors. The input queue stores
input jobs before they are processed by the StreamServer.
11.7 Output connectors

Output connectors are the channels through which output jobs are delivered. You
create the output connectors in the Platform, and in the Runtime configuration you
specify from which Processes to collect the output.
Connector type
There are different types of output connectors. Which type to select depends on
how the output jobs are delivered to the target application. For example, if the
target application is a printer, you can use a Spool output connector to deliver
the output to the printer.
Driver
If the output connector delivers page formatted output to the target application,
you must add the appropriate device driver to the output connector. For
example, if the target applications a PCL printer, you must add the appropriate
PCL device driver to the output connector.
Queue
You can connect output queues to the output connectors. The output queue
stores the output jobs before they are delivered to the target application.
Output mode
You must specify the appropriate output mode for each output connector. See
“Output modes” on page 98 for more information about output mode.
Runtime configuration connector settings

The connector type and device driver settings you configure in the Platform are
the default settings that will be applied in all Runtime configurations in the
Project. In each runtime configuration, you can override the default settings. In
the Runtime configurations, you can also configure connector settings that will
be applied before or after the Runtime job, and before or after each Document in
the Runtime job. For example sheet layouts, OMR codes, and enveloping.

11.8 Input queues

An input queue stores input jobs before they are processed by the StreamServer. It
queues input jobs if more jobs are sent to the StreamServer than it can process. In
case of an unexpected StreamServer shutdown, the queue also provides robustness
since it enables the StreamServer to reprocess the input jobs when it is restarted.
Several StreamServer applications can share the same input queue. This provides
possibilities for scaling over multiple StreamServer applications.
If several versions of a Project are run simultaneously, the version number is

automatically added to the queue names (input_1, input_2, etc.). This will make sure
that version <x> and version <y> of a Project using the same Platform and input
queues do not steal jobs from each other.
11.9 Output queues

An output queue stores the output jobs before they are delivered to the target
applications (printers, faxes, etc.). It queues output jobs if the StreamServer creates
more output jobs than it can deliver. In case of an unexpected StreamServer
shutdown, it also provides robustness since it enables the StreamServer to reprocess
the output jobs when it is restarted.
Several StreamServer applications can share the same output queue. This provides
possibilities for scaling over multiple StreamServer applications.
If several versions of a Project are run simultaneously, the version number is

automatically added to the queue names (output_1, output_2, etc.). This will make
sure that version <x> and version <y> of a Project using the same Platform and
output queues do not steal jobs from each other.
11.10 Output modes

The output mode specifies how to group documents before they are delivered via
the output connector to the target application. There are three different output
modes:
• Process - see “Output mode Process” on page 98.
• Document - see “Output mode Document” on page 99.
• Job - see “Output mode Job” on page 101.
Which output mode to use depends on the type of output and target application.
The default output mode Process can be used in different types of scenarios. In other
scenarios you may have to use output mode Document or Job.

11.11. Resources
11.11 Resources
All external files that you refer to when you configure a Project must be available to
the Project as resources. A resource in this context is a file with an embedded source
file. For example, to be able to use the image file logo.gif in a Project, this file must
be embedded in a resource. Resources are stored on disk, for example in the local
Project directory, or in a directory shared by several Projects.
Resource examples
• Overlays – layouts to include in page formatted output.
• Images – images to include in page formatted output.
• Filter chains – a collection of filters that can be used by a connector.
11.12 Resource sets

Resources (overlays, images, filter chains, etc.) must be available to the Project
components (Platforms, Message configurations, and Runtime configurations) via
resource sets. A resource set is a set of links to physical resource files stored on disk.
The default resource set

When you create a Project, a default resource set is automatically added to the
Project. This resource set is automatically connected to all Project components
you create from within the Project. This means all resources added to the default
resource set are available to all Project components. If you want to use other
resource sets, you must manually connect them to the Project components.
11.13 Platform layers

The Platform is separated into one generic layer and one physical layer per target
environment. For example, you may have the following target environments:
Development, Test, QA and Production. In this case the Platform must have four
physical layers – one for the Development environment, one for the Test
environment, etc.
Runtime configuration layers

A Runtime configuration is based on the Platform, and inherits the generic and
physical layers from the Platform. For example, if the Platform is separated into
a Development, Test, QA, and Production layer, the Runtime configuration will
also be separated into the same layers.
Generic layer settings

The generic layer includes settings that must be the same in all target
environments. These settings must be tested in all development and test
environments before the production layer is deployed. For example, you cannot
develop and test output using a PDF driver, and then use an AFP driver in the
production environment. In this case you must use an AFP reader in the
environments that have no access to the actual printer.

Physical layer settings

The physical layers include environment specific settings. For example, the
paths for input and output jobs will probably not be the same in the
development and production environment.
The same Design Center Project in all target environments

The separation of the Platform into layers enables you to use the same Design
Center Project in all target environments. When you export the Project, all
physical layers are included in the same export file. When you deploy the
Project to a StreamServer application, you specify which physical layer to
deploy and run.
Reuse of Platform settings

The generic Platform layer contains settings that apply to all target
environments. This means you only have to configure these settings once, no
matter how many physical layers you must create. When you create a new
physical layer, you create a copy of an existing physical layer. Then you only
have to edit the environment specific settings in the new physical layer.
11.14 Project export and deployment

A Project consists of a set of Project files. These files include all the information
needed by the StreamServer application to collect, transform, and deliver data. To
make this information available to the StreamServer application, you must first
export the Project, and then deploy the exported Project to the StreamServer
application.
Project export
When you export a Project, you create an export file (*.export) that includes all
the configuration files needed by the StreamServer application. The export file
includes the configuration files for all Platform layers defined in the Project. You
also have to option to include the.dcpackage file in the export file. Including
the .dcpackage affects performance if you make a local redeploy from Design
Center.
Deployment
You deploy Projects In Control Center. When you deploy a Project to a
StreamServer application, you must specify which Platform layer to deploy. All
the configuration files are then extracted from the export file, and stored in the
working directory of the StreamServer application.

11.15. Glossary
11.15 Glossary
• Alias
Method used to configure settings dynamically. There are two types of aliases:
• Script alias, where you use scripting to determine which alternative to select.
• Lookup alias, where you use lookup tables to determine which alternative to
select.
• Document
A Document (capital D) is a grouping of documents per customer number,
delivery address, etc. The scope of the Document is specified using a Document
trigger.
• Document trigger
A variable that determines the scope of the Document.
• Event
An Event defines how to identify documents in the input job, which parts of an
input document to extract, and how to create a Message.
• Event tool
Each Event type has its own Event tool (PageIN, StreamIN, XMLIN, etc.) where
the Event is configured.
• Export
When you export a Project, you create an export file (*.export) that includes all
the configuration files needed by the StreamServer application. The export file
includes the configuration files for all Platform layers defined in the Project.
• Filter chain
A collection of filters that can be used by a connector.
• Generic Platform layer
The generic Platform layer (also referred to as logical layer) includes settings that
must be the same in all target environments.
• Input Analyzer
Enables input connectors to receive input in different formats, and to deliver the
input to the appropriate Event.
• Input connector
Input connectors are the channels through which input jobs are received.
• Input job
A stream of data, with a distinct beginning and end, received via an input
connector, and processed by the StreamServer.
• Input queue

An input queue stores input jobs before they are processed by the StreamServer.
• MailOUT
Process used to create email output.
• Message
A tree structure of tagged fields and blocks used internally by the StreamServer
when transforming input documents into output documents.
• Message configuration
A Message configuration defines:
• How to identify documents in the input job.
• Which parts of an input document to extract.
• How to create a Message.
• How to use the Message to create the output documents.
• MessageIN
Event for OpenText Communications Center Enterprise XML input data.
• MessageOUT
Process for output data sent to a MesageIN Event. The MessageOUT Process
makes it possible to extend the processing chain over multiple StreamServers.
• Output connector
Output connectors are the channels through which output jobs are delivered.
• Output job
An output job is equivalent to a file, created by the StreamServer, and delivered
via an output connector to a target application (printer, fax, etc.). The scope of the
output job is set by the output mode, and in some scenarios by using script
functions (e.g. SetDestPath).
• Output mode
The output mode specifies how to group documents before they are delivered
via the output connector to the target application.
• Output mode Document
In output mode Document, the output is delivered as Documents. This means
the output connector waits until the Document is complete before it delivers the
output.
• Output mode Job
In output mode Job, the output connector waits until the whole Runtime job is
finished before it delivers the output.
• Output mode Process
In output mode Process, the output connector delivers the output as it arrives
from a Process. This means each output document is delivered separately.

11.15. Glossary
• Output queue
An output queue stores the output jobs before they are delivered to the target
applications (printers, faxes, etc.).
• PageIN
Event for page based input data.
• Physical Platform layer
A physical Platform layer includes environment specific settings.
• Platform
The Platform represents the StreamServer application to which the Project is
deployed, and contains the environment settings for that StreamServer
application.
• Post-processor
Used to retrieve documents from a Post-processor repository.
• PreformatIN
Event for pre-formatted (e.g. PDF) input data.
• Process
A Process defines which fields and blocks in a Message to use, and how to
organize the fields and blocks in the output documents.
• Process tool
Each Process type has its own Process tool (StoryTeller, StreamOUT, XMLOUT,
etc.) where the Process is configured.
• Project
The configuration used by a StreamServer application to collect, transform, and
deliver data. In Design Center, you create and configure the Project. Then you
export the Project, and deploy it to the appropriate StreamServer application.
• RedirectOUT
Process used to redirect input data directly to an output connector, and skip the
processing steps in the StreamServer.
• Resource
All external files that you refer to when you configure a Project must be available
to the Project as resources. A resource in this context is a file with an embedded
source file.
• Resource set
A resource set is a set of links to physical resource files stored on disk.
• Runtime configuration
The Runtime configurations in a Project connects Message configurations to the
Platform.
• Runtime job

A Runtime job is a grouping of one or several Message configurations in a

Runtime configuration.
• StoryTeller
Process for page based output data.
• StreamIN
Event for record based and field based input data.
• StreamOUT
Process for record based output data.
• StreamServer
The server that uses the configuration created in Design Center to collect,
transform, and deliver data.
• StreamServer application
The StreamServer can run several StreamServer applications, where each
StreamServer application is dedicated to a specific Design Center Project.
• Template Engine
Template Engine is a service used to create textual output based on templates.
The output from Template Engine can be assigned to script variables, written to
file, or delivered via output connectors.
• XMLIN
Event for XML based input data.
• XMLOUT
Process for XML based output data.

Chapter 12
Design Center dialog boxes
12.1 Main window reference

12.1.1 Customize dialog box
In the Customize dialog box, you can customize the Design Center toolbars.
Toolbars tab
On this tab you enable/disable toolbars and tooltips, and modify the appearance of
the toolbars.
• Toolbars
Displays all available toolbars. Use the check boxes to specify which toolbars to
display in Design Center.
• Show Tooltips
Select to enable tooltips for the toolbar buttons.
• Flat look
Select to flatten the toolbars.
• Large buttons
Select to display large size toolbar buttons.
• New
Add a new custom toolbar.
• Reset
Reset selected (native) toolbar to include its default toolbar buttons. Can be used
if you have added new buttons to the toolbar.
• Delete
Delete selected (custom) toolbar.
Command tab
On this tab you can see descriptions of all Design Center toolbar buttons. You can
also drag buttons and menus to any toolbar displayed in Design Center.
• Categories
Displays all available toolbar and menu categories.
• Buttons

Chapter 12 Design Center dialog boxes
Displays the buttons in the selected category. You can drag buttons from this
panel to any native or custom toolbar.
• Description
Shows the description of the selected button.
12.1.2 Design Center Settings dialog box

In the Design Center Settings dialog box you can specify the default Design Center
application settings.
• Remember these settings when closing Design Center

Select to open the Design Center views and windows as they were the last time
Design Center was closed.
• Default code page
The default code page specified here is the default code page in all code page
drop-down lists in Design Center.
• Enable wizard window at startup
Select to display the wizard window when you launch Design Center. The
wizard window contains the options Recent Projects, Open Project, Create new
Project, etc.
• Highlight Runtime links for selected items
Select to highlight all links to components selected in a Runtime configuration
view.
• Track active item in project tree
Select to highlight the active node in the Project browser. For example, if a
Message view is active in the Main window, the corresponding Message node in
the Project browser is highlighted.
• Enable autosave
Select to enable autosave of the Design Center Project files.
• Autosave interval
Specify how frequently to autosave the Design Center Project files.
• Inherit resource sets
Specify whether to inherit resource sets. For example, you have the resource set
"B" connected to the Message configuration "Invoice". When you add the
Message configuration "Invoice" to a Runtime configuration, you must decide
whether the Runtime configuration should inherit the resource set "B".
• Ask Before - You are prompted each time.

• Always - Resource sets are inherited automatically.
• Never - Resource sets are not inherited.

12.2. Project dialog boxes
• Obtain write lock when opening views

Specify whether Design Center should try to lock a Project file when opening the
corresponding view. This is only applicable if the Project is connected to the
CAS.
• Always - Design Center tries to lock the file automatically.
• Never - Design Center does not try to lock the file.
• Obtain write lock for all components when opening them
Specify whether Design Center should lock all components in a view when
opening the view. This is only applicable if the Project is connected to the CAS.
• Always - Design Center locks the components automatically.
• Never - Design Center does not lock the components.
• Project Templates location
The path to the Design Center Project templates.
• Help settings
• Server URL - The root URL to the help server. Default is the global help URL
http://docsapi.opentext.com/mapperpi.
If you have implemented your own private help system you must change this
to the root URL to your private help server, for example http://mydochost:
8080/docsapimapper/mapperpi. See Section 12.1 “Implementing the
OpenText Private Help Server for Communications Center” in OpenText
Communications Center Enterprise - Installation Guide (CCM-IGD) for more
information about implementing private help.
• Tenant ID - For future use.
• Format - The help format. Leave as is unless instructed by OpenText.
12.2 Project dialog boxes

12.2.1 Project Settings dialog box

In the Project Settings dialog box, you can configure the overall Project settings.
• Project name
The name of the Project.
• Default code page
The default code page in all code page drop-down lists in the Project.
• Default Resource set
The default resource set of the Project. This resource set is automatically
connected to all Platforms, Message configurations, and Runtime configurations
you create from within the Project.
• Project key
The ID of the Project. This is generated automatically and cannot be changed.
• Connect to CAS
The CAS the Project is connected to. If you want to connect the Project to a
different CAS (for example if you want to use the Project for another tenant),
click Disconnect.
When unpacking a Project from another tenant or environment, you should also
click Disconnect.
12.2.2 Project Package information dialog box

In the Project Package information dialog box you specify whether to save a package
as a Project package or as a Project template. You also specify/edit the category and
description of templates in this dialog box.
• Category
The category label of a template. When you create a new Project using this
template, you will find the template under the category you specify here.
• Description
A description of a template. When you create a new Project using this template,
you see this description when you select the template.
• Save as Project Package
Save the Project as a Project package.
• Save as Project Template
Save the Project as a Project template.

12.2.3 Unpack Project dialog box

In the Unpack Project dialog box, you specify how to unpack a Project Package.
• Reset project version number
Resets the Project version number to version 1. You should reset the Project
version number if you want to unpack and deploy the Project as a new Project.
• Reset template versions
Resets all template versions in the unpacked Project to version 1.
• Open Project after unpacking
Select to open the Project in Design Center after unpacking.
• Regenerate internal keys
Assigns a new unique ID to each Project component. This is required if you want
to have two copies of the same Project locally or in the same CAS.
When upgrading a Project, this is always selected.
• Regenerate external file keys
Available when Regenerate internal keys is enabled.
Enable to make copies of the external file links for resources as well as for the
Design Center components.
12.2.4 Create Project from Template dialog box

In the Create Project from Template dialog box, you select a template to use when
creating a new Project.
•
Open the Project template information dialog box, where you can edit the name,
category, and description of the selected template.
•
Delete the selected template.

• Category
The Project template category. Each category can contain several templates.
• Available templates
All available templates of the selected category. Here you select which template
to use.
• Description of selected template
A description of the selected template.
• Go online to get more templates for StreamServe

A link to templates available online.
12.2.5 Project Export Settings dialog box

In the Project Export Settings dialog box, you specify Project specific export settings.
Normally, the Project contains one Platform only. If there are Several Platforms in
the Project, you select the Platform by clicking the appropriate Platform icon. Then
you specify the settings for the selected Platform.
• Activated Runtimes for selected Platform
Select the Runtime configurations to include in the export. All Runtime
configurations built on the selected Platform are included in this list.
• InputAnalyzer tab
On this tab, you configure Input Analyzer settings for the selected Platform.
• Edit current Platform arguments
Shortcut to the “Configure Platform Export dialog box” where you specify the
startup arguments to include in the export. You specify the startup arguments
per physical layer of the selected Platform.
12.2.5.1 InputAnalyzer tab

On this tab, you configure Input Analyzer settings for the selected Platform. See
“Input Analyzer” on page 88 for more information.
• Available connectors
This list displays all available input connectors in the selected Platform. This is
where you select the input connector for which to configure the Input Analyzer
settings.
• Input Analyzer configuration
This list includes one row for each input type handled by the selected input
connector.
Input Type – This column displays the input types.
Filter Chain – This column displays, per input type, the filter chains connected to
the input connector.
• Handle XML-based input before StreamIN
Specifies which input type category to have first in the list.
•
For Connectivity Packs. See the corresponding documentation.

•
Display the names of all Events, of the selected input type, connected to the input
connector.

Add a filter chain to the selected input type. See “Adding filter chains”
on page 540for more information.
•
Move an input type down within a category.

•
Move an input type up within a category.

•
Remove the selected filter chain.
12.2.6 Font Dependencies dialog box

In the Font Dependencies dialog box, you can see all fonts used in StoryTeller
Processes in the Project.
All used fonts are displayed in a list. You can click the column labels to set the sort
criterion.
• Font
The name of the font.
• Dependencies
The Process where the font is used.
• Type
For example StoryTeller (Process) or StoryTeller Document (*.ssd).
• Go to selected item
• Activate the Message configuration that contains the Process where the font is
used. The Process is highlighted in the Message view.
• Activate the resource set that includes the overlay. The overlay resource is
highlighted in the resource set view.

12.2.7 Edit Custom Fields dialog box

In the Edit Custom Fields dialog box, you can add custom commands and keywords
in order to use StreamServer functionality that cannot be configured via the
standard Design Center GUI properties. See “Using custom commands and
keywords” on page 65 for more information.
• Access point
This is a browser that contains all configurable objects (connector, Message, etc.).
Each object is divided into one node for the generic (Logical in the GUI) layer,
and one node for each physical layer (Development, Test, etc.). You can browse
through the folders and nodes in this browser the same way as you do in a file
browser.
• Custom
This is where you enter the custom commands for the selected Access point
browser node.
12.2.8 Export and Export for release dialog boxes

In the Export dialog box, you specify the export settings to export the Project to disk.
In the Export for Release dialog box, you specify the export settings to export the
Project to the CAS.
• Platform to export
Normally, the Project contains one Platform only. If there are Several Platforms
in the Project, you use this drop-down list to select the Platform to export.
• Physical layers to export
This list displays all physical layers in the selected Platform. The check-boxes are
used to specify which layers to include in the export.
By default, all physical layers will be included in the export. You can uncheck
one or more physical layers to exclude them from the current export.
• Save these settings
Select this option if you want to save the modifications done in Physical layers to
export. If you do not select this option, all physical layers will be selected the
next time you open the Export dialog box.
• Specify export directory
Only available when exporting to disk
The path to the export directory. The export file will be stored in this directory.
• Add exported fonts to Platform's default resource set
Select to add all used fonts to a resource set connected to the Platform. This
ensures that all fonts are available if you move the Project to a new machine.
• Include DCPackage file in export

Only available when exporting to disk

Select to pack the Project, and include the package file (*.dcpackage) in the
export file. When the export file is deployed to a StreamServer application, the
package file is stored in:
<ManagementGateway>\<Version>\root\applications
\<streamServerApplication>\data\package
• Version number
Select the version number of the export file. For example, if you want to keep the
existing configuration for a StreamServer application, and run another
application with a modified export configuration.
• Scripts
Opens the “Scripts dialog box” where you can specify scripts to be executed
before or after the Project is exported.
• Configuration conflicts
If there are any conflicts in the export configuration, this will be displayed here.
12.2.8.1 Scripts dialog box

In this dialog box, you can specify scripts (bat, pearl or similar) to be executed before
and after the Project is exported.
• Specify pre-export script
A script to execute before the export.
Usage examples
• Backup the previous export files before exporting the Project.
• Backup the deployed Project before exporting the Project.
• Stop export if there is an error
Select if you want to stop the export if there are errors in the pre-export script.
• Specify post-export script
A script to execute after the export.
Usage examples
• Copy the export files to a remote machine.
• Deploy the export file to a StreamServer application, and restart the
StreamServer application. The script executes the command line Control
Center tools for this purpose.
• Display script results
Select whether to display script results:
• Always

• Only if an error occurs

• Never
Variables set by Design Center
The following variables are set by Design Center, and can be used in the pre-export
and post-export scripts:
$(ExportPackage)
The full path to the export file (*.export) created by the export.
$(ChecksumFile)
The full path to the checksum file (*.sfv) created by the export.
$(ProjectName)
The name of the Project.
$(ProjectPath)
The path to the Project folder.
Use the following syntax to pass one or more variables to the script:
"<script_path> var1[ var2][ var3][ var4]"
Example 12-1: Passing $(ExportPackage) and $(ChecksumFile) to

script.
"C:\scripts\copy.bat $(ExportPackage) $(ChecksumFile)"
12.3 Platform dialog boxes

12.3.1 Configure Platform dialog box
In the Configure Platform dialog box, you configure Platform specific settings. This
dialog box has two modes:
• The “Configure Platform dialog box – Generic layer mode”, where you specify
Platform settings that apply to all physical layers.
• The “Configure Platform dialog box – Physical layer mode”, where you specify
Platform settings for each physical layer.

12.3. Platform dialog boxes
12.3.2 Configure Platform dialog box – Generic layer mode

This mode is activated in the Configure Platform dialog box when the generic
Platform layer is activated in the Platform view.
In this mode, the dialog box is divided into the following tabs:
• “Job Status tab” on page 285
• “Advanced tab” on page 286
12.3.2.1 Job Status tab

Settings
• Delete successful jobs
Specify whether the Task Scheduler deletion events should delete successful
queue items and tracking jobs stored in the repository.
• Allow deletion after
Specify the time successful queue items and trackers must be kept in the
repository. The deletion events are allowed to delete queue items and trackers
that are older than the time specified.
• Time unit
Specify time unit for Allow deletion after (successful jobs).
• Delete failed jobs
Specify whether the Task Scheduler deletion events should delete failed queue
items and trackers stored in the repository.
• Allow deletion after
Specify the time failed queue items and trackers must be kept in the repository.
The deletion events are allowed to delete queue items and trackers that are older
than the time specified.
• Time unit
Specify time unit for Allow deletion after (failed jobs).

12.3.2.2 Advanced tab

On this tab, you can specify the following options:
• Whether to cache resources and exception rules. Caching improves performance
when running StoryBoard and Document Reviewer, especially when using large
numbers of resources.
• Whether to store Document Broker Plus Blobs on disk.
Settings
• Enable Cache
Select to enable caching of resources.
• Store Document Broker Plus Blobs on disk
Select to store Document Broker Plus blobs as files on disk, which improves
performance in scenarios where you have a few StreamServer applications on a
single computer.
If you have a complex environment, where you run many StreamServer
applications or run StreamServer applications on several computers, storing
Document Broker Plus blobs on disk does not improve performance.
By default, Document Broker Plus blobs are stored in the Document Broker
repository. If you select Store Document Broker Plus Blobs on disk, the
Document Broker repository only contains properties, not the actual data.
• Blob path
Only available if you select Store Document Broker Plus Blobs on disk.
Path to the folder where you want to store the files.
If several StreamServer applications use a common Document Broker repository,
you must specify the same absolute path for all applications.
12.3.3 Configure Platform dialog box – Physical layer mode

This mode is activated in the Configure Platform dialog box when a physical
In this mode, the dialog box is divided into the following tabs:
• “Recording Mode tab” on page 287
• “File Cache tab” on page 287

12.3.3.1 Recording Mode tab

On this tab, you can activate recording of page formatted input data in order to
create sample files.
• Activate recording mode
Select to run the StreamServer in record only mode.
• Lines
The number of lines in the input data to record.
• Columns
The number of columns in the input data to record.
• Input connector
The input connector that receives the data to be recorded.
12.3.3.2 File Cache tab

On this tab, you specify how to cache external XML and DTD files used by XMLIN
Events.
• File cache base directory
The file cache base directory. You can use an absolute path, or a path relative to
the working directory of the StreamServer. XML and DTD documents are cached
in a sub directory called XML.
• Enable XML cache
Select to enable caching of XML and DTD documents.
• XML cache size
The maximum number of documents in the XML cache directory. When the limit
is exceeded, the oldest document is removed.
• XML cache time-out
The “best before date” for a cached document. The StreamServer checks this date
each time it retrieves a document from the cache. If the document is older than
the cache time-out, it will be updated.

12.3.4 Manage Queues dialog box

In the Manage Queues dialog box, you can configure settings for available queues,
and add new queues to the Platform.
• Queue list
This list displays all available queues. This is where you select the queue you
want to configure.
• Add
Add a new queue to the Platform.
• Delete
Delete the selected queue. The queue will be deleted from all connectors using it.
• Queuing tab
On this tab, you specify how to handle successful and failed jobs. See “Queuing
tab” for details.
• Advanced tab
On this tab, you specify more advanced queue settings. See “Advanced tab” for
details.
There are also shortcut menu commands (right-click the queue list) that you can use.
• Add
Add a new queue to the Platform.
• Delete
Delete the selected queue. The queue will be deleted from all connectors using it.
• Rename
Rename the selected queue.
• Set as default input queue
Make the selected queue the default input queue. When you add a queue to an
input connector, and select the option (Use default), this queue is selected.
• Set as default output queue
Make the selected queue the default output queue. When you add a queue to an
output connector, and select the option (Use default), this queue is selected.

12.3.4.1 Queuing tab

On this tab, you specify when and how many times the StreamServer should try to
resend a failed job from the queue.
• Retries
The maximum number of times the StreamServer should try to resend a failed
job from the queue.
• Retry delay (ms)
The time (milliseconds) the StreamServer should wait before it tries to resend a
failed job from the queue.
• Enable sharing
Enable sharing of the queue.
If several StreamServer applications in the same domain are used for load
balancing and failover, they must be able to share queues. You must, in each
Design Center Project (one Project per StreamServer application), enable sharing
for all queues to be shared.
Note: If you disable sharing for a queue in Project A, and enable sharing
for the same queue in Project B, then StreamServer B can consume
StreamServer A's jobs. StreamServer A cannot consume StreamServer B's
jobs in this case.
12.3.4.2 Advanced tab

On this tab, you specify the following options:
• Whether to use transactional support
• Whether to sort the queue
• The spooling options for the queue
• Whether to store blobs on disk
• Transactional support
Specifies whether to deliver each output item from the job on the fly as it is
created (the default) or whether to deliver job output when all items in the job
are complete. For more information, see “Enabling transactional support”
on page 244.
• Automatic spooling
Select to spool the queue every time an item is added.
• Sorted queue
Sorts the items in the queue in “Priority” order followed by the order in which
they are received.
• Schedule spooling

Select to schedule spooling of the queue. For example, if an output queue

contains fax jobs, you can schedule the queue to wait until 6 PM before
delivering the jobs. By default, spooling stops when the queue is empty.
• Spooling interval
Open the scheduler, and specify the spooling intervals.
• Spool for a limited time
Select to specify a time for when to stop spooling.
• If the queue still contains jobs after the specified time, the remaining jobs are
handled in the next spooling interval.
• If the queue is emptied before the specified time, the queue waits for new jobs
to arrive. This means the new jobs can be handled in the same spooling
interval. You can select Stop if the queue is empty to override this feature.
• Days, Hours, Minutes, Seconds
The time when to stop spooling.
• Store blobs on disk
Select to store blobs as files on disk.
Documents in queued input/output jobs are by default stored as blobs (Binary
Large Objects). You can, for each queue, select to store the blobs as files on disk
instead. The repository will in this case include references to the blobs stored on
disk.
There are several reasons to store blobs on disk, for example to:
• Improve performance.
• Decrease the amount of repository data to backup.
• Minimize the risk to reach maximum database and tablespace limits.
Note: All jobs must be finished before you change this setting and redeploy
the Project.
• Blob path
Path to the folder where to store the files.
To store blobs on a network share, you must use UNC (Uniform Naming
Convention) when you specify the path. You cannot use drive letters.
For example, you can use \\wtvs01\data\queues but not H:\data\queues
when you specify the path.

12.3.5 Manage Physical Layers dialog box

In the Manage Physical Layers dialog box, you can navigate between physical
layers, add new layers, delete layers, and activate the appropriate layer. You can
also use the Project browser shortcut menu to manage the physical layers.
• Available Physical Layers
This list displays all physical Platform layers.
• Active Physical Layer
Displays the currently active physical layer.
• Add
Select to add a new physical layer to the Platform.
• Rename
Rename the physical layer selected in the Available Physical Layers list.
• Set as active
Select a physical layer in the Available Physical Layers list, and click this button
to make the selected layer the active layer.
• Delete
Delete the physical layer selected in the Available Physical Layers list. Note that
this will delete both the physical Platform and Runtime configuration layers.
12.3.6 Configure Platform Export dialog box

In the Configure Platform Export dialog box, you can specify arguments that are
read by the StreamServer at server startup, and used when running the Project. You
specify the arguments per physical layer.
The dialog box has two tabs:

• Arguments, where you specify startup arguments that are exported to the
standard startup argument file. To change these arguments you must change the
arguments in Design Center, export and redeploy the Project, and restart the
• Administrator Arguments, where you specify administrator arguments that are
exported to the file sysadmin.arg in the working directory of the StreamServer.
To change these arguments, the administrator can edit sysadmin.arg and restart
the StreamServer.
The settings described below apply to both the Arguments and Administrator
Arguments.
• Selected layer
Use this drop-down list to select the physical layer to configure.
• Name/Value list

Used to select which standard arguments to include in the argument file. To

select an argument you must check the corresponding check box. To add a value
to an argument, you must select the argument, and enter the value in the
argument field below the Name/Value list.
• Description
Displays a short description of the selected argument.
• Edit Custom
Opens the Custom Arguments dialog box, where you can add custom arguments
that are not included in the Name/Value list. Arguments that you add to the
Before section are added before the standard arguments in the argument file.
Arguments that you add to the After section are added after the standard
arguments in the argument file.
• Preview
Opens a preview of the argument file.
12.3.7 Input Connector Settings dialog box

In the Input Connector Settings dialog box, you configure the settings for the
selected input connector. This dialog box has two modes:
• The “Input Connector Settings dialog box – Generic layer mode”, where you
specify connector settings that apply to all physical layers.
• The “Input Connector Settings dialog box – Physical layer mode”, where you
specify connector settings for each physical layer.
12.3.8 Input Connector Settings dialog box – Generic layer

mode
This mode is activated in the Input Connector Settings dialog box when the generic
Platform layer is activated in the Platform view. In this mode, the dialog box is
divided into the icons and tabs shown in the table below.
•
“Queue tab” on page 293 – On this tab, you specify which queue to connect to
the connector.
•
“Filter chain tab” on page 293 – On this tab, you can connect filter chains to the
input connector.
•

“General tab” on page 294 – On this tab, you can add notes to the connector.
12.3.8.1 Queue tab

On this tab, you specify which queue to add to the connector and the priority of the
jobs received by the connector.
• Queue
Select which queue to add to the connector.
• Manage Queues
Open the “Manage Queues dialog box” on page 288, where you can add new
queues, configure queue settings, etc.
• Priority
The priority of the jobs received by the connector. See “Setting the job priority for
the input connector ” on page 86.
12.3.8.2 Filter chain tab

On this tab, you can connect filter chains to the input connector. For example, you
can apply a decompression filter to decompress input data. You must first add the
filter to a filter chain, and then add the filter chain to the connector.
• Look in
Lists all available resource sets. Browse to, and select, the appropriate resource
set.
The list below contains the filter chains and folders included in the selected
resource set. You can double-click a folder to display all items within. In this list,
you select the filter chain to add to the connector.
• Selected
This is the filter chain that will be added to the connector when you click OK.
You can only select one filter chain.
Selection buttons
Adds the selected filter chain to the Selected field. This means you have
specified the filter chain to add to the connector.
Removes the filter chain from the Selected field. This means you have not
Editor buttons
Edit the selected filter chain.

Exit the filter chain editor.
Resource set buttons
Adds an existing resource set to the Platform. This new resource set will be
available in the Look in list. Note that the resource set is not automatically
added to the Project.
Creates a new resource set and connect it to the Platform. This new resource set
will be available in the Look in list. Note that the resource set is not
automatically added to the Project.
Resource buttons
Creates a new empty filter chain and add it to the selected resource set. You can
now edit the filter chain and add it to the Selected field.
Adds an existing filter chain to the selected resource set. You can now add the
filter chain to the Selected field.
Not applicable to filter chains.
12.3.8.3 General tab

On this tab, you can add notes to the connector. You can also specify whether to
process all documents extracted from the input file (or equivalent) in the same input
job, or process each extracted document as a separate input job.
• Note
Add notes to the connector. For example, a short description of what it is used
for. Use Font to specify the note font, and the alignment buttons to specify how
to align the text.
• Keep input Job structure in output
Specifies whether to process all documents extracted from the input file (or
equivalent) in the same input job, or process each extracted document as a
separate input job. This affects the usage of variables and Process output since all
stored variables and Processes are removed when an input job is completed. For
example, it is only possible to use variables and to sort Process output within the
same input job.
If selected, the StreamServer processes all extracted documents in the same input
job.

If not selected, the StreamServer processes each extracted document as a separate

input job. This reduces the use of memory and disk space when handling large
jobs, but the Process output and all stored variables are removed when the
document is completed.
12.3.9 Input Connector Settings dialog box – Physical layer

mode
This mode is activated in the Input Connector Settings dialog box when a physical
Platform layer is activated in the Platform view. In this mode, the dialog box is
divided into the icons and tabs shown in the table below.
•
• “Connector Settings tab” on page 295 – On this tab, you select the type of
input connector to use, and configure the connector type specific settings.
• “HTTP Access tab” on page 295 – On this tab, you configure HTTP Access
settings for the connector.
•
12.3.9.1 Connector Settings tab

On this tab, you select the type of input connector to use, for example a Named pipe
input connector. You also configure the connector type specific settings on this tab.
• Connector type
Select the type of input connector to use. See “Connector reference“ on page 105.
• Property/Value list
Configure the settings of the selected connector type.
12.3.9.2 HTTP Access tab

On this tab, you configure HTTP Access settings for the connector.
Note: The connector must be connected to a queue.
You must configure HTTP Access settings in order to receive input via an HTTP or
HTTPS input connector. The input received via the HTTP(S) input connector can
also be passed on to another connector. In this case, you must also configure the
HTTP Access settings for that connector.
• HTTP Connector

All HTTP and HTTPS connectors in the Platform are available in this drop-down
list. If you are configuring an HTTP or HTTPS connector, you must select that
connector. For example, if you are configuring an HTTP connector called
HTTP_IN, you must select HTTP_IN from the drop-down list. If you are
configuring any other type of connector, you must select the HTTP or HTTPS
connector to collect the input from.
• URI
The URI of the connector you are configuring.
Example 12-2: HTTP Access configuration for an HTTP connector and

an Internal connector
This example includes one HTTP connector called HTTP_IN and one Internal
connector called INTERNAL. The connectors have the HTTP Access
configurations shown below.
- HTTP Connector URI

HTTP_IN HTTP_IN /
INTERNAL HTTP_IN /internal
A request sent to www.abc.com/ is received and handled by HTTP_IN.
A request sent to www.abc.com/internal is received by HTTP_IN and

forwarded to INTERNAL.
12.3.9.3 General Settings tab

On this tab, you can add notes to the connector.
• Note
to align the text.
12.3.10 Output Connector Settings dialog box

In the Output Connector Settings dialog box, you configure the settings for the
selected output connector. This dialog box has two modes:
• The “Output Connector Settings dialog box – Generic layer mode”, where you
specify connector settings that apply to all physical layers.
• The “Output Connector Settings dialog box – Physical layer mode”, where you
specify connector settings for each physical layer.

12.3.11 Output Connector Settings dialog box – Generic layer

mode
This mode is activated in the Output Connector Settings dialog box when the
generic Platform layer is activated in the Platform view.
In this mode, the dialog box is divided into the icons and tabs shown in the table
below.
•
“Code page Settings tab” on page 298 – On this tab, you can specify which code
page to apply to the output data.
•
• “Device Driver Settings tab” on page 298 – On this tab, you can specify
which device driver to add to the output connector.
• “Symbol Set tab” on page 299 – On this tab, you can override the symbol set
specified for the connector. Only applicable when sending output to PCL
printers.
•
“Filter Chain Settings tab” on page 300 – On this tab, you can connect filter
chains to the output connector.
•
“Queue tab” on page 301 – On this tab, you specify which queue to connect to
the connector.
•
“Output mode tab” on page 301 – On this tab, you specify the output mode for
the connector.
•
“General Settings tab” on page 302 – On this tab, you can add notes to the
connector. You can also specify options for downloading files (soft fonts,
overlays, etc.) to a printer.

12.3.11.1 Code page Settings tab

On this tab, you can specify which code page to apply to the output data. See
“About code pages and Unicode support“ on page 597 for more information about
code pages.
• Inherit code page
Select to inherit the code page specified for the input, and use the same code
page for both input and output.
• Code page name
Specify a different code page for the output. This code page must at a minimum
cover all the characters covered in the code page for the input.
• Reorder BiDi output in visual order
Only for Arabic and Hebrew code pages, and for UCS-2 and UTF-8. The StreamServer
processes bidirectional text in logical order. If required, select this option to
reorder the output to visual order.
• Add byte order mark
Only for UCS-2 and UTF8. Select to include a byte order mark at the beginning of
a UCS-2 (UTF-16) or a UTF-8 encoded output file. The application that receives
the output can use the byte order mark to automatically determine the encoding
(UTF-8 or UTF-16 encoding scheme) and byte order for the data in the UTF-16
encoding scheme.
• Byte order
Only for UCS-2. For the UTF-16 encoding schemes, each character code unit is
represented by two bytes. When you select UCS-2 as code page, you must also
specify the byte order. The byte order to select depends on the application that
receives the output.
12.3.11.2 Device Driver Settings tab

On this tab, you can specify which device driver to add to the output connector.
• Show all devices
Select to show all available device drivers in the Device drop-down list.
If you do not select this option, the Device drop-down list only includes a
selection of device drivers. You can configure this list in the Device tool by
selecting the option Include in device filter for the device drivers to include.
• Device
Select which device driver to add.
Configure the settings of the selected device driver.
• Alias

Specify aliases for the driver settings. See “Using aliases” on page 61.
Use the following syntax in the lookup table:
Event.Process.Option.key_value Value
For example:
ev1.pr1."Print Orientation:".DEN Landscape

• Use type manager
Select to generate UseTypeManager keyword into the DRS file. Fonts are searched
for in the \Fonts folder and used if available.
Note: If the font requires any driver specific setting, you can still use the
standard syntax. However, the ReadFont parameter is not required.
• Font substitution table
Select a font substitution table if you want to add new fonts or override font
definitions in the selected device. The font substitution table must be added to a
resource set connected to the Platform.
You can add new font entries to a font substitution table instead of editing the
actual driver file. The new font entries are added to the exported driver file. You
can also add font entries that override font entries in the driver file. The font
entry syntax depends on the driver to be used. See “Managing fonts“
on page 511 for more information.
12.3.11.3 Symbol Set tab

On this tab, you can override the symbol set specified for the connector. Only
applicable when sending output to PCL printers.
When sending output to a PCL printer, there you can override the symbol set in the
code page specified for the connector, and specify a different symbol set for the
printer.
• Override symbol set in default code page

Select to override the symbol set.
• Static
Select to use a static symbol set.
• Lookup
Select to use a lookup table to specify which symbol set to use. See “Lookup
alias” on page 63 for information on how to use lookup tables.
• Variable
Select to use a variable to specify which symbol set to use. See “Script alias”
on page 62 for information on how to use variables for this purpose.

12.3.11.4 Filter Chain Settings tab

On this tab, you can connect filter chains to the input connector. For example, you
can apply a decompression filter to decompress input data. You must first add the
filter to a filter chain, and then add the filter chain to the connector.
• Look in
Lists all available resource sets. Browse to, and select, the appropriate resource
set.
The list below contains the filter chains and folders included in the selected
resource set. You can double-click a folder to display all items within. In this list,
you select the filter chain to add to the connector.
• Selected
This is the filter chain that will be added to the connector when you click OK.
You can only select one filter chain.
Selection buttons
Adds the selected filter chain to the Selected field. This means you have
Removes the filter chain from the Selected field. This means you have not
Editor buttons
Edit the selected filter chain.
Exit the filter chain editor.
Resource set buttons
Adds an existing resource set to the Platform. This new resource set will be
available in the Look in list. Note that the resource set is not automatically
added to the Project.
Creates a new resource set and connect it to the Platform. This new resource set
will be available in the Look in list. Note that the resource set is not
automatically added to the Project.

Resource buttons
Creates a new empty filter chain and add it to the selected resource set. You can
now edit the filter chain and add it to the Selected field.
Adds an existing filter chain to the selected resource set. You can now add the
filter chain to the Selected field.
Not applicable to filter chains.
12.3.11.5 Queue tab

On this tab, you specify which queue to add to the connector and priority of the jobs
delivered by the connector.
• Queue
Select which queue to add to the connector.
• Manage Queues
Open the “Manage Queues dialog box” on page 288, where you can add new
queues, configure queue settings, etc.
• Priority
The priority of the jobs delivered by the connector. See “Setting the job priority
for the output connector” on page 95.
12.3.11.6 Output mode tab

On this tab, you specify the output mode for the connector. See “Output modes”
on page 98 for more information about the different output modes.
• Process
Select output mode Process. See “Output mode Process” on page 98.
• Document
Select output mode Document. See “Output mode Document” on page 99.
• Job
Select output mode Job. See “Output mode Job” on page 101.


On this tab, you can add notes to the connector. You can also specify options for
downloading files (soft fonts, overlays, etc.) to a printer.
• Download File
Select a resource, for example an overlay or soft font, to download to a printer.
• Enable download
Select to download the resource for each output page. If you do not select this
option, the resource is downloaded only for the first page.
• Include result in service response
Select to include the output data in the web service response to the client issuing
the web service request.
Only used if the input is received via a Service Request input connector.
Note: This output connector must be queue enabled.
• Rule
Select a rule or rules that pauses the job in the output connector. The job can be
released from the output connector in Supervisor.
See “Adding exception rules to the output connector” on page 102.
• Note
to align the text.
12.3.12 Output Connector Settings dialog box – Physical layer

mode
This mode is activated in the Output Connector Settings dialog box when a physical
In this mode, the dialog box is divided into the icons and tabs shown in the table
below.
•
“Connector tab” on page 303 – On this tab, you select the type of output
connector to use, and configure the connector type specific settings.
•

12.4. Message dialog boxes
12.3.12.1 Connector tab

On this tab, you select the type of output connector to use, for example a File output
connector. You also configure the connector type specific settings on this tab.
• Connector type
Select the type of output connector to use. See “Connector reference“
on page 105.

• Note
to align the text.
12.4 Message dialog boxes

12.4.1 Event Settings dialog box
In the Event Settings dialog box, you configure overall Event settings. This dialog
box is divided into the following tabs:
• “Agent Settings tab” – On this tab, you configure settings that apply to StreamIN
and XMLIN Events.
• “Event Order tab” – On this tab, you specify how to aggregate output from
several Events in a Message configuration.
12.4.1.1 Agent Settings tab

On this tab, you configure settings that apply to StreamIN and XMLIN Events.
StreamIN settings
• Input type
The input type of the StreamIN Event. Agent is only used for connectivity packs.
StrsXML and XML are only used for 3.0.1 and older versions.
• Description resource
The description file used by the StreamIN configuration. This file must be
included in a resource set connected to the Message configuration.
• Description ID
The FIELDIN or STREAMIN keyword in the description file (case sensitive).

XMLIN settings
• Collect entire documents

Select to use the Document collection mode for the XMLIN Event. This collection
mode collects the whole XML document before processing and parsing the data.
• Validation level
The validation level of the XMLIN Event.
• XSD mapping table
The XSD mapping table to use when validating input against an XSD. The
mapping table contains namespace to schema location mappings. This table must
be included in a resource set connected to the Message configuration.
• XML error connector
Output connector for sending error messages in case of XMLIN validation errors.
• Expand external entities
Select to expand and process document references.
12.4.1.2 Event Order tab

On this tab, you specify how to aggregate output from several Events in a Message
configuration. The output from the Events are appended to the same Message
structure in the order specified on this tab. The Message structure is then passed on
to the Process(es) in the Message configuration.
• First
Output from a First Event starts the Message structure. If there are no more
Events in the Message configuration, or if the following Event in the Message is
also a First Event, the Message structure only includes output from this Event.
• Repeating
Output from a Repeating Event is appended to the Message structure.
• If there are no preceding Events in the Message configuration, this option is

the same as the First option.
• If there are no following Events in the Message configuration, this option is
the same as the Last option.
• Last
Output from a Last Event is appended at the end of the Message structure.
If there are no preceding Events in the Message configuration, the Message
structure only includes output from this Event.

12.5. Runtime configuration dialog boxes
12.5 Runtime configuration dialog boxes

12.5.1 Edit Event Sort Definition dialog box
In the Event Sort Definition dialog box, you specify sort keys for sorting the input
before the output is generated. You can, for example, use a Document trigger
variable to sort the input before the Documents are generated.
If you add several sort keys, the sort keys will be applied in the order (top-down)
they are added to the list.
• Key
A variable specified in the Message configuration (Event or script).
• Type
Numeric or String. Specifies whether to sort in numeric or alphabetical order.
• Sort order
The sort order. Specifies whether to sort in ascending or descending order.
•
Add a new sort key to the list.

•
Edit the selected sort key.

•
Delete the selected sort key.

•
Move up the selected sort key.

•
Move down the selected sort key.

12.5.2 Set Job Sender dialog box

In the Set Job Sender dialog box, you can specify users as senders of the output job.
A sender can be validated against the internal users repository.
• Default value
Select if you do not want to specify a specific user as sender of the output.
• Other
Select if you want to specify a specific user as sender of the output. You can use
variables.
• Validate sender
Select if you want to validate the sender against the internal users repository. If
the sender is not found in the internal users repository, the output will not be
delivered.
12.5.3 Runtime Output Connector Settings dialog box

In the Runtime Output Connector Settings dialog box, you configure the settings for
the selected output connector. This dialog box has two modes:
• The “Runtime Output Connector Settings dialog box – Generic layer mode”,
where you specify connector settings that apply to all physical layers.
• The “Runtime Output Connector Settings dialog box – Physical layer mode”,
where you specify connector settings for each physical layer.
12.5.4 Runtime Output Connector Settings dialog box –

Generic layer mode
This mode is activated in the Runtime Output Connector Settings dialog box when
the generic layer is activated in the Runtime configuration view.
In this mode, the dialog box is divided into a number of icons (Global Settings, Job
Begin, etc.) and when you click an icon different tabs will be available. If any
settings are configured on a tab, this is indicated by bold labels on the tab and
corresponding icon.
Post-processing scripts
You can apply post-processing specific scripts to documents retrieved from a Post-
processor repository. To enable scripting, you must select the appropriate Process
Link in the Post-processor job when you open the dialog box. You can add scripts at
the following levels:
• Job Begin – scripts to run before the job.
• Document Begin – scripts to run before each document.
• Process Begin – scripts to run before or after each Process document.

• Page Begin – scripts to run before or after each logical page.

• Document End – scripts to run after each Document.
• Job End – scripts to run after the job.
To launch the script editor, right-click the corresponding icon and select Script.

• Note
to align the text.
12.5.4.2 Post-processor tab

On this tab, you enable document sorting, enveloping of documents, and post-
processing scripts.
• Enable Document Broker
Select to enable document sorting, enveloping of documents, and post-
processing scripts.
12.5.4.3 Document Trigger tab

On this tab, you specify which variable to use as Document trigger.
• Document trigger variable
The variable to use as Document trigger.
12.5.4.4 Device driver settings tab

On this tab, you can configure device driver settings. At Process Begin you can
override the default driver settings specified in the Platform. For some driver types
you can also configure driver settings at Job Begin and Document begin. Some
driver types, for example the AFP driver, have specific settings that you must
configure at Job Begin and Document Begin.
Configure the settings of the selected device driver.
• Alias
Specify aliases for the driver settings. See “Using aliases” on page 61.
Use the following syntax in the lookup table:
Event.Process.Option.key_value Value
For example:

ev1.pr1."Print Orientation:".DEN Landscape
12.5.4.5 Device Driver Symbol Set tab

On this tab, you can override the symbol set specified for the connector. Only
applicable when sending output to PCL printers.
When sending output to a PCL printer, there you can override the symbol set in the
code page specified for the connector, and specify a different symbol set for the
printer.
• Override symbol set in default code page
Select to override the symbol set.
• Static
Select to use a static symbol set.
• Lookup
Select to use a lookup table to specify which symbol set to use. See “Lookup
alias” on page 63 for information on how to use lookup tables.
• Variable
Select to use a variable to specify which symbol set to use. See “Script alias”
on page 62 for information on how to use variables for this purpose.
12.5.4.6 Sheet Layout tab

On this tab, you can create a sheet layout for the output documents. See “Sheet
Layouts“ on page 661 for more information about sheet layouts.
• Sheet layout
The sheet layout resource to use.
• Partition
Specifies how to print logical pages on the partitions specified in the selected
sheet layout.
• First partition
The partition where to print the first logical page.
• Alias
Specify aliases for Sheet layout, Partition, and First partition. See “Using aliases”
on page 61.

12.5.4.7 Side by Side tab

On this tab, you can specify which sheet layout to use for side by side printing (2 up
printing). This can be used when printing on output media that is larger than the
actual sheet size defined for the output pages. For example, when printing two A4
side by side on an A3. See “Sheet Layouts“ on page 661 for more information about
sheet layouts.
• Sheet layout
The sheet layout resource to use.
• Partition
Specifies how to print logical pages on the partitions specified in the selected
sheet layout. Normally you keep this empty for 2UP printing.
• Alias
Specify aliases for Sheet layout and Partition See “Using aliases” on page 61.
12.5.4.8 OMR tab

On this tab, you can specify OMR codes for the output documents. See “OMR
codes” on page 650 for information about OMR codes.
12.5.4.9 Labels tab

On this tab, you can specify labels for the output documents. See “Labels”
on page 655 for more information about labels.
• Name
The name of the label. Used only as an internal reference.
• X (mm)
The distance (in millimeters) between the left edge of the label and the left border
of the sheet.
• Y (mm)
The distance (in millimeters) between the top edge of the label and the top
border of the sheet.
• Rotation (degrees)
The clock-wise rotation (in degrees) of the label.
• Side
The side of the sheet where to print the label.
• None – Do not print the label.
• Front – Print the label on the front side of the sheet only.
• Back – Print the label on the back side of the sheet only.

• Both – Print the label on both sides of the sheet.

• Place on sheets
The sheets in a document where to print the label.
• First – Prints the label on the first sheet in the document only.
• Last – Prints the label on the last sheet in the document only.
• Between – Prints the label on all sheets between first and last sheet in the
document. Does not print the label on the first and last sheet.
• Not first – Prints the label on all sheets except the first sheet in the document.
• Not last – Prints the label on all sheets except the last sheet in the document.
• All – Prints the label on all sheets in the document.
• Font
The label text font.
• Font size
The label text font size.
• Text
The label text. You can use a combination of static text and variables. You can
also use the following post-processing specific (case sensitive) variables:
• <%NumSheets> – The total number of sheets in the current document.
• <%MailMach> – The name of the mailing machine.
• <%EnvelNr> – The number of the current envelope. Every envelope gets a
unique number when it is created.
• <DOCUMENT> – The number of the current document. Documents are
numbered per segment (if defined) and mailing machine.
• <PAGEINJOB> – The number of the current logical page. Pages are numbered
per segment (if defined) and mailing machine.
• <SHEETINJOB> – The number of the current sheet. Sheets are numbered per
segment (if defined) and mailing machine.
• <PAGESINDOCUMENT> – The total number of logical pages in the current
document.
• <PAGEINDOCUMENT> – The number of the current logical page in the current
document.
• <SHEETINDOCUMENT> – The number of the current sheet in the current
document.
•
Add a new label to the list.

Edit the selected label.

•
Delete the selected label.

•
Move up the selected label.

•
Move down the selected label.
12.5.4.10 Stored Variables tab

On this tab, you can specify variables to store when storing documents in the Post-
processor repository.
The StreamServer application that retrieves the documents from the Post-processor
repository has no access to the variables used when the documents were created. To
be able to use these variables, they must be stored together with the documents. On
this tab, you specify which variables to store and make available for post-processing
of the stored documents.
• Variable
The list of variables to store.
•
Add a new variable to the list.

•
Edit the selected variable.

•
Delete the selected variable.

•
Move up the selected variable.

•
Move down the selected variable.

12.5.4.11 Document Broker Plus tab

On this tab, you specify the types and properties to be used as keys when sorting
and bundling documents.
• Custom type
Select the types that contain the properties to be used as sort keys when sorting
and bundling documents.
12.5.4.12 Process Sort Definition tab

On this tab, you can specify how to order logical pages in a Document. Note that this
is for Documents specified by Document Triggers.
• Edit Process Sort Definition
Opens the Edit Process Sort Definition dialog box, where you specify the sort
keys for sorting the pages in a Document.
You can use several sort keys, for example country code, area code, and customer
number. The StreamServer will start with the first sort key in the list. You can use
the Up/Down arrows to move the sort keys in the list.
•
Add a new sort key to the list.

•
Edit the selected sort key.

•
Delete the selected sort key.

•
Move up the selected sort key.

•
Move down the selected sort key.

12.5.4.13 Archiving tab

On this tab, you can assign types from the metadata model to the documents
delivered via the connector, and specify whether to archive the documents.
• Custom type
Select the types from the metadata model that are applied to the documents
delivered via the connector.
• Archive
Select whether to archive the documents delivered via the connector.
• Documents from successful jobs – Archives documents that are part of
successful jobs.
• All documents – Archives all successful documents from both successful and
failed jobs, but does not archive failed documents.
• No – Does not archive any documents.
• Variable – Uses a variable to determine which documents to archive.
When using variables and scripting to determine which documents to
archive, the variable must be set to true to archive and false not to archive
(true and false are case-sensitive).
• Device independent copy
Select to store device independent LXF copies of the archived documents.
Storing device independent copies requires more space in the storage since they
are stored in addition to the archived document.
• Compress document in archive
Select to compress archived documents and device independent copies of the
documents. Compressing documents may affect performance when processing
the output, but each document occupies less space in the storage.
12.5.4.14 Enveloping tab

On this tab, you can specify how to handle enveloping of documents. See
“Bundling” on page 644 for information about enveloping.

12.5.4.15 Document Sort tab

On this tab, you can specify how to sort documents. See “Sorting documents”
12.5.5 Runtime Output Connector Settings dialog box –

Physical layer mode
This mode is activated in the Runtime Output Connector Settings dialog box when a
physical layer is activated in the Runtime configuration view. The context is either
Process Begin, Document End, or Job End depending on the output mode specified
for the connector in the Platform.
If any settings are configured on a tab, the label on this tab is bold.
12.5.5.1 Connector type (File, Spool, etc.) tab

On this tab, you can override the connector settings specified in the Platform. You
specify the connector type and default connector settings in the Platform.
12.5.5.2 Receiver tab

On this tab, you can specify users as receivers of the output delivered through the
connector. A receiver can be validated against the external users repository.
• Default value
Select if you do not want to specify a specific user as receiver of the output.
• Other
Select to assign specific users as receivers of the output. You can use variables.
• Validate receiver
Select to validate the receiver against the external users repository. If the receiver
is not found in the external users repository, the output is not delivered.

12.5.6 Runtime Event Settings dialog box

In the Runtime Event Settings dialog box, you can configure runtime specific
settings for the selected Event.
This dialog box is divided into the following tabs:

• “General tab” – On this tab, you specify general Runtime Event settings.
• “Code Page tab” – On this tab, you specify code page settings for the Event.

On this tab, you specify general Runtime Event settings.
• Priority
The priority level for the Event. The higher the number, the lower the priority.
Applicable only if several Events within the same Runtime job are triggered by
the same pattern.
• Select automatically
Select to trigger the Event automatically. If not selected, the Event must be
triggered using the “CallProc” scripting function at the end of a job.
• Agent driven
Applicable for connectivity packs.
Select to pick predefined connectivity pack variables from the input data to be
used in later in the Project. For example, to set a destination path via the
SetDestPath scripting function.
Prerequisite for the Lawson connectivity pack – To use this setting for service-
enabled Messages, you must select an input connector on the Base service input
connector on list in the Runtime Message settings dialog box.
• Ignore remaining data
Select to ignore the remaining data when the trigger pattern is found. For
example, when transmitting the entire input job via a RedirectOUT Process. The
pattern must be extracted to identify the data to be transmitted, but the actual
data is sent in its original format to the RedirectOUT Process.

12.5.6.2 Code Page tab

On this tab, you specify code page settings for the Event. See “About code pages and
Unicode support“ on page 597 for more information.
• No change
Use the code page specified for the input. This is either a code page filter added
to the input connector, or a retrieved script added to the Event.
• Lookup
Use a lookup table to specify which code page to use. See “Lookup alias”
on page 63. The lookup table has the following syntax:
<key> <code page>
Lookup table example
"Western Europe" ISO 8859-1

"Eastern Europe" ISO 8859-2
Turkish ISO 8859-9
• Variable
Use a script to specify which code page to use. See “Script alias” on page 62.
• Input order
This Lookup and Variable parameter specifies the ordering of characters in
bidirectional input text.
• Logical order – Select if the input does not contain Arabic or Hebrew text in
visual order.
• Visual order – Select only if the input contains Arabic or Hebrew text in
visual order. The text is reordered to logical order.
12.5.7 Runtime Process Settings dialog box

In the Runtime Process Settings dialog box, you can configure runtime specific
settings for the selected Process.
• “Rule tab” – On this tab, you can specify rules for when to trigger the Process.
• “General tab” – On this tab, you can specify general Runtime Process settings.
• “Delivery channels tab” – Applicable for theme enabled Processes. On this tab,
you can enable or disable email features in StoryBoard.

12.5.7.1 Rule tab

On this tab, you can specify rules for when to trigger the Process. For example:
idInvoce1 AND idInvoce2
A rule accepts the operators AND, OR, and NOT.

On this tab, you can specify general Runtime Process settings. Some settings are
Process type specific. Note that PageOUT can only be used in upgraded Projects
prior to version 16.
General tab for all Process types but PageOUT and MessageOUT
Select to trigger the Process automatically. If not selected the Process must be
triggered using the “CallProc” scripting function.
General tab for PageOUT

Select to trigger the Process automatically. If not selected, the Process must be
• Mirror PageOUT
Select to mirror the object layout in PageOUT.
• Mirroring variable
Use a variable to determine whether to mirror the object layout. If no variable is
specified, the layout is always mirrored.
The variable must return 0 or 1:
1 - layout is mirrored.
0 - layout is not mirrored.
General tab for MessageOUT

• Include variables in output
Select to include scripting variables in the output. You cannot include arrays or
variables specified in after Process and after Message scripts.
General tab for StoryTeller and Adobe LiveCycle Designer ES


• Automatic Doc Trigger
Select to create document boundaries automatically for each Process.
• Discard output on failure
Select to discard the output when an error occurs in the Process (e.g. a
substitution cannot be found, or an XFA template contains errors).
If selected, all output created by the Process (e.g. a PDF file) is discarded, and the
job is marked as failed.
If not selected, some output (or no output) is forwarded to the driver. The driver
will try to process the output and, for example, create an empty PDF file or a PDF
file that only contains the pages up to the page that failed.
In both cases the job is marked as failed, and StreamServer will retry to process
the job depending on the settings on the input queue.
12.5.7.3 Delivery channels tab

On this tab, you enable or disable email features in StoryBoard.
• Email
Select to enable email features in StoryBoard. All email specific features in
StoryBoard are enabled automatically when you connect a theme enabled
Process to an email output connector (SMTP (MIME) or EasyLink Email).
• Test connector
Select output connector for test sending emails from StoryBoard:
• None – Disables test sending.
• Custom – Enables custom selection of test send connector using scripts.
• <Output connector> – Selects a fixed test send connector.
• Watermark image
Fixed watermark to be used when test sending emails from StoryBoard via an
SMTP (MIME) connector. This watermark overrides any Body background
image defined in the HTML unpaginated driver. The watermark image must be
available in the resource set, and the format must be supported by the email
clients.
Caution
There are big differences how watermark images are treated in different
email clients. For example, an email client might not support body
background images at all.
We recommend that you use test send in StoryBoard to verify that the
watermark is properly rendered in each email client of interest. If you

identify potential display issues, you must account for those issues in your
Project design, for example by adding text messages to the template.
12.5.8 Edit Output Connector Settings dialog box

The Edit Output Connector Settings dialog box opens when you double-click an
output connector (or right-click and select Settings) in the Runtime configuration
view. From this dialog box, you open the “Runtime Output Connector Settings
dialog box” in the appropriate context.
There are different contexts for configuring the output connector – you can
configure the connector per Runtime job, Process in a Runtime job, Post-processor,
or Process Link in a Post-processor. You specify the context by selecting an option in
this dialog box and clicking OK.
12.5.9 Connector Selection Method dialog box

In the Connector Selection method dialog box, you can specify through which
connector to deliver the output from the selected Process.
The standard method to create a static connection between a Process and output
connector is to draw a line between them (click-draw-release). In this dialog box,
you have the option to create a dynamic connection using aliases (see “Using
aliases” on page 61).
• None
Select if you do not want to connect the Process to any output connector.
• Static
Select if you want to create a static connection between the Process and an output
connector. Use Connector below to select the connector.
• Connector
Select the static connector.
• Lookup
Use a lookup table to select the connector. The lookup table has the following
syntax:
<key> <connector>
Lookup table example
"Mike Jones" Printer1

"Jane Smith" Printer2
• Variable
Use a script to select the connector.
• Default connector

Select the default connector. The output is sent to this connector if there is no
match in the lookup table or script.
12.5.10 Process Link Target Settings dialog box

In the Process Link Target Settings dialog box, you can view the target Message and
target Process for the selected Process Link. If the selected Process Link is not a
Default Process Link, you can edit the Process Link target.
• Target Message
Displays the current target Message.
• Target Process
Displays the current target Process.
• Set Process Link Target
Select to change the target Message or target Process. A dialog box opens where
you can select the appropriate Message and Process.
12.5.11 Runtime Message Settings dialog box

In the Runtime Message Settings dialog box, you can configure runtime specific
settings for the selected Message.

• “Service tab” – On this tab, you can enable a Message to be invoked through
service requests.
• “Job scaling tab” – On this tab, you can select to split the processing of Messages
over several threads.
12.5.11.1 Service tab

On the Service tab, you enable a Message to be invoked through service requests.
Based on one Runtime configuration, external applications use services to handle the
Messages. Depending on the type of service request, the service gateway invokes the
correct service.
When the Message is service-enabled, internal service input connectors are

automatically created at runtime and used for the incoming service requests. The
connectors are not visible in the Platform configuration.
If the Message is to be paused by an exception rule, you must select the rule resource
in the dialog box.
• Service
Select to enable a Message to be invoked by service requests.
• Enable service support for content types

Select the preview formats to be available in the application:
• application/pdf – Not applicable for the Communications Center web

applications.
• image/tiff – Not applicable for the Communications Center web applications.
• text/html – Enables unpaginated preview. Can only be used for Messages
based on StoryTeller and Template Engine Processes.
• text/html+paginated – Enables paginated preview. Can only be used for
Messages based on StoryTeller Processes.
• Use default preview connector
Select to use default preview connectors for previewing the Message in the
external application. The connectors are automatically created and selected at
preview service requests. They are not visible in Design Center.
The default preview connectors automatically use the required drivers. The
drivers are pre-configured with settings that are sufficient for most preview
scenarios.
• Service name
Enter a descriptive name of the service.
The name must be unique within the domain.
• Rule
Applicable if the Message is to be paused by an exception rule.
Select the exception rule resource that pauses the Message.
If you select several rule resources, the exception rules are evaluated, one by one,
until one rule is evaluated as true or all rules are evaluated.
• Sample file
Browse to and select the sample file for the default simulation. The default
simulation is used to preview a template in WorkShop or a theme in StoryBoard
that is connected to the Message. You can add one sample file to each Message.
To get the default simulation in WorkShop, you must create a release in the CAS
rather than deploying locally.
• Base service input connector on
Applicable for create service requests.
Select an existing input connector in the Platform configuration from which the
internal service input connectors used at create requests inherit some settings.
For example, select an existing input connector and inherit a filter chain with a
code page filter from this connector. The filter chain can be applied either directly
on the existing input connector, or can be specified per input type in the Project
Export Settings dialog box.

12.5.11.2 Job scaling tab

On the Job scaling tab you can select to split the processing of Messages over several
threads. This can be used to increase performance when processing large input
batches containing several Messages.
When job scaling is used, the processing is done as separate jobs, and there is no way
to merge the batch back automatically once it is processed. This means care must be
taken on the output side so that files are not overwritten etc.
Job scaling works both when queues are used, and when queues are not used.
Performance can be increased more when queues are not used compared to when
queues are used. In some cases when using queues and job scaling with several
threads for small Messages, performance could even decrease when enabling job
scaling. This means tuning is necessary in each Project in order to avoid decrease in
performance.
Note: Job scaling cannot be used with PreformatIN Events.
• Single thread
Use one single thread, and do not enable job scaling.
• Variable trigger
Use a variable to determine how to split the input job. All Messages that have the
same value for this variable will be processed in the same thread. There will be as
many threads used as there are values of the variable.
This can be used, for example, to split a batch of invoices by using the customer
number as variable. All invoices that belong to customer A is processed in one
thread, all invoices that belong to customer B is processed in another thread and
so on.
• Round robin
Use a fixed number of threads for the input job. Splitting is done in a round robin
manner.
Script execution of Before and After job scripts
The following applies when you have enabled job scaling:

• A script added Before the Runtime job is executed once per input job.
• A script added After the Runtime job is executed once per thread. That is, as
many times as the number of threads specified for Round robin or as the number
of variable values assigned via the Variable trigger.

12.6. Resource set dialog boxes
12.6 Resource set dialog boxes

12.6.1 Select Fonts dialog box
In the Select Fonts dialog box, you can import fonts from the Fonts directory to the
resource set.
• Available fonts
Lists all available fonts in your Windows Fonts directory. You select the fonts to
import from this list.
• Fonts to import
These fonts will be imported to the resource set.
• Add
Add the selected fonts to Fonts to import.
• Remove
Remove the selected fonts from Fonts to import.
12.6.2 Resource Type Settings dialog box

In the Resource type Settings dialog box, you can specify the resource type of the
resources. The dialog box opens automatically when you create resources using the
Import command. You can also use this dialog box to change the resource type of
resources (right-click the resource and select Resource type).
• Certificate
Certificates used for encryption and authentication. The certificate files (*.cer,
*.crt etc.) must be imported.
• Description
Description files used by StreamIN configurations.
• Filter Chain
Filter chains that can be connected to input and output connectors. A filter chain
can contain several filters.
• Font
Fonts.
• Function
Function files. A function file is a text file containing user created script
functions.
• Generic
Imported files that do not belong to any of the standard types. This type is
included in the export.

• Image
Image files (*.gif, *.jpeg, etc.).
• Non-exportable
Files that you do not want to include in the export. You may for example import
a Word or Excel document to the Project as an attachment for information.
• OutputPlus configuration
OutputPlus configuration files. Only applicable to SAP Output+.
• Private Key
Private keys used for encryption and authentication. The private key files (*.pfx,
*.p12, etc.) must be imported.
• RDI Setting
Used to import an existing incparam file. Only applicable to SAP E-docs.
• Rule
Rule functions used in rules. The rules can be used as exception rules to pause
Messages before they are formatted and delivered. If uploaded in WorkShop, the
rules can be used as selection rules on themes in WorkShop and resources in
StoryBoard.
• Sample
Sample files
• Security Configuration
Security configurations used for encryption and authentication.
• Sheet Layout
Sheet layouts.
• StoryTeller Document
StoryTeller documents.
• SXD File
SXD files.
• Table
Table files.
• XDP Template
XDP templates.
• XML Stylesheet
XML stylesheets.

12.6.3 Set Resource Editor dialog box

In the Set Resource Editor dialog box, you can specify which editor to use when
editing resources.
• Use default resource editor
Select to use the default editor for the selected resource. Only native resource
types have default resource editors. See Default resource editors below.
• Pick resource editor
Select to specify an editor for the selected resource. You must browse to and
select the appropriate resource editor.
Default resource editors
The list below shows the default editors for the native resource types.
• Description file
UTF8 Edit
• Filter Chain
Filter Chain Editor
• Function file
Script Editor
• OutputPlus configuration
UTF8 Edit
• RDI Setting
UTF8 Edit
• Rule
Rule Editor
• Sample
UTF8 Edit
Security Editor
• Sheet Layout
Sheet Layout Editor
• StoryTeller Document
StoryTeller tool
• SXD file
UTF8 Edit

• Table file
UTF8 Edit
• XDP Template
UTF8 Edit
• XML Stylesheet
UTF8 Edit
12.6.4 Select CAS resources dialog box

In this dialog box, you can select a version of a resource in the CAS and download it
to the resource in the Design Center. This will replace the resource in the resource
set with the version from the CAS. This is only available for some types of Design
Center resources.
To replace a resource with a version of the resource in the CAS
1. In the Selected resources area, select the resource.

If, no resources are available in this area, use the Find options to search in the
CAS.
2. In the Version list in the lower-right of the dialog box, select the version of the
resource you want to use.
3. Click OK.
The resource is download from the CAS. This version of the resource will
replace the version in the resource set.
Select CAS resources dialog box options
Find
Enter the search criteria to find a resource in the CAS. Leave this blank to find all
resources of the selected type.
Click <change> to change the type of resource.
Find results
The list of search results. This shows all the resources in the CAS based on the
search criteria entered.
Click <change> to change the number of search results displayed.
Add to selection
Adds the selected resource to the Selected resource area.
Selected resources
The resource you have currently selected.
Selected resources details and version
Shows the information about the selected resource.
Version – The versions of the resource available in the CAS.

Remove from selection

Removes the selected resources.
12.6.5 Show Dependencies dialog box

In the Show Dependencies dialog box, you can see all objects where the selected
resource is used.
All objects are displayed in a list. You can click the column labels to set the sort
criterion.
• Name
The name of the object where the resource is used.
• Type
The type of object where the resource is used.
• Location
The location of the object where the resource is used.
• Go to selected item
Activate the view that contains the object where the resource is used. The object
is highlighted in the view.

Chapter 13
Startup argument reference
13.1 -a
Syntax
-a <file_name>
Description
Specifies an argument file for the StreamServer to read and process.
Comment
Command line argument if the server runs stand-alone. This argument cannot
be used if you start the StreamServer from Control Center.
Example
-a start.arg
13.2 -alternativebarcode
Syntax
-alternativebarcode
Description
Specifies to use Adobe style barcodes which are used from SP2 and onwards.
This argument is used by default if the Project has been upgraded from an SP2,
SP3, or SP4 Project.
Comment
-
Example
-alternativebarcode

Chapter 13 Startup argument reference
13.3 -args
Syntax
-args <path>
Description
Specifies an argument file for the StreamServer to read and process.
Comment
-
Example
-args /usr/streamserve/extensions/extended.arg
13.4 -asynchronqueue
Syntax
-asynchronqueue <maxsize>
Description
Set the maximum number of concurrent asynchronous requests allowed for a
processing job. Default is 10 requests.
Comment
Each request handles writing of an output job to the output queue. The
asynchronous queue uses the core IO dispatch thread pool to perform the
asynchronous requests (configured in threadmanager.xml).
You can reduce the number of asynchronous requests if the processing job is
creating too much load on the database server and the output queue. The
number of asynchronous requests could also be reduced if the server
simultaneously handles several highly loaded output queues.
Note: Asynchronous queuing can only be applied to output queues.
Example
-asynchronqueue 5

13.5. -demo
13.5 -demo
Syntax
-demo
Description
Runs the StreamServer in demo mode, which does not require any license.
Comment
In the output, the text "demo" is randomly included.
Example
-demo
13.6 -detectcompccharset
Syntax
-detectcompccharset
Description
If this argument is used, the StreamServer application attempts to detect the
charset of a text resource used in WorkShop or StoryBoard. If it is not UTF-8, the
StreamServer application attempts to convert the text to UTF-8 before returning
it to the current Process (e.g. StoryTeller, Template Engine). If the text cannot be
converted, the original text used.
Comment
Using this argument affects the performance of the StreamServer application.
Example
-detectcompccharset
13.7 -disableasynchronqueuing
Syntax
-disableasynchronqueuing
Description
Disable asynchronous queuing for all output queues.
Comment
By disabling asynchronous queuing, the output jobs are processed and stored in
the output queue one after another. Note, that disabling asynchronous queuing
does not guarantee the order in which documents are delivered.
When asynchronous queuing in disabled, the job processing thread will take all
IO waits preventing it from formatting data. Asynchronous queuing will
increase performance for batch jobs 1:M. If the server mostly runs 1:1 jobs, you
should consider disabling asynchronous queuing.

Note: Asynchronous queuing can only be applied to output queues.
Example
-disableasynchronqueuing
13.8 -disablesortedqueuing
Syntax
-disablesortedqueuing <queues>
Description
Controls when sorting is used when retrieving items from the queues. Disabling
sorted queuing can result in significant performance gains in some high-volume
scenarios. The default is to use sorting for all queues. The <queues> parameter
specifies which queues you want to disable sorting for:
• -disablesortedqueuing all – Disables sorting for all queues in the current
Project.
• -disablesortedqueuing "Queue1;Queue2;Queue3;...;QueueN" –
Disables sorting for the queues listed. Sorting is used for all other queues in
the Project. Separate multiple entries with a semicolon. Note, the queue
names are case-sensitive.
Example
-disablesortedqueuing all
13.9 -dumpvars
Syntax
-dumpvars <context>
Description
Dumps variables and their values to a text file. Only variables assigned to a
value at or before the specified context are written to this file. The context is
represented by a hex value listed below. To dump the variables at all contexts,
use hex value 0xFFFF.
A file with the dumped variables and their values is created in the deployed
Project's working directory. The file name is strs_dump_vars<job_ID>.txt.
Comment
The Preproc phase (0x01) can only be used in combination with other contexts.
Example
//Enable dumping of variables assigned Before Process, execution

and Preproc phases

13.10. -education
-dumpvars 0x05 // (0x04 and 0x01)

//Enable dumping of variables assigned Before Process, Retrieved/
Collect and execution phase
//Enable dumping of variables assigned After Event, execution
and Preproc phases
Context
• Preproc – 0x01
• Retrieved / Collect – 0x02
• Before Process – 0x04
• After Process – 0x08
• Before Event – 0x10
• After Event – 0x20
• Before Job – 0x40
• After Job – 0x80
13.10 -education
Syntax
-education
Description
Runs an unlicensed version of the StreamServer in education mode for fourteen
days. After the fourteen-day period has ended, you must either use a license file
or run it in demo-mode (-demo).
Comment
-
Example
-education

13.11 -evaluation
Syntax
-evaluation
Description
Runs an unlicensed version of the StreamServer in evaluation mode for fourteen
days. After the fourteen-day period has ended, you must either use a license file
or run it in demo mode (-demo).
Note: Only applicable when the StreamServer runs in a Windows

environment.
Comment
-
Example
-evaluation
13.12 -evcollectmt
Syntax
-evcollectmt <num>
Description
Enables the XMLIN agent to distribute XMLIN Event collection over several
threads. For example, -evcollectmt 4 enables the XMLIN agent to use 4
threads for pattern matching. This can reduce the time it takes to collect an
Event.
Note: This argument works only if the XMLIN agent runs in collection
mode Document or Message. It does not work in collection mode Node.
Comment
-
Example
-evcollectmt 4

13.13. -failinputfilteronerror
13.13 -failinputfilteronerror
Syntax
-failinputfilteronerror
Description
Enables the job to be cancelled if the input filter fails.
Example
-failinputfilteronerror
13.14 -grb
Syntax
-grb <path>
Description
Only applicable if you record sample files.
Specifies where sample files are saved when you run the StreamServer with the
startup arguments -rec or -reconly.
Comment
-
Example
-grb C:\StreamServe\Server\grb
13.15 -grbcodepage
Syntax
-grbcodepage <code_page>
Where <code_page> is the name of the new code page.
Description
Only applicable if you record PageIN sample files.
Converts the code page of a recorded sample file to the code page included in
the argument.
Comment
Use this startup argument when you record sample files, where the code page in
the sample file is not supported by Communications Center. You can then use
the recorded sample file when you configure the Communications Center
Project.

Example
-grbcodepage cp866_DOSCyrillicRussian
13.16 -ignorejobdefs
Syntax
-ignorejobdefs <jobdef1> [:<jobdef2>:<jobdef3>,...]
Description
Ignores all settings done for a job definition. For example, runtime connector
and archiving settings. By ignoring job definition settings, variables defined in a
specific job keep their values across different Messages in different job
definitions.
Comment
Use this startup argument if you use an upgraded Project from 3.0.1 or earlier
where one or more Messages did not belong to a job definition. By ignoring job
definition settings this way, you emulate the behavior of the 3.0.1 (or older)
version where variable values were kept from previous Messages in the
Messages not belonging to any job definition.
If you specify to “-includejobdefs” for the same job definition, the ignore setting
overrules the include setting.
Note: This startup argument is deprecated and it may be removed in

future releases of Communications Center software without any prior
notice given.
Example
-ignorejobdefs jd1:jd2:jd4
13.17 -includejobdefs
Syntax
-includejobdefs <jobdef1> [:<jobdef2>:<jobdef3>,...]
Description
Does the opposite from “-ignorejobdefs” by including all settings done for a job
definition. This means also that all other job definitions in the job will be
ignored.
Comment
If you specify to “-ignorejobdefs” for the same job definition, the ignore setting
overrules the include setting.
Note: This startup argument is deprecated and it may be removed in

future releases of Communications Center software without any prior
notice given.

13.18. -java-options
Example
-includejobdefs jd3:jd5
13.18 -java-options
Syntax
-java-options <property>
Description
Specifies the initial naming factory property for JNDI (Java Naming and
Directory Interface).
Comment
-
Example
-java-options
Djava.naming.factory.initial=com.sun.jndi.fscontext.RefFSContextF
actory
13.19 -java-user-class-path
Syntax
-java-user-class-path <path> <path>
Description
Specifies additional paths, libraries and JAR-files from which java classes can be
loaded. This is the same as the java -classpath argument.
Comment
-
Example
Windows:
-java-user-class-path c:\jndi.jar; c:\myjavaclasses
Unix:
-java-user-class-path /usr/local/app/jndi.ar:/opt/streamserve/
myjavaclasses

13.20 -langfile
Syntax
-langfile <file_name.sls> [,<lang_code>,<lang_code>,...]
Where:
• <filename.sls> specifies the name of the language file (*.sls)

• <lang_code> specify the language codes you want to use.
Description
Used with *.sls files. Specifies the name of the language file, and the language
files within that file, to use.
• Only applicable if you use StreamServe Language Sets files in the Project.
• Only applicable for PageOUT. Note that PageOUT can only be used in
upgraded Projects prior to version 16.
Enables the StreamServer to dynamically change the language used in a

PageOUT Process.
Comment
If you specify language codes, the StreamServer will ignore any language code
not specified here. However, if you do not specify any language codes at all, the
StreamServer will read all language codes specified in the StreamServe
Language Sets file.
Example
-langfile language.sls,eng,swe
13.21 -ldapsslcertdb
Syntax
-ldapsslcertdb <file>
Where <file> is the path to the cert7.db certificate database.
Description
Enables the use of the LdapConnectSSL script function to authenticate the
connection to the LDAP server.
Comment
This argument is required if you are setting up SSL communication between the
StreamServer and the Sun (IPlanet) Directory Server (LDAP Server). Other
LDAP servers are not supported. Follow the instructions in the manual for
setting up SSL.

13.22. -ldapSslKeyDb
Example
-ldapsslcertdb cert7.db
13.22 -ldapSslKeyDb
Syntax
-ldapSslKeyDb <file>
Where <file> is the path to the key3.db key database.
Description
Enables the use of the LdapConnectSSLCCA script function to authenticate the
connection to the LDAP server.
Comment
You must use this argument together with the -ldapsslcertdb argument.
This argument is required if you are setting up SSL communication between the
StreamServer and the Sun (IPlanet) Directory Server (LDAP Server). Other
LDAP servers are not supported. Follow the instructions in the manual for
setting up SSL.
Example
-ldapsslcertdb cert7.db
-ldapSslKeyDb key3.db
13.23 -licfile
Syntax
-licfile <filename>
Description
Specifies the license file.
Comment
Can only be used as an argument when you start the StreamServer from
command line, that is it can not be used in the startup argument file (*.arg).
Example
-licfile c:\streamserve\lic\strs.lic

13.24 -localpersistpath
Syntax
-localpersistpath <path>
Description
All LOCAL mode repositories and files used locally to generate unique IDs are
stored under <exportdir>\data\data by default. You can move the directory
to a different location, and use this startup argument to specify the new path to
the directory.
Comment
If any of the following directories have been set up in an earlier
Communications Center installation, you must stop the StreamServer and move
these directories to the new location, before changing the repository path:
• <exportdir>\data\jr
• <exportdir>\data\transactions
Example
-localpersistpath C:\localdata\repositories
13.25 -logcp
Syntax
-logcp <code_page>
Description
Specifies a code page for the StreamServer log.
Comment
• Applies to StreamServers run from the command line.
• If the characters displayed in the log conform to Latin 1 you do not have to
specify this argument.
Example
-logcp cp862_DOSGreek

13.26. -logfilecp
13.26 -logfilecp
Syntax
-logfilecp <code_page>
Description
Specifies a code page for the StreamServer log file.
Comment
• Applies to StreamServers run from Control Center.
• If the characters displayed in the log conform to Latin 1 you do not have to
specify this argument.
• To enable Control Center to display "non-Latin 1" characters correctly in the
log, you must specify UTF-8 as code page.
Example
-logfilecp UTF-8
13.27 -lxfcachedynamic
Syntax
-lxfcachedynamic
Description
Turns on caching of dynamic overlays. Dynamic overlays are not cached by
default because they decrease the performance of static overlays during larger
jobs.
Comment
When enabled, dynamic overlays stay in the cache between the preprocess and
runtime phases and are not removed until after runtime is finished.
Example
-lxfcachedynamic

13.28 -lxfcachesize
Syntax
-lxfcachesize <n>
Where <n> must be an integer greater than zero.
Description
Controls the number of cache items (LXF documents) that can be stored in the
server.
Comment
The cache will always try to cache static overlays. Static overlays stay in the
cache as long as possible, and are only discarded when the server is shut down.
Dynamic overlays (created in PreformatIN) are not cached by default because
they decrease the performance of static overlays during larger jobs. To cache
dynamic overlays, see -lxfcachedynamic.
Example
-lxfcachesize 20
13.29 -maxinfiles
Syntax
-maxinfiles <n>
Description
Number of files that are scanned when directory scan is used.
The server exits when the amount of files are scanned.
Comment
For test only.
Example
-maxinfiles 5

13.30. -maxsortnodes
13.30 -maxsortnodes
Syntax
-maxsortnodes <n>
Description
Assigns a maximum number of sorting nodes.
Comment
Only applicable with sorting.
An internal list with sorting keys consumes internal memory. You can limit the
size of the list to save time (less nodes are allocated).
Example
-
13.31 -mbytefile
Syntax
-mbytefile <path>
Where <path> is the full path and file name to the required multi-byte file.
Description
A unicode startup argument. Used if the multi-byte file ssmbyte.dat is not
located in any of its ordinary directories, or if you want to use another file.
Comment
The Communications Center installation includes a default file, ssmbyte.dat,
containing conversions between Unicode and multi-byte code pages. The
StreamServer will try to locate ssmbyte.dat according to the operating system
platform you are using. However, if the file is located elsewhere, or if you want
to use another file, you can specify a different location by using the startup
argument: -mbytefile
Example
-

13.32 -msgsource
Syntax
-msgsource textfile,<lang>,<local_folder>
Where:
• textfile is a keyword that specifies that the source for log messages is a
text file.
• <lang> is the language ID specified in <Communications Center
installation>\Applications\StreamServer\<version>\Common\data
\langid.txt.
• <local_folder> is the path to and name of a separate local folder that you
create.
Description
Lets you customize logging on a per-application basis.
Comment
To customize logging for all StreamServer applications, you modify the
<Communications Center installation>\Applications\StreamServer
\<version>\Common\data\logmsg.txt file.
To do this for a separate StreamServer application you can:
1. Copy the logmsg.txt and langid.txt files from <Communications Center

installation>\Applications\StreamServer\<version>\Common\data\
to a separate local folder.
2. Modify the logmsg.txt file.
3. Add the startup argument.
Example
-msgsource textfile,STRS_ENG,C:\local_log_folder
13.33 -norecgrb
Syntax
-norecgrb
Description
This argument is used together with the -rec argument.
The -norecgrb argument instructs the StreamServer not to generate separate
sample files for each input page. See the -rec argument for more information.
Comment
-

13.34. -nstack
Example
-norecgrb
13.34 -nstack
Syntax
-nstack <n>
Description
Specifies the size of the script expression size stack. Default is 50.
Comment
Rarely used. You can receive an "overflow" by using extremely large
mathematical expressions.
Example
-
13.35 -odbcpool
Syntax
-odbcpool <n>
Description
Enables the ODBC connection pool used by the Communications Center
scripting functions and specifies the maximum number of objects in the pool.
Comment
-
Example
-odbcpool 10
13.36 -odbctimeout
Syntax
-odbctTimeOut <n>
Description
Specifies the time-out value that the StreamServer uses for connecting to data
sources. The value is in seconds.
Comment
If no value is specified, the default value, 30 seconds, is used.
Note: After a connection has been established, this argument is not

applicable.

Example
-odbctimeout 60
13.37 -optalias
Syntax
-optalias <file_name>
Description
Overrides the default overlay alias file name (optalias) with the specified file
name.
Comment
• optalias is a default alias file name.
• optalias is a lookup table. This could be another way of loading a lookup
table.
Example
-optalias new_alias.txt
13.38 -parse
Syntax
-parse
Description
Reads syntax to see if it is correct and then exits.
Comment
Use this argument for syntax testing before runtime. For example to test *.dux
files.
Example
-parse

13.39. -pid
13.39 -pid
Syntax
-pid <filename>
Description
Enables the StreamServer to write its PID in the specified file at start-up. The
PID can be used later for termination.
Comment
-
Example
-
13.40 -preloadmorefontdata
Syntax
-preloadmorefontdata
Description
Improves performance by pre-loading all font data required for text layout
calculations in the XFA Processor. This will generally reduce the need for
drivers to load additional font data which also can improve performance.
However, an increase in startup time and runtime memory consumption can be
expected.
Comment
-
Example
-preloadmorefontdata
13.41 -prn
Syntax
-prn <path>
Description
Only applicable if you use PRN overlays.
Specifies the path for overlay files.
Comment
• The path is specified in relation to the <Application root> directory.
• If you insert the -prn argument before the <file_name.dua> argument, this
argument overrides the directory specified in the Communications Center
configuration.

Example
-prn files
13.42 -prnalias
Syntax
-prnalias <file_name>
Description
Overrides the default overlay alias file name (prnalias) with the specified file
name.
Comment
• prnalias is a default alias file name.
• prnalias is a lookup table. This could be another way of loading a lookup
table.
Example
-prnalias new_alias.txt
13.43 -quealias
Syntax
-quealias <file_name>
Description
Overrides the default connector alias file name (quealias) with the specified file
name.
Comment
-
Example
-quealias new_alias.txt

13.44. -rec
13.44 -rec
Syntax
-rec
Description
Instructs the StreamServer to record the input data and create sample files. In
addition to creating the sample files, the StreamServer also creates ordinary
output data via a PageIN Event and an appropriate Process. If you only want to
create a sample file, and no output data, you must use the -reconly argument
instead of the -rec argument.
The sample files are created in the directory specified by the -grb argument. The
following sample files are created:
• <event name><sequence number>.grb. Each page recorded generates a
separate sample file. You can use the -norecgrb argument together with -
rec if you do not want to generate these sample files.
• allpages.<input connector name>. Each page recorded is appended to this
sample file.
Comment
The number of columns and lines that are recorded and included on one page in
the <event name><sequence number>.grb file, is based on the page size in the
PageIN configuration:
• Columns outside the specified page size are discarded.
• Lines outside the specified page size are included in the following <event
name><sequence number>.grb file.
The allpages.<input connector name> sample file is not affected by the page
size specified in the PageIN configuration. All columns and lines are recorded
and included in the file.
Example
-rec

13.45 -reconly
Syntax
-reconly <columns>,<lines>
Description
Instructs the StreamServer to record the input data and create a sample file. If
you also want to create output data you must use the -rec argument instead of
-reconly.
All pages recorded are appended to the sample file allpages.<input
connector name>. This file is created in the directory specified by the -grb
argument.
Comment
You must specify values for <columns>,<lines>. These values are only for
backward compatibility and are ignored by the StreamServer.
You can also specify record-only mode in the Platform configuration.
Example
-reconly 140,100
13.46 -reducenotifications
Syntax
-reducenotifications
Description
Instructs the server to only generate notifications with a requested type.
Comment
When running large input jobs it is more efficient to use -
reducenotifications than to store all notifications and let the observer choose
among them. The methods may be combined.
Example
-reducenotifications

13.47. -rmlog
13.47 -rmlog
Syntax
-rmlog <file>
Description
Ensures that the log file is deleted and recreated at startup.
Comment
The -rmlog argument does not work if you run the StreamServer as a service.
Example
-rmlog ./logs/strs.log
13.48 -shareddatapath
Syntax
-shareddatapath
Description
Specifies the installation catalogue with the configuration files.
Comment
The “config” in the server directory is default in Unix. This option is used to
specify another directory path for configuration files.
Example
-shareddatapath <config directory>
13.49 -smtppoolsizemax
Syntax
-smtppoolsizemax <n>
Description
The maximum number of connections that can be stored in the SMTP connection
pool.
If the maximum number of connections is reached, new connections can only be
created if temporary objects are enabled. Note that temporary objects are
enabled by default.
Comment
The SMTP connection pool is used by SMTP (MIME) output connectors when
sending emails to the SMTP server. You can use this startup argument with -
smtppoolsizemin and -smtppooltempdisable to control the number of
connections that are always stored in the pool and the maximum number of
connections that can be used.

Example
-smtppoolsizemax 10
13.50 -smtppoolsizemin
Syntax
-smtppoolsizemin <n>
Description
The minimum number of connections that are always stored in the SMTP
connection pool.
Comment
The SMTP connection pool is used by SMTP (MIME) output connectors when
sending emails to the SMTP server. You can use this startup argument with -
smtppoolsizemax and -smtppooltempdisable to control the number of
connections that are always stored in the pool and the maximum number of
connections that can be used.
Example
-smtppoolsizemin 5
13.51 -smtppooltempdisable
Syntax
-smtppooltempdisable
Description
Prevents SMTP (MIME) output connectors from creating temporary connections
to the SMTP server.
Comment
The size of the SMTP connection pool is 0 by default, so if you use this startup
argument you must configure the number of connections stored in the pool by
using -smtppoolsizemin and -smtppoolsizemax.
Example
-smtppooltempdisable

13.52. -sortdef
13.52 -sortdef
Syntax
-sortdef <filename>
Description
If you use the sort script function to sort processes, you must include an ASCII
file, usually named sortdef in the startup argument file. The -sortdef
argument contains sort definitions.
Comment
-
Example
-sortdef sortdef.txt
13.53 -sprog
Syntax
-sprog <n>
Where <n> specifies a number greater than 500.
Description
Allocates memory for scripts, for example the total number of bytes in the
memory area. The default size is 10,000.
Comment
Only use this argument if you need to allocate more than 10,000 bytes.
Example
-sprog 25000
13.54 -statusreporter
Syntax
-statusreporter
Description
Tracking and status reporting in a shared queue environment requires that one
StreamServer is defined as the status reporting server. You use this startup
argument to define a StreamServer as the status reporting server.
Comment
-

Example
-statusreporter
13.55 -stdin
Syntax
-stdin <file_name>
Description
Assigns a file to the StdIn file descriptor.
Comment
This argument is only valid when using the StdIn input connector.
Equivalent with redirection in CommunicationServer <file_name>
Example
-
13.56 -streamcache
Syntax
-streamcache <maxsize>
Description
Set the maximum number of cached streams per queue. Default is 50.
Comment
This argument is global, and is applied to all queues used by the StreamServer
application.
The stream cache is used as an optimization between the input queue and the
job, and between the job and the output queue. You can reduce the number of
cached streams per queue if the server runs out of temporary stream objects.
Reducing the number of cached streams per queue will also reduce the memory
and resource consumption.
Example
-streamcache 100

13.57. -streamcachetimetolive
13.57 -streamcachetimetolive
Syntax
-streamcachetimetolive <time>
Description
Specifies the time out value for the stream caches (that is, how long blob data
remains in a stream cache before being expired). The value is in seconds.
Comment
If no value is specified, a default value of 5 seconds is used.
This argument is global, and is applied to all queues used by the StreamServer
application. Each queue has its own stream cache, where a maximum number of
data streams can be stored (by default, 50 data streams).
The stream cache is an optimization used to reduce database readings when the
same server queues and processes queue items. In a situation where several
servers are spooling queue items from the same queue, it is not guaranteed that
the same server that placed an item in the queue is the one picking it up for
processing. If a different server picks up the queue item for processing, it will
introduce a cache miss, forcing the processing server to read back the data from
the database. If this occurs frequently, it could be beneficial to reduce the
timeout value for the stream cache. The timeout can also be reduced in order to
save memory and resources.
Example
-streamcachetimetolive 2
13.58 -sync
Syntax
-sync
Description
Synchronizes output jobs with the input processing. The status of the output job
is propagated back to the processing job. This argument can be necessary to get
correct status returned by the GetJobStatus() script function.
Comments
• This argument can reduce performance of the server.
• Jobs are processed in sequence from when the input is received to when the
output is produced.
• Priority on the connectors is ignored if -sync is used.
Example
-sync

13.59 -tbl
Syntax
-tbl
Description
Assigns a path to the tbl-files (filter).
Comment
Is comparable to -prn
Example
-
13.60 -td
Syntax
-td <path>\<directory>
Description
Specifies the path and name of an alternative temporary directory for a Project.
Comment
The default temporary directory (tmp) resides in the working directory and can
grow unrestricted. Use this argument to specify an alternative temporary
directory outside the working directory.
Note: Specify a directory that the StreamServer can easily and quickly
access.
Example
-td D:\StreamServe\TemporaryDirectory
13.61 -tmpcompress
Syntax
-tmpcompress
Description
Compresses certain temporary files during the collect/preprocess/output sort
phase.
Comment
More CPU resources are used when using this argument, but less writing to disk
is performed.
This means if you have really fast CPUs and slow disks, this argument can
increase performance considerably. In the unlikely case that you have slow

13.62. -v
CPUs and fast disks, it could do nothing, or decrease overall performance

slightly.
If a system's disk cache has a high hit rate, and does not fill up, this argument is
usually unnecessary. This is often the case with real-time jobs.
If, during times of peak load, disk utilization is high but CPU utilization is low,
then this argument will usually help. This is often the case with batch jobs,
particularly large ones.
Example
-tmpcompress
13.62 -v
Syntax
-v
Description
The StreamServer prints its version on standard error.
Comment
-
Example
-v
13.63 -var
Syntax
-var <variable_1>=<variable_2>
Description
Creates a variable when starting the StreamServer application. For example, if
you want a variable that is available to an input filter.
Comment
The variables are read-only and cannot be changed later.
Example
-var dest=file.txt

13.64 -wsin
Syntax
-wsin <file>
Description
Records a list of all incoming data that the StreamServer identifies. The list is
recorded in the specified file.
Use the -wsin argument to produce a file containing a copy of the Message,
showing the actual data in the Fields and Blocks that you have specified, and in
the order in which Communications Center will process them.
Comment
This argument is used during the testing phase since it is able to copy
everything that will be processed in a file(s).
Example
-
13.65 -xmlunusedattributes
Syntax
-xmlunusedattributes include|ignore
Description
Used to reduce memory usage for XMLIN Events.
• Using -xmlunusedattributes ignore causes the XMLIN parser to ignore

attributes that are not included in XPath patterns or expressions in XML
Events. The ignored attributes are not included in the XMLIN DOM, which
means the size of the DOM tree can be reduced significantly. This will not
work properly together with XML validation (XML schema or DTD) since
validation errors may occur due to missing attributes. This will also not work
with XPaths that do not match a specific name, for example @*.
• Using -xmlunusedattributes include causes the XMLIN parser not to
ignore any attributes. This is the default server behavior, and is the same as
not using the -xmlunusedattributes startup argument.
Comment
-
Example
-xmlunusedattributes ignore

13.66. -xmlwhitespacenodes
13.66 -xmlwhitespacenodes
Syntax
-xmlwhitespacenodes include|ignore
Description
Used to reduce memory usage for XMLIN Events.
• Using -xmlwhitespacenodes ignore causes the XMLIN parser to ignore all
“white space only” nodes in the XMLIN DOM, which means the size of the
DOM tree can be reduced significantly.
• Using -xmlwhitespacenodes include causes the XMLIN parser not to
ignore any nodes. This is the default server behavior, and is the same as not
using the -xmlwhitespacenodes startup argument.
Comment
-
Example
-xmlwhitespacenodes ignore
Example 13-1: Using -xmlwhitespacenodes ignore

Input document:
<root>
<doc>
<field>value</field>
<other>
Value
</other>
</doc>
</root>
Document parsed when -xmlwhitespacenodes ignore is used:
<root><doc><field>value</field><other>
Value
</other></doc></root>
All nodes that only contain white space have been removed. Nodes that
contain both white space and non-white space are still included.

13.67 -xsdimport
Syntax
-xsdimport 0|1
Description
Used together with XMLIN Events and XML schemas. Specifies when to load
the XML schemas defined in the namespace/schema location mapping table.
Any settings in the mapping table will override -xsdimport.
• 0: load the schemas at StreamServer start-up.
• 1: load a schema when receiving input related to the schema. The schema
must be read and parsed before validation.
Comment
-
Example
-xsdimport 1

Part 2
Metadata management
Chapter 14
About metadata models
A metadata model is a representation of the properties that you can attach to

Communications Center documents or Messages. Some examples of how properties
can be used include:
• To write personalized texts in StoryBoard and ReTouch

• To sort and envelope documents and use other post-processing features
• To show information about documents paused in Supervisor in the Review view
As a tenant organization or company, you create one metadata model which

contains all the properties that can be used in your Communications Center
solutions. This means that all the Projects and Communications Center applications
for a tenant are connected to the same metadata model. Properties in the metadata
model are arranged into containers called types. The types are part of the model that
are attached to the Message or Documents in Design Center.
The metadata model is stored in the tenant repository. The same model is accessed
both at design time, from Describer and Design Center, and by the Communications
Center applications at runtime. The same metadata model is also used across
development, testing, and production environments. The metadata model is
versioned. Each time a change is made to the metadata model and the model is
checked-in, a new version of the model is created in the tenant repository.
The properties and types you create in the Describer replace the document types and
metadata that were used in OpenText StreamServe 5.x versions.
How the metadata model works with Projects and StreamServer

applications
1. Model designed - In Describer, a user builds a model of the types and properties
required for the documents in your tenant organization or company. The user
then checks in the model, which saves it in the tenant repository.
2. Model connected to a Project - In Design Center, a user connects the Project to

the management gateway and downloads the metadata model from the tenant
repository.
3. Types attached to Messages, document broker documents, or archived

documents - The Design Center user decides which types to attach to each
Message, document broker documents, or output queue items. When the user
connects the types to the Message or documents, the appropriate system type is
also attached to the Message or documents. This creates a custom type for the
Message, document broker document, or output queue item.

Chapter 14 About metadata models
4. Project exported - When the Project is exported, the versions of the types used in
the Project are mapped to corresponding versions of the types in the model in
tenant repository.
5. StreamServer applications access the model - At runtime, the StreamServer
applications access the types in the tenant repository and apply the correct
properties to the generated documents.
What happens when a model is updated?

1. Model updated - In Describer, a user makes a change to a model, for example
adding a new property or type. The user checks in the model, which saves a new
version of the model in tenant repository.
The Describer user informs the Design Center user that there is a new version of
the model available.
2. Design Center user downloads the new model - In Design Center, the user
downloads the new version of the model to the Project.
3. Changes to types attached to Messages, document broker documents, or
output queue items - The Design Center user decides whether change the
version of the model used for any existing Messages or documents, and whether
to attach any new types to the documents or Messages. This creates a new
custom type for the Message or document.
4. Project exported - When the Design Center user exports the Project, any new or
changed versions of the types used in the Project are mapped to corresponding
versions of the types in the tenant repository.
5. StreamServer applications access the model - If the Design Center user changed
the versions of the types used in the Project, the StreamServer applications use
the new versions of the types in the tenant repository.
If the Design Center user did not change the versions of the types used, the
StreamServer applications continue to use the existing versions of the types in
the tenant repository.

Chapter 15
Creating a model in Describer
15.1 Getting started with Describer

Describer is the application where you create the metadata model. To work in
Describer, you need to create a connection to a management gateway.
From Describer, you can open and work on models that belong to different tenants.
If you work with multiple tenants, you enter the tenant name when you connect to
the management gateway. In distributed environments, you can connect to any
management gateway that is connected to the Communications Center environment
to access a metadata model.
Before you begin
• Access control for Describer is provided by OpenText Directory Services (OTDS).

Before you can log on, you must be assigned the tenant administrator or tenant
user role in OTDS.
• Describer must be installed. It is part of the Control Center setup.
Steps – Working on a model for the first time
1. Open Describer. For example, on Windows Server 2012, from the Apps screen,
click the Describer shortcut in the OpenText category.
2. Create a connection to a management gateway See “Setting up a management

gateway connection” on page 366.
3. Open the blank model from the tenant repository. See “To open a model from
the tenant repository“ on page 366.
4. Check out the model. See “Checking in and out models” on page 367.
Steps – Working on a model on subsequent occasions
1. If you have previously worked on a model, you can either open the local version
of the mode or open the model from the tenant repository. See “Opening a
model” on page 366.
2. If you do not have the model checked out, check it out. See “Checking in and out
models” on page 367.

Chapter 15 Creating a model in Describer
15.1.1 Setting up a management gateway connection

Control Center, Design Center, and Describer use the same settings to connect to the
management gateway. If you have already set up a management gateway
connection in another one of these applications, it is available here.
1. If the Open Model dialog box is not already open, click File > Open to open it.
2. In the Connections area, click Add.
3. Enter a name for the connection, and the host and port for the management
gateway:
• Host
The address of the computer with the management gateway. For example:
https://localhost.
• Port
The port used for communication with the management gateway. The
default port is 28300.
4. Optional Change the default time-out settings:
• Connect time-out (milliseconds)

The time Design Center, Describer, and Control Center wait when trying to
establish a new connection to the management gateway.
• Send and receive time-out (milliseconds)
The time Design Center, Describer, and Control Center wait for responses
from the management gateway after the initial connection is established.
Tip: To edit the connection details, click Edit or to remove a connection,

click .
15.1.2 Opening a model

To open a model from the tenant repository
1. In the Open Model dialog box, in the Connections area, double-click the
connection to the management gateway.
2. Enter your tenant name, user name, and password.
To open a local copy of a model
• In the Open Model dialog box, in the Locally available models area, double-
click the model.

15.1. Getting started with Describer
15.1.3 Checking in and out models

Because several users may need to work with the same model, you must check out a
model before you can make changes. Checking out the model locks it preventing
other users from making changes at the same time. While a model is checked out,
any changes made are stored in a copy of the model on the disk. When you check in
the model, a new version is stored in the tenant repository and you can choose to
unlock the model or retain the lock so you can continue working later.
To check out a model
1. On the toolbar, click Check-out (lock) model.
2. If prompted, enter your tenant name, user name, and password to connect to
the management gateway.
To check in your changes
1. On the toolbar, click Check-in changes.
3. Enter a label and a description (optional).
4. Optionally, select Keep model checked out, to keep the lock on the model.
To revert and discard your changes
This reverts the model back to the last version that was checked in. Any changes
made to the model after the last check in are lost.
1. On the toolbar, click Undo check-out.
3. Click Yes to confirm the action.
To save your changes locally
• Click File and then Save.
To close Describer
• Click File and then Exit.

15.2 Concepts of modelling properties and types

In the model, you create a list of all the properties you want to use in your
Communications Center solution and arrange the properties into types. A type is a
container for the properties of an entity. Some examples of types include people,
countries, or types of documents. You set up types in a tree structure, which allows
you to create a hierarchy where sub types inherit properties from parent types. The
tree can have as many levels of types as required.
The types are the part of the model that you connect to the Messages or documents.
You can connect several types from different levels in the tree to a single Message or
document.
About inherited properties in the types tree

In the types tree, the properties of a parent type are inherited by the sub types.
Example 15-1: Inherited properties
a. Parent type – This type contains two properties xxx and yyy.
b. Sub types – These types inherit the properties xxx and yyy from the
parent type.
About adding and removing properties to the types tree

You can add and remove properties to types in the tree in the following ways:
• You can add new properties to a type at any level in the tree. New properties
added to a type are automatically inherited by the sub types.
• You can restrict an inherited property in a type. Restricting a property removes it
from the type and prevents it from being inherited by the sub types. You can re-
add restricted properties to the sub types or to the types that descend from the
type.
• You can add the same property to several types that are not connected tree.

15.3. Creating properties and types in the model
Example 15-2: Adding and removing properties
a. A new property added to a type – This property is not part of the parent
type. It is inherited by sub types.
b. Restricted property – This property is removed from the type. It is not

automatically inherited by the sub types F and G, but can be manually
re-added.
c. Property used in two types – In this example, both type E and F descend
from Type A. You can also add the same property to types that do not
descend from the same type.
15.3 Creating properties and types in the model

15.3.1 Adding properties to the model
To add a property to the model
Each property must have a unique combination of name and data type (string,
integer, etc.).
1. In the All Properties area, click the Add new property icon.
2. In the Property name dialog box, enter the a name for the property and click the
Property type.
3. Optionally, enter a description and click OK.

To make a copy of a property
1. In the All Properties area, right-click the property you want to copy and click
Copy.
2. Right- click in the All Properties view and click Paste.

A copy of the property is added to the list.
To change the property name, type, or description
1. In the All Properties area, double-click the property.
2. Change the name, property type, or description and click OK.
To refresh the Describer view
This refreshes the names of the properties, etc. displayed in Describer.
• On the toolbar, click the Refresh model icon.
Searching for properties

You can use the filters to search for properties in the All Properties and Selected
Type areas. The search is based on the property name by default. You can change
this to search in the description, key, or all the property fields.
To search for properties
• In the All Properties or the Selected type area, in the Filter: box, enter the
search criteria.
To remove the filter, click .
To change the property fields the search is based on
1. In the All Properties and Selected Type area, click Filter on: <Field name>.
2. Click the fields to search in and then click OK.
15.3.2 Creating the types tree

You can add types to the root node of the tree or add a sub type to an existing type.
Sub types added to the tree inherit properties from the parent type. Types added to
the root node do not contain any properties until you manually add them.
When you copy or move a type in the tree, the inherited properties of the type are
updated to reflect the new parent. Properties that are inherited from the new parent
are added and properties that were inherited from the previous parent type are
removed. However, if the new parent type contains a property that was restricted in
the original type you are copying or moving, this property is not added to the type.

To add a type to the tree
1. In the Model tree area, right-click the root node or the parent of the type, and
then click Add Type.
2. Enter a name for the type and press ENTER.
To make a copy of a type
1. In the Model tree area, right-click the type you want to copy, and then click
Copy.
2. Right-click the type that will be the parent of the new type and click Paste.
A copy of the type is added to the tree.
To move a type in the tree
1. In the Model tree area, click the type you want to move.
2. Drag the type to the new location in the tree.
To rename a type or the root node
1. Click the type or the root node in the Model tree area and press F2.
2. Enter the new name and press ENTER.
15.3.3 Using properties in the types

You can add new properties to a type at any level in the tree. New properties added
to a type are automatically inherited by the sub types of the type. You can add a
single property to several types that are not connected in the tree.
You can restrict an inherited property in a type or remove a property that you have
added to the type previously. When you restrict or remove a property, the property
is removed from the type and from the sub types of the type.
To add a property to a type
• In the All Properties area, click the property and drag it to the type in the
Model tree area.
The property is added to the type and all to sub types of the type.
To restrict an inherited property in a type
1. In the Model tree area, click the type.
2. In the Type content area, click Inherited.
3. Clear the check box beside property you want to restrict.

The property is removed from the type and all sub types of the type. The
property is still available in the All Properties are.

To see which types a property is used in
• In the All Properties view, click the property.

The types that contain the property are highlighted in the Model tree area.
To remove a property from a type
2. In the Type content area, click the property you want to remove and then click
.
The property is removed from the type and all sub types of the type. The
property is still available in the All Properties area.
To view the local and inherited properties of a type
In the Selected Type area, you can see the local and inherited properties that are
included in type.
2. In the Selected Type : <type name> area, click one of the following:
• Local
To see the properties that are added directly in type.
• Inherited
To see the properties that are inherited from the parent type.
• Included
To see both the local and inherited properties. Restricted properties are not
shown in this list.
To find the GUID for a type
1. In the Model tree area, right-click the type.

In the Selected Type area, you can see the GUID for the type beside the Type
key label.
2. Optionally, in the Selected Type area, click Copy to copy the GUID to the
clipboard.
To find the GUID for a property
• In the All properties area, right- click the property and click Copy key. The
GUID is copied to the clipboard.

15.3.4 Deleting types and properties

To delete or hide a type
When you delete a type, all the sub types of the type are also deleted. You cannot
delete types that have been checked-in, however you can hide these in the types tree
in Describer.
1. In the Model tree area, click the type you want to delete or hide.
2. Click .
To delete a property
You can only delete Properties that are stored in your local copy of the model. It is
not possible to delete a property that has been checked-in to the tenant repository.
1. In the All Properties area, click the property you want to delete.
2. Click .
3. If the property is used in a type, click Yes to confirm you want to delete the
property.
The property is removed from the All properties list and all the types is was
part of.
15.3.5 Versioning of models and types

Changes made to models and types are tracked by version numbers. New version
numbers for models and types are generated when the model is checked in. The
model version number is used to select the correct model when you add the types to
the Messages, output queue items, or document broker documents in Design Center.
A new version number for the model is created every time you check in the model.
However, not all changes you make to types trigger a new type version number
during check in. For example, if you only change the type names, no new version
number is generated when you check in the model.
Viewing previous versions of models and types

To view a previous version of a model
1. Open the model.
2. In the Model Version: list, click the version of the model you want to view.
To view a previous version of a type
1. Open the model.

3. In the Selected Type area, on the Type version list, click the version of the type
you want to view.
Viewing the version history of a model or type

You can view the version history of the model. The version history includes the time
the model was checked-in, the label, comment, and the key of the model or type.
From Describer, you can also view details of the model, such as the model key,
information about the last updates made to the model, as well as statistics for the
model, such as the total number of types and properties in the model.
To view the version history of a model
• On the Model menu, click View all labels .
To view the version history of a type

2. In the Selected Type area, click <view all> beside Labels.
To view the model details
• On the Model menu, click View model details.
15.3.6 Deleting a local model

Important
You cannot recover a local model that you delete. Changes that you have
made in the local model that have not been checked in will be lost.
To delete a local model
• In the Open Model dialog box, in the Locally available models area, click .
15.3.7 Copying a model, types, or properties from another

tenant
From Describer you can copy an entire model, a type, or a property from one
tenant’s model to another tenant’s model.
You copy an entire model by copying the root level of the model tree, this copies all
the types and properties in the model. You can paste the model into any level of the
types tree in the target model. When copying types from one model to another, the
local properties added to a type are copied while the inherited properties are
updated to reflect the types new position in the tree.
Generating new keys for the types and properties

Each key, type, and property in a model has a key that is unique within a single
model. When you copy a model, you can choose whether to copy the keys into

the target model or to generate new keys in the target model. If you want to use
the target model in a Design Project with scripts that reference keys in the
existing model, you must copy the keys into the target model (i.e. do not
generate new keys).
To copy an entire model from another tenant
1. Open both models in Describer and check out the target model.
2. In the model you want to copy, in the Model tree area, right-click the root node,
and then click Copy.
3. Open the model you want to copy to, in the Model tree area, right-click the root
node, and then click Paste.
4. Optional Select Generate new keys for all copied Types and Properties.
To copy a type or property from another model
1. Open both models in Describer and check out the target model.
2. In the model you want to copy the type or property from, do one of the
following:
• To copy a type and its local properties

In the Model tree area, right-click the type node, and then click Copy.
• To copy a single property
In the All properties area, right-click the property, and then click Copy.
3. In the target model, do one of the following:
• To paste a type and its local properties

In the Model tree area, right-click the parent type, and then click Paste.
• To paste a single property
Right-click in the All properties area, and then click Paste.
See also:
• “Importing and exporting models“ on page 395 – For information about how to
import and export an entire model.

15.4 Controlling access to the types

It is possible to control which OTDS groups can update and use the types in a
model. For example, you may want to restrict which OTDS groups can use certain
types in Design Center or which OTDS groups are able to make changes to the types
in Describer. If you do not change the default permissions for the model or types,
then tenants administrators have write permissions to all types and the other
Communications Center groups have use permissions.
Permissions can be set for each version of each type in your model. Permissions set
up for a type are not inherited by sub types. Setting up permissions for types
individually is useful if you have types that only some groups are allowed to change
or use.
Each type has an owner, which by default is the tenant administrator. The type
owner always has use and write permissions for the type regardless of the groups
you grant or remove the access for. You can change the type owner to any OTDS
user or group.
Tip: Only tenant administrators have the permissions to make changes in a

model in Describer. So if you change the type owner to another group, this
group will not be able to change the ownership for the type or change the
permissions for the type.
Permissions
• Groups with write permissions
• Can make changes to the type in Describer, for example by adding or

removing properties to the type.
• Can delete the type in Describer.
• Can view the type in Design Center, providing the group also has the use
permission to the parent type.
• Can attach types to Messages or documents in Design Center.
• Can change the permission settings for the type.
• Can change the owner of a type.
• Groups with use permissions
• Can view types in Design Center, providing the group also has the use
permission to the parent of type.
• Can attach types to Messages or documents in Design Center.
In Describer, all the types can be viewed by all users. This cannot be changed for
any group.

15.4. Controlling access to the types
Notes about types and permissions

When working locally, you may be able to make changes to types that you don't
have permissions for, but when you try to check in the model you will receive
an error.
Setting the access permissions for a type

To change the access permission settings for a type
2. In the Selected Type area, beside the Owner label, click Change.
3. In the Permissions for <type_name> dialog box, in the Groups list, select the
OTDS group that you want to set the permissions for. If the group is not shown
in the Permissions dialog box, click the Add icon to search for the group, see
“Searching for OTDS groups or users ” on page 377 below.
4. In the Permissions granted for: area, select the appropriate permission: Write
or Use.
To change the type owner
2. In the Selected Type area, beside the Owner label, click Change.
3. In the Permissions for <type_name> dialog box, beside the Owner label, click
Change.
4. In the Find query box, enter your search parameters, for example strs. For
more information about searching, see “Searching for OTDS groups or users ”
on page 377.
5. In the Search results area, click the group or user you want as the type owner.
6. Click OK.
Searching for OTDS groups or users

By default the Permissions dialog box only shows the Communications Center
OTDS groups, however it is possible to find any group or user in OTDS.
To search for OTDS groups or users
1. In the Permissions dialog box, click Add.
2. In the Find query box, enter your search parameters.

You can use the wildcard character (asterisk *) in your search criteria.
3. Optional Click Change to select different OTDS fields to search.
4. Optional Click Use strict search to find an exact match of your search string.

5. In the Search results area, select the groups you want to add to the Permissions
dialog box where you grant the group a permission to the type.

Chapter 16
Using a metadata model in Design Center
16.1 Selecting the model for a Design Center Project

You use Design Center to connect the types to documents or Messages. Each Project
can be connected to one metadata model, which is done by connecting the Project to
the management gateway. When you select the model for a Project, a local copy of
the model is saved in the Project. You can then apply the types from the local model
to documents or Messages.
To select a model for a Project
1. Connect the Project to the management gateway. For more information, see
“Setting up a management gateway connection” on page 50.
2. On the MGW menu, click Update Project Meta Model.
3. Click Check for new versions... The management gateway checks if any new
versions of the model are available.
4. Click Yes to save the new versions of the model in the Project.
5. Click OK.
To delete a local model from a Project
Deleting the local model removes the local model from the Project, which also
removes any types from the Messages or documents.
2. Click Delete current model and then click Yes.
See also:
• “Importing and exporting models“ on page 395 – For information about how to
export a model from Design Center and import a model in Describer.

Chapter 16 Using a metadata model in Design Center
16.2 Applying types to documents or Messages

You can apply types to Messages, document broker documents, or output queue
items (Archiving tab). You can connect several types from different levels in the tree
to a single Message, document broker document, or output queue item. In one
Project, you can also connect types from different versions of the model to different
Messages, document broker documents, or output queue items. To save space in the
repositories, we recommend that you only connect the types that you need.
Figure 16-1: Example of connecting types to a Message
Custom types and system types

When the types are connected to a Message, document broker document, or
output queue item, a custom type is created. The custom type contains all the
types linked to the Message, document broker document, or output queue item,
as well as the appropriate system type for the context (e.g. Message, output
queue item, or post processing). The system type contains the predefined
properties that are always available for a Message, output queue item, or
document broker document.
Where to connect the types in Design Center
The place in Design Center where you connect the types depends on how you want
to use the properties:
• To use the properties for output queue items or to make use of post processing
features, connect the types to an output connector in the runtime configuration.

16.2. Applying types to documents or Messages
• To use the properties in the web applications, connect the types to the Message.
Tip: If you don’t see the latest model versions downloaded to the Project, click
the Refresh icon on the menu bar.
To connect types to a Message
1. Right-click the Message configuration and then click Set Custom Meta Types.
The Define Custom Type dialog box opens.
2. In the Model version list, click the version of the model you want to use.
3. Select the types you want to connect to the Message, and then click OK.
To connect types to output queue items
1. In the Runtime configuration view, open the Runtime Output Connector

Settings dialog box (generic layer).
2. Depending on the output mode, click either Process Begin, Document Begin, or
Job Begin.
3. Click the Archiving tab and beside Custom Type click browse.
5. Select the types you want to connect to the documents and then click OK.
To connect types to documents for post processing
1. In the Runtime Output Connector Settings dialog box for the Document Broker
Plus connector, activate the generic layer and click the Document End icon.
2. On the Document Broker Plus tab, click the icon beside the Custom type box.
To copy the types selected for a Message or document to another Message or

document
1. In the Define Custom type dialog box, right-click the type or types, and then
select Copy Selection.
2. Open the Define Custom type dialog box for the target Message or document,
right-click in the Model tree area, and then click Paste.

16.3 Finding the types used in a Project

In Design Center, you can see the types that are used in each location in the Project.
For example, which types are used on the Message, output queue (Archiving
location), or Document Broker Plus connector. You can also see the version of the
type or types that are used in each location and whether the latest version of the
model is used.
To find the types used in a Project
• On the MGW menu, click Manage custom types.
16.4 Updates to models

The local model is not automatically updated when new model versions are checked
in from Describer or when you connect to the management gateway in Design
Center. You must manually update the local model to access to the latest types and
properties. Updating the model retrieves new model versions and saves them in the
Project along with the existing model versions.
After a new version of a model is saved to the Project, you must decide whether to
continue to use the versions of the types that are already connected to the Messages
or documents, or to whether to use a later version.
To update the local model for a Project

2. Click Check for new versions.... The management gateway checks if any new
versions of the model are available.
3. Click Yes to save the new version(s) of the model in the Project.
To change the version of type connected to a Message or document
1. In Design Center, open the Define Custom Type dialog box.

The location where you open this dialog box from depends on how the types
are used:
• Message – Right-click the Message configuration and then click Set Custom
Meta Types.
• Archiving or output queue items – In the Runtime configuration view, open
the Runtime Output Connector Settings dialog box (generic layer), click the
appropriate tab, and then beside Custom Types click browse.
• Document Broker documents – In the Runtime configuration view, open the
Runtime Output Connector Settings dialog box (generic layer), click the
2. In the Model selection area, in the Model version list, click the new version of
the model.

16.5. Assigning values to properties
3. Optional In the Model tree area, select any types you want to connect to the
Message or documents, and then click OK.
16.5 Assigning values to properties

You use script functions to assign values to properties. Different script functions are
used to retrieve and store properties for Messages, document broker documents,
items in the output queues, and to retrieve values from the input queue.
Script functions for Messages
“getMetadataMessage”
Retrieves a property value from the active Message.
“getMetadataMessageFrom”
Retrieves a property value from a Message in the Message storage.
“setMetadataMessage”
Stores a property value for the active Message.
Script functions for Document Broker documents
“getMetadataDBroker”
Retrieves a property value from the active Document Broker document.
“getMetadataDbrokerFrom”
Retrieves a property value from a document that is stored in the Document
Broker repository.
“setMetadataDBroker”
Stores a property value for the active Document Broker document.
Script functions for output queue items
“getMetadataOutput”
Retrieves a property value from the active output queue item.
“setMetadataOutput”
Stores a property value for the active output queue item.
Script function for input queue items
“getMetadataInput”
Retrieves a property value from the active input queue item.
Stages when the set scripts store property values

The set metadata script functions store property values into the repository at
predefined processing stages. If several property values are set for one document,
then only one insert is made to the repository at each stage. The context and script
placement determine the stages when property values can be stored.

Context: Stages when property values can be stored:

Message • After Event retrieved
• After Message
Document Broker • After the last Process in a document
• After each post processor document is processed
Output queue items • After Process
• After the last Process in an output job
Return codes for metadata script functions
–1 Unspecified error, for example, a database error.

—2 No property with the key exists.
—3 The property key is not in a valid format.
—4 The property value is not correctly formatted. For example, when trying to
set a numeric property to a string that cannot be converted to a number, or
trying to set a date property to a number that cannot be converted to a
date.
—5 No Message or Document Broker document matching the supplied
Message ID and type ID was found.
—6 The property is read-only.
16.5.1 Finding the GUID of a property

The metadata script functions use GUIDs to identify properties. You can find the
GUID for a property in the Define Custom Type dialog box in Design Center.
To find the GUID of a property
1. In Design Center, open the Define Custom Type dialog box.

The location where you open this dialog box from depends on how the
properties are used:
• Message – Right-click the Message configuration and then click Set Custom
Meta Types.
• Archiving or output queue items – In the Runtime configuration view, open
the Runtime Output Connector Settings dialog box (generic layer), click the
• Document Broker documents – In the Runtime configuration view, open the
Runtime Output Connector Settings dialog box (generic layer), click the
2. In the Selected Type preview area, right-click the property, and then click Copy
Key. The GUID for the property is copied to the clipboard.

Figure 16-2: Define Custom Type dialog box
16.5.2 getMetadataMessage
Syntax
There are two variations of this script:
getMetadataMessage(<key>, <value>);
getMetadataMessage(<key>);
<key>
A GUID identifying the property to return the value for.
<value>
The variable (local or global) that will receive the property value.
Description
Retrieves a property value from the active Message. The active Message is
determined by the level where the script is placed. It can be used at the
following levels:
• Event retrieved
• before and after Message
• before and after Process
• inside a Process
The active Message is the Message being stored if placed on Event retrieved,
otherwise it is the Message that is currently being processed.
Note: System properties are not available in Event retrieved scripts. Only
custom properties that are set with SetMetadataMessage are available in
Event retrieved scripts.
Returns
See “Return codes for metadata script functions” on page 384.

Note: If you omit the <value> parameter, the property value is returned
instead of the return code.
Example
This example gets the value of the property with the GUID 6B84E18B-
F03F-350C-E040-007F0200026D and places it in the variable $myValue.
getMetadataMessage("6B84E18B-F03F-350C-E040-007F0200026D",
$myValue);
16.5.3 getMetadataMessageFrom
Syntax
getMetadataMessageFrom(<messageID>, <typeID>, <typeVersion>,

<key>, <value>);
getMetadataMessageFrom(<messageID>, <typeID>, <typeVersion>,

<key>);
<messageID>
A GUID identifying a Message in the Message Storage.
<typeID>
Optional. A parameter to help find the Message. This can be one of the
following:
• A custom type ID defined in the Message storage. You can retrieve this
with getMetaDataMessage("6B84E18B-F03F-350C-
E040-007F0200026D"); when the document is being stored
(“getMetadataMessage” on page 385).
• A custom type ID defined in Describer.
• The name of an Event in the Message. This can only be used if the
Message is defined in the Project where the script function is used.
<typeVersion>
Only used if <typeID> is for a custom type, otherwise this is ignored. The version
of the custom type specified in <typeID>.
<key>
<value>
Description
Retrieves a property value from a Message in the Message storage. This script
function can be used at any level and in any script.
Returns

16.5.4 setMetadataMessage
Syntax
setMetadataMessage(<key>, <value>);
<key>
The GUID identifying the property to set the value for.
<value>
The property value.
Description
Stores a property value for the active Message. The active Message is
determined by the level where the script is placed. It can be used at the
following levels:
• Event retrieved
• before and after Message
The active Message is the Message being stored if placed on Event retrieved,
otherwise it is the Message that is currently being processed.
Returns
Example
This example sets the value of the property with the GUID 33c497c8-
e603-46ab-b455-d2f1f3dd177f to the value of the variable $storeUserID. In
this example, the $storeUserID variable is created from a field in the Event and
the script is placed on Event retrieved. However, the location of the script may
vary depending on the Project configuration.
setMetadataMessage("33c497c8-e603-46ab-b455-d2f1f3dd177f",
$storeUserID);

16.5.5 getMetadataDBroker
Syntax
getMetadataDBroker(<key>, <value>);
getMetadataDBroker(<key>);
<key>
The GUID identifying the property to return the value for.
<value>
Description
Retrieves a property value from the active Document Broker document. The
active Document Broker document is determined by the level where the script is
placed. It can be used at the following levels:

• post processor scripts (connector runtime settings)
The active Document Broker document is the document being stored for scripts
placed before Process, after Process, or inside a Process. Otherwise it is the
document that is currently being processed.
Note: In before Process scripts, the document is not always available since
the correct output connector is not yet selected. This means
GetMetadataDBroker may fail if used on that level in some cases.
Some system properties, such as the GUID of the Document Broker document,
are not available until the post processor scripts. However, the numeric
document sequence number is available for scripts inside and after Process.
Returns
Example
This example gets the value of the property with the GUID 6B84E18B-
F03C-350C-E040-007F0200026D and places it in the variable $myValue.
getMetadataDBroker("6B84E18B-F03C-350C-E040-007F0200026D",
$myvalue);

16.5.6 getMetadataDbrokerFrom
Syntax
getMetadataDbrokerFrom(<doc ID>, <typeID> , <typeVersion> ,

<key>, <value>);
getMetadataDbrokerFrom(<doc ID>, <typeID> , <typeVersion> ,

<key>);
<doc ID>
A GUID identifying a document in the Document Broker repository.
<typeID>
Optional A parameter to help find the Document Broker document. This can
be one of the following:
• A custom type ID defined in the Document Broker repository. You can
retrieve this with getMetaDataDBRoker("6B84E18B-F03F-350C-
E040-007F0200026D"); when the document is being stored.
• A custom type ID defined in Describer.
• The connector name if the script is used in the same Project as where the
document was stored.
<typeVersion>
Only used if <typeID> is for a custom type, otherwise this is ignored. The version
of the custom type specified in <typeID>.
<key>
<value>
Description
Retrieves a property value from a document that is stored in the Document
Broker repository. This script function is allowed at any level in any script.
Returns

16.5.7 setMetadataDBroker
Syntax
setMetadataDBroker(<key>, <value>);
<key>
The GUID identifying the property to set the value for.
<value>
The property value.
Description
Stores a property value for the active Document Broker document. The active
Document Broker document is determined by the level where the script is
placed. It can be used at the following levels:
• post processor document level scripts (connector runtime settings)
If the script is placed on before Process, after Process, or inside a Process, the
active Document Broker document is the document being stored. Otherwise it is
the document that is currently being processed.
Note: In before Process scripts, the document is not always available since
the correct output connector not yet selected. This means
setMetadataDBroker may fail there in some cases.
Returns
Example
This example sets the value of the property with the GUID
c0bf4328-9ec2-4bb8-aeaf-44762be66679 to the value of the variable
$CustID.
setMetadataDBroker("c0bf4328-9ec2-4bb8-aeaf-44762be66679",
$CustID);

16.5.8 getMetadataInput
Syntax
getMetadataInput(<key>, <value>);
getMetadataInput(<key>);
<key>
<value>
Description
Retrieves a property value from the active input queue item. This script is
allowed on any level.
Returns
Example
This example gets the value of a property with the ID 16748a3d-84c7-4109-
bf81-ca87a36eedea and saves it in the variable called $myvalue.
getMetadataInput("16748a3d-84c7-4109-bf81-ca87a36eedea",
$myvalue);
16.5.9 getMetadataOutput
Syntax
getMetadataOutput(<key>, <value>);
getMetadataOutput(<key>);
<key>
<value>
Description
Retrieves a property value from the active output queue item. The active output
queue item is determined by the level where the script is placed. It can be used
at the following levels: before and after Process, and inside a Process.

Note: In before Process scripts, the output item is not always available
since the correct output connector is not yet selected. This means
GetMetadataOutput may fail there in some cases.
Returns
Example
This example gets value for the property with the GUID 16748a3d-84c7-4109-
bf81-ca87a36eedea and stores it in the variable $myvalue.
getMetadataOutput("16748a3d-84c7-4109-bf81-ca87a36eedea",
$myvalue);
16.5.10 setMetadataOutput
Syntax
setMetadataOutput(<key>, <value>);
<key>
The GUID identifying the property to set.
<value>
The property value as a string.
Description
Stores a property value for the active output queue item. The active output
queue item is determined by the level where the script is placed. It can be used
at the following levels: before and after Process, and inside a Process.
Process output mode

If the current output connector uses the Process output mode, then it is only
possible to use SetMetadataOutput in the following contexts:
• Before process scripts when not in the pre-process phase (i.e. PreProc()
returns 0).
• Scripts inside the Process.
The function will fail in other contexts for the Process output mode.
Before Process scripts

In before Process scripts, the output item is not always available since the
correct output connector is not yet selected. This means SetMetadataOutput
may fail if used at that level in some cases.
Returns

Example
This example sets the value of the property with the GUID
16748a3d-84c7-4109-bf81-ca87a36eedea to the value of the variable
$CustomerName.
setMetadataOutput("16748a3d-84c7-4109-bf81-ca87a36eedea",
$CustomerName);

Chapter 17
Importing and exporting models
You can export a model as a file from a Design Center Project, or export a model or a
branch of a model from Describer. The exported file can then be imported to another
tenant’s environment via Describer.
Exporting an entire model

When you export an entire model from Describer or Design Center, you export all
the types and the properties used in the types. Properties that are not referenced in
the types are not exported. Although the entire model with the version history is
included in the exported file, you can only import the most recent version to
Describer.
To export a model from Describer
1. Open the model you want to export in Describer.
2. In the Model version list, select the version of the model you want to export.
3. On the Model menu, click Export model to file....
4. Save the model file in an appropriate location.
To export the model from a Design Center Project
1. Open Design Center, click the MGW menu, and then click Update Project Meta
Model.
2. Click Export model to file...
3. Save the model file in an appropriate location.
Exporting a branch of a model

From Describer, you can select a type in the types tree to export. This exports the
selected type, sub types of the type, and the properties used in the selected type and
sub types.
To export a branch from a model
1. Open the model in Describer.
2. In the Model version list, select the version of the model you want to export.
3. Select the type in the tree you want to export.
4. On the Model menu, click Export selected branch to file....

Chapter 17 Importing and exporting models
5. Save the file in an appropriate location.
Importing a model or branch

It is possible to import an exported model or exported branch into a blank model or
into a model with existing types and properties. If the model already has types and
properties, you must select the level in the types tree where you want to import the
model or branch.
There are three methods for importing a mode or branch:

• Synchronize
Compares the types in the source file with the target model and does the
following:
• Copies any types or properties that only exist in the source file into the target
model (keeping the keys from the source file).
• If there is a type with the same key in both the source and the target, then the
type in the target model is updated to reflect the type in the source file.
• Copy
Copies all the types and properties from the source file into the target model.
Generates new keys for all the types and properties copied into the target model.
• Merge
Compares the types in the source file with the target model and does the
following:
• Copies any types or properties that only exist in the source file into the target
model (keeping the keys from the source).
• If there is a type or property that has the same key, name, and location in both
the source file and target model, then no change is made the type/property in
the target model.
• If there is a type or property that has the same key in both the source file and
target model but has other differences (e.g. the name is different or for types
the location in the tree is different), then the type/property in the target model
remains unchanged, however the type/property from the source file is also
copied (with a new key) into the target model.
Figure 17-1 shows an example of the different import results for the synchronize,
copy, and merge options.

Figure 17-1: Import options and results
To import a model or branch from a file
1. Check out the target model.
2. Select the position the types tree where you want to import the model or
branch.
3. On the Model menu, click Import Model snapshot from file.
4. Beside the Model file to import box, click Browse and select the source file.
5. Select the type of import:
• Synchronize
• Copy
• Merge
6. Review the results of the import.
Tip: If you are not happy with the results, click Undo Check-in to revert
the model back to the last version that was checked in.

Part 3
Profile configurations
Chapter 18
About profile configurations
You can create different types of profiles containing connection, authentication, and
security settings. The profiles are used to establish communication channels between
the OpenText Communications Center Enterprise software and other services. For
example, an FTP output connector uses a TCP/IP connection profile and an
authentication profile to establish a communication channel to an FTP server.
Different profile categories
The following types of profile categories are available:

• TCP/IP profiles - Connection and recovery settings to access computers via the
TCP/IP protocol. See “TCP/IP profiles” on page 404.
• Web service profiles - Connection and recovery settings to access web services.
See “Web service profiles” on page 405.
• Authentication profiles - Authentication settings, that is user name and
password. See “Authentication profiles” on page 407.
• Secure channel profiles - Secure channel settings (SSL or TLS). See “Secure
channel profiles” on page 407.
• Certificate store profiles - Containers of digital certificates. See “Certificate store
profiles” on page 408.
• Repository profiles - Connection profiles to repositories. See “Repository
profiles” on page 409.
You create the profiles that are used within the Design Center Project as resources in
a Design Center resource set. You can reuse these profile resources in several
configurations within the Project. For information about how to create the Design
Center profiles, see “Creating profiles“ on page 403.

Chapter 19
Creating profiles
You create the profiles that are used within the Design Center Project as resources in
a resource set. You can reuse these profile resources in several configurations within
the Project.
In the resource set, the profile resources are contained within a profile configuration
resource. You create this profile configuration resource, with the included profile
resources, in the Profile Configuration Editor.
Tip: When setting up profiles in the Profile Configuration Editor, you can
check the validity of each profile on the Validation results tab or check the
complete profile configuration by selecting Tools > Validate all profiles. The
Profile Configuration Editor automatically validates the complete profile
configuration when you exit the tool.
Prerequisites and recommendations

• A Project must not contain more than one profile configuration resource
(containing the required profile resources).
• We recommend a separate resource set for the profile configuration resource.
• Each profile resource within the profile configuration resource must have a
unique name.
To create a profile configuration resource
1. Right-click the resource set and select New > Profile configuration.
2. Double-click the new profile configuration resource.
3. In the Profile Configuration Editor, create the profiles you need.
To create the profile resources
1. In the Profile Configuration Editor, right-click the <Profile type> folder and
select New <Profile type>.
2. In the properties view, edit the profile settings. See:
• “TCP/IP profiles” on page 404

• “Web service profiles” on page 405
• “Authentication profiles” on page 407
• “Secure channel profiles” on page 407
• “Certificate store profiles” on page 408

Chapter 19 Creating profiles
After adding a certificate store profile to a profile configuration, you must

add certificates to this profile. The certificates must first be imported to the
resource set.
• “Repository profiles” on page 409
To add a certificate to a certificate store profile
1. In the Profile Configuration Editor, select the certificate store profile.

2. Select the appropriate tab (for example, Trusted authorities certificates). For
information about the available tabs, see “Certificate store profiles”
on page 408.
3. Click and browse to and select the certificate.

4. Click OK.
To add certificate password and alias (optional)
1. Select the certificate and click Edit . The Edit Certificate Information dialog
box opens. For detailed information about the options, see “Edit Certificate
Information dialog box” on page 408.
2. Enter the Certificate password.
3. Click Add to add aliases (alias name and password).

4. Click OK.
19.1 TCP/IP profiles

A TCP/IP profile contains connection and recovery settings to access a computer via
the TCP/IP protocol.
• Name - The name of the TCP/IP profile.
• URI - The URI that identifies the profile.
• Host - The IP address or host name of the server to connect to.
• Port - The port to use.
try to reconnect if the computer does not respond. Available options are Never,
Limited times and Forever.
• Number of retries - The number of times Communications Center software
• Retry interval - The interval (seconds) between retries. (Applicable if Attempt
• Recovery action - N/A (for future use).

19.2. Web service profiles
• Secure channel profile - Used to establish a secure channel between

Communications Center software and the host. See “Secure channel profiles”
on page 407. (Optional)
• Custom properties - Used to add any custom properties (Property name and
Property value) that are not part of the standard connection configuration above.
(Optional)
19.2 Web service profiles

Web service profiles contain connection and recovery settings to access a web
service. The following types of web service profiles are available:
• Web service profile - A generic profile intended for accessing an external web
service. All other web services profiles are based on this generic profile. See
“Generic web service profiles” on page 405.
• Media Management connection profile - A profile dedicated for accessing a
Media Management repository. See “Media Management connection profiles”
on page 406.
• Archive Server profile - For informatiMy Supporton about creating a connection
to OpenText Archive Server, see Archiving for SAP documentation on My
Support.
• SAP NetWeaver RFC Connection - For more information about creating a
connection to SAP NetWeaver, see Archiving for SAP documentation on My
Support.
• EasyLink connection profile - A profile for sending output to OpenText
EasyLink. For information about creating a connection profile for EasyLink, see
“Creating a connection profile for EasyLink” on page 112.
• Vista Plus Output Manager profile - A profile for sending output to Vista Plus
Output Manager. For information about setting up a profile for Vista Plus
Output Manager, see “Creating a web service profile for Output Manager”
on page 229.
19.2.1 Generic web service profiles

A generic web service profile contains connection and recovery settings for a
communication channel to an external service accessed via web service calls. All
other web services profiles are based on this generic profile.
Note: To access a Media Management repository, you should use a Media

Management connection profile, see “Media Management connection profiles”
on page 406.
• Name - The name of the web service profile.
• Profile sub-type - The type of web service profile (Web service).

• URL - The address of the web service. For secure web services, use the https
prefix.
• Port - The port to use.
try to reconnect to the web service if the web service does not respond. Available
options are Never, Limited times and Forever.
should try to reconnect if the web service does not respond. (Applicable if Attempt
• Retry interval (seconds) - The interval (seconds) between retries. (Applicable if
Attempt recovery = Limited times or Forever)
• Recovery action - N/A (for future use).
• Authentication profile - Used to select an authentication profile to be used for
the connection. See “Authentication profiles” on page 407. (Optional)
Communications Center software and the web service. See “Secure channel
profiles” on page 407. (Optional)
• Secondary connection profile - Used to add a secondary web service profile, to
be used if the primary web service profile fails all recovery attempts. (Optional)
• Custom properties - Used to add any custom properties (Property name and
Property value) that are not part of the standard connection configuration above.
(Optional)
19.2.2 Media Management connection profiles

A Media Management connection profile contains connection and recovery settings
for a communication channel to an OpenText Media Management repository.
• Name - The name of the profile.

• Profile sub-type - The type of web service profile (Media Management
connection).
• URL - The address of the Media Management repository web service. When
using https, you must also establish a secure channel. See Secure channel
profile below.
• Port - The port to use. For example, 11090 for http and 11443 for https.
try to reconnect to the Media Management repository if a communication
channel could not be established. Available options are Never, Limited times
and Forever.

19.3. Authentication profiles

should try to reconnect to the Media Management repository if a communication
channel could not be established. (Applicable if Attempt recovery = Limited times)
• Retry interval (seconds) - The interval (in seconds) between retries. (Applicable if
• Authentication profile - Used to select an authentication profile to be used for
the connection. See “Authentication profiles” on page 407.
Communications Center software and the Media Management repository. See
“Secure channel profiles” on page 407. (Optional)
19.3 Authentication profiles

An authentication profile contains a user name and password to authenticate a user.
The authentication profile can be referenced by any web service profile, Media
Management connection profile, or repository profile in the same profile
configuration.
• Name - The name of the authentication profile.

• User name - User name used for authentication.
• Password - Password used for authentication.
19.4 Secure channel profiles

A secure channel profile is used to define a security protocol (SSL or TLS) to secure
the communication channel. The secure channel profile can reference a certificate
store profile that is used in conjunction with the security protocol. The secure
channel profile can be referenced by any connection profile in the same profile
configuration. For example, by a TCP/IP profile or web service profile.
Note: To set up security channel profiles and certificate store profiles, you
must have a good working knowledge of the security area.
• Name - The name of the secure channel profile.

• Channel type - SSL (version 3) or TLS (version 1). Note that SSL (version 3) is
the only supported channel type when accessing a Media Management
repository securely.
• Certificate store profile - The certificate store profile that contains the certificates
needed for the secure channel. See “Certificate store profiles” on page 408.

19.5 Certificate store profiles

A certificate store profile is used to group collections of certificates and private keys
into different containers. The certificate store profile can be referenced by a secure
channel profile in the same profile configuration.
Note: To set up security channel profiles and certificate store profiles, you
must have a good working knowledge of the security area.
• Name - The name of the web service profile.
• URI - The URI of the profile.
• Trusted authorities certificates - List of trusted CA root certificates. In order to
trust a peer certificate, the complete certificate chain must be trusted and
available. This is done by adding all intermediate certificates including the root
CA to the list of trusted authorities.
Note: Trusted authorities certificates is the supported certificate type

when accessing a Media Management repository securely.
• Trusted peers - N/A (for future use).
• Authentication certificates - List of public certificates. For example, to encrypt
emails delivered via an SMTP (MIME) output connector or to verify signatures in
such emails.
• Private keys - List of private keys. For example: To encrypt signatures in emails
delivered via an SMTP (MIME) output connector and to prove server and client
identities in SSL/TLS communication.
Edit Certificate Information dialog box

In the Edit Certificate Information dialog box, you add password, aliases, and alias
passwords for a certificate in the Trusted authorities certificates, Trusted peers, or
Authentication certificates container.
• Certificate resource - The certificate resource.
• Certificate resource password - The certificate password (only if the certificate
file is encrypted).
• Alias - The certificate alias. An alias can be required in certain scenarios. For
example, if the certificate store profile is used to sign or encrypt emails delivered
via an SMTP (MIME) output connector and the certificate does not contain the
email address that the certificate belongs to. In this case, the alias is used to
match the email address (case sensitive).
• Password - The alias password.
Edit Private Key Information dialog box

In the Edit Private Key Information dialog box, you add password, aliases, and
alias passwords for a private key in the Private keys container.

19.6. Repository profiles
• Private key resource - The private key resource. The private key can be stored in
PKCS12 or PEM format. In some scenarios, the private key could also be stored
in a Java KeyStore format.
• Private key resource password - The password to decrypt an encrypted private
key resource. If the private key resource is a Java KeyStore (and protected), then
the password is used to decrypt the complete KeyStore.
• Alias - The private key alias. If the private key resource format supports multiple
private keys inside the same resource, then the alias is used to identify individual
keys within the resource. If the private key resource is a Java KeyStore, then the
alias matches the alias in the Java KeyStore.
Note: There can be 0 or more aliases per private key resource.
• Password - The alias password, needed to access a private key identified by an

alias. If the private key resource is a Java KeyStore, then the alias password
matches the alias password used in the KeyStore.
Note: There is one password per defined alias.
19.6 Repository profiles

Repository profiles contain the connection information to access repositories.
SQL Server profiles

• Name - The name of the repository profile.
• Profile sub-type - SQL Server.
• Host - The IP address or host name of the database server that hosts the
repository.
• Port - The port used for communication with the database server. The default
port for SQL Server is 1433.
• Database Name - The name of the database. If you use a named instance of SQL
Server, you must specify the host name and instance name using the syntax
<hostname>\<instancename>.
try to reconnect to the repository if a communication channel cannot be
established or is lost. Available options are Never, Limited times and Forever.
should try to reconnect to the repository if a communication channel cannot be
established or is lost. (Applicable if Attempt recovery = Limited times)

• Recovery action - Available options are Abort and Ignore. (Applicable if Attempt
• Authentication profile - The authentication profile used for the connection. See
“Authentication profiles” on page 407.
Oracle profiles
• Profile sub-type - Oracle.
repository.
• Port - The port used for communication with the database server. The default
port for Oracle is 1521.
• Service name (SID) - The SID of the repository.
• Schema owner - The schema owner of the repository tables, functions, users, etc.

Repository profiles
• Profile sub-type - Repository.
• Vendor - SQL Server or Oracle.
repository.
• Port - The port used for communication with the database server. Default ports
are 1521 for Oracle and 1433 for SQL Server.

19.6. Repository profiles
• Database name - The name of the database. If you use a named instance of SQL
Server, you must specify the host name and instance name using the syntax
<hostname>\<instancename>. (Only required if vendor = SQL Server)
• Service name (SID) - The SID of repository. (Only required if vendor = Oracle)
• Schema owner - The schema owner of the tables, functions, users, etc. (Only
required if vendor = Oracle)
• Database instance - Not applicable in version 16.

Part 4
Drivers and fonts
Chapter 20
AFP driver
The AFP driver is used to send output to an AFP printing environment. The AFP
driver creates an AFP data stream file for each job or document produced by
StreamServer.
Example 20-1: AFP data stream file structure (simplified)
Resource group
Font
Code page
Image
Overlay
Formdef
...
Document
Page group
Page
Page
...
Page group
Page
Page
...
AFP resources
Fonts, code pages, overlays, images, color profiles and form definitions can be
represented in different ways in an AFP data stream file.
• Wrapped into a resource group

A resource group is similar to a zip file containing uniquely named
resources. The resources are either generated by StreamServer, or retrieved
from an external storage, and then wrapped into the resource group.
• As a reference in a page definition
The page definitions in the AFP data stream file (Page below Page group in
the example above) include references to resources. When the Print Server
reads the AFP data stream file and finds a reference, it searches for the
resource in the resource group.
• If the Print Server finds the resource in the resource group, it uses that
resource.
• If the resource is not included in the resource group, the Print Server
searches for the resource in the local resource storage.

Chapter 20 AFP driver
• If the Print Server finds the resource in the local storage, it uses that
resource.
• If the Print Server cannot find the resource, it generates an error message.
• As a bitmap in a page definition (only images and overlays)
Images and overlays can be merged as bitmaps directly on a page definition.
How StreamServer determines the resource options to use

Resource names, resource storage location, and resource modes (include, embed,
reference, etc.) can be specified in different ways. In the GUI settings for the AFP
driver you can specify default options that apply to all resource types, and
options that apply per resource type. You can also specify resource options in
map files. The flow chart below illustrates how StreamServer determines the
options to use when adding a resource to the AFP data stream file.
Required knowledge
You must be familiar with basic AFP terminology.

20.1. Configuring the AFP driver
20.1 Configuring the AFP driver

To enable an output connector to deliver AFP output you must select output mode
Job or Document and configure the AFP driver for the connector.
• Platform driver settings
In the Platform connector configuration you must select the AFP driver. You
cannot configure any driver settings at this stage.
• Document Begin driver settings
In the Runtime connector configuration, at Document Begin, you can configure
document related NOP comments and TLE indexes. See “Document Begin AFP
driver settings” on page 426.
• Page Begin driver settings
In the Runtime connector configuration, at Page Begin, you can configure page
level color profile settings. See “Page Begin AFP driver settings” on page 427.
• Job Begin driver settings
In the Runtime connector configuration, at Job Begin, you configure all other
AFP driver settings. See “Job Begin AFP driver settings” on page 417.
• Configuration file driver settings
In the driver configuration file, you can configure user defined halftone matrix
and halftone transfer curve. This is only recommended for experts in this area.
See “Configuration file AFP driver settings” on page 428.
20.1.1 Job Begin AFP driver settings

• Resolution
The resolution (dpi) of images, overlays, and fixed raster fonts in the AFP data
stream output. This is ignored for resources using Reference mode. Which option
to select depends on the capabilities of the printer.
• Color
The color range to use for text, graphics, and images in the AFP data stream
output. Which option to select depends on the capabilities of the printer.
None – All colors are mapped to black and white.
Yes – Text and graphics colors are mapped to a limited set of colors. Images are
mapped to black and white.
Extended – All colors are mapped to the RGB 0-255 color model. See also
“.Technology (Image)” for information about image colors.
Grayscale – All colors are mapped to 256 shades of gray.
Standard Limited for PTOCA – All colors used for PTOCA objects are mapped
to a limited OCA color set containing the following color values:
• Blue

• Red
• Pink/Magenta
• Green
• Turquoise/Cyan
• Yellow
• Black
• Brown
• Device default
• Color of medium
CMYK – All colors are mapped to the CMYK color model.

• GOCA
The GOCA (Graphics Object Contents Architecture) options apply to vector
graphics drawn in Storyteller. Which option to select depends on the capabilities
of the printer.
None – GOCA is not used to generate vector graphics. Only vertical and
horizontal lines are presented in the output.
Yes – Algorithms with simple GOCA objects are used to generate vector
graphics. Enables printing of free lines, polygons, ovals, and round corners.
Extended – The extended GOCA set is used to generate vector graphics without
GOCA fillets. Enables printing of free lines, polygons, ovals, and round corners.
Full – The extended GOCA set is used to generate vector graphics with GOCA
fillets. Enables printing of free lines, polygons, ovals, and round corners.
Raster All – All vector graphic objects on pages or overlays are rasterized.
Enables printing of free lines, polygons, ovals and round corners as raster
images.
Raster Patterns – All vector graphic objects with patterns are rasterized. GOCA
supports only a limited set of patterns. This option allows rasterizing of objects
filled by unsupported patterns.
• .Color (GOCA)
Default – Set GOCA colors according to global color setting (Color option).
None – All colors for GOCA objects are mapped to black & white.
Yes – Text and graphics colors are mapped to a limited set of colors. Images are
mapped to black and white.
Extended – All colors for GOCA objects are mapped to the RGB 0-255 color
model. See also “.Technology (Image)” for information about image colors.
Grayscale – All colors for GOCA objects are mapped to 256 shades of gray.
Standard Limited – All colors used for GOCA objects are mapped to a limited
OCA color set containing the following color values:

• Blue
• Red
• Pink/Magenta
• Green
• Turquoise/Cyan
• Yellow
• Black
• Brown
• Device default
• Color of medium
CMYK – All colors for GOCA objects are mapped to the CMYK color model.
• .Rasterizing Threshold (GOCA)
The lower limit of when the GOCA object is rasterized. If the number of points
(where there is one point per line of a polygon or shape and three points per
Bezier curve) of the object is lower than this value for the incoming GOCA
objects, it will not be rasterized.
• .Line thickness factor (GOCA)
The line thickness factor applies to polygons only – not to lines and boxes. It
affects the line width of polygons in the output.
The line width is expressed as parts of an inch, and the actual line width in the
output depends on the output device. In most cases you can keep the default line
thickness factor (100), but you may have to change the value in order to tune the
line width in the output. For example, if there are problems with the line widths
in business graphics, you can modify the line thickness factor to solve the
problem.
• .Line maximum width (GOCA)
The maximum width of lines to generate using the Line command. Lines wider
than this are generated using the Area command.
The GOCA commands Line and Area are used to generate lines and areas in the
output. The Line command is device dependent, but the Area command is not.
• .Pattern Set Limited (GOCA)
If you use fill functionality with less than 20% shading, you may see a dot pattern
instead of a shading in the filled area. To avoid this you can limit the GOCA
pattern set to use only the four first patterns.
• .Optimization (GOCA)
Used to specify that the sizes of GOCA drawing areas are based on the bounding
boxes of the objects (rather than drawing graphic objects to the whole page).
This helps printers that do not handle GOCA graphics as native objects use
memory more effectively.

This is switched off by default.

• Job comment
A comment that is included at the beginning of the job. Any string is accepted.
The comment is translated into a NOP object in the AFP data stream. You can
include properties in the string (see Assigning property values to comments and
TLE indexes on page 448).
• End Job comment
A comment that is included at the end of the job. Any string is accepted. The
comment is translated into a NOP object in the AFP data stream. You can include
properties in the string (see Assigning property values to comments and TLE
indexes on page 448).
• Before document group comment
A comment that is included before all document groups. Any string is accepted.
• Document group comment
A comment that is included before each document group. Any string is accepted.
• End document group comment
A comment that is included after all document groups. Any string is accepted.
• Resource
The default mode for how to handle resources.
Default – Depends on how the driver option “Disable inline resources” is
specified. If Disable inline resources is Yes, Reference mode is used, and if it is
No, Embed mode is used.
See “Modes for managing AFP resources” on page 429 for more information
about the other modes.
• .Map file (Resource)
The path to the map file for overlays and images. For example:
data/tables/mapfile.txt
This file is optional, and the settings in the file override any other settings
specified for overlay and image resources. See “Specifying color profiles for
external images” on page 441 for more information.
• .Location (Resource)

The default resource directory used by StreamServer. This directory is used in

Include and Export mode.
• Font
The mode used to handle font resources. Overrides the default resource mode.
Default – Use the default resource mode.
• .Default (Font)
If there is a default font in the job, this setting can be used to specify a font name
(AFP character set name, e.g. CZ123, or AFP coded font ID, e.g. X0MAXI2A) for the
default font. Normally you use the file afp2wfnt.map to specify which names to
use for the fonts. See “Mapping fonts and code pages” on page 435.
You can also use this field to enter the FGID (Font Global Identifier) that applies
to all generated fonts.
• .Technology (Font)
Technology used for generating font resources. Applicable to modes Embed and
Export, and ignored for all other modes. See “Generating font resources”
on page 433.
• .Content (Font)
N/A
• .Location (Font)
The font resource directory used by StreamServer. This directory is used in
Include and Export mode, and overrides .Location (Resource).
• Code page
The mode used to handle code page resources. Overrides the default resource
mode.
• .Default (Code page)
Overrides the auto generated code page name for the default code page. The
default code page is the code page specified on the connector, or IBM CP 500
(Communications Center code page name) if no code page is specified.
For example:
T1LATIN1
See also “Fonts and code pages” on page 433.

You can also specify multiple code pages. If the character is not found in the first
specified code page, the character is searched in the next following, and so on.

Use the following syntax

<code page> -SYSCP[<system code page>]
and separate the code pages with a semicolon.
For example:
T1000852 -SYSCP[IBM CP 852];T1000500 -SYSCP[IBM CP 500];T1000851 -
SYSCP[IBM CP 851]
• .Technology (Code page)
The technology used for generating code page resources. Applicable to modes
Embed and Export, and ignored for all other modes. See “Generating code page
resources” on page 435.
• .Content (Code page)
N/A
• .Location (Code page)
The code page resource directory used by StreamServer. This directory is used in
• Image
The mode used to handle image resources. Overrides the default resource mode.
• .Default (Image)
N/A
• .Technology (Image)
Technology used for generating image resources. Applicable to modes Embed,
Wrap, and Export. Ignored for all other modes. See “Generating image
resources” on page 440.
• .Content (Image)
Color mode for generating images. Applicable to modes Embed, Wrap, and
Export. Ignored for all other modes. See “Generating image resources”
on page 440.
• .Location (Image)
The image resource directory used by StreamServer. This directory is used in
• Color Profile-Image-Audit
The mode used for handling color profile resources for the image. See “Modes
for managing AFP resources” on page 429.
Color profile settings you specify here override all other color profile settings
you specify at Job Begin and Page Begin.
• .Name (Color Profile-Image-Audit)

The name of the color profile for the image.

• .Location (Color Profile-Image-Audit)
The path to the directory with the color profile. This only required for Include
mode.
• Overlay
The mode used to handle overlay resources. Overrides the default resource
mode.
• .Default (Overlay)
N/A
• .Technology (Overlay)
Technology used for generating overlay resources. Applicable to modes Embed,
Wrap, and Export, and ignored for all other modes.
Vector – Generates vector based overlays.
Raster – Generates raster based overlays.
• .Location (Overlay)
The overlay resource directory used by StreamServer. This directory is used in
• Formdef
The mode used to handle formdef resources. Overrides the default resource
mode.
• .Default (Formdef)
The name of the generated formdef. For example:
FM2UP
• .Location (Formdef)
The formdef resource directory used by StreamServer. This directory is used in
Include or Export mode, and overrides .Location (Resource).
• Color Profile-Document-Audit
The mode used for handling audit color profile resources for the entire AFP data
stream. See “Modes for managing AFP resources” on page 429.
• .Name (Color Profile-Document-Audit)
The name of the audit color profile used for the AFP data stream.

• .Location (Color Profile-Document-Audit)

The path to the directory with the color profile. This is only required for Include
mode.
• Color Profile-Document-Instruction
The mode used for handling instruction color profile resources for the entire AFP
data stream. See “Modes for managing AFP resources” on page 429.
• .Name (Color Profile-Document-Instruction)
The name of the instruction color profile for the AFP data stream.
• .Location (Color Profile-Document-Instruction)
The path to the directory with the color profile. This is only required for Include
mode.
• SSI headers
Enables/disables generation of SSI headers.
SSI headers can be used in OS/390 environments. The SSI headers contain AFP
transparent information that the Print Server can use for tailoring the printing
process.
• .Key (SSI <n>)
The key of SSI header number <n>. Any string can be used.
This is the key that the Print Server uses to identify a specific SSI header.
• .Value (SSI <n>)
The value of SSI header number <n>. Any string can be used.
• System text code page
The EBCDIC code page to use for NOP comments and TLE information. For
example:
IBM CP 278
If no System text code page is specified, the code page specified for the connector
is used. If the code page specified for the output is not an EBCDIC code page,
you must specify an EBCDIC code page for TLE information and NOP
comments.
• TLE code page
The EBCDIC code page to use for TLE information. Leave this empty if you want
to use the same code page as for NOP comments.
• Disable inline resources
Disables the use of inline resources in the AFP data stream file. When selected,
only the Reference mode can be used.
• Disable mCF-2
Disables Map Coded Font function 2 (MCF2). Select this option if the output
device only supports MCF1 and not MCF2.

• Disable mDR
Disables Map Data Resource (MDR). Select this option if .Technology (Font) is
Open Type, and if the printer does not support MDR.
If .Technology (Font) is not Open Type, MDR is disabled automatically.
• Disable n-up
Disables AFP n-up for side-by-side printing. Select this option if you want to use
the Sheet Layout n-up functionality instead of the AFP n-up definition for side-
by-side printing.
For example, if the Sheet Layout has two A4s on one A3 Landscape, and you
disable n-up, the A4 sheets are merged on one Landscape A3 sheet. The Print
Server receives one A3 sheet, and not two A4 sheets positioned side by side.
• Front pages only
Overrides duplex printing.
• Disable Image Background
Some printers cannot handle image transparency correctly. Instead of printing an
image with a transparent background, a black box is printed. If you disable the
image background, the image is printed as a transparent image, but the opaque
function is lost.
• Disable Automatic Orientation
Disables the automatic orientation of logical pages on the sheet. For example, if
you use partition rotation to place a logical page with landscape orientation onto
a physical sheet with portrait orientation, the physical sheet will still have
portrait orientation.
• Disable BCOCA
Disables the Bar Code Object Content Architecture. This can be useful if your
printer does not support BCOCA, or if you want to allow barcodes on a server or
printer that does not support BCOCA.
• Max Record Length
The maximum record length for AFP structured fields. Which option to select
depends on the capabilities of the printer. If you select None, 32 KB is used by
default.
• Halftone Method
The halftone method used to convert color and grayscale images to black and
white. Available methods are Floyd Steinberg and Ordered Dither. If you select
Default, Ordered Dither is used.
• Halftone Size
The size of the halftone matrix. Default is an 8x8 matrix.
• Halftone Gamma
The halftoning gamma value.

• Page Group Scope

The PageGroup scope.
Default – Use the Document definition to set the scope of the PageGroup.
Envelope – Use the envelope definition to set the scope of the PageGroup.
20.1.2 Document Begin AFP driver settings

• Before document comment
A comment that will be included before the document. Any string is accepted.
• Document comment
A comment that is included in the document. Any string is accepted. The
• Document name
The name of a specific BNG (Begin Named Page Group) in the AFP print file.
This name corresponds to the Communications Center Document. The name can
be built up using several variables, for example the Document number and user
ID. If left empty, the default naming convention (D0000001, D0000002, ...) is
used.
• End document comment
A comment that is included at the end of the document. Any string is accepted.
• TLE indexes
Enable/disables generation of TLE indexes.
If the Process output contains bookmarks and TLE indexes is enabled, page level
TLE indexes are generated automatically.
• .Key (TLE <n>)
The key of TLE archiving index number <n>. Any string can be used.
• .Value (TLE <n>)
The value of TLE archiving index number <n>. Any string can be used
(maximum 250 characters). You can include properties in the string (see
Assigning property values to comments and TLE indexes on page 448).

20.1.3 Page Begin AFP driver settings

• Before Page Comment
A comment that will be included before the page. Any string is accepted. The
• Page comment
A comment that is included in the page. Any string is accepted. The comment is
translated into a NOP object in the AFP data stream. You can include properties
in the string (see Assigning property values to comments and TLE indexes
on page 448).
• Page TLE indexes
Enable/disables generation of TLE indexes for StoryTeller output.
If the output contains bookmarks and TLE indexes is enabled, page level TLE
indexes are generated automatically.
• .Key (Page-TLE <n>)
The key of TLE archiving index number <n>. Any string can be used.
• .Value (Page-TLE <n>)
The value of TLE archiving index number <n>. Any string can be used
(maximum 250 characters). You can include properties in the string (see
Assigning property values to comments and TLE indexes on page 448).
• Color Profile-Page-Audit
The mode used for handling audit color profile resources for the page. See
“Modes for managing AFP resources” on page 429.
Color profile settings specified here override color profile settings specified for
the entire AFP data stream at Job Begin.
• .Name (Color Profile-Page-Audit)
The name of the audit color profile used for the page.
• .Location (Color Profile-Page-Audit)
The path to the directory with the color profile used for the page. This is only
required for Include mode.

20.1.4 Configuration file AFP driver settings

In the AFP driver configuration file afp.drs you can configure user defined
halftone matrix and halftone transfer curve. This file is available from the Device
Tool. See “Device Tool” for information on how to configure driver files.
Note: Configuring user defined halftone matrices requires expert knowledge

in this matter.
Example 20-2: User defined halftone matrix

// The sample of user halftone matrix
Halftone 8 2.0
HalftoneMethod "ordered dither"
HalftoneMatrix 64
0 128 32 160 8 136 40 168
192 64 224 96 200 72 232 104
48 176 16 144 56 184 24 152
240 112 208 80 248 120 216 88
12 140 44 172 4 132 36 164
204 76 236 108 196 68 228 100
60 188 28 156 52 180 20 148
252 124 220 92 244 116 212 84
End
Example 20-3: User defined grayscale transfer curve

// The sample of user Grayscale transfer curve
HalftoneTransfer 256
0 4 9 12 15 17 19 21 22 24 25 27 28 29 30
32
33 34 35 37 38 39 40 42 43 45 46 48 49 50 52
53
55 56 58 59 61 62 64 65 67 68 70 71 72 73 75
76
77 78 79 80 81 82 83 83 84 85 86 87 88 89 90
91
92 93 94 95 96 98 99 100 102 103 104 106 107 108 110
111
112 113 115 116 117 118 120 121 122 123 124 125 126 127 128
129
130 131 132 133 134 135 136 137 138 138 139 140 141 142 143
144
145 146 147 148 149 150 151 152 153 154 155 156 157 157 158
159
160 161 162 163 163 164 165 166 167 168 168 169 170 171 171
172
173 174 175 175 176 177 178 179 180 181 182 183 184 185 186
187
188 189 190 191 192 193 194 195 196 196 197 198 199 200 200
201
202 202 203 204 204 205 206 206 207 207 208 209 209 210 210

20.2. Modes for managing AFP resources
211
212 212 213 213 214 214 215 215 216 217 217 218 218 219 220
220
221 221 222 223 223 224 225 226 226 227 228 229 230 230 231
232
233 234 235 235 236 237 238 239 239 240 241 242 243 243 244
245
246 246 247 248 248 249 249 250 251 251 252 252 253 253 254
255
End
20.2 Modes for managing AFP resources

The AFP driver can use several modes to handle resources. You can specify a default
mode used to handle the resources, and then for each resource type specify other
options that override the default options.
Embed mode
The Embed mode is the default mode. It converts the original resources to AFP
resources, and wraps the AFP resources into the resource group in the AFP data
stream file.
The following steps describe a simple scenario:
1. StreamServer finds a resource on a page in the original document.
2. StreamServer generates an AFP resource with a unique name, and wraps the
AFP resource into the resource group in the AFP data stream file.
3. StreamServer adds the unique name as a reference on the corresponding page

definition in the AFP data stream file.
4. StreamServer continues to generate and wrap AFP resources and add references
for all the resources it finds.
5. The Print Server reads the AFP data stream file.
6. When the Print Server finds a reference in the AFP data stream file, it retrieves
the corresponding resource from the resource group in the AFP data stream file.

Include mode
The Include mode enables the use of external resources (3rd party or modified
resources). This mode requires that the external resources are included in the
resources storage used by StreamServer.
2. StreamServer generates a unique name for the resource, retrieves the

corresponding AFP resource from the resources storage, and wraps it into the
resource group in the AFP data stream file.
3. StreamServer adds the unique name as a reference on the corresponding page

definition in the AFP data stream file.
4. StreamServer continues to retrieve and wrap AFP resources, and add references
for all resources it finds.
the corresponding resource from the resource group in the AFP data stream file.
Note: The names of the resources in the resources storage must correspond to
the resource names generated by StreamServer.
Reference mode
The Reference mode can be used to optimize conversion speed, the size of the AFP
data stream file, and resource loading on the printer. This mode requires that the
resources are included in the resources storage used by the Print Server.

20.2. Modes for managing AFP resources
2. StreamServer generates a unique name for the resource, and adds this name as a
reference on the corresponding page definition in the AFP data stream file.
3. StreamServer continues to add references for all resources it finds.
the corresponding resource from the resources storage.
Note: The names of the resources in the resources storage must correspond to
the resource names generated by StreamServer.
Merge mode
The Merge mode merges images and overlays as bitmaps directly on a page
definition. This mode can be used for unique images/overlays that are not shared by
several page definitions.
2. StreamServer generates a bitmap, and merges the bitmap on the corresponding

page definition in the AFP data stream file.
3. StreamServer continues to generate and merge bitmaps for all resources it finds.
5. When the Print Server finds a bitmap, it uses this bitmap in the output.

Export mode
The Export mode can be used to generate AFP resource files. The generated files can
be uploaded to the resources storage used by the Print Server, and later be used with
the Reference mode. The resource files can also be modified, and later be used with
the Include mode.
2. StreamServer generates an AFP resource with a unique name, and exports the
resource to a file in the resources storage used by StreamServer.
3. StreamServer continues to generate and export AFP resources for all resources it
finds.
Ignore mode
The Ignore mode is only applicable to image, overlay, and formdef resources. It can
be used during development to ignore temporary problems with resources. It can
also be used during production where the corresponding resources are pre-printed
on paper.
2. StreamServer ignores the resource, and adds no resource information to the

AFP data stream file.
3. StreamServer continues to ignore all resources it finds.

20.3. Fonts and code pages
5. The Print Server finds no resources, and no resources are included in the
output.
20.3 Fonts and code pages

Font output can be handled by the AFP driver using the following modes:
• Embed
• Include
• Reference
• Export
See “Modes for managing AFP resources” on page 429 for information about the
above driver options.
Auto generated font names

By default, the AFP driver creates sequential names for fonts in the same job.
The first font found in a job is named prefix000000 (where prefix is CZ for
outline fonts and C0 for raster fonts), the next is named prefix000001, and so
on. This method can only be used if the AFP driver runs in Embed mode for font
resources.
Specified font names
If the AFP driver runs in Include, Reference, or Export mode for font resources,
the font names must not change between jobs. This means auto generated font
names cannot be used. You must therefore manually map the fonts to unique
names. You can use any name for a font as long as it has the right prefix (CZ for
outline fonts and C for raster fonts) and is less than 9 characters long (including
the prefix). See “Mapping fonts and code pages” on page 435 for more
information on how to name fonts.
20.3.1 Generating font resources

To generate font resources Embed and Export mode) you must use the driver
setting .Technology (Font) to specify which technology to use to generate font
resources.
Font technologies
• Outline
Embeds Adobe Type 1 fonts in AFP outline font resources.
• CID Outline
Embeds Adobe CID fonts in AFP outline font resources.
• Raster
Generates AFP raster font resources. The font resolution is determined by the
Resolution driver setting. If you specify 240 dpi, fixed raster metrics is used. If
you specify a higher resolution, relative raster metrics is used.

• Relative Raster
Generates AFP raster font resources using relative raster metrics.
• Fixed Raster
Generates AFP raster font resources using fixed raster metrics. The font
resolution is determined by the Resolution driver setting.
• OpenType
Embeds OpenType and TrueType fonts as data resources rather than traditional
AFP font resources. This new technology is not supported by most printers.
• TT Outline
Embeds TrueType fonts in AFP outline font resources. Used only for OCE
printers that do not support Type 1 fonts.
Fixed raster metrics compensation

If a fixed raster metrics technology is used to generate font resources, the width
of the printed characters can be affected when, for example, printing long right-
aligned texts, or when the character format changes (e.g. from normal to bold).
The driver compensates for this effect if the fonts are mapped to ReadFonts in
the file afp2wfnt.map. If the fonts are mapped to Width Table fonts, no
compensation is made. See “Mapping fonts and code pages” on page 435 for
more information about afp2wfnt.map.
Characters included in a font resource

When running the AFP driver in Embed mode for font resources, only the
characters that are used are included in the font resource wrapped into the
resource group.
When running the AFP driver in Export mode for font resources, all characters
from the code page specified for the font are included in the exported font
resource. This means if you use exported font resources when running the AFP
driver in Include mode, all characters from the code page specified for the font
are included in the font resource.
20.3.2 Code pages

By default, the code page specified on the output connector is used for all fonts. If no
code page is specified, IBM CP 500 is used.
Auto generated code page names

A code page is normally uniquely named by resolving the Communications
Center code page name. For example, IBM CP 500 is named T1000500. In this
case, the auto generated code page name can be used in all modes for code page
resources (Embed, Include, etc.)
A code page that cannot be named uniquely by resolving the Communications
Center code page name is given a sequential number, for example T1000000. In
this case, the auto generated code page name can only be used if the AFP driver
runs in Embed mode for code page resources.

Specified code page names

You can use the AFP driver setting .Default (Code page) to explicitly name the
default code page. The name you enter in this field overrides the auto generated
code page name. The code page name must begin with T1, and be less than 9
characters long.
You can also use the file afp2wfnt.map to name the default code page, as well as
any other code pages used in the job. See “Mapping fonts and code pages”
Unicode
Unicode is applicable only if the AFP driver runs in Embed mode for code page
resources. If you specify unicode (Communications Center name Unicode
(UCS-2)) as the default code page on the output connector, the auto generated
AFP code page name is T11200.
Code page for TLE information and NOP comments

External applications that read TLE information and NOP comments expect
EBCDIC code pages (Communications Center code page name IBM CP nnn). This
means if the code page specified for the output is not an EBCDIC code page, you
must specify an EBCDIC code page for the TLE information and NOP
comments. The AFP driver setting System text code page applies to both TLE
information and NOP comments. If you need a separate code page for TLE
information, you can use the AFP driver setting TLE code page.
Generating code page resources

Normally you will use the default technology to generate code page resources
(Embed and Export mode).
If you need to produce double byte output not only for printing, but also for
archiving, searching, etc., you must set the AFP driver option .Technology (Code
page) to Coded Font for Double Byte. This means the AFP driver converts double
byte code pages to a set of single byte AFP code page resources and AFP font
resources, together with AFP coded fonts.
20.3.3 Mapping fonts and code pages

When using external font and code page resources, i.e. when running the AFP driver
in Include or Reference mode, you must make sure the resource names in the AFP
data stream file are the same as the names of the external resources. You must
therefore map the fonts and code pages used in the Process to the corresponding
external resources. To do this, you edit the AFP driver file afp2wfnt.map using the
Device Tool. You can also use the afp2wfnt.map file to specify options for a specific
font or code page. See “Device drivers and tools“ on page 523 for information on
how to edit driver files.
The settings in the afp2wfnt.map file override the corresponding AFP driver GUI
settings for fonts and code pages. A standard entry for a font has the following
format in the afp2wfnt.map file:

Font "TTF_name"
ReadFont "TTF_file" SelectPrefix "TTF_name" Codepage "Source_CP"
Select "AFP_font" Codepage "AFP_CP"
Example 20-4: Font entry in afp2wfnt.map
Font "Arial"
ReadFont "ARIAL.TTF" SelectPrefix "Arial" Codepage "Ansi"
Select "CZH200" Codepage "T1000870"
afp2wfnt.map parameters
TTF_name
The original TrueType font used in the Process. The name must contain all used
flags, e.g. bold or italic. You must use underscores as separators. For example
Arial_bold_italic
TTF_file
The TrueType font file read by StreamServer.
AFP_font
The name to use for the AFP font resource.
Source_CP
The source code page.
AFP_CP
The name to use for the AFP code page resource.
-Technology[Technology_font]
The font technology to use to generate font resources. You can specify the
following Technology_font options:
• CID
• OUTLINE
• TTOUTLINE
• RASTER
• RELATIVERASTER
• FIXEDRASTER
• OPENTYPE
See “Generating font resources” on page 433 for more information about these
options.
-Technology[Technology_CP]
The code page technology to use to generate code page resources. You can
specify the following Technology_CP options:

• DEFAULT
• CODEDFONT
See “Generating code page resources” on page 435 for more information about
these options.
-mode
The mode to use for the font/code page resource. You can specify the following
modes:
• INCLUDE
• REFERENCE
• EXPORT
• EMBED
about these options.
Location_font
The location of the font resource. Used only if mode is INCLUDE or EXPORT.
If mode is INCLUDE, the resource will be retrieved from this location. If mode is
EXPORT, the resource will be exported to this location.
Location_CP
The location of the code page resource. Used only if mode is INCLUDE or EXPORT.
If mode is INCLUDE, the resource is retrieved from this location. If mode is EXPORT,
the resource is exported to this location.
-SYSCP[System_CP]
System code page to use for a font, where System_CP is the Communications
Center name of the code page to use. For example:
-SYSCP[ISO 8859-1]
Mode
To specify whether to export, include, embed, or reference a specific font or code

page resource, you must add the mode parameter to the Select row.
Example 20-5: Embedding a font and code page resource
Select "CZH200 -EMBED" Codepage "T1000870 -EMBED"
Export/Include path
To be able to export or include a font or code page resource, you must add the
Location_font and Location_CP parameters to the Select row.

Example 20-6: Including a font and code page resource
Select "CZH200 -INCLUDE Data\Fonts\*.OLN" Codepage

"T1000870
-INCLUDE Data\Fonts\*."
Font sizes for raster fonts

You can specify which raster font to use for a specific font size.
Example 20-7: An entry specifying which font to use according to

font size
Font "Arial"
Size 7 Select "COH20080"
Size 8 Select "COH20080 -INCLUDE data\fonts\*.300
Size 9 Select "COH20090.300"
Size 10 Select "COH20000.300"
Font technology
You can use the parameter -Technology [Technology_font] to specify which
technology to use when generating a specific font.
Example 20-8: Entries specifying font technology
Font "Arial"
Select "COH20000 -EXPORT -Technology [RASTER] data\fonts\*.
300"
Font "Times_New_Roman"
ReadFont "TIMES.TTF" SelectPrefix "Times New Roman"
Codepage "Ansi"
Select "CZN200 -EXPORT -Technology [CID] data\fonts\*.OLN"
System code page

You can use the parameter -SYSCP[System_CP] to specify a specific system
code page for a font. This will override the default system code page specified
for the output connector.
Example 20-9: An entry specifying a system code page for a font
Font "MS_Mincho"
ReadFont "MSMINCHO.TTF" SelectPrefix "MS_Mincho" Codepage
"Ansi"
Select "CZM001" Codepage "T1000950 -SYSCP[BIG5]"

20.4. Images and overlays
20.4 Images and overlays

Image and overlay output can be handled by the AFP driver using the following
modes:
• Embed
• Include
• Reference
• Export
• Merge
• Ignore
See “Modes for managing AFP resources” on page 429 for more information about
the above driver options.
Auto generated image and overlay names

The AFP driver auto generates resource names for images and overlays as
PrefixName, where Prefix is S1 for images and O1 for overlays, and Name is the
name of the image/overlay used in the Process. For example:
S1LOGO
O1SLIP
The resource name, including prefix, can be up to eight characters long. This
means that if the original image/overlay contains more than six characters, the
name is truncated. For example, an image called logoSWE in the Process
generates the image resource name S1LOGOSW.
Auto generated resource names are normally used when running the AFP driver
in Embed and Merge mode for image and overlay resources.
Specified image and overlay names

When using external image and overlay resources (Include and Reference
mode), you must make sure the resource names in the AFP data stream file are
the same as the names of the corresponding external resources. This means you
can only use auto generated resource names if you first export the resources,
and then use the exported resources as external resources.
If you use other resources (e.g. 3rd party generated image and overlay
resources) as external resources, you must map the original images and overlays
used in the Process to the corresponding external resources. See “Mapping
images, overlays and color profiles” on page 442 for more information.

20.4.1 Generating image resources

When generating image resources (Embed, Export and Merge mode), you must
specify the resolution and color range for the image resources. You can also specify
different modes for generating color images.
Resolution
The AFP driver setting Resolution specifies the resolution of the generated
images. This setting also sets the resolution of all generated overlays and fixed
raster fonts.
Color settings
The AFP driver settings Color and .Technology (Image) specify whether to
generate black or white, or color images. To generate color images, you must
select Color> Extended and .Technology (Image)> IO Image or IO Image
Compressed.
IOCA settings
The IOCA settings (AFP driver setting .Content (Image)) apply to color images.
The following modes are available:
• IOCA FS11 (.Content (Image)> RGB)
• IOCA FS45 (.Content (Image)> CMYK)
• IOCA FS10 (.Content (Image)> B/W)
The mode to select depends on the capabilities of the printer. The default mode
is IOCA FS45, and is normally used for printing. IOCA FS11 is normally used for
AFP viewers.
20.4.2 Generating overlay resources

When generating overlay resources (Embed, Export, and Merge mode), you must
specify the resolution and color range for the overlay resources. You can also specify
different GOCA modes for generating vector graphics.
Resolution
The AFP driver setting Resolution specifies the resolution of the generated
overlays. This setting also sets the resolution of all generated images and fixed
raster fonts.
Color settings
The AFP driver setting Color specifies whether to generate black and white,
gray scale, or color overlays. The option to select depends on the capabilities of
the printer. The following options are available:
• None – All colors are mapped to black and white.
• Yes – All colors are mapped to a limited set of colors.
• Extended – All colors are mapped to the RGB 0-255 color model.
• Grayscale – All colors are mapped to 256 shades of gray.

Note: Color support is only applicable to vector technology overlays, and

not to raster technology overlays.
GOCA settings
The AFP driver setting GOCA applies to vector graphics in the overlay, and also
to vector graphics drawn directly in the Process tool. Which option to select
depends on the capabilities of the printer. The following options apply:
• None – GOCA is not used to generate vector graphics. Only vertical and
horizontal lines are presented in the output.
• Yes – Algorithms with simple GOCA objects are used to generate vector
graphics. Enables printing of free lines, polygons, ovals, and round corners.
• Extended – The extended GOCA set is used to generate vector graphics
without GOCA fillets. Enables printing of free lines, polygons, ovals, and
round corners.
• Full – The full GOCA set is used to generate vector graphics with GOCA
fillets. Enables printing of free lines, polygons, ovals, and round corners.
• Raster All – All vector graphic objects on pages or overlays are rasterized.
Enables printing of free lines, polygons, ovals and round corners as raster
images.
• Raster Patterns – All vector graphic objects with patterns are rasterized.
GOCA supports only a limited set of patterns. This option allows rasterizing
of objects filled by unsupported patterns.
20.4.3 Specifying color profiles for external images

You can specify ICC (International Color Consortium) color profiles when using
external images in Reference or Include mode. These settings are specified in the
AFP driver at Job Begin.
Image color profile settings

The AFP driver setting .Name (Color Profile-Image-Audit) is used to specify
the name of an external color profile file for an image. When using Include
mode, the setting .Location (Color Profile-Image-Audit) specifies the file path
to the directory with the color profile.
These settings override color profile settings specified for the entire AFP data
stream at Job Begin or at page level at Page Begin.
Specifying color profiles for images using a map file

You can use a map file to specify color profiles for images. When you map an
image to an external resource, you can also map a color profile for the image
using the COLORPROFILE keyword.
Settings in the map file override the color profile settings for the image in the
GUI at Job Begin.
For more information see “Mapping images, overlays and color profiles”
on page 442.

20.4.4 Mapping images, overlays and color profiles

When using external image, overlay or color profile resources (Include and
Reference mode), you must make sure that the resource names in the AFP data
stream file are the same as the names of the external resources. This means you must
map the original images and overlays to the corresponding external resources using
a map file.
Creating a map file

You create a map file that describes how to map original images, overlays and color
profiles to external resources. Then you add the map file to the AFP driver
configuration. The map file settings override the corresponding AFP driver GUI
settings for images, overlays and color profiles.
To create a map file
1. Create a new table resource in a resource set.
2. Rename the table resource. For example to resourcemap.
3. Open the table resource.
4. For each image/overlay/color profile you want to map, add a new line using the
syntax and parameters described below.
5. Save and close the table resource.
Syntax – Mapping an image/overlay/color profile to an external resource

The following syntax is used to map an image, overlay or color profile to an
external resource.
Item TAB Type TAB Name TAB Mode TAB Location
Syntax – Specifying a color profile for a mapped image

The following syntax is used to map an image, and map a color profile for that
image.
Item TAB Type TAB Name TAB Mode TAB Location COLORPROFILE TAB
Name TAB Mode TAB Location
Parameters
Item
The name defined for the overlay/image in the Communications Center Process
tool.
Type
The resource type. The following types apply:
• PSEG – for images.
• OVERLAY – for overlays.

• COLORPRFOFILE – for color profiles.
Name
The AFP resource name, for example 01SLIPEN. Image resources have the prefix
S1, and overlay resources have the prefix O1. The resource name and prefix for
images and overlays can be up to eight characters long.
Mode
The mode used for the resource. The following options apply:
• INCLUDE
• REFERENCE
• EXPORT
• EMBED
• IGNORE
• MERGE
See “Modes for managing AFP resources” on page 429 for more information.
Location
The path to the directory with the image/overlay/color profile resource. For
example, AFPRESOURCES/01SLIPEN.OVL
Used only if Mode is INCLUDE or EXPORT.
If Mode is INCLUDE, the resource is retrieved from this location. If Mode is EXPORT,
the resource is exported to this location.
Type
COLORPROFILE
This parameter is optional. It is only used to specify a color profile for an image
that is mapped to an existing AFP resource.
Name
The name of the color profile.
Mode
The mode to use for the color profile resource. The following modes apply:
• INCLUDE
• REFERENCE

Location
The path to the directory with the color profile resource. Used only if Mode is
INCLUDE.
To add the map file to the AFP driver configuration
The map file you create is exported from the resource set to <export>\data\
tables. You must specify this path when you configure the device driver settings.
1. Open the Runtime Connector settings dialog for the output connector that
delivers the AFP output.
2. Select Job Begin and Device Driver Settings.
3. In .Map file (Resource), enter the path to the map file, for example:
data\tables\resourcemap
Example 20-10: Mapping images and overlays
In this example, the image Logo.gif and the overlay Slip.lxf are used in
the Process. The image and overlay are added to the AFP data stream file
using Include mode. The image resource is retrieved from the file S1LOENG.
PSG, and is named S1LOENG. The overlay resource is retrieved from the file
O1SLIPEN.OVL, and is named O1SLIPEN. Both resource files are stored in the
resource directory AFPRESOURCES in the Export directory of the Project.
The map file looks like this:
//!CodePage UTF8!
Slip OVERLAY 01SLIPEN INCLUDE AFPRESOURCES/
01SLIPEN.OVL
Logo PSEG S1LOEN INCLUDE AFPRESOURCES/
S1LOEN.PSG
Example 20-11: Mapping a color profile for an image
In this example, the image logo references a color profile named

ICCColorProfile45x. The color profile is added to the AFP data stream file
using Include mode. The color profile is retrieved from the file
ICCColorProfile45T.icc, which is located in the Project export directory
called AFPRESOURCES.
The entry in the map file looks like this:
//!CodePage UTF8!
logo COLORPROFILE ICCColorProfile45x INCLUDE
AFPRESOURCES/ICCColorProfile45T.icc

20.5. Form definitions
Example 20-12: Mapping an image that references a color profile
In this example, the image Logo is mapped to the file 1LOENG.PSG, which is
located in the directory called AFPRESOURCES in the Project Export directory.
The image is added to the AFP data stream file using Reference mode. The
image references a color profile named ICCColorProfile45x.
The entry in the map file looks like this:
//!CodePage UTF8!
Logo PSEG S1LOEN INCLUDE AFPRESOURCES/S1LOEN.PSG
COLORPROFILE ICCColorProfile45x REFERENCE
20.5 Form definitions

A form definition (formdef) is a resource object that defines the layout and
characteristics of logical pages on a sheet. A form definition is normally created
using the Sheet layout editor. If you do use the Sheet layout editor, a default form
definition is generated. This default form definition is based on the layout defined in
the Communications Center Process tool.
Formdef output can be handled by the AFP driver using the following modes:
• Embed
• Include
• Reference
• Export
• Ignore
See “Modes for managing AFP resources” on page 429 for more information about
the above driver options.
20.6 Color management

You can specify ICC (International Color Consortium) color profiles in AFP output.
Color profile resources can be handled by the AFP driver using the following
modes:
• Include
• Reference
For more information about modes for handling resources, see “Modes for
managing AFP resources” on page 429.

Hierarchy of color profiles in AFP output

Color profiles can be specified at three levels in AFP output:
• For the entire AFP data stream file.

• For a page in the AFP data stream file.
• For a specific image.
Color profiles specified at page level override color profiles specified for the
entire AFP data stream.
Color profiles specified for image objects override color profiles specified at
page level and for the entire AFP data stream.
Figure 20-1: Hierarchy of color profile settings in the AFP driver
Specifying color profiles

For information about specifying color profiles see:
• “Specifying a color profile for the AFP data stream” on page 447.
• “Specifying a color profile for a page” on page 447.
• “Specifying color profiles for external images” on page 441.
Further color management information

For more information about color profiles refer to the CMOCA (Color
Management Object Content Architecture).

20.7. Variables and properties
20.6.1 Specifying a color profile for the AFP data stream

You can specify audit or instruction color profiles that are used for the entire AFP
data stream. These settings are specified in the AFP driver at Job Begin.
Audit color profile settings

To specify an audit color profile for the AFP data stream you use the
setting .Name (Color Profile-Document-Audit). When running in Include
mode, you must also specify the path to the directory with the color profile
using the setting .Location (Color Profile-Document-Audit).
Instruction color profile settings

To specify an instruction color profile for the entire AFP data stream you use the
setting .Name (Color Profile-Document-Instruction). When running in Include
mode, you must also specify the path to the directory with the color profile
using the setting .Location (Color Profile-Document-Instruction).
20.6.2 Specifying a color profile for a page

You can specify an audit color profile that is used for a specific page in the AFP
output. This is done at Page Begin.
Color profiles specified for a page override color profiles for the entire AFP data
stream.
Color profile settings

To specify an audit color profile for a page you use the setting .Name (Color
Profile-Page-Audit). When running in Include mode, you must also specify the
path to the directory with the color profile using the setting .Location (Color
Profile-Page-Audit).
20.7 Variables and properties

You can assign variables to the device driver settings at both Job Begin and
Document Begin.
To assign a variable to a device driver setting
You cannot enter a variable into the property field, you must use the Alias method
to enter the variable.
1. On the Device Driver Settings tab, at Job Begin or Document Begin, select the
device driver property. The selected property is displayed as an Alias option at
the bottom of the Runtime Connector Settings dialog box.
2. Select Variable and enter the variable in the Variable field.
Example 20-13: Assigning a variable to .Value (TLE 1)
In this example, the variable $zip is assigned to the property .Value (TLE 1).

1. Select .Value (TLE 1) on the Device Driver Settings tab at Document

Begin. Alias for Option: .Value (TLE 1) is displayed at the bottom of
the Runtime Connector Settings dialog box.
2. Select Variable and enter $zip in the Variable field.
Assigning property values to comments and TLE indexes

The text strings that specify TLE values and NOP comments can include
properties generated for post-processing purposes (bundling, sorting,
enveloping, etc.). You include the properties as variables using the following
format:
%{propertyName}
For example, to add the number of sheets in a document to a comment, you

enter %{NumSheets}in the comment field.
20.8 Page identification parameters included in the

generated AFP data stream file
The generated AFP data stream file contains a number of page identification
parameters that can be used by the Print Server. The following parameters are
added as a NOP comment below each Begin Page node in the AFP data stream file:
• SIDE – Front (F) or back (B).
• DOCNR – The document number.
• DOCPG – The page number in a document.
• DOCSH – The sheet number in a document. This is only specified if a sheet layout
resource is used.
• JOBPG – The page number in a job.
• JOBSH – The sheet number in a job. This is only specified if a sheet layout
resource is used.
20.9 Optimizing performance

• Page size
The number of bytes on each logical page affect performance. The page size is
mainly determined by page density and complexity, for example image scaling
and resolution.
• Page density
The page density affects performance more than the number of bytes on the
page. Reduce the page density as much as possible.
• Resolution

20.9. Optimizing performance
If possible, make sure the resolution of the input data is the same as the printer
resolution.
• Scaling
If possible, make sure that images do not need to be scaled by the printer control.
• Fonts
Reduce the number of fonts used in a job. Switching between different fonts can
affect printing speed. Use fonts that are stored in the printer if possible.
• Redundancy
Avoid defining fonts, text orientation, and positioning unless it is required.
Avoid unnecessary blank characters and lines that overlap. For uncompressed
images, reduce the number of areas of white space if possible.
• AFP objects
Reduce the number of objects, structured fields, and controls. Try to avoid
switching between different AFP object types.
• Representation
Use efficient representation, for example solid lines instead of dashed, and group
data that uses the same font. Use compressed images instead of uncompressed,
and where possible use IOCA images instead of GOCA images.
• Optimizing printer efficiency for AFP throughput
There are several things to consider when optimizing printer efficiency for AFP
output:
• Retain resources in the printer storage.
• Use overlays for sections that are common to several pages.
• Avoid creating many short jobs. Job initiation and termination can affect
printer performance.
• Minimize the need to switch between simplex and duplex.
• Minimize the need to switch between different input bins.

Chapter 21
DOCX driver
21.1 DOCX driver settings

To enable Word output, you specify to use the DOCX driver on the output connector
in Design Center Platform settings. The driver has the following settings:
Processing mode
• Loose - If the driver receives a layout object or property that it does not
support, it is ignored and not rendered in the output. This can be useful for
documents not primarily designed for the DOCX driver. A warning message
is issued but the processing is not stopped.
• Strict - If the driver receives layout that it does not support, the processing is
stopped and an error message is issued. This can be useful when designing
documents mainly intended for DOCX output.
Info Author
Optional information for the “Author” Word property.
Info Title
Optional information for the “Title” Word property.
Info Company
Optional information for the “Company” Word property.
Info Subject
Optional information for the “Subject” Word property.
Track Changes
Select Yes to have the Track changes option enabled when opening the
document in Word.
Editing restrictions
Specifies editing restrictions for the document:
• None - No restrictions.
• Read only - The end user can only read and not edit the document.
• Allow filling in forms - The end user can read and fill in forms in the
document.
Restrictions password
Optional password that can be used to prevent the end user from modifying the
editing restrictions.

Chapter 21 DOCX driver
Copies
N/A
Caution
Do not use the DOCX driver when input comes via the AFPIN, PDFIN
filter or LXF Writer. This may generate output that is not possible to open
in Word.
21.2 DOCX output structure

Document structure
In Word, you can divide the document in sections which can have separate
formatting, like dimension, margins, headers and footers etc. In the following
cases, support for Word sections is provided:
• A StoryTeller page with Occurrence set to Once or more is mapped to a

Word section with one header and footer definition in the output for all
Word pages rendered from this StoryTeller page definition
• A StoryTeller page with Occurrence set to Exact count = 1, followed by a
page with Occurrence set to Repeatable, is mapped to one Word section
with one layout for the first page with a specific header and one layout for
the repeatable pages with a specific header. This applies if the same Story is
used in both page definitions.
Page structure
A Word page or a Word section consists of
• One rectangular body area with page margins, defining a page frame.
• Optionally a header and/or footer, which can contain objects covering the
whole page
In StoryTeller, you can define several Story frames on a page. Because Word
only supports one page frame, only one of the Story frames can be mapped as
the Word body area. The DOCX driver by default selects the first Story frame
listed in the Page object list to be mapped to the Word body area.
Note: If a StoryTeller page does not contain any Story frame, the page is
mapped to a Word page with a header where the page content is rendered.
Caution
If the same Story flows between Story frames on a first page and on
continuous pages, the Story frames must have the same dimensions
and positions, except for the upper edges of the frames. To achieve this,
you can copy the Story frame position and size from the first page
definition to the continuous pages. If required, you can resize the frame

21.3. Word driver considerations
on the page definition for the continuous pages vertically by moving

the upper edge.
21.3 Word driver considerations

The design you have created in StoryTeller is converted to corresponding Word
format with the exceptions and considerations described below.
Note: The focus when developing the DOCX driver has been to create output
for further editing in Word, and not primarily to create exactly the same output
you get when using e.g. the PDF driver.
Barcodes
Barcodes are rasterized in the DOCX output.
Bidirectional text and Shaping

All texts in Word use the equivalent of the Complex setting for BiDi and Shaping.
Any BiDi and Shaping value you specify in StoryTeller is not interesting for Word
and thus ignored.
Borders
Images
In StoryTeller, increasing the border thickness will cause half the border
thickness to extend outside the image and half will occupy space on the image
itself. In Word output, all of the border is extended outwards of the image,
meaning the total area occupied by the image will be larger than in StoryTeller.
Text
For text areas, the border behavior is similar in both outputs.
Bullets and numbering

In Word,
• It is not possible to mix numbering types in a numbered list. For example a

numeric 1 and roman II. The first number type used in the numbered list is
rendered in the DOCX output.
• It is not possible to mix numbering and bullets in a numbered/bullet list. If such a
mix exists in the StoryTeller document, the output will be a numbered list
starting from 1.
• The numbering level Body does not exist. A paragraph defined as body in
StoryTeller is rendered as a level 1 paragraph in Word.

Chart
Charts are rasterized in the DOCX output. However, it will most likely be supported
and mapped to Word charts in future releases.
Columns
StoryTeller columns are only supported in the DOCX output for the first Story in the
Stories list.
Decimal tabulator
StoryTeller applies the appropriate decimal separator according to the current
language in the document. In Word, the system locale setting is used to decide
which decimal separator to use. This means that if you have different decimal
separator in different parts of your StoryTeller document depending on the
language, all decimal separators will be the same in the Word output.
This means also that the decimal tabulator may be rendered differently in the DOCX
output compared to what you have designed in StoryTeller.
Fragments
For Dynamic and Content Dependent Fragments defined in StoryTeller, the
following apply:
• the <page> substitution is mapped to a field in Word displaying the current page
number.
• the <pages> substitution is mapped to a field in Word displaying the total
number of pages in the document.
Note: For other output than via the DOCX driver, you must use a Content
Dependent Fragment if you use the <pages> substitution, or the pages() script
function. This means that if you e.g. intend to create output via drivers like
PDF or AFP from the same StoryTeller document, you must use the Content
Dependent fragment for these fields.
Caution
Dynamic fragments can only be evaluated when the page type where the
fragment is added has been defined in StoryTeller and generated with the
DOCX driver. Pages that are added in Word afterwards are not included in
the evaluation.
Images
In Word, images that are larger than the object size are always resized or cropped to
fit the object size.

• If you use negative margins in StoryTeller to let an image be larger than its object
boundaries, the image is cropped in the DOCX output.
• If you insert an image in StoryTeller where the image native size is larger than its
object boundaries, the image is scaled to fit the object in the DOCX output.
Inline positioning of object on text line

If you have placed an object inline in a text line in StoryTeller, without any text, the
DOCX output renders a line height depending on the current font of the text.
Especially, this is visible when a horizontal line is the only object in a paragraph.
Keep lines together

In Word you can not specify an exact number of lines to keep together. If a
StoryTeller paragraph has:
• All lines specified for Keep lines together (or for either Keep start lines together
or Keep end lines together), the setting is mapped to “Keep together” in Word.
• If a StoryTeller paragraph has at least 1 line specified for either Keep start lines
together or Keep end lines together, the setting is mapped to “Widow/Orphan
control”.
Keep with next

In Word you can only specify to keep with next paragraph, not any specific number
of lines. If a StoryTeller paragraph has Keep with next specified to one line more,
the setting is mapped to “Keep with next” in Word.
Line breaking mode

In Word there is no equivalent to the Line breaking mode settings, and they are
ignored in the Word output.
Line wrapping and line spacing

• Line wrapping (new line created when text reaches boundary or soft return) and
line spacing is implemented differently in StoryTeller and Word.
By specifying MS Word on the Text wrapping paragraph property in
StoryTeller, you enable a formatting mode that tries to mimic the line wrapping
and line spacing in StoryTeller as to how it is done in Microsoft Word.
Note: For RTF filtered input, the property is set to MS Word by default.
• In Word, there is no equivalent to Linespacing mode value Multiple. The

Multiple value in StoryTeller is mapped to “At least” in Word.
Note: The “Multiple” value in Word corresponds to Linespacing Mode

value Relative in StoryTeller.

Page structure
Figure 21-1: The first frame in the list is used in the DOCX output
Tip: By setting the Name property of a Story frame to _MAIN_, the DOCX
driver selects this frame to use in the output, even if it is not first in the list.
Figure 21-2: The _MAIN_ frame is used in the DOCX output
Note: The remaining Story frames are mapped into text areas that are rendered
in the page header of the Word output. Other objects than Story frames are also
rendered in the page header.
Tables
Table headers
In StoryTeller, you can use several types of overflow headers, like Only first
instance, All but first instances etc. Word only has support for a repeated
header. The following applies:
• If you specify a row header to Only first instance, and you also have a
header for All instances, the Only first instance header is ignored. If an All
instances header does not exist, the Only first instance header is mapped
into a body row.
• If you specify an All instances header, it must be the first row of the table.
Space before and after a paragraph table

A StoryTeller table that is defined as a paragraph table, i.e. it is not inline within
the text but is located on its own paragraph, has the paragraph properties as any
paragraph, including e.g. Space before.

In Word, the table is a paragraph of its own but lacking the paragraph
properties a text paragraph has, such as the space before and after the
paragraph. Therefore, any setting for Space before and Space after is ignored in
the Word output.
Table inline within a paragraph

To enable rendering of an inline table in Word, the table is encapsulated in a text
box. This means that the objects in the table, e.g. text in cells, have to be
rasterized by the driver.
Table cell fill color

If you specify a gradient fill on a table cell in StoryTeller, only the Fill color
value is used to render a solid fill. The Secondary color is ignored, because
gradient fill is not supported in Word table cells.
Table and table cell borders

In Word, generally either the table border or the table cell borders are drawn,
usually only the cell borders if you have specified to draw them in StoryTeller.
Horizontal cell border width

In Word, the horizontal border width is included in the total row height, which
is not the case in StoryTeller. This means that fewer table rows may fit into a
frame than in StoryTeller.
Vertical cell border width

In Word, the vertical cell border width is included in total cell area, which is not
the case in StoryTeller. This means that less content may fit inside a cell in Word
than in StoryTeller.
Balanced columns
In Word, all data is rendered in one column regardless of the StoryTeller column
section settings.
Text area objects

Text objects and shapes in a text box are rasterized by the DOCX driver.
Text inside a shape

If you add text into a non-rectangular shape (right-click a shape and select Insert >
Text), StoryTeller uses the inner margin (left or right depending on direction of text)
and/or indents to define the area for the text.

Figure 21-3: Text following the edges in a StoryTeller shape
In Word, the inner margins is used to define a rectangular area for the text. This
means that the DOCX output can look different from the StoryTeller design:
Figure 21-4: The DOCX output for the StoryTeller design in Figure 21-3
Note: In addition to standard shapes, like ellipses or free forms, a shape can be
created in StoryTeller by enabling point editing mode on a text box.
Visibility
In StoryTeller, if you specify Visibility to Invisible on an object, the DOCX driver
generates an empty text object. This object can be deleted when output is opened in

21.4. Defining Table of Contents for DOCX output
Word. However you can not make it visible again. Objects with Visibility set to
Hidden are not included at all in the DOCX output.
Wrapping text around objects

StoryTeller design where text is wrapped around objects is not supported in the
DOCX output. However, it will most likely be supported in future releases.
21.4 Defining Table of Contents for DOCX output

You can define a location within a text flow where you want a table of contents to be
inserted in the DOCX output. The text flow can be either a Story or a Text area. The
table of contents is based on a template that you can define in StoryTeller.
Note: The paragraphs you want to be included in the table of contents must be
included in a Story and have Outline level set to Level 1 or higher in the
Properties panel Paragraph properties.
To define the location of the table of contents in a Story
1. In the Stories panel, select a Story.
2. In the Stories view, right-click in the Story where you want to insert the table of
contents and select Insert > Table of Contents for DOCX.
3. Verify in the Stories panel that a Table of Contents for DOCX command is
inserted into the Story.
To define a table of contents template
1. In the Stories panel, select the Table of Contents for DOCX command.
2. In the Properties panel, Command category, select Table of Contents

definition.
3. Click the browse button. The Table of Content definition dialog opens.
4. Define the table of contents. For information about the options in the dialog, see
Section 8.7.30 “Table of Contents definition dialog” in OpenText Communications
Center Enterprise - StoryTeller Configuration Guide (CCMSTT-CGD).
Generating table of contents in Word
When opening the DOCX output for the first time in Word, you are asked if you
want to update fields that refer to other files:
• Select Yes to generate a table of contents in the Word file at the location you
defined in StoryTeller.
• Select No to keep an empty placeholder for the table of contents. It is possible to
generate the TOC later in Word by right-clicking the placeholder and selecting
Update field.

Chapter 22
HTML unpaginated driver
The HTML unpaginated driver is used to generate unpaginated data streams in

HTML format. For example, rich HTML output from a StoryTeller Process for use in
an email body.
In the Runtime configuration, you can override the Platform driver settings. For
example, to set values dynamically via variables. For some settings, the value
returned by a variable must be Yes or No (case sensitive).
Tip: You can configure custom properties for some of the driver settings in
StoryTeller (see Section 2.3.1 “HTML settings in StoryTeller” in OpenText
Communications Center Enterprise - StoryTeller Configuration Guide (CCMSTT-
CGD)). For example, to use individual settings for several StoryTeller Processes
in the same Message. The driver settings override the custom properties
configured in StoryTeller.
Note: All driver settings with Default as value (or empty value) will use the
value defined in StoryTeller. This is either the StoryTeller default value or a
value specified by a custom property.
HTML version
The HTML version to use for the output.
• Default - Any value specified by the custom property html.version in
StoryTeller is used. If no custom property is specified, HTML 4.01 is used.
• HTML 4.01 Transitional - Used for HTML 4.01 output. Used mostly for
backward compatibility reasons.
• HTML 5 - Used for HTML 5 output. Must be used to, for example, enable
StoryTeller interactive objects.
HTML title
A title of the HTML page (optional) visible in the client web browser.
If left empty, any value specified in StoryTeller using the custom property title is
used. If no custom property is specified, no title is used.
Inline CSS
Specifies how the CSS (Cascading Style Sheets) is used with the HTML output.
• Default - For SMTP (MIME), the CSS is integrated in the HTML output, and for
other output connectors, a separate CSS file is generated.

Chapter 22 HTML unpaginated driver
• Yes - Integrates the CSS in the HTML output, regardless of the output connector
being used.
• No - Generates a separate CSS file that the HTML output links to. Only
supported for File and SMTP (MIME) connectors, and for output connectors
with Include result in service response enabled (input received via a Service
Request input connector).
Note: At a StoryBoard preview, a separate CSS file is always generated,

regardless of this driver configuration.
Link images
A regular expression to link images in the HTML output. For information about
regular expression syntax, see http://www.regular-expressions.info/reference.html.
If left empty, any value specified in StoryTeller using the custom property
linkedresources is used. If no custom property is specified, images are not linked.
If you link images as external resources in the StoryTeller document, you can use a
regular expression to link the images also in the HTML output. When the regular
expression matches an image URI, the image URI is used in the HTML output. With
no match, the image is generated as an external file referenced from the HTML
output.
Example 22-1: Link HTTP images except those stored on local host/
network
To use HTTP image URIs directly in the HTML output for images that are
not referenced from the localhost or the local network, you can specify the
following regular expression:
^http://(?!localhost[/:]|192\.168\.)
This means that if the URI starts with http:// the image URIs are kept in
the output, except in the following cases:
http://localhost/
http://localhost:
http://192.168.
Body background color

The background color of the HTML page in HTML color format. For information
about HTML color formats, see http://www.w3schools.com/html/html_colors.asp.
If left empty, any value specified in StoryTeller using the custom property html.
body.background-color is used. If no custom property is specified, no background
color is used.

Example 22-2: Body background color red, no opacity
To add a red background color, you can use one of the following HTML
color formats:
red
rgb(255,0,0)
rgb(100%,0%,0%)
#FF0000
#F00
You can also use the RGBA color model to specify the opacity of a color. Note that
the RGBA color model is not supported by all web browsers and email clients.
Example 22-3: Body background color red, opacity 50%
To set the opacity of the red color to 50%:
rgba(255,0,0,0.5)
Body margin
The body margins of the HTML page in pixels or CSS units. For information about
body margin syntax, see http://www.w3schools.com/css/css_margin.asp. If left
empty, any value specified in StoryTeller using the custom property html.
body.margin is used.
The margins define the space around the body object. You can specify one value for
four all margins, or use different values for the top, right, bottom, and left margins.
You can use negative values to overlap content, but note that negative values for
margins are not supported by all email clients.
Example 22-4: Body margin
To set all four margins to 96 pixels, enter 96.
To set different values for the top (14 points), right (1 inch), bottom (no
margin) and left (1 inch) margins, enter 14pt 1in 0 1in.
Rasterize fragments
Determines whether to rasterize fragments referenced from Stories.
• Default - Same as No below.

• Yes - Rasterizes fragments that are referenced from Stories.

• No - Ignores fragments that are referenced from Stories.
Use native gradient fill

Defines how StoryTeller objects that use gradient fill are treated in the HTML
output.
Notes
• Radial gradients are always rasterized, regardless of driver configuration.
• Gradient fill is not supported by all web browsers.
• Default - Any value specified by the custom property html.native-gradient-
fill in StoryTeller is used. If no custom property is specified, shapes with
gradient fill are rasterized.
• Yes - Enables horizontal and vertical gradients in the HTML output. On the
HTML page, gradients are rendered according to the web browser support for
gradient fill.
• No - Shapes with gradient fill are rasterized.
Body background image

Specifies the URL to a background image, e.g. a watermark in an email body, to be
rendered on the HTML page. Note that the image format must be supported by the
web browser or email client. For more information about background images and
the related settings, see http://www.w3schools.com/cssref/pr_background-
image.asp.
If left empty, any value specified in StoryTeller using the custom property html.
body.background-image is used. If no custom property is specified, no background
image is used.
No guarantee that a watermark is displayed

There are big differences in how watermark images are treated by different
email clients. For example, an email client might not support body
background images at all. And even if such images are supported, the
email client might have fixed values for the related body background
properties, such as repeat and attachment.
We recommend that you verify that the watermark image is properly

rendered in each email client of interest. If you identify potential display
issues, you must account for those issues in your Project design. For
example, by adding textual messages to the StoryTeller template.
Valid URLs
The client must be able to access the image using the URL specified. In case of an
absolute URL you must use the appropriate prefix, for example http:.

Body background repeat
Defines whether the specified Body background image is repeated on the HTML
page. For more information about repeating background images, see http://
www.w3schools.com/cssref/pr_background-repeat.asp.
• Default - Any value specified by the custom property html.body.background-
repeat in StoryTeller is used.
• repeat - The image is repeated both horizontally and vertically.
• no-repeat - The image is displayed only once.
• repeat-x - The image is repeated horizontally only.
• repeat-y - The image is repeated vertically only.
Body background attachment

Defines whether the specified Body background image move along with the HTML
content or is displayed on a fixed position in the web browser or email client. For
more information about background image attachments, see http://
www.w3schools.com/cssref/pr_background-attachment.asp.
• Default - Any value specified by the custom property html.body.background-
attachment in StoryTeller is used.
• scroll - The image scrolls along with the content body.
• fixed - The image is fixed with regard to the viewport (the viewing area on the
screen).
Body background position

The initial position of the specified Body background image before any scrolling
occurs. If left empty, any value specified in StoryTeller using the custom property
html.body.background-position is used.
The offset is set from the upper left corner of the content body. You can specify the
values in pixels, CSS units, or via the following keywords (case sensitive):
• left - Equivalent to 0% for the horizontal position.
• right - Equivalent to 100% for the horizontal position.
• top - Equivalent to 0% for the vertical position.
• bottom - Equivalent to 100% for the vertical position.
• center - Equivalent to 50% for the horizontal position if it is not otherwise given,
or 50% for the vertical position if it is.
If you specify only one value, the second value is assumed to be center. If at least
one value is not a keyword, then the first value represents the horizontal position
and the second represents the vertical position.

Note: If Body background attachment is set to fixed, the image is placed

relative to the viewport (the viewing area on the screen) instead of the content
body.
For more information about background image positions, see http://

www.w3schools.com/cssref/pr_background-position.asp
Example 22-5: Body background position
To offset the image 2 cm to the right and 1 cm below the upper left corner,
use:
• 2cm 1cm
To offset the image 2 inches to the right of the upper left corner, but still
aligned with the top, you can use one of the following:
• 2in top
• 2in 0
To offset the lower right corner of the image to the lower right corner of the
content body, you can use one of the following:
• right bottom
• 100% 100%
Head additional contents source URI

URI to a file containing additional head elements. If left empty, any value specified
in StoryTeller using the custom property html.head.additional-contents.
source-uri is used.
A developer can add additional head elements to an UTF-8 encoded file, and store
this file in any repository that can be accessed by StoryTeller. The additional
elements are normally <meta>, <link>, <script> and <style> elements, but the
developer can add any content supported in the <head> element (except <title>).
When specifying the URI to this file, the file content is added to the <head> section
in the generated HTML.
Valid URLs
The resource referenced by the URL is a resource used in StoryTeller. This URL
can be any standard StoryTeller repository URL.
No minimum thickness on transparent borders

Specifies how to handle the line width of transparent borders in the output.

• Default - Any value specified by the custom property html.no-minumum-
thickness-on-transparent-borders in StoryTeller is used. If no custom
property is specified, the default value is the same as No (see below).
• Yes - If a border line is transparent, the line width in the output is the same as the
line width defined for the object in StoryTeller. For example, if the line width
defined in StoryTeller is 0 pt, then the line width in the output is 0 pt as well.
• No - The line width in the output is at least 0.75 pt for transparent border lines as
well as for colored border lines. For example, if the line width defined in
StoryTeller is 0 pt, then the line width in the output is 0.75 pt.
Semantic tag attribute name

Used to propagate semantic tags from StoryTeller documents to HTML output via
the HTML unpaginated driver. If left empty, any value specified in StoryTeller using
the custom property html.semantic-tag.attribute-name is used.
The purpose is to help users when post-processing the output using custom CSS or
JavaScript filter (see “JavaScript filter” on page 556). The value of Semantic tag
attribute name must be a valid attribute name. An attempt to set an invalid value
throws an exception. In HTML, all attributes with prefix data- should be valid.
Note: The attribute name class (case insensitive) is invalid.
If the value of Semantic tag attribute name is empty, semantic tags are not
propagated to the HTML output. If the value is a valid attribute name, this attribute
name determines the HTML attribute where Class values from the StoryTeller
document have to appear. The driver may produce a specific additional HTML
element for the attribute, or it may add the attribute to a suitable element.
When a Class is found in a StoryTeller document, and if the value of Semantic tag
attribute name is valid, this tag is propagated to the HTML output under the
following circumstances:
• The Class is assigned to the main story, a table story or a story owned or
referenced by a switch
• The Class is not assigned to a story containing just table rows (“Table range”).
• The Class is not inside external contents arriving via a substitution.
• The contents is not rasterized in the HTML output.
Copies
Not applicable.

22.1 HTML considerations

Caps and joins
Line properties Start cap, End cap and Line join are ignored in the output.
Colors
CMYK and grayscale is not supported in HTML, colors are converted to RGB.
Corner effects
Corner effects, e.g. rounded corners are:
• Ignored in tables, i.e. normal square corners are rendered in the output.
• Rasterized in shapes, e.g. rectangles.
Gradient fill
Shapes with gradient fill are by default rasterized, because not all web browsers
support gradient fill. You can override this behavior and allow gradient fill to be
generated by specifying either:
• The html.native-gradient-fill custom property in StoryTeller.

• The Use native gradient fill setting for the HTML unpaginated driver.
Note: Interactive objects can not have any gradient fill.
Horizontal scaling
Horizontal scaling of text is not supported in HTML.
Hyphenation
Hyphenation of text is not supported in HTML.
Inline objects
If possible, avoid using multiple text objects or tables in the same text line. Instead
use a single table. This is because the HTML driver generates one cell tables for text
objects to support vertical alignment of these objects. However, e.g. MS Outlook
displays these tables as a paragraph table, i.e. the table is the only object that can be
on that same text line.
Interactive objects
• Because Internet Explorer does not submit values from interactive objects outside
of an interactive form, an interactive object must always be kept within the scope
of an interactive form.

22.1. HTML considerations
• A drop-down list in HTML output always have the first value in the list pre-
selected, as long as the user has not yet selected any other value.
Linespacing
You should avoid situations where exact line spacing is necessary since HTML and
StoryTeller handle line spacing differently. In HTML, the space is distributed
equally above and below the text, while in StoryTeller the specified line spacing is
rendered below the text.
Rotation
Rotation of objects is not supported by HTML and thus ignored. Objects rotated in
StoryTeller are rendered in the HTML output without rotation.
Symbol fonts
You should avoid symbol fonts since HTML does not support characters addressed
by codepoints.
However, the StoryTeller bullets, which uses Symbol font, are mapped from the
Symbol font by the HTML driver to Unicode U+2022. This renders a bullet of the
current font in the same point size as the original bullet, just slightly smaller.
Tabs
HTML does not support tabs. Each tab is replaced with two space characters in the
output. In StoryTeller, tabs are used in the default numbering types. However, for
bullets and numbering, it is ensured that the bullet or number is placed at the first
line indent and a relative width span is rendered before the bullet/numbering
content. This space is the shortest of the defined tab and the indent position.
Tables
Because HTML does not support balanced columns, all data is rendered in one
column regardless of the column section settings.
Vector graphics
The following examples of vector graphics are rasterized:
• Dotted or dashed rectangles

• Ellipses
• Lines
• Barcodes
• Charts
Rectangles with solid lines are maintained as vector objects also in the HTML
output.

Vertical grow
It is recommended that you let content grow with text areas and table rows, instead
of using fixed heights. Depending on the mail client, the content may require more
space than the HTML driver expects.
Caution
As described above, many design elements that you add in StoryTeller are
rasterized by the HTML driver. Be aware of that this rasterization may
cause the following:
• Slower processing.
• Large image attachments to the email.
• Screen resolution and zooming constraints.
Additional font information
To enable better suggestions to browsers that do not have the exact font name
available, additional font information is generated in addition to the font family
name, as in the examples below:
• Arial - 'Arial', sans-serif
• Arial Narrow - 'Arial Narrow', sans-serif
• Times New Roman - 'Times New Roman', serif
• Imprint MT Shadow - 'Imprint MT Shadow', fantasy
• Courier New - 'Courier New', monospace
• Bradley Hand ITC - 'Bradley Hand ITC', cursive
• Wizardry - 'Wizardry\xd5
XML transformation
The HTML output can be transformed into XML by loading it in an XML parser.

Chapter 23
Layout driver
The Layout driver is intended for StoryTeller output only. It is typically used to
produce paginated output for browser based editors like Communications Center
StoryBoard and ReTouch.
The driver collects layout information from individual StoryTeller pages, rasterizes
the pages to the appropriate image format (PNG or SVG), and produces XML
output. To transform the XML to a presentation suitable for the client (for example
StoryBoard) you must apply an XML Stylesheet Filter to the output (see “XML
stylesheet filter” on page 563).
Layout driver settings

• ImageFormat
Image format of the rasterized pages (png or svg). Default image format is
PNG.
• Dpi
Resolution of the rasterized pages. Default resolution is 96 DPI.
• RenderFilter
Filter defining which pages to include in the output. If left blank, all pages
are included in the output.
• RasterizeFilter
Filter defining which pages to rasterize. If left blank, all pages are rasterized.
• Copies
N/A
Filter examples
The following examples apply to both the RenderFilter and RasterizeFilter:
• 2
Select page number 2 only.
• 2,2,2
Same as 2.
• 1–3
Select page number 1–3.
• 3–1
Same as 1–3.

Chapter 23 Layout driver
• 1,3,6
Select page number 1, 3 and 6.
• 6,3,1
Same as 1,3,6.
• 1,3–5,8
Select page number 1, 3, 4, 5 and 8.
• 6–
Select all pages from page 6 to the end.
Interaction between the filters

The RenderFilter defines which pages to include in the output and the
RasterizeFilter defines which pages to rasterize. The interaction between the
filters can be exemplified as follows:
• RenderFilter: 1-3 and RasterizeFilter: 2-
Include the first 3 pages but rasterize only page 2 and 3.
• RenderFilter: 2,4,6 and RasterizeFilter: 1–8
Include and rasterize page 2, 4 and 6.

Chapter 24
PCL 6 driver
The PCL 6 driver is a Hewlett-Packard developed LaserJet PCL language with

related technology.
Platform settings
• Page size
The size of the page. You can select from a number of pre-defined sizes (Letter,
Legal, A4, etc.) or specify a custom page size (in millimeters).
• CustomPageWidth
The page width (mm) when Page size is Custom Size.
• CustomPageHeight
The page height (mm) when Page size is Custom Size.
• Paper source
The media source for the printer, i.e. the source where the printer gets the media
(Letter, A4, etc.) to print on.
• PageDestination
The destination for the printed output.
• Duplex
Specifies whether to use duplex printing (both sides of the sheet), and how to
apply the binding (horizontal or vertical) for duplex printing.
• None - No duplex printing (print on one side of the sheet only).
• Horizontal - Use duplex printing with horizontal binding.
• Vertical - Use duplex printing with vertical binding.
• DuplexSide
The side of the sheet where to print the current page.
• None - Use device default setting.
• Front Media Side - Print on the front side of the sheets.
• Back Media Side - Print on the back side of the sheets.
• Orientation
The orientation of the page.
• ImageColorQuality
The color quality used on the output image.

Chapter 24 PCL 6 driver
• 256 Color - 256 color quality (8 bit).

• High Color - Maximum color quality (24 bit).
• ImageCompression
The compression method used on the output image.
• No Compression - No compression.
• RLE Compression - Run length encoding (RLE) compression.
Runtime settings
• ByteOrder
Ordering of the most significant to the least significant bytes in the stream for
multibyte binary fields.
• Big Endian - A binary binding follows in the stream body where operator
identifiers, attribute identifiers, and attribute values are expressed in a form
where the most significant byte is the first byte in the binary field (from left to
right) and the least significant byte is last (to the right).
• Little Endian - A binary binding follows in the stream body where operator
identifiers, attribute identifiers, and attribute values are expressed in a form
where the least significant byte is the first byte in the binary field (from left to
right) and the most significant byte is last (to the right).
• ErrorReport
Indicates the method for how to report errors to the user.
• Error Page - Report errors by printing or displaying an error page.

• No Reporting - Do not report errors.
• Back Channel - Report errors through the back channel (i.e. device
dependent).
• Back Channel and Error Page - Report errors through the back channel and
by printing or displaying an error page.
• No Warn. Back Channel - Only report errors (no warnings) through the back
channel (i.e. device dependent).
• No Warn. Error Page - Only report errors (no warnings) by printing or
displaying an error page.
• No Warn. Back Channel and Error Page - Only report errors (no warnings)
through the back channel and by printing or displaying an error page.
Printing overlays before processed output

If you need to send overlays to the driver before the processed output, for example if
the PCL output contains white text printed over overlays, you can use the custom

command overlayfirstonpage. See “Using custom commands and keywords”
on page 65 for information about how to add custom commands and keywords.
You must add this command to the following node:
Runtimes/<Runtime>/Output Connectors/<Connector>/<Job>/Job Begin/Logical
PJL command support

PJL commands allows job level control that cannot be accomplished with the PCL
printer language, for example job separation, printer configuration and status
readback from the printer.
To be able to add PJL commands you must create a custom PCL 6 device and a copy
of the pcl6.drs driver file for this device. See “Device Tool” on page 525 for
information about how to create custom devices. When you have your custom
device you can add the appropriate PJL commands to its custom *.drs file.
When you open the *.drs file in an editor you will find the following JobBegin tag
(line breaks added for readability reasons):
JobBegin "<1b>%-12345X@PJL<0d,0a>
@PJL JOB NAME=<22>%1<22> DISPLAY=<22>%1<22><0d,0a>
@PJL SET RESOLUTION=600<0d,0a>"
The default string contains PJL commands for job name and resolution. If you need
more PJL commands, you must add them to this string. For example, to add the PJL
command @PJL SET COPIES=3<CR><LF> you can edit the JobBegin string as follows:
JobBegin "<1b>%-12345X@PJL<0d,0a>
@PJL JOB NAME=<22>%1<22> DISPLAY=<22>%1<22><0d,0a>
@PJL SET RESOLUTION=600<0d,0a>
@PJL SET COPIES=3<0d,0a>"
Note: You must use hexadecimal <0d,0a> for <CR><LF>.

Chapter 25
PDF driver
The following applies to the PDF driver:
• Generates the lowest possible PDF version, which is normally PDF 1.3, unless the
output contains features that require later versions of PDF.
• Compatible with Acrobat 4.0 and later.
• Accepts LXF overlays.
• Enables adding and embedding of TrueType fonts in output.
• Enables adding and embedding of Postscript Type 1 fonts in output.
• Full Unicode support (via automatic font embedding).
• Full color support.
• Accepts interactive objects added in StoryTeller.
• Accepts graphics added in StoryTeller.
• Supports rounded corners and oblique lines.
• Supports file compression.
• Supports encryption.
• Supports bookmarks.
• Supports PDF/A and PDF/X.
• Supports attachments with Plain PDF and PDF/A-3.
To generate PDF output, you must select and configure a PDF driver for the output
connector, and configure the corresponding driver options, see “PDF driver
Fonts
You can use TrueType or Postscript Type 1 fonts in the PDF output.
Embedding fonts
Embedded TrueType or Postscript Type 1 fonts enable the receiver of the PDF
file to view and print fonts without installing them locally. For information on
how to embed fonts in PDF documents, see “Embedding fonts in PDF
documents” on page 519.
Signing PDF documents

You can use the PDF signature filter to create locally signed PDF documents. See
“PDF signature filter” on page 559.

Chapter 25 PDF driver
25.1 PDF driver settings

• Use compression
• Yes - Use compression.
• No - Do not use compression.
Use compression whenever possible.

• Info: Author
The document author.
• Info: Creator
The application that created the document.
• Info: Title
The document title.
• Info: Subject
The document subject.
• Info: Keywords
Keywords associated with the document.
• Use encryption
• No - Do not use encryption.
• Standard R2 - Use Standard Security Handler revision 2 (encryption
algorithm RC4 with 40-bit keys). See Standard Security Handler revision 2
on page 486.
algorithm RC4 with 128-bit RC4 encryption). See Standard Security Handler
revision 3 on page 486.
algorithm AES with 256-bit AES encryption). See Standard Security Handler
revision 5 on page 487
• User password
Applicable only if encryption is used
A password a user must enter to open, decrypt, and display the document on
screen. Enables printing, modifying, and copying of the document according to
the values selected for the Allow print, Allow modify, and Allow copy options
below.
• Owner password
A password a user must enter to open, decrypt, and display the document on
screen. Enables full access to the document.

25.1. PDF driver settings
• Allow print
• No - Do not allow printing of the document.
• Yes - Allow printing of the document.
• Allow modify
• No - Do not allow modification of the document.
• Yes - Allow modification of the document.
• Allow copy
• No - Do not allow copying of text and graphics from the document.
• Yes - Allow copying of text and graphics from the document.
• Use filter ASCII 85
• Yes - Encode data as 7-bit ASCII text.
• No - Do not encode data as 7-bit ASCII text.
The ASCII-85 filter encodes binary data as 7-bit ASCII text consisting only of
printable characters. This enables data to be sent through various communication
channels without undesired changes, for example, older mail systems that cannot
handle 8-bit data streams.
When this filter is used, the overall PDF file size becomes approximately 20%
larger.
Encrypted PDF files are always binary, so the filter is not useful for this kind of
data.
For more information about the ASCII-85 filter, see for example the PostScript®
Language Reference.
• Use resolution
• No - Embed images as they are.
• Yes - The resolution specified in the driver file is used. The default resolution
is 300 dpi. Some images are down-scaled, depending on the actual image
resolution and the resolution specified in the driver file. To specify another
value than the default resolution you must edit the driver file. See “Device
drivers and tools“ on page 523.
• Embed threshold
If you want to embed characters with codes below 256, you can define which
characters to embed when using Unicode characters in TrueType fonts. For
example, if you set this value to 128, all characters used, with codes greater than
or equal to 128 will be embedded. Minimum value is 0, maximum value is 256.

• Viewer: Page number

Applied when the user opens the document. The first page displayed in the
viewer.
• Viewer: Page zoom
Applied when the user opens the document.
• Default - Use the display settings in Acrobat general preferences.
• Fit in window - Adjust the page size to fit the window size.
• Fit width - Adjust the page size to fit the window width.
• Fit visible - Adjust the page size to fit the window width, displaying all
visible text and graphics but not the page margins.
• 25%-1600% - The zoom factor.
• Viewer: Page layout
Applied when the user scrolls the document.
• Default - Use the display settings in Acrobat general preferences.
• Single page - Display just one page at the time.
• Continuous - Display pages continuously.
• Continuous Facing - Display even and odd pages facing each other and
continuously.
• Viewer: Full screen
• No - Do not open the document in full screen view.
• Yes - Open the document in full screen view.
• Viewer: Hide toolbar
• No - Do not hide the toolbar
• Yes - Hide the toolbar.
• Viewer: Hide menu bar
• No - Do not hide the menu.
• Yes - Hide the menu bar.
• Viewer: Hide window UI
• No - Do not hide the window controls.

• Yes - Hide the window controls, for example bookmarks and thumbnails.
• Viewer: Fit window
• No - Do not resize the viewer to fit the page.
• Yes - Resize the viewer to fit the page.
• Viewer: Center window
Select Yes to display the window centered on screen.
• Viewer: Display document title
• No - Do not display the document title in the title bar.
• Yes - Display the document title in the title bar.
• Viewer: Page mode
• Page Only - Only display the page.
• Bookmarks and Page - Display the Bookmarks tab and the page.
• Conformance
The conformance level of the PDF output.
Note: Tagged PDF and PDF/A-1a can only be used in combination with the
Adobe LiveCycle Designer ES Process.
• Plain PDF - Select to generate plain PDF.
• Tagged PDF - Select to generate tagged PDF, i.e. include information about
the structure of the document in the PDF. Structure is the term for a set of
instructions that define the logic that binds the content together – for example
the correct reading order, and the presence and meaning of significant
elements such as figures, lists, tables, etc.
• PDF/A-1a - Select to generate PDF/A–1 Level A compliant output. See “About
PDF/A” for more information.
• PDF/A-1b - Select to generate PDF/A–1 Level B compliant output. See “About
• PDF/X-1a:2003 - Select to generate PDF/X output compliant to ISO
15930-4:2003. See “About PDF/X” for more information.

• PDF/X-3:2003 - Select to generate PDF/X output compliant to ISO

15930-6:2003. See “About PDF/X” for more information.
• Use JPEG Image Compression
Specifies whether to convert color images to compressed JPEG images.
• Yes - Convert all color image formats to compressed JPEG images.
Monochrome images will be compressed as CCIT G4 or using ZLIB.
• No - Keep the original image formats. No compression is applied unless the
original format is JPEG.
If you select No, JPEG compression will still be used for images already in JPEG
format. If a source image is of any other format (PNG, BMP, etc.) you must select
Yes to compress the image in the output document.
Note that if you select No, and Use compression above is set to Yes, the ZLIB
compression is applied to images.
• JPEG Image Compression Quality
Specifies the compression level and quality of JPEG images in the output
document. You can select a number between 10 (highest compression level/worst
quality) and 100 (lowest compression level/best quality). The default value is 80.
Compression quality is applied when compressing non-JPEG images. Images
already in JPEG format are not reprocessed.
• Use forms
• Yes - All non-dynamic overlays used in the Project are generated as PDF form
objects.
• No - All data is processed as usual.
• Color: Profile for RGB
Specifies the file path to an ICC color profile for RGB colors. The path is relative
to the working directory.
Note: This profile is used only if a color profile is required and the color
profile of the RGB input color for the PDF driver is not known.
• Color: Rendering intent
If color conversion is required, e.g. if the color space differs between the source
and the destination, you can specify one of the following to e.g. avoid clipping of
saturated colors:
• AbsoluteColorimetric - Use to render exact specified colors.
• RelativeColorimetric - Use to render exact specified colors, but with a
correction for the output media.
• Saturation - Recommended for charts where a limited set of distinctive colors
is used.
• Perceptual - Recommended for natural images/photos.

• Output intent: OutputConditionIdentifier

If a characterization data registry is required, this specified a reference name of
the characterization data. The intended printing condition is defined in the ICC
characterization registry. For example, FOGRA43
• Output intent: OutputCondition
A text string that identifies the characterized printing condition.
Note: The text should be meaningful to the operator receiving the file.
• Output intent: RegistryName

Specifies the characterization data registry, if required. If the intended printing
condition is defined in the ICC characterization registry, specify the following:
http://www.color.org/
• Output intent: DestOutputProfile
Specifies the file path to the color profile corresponding to the characterization
data reference specified in Output intent: OutputConditionIdentifier. The path
is relative to the working directory.
For example, .\CoatedFOGRA43.icc
• Document script
If you want to embed a JavaScript into the PDF output, specify the path here. The
script must be located in a file that can be accessed by the StreamServer
application. The path to this file is typically relative to the working directory.
• Interactive fields
Select whether to use interactive objects configured in StoryTeller.
• Interactive - Select to use interactive objects.
• Static - Select to render interactive objects as static objects.
Note: Must be Static for PDF/A and PDF/X documents. If not, the presence
of interactive objects will trigger an exception and document processing
will fail.
• XMP descriptions file
Specify file path to the XMP descriptions file to use. This may be required when
PDF is used for output documents that should comply with industry defined
standards, such as the ZUGFeRD specification.
• Copies
Not applicable.
About PDF/A
PDF/A is used for long term archiving of electronic documents, and ensures the
documents can be reproduced the exact same way in years to come. All information

necessary for displaying the document is embedded in the file. This includes all
content, fonts, and color information. A PDF/A document must not be reliant on
information from external sources (e.g. font programs and hyperlinks), and must not
be password protected.
Level B is focused on preserving the appearance of the document.
Level A is the same as Level B, with the addition of tagged PDF. Level A
conformance ensures, in addition to the appearance of the document, that the
document structure is described in the PDF, and that all text can be extracted. For
example, to enable a document to be read out loud using a speech synthesizer, you
must use Level A.
PDF/A-3a extends PDF/A-1 with the possibility to embed attachments in the PDF.
The attachment can be in any format, but the attached file must be explicitly
associated with the PDF where you specify the relationship (source, data,
alternative, supplement, or unspecified) on the output connector. See “Specifying
attachments to be embedded in the PDF output.“ on page 484.
Notes
• You can not use encryption together with PDF/A.

• You can not use interactive objects defined in StoryTeller together with PDF/
A.
Specifying attachments to be embedded in the PDF output.
1. In the Platform settings, for PDF device Conformance option, specify Plain PDF
or PDF/A-3a.
2. In the Runtime settings on the output connector, click Document Begin.
3. Specify the settings below:
Attachment type
Static attachment – Select to specify a static attachment via the Attachment path
option below.
Output from Attachment connector – Select to use dynamic attachments via an
Attachment output connector (see “Using an Attachment connector”
on page 139).
Attachment name
A name of the attachment. You can use a variable for this.
Attachment description
Optionally, enter a description of the attachment. You can use a variable for this.
Use attachment as
Source – Use when the file you specify in Attachment path or on the
Attachment connector is the original source material for the associated content.

Data – Use when the file you specify in Attachment path or on the Attachment
connector represents information used to derive a visual presentation, e.g. a
table or a graph.
Alternative – Use when the file you specify in Attachment path or on the
Attachment connector represents an alternative representation of content, e.g.
audio.
Supplement – Use when the file you specify in Attachment path or on the
Attachment connector represents a supplemental representation of the original
source or data that may be more easily consumable e.g. a MathML version of an
equation.
Note: Use only when the file is not used as Source or Alternative.
Unspecified – Use when none of the other options fit.
Is mandatory
Select if output should not be created in case the attachment can not be
embedded in the PDF.
Attachment path
For static attachment, specify path to the file to embed into the PDF. The path
can point to a file in a local folder, in a resource repository (resource://) or in
an OpenText Media Management repository (otmm://).
You can use a variable for this.
Examples:
..\resource\$myattachment.xml
c:\attfolder\offer.xml
otmm://otmm-ny/?id=6708ba967b9b4dbd94f01fd6457a7
resource:/?name=marketing
Content type
For static attachment, specify the type of content the attachment includes.
Predefined – Specify the Predefined type option.
Custom – Specify the Custom type option.
Custom type
For Content type Custom, specify a custom content type.
Predefined type
For Content type Predefined, select one of the predefined types.
Attachment connector
For output from attachment connector, select the attachment output connector to
use.

About PDF/X
PDF/X is used to make graphics exchange easier. A number of settings related to
printing requirements is therefore included.
• PDF/X-1a – all fonts must be embedded and all colors must be CMYK. However,
the PDF driver converts any RGB colors to CMYK.
• For PDF/X-3 – mainly as PDF/X-1a, but calibrated RGB is accepted. The PDF
driver embeds the RGB color profiles.
If color conversion is to be performed by the driver, input and output color profiles
are required. For input profile, it may be either embedded in the image, or via the
Color: Profile for RGB option. The output profile must be specified in the Output
intent: DestOutputProfile option.
Caution
PDF features such as forms, comments, signatures, encryption, actions,
JavaScript, and transparency are not supported for PDF/X.
25.2 Encryption
You can encrypt the PDF output to protect the generated PDF documents from
unauthorized access. Encryption only applies to the contents of the document. It
does not apply to other object types that are used to convey information about the
structure of the document.
The filter that controls access to the contents of the encrypted document is the
security handler. The security handlers available in PDF are Standard Security
Handler revision 2 and Standard Security Handler revision 3.
Standard Security Handler revision 2

• Algorithm
RC4 with 40-bit keys.
• Passwords
User and owner passwords can be specified.

• Restrictions
Acrobat version 4.05 and PDF version 1.4 or higher.
• Algorithm
RC4 with 128-bit keys.
• Passwords
User and owner passwords can be specified.

25.2. Encryption

• Restrictions
PDF version 1.7 or higher.
• Algorithm
AES with 256-bit keys.
• Passwords
User and owner passwords can be specified. The passwords must be normalized
by applying the SASLPrep profile (RFC 4013) of the stringprep algorithm (RFC
3454) to the supplied password using the Normalize and BiDi options.

Chapter 26
PostScript driver
Image compression
Images are compressed using:
• CCITT compression for 1-bit monochrome images

• LZW (Lempel-Ziv-Welch) compression for grayscale and color images (i.e.
all but 1-bit monochrome images).
The appropriate compression method is selected automatically according to

image type. To further optimize image output for non-color printers, set the
Grayscale option to Yes.
PostScript forms
PostScript forms can be used to optimize driver output. A form is a resource that
can be added to the output stream once, cached in the printer memory and then
executed multiple times on subsequent pages. This means that only information
that changes between forms needs to be interpreted for each page. Images
(raster and EPS), device overlays (EPS), and LXF overlays can be converted into
forms.
Note: Dynamic overlays from PreformatIN can not be converted into

forms since they only appear once in the printed file.
Settings
• Page size
Page size. If you select None, the printer device settings will be used when
printing.
Note: If you use a sheet layout definition, the sheet layout settings will
override the driver settings.
• Simplex/Duplex
Select whether to print on one side or both sides of the paper. If you select None,
the printer device settings will be used when printing.
• Orientation
Print orientation. If you select None, the printer device settings will be used
when printing.

Chapter 26 PostScript driver
• For
The name of the user for whom the document is printed.
• Routing
Information about how to route the document back to its owner after printing,
for example an email address.
• Version
The version or revision number of the document or resource.
• Page order
• None - Select this option if the order of the pages is not important.
• Ascend - The pages of the document are in ascending order.
• Descend - The pages of the document are in descending order.
• Special - The pages in the document are in a special order, e.g. signature
order and should not be changed.
• Grayscale
• Yes - Converts color images into 8-bit grayscale and compresses them using
the LZW compression method. Select this option to optimize image output
for non-color printers.
• No - The compression method is selected automatically.
• Use PostScript forms
• Yes - All static images and overlays used in the Project are generated as
PostScript form objects.
• No - All data is processed as usual.
• Virtual Memory for Forms (KB):
The amount of virtual memory to be used for forms. The default form cache size
is 16 MB (16384 kB). If the amount of cached PostScript data exceeds the limit
defined for this setting, the image or overlay will not be cached and will be
processed as usual.
• Language level
The PostScript language level.
• Default - The driver attempts to stay at level 2. If it needs to use OpenType

fonts with PostScript outlines it will switch to level 3 automatically.
• Level 2 - The driver uses level 2. Use this option for printers that have no
level 3 support.

• Level 3 - The driver uses level 3. Use this option if you need to support
images with alpha channel transparency, i.e. where areas of the images may
have variable opaqueness.
• Copies
Not applicable.

Chapter 27
XPS driver
The XPS driver produces Microsoft XPS documents according to XML Paper
Specification version 1.0.
XPS (XML Paper Specification) is a document storage and viewing specification

developed by Microsoft. It is based on the XML language and the printer page
description language is based on:
• a new print path.
• a color-managed device independent and a resolution independent vector-based
document format.
• support for advanced printing features such as:
• gradients
• transparencies
• CMYK color space
• named colors
• printer calibration
• print schemas etc.
The XPS document format contains a set of related pages with a fixed layout
organized as one or more documents. A file that implements this format includes
everything necessary to fully render these documents on a display device or
physical medium (e.g. paper). This includes all resources such as fonts and images
that might be required to render the individual page markings. XPS uses a ZIP
archive, containing documents (fixed documents, pages etc.) and resources (images,
fonts etc.).
The XPS documents use the XML language to describe fixed documents and pages.
The documents contain a root fixed document sequence that binds a collection of
fixed documents which, in turn, bind a collection of fixed pages.
Copyright
For use of the Communications Center XPS driver, the following copyrights
apply:

Chapter 27 XPS driver
Copyright © 1990-2005 Info-ZIP. All rights reserved.
Permission is granted to anyone to use this software for any purpose, including
commercial applications, and to alter it and redistribute it freely, subject to the
following restrictions:
Redistributions in binary form (compiled executables) must reproduce the above

copyright notice, definition, disclaimer, and this list of conditions in documentation
and/or other materials provided with the distribution.

Chapter 28
Zebra Label Printer driver
The Zebra Label Printer driver automatically generates ZPLII (Zebra Programming
Language II) code. ZPLII is a high-level label definition and printer control
language. It contains instructions for printer configuration, label text, bar codes,
lines, and bitmap graphics.
For information and details about ZPLII, see the ZPLII Programming Guide, Zebra
Part Number 46496L, published by Zebra Technologies Corporation.
Required knowledge
These instructions are intended for users who are familiar with Communications
Center and ZPLII.
28.1 Driver files and printer resolution

You should use the Zebra Label Printer driver that corresponds to the resolution
supported by your Zebra printer:
• ZEBRA LabelPrinter (150dpi)

28.2 Getting the label size right

The Zebra Label Printer driver supports any label size supported by the printer.
You define the label size in the Process. When printed, the label is automatically
centered on the media. The best result is achieved if the page width defined in the
Process is equal to the actual physical width of the media.
In cases where the page size is larger than the physical size of the label, the output
will be different from that defined in the Process or the overlay.
Continuous media
When using continuous media for printing, the label length is defined by the
page height.
Overlays
If you use overlays, the size of the overlay should be the exact same size as that
of the page defined in the Process.

Chapter 28 Zebra Label Printer driver
28.3 Fonts
The Zebra Label Printer driver supports the A-H bitmap fonts, and the scalable font
0, that come with most Zebra printers. The driver also supports downloading
TrueType fonts to the printer.
Notes
• The GS (Graphic Symbol) Zebra font is supported for all fonts and code pages,
except for downloaded Unicode fonts.
• You cannot download Windows TrueType fonts as Zebra bitmap fonts.
• Font rasterization is not supported. Adding the options Rasterizefont or
FontEmbed in the driver file will have no effect.
Tips and caveats

• You should map monospaced TrueType fonts to Zebra fonts A-H, and variable
width fonts to the Zebra font 0.
• Zebra fonts A-H are only scalable to specific font sizes. The height of these fonts
can differ significantly from what you defined in the Process or in the overlay.
See “Font sizes” on page 497
• Avoid using horizontal text stretching and scaling for Zebra fonts A-H. This does
not work for these bitmap fonts.
• Letter spacing will be ignored for fonts mapped to Zebra fonts A-H.
• Downloading TrueType fonts to the printer will significantly delay the output of
the first label in a Job. Using Zebra fonts A-H will speed up processing in the
printer.
• Fonts that are downloaded to the printer are only available during the
Communications Center Job. The fonts are deleted from the printer memory
when the Job is finished.
• Text can only be rotated 0, 90, 180, and 270 degrees. Any other angle will result in
0 degrees rotation in the output.
• Zebra font H only supports uppercase letters. No lowercase letters will be
included in the output.

28.3. Fonts
28.3.1 Mapping fonts to Zebra fonts

To change the mapping of Zebra fonts, you must edit the Fonts Mapping section in
the driver file. See “Device drivers and tools“ on page 523 for information on how
to edit driver files.
Text underlining and striking out is supported for all Zebra fonts. You can map
several fonts to the same Zebra font.
Example 28-1: Mapping fonts used in the Process to Zebra fonts
To map the Arial font to the Zebra font 0, add the following line to the Fonts
Mapping section in the driver file:
MapFont "Arial" "0"
Example 28-2: Mapping underlined fonts
To map underlined fonts, add a line in the following format to the Fonts
Mapping section in the driver file:
MapFont "Arial_Underline" "0_Underline"
28.3.2 Font sizes

Zebra fonts A-H are bitmap fonts with a fixed width and height. Font sizes specified
in the Process, or in overlays, will be matched to the nearest Zebra font size, as
specified in the driver file.
To change the size of Zebra fonts used in the printed output, you must edit the Fixed
size fonts section in the driver file. See “Device drivers and tools“ on page 523 for
information on how to edit driver files.
All font sizes used in the Process, and in overlays, must be mapped to a valid Zebra
font size. Valid Zebra font sizes for bitmap fonts A-H are multiples of height from 2
to 0 times the standard height in increments of 1. For example, Zebra font A has
standard height 9 dots. Valid values for this font would be 9 (default), 18, 36, 45, 54,
63, 72, 81, and 90. Specifying another value will not generate an error, but has no
sense because it will be rounded to the closest valid value. See the ZPLII
Programming Guide for valid font sizes for specific printer resolutions.
Note: In the Process, and in overlays, font size is specified in points, while the
size of Zebra fonts is specified in printer dots.

Example 28-3: Mapping font sizes used in the Process to Zebra font
sizes
To map sizes 10, 12, and 15 of the Courier font to sizes 18, 36, and 45 of Zebra
font A, add the following lines to the Fixed size fonts section in the driver
file:
Font "Courier" WidthTable 2

Size 10 SelectPrefix "A" SelectPostfix "18"
Where:
• the WidthTable number must correspond to the width table of the
selected Zebra font, as specified in the section Mapped fonts definition
in the driver file. See Valid width table numbers for Zebra fonts
on page 498 for valid width table numbers.
• the size (10, 12, and 15 in this example) is the size of the font used in the
Process, specified in points.
• the string in double quotes after SelectPrefix (A in this example) is the
Zebra font.
• the string in double quotes after SelectPostfix (25, 35, and 45 in this
example) is the Zebra font size (height), specified in dots.
Valid width table numbers for Zebra fonts
0 1
A 2
B 3
C 4
D 4
E 5
F 6
G 7
H 8

28.3. Fonts
28.3.3 Downloading TrueType and Unicode fonts to the Zebra

printer
To ensure that the printed output looks exactly as defined in the Process and
overlays, you can download TrueType fonts directly to the printer memory. If you
use international character sets, you must download the Unicode fonts to the
printer. The downloaded fonts are only available during the Communications
Center Job and are deleted from the printer memory when the Job is finished.
To download fonts to the Zebra printer you must do the following:

• Download and install the Zebra Tools Utility
Download the Zebra Tools Utility (ZTools) from Zebra Technologies
Corporation.
• Configure the Zebra printer
You must convert TrueType fonts, and Unicode fonts if you use international
character sets, to the internal ZPLII format. In ZTools, you specify the source
directories where TrueType and Unicode fonts are stored, and the path to the
destination files. See “Configuring the Zebra printer” on page 500.
• Edit the driver file and add the fonts to be downloaded to the printer
See “Editing the driver file and adding the fonts to be downloaded to the
printer” on page 500.
• Verify font locations
Make sure that the TrueType and Unicode fonts, as well as the Zebra fonts, are
stored in the specified directories
Tip: Downloading ZST and ZSU files directly to the printer
If you are familiar with ZPLII and ZTools, you can use ZTools (or other label
printer utilities) to download ZPL code, including ZST and ZSU files, to the
printer.
Edit the ZST or ZSU file by using the ^CW command to assign a built-in font
between I and Z to the font in the file, and download the ZST or ZSU file
offline. See the ZPLII Programming Guide.
Add the font to the Zebra Label Printer driver file by entering a line in the
following format to the Downloadable Fonts section:
Font "SAMPLE"
ReadFont "SAMPLE.TTF" Select "Z:ZSU"
For example:
Font "Arial"
ReadFont "arial.ttf" Select "Z:ZSU"
This will significantly speed up processing in the printer.

Configuring the Zebra printer

You use ZTools to do the following:
• Specify the directory where TrueType and Unicode fonts are stored, and the
destination directory (that is, the font directory of the current Project) to which
Zebra fonts will be written.
• Convert TrueType fonts to the internal ZPLII format.
Note: Do not edit the destination ZST files.
• Convert Unicode fonts to the internal ZPLII format.
Note: Do not edit the destination ZSU files.
Editing the driver file and adding the fonts to be downloaded to

the printer
To specify the font to be downloaded to the printer, you must edit the Downloadable
fonts section in the driver file. For information on how to edit a driver file see
“Device drivers and tools“ on page 523.
Example 28-4: Specifying a font to be downloaded in the driver file
If you use the Book Antiqua Bold Italic font, ANTQUABI.TTF and you have the
ANTQUABI.ZST in the fonts directory, you should add the following line in
the Downloadable fonts section in the driver file:
Font "Book_Antiqua_Bold_Italic" ReadFont "antiquabi.ttf" Select "antiquabi.zst"
28.4 Printing white text on black background

Avoid using colors in the Process when printing white text on a black background.
Bright and dark contrasting colors may look white and black respectively, but may
not give the expected result when printed out.
To print white text on black background
1. Create a rectangle with black fill color and black stroke color.
2. Enter the desired text on the rectangle and set text color to white. The text
should not exceed the rectangle boundaries.

28.5. Barcodes
28.5 Barcodes
You configure barcodes in the Process. Supported barcodes are listed in “Supported
barcodes and their corresponding Zebra instructions.” on page 501.
Comments
• Barcodes, like text, can only be rotated 0, 90, 180, and 270 degrees. Any other
angle will result in 0 degrees rotation in the printed output.
• Exact positioning of barcodes which are rotated any other angle than 0 degrees,
is supported only for 1-dimensional barcodes.
• All features are not available for all barcode types. If an option is not available in
the Barcode dialog box, the default value, as specified in the ZPLII Programming
Guide, is used.
• For the Maxicode barcode, the encoding mode is determined by the data content.
Only modes 2, 3, and 4 are supported. No structural append is available.
• For the UPC-E barcode, the length of the input data must be 11 or 12 digits with a
pre-calculated checksum. The checksum must be in the same format as data for
UPC-A. The system ID digit must be 0.
• For the QR Code barcode, Quiet Zone is not supported. This means Use Quiet
Zone must be set to No when this barcode is configured in the Process.
Table 28-1: Supported barcodes and their corresponding Zebra instructions.
Zebra instruction Barcode

^B1 Code 11 (USD-8)
^B2 Interleaved 2 of 5
^B3 Code 39 (USD-3 & 3 of 9)
^B4 Code 49
^B7 PDF417
^B8 EAN-8
^B9 UPC-E
^BA Code 93
^BB CODABLOCK A, E, F
^BC Code 128
^BD UPS MaxiCode
^BE EAN-13
^BF Micro-PDF417
^BI Industrial 2 of 5

Zebra instruction Barcode

^BK ANSI Codabar
^BL LOGMARS
^BM MSI
^BP Plessey
^BQ QR Code
^BU UPC-A
^BX Data Matrix
^BZ PostNet
28.6 Graphics
The main difference between firmware versions X.9 and X.10 is in graphics support.
Firmware X.9 supports fewer ZPLII commands than X.10. See “Differences in
graphics support between firmware X.9 and X.10” on page 502, and the ZPLII
Programming Guide for more information. Non-supported graphical objects will not
be included in the printed output.
Table 28-2: Differences in graphics support between firmware X.9 and X.10
Graphical object Firmware X.10 Firmware X.9

Line All line types are supported. Only vertical and horizontal
For diagonal lines, the line lines are supported.
width can differ depending on
the slope angle.
Rectangle Supported. Target fill color is Supported. Target fill color is
black (for input fill color with black (for input fill color with
intensity 0-127 on a 0-255 scale) intensity 0-127 on a 0-255 scale)
or white (for input fill color or white (for input fill color
with intensity 128-255 on a with intensity 128-255 on a
0-255 scale). 0-255 scale).
Rectangle with Supported. Target fill color is Not supported. Rounded
rounded corners black (for input fill color with corners are replaced by sharp
intensity 0-127 on a 0-255 scale) corners in the printed output.
or white (for input fill color
with intensity 128-255 on a
0-255 scale).
Circle and ellipse Supported. Target fill color is Not supported.
black (for input fill color with
intensity 0-127 on a 0-255 scale)
or white (for input fill color
with intensity 128-255 on a
0-255 scale).
Polygon/Polyline Supported. Cannot be filled. Not supported.

28.7. Enabling hexadecimal character values
Graphical object Firmware X.10 Firmware X.9

Path Paths are always presented as Not supported.
polygons or polylines. Curves
are presented as lines
connected at the end points.
28.7 Enabling hexadecimal character values

If you want to use ZPL reserved characters (e.g. ^ and ~) in field data output to a
Zebra label printer, you must use the corresponding hexadecimal character values.
To be able to use hexadecimal character values in field data (in an ^FD command),
you must add the following keyword to the driver file (without parameters):
ENABLE_HEX
For example, to be able to use ~ (tilde) in output to a Zebra label printer, you must
add the ENABLE_HEX keyword to the driver file, and use the hexadecimal value for ~
(<7e>) in the Process. In the output to the printer, the field data is translated to the
correct ZPL syntax. The list below shows the field data in the Process and the
corresponding field data sent to the printer.
• Field data in the Process

Tilde <7e> used for hex
• ZPL command
^FH^FDTilde _7e used for hex^FS
28.8 Zebra Label Printer driver settings

• Firmware version
The printer firmware version. Available options are X.10 and X.9 (X.9 means all
firmware versions up to 9).
To determine the version of the firmware in your printer, you can print out a
Printer Configuration Label. See the printer documentation. The firmware
version usually has the format VXX.N.Z. where VXX is the main version number
(X), N is 9 or 10, and Z is a version extension.
• Print mode
• Tear off – The printed label is advanced so that it can be torn off manually.
The backing is still attached to the label.
• Peel off – The backing is partly separated from the label. Printing stops until
the label is removed.
• Cutter – The label is cut by the cutter mechanism.

• Rewind – The label and backing are rewound on an (optional) external

rewind device. The next label is positioned under the printhead (no backfeed
motion).
• Applicator – When used with an application device, the label move far
enough forward to be removed by the applicator and applied to an item.
• None – Do not set the print mode.
• Media type
• None – Do not set the media type.

• Direct thermal – The media is heat sensitive and no ribbon is required.
• Thermal transfer – Black or color high carbon ribbon. The ink on the ribbon is
bonded to the media.
• Media tracking
• Non-continuous – The media has some kind of physical characteristic, for

example holes or perforations, that can be detected by the printer to separate
the labels.
• Continuous – The media has no physical characteristic that can be used to
separate the labels.
• Media feed at power up
The media feed action at start up. Available options are:
• Media feed
• No media feed
• Set media sensor calibration – Feeds the media one label length, and
recalibrates the media and ribbon sensors.
• Set label length – Feeds one or more blank labels, depending on the label
size. When using continuous media, the label length is defined by the page
height, as defined in the Process.
• Media feed at head close
The media feed action after closing print head. Available options are:
• Media feed
• No media feed
• Set media sensor calibration – feeds the media one label length, and
recalibrates the media and ribbon sensors.
• Set label length – Feeds one or more blank labels, depending on the label
size. When using continuous media, the label length is defined by the page
height, as defined in the Process.
• Label home X-axis

28.8. Zebra Label Printer driver settings
The label printing position along the x-axis. The default home position of a label
is the upper-left corner (position 0,0).
Valid values are 0 - 300.
• Label home Y-axis
The label printing position along the y-axis. The default home position of a label
is the upper-left corner (position 0,0).
Valid values are 0 - 300.
• Label top alignment
Moves the entire label up or down. The Label top is relative to the current Label
home position. A positive value moves the format downwards, away from the
top, while a negative value moves it upwards, towards the top.
Valid values are -64 - 64. Default is 0.
• Tear off adjust alignment
Defines where the media is cut. The tear-off position is relative to the end of the
printing on the label.
• Media darkness
Adjusts the darkness relative to the darkness settings specified on the Printer
Configuration Label. For example, if the value specified on the configuration
label is 16, and you specify Media darkness -9, the value will be 7.
The maximum and minimum values cannot be surpassed. For example, if the
value specified on the configuration label is 25 and you specify Media darkness
10, the value will still be 30.
• Print rate
The media speed during printing.
Valid values depend on the firmware version:
Firmware X.9: 2, 3, 4, 5, 6, and 8.
Firmware X.10: 2, 3, 4, 5, 6, 8, 9, 10, 11, and 12.
• Slew rate
The slew speed (feeding a blank label).
Valid values depend on the firmware version. See Print rate.
• Print orientation
Normal – Prints the label with normal orientation.
Inverted – Inverts the label 180 degrees, so that the label is printed upside down.
• International Character Set
The character set used for printing. If you select a value other than Auto, the code
page settings defined for the output connector will be ignored.

If you select None, the international character set command in ZPLII output is
suppressed. The label printer will use the last value that was saved.
If you select Auto, the code page settings defined for the output connector are
used to select the appropriate character set.
Note: If you use international characters, you must configure the Zebra
printer to use Unicode characters, see “Downloading TrueType and
Unicode fonts to the Zebra printer” on page 499.
• Image dithering method
The dithering method used for converting true color and palletized images to
black and white images.
Usually, None is used for black and white line art images, and one of the
dithering methods are used for photographic images.
• Memory device for downloads
The device used for storing downloaded files, for example fonts and images.
• R: (printer DRAM library) – Always present and read/write access.
• B: (optional memory card) – A card or factory installed memory. Read/write
access.
• E: (flash memory) – Use only with jobs using already loaded images and
fonts. Read only access.
• Pause and cut value (^PQ,p)
The number of labels to be printed before pausing for a cut. Valid values are 0 to
99999999. The default value is 0.
• Copies
The number of labels to be printed.

Chapter 29
RFID
Radio Frequency Identification (RFID) tags are used for automatic identification of
individual items. RFID inlays are configured in the Process tool and the following
Communications Center drivers can be used for sending RFID configuration
information to label printers:
• Intermec DP (203dpi)
• Intermec DP (300dpi)
• Zebra ZPLII (150dpi, 200dpi, 300dpi and 600dpi)
• Printronix IGP/PGL
Prerequisite
To configure RFID inlays you must have:

• Detailed knowledge in the printing environment and the hardware
configuration.
• Basic knowledge in RFID, such as, air protocols and tag data formats (EPC
encoding).
Unsupported features
• Intermec
• Limited support of NUM format. Maximum 4 bytes, 10 digits.
• NUM format is not supported for EPC Class 1 air protocols.
• Zebra
• No support for NUM format.
• Printronix
• No support for ISO18000-6b.
• No support of ASCII-96, ASCII -64 and NUM-96.
• No support to lock EPC Class 1 inlays, only kill password is supported.

Chapter 29 RFID
29.1 Supported air protocols and printer models

The following air protocols are supported:
• EPC Class 1 Version 1
• EPC Class 1 Generation 2
• ISO18000-6b
The printer models below are supported.

• Intermec EasyCoder PM4i f/w IPL and
f/w FingerPrint/Direct protocol
Air protocol:
• ISO18000-6b
• Zebra R110Xi (SP994X)
Air protocol:
• ISO18000-6b
• Zebra R4MPlus f/w: ZPL II (R60.13.X)
Air protocol:
• ISO18000-6b
• Printronix SL5000r MP, SL5000r MP2 f/w PG
Air protocol:

29.2. RFID settings
29.2 RFID settings

The following settings are available for the drivers supporting RFID. You configure
the settings in the Platform configuration.
Note: The settings are not applicable for Printronix.
RFID settings
• RFID antenna offset
The distance the label is moved to align the inlay over the coupler (the printer
antenna) before programming the chip.
Depending on the printer model, specify antenna offset in dots or millimeters.
• RFID number of retries in dots
Can be set to 0-10.
Intermec printers - If set to 1 or greater and a read or write command fails, the
printer tries to read or write the next label. If this also fails the procedure is
repeated until a successful read or write command is committed, or the specified
number of retries is reached. The string VOID, or any other selected string, is
printed on all rejected labels.
Zebra printers - The number of read or write retries before a transponder is
declared defective. When the specified number of retries is reached, the string
VOID is printed on the label and the transponder is ejected.
• Print mode (^MM)
Only applicable for Zebra.
RFID - Activates the RFID functionality in the printer.

Chapter 30
Managing fonts
You must make sure all fonts you intend to use in Design Center are in the Windows
Fonts directory before you try to use them in your documents.
When you export a Project, all fonts in the resource sets are included in the export
package. To have all used fonts included in the export package you should make
sure they are added to a resource set. You can for example select Add exported
fonts to Platform's default resource set in the Export or Export for Release dialog
box when you export the Project.
When you deploy a Project, all fonts in the Project export package are deployed to
the working directory of the StreamServer application. The default location of the
fonts used by the StreamServer application when processing jobs depends on the
environment:
• On Windows, StreamServer first checks if the font is installed on the system. If it
is, that font is used. If the font is not installed on the system, the font from the
export package is used.
• On UNIX, the fonts from the export package are used.
Making fonts available to drivers

To make fonts available to the drivers when processing jobs, you should enable
Type Manager for the drivers. Without Type Manager embedded fonts will not
work, and all used fonts have to be fully described in the driver file or font
substitution table.
30.1 Using Type Manager

When using Type Manager, you do not have to add font entries to the driver file or
font substitution table, and the used fonts do not have to be installed in the
environment where StreamServer is running.
To enable Type Manager for a driver
1. In the Output Connector Settings dialog box, generic layer, click the Driver
icon.
2. On the Device Driver Settings tab, select Use type manager.
Font paths
Type Manager searches for fonts in the paths specified in strstypemanager.
xml located in:
<Communications Center installation>

\Applications\StreamServer\<Version>\Server\bin

Chapter 30 Managing fonts
You can use the custom -fd (Fonts Directory) startup argument to specify a font
path. This path is automatically added to the font path specification in
strstypemanager.xml.
• If you do not specify this argument, it defaults to ../data/fonts (relative to

the working directory of the StreamServer application). If only this path is
used you must make sure all used fonts are included in the export package.
• If you specify this argument it should point to the location where the fonts
will be available to StreamServer when processing jobs.
You can also edit strstypemanager.xml to specify multiple font paths.

Editing font entries for drivers
If you cannot use a font straight off in the output from a specific driver you can
edit the font entries in the driver file or use a font substitution table. See “Font
entries in driver files and substitution tables” on page 512 for information
about font entries.
30.2 Font entries in driver files and substitution tables

If you, for some reason, do not use Type Manager, all used fonts must be included as
entries in the driver file or font substitution table connected to the driver.
If you use Type Manager, and if you cannot use a font straight off in the output, you
must edit the font entries in the driver file or font substitution table connected to the
driver.
Readfont
A driver file and font substitution table can contain readfont entries.
Example 30-1: Readfont entry

Font "Century" ReadFont "CENTURY.TTF"
SelectPrefix "Century" Codepage "Ansi"
Character width tables

A driver file and font substitution table can contain font entries with character
width tables.
Example 30-2: Font entry with character width table

// Century - regular, italic
WidthTable 1 Size 7200
7200 5400 5400 5400 5400 5400 5400 5400 5400
5400...
...
End
Font "Century" WidthTable 1
SelectPrefix "Century" CodePage "Ansi"

30.3. Editing font entries
Mapfont
A driver file and font substitution table can contain mapfont entries where fonts
are mapped to other fonts. In the example below, the font
Times_New_Roman_bold_underline is mapped to Arial_bold. If StreamServer
finds the font Times_New_Roman_bold_underline, it will use Arial_bold in the
output.
Example 30-3: Mapfont entry
mapfont "Times_New_Roman_bold_underline" "Arial_bold"
Embedding fonts and downloading soft fonts

All fonts included in the output from StreamServer must be available to the
printer (or equivalent) that receives the output. If there are fonts that are not
installed on the printer, you must make them available to the printer. See
“Embedding fonts and downloading soft fonts” on page 518.
30.3 Editing font entries

If you cannot use a font straight off in the output from a specific driver you can edit
font entries in the driver file (*.drs) or use a font substitution table to add driver
specific entries for the font.
Editing driver files

You can edit font entries in *.drs files for custom device drivers. See “Device
Tool” on page 525 for information about how to create custom device drivers.
Using font substitution tables

You can add font entries to a font substitution table. When you export the
Project, the font entries in the font substitution table are appended to the
exported *.drs file.
Note: If you connect font substitution tables to several connectors with the
same driver, only entries in one table are appended to the exported *.drs.
To connect a font substitution table to an output connector
1. In the Output Connector Settings dialog box, generic layer, click the
Driver icon.
2. On the Device Driver Settings tab, browse to and then select the Font
substitution table resource.
Font not referenced in driver file

If the font is not referenced in the actual driver file (*.drs) you can use a font
substitution table, and add the font entry to this table.

Font already referenced in driver file

If you want to edit font entries that are already referenced in the *.drs file you
must edit the entries in the *.drs file or use a font substitution table to override
the font entries in the *.drs file. If you use a font substitution table you must
make sure to use exactly the same font specification as in the *.drs file to be
able to override the font entries. For example, if you want to embed ARIAL.TTF
and the *.drs file contains the following font specifications for ARIAL.TTF:
Font "Arial" ReadFont "ARIAL.TTF"

SelectPrefix "Arial" Codepage "Ansi"
Font "Arial_Underline" ReadFont "ARIAL.TTF"
Then you should edit the *.drs file or add the following font entries to the font
substitution table in order to override the entries in the *.drs file:

SelectPrefix "Arial" Codepage "Ansi" FontEmbed
Using custom driver with no font references

Another option is to create a custom driver (for example a custom PDF driver)
where you remove all font entries. Since the custom driver contains no font
entries you can use a font substitution table without caring about overwriting
any font entries in the *.drs file.
30.4 TTF fonts

You can add TTF font entries to driver files and font substitution tables.
Using Windows Driver Tool to create TTF font entries

You can use Windows Driver Tool to create a temporary driver file with TTF
font entries. You can then copy the entries from the temporary driver file, and
paste them into a font substitution table or driver file.
To create font entries using Windows Driver Tool
1. From the Start menu, select OpenText > Communications Center >
Utilities > Windows Driver Tool. The Windows Driver Tool opens.
2. From the Printers drop-down list, select any printer.
3. Specify the path to the driver file in File name (drs-file) (the name must not
contain any of the characters\/:*?"<>|).
4. Specify the path to the option file in File name (opt-file).
5. Enter a Driver name.
6. Select Create width tables during runtime if you want to create readfonts.
7. Select the appropriate Charset.

30.4. TTF fonts
8. Select the Fonts you want to create (you can multi select font entries) and
click Create. You can now open the created *.drs file and copy the font
entries.
True Type Collections (TTC)

You can use True Type Collections (TTC). TTC support is necessary for certain
Japanese and non-Western typefaces. All information and instructions regarding
TTF fonts in this document also apply to True Type Collections.
If the True Type Collection has an English name and a locale specific name (for
example a Japanese name), you must update the driver file with separate entries
for both of these names. For some languages, you must run the language version
of Windows to be able to see the locale specific names.
30.4.1 PostScript, PDF, and raster drivers

You can add/edit TTF font entries for PDF, Postscript, and raster drivers but not for
the PDF (PCL convert) driver.
To add font entries
1. Create the font entries in Windows Driver Tool.

2. Open the temporary *.drs file and copy the font entries.
3. Paste the entries to the font substitution table or driver file.
To add mapfont entries
1. Open the font substitution table or driver file.

2. Add the mapfont entries. For example:
30.4.2 PCL 5 drivers

PCL 5 printers use escape sequences to select fonts. The escape sequences are not the
same for all printer models, so you must make sure to use the correct escape
sequences for your printer model.
As long as you use the correct driver for your printer, all fonts entries defined in the
*.drs file for this driver have the correct escape sequences. This means that if all
fonts you are using are defined in the *.drs file you do not need to edit any font
entries.
If you are using a font that is not defined in the *.drs file you must create a custom
driver for the printer and add a new entry for this font to this *.drs file. Since the
escape sequences are driver specific settings this also applies if you are using Type
Manager.
Note: You cannot use a font substitution table to add font entries with escape
sequences or other driver specific settings.

You can use Windows Driver Tool to create new font entries. Before you create font
entries you must use the printer menu to print a list of all PCL fonts installed on the
printer. This list includes the escape sequences for the fonts.
The escape sequence for a proportional font may include <esc>(s1pv0s0b16602T. If

you want to add the font as a readfont, you must replace <esc> with <1B> and
divide the sequence into one SelectPrefix and one SelectPostfix section:
SelectPrefix "<1B>(s1p" SelectPostfix "v0s0b16602T"
Example 30-4: Readfont entry for the TTF font Century
Font "Arial" ReadFont "arial.ttf"

Codepage "Ansi"
The escape sequence for a monospaced font may include <esc>(s0p16.

67h15v0s0b3T. If you want to add the font as a width table font you must replace
<esc> with <1B> and specify the size and CPI for each font size entry:
Size NN SelectPrefix "<1B>(s0p10h10v0s0b3T" CPI NN
Example 30-5: Width table font entries for the TTF font Courier
Font "Courier" WidthTable 8

Size 10 SelectPrefix "<1B>(s0p12h12v0s0b3T" CPI 12
Size 12 SelectPrefix "<1B>(s0p10h10v0s0b3T" CPI 10
To add font entries
1. Create the font entries in Windows Driver Tool.
2. Open the temporary *.drs file and copy the font entries.
3. Paste the entries to the *.drs file of the custom PCL 5 driver. For example:

4. Replace the SelectPrefix entries with the modified escape sequences. For
example:

Codepage "Ansi"

30.5. Type 1 fonts
30.5 Type 1 fonts

You can add Type 1 font entries to driver files and font substitution tables.
Note: You must import the Type 1 font from the Windows Fonts directory to a
resource set connected to the Message where the font is used.
Supported drivers
You can add Type 1 font entries to the following drivers:
• PDF (not PDF (PCL convert))

• Postscript
Font entry syntax
Font "<fontName>" ReadFont "<fontFile>.pfb"

SelectPrefix "<typefaceName>"
Where:
• <fontName> is the font name in the exported *.dux.

• <fontFile> is the Type 1 font file.
• <typefaceName> is the typeface name specified in the *.pfm font file.
Example 30-6: Minion Condensed Type 1 font entry
Font "Minion_Condensed" ReadFont "moc_____.pfb"

SelectPrefix "Minion Condensed"
To add font entries
2. Add the font entries.

30.5.1 Adding character encodings to Type1 font entries

The default character encoding for the fonts in the PDF driver is Windows code page
1252, and the default character encoding for the fonts in the Postscript driver is the
default character set specified for the font.
To use other encodings outside the default character encoding for a font, you must
add the new encoding to the font entry in the driver file. Character encodings are
defined in separate encoding files (*.enc).
Adding an encoding file to a device driver

To make an encoding file available to StreamServer, you must add the encoding
file to the custom device driver. See “Adding device driver files” on page 527
for more information. When you export and deploy the Project, the encoding file
is added to the drivers directory.
Adding an encoding to a font entry

You must update the readfont entry (either in the driver file or in a font
substitution table) to include the EncodingFile keyword and the path to the
encoding file.
Example 30-7: Adding an encoding to a font entry

Font "Minion_Condensed" ReadFont "moc_____.pfb"
SelectPrefix "Minion Condensed" EncodingFile "drivers
\iso8859_1.enc"
30.6 Embedding fonts and downloading soft fonts

If your output contains fonts that are not installed on the printer, you must make
sure the missing fonts are sent to the printer.
Embedding fonts
You can embed the missing fonts in the output sent to the printer. See
“Embedding fonts in PDF documents” on page 519 and “Embedding fonts in
output to PCL printers” on page 520.
Downloading soft fonts

Embedding fonts in the output increases the size of the output files. If you want
to keep down the size of the output sent to PCL printers, you can download the
missing fonts as softfonts to the printer. See “Downloading soft fonts to PCL
printers” on page 520.

30.6. Embedding fonts and downloading soft fonts
30.6.1 Embedding fonts in PDF documents

You can embed TTF, TTC, and Type 1 readfonts in PDF documents. Note that this is
applicable only to the PDF driver, and not to the PDF (PCL convert) driver. To
embed a font, you add the FontEmbed keyword to the entries for the fonts to embed.
To completely embed a font file in the output, you can use the FontEmbedFull
keyword instead of FontEmbed. The FontEmbedFull keyword is supported for TTF
fonts that do not use glyph-based output (for example, it is not supported for Indic
texts).
Note: The FontEmbedFull keyword results in large output PDF files.
How to embed a font depends on whether the font is already referenced in the
driver file. See “Editing font entries” on page 513.
Example 30-8: Embedding a new font using a font substitution table

Font "Century" FontEmbed
Example 30-9: Embedding an already referenced font using driver file

or substitution table
Original font entry:


Modified font entry:


To embed a readfont
1. Open the font substitution table or driver file that includes the entries for the
fonts to embed.
2. Add/edit the entries for the fonts to embed.

30.6.2 Embedding fonts in output to PCL printers

You can embed TTF readfonts in the output sent to PCL 5 compatible printers that
support True Type based soft fonts. To embed a font, you add the FontEmbed
keyword and the escape sequence SelectPrefix "<1B>(s" SelectPostfix "V" to
the entries for the fonts you want to embed.
How to embed a font depends on whether the font is already referenced in the
driver file. See “Editing font entries” on page 513.
Example 30-10: Embedding a new font using a font substitution table

Font "Arial" ReadFont "arial.ttf" FontEmbed
SelectPrefix "<1B>(s" SelectPostfix "V" Codepage "Ansi"
Example 30-11: Embedding an already referenced font using driver file

or substitution table
Original font entry:

Codepage "Ansi"
Modified font entry:

Font "Arial" ReadFont "arial.ttf" FontEmbed
SelectPrefix "<1B>(s" SelectPostfix "V" Codepage "Ansi"
To embed a readfont
1. Open the font substitution table or driver file that includes the entries for the
fonts to embed.
2. Add/edit the entries for the fonts to embed.
30.6.3 Downloading soft fonts to PCL printers

You can download missing fonts as soft fonts to PCL printers if you want to keep
down the size of the output sent to the printer. The downloaded soft fonts are
available to the printer until it is restarted. If the printer is restarted, you must
download the soft fonts again.
TTF soft font files

You can download TTF fonts as soft fonts to the printer. Please contact your
Communications Center supplier for information on how to acquire soft fonts.
The soft fonts must have a format supported by the printer, and include the
same character set as specified for the output. For example, if you use Russian
version TrueType fonts in the Project, the corresponding soft fonts must include
the Russian version.

30.6. Embedding fonts and downloading soft fonts
Type 1 soft font files

You can download Type 1 fonts as soft fonts to the printer. To create a Type 1
soft font file, you must convert the binary *.pfb font file to an ASCII *.pfa font
file. Then you add the following section at the beginning of the *.pfa file:
%!load the font in VM

serverdict begin
0
exitserver
How to convert *.pfb files to *.pfa files is not described in this document.
To download soft fonts
1. In Design Center, activate the generic Platform layer, and double-click the
output connector that delivers the output to the PCL printer. The Output
Connector Settings dialog opens.
2. Click the General icon and select Enable download.
3. In Download File, specify the soft font file to download.
4. Export the Project, start StreamServer, and send output to the PCL printer. The
soft font is downloaded to the PCL printer.
When you have downloaded the soft fonts, you must use the printer menu to print a
list of all installed PCL fonts. This list includes the escape sequences for the
downloaded soft fonts. Then you must add the new soft font entries to the driver
file. See “PCL 5 drivers” on page 515.

Chapter 31
Device drivers and tools
A number of native Communications Center device drivers are available in Design

Center. Each device driver consists of:
• A driver file (*.drs) and supplementary files referenced from the driver file, for
example encoding files (*.enc) and mapping files (*.map). The driver file
contains the information that the StreamServer application needs to
communicate with the device.
• Options, such as page size and duplex options, that you specify in the Design
Center output connector settings.
You cannot modify the native Communications Center device drivers. If a

customized device driver is required, you must add the new device driver as a
Custom device resource to a resource set connected to the Platform. You can use the
following tools (running on Microsoft Windows®) to create customized device
drivers:
• Windows Driver Tool - Used to create new Communications Center compatible

Windows printer drivers. See “Windows Driver Tool” on page 523.
• Device Tool - Used to create and modify custom Communications Center device
drivers in the Design Center resource set. See “Device Tool” on page 525.
31.1 Windows Driver Tool

You use the Windows Driver Tool to create new Communications Center printer
drivers that are compatible with the Windows printing system. To make a new
driver available in Design Center, you must add the driver to a resource set
connected to the Platform. See “Adding a Windows printer driver” on page 527.
To start the Windows Driver Tool
• From Windows Start menu, select All Programs > OpenText > OpenText
Communications Center <Version> > Utilities > Windows Driver Tool.
Creating a Windows printer driver

The printer you want to create a driver for must be installed before you start the
Windows Driver Tool.
Note: Since data must continue directly to the Windows print spooler, queues
cannot be used together with Windows printer drivers on the output
connector.

Chapter 31 Device drivers and tools
To create a Windows driver
1. Start the Windows Driver Tool.
2. From the Printers drop-down list, select the printer you want to create a driver
for. The fonts and paper options available for the selected printer are displayed.
3. Specify the settings (see below) and click Create.
4. Close the tool.
Settings
• Printers
The printer you want to create a driver for.
• Driver Name
The name of the driver. For example: My_HPPCL5
• Filename (drs-file)
The path to the driver file. For example: C:\temp\My_HPPCL5.drs
• Filename (opt-file)
The path to the driver options file. For example: C:\temp\My_HPPCL5_opt.txt
• Show Character Set
Select to include width-tables in the new driver file. The Windows Driver Tool
creates the width-tables from the fonts installed on the printer. The StreamServer
application uses these fixed width-tables at runtime.
Select the character sets for which you want to display the fonts available on the
printer, and click Refresh Fonts. The fonts are displayed in the Fonts list.
• Create widthtables during runtime
Instead of using a fixed width-table, the StreamServer application adapts the
width for each character at runtime using the TrueType fonts (*.ttf and *.ttc)
installed in a directory.
In the Font directory box, enter or browse to the path of the directory that
contains the fonts, and click Refresh Fonts. The fonts are displayed in the Fonts
list.
From the Charset list, select a character set.
• Create font list during runtime
Select to make fonts and width-tables available via the Type Manager. This
option adds the usetypemanager keyword to the driver file, which tells the
driver to use the Type Manager.
For detailed information about the Type Manager, see “Using Type Manager”
on page 511.
• Fonts

31.2. Device Tool
Not applicable for the Create font list during runtime option.
The selected fonts to be included in the driver file.
• Paper Sizes
The selected paper sizes to be included in the driver file and the driver options
file.
• Paper Sources
The selected paper sources to be included in the driver file and the driver options
file.
31.2 Device Tool

The Device Tool is a resource editor in the Design Center resource set for creating
and modifying custom device drivers. Since the device drivers are resources in the
resource set, you handle the drivers using ordinary resource set management
procedures. For example, to reuse a device driver in another Project, you must first
save the resource file and then add it to the new resource set.
Tip: To change the font definitions for a driver, you do not have to edit the
device driver. Instead, you can use a font substitution table that you add to the
output connector.
31.2.1 Adding customized device drivers

You cannot modify the native Communications Center device drivers included in
the installation. If a customized device driver is required, you must add the new
device driver to a resource set connected to the Platform. From the resource set, the
new device driver is immediately available in the Design Center configurations.
Creating a new device driver manually

1. Open the resource set.
2. Right-click the node (root node or folder) where you want to add the new
device and select New > Custom device.
3. Right-click the new device and select Start Editor.
4. In the Creating new Custom Device dialog box, click Empty Device.
5. In the Device Tool, configure the new device driver. See:
• “Device Tool GUI reference” on page 529

• “Adding device driver files” on page 527
• “Adding device driver options” on page 528
6. Save and exit the tool.

Importing device package files

In earlier releases, device drivers could be exported from the Device Tool to device
package files (*.sdp). You can import device package files to a resource set.
Prerequisites
The device driver to be imported must be packaged as an SDP file (*.sdp). One
package file may include multiple device drivers.
To import a device driver
4. In the Creating new Custom Device dialog box, click Import from .sdp.
5. Browse to the package file and click Open.
Duplicating a device driver

You cannot modify the native Communications Center device drivers. If a
modification of a native device driver is required, you must make a copy of the
native device driver and modify the copy.
Note: HTML unpaginated and DOCX drivers cannot be customized and must
not be duplicated.
To duplicate a device driver
4. In the Creating new Custom Device dialog box, select the device driver you
want to duplicate on the list and click Create From template.
5. In the Device Tool, modify the new device driver. See:


31.2. Device Tool
Adding a Windows printer driver

If you use the Windows Driver Tool to create a Windows printer driver, you must
add this printer driver to the resource set. First you create a new device driver, and
then you add the Windows printer driver file and option file to the new driver.
Prerequisites
The option file (*.txt) and driver file (*.drs) for the Windows printer driver
must be created. See “Windows Driver Tool” on page 523.
To add a Windows printer driver
4. In the Creating new Custom Device dialog box, click Empty Device.
5. In Logical (internal) name, enter the name of the driver as specified in the
corresponding driver file.
Note: The name can not contain any of the following characters: \/:*?
"<>|
6. In Default display name, enter the name to be displayed in Design Center.
7. In the Device driver files area, click New.
8. In the Enter name dialog box, enter the name of the Windows printer driver file
and click OK.
9. In the Device driver files list, check and select the new driver file and click
Import Content.
10. Browse to the Windows printer driver file and click Open.
11. In the Device options area, click Create From File.
12. Browse to the options file for the Windows printer driver and click Open.
13. Save exit the tool.
Adding device driver files

A driver file contains the information that the StreamServer application needs to
communicate with the device. When you create a device driver, you must connect
the device driver to the appropriate driver files (*.drs, *.enc, *.map, etc.).
Each device driver must be connected to a unique DRS file. In the DRS file, the
DRIVER keyword specifies the logical (internal) name for the specific device driver.

Other driver files, such as ENC files and MAP files, can be connected to, and shared
by, several device drivers.
You cannot modify native driver files. If a modification of a native driver file is
required, you can make a copy of the native device driver and modify the copy.
To duplicate an existing driver file
1. In the Device driver files area, select the driver file you want to duplicate and
click Duplicate.
2. In the Enter Name dialog box, enter a name of the driver file and click OK.
3. In the Device driver files list, select the new driver file and click Edit.
4. Update the file as required. For DRS files, you must update the name of the
driver specified by the DRIVER keyword to theLogical (internal) name specified
for the device driver.
5. Save and close the driver file.
To add a new driver file
1. In the Device driver files area, click New.
2. In the Enter Name dialog box, enter the name of the driver file and click OK.
3. In the Device driver files list, select the new driver file and click Import
Content.
4. Browse to the driver file you want to add and click Open. The contents of the
file is imported to the new driver file.
To connect a driver file to a device driver
• In the Device driver files area, check the driver file that you want to connect to
the device driver.
Adding device driver options

Driver options are displayed in Design Center, in the output connector settings. You
can either add the options manually, one by one, to the device driver. You may also
import the driver options from an option file. The options you add must correspond
to the driver file connected to the device driver.
To import driver options
1. In the Device options area, click Create From File.
2. Browse to the options file that corresponds to the driver file and click Open. The
options are imported to the Device Tool and displayed in the Device options
area.

31.2. Device Tool
To add a driver option manually
1. In the Device options area, click New.
2. In the Define Option Parameters dialog box, specify the option parameters and
click OK. See “Option parameter settings” on page 533.
To preview driver options
• In the Device options area, click Preview.
31.2.2 Modifying customized device drivers

You can modify the custom device drivers in the resource set.
Tip: You cannot modify native device drivers. If a modification of a native

device driver is required, you must make a copy of the native device driver
and modify the copy. See “Duplicating a device driver” on page 526.
To modify a custom device driver
2. Right-click the device driver and select Start Editor.
3. Modify the device driver as required. See:

31.2.3 Device Tool GUI reference

Creating new Custom Device dialog box settings
The Creating new Custom Device dialog box includes the following settings:
• Empty Device
Click to create a new device driver.
• Import from .sdp
Click to import existing device drivers from a device package file (*.sdp).
• Create From template
Click to create a copy of the selected native driver and save the configuration
with a new name.

Main window settings
The Device Tool contains the following main settings:
• Name settings
See “Internal name and display name settings” on page 530.
• Device class settings
See “Device class settings” on page 531.
• Device configurator settings
See “Device configurator settings” on page 531.
• Device driver file settings
See “Device driver file settings” on page 532.
• Device option settings
See “Device options settings” on page 532.
31.2.3.1 Internal name and display name settings

• Logical (internal) name
The logical name of the driver. The logical name must be the name specified by
the DRIVER keyword in the driver file. The name is case sensitive and must be
unique.
Note: The name can not contain any of the following characters: \/:*?"<>|
• Default display name

The default driver name to be displayed if no language is selected in Design
Center, or if no display name is specified for a selected language.
• Display names
Depending on selected language, different driver names can be displayed in
Design Center.
• Lang ID – The language code (decimal representation).

• Display Name – The name to be displayed if the corresponding language
code is selected.
• New – Add a new display name.
• Edit – Edit the selected display name.
• Delete – Delete the selected display name.

31.2. Device Tool
31.2.3.2 Device class settings

The device class is used internally by Design Center, to identify the device type and
the expected output.
• Device class
• POSTSCRIPT – Select for PostScript drivers.

• PCL – Select for PCL drivers.
• PRINT – Select for printed output.
• FAX – Select for faxed output. This is the only class used by Design Center at
present.
• FILE – Select for output to be saved in a file.
• HTML – Select for output to be saved as HTML code.
• Additional class
Any other classes, apart from the ones listed above.
31.2.3.3 Device configurator settings

You can add new tabs (ActiveX controls) with driver options to the Design Center
Runtime configuration dialog boxes.
Caution
Adding incorrect driver configurators, especially a ProgID value, can cause
Design Center to go down. Do not add any driver configurators, unless you
are familiar with the ActiveX control concept and the ActiveX controls
allowed in Communications Center.
• ProgID
Programmatic IDentifier for the ActiveX control.
• Context
The context for the ActiveX control. (Process End is currently not used.)
• New
Add a new configurator.
• Edit
Edit the selected configurator.
• Delete
Delete the selected configurator.

31.2.3.4 Device driver file settings

A driver file contains the information that the StreamServer application needs to
communicate with the device.
• Device driver files
List of all driver files (*.drs, *.enc, *.map, etc.) available.
• New
Add a new file to the list.
• Import Content
Import the contents from a file to the highlighted driver file.
• Duplicate
Create a copy of the highlighted driver file.
• Edit
Edit the highlighted driver file.
• Rename
Rename the highlighted driver file.
• Delete
Delete the highlighted driver file.
• List devices
Display the devices that use the highlighted driver file.
31.2.3.5 Device options settings

• Logical Name
The logical name of the option. The logical name must be the name specified by
the Option keyword in the driver file. The name is case sensitive and must be
unique.
• Type
The option type (Char, Float, Integer or Fixed).
• Context
The level to which you want to add the driver option. (Process End is not
currently used.)
• New
Add an option. See “Option parameter settings” on page 533.
• Duplicate
Duplicate the selected option.
• Create From File

31.2. Device Tool
Import the option settings from a driver options file.

• Edit
Edit the selected option. See “Option parameter settings” on page 533.
• Move Up
Move the selected option upwards in the list.
• Move Down
Move the selected option downwards in the list
• Delete
Delete the selected option.
• Delete All
Delete all properties in the list.
• Preview
Open a preview showing how the options will be displayed in Design Center.
31.2.3.6 Option parameter settings

You specify the parameters for each option in the Define Option Parameters dialog
box.
• Logical (internal) name

The logical name of the option. The logical name must be the name specified by
the Option keyword in the driver file. The name is case sensitive and must be
unique.
• Default display name
The default option name to be displayed if no language is selected in Design
Center, or if no display name is specified for a selected language.
• Display Names
Depending on selected language, different option names can be displayed in
Design Center.
• Lang ID – The language code (decimal representation).

• Display Name – The name to be displayed if the corresponding language
code is selected.
• Add – Add a new display name.
• Edit – Edit the selected display name.
• Delete – Delete the selected display name.
• Context
The level to which you want to add the driver option.

• Job Begin – The StreamServer application will use the driver options when it
starts processing the Job.
• Job End – The StreamServer application will use the driver options when it
has finished processing the Job.
• Document Begin – The StreamServer application will use the driver options
when it starts processing starts processing a Document within the Job.
• Document End – The StreamServer application will use the driver options
when it has finished processing a Document within the Job.
• Process Begin/Platform – The StreamServer application will use the driver
options when it is running a specific Process within the Job. Select this if you
want the options of the driver to be visible in the Platform.
• Process End – Not currently used. The StreamServer application will use the
driver options when it has finished is running a specific Process within the
Job.
• Option type - Char
• Initial value – The default text to be displayed for a text string property in
Design Center.
• Option type - Float
• Initial value – The default number to be displayed for a number property in
Design Center.
• Restrict value – Removes all minimum and maximum restrictions that can be
selected in Design Center.
• Min. value – The minimum number that can be selected in Design Center.
• Max. – The maximum number that can be selected in Design Center.
• Step – The increments to be suggested when using the arrow buttons in
Design Center.
• Option Type - Integer
• Initial value – The default integer to be displayed for an integer property in
Design Center.
• Restrict value – Removes all minimum and maximum restrictions that can be
selected in Design Center.
• Min. value – The minimum integer that can be selected in Design Center.
• Max. – The maximum integer that can be selected in Design Center.
• Step – The increments to be suggested when using the arrow buttons in
Design Center.
• Option Type - Fixed
• Initial value – The default text to be displayed in Design Center for a fixed
text property.

31.2. Device Tool
• Fixed values – The other text options that the user will be able to select from.
• Add – Add a new text property to the list.
• Edit – Edit a selected text property.
• Delete – Delete a selected text property.
• Move Up – Move a selected text property upwards in the list.
• Move Down – Move a selected text property downwards in the list.

Part 5
Filter management
Chapter 32
Filters and filter chains
You can apply filters to input and output data. For example, if the input data is
compressed you must apply a decompression filter to the input data. See “Filter
reference” on page 541 for information about available filters.
Filter chains
When you create a filter, you must first create a filter chain resource. Then you
add the filter to the filter chain, and configure the filter settings. See “Creating
filter chains” on page 539 for information on how to create a filter chain.
Adding filters to a connector

To add a filter to a connector, you must add a filter chain that contains the filter
to the connector. See “Adding filter chains” on page 540 for information on
how to add a filter chain to a connector.
Using variables in filters

You can use the “-var ” startup argument to create variables that are available to
the input filters.
32.1 Creating filter chains

You must create the filter chain in a resource set connected to the Platform.
To create a filter chain
2. Right-click in the resource set and select New Resource > Filter Chain. A new
filter chain is added to the resource set.
3. Rename the filter chain.
To add a filter to a filter chain
1. Double-click the filter chain. The filter chain editor opens.
2. Right-click the flow bar, select Add Filter, and select the filter type. The filter is
added to the flow bar.
3. Select the filter and edit the properties.
Several filters in one filter chain

A filter chain can contain several filters. The filters are applied in order they are
displayed in the filter chain editor.
To order filters in a filter chain

Drag the filters to the appropriate positions in the flow bar.

Chapter 32 Filters and filter chains
32.2 Adding filter chains

You can add filter chains to connectors or apply filter chains per input type.
Adding filter chains to connectors

In the Platform, you can add filter chains to both input and output connectors.
The added filter chains are applied to all data sent through the connector.
To add a filter chain to a connector
2. Right-click the connector and select Settings. The Connector Settings dialog
box opens.
3. Click the Filter Chain icon.
4. From the Look in drop-down list, select the resource set that contains the
filter chain you want to add. All filter chains in the selected resource set are
displayed in the list of items. If the filter chains is located in a folder, you
must double-click the folder to display the filter chains.
5. Double-click the filter chain you want to add and click OK.
Applying filter chains per input type

Filter chains can also be applied per input type. For example, if you have an
input connector that receives both page formatted and record based input, you
can apply one filter chain to the page formatted input, and another filter chain to
the record based input. If you also have added a filter chain to the input
connector, this filter chain is applied to both the page formatted and record
based input.
To apply filter chains per input type
1. In the Project browser, right-click the Project node and select Project Export
Settings. The Project Export Settings dialog box opens.
2. Select the InputAnalyzer tab.
3. In the Available connectors list, select the connector.
4. In the Input Analyzer settings list, select the input type and click the Select
a Filter Chain icon. The Browse for Resources dialog box opens.
5. From the Look in drop-down list, select the resource set that contains the
filter chain you want to add. All filter chains in the selected resource set are
displayed in the list of items. If the filter chains is located in a folder,
double-click the folder to display the filter chains.
6. Double-click the filter chain you want to add and click OK.

32.3. Filter reference
32.3 Filter reference

AFPIN filter
This filter enables the StreamServer to identify and extract AFPDS (Advanced
Function Presentation Data Stream) formatted input. See “AFPIN filter“
Bypass filter
Bypasses the StreamServer, and sends the input data directly to a designated
output connector. See “Bypass filter” on page 543.
Note: Even if you use the bypass filter to bypass all the input data, you
must connect the input connector to a dummy Event. If you do not connect
the input connector to an Event, the filter chain will not be activated.
Code page filter

This filter is used to apply a code page for the input data. See “About code pages
and Unicode support“ on page 597 for more information.
Compression filter
This filter compresses the output data.
Content Server filter

This filter makes StreamServer output available in Content Server. See “Content
Server filter” on page 544 for more information.
DAQ filter
This filter takes a DAQ (Document Abstraction Query) as input, and retrieves
documents from a queue repository or Document Broker repository. See “DAQ
filter” on page 547.
Decompression filter
This filter decompresses the input data.
External filter
This filter reads data from standard input, sends it to the specified filter, and
delivers the filtered data back on standard output. The specified filter can be any
executable.
File filter
This filter converts characters in the input or output data using a conversion
table. See “File filter” on page 551.
GenericArchive filter
This filter archives output data in an external archive. Any metadata is archived
in an index file together with the data. See “GenericArchive filter” on page 553.
Archiving via the GenericArchive filter is an alternative to archiving via the
Generic Archive output connector. When using the GenericArchive filter, you
can use any type of output connector for the final delivery of the output data.
You must assign types from the metadata model to the data to be archived.

Internal filter
This filter handles escape codes (HpPcl, Esc0, and URL) in the input data. See
“Internal filter” on page 554.
Java filter
You can create Java classes to be executed in order to process data delivered to
connectors, e.g. to clean up or rearrange data before it is processed by the
StreamServer application. By adding the Java filter to a connector you can call
the appropriate Java class to use for processing the data delivered to this
connector. The Java filter can be used both as an input and output filter. See
“Java filter” on page 555.
JavaScript filter
This filter references a JavaScript file with JavaScript code that is applied to the
stream that enters the filter. See “JavaScript filter” on page 556.
Job filter
This filter enables the StreamServer to divide large input jobs into several small
jobs. Sequences in the input data determine the size of each job. See “Job filter”
on page 557.
LiveCycle filter
This output filter is used to integrate Adobe LiveCycle ES processes into the
StreamServer pipeline when processing documents. See “LiveCycle filter”
on page 558.
PDFIN filter
This filter enables the StreamServer to identify and extract PDF formatted input.
See “PDFIN filter“ on page 583 for more information.
PDF signature filter

This output filter is used to create locally signed PDF documents. See “PDF
signature filter” on page 559.
Resource filter
This output filter is used to store output from the connected Process as resources
in the repository. See “Resource filter” on page 561.
Service call filter

This filter is used to call StreamServer applications exposed via Service Request
input connectors. The Service call filter can be used both as an input and output
filter. See “Service call filter” on page 562.
XML stylesheet filter

This filter is used when XML transformation is required, and applies an XSLT
stylesheet to the XML. See “XML stylesheet filter” on page 563.

32.3.1 Bypass filter

This filter bypasses the StreamServer, and sends the input data directly to a
designated output connector. The filter settings are described in the table below.
• Start in bypass
If selected, all input received between StreamServer start-up and the first Bypass
off trigger is sent to the Bypass connector.
• Bypass connector
The name of the output connector to send the input data to.
• Initial time-out
N/A
• Bypass time-out
Time-out (seconds). Overrides the ordinary connector time-out
• Bypass on
Sequence in input data that activates the bypass filter, for example #bypassON.
• Remove (bypass on)
Select whether to remove the Bypass on sequence from output data.
• Bypass off
Sequence in input data that deactivates bypass mode, for example #bypassOFF.
• Remove (bypass off)
Select whether to remove the Bypass off sequence from output data.
• Append output to job
Allows the output sent to the bypass connector to be treated as a unit. For
example, if the bypass connector is a File connector, the output will end up in the
same file.
• Overlay resource
Optional overlay to include in the output.
• Overlay select
Sequence in input data that indicates "here comes an overlay", for example #ovl.
• Remove (overlay select)
Select whether to remove the Overlay select sequence from output data.
• Overlay trigger
Sequence in input data that indicates the end of the overlay file name, for
example ##.
• Remove (overlay trigger)
Select whether to remove the Overlay trigger sequence from output data.

Example 32-1: Bypass sequences
Settings:
Bypass on = #ON and Bypass off = #OFF
Input data:
xyz;#ONabc;def;ghi#OFF;jkl
Bypassed data:
abc;def;ghi
Example 32-2: Overlay sequences
Settings:
Overlay select = #OVL and Overlay trigger = ##
Input data:
abc;def;#OVLlogo.prn##ghi;jkl
Result:
The file logo.prn is sent between #OVL and ##.
32.3.2 Content Server filter

This filter makes StreamServer output available in Content Server, including
searchable categories and attributes.
Filter settings
The filter settings below can be set using variables.

• Content Server folder
Node ID or path to a Content Server folder.
• Node ID example - 1442812
• Path example - /enterprise/Sales/Customers/ABC Industries (8010)/
04 - Billing Documents
• Document name
The name of the document to store in Content Server.
• Description

Description of the document to store in Content Server.

• Content type
Content type (application/pdf, text/xml etc.) of the document to store in
Content Server. This content type overrides any content type derived from the
processed data. If left blank the content type is derived from the processed data.
• Allow multiple versions
Select to allow multiple versions of documents in the Content Server folder.
A web service connection profile with the sub type Content Server that points to
the Content Server HTTP or HTTPS port for REST communication.
• Mapping file
Path to a mapping file (see “About mapping files” on page 545). If left blank,
categories and attributes are not stored in Content Server. The path can be an
absolute path or a path relative to the working directory of the StreamServer
application.
• Cache size
Number of entries to have in the cache. Use 0 to disable caching. See also “About
caching” on page 547.
About mapping files

A mapping file maps types and properties in the processed document to categories
and category attributes in Content Server. The mapping can be applied to category/
attribute names only or to category/attribute names and IDs.
Syntax
<?xml version="1.0" encoding="UTF-8"?>

<StrsCsTypeMaps>

<StrsCsTypeMap StrsTypeId="<type>" CsCategoryName="<catName>"
CsCategoryId="<catID>" />

<Map>
<Metadata StrsPropertyId="<property>"
CsAttributeName="<attName>" CsAttributeId="<attID>"/>
...
</Map>
</StrsCsTypeMap>
...
</StrsCsTypeMaps>
Where:
• <type> is the GUID of the type created in Describer.
• <catName> is the category name in Content Server.

• <catID> is the category ID in Content Server (optional).

• <property> is a property to map to an attribute in Content Server.
• <attName> is an attribute name in Content Server.
• <attID> is an attribute ID in Content Server (optional).
About the StrsPropertyId attribute

The StrsPropertyId="<property>" attribute defines a property to map to an
attribute in Content Server, where <property> can have different types of
values:
• GUID of a property created in Describer.
• String variable, for example $CorrespondenceKeyVar.
• Single value from an array, for example $TaxIDERPVar[1].
• Multiple values from a single dimension array, for example
$PolicyIdVar[]. The values will be mapped to a multivalue attribute in
Content Server.
Example 32-3: Mapping file and script
In this example, all types of <property> values are used for the
StrsPropertyId= attribute. Note that the GUIDs are truncated for
readability reasons.
Script for variables and arrays
$CorrespondenceKeyVar = "CR007";
$TaxIDERPVar[0] = "TaxIDERP0";
$PolicyIdVar[0] = "POLICY007";
Mapping file
<?xml version="1.0" encoding="UTF-8"?>

<StrsCsTypeMaps>
<StrsCsTypeMap StrsTypeId="1f8..."
CsCategoryName="Correspondence" CsCategoryId="19201">
<Map>
<Metadata StrsPropertyId="65a..."
CsAttributeName="BusinessPartnerName"
CsAttributeId="19201_2" />
<Metadata StrsPropertyId="73f..."
CsAttributeName="BusinessPartnerID" CsAttributeId="19201_3" />
<Metadata StrsPropertyId="$TaxIDERPVar[1]"
CsAttributeName="TaxIDERP" CsAttributeId="19201_4" />
<Metadata StrsPropertyId="$CorrespondenceKeyVar"
CsAttributeName="CorrespondenceKey" CsAttributeId="19201_5" />
<Metadata StrsPropertyId="$PolicyIdVar[]"

CsAttributeName="PolicyID" CsAttributeId="19201_6" />

</Map>
</StrsCsTypeMap>
</StrsCsTypeMaps>
About caching
If a path (not Node ID) is specified in Content Server folder, StreamServer makes an
extra call to get the Node ID from Content Server. Without caching performance
would be affected since this extra call is made each time a document is stored in
Content Server. With caching enabled the Node ID is cached the first time the call is
made, and the Node ID will be retrieved from the cache in the following calls.
Since a variable can be used for the path specified in Content Server folder,
different folders, and thus different Node IDs, can be used for the documents in
Content Server. In such a case it is not enough to set Cache size to 1. For example, if
documents can be stored in two different folders you must set Cache size to at least
2.
It is not only Content Server folder that determines whether to use caching. If
CsAttributeId or CsCategoryId are not specified in the mapping file (these
attributes are optional), extra calls are also made to get the IDs. These IDs should
also be stored in the cache, and this also affects the Cache size.
32.3.3 DAQ filter

This filter takes a DAQ (Document Abstraction Query) as input, and collects
documents from a queue repository or Document Broker repository. The filter only
contains the setting Repository which is used to select the repository to collect
documents from. There are two options:
• Queue repository - Selects the queue repository linked to the domain.

• Document Broker Plus repository - Selects the Document Broker repository
linked to the domain.
Collecting documents from a Document Broker repository

Documents can be stored, via the Document Broker Plus output connector, in the
Document Broker repository. The Document Broker Plus connector can have
different types of drivers applied, or no driver at all. In a standard Document Broker
scenario the SDR for relational database driver is used, and documents can be
collected from the repository using a Post-processor (see “Collecting documents
from a Document Broker repository” on page 627).
If other drivers, or no driver, is used to store documents in a Document Broker

repository you must use the DAQ filter to collect the documents, i.e. you cannot use
a Post-processor to collect the documents.

The DAQ filter takes a DAQ as input and collects the documents that corresponds to
the selection defined in the DAQ. The output documents are delivered as a single
stream where the documents are concatenated in the sort order defined in the DAQ.
Deleting documents in the repository

The DAQ filter only processes documents without doing any updates. The
documents must therefore be deleted some other way if a delete is needed. To
do this you must set up an “expire contents” task in the task scheduler to expire
the documents intended for the DAQ filter.
Collecting documents from a queue repository

The DAQ filter can also be used to collect documents from the queues instead. The
functionality of the filter is exactly the same as when used with the Document
Broker repository. If you use the DAQ filter together with other Project design and/
or coding you can for example create a solution for reprocessing documents from
the queues. Exactly how to do this is out of scope for this documentation.
Using the DAQ filter in the input pipeline

The DAQ filter can be used on an input connector. In this case the DAQ is retrieved
via the input connector, and the DAQ filter collects, sorts, and delivers the
documents for further processing.
Using the DAQ filter in the output pipeline

The DAQ filter can be used on an output connector. In this case the DAQ is
generated by, for example, a Template Engine Process. The DAQ is sent to the
output connector, and the DAQ filter collects, sorts, and delivers the documents for
further post-processing.
Filter decorator
A decorator can be added to the DAQ. This decorator may contain three sections:
• Header - This optional section contains text to add before the very first document
in the result set. For example a start tag for an XML document to make it valid.
• Separator - This optional section contains text to add between every document in
the result set. For example a sequence of characters to enable a subsequent filter
in the filter chain to determine and split up the individual documents in order to
create a MIME envelope of them.
• Footer - This optional section contains text to add after the very last document in
the result set. For example an end tag for an XML document to make it valid.
The decorator syntax is described below:
<decorator type="http://schemas.streamserve.com/uid/configuration/
documentabstractiontextinsertquerydecorator/1.0">
<configuration>
<textinsertdecorator xmlns="http://schemas.streamserve.com/uid/

configuration/
documentabstractiontextinsertquerydecorator/
1.0">
<header><header></header>
<separator><separator></separator>
<footer><footer></footer>
</textinsertdecorator>
</configuration>
</decorator>
DAQ example
An example of a DAQ is illustrated below.
Example 32-4: Overall DAQ structure

<docabs xmlns="http://schemas.streamserve.com/uid/resource/
documentabstraction/1.0"
xmlns:strs="http://schemas.streamserve.com/public/
1.0">
<docab>
<command type="http://schemas.streamserve.com/uid/
configuration/
documentabstractionquery/1.0">
<configuration>
<daq xmlns="http://schemas.streamserve.com/uid/resource/
documentabstractionquery/1.0">
<query>
<filter>
<filterClause>
<conditions>
...
</conditions>
</filterClause>
</filter>
<sort>
<attributes>
...
</attributes>
</sort>
</query>
<decorators>
...
</decorators>
</daq>
</configuration>
</command>
</docab>
</docabs>

Example 32-5: DAQ conditions
<conditions>
<condition>
<strs:id>

<strs:value>FE08E578-DBF8-4748-A6EF-81E90A29120C</
strs:value>
</strs:id>
<strs:values>

<strs:value>6F2CC62E-D467-4BF9-BDC6-8ACCE29C0DED</
strs:value>
</strs:values>
<operatorValue>==</operatorValue>
</condition>
<condition>
<strs:id>

<strs:value>118EA52C-567E-4369-9AC3-2EF14A8AE0A5</
strs:value>
</strs:id>
<strs:values>

<strs:value>application/xml</strs:value>
</strs:values>
<operatorValue>==</operatorValue>
</condition>
<condition>
<strs:id>

<strs:value>7EDD3093-36C2-FCBF-E040-007F020039B2</
strs:value>
</strs:id>
<strs:values>
<strs:value>1</strs:value>
</strs:values>
<operatorValue>in</operatorValue>
</condition>
</conditions>
Example 32-6: DAQ sort attributes
<attributes>
<attribute>
<strs:id>

<strs:value>7EDD3093-36C2-FCBF-E040-007F020039B2</

strs:value>
</strs:id>
<method>descending</method>
</attribute>
</attributes>
Example 32-7: DAQ decorators

<decorator type="http://schemas.streamserve.com/uid/
configuration/
documentabstractiontextinsertquerydecorator/
1.0">
<configuration>
<textinsertdecorator xmlns="http://schemas.streamserve.com/
uid/configuration/
documentabstractiontextinsertquerydecorator/1.0">
<header>--9876</header>
<separator>--1234</separator>
<footer>--4321</footer>
</textinsertdecorator>
</configuration>
</decorator>
32.3.4 File filter

This filter coverts characters in the input or output data using a conversion table.
The settings are described in the table below.
• File
The conversion table that describes how to convert the characters. The
conversion table must be available in the same resource set as the filter chain.
Use the following syntax in the conversion table:
input_string_1
output_string_1
input_string_2
output_string_2
...
input_string_N
output_string_N
If the Use regular expressions option below is cleared (default), the strings in the
conversion table are treated as text rules. The following apply:
• You can use hexadecimal notation within angle brackets (<hex>). Some
characters (tab, line feed, angle brackets, quotation marks, etc.) must have
hexadecimal notation. You can separate multiple hex values with comma. For
example, <0D,0A>

• The strings are case sensitive, and you must comment empty rows with // or
*.
• Use regular expressions
Select to treat the rules in the conversion table file selected in the File option as
regular expressions.
Communications Center supports the ECMA Script syntax for regular
expressions. For syntax information, see for example http://userguide.icu-
project.org/strings/regexp
The following apply:
• The input_string_N must not include empty strings.

• The output_string_N may include empty stings.
• The output_string_N may include format specifiers and escape sequences
that are replaced by the characters they represent. You can use the specifier $n
n-th backreference, which is a copy of the <n>:th matched group specified
with parentheses in the regex pattern. n must be an integer that is a maximum
of two digits, greater than or equal to 0, but not greater than the number of
capture groups.
For example, $0 returns the whole pattern, while $1 returns first matched
group in the pattern.
• The strings are case sensitive, and you must comment empty rows with // or *
(except when output_string_N includes empty stings).
Tip: To combine text rules and regular expressions in the same filter chain, you
can use several File filters with different settings.
Example 32-8: Conversion table for text rules
// Substitute ALPHA with BETA

ALPHA
BETA
// Substitute line feed with carriage return and line feed
<0A>
<0D,0A>
// Substitute " with ()
<22>
<28,29>
// Substitute \ with /
<5C>
<2F>
Example 32-9: Conversion table for regular expression
//Substitue the word "cat" with an empty string

\bcat\b

//Substitute "sub" with "sub-" in words beginning with "sub"

\b(sub)([^ ]*)
sub-$2
32.3.5 GenericArchive filter

This filter archives output data in an external archive. Any properties are archived in
an index file together with the data.
What settings to specify depends on the requirements from the archiving system.
For example, if a third-party archiving client scans the directory for index files with
a certain extension, you must specify this extension. As the extension is added at job
end, you prevent the archiving client from accessing an index file before it is
completed.
The settings are described in the table below.

• Output directory
The root directory for the output. The output is temporarily stored in the root
directory before it is sent to the archiving system. You can use variables.
• Output document name prefix
A prefix that is added to the output data at job end. You can use variables.
• Output document name extension
An extension that is added to the output data at job end. You can use variables.
• Output document name
The name for the output data. You can use variables. If no name is specified, a
name is automatically generated.
Output document name overrides the Output document name prefix and
Output document name extension settings.
• Index file name prefix
A prefix that is added to the index file at job end. You can use variables.
• Index file name extension
An extension that is added to the index file at job end. You can use variables.
• Index file name
The name for the index file. You can use variables. If no name is specified, an
index file name is automatically generated.
Index file name overrides the Index file name prefix and Index file name
extension settings.
• External archive command
A command to execute when all files are added to the Output directory. You can
use variables.

Use %doc for document name and %idx for index name. If the command includes
a path with spaces, the path must be specified within apostrophes.
Note: Do not us any command that moves or removes the files. Use the
Remove files after external archive command instead.
• Remove files after external command execution
Removes the files (in the Output directory) after successful completion of the
External archive command. At a successful completion, the External archive
command returns the value 0.
32.3.6 Internal filter

This filter handles escape codes (HpPcl, Esc0, and URL) in the input data.
HpPcl
Removes HpPcl escape codes from the input data. StreamServer detects an
escape code as an ESC character (0x1b) followed by any number of characters.
The “end of escape code” character is an upper case letter (character in the range
[0x41..0x5a]). When StreamServer detects an ESC character, it removes all
characters until it finds an upper case letter (including the upper case letter).
Note: If no “end of escape code” is found, input is truncated at the ESC

character.
Esc0
Removes Esc0 escape codes from the input data. StreamServer detects an escape
code as an ESC character (0x1b) followed by any number of characters. The“end
of escape code” character is a NULL character (0x00). When StreamServer detects
an ESC character, it removes all characters until it finds a NULL character
(including the NULL character).
Note: If no “end of escape code” is found, input is truncated at the ESC

character.
URL
• Converts URL escape codes (%20 to space etc.).
• Converts & (ampersand) to <0D, 0A> (carriage return - line feed).
• Converts + (plus sign) to space.

32.3.7 Java filter

You can create Java classes to be executed in order to process data delivered to input
connectors as well as to output connectors. By adding the Java filter to a connector
you can call the appropriate Java class to use for processing the data delivered to this
connector. For example, use a Java input filter to rearrange data before it is
processed by the StreamServer application.
The filter reads input from the input stream and writes output to the output stream.
If an exception is thrown from the filter, the result is as follows:
• If used as input filter, no data is sent to the Event for processing. The processing
job is not marked as failed by the filter.
• If used as output filter, no data is sent to any subsequent filters or to the
connector. The output job is marked as failed.
Filter settings
• Java filter class name
The name of the Java filter class to invoke. This class must implement the
streamserve.filter.Execute interface included in jstrs.jar.
For information about how to create Java filter classes, see the Java Connectors
and Filters SDK documentation.
• Java configuration class name
The name of an optional Java configuration class to invoke. This class must
implement the streamserve.service.Configuration interface included in
jstrs.jar.
The configuration is global and shared between all running instances of the same
filter. The configuration is loaded once at startup of the StreamServer application.
For information about how to create Java configuration classes, see the Java
Connectors and Filters SDK documentation.
• Configuration file name
Optional configuration file used by the configuration class. The file can be in any
format that can be handled by the configuration class, and must be available in a
resource set connected to the platform. The file is supplied as a stream to the
configuration class readConfiguration method which is called during
initialization.

32.3.8 JavaScript filter

The JavaScript filter can be used for both input (Input Analyzer or input connectors)
and output (output connectors). The filter references a JavaScript file with JavaScript
code that is applied to the stream that enters the filter. This JavaScript file must be a
resource of type JavaScript, and the same JavaScript file (resource) can be used in
several filters.
The JavaScript code determines what to do with the stream that enters the filter. For
example, in a responsive email scenario the filter can be used to modify the HTML
structure, change attribute values and add data to the HTML head element.
Filter settings
• Javascript File Name - Browse to the JavaScript file to use.
About the JavaScript code

The JavaScript code used with this filter is similar to the JavaScript code for
StoryTeller (see Section 5 “JavaScript” in OpenText Communications Center Enterprise -
StoryTeller Configuration Guide (CCMSTT-CGD)). Some notable differences are
described below.
Reading and writing filter data

The filter accesses stream data using the repo module. Two filter specific
methods are available in the repo module: loadInput and saveOutput. These
methods are similar to the standard repo methods load and save used in
StoryTeller scripting with the following exceptions:
• loadInput takes one parameter: encoding.
• saveOutput takes two parameters: data and encoding.
Example 32-10: Changing data to uppercase
var repo = require( 'repo' );

var str = repo.loadInput();
str = str.toUpperCase();
repo.saveOutput( str );
Supported JavaScript modules

The filter supports the same JavaScript modules that are supported in
StoryTeller scripting. There are some differences:
• The data module is supported by the filter only if data is available. It is not
supported in the input pipeline for example.
• The layout and i18n modules are not supported at all by the filter.

Content type and HTTP header management

The properties process.getProp and process.setProp are used in the filter,
together with the properties filter.contenttype and http.header.<name>, to
manage content type and HTTP headers.
• filter.contenttype contains the input content type. This property should
be set to the output content type or be left unchanged. In the input pipeline,
the input content type is always application/octet-stream (may change
in a future release).
• http.header.<name> , where <name> is the header field name, contains the
current HTTP header (cannot be written).
32.3.9 Job filter

This filter enables StreamServer to divide large input jobs into several small jobs.
Sequences in the input data determine the size of each job. The settings are described
in the table below.
• Job begin
Sequence specifying the beginning of a job. For example:
[JOB BEGIN]
• Job end
Sequence specifying the end of a job. For example:
[JOB END]
Example 32-11: Job filter
This example displays two scenarios where one large input job is divided
into smaller jobs.

32.3.10 LiveCycle filter

StreamServer can use a LiveCycle output filter to invoke LiveCycle processes that
are deployed within Adobe LiveCycle ES and exposed through web services. These
web services can be used to integrate LiveCycle processes into the StreamServer
pipeline when processing documents.
The filter settings are described in the table below.
• Host name
The host name or IP address of the server hosting LiveCycle ES. For example
localhost
• Port
The port used by the LiveCycle ES server. For example 8080
• Web service name
The name (case sensitive) of the service to invoke. This name must be the same as
the corresponding process created in LiveCycle Workbench ES.
• User name
User name to connect to the server hosting LiveCycle ES. Used in case of basic
• Password
Password to connect to the server hosting LiveCycle ES. Used in case of basic
• Enable asynchronous communication
Yes – Make asynchronous calls to the service. This option is used when invoking
long-lived LiveCycle services.
No – Make synchronous calls to the service. This option is used when invoking
short-lived LiveCycle services.
• Asynchronous poll interval
Only used together with asynchronous calls. This is the interval (milliseconds)
used to check for a response to the invocation request.
• Root certificate for SSL communication
The root certificate used when HTTPS is used as web service protocol (secure
communication). The certificate must be available from a resource set connected
to the Platform.
• Custom options
A list of custom keys (key-value pairs) to include in the invocation request.

To be able to handle custom keys, the service must have a variable named
optionsMap of the type map. All custom keys defined here will be added to the
optionsMap variable in the invoked service.
The values provided can be extracted in the receiving LiveCycle process by using
an XPath expression in the LiveCycle process.
Examples of custom keys are passwords for creating password encrypted PDF
files. For example:
Key: pdfpassword
Value: encrypted
32.3.11 PDF signature filter

This filter is used to create locally signed PDF documents. The settings are described
in the table below.
Prerequisites
• You must have a Certificate store profile that contains the private key used to
sign the documents. See Certificate store below.
• The StreamServer application that runs the Project must be configured for Java.
See Java configuration for the StreamServer application below.
Filter settings
The Certificate store profile that contains the private key used to sign the
documents. See Certificate store below.
• Private key alias
Specifies an alias for the private key to be used. See Certificate store below.
• Visible signature
Specifies whether to include a visible signature in the PDF.
Enter Yes to include or No to not include a visible signature.
• Reason
Reason for signing the PDF. This information is displayed in the visible
signature.
• Location
Location where the PDF is signed. This information is displayed in the visible
signature.
• Page number
The page number where to include the visible signature.
• If you enter -1, the signature is included on the last page.

• If you enter 0 (e.g. a variable that evaluates to 0) the signature is included on

the first page.
• If you enter a value that is larger than the last page the signature is included
on the last page.
• Rect low left x/y
The x/y coordinate of the lower-left corner of the rectangle containing the visible
signature. Specified as points from the lower-left corner of the page.
• Rect width
The width (points) of the rectangle.
• Rect height
The height (points) of the rectangle.
• Pdf Owner password
Specifies an owner password for the PDF document.
• Pdf User password
Specifies a user password for the PDF document.
If any of the rectangle settings (Rect low left x/y and Rect width/height) causes the
visible signature to be positioned off the page, the filter sets the signature to the
following size and position:
• Rect low left x = 300
• Rect low left y = 150
• Rect width = 300
• Rect height = 50
Certificate store
Before you can configure and use the filter, you must create a Certificate store
profile that contains the private keys (*.pfx) used to sign the documents. When
you have the Certificate store profile, you can link it to your PDF signature filter.
The certificate store may include a set of private keys used for singing, and each
private key can have an alias assigned. You can use the Private key alias field to
specify the private key to be used for signing.
See “Certificate store profiles” for more information about how to create
certificate store profiles.
Using variables
The settings (except for Certificate store profile) can be controlled via variables,
i.e. you can enter variables instead of fixed values when you specify the filter
settings.
Java configuration for the StreamServer application
The StreamServer application that runs the Project must be configured for Java.
The only property you have to provide is the Java vendor. You do this in
Control Center:

1. Right-click the StreamServer application and select Java Configuration.
2. Specify the Java vendor and click OK.
32.3.12 Resource filter

The Resource filter stores output as resources in the repository. The stored resources
can be accessed from, for example, Template Engine, SMTP (MIME) connector and
MIMEAddPart script function.
For example, a StoryTeller document can be stored as a resource via a Resource

filter, and this resource can then be wrapped into the output from a Template
Engine Process.
Filter settings
• Resource name
The name of the resource. This name, or the GUID of the resource, can later be
used to access the resource.
• Content type
The content type of the resource.
• Expire by time
Specifies whether to set an expiry time for the resource.
Yes – Use Duration and Time unit below to specify for how long to store the
resource in the repository.
No – Do not set an expiry time for the resource.
• Duration
The number of <Time units> to store the resource.
• Time unit
The time unit for the Duration.
Resource connector and Resource filter

You can use a Resource output connector (see “Resource output connector”
on page 200) or a Resource filter to store output as resources in the repository.
For example, you can use the connector if you only want to store the output as
resources, and use the filter if you want to deliver output via a standard output
connector and driver (e.g. a File connector and PDF driver) and at the same time
store the output as resources.
Accessing stored resources

A resource stored in the repository can be accessed by referencing the GUID or
name of the resource. The following types of URIs can be used to access a
resource:
resource://guid=<GUID>
resource://name=<Name>

resource:/?guid=<GUID>
resource:/?id=<GUID>
resource:/?name=<Name>
resource:/v1/resources/<GUID>
resource:/v1/resources?name=<Name>
For example, Template Engine can use the #include directive to include the
resource in the output:
#include('resource://name=my_text')
Example
This example includes a Message with a StoryTeller Process and a Template
Engine Process, where the StoryTeller Process is run before the Template Engine
Process.
The StoryTeller Process is connected to a Null output connector with a Resource
filter and a PDF driver. In the Resource filter, Content type is set to
application/pdf and Resource name is set dynamically by the variable
$resource.
The variable $resource is a unique name set by a script run before the
StoryTeller Process:
CreateGlobalSerNo("resourcenumbers", 1, 1, -1);
$resource = "res_" + str(GetGlobalSerNo("resourcenumbers"));
The Template Engine Process is connected to a File output connector. In the

Template Engine Process, a reference is made to the resource generated by the
StoryTeller Process. The reference is an #include directive using the resource
protocol and the variable set by Resource name to reference the resource:
#include("resource://name=$variables.resource?outputEnc=base64")
When the StreamServer application is run, the StoryTeller PDF is stored as a

resource in the repository, and then wrapped base64 encoded into the output
from the Template Engine Process.
32.3.13 Service call filter

The Service call filter is used to call StreamServer applications exposed as services
via Service Request input connectors. Data arriving to an input or output connector
with a Service call filter is passed on to the service defined by the Service name and
Service version settings in the filter.
You can use the Service call filter to access a service in the same domain. If the called
service is configured to return the output in the response, this output is returned via
the filter. This method for returning the response can be used instead of internal
output/input connectors to loop data within the same Project (i.e. StreamServer
application).
You can create a filter chain that contains several Service call filters. When data
arrives to the connector it is passed on to the service called by the first Service call

filter. The response from the service is then returned, and this data is passed on to
the service called by the next Service call filter and so on.
Filter settings
• Service type
Static field that you cannot edit. It always displays Generic to indicate that
Generic is the Request type that must be selected in the Service Request
connector through which the service is exposed.
• Service name
The name of the service to call. This name is defined as Service name in the
Service Request connector through which the service is exposed.
• Timeout
Timeout (milliseconds) for the service call, i.e. the time to wait for the response
before the service call expires. Specify -1 for no timeout, and wait as long as it
takes for the response.
• Service version
The version of the service (StreamServer application) to call. Specify 0 to always
use the latest version.
• Custom header
Custom HTTP header that can be submitted to the service. The header contains
key-value pairs of the format Key:Value. Separate the pairs with <0D><0A> (hex
values for carriage return + newline).
Values in the header can be accessed with the GetConnectorValue script
function.
32.3.14 XML stylesheet filter

The XML stylesheet filter is used when XML transformation is required, and applies
an XSLT stylesheet to the XML. The filter can be used, for example, together with the
Layout driver to transform XML to HTML. The XSLT stylesheet referenced in this
filter must be available as an XML Stylesheet resource in a resource set.
The content type of the output is determined by xsl:output/@media-type or

xsl:output/@method in the XSLT stylesheet. If not defined in the stylesheet, the
content type is application/xml.
Filter settings
• XML Stylesheet File Name
The XSLT stylesheet to use for XML transformation.
• XSLT Parameters
Optional global xsl:param parameters to pass to the transformation.
An XSLT parameter is defined as <name>=<value>. For example, pTarget=small

Where:
• pTarget corresponds to xsl:param/@name="'pTarget'"
• small corresponds to xsl:param/@select="'small'"
Several parameters are separated by semicolon (;), for example pTarget=small;

pReplacement=tiny

Chapter 33
AFPIN filter
The AFPIN filter converts AFP input to Layout eXchange Format (LXF), and enables
Streamserver to identify and extract AFP formatted input documents. Typical usage
scenarios are to:
• Recognize pages and read formatted text from the AFP document using
PreformatIN.
• Convert AFP documents to other print formats, such as PCL and PostScript.
• Convert AFP documents to archival formats, such as PDF and TIFF, and reuse
indexing information.
• Convert AFP overlays to LXF overlays for migration to Communications Center
environment.
• Convert AFP documents and hide or replace, for example, OMRs and barcodes.
• Store AFP document in the post-processor repository using AFP document
metadata. The AFP documents can be sorted and included in the same envelope
as other stored documents.
The AFP conversion may result in large LXF documents, depending on the
complexity of your AFP data stream and PreformatIN design. The large LXF
documents may affect Project performance, depending on factors such as
throughput, operating environment and hardware.
AFP reference
You must have knowledge of the AFPDS format and AFP terminology to use the
AFPIN filter.
33.1 Notes about the AFPIN filter

Fonts
AFP fonts are always mapped to TrueType or Type1 fonts, that are available to
StreamServer.
Pagedef
AFP Pagedef is not supported.
Formdef
N-Up printing is not supported. The following is supported from the AFP
Formdef:
• sheet size
• duplex
• overlays

Chapter 33 AFPIN filter
• trays and bins
Overlays
OGL source files must be converted into AFP overlays.
Images
Embedded images (TIFF, JPEG, BMP, EPS, etc.) are not supported. Bitmap
patterns from IM image and IOCA are replaced with boxes filled with solid
color of the respective shade percentage.
Graphics
GOCA markers are not supported.
33.2 Supported barcodes

The following barcode types are supported:
• Australia Post Bar Code
• Code 128
• CODE 39
• Data Matrix
• EAN-13
• EAN-8
• Industrial 2-of-5
• Interleaved 2-of-5
• Matrix 2-of-5
• MaxiCode
• MSI
• PDF417
• POSTNET
• RM4SCC
• UPC/CGPC Version A
• UPC/CGPC Version E

33.3. Configuring the AFPIN filter
33.3 Configuring the AFPIN filter

The procedure for configuring the AFPIN filter is the same as for all other types of
filter chain filters.
Use the filter chain editor to configure the AFPIN filter with settings for a specific
project. To specify defaults that can be used by multiple projects you use a settings
file. For more information see “AFPIN filter settings” on page 576.
33.3.1 Font mapping

AFP fonts can not be read by StreamServer and must be mapped to TrueType and
Type1 fonts. You must create a font mapping file where you specify how to map the
fonts. A sample of a font mapping file, AFPINfont.map, is included in the AFPIN
filter installation and located in the following directory:
<Communications Center installation>\ Applications\StreamServer

\<Version>\Common\Modules\Filters
The sample file contains mappings for AFP character sets, typefaces, coded fonts,
FGID (Font Global Identifier), CPGID (Code Page Global Identifier) and code pages.
For mapping file syntax descriptions, see:
• “Character set mapping” on page 568
• “Typeface mapping” on page 570
• “Coded font mapping” on page 571
• “FGID mapping” on page 571
• “Code page mapping” on page 571
• “CPGID mapping” on page 572
To create a font mapping file
1. Copy the sample file AFPINfont.map.
2. Enter the keywords and mapping values according to the syntaxes. Use tab to
separate the columns.
3. Save the file and add it to a resource set connected to the Platform.

33.3.2 Character set mapping

To map AFP character sets to TrueType fonts, use the following syntax:
<AFP charset> CHARSET <font> [<style>] [<size>]
Note: Style and size specified in the AFP character set resource overrides the
settings in the font mapping file.
Example 33-1: Character set mapping

// Charset mapping
C0H200A0 CHARSET Arial 11.0
C0H30080 CHARSET Arial Italic 8.0
C0H40070 CHARSET Arial Bold 7.0
C0H500B0 CHARSET Arial Bold,Italic 12.0
Example 33-2: Character set mapping when style and size are specified
in the AFP character set resource
// Charset mapping
C0H200A0 CHARSET Arial
Forced character set mapping
If you want mapped fonts to always be bold or italic, or to never be bold or italic,
you use the following keywords:
• NOT_BOLD – Mapped fonts will always be plain in the output.
• USE_BOLD – Mapped fonts will always be bold in the output.
• NOT_ITALIC – Mapped fonts will always be plain in the output.
• USE_ITALIC – Mapped fonts will always be italic in the output.
Use the following syntax in the charset mapping:
<AFP charset> CHARSET <font> <keyword> [<size>]
Example 33-3: Forced character set mapping
In this case, mapped font will always be bold independent on flags in found
AFP charset C0HL05GP.
// Charset mapping
C0HL05GP CHARSET Arial USE_BOLD 5.0
Forced font size mapping

You can use “!” to override the font size specified in the AFP charset resource.

Example 33-4: Forced font size mapping

In this case, the mapped font size will always be 10.0 independent on
flags in found AFP charset COHL10GP.
// Charset mapping
COHL10GP CHARSET Arial !10.0
Matching multiple character sets

Enter a question mark in the character set name to match multiple character set
names. Any character in the position of the question mark is ignored.
Example 33-5: Mapping matching multiple character sets

In this example C?H500B0 matches C0H500B0, C1H500B0, C2H500B0 etc.
// Charset mapping
C?H500B0 CHARSET Arial Bold,Italic 12
C?H30080 CHARSET Arial Italic 8
Specifying font size for multiple character sets

Enter the percentage sign in the character set name to specify the font size
according to IBM font naming standard. The font size is derived from the
character in the position of the percentage sign, according to the following rules:
1 = 1.0, 2 = 2.0, 3 = 3.0, …, 9 = 9.0, 0 = 10.0, A = 11.0, B = 12.0, C = 13.0 ...
Note: A font size specified in the AFP character set resource overrides the
setting in the font mapping file.
Example 33-6: Specifying fonts size for multiple character sets

In this example C?H500%0 matches, for example, C1H500B0. The font
size is derived from the B and set to 12.
//Charset mapping
C?H500%0 CHARSET Arial Bold,Italic
C?H300%0 CHARSET Arial Italic

33.3.3 Typeface mapping

You can map AFP character sets to TrueType fonts using typeface mapping. Use the
typeface name from the font descriptor in the AFP character set, and the following
syntax:
<AFP typeface name> TYPEFACE <font>
Example 33-7: Typeface mapping

// Typeface mapping
TIMES ROMAN TYPEFACE Times New Roman
HELVETICA TYPEFACE Arial
COURIER LATIN1 TYPEFACE Courier New
Forced typeface mapping
To map plain AFP typefaces to bold or italic, or bold and italic AFP typefaces to
plain, you can use the following keywords:
• NOT_BOLD – Mapped AFP typefaces will always be plain in the output.
• USE_BOLD – Mapped AFP typefaces will always be bold in the output.
• NOT_ITALIC – Mapped AFP typefaces will always be plain in the output.
• USE_ITALIC – Mapped AFP typefaces will always be italic in the output.
Use the following syntax in the typeface mapping:
<AFP typeface name> TYPEFACE <font> <keyword>
Example 33-8: Forced typeface mapping
In this case, AFP typefaces in Windings will always be plain in the output,
even if original AFP typefaces are bold.
// Typeface mapping
WINGDINGS TYPEFACE Wingdings NOT_BOLD

33.3.4 Coded font mapping

Use the following syntax to map coded fonts to a specific AFP code page with a
specific AFP character set:
<coded font> CODEDFONT <AFP code page> <AFP character set>
Example 33-9: Coded font mapping

// Coded font mapping
X0A0558C CODEDFONT T1V10273 C0A05580
X0A0756C CODEDFONT T1V10273 C0A05560
33.3.5 FGID mapping

Use the following syntax to map FGIDs (Font Global Identifiers) to TrueType fonts:
<fgid> FGID <font> [<style>]
Note: The <fgid> must be a decimal integer.
Example 33-10: FGID mapping

// FGID mapping
05580 FGID Arial Bold
33.3.6 Code page mapping

Use the following syntax to map the AFP code pages to code pages used by
StreamServer:
<AFP code page> CODEPAGE <code page>
The code pages used by StreamServer are found in the Design Center, for example,
Tools > Design Center Settings.
Example 33-11: Code page mapping

// Codepage mapping
T1V10273 CODEPAGE IBM CP 273
T1D1STMT CODEPAGE IBM CP 500
T1V10500 CODEPAGE IBM CP 500

33.3.7 CPGID mapping

Use the following syntax to map CPGIDs (Codepage Global Identifiers) to code
pages used by StreamServer:
<cpgid> CPGID <code page>
Note: The <cpgid> must be a decimal integer.
The code pages used by StreamServer are found in the Design Center, for example,
Tools > Design Center Settings.
Example 33-12: CPGID mapping

// CPGID mapping
02819 CPGID IBM CP 273
33.3.8 GCGID mapping

In a standard scenario where the AFP input only contains standard GCGIDs
(Graphic Character Global Identifiers), the GCGIDs are automatically converted to
Unicode value.
If the AFP input contains unavailable GCGIDs, you must specify a GCGID mapping
table and/or specify GCGID generic masks. See “Creating a GCGID mapping file”
on page 572 and “Specifying GCGID generic masks” on page 573.
33.3.9 Creating a GCGID mapping file

Use the following syntax in the GCGID mapping file:
<Unicode> <GCGID>
Example 33-13: The GCGID mapping file UserGCGID.txt

U0020 SX010000
U0021 SP0200X0
U0022 SP0400X0
U0023 SM0100W0
U0025 SM02000Y
To create a GCGID mapping file
1. Open a text editor.

2. Enter the mappings according to the syntax and use TAB to separate the
columns.
3. Save the file, and add it to a resource set connected to the Platform.

33.3.10 Specifying GCGID generic masks

For GCGIDs that have been generated from Unicode values, you can use masks to
derive the Unicode value. The masks must have the following format:
%[width]type
where
• % indicates the start of the Unicode value to derive.
• width specifies the maximum number of characters to read.
• type specifies the data type that is expected.
The following types can be used:

• d - Decimal integer
• x - Hexadecimal integer
• u - Unsigned decimal integer
• o - Octal integer
The GCGID masks must be separated by semicolons.
Example 33-14: GCGID masks

UD0%05d;U000%04x;UD0%05u;UO%06o
UD0%05d matches GCGIDs that begin with UD0. The following five
characters are interpreted as a decimal number.
U000%04x matches GCGIDs that begin with U000. The following four
characters are interpreted as a hexadecimal number.
UD0%05u matches GCGIDs that start with UD0. The following five characters
are interpreted as unsigned decimal integers.
UO%06o matches GCGIDs that start with U0. The following six characters are
interpreted as octal integers.

33.3.11 Extracting NOP records

You can extract NOP records from different levels in the AFP input data. The NOP
records are converted to variable values that can be used for further processing. In
the filter chain editor you use the following arguments to specify what NOP records
to extract:
[<apf_level>]:[<starts_with>]:<property_name>[;]
In the settings file you use the same arguments with the AFP_NOP_MASKS keyword.
Note: If multiple NOP records match your arguments, the variable will contain
the value of the last processed NOP record.
NOP extracting arguments
<apf_level>
The level where the NOP is extracted. If not specified, NOPs for all levels are
extracted. Available levels are BGN and BPG.
<starts_with>
Initial pattern of the NOP value to extract. If not specified, all available NOPs
are extracted.
<property_name>
Name of the variable that will contain the NOP. You cannot use the following as
variable names (the names are restricted to page description in the LXF file):
• PAGEDUPLEX
• PAGETRAY
• PAGEBIN
• PAGEORIENTATION
• PAGEMEDIA
• PAGEWIDTH
• PAGEHEIGHT
• MEDIUMMAP
• MEDIAORIENT
• AFP_BNG_NAME
Example 33-15: Extracting a NOP record at BNG level
In this example, NOP records at BNG level are extracted. The last processed
NOP is stored in the variable AFP_NOP.
BNG::AFP_NOP

Example 33-16: Extracting a specific NOP record
In this example, NOP records starting with 333 at BNG level are extracted.
The last processed NOP is stored in the variable AFP_NOP.
BNG:333:AFP_NOP
Example 33-17: Extracting multiple NOP records at any level
In this example, NOP records located at any level starting with 222 or 333
are extracted. The last processed record starting with 222 is stored in the
AFP_NOP1 variable and the last processed record starting with 333 stored in
the AFP_NOP2 variable.
:222:AFP_NOP1;:333:AFP_NOP2
33.3.12 Capturing and reusing AFP objects

To capture AFP objects from the AFP input data, for example TLEs, you must
analyze the input data to find the names of the objects.
You use variables and scripting to capture the values of the objects.
Example 33-18: Capturing TLE values
In this example, the AFP name of the TLE is PageInfo.
$var=$PageInfo
33.3.13 Medium Map variables

When the AFP input document uses Medium Maps, the AFPIN filter extracts
information from the currently used Medium Map, and adds this information to
page variables. The variables are described in the table below.
Medium Map variables
MEDIUMMAP
The name of the invoked Media Map.
MEDIAORIENT
The media orientation:
• PORTRAIT
• LANDSCAPE
• PORTRAIT90

• LANDSCAPE90
PAGETRAY
The tray number.
PAGEBIN
The output bin number.
PAGEDUPLEX
Duplex control:
• 0 = SIMPLEX
• 1 = DUPLEX
• 2 = DUPLEX TUMBLE
33.4 AFPIN filter settings

Use the filter chain editor to configure the AFPIN filter, or a settings file for default
settings that can be used by multiple projects. See “AFPIN filter GUI reference”
on page 577 and “AFPIN filter settings file” on page 577.
Note: Any configuration made in the filter chain editor overrides the
corresponding configuration in the settings file.
AFP resources and search order
When you configure the AFPIN filter, you specify which AFP resources to use.
Separate multiple paths using semicolons, and use wildcards to specify multiple
files. Specify the paths in the order you want them to be searched. You can also
specify defaults that are used when there is no other way to determine, for example,
the name and size of the TrueType font to use.
The AFP resources are searched in the following order:
1. In the inline resource group
2. In the configured paths
3. In the configured paths for the default resource groups and default resources
Note: External resource groups are only searched in the paths specified for
resource groups.

33.4. AFPIN filter settings
33.4.1 AFPIN filter settings file

In the settings file, you specify default settings that can be used by multiple projects.
Use the following syntax and one keyword per row when you enter the keywords:
<keyword>=<value>
For information about the keywords, see “AFPIN filter GUI reference”
on page 577.
A sample settings file is included in the AFPIN filter installation. It is located in the
following directory:
<installation_directory>/Common/modules/filters/AFPIN.settings
Example 33-19: Contents in the AFPSettings.txt

AFP_FONT_PATHS=C:/Font/;C:/AFPRes/*.300;D:/Res/X0*
AFP_IMAGE_PATHS=C:/Images/;C:/AFPRes/*.psg;D:/Res/S1*
AFP_EXTERNAL_FORMDEF=C:/AFPRes/F1FMDEF
AFP_IGNORE_INLINE_FORMDEF=yes
To create a settings file
1. Copy the sample file.
2. Enter keywords and their values.
3. Save the file and add it to a resource set connected to the Platform.
33.4.2 AFPIN filter GUI reference

The AFPIN filter converts AFPDS input to an internal XML format. The converted
input is sent to a PreformatIN Event for processing.
You can use the keywords listed below in the settings file.
Settings
• Settings file name
The settings file to be used.
Keyword: AFP_SETTINGS_FILE
• Font paths
The AFP font resources to be used, for example:
C:/AFPRes/*.300;D:/Res/X0*;./External/Fonts
Keyword: AFP_FONT_PATHS
• Image paths

The AFP image resources to be used, for example:
C:/Images/;C:/AFPRes/*.psg;./External/Images
Keyword: AFP_IMAGE_PATHS
• Overlay paths
The AFP overlay resources to be used, for example:
./External/Overlays;C:/AFPRes/*.ove
Keyword: AFP_OVERLAY_PATHS
• Resource group paths
The AFP external resource groups to be used, for example:
./External/ResGroup;C:/AFPRes/*.grp
Keyword: AFP_RESGROUP_PATHS
• Default resources paths
The AFP default external resources to be used, for example:
./External;C:/Overlays/;C:/Fonts/;D:/Res/
Keyword: AFP_DEFAULTRES_PATHS
• User GCGID map file name
The GCGID mapping file to be used.
Keyword: AFP_USER_GCGID_MAP_FILENAME
• GCGID generic masks
The GCGID generic masks to be used, for example:
U000%04X;X000%04X;UNIC%04X
Keyword: AFP_GCGID_GENERIC_MASKS
• Font mapping file name
The font mapping file to be used.
Keyword: AFP_FONT_MAPPING_FILENAME
• Default codepage name
The default code page to be used. If not specified here or in a settings file, IBM CP
500 is used.
Keyword: AFP_DEFAULT_CODEPAGE_NAME
• Default font name
The default TrueType font to be used. If not specified here or in a settings file,
Courier New is used.
Keyword: AFP_DEFAULT_FONT_NAME

• Default font size

The default font size in points to be used. If not specified here or in a settings file,
10 is used.
Keyword: AFP_DEFAULT_FONT_SIZE
• Default character
The default character to be used. If not specified here or in a settings file, the
space character (Unicode X20) is used.
Keyword: AFP_DEFAULT_CHARACTER
• External formdef
The external AFP form definition to be used, for example:
C:/AFPRes/F1FMDEF
If you only specify the file name, and not the path, the paths specified for default
external resources are searched.
Note: The external form definition is only used when the Ignore inline
formdef is set to Yes or form definition is not available in the inline
resource group.
Keyword: AFP_EXTERNAL_FORMDEF
• Ignore inline formdef
Specifies if the inline AFP form definition in the document resource group
should be ignored.
Yes – The inline form definition is ignored.
No – The inline form definition is used.
<Default> – If not specified in a settings file, the inline form definition is used.
Keyword: AFP_IGNORE_INLINE_FORMDEF
• Capture page TLE
Specifies if AFP TLEs on page level should be captured and converted to
variables. See also “Capturing and reusing AFP objects” on page 575.
Yes – The TLEs are captured.
No – The TLEs are ignored.
<Default> – If not specified in a settings file, the TLEs are captured.
Keyword: AFP_CAPTURE_PAGE_TLE
• Capture page group TLE
Specifies if AFP page group and document TLEs should be captured and
converted to variables. See also “Capturing and reusing AFP objects”
on page 575.
Yes – The TLEs are captured.

No – The TLEs are ignored.

<Default> – If not specified in a settings file, the TLEs are captured.
Keyword: AFP_CAPTURE_PG_GROUP_TLE
• Capture BNG names
Specifies if BNG (Begin Named Group) names should be captured and converted
to page property AFP_BNG_NAME available for re-use. See also “Capturing and
reusing AFP objects” on page 575.
Yes – The BNG names are captured.
No – The BNG names are ignored.
<Default> – If not specified in a settings file, the BNG names are ignored.
Keyword: AFP_CAPTURE_BNG_NAMES
• NOP masks
Masks used for extracting NOP records. Use the following syntax:
[<apf_level>]:[<starts_with>]:<property_name>[;]
<apf_level> – The level where the NOP is extracted. If not specified, NOPs for
all levels are extracted. Available levels are BGN and BPG.
<starts_with> – Initial pattern of the NOP value to extract. If not specified, all
available NOPs are extracted.
<property_name> – Name of the variable that will contain the NOP.
You can not use the following as variable names. The names are restricted to
page description in the LXF file:
• PAGEDUPLEX
• PAGETRAY
• PAGEBIN
• PAGEORIENTATION
• PAGEMEDIA
• PAGEWIDTH
• PAGEHEIGHT
• MEDIUMMAP
• MEDIAORIENT
• AFP_BNG_NAME
For more information and examples, see “Extracting NOP records” on page 574.
Keyword: AFP_NOP_MASKS=[<apf_level>]:[<starts_with>]:
<property_name>[;]

• Use name referencing for missing overlays

Specifies how missing AFP overlays should be handled.
Yes – If an overlay in the internal LXF format with the same name is available, it
replaces the missing overlay.
No – The missing overlay is ignored.
<Default> – If not specified in a settings file, the missing overlay is ignored.
Keyword: AFP_USE_NAME_REF_FOR_MISSING_OVERLAYS
• Use name referencing for missing images
Specifies how missing AFP images should be handled.
Yes – If an image with the same name in PNG, TIFF or JPG format exists, it
replaces the missing image.
No – The missing image is ignored.
<Default> – If not specified in a settings file, the missing overlay is ignored.
Keyword: AFP_USE_NAME_REF_FOR_MISSING_IMAGES
• Default double byte mapping
Only applicable when double-byte fonts are used in the AFP input data.
The default double-byte code point to be used. If not specified here or in a
settings file, JAPANESE is used.
Keyword: AFP_DEFAULT_DOUBLE_BYTE_MAPPING
• SDF binary output
The internal document format to be used.
Yes – The binary LXF format SDF is used.
No – The text based LXF format is used.
<Default> – If not specified in a settings file, the text based LXF format is used.
Keyword: AFP_SDF_BINARY_OUTPUT

Chapter 34
PDFIN filter
The PDFIN filter converts PDF input to Layout eXchange Format (LXF), and enables
StreamServer to identify and extract PDF formatted input documents. Typical usage
scenarios are:
• Email attachments – Receiving PDF files as email attachments. Archiving or
distributing the received files to multiple destinations.
• Archiving – Converting PDF files to a format accepted by the archiving system.
• Document design – Reusing the layout in the received PDF files. See Section 19.1
“Reusing the input layout” in OpenText Communications Center Enterprise - Event
tools Configuration Guide (CCMEVT-CGD) for information on how to reuse the
layout.
• Scanned documents – Receiving scanned documents that are converted to PDF
format. Archiving or distributing the received documents to multiple
destinations.
The PDF conversion may result in large LXF documents, depending on the
complexity of your PDF data stream and PreformatIN design. The large LXF
documents may affect Project performance, depending on factors such as
throughput, operating environment and hardware.
PDF reference
See the PDF specification for information about the PDF format and for
information on how applications can create, read, or modify PDF content. This
specification is available at www.adobe.com (http://www.adobe.com).
34.1 Notes about the PDFIN filter

Filters
The application that generates the PDF file can encode parts of the information to
compress it or to convert it to a portable ASCII representation. This information
must be decoded using the corresponding decoding filter:
• ASCIIHexDecode
• ASCII85Decode
• LZWDecode
• FlateDecode
• RunLengthDecode
• CCITTFaxDecode

Chapter 34 PDFIN filter
• JBIG2Decode
• DCTDecode
• JPXDecode
Note: The Crypt filter is not supported.
Security handlers
The PDF standard security handler enables access permissions and passwords to be
specified for a document.
Documents using the standard security handler have a version (0, 1, 2, 3, or 4) and
revision (2, 3, or 4) specification. Only documents using version 1 or 2, and revision
2 or 3, are supported. In addition to the standard security handler, applications can
also use other types of security handlers. This type of security handlers is not
supported.
Passwords
• Owner password. Enables full access to the document.

• User password. Enables access to the document.
Access permissions
Access permissions are specified in the form of flags. There are several types of
access permissions, for example, permission to modify or print a document. If
any permission flag in the PDF input document is set to "do not allow", and if
the correct Owner password is not specified in the PDFIN filter, the document
will be rejected. If the correct Owner password is specified in the PDFIN filter,
the document will not be rejected, and StreamServer will have full access
permissions.
Line Cap Style

The line cap style specifies the shape used at the ends of open sub-paths (and
dashes, if any).
The output always uses a projecting square cap. This means the stroke continues
beyond the endpoint of the path for a distance equal to half the line width and is
then squared off.
Line Join Style

The line join style specifies the shape used at the corners of paths that are stroked.
The output always uses a miter join. This means the outer edges of the strokes for
the two segments are extended until they meet at an angle.

34.1. Notes about the PDFIN filter
Line dash patterns

Line dash patterns control the pattern of dashes and gaps used to stroke paths.
The PDFIN filter can only handle two values for a dash pattern.
CIE-based color spaces

Colors can be specified independently of the characteristics of a particular output
device. The PDFIN filter does not preserve these colors as calibrated. The colors are
converted to device colors using a default method.
Types
CalGray, CalRGB, Lab, and ICC-Based.
Special color spaces

Enables patterns, color mapping, separations, high-fidelity, and multitone color.
Objects filled with patterns are always filled by a solid color. Indexed, Separation,
and DeviceN colors are converted to their underlying color space (typically CMYK
or RGB).
Types
Pattern, Indexed, Separation, and DeviceN.
Overprint control (overprinting)

Not supported.
Antialias
Not supported.
Patterns
Not supported. The painted area will be filled by a solid color.
Transformations
Translation, rotation, scaling, and skewing of graphics.
Images and text can only be scaled and rotated. Some rotations might not be
detected due to round off errors in the PDF. Scaled line graphics is output as a scaled
box. Other transformations are applied to the corners of the object. This means the
output from the PDFIN filter loses the transformation property. For example, a
rotated box is converted to a polygon without rotation. Typically, this means that an
object that is transformed in the input is not transformed in the output from the
PDFIN filter.

Masked images
Masked images are converted to regular images. Transparent areas are filled in with
white.
Inline images
Some PDF input documents may lose image data.
PostScript XObjects
Graphics objects that contains a fragment of PostScript code are ignored.
Optional Content
Refers to sections of PDF documents that can be selectively viewed or hidden.
Optional content is not included in the output from the PDFIN filter.
Image transparency
Transparency groups are not supported. Objects in a transparency group do not
appear in the output from the PDFIN filter.
Text rendering modes

Stroking, filling, and clipping of text. Only mode 0 (fill text) is supported. Text
appears with a solid fill color and no outline. No clipping is performed.
Text knockout
If disabled, overlapping glyphs composites with one another. This is a transparency
group feature, and is not supported.
Text-showing
Shows/repositions text on the page. The PDFIN filter cannot include embedded fonts
in the LXF for later display. If a font is not available on the host, a generic font is be
used instead.
A workaround is to ensure you have all fonts available, and possibly map the font to
a Windows font using the font mapping table.
Composite fonts
Glyphs are obtained from a CIDFont object. The PDFIN filter can only handle
Unicode glyphs that fit in 16 bits.
Bidirectional text (Arabic and Hebrew) in visual order

Bidirectional text in visual order must be reordered to logical order before it can be
processed by StreamServer. This is not supported by the PDFIN filter.

34.1. Notes about the PDFIN filter
Viewer preferences
Not supported.
Links
URLs and links to other pages in a document or to other documents are not
supported.
Bookmarks
Not supported.
Thumbnails
Not supported.
Page labels
Page labels, for example displayed in the table of contents, are not supported.
Articles
Sequences of content that are logically connected but not physically sequential. This
is not supported by the PDFIN filter.
Presentations
Slide-shows (automatic or user controlled) are not supported.
Sub-page navigation
Navigation between different stages of the same page, for example switching bullet
points on and off, is not supported.
Annotations
Not supported.
Actions
Not supported.
Interactive forms
Not supported.
Digital signatures
Not supported.

Ligatures
Not supported.
Vector images
Not supported.
Font kerning
Not supported.
Opacity
Not supported.
Interactive objects
Not supported.
Shading
Only axial shading is supported.
Soft Mask
Not supported.
Custom color profiles

Not supported.
Embedded JavaScript
Not supported.
Embedded fonts
Different embedded fonts with the same name is not supported.

34.2. Configuring the PDFIN filter
34.2 Configuring the PDFIN filter

The procedure for configuring a PDFIN filter is the same as for all other types of
filter chain filters. If you want to load a PDF file as a sample in the PreformatIN tool,
you must also configure the PDFIN filter settings. See Section 18.1 “Loading and
adjusting samples” in OpenText Communications Center Enterprise - Event tools
Configuration Guide (CCMEVT-CGD) for information about how to load samples.
Settings
• OwnerPassword
The password to enter if the PDF input document is protected by an owner
password.
• UserPassword
The password to enter if the PDF input document is protected by a user
password.
• Font Mapping File Name
A mapping table where PDF font names are mapped to Windows font names.
See The font mapping table on page 591.
The mapping table must be included in the same resource set as the filter chain
(that includes the PDFIN filter).
• SDF binary output
Select Yes to deliver the output from the filter in binary format.
Select No to deliver the output from the filter in XML based LXF format.
• Produce output even when error occurs
Specify whether you want the PDFIN filter to create output even if an error
occurs.
• Consolidate separate text labels when possible
Specify whether you want the PDFIN filter to consolidate text fragments in the
LXF output. See “Consolidating text” below.
• Use Windows fonts when available
Specify whether to use fonts in the Windows fonts folder.
If enabled, StreamServer will first search for fonts in the Windows fonts folder
and then, if a font is not found, in the data\fonts folder in the working
directory.
If disabled, StreamServer will only search for fonts in the data\fonts folder.
This will enhance performance if the input consists of large volumes of small
PDF files. Note that you must make sure all used fonts are included in the export.
See also “Font handling” on page 590.
• Embed fonts

Specify whether to embed fonts in the LXF output from the PDFIN filter.
• No – Do not embed any fonts.
• Only missing fonts – Embed fonts that are missing on the machine where
you run the PDFIN filter.
• All fonts – Embed all fonts.
Consolidating text
When the Consolidate option is disabled, each paragraph section in the PDF is by
default converted to several text fragments in the LXF output from the PDFIN filter.
Figure 34-1: Consolidation option disabled.
When the Consolidate option is enabled, each line of text in the PDF is consolidated
into the same text fragment in the LXF output from the PDFIN filter.
Figure 34-2: Consolidation option enabled.
34.3 Font handling

The fonts in the PDF input file are referenced by PDF specific font names. These font
names must be mapped to Windows font names, which in most cases is done
automatically. To avoid font problems, do the following before you use the PDFIN
filter:
• Make sure all fonts used in the PDF document are installed on the machine
where you run the PDFIN filter.
• Add the font mapping table pdfinfontmap.tbl to the PDFIN filter
configuration.
Note: You do not have to map embedded fonts.

34.3. Font handling
The font mapping table

The font mapping table pdfinfontmap.tbl should be imported to the resource
set that includes the PDFIN filter. The table is located in the following directory
relative to the Communications Center installation directory:
Applications\StreamServer\<version>\Common\Modules\Filters
This table contains mappings for the most common PDF font names to Windows
font names. The font mapping entries have the following syntax:
"PDF font name" TAB "Windows font name" [,Bold,

ItalicWeght<value> <Embed>]
• Weight <value> – An exact value of the boldness.

• <Embed> – one of the following:
• EmbedNo – Never embed the font.

• EmbedMissing – Embed font when it is not available on the machine
where the PDFIN filter is installed.
• EmbedAlways – Always embed the font.
Example 34-1: pdfinfontmap.tbl sample
...
"OCRA-Alternate" "OCRA Alternate"
"OCRB" "OCRB"
"OCRB-Alternate" "OCRB Alternate"
"MICR" "MICR"
"HelveticaNeue-UltraLight" "Helvetica 25 UltraLight"
"HelveticaNeue-UltraLightItal" "Helvetica 25 UltraLight,
Italic"
"Bodoni-Bold" "Bodoni, Bold Weight900
EmbedMissing"
...
To display the fonts used in the PDF document
1. Open the PDF document in Adobe® Reader®.
2. Select File > Document Properties > Fonts to display the fonts used in the
document.
3. Depending on the version of Adobe® Reader®, you may have to click List All
Fonts to display all fonts used in the document, and not only the fonts used on
the current page.
All PDF font names are now displayed. You must make sure all corresponding
Windows fonts are installed.

To add the font mapping table to the filter configuration
1. Open the PDFIN filter in the Filter Chain editor.
2. In Font Mapping File Name, select the pdfinfontmap.tbl resource.
To verify that all fonts are mapped correctly

Run the Project and examine the log. If all fonts are mapped correctly, no error
messages are displayed in the log. If a font is not mapped correctly, it is
displayed as (4132) <pdf font> not found in the system. In this case, you
must make sure the corresponding Windows font is installed, and then map the
PDF font to the Windows font in the pdfinfontmap.tbl resource. See The font
mapping table on page 591.
Example 34-2: Log showing that all fonts are mapped correctly.
...
(4130) PDFIN: Starting conversion...
(4131) PDFIN: Starting normalization...
(4131) Producer: StreamServer 5.0.0 Build x.
(4130) PDFIN: Conversion completed successfully.
...
Example 34-3: Log showing that the PDF font HelveticaNeue-Light is

not mapped correctly.
...
(4130) PDFIN: Starting conversion...
(4131) PDFIN: Starting normalization...
(4131) Producer: StreamServe StreamServer 5.0.0 Build x.
(4132) HelveticaNeue-Light font not found in the system.
(4130) PDFIN: Conversion completed successfully.
...
In this example, the PDF font HelveticaNeue-Light must be mapped to the

Windows font Helvetica 45 Light. This means you must add the following
line to the pdfinfontmap.tbl resource:
"HelveticaNeue-Light" "Helvetica 45 Light"
You must also make sure Helvetica 45 Light is installed.

34.4. Retrieving metadata from input documents
34.4 Retrieving metadata from input documents

The PDFIN filter extracts metadata from the PDF input file. The metadata is
automatically declared as variables (Title declared as $Title, Author declared as
$Author, etc.).
Available metadata
• Title - The title of the document.
• Author - The name of the person who created the document.
• Subject - The subject of the document.
• Keywords - Keywords associated with the document. Multiple keywords are
comma separated.
• Creator - The application that created the source file, which was converted to
PDF. For example Adobe FrameMaker®.
• Producer - The application that converted the source file to PDF. For example,
StreamServer.
• CreationDate - Date and time the document was created.
• ModDate - Date and time the document was most recently modified.
• Pageorientation - Page orientation (Portrait or Landscape).
• Pagemedia - Page media (A4, Letter, etc.).
• Pageheight - Page height in millimeters.
• Pagewidth - Page width in millimeters.
You can use these variables directly in scripts, Processes, etc. For example, if you
want to use the metadata key Pageorientation in a script, you have to include the
variable $pageorientation.

Part 6
Codepage management
Chapter 35
About code pages and Unicode support
The Unicode standard provides a code point for every character in modern use
worldwide. It enables plain text data to be transported through different platforms,
systems, and programs without corruption. A code page is a coded character set, in
which each character is assigned a unique code within the Unicode code space. Code
pages usually cover only a small subset of the Unicode characters. For more
information about the Unicode standard, see http://www.unicode.org.
35.1 Code pages and Unicode support in

Communications Center
StreamServer and Communications Center tools support the following Unicode
encoding schemes:
• UTF-8 (with and without BOM)
• UTF-16
• UTF-16BE
• UTF-16LE
How StreamServer handles character encoding

Internally, StreamServer handles all data in the UTF-16 encoding form. This
means input data must be converted to UTF-16 before StreamServer starts
processing the data. When StreamServer has finished processing the data, the
output is encoded using the appropriate code page.
In order to convert the input to UTF-16, without corrupting the input data,
StreamServer must know which code page is used to encode the input data. You
must specify this when you configure your Project. You must also specify which
code page to use to encode the output data.
Example 35-1: ISO 8859-15 encoded input and output.
In this example, input data is ISO 8859-15 encoded. StreamServer converts

the input data to UTF-16, processes the data, and uses ISO 8859-15 to encode
the output data before sending it to the printer.

Chapter 35 About code pages and Unicode support
Preparing the workstation environment

Before you configure your Projects in the Design Center you may have to
prepare your workstation environment with respect to the fonts and code pages
to be used, and to the language version of your operating system.
Whenever possible you should use the appropriate language version of the
operating system. For example, always try to configure a Greek Project on a
Greek operating system.
You must make sure all required fonts are available, as well as complex script
support (e.g. for Arabic or Hebrew) if needed. Consult the Microsoft®
Windows® documentation or your System Administrator for information on
how to do this.
Specifying code pages for input and output data

Code pages for the input can be specified as filters in filter chains that you add
to the input connector. A code page can also be specified for the Event, either by
using the scripting function “ConvCurrMsgToUC” in a retrieved script, or by
using lookup tables or script aliases. Code pages for the output are specified in
the output connector configuration (Platform).
See “Code pages for input data“ on page 603 and “Code pages for output
data“ on page 609.
If you do not specify a code page for the input data, StreamServer may fail to
process the data correctly. However, if input data conforms to ISO 8859-1 (Latin

35.1. Code pages and Unicode support in Communications Center
1) you do not have to specify a code page for the input. Similarly, if both the
input and output data conforms to ISO 8859-1 you do not have to specify a code
page for the output.
Bidirectional text
Plain text data that contains Arabic or Hebrew text in logical order is treated the
same way as data that contains unidirectional left-to-right text. Arabic/Hebrew
text in visual order must be reordered to logical order before StreamServer
processes the text. Output from StreamServer can also be reordered from logical
to visual order if required (e.g. Arabic text in PDF output). See “Bidirectional
text“ on page 613.
Export files from the Design Center

All configuration files included in the export from the Design Center are UTF-8
encoded.
Table files and function files

All table files and function files must be UTF-8 encoded. See “Specifying code
pages for table files” on page 611 and “Specifying code pages for function
files” on page 611.
ODBC scripting functions

The following ODBC scripting functions can be used to specify code pages when
retrieving input from an ODBC data source:
• “OdbcSetCodepage”
• “OdbcSetCodepage”
Specifying a default code page for the Design Center

You can specify a default code page for the Design Center. This code page will be
the default code page for all Projects you create. For each Project you can override
the Design Center default code page, and specify a new default code page for the
Project. When you create a code page filter for an input connector, or a code page for
an output connector, the Project's default code page is selected by default.
To specify a default code page for the Design Center
1. In the Design Center, select Tools > Design Center Settings. The Design Center
Settings dialog box opens.
2. From the Default code page drop-down list, select the appropriate code page.
To specify a default code page for a Project
1. Open the Project in the Design Center.
2. In the Project browser, right-click the top node and select Settings. The Project
3. From the Default code page drop-down list, select the appropriate code page.

Code pages supported by StreamServer

• BIG5 - Traditional Chinese, Taiwan
• CNS 11643 - Traditional Chinese, Taiwan
• cp437_DOSLatinUS - Microsoft DOS US
• cp737_DOSGreek - Microsoft DOS Greek
• cp775_DOSBaltRim - Microsoft DOS Baltic Rim
• cp850_DOSLatin1 - Microsoft DOS Latin1 (Western Europe)
• cp852_DOSLatin2 - Microsoft DOS Latin2 (Eastern Europe)
• cp855_DOSCyrillic - Microsoft DOS Cyrillic (Russia)
• cp857_DOSTurkish - Microsoft DOS Turkish
• cp860_DOSPortuguese - Microsoft DOS Portuguese
• cp861_DOSIcelandic - Microsoft DOS Icelandic
• cp862_DOSHebrew - Microsoft DOS Hebrew (Israel)
• cp863_DOSCanadaF - Microsoft DOS CanadaF (Canada French)
• cp864_DOSArabic - Microsoft DOS Arabic
• cp865_DOSNordic - Microsoft DOS Nordic
• cp866_DOSCyrillicRussian - Microsoft DOS Cyrillic (Russia)
• cp874_DOSThai - Microsoft DOS Thai
• cp932_ShiftJIS - Microsoft ShiftJIS (Japanese industrial standard)
• cp936_GBK - Microsoft GBK (Simplified Chinese)
• cp949_UnifiedHangul - Microsoft Unified Hangul (Korea)
• cp950_Big5 - Microsoft Big5 (Traditional Chinese, Taiwan)
• cp950_Big5_HKSCS-2001 - Microsoft Big5 (Hong Kong Supplementary
Character Set)
• cp1250_WinLatin2 - Microsoft Windows Latin2 (Eastern Europe)
• cp1251_WinCyrillic - Microsoft Windows Cyrillic (Russia)
• cp1252_WinLatin1 - Microsoft Windows Latin1 (Western Europe & USA)
• cp1253_WinGreek - Microsoft Windows Greek
• cp1254_WinTurkish - Microsoft Windows Turkish
• cp1255_WinHebrew - Microsoft Windows Hebrew (Israel)
• cp1256_WinArabic - Microsoft Windows Arabic
• cp1257_WinBaltic - Microsoft Windows Baltic
• cp1258_WinVietnamese - Microsoft Windows Vietnamese

35.1. Code pages and Unicode support in Communications Center
• GB2312-80 - Simplified Chinese

• IBM CP 37 - Common Europe EBCDIC
• IBM CP 256 - IBM Netherlands EBCDIC
• IBM CP 273 - Austria/Germany EBCDIC
• IBM CP 277 - Denmark/Norway EBCDIC
• IBM CP 278 - Finland/Sweden EBCDIC
• IBM CP 280 - Italian EBCDIC
• IBM CP 284 - Spanish EBCDIC
• IBM CP 285 - UK EBCDIC
• IBM CP 297 - French EBCDIC
• IBM CP 423 - Greek EBCDIC
• IBM CP 424 - Hebrew EBCDIC
• IBM CP 500 - International EBCDIC
• IBM CP 852 - Latin 2 PC-DATA
• IBM CP 870 - Latin-2 EBCDIC
• IBM CP 875 - Greek EBCDIC
• IBM CP 1026 - IBM Turkey Latin-5
• IBM CP 1140 - US-Canada-Euro EBCDIC
• IBM CP 1141 - Germany-Euro EBCDIC
• IBM CP 1142 - Denmark-Norway-Euro EBCDIC
• IBM CP 1143 - Finland-Sweden-Euro EBCDIC
• IBM CP 1144 - Italy-Euro EBCDIC
• IBM CP 1145 - Spain-Euro EBCDIC
• IBM CP 1146 - UK-Euro EBCDIC
• IBM CP 1147 - France-Euro EBCDIC
• IBM CP 1149 - Icelandic-Euro EBCDIC
• ISO 8859-1 - Western Europe
• ISO 8859-2 - Eastern Europe
• ISO 8859-3 - Southern Europe, Malta
• ISO 8859-4 - Northern Europe, Baltic countries, Greenland
• ISO 8859-5 - Cyrillic (Russia)
• ISO 8859-6 - Arabic
• ISO 8859-7 - Greek

• ISO 8859-8 - Hebrew

• ISO 8859-9 - Turkish
• ISO 8859-10 - Nordic
• ISO 8859-13 - Baltic Rim
• ISO 8859-14 - Celtic languages
• ISO 8859-15 - ISO 8859-1 + Euro sign and extra characters for France/Finland
• JIS 0212 - Japanese Industrial standard
• Roman-8 - HP-Roman8
• Shift-JIS - Japanese Industrial standard
• Unified Hangeul KSC5601-87 - Korean DBCS
• Unified Hangeul KSC5601-92 - Korean DBCS
• Unified Hangeul KSX1001 - Korean DBCS
• Unicode (UCS-2) - Unicode encoding schemes UTF-16, UTF-16BE, UTF-16LE
• UTF8 - Unicode encoding scheme(s) UTF-8, with or without BOM
Known limitations
The Communications Center Unicode support has some limitations:
• The MailOUT Process does not support Unicode. Instead, you must use an SMTP
(MIME) output connector and the appropriate Process.
• Do not use characters outside the ASCII range in executable scripts or for
variables.

Chapter 36
Code pages for input data
You must specify which code page the source application uses to encode the input to
StreamServer. First, you identify the code page used for encoding the input (see
“Identifying the code page used to encode input data” on page 603), then you
select this code page when you configure the code page settings for the input in the
Design Center. Where possible, use a Unicode encoding scheme for the input data.
Code pages applied per input connector

If the same code page is used for all input data received by an input connector,
you can specify a code page for the input connector. See “Specifying code pages
per input connector” on page 604.
Code pages applied per input type

If the input connector receives different types of input, and if the input types are
encoded using different code pages, you can specify one code page per input
type. See “Specifying code pages per input type” on page 605.
Retrieved script or lookup/script alias on the Event

You can use a retrieved script, or lookup/script aliases to dynamically select
which code page to use for the input to an Event. See “Dynamically selecting
code pages for the input to an Event” on page 606.
36.1 Identifying the code page used to encode input

data
Information about the code page used to encode the input data is often available
from the data source documentation or from the System Administrator. You can also
open a sample input data file in Communications Center UTF Edit to identify the
code page used.
To use UTF Edit to identify the code page
1. In UTF Edit, select Edit > Set Font.
2. From the Fonts drop-down list, select a font that supports a wide range of code
pages (e.g. Arial) and click OK.
3. Open the sample input data file.
4. Select Edit > Code Page and select a code page that displays all characters
correctly in UTF Edit.
If you cannot find the accurate code page, repeat the procedure with another font. If
you still cannot find the accurate code page, you must install a more suitable font.

Chapter 36 Code pages for input data
36.2 Specifying code pages per input connector

If the same code page is used for all input data received via an input connector, you
can specify the code page when you configure the input connector in the Platform.
To specify the code page
1. Create a filter chain, or use an existing filter chain.
2. Open the filter chain.
3. In the filter chain editor, right-click the flow bar and select Add Filter >
Codepage Filter. A new code page filter is added to the flow bar.
4. From the Code page drop-down list, select the appropriate code page.
5. Save the filter chain and close the filter chain editor.
6. Activate the generic layer in the Platform view.
7. In the Platform view, double-click the input connector. The Input Connector
8. Click the Filter Chain icon and browse to and select the filter chain that contains
the code page filter.
To specify the byte order for UTF-16 encoded data
For the UTF-16 encoding schemes, each character code unit is represented by two
bytes. When you select UTF-16 as code page, you must also specify how the bytes
are ordered for each code unit – most significant byte first or last.
• From the Byte order drop-down list, select the appropriate option:
• Most significant byte first (Big Endian) - When the input is encoded using
the encoding schemes UTF-16BE (big endian without byte order mark) or
UTF-16 (big endian with or without byte order mark)
• Most significant byte last (Little Endian) - When the input is encoded using
the encoding schemes UTF-16LE (little endian without byte order mark) or
UTF-16 (little endian with byte order mark.
Example 36-1: Code page filter connected to the input connector

(Platform).
In this example, input data received via the input connector is ISO 8859-15
encoded. A code page filter with the code page ISO 8859-15 is connected to
the input connector.

36.3. Specifying code pages per input type
36.3 Specifying code pages per input type

If an input connector receives different types of input (XML, page formatted, etc.),
and if the input types are encoded using different code pages, you can specify one
code page per input type.
To specify the code pages
1. Create a filter chain, or use an existing filter chain.
2. Open the filter chain.
3. In the filter chain editor, right-click the flow bar and select Add Filter >
Codepage Filter. A new code page filter is added to the flow bar.
4. From the Code page drop-down list, select the appropriate code page.
5. Save the filter chain and close the filter chain editor.
6. Repeat Step 1 through Step 5 for each input type and code page.
7. In the Project browser, right-click the Project node and select Project Export
Settings. The Project Export Settings dialog opens.
8. Select the InputAnalyzer tab.
9. In the Available connectors list, select the connector.
10. For each input type in the Input Analyzer settings list, click the Select a Filter
Chain icon and browse to and select the filter chain that contains the code page
filter for the input type.
Note: If you connect a code page filter to the connector in both the Platform
and in the Project Export Settings dialog, StreamServer will not start.
• From the Byte order drop-down list, select the appropriate option.

Chapter 36 Code pages for input data
• Most significant byte first (Big Endian) - When the input is encoded using
the encoding schemes UTF-16BE (big endian without byte order mark) or
UTF-16 (big endian with or without byte order mark)
• Most significant byte last (Little Endian) - When the input is encoded using
the encoding schemes UTF-16LE (little endian without byte order mark) or
UTF-16 (little endian with byte order mark).
Example 36-2: Code page filters in the Runtime configuration.
In this example the input connector receives ISO 8859-15 encoded page
formatted data, and ISO 8859-2 encoded XML formatted data. A code page
filter with the code page ISO 8859-15 is connected to the PageIN branch, and
a code page filter with the code page ISO 8859-2 is connected to the XMLIN
branch.
36.4 Dynamically selecting code pages for the input

to an Event
You can use lookup/script aliases or retrieved scripts to dynamically select the
appropriate code page for the input to an Event.
Prerequisites
• The input data must be represented by single-byte characters.

• No code page filter is added to the input connector that receives the input data.
To select code pages using a retrieved script
• Add a retrieved script that includes the “ConvCurrMsgToUC”scripting

function to the Event.

36.4. Dynamically selecting code pages for the input to an Event
To select code pages using lookup/script aliases
1. In the Runtime configuration view, right-click the Event and select Settings.
The Runtime Event Settings dialog box opens.
2. On the Code Page tab, select Lookup or Variable and specify the alias settings.
See “Using aliases” on page 61 for information about alias selection methods.
Lookup table syntax
<key value> <code page>
Comments:
• Use TAB to separate <key value> and <code page>.

• Use quotation marks if <key value> contains white spaces.
• <code page> must be a name listed in “Code pages supported by
StreamServer” on page 600.
Example 36-3: Lookup table
"Western Europe" ISO 8859-1

"Eastern Europe" ISO 8859-2
Turkish ISO 8859-9
Example 36-4: Code page selection using a lookup table.
In this example the PageIN Event receives both ISO 8859-15 and ISO 8859-2
encoded input. The following lookup table is used to dynamically select the
appropriate code page:
Western ISO 8859-15

Eastern ISO 8859-2

Chapter 37
Code pages for output data
The output can inherit the code page specified for the input, or you can specify a
new code page for the output. The code page you specify must be supported by the
output device (e.g. a printer).
To specify a code page for the output
2. In the Platform view, double-click the output connector. The Output Connector
3. Click the Code page icon and select Inherit code page or select the appropriate
code page from the Code page drop-down list. Select Inherit code page if you
want to use the same code page for both input and output, and select a code
page from the drop-down list if you want to select a different code page for the
output. Note that the code page must cover at a minimum all the characters
covered in the code page for the input.
Dynamically selecting code pages for the output

You cannot apply scripting or aliases to the output in order to dynamically
select code pages. However, if you specify dynamic selection of code pages for
the input, and select Inherit code page for the output, the code pages for the
output will be dynamically selected as well.
• From the Byte order drop-down list, select Most significant byte last (Little
Endian) or Most significant byte first (Big Endian). The byte order to select
depends on the application that receives the output.
To add a byte order mark to UTF-8 and UTF-16 encoded data
• Select Add byte order mark if you want to add a byte order mark at the
beginning of a UTF-16 or UTF-8 encoded output file. The application that
receives the output can use this byte order mark to automatically determine the
encoding (UTF-8 or UTF-16 encoding scheme) and the byte order used for the
data in the UTF-16 encoding scheme.

Chapter 38
Code pages for support files and logs
Specifying code pages for table files

All table files used in the Design Center must be UTF-8 encoded. In order to make
StreamServer interpret the table file as UTF-8 encoded, the file must begin with the
following text string:
//!codePage UTF8!
Example 38-1: UTF-8 encoded table file.
//!codePage UTF8!
ENG Printer_1
SWE Printer_2
Table files created from within a resource set

If you create a new table file from within a resource set, the encoding is
automatically set to UTF-8. When you open the table file in the resource editor,
the code page information string //!codePage UTF8! is added by default.
Table files created using external text editors

You can create a table file using an external text editor, and then import the table
file to a resource set. Before you import the file you must:
• enter //!codePage UTF8! as the first line of text

• save the file UTF-8 encoded.
Table files in upgraded Projects

If you are upgrading Projects prior to 4.1 you must modify the table files. Before
you upgrade you must:
• enter //!codePage UTF8! as the first line of text

Specifying code pages for function files

All function files used in the Design Center must be UTF-8 encoded. In order to
make StreamServer interpret the function file as UTF-8 encoded, the file must begin
with the following text string:
CodePage UTF8

Chapter 38 Code pages for support files and logs
Example 38-2: UTF-8 encoded function file.

CodePage UTF8
func timetotal()
...
Function files created from within a resource set

If you create a new function file from within a resource set, the encoding is
automatically set to UTF-8. When you open the function file in the resource
editor, the code page information string CodePage UTF8 is added by default.
Function files created using external text editors

You can create a function file using an external text editor, and then import the
function file to a resource set. Before you import the file you must:
• enter CodePage UTF8 as the first line of text
Function files in upgraded Projects

If you are upgrading Projects prior to 4.1 you must modify the function files.
Before you upgrade you must:
• enter CodePage UTF8 as the first line of text

Chapter 39
Bidirectional text
Bidirectional text consists of mainly right-to-left text with left-to-right nested

segments, or vice versa. In languages involving bidirectional text (StreamServer
supports Arabic and Hebrew), the general text flow proceeds horizontally from right
to left, but numbers are written from left to right. In addition, embedded addresses,
acronyms, and quotations in a left-to-right language are also written from left to
right.
Logical and visual order
Bidirectional text can be visually or logically ordered:

• Logical order – the characters are ordered in the same way that they have been
keyed. In this case, it does not matter if the text is Arabic, Hebrew, or Latin –
direction has no meaning.
• Visual order – the characters are ordered as they are displayed on a screen,
printed page, or other medium.
Visually ordered input must be reordered to logical order before StreamServer

processes the text. See “Reordering visually ordered input” on page 613. Output
from StreamServer can be reordered to visual order if required. See “Reordering
output to visual order” on page 614.
39.1 Reordering visually ordered input

Visually ordered input must be reordered to logical order before StreamServer
processes the text. You can reorder the input for the following Events:
• PageIN - reordering is applied per line. See “Reordering page formatted input”
on page 613.
• StreamIN - reordering is applied per field. See “Reordering field and record
based input” on page 614.
Input to all other Events must be logically ordered.
Reordering page formatted input

You can enable reordering of the input when you configure the code page settings
for the input. See “Code pages for input data“ on page 603.
To reorder the input using a code page filter
• From the Input order drop-down list, select Visual order (Arabic and Hebrew
only).

Chapter 39 Bidirectional text
To reorder the input using aliases (Runtime Event settings)
• From the Input order drop-down list, select Visual order (Arabic and Hebrew
only).
To reorder the input using a retrieved script
• In ConvCurrMsgToUC(codepage,visual_order), set visual_order to 1. For

example:
ConvCurrMsgToUC("UTF8",1);
Reordering field and record based input

You can enable reordering of the input when you configure the input connector.
To reorder the input
• Enter the ReorderRTLField keyword to the input connector. See “Using custom
commands and keywords” on page 65 for information on how to add custom
commands and keywords to a connector.
Note: You must not enable reordering using code page filters, aliases, or
retrieved script for input received via this connector if you use this keyword.
39.2 Reordering output to visual order

StreamServer processes text in logical order. If required, the output can be reordered
to visual order. You can reorder the output from the following Processes:
• PageOUT - reordering is applied per paragraph. See “Reordering page formatted
output” on page 614.
• StreamOUT - reordering is applied per field. See “Reordering record based
output” on page 615.
Reordering page formatted output

Page formatted bidirectional text displayed on the screen or as printed output is
normally displayed in visual order. Some output devices reorder the text
automatically, which means the output from StreamServer must be in logical order
when it is sent to such a device. The list below shows how to order the output when
using different types of drivers.
• PCL drivers - visual order.
• Postscript drivers - visual order.
• GIF, BMP, etc. - visual order.
• RTF - logical order.
• PDF - visual order.

39.2. Reordering output to visual order
• Windows driver - logical order.
Visually ordered page formatted Arabic text is in addition shaped – the glyphs for
the letters are cursively joined, lam-alif ligatures are formed, and mirror characters
(e.g. parentheses and brackets) are mirrored. Contextual shaping must therefore be
performed on the text in order to create the correct sequences of glyphs. Shaping is
automatically performed if you enable reordering of page formatted output. This
functionality is restricted to be without vowel marks.
Note: Visually ordered Arabic PCL output must be UTF-8 encoded.
To reorder the output per output connector
3. Click the Code page icon and select Reorder BiDi output in visual order.
To reorder the output from mirrored PageOUT layouts
• If you mirror PageOUT output, reordering is enabled automatically. See Section

3.13 “Mirroring page layouts” in OpenText Communications Center Enterprise -
Process Tools Configuration Guide (CCMPTO-CGD) for information on how to
mirror page layouts.
Reordering record based output

Record based output should normally be in logical order. If required, the order of
the output can be changed to visual order.
To reorder the output

3. Click the Code page icon and select Reorder BiDi output in visual order.

Part 7
Post-processing
Chapter 40
Document Broker
Document Broker Plus enables consolidation of documents generated by several

StreamServer applications by storing the documents in a common Document Broker
repository. The documents can be collected by any StreamServer application that has
access to the same Document Broker repository.
The figure below illustrates a scenario where two StreamServer applications store
documents in a Document Broker repository, and one StreamServer application
collects the documents.
Storing documents
To store documents in a Document Broker repository, you need a Document
Broker Plus output connector and driver. You must also specify a document
trigger for the documents.
Adding types and properties to documents

To be able to search for documents in the Document Broker repository, you
must apply types and properties to the documents. To do this, you must first
create a metadata model that includes all the properties to use, then connect the
model to the Project, and finally connect the types to the Document Broker Plus
output connector.
Collecting documents
To collect documents from a Document Broker repository you need an input
connector, a Post-processor, and a query. The query includes filters that define
which documents to collect from the Document Broker repository. This query is
delivered to the Post-processor via the input connector, and the Post-processor
uses the information in the query to collect the documents.
Post-processing documents
Documents collected from a Document Broker repository can be post-processed.
Post-processing includes sheet layout, sorting, and enveloping of documents.

Chapter 40 Document Broker
See “Sheet Layouts“ on page 661 and “Sorting and bundling“ on page 641 for
more information on post-processing features.
40.1 Document Broker concepts

Document Broker repository
The Document Broker repository is where the documents are stored. Several
domains can be connected to the same Document Broker repository. It is also
possible for each domain to be connected to separate Document Broker repositories.
If you have several domains, we recommend that you create a central Document
Broker repository which is shared by all the domains.
Figure 40-1: Multiple domains using a central Document Broker repository
Using a separate Document Broker repository for each domain is only suitable in
environments where you know that the Document Broker repository will never be
shared by StreamServer applications in different domains at any time in the future.
Connecting each domain to a separate repository limits the solution to only being
able to consolidate documents created within a particular domain.
Post-processor
A Post-processor is equivalent to a Job in a Runtime configuration. The Post-
processor retrieves documents from a Document Broker repository, and does not
include any Message configurations as the Job does.

40.1. Document Broker concepts
The Post-processor is connected to input and output connectors in the same way as a
runtime Job. The input connector collects the query that specifies which documents
to collect from the Document Broker repository, and the Post-processor uses the
query to query the Document Broker repository for documents. When the
documents are collected, StreamServer can post-process the documents (sheet
layout, sorting, bundling, etc.) and deliver the output via the appropriate output
connector.
Post-processors can be used only if documents are stored in the Document Broker
repository using the SDR for Relational Database driver. If any other driver is used
you must use a DAQ filter instead (see “DAQ filter” on page 547).
Queries
Queries contain filters based on types and properties from the metadata model, and
are used by Post-processors to query the Document Broker repository for
documents. A query specifies which documents to select, and the action to apply to
the selected documents.
For information about how to create queries, see “Creating PPQs” on page 630.

40.2 Creating a central Document Broker repository

You must create a Document Broker repository. If you have several domains, we
recommend you create a central Document Broker repository that is linked to all the
domains. Using a central Document Broker repository for all domains means you
will have one single Document Broker repository for all document broking and post
processing requirements. Having a central Document Broker repository enables you
to consolidate documents from multiple sources in different domains.
Notes
• In scenarios where a central Document Broker repository and tracking

repository are used, all the domains linked to the central Document Broker
repository must also be linked to a central tracking repository.
• You cannot connect an domain to several Document Broker repositories.
Scenario
Company ABC uses three different StreamServer applications, all running in
separate domains. Company ABC needs to consolidate the output documents
from StreamServer A and StreamServer B, and use StreamServer C to deliver the
consolidated documents to the customers. Company ABC also wants to track
top jobs.
To achieve this, a central Document Broker repository is created and a central
tracking repository is created. Both repositories are connected to all three
domains. StreamServer A and StreamServer B store the output documents in the
central Document Broker repository, and StreamServer C collects the documents
from the repository. The applications in all three domains store top job
information in the central tracking repository.
To create a central Document Broker repository
1. In Control Center, right-click the Repositories node and select New

Repository. The Repository dialog box opens.

40.3. Storing documents in a Document Broker repository
2. From the Type drop-down list, select Document Broker Repository.
3. Enter the Name and a Description of the Document Broker repository and
click OK. The Configuration dialog box opens,
4. Configure the database settings for the repository and the connection
settings to access the repository.
5. Right-click the new Document Broker repository node and select Create
Database. The Create Database dialog box opens.
6. Select the appropriate Operation (Create now etc.) and click Start.
To link a Document Broker repository to domains
1. Right-click the repository node and select Link domain.
2. Select the domains to link the repository to, and click OK.
Related documentation
• See OpenText Communications Center Enterprise - System Administration Guide
(CCMSYS-AGD) for information about creating and tracking repositories.
40.3 Storing documents in a Document Broker

repository
To store documents in a Document Broker repository you need a Document Broker
Plus output connector. You also need to apply types from the metadata model to the
Document Broker Plus output connector.
Document Broker Plus output connector

You must use the Document Broker Plus output connector to store documents
in a Document Broker repository. You must create a document trigger in order
to store the output as documents in the Document Broker repository.
Compression of the documents (enabled by default) reduces the size of the
Document Broker repository. For smaller jobs it can be more efficient not to
compress documents. You specify whether to enable compression in the runtime
output connector settings (Device Driver Settings tab at Job Begin).
Applying types to the Document Broker Plus output connector

You must apply types from the metadata model to the Document Broker Plus
output connector. In the metadata model for your tenant, you must create types
and add properties to the types. The metadata model must include all the
properties you want to add to the stored documents. You then connect the
metadata model to the Project, and finally connect the types to the Document
Broker Plus output connector.
The properties are used as search criteria in the Document Broker repository,
and to sort and bundle documents collected from the Document Broker
repository.

Storing documents – overview
Figure 40-2: Overview
1. Input is received via an input connector.

2. StreamServer processes the input data.
3. Types are applied to the documents.
4. StreamServer stores the documents in the Document Broker repository.
40.3.1 Configuring types and properties

When you store documents in the Document Broker repository you must apply
types from the metadata model to the documents. The properties in the types are
used as search criteria in the Document Broker repository, and to sort and bundle
documents collected from the Document Broker repository.
To be able to add properties to the documents, you must first create a metadata
model with the properties to store in the Document Broker repository (in the
metadata model, the properties are arranged into containers called types). The
metadata model must contain all properties to add to the documents. The metadata
model must then be connected to the Project and the appropriate types must be
applied to the Document Broker Plus output connector. For more information about
metadata models, see “Metadata management” on page 361.
40.3.2 Configuring a Document Broker Plus output connector

To be able to store documents in a Document Broker repository you must first create
a Document Broker Plus output connector. Then you connect the Process to the
Document Broker Plus output connector, specify a document trigger for the
documents, and apply types from the metadata model to the connector. You can also
configure the output connector to auto-generate a PPQ as a file and/or as a call to
another connector (see “Auto-generating PPQs” on page 638).
Prerequisites
A metadata model must be connected to the Project. See “Selecting the model for
a Design Center Project” on page 379.
Available drivers
The Document Broker Plus output connector can use the following drivers:

40.3. Storing documents in a Document Broker repository
• (No device)
• DOCX
• HTML unpaginated
• Layout
• PDF
• SDR for Relational Database
Note: To be able to use a Post-processor to collect documents (see

“Collecting documents from a Document Broker repository”
on page 627) you must use the SDR for Relational Database driver. If
you use any other driver, or no driver, you must use the DAQ filter to
collect the documents (see “DAQ filter” on page 547).
To create a Document Broker Plus output connector
1. Right-click the Platform view in Design Center and select New Output
Connector > Document Broker Plus. A new output connector is added to the
Platform view.
2. Double-click the new output connector. The Output Connector Settings dialog
box opens.
3. Activate the generic layer and click the Driver icon.
4. From the Device drop-down list, select the appropriate driver and click OK.
To create a document trigger
1. In the Runtime configuration view in Design Center, open the Runtime Output
Connector Settings dialog box for the Document Broker Plus connector.
2. Activate the generic layer and click the Document Trigger icon.
3. Enter the Document trigger variable.
To apply types from the metadata model to a Document Broker Plus output
connector
Plus connector, activate the generic layer and click the Document End icon.
TheDefine Custom Type dialog box opens.

To configure the connector to generate PPQ
Plus connector, click the Job End icon.
2. On the Device Driver Settings tab, enter a PPQ file name and/or the name of
the connector. For information about the settings on the tab, see “Connector
settings for auto-generated PPQs” on page 639.
40.3.2.1 Storing variables with the documents

Stored variables can be used for scripting and statistics after the documents are
retrieved from the Document Broker repository. To make a variable available after a
document is stored, you must store the variable with the document at either
Document Begin, Process Begin, Page Begin, or Document End.
A stored variable is only valid at the same level as it was stored. For example, a
variable stored at Document Begin is valid until Document End, whereas a variable
stored at Page Begin only is valid until the next Page Begin.
To store a variable
2. Activate the generic layer and click the Document Begin, Process Begin, Page
Begin, or Document End icon.
3. Select the Stored Variables tab and click . The Add Stored Variable dialog
box opens.
4. Enter the variable and click OK. The new variable is added to the Stored
Variables list.
40.3.2.2 Storing Document Broker Plus blobs on a disk

By default, Document Broker Plus blobs are stored in the Document Broker
repository. In scenarios where you run Document Broker Plus with a few
StreamServer applications on a single computer, you can improve performance by
storing the Document Broker Plus blobs as files on a disk. For more information, see
“Advanced tab” on page 286.
Deleting Document Broker Plus blob files from a disk

To delete the blob files from the disk, you must run one of the following types of
queries:
• delete
• process and delete

40.4. Collecting documents from a Document Broker repository
40.3.3 Storing only documents from successful jobs

By default, each document is stored in the Document Broker repository as it is
created. You can change this default behavior and only store documents in the
Document Broker repository if the entire job is processed successfully. This prevents
a StreamServer application from storing duplicates when it retries to process a job
that failed.
The default settings for storing successful jobs in a Document Broker repository have
changed in version 16. Now each document is stored as it is created, which means
duplicate documents can be stored if a job fails and is retried from the input queue.
In prior versions, the default was to only store documents in the Document Broker
repository if the entire job was processed successfully.
To change the default behavior and only store documents from successful jobs,
enable the Transactional support option on the input queue. For more information
about transactional support, see “Enabling transactional support” on page 244.
40.4 Collecting documents from a Document Broker

repository
You need the following Design Center components to collect documents from a
Document Broker repository:
• Query
• Input connector for the query
• Post-processor or DAQ filter
Query
The query is used by the Post-processor or DAQ filter to query the Document
Broker repository for documents. The query specifies which documents to select,
and the action to apply to the selected documents.
Input connector
The input connector collects the query. You can use different types of input
connectors to collect queries. For example, a Directory input connector that
collects the query from a specific directory.
Post-processor
The Post-processor executes the query and collects the documents from the
Document Broker repository.
Note: To be able to use a Post-processor the documents must be stored

using the SDR for Relational Database driver. If any other driver is used
you must use the DAQ filter instead (see “DAQ filter” on page 547).
Post-processing
StreamServer can post-process the collected documents. Post-processing
includes sheet layout, sorting, and bundling of documents. See “Sheet Layouts“

on page 661 and “Sorting and bundling“ on page 641 for more information
about post-processing features.
Collecting documents using Post–processors – overview
Figure 40-3: Overview
1. The Post-processor receives a query via an input connector.

2. The Post-processor uses the query to query the Document Broker repository
for documents.
3. The Post-processor collects the documents from the Document Broker
repository, and StreamServer post-processes the collected documents.
4. StreamServer delivers the documents via the appropriate output connector.
40.4.1 Creating queries for a Post-processor

The query is used by the Post-processor to query the Document Broker repository
for documents. The query specifies which documents to select, and the action to
apply to the selected documents.
For information about how to create queries, see “Creating PPQs” on page 630.
40.4.2 Configuring input connectors to collect queries

You can use several types of standard input connectors (Directory, HTTP, etc.) to
collect queries when using a Post-processor. Use standard procedures to configure
the connector to collect the queries in this case. You can also use a Post-processor
scheduler input connector (see “Using a Post-processor scheduler input connector”
on page 628).
For information about how to collect queries when using a DAQ filter, see “DAQ
filter” on page 547.
Using a Post-processor scheduler input connector

You can use a Post-processor scheduler input connector to collect the query. The
query must be included in a resource set connected to the platform.
Creating a query resource

There is no specific resource type for queries used in Document Broker Plus.
You can use any type of text formatted resource, for example a sample resource.
See “Creating PPQs” on page 630 for information about how to create queries.

40.4. Collecting documents from a Document Broker repository
To configure a Post-processor scheduler input connector
1. Create a query resource.
2. Create a Post-processor scheduler input connector.
3. Open the Input Connector settings dialog box (physical layer).
4. Browse to and select the Post-processor query you created in Step 1.
5. Schedule when to collect the query (e.g. once a month).
6. Click OK.
How the Post-processor scheduler input connector works

The Post-processor scheduler input connector is similar to a Directory input
connector. It periodically scans a resource directory in the StreamServer
application's working directory for input. For example, if you use a Sample
resource as query, the connector scans the Sample resource directory for input.
When you export and deploy a Project, the query is added to the resource
directory. The Post-processor scheduler input connector collects, but does not
delete, the query as soon as the StreamServer application is started. The Post-
processor scheduler input connector then waits until the next collection event
(specified by the Schedule property), collects the same query once again, waits
until the next collection event, collects the query and so on.
40.4.3 Configuring Post-processors

A Post-processor collects documents from a Document Broker repository, and does
not include any Message configurations. The Post-processor retrieves a query via an
input connector, executes the query, collects the documents from the Document
Broker repository and delivers the documents via the appropriate output connector.
Output connector limitations

The output mode for the output connector must be Document or Job. The
following connector types cannot be used as Post-processor output connectors:
• MailOUT-dependent
• Document Broker Plus
Process links
A Post-processor always includes a default Process link, which is used as the
connection point to the output connector. To enable Process specific or Page
specific output connector settings, you must add a new Process link to the Post-
processor. This Process link must be linked to the Process that stored the
corresponding document in the Document Broker repository.

Figure 40-4: Post-processor with default and specific process links
To create a Post-processor
1. Right-click the Runtime configuration view and select New Post-processor.

A new Post-processor is added.
2. Rename the Post-processor.
3. Connect the appropriate input and output connectors to the Post-processor.
To add a new Process link
1. Right-click the Post-processor and select Add Process Link.
2. Browse to and select the appropriate Message and Process (you can multi-
select Processes). The new Process links are added to the Post-processor,
and connected to the same output connector as the Default Process link.
40.5 Creating PPQs

You can create PPQs using any editor or application that generates XML output, or
auto-generate PPQs while processing documents.
40.5.1 PPQ syntax

The PPQ syntax is illustrated below.
<?xml version="1.0" encoding="utf-8"?>

<s-dbs action="value" update="value">
<database>
<jobset sel="property=value">
<docset sel="filter" metainfo="filter"/>
...
</database>
</s-dbs>
• The <s-dbs> element specifies which action to apply to the selected documents.
See “Action” on page 631 and “Update” on page 632.

40.5. Creating PPQs
• The <jobset> element specifies which batch in the repository to select. See “Job
selection” on page 633.
• The <docset> element specifies which documents in the repository to select. See
“Document selection” on page 634.
40.5.1.1 Action
Use the action attribute in the <s-dbs> element to specify what to do with the
selected documents.
• process
Process the documents, but do not delete them in the repository.
• process_and_delete
Process the documents, and delete them in the repository.
• delete
Delete the documents in the repository.
Example 40-1: Action=process.
Process all documents.

<s-dbs action="process">
<database>
<docset sel="all"/>
</database>
</s-dbs>
Example 40-2: Action=process_and_delete.
Process all documents, and delete them in the repository.

<s-dbs action="process_and_delete">
<database>
<docset sel="all"/>
</database>
</s-dbs>

40.5.1.2 Update
Use the update attribute in the <s-dbs> element to specify that documents can be
processed by several parallel applications. For example, when using different
delivery channels.
• all
This is also the default behavior if the update attribute is not used.
Documents are processed by one single application at the time, which ensures
that processed documents are delivered only once.
Documents are reserved during processing, but can be processed by other
applications that use update=none. Document status during processing is
processing and after processing processed.
• none
Documents can be processed and delivered by several parallel applications.
Documents are not reserved during processing and can be processed by other
applications. Document Status is not updated and you must use the
“UpdatePPDocStatus” scripting function to update the status.
Notes
• All selected documents are processed, even if they are locked by other
applications that use update=all.
• Not applicable to action="process_and_delete".
Example 40-3: Update=all
Lock documents while processing.

<s-dbs action="process" update="all">
<database>
<docset sel="all"/>
</database>
</s-dbs>
Example 40-4: Update=none
Process all documents, even if they are locked.

<s-dbs action="process" update="none">
<database>
<docset sel="all"/>
</database>
</s-dbs>

40.5. Creating PPQs
40.5.1.3 Job selection

The <jobset sel="property=value"> sections in the PPQ specify which batch jobs
in the Document Broker repository to select.
Job property Description Examples

All Select all jobs in the repository. sel="All"
ID Select a job with either of the (JobSequenceNumber)
following:
sel="ID=2"
• JobSequenceNumber,
(numeric values) (StoredJobID)
• StoredJobID (GUID), (numeric
or string values) sel="ID="D4B5943B-76B
9-4426-906E-75316E141B42&q
uot;"
DocumentType Select jobs connected to a specific sel="DocumentType='Invoice
type defined in Describer. The '"
type can be specified by name or sel="DocumentType='98A2388
GUID. 9-62E7-
B718-8842-2607A980C851'"
The <jobset> element can enclose zero, one or multiple <docset> elements in the
PPQ, see examples below.
Example 40-5: <jobset> combined with <docset>

<database>
<jobset sel="property=value">
</jobset>
</database>
</s-dbs>

<database>
</database>
</s-dbs>

<database>
<jobset sel="property=value"/>
</database>
</s-dbs>

Operators
For a list of available operators, see Filter operators on page 634.
40.5.1.4 Document selection

The <docset sel="filter" metainfo="filter"/> sections in the PPQ specify
which documents in the Document Broker repository to select. You can use two
types of filters:
• Document property filters (sel="filter"). See “Creating document property
filters” on page 635.
• Property filters (metainfo="filter"). See “Creating property filters”
on page 637.
Filter operators
You can use the operators shown in the table below when you create document
property filters and property filters.
=
Equal to. Numeric and string values. For example:
metainfo="CustomerName="Eva Farrel""
< (<)
Less than. Numeric and string values. For example:
metainfo="CustomerNumber<1020"
> (>)
Greater than. Numeric and string values. For example:
metainfo="CustomerNumber>1020"
!=
Not equal to. Numeric and string values. For example:
metainfo="CustomerNumber!=1020"
>= (>=)
Greater than or equal to. Numeric and string values. For example:
metainfo="CustomerNumber>=1020"
<= (<=)
Less than or equal to. Numeric and string values. For example:
metainfo="CustomerNumber<=1020"
+
Addition. Numeric and string values.
-
Subtraction. Numeric values only.

40.5. Creating PPQs
*
Multiplication. Numeric values only.
/
Division. Numeric values only.
AND
Logical AND. For example:
metainfo="CustomerNumber<=1020 AND Country=SWE"
OR
Logical OR. For example:
metainfo="Country=FIN OR Country=SWE"
40.5.2 Creating document property filters

You can use the sel attribute in the <docset> element to create a filter that uses
document properties as filter criteria.
Document Description Examples

property
All Select all documents in the sel="All"
repository.
ID Select a document with a specific (DocumentAbstractionID)
DocumentAbstractionID or
DocSequenceNumber. sel="ID='8FA23889-7BE7-
B743-8842-2607A980C851'"
(DocSequenceNumber)
sel="ID=2"
Priority Select documents with a specific sel="Priority=50"
priority.
CreationTime Select documents created a sel="CreationTime>
specific date and time. 2010-03-29T09:30:00"
ProcessTime Select documents updated a sel="ProcessTime>
specific date and time. 2010-03-29T09:30:00"
Error Select documents processed with (Documents processed without
or without errors. errors)
Possible values are 0 and 1. sel="Error=0"
(Documents processed with errors)
sel="Error=1"
Status Select documents of a specific sel="Status=Stored"
Status.

Document Description Examples

property
State Select documents of a specific sel="State=Submitted"
State. sel="State=1"
DocumentType Select documents connected to a sel="DocumentType='Invoice
specific type defined in Describer. '"
The type can be specified by name sel="DocumentType='98A2388
or GUID. 9-62E7-
B718-8842-2607A980C851'"
PageCount Select documents that contain a sel="PageCount>=10"
specific number of pages.
Example 40-6: sel=all.
Document property filter selecting all documents in the repository.

<database>
<docset sel="all"/>
</database>
</s-dbs>
Date and time format and keywords

Date values must follow the ISO 8601 standard, see an example below.
Date and time
YYYY-MM-DDThh:mm:ss
For example: 2010-05-20T13:04:25

The following keywords can be used together with the CreationTime and
ProcessTime properties.

40.5. Creating PPQs
Keyword Description Examples

today Select documents created or updated (Documents created today)
today or any day before today.
sel="CreationTime=toda
y"
(Documents updated
yesterday)
sel="ProcessTime=today
-1"
(Documents created five days

ago)
sel="CreationTime=toda
y-5"
now Select documents created or updated (Documents created during
during a period of hours and minutes the last four hours)
back in time.
sel="CreationTime>=
now-4"
(Documents updated during

the last hour and twenty
minutes)
sel="ProcessTime>=n
ow-1:20"
40.5.3 Creating property filters

You can use the metainfo attribute in the <docset> element to create a filter that
uses properties stored with the documents as filter criteria.
Example 40-7: Using metainfo attribute
Property filter selecting documents where property Country=SWE.

<database>
<docset metainfo="Country=SWE"/>
</database>
</s-dbs>

40.5.4 Auto-generating PPQs

When a StreamServer application processes documents to be stored in a Document
Broker repository, it can also auto-generate a PPQ. This PPQ can be used to select
and process all documents in a batch and you have the following options:
• Save the PPQ as a file for later processing of documents stored in the Document
Broker repository.
• Send the PPQ directly to an input or output connector for immediate processing.
Note: In most cases it is recommended to send the PPQ to a connector, since it

gives you more control and additional processing options. See “Scenarios for
auto-generated PPQs” on page 639.
Example 40-8: Auto generated PPQ.
This example shows an auto-generated PPQ file that will process all
documents in the stored batch with job ID=8FA23889-7BE7-
B743-8842-2607A980C851.

<database>
<jobset sel="ID='8FA23889-7BE7-B743-8842-2607A980C851'"/>
</database>
</s-dbs>
To auto generate a PPQ
2. Activate the generic layer and click the Job End icon.
3. On the Device Driver Settings tab, enter a PPQ file name and/or the name of the
connector. For information about the settings on the tab, see “Connector settings
for auto-generated PPQs” on page 639.

40.5. Creating PPQs
40.5.4.1 Scenarios for auto-generated PPQs
When to use the Job Info Connector setting
• Store, post-process and deliver – When you are using, for example, Service
Request or HTTP input connectors and want to store, post-process and deliver
the documents within the same job.
• Return information about stored documents – When you are using, for
example, Service Request or HTTP input connectors and want to return
information about what was stored to the input connector.
• Manipulate PPQ before process – When you want to manipulate the PPQ before
processing it or storing it as a file. You can, for example, send the PPQ file to an
XMLIN Event and modify it in an XMLOUT Process before it is written to a File
output connector.
• Post-process without scripting or copying files – When you want to post-
process stored documents directly, without scripting or copying files.
When to use the Job Info File setting
• Keep record of stored documents – When you only want to keep record of
documents stored by a post-processor job.
• Upgrade existing Project – When you upgrade an existing project that uses PPQ
files and do not want to change that.
40.5.4.2 Connector settings for auto-generated PPQs

You configure the connector settings for auto-generated PPQs on the Document
Broker Plus connector (the Device Driver Settings tab in the Runtime configuration).
• Job Info File

Specifies the path where to save the auto-generated PPQ, as a file, for example:
C:\strs_data\JobInfo\phone.xml
Note that all folders in the path must exist.

• Job Info Connector
Specifies the connector in the project to which the auto-generated PPQ is sent.
Only one connector can be specified and it can be an input or output connector.
You can use static text, a variable or a lookup table to specify the connector.
Note: When using input queues in the storing job, you cannot use variables
in the runtime settings of the connector receiving the PPQ. The reason is
that the PPQ is sent after job end when variables are cleared.
• Update documents when processing

• Yes – Documents are reserved and processed by one post-processor at the

time. This setting corresponds to PPQ attribute update with value all, see
“Update” on page 632.
• No – Documents can be processed and delivered by several parallel
applications. This setting corresponds to PPQ attribute update with value
none, see “Update” on page 632.
• Delete documents when processing
• Yes – Documents are processed and then deleted from the repository. This
setting corresponds to PPQ attribute action with value
process_and_delete, see “Action” on page 631.
• No – Documents are processed but not deleted from the repository. This
setting corresponds to PPQ attribute action with value process, see
“Action” on page 631.
• Selection criteria when processing
• jobset – The PPQ is generated with a <jobset sel="ID=x"> tag that uses the
job ID as main selection criteria together with a <docset sel="ID >= x AND ID
<= y"/> range.
• docset – The PPQ is generated with one <docset sel="ID=x"/> tag for each
generated document.
Note: The docset option requires more memory and has more performance
requirements than the jobset option. The docset option is only
recommended if the PPQ is modified before processing. For example, by
adding gmi tags to modify properties.

Chapter 41
Sorting and bundling
Document sorting and bundling includes:

• Sorting documents. See “Sorting documents” on page 642.
• Bundling documents and preparing the documents for enveloping. See
“Bundling” on page 644.
• Printing OMR marks on sheets. See “OMR codes” on page 650.
• Printing labels on sheets. See “Labels” on page 655.
• Sorting and bundling script functions. See “Sorting and bundling scripts”
on page 657.
Types and properties

To be able to sort and bundle documents you must first create a metadata model
that includes the properties to use as sort keys and connect this metadata model
to the Project. For more information about metadata models, see “Metadata
management” on page 361.
41.1 Asynchronous and synchronous sorting and

bundling
Documents can be sorted and bundled asynchronously as well as synchronously. In
both cases a Document Broker repository must be linked to the domain.
Asynchronous sorting and bundling

Asynchronous sorting and bundling is applied to documents that are first stored in a
Document Broker repository and then retrieved from this repository using a post-
processor. All document sorting and bundling features are enabled by default, and
can be applied to the documents retrieved from the repository.
Synchronous sorting and bundling

Synchronous sorting and bundling is applied to documents from a standard runtime
job. To be able to use synchronous sorting and bundling you must:
• Enable document sorting and bundling on the output connector. In
asynchronous mode this is done automatically when the connector is linked to
the post-processor.
• Apply custom types to the output connector, i.e. define the properties to be
available when defining keys for sorting and bundling. In asynchronous mode
this is done when storing the documents in the Document Broker repository.

Chapter 41 Sorting and bundling
Caution
The job fails and an error is logged if the input connector uses a queue
where Transactional support is enabled.
To enable document sorting and bundling on the output connector
1. Open the Runtime Output Connector Settings dialog box (generic layer) and
click the Global Settings icon.
2. On the Post-processor tab, select Enable Document Broker.
To apply custom types to the output connector
click the Document End icon.
4. Select the types that include the properties to be available when defining keys
for sorting and bundling, and then click OK.
41.2 Sorting documents

Documents must be sorted to make sure they arrive in the right order before
enveloping is applied. You can, for example, sort the documents using the zip code
as the first sort criterion and the customer number as the second sort criterion. This
will first group the documents per zip code, and then, within each zip code group,
group the documents per customer number.
Sort keys
Sorting is applied using one or more sort keys, for example zip code and
customer number as described in the example above. When you define a sort
key, you define which property to use as key and the sort order (ascending or
descending).
Defining sort keys

To enable properties to be used as sort keys
Before you can define sort keys you must select the appropriate metadata model
version and the types that include the properties to use as sort keys.
click the Job End icon.
2. On the Document Sort tab, click the icon beside the Custom type box. The
Define Custom Type dialog box opens.

41.2. Sorting documents
4. Select the types that include the properties to use as sort keys and then click
OK.
To define a sort key
2. On the Document Sort tab, click . The Add Sort Key dialog box opens.
3. Select the appropriate Metadata name and Sort order, and then click OK.
Defining sort keys using scripts

The “DeclareMetadata” script function specifies a metadata name to be used for
sorting or bundling of documents. The metadata name can then be associated with a
variable by for example using the following functions:
• “SetCurrMetadata” – sets the metadata value on the current document.
• “SetSegMetadata” – sets the metadata value on a specified document.
You can then sort the documents in the current segment by using the “SortSegDoc”
script function.
Note: If you do not use enveloping the whole input job is one segment.
Example 41-1: Job begin script

$ret = DeclareMetadata("zip", "N"; "A")
Example 41-2: Post-processor Job begin script

$doc_id = getFirstSegDoc();
while (num($doc_id)> 0)
{$zip = "1234"
$setSegMetaData($doc_id, "zip", $zip);
$doc_id = GetNextSegDoc($doc_id);}

41.3 Bundling
41.3.1 Defining mailing machines
Enveloping can be done by several mailing machines. For example one mailing
machine for documents containing up to seven sheets, a second for documents
containing 8-14 sheets and a third for documents containing more than 14 sheets.
The output job is then divided into one unit per mailing machine. If only one
mailing machine is used, the entire output job is sent to this mailing machine.
When you define a mailing machine, you must specify the name of the mailing
machine and the maximum number of sheets per envelope for the mailing machine.
Example 41-3: Using two mailing machines

In this example, two mailing machines are used: MM1 for documents
containing up to seven sheets and MM2 for documents containing more than
seven sheets. The output file path (see Paths to mailing machines
on page 644) is specified as .\Out\%{TARGET}\document.pdf
When StreamServer runs the job, the output job is divided into two units:
• One unit for all documents that contain less than eight sheets. These
documents are sent in a pdf file to the target folder for MM1:
.\Out\MM1\document.pdf
• One unit for all documents that contain more than eight sheets. These
documents are sent in a pdf file to the target folder for MM2:
.\Out\MM2\document.pdf
Paths to mailing machines

On the output connector, the path is specified as <somePath>\%{TARGET}
\<FileName> if several mailing machines are used. <FileName> must include
the %{SEGMENT} variable if you want to enable segmentation of the output files.
For example:
.\Out\%{TARGET}\document_%{SEGMENT}.afp
When the output file is created, the %{TARGET} variable is replaced by the name
of the mailing machine and the %{SEGMENT} variable is replaced by a number
that is increased for each new segment file.
If you only have one mailing machine, and if you create a target folder
manually, the name of the target folder must be the same as the name of the
mailing machine. For example:
.\Out\MM\document.afp
Handling large documents

You must make sure the mailing machines can manage large documents. For
example, if you only have one mailing machine, and maximum number of

41.3. Bundling
sheets per envelope for this mailing machine is set to 10, it cannot handle
documents containing more than 10 sheets. To solve this you can do the
following:
• Define a new mailing machine with unlimited number of sheets per

envelope. This will require manual handling of the envelopes.
• Enable splitting of documents into several envelopes. See “Splitting
documents” on page 647.
To define a mailing machine
1. Open the Runtime Output Connector Settings dialog box (generic layer).
2. Click the Job End icon and select the Enveloping tab.
3. Click . The Add mailing machine definition dialog box opens.
4. Configure the settings:
• Mailing machine name – the name of the mailing machine. Must be the
same as the name of the target folder used by the mailing machine.
• Maximum sheets per envelope – the maximum number of sheets per

envelope allowed for the mailing machine.
• Define maximum sheets per segment – used if you need to divide large
output files into several smaller files. See Segmenting output files
on page 645.
5. Click OK.
Segmenting output files

If large output jobs are sent to a mailing machine, you can divide the output file
into segments, i.e. divide a large output file into several smaller files. This means
a printer can start printing as soon as a segment file is ready instead of waiting
until the entire output job is ready for printing.
You use the Maximum setting to specify the maximum number of sheets to
include in a segment file. For example, if you set this limit to 1000, a segment file
can include up to 1000 sheets. Note that segments are always split between
documents, which means all sheets in a document are always contained in the
same segment file.
You use the Last segment max setting to specify the maximum number of sheets
to include in the last segment file. For example, if Maximum is set to 1000, and
there are 1010 sheets left in the job, there would be 10 sheets in the last segment
file if there was no option to set a separate limit for the last segment. If you set
Last segment max to a higher value than Maximum, for example 1100, all 1010
sheets are included in the last segment.

41.3.2 Bundling documents

By default, a mailing machine handles the number of sheets in a document as the
number of sheets to include in an envelope. For example, if an output job contains
invoices only, all sheets in an invoice are included in the same envelope.
If the output job contains several types of documents, and you want to include all
documents to a recipient in the same envelope, you must define how to bundle
documents and prepare them for enveloping.
Envelope keys
Bundling is applied using envelope keys, for example customer number if you
want to include all documents to each customer in the same envelope. When
you define an envelope key, you define which property to use as key and the
sort order (ascending or descending).
Defining envelope keys

To enable properties to be used as envelope keys
Before you can define envelope keys you must select the appropriate metadata
model version and the types that include the properties to use as envelope keys.
2. On the Enveloping tab, click the icon beside the Custom type box. The Define
Custom Type dialog box opens
4. Select the types that include the properties to use as envelope keys and then
click OK.
To define an envelope key
2. On the Envelope tab, click . The Add Envelope Key dialog box opens.
3. Select the appropriate Metadata name and Sort order, and then click OK.

41.3. Bundling
41.3.3 Splitting documents

Splitting a document set across several envelopes
By default, all documents that match an envelope definition are bundled together as
a document set, which means they should be included in the same envelope. For
example, if you have the following mailing machines:
• MM1 for envelopes containing up to seven sheets.
• MM2 for envelopes containing 8-14 sheets.
• MM3 for envelopes containing more than 14 sheets (manual handling of
envelopes).
Then all documents containing more than 14 sheets are sent to MM3, and these
documents must be enveloped manually. To minimize manual handling of
envelopes, you can enable Minimize manual handling when you define envelopes.
If you do, StreamServer tries to sort the documents in the same document set (i.e.
documents with the same envelope key) across several envelopes, which reduces
manual handling.
Example 41-4: Minimizing manual handling
In this example you have the same mailing machines as described above
(MM1, MM2 and MM3). The envelope definition uses “customer ID” as key,
which means all documents with the same “customer ID” should be
included in the same envelope.
You have a three documents, each containing six sheets, where all
documents have the same “customer ID”.
• If you select Minimize manual handling, MM2 will handle the
enveloping and create two envelopes – one envelope with two
documents (12 sheets) and one envelope with one document (six sheets).
• If you do not select Minimize manual handling, all 18 sheets are sent to
MM3 (manual handling).
Note that if any of the three documents contains more than 14 sheets, all
sheets are sent to MM3 even if you select Minimize manual handling.
Splitting a document across several envelopes

By default, all documents with the same envelope key are bundled together as a
document set. The Minimize manual handling option (see “Splitting a document
set across several envelopes” on page 647) enables splitting of a document set with
the same envelope key across several envelopes. If you want to enable splitting of a
document in a document set, i.e. enable splitting of a separate document across
several envelopes, you must use advanced enveloping.

If a document is split across several envelopes, the address must be printed on the
first sheet in each envelope. You can achieve this by either:
• Producing page-formatted data where all pages contain the address.
• Repeating the page that contains the address for each envelope.
• Inserting a pre-defined address page for each envelope.
To enable splitting of documents
3. Click Advanced. The Advanced Enveloping dialog box opens.
4. Select Allow document splitting.
5. Enter the appropriate settings:
• Simple - No address page is added to the envelopes. The address must be

included on all logical pages in the output.
• Copy address page - The first page of the document is duplicated and put
into each envelope.
• Insert address page - Inserts a new address sheet in each envelope, except in
the first envelope. The address sheet must be available as an overlay in a
resource set connected to the runtime configuration. Select the overlay to be
used for the address sheet.
• Define address sheet layout - If you select Copy address page or Insert
address page, you can define the layout to use for the address pages.
6. Click OK.
Limiting the number of envelopes to recipients

If you have enabled Minimize manual handling (see “Splitting a document set
across several envelopes” on page 647) or Allow document splitting (see “Splitting
a document across several envelopes” on page 647) some recipients may receive to
many envelopes. You can set a limit defining the maximum number of envelopes to
send to a recipient. If this limit is exceeded, the corresponding documents are sent to
a mailing machine for manual handling.
To limit the number of envelopes
4. Select Limit envelope count.

41.3. Bundling
5. Specify Max envelopes per recipient and click OK.
41.3.4 Managing inserts

Pre-printed sheets, for example marketing material, can be included in the
envelopes. You can take these inserts into account when calculating the total number
of sheets in an envelope.
Weight equivalents table

If the inserts are printed on different paper quality than the sheets used for the
output documents, you must specify weight equivalents for the inserts to count
the total number of sheets correctly. A weight equivalent is the weight of the
insert divided by weight of the standard sheet. For example, if the weight of the
standard sheet is 15 grams, and the weight of the insert is 30 grams, the weight
equivalent is 2.
Weight equivalents are defined in a weight equivalents table, which is a table
resource in a resource set connected to the runtime configuration. The table
must contain two tab separated columns. The first column lists insert trays. The
trays are defined by Insert mask in the OMR settings, see “Defining OMR
codes” on page 650. The second column lists the weight equivalents for each
insert. The maximum value is 16.
Note: You do not have to include weight equivalents equal to 1 in the

table.
Example 41-5: Weight equivalents table

//!CodePage UTF8!
1 2
3 0.5
5 1.5
To enable counting of inserts
4. Select Count inserts.
5. Enter the appropriate settings:
• Define insert equivalents - Enables selection of a weight equivalents

table. Browse to and select the table resource that contains the weight
equivalents table.
• Optimize inserts - Makes sure a recipient does not receive more than
one insert of the same type. This could happen if documents are split
across several envelopes.

6. Click OK.
41.4 OMR codes

OMR (Optical Mark Reader) codes are a set of strokes that can be used by an
enveloping machine to, for example, identify the first and last pages in a document.
Depending on the requirements of the enveloping machine, you can define:

• Standard OMR codes (STD)
• Generic OMR codes
• Bar codes (where the strokes in an OMR code definition can have different
thicknesses)
41.4.1 Defining OMR codes

You can add one or more OMR codes to a document. You specify OMR codes at Job
Begin, Document Begin, Process Begin, or Page Begin.
Note: For performance reasons, add an OMR code at Job begin if you use
constant values for the OMR code.
Standard strokes
STD OMR codes use standard strokes, i.e. each stroke position in the code has a
predefined meaning. See “STD strokes” on page 651.
Bar functions
By defining a generic OMR code or a bar code, you can use bar functions at any
stroke position in the OMR code. See “Bar functions” on page 652.
To define an OMR code at Job Begin

This procedure describes how to define an OMR code at Job Begin. To define
OMR codes at other levels (Document Begin etc.) you must select the
corresponding icon.
2. Click the Job Begin icon and select the OMR tab.
3. Click . The Define Options dialog box opens.
4. Configure the OMR settings (see OMR settings on page 650) and click OK.
OMR settings
• Name - The OMR code name (only used as an internal reference). Only the
first OMR code of two or more OMR codes with identical names is printed.
An OMR code defined on both Job begin and Document begin will be
printed only on Job begin.

41.4. OMR codes
• Type - The OMR code type. For STD, STDH, and STDE OMR types, see
“STD strokes” on page 651. For all barcode types, you can define the OMR
by using bar functions, see “Bar functions” on page 652.
• X (mm) - The absolute horizontal position of the OMR code (0 is left).
• Y (mm) - The absolute vertical position of the OMR code (0 is top).
• Rotation (degrees) - The rotation of the OMR code.
• Side - The side of the sheet where the OMR code is placed.
• Bar functions - Functions representing bar strokes. See “Bar functions”
on page 652.
• Low sequence - The sequence start value.
• High sequence - The highest value in sequence.
• Sequence order - The sequence order. None is Ascending.
• Insert mask - By setting this option, inserts can be included in envelopes
depending on the OMR type. You can use a maximum of 31 insert trays, so
you can enter an integer from 0 to (232-1) since the value is used as a binary
mask. For example, 13=1101 means that inserts 1,3 and 4 are used for the
documents within the job.
• ON value - The value that indicates that a specific stroke is printed, normally
1.
• Bar height (mm) - The height of the OMR code in millimeters.
• Font size - The font size for the barcode text.
For the OMR type specific attributes, refer to the corresponding barcode
specification.
41.4.2 STD strokes

STD OMR codes use standard strokes, i.e. each stroke position in the code has a
predefined meaning.
Stroke Value Explanation

position
1 1 Synchronization
2 0 Space, double row-distance
3 1 Read control
4 Seq1 1st bit of the sequence
5 Seq2 2nd bit of the sequence
6 Seq4 3rd bit of the sequence
7 Seq8 4th bit of the sequence

Stroke Value Explanation

position
8 notlast 1 – if the sheet is not the last one.
0 – if the sheet is the last one.

9 last 1 – if the sheet is the last one.
0 – if the sheet is not the last one.

10 0 Call slave – this stroke is not supported by Communications
Center, always 0.
11 Ins1 1st bit of insert mask
12 Ins2 2nd bit of the insert mask
13 Ins3 3rd bit of the insert mask
14 Ins4 4th bit of the insert mask
15 Parity 1 – if the sum of strokes with value 1 is even
0 – if the sum of strokes with value 1 is odd.

Only for STDE and STDHE
16 1 Extra bit at the end.
41.4.3 Bar functions

Bit and byte sequence
By default, a bar function defines a bit in a binary sequence. You can switch back
and forth to a byte sequence with < and > characters. The < character switches to
byte sequence, and the > character switches to bit sequence. For example:
1/1/0/<1/0/>1/0/0/0
Byte translation
Bytes are compiled from the bit/byte sequence in the same order as the bit
sequence is entered. For example:
1/1/1/0/0/0/1/1 = 11100011 = 227
To compile bytes using old INT2OF5 and Code 39 OMR behavior, add a #
character in front of the bit sequence. For example:
#1/1/0/1/0/1/0/0/0
Note: For the old INT2OF5 and Code 39 OMR behavior, this is not
recommended when byte sequences are included.
String within the bar function sequence

You can add strings to the bar function sequence by surrounding the string with
single quotes. For example
1/1/0/<'25'>/1/0

41.4. OMR codes
• 1
Bar is printed.
• 0
Bar is not printed.
• seqN
N=1,2,4,8,16,... A bar is printed depending on the binary/byte sequence.
See “OMR example with sequence bars” on page 655.
Note: In byte representation, this barfunction must be specified as

<seq/>. If for example seq=25, the result is the same as 1/<'25'>/1/
0=1252
• insN
N=1,2,3,4... A bar is printed depending on binary or byte representation of
the insert mask.
For example, if Insert mask is set to 10, which is 1010 in binary
representation, it means that ins2 and ins4 are available to use as inserts for
the job. The maximum value of N is 31.
Note: In byte representation, the value is a byte instead of a bit.
• firstpage
A bar is printed if it is the first page in the document.
• notfirstpage
A bar is printed if it is not the first page in the document.
• lastpage
A bar is printed if it is the last page in the document.
• notlastpage
A bar is printed if it is not the last page in the document.
• $variable
A bar is printed depending on value of $variable
• $variable[N]
A bar is printed depending on value of $variable and the bit or byte
representation. N=1,2,3,4...
• Bit representation
The maximum value of N is 31.
For example, if the following bar functions are specified:
$page_no[3]/$page_no[2]/$page_no[1]

then for $page_no = 3, bars are printed corresponding to 0/1/1.

• Byte representation
N represents the N:th character of the variable.
For example:
$variable="abcd"
=> $variable[0]="a", $variable[3]="c"
• Variable arrays
the N:th bit or byte (character) is specified as the second pair square
brackets, e.g. $var[0][1], where [1] is the first bit or the second
character in the first element of the $variable array.
• evenparity
A bar is printed if the number of the other bars is odd. This bar function is
used as a security check. If this function is set, the numbers of bars on the
sheet must be even. This means that if the number of bars printed to the
sheet is odd, the parity bar must be added. If the OMR reads an odd number,
there is a misreading. Therefore, security is doubled.
• oddparity
A bar is printed if the number of the other bars is even. This bar function is
used as a security check. If this function is set, the numbers of bars on the
sheet must be odd. This means that if the number of bars printed to the sheet
is even, the parity bar must be added. If the OMR will reads an even number,
there is a misreading. Therefore, security is doubled.
• firstsheetinenvelope
A bar is printed if it is the first sheet in the envelope.
• notfirstsheetinenvelope
A bar is printed if it is not the first sheet in the envelope.
• lastsheetinenvelope
A bar is printed if it is the last sheet in the envelope.
• notlastsheetinenvelope
A bar is printed if it is not the last sheet in the envelope.
Combinations of bar functions

• func1&func2
A bar is printed if both func1 and func2 print a bar.
Note: The evenparity and oddparity functions cannot be combined.
• func1|func2
A bar is printed if func1 or func2 print a bar.

41.5. Labels
Note: The evenparity and oddparity functions cannot be combined.
41.4.4 OMR examples

OMR example with envelope bar functions
OMR codes are printed from left to right. The following bar functions print an OMR
code with two bars on every sheet, one bar if the sheet is first in the envelope, one
bar if the sheet is last in the envelope, and another two bars on every sheet.
Bar functions: 1/1/firstsheetinenvelope/lastsheetinenvelope//1/1
First sheet Intermediate Last
OMR example with sequence bars

This example is identical to the example above, but sequence bars are added to the
OMR code. The sequence bars have binary representation.
Bar functions: 1/1/firstsheetinenvelope/lastsheetinenvelope//1/1/seq1/

seq2/seq4
First sheet Second Third
41.5 Labels
You can add one or more labels to an output document. If the document is retrieved
from a Document Broker repository, the label can contain variables that for example
specify the sheet number or the enveloping machine that handled the sheet.
Defining labels
You define labels at Job Begin, Document Begin, Process Begin, or Page Begin.
Note: For performance reasons, add a label at Job begin if you use constant
values for the label.

To define a label at Job Begin
This procedure describes how to define a label at Job Begin. To define labels at other
levels (Document Begin etc.) you must select the corresponding icon.
2. Click the Job Begin icon and select the Labels tab.
3. Click . The Define Options dialog box opens.
4. Configure the label settings (see Label settings on page 656 and click OK.
Label settings
• Name - The label name (only used internally as a reference). Only the first label
of two or more labels with identical names is printed. A label defined on both Job
begin and Document begin is printed only on Job begin.
• X (mm) - The X position of the label in millimeters (0 is left).
• Y (mm) - The Y position of the label in millimeters (0 is bottom).
• Rotation (degrees) - The clock-wise rotation of the label.
• Side - The side of the sheet where the label is placed.
• Place on sheets - The sheet(s) in a document where the label is placed. Select
Between to put the label on all sheets except the first and the last sheet.
• Font - The font to use for the label text.
• Font size - The size in number of points of the font used for the label text.
• Text - The printed text. If the document is retrieved from a Document Broker
repository you can use the following variables (case sensitive) in your text:
<%NumSheets>
The number of sheets in the document.
<%MailMach>
The name of the mailing machine.
<%EnvelNr>
The number of the current envelope. Every envelope gets a unique number
when it is created.
<DOCUMENT>
The number of the current document. Documents are numbered per segment
(if defined) and mailing machine.
<PAGEINJOB>
The number of the current logical page. Pages are numbered per segment (if
defined) and mailing machine.

41.6. Sorting and bundling scripts
<SHEETINJOB>
The number of the current sheet. Sheets are numbered per segment (if
defined) and mailing machine.
<PAGESINDOCUMENT>
The number of pages in the document.
<PAGEINDOCUMENT>
The number of the current page in the document.
<SHEETINDOCUMENT>
The number of the current sheet in the document.
41.6 Sorting and bundling scripts

You can retrieve data about the documents that will be sorted and bundled. For
example you can retrieve properties for a document, the number of sheets in a
document, or the number of documents in an envelope. This information can be
used as criteria for different processing options for the documents in a specific
segment. For example, you can add or skip a specific page depending on the invoice
number, or split the input job into two output files, where each file contain
documents with a specific range of number of pages.
For an example of how to divide output depending on number of pages in the

documents, see Example 41-6, “Document sorting and bundling script on Job begin
for splitting output” on page 658
Retrieving information about documents

You retrieve data about the documents by using document sorting and bundling
scripting functions. For example:
• “GetPPMetadata” – returns the value of a property for a specific document,
for example the invoice number.
• “GetSegMetadata” – returns the value of a property for a specific document
within the segment, for example the invoice number.
• “GetPPDocProperty” – returns the value of a specified property for a
document, for example the number of logical pages in the document.
• “GetEnvelNr” – returns the envelope number that a document is included in.
• “GetSegment” – returns the segment number that a document and an
envelope are included in.
• “IsFirstPageInEnvelope” – returns information about whether or not the
current page is the first page in the envelope.
Taking action based on the retrieved information

You can perform actions on the documents or parts of the documents using
scripting functions. For example:
• “NextPage” – skips the rest of the current page and processes next page.

• “NextProc” – skips the rest of the current Process, and processes the next
Process.
• “NextDoc” – skips the rest of the current document and processes the next
document.
• “NextSegment” – skips the rest of the current segment and processes the next
segment.
• “InsertPage” – inserts a page in the current document.
• “FlushOutput” – sends parts of the job to the output connector even if the job
is not completed.
• “SetDestPath” – sets a destination path, and optionally, a file name.
To add a document sorting and bundling script, see “Adding a document

sorting and bundling script” on page 659. For more information on document
sorting and bundling scripting functions, see Section 12 “Document sorting and
bundling functions” in OpenText Communications Center Enterprise - Scripting
Reference Guide (CCMPRJ-RSC).
Example 41-6: Document sorting and bundling script on Job begin

for splitting output
$doc_index = GetFirstDoc();
$PageCount = 0;
while(num($doc_index)> 0)
{$PageCount = num($pageCount) +
num(GetPPDocProperty($doc_index, "pages"));
$doc_index=GetNextPPDoc($doc_index);}
if(num($PageCount)> 5)
{$filename = "./out/big.pcl";}
else
{$filename = "./out/small.pcl";}
41.6.1 Generating statistics reports

You can retrieve and report information about documents to be post-processed. The
information can be written to a separate file or a repository. You must use scripting
to retrieve and report the information. For example, you can use the following script
functions to retrieve statistics information:
• “GetEnvelNr”
• “GetMailMachine”
• “ConnectorPageActual”
Note: The “GetDocSheetCount” function can only be used if you have

specified a mailing machine. See “Defining mailing machines” on page 644.
To write or store the retrieved information you can, for example, use the following
script functions:

41.6. Sorting and bundling scripts
• “FileOpen”
• “FileWrite”
• “OdbcConnect”
• “OdbcExecute”
Note: To use Post-processor scripting to insert or skip pages, you must specify
a sort variable or a mailing machine.
Example 41-7: Script that generates number of sheets per mailing

machine
$mailmachine = "Sheets to mailingmachine" + "<20>" +
GetMailMachine() + "<3a><20>";
$pagecount = ConnectorPageActual();
fileopen("Statistics\pagecount.txt","a");
filewrite("Statistics\pagecount.txt",$mailmachine +
$pagecount + "<0d><0a>" + "<0d><0a>");
This can result in the following rows in the statistics file:
Sheets to mailingmachine Invoice: 24

Sheets to mailingmachine Overflow: 16
41.6.2 Adding a document sorting and bundling script

2. Right-click the level where you want to add the script and select Script. The
Script editor opens.
3. If you use scripting on Process begin or Page begin, select whether to run the
script before or after the Process or Page is processed.
4. Edit the script and click OK.

Chapter 42
Sheet Layouts
You use Sheet Layout editor to create sheet layout resources that you connect to the
appropriate output connectors. The sheet layout resources define the layout of
logical pages on physical sheets, and this layout can include both text and images.
To define sheet layout for output you must create sheet layout resources and assign
them to the appropriate output connectors. See “Creating sheet layout resources”
on page 661 and “Assigning sheet layouts to output connectors” on page 666.
42.1 Creating sheet layout resources

You create sheet layout resources in a resource set connected to the runtime
configuration.
To create a sheet layout resource
1. Right-click the resource set and select New Resource > Sheet Layout.
2. Double-click the sheet layout resource to open Sheet Layout editor.
3. Configure the sheet layout.
Presentation, orientation, margins, and page order

You can specify where and how the document pages are printed on sheets, for
example duplex, landscape, or booklet mode.
You can use variables for the presentation, orientation, and margins settings. For
example, you can use simplex for the first sheet of a document, and duplex for the
rest. To use a variable for a specific property, select the property to activate the Alias
frame for this property.
To specify presentation, orientation, margins, and page order
1. In the Sheet Layout editor, select Sheet layout in the Category tree.
2. Edit the sheet layout settings. See “Sheet layout settings” on page 669.
Images
You can add images to a sheet and to specific partitions on the sheet
To add an image to a sheet
1. In the Sheet Layout editor, select Sheet Layout in the Category tree.
2. From the Sheet Layout menu, select Add Image.

Chapter 42 Sheet Layouts
3. Edit the values for the image. See “Image settings – sheet level” on page 672.
To add an image to a partition
1. In the Sheet Layout editor, select Partition in the Category tree.

2. From the Sheet Layout menu, select Add Image.
3. Edit the values for the image. See “Image settings – partition level”
on page 673.
Overlays
You can add an overlay to a sheet.
To add an overlay
1. In the Sheet Layout editor, select Sheet Layout in the Category tree.
2. From the Sheet Layout menu > Add Form Overlay.
3. Edit the values for the overlay. See “Overlay settings” on page 673.
If you want to add an overlay to a page according to a condition, for example if the
page is the first one in the envelope, you can use the “InsertOverlay” script function.
Example 42-1: InsertOverlay script

if (isFirstPageInEnvelope())
{insertOverlay("overlay1", 0, 0)
To add a post-processing script, see “Sorting and bundling“ on page 641.
Repeat settings
You can print signatures from several documents on a single sheet, or repeat the
signature vertically or horizontally. You can also repeat the entire sheet. Repeating
signatures is useful when, for example, printing business cards.
To specify repeat settings
1. In the Sheet Layout editor, select Repeat in the Category tree.

2. Edit the repeat settings. See “Repeat settings” on page 674.
Signatures
You can specify how the sheet is divided in partitions, by specifying the number of
rows and columns.
To specify signatures
1. In the Sheet Layout editor, select Signature in the Category tree.

42.1. Creating sheet layout resources
2. Edit the signature settings. See “Signature settings” on page 674.
3. Specify the partitions. See “Partitions” on page 663.
Partitions
A partition is a section of the signature that contains one page. You can add and
configure the partitions in a signature.
Note: Make sure the size of the logical page fits the partition size.
To specify partitions automatically
2. From the Sheet Layout menu, select Auto Add Partitions. Partitions are added
according to your signature definition.
3. Edit the values for the partitions. See “Partition settings” on page 675.
To add a partition manually
2. From the Sheet Layout menu, select Add Partition.
3. Edit the values for the partition. See “Partition settings” on page 675.
Fold marks
Fold marks display where the border between rows in a signature is located, and
they indicate where the sheet is supposed to be folded. In the Fold marks tables, you
can double-click a cell or click F2 when a row is selected to start editing.
Horizontal fold marks are printed outside the left and right edges of the signature,
between the selected rows. Vertical fold marks are printed outside the top and
bottom edges of the signature, between the selected columns.
To specify horizontal fold marks
1. In the Sheet Layout editor, select Hor. Fold Marks in the Category tree.
2. Edit the fold mark settings. See “Horizontal fold marks settings” on page 676.
To specify vertical fold marks
1. In the Sheet Layout editor, select Ver. Fold Marks in the Category tree.
2. Edit the fold mark settings. See “Vertical fold marks settings” on page 676.
To specify default values for fold marks
You can specify the default values used for fold mark length, width, and distance.

1. In the Sheet Layout editor, select Tools > Options. The Options window opens.
2. Edit the Fold marks default values and click OK.
Gutters
The gutter is the area between two rows or columns of partitions in a signature. The
gutter allows the logical pages that are printed on the partitions to be easily visible
when the sheet is folded. In the Gutters tables, you can double-click a cell or click F2
when a row is selected to start editing.
The horizontal gutter is the empty area between two rows of partitions in a
signature, and the vertical gutter is the empty area between two columns of
partitions in a signature.
To specify horizontal gutters
1. In the Sheet Layout editor, select Hor. Gutters in the Category tree.
2. Edit the gutter settings. See “Horizontal gutters settings” on page 677.
To specify vertical gutters
1. In the Sheet Layout editor, select Ver. Gutters in the Category tree.
2. Edit the gutter settings. See “Vertical gutters settings” on page 677.
Page order
Every page in a document has a unique sequence number beginning with 1.
To create an expression that represents this sequence number, you can use integers,
+, -, *, /, (, ), and the following variables:
• s – the sheet number where the logical page is to be printed.

• n – the total number of logical pages to be printed.
The variable n is retrieved from the lowest of the following values:

• The number of logical pages in the document.
• The MaxSheets parameter specified in the Sheet Layout category.
Example 42-2: Booklet
The number of pages is eight, so 2 sheets are printed.
1st partition (front left): n+2-2*s
1st sheet: The page printed on the front left partition is 8+2-2*1=8
2nd sheet: The page printed on the front left partition is 8+2-2*2=6

42.1. Creating sheet layout resources
2nd partition (front right): 2*s-1
1st sheet: The page printed on the front right partition is 2*1-1=1
2nd sheet: The page printed on the front right partition is 2*2-1=3
3rd partition (back left): 2*s
1st sheet: The page printed on the back left partition is 2*1=2
2nd sheet: The page printed on the back left partition is 2*2=4
4th partition (back right): n+1-2*s
1st sheet: The page printed on the back right partition is 8+1-2*1=7
2nd sheet: The page printed on the back right partition is 8+1-2*2=5
Example 42-3: Cut normal order
1st partition (front left): 2*s-1
2nd partition (front right): 2*s-1+n/2
3rd partition (back left): 2*s+n/2
4th partition (back right): 2*s
Example 42-4: Cut reverse order
1st partition (front left): n+2-2*s
2nd partition (front right): n/2+2-2*s
3rd partition (back left): n/2+1-2*s
4th partition (back right): n+1-2*s

42.2 Assigning sheet layouts to output connectors

You must assign the sheet layout resource to an output connector (runtime settings).
You can configure the output connector at Job begin, Document begin, Process
begin, or Page begin. We recommend you to configure the connector at Job begin,
unless you want to specify a specific document, Process or Page.
The priority order when selecting a sheet layout is Page, Process, Document and
then Job. For example, if you specify different sheet layouts on Page begin and
Document begin, the sheet layout on Page begin is used for the selected pages
within the document.
To add a sheet layout
1. Open the Runtime connector settings dialog box for the output connector.
2. Select the Sheet Layout tab and browse to the sheet layout resource that you
have created.
3. If you have not defined a Page order, you can select the partition on which to
place the pages. You can specify a partition number or a partition name that you
have defined in the Sheet Layout editor. A name must be specified as
'<partition_name>' . Default is Next (if none is selected).
4. Optionally, you can specify the partition in which the first page of the Job,
Document or Process is printed. You can specify a partition number or a
partition name that you have defined in the Sheet Layout editor. A name must
be specified as '<partition_name>' . Default is Next (if none is selected).
5. Click OK.
42.3 Side-by-side printing

You can configure an output connector to print the sheet layout side by side on a
larger sheet. For example, if you defined your sheet layout on A4 media, you can
print two of these sheet layouts side by side on an A3 sheet. To do this you must
specify to print the pages side by side in the Page Order definition for the partitions.
For an example of side-by-side printing, see “Sheet layout examples” on page 667.
To configure side-by-side printing
1. In the Runtime configuration window, open the connector settings for the
output connector to be used.
2. Select the Side by Side tab and browse to the sheet layout resource that you
have created.
3. Select the partition on which to place the pages. You can specify a partition
number or a partition name that you have defined in the Sheet Layout editor. A
name must be specified as '<partition_name>' . Default is Next (if none is
selected).

42.4. Sheet layout examples
4. Click OK.
42.4 Sheet layout examples

Printing business cards
In this example, business cards are printed on 10 sheets with 20 business cards on
each sheet. The business card page defined in the Process tool has a size that allows
20 business cards to be printed onto an A4 page.
1. Create a new sheet layout.
2. In the Category tree, select Repeat.
3. In the upper Repeat frame, select Stack.
4. In the upper Count box, enter 10.
5. In the intermediate Repeat frame, select Horizontal.
6. In the intermediate Action list box, select Duplicate.
7. In the intermediate Count box, enter 4.
8. In the lower Action list box, select Duplicate.
9. In the lower Count box, Enter 5.
10. Save the sheet layout.
11. Configure an output connector to use this sheet layout.
Printing side-by-side
1. Create a new sheet layout.
2. Configure an output connector to use this sheet layout.
3. Create another sheet layout.
4. In the Category tree, select Sheet Layout.
5. In the Page Order frame, select Cut Normal Order. The Layout Presentation is
automatically set to Duplex, or Duplex tumble, depending on the Layout
Orientation that you have specified. The Media size is twice the Media size of
the sheet layout selected on the Sheet Layout tab.
6. Save the sheet layout.
7. Configure an output connector to use side-by-side printing.

42.5 Sheet layout editor GUI reference

42.5.1 Sheet Layout menu
• Add Image
Adds an image to the sheet or to a selected partition.
• Add Form Overlay
Adds an overlay to the sheet.
• Add Partition
Adds a new partition to the signature.
• Auto Add Partitions
Adds partitions to the signature. Uses the signature definition to calculate how to
create the partitions.
• Move Up
Moves the selected partition upwards.
• Move Down
Moves the selected partition downwards.
• Delete Selection
Deletes the selected image, overlay, or partition.
42.5.2 Tools menu

• Options
Opens the Options dialog box, where you can specify measurement units
(Inches, Millimeters or Points) and default fold marks settings (Distance, Length,
and Width)
42.5.3 Categories
The Sheet Layout Editor settings are divided into several categories.
• Sheet Layout - Defines presentation, orientation, margins, and page order. See
“Sheet layout settings” on page 669.
• Media - Defines the type of paper to use, where to retrieve new sheets, and
where to output the printed sheets. See “Media settings” on page 671.
• Image - Defines images to add to the sheet or to a specific partition on the sheet.
See “Image settings – sheet level” on page 672 and “Image settings – partition
level” on page 673.
• Overlay - Defines overlays to add to the sheet. See “Overlay settings”
on page 673.
• Repeat - Defines how to repeat signatures. See “Repeat settings” on page 674.

42.5. Sheet layout editor GUI reference
• Signature - Defines how the sheet is divided in partitions. See “Signature

• Partition - Defines how to configure a partition. See “Partition settings”
on page 675.
• Hor. Fold Marks - Defines the horizontal fold marks. See “Horizontal fold marks
• Ver. Fold Marks - Defines the vertical fold marks. See “Vertical fold marks
• Hor. Gutters - Defines the horizontal gutters. See “Horizontal gutters settings”
on page 677.
• Ver. Gutters - Defines the vertical gutters. See “Vertical gutters settings”
on page 677.
42.5.3.1 Sheet layout settings

You can specify where and how the document pages are printed on sheets, for
example duplex, landscape, or booklet mode.
You can use variables for the presentation, orientation, and margins settings. For
example, you can use simplex for the first sheet of a document, and duplex for the
rest. To use a variable for a specific property, select the property to activate the Alias
frame for this property.
• Presentation
Page presentation. Duplex Tumble means to turn the page on the short side.
Variable values:
• Simplex
• Duplex
• Tumble
• Orientation
The orientation of the sheet.
Variable values:
• Portrait
• Landscape
• Margins (mm)
• Top - The size of the margin from the top of the sheet to the signature.
• Bottom - The size of the margin from the bottom of the sheet to the signature.
• Left - The size of the margin from the left side of the sheet to the signature.
The margin is defined when the sheet is front side up. Therefore, on the back
side, this margin is on the right side.

• Right - The size of the margin from the right side of the sheet to the signature.
The margin is defined when the sheet is front side up. Therefore, on the back
side, this margin is on the left side.
Variable values: Must be points.

• Page order
• None - No page order is defined. The partition order specified at Job begin,
Document begin, Process begin, or Page Begin is used for the imposition of
the pages.
• Booklet - The pages are positioned for booklet printing. Only 2-up signature
is supported. See “Signature settings” on page 674.
• Cut Normal Order - Starting with the first page, the first half of the total
number of pages is positioned on the left side of the sheets, and the second
half on the right side of the sheets.
• Cut Reverse Order - Starting with the last page, the first half of the total
number of pages is positioned on the left side of the sheets, and the second
half on the right side of the sheets.
• Custom Order - The pages are positioned according to the Page Order option
specified for a specific partition, see “Partition settings” on page 675.
• Max no of sheets
If you want the Page Order option that you have specified to be applied to less
pages than the total number of pages in the document, you must specify the
maximum number of sheets that can be used for the pages in the document. This
can be useful, for example, if a cutting machine can only handle a limited
number of sheets.
• Keep documents together
• No - Each document starts on a new sheet.

• Yes - A document is printed on the sheet directly after the previous
document.
• Front Column - The first page of each document is printed on the top
partition in the column to the right of the previous column on the front side.
• Front Row - The first page of each document is printed on the left partition in
the row below the previous row on the front side.
• Front Cell - The first page of each document is printed on a partition on the
next row or column on the front side.
• Signature - The first page of each document is printed on the next signature.
This can be useful when you are repeating signatures, see “Repeat settings”
on page 674.

42.5.3.2 Media settings

You can specify the type of paper to use, where to retrieve new sheets, and where to
output the printed sheets.
You can use variables for all Media settings. For example, you can use a separate
type of paper for the first sheet in a document. To use a variable for a specific
property, select the property to activate the Alias frame for this property.
• Paper size
The paper size. If you select Custom, you must specify Width and Height.
Variable values:
• A3
• A4
• A5
• Letter
• Tabloid
• Ledger
• Legal
• Executive
• Width (mm)
The width of the paper in millimeters.
• Height (mm)
The height of the paper in millimeters. The height must be greater than the
width, as the media is defined as portrait layout.
• Type
The type of paper, for example transparency or drilled. The string must comply
with the output format definition. See your output format manual for available
definitions.
Variable values: A string.
• Color
The paper color. The string must comply with the output format definition. See
your output format manual for available definitions.
• Weight
The weight of the paper in grams per square meter.


• Gutter change (mm)
The increase in gutter size for every new sheet. This is used to compensate for the
media thickness when the sheets are put together and folded, for example when
booklets are used. See “Horizontal gutters settings” on page 677.
• Input tray
The input tray name.
• Output bin
The output bin name.
42.5.3.3 Image settings – sheet level

• Name
The image file name as specified in the resource set. You can use a variable for
the image name. For example, you can use customized images depending on the
customer ID.
• Horizontal position (mm)
The horizontal position on the sheet. Left is 0.
• Vertical position (mm)
The vertical position on the sheet. Top is 0.
• Sheet side
The side of the sheet where the image will be located.
Variable values:
• Front
• Back
• Both

42.5.3.4 Image settings – partition level

• Name
The image file name as specified in the resource set. You can use a variable for
the image name. For example, you can use customized images depending on the
customer ID.
The horizontal position on the partition or sheet. Left is 0.
The vertical position on the partition or sheet. Top is 0.
• Position from partition origin
The horizontal and vertical positions are relative to the partition origin (top left
corner of the partition), instead of the sheet origin.
42.5.3.5 Overlay settings

• Name
The overlay name as specified in the resource set. You can use a variable for the
overlay name. For example, you can use customized overlays depending on the
customer ID.
The horizontal position. Left is 0.
The vertical position. Top is 0.
• Sheet side
The side(s) of the sheet where to print the form overlay.
Variable values:
• Front
• Back
• Both

42.5.3.6 Repeat settings

You can print signatures from several documents on a single sheet, or repeat the
signature vertically or horizontally. You can also repeat the entire sheet. Repeating
signatures is useful when, for example, printing business cards.
• Repeat
The direction in which the signature is repeated.
If you specify Stack, the whole sheet is repeated. Within the stack repetition, you
can repeat the signature vertically and horizontally.
• Reverse
Reverse the direction of repeating. By default, repeating vertically is from top to
bottom of the sheet, and repeating horizontally is from left to right.
• Action
• Duplicate – The contents of the signature is duplicated in the next signature.

• Increment – The next pages of the document are printed in the next signature.
• Count
The number of times the signature is repeated.
• Spacing (mm)
The distance between signatures, when repeated vertically or horizontally.
42.5.3.7 Signature settings

You can specify how the sheet is divided in partitions, by specifying the number of
rows and columns.
• N-up definition
Predefined signatures allow you to configure the sheet to contain up to four
partitions on each side.
• Rows and column definition
You can define a custom signature by specifying the number of rows and
columns for both back and front sides.
• Set size
• Width (mm) – the horizontal size of the signature.

• Height (mm) – the vertical size of the signature.
• Same partitions on both sides
The partitions defined for the signature are applied to both sides of the sheet.

42.5.3.8 Partition settings

A partition is a section of the signature that contains one page. You can add and
configure the partitions in a signature.
• Partition name
The partition name. You can use the name when you select a partition and a
sheet layout resource on the runtime settings, see “Assigning sheet layouts to
output connectors” on page 666.
• Constant
• True – Does not allow logical pages to be printed on this partition.
• False – Allows logical pages to be printed on this partition.
• Cell
The row and column number of the partition being defined. Top left corner is
1,1.
• Coord (mm)
The X and Y position of the partition on the sheet. Top left corner is 0,0.
• Sheet side
The side of the sheet where the partition is located.
• Rotate
The counter-clockwise rotation of the page, the form overlay, and the image, that
will be printed in this partition. The Auto option rotates the page, the form
overlay, and the image to best fit the partition. For example, if a page with
landscape orientation is to be printed in a portrait partition, the page is rotated to
fit in the partition.
• Center small pages
If the logical page is smaller than the partition, the page is centered in the
partition. If not selected, the page is positioned in the upper left corner of the
partition.
• Page order
A mathematical expression that represents the sequence number of the page to
be printed in this partition. See “Page order” on page 664.

42.5.3.9 Horizontal fold marks settings

they indicate where the sheet is supposed to be folded. Horizontal fold marks are
printed outside the left and right edges of the signature, between the rows that you
specify.
In the Fold marks tables, you can double-click a cell or click F2 when a row is
selected to start editing.
• Begin row
Specifies the row in the signature above which the first fold mark is printed.
Enter 0 to start at the top.
• End row
Specifies the row in the signature under which the last fold mark is printed.
• Distance
The distance between the signature and the closest edge of the mark.
• Length
The length of the fold mark.
• Width
The width of the fold mark.
• Automatically add fold marks
Click to automatically add horizontal fold marks to every place where it is
possible, that is on the horizontal limit between rows in the signatures, as well as
above the first row and under the last row.
42.5.3.10 Vertical fold marks settings

they indicate where the sheet is supposed to be folded. Vertical fold marks are
printed outside the top and bottom edges of the signature, between the columns that
you specify.
In the Fold marks tables, you can double-click a cell or click F2 when a row is
selected to start editing.
• Begin col
Specifies the column in the signature to the left of which the first fold mark is
printed. Enter 0 to start at the top.
• End col
Specifies the column in the signature to the right of which the last fold mark is
printed.
• Distance

The distance between the signature and the closest edge of the fold mark.
• Length
The length of the fold mark.
• Width
The width of the fold mark.
• Automatically add fold marks
Click to automatically add vertical fold marks to every place where it is possible,
that is on the vertical limit between columns in the signatures, as well as to the
left of the first column and to the right of the last column.
42.5.3.11 Horizontal gutters settings

when the sheet is folded. The horizontal gutter is the empty area between two rows
of partitions in a signature.
In the Gutters tables, you can double-click a cell or click F2 when a row is selected to
start editing.
• Begin row
The upper row in the signature, under which the horizontal gutter is located. Top
row = 1.
• End row
The lower row in the signature, above which the horizontal gutter is located.
• Distance
The size of the gutter. If you leave this empty, the size is calculated from the
Gutter change value. See “Media settings” on page 671.
42.5.3.12 Vertical gutters settings

when the sheet is folded. The vertical gutter is the empty area between two columns
of partitions in a signature.
In the Gutters tables, you can double-click a cell or click F2 when a row is selected to
start editing.
• Begin col
The left column in the signature to the right of which the vertical gutter is
located. Left column = 1.
• End col

The right column in the signature to the left of which the vertical gutter is
located.
• Distance
The size of the gutter. If you leave this empty, the size is calculated from the
Gutter change value that you can specify in the Media settings.

Part 8
Correspondence management
Chapter 43
About correspondence management
A correspondence management scenario includes the following Communications

Center web applications:
• WorkShop (including the Resources, Templates, and Services view)
• StoryBoard
• Supervisor (including the Review and Track views)
• ReTouch

Chapter 44
Managing templates, themes, and documents
This section describes the additional configurations you must apply to a Design
Center Project in order to manage templates in WorkShop, themes in StoryBoard,
and documents in ReTouch.
Configuring input connectors and Events

Configuration of input connectors and Events is the same as for standard
Projects, and no additional configurations are required.
Making a Message available as a template

A template exposed in WorkShop is a Message configured in a theme-enabled
Process (StoryTeller or Template Engine). The WorkShop user can create a
theme based on the template, and the StoryBoard user can edit the actual theme.
See “Making a Message available as a template” on page 684.
Configuring delivery output connector

The output connector configuration for delivering the output is the same as for
standard Projects. You must select a connector and driver that corresponds to
the delivery channel and output format you want to use for the output
documents. For example, a File output connector and PDF driver. See
“Configuring output connectors for delivery” on page 684.
Configuring custom preview connectors

The StoryBoard user must be able to preview themes. You can use the default
preview connectors that are pre-configured and ready to use, but if you need to
configure the preview connectors you must create custom preview connectors.
See “Using custom preview connectors” on page 686.
Connecting types to the Message

To be able to use properties in WorkShop and StoryBoard, you must make the
properties available to the Message. See “Connecting types to the Message”
on page 684.
Service-enabling the Message

A Message exposed as a template in WorkShop and as a theme in StoryBoard is
invoked via service requests. You must therefore assign a service to the
Message. In WorkShop and StoryBoard, you use simulations to preview the
themes or templates. If you want to create a default simulation, you can add
sample file to the Message. See “Service-enabling the Message” on page 685.
Composing rules
In Design Center you can compose the rules to be used in WorkShop and
StoryBoard. See “Creating rules” on page 687.

Chapter 44 Managing templates, themes, and documents
44.1 Making a Message available as a template

You must make a Message available as a template in WorkShop, and as a theme in
StoryBoard. This type of Message must be configured in a StoryTeller or Template
Engine Process.
Naming the Process

The name of a template in WorkShop is the same as the name of the Process
behind the template. This means you must give this Process a unique and
descriptive name.
Caution
Once the Project is deployed, you must not rename the Process.
Renaming a deployed Process will damage the corresponding template
and all themes based on this template.
Defining sections in the Process

All editable sections in a theme are based on sections defined in the Process
behind the template. How to define sections depends on the type of Process. See
the corresponding tool documentation for information.
Exposing the Message

In Design Center you must explicitly expose the Message as a template in
WorkShop and as a theme in StoryBoard:
• In the Message configuration view, right-click the Process and select Theme.
44.2 Connecting types to the Message

To use properties in WorkShop and StoryBoard, you must make the properties
available to the Message. To make the properties available, the types that contain the
properties must be connected to the Message. See “Applying types to documents or
Messages” on page 380 for information about how to connect types to a Message.
44.3 Configuring output connectors for delivery

The output connector configuration for delivering the output is the same as for
standard Projects. You must select a connector and driver that corresponds to the
delivery channel and output format you want to use for the output documents.
• Print output - For output to be printed, select the appropriate connector and
driver. For example, a File connector and PDF driver.
• Email output - For output to be delivered in email bodies, select an SMTP
(MIME) or EasyLink Email connector and HTML unpaginated driver.
• Web output - For output to be produced on the web, select the appropriate
connector and driver. For example, a File connector and HTML unpaginated
driver.

44.4. Service-enabling the Message
• Multi-channel delivery - You can connect the Process to several output

connectors, and deliver the output from the Process via several channels at the
same time. For example, send business documents via emails, and at the same
time create printed output. For more information, see “Linking Processes to
output connectors” on page 80.
44.4 Service-enabling the Message

To preview themes and to use themes in document production, you must enable the
Message to be invoked through service requests. Service-enabling the Message is
also a prerequisite for creating, previewing, and releasing paused documents in the
Message repository. When the Message is service-enabled, external applications like
WorkShop, StoryBoard, and Supervisor can use services to handle Messages based
on the Runtime configuration.
To create a default simulation used to preview a template in WorkShop or a theme

in StoryBoard, you add a sample file to the Message. This will create simulation that
can be used to preview all the templates and themes connected to the Message. You
can add one sample file to each Message. To get the default simulation in WorkShop,
you must create a release in the CAS rather than deploying locally. If you change the
sample file and redeploy the Project, the sample file used in the simulation is
updated.
To service-enable a Message
1. In Design Center, open the Runtime configuration.
2. Right-click the Message and select Settings.
3. On the Service tab, select Service.
4. In Enable service support for content types, select the preview formats to be
available:
• application/pdf - Not applicable for the Communications Center web

applications.
• image/tiff - Not applicable for the Communications Center web
applications.
• text/html - Enables unpaginated preview. Can only be used for Messages
based on StoryTeller and Template Engine Processes.
• text/html+paginated - Enables paginated preview. Can only be used for
Messages based on StoryTeller Processes.
5. To use default preview connectors, keep Use default preview connectors

selected.
6. In Service name text box, enter the name of the service. The name of the service
is displayed in WorkShop when, for example, adding services to simulations.
This means you must give the service a unique and descriptive name.

Caution
Do not modify the name in an already deployed Project. If the name is
modified, you can no longer preview and release paused documents.
7. In Sample file text box, browse to and select the sample file to use for the
default simulation.
8. Click OK.
44.5 Preview enabling themes

The StoryBoard user must be able to preview the theme. You must assign a service
to the Message and specify which preview formats to enable in StoryBoard (see
“Service-enabling the Message” on page 685).
If you do not intend to use custom preview connectors (see “Using custom preview
connectors” on page 686) this is all you have to do to preview enable themes.
44.5.1 Using custom preview connectors

To be able to use custom drivers and fonts when previewing and editing themes and
paused documents, you must use custom preview connectors.
At a preview request the driver settings, and optional filter chains, on the preview
connectors are applied – all other connector settings are ignored. You can use the
delivery connectors as preview connectors if it is OK to use the same driver settings
for preview and delivery. You can also create separate connectors for preview, for
example Null Connector connectors and add the appropriate drivers to these
connectors.
Note: Custom preview connectors must use output queues.
Drivers and preview formats

• For paginated preview (content type text/html+paginated), you must use
a Layout driver and an XML Stylesheet Filter that references the stylesheet
preview.xslt. This stylesheet is available in:
<Installation directory>\Applications\Common\<version>\Modules
\Filters
See “Layout driver“ on page 471 for more information about the Layout
driver and “XML stylesheet filter” on page 563 for more information about
the XML Stylesheet Filter.
• For unpaginated preview (content type text/html), you must use an HTML
unpaginated driver.
Connector selection
Script functions are used to select the appropriate preview connector, and the
content type and preview type in the preview request determines which

44.6. Creating rules
preview connector to use. The following script functions are used in a before
Process script for this purpose:
• IsPreview – Checks if the job is a preview job or not.
• GetPreviewTypeEx – Returns a number indicating from where the preview
job was invoked.
• GetRequestedPreviewContentType – Returns the requested content type.
Example 44-1: Connector selection script

if (IsPreview())
{
$ContentType = GetRequestedPreviewContentType();
if (GetPreviewTypeEx() == 1) //preview
{
if ($ContentType == "text/html")
{
$connectors[0] = "previewWeb"; //preview connector
}
else if ($ContentType == "text/html+paginated")
{
$connectors[0] = "previewPrint"; //preview
connector
}
}
}
else
{
$connectors[0] = "filePDF"; //delivery connector
$connectors[1] = "fileHTML"; //delivery connector
}
44.6 Creating rules

In Design Center, you can compose rules for themes and resources used in themes. If
the Project is checked-in via the common asset service, the rules are automatically
available in WorkShop.
The WorkShop user can also upload rules to WorkShop. After you export the Project
and deploy, you will find the rules in the working directory of the StreamServer
application. You can copy the rules to the appropriate folder and inform the
WorkShop user where to find the rules to upload.
To create a rule
1. Open a resource set connected to the Message configuration.

2. Right-click the resource set and select New > Rule.
3. Give the resource a descriptive name, and then open the resource in the Rule
editor.

4. In the Rule Editor, enter a unique name for the rule function.
Note: Do not use white spaces in the name.
5. Edit and save the rule function.

Chapter 45
Reviewing documents
This section describes the additional configurations you must apply to your Design
Center Project to enable preview, approval, and release of documents in the Review
view in Supervisor.
Prerequisites
The following repositories are required to review documents in the Review view:
• A Message repository is linked to the domain.

• A statistics repository is linked to the domain.
• A queue repository is linked to the domain.
• A tracker repository is linked to the domain (for document preview).
Setting property values

To display a custom property when previewing a document in the Review view,
or to use a custom property in an exception rule, you must set the property
value using a script function. See “Setting property values” on page 689.
Configuring exception rules

A document displayed in the Review view is actually a Message, paused in the
Message repository when certain conditions are fulfilled. You must configure
these conditions in exception rules. See “Configuring exception rules”
on page 690.
Adding exception rules to the Message

You must add the exception rules to the Message. You add the rules when you
service-enable the Message. See “Adding exception rules to the Message”
on page 692.
45.1 Setting property values

To display a custom property when previewing a document in the Review view, or
to use a custom property in an exception rule, you must set the property value using
the setMetadataMessage scripting function.
To save space in the Message repository and improve search performance, you
should not set more property values than what is really required.
Prerequisites
• The metadata model is prepared and connected to the Project.

Chapter 45 Reviewing documents
To set property values
1. In Describer, add the properties to one or more types in the metadata model.
2. In Design Center, in the Message configuration, connect the types to the

Message.
3. Add a script and use “setMetadataMessage” to set the property values.
Tip: The script function uses GUIDs to identify properties. For information
about how to find the GUIDs, see “Finding the GUID of a property”
on page 384.
Example 45-1: Setting property value
In this example, the property Category is displayed when previewing a

document in the Review view. The property can also be used in exception
rules.
In the Message configuration, the script below is added as a retrieved script

on the Event.
setMetadataMessage("5fb1c989-ae0b-4c98-8a15-c592af6db25c",
$Category);
45.2 Configuring exception rules

To pause a document, certain conditions must be fulfilled. You configure these
conditions in exception rules, which are executed directly after any retrieved scripts.
In the rule functions, you use the Communications Center script syntax to set up
conditions. Depending on property values, these conditions are either true or false.
The property values should be retrieved using the getMetadataMessage or
getMetadataMessageFrom scripting function.
Prerequisites
• The property values should be set using the setMetadataMessage scripting

function. OpenText does not recommend using field variables directly in rule
functions since such variables may not be available when the exception rule is
evaluated.
To add a rule to the resource set
1. In Design Center, open the resource set connected to the Runtime configuration.
2. Right-click in the resource set, and then select New > Rule.
3. In the resource set, give the new rule a unique and descriptive name.

45.2. Configuring exception rules
To configure a rule function
1. In the resource set, double-click the rule resource.
2. In the Rule Editor, enter a unique name for the rule function.
Note: Do not use white spaces in the name.
3. Enter the rule function. Use “getMetadataMessage” or

“getMetadataMessageFrom” to retrieve property values.
Tip: The script functions use GUIDs to identify properties. For information
about how to find the GUIDs, see “Finding the GUID of a property”
on page 384.
Caution
If you update a rule function in an already deployed Project, the
updated function is used the next time the exception rule is evaluated.
4. Click Check Syntax and update the syntax if required.
5. Click File > Save.
6. Click OK.
Example 45-2: Exception rule for pausing documents
In this example, an exception rule pauses all documents with the value
Young for the property Category. The documents are then available in the
Review view. Documents with other values for the property are formatted
and distributed without being paused.
In the resource set, a new rule resource called Category is Young is created.
In the Rule Editor, the rule function below is created.
getMetadataMessage("5fb1c989-ae0b-4c98-8a15-c592af6db25c",
$Category);
if ($Category == "Young")
return "true";
else
return "false";

Chapter 45 Reviewing documents
45.3 Adding exception rules to the Message

You must add the exception rules to the Message. If you add several exception rules,
the rules are evaluated, one by one, until one rule is fulfilled or all rules are
evaluated.
You add the rules when you service-enable the Message.
Prerequisites
• The Message is service-enabled as described in “Service-enabling the Message”
on page 685.
To add exception rules to a Message
1. In Design Center, open the Runtime configuration.
2. Right-click the Message and select Settings.
3. On the Service tab, select Service.
4. In the Rule field, click to add exception rule resources for pausing documents in
the Message repository.
5. Click OK.

Chapter 46
Modifying configurations
This section describes how Project modifications affect your themes and your
paused documents.
When you modify a Project that contains theme-enabled Processes, you must be
aware of the consequences. For example, if you modify a Project that is already used
in output document production, you must consider whether the updates should be
applied to both future documents and to already paused documents in the Message
repository. If you want to apply the changes to paused documents, you must be
aware of which types of modifications can be applied.
46.1 Modifications and template versions

Each theme-enabled Process is assigned a template version number. After deploying
the Project that includes the Process, the template and the template version are listed
in WorkShop.
This sections gives an overview of how configuration modifications affect the

template version.
Modifications affecting the template

If you modify the Process in a way that affects the structural design of the template,
the template version is automatically increased when you save the Process. After
redeploying the Project, the new template version is available in WorkShop.
StoryTeller modifications affecting the template

The following types of changes affect the template and version:
• Adding, deleting or renaming a section.
• Moving a section to another page.
• Modifying the size of the section placeholder (text object or story frame).
• Modifying the page size.
• Adding or removing pages.
• Adding or deleting exposed stories.
Template Engine modifications affecting the template

The following types of changes affect the template and version:
• Adding, deleting or renaming a section.
• Changing the order of the sections.

Chapter 46 Modifying configurations
• Changing the description of a section.
Project version modifications affecting the template

• If you manually increase the Project version number at export or release, the
versions of all included templates are also automatically increased. For
information about this scenario, see “Deploying a new version of the Project”
on page 696.
Modifications not affecting the template

Not all Project modifications affect the template. For example, if you add a new field
from the Event configuration or update a text in a StoryTeller document, the
template is not affected. Modifications that do not affect the template do not result in
an increased template version.
Event modifications
You can delete, rename, or add fields in the Event configuration without affecting
the template version. The following applies:
• If you delete a field, the field is no longer used in the paused documents.
• If you rename a field, the field is no longer used in the paused documents.
• If you add a field, the paused documents are not affected. However, if you add
the new field to a StoryTeller document, the field will be empty in the paused
documents.
Caution
If you delete or rename a field used in StoryTeller, you must open and
update the StoryTeller document accordingly. If not, the output
documents will be corrupt.
Exception - If you concatenate several Events, you cannot do any Event changes
without creating a new export version of the Project and thereby increase the
template versions of all included theme-enabled Processes.
46.2 Deploying updated configurations

After completing your Project modifications, you must redeploy the Project for the
changes to take effect. You can either redeploy the updated Project to the same
StreamServer application, or you can deploy a new export version of the Project to
another StreamServer application.
In a production environment, you may have to use combinations of the deployment

scenarios. For example, if you want to rectify a spelling error in both already paused
documents in the Message repository and in future documents, but only want to
apply template updates to future documents. When combining the scenarios, you
must also consider the order in which the modifications are deployed.

46.2. Deploying updated configurations
Service version background

When you deploy a Project that includes a service-enabled Message, the
StreamServer application exposes a service. The service is assigned the same
version as the Project version that you manually set when creating a release or
exporting the Project. The service is used for creating, previewing, and releasing
documents based on the runtime configuration. After deployment, the service
and the service version are listed in WorkShop.
When the WorkShop user creates a theme, the user selects the service version to
be used. The service version runs the corresponding Project version, which
includes the template version that the theme will be based upon. Later, when the
user enables the theme for batch document production, the user selects one or
many domains in which the specific service version must be running.
Several StreamServer applications can expose different versions of the same
service at the same time. This means that one StreamServer application can
create documents based on one Project version and one theme, and another
StreamServer application can create other documents based on a later version of
the same Project and another theme.
Note: The version of the Project file in CAS does not correspond to the
Project version set at release or export. For example, you can check in
several versions of a Project file without changing the Project version.
46.2.1 Redeploying the existing version of the Project

If you want your Project updates to be applied to both future documents and to
already paused documents in the Message repository, you can redeploy the existing
Project version to the same StreamServer application. For example, if you correct a
spelling error in a StoryTeller document.
Notes
• Applying Project changes to paused documents could affect the rendering or
other logic of the output.
• Not all Project changes can be applied to paused documents. For example, if
you add a new section to the StoryTeller template, this section will not be
rendered in paused documents.
• Some updates are always reflected when applying Project changes to paused
documents. For example, if you remove a section from the StoryTeller
template, this section will no longer be rendered in paused documents. Nor
will the removed section be rendered when previewing themes based on the
template.
Caution
To avoid version conflicts, you must never simultaneously run the same
export version of a Project, with different versions of a template, on
different StreamServer applications in the same domain.

Chapter 46 Modifying configurations
To redeploy the existing version of a Project
• In Control Center, redeploy the export file for the modified Project to the
Consequences for themes

• Modifications not affecting the template – Immediately reflected in themes.
• Modifications affecting the template – The new template version is available in
WorkShop. In WorkShop, the user can update the themes based on the template
to the new template version. After updating the template version, the user must
also disable batch mode for the previous version of the theme (that is, remove no
longer applicable domains). The server will use the latest version of a specific
theme if there are several batch-enabled versions of the theme.
Consequences for paused documents

• Modifications not affecting the template – Immediately reflected in paused
documents.
• Modifications affecting the template – A paused document in the Message
repository is locked to the service version that originally created the
corresponding Message. To preview and release the document, the specific
service version must be running. The service version will continue to use the
original theme, based on the original template.
46.2.2 Deploying a new version of the Project

To make sure that Project modifications are not applied to any paused documents in
the Message repository, you can create a new export version of the Project and
deploy this version to a separate StreamServer application. For example, if you
update a text in the StoryTeller document, but want already paused documents to be
completed with the original text.
Tip: If you run multiple versions of a Project on separate StreamServer

applications and the applications share resources for input data, you can
disable the input connectors for the applications that you do not want to
retrieve new input data.
You disable input connectors by editing the application properties in Control

Center.
To deploy a new export version of a Project
1. In Design Center, when you create a release for the modified Project or export
the modified Project, increase the Version number.
Note: When you increase the Project version number, the versions of all
included templates are automatically increased.
2. In Control Center, create a new StreamServer application.

46.2. Deploying updated configurations
3. In Control Center, deploy the export file for the modified Project to the
Consequences for themes

• The new template version is available in WorkShop. In WorkShop, the user can
then create new themes based on the new service version.
Consequences for paused documents

• A paused document in the Message repository is locked to the service version
that originally created the corresponding Message. To preview and release the
document, the specific service version must be running. The service version will
continue to use the original theme, based on the original template. No changes to
the Project are reflected in the output.

Part 9
Document tracking framework
Chapter 47
About the document tracking framework
This section describes how to configure a Design Center Project for use with the
document tracking framework.
The document tracking framework provides a way to track the lifecycle of

Communications Center documents. It can provide statistics about the number of
jobs sent, the resources used in output documents, and show status information for
individual jobs.
Configuring the document key

To use the document tracking framework, you must configure a document key
in the Project.
The document key is used to identify each unique document within a job.
During job processing, the document key is passed to the notification listener
and stored in document tracking repository with the tracking data. To allow
tracking of both documents and output connectors, the document key must be
configured for each output connector and Message you want to track. See
“Configuring the document key“ on page 703.
Configuring custom tracking attributes

You can also (optionally) configure other tracking attributes in the Project. For
example, if you want to add the invoice ID, customer ID, or another attribute to
the tracking data. Custom attributes are passed on to the notification listener
and stored in the document tracking repository. See “Configuring custom
tracking attributes (Optional) “ on page 707.
Related documentation
• For an overview of how the document tracking framework works and
information about how to install and configure the document tracking
framework, see Part VIII “Using the document tracking framework” in OpenText
Communications Center Enterprise - System Administration Guide (CCMSYS-AGD).

Chapter 48
Configuring the document key
The following steps are required to configure the document key:
• “Assigning the document key to the Messages and output connectors”

on page 703
• “Setting the value of the document key” on page 704
• “Mapping the document key” on page 705
48.1 Assigning the document key to the Messages

and output connectors
The type containing the property for the document key must be attached to each
Message and output connector you want to track.
Prerequisites
• A property for the document key is configured in the metadata model attached
to the Project. For more information, see “Metadata management” on page 361.
To assign the type with the document key to the Message
You must repeat these steps for all the Messages you want to track.
1. Open the Message node in the Project.
2. Right-click the Message and then click Set Custom Meta Types.
4. In the tree, select the type that contains the property for the document key.
5. Close the dialog box.
Tip: Before you close Define Custom Type dialog box, copy the GUID of the
document key property by right-clicking on the property and selecting Copy
Key.
You need the GUID to set the value of the property and again when you
configure the metadata_mapping.properties file.
See also “Finding the GUID of a property” on page 384.

Chapter 48 Configuring the document key
To assign the type with the document key to the output connector
You must repeat these steps for all the output connectors you want to track.
1. In Design Center, open the Runtime node.
2. Right-click an output connector and select Settings.
3. Select the output connector context and click OK.
4. In the Select layer list, click the generic Platform layer.
5. Depending on the output mode, click one of the following:
• Document End for output mode Document.

• Process Begin for output mode Process.
• Job End for output mode Job.
6. Click the Archiving tab.
7. Beside the Custom Type box, click .

a. In the Model version list, click the version of the model you want to use.
b. In the tree, select the type that contains the property for the document key.
8. Close the dialog boxes.
48.2 Setting the value of the document key

The value of the document key must be set for each Message and output connector
you want to track. Values are assigned with the following script functions:
• “setMetadataMessage” to assign the value on the Message

• “setMetadataOutput” to assign the value on the output connector
The location where you add the script functions is different for each output mode.
Table 48-1: Script location by output mode
Script location
Output mode Event (e.g. XMLIN) Message Process
Document - setMetadataMessage setMetadataOutput
Document (batch mode) setMetadataMessage - setMetadataOutput
Process setMetadataMessage - setMetadataOutput
Job setMetadataMessage - -

48.3. Mapping the document key
To set the value of the document key on the Message
1. Double-click the Message node in the Project.
2. Do one of the following:
• For Document output mode, right-click on the Message, and select Script.
• For Document (batch), Process, or Job output mode, right-click on the Event,
and select Script.
3. Add the script to set the value of the document key. For example:
// This variable is used for the tracking system - Do not remove

it!
$trackerDocKeyGUID = "03dfb844-a84a-492c-b439-c7fe8019bf71";
setMetadataMessage($trackerDocKeyGUID, $docKey);
Where:
• $trackerDocKeyGUID is the GUID that you copied earlier.
• $docKey is something that identifies the unique document within the job.
For example, $docKey = $customerID + $orderID where $customerID +
$orderID are defined as variables in the XMLIN event.
4. Close the Script Editor.
To set the value of the document key on the output connector
1. Double-click the Message node in the Project.
2. Right-click on the Process and select Script.
3. Add the script to set the value of the document key:
setMetadataOutput($trackerDocKeyGUID, $docKey);
4. Close the Script Editor.
48.3 Mapping the document key

You must map the GUID of the document key to the internal document tracking key
in the metadata_mapping.properties file. This configuration enables the
document key to be passed on to the notification listener.
Typically there is one metadata_mapping.properties file for each StreamServer

application, which is located in the working directory.
To map the GUID of the document key to the internal document key
1. Open the metadata_mapping.properties file for the StreamServer application

that will run the Project.

Chapter 48 Configuring the document key
2. Replace the variable <GUID.DocumentKey> with the GUID for the document
key.
# The document Key - This is mandatory mapping since the

document Key is part of the DB tables key
OTTracking.DocumentKey=<GUID.DocumentKey>
Example 48-1: Document key configuration
OTTracking.DocumentKey=03dfb844-a84a-492c-b439-c7fe8019bf71

Chapter 49
Configuring custom tracking attributes (Optional)
The document tracking framework collects data about a number of attributes by

default. It also provides the option to track up to five custom attributes. To do this,
you configure the attributes as properties in the metadata model and then assign
them to internal keys in the metadata_mapping.properties file.
In the metadata_mapping.properties file, the custom attributes have the following

preconfigured names:
• ObjectID
• ObjectType
• RecipientID
• RecipientName
• RecipientType
The names are used to map the attributes to columns in the document tracking
repository. You cannot change the names, however you can assign any property
from the metadata model to any of the custom attributes. This will then populate the
corresponding column in the TrackingDocuments table of the document tracking
repository with the property value.
To configure custom tracking attributes
1. In Describer, configure each custom attribute you want to track as a property in

the metadata model. For more information, see “Metadata management”
on page 361.
2. In Design Center, assign the types with the properties you want to track to the
Message. For information about how to assign a type to the Message, see “To
assign the type with the document key to the Message“ on page 703.
3. Set the value of each property on each Message with the Section 33.18.24
“setMetadataMessage” in OpenText Communications Center Enterprise - Scripting
Reference Guide (CCMPRJ-RSC)script function.
4. Open the metadata_mapping.properties file and uncomment an entry for

each property. For example, to track the recipient name, uncomment the line:
OTTracking.RecipientName=GUID.RecipientName
5. Add the GUID of the property to the entry.

For example, if the Recipient Name property in the metadata model has the key
(i.e. GUID) c71fc5c8-27dc-4ecf-bd01-aaaf6399df7, you would change this
entry to:

Chapter 49 Configuring custom tracking attributes (Optional)
OTTracking.RecipientName=c71fc5c8-27dc-4ecf-bd01-aaaf6399df7
For information about finding the GUID, see “Finding the GUID of a property”
on page 384.

Part 10
Security management
Chapter 50
About encryption and authentication
A StreamServer application can be configured as an SSL server or SSL client that

communicates over an encrypted HTTPS channel.
Authentication
An SSL server must always authenticate itself to all SSL clients, and the SSL
client must authenticate itself to the SSL server if the SSL server requires client
authentication.
S/MIME
Encryption and authentication can also be applied to data sent via email, where
the StreamServer application uses S/MIME to sign and encrypt/decrypt emails.
50.1 Digital certificates

SSL servers and clients use digital certificates for encryption and authentication. A
digital certificate is used to verify that a user sending a message is who he claims to
be, and to provide the receiver with the means to encode a reply.
Certificate Authority
A Certificate Authority (CA) is a trusted third-party organization or company
that issues digital certificates.
Certificate chain
A certificate chain is a tree structure of certificates. The validity of a certificate in
a certificate chain is verified by the certificate one level up in the tree. The root
node in the tree is the self signed root CA certificate.
Before the StreamServer can trust a certificate provided by an SSL server or
client, it must verify the complete certificate chain – up to the root CA certificate.
To be able to do this, it must have access to all certificates in the certificate chain.
Certificate chain example

In this example, a three level deep certificate chain consists of the following
certificates:
• Root CA certificate (level 1).
• Intermediate CA certificate (level 2).
• Subject certificate (level 3).
The level 1 and 2 certificates are available to the SSL client in this example, and
the level 3 certificate is sent by the SSL server to the SSL client.
1. The SSL client sends a request to an SSL server that returns the level 3
certificate.

Chapter 50 About encryption and authentication
2. The SSL client uses the public key embedded i the level 2 certificate to verify
the signature of the level 3 certificate, and to verify that the level 3 certificate
has not been revoked.
3. If the level 3 certificate is OK, the SSL client uses the public key embedded i
the level 1 certificate to verify the signature of the level 2 certificate, and to
verify that the level 2 certificate has not been revoked.
4. If the level 2 certificate is OK, the SSL client verifies the self signed level 1
certificate. It uses the public key embedded i the level 1 certificate to verify
the signature of the level 1 certificate, and to verify that the level 1 certificate
has not been revoked.
5. If all tests are OK, the complete certificate chain can be trusted, and the
identity and integrity of the level 3 certificate is verified.
50.2 Security configurations

In Design Center, digital certificates are managed using a specific resource type
called security configuration. There are two types of security configurations:
• Trust Server – all certificate information is retrieved from an XKMS (XML Key
Management Specification) compliant Trust Server. Only the certificate chain that
verifies the identity of the Trust Server is stored locally. See “Trust Server
security configurations” on page 715.
• Legacy – all certificate and private key data is stored locally. See “Legacy security
configurations” on page 724.
50.3 Entropy
When running on a Windows platform, the StreamServer uses a default entropy
source to generate randomness for SSL. When running on a UNIX platform, the
StreamServer searches for the entropy using the following sources:
• /dev/random
• /var/run/egd-pool
• /dev/egd-pool
• /etc/egd-pool
• /etc/entropy
• /dev/urandom
The StreamServer only uses the first source found in the list, starting at the top. You
must make sure that the appropriate entropy source is available.
Note: If no source is found in the list above, the StreamServer will use an
entropy source of low quality.

50.4. Trust Server administration
50.4 Trust Server administration

The Trust Server is installed separately. For information on how to administer the
Trust Server, see the documentation included in the Trust Server installation.

Chapter 51
Creating security configurations
You can create security configurations for different purposes. For example, if the
StreamServer is both an SSL server (specified using an HTTPS input connector) and
an SSL client (specified using an HTTPS Submit output connector or HTTPS Poll
input connector), you can create one security configuration for the server and
another for the client. Then you connect the server security configuration to the
HTTPS input connector, and the client security configuration to the HTTPS Submit
output connector.
Note: You should be experienced in the area of SSL and S/MIME to be able to
create security configurations.
51.1 Trust Server security configurations

If the StreamServer and all involved parties (SSL server/client and email sender/
receiver) are registered in a Trust Server, you can use Trust Server security
configurations. In this case all certificate information is retrieved from the Trust
Server, and only the certificates that verify the identity of the Trust Server are stored
locally.
Prerequisites
• The certificates that verify the identity of the Trust Server are added to the same
resource set as the security configuration.
• The certificates for all involved parties (SSL server/client and email sender/
receiver) are registered in the Trust Server.
To create a Trust Server security configuration
1. In a resource set, create a new Security Configuration resource.
2. Give the security configuration a unique name.
3. Open the security configuration and select the type Trust Server.
4. On the Certificates tab, add all the certificate resources to include in the
certificate chain used to verify the identity of the Trust Server.
5. On the Trust Server tab, enter the Trust Server URL, and the User name and
Password to access the Trust Server.
Depending on the purpose of the security configuration, you must also configure a
number of additional parameters:
• “Security configuration for an SSL server” on page 716

Chapter 51 Creating security configurations
• “Security configuration for an SSL client” on page 716

• “Security configuration for signing emails” on page 717
• “Security configuration for rejecting emails from non-trusted addresses”
on page 717
• “Security configuration for encrypting emails” on page 718
• “Security configuration for receiving encrypted emails” on page 718
51.1.1 Security configuration for an SSL server

You can run the StreamServer as an SSL server that communicates with one or more
SSL clients. To achieve this, you must create a security configuration and an HTTPS
input connector, and connect the security configuration to the HTTPS input
connector.
To create a security configuration
1. Create a new security configuration. See “To create a Trust Server security
configuration“ on page 715.
2. On the HTTP tab, enter the Key name and Passphrase to access the
StreamServer private key.
To connect the security configuration to the connector
1. Open the HTTPS input Connector Settings dialog box.

2. In the Security configuration field, browse to and select the security
configuration.
51.1.2 Security configuration for an SSL client

You can run the StreamServer as an SSL client that communicates with an SSL
server. To achieve this, you must create a security configuration and an HTTPS
Submit output connector (or HTTPS Poll input connector), and connect the security
configuration to the connector.
2. If the SSL server requires client authentication, you must also select the HTTP
tab and enter the Key name and Passphrase to access the StreamServer private
key.
To connect the security configuration to an HTTPS Submit output connector
1. Open the HTTPS Submit Output Connector Settings dialog box.

2. Select Use security configuration.

51.1. Trust Server security configurations

configuration.
To connect the security configuration to an HTTPS Poll input connector
1. Open the HTTPS Poll Input Connector Settings dialog box.

configuration.
51.1.3 Security configuration for signing emails

The StreamServer can sign emails. The email recipients use the signature to verify
that the email comes from a trusted address. To achieve this you must create a
security configuration for each From address, and enable signing of emails on the
output connector that delivers the emails (SMTP (MIME) or SMTP (MIME) for
MailOUT).
2. On the Email tab, enter the Key name and Passphrase to access the private key
for the From address.
To enable signing
• Open the email Output Connector Settings dialog box and select Sign.
51.1.4 Security configuration for rejecting emails from non-

trusted addresses
The StreamServer can reject emails from non-trusted addresses. The StreamServer
uses the sender's public key to verify the identity of the sender. To achieve this you
must create a security configuration, and enable rejection of emails on the EmailIN
input connector.
• Create a new security configuration. See “To create a Trust Server security
To enable rejection
1. Open the EmailIN input Connector Settings dialog box and select Retrieve
email > Advanced.
2. Select Request signature.

51.1.5 Security configuration for encrypting emails

The StreamServer can encrypt emails, and prevent emails from being sent to non-
trusted addresses. The StreamServer encrypts an email with the recipient's public
key. To achieve this you must create a security configuration, and enable encryption
of emails on the output connector that delivers the emails (SMTP (MIME) or SMTP
(MIME) for MailOUT).
• Create a new security configuration. See “To create a Trust Server security
To enable encryption
• Open the email Output Connector Settings dialog box and select Encrypt.
51.1.6 Security configuration for receiving encrypted emails

The StreamServer can decrypt received emails, and reject unencrypted emails. The
StreamServer decrypts emails with the private key. To achieve this you must create a
security configuration, and enable rejection of unencrypted emails on the EmailIN
input connector.
2. On the Email tab, enter the Key name and Passphrase to access the private key
for the recipient address.
To enable rejection of unencrypted emails
email > Advanced.
2. Select Request encryption.
51.2 Trust Server scenarios

51.2. Trust Server scenarios
51.2.1 SSL server and SSL client

This scenario involves the two StreamServers SERVER and CLIENT. The SERVER
communicates via an HTTPS input connector, and the CLIENT communicates via an
HTTPS Submit output connector.
Prerequisites
• Both SERVER and CLIENT use SSL version SSLv3.
• Both SERVER and CLIENT have the following resource in the default resource set:
• TS root.cer – the Trust Server CA root certificate. This is the only certificate in
the certificate chain.
Configuring the SERVER
To create the Security configuration
1. Add a security configuration to the default resource set and rename it to SSL
SERVER.
2. Open SSL SERVER and select the type Trust Server.
3. On the Certificates tab, add the certificate resource TS root.cer.
5. On the HTTP tab, enter the Key name and Passphrase to access the SERVER
private key.
To configure the HTTPS input connector
1. Select security configuration > SSL SERVER.
2. Select SSL Version > SSLv3.

Configuring the CLIENT
CLIENT.
2. Open SSL CLIENT and select the type Trust Server.
5. On the HTTP tab, enter the Key name and Passphrase to access the CLIENT
private key.
To configure the HTTPS Submit output connector
2. Select Security configuration > SSL CLIENT.
51.2.2 Encrypted emails

This scenario involves the two StreamServers SENDER and RECEIVER. The SENDER
sends encrypted emails to the RECEIVER via an SMTP (MIME) output connector, and
the RECEIVER receives the emails via an EmailIN input connector.
Prerequisites
Both SENDER and RECEIVER have the following resource in the default resource
set:
• TS root.cer – the Trust Server CA root certificate. This is the only certificate
in the certificate chain.

Configuring the SENDER
1. Add a security configuration to the default resource set and rename it to

ENCRYPT.
2. Open ENCRYPT and select the type Trust Server.
To configure the SMTP (MIME) output connector
• Select Encrypt.
Configuring the RECEIVER

DECRYPT.
2. Open DECRYPT and select the type Trust Server.
5. On the Email tab, enter the Key name and Passphrase to access the private
key for the recipient address.
To configure the EmailIN input connector
1. Select Retrieve email > Advanced.
51.2.3 Signed emails

sends signed emails to the RECEIVER via an SMTP (MIME) output connector, and the
RECEIVER receives the emails via an EmailIN input connector.

Prerequisites
set:

SIGN.
2. Open SIGN and select the type Trust Server.
key for the sender address.
• Select Sign.

SIGNED.
2. Open SIGNED and select the type Trust Server.


51.2.4 Encrypted and signed emails

sends signed and encrypted emails to the RECEIVER via an SMTP (MIME) output
connector, and the RECEIVER receives the emails via an EmailIN input connector.
Prerequisites
set:

SIGN_ENCRYPT.
2. Open SIGN_ENCRYPT and select the type Trust Server.

key for the sender address.

• Select Sign and Encrypt.

SIGNED_ENCRYPTED.
2. Open SIGNED_ENCRYPTED and select the type Trust Server.

key for the recipient address.

2. Select Request signature and Request encryption.
51.3 Legacy security configurations

If the StreamServer, or any of the involved parties (SSL server/client and email
sender/receiver), are not registered in a Trust Server, you can create security
configurations using locally stored certificates.
To create a Legacy security configuration
1. In a resource set, create a new Security Configuration resource.

2. Give the security configuration a unique name.
3. Open the security configuration and select the type Legacy.
Depending on the purpose of the security configuration, you must also configure a
number of additional parameters:
• “Security configuration for an SSL server (with client authentication)”
on page 725.
• “Security configuration for an SSL server (without client authentication)”
on page 726.
• “Security configuration for an SSL client (with client authentication)”
on page 726.
• “Security configuration for an SSL client (without client authentication)”
on page 727.

51.3. Legacy security configurations
• “Security configuration for signing emails” on page 728.

• “Security configuration for rejecting emails from non-trusted addresses”
on page 729.
• “Security configuration for encrypting emails” on page 729.
• “Security configuration for receiving encrypted emails” on page 730.
51.3.1 Security configuration for an SSL server (with client

authentication)
You can run the StreamServer as an SSL server that requires client authentication. To
achieve this, you must create a security configuration and an HTTPS input
connector, and connect the security configuration to the HTTPS input connector.
Multiple clients
If the StreamServer communicates with multiple clients, you must:
• Create one security configuration per client.
• Create one HTTPS input connector per client. These connectors cannot share
the same port.
Prerequisites
• The StreamServer private key file is added to the same resource set as the
security configuration.
• The StreamServer CA root certificate is distributed to the clients.
• The certificates that verify the identity of the client are added to the same
• The client certificate is added to the same resource set as the security
configuration.
1. Create a new security configuration. See “To create a Legacy security

certificate chain used to verify the identity of the client.
3. Click the HTTP Server tab.
4. Select the StreamServer Private key file and enter the Password to access the
private key.
5. Select Client authentication and select the Client certificate.


configuration.
51.3.2 Security configuration for an SSL server (without client

authentication)
You can run the StreamServer as an SSL server that does not require client
authentication. To achieve this, you must create a security configuration and an
HTTPS input connector, and connect the security configuration to the HTTPS input
connector.
Prerequisites
• The StreamServer CA root certificate is distributed to the clients.

2. Click the HTTP Server tab.
private key.

configuration.
51.3.3 Security configuration for an SSL client (with client

authentication)
You can run the StreamServer as an SSL client that communicates with an SSL server
that requires client authentication. To achieve this, you must create a security
configuration and an HTTPS Submit output connector (or HTTPS Poll input
connector), and connect the security configuration to the connector.
Prerequisites
• The certificates that verify the identity of the SSL server are added to the
same resource set as the security configuration.
• The StreamServer CA root certificate and client certificate are distributed to
the SSL server.


certificate chain used to verify the identity of the SSL server.
3. Click the Email and HTTP client tab.
private key.

configuration.

configuration.
51.3.4 Security configuration for an SSL client (without client

authentication)
You can run the StreamServer as an SSL client that communicates with an SSL server
that does not require client authentication. To achieve this, you must create a
security configuration and an HTTPS Submit output connector (or HTTPS Poll input
connector), and connect the security configuration to the connector.
Prerequisites
The certificates that verify the identity of the SSL server are added to the same

certificate chain used to verify the identity of the SSL server.


configuration.

configuration.
51.3.5 Security configuration for signing emails

The StreamServer can sign emails. Email recipients use the signature to verify that
the email comes from a trusted address. To achieve this you must create a security
configuration for each From address, and enable signing of emails on the output
connector that delivers the emails (SMTP (MIME) or SMTP (MIME) for MailOUT).
Prerequisites
• The StreamServer CA root certificate is distributed to the recipients.

private key.
To enable signing
• Open the email Output Connector Settings dialog box and select Sign.

51.3.6 Security configuration for rejecting emails from non-

trusted addresses
The StreamServer can reject emails from non-trusted addresses. The StreamServer
uses the sender's public key to verify the identity of the sender. To achieve this you
must create a security configuration, and enable rejection of emails on the EmailIN
input connector.
Prerequisites
• The certificates that verify the identity of the email sender are added to the
same resource set as the security configuration.
• If the email senders have different CA root certificates, you must create one
security configuration for each CA root certificate.

certificate chain used to verify the identity of the email sender.
To enable rejection
email > Advanced.
51.3.7 Security configuration for encrypting emails

The StreamServer can encrypt emails, and prevent emails from being sent to non-
trusted addresses. The StreamServer encrypts an email with the recipient's public
key. To achieve this you must create a security configuration, and enable encryption
of emails on the output connector that delivers the emails (SMTP (MIME) or SMTP
(MIME) for MailOUT).
Prerequisites
The encryption certificates for all email addresses are added to the same
resource set as the security configuration. Each certificate resource must be
renamed to <email address>.crt, for example arnold_abc.com.crt.
Note: You must not use "@" – use "_" instead.
• Create a new security configuration. See “To create a Legacy security


To enable encryption
• Open the email Output Connector Settings dialog box and select Encrypt.
51.3.8 Security configuration for receiving encrypted emails

The StreamServer can decrypt received emails, and reject unencrypted emails. The
StreamServer decrypts emails with the private key.
To achieve this you must create a security configuration, and enable rejection of
unencrypted emails on the EmailIN input connector.
Prerequisites
• The StreamServer email certificate is distributed to the senders.

private key.
To enable rejection of unencrypted emails
email > Advanced.
51.4 Legacy scenarios

51.4.1 SSL server and SSL client with client authentication
HTTPS Submit output connector. The CLIENT must authenticate itself to SERVER.

51.4. Legacy scenarios
Prerequisites

• SERVER has the following resources in the default resource set:
• Private key.pfx – the private key file for SERVER.

• CLIENT CA root certificate.crt – the CA root certificate for CLIENT.
This is the only certificate in the certificate chain.
• CLIENT public key.crt – the certificate for CLIENT.
• CLIENT has the following resources in the default resource set:
• SERVER CA root certificate.crt – the CA root certificate for SERVER.

• Private key.pfx – the private key file for CLIENT.
SERVER.
2. Open SSL SERVER and select the type Legacy.
3. On the Certificates tab, add the certificate resource CLIENT CA root

certificate.crt.
4. On the HTTP Server tab, select Private key file > Private key.pfx and enter
the Password to access the private key.
5. Select Client authentication and select Client certificate > CLIENT public
key.crt.


CLIENT.
2. Open SSL CLIENT and select the type Legacy.

3. On the Certificates tab, add the certificate resource SERVER CA root
certificate.crt.
4. On the Email and HTTP client tab, select Private key file > Private key.pfx
and enter the Password to access the private key.

51.4.2 SSL server and SSL client without client authentication

HTTPS Submit output connector. The CLIENT does not authenticate itself to SERVER.
Prerequisites
• SERVER has the following resource in the default resource set:
• Private key.pfx – the private key file for SERVER.

• CLIENT has the following resource in the default resource set:
• SERVER CA root certificate.crt – the CA root certificate for SERVER.

SERVER.
2. Open SSL SERVER and select the type Legacy.

3. On the HTTP Server tab, select Private key file > Private key.pfx and enter
the Password to access the private key.
CLIENT.
2. Open SSL CLIENT and select the type Legacy.
3. On the Certificates tab, add the certificate resource SERVER CA root

certificate.crt.

51.4.3 Encrypted emails

sends encrypted emails to the RECEIVER via an SMTP (MIME) output connector, and
the RECEIVER receives the emails via an EmailIN input connector.
Prerequisites
• SENDER has the following resource in the default resource set:
• info_abc.com.crt – the encryption certificate for RECEIVER.

• RECEIVER has the following resource in the default resource set:
• Private key.p12 – the private key file for RECEIVER.

ENCRYPT.
2. Open ENCRYPT and select the type Legacy.
• Select Encrypt.

ENCRYPTED.
2. Open ENCRYPTED and select the type Legacy.
3. On the Email and HTTP client tab, select Private key file > Private key.p12

51.4.4 Signed emails

sends signed emails to the RECEIVER via an SMTP (MIME) output connector, and the
RECEIVER receives the emails via an EmailIN input connector.
Prerequisites
• SENDER has the following resource in the default resource set:
• Private key.p12 – the private key file for SENDER.

• RECEIVER has the following resource in the default resource set:
• SENDER CA root certificate.crt – the CA root certificate for SENDER.


SIGN.
2. Open SIGN and select the type Legacy.
• Select Sign.


SIGNED.
2. Open SIGNED and select the type Legacy.
3. On the Certificates tab, add the certificate resource SENDER CA root

certificate.crt.
51.4.5 Signed and encrypted emails

sends signed and encrypted emails to the RECEIVER via an SMTP (MIME) output
connector, and the RECEIVER receives the emails via an EmailIN input connector.
Prerequisites
• SENDER has the following resources in the default resource set:
• info_abc.com.crt – the encryption certificate for RECEIVER.

• Private key.p12 – the private key file for SENDER.
• RECEIVER has the following resources in the default resource set:
• Private key.p12 – the private key file for RECEIVER.

• SENDER CA root certificate.crt – the CA root certificate for SENDER.

51.5. Security configuration GUI reference

SIGN ENCRYPT.
2. Open SIGN ENCRYPT and select the type Legacy.
• Select Sign and Encrypt.

SIGNED ENCRYPTED.
2. Open SIGNED ENCRYPTED and select the type Legacy.
3. On the Certificates tab, add the certificate resource SENDER CA root

certificate.crt.
2. Select Request signature and Request encryption.
51.5 Security configuration GUI reference

Security configuration type
• Trust Server
All certificate information is retrieved from an XKMS (XML Key Management
Specification) compliant Trust Server. Only the root CA that verifies the identity
of the Trust Server is stored in a file. See “Trust Server settings” on page 738.
• Legacy
All digital certificates are stored locally. See “Legacy settings” on page 739.

51.5.1 Trust Server settings

Certificates tab
On the Certificates tab, you add all certificate resources to include in the
certificate chain used to verify the identity of the Trust Server.
Trust Server tab settings
On the Trust Server tab you specify the connection to the Trust Server.
• URL
The Trust Server URL.
• User
The user name to access the Trust Server.
• Password
The password to access the Trust Server.
HTTP tab settings
Use the HTTP tab when the StreamServer must authenticate itself to SSL clients or
SSL servers. On this tab you enable access to the StreamServer private key.
• Key name
The key name assigned to the StreamServer when it was registered in the Trust
Server. The key name corresponds to a private key.
• Passphrase
The passphrase the StreamServer must use to access the private key.
Email tab settings
Use the Email tab when the StreamServer must sign or decrypt emails. On this tab
you enable access to the StreamServer private key.
• Key name
The key name assigned to the StreamServer when it was registered in the Trust
Server. The key name corresponds to a private key.
• Passphrase
The passphrase the StreamServer must use to access the private key.

51.5. Security configuration GUI reference
51.5.2 Legacy settings

Certificates tab
On the Certificates tab, you add all certificate resources to include in the
certificate chain used to verify the identity of the SSL server or SSL client.
HTTP Server tab settings
Use the HTTP Server tab when the StreamServer runs as an SSL server. On this tab
you enable access to the StreamServer private key and, if required, the client
certificate.
• Private key file
The private key file the StreamServer must use to authenticate itself. The private
key file must be included in the same resource set as the security configuration.
• Password
The password the StreamServer must use to access the private key file.
• Client Authentication
Select if this StreamServer requires client authentication.
• Client certificate
The client certificate. The StreamServer must use this certificate to verify the
identity of the client. The client certificate must be included in the same resource
set as the security configuration.
Email and HTTP Client tab settings
Use the Email and HTTP Client tab when the StreamServer runs as an SSL client that
must authenticate itself to the SSL server, or when it should sign or decrypt emails.
• Private key file
The private key file the StreamServer must use to authenticate itself or to decrypt
emails. The private key file must be included in the same resource set as the
• Password
The password the StreamServer must use to access the private key file.

Part 11
Utilities
Chapter 52
I/O Delegator
Communications Center I/O Delegator is a command line utility that acts as an

integration tool between a client application and a StreamServer application. The
StreamServer application runs continuously and I/O Delegator starts and stops as
jobs are received and completed. This eliminates the time that is wasted when
starting and stopping the StreamServer application for smaller jobs.
By default, I/O Delegator receives input via StdIn and delivers output via StdOut.
You can use arguments in the command to specify other input and output channels
when you run I/O Delegator.
I/O Delegator can enhance performance significantly when a StreamServer

application is used with, for example, the following spooling systems:
• Dazel
• Macro4
• Infoprint Manager
• UNIX spooling system
52.1 Running I/O Delegator

The strsIODelegator executable and the iod_logmsg.txt file must be installed in
the same directory. By default, they are installed in the following path relative to the
Communications Center installation directory:
Applications\StreamServer\<version>\Server
Modes
I/O Delegator can operate in different modes:

• Service request mode. See “Running I/O Delegator in service request mode”
on page 744.
• HTTP mode. See “Running I/O Delegator in HTTP mode” on page 746.
• File mode. See “Running I/O Delegator in File mode” on page 747.

Chapter 52 I/O Delegator
52.1.1 Running I/O Delegator in service request mode

When running in service request mode, I/O Delegator uses service calls to invoke the
StreamServer application that will process the data delivered via I/O Delegator. The
service is exposed via a Service Request input connector configured in the Design
Center Project that is exported and deployed to the StreamServer application.
I/O Delegator delivers the data to the StreamServer application via the Service
Request input connector. The StreamServer application processes the data and
delivers the output via the appropriate output connector. The output can be
returned in the response to I/O Delegator if this is enabled in the Design Center
Project.
The web service (WSJobSubmit) that controls the communication between I/O
Delegator and the StreamServer application is hosted by a service gateway. This
service gateway must be running in the same domain as the StreamServer
application.
52.1.1.1 Configuring a StreamServer application to handle service

requests
You must export and deploy a Design Center Project that includes a Service Request
input connector to the StreamServer application to be invoked by the service
request. I/O Delegator will use the service name specified in the connector in the
service request and deliver the data via this connector.
If you want the StreamServer application to be able to return the output in the
response to I/O Delegator you must enable this in the Design Center Project.
To configure the Service Request input connector
1. In the Connector Type drop-down list, select Service Request.
2. In the Request type drop-down list, select Generic.
3. Enter the appropriate Service name.
To enable the output to be returned in the response
2. Double-click the output connector that delivers the output. The Output
Connector Settings dialog box opens.
3. Click the General icon and select Include result in service response.
4. Click OK.

52.1. Running I/O Delegator
52.1.1.2 Running I/O Delegator

I/O Delegator can be run from a command prompt in the directory where
strsIoDelegator.exe is located. The command to run I/O Delegator includes
several arguments. See “I/O Delegator arguments” on page 750.
Windows command to run I/O Delegator in service request mode
StrsIODelegator -servicerequestmode <argument2>...<argumentN>
UNIX command to run I/O Delegator in service request mode
./StreamServe StrsIODelegator -servicerequestmode

<argument2>...<argumentN>
Example 52-1: Submit data from StdIn and do not wait for response
(Windows)
This command submits input data from StdIn to the service named
myService.
I/O Delegator exits without waiting for the job to complete.
StrsIODelegator -servicerequestmode -url http://localhost:

2718
-user tntadmin -pwd TenantQa123$ -servicename myService -
submittype FireAndForget
Example 52-2: Submit data from file wait for response (Windows)
This command submits input data from the file in.txt to the service named
myService. I/O Delegator waits for the response and stores each received
document as a separate file in the output directory out.
StrsIODelegator -servicerequestmode -url http://localhost:

2718
-user tntadmin -pwd TenantQa123$ -servicename myService -
submittype FireAndWaitResult -input in.txt -outputdir out

52.1.2 Running I/O Delegator in HTTP mode

To run I/O delegator in HTTP mode you must use an HTTP input connector for the
input and an HTTP response output connector for the response.
Configuring the input connector

You must use a queue enabled HTTP input connector for the input where you
specify the resource where jobs should be sent and optionally authentication
settings.
To configure the HTTP input connector
1. In the Input Connector Settings dialog box for the HTTP connector (physical
layer), click Queue and then select the appropriate input Queue.
2. Switch to the generic layer and click Connector.
3. On the Connector Settings tab, enter a Job resource URI. This identifies the
resource where jobs should be sent, for example /
4. Optional If you want to run I/O Delegator with authentication, you must
a. In the Authentication field, select Basic.

b. Click HTTP Realms and add an HTTP realm.
Starting I/O Delegator

You start I/O Delegator from a command prompt where you enter the I/O Delegator
command and arguments. You can enter the arguments directly in the command.
You can also specify the arguments in a file and use this file as argument in the
command:
-a <filename>
For a description of the arguments, see “HTTP mode arguments” on page 759 and
“Arguments applicable to all modes” on page 752.
Notes
• If you have specified HTTP authentication for the Connector, you must
specify a user name, password and realm by using the user, pwd and realm
arguments.
• If you specify the same argument more than once with different options, the
last argument specified is used.
To start I/O Delegator in HTTP mode in Windows
1. Open a command prompt and browse to the directory where

strsIoDelegator.exe is located.
2. Enter the following command:

StrsIODelegator -httpmode <argument2>...<argumentN>.
To start I/O Delegator in HTTP mode in UNIX


./StreamServe StrsIODelegator -httpmode <argument2>...<argumentN>.
Example 52-3: Starting I/O Delegator in HTTP mode
In this example you start I/O Delegator specifying the following:
• HTTP mode
• A reference to the file containing one or more URLs for StreamServer
• Log level 4
• Verbose level 2
• An argument (-quiet) to filter out two unwanted lines from the response
file, when delivering output via StdOut. This argument is not necessary if
you specify the output file in an argument file (using the -output
argument) instead of on the command line.
• An XML file that will be converted by StreamServer to a PDF file.
Windows command:
StrsIODelegator -httpmode -urlf ./urlfile.txt -ll 4 -verbose 2 -

quiet <./grb/filein.xml >./iodelout/fileout.pdf
UNIX command:
./StreamServe StrsIODelegator -httpmode -urlf ./urlfile.txt -ll 4

-verbose 2 -quiet <./grb/filein.xml >./iodelout/fileout.pdf
52.1.3 Running I/O Delegator in File mode

To run I/O Delegator in File mode, you must use a Directory input connector for the
input and a File output connector for the output.
Configuring the output connector

You must use a File output connector for the output. The file name must exactly
match name of the incoming file. To retrieve the name of the incoming file you must
use scripting, for example:
$fileName="stdout\" + CurrInFileName()

To configure the File output Connector
• In the Input Connector Settings dialog box for the File output connector
(physical layer), specify a File name that exactly matches the name of the
incoming file.
Starting I/O Delegator

You start I/O Delegator from a command prompt where you enter the I/O Delegator
command and arguments. You can enter the arguments directly in the command.
You can also specify the arguments in a file and use this file as argument in the
command:
-a <filename>
For a description of the arguments, see “File mode arguments” on page 762 and
“Arguments applicable to all modes” on page 752.
Note: If you specify the same argument more than once with different options,
only the last argument specified is used.
To start I/O Delegator in File mode in Windows


StrsIODelegator -filemode <argument2>...<argumentN>.
To start I/O Delegator in File mode in UNIX


./StreamServe StrsIODelegator -filemode <argument2>...<argumentN>.
Example 52-4: Starting I/O Delegator in File mode
In this example you start I/O Delegator specifying the following:

• File mode
• The input spool directory
• The output directory
• An XML file that will be converted by StreamServer to a PDF file.
Windows command:
StrsIODelegator -filemode -sid ./spool -sod ./out -input ./grb/

filein.xml -output ./iodelout/fileout.pdf

UNIX command:
./StreamServe StrsIODelegator -filemode -sid ./spool -sod ./out -

input ./grb/filein.xml -output ./iodelout/fileout.pdf
File handling
A file that is sent to I/O Delegator for processing in StreamServer is renamed to a
unique name by I/O Delegator. This avoids different files with identical names being
sent to StreamServer simultaneously. In File mode, you can specify a prefix and a
file extension for the file to be sent to StreamServer. If you do not specify anything,
the file will be given a name that consists of the following:
• a number read from a file. By default this file is nextid.txt. You can use the -
idfile argument to specify a different file.
• a file extension which is txt
For example, a file can be named 349.txt
Specifying prefix and postfix

You can specify a prefix and a file extension for the file to be sent to
StreamServer. If you:
• specify the -pre argument file, the file will be named file349.txt.
• specify the -post argument .dat, the file will be called 349.dat.
You can combine the arguments to give the file the name file349.dat. When
the output file is returned to I/O Delegator by StreamServer, the file is identified
by the file name including the prefix and file extension. The file must be created
using the same name as the input file.
Specifying a file extension for the error file

In File mode, you can specify the -efpost argument with a value, for
example .err, to receive error files. This can be useful if the client application
cannot interpret the data sent to StdIn.
To enable error files to be sent back to the client application, StreamServer must
be setup with the same name of the error file as the input file sent to
StreamServer. For example, if the file received by StreamServer is called
file349.dat, the file returned from StreamServer must be called file349.
dat.err.

52.1.4 Time-outs
You can specify the following time-out parameters:
• CTO
Connection time-out (only applicable to HTTP mode). The time to wait for a
HTTP connection to be established between I/O Delegator and StreamServer. The
default value is 30 seconds.
• ATO
Answer timeout. The time to wait for StreamServer to finish processing the job.
The default value is 300 seconds.
• FTO
File time-out (only applicable to File mode). The time to wait for the output file to
be generated by StreamServer. It is also the time to wait for the next unique
filename to be generated according to the id file, which by default is nextid.txt.
52.2 I/O Delegator arguments

This chapter describes the I/O Delegator arguments that can be specified for
StrsIODelegator.exe.
52.2.1 Mode selection arguments

Use the following arguments to specify the mode or to display information on error
codes:
• “-servicerequestmode ” – specifies service request mode for I/O Delegator.

• “-httpmode” – specifies HTTP mode for I/O Delegator.
• “-filemode” – specifies File mode for I/O Delegator.
• “-err” – displays information about an error code.

52.2. I/O Delegator arguments
52.2.1.1 -servicerequestmode
Syntax
StrsIODelegator -servicerequestmode
Description
Specifies service request mode for I/O Delegator.
Example
StrsIODelegator -servicerequestmode -url http://localhost:2718
-user tntadmin -pwd TenantQa123$-servicename MyService -

submittype FireAndForget
52.2.1.2 -httpmode
Syntax
StrsIODelegator -httpmode
Description
Specifies HTTP mode for I/O Delegator.
Example
StrsIODelegator -httpmode -urlf ./urlfile.txt

-ll 4 -verbose 2 <./grb/filein.xml>./iodelout/fileout.pdf
52.2.1.3 -filemode
Syntax
StrsIODelegator -filemode
Description
Specifies File mode for I/O Delegator.
Example
StrsIODelegator -filemode -sid ./spool

-sod ./out <./grb/filein.xml>./iodelout/fileout.pdf

52.2.1.4 -err
Syntax
-err <errorcode>
Description
Displays information about an error code. See “Error codes on StdErr”
on page 765. You will be able to see this error code on StdErr if -verbose 1 is
used. See “-verbose” on page 753.
Example
StrsIODelegator -err 40802301
52.2.2 Arguments applicable to all modes

You can use the following arguments in all modes:
• “-a” – a text file that contains arguments for I/O Delegator

• “-td” – the path to the temp directory.
• “-verbose” – activates the output of error information to StdErr.
• “-log” – a log file name.
• “-ll” – the log level (0-4).
• “-ato”“-cto” – time to wait for StreamServer to finish processing a job.
52.2.2.1 -a
Syntax
-a <filename>
Description
Specifies a text file that contains arguments for I/O Delegator.
Comment
Optional. Enter only one argument per row in the file.
Example
-a argumentfile.arg
Example of argument file
-urlf ./urlfile.txt
-ll 2
-verbose 2

52.2.2.2 -td
Syntax
-td <temp_dir_path>
Description
Specifies the path to the temp directory.
Comment
Optional. The default value is “.”.
Example
-td ./tempdir
52.2.2.3 -verbose
Syntax
-verbose <option>
Description
Activates the output of error information to StdErr. The options are:
• 0 - deactivated
• 1 - An error code is sent to StdErr. The client application can interpret and
take actions based on this error code.
• 2 - As option 1 but an error message text is also displayed.
Comment
Optional. The default value is 0, but if you specify
-verbose without option, the default option is 1.
Example
-verbose 2
52.2.2.4 -log
Syntax
-log <logfile>
Description
Specifies a log file name.
Comment
Optional. The default value is iod_log.txt.
Example
-log mylog.txt

52.2.2.5 -ll
Syntax
-ll <loglevel>
Description
Specifies the log level (0-4). A higher value gives more information.
Comment
Optional
Example
-ll 4
52.2.2.6 -ato
Syntax
-ato <time-out>
Description
Specifies the number of seconds to wait for the StreamServer application to
finish processing the job. See “File handling” on page 749.
Comment
Optional. The default value is 300, and the maximum value is 2000000. For
HTTP mode, you must set the Response time-out on the HTTP connector
accordingly to make sure that the -ato value will be correct.
Example
-ato 500
52.2.3 Service request mode arguments

You can use the following arguments in HTTP mode:
• “-url ” – URL to the service gateway hosting the service to invoke.
• “-servicename ” – name of the service to invoke.
• “-serviceversion ” – version of the service to invoke.
• “-submittype ” – the type of service to invoke.
• “-sslversion ” – SSL version. (sslv3 or tlsv1).
• “-sslauthentication ” – SSL authentication type.
• “-input ” – Redirects the input from StdIn to a file.
• “-output ” – Redirects the output from StdOut to a file.
• “-outputdir ” – Redirects the output from StdOut to an output directory.

• “-var ” – Specifies variables as name-value pairs.
See also “Arguments applicable to all modes” on page 752.
52.2.3.1 -url
Syntax
-url <host:port>
Description
The URL to the service gateway hosting the service to invoke.
Comment
Mandatory argument.
Example
-url http://localhost:2718
52.2.3.2 -servicename
Syntax
-servicename <name>
Description
The name of the service to invoke.
Comment
Mandatory argument.
Example
-servicename myService
52.2.3.3 -serviceversion
Syntax
-serviceversion <version_number>
Description
The version of the service to invoke.
Comment
Optional argument. If you do not specify a version, the latest version of the
service will be used.
Example
-serviceversion 2

52.2.3.4 -submittype
Syntax
-submittype <type>
Description
The type of service. Can be one of the following:
• FireAndForget – I/O Delegator does not wait for any response. It exits after
the request is sent, and delivers no output.
• FireAndWaitNoResult – I/O Delegator waits for a response before it exits.
No output is delivered.
• FireAndWaitResult – I/O Delegator waits for a response before it exits.
Output is delivered via StdOut or to a path specified by the “-outputdir ”
on page 758 or “-output ” on page 757 argument.
Comment
Optional argument. Default is FireAndWaitResult.
Example
-submittype FireAndForget
52.2.3.5 -sslversion
Syntax
-sslversion <version>
Description
SSL version. Used if SSL communication is configured for the service gateway
(https://<host:port> in -url argument). Can be one of the following:
• sslv3
• tlsv1
Comment
Optional argument. Default is sslv3.
Example
-sslversion tlsv1

52.2.3.6 -sslauthentication
Syntax
-sslauthentication <type>
Description
SSL authentication type. Used if SSL communication is configured for the
service gateway (https://<host:port> in -url argument). Can be one of the
following:
• mandatory
• optional
• anonymous
Comment
Optional argument. Default is mandatory.
Example
-sslauthentication anonymous
52.2.3.7 -input
Syntax
-input <path>
Description
Redirects the input from StdIn to the file specified in <path>.
Comment
Optional argument. The path is either an absolute path or a path relative to the
directory where strsIoDelegator.exe is located.
Example
-input in.txt
52.2.3.8 -output
Syntax
-output <path>
Description
Redirects the output from StdOut to the file specified in <path>.
Comments
Optional argument. The path is either an absolute path or a path relative to the
directory where strsIoDelegator.exe is located.
If -submittype FireAndWaitResult and -outputdir is included in the
command, -output is ignored (i.e. -outputdir overrides -output).

Example
-output out.txt
52.2.3.9 -outputdir
Syntax
-outputdir <path>
Description
Redirects the output from StdOut to the directory specified in <path>. All
documents received in the response are stored as separate files in this directory,
and no data is sent to StdOut.
Comments
Optional argument. Applicable only if -submittype is FireAndWaitResult.
The path is either an absolute path or a path relative to the directory where
Example
-outputdir out
52.2.3.10 -var
Syntax
-var <name>=<value>
Description
Specifies variables as name-value pairs. These values are sent to the
StreamServer application as HTTP header values.
Comment
Optional. To fetch the value of the variable, use the GetHttpHeaderValue script
function:
$servervariable=GetHttpHeaderValue("<name>");
It is recommended that you fetch the variable before the first Event.
Example
-var lang=eng
The variable lang is given the value eng.
-var "test=print on \"pcl\""
The variable test is given the value print on "pcl".

Example of how to fetch the variable:
$language=GetHttpHeaderValue("lang");

52.2.4 HTTP mode arguments

You can use the following arguments in HTTP mode:
• “-url” – URL to the StreamServer application.
• “-urlf” – a file containing one or more URLs.
• “-user” – user name for logging on to the StreamServer application.
• “-pwd” – password for logging on to the StreamServer application.
• “-realm” – realm set up in the StreamServer application.
• “-cto” – time to wait for a connection to the StreamServer application.
• “-input” – a file to use instead of StdIn.
• “-output” – a file to use instead of StdOut.
• “-var” – a variable and its value.
52.2.4.1 -url
Syntax
-url <url>
Description
Specifies the URL of the HTTP input Connector.
Comment
Optional. The default value is:
http://127.0.0.1/iodelegator
See also “-urlf” on page 759.
Example
-url http://localhost:8192/iodelegator
52.2.4.2 -urlf
Syntax
-urlf <filename>
Description
Specifies a file containing one or more URLs. Enter only one URL per row in the
file.
Comment
Optional.

Example
-urlf myurlfile.txt
52.2.4.3 -user
Syntax
-user <username>
Description
Specifies the user name for logging on to the StreamServer application.
Comment
Optional. Must be used together with the pwd and realm arguments if you have
specified Basic authentication for the connector.
Example
-user billy
52.2.4.4 -pwd
Syntax
-pwd <password>
Description
Specifies a password for logging on to the StreamServer application.
Comment
specified basic authentication for the connector.
Example
-pwd mypassword
52.2.4.5 -realm
Syntax
-realm <realm>
Description
Specifies the realm set up in the StreamServer application.
Comment
specified basic authentication for the connector.
Example
-realm StreamServeUsers

52.2.4.6 -cto
Syntax
-cto <time-out>
Description
Specifies the number of seconds to wait for the connection to the HTTP input
Connector to be established at startup. See “File handling” on page 749.
Comment
Optional. The default value is 30 seconds.
Example
-cto 5
52.2.4.7 -input
Syntax
-input <filename>
Description
Specifies a file to use instead of StdIn (<)
Comment
Optional. The input argument must be used instead of StdIn if you want to
specify the input file in an argument file instead of on the command line.
Example
-input myinputfile
52.2.4.8 -output
Syntax
-output <filename>
Description
Specifies a file to use instead of StdOut.
Comment
Optional. The output argument must be used instead of StdOut if you want to
specify the output file in an argument file instead of on the command line.
Example
-output myoutputfile

52.2.4.9 -var
Syntax
-var <name>=<value>
Description
Specifies a variable and its value. These values will be sent to the StreamServer
application as HTTP header values.
Comment
Optional.
To fetch the value of the variable, use the following scripting command:
$servervariable =gethttpheadervalue("valuename");
It is recommended that you fetch the variable before the first Event.
Example
-var lang=eng
The variable lang is given the value eng.
-var "test=print on \"pcl\""
The variable test is given the value print on "pcl".

Example of how to fetch the variable:
$language=gethttpheadervalue("lang");
52.2.5 File mode arguments

You can use following arguments in File mode:
• “-fto” – time to wait for file access.

• “-sid” – the server input directory.
• “-sod” – the server output directory.
• “-pre” – a prefix to use for the name of the file that will be sent to the
• “-post” – a file extension to use for the file to send to the StreamServer
application.
• “-efpost” – Activates checking for a file that indicates errors.
• “-idfile” – the name of the file that contains the next id to use for the output file.

52.2.5.1 -fto
Syntax
-fto <time-out>
Description
Specifies the time-out in number of seconds to wait for file access. See “File
handling” on page 749.
Comment
Optional. The default value is 30 seconds.
Example
-fto 50
52.2.5.2 -sid
Syntax
-sid <directory>
Description
Specifies the server input directory.
Comment
Required.
Example
-sid .\spool
52.2.5.3 -sod
Syntax
-sod <directory>
Description
Specifies the server output directory.
Comment
Required.
Example
-sod .\out

52.2.5.4 -pre
Syntax
-pre <prefix>
Description
Specifies a prefix to use for the name of the file that will be sent to the
StreamServer application. See “File handling” on page 749.
Comment
Optional
Example
-pre file
52.2.5.5 -post
Syntax
-post <postfix>
Description
Specifies a file extension to use for the name of the file to send to the
StreamServer application. See “File handling” on page 749.
Comment
Optional
Example
-post .dat
52.2.5.6 -efpost
Syntax
-efpost <errorfile_postfix>
Description
Activates checking for a file that indicates errors. See “File handling”
on page 749.
Comment
Optional.
Example
-efpost .err

52.3. Return codes
52.2.5.7 -idfile
Syntax
-idfile <filename>
Description
Specifies the name of the file that contains the next id to use for the output file.
See “File handling” on page 749.
Comment
Optional. The default value is nextid.txt.
Example
-idfile mynextidfile.txt
52.3 Return codes

The following codes can be returned by I/O Delegator:
• 0 - OK
• 1 - Parameter error
• 2 - Response is empty
• 3 - HTTP error or error file found (when using -efpost argument)
• 4 - Time-out occurred
• 5 - Memory or file handling error
52.4 Error codes on StdErr

If an error occurs while running I/O Delegator with verbose value 1, you will get an
error code on StdErr. The error code consists of up to eight digits representing the
following:
Digit 1-3: HTTP information
Digit 4-6: Action
Digit 7-8: Error number
Note: Leading zeros are not displayed.
You can use the -err <error_code> argument to get information about the error
code. See “Arguments applicable to all modes” on page 752.
Example 52-5: Error code
StrsIODelegator -err 40802301

This will produce the following information text on StdOut:
OS error text: Operation not permitted

Error occurred when: Posting data using HTTP
HTTP error: Request Time-out
Tip: If you run I/O Delegator with verbose value 2, you will get the
information text directly on StdErr. See “-verbose” on page 753.

Chapter 53
Print Processor
Print Processor enables you to convert documents from Microsoft Office

applications into LXF (Layout eXchange Format) files.
A print processor is a component of the Windows printing environment that handles

spooled print jobs. Print Processor receives Windows EMF (Enhanced Meta Format)
spool files from printer drivers, and if specified, converts the spool files to LXF
format. It then sends the data to StreamServer or disk file.
This means that you can print overlays from external Windows applications to a
printer that is configured to use Print Processor, and deliver the resulting overlays to
Communications Center in a format that StreamServer can work with.
When an EMF spool file is sent to StreamServer, the EMF to LXF filter can be used to
convert the file to LXF format on the server side.
53.1 Processing EMF data using Print Processor

When using Print Processor, there are several ways you can handle EMF files sent to
StreamServer. These settings are configured using the Communications Center Print
Processor configuration utility. See “Configuring Print Processor” on page 770.

Chapter 53 Print Processor
Figure 53-1: Processing EMF data using Print Processor
1. LXF conversion enabled?

When a Windows print spool file is sent to StreamServer, Print Processor detects
the file and determines whether LXF conversion is enabled (Output LXF format
is selected).
If LXF conversion is enabled, Print Processor will convert all EMF files to LXF
format.
If LXF conversion is disabled, the EMF data is sent directly to StreamServer,
without converting, via the HTTP protocol. When LXF conversion is disabled,
you can still substitute temporary fonts in the data with Communications Center
recognized fonts.
2. Send data to an output file?
You can send the converted LXF data to an output file in a local directory, or to
StreamServer via the HTTP protocol.
If you send the data to an output file, you can also configure the following
options using Print Processor:

53.2. Setting up Print Processor
• Create unique file names only

• Prompt for file names
• Run a command (with parameters) after the file is created
• Automatically open the output file in the associated application
• Create plain multi-page LXF output (with no control tags)
• Include exact text position in the output file
• Embed text character widths in the output file
• Convert all paths to polygons in the output file
• Substitute temporary fonts in the file to Communications Center recognized
fonts
• Create a log file
53.2 Setting up Print Processor

For information about installing Print Processor, see OpenText Communications Center
Enterprise - Installation Guide (CCM-IGD). After you install Print Processor, the
following steps are required to set up Print Processor:
• Configure LXF Writer printer. See “Configuring the LXF Writer printer for Print
Processor” on page 769.
• Configure Print Processor. See “Configuring Print Processor” on page 770.
Using a remote printer with Print Processor

If you are using a remote printer to print output from StreamServer, you must
have administrator rights on the remote host to be able to configure the printer
to use Print Processor.
53.2.1 Configuring the LXF Writer printer for Print Processor

Before you can use Print Processor, you must configure the printer properties for the
LXF Writer printer, which is part of the Print Processor installation.
Requirements
The LXF Writer printer for Print Processor requires the following settings:
• Shared for use with other users.
• Printing starts after the last page is spooled.
• StrsPrint is selected as Print Processor.
• The default data type for StrsPrint print processor is EMF. If you need to, you
can change the data type to RAW.
See your operating system documentation for information on how to configure

printer queues.

53.2.2 Configuring Print Processor

To configure Print Processor
1. Start Print Processor configuration utility (All Programs > OpenText >
OpenText Communications Center Utilities > LXF Writer Configuration). The
Communications Center Print Processor dialog box opens.
2. Specify the Print Processor properties and then click OK.
Print Processor properties

• Write copy to file
Print Processor creates an output file of the data.
• File name
The name of the output file. If you do not specify a file name, Print Processor
uses the print job name for the output file.
• Folder
The path to the directory where Print Processor sends the output files.
• Create unique file name
If the specified filename already exists, Print Processor appends a sequence
number to the filename.
• Prompt for file name
Print Processor opens the Save As dialog box and prompts you for the name of
the output file.
• Output LXF format
Print Processor converts all EMF print spool files to LXF format.
• Plain LXF output
When converting the EMF print spool files, Print Processor creates plain multi-
page LXF output (with no control tags). When unchecked, the output contains
multiple single-page LXF documents, separated by control tags.
• Do not output control tags
When converting the EMF print spool files, Print Processor does not include
control tags in the LXF output.
• Position text by character
When converting the EMF print spool files, Print Processor attempts exact text
positioning by converting each character as a separate label object.
• Include text widths
Print Processor embeds text character widths in the output. This can increase the
size of the output file, but helps to maintain the text layout.
• Curves as polygons

When converting the EMF print spool files, Print Processor converts all path
curves to polygons.
If not selected, Print Processor converts all path curves to path objects.
Note: We recommend you convert all path curves to polygons, as

StreamServer 3.0.1, and all prior versions, do not support path objects.
• Graphics as EMF image
All graphics (except text) are stored in the output as a single embedded Windows
Enhanced Metafile image. This is only recommended for output to Windows
drivers.
• Text as EMF image
All text on the page is stored in the output as a single embedded Windows
Enhanced Metafile image. This is only recommended for output to Windows
drivers.
• Substitute temporary fonts
Some printing applications install temporary fonts for the duration of a print job.
By selecting this option, Print Processor will try to map the temporary font to an
existing font as similar as possible to the temporary font.
• Embed temporary fonts
Embeds temporary fonts into the document. The temporary fonts are those
installed by the printing application for the duration of a print job.
• Embed installed fonts
Embeds all fonts into the document.
• Consolidate labels
Consolidates small side-by-side text labels into one. This saves space in the
output document and makes it easier to edit.
Note: The labels have to be in the exact same vertical position and use the
same font.
• Use glyph indices
If the printing application renders text as glyphs, this enables the glyph indices
from the metafile to be stored in the LXF. This avoids the need for converting
into Unicode which may not be possible e.g. for Arabic or Indic texts. This can
also increase performance, however the text will not be editable or possible to
copy/paste.
• Output log file
The filename and directory of a separate log file Print Processor creates when
converting the print spool file to LXF format.
• Run command
Print Processor runs additional post-processing tasks after the output file is
created. The tasks are specified in following text boxes.

• Command
The command Print Processor runs after creating the output file.
• Parameters
The parameters for the previously specified command. Use %1 for the current
output filename.
• Use shell association for output file type
After creating the output file, Print Processor automatically launches the
associated application (if specified) and opens the output file created.
• Send to server
Print Processor sends the output file to the specified HTTP server.
• Server
The name of the HTTP server that Print Processor sends the output file to.
• Port
The port number for the receiving HTTP server. For example: 9999
• Timeout
The timeout when sending a job using HTTP. The default is 5000.
• Bypass file without ESC sequence
Sends files that do not contain printer commands starting with the specified
sequence directly to the printer.
• Log system errors to file
The file name and directory of the system log file for Print Processor. This log file
should only be used if there is a problem with Print Processor.
Leave this field empty to disable the log.
Example 53-1: Creating a local LXF file for a multi-page document
This example shows how you can configure Print Processor to produce a
local LXF file that contains a multi-page document, which you can use as
input for PreformatIN, or to import to StoryTeller.

53.2.3 Handling font mismatch

You can use a font settings file to specify what to do with a specific font included in
the input document, if the font is not installed in the \WINDOWS\Fonts folder on the
machine where you run Print Processor. This is normally only needed if Print
Processor runs on a machine separate from where the input file was created, causing
a possible font mismatch.
By editing this file, you can specify for every font to either:
• Substitute the font with the best matching font that Print Processor recognizes.
• Rasterize the text. (This means the text will be bitmapped and not scalable).

53.2.4 Editing the font settings file

You can edit the font settings file in the Font Settings dialog. To open the Font
Settings dialog, click Fonts in the Communications Center Print Processor dialog.
If you do not have access to a Font settings file, typically the first time you specify
font settings, click Use font list which lists the available fonts in the \WINDOWS\
Fonts folder.
Saving the font settings file
• When you have specified the substitution options for fonts, you must save the
settings in a file, by specifying a path to the file and clicking Save.
Adding fonts to the font list
1. Click Load and browse to the font settings file.
2. Check Use font list to display the fonts in the loaded file.
3. Click Add.
4. Enter a font name, style and the substitution method.
5. Click OK to add the font to the list.
6. Click Save to save the font settings file.
Editing substitution settings for a font
1. Click Load and browse to the font settings file.
2. Check Use font list to display the fonts in the loaded file.
3. Click Edit.
4. Select a style and the substitution method.
5. Click OK to add the font to the list.
6. Click Save to save the font settings file.

53.3. Print Processor registry keys
53.3 Print Processor registry keys

• Receiver
The name or IP address of the HTTP server that Print Processor will send the
output file to.
• Receiver port
The port number for the receiving server, for example:9999
• Receiver enabled
Enable (1) or disable (0) the connection to the server. Default value is 1.
• Log file
The name of the error log file.
• Log enabled
Enable (1) or disable (0) the creation of a log file.
• File enabled
Enable (1) or disable (0) file output.
• File folder
The path to the directory for sending output files.
• File name
The name of the output file.
• File autoname
Enable (1) or disable (0) automatic renaming of the output file when the file
already exists. If enabled, a sequence number is added to the filename, if the
filename already exists.
• File autostart
Enable (1) or disable (0) automatic file opening. If enabled, when the output file
is created, the associated application (if specified) is automatically launched and
the output file is opened in the application.
• Command
The command Print Processor will run after creating the output file.
• Command parameters
The parameters for the previously specified command. Use %1 for the current
output filename.
• Command enabled
Enable (1) or disable (0) the previously specified command to run after the
output file is created.
• LXF enabled

Enable (1) or disable (0) the filter to convert print spool files to LXF format.
Default value is 1.
• LXF plain
Enable (1) or disable (0) the filter to create plain multi-page LXF output (with no
control tags) when converting the print spool files.
• LXF exact
Enable (1) or disable (0) the filter to include exact text positioning when
converting the print spool files.
• LXF empty tags
Enable (1) or disable (0) the filter to not include control tags in the LXF output
when converting the print spool files.
• LXF paths
Enable (1) or disable (0) the filter to convert all path curves to polygons when
converting the print spool files. If disabled, the filter will convert all path curves
to path objects. Default value is 0.
• Bypass
Enable (1) or disable (0) bypassing the print job to the printer when the print job
does not contain any embedded codes.
• EC Separator
Sequence used to detect embedded codes in print spool file.

Chapter 54
Previewer
Previewer enables you to preview output from Communications Center Projects in

external viewers. For example, you can preview PDF output in Acrobat Reader.
StreamServer sends the data to be previewed to the external viewer via TCP/IP, and
the output is displayed on screen in the associated viewer. The connection between
StreamServer and Previewer is established on a per-machine basis, not per user.
Requirements
If you run Previewer on a separate machine, you must make sure it can be
accessed over the network. Note that you cannot run Previewer in a Terminal
Server or Citrix environment.
You must have the appropriate external viewer installed, for example Adobe
Acrobat reader to preview PDF files. If Previewer cannot recognize the file
format, it will treat the file as if it was ASCII text. For information on how to
associate file types with applications, see the Windows documentation.
Supported formats and viewers
The following formats and viewers are supported:
• PDF - Adobe Acrobat Reader
• PCL5 - PCL viewer
• PS - Ghostview
• TIFF - Image
• DCX - Image
• TXT - Windows Notepad
54.1 Using Previewer

To use Previewer you need to:
• Configure an External Viewer output connector, see “StreamServe External
Viewer output connector” on page 208.
• Configure Previewer. Use the Previewer configuration tool (PreviewCFG.exe) to
configure Previewer, see “Configuring Previewer” on page 777.
• Start Previewer. See “Starting Previewer” on page 778.
Configuring Previewer
The Previewer configuration tool PreviewCFG.exe is located in:
<installation_dir>\Applications\StreamServer\<Version>\Server

Chapter 54 Previewer
The configuration settings are stored in the Windows Registry under:
HKEY_LOCAL_MACHINE\SOFTWARE\StreamServe\PreviewServer
To configure Previewer
1. Start PreviewCFG.exe from the command line or by double-clicking the

executable in the file browser.
2. Enter the appropriate configuration settings:

• Logfile - The path to the log file, for example <path>\export\preview.log
• Temp directory - The path to the temporary directory if you want to use another
than the Communications Center default, for example <path>\export\tmp
• IP Port - The port Previewer listens to. The port must be the same as that
specified for the External Viewer output connector. The default port is 9343.
• Use global settings - If selected, all users on the machine where Previewer is
running will use the same settings.
Starting Previewer
The Previewer executable PreviewServer.exe is by default located in:
<installation_dir>\Applications\StreamServer\<Version>\Server
To start Previewer
1. Open a command line and go to the PreviewServer.exe directory.
previewserver.exe -win -tray -winstart
The Previewer icon is added to the Windows tray menu. You can use the tray
menu to start and stop the server.

OpenText Communications Center Enterprise 16.0 - Project Configuration Guide English (CCMPRJ160000-CGD-EN-03)

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OpenText Communications Center Enterprise 16.0 - Project Configuration Guide English (CCMPRJ160000-CGD-EN-03)

Uploaded by

Copyright:

Available Formats

OpenText™ Communications Center

Project Configuration Guide

This guide describes how to configure Design Center Projects.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Copyright © 2016 Open Text. All Rights Reserved.

No Warranties and Limitation of Liability

1 Understanding the Design Center interface ......................... 25

2 Getting started in Design Center ........................................... 41

3 Working with Projects ............................................................. 59

OpenText Communications Center Enterprise – Project Configuration Guide iii

4 Message management ............................................................ 71

5 Input connector management ................................................ 85

6 Output connector management ............................................. 93

7 Connector reference ............................................................. 105

iv OpenText Communications Center Enterprise – Project Configuration Guide

7.5 EasyLink connectors ..................................................................... 109

OpenText Communications Center Enterprise – Project Configuration Guide v

7.8.1.1 Fax (Generic) ................................................................................ 160

vi OpenText Communications Center Enterprise – Project Configuration Guide

7.20 Pipe connectors ............................................................................ 199

OpenText Communications Center Enterprise – Project Configuration Guide vii

8 Queue management .............................................................. 243

9 Resource set management ................................................... 249

10 Sorting .................................................................................... 255

11 Concepts and glossary ......................................................... 263

viii OpenText Communications Center Enterprise – Project Configuration Guide

11.9 Output queues .............................................................................. 268

12 Design Center dialog boxes ................................................. 275

OpenText Communications Center Enterprise – Project Configuration Guide ix

12.3.9.1 Connector Settings tab .................................................................. 295

x OpenText Communications Center Enterprise – Project Configuration Guide

12.5.5.2 Receiver tab ................................................................................. 314

13 Startup argument reference ................................................. 329

OpenText Communications Center Enterprise – Project Configuration Guide xi

13.21 -ldapsslcertdb ............................................................................... 338

xii OpenText Communications Center Enterprise – Project Configuration Guide

13.63 -var .............................................................................................. 357

Part 2 Metadata management 361

14 About metadata models ........................................................ 363

15 Creating a model in Describer .............................................. 365

16 Using a metadata model in Design Center .......................... 379

17 Importing and exporting models .......................................... 395

OpenText Communications Center Enterprise – Project Configuration Guide xiii

Part 3 Profile configurations 399

18 About profile configurations ................................................ 401

19 Creating profiles .................................................................... 403

Part 4 Drivers and fonts 413

20 AFP driver .............................................................................. 415

21 DOCX driver ........................................................................... 451

xiv OpenText Communications Center Enterprise – Project Configuration Guide

21.2 DOCX output structure .................................................................. 452

22 HTML unpaginated driver ..................................................... 461

23 Layout driver .......................................................................... 471

24 PCL 6 driver ........................................................................... 473

25 PDF driver .............................................................................. 477

26 PostScript driver .................................................................... 489

27 XPS driver .............................................................................. 493

28 Zebra Label Printer driver ..................................................... 495

29 RFID ........................................................................................ 507

30 Managing fonts ...................................................................... 511

OpenText Communications Center Enterprise – Project Configuration Guide xv

30.6.1 Embedding fonts in PDF documents ............................................... 519

31 Device drivers and tools ....................................................... 523