StreamServe Design Center GUI Reference

Transcription

1 StreamServe Design Center GUI Reference Reference Guide SP2 Rev A

2 StreamServe Design Center GUI Reference Reference Guide 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

3 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 Sub-windows and dialog boxes...11 Customize dialog box Design Center Settings dialog box Colors dialog box View Information window Search Results window Project window...15 Project Settings dialog box...17 Unpack Project dialog box Input Connector Settings dialog box...19 Connector Settings tab ADO input connector settings Device input connector settings Directory input connector settings IN input connector settings Exchange input connector settings FTP input connector settings HTTP(S) input connector settings HTTP(S) Poll input connector settings Internal input connector settings Java input connector settings Java RMI input connector settings JMS Queue input connector settings JMS Subscribe input connector settings MSMQ input connector settings Named Pipe input connector settings Netware Bindery input connector settings Netware NDS input connector settings Serial input connector settings Service Channel (COM) input connector settings Service Channel (HTTP) input connector settings SMS Provider input connector settings Status Messenger input connector settings... 39

4 4 StdIn input connector settings TCP/IP input connector settings WebSphere MQ input connector settings HTTP Access tab Queue Settings tab Filter Chain Settings tab General Settings tab Output Connector Settings dialog box...47 Codepage Settings tab Device Driver Settings tab Symbol Set tab Filter Chain Settings tab Queue Settings tab Connector Settings tab ADO output connector settings Command output connector settings Dazel output connector settings Exchange output connector settings Fax Connect output connector settings File output connector settings FTP output connector settings Generic Archive output connector settings HTML output connector settings HTTP Response output connector settings HTTP(S) Submit output connector settings Internal output connector settings IXOS Archive in R3 output connector settings Java output connector settings Java Response output connector settings Java RMI output connector settings JMS Publish output connector settings JMS Queue output connector settings JMS Response output connector settings Job Resource output connector settings Lotus Notes output connector settings MAPI output connector settings MAPI for MailOUT output connector settings MSMQ output connector settings Netware Bindery output connector settings Netware NDS output connector settings Null Connector output connector settings Pipe output connector settings RePRINT output connector settings Service Channel Response (COM) output connector settings Service Channel Response (HTTP) output connector settings Service Channel Submit (COM) output connector settings Service Channel Submit (HTTP) output connector settings SMS output connector settings SMS Provider output connector settings SMTP output connector settings SMTP (MIME) output connector settings SMTP (MIME) for MailOUT output connector settings... 86

5 5 SNMP trap output connector settings Spool output connector settings StdOut output connector settings StreamServe External Viewer output connector settings TCP/IP output connector settings TFS output connector settings TFS for MailOUT output connector settings Topcall output connector settings WebSphere MQ output connector settings WinFaxAdapter output connector settings XTrade output connector settings General Settings tab Configure Platform dialog box...96 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 Configure Platform Export dialog box Paths tab Arguments tab Manage Queues dialog box Scheduler Configuration dialog box Message window Event Settings dialog box Agent Settings tab Event Order tab Runtime configuration window Runtime Input Connector Settings dialog box Input Analyzer tab General tab Runtime Event Settings dialog box General tab Code Page tab Runtime Process Settings dialog box Rule tab General tab Attach Process tab RePRINT tab Connector Selection Method dialog box...127

6 6 Edit Output Connector Settings dialog box Runtime Output dialog box Device Driver Settings tab Device symbol set tab Document Trigger tab Connector tab Process Sort Definition tab Sort Definition dialog box Resource set window Resource Folder Settings dialog box Resource Folder Export Settings dialog box Resource selection browser Filter Chain editor Input connector filters Bypass Filter Codepage Filter Decompression Filter External Filter File Filter Internal Filter Job Filter Output connector filters Compression filter

7 7 Main window Menus and menu commands File menu New Open Close Save Save All Save As Open Project Save Project Close Project Create new Platform, Message, Runtime configuration, resource set, or Project. Open a Platform, Message, Runtime configuration, or resource set. Close the active window (Platform, Message, Runtime configuration, or resource set). Save the active window. Save all open windows. Also saves the open Project and everything within. Save active window with a new name. Open a Project. Save the active Project, including all Platforms etc. Close the Project. Obtain Write Lock Lock the selected component in the Project. Write lock = only you can edit the component. Release Write Lock Reload Component Add to Project Remove from Project Pack Project Unpack Project Recent Files Unlock the selected component in the Project. Revert to the latest saved version of the selected component in the Project. Add a Platform, Message, Runtime configuration, or resource set to the Project. Select an item in the Project and remove it from the Project. Pack the Project and save it as a package file. Unpack a packed Project. Open recent files.

