Contents SAS/IntrNet 8.2: Application Dispatcher Previous Next

Reserved or Special Variables

Application Dispatcher variables are referred to as name/value pairs, symbols, fields, or variables. You define most variables, such as the name of a data set to graph or a year to use in a WHERE clause. Some fields have special meaning to the Dispatcher and are described here.

Value Description
_ADMAIL E-mail address of the administrator. Automatically generated by the Broker according to the AdministratorMail directive.
_ADMIN Name of the administrator. Automatically generated by the Broker according to the Administrator directive.
_DEBUG Debugging flags. Default value is set by the Debug directive. See also Setting the Default Value of _Debug.
_PGM The next to last level in the value of the _PROGRAM variable. Indicates the name of the external file or catalog entry containing the current program code. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_PGMCAT The second level in the value of the _PROGRAM variable. It indicates the SAS catalog containing the current program. This variable is blank for programs of type SAS because they have three-level names and are stored in external files. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_PGMLIB The first level in the value of the _PROGRAM variable. It indicates the program library for the current program. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_PROGRAM Name of the Dispatcher program that the Application Server should run. The following lists the program types and the syntax for each:
A SAS program (an external file containing SAS source code with a .SAS extension)
Specify the fully qualified, three-level name: library.filename.sas.
A source entry (a catalog entry with a .SOURCE extension)
Specify the four-level name: library.catalog.entry.source.
A macro entry (a catalog entry with a .MACRO extension)
Specify the four-level name: library.catalog.entry.macro.
An SCL entry (a catalog entry with a .SCL extension)
Specify the four-level name: library.catalog.entry.scl.

You must specify a three- or four-level name in the _PROGRAM field, except when using Dispatcher-reserved Server Administration Programs, such as STATUS and STOP. For information about Server Administration Programs, see Application Server Administration Programs.

For more information on _PROGRAM see The Four Types of Programs.

_PGMTYPE The last level in the value of the _PROGRAM variable. It indicates the type of the current program. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_PORT The TCP/IP port number of the current Application Server. Together with _Server, it indicates the server selected out of the specified service.
_REPLAY A complete URL for use with programs that use the Output Delivery System (ODS). It is composed from the values of _URL, _SERVICE, and _TMPCAT. ODS uses this URL to create links that will replay stored output when they are loaded by the user's Web browser. See also Using the Output Delivery System. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_SERVER The DNS or IP address of the current Application Server. Together with _PORT, it indicates the server selected out of the specified service.
_SERVICE Name of a Dispatcher Service defined in your configuration file with the LaunchService or SocketService directives.
_THISSRV A URL composed from the values of _URL and _SERVICE. This variable is created by the Application Server and is not one of the symbols passed from the Broker.
_THISSESSION A URL composed from the values of _URL, _SERVICE, _SERVER, _PORT, and _SESSIONID. This variable is created by the Application Server and should be used as the base URL for all URL references to the current session.
_TMPCAT A unique, temporary catalog name. This catalog can be used to store temporary entries to be retrieved later. In socket servers, the _TMPCAT catalog is deleted after a number of minutes specified in the variable _EXPIRE. This variable is created by the Application Server and is not one of the symbols passed from the Broker. See Using the Output Delivery System.
_URL Self-reference to the Broker CGI program. Useful for generating pages that have links or inline images that reinvoke the Dispatcher. See also the SelfURL directive.
_VERSION Broker version number. Automatically generated by the Broker.

Contents SAS/IntrNet 8.2: Application Dispatcher Previous Next