The Job Controller configuration file contains lines of the form

option=value

in accordance with the format of PMDF option files.

In addition to option settings, the file can contain a line consisting of a section and value enclosed in square-brackets in the form

[section-type=value]

Such a line indicates that option settings following this line are to apply only to the section named by value. Initial option settings that appear before any such section tags will apply globally to all sections.

Per section option settings will override global defaults for that section.

Recognized section types for the Job Controller configuration file are QUEUE to define queues and their parameters, and CHANNEL to define channel processing information.

A sample Job Controller configuration file on UNIX is shown in Figure 10-1; a sample Job Controller configuration file on NT is shown in Figure 10-2.

Figure 10-1 Sample Job Controller Configuration File, job_controller.cnf , on UNIX

! ! Global parameters and defaults for all queues ! and channels. ! UDP_PORT=27442 (1) CAPACITY=200 (2) SLAVE_COMMAND=NULL (3) ! ! The DEFAULT queue, which will be used for channels that don't ! specify a queue. ! [QUEUE=DEFAULT] (4) JOB_LIMIT=8 (5) ! ! Another queue for some channels to use. ! [QUEUE=BIGQUEUE] JOB_LIMIT=16 ! ! Definitions for channel processing; each section ! corresponding to a PMDF channel. ! [CHANNEL=l] (6) MASTER_COMMAND=/pmdf/bin/l_master ! [CHANNEL=tcp_*] MASTER_COMMAND=/pmdf/bin/tcp_smtp_client ! [CHANNEL=cc_*] (7) MASTER_COMMAND=/pmdf/bin/cc_master SLAVE_COMMAND=/pmdf/bin/cc_slave

Figure 10-2 Sample Job Controller Configuration File, job_controller.cnf , on NT

! ! Global parameters and defaults for all queues ! and channels. ! UDP_PORT=27442 (1) CAPACITY=200 (2) SLAVE_COMMAND=NULL (3) ! ! The DEFAULT queue, which will be used for channels that don't ! specify a queue. ! [QUEUE=DEFAULT] (4) JOB_LIMIT=8 (5) ! ! Another queue for some channels to use. ! [QUEUE=BIGQUEUE] JOB_LIMIT=16 ! ! Definitions for channel processing; each section ! corresponding to a PMDF channel. ! [CHANNEL=l] (6) MASTER_COMMAND=C:\pmdf\bin\popstore_master ! [CHANNEL=tcp_*] MASTER_COMMAND=C:\pmdf\bin\tcp_smtp_client ! [CHANNEL=cc_*] (7) MASTER_COMMAND=C:\pmdf\bin\cc_master SLAVE_COMMAND=C:\pmdf\bin\cc_slave

The key items in the above examples are

1. This global option defines the UDP port number on which the Job Controller listens for requests.
2. Set a default CAPACITY for subsequent [QUEUE] sections.
3. Set a default SLAVE_COMMAND for subsequent [CHANNEL] sections.
4. This [QUEUE] section defines a queue named "DEFAULT". This queue will be used by all channels which do not specify a queue name using the queue channel keyword.
5. Set the JOB_LIMIT for this queue to 8.
6. This [CHANNEL] section applies to a channel named "l", the PMDF local channel. The only definition required in this section is the MASTER_COMMAND which the Job Controller issues to run this channel. Since no wildcard appears in the channel name, the channel must match exactly.
7. This [CHANNEL] section applies to any channel whose name begins with "cc_*", i.e., to any PMDF-LAN cc:Mail channel. For this channel, both a MASTER_COMMAND and a SLAVE_COMMAND are necessary. Since this channel name includes a wildcard, it will match any channel whose name begins with "cc_".

The available options are:

CAPACITY (integer > 0)

The maximum number of outstanding requests that a queue will hold. Additional requests beyond the CAPACITY of the queue are ignored. Exceeding the CAPACITY of a queue will not affect the ability of another queue to buffer outstanding requests until that queue's CAPACITY is exceeded. If set outside of a section, it will be used as the default by any [QUEUE] section which doesn't specify CAPACITY. This option is ignored inside of a [CHANNEL] section.

DEBUG (0 or 1)

If DEBUG=1 is selected, PMDF will write debugging information to a file in the PMDF log directory, /pmdf/log/ on UNIX or usually C:\pmdf\log\ on NT, named job_controller.log-uniqueid, where uniqueid is a unique string disambiguifying the file name. (Note that the pmdf purge utility understands the uniqueids and can be used to purge back older log files.)

JOB_LIMIT (integer)

The maximum number of requests that a queue can execute in parallel. Execution of a request will use a UNIX process, so this corresponds to the maximum number of UNIX processes you allow a queue to use. If more requests are present for a queue, they will be held until an executing job finishes, unless the CAPACITY of the queue is exceeded. The JOB_LIMIT applies to each queue individually; the maximum total number of jobs is the sum of the JOB_LIMIT parameters for all queues. If set outside of a section, it will be used as the default by any [QUEUE] section which doesn't specify JOB_LIMIT. This option is ignored inside of a [CHANNEL] section.

MASTER_COMMAND (file specification)

The full path to the command to be executed by the UNIX process created by the Job Controller in order to run the channel and dequeue messages outbound on that channel. If set outside of a section, it will be used as the default by any [CHANNEL] section which doesn't specify a MASTER_COMMAND. This option is ignored inside of a [QUEUE] section.

POLL_RUNS_SLAVE (0 or 1)

This option controls whether jobs submitted with the poll parameter execute both master and slave directions of a channel, or whether poll jobs only execute the master direction of a channel. POLL_RUNS_SLAVE=1 is the default and should be used for most channels. POLL_RUNS_SLAVE=0 should be specified for PMDF-DIRSYNC channels.

SLAVE_COMMAND (file specification)

The full path to the command to be executed by the UNIX process created by the Job Controller in order to run the channel and poll for any messages inbound on the channel. Note that many PMDF channels do not have a SLAVE_COMMAND. If that is the case, the reserved value NULL should be specified. If set outside of a section, it will be used as the default by any [CHANNEL] section which doesn't specify a SLAVE_COMMAND. This option is ignored inside of a [QUEUE] section.

UDP_PORT (integer)

An integer number indicating the UDP port on which the Job Controller should listen for request packets. You generally do not want to change this option unless the default conflicts with another UDP application on your system. If you do change this option, be sure to change the corresponding PMDF_JBC_SERVICE option in the PMDF tailor file (UNIX) or PMDF tailor Registry entry (NT) so that it matches.² The UDP_PORT option applies globally and is ignored if it appears in a [CHANNEL] or [QUEUE] section.