Using the Broker Configuration File

The Application Broker is controlled by the directives in a configuration file. Usually, the configuration file is named broker.cfg and lives in the same directory as the broker executable, but other names or directories can be used in special cases. The Broker searches for the configuration file in the following manner:

1. builds the configuration file name by adding .cfg as the file type to the executable name. For example, broker.exe would look for broker.cfg and broker7 or broker7.cgi would look for broker7.cfg.

2. checks for the environment variable BROKER_CFG. If this variable exists, it is assumed to contain the path with the configuration file. If the BROKER_CFG variable exists, the configuration file must exist in this directory or the Broker will fail to execute.

3. checks for the configuration file in the same directory as the executable.

Platform Notes

UNIX

• Check /usr/local/lib/IntrNet/broker/ for the configuration file.

OS/390

• Check /usr/local/lib/IntrNet/broker/ for the configuration file.

• Starting with Release 8.2, the Broker configuration file is assumed to be in the encoding specified by the Web server's file system codepage option (FSCP).

If the configuration file is not found in any of the locations above, the Broker will fail to execute.

Template Configuration File

A template Broker configuration file named broker.cfg_v8 is installed with SAS/IntrNet. If this is the first installation of SAS/IntrNet, the template file will be installed as your initial Broker configuration file. The template contains example directives to help configure the Broker for your site. The following pages describe some of these directives in greater detail.

• Specifying the Global Administrator
• Specifying the Self-Referencing URL
• Specifying HTTP Methods
• Setting the Default Value of _DEBUG
• Using the DebugMask and ServiceDebugMask
• Displaying the Powered by SAS Logo
• Exporting Environment Variables
• Configuration File Directives

Modifying the Broker Configuration File

Use the following guidelines when modifying the template configuration file:

• Comments start with # as the first non-blank character.

• Because the Broker ignores leading spaces, you can include them to make the file easier for you to read.

• Each line of the configuration file must not extend beyond the first 256 columns. The plus sign (+) at the end of a non-comment line is used for line continuation.

• Quotation marks are required for values that contain blanks.

• You can use single or double quotation marks. Values that might require quotation marks are filenames and descriptions.

• If a configuration file entry accepts multiple values, delimit the values with spaces only.

• To specify a single quotation mark in a value, use \'.

• To specify double quotation marks in a value, use \".

• To specify a single backslash in a value, use \\.

• If an entry in the configuration file begins with #, you can activate that entry by removing the #.

• To complete an entry, delete or modify the text provided in the sample file. Replace this text with information that is valid for your site and installation.