Copyright © Cloud Software Group, Inc. All rights reserved.

Configuration Parameters

The TIBCO iProcess Objects Server is configured using configuration parameters. The operating system you are using will determine how you modify the parameters:

•

Windows - In Windows, configuration parameters are modified using TIBCO iProcess Objects Server Configuration Utility. The configuration utility is available as a Control Panel applet (note that if the server is installed on a 64-bit machine, the utility applet is found under "View x86 Control Panel Icons" on the Control Panel) or by executing SWDIR\bin\SWEntObjSvCfg.exe.

The TIBCO iProcess Objects Server stores all configuration parameters in the Windows Registry in the following key:

---

 

\HKEY_LOCAL_MACHINE\SOFTWARE\Staffware plc\Staffware EntObj Server\Nodes

---

 

If the software is installed on a 64-bit machine, the Registry path will include "Wow6432Node", as follows: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Staffware plc\...

Each TIBCO iProcess Objects Server keeps its configuration under a key with the same name as the node name of the server. Note that it is highly recommended that you use the configuration utility to modify parameters rather than editing the registry directly.

If any configuration parameters are missing when the TIBCO iProcess Objects Server is started, they will be automatically created with default values. The TIBCO iProcess Objects Server will not start if any configuration parameters have invalid values.

•	UNIX - When using the supported UNIX operating systems (AIX, HP-UX, etc.), the configuration parameters are stored in the text file $SWDIR/seo/data/swentobjsv.cfg. The parameters in this file have the format:

       ConfigKey = Values

where:

ConfigKey is the name of the configuration parameter.

Value is the value of the parameter.

Lines beginning with a # are ignored and can be used for comments or for temporary changes. Blank lines are ignored and can be used to improve the readability of the file.

If any configuration parameters are missing when the TIBCO iProcess Objects Server is started, they will be automatically created with default values. If any of the configuration parameters contain invalid values, the TIBCO iProcess Objects Server will not start.

To make changes to the configuration file, you must first stop the UNIX TIBCO iProcess Objects Server, make your changes, then restart the server.

iProcess Objects Server Configuration File When Upgrading

[UNIX only] If you are upgrading TIBCO iProcess Objects Server from an earlier version on a UNIX system, the installation program will not overwrite your server configuration file, $SWDIR/seo/data/swentobjsv.cfg, if it exists. (Since this is an upgrade, the only reason the configuration file wouldn’t already exist is if it has been manually moved/deleted). The installation program won’t overwrite your existing configuration file because you may have customized it for your particular needs.

•	If the swentobjsv.cfg file does not exist, the installation program will install both an swentobjsv.cfg file and a sample.cfg file in the $SWDIR/seo/data directory. These files will be exactly the same.

•	If the swentobjsv.cfg file does exist, the installation program will install only a sample.cfg file in the $SWDIR/seo/data directory.

In both cases above, the newly installed configuration file (swentobjsv.cfg and/or sample.cfg) is the configuration file for the version of the server to which you are upgrading. It may contain new configuration parameters or other changes. Note, however, that all configuration parameters in the new configuration file(s) are commented out — if used as is, iProcess Objects Server will use the default values for all parameters.

If the new configuration file contains new/modified information, you can copy that information and paste it into your configuration file. (You can use the diff program (diff swentobjsv.cfg sample.cfg) to determine what is different between your configuration file and the new configuration file.)

Whether or not you make any modifications, the $SWDIR/seo/data directory must contain a swentobjsv.cfg file, which will be used to configure iProcess Objects Server when it is started.

Also, if any of the configuration parameters contain invalid values, iProcess Objects Server will not start. Note that since iProcess Objects Server log file is not opened until after the configuration file is read, if there is an error in the configuration file, it is not written to the log file. Instead, it is written to the $SWDIR/logs/seo_error file (this file is created when iProcess Objects Server starts, so the presence of the file does not mean there were errors).

Multiple Instances of Configuration Parameters

