Configuration file

The BMC Impact Integration Web Services configuration file, ImWebServices.conf, is stored in the $IIWS_HOME/Tomcat/webapps/imws/ WEB-INF/etcdirectory, which resides on the BMC Impact Integration Web Services server. It is loaded when the BMC Impact Integration Web Services server is started. After modifying a value, you need to restart the BMC Impact Integration Web Services server to apply the modified value.

Configuration file parameters

The following table lists and describes the configuration file parameters.

Configuration file parameters

Group

Parameters

Description

Message Buffer

MessageBufferKeepSent

The number of seconds to keep sent messages buffered while waiting for an answer.

Default: 300 seconds

MessageBufferKeepWait

The number of seconds that messages are retained in the buffer while waiting for the connection to be established.

Default: 3600 seconds (one hour)

MessageBufferBaseSize

The number of messages that can be stored in the message buffer.

Default: 5000 messages

MessageBufferSizeLimit

The maximum number of messages that can be stored in the message buffer.

Default: 0

MessageBufferReconnectInterval

(Optional) The number of seconds between attempts to connect to a BMC Impact Manager cell.

Default: 120

  • The value of this parameter cannot be less than 60 seconds.
  • When a connection is established, the BMC Impact Integration Web Services server sends buffered messages that are designated for the BMC Impact Manager cell with which a connection is established.

MessageBufferResendCount

The number of times to resend unanswered messages.

Default: 1

MessageBufferExpandPercentage

The percentage up to which the message buffer can expand.

Default: 10

Event Persistency

PersistencyEnabled

Enables persistency, which specifies additional buffering parameters when the buffer mode is No.

Valid values:

  • No (Default)
  • Yes

PersistencyLevel

(Optional) The buffer mode used when the Default buffering mode is specified. This parameter is enabled only when the PersistencyEnabled parameter value is Yes.

Valid values:

  • None (Default)
  • Low
  • High

These values are case-sensitive and must be entered as shown here.

PersistencyFileName

The name of the file where the buffered messages are stored.

Default: log/imgw-mposter.dat

PersistencyCleanupSize Threshold

The threshold size, in bytes, of the persistency file that activates garbage collection.

Default: 100000

PersistencyCleanupGarbage Threshold

The threshold percentage of the persistency file that activates garbage collection.

Default: 40 percent.

PersistencyDisconnectRemove Messages

Indicates whether messages written to the persistency file are deleted when the integration is intentionally disconnected from a BMC Impact Manager cell.

Valid values:

  • No
  • Yes (Default value)

The contents of the file are not deleted when the integration terminates unexpectedly.

PersistencyCleanupRefuseFile

Default: Yes

PersistencyStatisticsLevel

Default: None

GetEvents parameters

GateWayServername

The name of the gateway server for the BMC Impact Integration Web Services server that, like a listener server, receives messages from the cell(s). This gateway server needs to be defined in mcell.dir of the BMC Impact Integration Web Services of GWType imcomm. The cell(s) need to be configured to propagate the events to this gateway server.

Default: IIWSGatewayServer

MaxSubscriberNumber

The maximum number of subscriptions allowed for the gateway server.

Default: 100

RecvBufferSize

The maximum number of matching events stored in the gateway persistent receiver buffer. If the number of events received exceeds the RecvBufferSize value, old events are removed from the persistent receiver buffer.

Default: 2000

SelectorFileName

The file that defines the filter criteria used to identify and select the events that are propagated from Impact Managers.

Default: 2000

AutoSubscribe

When enabled, invoking GetEvents without prior subscription, will automatically register an unreliable subscription.

Default: AutoSubscribe=Yes

Cell Connection Timeout Parameters

ConnectionSetupTimeout

The maximum time, in seconds, that IIWS attempts to establish a TCP/IP connection to a cell. If the connection with the cell cannot be established within this time, the connection will not be established.

Default: 10 seconds

SynchronizeTimeout

The maximum time, in seconds, that IIWS attempts to synchronize or hand shake with the cell (after the TCP/IP connection has been established). If the synchronization with the cell cannot be completed within this time, the connection will not be established.

If the cell is busy with a database cleanup, it might be impossible to connect with the default values of ConnectionSetupTimeout and SynchronizeTimeout

Default: 5 seconds

Diagnostic Log Dump

SendDump

If true, events sent from the client to the cell are written to a log file in hex value.

Default: False

queryResultsDump

If true, query results received from the cell are written to a log file in hex value.

Default: False

RecvDump

If true, events propagated from the cell are written to a log file in hex value.

Default: False

Query Parameters

MaxReturnEventListSize

The maximum number of events or data returned each time in response to RetrieveQueryResults or GetEvents.

Default: 20

Editing the configuration file

  1. Using a text editor, open the ImWebServices.conffile.

    Note

    The selector file is not required for web service clients that only send events or data or that only launch queries.

  2. (Optional). Modify the file to include any optional BMC Impact Integration Web Services server parameters that you want to use. The following table lists these parameters.
  3. Save the file by using the file name of your choice and the file extension .conf.
  4. Ensure that the configuration file can be read by the user under whose permissions the BMC Impact Integration Web Services server is running.
  5. Restart the BMC Impact Integration Web Services server.
Was this page helpful? Yes No Submitting... Thank you

Comments