StreamServe

Design Center GUI Reference

Reference Guide
4.1.2 SP2 Rev A
StreamServe Design Center GUI Reference Reference Guide
4.1.2 SP2 Rev A
© 2007 StreamServe, Inc.
StreamServe is a trademark of StreamServe, Inc.

No part of this document may be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose, without the express written permission of StreamServe, Inc. Information in this
document is subject to change without notice. StreamServe Inc. assumes no responsibility or liability for any
errors or inaccuracies that may appear in this book. All registered names, product names and trademarks of
other companies mentioned in this documentation are used for identification purposes only and are
acknowledged as property of the respective company. Companies, names and data used in examples in this
document are fictitious unless otherwise noted.

StreamServe, Inc. offers no guarantees and assumes no responsibility or liability of any type with respect to
third party products and services, including any liability resulting from incompatibility between the third party
products and services and the products and services offered by StreamServe, Inc. By using StreamServe
and the third party products mentioned in this document, you agree that you will not hold StreamServe, Inc.
responsible or liable with respect to the third party products and services or seek to do so.

The trademarks, logos, and service marks in this document are the property of StreamServe, Inc. or other
third parties. You are not permitted to use the marks without the prior written consent of StreamServe, Inc.
or the third party that owns the marks.

Use of the StreamServe product with third party products not mentioned in this document is entirely at your
own risk, also as regards the StreamServe products.

StreamServe Web Site

http://www.streamserve.com
 3

Contents

Main window .....................................................................................................7

Menus and menu commands.............................................................................. 7
File menu ....................................................................................................... 7
Edit menu ....................................................................................................... 8
Tools menu .................................................................................................... 8
Platform menu................................................................................................ 9
Message menu............................................................................................... 9
Runtime menu................................................................................................ 9
Resources menu .......................................................................................... 10
Sub-windows and dialog boxes ....................................................................... 11
Customize dialog box................................................................................... 11
Design Center Settings dialog box............................................................... 11
Colors dialog box ......................................................................................... 12
View Information window ............................................................................. 12
Search Results window................................................................................ 13
Project window ...............................................................................................15
Project Settings dialog box............................................................................... 17
Unpack Project dialog box ................................................................................ 18
Platform window .............................................................................................19
Input Connector Settings dialog box ............................................................... 19
Connector Settings tab................................................................................. 19
ADO input connector settings ........................................................................... 20
Device input connector settings........................................................................ 21
Directory input connector settings .................................................................... 21
EmailIN input connector settings ...................................................................... 22
Exchange input connector settings ................................................................... 25
FTP input connector settings ............................................................................ 26
HTTP(S) input connector settings..................................................................... 27
HTTP(S) Poll input connector settings.............................................................. 30
Internal input connector settings ....................................................................... 32
Java input connector settings ........................................................................... 32
Java RMI input connector settings.................................................................... 33
JMS Queue input connector settings ................................................................ 33
JMS Subscribe input connector settings........................................................... 34
MSMQ input connector settings........................................................................ 35
Named Pipe input connector settings ............................................................... 36
Netware Bindery input connector settings ........................................................ 36
Netware NDS input connector settings ............................................................. 36
Serial input connector settings.......................................................................... 37
Service Channel (COM) input connector settings............................................. 37
Service Channel (HTTP) input connector settings............................................ 38
SMS Provider input connector settings............................................................. 38
Status Messenger input connector settings ...................................................... 39

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 4

StdIn input connector settings .......................................................................... 41

TCP/IP input connector settings ....................................................................... 41
WebSphere MQ input connector settings ......................................................... 41
HTTP Access tab ......................................................................................... 43
Queue Settings tab ...................................................................................... 43
Filter Chain Settings tab............................................................................... 45
General Settings tab .................................................................................... 46
Output Connector Settings dialog box ............................................................ 47
Codepage Settings tab................................................................................. 47
Device Driver Settings tab............................................................................ 48
Symbol Set tab............................................................................................. 48
Filter Chain Settings tab............................................................................... 49
Queue Settings tab ...................................................................................... 49
Connector Settings tab................................................................................. 50
ADO output connector settings......................................................................... 50
Command output connector settings ................................................................ 51
Dazel output connector settings ....................................................................... 51
Exchange output connector settings................................................................. 52
Fax Connect output connector settings ............................................................ 52
File output connector settings ........................................................................... 53
FTP output connector settings .......................................................................... 54
Generic Archive output connector settings ....................................................... 55
HTML output connector settings ....................................................................... 56
HTTP Response output connector settings ...................................................... 56
HTTP(S) Submit output connector settings ...................................................... 57
Internal output connector settings..................................................................... 59
IXOS Archive in R3 output connector settings.................................................. 60
Java output connector settings ......................................................................... 61
Java Response output connector settings........................................................ 61
Java RMI output connector settings ................................................................. 61
JMS Publish output connector settings............................................................. 61
JMS Queue output connector settings.............................................................. 63
JMS Response output connector settings ........................................................ 65
Job Resource output connector settings .......................................................... 66
Lotus Notes output connector settings ............................................................. 67
MAPI output connector settings........................................................................ 71
MAPI for MailOUT output connector settings ................................................... 73
MSMQ output connector settings ..................................................................... 74
Netware Bindery output connector settings ...................................................... 76
Netware NDS output connector settings........................................................... 77
Null Connector output connector settings ......................................................... 77
Pipe output connector settings ......................................................................... 77
RePRINT output connector settings ................................................................. 77
Service Channel Response (COM) output connector settings ......................... 78
Service Channel Response (HTTP) output connector settings ........................ 79
Service Channel Submit (COM) output connector settings .............................. 79
Service Channel Submit (HTTP) output connector settings ............................. 80
SMS output connector settings......................................................................... 82
SMS Provider output connector settings .......................................................... 82
SMTP output connector settings....................................................................... 83
SMTP (MIME) output connector settings .......................................................... 84
SMTP (MIME) for MailOUT output connector settings ..................................... 86

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 5

SNMP trap output connector settings ............................................................... 87

Spool output connector settings ....................................................................... 87
StdOut output connector settings ..................................................................... 88
StreamServe External Viewer output connector settings ................................. 88
TCP/IP output connector settings ..................................................................... 89
TFS output connector settings .......................................................................... 89
TFS for MailOUT output connector settings ..................................................... 90
Topcall output connector settings ..................................................................... 90
WebSphere MQ output connector settings ....................................................... 91
WinFaxAdapter output connector settings........................................................ 93
XTrade output connector settings..................................................................... 94
General Settings tab .................................................................................... 95
Configure Platform dialog box ......................................................................... 96
Job ID tab..................................................................................................... 96
Dynamic Resources tab ............................................................................... 97
Default Repository tab.................................................................................. 98
Job Status tab .............................................................................................. 99
Recording Mode tab................................................................................... 102
Log File tab ................................................................................................ 103
Custom tab................................................................................................. 103
Gateway tab ............................................................................................... 103
Service Broker tab...................................................................................... 104
Notifications tab.......................................................................................... 104
File Cache tab ............................................................................................ 105
Configure Platform Export dialog box ........................................................... 106
Paths tab .................................................................................................... 106
Arguments tab............................................................................................ 106
Manage Queues dialog box ............................................................................ 107
Scheduler Configuration dialog box .............................................................. 113
Message window ..........................................................................................115
Event Settings dialog box ............................................................................... 115
Agent Settings tab...................................................................................... 115
Event Order tab.......................................................................................... 117
Runtime configuration window ...................................................................119
Runtime Input Connector Settings dialog box.............................................. 119
Input Analyzer tab ...................................................................................... 119
General tab ................................................................................................ 120
Runtime Event Settings dialog box................................................................ 121
General tab ................................................................................................ 121
Code Page tab ........................................................................................... 121
Runtime Process Settings dialog box ........................................................... 123
Rule tab...................................................................................................... 123
General tab ................................................................................................ 123
Attach Process tab ..................................................................................... 124
RePRINT tab.............................................................................................. 125
Connector Selection Method dialog box ....................................................... 127

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
6

Edit Output Connector Settings dialog box .................................................. 128

Runtime Output Connector settings dialog box........................................... 129
Device Driver Settings tab ......................................................................... 129
Device symbol set tab................................................................................ 130
Document Trigger tab ................................................................................ 130
Connector tab ............................................................................................ 130
Process Sort Definition tab ........................................................................ 130
Sort Definition dialog box ............................................................................... 131
Resource set window .................................................................................. 133
Resource Folder Settings dialog box ............................................................ 135
Resource Folder Export Settings dialog box................................................ 136
Resource selection browser........................................................................... 137
Filter Chain editor ........................................................................................ 139
Input connector filters..................................................................................... 140
Bypass Filter .............................................................................................. 140
Codepage Filter ......................................................................................... 141
Decompression Filter................................................................................. 142
External Filter............................................................................................. 142
File Filter .................................................................................................... 142
Internal Filter.............................................................................................. 143
Job Filter .................................................................................................... 144
Output connector filters.................................................................................. 145
Compression filter...................................................................................... 145

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 7

Main window

Menus and menu commands

File menu

New Create new Platform, Message, Runtime configuration,

resource set, or Project.
Open Open a Platform, Message, Runtime configuration, or
resource set.
Close Close the active window (Platform, Message, Runtime
configuration, or resource set).
Save Save the active window.
Save All Save all open windows. Also saves the open Project and
everything within.
Save As Save active window with a new name.
Open Project Open a Project.
Save Project Save the active Project, including all Platforms etc.
Close Project Close the Project.
Obtain Write Lock Lock the selected component in the Project. Write lock =
only you can edit the component.
Release Write Lock Unlock the selected component in the Project.

Reload Component Revert to the latest saved version of the selected

component in the Project.
Add to Project Add a Platform, Message, Runtime configuration, or
resource set to the Project.
Remove from Select an item in the Project and remove it from the
Project Project.
Pack Project Pack the Project and save it as a package file.
Unpack Project Unpack a packed Project.
Recent Files Open recent files.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
8 Menus and menu commands
Main window

Recent Projects Open recent Projects.

Exit Exit the Design Center.

Edit menu

Find Search and find.

Open Select an Event or Process and open the corresponding
tool.
Close Select an Event or Process and close the corresponding
tool.
Script Add script to selected item.
Go to source Select an item in the Runtime configuration view, and go
to the corresponding Message or Platform view. For
example, if you select an Event in the Runtime
configuration, the corresponding Message will be
opened, with the Event high-lighted.
Add Resource Set Add resource set to selected item.
Remove Resource Remove resource set from selected item.
Set

Settings Edit settings for the selected item.

File Properties Display the path to the selected object.

Tools menu

Customize Edit toolbar, toolbar buttons etc. See Customize dialog

box on page 11.
Design Center Edit default Design Center settings. See Design Center
Settings Settings dialog box on page 11.
Select Color Select a color scheme for the Design Center GUI. See
Scheme Colors dialog box on page 12.
Select Note Font Select font for the notes you enter in the View
Information window.
Select Note Select alignment for the notes you enter in the View
Alignment Information window.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Menus and menu commands 9
Main window

Export wizard Export the Project using the export wizard.

Export now Export the Project directly.
Autocreate Auto-create a Message based on an SXD file (Event) and
Message a PLT file (Process).
Edit Project Browse to a Design Center template or package and edit
Template the category and description.
Information

Platform menu
This menu is related to the active Platform view. If no Platform view is active, this
menu is not available.

New input Add an input connector.

connector

New output Add an output connector.

connector

Manage Queues Open the Manage Queues dialog box.

Configure Platform Open the Configure Platform dialog box.

Configure Export Open the Configure Platform Export dialog box.

Message menu
This menu is related to the active Message view. If no Message view is active, this
menu is not available.

Add Event Add an Event.

Add Process Add a Process.

Runtime menu
This menu is related to the active Runtime configuration view. If no Runtime
configuration view is active, this menu is not available.

Edit Platform Open the corresponding Platform view.

New Job Create a new job.
Add Message Add a Message to the selected job.
New Post- Create a new Post-processor.
processor

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
10 Menus and menu commands
Main window

Add Process Link Add a process link to the Post-processor.

Collapse all Jobs & Show the Job containers and Post-processors as named
Post-processors boxes. Hide all connection lines.
Expand all Jobs & Show all connection lines from all Job containers and
Post-processors Post-processors.
Export Runtime Export the Project using the export wizard.
wizard

Export Runtime Export the Project directly.

now

Extract Create a Word document with details about the Runtime

documentation configuration (components, settings, notes, etc.).

Resources menu
This menu is related to the active resource set view. If no resource set view is
active, this menu is not available.

New Resource Create a new resource file using a resource editor. The
resource file is automatically linked to the resource set.
Add Resource Link an existing resource file to the resource set.
Import Create a new resource file by importing a source file. The
resource file is automatically linked to the resource set.
Start Editor Edit the selected resource file.
Stop Editor Stop and close the editor for the selected resource file.
Update from origin If the resource file is created by importing a source file,
you can edit the source file and use Update from origin to
update the resource file.
Extract to file Extract the embedded file in the selected resource file.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Sub-windows and dialog boxes 11
Main window

Sub-windows and dialog boxes

Customize dialog box

Used for: Customizing the toolbars in the main window.

Toolbars tab
Used for enabling/disabling toolbars and tooltips, and for modifying the
appearance of the toolbars.

Command tab
Used for displaying information about the toolbar buttons.

Design Center Settings dialog box

Used for: Default application settings and product registration.

Application settings

Remember window layout when Open views as they were the last time you closed the
closing Design Center Design Center.
Default code page Select a default code page for all objects in the Design
Center. For example, when you add a code page filter to
a filter chain, the selected code page will be used by
default.
Use Platform, Message, and Enable identifier colors (bar at the bottom of the view).
Runtime identifier colors in views

Enable wizard window at startup Display the shortcut window (Open Project, etc.) when
you launch the Design Center.
Highlight Runtime links for In the Runtime configuration, high-light all lines
selected items connected to a selected Job container, Message, Process,
or connector.
Inherit resource sets Inherit the resource sets connected to added objects. For
example, let the Runtime configuration inherit the
resource sets connected to the added Messages.
Add new views to active project Add new views, created using File > New, to the active
Project.
Add new view dependencies to Add dependencies for new views, created using File >
active project New, to the active Project.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
12 Sub-windows and dialog boxes
Main window

Application settings

Try to obtain write lock when If selected, the Design Center will attempt to lock the
opening views view so it can be edited. Write lock = only you can edit
the view.
Always obtain write lock for all Set components to read-only or editable when opening
components when opening the views. Write lock = only you can edit the view.
Project Template location The directory that contains the Design Center Project
templates.

Colors dialog box

Used for: Selecting a color scheme for the Design Center GUI.

View Information window

Used for: Viewing information related to the active Platform, Message, Runtime
Configuration, or resource set view.

Active view and Selected item

Displays the active view, and the selected item in the view.

Note

Used for adding and editing notes related to the selected item.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Sub-windows and dialog boxes 13
Main window

Dependencies

Shows dependencies for the active view. You can right-click an item and select a
menu command.

Menu commands

Set as Default Set as default resource set for the active view.
Resource Set

Activate Activate the corresponding view.

Add Resource Sets Add resource sets to the active view.

Remove Resource Remove the selected resource set from the active view.
Set

Search Results window

Used for: Displaying search results (Edit > Find). Double-click an item to go to
the corresponding item.

Columns

View The view (Platform, etc.) where the item was found.
Location The location of the item.
Dependency N/A
Description Description of the item

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
14 Sub-windows and dialog boxes
Main window

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 15

Project window

Used for: Structuring and managing components in a StreamServe Project.

The Project tree contains the top node, representing the Project, and separate
folders for Platforms, Messages, Runtime configuration, and resource sets.

Shortcut menu commands

New Create new Platform, Message, Runtime configuration,

resource set, or Project.
Open Project Open a Project.
Recent Projects Open recent Projects.
Save Project Save the active Project, including all Platforms etc.
Save As Save the Project with a new name.
Close Project Close the Project.
Pack Project Pack the Project and save it as a package file.
Unpack Project Unpack a packed Project.
Obtain Write Lock Lock the selected component. Write lock = only you can
edit the component.
Release Write Lock Unlock the selected component.