Although this section primarily pertains to setting configuration parameters when running multiple instances of the TIBCO iProcess Objects Server, some of it is also applicable when setting parameter values for non-multiple-instance TIBCO iProcess Objects Servers.

Multiple instances of the TIBCO iProcess Objects Server can be run on a single machine. See Running Multiple Instances of the TIBCO iProcess Objects Server for more information.

If the multiple instance feature is being used, you can also specify multiple instances of the configuration parameters described in this chapter. This allows you to configure each instance of the TIBCO iProcess Objects Server differently. You can define multiple instances of all configuration parameters except NumFiles, AnonymousUserName’X’, AnonymousSWUserName’X’, AnonymousPoolSize’X’ and AnonymousPrivilege’X’.

Configuring Multiple Instance Parameters on UNIX Systems

To specify a parameter for a particular instance, add "01" to the parameter name for the first instance, "02" for the second and so on. Any instance that does not have an individual parameter set will use the "common" parameter.

For example, if the following is the only "LogFileMaxSize" parameter specified:

LogFileMaxSize = 50

Then all instances will use a log size of 50MB.

If the following "LogFileMaxSize" parameters have been defined:

LogFileMaxSize = 50

LogFileMaxSize03 = 100

Then instance 3 of the TIBCO iProcess Objects Server will have a 100MB file size, while all other instances will have a 50MB file size.

The TCPServiceName and UDPServiceName parameters work a little differently. For information about how these parameters work with multiple instances of TIBCO iProcess Objects Servers, see This identifies the port number on which the TIBCO iProcess Objects Server will listen for client connections. This can be specified in the following ways: and UDPServiceName.

Configuring Multiple Instance Parameters on Windows Systems

The TIBCO iProcess Objects Server Configuration Utility allows you to select each instance of the TIBCO iProcess Objects Server on the machine so that parameters can be configured for that instance:

If the TIBCO iProcess Objects Server is multiple-instance capable (i.e., it has CR 10974 implemented), the Multiple Instance Server check box will be checked when that server is selected in the server drop-down list. Also, for each TIBCO iProcess Objects Server that is multiple-instance capable, the server name will be shown in the server drop-down list with “(default)” to the right of the name. Then, each instance of that TIBCO iProcess Objects Server is shown in the list with a two-digit instance number appended to the server name. In the example shown above, the TIBCO iProcess Objects Server named “vi10sql” has three instances.

If the TIBCO iProcess Objects Server is multiple-instance capable, but you are not running multiple instances of that server, there will still be two entries for that server in the drop-down list: “<ServerName>(default)” and “<ServerName>01”.

Setting Default Parameter Values When Using the Configuration Utility

There are two types of default values for the TIBCO iProcess Objects Server configuration parameters

•	System defaults - These are the values to which all parameters are set when the TIBCO iProcess Objects Server is initially installed. These default values are established by the system.

•

Multiple-instance defaults - These are values that you can establish as the default values for a TIBCO iProcess Objects Server that is multiple-instance capable. Initially, these default values are the same as the system default values. To establish the default values for a particular TIBCO iProcess Objects Server, select the “<ServerName>(default)” entry for the desired server from the server drop-down list, then change the desired values.

The TIBCO iProcess Objects Server Configuration Utility has been designed so that the color of the text indicates if a value is different from either the system default or the multiple-instance default.

•	Values that are the same as the system default are displayed in black.

•	Values that are different than the system default are displayed in blue. Note that this also applies to parameters for TIBCO iProcess Objects Servers that are non-multiple-instance servers.

•	Values that are different than the multiple-instance default are displayed in red. This, of course, only applies to TIBCO iProcess Objects Servers that are multiple-instance capable.

Setting Values to the Defaults

You can set parameter values back to the default values using the following methods:

•	Set All Defaults button - This button, which is displayed on the bottom of the TIBCO iProcess Objects Server Configuration Utility window, allows you to set the parameter values to either the system defaults or the multiple-instance defaults, as follows:

−	If a non-multiple-instance TIBCO iProcess Objects Server is selected in the server drop-down list, clicking Set All Defaults causes all parameters for that server to be set to the system defaults.

