Configuration file syntax

The configuration file is divided into sections.

Each section begins with a header in one of the two following formats (the square brackets are required, they are not command syntax indicators):

     [ _GLOBAL_ ]
 [<program>]

[ _GLOBAL_ ]

There must be only one [ _GLOBAL_ ] section containing general information about the product and the tracing configuration for all programs that do not have a specific section.

[<program>]

You can define a separate section for each of the IBM Workload Scheduler programs ([<program>]). The following programs are most likely to require tracing:

   APPSRVMAN
   BATCHMAN
   JOBMAN
   JOBMON
   MAILMAN
   NETMAN
   WRITER
   JAVA (the connector)

However, you can trace any executable program such as COMPOSER, CONMAN and all the utilities stored in the IBM Workload Scheduler /bin directory.

You cannot have more than one instance of a section for the same program.

If a program has no specific section, its trace configuration uses the defaults in the [ _GLOBAL_ ] section. Details defined in the program sections in almost all cases override the corresponding values in the [ _GLOBAL_ ] section (the exception is Product).

The program name is not case-sensitive. For example, you can write Netman, NetMan, netman or NETMAN.

Note: On UNIX™ operating systems, JOBMAN and jobman are two separate programs performing different functions. This means that on UNIX™ operating systems, because of the case-insensitivity, if you set a trace configuration section for either JOBMAN or jobman, both programs will be traced using that section and therefore to the same segment. This is a limitation that cannot be avoided at present.

Available keys (each key can be defined only once in each section):

Product

[ _GLOBAL_ ] only. Product identification string. Required.

Enabled

Specifies if the segment is enabled. If you change the enablement of a segment by changing this value and saving the configuration file, you must restart the product to make the change effective. If the segment in the [ _GLOBAL_ ] section is not enabled, the entire tracing facility is disabled. Enter "y" or "n".

Active

Specifies whether tracing for the specific program is active. If the [ _GLOBAL_ ] section is not activated, the tracing for all programs without a specific section is not activated. This value can be changed without restarting the product by using the tracing command. Enter "y" or "n".

SegNum

Determines the segment number to use for tracing for a specific section. More than one program can be defined for the same segment in different sections. The SegNum specified in the

[
_GLOBAL_ ]

section is used by any program that does not have a specific section defined. If you change the segment number of a program by changing this value and saving the configuration file, you must restart the product to make the change effective. Enter any numeric value.

FilterFile

Specifies the file that contains the criteria for filtering components, functions, or source files. The file is applied at segment level, so you cannot specify different filter files for different programs that use the same segment. This value can be changed without restarting the product by using the tracing command. Enter the fully qualified file path.

The default filter file supplied with the product does not trace the top 5% most-used routines (by being most-used they are less likely to exhibit problems).

SegSize

Specifies the segment size (Kb). If this value is supplied more than once in different sections for the same segment, the trace facility uses the highest of the supplied values. If you change the size of a segment by changing this value and saving the configuration file, you must restart the product. Enter a numeric value.

The full shared memory usage is the sum of all enabled segments, plus several Kbytes for the control data.

On UNIX™, ensure that you do not exceed the configurable kernel parameter which determines the maximum size of shared memory.

Level

Specifies the maximum level to be traced for the program. Enter one of the following numeric values:


Level	Description
10	Unrecoverable
20	Error
30	Warning
40	Informational
50	Debug minimum
60	Debug medium
70	Debug maximum
80	Function entry and exit

If this value is supplied more than once in different sections for different programs that trace in the same segment, the trace facility uses the appropriate values for each program. Thus, the segment might contain traces for one program at level 10 and for another at level 80.

This value can be changed without restarting the product by using the tracing command.

SegPerUser

Specifies if the segment provides access to the owner of the segment only (y) or all users (n). Enter "y" or "n"