Server Configuration Parameters

At start up, the server loads a configuration file in XML format named config.xml. This file contains the options set for this server. It is stored in the bin subdirectory of the PathWAI Editor installation directory. Typically, these options are set at installation, but you can modify them as needed at any time.

Sample Configuration File

Platform

The type of operating system on the machine on which the server is running. The valid values are:

WINDOWS

UNIX

This parameter is set by the installer and should not be edited.

ProfilePath

The server maintains a profile for each user, which it updates each time the user accesses the server. The profile stores the settings last used by the user ID for opening queues and filtering messages.

This parameter indicates the  path to the directory where the server will find the user profile files. The default value is <candlehome> (the directory in which PathWAI Editor is installed).

This parameter is set by the installer and should not be edited.

Port

The number of the port on which the server receives messages. By default, the value is 4444. The port number can also be specified as an option when the server is started (-port <port_number>). The value supplied in the startup command overwrites the value specified in the configuration file. This is useful if you want to create a new process with the same configuration file, but on a different port.

ResourceBase

The resource to use as a relative base for all context resources. The default value is <candlehome>\html or <candlehome>/html.

This parameter is set by the installer and should not be edited.

ContextPath

The represents the context prefix. The default value is “/” (the root).

This parameter is set by the installer and should not be edited.

Trace

One of the following values:

None

Trace is disabled

Flow

Only the message flow is displayed in the debugger window

XML

The content of the XML requests and responses are displayed in the Debugger window

Log

The content of the XML requests and responses are displayed in the Debugger window and in addition a log file containing the request and response for each received message is generated

 

The default is None. This option should be changed only at the request of Candle customer support.

Environment

Valid values are:

The default is ALL (both MQSeries and JMS are supported).

QMGRS

The directory where WebSphere MQ is creating queue managers on this machine.

ValidateUser

Specifies if user validation (user id and password) is to be performed. Valid values are:

The default is No.

Audit

Logs updates made to messages, so that administrators can maintain an audit trail of changes. One of the following two parameters:

None

Audit logging is disabled

Log

The following edit operations are logged: creating a queue, deleting a queue, deleting a message, creating a message

 

UseUserId

Specifies whether WebSphere MQ operations are done using an alternate user ID (the user ID provided at login). Valid values are:

By default, the alternate user ID is used.

Timeout

The maximum time, in milliseconds, PathWAI Editor waits for a response to a PCF (programmable command format) request.

The default is 10000 (10 seconds). Range 1–100000 (100 seconds).

Idle

The maximum amount of time, in minutes, the server keeps the connection alive while not receiving any request on it. If an attempt is made to access the connection after the idle time has expired, a timeout message is displayed and the session is ended.

The default is 30 minutes. Range 1–1000.

FieldSize

The field size for unformatted raw (non-XML) messages. The default is 100 bytes. Range 1–1000.

FieldCount

The maximum number of unformatted raw (non-XML) fields. The default is 10.

MaximumResponseSize

The limit, in bytes, over which no more messages will be returned in a single peek. Messages that exceed the maximum response size may be split.

The default is 2 MB. Range 100000–10000000 (100KB to 10MB).

MaximumQueues

The maximum number of queue names displayed in the queue list when a queue manager is selected.

The default is 100. Range 1–500.

Namespace

The default MDR namespace in which message formats are defined. It may be overwritten by a queue profile.By default, the server points to the namespace :CandleSamples.MessageEditor. If you decide to use a different namespace for your format definitions, you will need to change the value of this tag in the server's config.xml file to refer the new namespace.

Filter

The Filter tag describes the access mode for adding, updating, and removing message filters in the MDR.

Filter definitions are stored in a data dictionary DataFilters in the same metadata repository as the message format definitions. The Filter field contains the information necessary for the server to access this data dictionary in the MDR. The URL can be an LDAP server or a configuration file.

URL—the location of the DataFilters dictionary, in the format protocol://host:port/path
For example: ldap://localhost:389/dc=dictionary,dc=roma,dc=candle,dc=com

UserID—the user ID required to access the dictionary, if any. The default is cn=manager.

Password—the user password required to access the dictionary, if any. The default is secret.

UseClientId

Use client id to connect queue manager in client connection. Valid values are:

If specified with value "No", the queue manager of a client connection is accessed using the PEM id.

QueueAdmin

The parameter decides whether you can create/delete/purge queue. If it is not "Yes", the operation of create/delete/purge queue will not work. The default value is "Yes".

AccessListRequired

The parameter confirms whether access List required for accessing client connection. If AccessListRequired is not "Yes" or specified in config.xml, the AccessList property is ignored, which means any user can see and access any client connection, regardless of whether the AccessList is defined or whether the user is a member of the AccessList. On the contrary, if AccessListRequired is "Yes",users from the <Administrators> list can see and access any client connection, regardless of whether the AccessList is defined or whether the user is a member of the AccessList; users who are not in the <Administrators> list can only see the client connections with that the AccessList property defined and the user must be a member of the AccessList. The default value is "No".