−

If the “(default)” selection for a multiple-instance capable TIBCO iProcess Objects Server is selected in the server drop-down list, clicking Set All Defaults causes the multiple-instance defaults for that TIBCO iProcess Objects Server to be set to the system defaults. This also causes the parameters for instances of that TIBCO iProcess Objects Server to take on the system default values, but ONLY if they had not previously been modified. In other words, any parameter values that had been changed for a particular instance of the TIBCO iProcess Objects Server is not modified when you set the default parameters for that TIBCO iProcess Objects Server.

−	If one of the instances of the TIBCO iProcess Objects Server is selected in the server drop-down list (e.g., vi10sql02 in the example shown earlier), clicking on Set All Defaults causes the following dialog to be displayed:

From this dialog, you can set all of the parameters for that instance of the TIBCO iProcess Objects Server to the system defaults or the multiple-instance defaults.

•	Right-click drop-down menu - Right-clicking on an individual field or check box in the TIBCO iProcess Objects Server Configuration Utility displays the following menu.

This menu allows you to set that specific parameter to either the system default or multiple-instance default. Note that the Set to System Default selection is available only if the parameter value is currently different than the system default, and the Set to Multi-Instance Default selection is available only if the parameter value is currently different than the multiple-instance default.

This right-click drop-down menu also provides selections that allow you to perform standard Windows copy, paste, and undo functions.

Accessing Configuration Parameters Through the Object Model

Each of the configuration parameters can be accessed through TIBCO iProcess Objects or TIBCO iProcess Server Objects object models using the following properties/methods:

•	TIBCO iProcess Objects (COM): ConfigInfos property on SWNodeInfoEx

•	TIBCO iProcess Objects (Java and C++): getConfigInfos method on SWNodeInfoEx

•	TIBCO iProcess Server Objects (.NET): ConfigInfos property on vANode

•	TIBCO iProcess Server Objects (Java): getConfigInfos method on vANode

These properties/methods all return a list of objects, each representing one of the TIBCO iProcess Objects Server configuration parameters, as well as the value of each of the parameters. See the following pages for the names of the available parameters.

In addition to the TIBCO iProcess Objects Server configuration parameters, the following parameters are also returned by the ConfigInfos/getConfigInfos property/method. These additional parameters allow you to determine if the TIBCO iProcess Objects Server supports new features that have been added to the server:

•	UVAPISupported - Indicates if the User Validation API is supported. This feature was added to the TIBCO iProcess Objects Server in CR 10355.

•	QCountsAudMsgSupported - Indicates if the audit text message is available on the SWAuditStep object (in TIBCO iProcess Objects) or the vAuditStep object (in TIBCO iProcess Server Objects). This feature was added to the TIBCO iProcess Objects Server in CR 12407.

•	MultipleInstanceSupported - Indicates if multiple instances of the TIBCO iProcess Objects Server can be run. This feature was added to the TIBCO iProcess Objects Server in CR 10974.

•	XPCCaseFilteringSupported - Indicates whether or not all cases will be filtered by the database. This feature was added to the TIBCO iProcess Objects Server in CR 13182.

•	F3WISFilteringSupported - Indicates whether or not all work items will be filtered by the Work Item Server (WIS). This feature was added to the TIBCO iProcess Objects Server in CR 12744.

•	MemosSupported - Indicates if fields of type swMemo are supported. This feature was added to the TIBCO iProcess Objects Server in CR 8427.

•	SmartHeapSupported - Indicates if SmartHeap was compiled and linked into TIBCO iProcess Objects Server.

•	SmartHeapVersion - Contains the version number, in the format XX.XX.XX, if SmartHeap is supported.

These parameters (with the exception of SmartHeapVersion) will return a value of 1 if the TIBCO iProcess Objects Server supports that feature; they will return a value of 0 if the TIBCO iProcess Objects Server does not support the feature.

Copyright © Cloud Software Group, Inc. All rights reserved.