8 8 Menus and menu commands Main window Recent Projects Exit Open recent Projects. Exit the Design Center. Edit menu Find Open Close Script Go to source Add Resource Set Remove Resource Set Settings File Properties Search and find. Select an Event or Process and open the corresponding tool. Select an Event or Process and close the corresponding tool. Add script to selected item. 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 to selected item. Remove resource set from selected item. Edit settings for the selected item. Display the path to the selected object. Tools menu Customize Design Center Settings Select Color Scheme Select Note Font Select Note Alignment Edit toolbar, toolbar buttons etc. See Customize dialog box on page 11. Edit default Design Center settings. See Design Center Settings dialog box on page 11. Select a color scheme for the Design Center GUI. See Colors dialog box on page 12. Select font for the notes you enter in the View Information window. Select alignment for the notes you enter in the View Information window.

9 Menus and menu commands 9 Main window Export wizard Export now Autocreate Message Edit Project Template Information Export the Project using the export wizard. Export the Project directly. Auto-create a Message based on an SXD file (Event) and a PLT file (Process). Browse to a Design Center template or package and edit the category and description. Platform menu This menu is related to the active Platform view. If no Platform view is active, this menu is not available. New input connector New output connector Manage Queues Configure Platform Configure Export Add an input connector. Add an output connector. Open the Manage Queues dialog box. Open the Configure Platform dialog box. 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 Process Add an Event. 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 New Job Add Message New Postprocessor Open the corresponding Platform view. Create a new job. Add a Message to the selected job. Create a new Post-processor.

10 10 Menus and menu commands Main window Add Process Link Collapse all Jobs & Post-processors Expand all Jobs & Post-processors Export Runtime wizard Export Runtime now Extract documentation Add a process link to the Post-processor. Show the Job containers and Post-processors as named boxes. Hide all connection lines. Show all connection lines from all Job containers and Post-processors. Export the Project using the export wizard. Export the Project directly. Create a Word document with details about the Runtime 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 Add Resource Import Start Editor Stop Editor Update from origin Extract to file Create a new resource file using a resource editor. The resource file is automatically linked to the resource set. Link an existing resource file to the resource set. Create a new resource file by importing a source file. The resource file is automatically linked to the resource set. Edit the selected resource file. Stop and close the editor for the selected resource file. 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 the embedded file in the selected resource file.

11 Sub-windows and dialog boxes 11 Main window Sub-windows and dialog boxes Customize dialog box 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 Default application settings and product registration. Application settings Remember window layout when closing Design Center Default code page Use Platform, Message, and Runtime identifier colors in views Enable wizard window at startup Highlight Runtime links for selected items Inherit resource sets Add new views to active project Add new view dependencies to active project Open views as they were the last time you closed the Design Center. 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. Enable identifier colors (bar at the bottom of the view). Display the shortcut window (Open Project, etc.) when you launch the Design Center. In the Runtime configuration, high-light all lines connected to a selected Job container, Message, Process, or connector. 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, created using File > New, to the active Project. Add dependencies for new views, created using File > New, to the active Project.

12 12 Sub-windows and dialog boxes Main window Application settings Try to obtain write lock when opening views Always obtain write lock for all components when opening Project Template location If selected, the Design Center will attempt to lock the view so it can be edited. Write lock = only you can edit the view. Set components to read-only or editable when opening the views. Write lock = only you can edit the view. The directory that contains the Design Center Project templates. Colors dialog box Selecting a color scheme for the Design Center GUI. View Information window 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.

13 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 Resource Set Activate Add Resource Sets Remove Resource Set Set as default resource set for the active view. Activate the corresponding view. Add resource sets to the active view. Remove the selected resource set from the active view. Search Results window Displaying search results (Edit > Find). Double-click an item to go to the corresponding item. Columns View Location Dependency Description The view (Platform, etc.) where the item was found. The location of the item. N/A Description of the item

14 14 Sub-windows and dialog boxes Main window

15 15 Project window 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 Open Project Recent Projects Save Project Save As Close Project Pack Project Unpack Project Obtain Write Lock Release Write Lock Reload Component Add to Project Export wizard Export now Rename Create new Platform, Message, Runtime configuration, resource set, or Project. Open a Project. Open recent Projects. Save the active Project, including all Platforms etc. Save the Project with a new name. Close the Project. Pack the Project and save it as a package file. Unpack a packed Project. Lock the selected component. Write lock = only you can edit the component. Unlock the selected component. Revert to the latest saved version of the selected component. Add a Platform, Message, Runtime configuration, or resource set to the Project. Export the Project using the export wizard. Export the Project directly. Rename the selected component.