ClientConnectionCredentials

If specified with the value "No", no new credentials might be specified while accessing a client connection. The default value is "Yes".

Administrators

If specified, it restricts the users with access to create/delete/update client connections. <Administrators> contains a list of users who can see and access any client connection, regardless of whether the AccessList is defined or whether the user is a member of the AccessList. For example:

<Administrators>

<User>userid1</User>

<User>userid2</User>

...

</Administrators>

LoadPath

The parameter specifies the global (shared) directory for load/unload operation. It works when you set a valid "LoadPath" and confirm the check box named "Use Common Directory".

MessageCount

The parameter decides the maximum messages displayed per view. The default value is 200.

JKS

If specified, it is represents the global JKS for the client connections using SSL. Any client connection might:

EnableXMLUnload

If EnableXMLUnload is set to "Yes", it will enable the 'XML Format' check box in the 'UnLoad Messages' dialog window, or else that check box is disabled. By default, 'XML Format'check box is disabled.

The tag must be specified in the immediate level under the <ProfilePath>/bin directory in the config.xml file, and under the <ProfilePath>/Users/USERNAME directory in the user profile.xml file. If it is specified with the value "Yes", the 'XML Format', 'Separate Messages', 'Include Message Header', and 'Split Payload' check boxes in the 'Unload Messages' dialog window become enabled. Those check boxes enable unloading messages to XML files. Any value other than "Yes" or the default (when this tag is omited) will disable those check boxes.

DisableDeleteLoadFile

If DisableDeleteLoadFile is set to "Yes", it will disable the "Delete file only" check box in the 'Load Messages' dialog window, or else the check box is active for determining whether to delete the specific load file.

Any value other than "Yes" (ignore case) or the default (when this tag is omited) will keep the 'Delete File Only' check box enabled.

EditMsgExBytes

Specifies the maximum size of a message that can be edited. An exception occurs (no matter whether the 'Ignore Message Formatting' option in the 'Open Queue' dialog window is selected), when the size of the a message being edited is large. If the length of the message after it is pre-filtered is larger than 10MB, the message is truncated for performance consideration.

Note that "EditMsgExBytes" <= 500*1024*1024. If there is any incorrect character contained in the specified value, the default value 512000 is used instead.

PreFilterTags

Any data that is enclosed by the tag(s) specified in the <PreFilterTags> tag is pre-filtered or removed when an XML message is edited, no matter whether the 'Ignore Message Formatting' option in the 'Open Queue' dialog window is selected. If a message length is smaller than the value that is specified by the ListMsgFmtBytes tag, no data is pre-filtered. No default value is used if it is not specified. For example:

<PreFilterTags>

<tag>PassThroughData</tag>

...

</PreFilterTags>

ListMsgFmtBytes

Specifies whether a message is pre-processed to be displayed in a well-formed format when the messages are listed in a queue. If the message size is larger than the ListMsgFmtBytes value, it is not parsed, it will be pre-filtered according to the tags that are defined in PreFilterTags while editing.

Note that "ListMsgFmtBytes" <= 1*1024*1024. If it is not specified, the default value 1048576 is used.

MBCS

MBCS (multiple byte character sets) are supported only in the text message mode. If you have MBCS messages, the corresponding CCSID must be listed here so that they can be handled appropriately, and the browser must have a suitable font installed to display the characters.

The parameters are a list of character set IDs (CCSIDs) for which conversion operations will not be applied to raw text messages. For example:

<MBCS>

<CCSID>1208</CCSID>

<CCSID>936</CCSID>

</MBCS>

MAPCS

This parameter lets WebSphere MQ supported Codepage Sets be mapped to ones supported by Java. The different platforms and release levels of MQ have different default codepages:

Sun

923 (819 is already handled via the alias table)

HP

1051

AIX

819

 

For example:

<MAPCS>

<CCSID source="923">437</CCSID>

<CCSID source="1051">437</CCSID>

</MAPCS>

QueueReadOnlyUsers

The <QueueReadOnlyUsers> tag is in the config.xml file. It is a global tag. Use this tag to restrict the specified users to create queues, delete queues, and edit messages. The <QueueReadOnlyUsers> tag contains a list of users who cannot edit messages, create queues, or delete queues.

For example:

<QueueReadOnlyUsers>

<User>user1</User>

<User>user2</User>

</QueueReadOnlyUsers>

ClearQueueOnlyUsers

The <ClearQueueOnlyUsers> tag is in the config.xml file. It is a global tag. Use this tag to restrict the specified users to create and delete queues. The <ClearQueueOnlyUsers> tag contains a list of users who can only clear queues.

For example:

<ClearQueueOnlyUsers>

<User>user1</User>

<User>user2</User>

</ClearQueueOnlyUsers>