Reload Component Revert to the latest saved version of the selected

component.
Add to Project Add a Platform, Message, Runtime configuration, or
resource set to the Project.
Export wizard Export the Project using the export wizard.
Export now Export the Project directly.
Rename Rename the selected component.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
16
Project window

Shortcut menu commands

Settings Open the Project Settings dialog box and edit the Project
settings.
File Properties Display the path to the selected object.
Remove from Remove the selected component from the Project.
Project

Open/Activate View Open the view containing the selected component.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Project Settings dialog box 17
Project window

Project Settings dialog box

Used for: Modifying Project settings.

Project settings

Project name The name of the Project.

Default code page The default code page for all items within the Project.
Overrides the default code page defined in the Design
Center Settings dialog box.
Default Resource The name of the default resource set.
Set

Project folder/ The path to the folder where to save your Project files.
directory

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
18 Unpack Project dialog box
Project window

Unpack Project dialog box

Simple mode
Used for: Unpacking and storing all unpacked files in a specified folder.

Options

Project Location The path to the folder where to store the Project files.

Advanced mode
Used for: Selecting which files to unpack, and where to store the unpacked files.

Options

Components in Lists all components that can be unpacked. Select the

package components to unpack.
Location for The path to the folder where to store the selected
selected components.
components

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 19

Platform window

Input Connector Settings dialog box

Used for: Configuring input connectors.

Connector icon
• Connector Settings tab
• HTTP Access tab

Queue icon
• Queue Settings tab

Filter Chain icon

• Filter Chain Settings tab

General icon
• General Settings tab

Connector Settings tab

Used for: Configuring input connectors.

Settings

Connector Type of input connector.

Connector specific Connector specific settings.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
20 Input Connector Settings dialog box
Platform window

Settings

Time-out The maximum time (seconds) the connector will wait for
input before it shuts down the connection. The time-out
counter starts over again as soon as the connector
receives input.
Polling interval If, when, and how often to poll the data source for
information.

ADO input connector settings

Used for: Extracting data from ODBC or OLE DB enabled

database tables.
Platform: Windows.

Connector settings

DataSource The ODBC data source to connect to.

CustomData A custom data source to connect to, for example an
Source external ODBC or OLE DB data source. This will
override the DataSource specified above.
For example:
driver={SQL Server};
server=my_server;uid=;pwd=;database=my_db;

UserName User name for accessing the data source. Overrides any
other user names specified for the data source.
Password Password for accessing the data source. Overrides any
other passwords specified for the data source.
SQLCommand SQL command to be carried out on the data source. For
example:
select * from my_table

EventName The Event that receives input from this connector.

Mode Move (with delete) – Delete the record from the database
table after reading.
Copy (no delete) – Copy the record from the database.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 21
Platform window

Connector settings

RowLevel Objects as blocks – Each ADO record will be submitted

as a block, one block per record.
Objects as events – Each ADO record will be submitted
as an Event, one Event per record.
Objects as jobs – Each ADO record will be submitted as
a job, one job per record.
Create SXD If you use the Communication Server to create an SXD
file, enter a name and a path for where you want to save
this SXD file.

Device input connector settings

Used for: Scanning a UNIX FIFO for incoming jobs. A FIFO is a

First-In-First-Out queue.
Platform: UNIX.

Connector settings

Device File path to the FIFO, for example:

./fifos/My_Fifo

Directory input connector settings

Used for: Retrieving files from a named directory. The source

application writes data to this directory, and the
Communication Server retrieves the data.
Platform: Windows and UNIX.

Connector settings

Match criterion The path to the directory, for example:

scandir/*.txt
Use an absolute path, or a path relative to the export
directory.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
22 Input Connector Settings dialog box
Platform window

Connector settings

Sort by How to sort files when reading from the directory. Two
or more files with the same value (for example the same
file extension) will be sorted by file name in ascending
alphabetical order.

Load balancing: Several Directory connectors can scan the same directory
for the same type of files. All involved Communication
Servers must be located on the same machine. Match
Criterion must be identical for all connectors.

networksafe: The Communication Server may go down if the directory,

from which the files are retrieved, is located on a remote
machine, and the network goes down. To avoid this you
can enter networksafe in the connector’s Custom settings
field.

EmailIN input connector settings

Used for: Retrieving input sent via email.

Platform: Windows and UNIX.

Connector settings

Mailbox type The type of mailbox on the mail server.

Port The port the Communication Server will use to
communicate with the mail server.
Mail server name The mail server’s IP address or host name.
Mail folder Applicable only to IMAP.
Mail folder to scan for input. Leave this empty if you
want to select the Inbox.
User name User name for accessing the mailbox.
If several Communication Server instances retrieve input
from the same mail server, each instance must use a
unique user name.
Password Password for accessing the mailbox.
Read mail text Select whether or not to process the email body.
Read attachment Specify the attachments to be processed by the
file Communication Server. See Example 1 below.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 23
Platform window

Connector settings

Mail read filter Read All – Retrieve all emails in the mailbox.
Advanced – Use the read filter parameters below to
specify which emails to retrieve. You can use wildcards.
See Example 2 below.
Read filter From – Retrieve emails with specific From addresses.
parameters
To – Retrieve emails with specific To addresses.
Cc – Retrieve emails with specific Cc addresses.
Date – Use a timeframe to specify which emails to
retrieve. The timeframe 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.
Signed – Select to reject unsigned emails.
Encrypted – Select to reject un-encrypted emails.

Delete mail Delete emails from the mailbox after they have been
retrieved by the Communication Server.
Mail delete filter Delete Processed – Delete all emails that have been
retrieved and processed.
Delete all – Delete all emails that have been retrieved.
Advanced – Use the delete filter parameters below to
specify which emails to delete. You can use wildcards.
See Example 3 below.
Delete filter Delete From – Delete emails with specific From
parameters addresses.
Delete To – Delete emails with specific To addresses.
Delete Cc – Delete emails with specific Cc addresses.
Delete Date – Use a timeframe to specify which emails
to delete. The timeframe 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
Save attachment Save email attachments to disk.
Attachment The directory where to save attachments.
directory

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
24 Input Connector Settings dialog box
Platform window

Example 1 Specifying whether to read attachments

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 retrieved by the Communication Server.
If Read Attachment File is INVOICE*.xml, only INVOICE_101.xml will be
retrieved by the Communication Server.

Example 2 Specifying which emails to retrieve

Date: 2002-01-**
Emails dated January 2002 will be retrieved.

Example 3 Specifying which emails to delete

Delete Date: 2002-01-**

Emails dated January 2002 will be deleted.

GetConnectorValue attributes
You can use the scripting function GetConnectorValue to fetch EmailIN
attributes.

Attribute GetConnectorValue("<attribute>")

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.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 25
Platform window

Attribute GetConnectorValue("<attribute>")

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

Exchange input connector settings

Used for: Reading objects in Microsoft® Exchange Server®

folders. For example, read emails and attachments from
Microsoft® Outlook® Public Folders.
Platform: Windows.

Connector settings

Server The Microsoft Exchange Server. For example: laxnt04

MailBox The user account on the Microsoft Exchange Server. For
example: streamserve
Folder The folder to be read. For example:
Mailbox - Brown, Jane\Inbox
The folder name can be language sensitive. In that case,
you must write the folder name on the local language. For
example: Postlåda - Brown, Jane\Inkorg
EventName The Event that receives input from this connector.
Mode Move (with delete) – Deletes the object from the
Microsoft Exchange Server after reading it.
Copy (no delete) – Copies the object from the Microsoft
Exchange Server.
DataType CDOObject – All fields in a retrieved object will be
entered as fields in a StreamServe XML-data structure.
File – The first attachment of each object will be
streamed through the Communication Server.
RowLevel Objects as blocks – Each object will be sent to the
Communication Server as a block, one block per object.
Objects as events – Each object will be sent to the
Communication Server as an Event, one Event per object.
Objects as jobs – Each object will be sent to the
Communication Server as a job, one job per object.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
26 Input Connector Settings dialog box
Platform window

Connector settings

Create SXD If you want the Communication Server to create an SXD

file, enter a name and a path for where you want to save
this SXD file.

FTP input connector settings

Used for: Retrieving files from an FTP server. After a file is

retrieved, it is deleted from the FTP server.
Comments: If you need more than one connector (input or output) per
user account, this must be defined on the FTP server. On
the FTP server, the number of concurrent connections
must be equal to, or higher than, the number of FTP
connectors (input and output) set up for a user account.
Platform: Windows and UNIX.

Connector settings

Host The FTP server, for example rtu.baldwin.com

Port The port on the FTP server.
User name The user name for accessing the FTP server.
Password The password for accessing the FTP server.
Remote path The directory to be accessed on the FTP server. If you
leave this blank, the root directory will be set as remote
path.
For example: /invoices/pdfout/area2
Whether to use slash or back-slash is determined by the
FTP server software.
File match criterion The match criterion for the files to be retrieved, for
example *.pdf

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 27
Platform window

Connector settings

Passive mode Select whether or not to enable Passive Mode. FTP in

Passive 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 itself on a randomly chosen high-
numbered port.
Note: This works with most firewalls unless the firewall
restricts outgoing connections on high-numbered
ports.
Transfer mode ASCII – ASCII, Type A, transfer method. Control and
formatting data is converted to local equivalents.
Binary – FTP Image, Type I, transfer method. The file is
transferred without any changes.

HTTP(S) input connector settings

Used for: Enabling the Communication Server to function as an

HTTP server.
Platform: Windows and UNIX.

Connector settings

Security HTTPS only.

configuration
The security configuration to connect to this connector.
The security configuration must be included in a resource
set connected to the Platform. See the Encryption and
authentication documentation for more information.
Version The HTTP version to use. Auto means that the version is
determined by the client.
SSL version HTTPS only.
The SSL version to use. Server and clients must use the
same SSL version.
Address An alternative network address for this Communication
Server if you do not want to use the default network
address for the workstation. For example, the IP address
to a specific network card.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
28 Input Connector Settings dialog box
Platform window

Connector settings

Port The port this connector listens to for HTTP requests.

Several HTTP(S) connectors cannot share the same port.
You must use a unique port for each connector.
Input threads The maximum number of concurrent connections. When
all connections are busy, and a new client tries to connect
to the Communication Server, the connection may fail.
Note: Increasing the number can decrease performance.

Idle time-out This time-out (milliseconds) is applied when the

Communication Server has finished processing a request,
and no more data related to the request will be received
or sent. It specifies 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 This time-out (milliseconds) is applied when the
Communication Server sends or receives data, and its
purpose is to close dead connections. If no data is sent or
received during the time specified, the connection will be
closed.
Response time-out This time-out (milliseconds) is applied when the
Communication Server has received all data from the
client. It specifies the maximum time the client is
expected to wait for a response.
The client can use an HTTP header field to override this
time-out. To enable this, you must use the keyword
HTTPResponseTimeOut. With this keyword you can also
specify a file to return to the client when the time-out
occurs. See Custom keywords below.
If the client does not expect any response from the
Communication Server, you should set this time-out to
“0”. In this case the Communication Server will
immediately return “200 OK”, and optionally a file using
HTTPResponseTimeOut, to inform the client that the
request has succeeded.
Authentication 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. See RFC 2617.
Publish directory The root directory for stored files.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 29
Platform window

Connector settings

Publish extension An alias table where you associate file formats to

file content-types (RFC 2045). This table must be available
in a Resource Set connected to the Platform.
The Communication Server accepts html, htm, gif, jpg,
txt, zip by default. To use other formats, you must
specify a publish extension file.
Job resource URI The Job resource URI identifies an output file stored via
a Job Resource output connector. For example:
/jr
You can configure the Communication Server to
automatically return processed output to the client. In
most cases you will use an HTTP Response output
connector to handle the response. There are also
scenarios where a client expects the response, for
example a pdf file, to be presented in a web browser via
an ActiveX plug-in. To make this work, the response
must be temporarily stored using a Job Resource output
connector.

Custom keywords
This table describes a number of keywords that you can add to the Custom tab.

Keyword Description
HTTPExtJobIdField Retrieves the external ID from an application that sends input
"ID_name"; to the Communication Server. The application that sends the
input must include the external ID as HTTP header
information (ID_name:ID_value).
HTTPMaxContentLength Limits the size (in bytes) of the body in an HTTP request. If a
limit;
request contains a body that exceeds this limit, an error
response will be returned.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
30 Input Connector Settings dialog box
Platform window

Keyword Description
HTTPResponseTimeOut Specifies what the Communication Server should do when a
"timeout" "path" "custom" response time-out occurs.
END;
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 must use HTTPResponseTimeOut:
HTTPResponseTimeOut "x-timeout" "" "" END;
Leave this argument empty if you do not want to allow clients
to set the response time-out.
path:
A file with information to send in the response when the time-
out occurs. For example:
HTTPResponseTimeOut "" "/Messages/timeout.txt" ""
END;
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>.

HTTP(S) Poll input connector settings

Used for: Enabling the Communication Server to function as an

HTTP client that polls an HTTP server.
Platform: Windows and UNIX.

Connector settings

CA certificate HTTPS only.

A CA root certificate that confirms the identity of the
SSL server. The certificate must be included in a resource
set connected to the Platform.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 31
Platform window

Connector settings

Method Specify the method the client will use when polling the
HTTP server.
HEAD
Requests a HEAD header from the HTTP server.
If the Last-Modified entity-header field has changed,
the Communication Server 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.
The Communication Server 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. The Communication Server
will process the data only if the checksum has changed.
URL The URL to the HTTP server.
Content-type If the Method is POST
The content-type of the file to be posted.
If the Method is HEAD or 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.
File to POST The file to be posted.
Time-out The maximum time (milliseconds) to wait before
aborting a transfer.
Version The HTTP version to use.
SSL Version HTTPS only.
The SSL version to use. Server and clients must use the
same SSL version.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
32 Input Connector Settings dialog box
Platform window

Connector settings

Authentication 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.
Realm Only if authentication is required.
The realm.
User name Only if authentication is required.
User name to access the realm.
Password Only if authentication is required.
Password to access the realm.
Cache file Cache file that stores communication checksums
between Communication Server start/stop.

Internal input connector settings

Used for: Enabling the Communication Server to pass on data

internally. For example to loop back output for further
processing.
Comment: If you have an internal loop via an Internal input connector
and an Internal output connector, you must specify a UTF-
8 code page for both connectors.
Platform: Windows and UNIX.

Connector settings

There are no properties for this type of connector.

Java input connector settings

Used for: Custom Java input connector. See the StreamServe EIF
SDK documentation.
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 33
Platform window

Java RMI input connector settings

Used for: Custom Java input connector. See the StreamServe EIF
SDK documentation.
Platform: Windows and UNIX.

JMS Queue input connector settings

Used for: Enabling the Communication Server to receive messages

from a named queue in a point-to-point messaging
system.
For more information about JMS, see
http://java.sun.com/products/jms/

Platform: Windows and UNIX.

Connector settings

Context The JNDI context. If you leave this empty, the initial
context will be used.
Queue Factory The JNDI lookup name for the queue connection factory.
This setting is mandatory.
A JMS client uses a connection factory to create a
connection to the JMS provider.
User Name User name to access the JMS provider.
Password Password to access the JMS provider.
Queue The JNDI lookup name for the queue. This setting is
mandatory.
Selector If the JMS client needs to filter the messages it receives,
you can use a message selector. 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. For example:
Type = ’Invoice’ OR Type = ’Order’
will select messages where Type is set to either Invoice
or Order.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
34 Input Connector Settings dialog box
Platform window

JMS Subscribe input connector settings

Used for: Enabling the Communication Server to receive

messages from a named topic in a publish-subscribe
messaging system.
For more information about JMS, see
http://java.sun.com/products/jms/

Platform: Windows and UNIX.

Connector settings

Context The JNDI context. If you leave this empty, the initial
context will be used.
Topic Factory The JNDI lookup name for the topic connection factory.
This setting is mandatory.
A JMS client uses a connection factory to create a
connection to the JMS provider.
User Name User name to access the JMS provider.
Password Password to access the JMS provider.
Topic The JNDI lookup name for the topic. This setting is
mandatory.
Selector If the JMS client needs to filter the messages it receives,
you can use a message selector. 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. For example:
Type = ’Invoice’ OR Type = ’Order’
will select messages where Type is set to either Invoice
or Order.
Subscriber Id Identifies this particular subscription service. Enables the
JMS provider to postpone sending messages to this
subscriber if the connection between the Communication
Server and the JMS provider is lost. No messages will be
lost during the time the connection is down.
Unsubscribe on If you have specified a subscriber ID, you can select
close whether or not to unsubscribe when the Communication
Server is shut down.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 35
Platform window

MSMQ input connector settings

Used for: Enabling and integrating Communication Server

capabilities in Microsoft message queuing
environments.
Comments: If the messages that are sent to the connector are
segmented, the application sending the messages must
synchronize the messages as follows:
• The first message in the sequence must have the
appspecific property set to the number of
messages that will arrive in this sequence of
segmented messages (the first message is
excluded).
• The following messages must have this number
decreased by one and the last message in the
sequence must have the appspecific property set
to 0.
• All messages, except the first one, must have their
correlation ID property set to the message ID of the
first message.
Private and Public message queues are published in the Active
public message Directory.
queues: Private message queues are not published in the Active
Directory. They are accessible only by Message Queuing
applications that know the full path name or format name
of the message queue.
Platform: Windows.

Connector settings

Queue Manager The server on which the MS Message Queue resides.

Queue Name The MS Message Queue from which to retrieve data.
This MS Message Queue must belong to the Queue
Manager.
Private Select to access a Private message queue. The Private
message queue can be accessed even if the queue
manager is off-line.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
36 Input Connector Settings dialog box
Platform window

Connector settings

Transaction Type MQ_NO_TRANSACTION – All messages will be read

without transaction support.
MQ_INTERNAL_TRANSACTION – Messages that are
not successfully processed will be rolled-back, and the
Communication Server will try to process them again.
Transactional messages are only read (removed) from a
connector if and when the transaction is committed.
Otherwise they are returned to the connector and can be
read during a subsequent transaction.

Named Pipe input connector settings

Used for: Handling output from a FIFO file.

Platform: Windows and UNIX.

Connector settings

Named pipe The named pipe.

Netware Bindery input connector settings

Used for: Retrieving data from a Novell 3.x network print queue.
Platform: Windows.

Connector settings

Server The Novell 3.x network server.

Queue name The Novell 3.x network print queue.
Print server The Novell 3.x network print server.
Password Password to the Novell 3.x network print server.

Netware NDS input connector settings

Used for: Retrieving data from a Novell 4.x network print queue.
Platform: Windows.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 37
Platform window

Connector settings

Queue The Novell 4.x network print queue.

Serial input connector settings

Used for: Receiving input via a serial port.

Platform: Windows and UNIX.

Connector settings

Port The port to be used.

Bits per second Data transfer speed.
Data bits The number of data bits.
Parity How to handle parity.
Stop bits The number of stop bits to be transmitted per byte.
Flow control How to handle flow control.

Service Channel (COM) input connector settings

Used for: Publishing a service in a Service Broker. Clients can

access the service via COM.
Comment: There is also a Service Channel Response (COM) input
connector (without “Response”) that must be used when
a response is required from the Communication Server.
This connector is configured the same way.
Platform: Windows.

Connector settings

Service description The name of the service as it will be published in the

Service Broker. This name will be used in the client
requests.
Maximum lock time The maximum time (seconds) a client can lock the
service. When this time has passed, the Service Broker
will make the service available to other clients.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
38 Input Connector Settings dialog box
Platform window

Connector settings

Maximum idle lock The maximum time (milliseconds) a client can lock the
time service without using it. When this time has passed, the
Service Broker will make the service available to other
clients.

Service Channel (HTTP) input connector settings

Used for: Publishing a service in a Service Broker. Clients can

access the service via http.
Platform: Windows and UNIX.

Connector settings

Service description The name of the service as it will be published in the

Service Broker. This name will be used in the client
requests.
You can define several names, separated by comma, for
the same service.
Version The version of the service.
There can be several versions of the same service. A
client can request a specific version of a service. If the
client does not request a specific version, it will get the
highest available version of the service.

SMS Provider input connector settings

Used for: Receiving SMS messages via an external service

provider (Telia).
Platform: Windows and UNIX.

Connector settings

Host The IP address of the Communication Server host. Must

be registered with Telia.
Port The port the Communication Server listens to for
incoming SMS messages. Must be registered with Telia.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 39
Platform window

Connector settings

Time-out (ms) The maximum time (milliseconds) the connector will try
to carry out the transaction (connect, send data, receive
data) before canceling.
Event name The Event that handles SMS input.

Status Messenger input connector settings

Used for: Retrieving and filtering status information generated by

the Communication Server.
Platform: Windows and UNIX.

Connector settings

Event name The e MessageIN Event that will extract the notification
data.
Notifications to Click the browse button to select the kind of information
receive to be included in the status message.

Notification settings

Level Select the type of Project components for which

information should be included in the status message.
Note: Preproc must be combined with Event, job, or
Process to give a result.
Status Select the status of incidents or events for which
information should be included in the status message.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
40 Input Connector Settings dialog box
Platform window

Notification settings

Options All notifications for one job in the same XML

message
Include all notifications generated by the same job in the
same status message.
If this option is cleared, each notification will generate a
separate status message.
You must select the corresponding SXD file for the
MessageIN Event.
Receive non-job related notifications (no job ID)
Create status messages for information from the
Communication Server that is not related to specific job
IDs. For example status information for input connectors,
or notifications about the Communication Server start/
stop.
Receive only first notification for each job
Create a status message only for the first notification
generated by a job, and ignore subsequent notifications
for the same job.
Enable advanced features (disables Level and
Status)
Select to enable advanced options, as described below.
External job IDs
Enter the external IDs of the jobs that should generate a
status message. Variables can not be used. Use commas
to separate IDs.
Log message IDs
Enter the log message IDs that should generate a status
message. Variables can not be used. Use commas to
separate IDs. You will find the log message IDs in the
\common\data\logmsg.txt file.

Note: If you enter both an external job ID and a log

message ID, a status message will be created
when the log message is generated for the
specified job. For example, if you enter external
job IDs K12 and K13, and log message ID 1719,
status messages will only be created if log
message 1719 is generated for either of the two
jobs.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 41
Platform window

StdIn input connector settings

Used for: The StdIn and StdOut connectors enable external

applications to send data to the Communication Server via
StdIn and receive output on StdOut.
Platform: Windows and UNIX.

Connector settings

There are no settings for this type of connector.

TCP/IP input connector settings

Used for: Receiving input on a designated IP port.

Platform: Windows and UNIX.

Connector settings

Host name The host.

Port The port number.

WebSphere MQ input connector settings

Used for: Receiving input via an IBM WebSphere MQ message

queue. See Dependencies and requirements on page 41
before you configure the connector.
Platform: Windows and UNIX.

Connector settings

Queue manager The queue manager that owns the message queue.
Queue name The message queue.

Dependencies and requirements

The IBM WebSphere MQ environment

The IBM WebSphere MQ environment must be set up on the same host as the
Communication Server, and the IBM WebSphere MQ configuration must be done
using IBM WebSphere MQ specific tools.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
42 Input Connector Settings dialog box
Platform window

Asynchronous messaging
The WebSphere MQ input connector only supports asynchronous messaging.

Defining a client-connection channel

You must define a client-connection channel that specifies the name of the MQI
channel, the communication type, and the WebSphere MQ Server address. The
name of the MQI channel must be the same as the name of the server-connection
channel defined on the WebSphere MQ Server. You can define the client-
connection channel using the environment variable MQSERVER, as shown in the
example below. For more information, see the IBM WebSphere MQ
documentation.

Example 4 Defining a client-connection channel

SET MQSERVER=CHANNEL1/TCP/<WebSphere MQ server address>

Startup arguments
You must add -webspheremq to the argument file.

Groups and Segments

The Communication Server and the application that sends data to the
Communication Server must handle group and segment properties in the same
way. Both the Communication Server and the sending application should read
groups and segments by using MQGMO_LOGICAL_ORDER to ensure that all messages
are received in the same order as they were sent.
The Communication Server uses MQGMO_SYNCPOINT to make sure that the
message remains in the queue if the Communication Server fails to read or
process the message. The Communication Server will retry 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.
If a group of messages is sent, MQGMO_ALL_MSGS_AVAILABLE and MQGMO_WAIT are
used to ensure that the Communication Server waits until all messages in the
group are available. The Communication Server will also wait until all segments
of a message are available.

Get connector values

You can use the scripting function GetConnectorValue to fetch WebSphere MQ
attributes.

Attribute GetConnectorValue("<argument>")
GroupId GetConnectorValue("IBMMQGroupId")

MessageId GetConnectorValue("IBMMQMsgId")

CorrelationId GetConnectorValue("IBMMQCorrelId")

Reply-To-Queue GetConnectorValue("IBMMQReplyToQ")

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 43
Platform window

Attribute GetConnectorValue("<argument>")
Reply-To-Queue-Manager GetConnectorValue("IBMMQReplyToQMgr")

Message type GetConnectorValue("IBMMQMsgType")

Report options GetConnectorValue("IBMMQReport")

HTTP Access tab

Used for: Specifying HTTP access for an input connector. You can use an
HTTP(S) input connector as interface for receiving input over HTTP. You can
forward the input, from the HTTP input connector, to several queue enabled input
connectors of different types.

Settings

HTTP Connector The HTTP or HTTPS input connector.

URI The URI to access this connector via HTTP.

Example 5 HTTP access for an Internal input connector

You have one HTTP connector HTTP_IN and one Internal connector INTERNAL.
The connector HTTP_IN has the following HTTP access specified:
• HTTP Connector: HTTP_IN
• URI: /
The connector INTERNAL has the following HTTP access specified:
• HTTP Connector: HTTP_IN
• URI: /internal
If a request is sent to www.abc.com/, the connector HTTP_IN will receive and
handle the request.
If a request is sent to www.abc.com/internal, the connector HTTP_IN will receive
the request and forward it to the connector INTERNAL.

Queue Settings tab

Used for: Selecting a queue for the connector and, optionally, to edit the queue
settings.

Settings

Queue The queue to select for the connector.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
44 Input Connector Settings dialog box
Platform window

Settings

Manage Queues Add new queues to the Platform, edit queue settings, etc.
Use default Select whether or not to use the default queuing options.
queuing options

Store successful What to store when a job has been successfully sent
jobs through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Store failed jobs What to store when a job has not been successfully sent
through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Retries Number of times the Communication Server will try to
handle a failed job.
Retry delay The time (milliseconds) the Communication Server will
wait before it tries to handle a failed job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input Connector Settings dialog box 45
Platform window

Filter Chain Settings tab

Used for: Specifying a filter chain for the input connector.

Contents

Look in Browse to the appropriate resource set and filter chain

folder.
Item A filter chain. All available filter chains are displayed in
the items list.
Note Notes written for the item. Right-click the item and select
Edit Notes to edit the notes.
Selected Displays the selected filter chain.
Filter Enable/disable the resource filter. When enabled, only
filter chain folders will be visible.
Select Select the filter chain (copy from the Items list to the
Selected list).
Undo select Undo selection (remove from the Selected list).
Open editor Select a filter chain in the Items list and open it in the
filter chain editor.
Close editor Close the filter chain editor.
Add Resource Set Add a resource set to the active Platform.
Create Resource Create a new resource set and add it to the active
Set Platform.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
46 Input Connector Settings dialog box
Platform window

Contents

New resource Create a new resource file using a resource editor, and
link it to the resource set.
Add resource Link an existing resource file to the resource set.
Import Create a new resource file and link it to the resource set.
You create the resource file by importing and embedding
a source file.

General Settings tab

Used for: Adding notes, and customizing the connector.

Settings

Note Comments and notes related to this connector.

Custom Settings Commands and keywords.
Keep input Job Specifies whether to process all Messages extracted from
structure in output the input file (or equivalent) in the same StreamServe job,
or process each extracted Message as a separate
StreamServe job. This affects the usage of variables and
Process output since all stored variables and Processes
are removed when a StreamServe job is completed. For
example, it is only possible to use variables and to sort
Process output within the same StreamServe job.
If selected, StreamServer processes all extracted
Messages in the same StreamServe job.
If not selected, StreamServer processes each extracted
Message as a separate StreamServe 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 Message is completed.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 47
Platform window

Output Connector Settings dialog box

Used for: Configuring the output connector.

Code page icon

• Codepage Settings tab

Driver icon
• Device Driver Settings tab
• Symbol Set tab

Filter Chain icon

• Filter Chain Settings tab

Queue icon
• Queue Settings tab

Connector icon
• Connector Settings tab

General icon
• General Settings tab

Codepage Settings tab

Used for: Specifying a code page for the output. See the Code pages and Unicode
support in StreamServe documentation for information.

Settings

Inherit code page Use the same code page for both input and output. The
output will inherit the code page specified for the input
Code page name Specify a different code page for the output. This code
page must cover at a minimum all the characters covered
in the code page for the input.
Reorder BiDi Only for Arabic and Hebrew code pages, and for UCS-2
output in visual and UTF-8.
order
The Communication Server processes bidirectional text
in logical order. If required, select this option to reorder
the output to visual order.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
48 Output Connector Settings dialog box
Platform window

Settings

Add byte order Only for UCS-2 and UTF8.

mark
Select to include a byte order mark at the beginning of a
UCS-2 (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.
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.

Device Driver Settings tab

Used for: Selecting the device to use. The actual output destination, for example
an HP Laser Jet printer, determines which option to select.

Settings

Device Type of output device.

Driver settings Device specific settings. See the data sheet for the
corresponding device.
Alias You can specify an alias for each property.

Symbol Set tab

Used for: When sending output to a PCL printer, there is an option to override
the symbol set in the code page specified for this connector, and specify a
different symbol set for the printer.

Settings

Override symbol... Select to override the symbol set.

Static Select a static symbol set.
Lookup A lookup table specifies which symbol set to use.
Variable A variable specifies which symbol set to use.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 49
Platform window

Filter Chain Settings tab

Used for: Specifying a filter chain for the input connector. See Filter Chain
Settings tab on page 45.

Queue Settings tab

Used for: Selecting a queue for the connector and, optionally, to edit the queue
settings.

Settings

Queue The queue to select for the connector.

Manage Queues Add new queues to the Platform, edit queue settings, etc.
Use default Select whether or not to use the default queuing options.
queuing options

Store successful What to store when a job has been successfully sent
jobs through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Store failed jobs What to store when a job has not been successfully sent
through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Retries Number of times the Communication Server will try to
handle a failed job.
Retry delay The time (milliseconds) the Communication Server will
wait before it tries to handle a failed job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
50 Output Connector Settings dialog box
Platform window

Connector Settings tab

Used for: Configuring output connectors.

Settings

Connector Type of output connector.

Connector specific Connector specific settings.

Output mode Select to generate output per Process, Document or job.

ADO output connector settings

Used for: Entering data into an ODBC or OLE DB enabled

database table.
Comments: You must use StreamServe ODBC scripting functions if
you want to update existing information in a database
table, or if you want to carry out several SQL commands
on the data source.
Platform: Windows.

Connector settings

DataSource The ODBC data source to connect to.

CustomData A custom data source to connect to, for example an
Source external ODBC or OLE DB data source. This will
override the DataSource specified above.
For example:
driver={SQL Server};
server=my_server;uid=;pwd=;database=my_db;

UserName User name for accessing the data source. Overrides any
other user names specified for the data source.
Password Password for accessing the data source. Overrides any
other passwords specified for the data source.
SQLCommand SQL command to be carried out on the data source. For
example: Insert into customer_table *
Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 51
Platform window

Command output connector settings

Used for: Enables you to use commands that specify how to handle
the output.
Platform: Windows and UNIX.

Connector settings

Command Enter the path to a batch file or a script. For example:

C:\project\myname.bat
You can also enter a one-line command. For example:
Physical "<[cmd=cat %1 > kv.$destination]>"

Output mode Select to generate output per Process, Document, or job.

Dazel output connector settings

Used for: Writing output to a Dazel logical queue. See your Dazel
documentation for details.
Platform: Windows and UNIX.

Connector settings

Dazel logical queue The Dazel logical queue, for example:

qprinter

Runtime specific settings

FTP Type default The default file transfer mode.
Character set The default character set.
default

Document format The format of an incoming document.

default

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
52 Output Connector Settings dialog box
Platform window

Exchange output connector settings

Used for: Writing objects to Microsoft® Exchange Server®

folders. For example, create a calendar object and
automatically enter it directly into a specified Microsoft®
Outlook® Calendar folder.
Platform: Windows.

Connector settings

Server The Microsoft Exchange Server. For example: laxnt04

MailBox The user account on the Microsoft Exchange Server. For
example: streamserve
Folder The folder to write to. For example:
Mailbox - Brown, Jane\Inbox
The folder name may be language sensitive. In that case,
you must write the folder name on the local language. For
example: Postlåda - Brown, Jane\Inkorg
DataType CDOObject – All fields in the output will be added to the
folder.
File – The output will be added as an attachment to the
folder. This mode is used to, for example, save PDF
documents.
FileName Name and the path for the file to write to the folder.
Output mode Select to generate output per Process, Document, or job.

Fax Connect output connector settings

Used for: Faxing output via different types of fax servers. You
select which type of fax server to use when you select a
device driver for the connector.
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 53
Platform window

Connector settings

Type Command – Use a DOS / UNIX command, batch file, or

script to specify the output destination.
Spool – Send the output to a specific fax device.
File – Send the output to a specific directory. The fax
device will retrieve the output from this directory.
Command A command, batch file, or script. For example:
C:\project\myname.bat

Printer The fax device.

Directory The output directory.
Output mode Select to generate output per Process, Document, or job.

File output connector settings

Used for: Sending output to a file.

Platform: Windows and UNIX.

Connector settings

File The file. For example:

C:\projects\myfile.txt
You can also specify the file using the SetDestPath
scripting function.
Append Yes – Output will be appended to the file. If the file does
not exist, it will be created.
No – The file will be overwritten if it already exists. If the
file does not exist, it will be created.
Create directories Yes – If any of the directories in the File path does not
exist, it will be created.
No – If any of the directories in the File path does not
exist, an error message will be generated.
Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
54 Output Connector Settings dialog box
Platform window

FTP output connector settings

Used for: Writing files to an FTP server.

Comments: If you need more than one connector (input or output) per
user account, this must be defined on the FTP server. On
the FTP server, the number of concurrent connections
must be equal to, or higher than, the number of FTP
connectors (input and output) set up for a user account.
Platform: Windows and UNIX.

Connector settings

Host The FTP server, for example rtu.baldwin.com

Port The port on the FTP server.
User name The user name for accessing the FTP server.
Password The password for accessing the FTP server.
Remote path The directory to be accessed on the FTP server. If you
leave this blank, the root directory will be set as remote
path.
For example: /invoices/pdfout/area2
Whether to use slash or back-slash is determined by the
FTP server software.
File The file name, including file extension, to be written to
the FTP server.
Passive mode Select whether or not to enable Passive Mode. FTP in
Passive 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 itself on a randomly chosen high-
numbered port.
Note: This works with most firewalls unless the firewall
restricts outgoing connections on high-numbered
ports.
Transfer mode ASCII – ASCII, Type A, transfer method. Control and
formatting data is converted to local equivalents.
Binary – FTP Image, Type I, transfer method. The file is
transferred without any changes.
Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 55
Platform window

Runtime specific settings

If you select the <Default> options for Passive Mode and Transfer Mode, the
Platform settings will be used.

Generic Archive output connector settings

Used for: Archiving output in external archiving systems.

Platform: Windows and UNIX

Connector settings

Index directory A directory where the output will be stored temporarily

before it is sent to the archiving system. There will
automatically be one sub directory per job.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Index Entry Characters used to separate the Archive Attributes within
an index line.
Index Line Characters used to separate index lines.
Separator

Index Command This command is executed when all files have been
added to the Index Directory. For example:
programname -st %l -dt %
where programname uses the index file (%1) in the Index
Directory (%) for further processing.
Remove Job Select to remove the job directory (within the Index
Directory Directory) after successful completion of the Index
Command.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
56 Output Connector Settings dialog box
Platform window

Runtime specific settings

Archive Attributes The archive 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 the
Communication Server will output 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.

HTML output connector settings

Used for: Generating output spool files in static HTML using

stylesheets. The output is sent to the directory specified
in the connector settings.
You must use the HTML driver and configure the
settings at Job Begin in the Runtime configuration.
Platform: Windows and UNIX.

Connector settings

HTML destination The path to the HTML output. For example:

HTMLOUT/stones.html
If the output contains more than one HTML file, a
number will be added to the file name. For example:
stones-1.html
stones-2.html

HTTP Response output connector settings

Used for: Enabling the Communication Server to respond to an

HTTP request.
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 57
Platform window

Connector settings

Content-type The content-type of the output. For example:

text/html; charset="ascii"

Output mode Select to generate output per Process, Document or job.

Runtime specific settings

Custom header A user defined header that will be included in the

response. Use the following syntax:
<Name>:<Value>
You can separate <Name>:<Value> pairs with
<0d><0a>.

HTTP(S) Submit output connector settings

Used for: Enabling the Communication Server to function as an

HTTP client submitting output to an HTTP server.
Platform: Windows and UNIX.

Connector settings

Use security HTTPS only.

configuration
Select this option if you want to connect a security
configuration to this connector.
CA certificate HTTPS only.
A CA root certificate that confirms the identity of the
SSL server. The certificate must be included in a resource
set connected to the Platform. You can also specify the
CA root certificate in a security configuration that you
connect to this connector.
Security HTTPS only.
configuration
The security configuration to connect to this connector.
The security configuration must be included in a resource
set connected to the Platform. See the Encryption and
authentication documentation for more information.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
58 Output Connector Settings dialog box
Platform window

Connector settings

Method Specify the method the client will 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) the Communication

Server waits before cancelling a transfer.
Version The HTTP version to use.
SSL version HTTPS only.
The SSL version to use. Server and clients must use the
same SSL version.
Authentication 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.
Realm Only if authentication is required.
The name of the realm.
User name Only if authentication is required.
The user name to access the realm.
Password Only if authentication is required.
The password to access the realm.
Cache file The cache file that stores communication checksums
between Communication Server start/stop.
Output mode Select to generate output per Process, Document or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 59
Platform window

Runtime specific settings

Custom header A user defined header that will be added to the HTTP
output. Use the following syntax:
<Name>:<Value>
You can separate <Name>:<Value> pairs with
<0d><0a>.
Response place The connector that will receive the response from the
connector HTTP server.
To use the response, you must specify the connector that
will receive the response. This is either an HTTP
Response output connector, or any type of queue enabled
input connector.
Response custom A user defined header that will be added to the response
header from the HTTP server.
On failure file The path to a file that the Communication can send when
it fails to send output to the HTTP server.
On failure place The connector that will pick up the failure file. This is
connector either an HTTP Response output connector, or any type
of queue enabled input connector.
For example, if the Communication Server receives input
from a client, and sends output to an HTTP server, an
error message (the failure file) can be sent back to the
client using an HTTP Response connector.
On failure content The content-type of the failure file.
type

On failure custom A user defined header that will be added to the failure
header file.

Internal output connector settings

Used for: Enabling the Communication Server to loop back output

for further processing. Data is looped back to an Internal
input connector.
Comments: • Data sent from the Internal output connector must not
contain any formatting information.
• If you have an internal loop via an Internal input
connector and an Internal output connector, you must
specify a UTF-8 code page for both connectors.
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
60 Output Connector Settings dialog box
Platform window

Connector settings

Destination (input The Internal input connector to send data to.

connector name)

IXOS Archive in R3 output connector settings

Used for: Writing output to an IXOS transfer directory. IXOS is a

document management system for SAP/R3 users.
Comments: You must be familiar with IXOS and the terminology
used by IXOS. See www.ixos.com.
Platform: Windows and UNIX.

Connector settings

IXOS transfer The path to the IXOS transfer directory. For example:
directory
\\project\myfolder\IXOSfiles

Meta documents Yes – Enable the use of Meta Documents. Use Max
Documents in Meta below to specify the maximum
number of documents to be stored in each Meta
document. When the maximum number of documents
have been added, a new meta file is created, i.e. a new
document directory is created.
No – Disable the use of Meta Documents.

Max. no of The maximum number of documents in each Meta

documents in meta Document directory.

Fixed directory Yes – The Communication Server will use a fixed

name directory specified in the Runtime configuration.
No – The Communication Server will generate unique
directories with a maximum of 1000 documents in each
directory.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

IXATTR file lines These lines will be stored in a file. All variables specified
and in the lines will be checked, and their values will be used
Commands file when the file is created.
lines You can add, delete, or edit the lines, and you can also
rearrange the order of the lines.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 61
Platform window

Runtime specific settings

Autodetect When selected, the Communication Server will refer to
Document Type the driver being used to format the document.
Document Type This document type will be used regardless of the driver
type.
Directory Name The Fixed Directory.
Component Name The name to be inserted in the Commands file.

Java output connector settings

Used for: Custom Java output connector. See the StreamServe EIF
SDK documentation.
Platform: Windows and UNIX.

Java Response output connector settings

Used for: Custom Java output connector. See the StreamServe EIF
SDK documentation.
Platform: Windows and UNIX.

Java RMI output connector settings

Used for: Custom Java output connector. See the StreamServe EIF
SDK documentation.
Platform: Windows and UNIX.

JMS Publish output connector settings

Used for: Enabling the Communication Server to deliver messages

to a named topic in a publish-subscribe messaging
system.
For more information about JMS, see
http://java.sun.com/products/jms/

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
62 Output Connector Settings dialog box
Platform window

Platform: Windows and UNIX.

Connector settings

Context The JNDI context. If you leave this empty, the initial
context will be used.
Topic Factory The JNDI lookup name for the topic connection factory.
This setting is mandatory.
A JMS client uses a connection factory to create a
connection to the JMS provider.
User Name User name to access the JMS provider.
Password Password to access the JMS provider.
Topic The JNDI lookup name for the topic. This setting is
mandatory.
Custom Properties Custom message properties. Can be used for selecting
messages, or for providing information about contents or
message types. For example, set a custom header to
"color=’blue’".

Message Format BytesMessage – Send the message as bytes. The

recipient must know how to interpret the information.
Use this option if you specify a driver for the connector.
TextMessage – Send the message as text. Use this option
when sending XML or text formatted output.
Delivery Mode Default – Keep the settings defined in the deployment
process.
Persistent – Output will be delivered even if power is
lost.
Non persistent – Output will be delivered faster.
Delivery is not guaranteed if power is lost.
Priority JMS priority. 0 is lowest priority, and 9 is highest
priority. If you do not specify a priority level, the default
level is 4. A JMS provider tries to deliver messages with
high before messages with low priority, but will not
necessarily deliver the messages in the order of priority.
Time to live By default, a message will live forever. You can use this
parameter to specify an expiration time (milliseconds).

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 63
Platform window

Connector settings

Type This is a JMSType header field. You can, for example,

specify the type of message when using the message
format BytesMessage. Receivers can use the JMSType
header field to determine whether or not they can
interpret this kind of message.
Reply To The JNDI lookup name of the queue or topic to which the
message receiver should send a response message.
Specify this only if you expect the message receiver to
reply to the delivered message.
Correlation Id A correlation id for the message. Can be used to link one
message to another, for example to link a response
message to the corresponding request message.
It is possible to fetch the correlation ID for incoming JMS
messages using the scripting function GetExtJobId().
Output mode Select to generate output per Process, Document, or job.

JMS Queue output connector settings

Used for: Enabling the Communication Server to deliver messages

to a named queue in a point-to-point messaging system.
For more information about JMS, see
http://java.sun.com/products/jms/

Platform: Windows and UNIX.

Connector settings

Context The JNDI context. If you leave this empty, the initial
context will be used.
Queue Factory The JNDI lookup name for the queue connection factory.
This setting is mandatory.
A JMS client uses a connection factory to create a
connection to the JMS provider.
User Name User name to access the JMS provider.
Password Password to access the JMS provider.
Queue The JNDI lookup name for the queue. This setting is
mandatory.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
64 Output Connector Settings dialog box
Platform window

Connector settings

Custom Properties Custom message properties. Can be used for selecting

messages, or for providing information about contents or
message types. For example, set a custom header to
"color=’blue’".

Message Format BytesMessage – Send the message as bytes. The

recipient must know how to interpret the information.
Use this option if you specify a driver for the connector.
TextMessage – Send the message as text. Use this option
when sending XML or text formatted output.
Delivery Mode Default – Keep the settings defined in the deployment
process.
Persistent – Output will be delivered even if power is
lost.
Non persistent – Output will be delivered faster.
Delivery is not guaranteed if power is lost.
Priority JMS priority. 0 is lowest priority, and 9 is highest
priority. If you do not specify a priority level, the default
level is 4. A JMS provider tries to deliver messages with
high before messages with low priority, but will not
necessarily deliver the messages in the order of priority.
Time to live By default, a message will live forever. You can use this
parameter to specify an expiration time (milliseconds).
Type This is a JMSType header field. You can, for example,
specify the type of message when using the message
format BytesMessage. Receivers can use the JMSType
header field to determine whether or not they can
interpret this kind of message.
Reply To The JNDI lookup name of the queue or topic to which the
message receiver should send a response message.
Specify this only if you expect the message receiver to
reply to the delivered message.
Correlation Id A correlation id for the message. Can be used to link one
message to another, for example to link a response
message to the corresponding request message.
It is possible to fetch the correlation ID for incoming JMS
messages using the scripting function GetExtJobId().
Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 65
Platform window

JMS Response output connector settings

Used for: Enabling the Communication Server to send a response

to a received message. The received message must
include information about which queue or topic to send
the response to.
For more information about JMS, see
http://java.sun.com/products/jms/

Platform: Windows and UNIX.

Connector settings

Queue Factory The JNDI lookup name for the queue connection factory.
A JMS client uses a connection factory to create a
connection to the JMS provider.
Queue User Name User name to access the (queue) JMS provider.
Queue Password Password to access the (queue) JMS provider.
Topic Factory The JNDI lookup name for the topic connection factory.
Topic User Name User name to access the (topic) JMS provider.
Topic Password Password to access the (topic) JMS provider.
Custom Properties Custom message properties. Can be used for selecting
messages, or for providing information about contents or
message types. For example, set a custom header to
"color=’blue’".

Message Format BytesMessage – Send the message as bytes. The

recipient must know how to interpret the information.
Use this option if you specify a driver for the connector.
TextMessage – Send the message as text. Use this option
when sending XML or text formatted output.
Delivery Mode Default – Keep the settings defined in the deployment
process.
Persistent – Output will be delivered even if power is
lost.
Non persistent – Output will be delivered faster.
Delivery is not guaranteed if power is lost.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
66 Output Connector Settings dialog box
Platform window

Connector settings

Priority JMS priority. 0 is lowest priority, and 9 is highest

priority. If you do not specify a priority level, the default
level is 4. A JMS provider tries to deliver messages with
high before messages with low priority, but will not
necessarily deliver the messages in the order of priority.
Time to live By default, a message will live forever. You can use this
parameter to specify an expiration time (milliseconds).
Type This is a JMSType header field. You can, for example,
specify the type of message when using the message
format BytesMessage. Receivers can use the JMSType
header field to determine whether or not they can
interpret this kind of message.
Reply To The JNDI lookup name of the queue or topic to which the
message receiver should send a response message.
Specify this only if you expect the message receiver to
reply to the delivered message.
Correlation Id A correlation id for the message. Can be used to link one
message to another, for example to link a response
message to the corresponding request message.
It is possible to fetch the correlation ID for incoming JMS
messages using the scripting function GetExtJobId().
Output mode Select to generate output per Process, Document, or job.

Job Resource output connector settings

Used for: Temporarily storing data as a job resource that will be

added to processed data later on. For example, you can use
the EMF Print processor to convert EMF files into LXF
overlays. The LXF overlay is sent to a Job Resource output
connector. The LXF overlay can then be called from a
PageOUT Process and be added to the processed output.
Comments: The following script functions are related to this connector:
• OutputLXFJobResource()

• DeleteJobResource()

• GetJobResourceIndex()

• GetJobResourceURI()

Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 67
Platform window

Connector settings

Name A name used together with scripting functions to identify

a specific job resource.
Content-type Used only with HTTP(S) input and HTTP Response
output connectors.
The content-type of the job resource. For example:
text/html; charset="ascii"

Custom header Used only with HTTP(S) input and HTTP Response
output connectors.
A user defined header that will be added to the job
resource. Use the following syntax:
<Name>:<Value>
You can separate <Name>:<Value> pairs with
<0d><0a>.
Expire by time Yes – Define a life-time for the job resource.
No – Do not define a life-time for the job resource.
Renew – Restart the life-time counter when the resource
has been accessed.
Duration Duration and Time unit sets the life time.
Time unit Duration and Time unit sets the life time.
Expire by access Yes – Limit the number of times a resource can be
accessed before it is deleted.
No – Do not limit the number of times a resource can be
accessed.
Access count The number of times the resource can be accessed. All
resource operations within the same job are considered as
one access.
Expire with job Yes – Delete the resource when the job is completed.
No – Do not delete the resource when the job is
completed.
Output mode Select to generate output per Process, Document, or job.

Lotus Notes output connector settings

Note: If you run the Communication Server and a Lotus Notes client version 6.x
or 7.0 on a Windows 2003 Server, you must install Citrix to use the Lotus
Notes output connector.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
68 Output Connector Settings dialog box
Platform window

Used for: Writing output to a Lotus Notes database on a Lotus

Domino server.
Platform: Windows.

Connector settings

Notes Server The Lotus Domino server to connect to.

For example:
windows_server05/my_domino_server
where windows_server05 is the computer hosting the
Lotus Domino server.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Notes Database The Lotus Notes database on the Lotus Domino server
specified in the Notes Server setting. The Lotus Notes
database stores the output from the Communication
Server as an attachment to a Note.
For example:
custmsgs.nsf
Note: The specified database must allow write access
for the user specified in the Lotus ID file. Only a
Lotus Domino administrator can enable read or
write access to the Lotus Notes database.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 69
Platform window

Runtime specific settings

Password The password for unlocking the Lotus ID file which

authenticates access to a Lotus Notes database.
The Communication Server searches for the Lotus ID file
named ssdominouser.id in the export directory of the
StreamServe Project. If the Lotus ID file is not found, or
if the password fails to unlock it, the Communication
Server tries to use the previously used Lotus ID file that
ssnotes.ini has a reference to.
If you connect to the database via a Lotus Domino server,
without access to a Lotus Notes client installation, you
must:
• Obtain a suitable Lotus ID file.
• Ensure that the Lotus ID file is recertified and
contains a valid password.
• Rename the Lotus ID file to ssdominouser.id
• Store the Lotus ID file in the export directory of the
Project.
Ask your Lotus Domino administrator for assistance.
Default Form The Lotus Notes form to be used. To create a Lotus Notes
form on the Lotus Domino server, you must use the
Domino Designer client.
File name The name of the file created by the Communication
Server and attached to the Note.
For example:
$docname.pdf
Note: The Temporary directory property must be
specified with a full path for the StreamServe
service running the Project.
Compress Select to compress the file attached to the Note when
sending it to the Domino Server.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
70 Output Connector Settings dialog box
Platform window

Runtime specific settings

Indexes In addition to the attached file produced by the

Communication Server, you can add data about the
attachments to the corresponding Note. This is useful if
you want data about the attachment to be easily
accessible by the Lotus Notes client or the Lotus Notes
Fetch wizard, without having to open the attachment.
To add this data for a Note, you must enter the items that
will be included in the Note and a variable for each item.
Index Name – The Note item name.
Data Type – The type of the item data.
Variable – A StreamServe variable. The value of the
variable is stored in the Note.

To specify the number of, and delay between attempts to

• open the Lotus Notes database
• send a Note to the Domino Server via a Lotus Notes output connector,
you can specify the following additional runtime parameters on the Custom tab.

Parameter Description

lotusdbopenretrydelay The time to wait in milliseconds between attempts

<open_delay> to open the Lotus Notes database. The default
value is 1000.
For example:
lotusdbopenretrydelay 2000

lotusdbopenmaxretries The number of times to attempt to open the Lotus

<open_retries> Notes database. The default value is 10.
For example:
lotusdbopenmaxretries 5

lotusconnretrydelay The time to wait in milliseconds between attempts

<send_delay> to send a Lotus Note to the Lotus Domino server
via a Lotus Notes output connector. The default
value is 20000.
For example:
lotusconnretrydelay 15000

lotusconnmaxretries The number of times to attempt to send a Note to

<send_retries> the Lotus Domino server via a Lotus Notes output
connector. The default value is 10.
For example:
lotusconnmaxretries 20

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 71
Platform window

MAPI output connector settings

Used for: Sending output via MAPI email.

Comments: In the Control Center, the logon options for the
Communication Server service 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 connector. To
change the logon options, right-click the service in the
Control Center and select Service Startup.
Platform: Windows

Connector settings

Default profile The Windows Messaging Profile that will be used by

default.
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 The number of times to try to reconnect if the mail server
does not respond.
Retry interval The interval (seconds) between retries.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Edit Mail Opens the email editor.

Ignore missing Select whether or not you want the Communication
attachments Server to try to send an email with missing attachments.
Attachment name The name of the attachment that contains the output from
the Process. For example:
$custno.pdf

Convert PCL to Select whether or not to convert PCL attachments to

PDF PDF.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
72 Output Connector Settings dialog box
Platform window

Runtime specific settings

Compress Select whether or not to compress the attachments.

Code page Code page for the email.
Profile name A Windows Messaging Profile identifies a specific user.
The email address that will be used is the address
specified in the From address in the user’s profile – no
matter what you entered in the From field when you
created the email. To be able to use alternative From
addresses, you must set up a profile for each address.
Use default Profile of Connector – Use the profile
specified in the Platform.
Static – Use an alternative profile.
Variable – Use a variable to determine the alternative
profile.
Lookup – Use a lookup table to determine the alternative
profile.

Edit Mail settings

To, Cc, Bcc, and Standard email attributes.

Subject

Request receipt Request a read receipt from the email recipient. A

notification is received when the recipient reads the email
– provided that this functionality is supported by the
email servers and clients.
Attachments Attached files (not Process output). Use the Add/ Edit
buttons to specify the Mail Attachment settings.

Mail Attachment settings

Attachment The path to the file to attach.

Attachment name The name of the attachment, for example
pricelist.pdf.
Leave this empty if you want the attachment name to be
the same as the name of the source file.
Convert Select whether or not to convert PCL attachments to
attachment from PDF.
PCL to PDF

Compress Select whether or not to compress the attachments.

attachment

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 73
Platform window

MAPI for MailOUT output connector settings

Used for: Sending output via MailOUT and MAPI email.

Comments: In the Control Center, the logon options for the
Communication Server service 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 connector. To
change the logon options, right-click the service in the
Control Center and select Service Startup.
Platform: Windows.

Connector settings

Default Profile The Windows Messaging Profile that will be used by

default.
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 Number of times to try to reconnect if the mail server
does not respond.
Retry interval Interval (seconds) between retries.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
74 Output Connector Settings dialog box
Platform window

Runtime specific settings

Profile Name A Windows Messaging Profile identifies a specific user.

The email address that will be used is the address
specified in the From address in the user’s profile – no
matter what you entered in the From field when you
created the email. To be able to use alternative From
addresses, you must set up a profile for each address.
Use default Profile of Connector – Use the profile
specified in the Platform.
Static – Use an alternative profile.
Variable – Use a variable to determine the alternative
profile.
Lookup – Use a lookup table to determine the alternative
profile.

MSMQ output connector settings

Used for: Enabling and integrating Communication Server

capabilities in Microsoft message queuing
environments.
Private and Public message queues are published in the Active
public message Directory.
queues: Private message queues are not published in the Active
Directory. They are accessible only by Message Queuing
applications that know the full path name or format name
of the message queue.
Platform: Windows.

Connector settings

Queue Manager The server on which the MS Message Queue resides.

Queue Name The MS Message Queue to which to write data. This MS
Message Queue must belong to the Queue Manager.
Private Select to access a Private message queue. A private
message queue can be accessed even if the queue
manager is off-line.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 75
Platform window

Connector settings

Max Message Size The maximum size for an MSMQ message is 4 MB. This
is also the default message size if no other value is
specified.
If the data sent from the Communication Server exceeds
this size, it will be split into several messages. These
messages will be synchronized as follows:
• The first message in the sequence will have the
appspecific property set to the number of messages
that will arrive in this sequence of segmented
messages (the first message is excluded).
• The following messages will have this number
decreased by one and the last message in the
sequence will have the appspecific property set to
0.
• All messages, except the first one, will have their
correlation ID property set to the message ID of the
first message.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Message Delivery Express – The message is not stored on disk, and cannot
be recovered in case of failure.
Persistent – The message is stored on disk, and can be
recovered in case of failure.
Message Priority The priority of the message.
Message Enable message encryption. Symmetric key and
Encryption asymmetric (public/private) key encryption algorithms.
Encryption slows down transfer of messages.
Message Journals provide audit trails.
Journaling
MQMSG_JOURNAL_NONE – No journaling.
MQMSG_JOURNAL – Journaling enabled.
MQMSG_DEADLETTER – If the message is not
delivered or read in time, it will be stored in a deadletter
queue.
MQMSG_JOURNAL|MQMSG_DEADLETTER – Both
journaling and deadletter functionality enabled.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
76 Output Connector Settings dialog box
Platform window

Runtime specific settings

Max Time to Reach The maximum time (seconds) for the message to reach
Queue the destination queue.
If the message does not reach the destination queue
within this time, and you have enabled one of the dead-
letter options, the message will be moved to the dead-
letter queue.
Max Time to The maximum time (seconds) to wait for the message to
Receive be read.
If the message is not read within the specified time, and
you have enabled one of the dead-letter options, the
message will be moved to the dead-letter queue.
Message Tracing Tracing Off – No tracing of the progress of the message.
Tracing On – Progress of the message is traced.
Note: Message route tracking must be enabled by
defining a report queue for the sending party.
Transaction Type MQ_NO_TRANSACTION
The message will be sent without transactional support.
MQ_INTERNAL_TRANSACTION
The message will be sent within a transaction.
Transactional messages are either sent together and in the
order they were sent (a committed transaction), or not
sent at all (an aborted transaction).
Note: The receiving MSMQ queue must support
transactions.
Message Label A descriptive text to include in the message.

Netware Bindery output connector settings

Used for: Sending data to a Novell 3.x network print queue.

Platform: Windows.

Connector settings

Server The Novell 3.x network server.

Queue name The Novell 3.x network print queue.
Print server The Novell 3.x network print server.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 77
Platform window

Connector settings

Password Password to the Novell 3.x network print server.

Netware NDS output connector settings

Used for: Sending data to a Novell 4.x network print queue.

Platform: Windows.

Connector settings

Queue The Novell 4.x network print queue.

Null Connector output connector settings

Used for: Enabling the Communication Server to send output to a

dummy connector that does not direct output to any file
or printer.
Platform: Windows and UNIX.

Connector settings

There are no properties for this type of connector.

Pipe output connector settings

Used for: Sending output to a named pipe.

Platform: UNIX.

Connector settings

Pipe The command to execute, for example

cat

RePRINT output connector settings

Used for: Delivering documents to a RePRINT database.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
78 Output Connector Settings dialog box
Platform window

Platform: Windows and UNIX.

Connector settings

Data source The ODBC data source to connect to. For example
StrsArchiveDSN

User name User name for accessing the data source.

Password Password for accessing the data source.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Document type The document type identifier. Can contain any alpha-
identifier numeric character, including space. Maximum 55
characters.
To store several document types, you must use a variable
for the identifier.
Available A list of available document types for the specified
document types document type identifier.

Service Channel Response (COM) output connector settings

Used for: Used together with a Service Channel Response (COM)

input connector. Sends the processed output back to the
client via the Service Channel Response (COM) input
connector.
Platform: Windows.

Connector settings

Input Connector The Service Channel Response (COM) input connector

Name that received the input.
Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 79
Platform window

Service Channel Response (HTTP) output connector settings

Used for: Used together with a Service Channel (HTTP) input

connector. Sends the processed output, via a Service
Broker, back to the client.
Platform: Windows and UNIX.

Connector settings

Content-type The content-type of the output. For example:

text/html

Output mode Select to generate output per Process, Document, or job.

Service Channel Submit (COM) output connector settings

Used for: Invoking services via a Service Broker.

Platform: Windows.

Connector settings

Service Broker The Service Broker host.

Host

Service Description The name of the requested service. For example:

Service_3

Server ID The server ID of a specific Communication Server. For

example:
124.234.7.31\StreamServe4
Specify this only if you want to select a specific
Communication Server. If you do not specify a Server
ID, the Service Broker will select the appropriate
Communication Server.
Wait for lock The maximum time (milliseconds) the connector will
wait to access the service.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
80 Output Connector Settings dialog box
Platform window

Connector settings

Send Mode Direct – Send data directly to the destination. Runtime

settings will have no effect in this mode. To enable
Runtime settings you must use one of the Buffer modes
below.
Buffer in memory – Buffer all data in memory before
sending it. Fast data transfer, but can consume a lot of
memory.
Buffer to disk – Buffer all data on disk before sending it.
Suitable for large files.
Output mode Select to generate output per Process, Document, or job.

Service Channel Submit (HTTP) output connector settings

Used for: Invoking services via a Service Broker. Can also be used
for adding documents to a service response.
Platform: Windows and UNIX.

Connector settings

Service Broker The Service Broker host.

host

Port The Service Broker port.

Service description The name of the requested service. For example:
Service_3

Server ID The server ID of a specific Communication Server. For

example:
124.234.7.31\StreamServe4
Specify this only if you want to select a specific
Communication Server. If you do not specify a Server
ID, the Service Broker will select the appropriate
Communication Server.
Version The version of the service. If omitted, the highest
registered version of the service will be used.
Content-type The content-type of the submitted output. For example:
application/pdf

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 81
Platform window

Connector settings

Command Specifies what to do with the output data (document).

SendDocument – Send the output via the Service Broker
to a Communication Server. The Communication Server
will process the data, and send the processed output to a
printer, fax, etc..
SendReceiveDocument – Send the output via the
Service Broker to a Communication Server. The
Communication Server will process the data, and send
the processed output back in the response.
AddDocument – Send the output to the Service Broker.
The Service Broker will add this document to a response
that has the same Doc Group ID or Strs ID as this
document.
Response service The service name of the Service Channel (HTTP) input
channel connector that will receive the response. For example:
response_connector

Connection time- The maximum time (milliseconds) to wait to connect to

out the Service Broker .
Communication The maximum time (milliseconds) to wait before
time-out aborting transfer/reception of data.
Doc group ID Can be used to define which response to add documents
to.
The instance that issued the SendReceiveDocument
request is the instance that will receive the response. The
instance that issued the AddDocument request is the
instance that will add the document to the above
response. The document will be added to the response if
either:
• Both instances use the same Doc Group ID.
• No Doc Group ID is specified, and the response
and document to add have the same Strs ID.
LastDoc Defines whether or not the current document is the last
document to add. Normally used when the client that
issued the SendReceiveDocument request sets
waitfordocs to -1.

Output mode Select to generate output per Process, Document, or job.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
82 Output Connector Settings dialog box
Platform window

SMS output connector settings

Used for: Sending SMS messages via a mobile phone and an SMS
Server.
Platform: Windows and UNIX.

Connector settings

URI The URI that identifies the SMS Server. For example
ipp://WTREGH09/SMSOUT
Must be the same URI as specified for the SMS Server
(SMS spooler device) in the Control Center.
User name User name to associate with jobs sent from this
connector.
Password N/A
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Name The recipient’s name.

Number The recipient’s mobile phone number, including country
code.
If you enter several numbers, you must separate the
numbers with semi-colon(;). For example:
+46 70 555 5555;+46 70 555 5556

Service Center Applicable only if you want to use a number other than
the default service center number for the recipient(s).
Retries The time the service center should try to re-send
messages that fail.
Message Type The message type.

SMS Provider output connector settings

Used for: Sending SMS messenger via an external service provider

(Telia).
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 83
Platform window

Connector settings

Account The account number provided by Telia.

Password The password for accessing the account. Provided by
Telia.
Address The service provider URL:
https://telemat.telia.com/aps/APSlet

CA Certificate The CA certificate provided by telia.

Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Recipients The recipient’s mobile phone number.

If you enter several numbers, you must separate the
numbers with semi-colon(;). For example:
070 555 5555;070 555 5556

SMTP output connector settings

Used for: Sending output to an SMTP server. The data recipient,

for example another Communication Server, will in turn
retrieve the information from the SMTP server. This is
similar to communication via HTTP. The main difference
is that the data recipient does not have to be up and
running when the output is sent out.
Comments: You must specify the recipients, normally one or more
mail boxes, of the output sent to the SMTP server. You
must use the SetDestPath script function to specify the
recipients. For example:
SetDestPath("[email protected];[email protected]");
SetDestPath($email);

Platform: Windows and UNIX.

Connector settings

Mail server The IP address or host name of the SMTP server.

Return Address The email address to which the SMTP server will report
errors.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
84 Output Connector Settings dialog box
Platform window

SMTP (MIME) output connector settings

Used for: Sending output via SMTP (MIME) email.

Platform: Windows and UNIX.

Connector settings

Mail server The IP address or host name of the regular mail server.
For example:
mail.domain.com

Mail server user User name for accessing the SMTP mail server.
name

Mail server Password for accessing the SMTP mail server.

password

Alternate mail The IP address or host name of an alternative mail server.

server Used if the regular mail server does not respond.
Domain name The domain from which the Communication Server
sends the email. For example:
streamserve.com
The Domain Name must be a name accepted by the mail
server. A mail server is normally configured to serve a
specific domain.
Number of retries 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 whether or not you want the Communication
Server to sign emails (S/MIME).
Encrypt Select whether or not you want the Communication
Server to encrypt emails (S/MIME).
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Edit Mail Open the email editor.

Ignore missing Select whether or not you want the Communication
attachments Server to send an email if an attachment is missing.
Attachment name The name of the attachment that contains the output from
the Process. For example:
$custno.pdf

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 85
Platform window

Runtime specific settings

Convert PCL to Select whether or not to convert PCL attachments to

PDF PDF.
Compress Select whether or not to compress the attachments.
Attachment MIME The MIME type (content-type) of the attachment.
Type
Autoselect – The Communication Server determines
which MIME type to use. The information is retrieved
from the driver that generates the attachment file.
Predefined – Select the MIME type from a list.
Custom – Specify a custom MIME type.

Predefined MIME Select the MIME type from a list.

Type

Custom MIME Type Specify a custom MIME type.

Code page Code page for the email.

MIME Encoding MIME encoding for subject, body, and attachments.
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.

Edit Mail settings

From, To, Cc, Bcc, Standard email attributes.

and Subject

Reply to Used by the client instead of the From address when

responding to an e-mail.
Display name The From address will be replaced by this name when the
email is delivered. This functionality must be supported
in the email client.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
86 Output Connector Settings dialog box
Platform window

Edit Mail settings

Request receipt Request a read receipt from the email recipient. A

notification is received when the recipient reads the email
– provided that this functionality is supported by the
email servers and clients.
Attachments Attached files (not Process output). Use the Add/ Edit
buttons to specify the Mail Attachment settings.

Mail Attachment settings

Attachment The path to file to attach.

Attachment name The name of the attachment, for example
pricelist.pdf.
Leave this empty if you want the attachment name to be
the same as the name of the source file.
MIME Type The MIME type (content-type) of the selected
attachment.
Predefined – Select the MIME type from a list.
Custom – Specify a custom MIME type.

Convert Select whether or not to convert PCL attachments to

attachment from PDF.
PCL to PDF

Compress Select whether or not to compress the attachments.

attachment

SMTP (MIME) for MailOUT output connector settings

Used for: Sending output from MailOUT via SMTP (MIME).

Platform: Windows and UNIX.

Connector settings

Mail server The IP address or host name of the regular mail server.
For example:
mail.domain.com

Mail server user User name for accessing the SMTP mail server.
name

Mail server Password for accessing the SMTP mail server.

password

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 87
Platform window

Connector settings

Alternate mail The IP address or host name of an alternative mail server.

server Used if the regular mail server does not respond.
Domain name The domain from which the Communication Server
sends the email. For example:
streamserve.com
The Domain Name must be a name accepted by the mail
server. A mail server is normally configured to serve a
specific domain.
Number of retries 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 whether or not you want the Communication
Server to sign emails (S/MIME).
Encrypt Select whether or not you want the Communication
Server to encrypt emails (S/MIME).

SNMP trap output connector settings

Used for: Sending SNMP traps to Network Management Systems.

Platform: Windows and UNIX.

Connector settings

Trap destination The IP address or hostname of the NMS.

Trap destination IP The port on which the NMS receives SNMP traps.
port

Community string Password used by the Communication Server to

authenticate itself to the NMS.
Source description A description of the source sending the notifications.

Spool output connector settings

Used for: Sending output to a printer.

Platform: Windows.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
88 Output Connector Settings dialog box
Platform window

Connector settings

To The printer to send output to.

Output mode Select to generate output per Process, Document, or job.

StdOut output connector settings

Used for: The StdIn and StdOut connectors enable external

applications to send data to StreamServe via StdIn and
receive output on StdOut.
Platform: Windows and UNIX.

Connector settings

There are no settings for this type of connector.

StreamServe External Viewer output connector settings

Used for: Sending output to a Preview Server. The Preview Server

reads the file extension and opens the output file in the
corresponding application (*.pdf in Acrobat Reader,
etc.). The Preview Server recognizes the following
formats: pdf, ps, tif, dcx, html, xml, pcl. It tries to open
other formats as *.txt.
Example: You have two Processes – 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");

Platform: Windows.

Connector settings

Host The Preview Server host.

Port The port the Preview Server listens to. The default port is
9343.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 89
Platform window

Connector settings

Output mode Select to generate output per Process, Document, or job.

TCP/IP output connector settings

Used for: Enabling the Communication Server to send output to a

TCP/IP address anywhere on the system or network.
Platform: Windows and UNIX.

Connector settings

Host The receiving host.

Port The port the host listens to. The default port is 9343.
Output mode Select to generate output per Process, Document, or job.

TFS output connector settings

Used for: Sending output via TFS.

Platform: Windows and UNIX.

Connector settings

TFS installation The TFS installation directory.

directory

Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Edit Mail Open the email editor.

Ignore missing Select whether or not you want the Communication
attachments Server to send an email if an attachment is missing.
Attachment name The name of the attachment that contains the output from
the Process. For example:
$custno.pdf

Convert PCL to Select whether or not to convert PCL attachments to

PDF PDF.
Compress Select whether or not to compress the attachments.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
90 Output Connector Settings dialog box
Platform window

Runtime specific settings

Code page Code page for the email.

Edit Mail settings

From, To, Cc, and Standard email attributes.

Subject

Attachments Attached files (not Process output). Use the Add, Edit
buttons and specify the Mail Attachment settings.

Mail Attachment settings

Attachment The path to the file to attach.

Attachment name The name of the attachment, for example
pricelist.pdf.
Leave this empty if you want the attachment name to be
the same as the name of the source file.
Convert Select whether or not to convert PCL attachments to
attachment from PDF.
PCL to PDF

Compress Select whether or not to compress the attachments.

attachment

TFS for MailOUT output connector settings

Used for: Sending output from MailOUT via TFS.

Platform: Windows and UNIX.

Connector settings

TFS installation The TFS installation directory.

directory

Topcall output connector settings

Used for: Enabling the Communication Server to send fax and

email output via TOPCALL.
Platform: Windows and UNIX.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 91
Platform window

Connector settings

TOPCALL To The destination for address information.

Directory

TOPCALL The destination for the Communication Server output

Attachment files.
Directory

WebSphere MQ output connector settings

Used for: Sending output via an IBM WebSphere message queue.

See Dependencies and requirements on page 93 before
you configure the connector.
Platform: Windows and UNIX.

Connector settings

Queue manager The queue manager that owns the message queue.
Queue name The message queue to which to write data.
Message AS_Q_DEF – use the same message persistency as the
persistence default specified for the queue used.
Yes – write the message to disk. The message will be
recoverable in case of system failure.
No – process the message in memory. This will improve
performance at the expense of security.
Max. message size The maximum message size that the Communication
Server can send without message segmentation (platform
dependent). Default is 4Mb.
Allow queue Yes – enable the Queue Manager to segment the
manager message. This could be necessary if the message is routed
segmentation between different platforms and the message exceeds
Max message size on a specific platform.
No – the Queue Manager will not segment the message.

Allow application Yes – if data content is larger than the maximum message
segmentation size, the Communication Server will divide the data into
several smaller messages.
No – if data content is larger than the maximum message
size, no data is sent to the message queue and an error
message is written to the log.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
92 Output Connector Settings dialog box
Platform window

Connector settings

Message format String – enable the Queue Manager to convert the

message data to the character format used on the platform
that receives the message.
None – disable the message data conversion. If a code
page is specified, the data will be converted to this code
page regardless of the Message Format setting.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Message type Select a message type so that the receiving application
can determine how to handle the message.
Request – an answer to the message is expected. If
selected, you must set the ReplyToQ and ReplyToQMgr
properties on the Custom tab. See Custom options below.
Reply – the message is a reply to a request message.
Datagram – no answer to the message is expected.
Report – a receiving application or a Queue Manager can
report the message status to the sending application,
depending on how the report properties on the received
message have been set.
Message ID Enter a message id to enable sending and receiving
applications to correlate messages. Maximum length is
24 characters.
Correlation ID Enter a correlation ID for example if you are sending a
reply message, and want the receiver to know which
message you reply to. Use the Message Id from the
request.
The maximum length is determined by the environment
variable MQ_CORREL_ID_LENGTH. The recommended
value is 24.

You can specify the following additional runtime parameters on the Custom tab.

Parameter Description

Report Option Refer to the WebSphere MQ documentation for

information about available Report Options.
Must be long integer format (hexadecimal or decimal).
For example:
QueueOption "Report Option" "0x101c000"

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 93
Platform window

Parameter Description

ReplyToQ The queue to reply to if a request message is sent or if any

report options are set. For example:
QueueOption "ReplyToQ" "pdfQ"

ReplyToQMgr The queue manager that the reply queue in the ReplyToQ
field belongs to. For example:
QueueOption "ReplyToQMgr" "QM_Strs"

Dependencies and requirements

The IBM WebSphere MQ environment

The IBM WebSphere MQ environment must be installed on the same host as the
Communication Server, and the IBM WebSphere MQ configuration must be done
using IBM WebSphere MQ specific tools.

Asynchronous messaging
The WebSphere MQ output connector only supports asynchronous messaging.

Defining a client-connection channel

You must define a client-connection channel that specifies the name of the MQI
channel, the communication type, and the WebSphere MQ Server address. The
name of the MQI channel must be the same as the name of the server-connection
channel defined on the WebSphere MQ Server. You can define the client-
connection channel using the environment variable MQSERVER, as shown in the
example below. For more information, see the IBM WebSphere MQ
documentation.

Example 6 Defining client-connection channel

SET MQSERVER=CHANNEL1/TCP/<WebSphere MQ server address>

Startup arguments
You must add -webspheremq to the argument file.

WinFaxAdapter output connector settings

Used for: Enabling the Communication Server to send fax via

WinFax.
Platform: Windows.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
94 Output Connector Settings dialog box
Platform window

Connector settings

Temporary File Path The destination for the output files from the
Communication Server.
Attachment Expire Enable deletion of output files.
by Days

Days Number of days the output files are stored in the output
directory.
Output mode Select to generate output per Process, Document, or job.

XTrade output connector settings

Used for: Enabling the Communication Server to act as an XTrade

client and send output to an XTrade server.
XTrade is a product for integrating business processes and
information systems. XTrade makes it possible for
different information systems on different platforms to
communicate with each other. See www.xware.com.
Platform: Windows and UNIX.

Connector settings

XTrade server The IP address or host name of the XTrade server.

Default contract The default contract name.
Client name The IP address or host name of the host on which the
Communication Server is installed.
Acknowledge DN Enable DN acknowledgements.
The DN acknowledgement is sent when the receiving
XTrade server has received the message. If enabled,
StreamServe will wait until the Acknowledge Timeout
has expired before marking the output as successfully
sent.
Acknowledge PN Enable PN acknowledgements.
The PN acknowledgement is sent when the receiving
client has received the message. If enabled, StreamServe
will wait until the Acknowledge Timeout has expired
before marking the output as successfully sent.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output Connector Settings dialog box 95
Platform window

Connector settings

Acknowledge time- The number of seconds the Communication Server waits

out (s) for DN and PN acknowledgements from the XTrade
server.
Use EDI-MGR Only applicable when the output is created for E-
header Faktura, a Swedish electronic invoice format.
Select Yes if you want to insert an EDI-MGR Header in
each message. You specify EDI-MGR Header fields in
the Runtime settings.
Output mode Select to generate output per Process, Document, or job.

Runtime specific settings

Contract The contract name. Overrides Default Contract in the
Platform.
EDI-MGR Sender The Sender Code to use. The Sender Code is normally an
Code EAN code.
EDI-MGR Receiver The Receiver Code to use. The Receiver Code is
Code normally an EAN code.
EDI-MGR Message The message type.
Type

General Settings tab

Used for: Downloading resource files to printers, adding notes, and adding
custom commands and keywords.

Settings

Download File The resource file, e.g. an overlay file, to download to the
printer.
Enable download Select to download the file for each page. Otherwise the
file is downloaded only for the first page.
Note Add comments and notes to the current connector.
Custom Settings Enter custom keywords or commands.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
96 Configure Platform dialog box
Platform window

Configure Platform dialog box

Used for: Specifying interfaces to different types of repositories, services, etc.
• Job ID tab
• Dynamic Resources tab
• Default Repository tab
• Job Status tab
• Recording Mode tab
• Log File tab
• Custom tab
• Gateway tab
• Service Broker tab
• Notifications tab
• File Cache tab

Job ID tab
Used for: Configuring the Job ID repository. The repository stores job identifiers
that can be used as search criteria in the Job Gateway.

Settings

Use Job ID Enable the Job ID repository.

repository

Alias/Path An alias or path that points to the location of the

repository. The repository is created the first time you
run the Project.
Path
An absolute path, or a path relative to
<installation_directory>/Server.

%(PlatformName)
The suggested path is %(PlatformName)/
<repository>. The string %(PlatformName) will be
replaced with the name of the Platform. For example:
C:/Strs41/Server/PLT22/jobid
Alias
You can use the Repository Tool to create aliases for
repositories.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Configure Platform dialog box 97
Platform window

Settings

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.

Reconnection to repository server

On the Custom tab, you can use the keyword DefaultRepositoryFailover to
specify how the Communication Server should reconnect to the repository server
in case of a network failure.

Syntax: DefaultRepositoryFailover <n1> <n2> <n3>;

where: <n1> specifies the number of reconnection attempts. If set to -1, the
Communication Server will try to reconnect until a connection is
successfully established.
<n2> specifies the time (seconds) between reconnection attempts.
<n3> specifies whether or not the Communication Server will shut
down after the last unsuccessful reconnection attempt:
• If set to 0, the Communication Server will not shut down.
• If set to any other value, the Communication Server will shut
down.

Dynamic Resources tab

Used for: Configuring the Dynamic Resources repository. This repository is used
by PreformatIN for storing dynamic overlays.

Settings

Use Dynamic Enable the Dynamic Resources repository.

Resources
repository

Inherit Default Use the settings defined on the Default Repository tab.
Repository settings

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
98 Configure Platform dialog box
Platform window

Settings

Alias/Path An alias or path that points to the location of the

repository. The repository is created the first time you
run the Project.
Path for Server mode repositories
An absolute path, or a path relative to
<installation_directory>/Server

Path for LOCAL mode repositories

An absolute path, or a path relative to
<Export_directory>/data/data

%(PlatformName)
The suggested path is %(PlatformName)/
<repository>. The string %(PlatformName) will be
replaced with the name of the Platform. For example:
C:/Strs41/Server/PLT22/DynamicResources
Alias
You can use the Repository Tool to create aliases for
repositories.
Use repository server Run the repository in server mode. This mode enables:
• Remote clients to access the repository.
• Multiple clients to access the repository at a time.
If not selected, the repository will be run in LOCAL
mode.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.

Default Repository tab

Used for: Configuring repository settings that can be inherited when configuring
other repositories.

Settings

Define a default Enable the default repository.

repository

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Configure Platform dialog box 99
Platform window

Settings

Alias/Path An alias or path that points to the location of the

repository.
Path for Server mode repositories
An absolute path, or a path relative to
<installation_directory>/Server

Path for LOCAL mode repositories

An absolute path, or a path relative to
<Export_directory>/data/data

%(PlatformName)
The suggested path is %(PlatformName)/
<repository>. The string %(PlatformName) will be
replaced with the name of the Platform. For example:
C:/Strs41/Server/PLT22/default_rep
Alias
You can use the Repository Tool to create aliases for
repositories.
Use repository server Run the repository in server mode. This mode enables:
• Remote clients to access the repository.
• Multiple clients to access the repository at a time.
If not selected, the repository will be run in LOCAL
mode.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.

Job Status tab

Used for: Specifying how to track, report, and store status information.

Settings

Track status Select whether or not to track job status.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
100 Configure Platform dialog box
Platform window

Settings

Report status Specify when generate a status report.

When input is received – This type of status report only
guarantees that the Communication Server has received
input. No failures at a later stage will be reported.
When output is queued – This type of status report is
generated when the Communication Server has
processed the input data, and sent the output to an output
queue.
When delivered from the output queue – This type of
status report is generated when the Communication
Server has delivered the output from the output queue.
Purge status Select whether or not to purge the status storage. The
status storage keeps track of all queue items that belong
to the same Strs ID. Keep the status information until all
concerned applications have received this information.
Also, make sure this information is available if you
intend to use the KeepJob keyword to continue with the
same Strs ID for different input jobs with the same
external ID.
Interval Interval for Purge status.
Time unit Time unit for the purge interval.
Purge ID Select whether or not to delete all queue items, with the
same Strs ID, when the status of the entire Strs ID job is
set to completed.
Interval Interval for Purge ID.
Time unit Time unit for the purge interval.
Storage type Select whether to store status and job ID information on
disk or in memory. If you select to store this information
in memory, the information will be lost when the
Communication Server goes down.
Status repository settings
The Status repository keeps track of all entities that belong to the same StrsId.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Configure Platform dialog box 101
Platform window

Settings

Alias/Path An alias or path that points to the location of the

repository. The repository is created the first time you run
the Project.
Path for Server mode repositories
An absolute path, or a path relative to
<installation_directory>/Server

Path for LOCAL mode repositories

An absolute path, or a path relative to
<Export_directory>/data/data

%(PlatformName)
The suggested path is %(PlatformName)/<repository>.
The string %(PlatformName) will be replaced with the
name of the Platform. For example:
C:/Strs41/Server/PLT22/StatRep
Alias
You can use the Repository Tool to create aliases for
repositories.
Use repository Run the repository in server mode. This mode enables:
server
• Remote clients to access the repository.
• Multiple clients to access the repository at a time.
If not selected, the repository will be run in LOCAL mode.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.
Names repository settings
The Names repository maps StrsIDs to external job IDs

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
102 Configure Platform dialog box
Platform window

Settings

Alias/Path An alias or path that points to the location of the

repository. The repository is created the first time you run
the Project.
Path for Server mode repositories
An absolute path, or a path relative to
<installation_directory>/Server

Path for LOCAL mode repositories

An absolute path, or a path relative to
<Export_directory>/data/data

%(PlatformName)
The suggested path is %(PlatformName)/<repository>.
The string %(PlatformName) will be replaced with the
name of the Platform. For example:
C:/Strs41/Server/PLT22/NamesRep
Alias
You can use the Repository Tool to create aliases for
repositories.
Use repository Run the repository in server mode. This mode enables:
server
• Remote clients to access the repository.
• Multiple clients to access the repository at a time.
If not selected, the repository will be run in LOCAL mode.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.

Recording Mode tab

Used for: Generation of grab files. In record only mode the Communication
Server uses input data from a designated input connector to produce grab files.

Settings

Activate recording Run the Communication Server in record only mode.

mode

Lines Number of lines in the input data to record.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Configure Platform dialog box 103
Platform window

Settings

Columns Number of columns in the input data to record.

Input connector The designated input connector.

Log File tab

Used for: Truncation of the Communication Server’s log file.

Settings

Age restrictions Select if you want the Communication Server to start

writing to a new log file after a specific number of days.
Maximum age The maximum number of days the Communication
Server will write to the same log file.
Create new log file The time of the day when the Communication Server
at will start writing to a new log file.
Size restrictions Select if you want the Communication Server to start
writing to a new log file when the current log file reaches
its maximum size.
Maximum size The log file’s maximum size (MB).
Move old log files To store old log files, you must specify a directory.
to

Custom tab
Used for: Adding custom commands and keywords to the Platform.
The Communication Server can have functionality that is not implemented in the
Design Center. You can add commands and keywords to the Platform in order to
use this functionality.

Gateway tab
Used for: Specifying job gateway settings.

Settings

Allow remote client Allow clients to access the queue repositories.

to connect to
gateway

Protocol HTTP or HTTPS.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
104 Configure Platform dialog box
Platform window

Settings

TCP/IP Port The port on the Communication Server host assigned to

the job gateway. This is the same port as that defined
when configuring the job gateway.
This port must be unique for each Communication
Server running on the same host.
Gateway URL Information for the Control Center about which URL to
use to access the job gateway. Use the following
syntax:
http://job_gateway_host:tomcat_port/
jobgateway/Access
For example:
http://198.232.9.23:8080/jobgateway/Access

Password The password to access the queue repositories.

This is the same password as that defined when
configuring the job gateway.

Service Broker tab

Used for: Configuring how to connect to a Service Broker. This is described in
the Service Broker documentation.

Notifications tab
Used for: Enabling notifications, and configuring publishing and storage of
notifications.
Note: Notifications cannot be handled correctly in a shared queue environment.

Settings

Use notifications Enable the Communication Server to generate

notifications.
Store notifications Store notifications in the notifications repository.
Notification interval Interval (ms) between notifications.

Unlimited number Do not limit the size of the repository.

of jobs

Maximum number The maximum number of stored jobs. When the limit is
of stored jobs reached, the oldest notifications (job) will be removed.
Publish service Select if you want to display the notifications in the
Control Center.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Configure Platform dialog box 105
Platform window

Settings

Authentication Select if the repository server requires authentication.

required

User name User name to access the repository.

Password Password to access the repository.

File Cache tab

Used for: Caching XML and DTD documents. This is described in the XMLIN
documentation.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
106 Configure Platform Export dialog box
Platform window

Configure Platform Export dialog box

Used for: Specifying the Java User Class path, and for specifying arguments in
the startup argument file.
• Paths tab
• Arguments tab

Paths tab
Used for: Specifying the argument file and the Java User Class path.

Settings

Java User Class Absolute path to the Java User Class directory where the
Path Java User Classes are located.

Arguments tab
Used for: Specifying arguments in the startup argument file that will be generated
when you export the Project.

Settings

Name/Value list Select and configure the applicable startup arguments.

Edit Custom Add custom arguments at the beginning or end of the
argument file.
Preview Preview the argument file.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Manage Queues dialog box 107
Platform window

Manage Queues dialog box

Used for: Configuring queues.

Shortcut menu in list

Add Add a new queue. Same as the Add button.

Delete Delete a queue. Same as the Delete button.
Rename Rename the selected queue.
Set as Default Input Select a queue as the default input queue.
Queue

Set as Default Select a queue as the default output queue.

Output Queue

Queue type

Repository Select to use repository queues.

Indexed file Select to use indexed file queues.

Tabs
• Location tab
• Queuing tab
• Advanced tab
• Recovery tab.
• Custom tab

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
108 Manage Queues dialog box
Platform window

Location tab

Settings (Repository queue)

Inherit Default Use the Default Repository settings defined in the

Repository settings Configure Platform dialog box.

Alias/Path An alias or path that points to the location of the

repository. The repository is created the first time you run
the Project.
Path for Server mode repositories
An absolute path, or a path relative to
<installation_directory>/Server

Path for LOCAL mode repositories

An absolute path, or a path relative to
<Export_directory>/data/data/queues
%(PlatformName)
The suggested path is %(PlatformName)/<repository>.
The string %(PlatformName) will be replaced with the
name of the Platform. For example:
C:/Strs41/Server/PLT22/InQ
Alias
You can use the Repository Tool to create aliases for
repositories.
Use repository Run the repository in server mode. This mode enables:
server
• Remote clients to access the repository.
• Multiple clients to access the repository at a time.
If not selected, the repository will be run in LOCAL mode.
Server The repository server host. For example, localhost,
134.132.137.145, wkbg01, etc.

Username Username to access the queue repository.

Password Password to access the queue repository.

Settings (Indexed file queue)

File name The queue file.

Alias/Path Path to the directory in which the queue file is located.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Manage Queues dialog box 109
Platform window

Queuing tab

Settings

Store successful What to store when a job has been successfully sent
jobs through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Store failed jobs What to store when a job has not been successfully sent
through the queue.
No – Store nothing.
Store information only – Store information about the
job.
Store information and job – Store information about the
job, and the job itself. Allows the queue to resend the job
more than once.
Retries Number of times the Communication Server will try to
reprocess a failed job.
Retry delay Time (milliseconds) the Communication Server will wait
before it tries to reprocess a failed job.
Unlimited number Do not limit the number of stored jobs.
of stored jobs

Maximum number The maximum number of stored jobs. When the limit is
of stored jobs reached, the oldest job will be overwritten.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
110 Manage Queues dialog box
Platform window

Recovery tab.

Settings (Repository queue)

Lost job behavior Used for specifying how to handle a running job if the
Communication Server goes down. Only available for
repository queues running in server mode (Use
repository server and Server properties on the Settings
tab). Used in a shared queue environment with multiple
Communication Servers.
Retry
If the original Communication Server comes up before
the time specified in Delay before retry or aborts, the
original Communication Server will continue to process
the job.
If the time specified in Delay before retry or aborts has
elapsed, the job will be reprocessed, either the original or
a different Communication Server (original or other).
Abort
If the original Communication Server comes up before
the time specified in Delay before retry or aborts, the
original Communication Server will continue to process
the job.
If the time specified in Delay before retry or aborts has
elapsed, the job will be aborted.
Delay before retry Time (seconds) before Retry or Abort.
or aborts

On lost repository Only available to repository queues running in server

server connection mode (Use repository server and Server properties on the
Settings tab). Used for specifying how the
Communication Server should reconnect to a repository
queue in case of failure. The Communication Server can
reconnect either to a backup repository server, or to the
original repository server if it comes up again.
Do not attempt recovery – The Communication Server
will not try to reconnect to the repository server.
Attempt recovery forever – The Communication Server
will try to reconnect to the repository server (original or
backup) until a connection has been successfully
established.
Attempt recovery a limited number of times – The
Communication Server will make <x> number of
Reconnection attempts to the repository server (original
or backup).

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Manage Queues dialog box 111
Platform window

Settings (Repository queue)

Reconnection Used with Attempt recovery a limited number of times to

attempts specify the number of reconnection attempts to the
repository server.
If the Communication Server fails to reconnect after the
last attempt, it will shut down.
Time between Time (seconds) between reconnection attempts.
attempts

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
112 Manage Queues dialog box
Platform window

Advanced tab

Settings

Threads The maximum number of job threads you want the queue
to use.
The Communication Server can operate several queued
jobs at the same time. The scenario where this is an
advantage is when a large job is followed by a small job.
With one single thread, the small job must wait for the
large job to be completed.
Note: Each thread consumes system resources.

Process jobs On arrival – Process jobs as soon as possible.

When parent completed – Hold all job children in the
queue until the parent job is successfully processed. If the
parent job fails, all its children will be removed.
Schedule spooling Schedule the output from the queue.
For example, if an output queue contains jobs that will be
faxed, you can put the jobs on hold and wait for low peak
hours.
Spooling interval Specify spooling intervals.
Spool for a limited Limit the spooling interval.
time

Days Number of days for the limit.

Hours Number of hours for the limit.
Minutes Number of minutes for the limit.
Seconds Number of seconds for the limit.
Stop if the queue is Stop spooling if the queue is empty.
empty

Custom tab
Used for adding custom commands and keywords. The Communication Server
can have functionality that is not implemented in the Design Center. You can add
commands and keywords to the queue in order to use this functionality.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Scheduler Configuration dialog box 113
Platform window

Scheduler Configuration dialog box

Used for: Scheduling events such as polling intervals, spooling of queues, etc.

Intervals
Add one or more intervals, and specify amount and unit for each interval.

Apply selected
Select an interval in the Intervals area, and specify when to apply this interval. No
entries in this area is the same as “always”.

Apply all
You can optionally specify when to apply the settings above.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
114 Scheduler Configuration dialog box
Platform window

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 115

Message window

Shortcut menu commands

Add Event Add an Event.

Add Process Add a Process.
Add Resource Sets Add one or more resource set to the Message.

Remove Resource Remove the selected resource set from the Message.
Set

File Properties Display the path to the Message file.

Event Settings dialog box

Used for: Configuring agent settings and Event order for an Event.
• Agent Settings tab
• Event Order tab

Agent Settings tab

Used for: Specifying agent settings per input type. Used with XMLIN and
StreamIN Events.

Agent (StreamIN)

Only for Connectivity Packs. See the corresponding documentation.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
116 Event Settings dialog box
Message window

FieldIN (StreamIN)

Description The description file resource.

resource

Description ID The ID of the description file. Specified by the FIELDIN

keyword in the first line in the description file (case
sensitive).

RecordIN (StreamIN)

Description The description file resource.

resource

Description ID The ID of the description file. Specified by the

STREAMIN keyword in the first line in the description
file (case sensitive).

StrsXML and XML (StreamIN)

Only for Projects created in StreamServe 3.0.1 and older versions. See the
corresponding documentation.

XMLIN

Collect entire Select to collect entire documents. The collection

documents methods are described in the XMLIN documentation.
Validation level Select how to validate XML input. Described in the
XMLIN documentation.
XSD mapping table A table resource containing namespace to schema
location mappings. Used when validating input against
an XSD.
XML error A connector that will handle output in case of a validation
connector error.
Expand external Incoming XML documents can have references to
entities external XML documents. You can include the external
documents in the Event.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Event Settings dialog box 117
Message window

Event Order tab

Used for: Specifying the order of Events when merging Events.

Event Order options

First Always starts a new Message.

Comments
If there is no following Event, or if the following Event is
also set to First, this will be the only Event in the
Message.
Repeating Appends the Event to the Message.
Comments
If there is no previous Event, this Event will be the first
Event in the Message.
If there is no following Event, this will be the last Event
in the Message.
Last Appends the Event and ends the Message.
Comments
If there is no previous Event, this will be the only Event
in the Message.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
118 Event Settings dialog box
Message window

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 119

Runtime configuration window

Runtime Input Connector Settings dialog

box
Used for: Specifying Runtime settings for input connectors.
• Input Analyzer tab
• General tab

Input Analyzer tab

Used for: Managing the Input Types handled by the connector.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
120 Runtime Input Connector Settings dialog box
Runtime configuration window

Settings

Input Type Lists all input types the connector is expected to receive.
The list is automatically updated when the connector is
connected to a new input type (Event).
There are three groups of input types:
• Group 1 – XML formats.
• Group 2 – FieldIN, RecordIN, and Input Analyzer
enabled Agents.
• Group 3 – PageIN.
PageIN must always be the last item in the list, but you
can select whether to have Group 1 or Group 2 as the first
group in the list.
Handle XML-based Select whether to have Group 1 or Group 2 as the first
input before group in the list.
StreamIN

Filter Chain The name of the filter chain (if any) used for the
corresponding input type.
Edit parameter For Connectivity Packs. See the corresponding
documentation.
View Events Select an input type and list the names of all
corresponding Events.
Add Filter Chain Select an input type and add a filter chain.
Move Select an input type and move it up or down.

General tab
Used for: Adding notes, and customizing the connector.

Settings

Note Comments and notes related to this connector.

Custom Settings Commands and keywords.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Runtime Event Settings dialog box 121
Runtime configuration window

Runtime Event Settings dialog box

Used for: Specifying Runtime options for an Event.
• General tab
• Code Page tab

General tab
Used for: Specifying general options for the Event.

Settings

Custom Enter commands and keywords to be applied to the

Event.
Priority The priority level for the Event. The higher the number
the lower the priority.
Applicable only if two or more Events within a job are
triggered by the same pattern.
Select Specifies that this Event will only be activated by a
automatically NewJob scripting function. See the Scripting reference.

Agent driven Applicable only to Connectivity Packs. See the

corresponding Connectivity Pack documentation.
Ignore remaining Specifies that this Event will search for a matching
data pattern in the input job., and when it finds the pattern it
will skip the remaining input data.
Used, 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 as it is to the RedirectOUT Process.

Code Page tab

Used for: Specifying code page options for the Event. See the Code pages and
Unicode support in StreamServe documentation for information.

Code page options

No change The input connector settings, or a script, specifies which

code page to use.
Lookup A lookup table is used to determine which code page to
use.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
122 Runtime Event Settings dialog box
Runtime configuration window

Code page options

Variable A variable is used to determine which code page to use..

Input order Specifies the ordering of characters in bidirectional input
text.
Logical order – keep this option if the input does not
contain Arabic or Hebrew text in visual order.
Visual order (Arabic and Hebrew only) – select this
option only if the input contains Arabic or Hebrew text in
visual order. The text will be reordered to logical order.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Runtime Process Settings dialog box 123
Runtime configuration window

Runtime Process Settings dialog box

Used for: Specifying Runtime options for a Process.
• Rule tab
• General tab
• RePRINT tab

Rule tab
Used for: Creating rules for triggering a Process. A rule accepts the operators
AND, OR, and NOT.

Example 7 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 8 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 9 Use a connector name to trigger the Process

The before script $InConnector=InConnectorName(); has been added to the

Event.
Rule: $InConnector=Input1
Result: The Process is run only if input comes from the connector Input1.

General tab
Used for: Specifying general options for the Process.

Standard settings

Select Specifies that this Process will only be activated by a

automatically CallProc scripting function. See the Scripting reference.

Custom settings Enter scripts and commands to customize the Process.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
124 Runtime Process Settings dialog box
Runtime configuration window

PageOUT specific settings

Mirror PageOUT Select to mirror the object layout in PageOUT.

Mirror variable Use a variable to decide whether or not to mirror the
object layout. If no variable is specified, the layout will
always be mirrored if you select Mirror PageOUT.
The variable must return 0 or 1:
1– layout will be mirrored.
0– layout will not be mirrored.

MessageOUT specific settings

Include variables in Select if you want to include variables specified in scripts

output in the output.
Restrictions:
• You cannot include arrays in the output data.
• Variables specified after Process or after Message
cannot be included in the output.

Attach Process tab

Applicable to MailOUT Processes only. Specifies Process output to attach to the
email.
Note: To add files on disk as attachments to the email, you must specify this in
the MailOUT Process configuration.

Click Add New Item to specify a new attachment, or select an attachment and
click Edit Selected Item to edit the attachment settings.

Process Attachment options (Process Attachment dialog box)

Attachment name The name of the attachment, for example Invoice.pdf.

Process Select this option, and use the Select Process drop-
attachment down list to specify the Process.
Free attachment Select this option, and use the Free Attachment field to
specify the Process.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Runtime Process Settings dialog box 125
Runtime configuration window

Process Attachment options (Process Attachment dialog box)

Mime content type The MIME content type of the attachment (only
applicable to SMTP mail servers).
• Autoselect - the Communication Server
determines which content-type to use. The
information is retrieved from the driver that
generates the attachment file.
• Predefined - select content-type from a predefine
list.
• Custom - specify a custom content-type.

Convert Select whether or not to convert PCL attachments to

attachment from PDF.
PCL to PDF

Compress the Select whether or not to compress the attachments.

attachment

RePRINT tab
Used for: Specifying document types and indexes for RePRINT.

Activation options

Disabled Disable RePRINT storage for the Process.

Enabled Enable RePRINT storage for the Process. A copy of the
output data and an index file will be sent to the RePRINT
scanning directory.
On Failure Enable RePRINT storage only for Process data that could
not be delivered to the output connector.

Object type settings

Name The document type to be stored. Can contain any alpha-

numeric character, including space. Maximum 55
characters.
Indexes A list of the indexes available for the specified document
type.
Index name The name of the index to be used when searching for
stored objects in the RePRINT database. Can contain any
alphanumeric character. Maximum 50 characters

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
126 Runtime Process Settings dialog box
Runtime configuration window

Object type settings

Data type Numeric – Any positive or negative numerical value.

Text – Any alphanumeric character.
Date – Date format. Must match the date settings allowed
in the RePRINT database.
Variable A unique variable for the index.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Connector Selection Method dialog box 127
Runtime configuration window

Connector Selection Method dialog box

Used for: Selecting an output connector for the Process output.

Options

None Do not send the output to any connector.

Static Select a specific connector. The Process will always send
the output to this connector.
Lookup Use a lookup table to determine which connector to send
the output to.
Key – The key variable used for selecting the connector.
Table – The lookup table.
Default connector – The default connector. The output
is sent to this connector if the key variable does not match
any value in the lookup table.
Lookup table syntax
Use the following syntax in the lookup table:
key_value alternative_connector
For example:
"Mike Jones" Printer1
"Jane Smith" Printer2

Variable Use a script variable to determine which connector to

send the output to.
Variable – The script variable used for selecting the
connector.
Default connector – The default connector. The output
is sent to this connector if the variable does not match any
other connector.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
128 Edit Output Connector Settings dialog box
Runtime configuration window

Edit Output Connector Settings dialog box

Used for: Selecting a context for the connector configuration.

Options

Process: name Configure Process specific connector settings. You can

also configure connector settings that will be applied to
the job that contains the selected Process.
Job: name Configure job specific connector settings.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Runtime Output Connector settings dialog box 129
Runtime configuration window

Runtime Output Connector settings dialog

box
Used for: Specifying Runtime options for an output connector.

Job Begin icon

• Device Driver Settings tab
• Device symbol set tab

Document Trigger icon

• Document Trigger tab

Document Begin icon

• Device Driver Settings tab
• Device symbol set tab

Process Begin icon

• Device Driver Settings tab
• Device symbol set tab
• Connector tab

Document End icon

• Process Sort Definition tab
• Connector tab

Job End icon

• Connector tab

Post-processing specific
You can also configure post-processing specific options. See the Document
sorting and bundling documentation for information.

Device Driver Settings tab

Used for: Specifying device driver settings. You must select the device driver
when you configure the connector in the Platform..

Settings

Driver settings Device specific settings. See the documentation for the
corresponding device.
Alias You can specify an alias for each driver option.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
130 Runtime Output Connector settings dialog box
Runtime configuration window

Device symbol set tab

Used for: When sending output to a PCL printer, you can specify a different
symbol set for the printer than that specified in the code page settings..

Settings

Override symbol... Select to override the symbol set.

Static Select a static symbol set.
Lookup Use a lookup table to determine which symbol set to use.
Variable Use a variable to determine which symbol set to use.

Document Trigger tab

Used for: Defining a Document trigger for the connector and job.

Settings

Document Trigger The variable to be used as the Document trigger. Must be

variable a variable specified in the corresponding Messages.

Connector tab
Used for: Configuring the runtime connector setting.

Settings

Connector specific Connector specific settings.

Process Sort Definition tab

Used for: The Communication Server creates Documents according to the
Document trigger. You can use sort keys to specify the order of the pages in the
Document..

Options

Edit Process Sort Open the Sort Definition dialog box.

Definition

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Sort Definition dialog box 131
Runtime configuration window

Sort Definition dialog box

Settings

Sort Key A variable specified in the Messages (Event or script).

Type Specify whether the sort key is a number or a string.
Sort Order Select to sort the pages in Ascending or Descending
order.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
132 Sort Definition dialog box
Runtime configuration window

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 133

Resource set window

Shortcut menu commands on root object and folders

New Resource Create a new resource file using a resource editor, and
link it to the resource set.
Add Resource Link an existing resource file to the resource set.
Import Create a new resource file and link it to the resource set.
You create the resource file by importing and embedding
a source file.
Settings Specify where to store new resources files, and how to
resolve name conflicts. See Resource Folder Settings
dialog box on page 135.
Export Settings Specify export paths for custom resource types. See
Resource Folder Export Settings dialog box on page 136.
Delete Delete a custom resource folder.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
134
Resource set window

Shortcut menu commands on root object and folders

Rename Rename. If you rename the root folder, you also rename
the resource set. You cannot rename native resource
folders.

Shortcut menu commands on resource objects

Start Editor Open the resource editor and edit the resource.
Stop Editor Close the resource editor.
Update from origin Import updated information from the source file.
Applicable only to resources created using the Import
command.
Extract to file Extract the resource to a file.
File Properties Display the path to the selected object.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Resource Folder Settings dialog box 135
Resource set window

Resource Folder Settings dialog box

Used for: Specifying where to store new resources files, and how to resolve name
conflicts.

Options

Use default storing Select to use the default rules for storing resource files.
rules
If you edit the resource file from a resource set within a
Project, the default path for the resource files is the root
directory for the Project. If you try to overwrite an
existing resource you will be prompted.
If you edit a resource file from a stand-alone resource set
you will be prompted for path and name.
Default target Default folder for storing the resources.
folder

Reuse existing Keep the old resource file and ignore the new.
resource

Prompt Prompt when trying to overwrite an exiting resource file.

Overwrite the Replace the old resource file with the new.
existing resource

Resolve conflict Keep the old resource file and add a number to the name
of the new resource.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
136 Resource Folder Export Settings dialog box
Resource set window

Resource Folder Export Settings dialog box

Used for: Specifying the export path for resource files in custom resource folders.

Options

Export to base Export the resources to the export directory.

directory

Export to same Select a native resource type, and export the resources to
directory as the same directory.
Do not export Do not export the resources.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Resource selection browser 137
Resource set window

Resource selection browser

Used for: Selecting a resource for a connector etc. You can also add and edit
resources.

Contents

Look in Browse to the appropriate resource set and resource

folder.
Item The name of a resource. All resources in the selected
folder are displayed in the list.
Note Notes written for the item. Right-click the item and select
Edit Notes to edit the notes.
Selected Displays the selected resource.
Filter Enable/disable the resource filter. When the filter is
disabled, all resource folders will be visible.
Select Select the resource (copy from the Items list to the
Selected list).
Undo select Undo resource selection (remove from the Selected list).
Open editor Select a resource in the Items list and open the resource
in the resource editor.
Close editor Close the resource editor.
Add Resource Set Add a resource set to the active object (Platform,
Message, or resource set).

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
138 Resource selection browser
Resource set window

Contents

Create Resource Create a new resource set and add it to the active object
Set (Platform, Message, or resource set).
New resource Create a new resource file using a resource editor, and
link it to the resource set.
Add resource Link an existing resource file to the resource set.
Import Create a new resource file and link it to the resource set.
You create the resource file by importing and embedding
a source file.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 139

Filter Chain editor

Used for: Creating filter chain resources files.

Components

Flow bar Add one or more filters to the flow bar. The order of the
filters in the chain is important. Data flows through the
filters – from left to right – as you see them in the flow
bar.
Filter icons Each filter is represented by a filter icon.
Property/Value Settings for the selected filter.

Input connector filters

• Bypass Filter
• Codepage Filter
• Decompression Filter
• External Filter
• File Filter
• Internal Filter
• Job Filter

Output connector filters

Compression filter

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
140 Input connector filters
Filter Chain editor

Input connector filters

Bypass Filter
Use this filter to bypass the Communication Server. Data is sent directly from this
input connector to a designated output connector.

Settings

Start in bypass If selected, all input received between Communication

Server start-up and the first Bypass off trigger will be sent
to the bypass connector.
Bypass connector The name of the output connector to bypass 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 Select whether or not to remove the Bypass on sequence

on) from output data.
Bypass off Sequence in input data that deactivates bypass mode. For
example:
#bypassOFF.

Remove (bypass Select whether or not to remove the Bypass off sequence
off) from output data.
Append output to Allows the output sent to the bypass connector to be
job 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 that “here comes an
overlay”. For example:
#ovl

Remove (overlay Select whether or not to remove the Overlay select

select) sequence from output data.
Overlay trigger Sequence in input data that indicates the end of the
overlay file name. For example:
##

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input connector filters 141
Filter Chain editor

Settings

Remove (overlay Select whether or not to remove the Overlay trigger

trigger) sequence from output data.

Example 10 Bypass sequences

Settings:
Bypass on = #ON and Bypass off = #OFF
Input data:
xyz;#ONabc;def;ghi#OFF;jkl
Bypassed data:
abc;def;ghi

Example 11 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 “##”.

Codepage Filter
Use this filter to specify a code page for the input connector. See the Code pages
and Unicode support in StreamServe documentation for information on how to
handle code page settings in StreamServe.

Settings

Code page The code page the connector will use.

Input order Specifies the ordering of characters in bidirectional input
text.
Logical order – keep this option if the input does not
contain Arabic or Hebrew text in visual order.
Visual order (Arabic and Hebrew only) – select this
option only if the input contains Arabic or Hebrew text in
visual order. The text will be reordered to logical order.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
142 Input connector filters
Filter Chain editor

Settings

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.
Most significant byte first (Big Endian):
Select 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):
Select 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).

Decompression Filter
Use this filter to decompress compressed input data. There are no settings for this
filter.

External Filter
This filter reads data from StdIN, processes the data, and delivers the processed
data back on StdOUT. The actual filter can be any executable.

Settings

External The path to the executable.

File Filter
This filter uses a conversion table to substitute characters in input data.

Settings

File The conversion table. The conversion table must be

available as a resource in the same resource set as the
filter chain.

Conversion table description

Syntax input_string
output_string

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Input connector filters 143
Filter Chain editor

Conversion table description

Strings The table applies to strings of one or more characters.

Hexadecimal You can always use hexadecimal notation within angle
brackets (<hex>). Some characters – tab, line feed, angle
brackets, quotation marks, etc. – must have hexadecimal
notation. You can use multiple hex values if you separate
them with comma. For example:
<0D,0A>

Empty rows You must comment all empty rows with // or *.

Case The text strings are case sensitive.
Example // 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>

Internal Filter
This filter handles escape codes in input data.

Settings

Internal HpPcl:
Removes HpPcl escape codes from the input data.
Esc0:
removes Esc0 escape codes from data.
URL:
• Converts URL escape codes (%20 to space etc.) in
input data.
• Converts ‘&’ (ampersand) to <0D, 0A> (carriage
return - line feed).
• Converts ‘+’ (plus sign) to ‘ ‘ (space).

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
144 Input connector filters
Filter Chain editor

Job Filter
This filter enables the Communication Server to divide a large input job into a
several small jobs. Sequences in input data specify the size of each job.

Settings

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 12 The Job filter

This example displays two scenarios where one large input job is divided into
smaller jobs.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
 Output connector filters 145
Filter Chain editor

Output connector filters

Compression filter
Use this filter to compress the output from the connector. See the Code pages and
Unicode support in StreamServe documentation for information on how to handle
code page settings in StreamServe.

Settings

Use compression Select to compress the output from the connector.

Compression level The level of compression.

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A
146 Output connector filters
Filter Chain editor

StreamServe Design Center GUI Reference Reference Guide 4.1.2 SP2 Rev A