IBM MQ properties
IBM MQ properties apply to the whole IBM MQ installation.
The following tables list the properties that we can set for IBM MQ:
For each property, there is a brief description of when you might need to configure the property. The properties in the IBM MQ properties dialog relate to stanzas in the configuration files.
General page
The following table lists the properties that we can set on the General page of the Properties for IBM MQ dialog.
Property Description Stanza key Default prefix To change the location of the directory that stores all the queue manager data, type the full path to the new directory. DefaultPrefix Default queue manager name To specify a default name for new queue managers, type the name in this field. Name
Extended page
The following table lists the properties that we can set on the Extended page of the Properties for IBM MQ dialog.
Property Description Stanza key Default Ephemeral Prefix To change the location of the directory that stores all ephemeral queue manager data, type the full path to the new directory. DefaultEphemeralPrefix Convert EBCDIC newline EBCDIC code pages contain a newline (NL) character that is not supported by the ASCII code pages (although some ISO variants of ASCII contain an equivalent). If messages are sent from a system that uses EBCDIC code pages (for example, a z/OS system) to a system that uses ASCII, we can control how the EBCDIC newline character is converted into ASCII format. The default value is NL_TO_LF, which means that the EBCDIC NL character (X'15') is converted to the ASCII line feed character LF (X'0A') for all EBCDIC to ASCII conversions. To convert the EBCDIC NL character according to the conversion tables on your operating system, click TABLE. Note that the results of a TABLE conversion can vary from platform to platform and from language to language; even on the same platform the results might vary if we use different coded character set identifiers (CCSIDs). To convert ISO CCSIDs using the TABLE method and use the NL_TO_LF method for all other CCSIDs, click ISO. ConvEBCDICNewline Cluster workload mode The cluster workload exit, CLWL, specifies which cluster queue in the cluster is to be opened in response to an MQI call (for example MQOPEN or MQPUT). The default value is SAFE, which means that the CLWL exit is run in a separate process to the queue manager so that if there is a problem, the integrity of the queue manager is preserved. However running the CLWL exit as a separate process can have a detrimental effect on performance. To improve performance by running the CLWL exit in the same process as the queue manager, click FAST. Use FAST mode only if we are certain that there are no problems with your CLWL exit because if there is a problem in FAST mode, the queue manager fails and the queue manager's integrity is at risk. This value can be overridden for individual queue managers using the cluster workload mode property. For more information, see Queue manager properties. CLWLMode
Exits page
The following table lists the properties that we can set on the Exits page of the Properties for IBM MQ dialog. To configure the exits that are common to all of the queue managers on this computer, edit the properties on the Exits page.
Property Description Stanza key Exits Default Path To change the location of channel exits for clients, and channel exits and data conversion exits for servers, type the path to the new directory. ExitsDefaultPath Common API Exits To configure a new common API exit for IBM MQ, click Add then in the Properties dialog, type the details of the exit. To edit a common API exit that is already shown in the table, click Edit; to remove an API exit from the table, click Remove. ApiExitCommon Template API Exits To configure a new template API exit for IBM MQ, click Add then in the Properties dialog, type the details of the exit. To edit a template API exit that is already shown in the table, click Edit; to remove an API exit from the table, click Remove. ApiExitTemplate Name Specifies the descriptive name of the API exit which is passed to the API exit in the ExitInfoName field of the MQAXP structure. This name must be unique and is limited to a length of 48 characters, and must contain only those characters that are valid for the name of IBM MQ objects, such as queue names. Name Type Specifies the type of exit: common, or template. (Not a separate stanza key.) Sequence This property is an unsigned numeric value that defines the sequence in which this API exit is called in comparison with other API exits. An API exit with a low sequence number is called before another API exit with a higher sequence number. The order in which different API exits with the same sequence number are called is undefined. It is perfectly value for there to be gaps in the sequence numbers of the API exits defined for a queue manager. Sequence Module Specifies the module that contains the code for the API exit. If this field contains the full path name of the module it is used as is. If this field contains just the module name, the module is located using the same method as channel exits; that is, using the value in the Exit default path field on the Exits page of the queue manager properties dialog. Module Function Specifies the name of the function entry-point into the module that contains the code for the API exit. This entry-point is the MQ_INIT_EXIT function. The length of this field is limited to MQ_EXIT_NAME_LENGTH. Function Data If this property is specified, leading and trailing blanks are removed, the remaining string is truncated to 32 characters and the result is passed to the exit in the ExitData field of the MQAXP structure. If this property is not specified, the default value of 32 blanks is passed to the exit in the ExitData field of the MQAXP structure. Data
Default log settings
The following table lists the properties that we can set on the Default Log Settings page of the Properties for IBM MQ dialog. To change the default log settings, edit the properties on the Default Log Settings page. These settings are applied to all new queue managers by default.
Property Description Stanza key Log type To enable the queue manager to recover when it is restarted, click Circular. If the queue manager uses circular logging, when the log file is full, the file is overwritten starting from the beginning of the file. To enable the queue manager to recover when it is restarted and to enable media or forward recovery, click Linear. If the queue manager uses linear logging, when the log file is full, a new log file is started. LogType Log path To change the default location of the logs, type the full path here. If we do not specify the path here, the default is a sub-directory called Log in the DefaultPrefix, where DefaultPrefix is the directory specified in the Default prefix property on the General page of the Properties for IBM MQ dialog. LogPath Log file pages Type the number, from 32 - 4095, of 4KB pages in the log file. For example, if you type 256, the file size is 1MB. LogFilePages Log primary files On Windows, type the number, from 2 to 254, of primary log files. The default value is 3. The total number of primary and secondary log files must not exceed 255 and must not be less than 3.
On UNIX and Linux, type the number, from 2 to 510, of primary log files. The default value is 3. The total number of primary and secondary log files must not exceed 511 and must not be less than 3.
LogPrimaryFiles Log secondary files On Windows, type the number, from 1 to 253, of secondary log files. The default value is 3. The total number of primary and secondary log files must not exceed 255 and must not be less than 3.
On UNIX and Linux, type the number, from 1 to 509, of secondary log files. The default value is 3. The total number of primary and secondary log files must not exceed 511 and must not be less than 3.
LogSecondaryFiles Log buffer pages Type the number, from 0 - 512, of 4KB buffer pages for writing. If you specify 0, the queue manager selects the number itself. If you type a number from 1 to 17, the minimum of 18 is used. If you type a number from 18 - 512, that number of pages is used. If we change the value of this property, restart the queue manager to detect the change.
LogBufferPages Log write integrity The method that the logger uses to reliably write log records. The default value is TripleWrite. Note, that we can select DoubleWrite, but if you do so, the system interprets this as TripleWrite.
We should use SingleWrite, only if the file-system or device hosting the IBM MQ recovery log explicitly guarantees the atomicity of 4KB writes.
That is, when a write of a 4KB page fails for any reason, the only two possible states are either the before image, or the after image. No intermediate state should be possible.
LogWriteIntegrity Log management The method used to manage your logs. LogManagement applies only when LogType is LINEAR. If we change the LogManagement value, the change does not take effect until the queue manager is restarted.
There are three options.
Manual, where you manage the log extents manually. Specifying this option means that the queue manager does not reuse or delete log extents, even when they are no longer required for recovery.
Automatic, where log extents are managed automatically by the queue manager. Specifying this option means that the queue manager is able to reuse or delete log extents as soon as they are no longer required for recovery. No allowance is made for archiving.
Archive, where log extents are managed by the queue manager, but we must notify the queue manager when archiving of each log extent is complete.
Specify this option means that the queue manager is free to reuse or delete a log extent, as soon as the queue manager has been notified that an extent no longer required for recovery has been archived.
The default value is Manual.
LogManagement
ACPI page
The following table lists the properties that we can set on the ACPI page of the Properties for IBM MQ dialog. ACPI (Advanced Configuration and Power Interface) is an operating system feature that allows the computer to detect certain activity states and consequently to hibernate, that is to switch itself into a low power mode with no programs running, and in such a manner as to allow a quick "wake up".
When ACPI wants to put the computer into hibernation it first sends a suspend request to all applications. To control how IBM MQ responds to this request, set the Do dialog property on the ACPI page.
Property Description Stanza key Do dialog The default value is Yes, which means that IBM MQ displays a message that asks the user whether to suspend the running queue managers. To suspend IBM MQ without displaying this message, click No. DoDialog Deny suspend If the Do dialog property is not set, or if it is set but the dialog cannot be displayed (for example, if a laptop computer has its lid closed) then Deny suspend controls the response. The default value is No, which means that IBM MQ suspends, even if the dialog cannot be displayed. To prevent IBM MQ suspending when the dialog cannot be displayed, click Yes. This property can be overruled by the Check channels running property. DenySuspend Check channels running The default value is No, which means that IBM MQ does not check whether there are any channels running, and responds as directed by the Do dialog and Deny suspend properties. To check whether there are any channels running, click Yes. If there are no channels running, IBM MQ ignores the Do dialog and Deny suspend properties. If there are channels running, IBM MQ responds as directed by the Do dialog and Deny suspend properties. CheckChannelsRunning
Alert monitor page
The Alert monitor is available only on Windows.
The following table lists the properties that we can set on the Alert monitor page of the Properties for IBM MQ dialog. The Alert monitor is useful for problem determination. Alerts are raised by the services when something goes wrong; for example, if a channel initiator service cannot start because a queue that is needed has been deleted. To configure the alert monitor, edit the properties on the Alert monitor page.
Property Description Stanza key Alert monitor notifies user The default value is No, which means that IBM MQ does not send alerts to the user when there is a problem. To configure IBM MQ to send alerts when there is a problem, click Yes. Enable Alert monitor user Type the computer name or the user name to which IBM MQ should send alerts. Recipient Alert monitor icon added to taskbar The default value is No, which means that the Alert Monitor icon is not shown in the Windows system tray. To show the Alert Monitor icon in the Windows system tray, click Yes. TaskBar
Configuration information page
The following table lists the properties that are displayed on the Configuration information page of the Properties for IBM MQ dialog. The properties on the Configuration information page are read-only.
Parent topic: Properties
Property Description Install type Read-only. This property indicates whether you have installed the Server or Client version of IBM MQ on this computer. mqjbnd05 loaded Read-only. This is the library that is required to connect to local queue managers. MQ Version Read-only. This is the version of IBM MQ installed on this computer. Build level Read-only. This is the build number of the IBM MQ product that is installed on this computer. Build type Read-only. This is the type of build of the IBM MQ product that is installed on this computer.
Related tasks