16 16 Project window Shortcut menu commands Settings File Properties Remove from Project Open the Project Settings dialog box and edit the Project settings. Display the path to the selected object. Remove the selected component from the Project. Open/Activate View Open the view containing the selected component.

17 Project Settings dialog box 17 Project window Project Settings dialog box Modifying Project settings. Project settings Project name Default code page Default Resource Set Project folder/ directory The name of the Project. The default code page for all items within the Project. Overrides the default code page defined in the Design Center Settings dialog box. The name of the default resource set. The path to the folder where to save your Project files.

18 18 Unpack Project dialog box Project window Unpack Project dialog box Simple mode 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 Selecting which files to unpack, and where to store the unpacked files. Options Components in package Location for selected components Lists all components that can be unpacked. Select the components to unpack. The path to the folder where to store the selected components.

19 19 Input Connector Settings dialog box 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 Configuring input connectors. Settings Connector Connector specific Type of input connector. Connector specific settings.

20 20 Input Connector Settings dialog box Settings Time-out Polling interval 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. If, when, and how often to poll the data source for information. ADO input connector settings Extracting data from ODBC or OLE DB enabled database tables. Windows. DataSource CustomData Source UserName Password SQLCommand EventName Mode The ODBC data source to connect to. A custom data source to connect to, for example an 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; User name for accessing the data source. Overrides any other user names specified for the data source. Password for accessing the data source. Overrides any other passwords specified for the data source. SQL command to be carried out on the data source. For example: select * from my_table The Event that receives input from this connector. Move (with delete) Delete the record from the database table after reading. Copy (no delete) Copy the record from the database.

21 Input Connector Settings dialog box 21 RowLevel Create SXD 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. 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 Scanning a UNIX FIFO for incoming jobs. A FIFO is a First-In-First-Out queue. UNIX. Device File path to the FIFO, for example:./fifos/my_fifo Directory input connector settings Retrieving files from a named directory. The source application writes data to this directory, and the Communication Server retrieves the data. Windows and UNIX. Match criterion The path to the directory, for example: scandir/*.txt Use an absolute path, or a path relative to the export directory.

22 22 Input Connector Settings dialog box 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: networksafe: 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. 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. IN input connector settings Retrieving input sent via . Windows and UNIX. Mailbox type Port Mail server name Mail folder User name Password Read mail text Read attachment file The type of mailbox on the mail server. The port the Communication Server will use to communicate with the mail server. The mail server s IP address or host name. Applicable only to IMAP. Mail folder to scan for input. Leave this empty if you want to select the Inbox. 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 for accessing the mailbox. Select whether or not to process the body. Specify the attachments to be processed by the Communication Server. See Example 1 below.

23 Input Connector Settings dialog box 23 Mail read filter Read filter parameters Delete mail Mail delete filter Delete filter parameters Save attachment Attachment directory Read All Retrieve all s in the mailbox. Advanced Use the read filter parameters below to specify which s to retrieve. You can use wildcards. See Example 2 below. From Retrieve s with specific From addresses. To Retrieve s with specific To addresses. Cc Retrieve s with specific Cc addresses. Date Use a timeframe to specify which s to retrieve. The timeframe corresponds to the date and time the was received. Use YYYY-MM-DD as format. Subject Retrieve s with specific subjects. Reply to Retrieve s with specific Reply to addresses. Signed Select to reject unsigned s. Encrypted Select to reject un-encrypted s. Delete s from the mailbox after they have been retrieved by the Communication Server. Delete Processed Delete all s that have been retrieved and processed. Delete all Delete all s that have been retrieved. Advanced Use the delete filter parameters below to specify which s to delete. You can use wildcards. See Example 3 below. Delete From Delete s with specific From addresses. Delete To Delete s with specific To addresses. Delete Cc Delete s with specific Cc addresses. Delete Date Use a timeframe to specify which s to delete. The timeframe corresponds to the date and time the was received. Use YYYY-MM-DD as format. Delete Subject Delete s with specific subjects. Delete Reply to Delete s with specific Reply to addresses Save attachments to disk. The directory where to save attachments.

24 24 Input Connector Settings dialog box Example 1 Specifying whether to read attachments An 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 s to retrieve Date: ** s dated January 2002 will be retrieved. Example 3 Specifying which s to delete Delete Date: ** s dated January 2002 will be deleted. GetConnectorValue attributes You can use the scripting function GetConnectorValue to fetch IN attributes. Attribute From To Cc Reply To Subject Date Body encoding Body type Attachment encoding Attachment type GetConnectorValue("<attribute>") GetConnectorValue("From") GetConnectorValue("To") GetConnectorValue("Cc") GetConnectorValue("Reply To") GetConnectorValue("Subject") GetConnectorValue("Date") GetConnectorValue("Encoding") GetConnectorValue("Type") GetConnectorValue("AttEncoding<n>") where <n> is the attachment number. GetConnectorValue("AttType<n>") where <n> is the attachment number.

25 Input Connector Settings dialog box 25 Attribute AttCount GetConnectorValue("<attribute>") GetConnectorValue("AttCount") Returns the number of attachments in the current that have been saved to disk. Exchange input connector settings Reading objects in Microsoft Exchange Server folders. For example, read s and attachments from Microsoft Outlook Public Folders. Windows. Server MailBox Folder EventName Mode DataType RowLevel The Microsoft Exchange Server. For example: laxnt04 The user account on the Microsoft Exchange Server. For example: streamserve 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 The Event that receives input from this connector. 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. 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. 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.

26 26 Input Connector Settings dialog box 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 Comments: Retrieving files from an FTP server. After a file is retrieved, it is deleted from the FTP server. 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. Windows and UNIX. Host Port User name Password Remote path The FTP server, for example rtu.baldwin.com The port on the FTP server. The user name for accessing the FTP server. The password for accessing the FTP server. 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

27 Input Connector Settings dialog box 27 Passive mode Transfer 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 highnumbered port. Note: This works with most firewalls unless the firewall restricts outgoing connections on high-numbered ports. 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 Enabling the Communication Server to function as an HTTP server. Windows and UNIX. Security configuration Version SSL version Address HTTPS only. 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. The HTTP version to use. Auto means that the version is determined by the client. HTTPS only. The SSL version to use. Server and clients must use the same SSL version. 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.

28 28 Input Connector Settings dialog box Port Input threads Idle time-out Time-out Response time-out Authentication Publish directory 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. 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. 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. 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. 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. 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 The root directory for stored files.

29 Input Connector Settings dialog box 29 Publish extension file Job resource URI An alias table where you associate file formats to 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. 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 HTTPExtJobIdField "ID_name"; HTTPMaxContentLength limit; Description Retrieves the external ID from an application that sends input to the Communication Server. The application that sends the input must include the external ID as HTTP header information (ID_name:ID_value). Limits the size (in bytes) of the body in an HTTP request. If a request contains a body that exceeds this limit, an error response will be returned.

30 30 Input Connector Settings dialog box Keyword HTTPResponseTimeOut "timeout" "path" "custom" END; Description Specifies what the Communication Server should do when a response time-out occurs. 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 timeout occurs. For example: HTTPResponseTimeOut "" "/Messages/timeout.txt" "" END; custom: Custom fields (name:value) added to the response header. For example: HTTPResponseTimeOut "" "timeout.txt" "contenttype:text/plain" END; You can separate several name:value pairs with <0d><0a>. HTTP(S) Poll input connector settings Enabling the Communication Server to function as an HTTP client that polls an HTTP server. Windows and UNIX. 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.

31 Input Connector Settings dialog box 31 Method URL Content-type File to POST Time-out Version SSL Version 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. The URL to the HTTP server. 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. The file to be posted. The maximum time (milliseconds) to wait before aborting a transfer. The HTTP version to use. HTTPS only. The SSL version to use. Server and clients must use the same SSL version.

32 32 Input Connector Settings dialog box Authentication Realm User name Password Cache file 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. Only if authentication is required. The realm. Only if authentication is required. User name to access the realm. Only if authentication is required. Password to access the realm. Cache file that stores communication checksums between Communication Server start/stop. Internal input connector settings Comment: Enabling the Communication Server to pass on data internally. For example to loop back output for further processing. 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. Windows and UNIX. There are no properties for this type of connector. Java input connector settings Custom Java input connector. See the StreamServe EIF SDK documentation. Windows and UNIX.

33 Input Connector Settings dialog box 33 Java RMI input connector settings Custom Java input connector. See the StreamServe EIF SDK documentation. Windows and UNIX. JMS Queue input connector settings Enabling the Communication Server to receive messages from a named queue in a point-to-point messaging system. For more information about JMS, see Windows and UNIX. Context Queue Factory User Name Password Queue Selector The JNDI context. If you leave this empty, the initial context will be used. 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 to access the JMS provider. Password to access the JMS provider. The JNDI lookup name for the queue. This setting is mandatory. 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.

34 34 Input Connector Settings dialog box JMS Subscribe input connector settings Enabling the Communication Server to receive messages from a named topic in a publish-subscribe messaging system. For more information about JMS, see Windows and UNIX. Context Topic Factory User Name Password Topic Selector Subscriber Id Unsubscribe on close The JNDI context. If you leave this empty, the initial context will be used. 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 to access the JMS provider. Password to access the JMS provider. The JNDI lookup name for the topic. This setting is mandatory. 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. 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. If you have specified a subscriber ID, you can select whether or not to unsubscribe when the Communication Server is shut down.

35 Input Connector Settings dialog box 35 MSMQ input connector settings Comments: Private and public message queues: Enabling and integrating Communication Server capabilities in Microsoft message queuing environments. 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. Public message queues are published in the Active Directory. 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. Windows. Queue Manager Queue Name Private The server on which the MS Message Queue resides. The MS Message Queue from which to retrieve data. This MS Message Queue must belong to the Queue Manager. Select to access a Private message queue. The Private message queue can be accessed even if the queue manager is off-line.

36 36 Input Connector Settings dialog box 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 Handling output from a FIFO file. Windows and UNIX. Named pipe The named pipe. Netware Bindery input connector settings Retrieving data from a Novell 3.x network print queue. Windows. Server Queue name Print server Password The Novell 3.x network server. The Novell 3.x network print queue. The Novell 3.x network print server. Password to the Novell 3.x network print server. Netware NDS input connector settings Retrieving data from a Novell 4.x network print queue. Windows.

37 Input Connector Settings dialog box 37 Queue The Novell 4.x network print queue. Serial input connector settings Receiving input via a serial port. Windows and UNIX. Port Bits per second Data bits Parity Stop bits Flow control The port to be used. Data transfer speed. The number of data bits. How to handle parity. The number of stop bits to be transmitted per byte. How to handle flow control. Service Channel (COM) input connector settings Comment: Publishing a service in a Service Broker. Clients can access the service via COM. 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. Windows. 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.

38 38 Input Connector Settings dialog box Maximum idle lock time The maximum time (milliseconds) a client can lock the 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 Publishing a service in a Service Broker. Clients can access the service via http. Windows and UNIX. 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 Receiving SMS messages via an external service provider (Telia). Windows and UNIX. Host Port The IP address of the Communication Server host. Must be registered with Telia. The port the Communication Server listens to for incoming SMS messages. Must be registered with Telia.

39 Input Connector Settings dialog box 39 Time-out (ms) Event name The maximum time (milliseconds) the connector will try to carry out the transaction (connect, send data, receive data) before canceling. The Event that handles SMS input. Status Messenger input connector settings Retrieving and filtering status information generated by the Communication Server. Windows and UNIX. Event name Notifications to receive The e MessageIN Event that will extract the notification data. Click the browse button to select the kind of information to be included in the status message. Notification settings Level Status 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. Select the status of incidents or events for which information should be included in the status message.

40 40 Input Connector Settings dialog box 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.

41 Input Connector Settings dialog box 41 StdIn input connector settings The StdIn and StdOut connectors enable external applications to send data to the Communication Server via StdIn and receive output on StdOut. Windows and UNIX. There are no settings for this type of connector. TCP/IP input connector settings Receiving input on a designated IP port. Windows and UNIX. Host name Port The host. The port number. WebSphere MQ input connector settings Receiving input via an IBM WebSphere MQ message queue. See Dependencies and requirements on page 41 before you configure the connector. Windows and UNIX. Queue manager Queue name The queue manager that owns the message queue. 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.

42 42 Input Connector Settings dialog box 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 clientconnection 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 GroupId MessageId CorrelationId Reply-To-Queue GetConnectorValue("<argument>") GetConnectorValue("IBMMQGroupId") GetConnectorValue("IBMMQMsgId") GetConnectorValue("IBMMQCorrelId") GetConnectorValue("IBMMQReplyToQ")

43 Input Connector Settings dialog box 43 Attribute Reply-To-Queue-Manager Message type Report options GetConnectorValue("<argument>") GetConnectorValue("IBMMQReplyToQMgr") GetConnectorValue("IBMMQMsgType") GetConnectorValue("IBMMQReport") HTTP Access tab 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 URI The HTTP or HTTPS input connector. 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 the connector HTTP_IN will receive and handle the request. If a request is sent to the connector HTTP_IN will receive the request and forward it to the connector INTERNAL. Queue Settings tab Selecting a queue for the connector and, optionally, to edit the queue settings. Settings Queue The queue to select for the connector.