OBJECTSERVER System Option

Specifies whether SAS is to run as an Integrated Object Model (IOM) server.
Valid in: configuration file, SAS invocation
Category: Environment control: Initialization and operation
PROC OPTIONS GROUP= EXECMODES
Default: NOOBJECTSERVER
See: OBJECTSERVERPARMS System Option
Table of Contents

Syntax

-objectserver

Syntax Description

-objectserver
when specified, SAS runs as an IOM server.

Details

An IOM server is a noninteractive SAS session that is run with the OBJECTSERVER system option. The spawner sets OBJECTSERVER for the SAS IOM servers that it invokes. In order to make it easy to specify the command, the server can be started by using a simple command with an option to connect back to the metadata server to obtain additional IOM-specific options.
You can specify the server start-up command in several locations:
  • system command line
  • script
  • metadata (server definition in SAS Management Console)
The general form of the server start-up command is: 
SAS-exec -objectserver other-system-options -objectserverparms "object-server-parameters"
  • SAS-exec
    is the absolute path to the SAS executable. For example:
    • Windows:
      C:\Program Files\SASHome\SASFoundation\9.3\sas
    • UNIX:
      /usr/local/bin/SAS/SASFoundation/9.3/sas
  • -objectserver
    launches this SAS session as an IOM server.
    Note: In configuration files on z/OS, do not precede system options with a hyphen. Also, an equal sign must precede the first parameter that follows the OBJECTSERVERPARMS keyword. For example: 
    objectserver  objectserverparms="cel=credentials protocol=bridge port=8561"
  • other-system-options
    are optional, additional system options. System options that are typically used for servers include options such as: LOGCONFIGLOC, NOTERMINAL, and NOLOGO. For complete information about system options, see SAS System Options: Reference.
  • -objectserverparms "object-server-parameters"
    are IOM-server-specific options that are passed to the server by the OBJECTSERVERPARMS system option. For more information, see OBJECTSERVERPARMS System Option.
Note: For SAS Workspace Servers that run on UNIX, it is sometimes necessary to call the SAS start-up command by using a wrapper script. For more information, see Managing Workspace Servers and Stored Process Servers.
The server start-up command is obtained as follows:
  • When the server is started by a spawner, the start-up command is stored in SAS metadata.
    In the SAS metadata, there is one metadata field for the SAS start-up command and system options, and another field for the object server parameters. The object spawner combines these two fields, along with connection information and some spawner internal object server parameters, to create the complete SAS command. The object spawner then passes this command to the operating environment.
  • When the server is started by a script or as a service or daemon, the command that is passed to the operating environment is not determined by SAS metadata.
    However, SAS Workspace Servers, and any OLAP server can connect back to the SAS Metadata Server in order to obtain additional object server parameters and connection information (such as protocol engine and port number). (Some object server parameters cannot be obtained from the metadata. For more information, see OBJECTSERVERPARMS System Option.
    When object server parameters are specified in the metadata, if there are any object server parameters that are also specified in the command, then the object server parameters in the command take precedence over those that are stored in the metadata.
Regardless of how the server is started, workspace servers, stored process servers, and OLAP servers, by default, also connect back to the metadata server in order to obtain configuration information, such as pre-assigned libraries, that is associated with the SAS Application Server.
The following table summarizes the ways that the SAS command, system options, and object server parameters can be specified for each type of IOM server. (1 = Object server parameters that are stored in metadata supplement the command-line object server parameters if the SERVER parameter is used.)
Various Ways to Launch IOM Servers
Server
Spawner launched?
Use of SERVER parameter
Obtainable from metadata?
Command
Object server parameters
Librefs
Workspace server
Required
Spawner supplied
Yes
(Spawner retrieves)
Yes
(Spawner retrieves)
Yes
Stored process server
Required
(Load-balanced)
Spawner supplied
Yes
(Spawner retrieves)
Yes
(Spawner retrieves)
Yes
OLAP server
Not allowed
Required
No
Yes
Yes
(If SERVER is used)
Metadata server
Not allowed
Not allowed
No
No
No
Note: When you start the server with a script, some object server parameters, such as DNSMATCH, cannot be obtained from the metadata. Do not enter these object server parameters in your metadata. For details, see OBJECTSERVERPARMS System Option.

Example

This example shows how OBJECTSERVER can be used in a configuration file used to start the metadata server: 
-objectserver 
-objectserverparms "cel=credentials protocol=bridge port=8561 classfactory=
0217E202-B560-11DB-AD91-001083FF6836 trustsaspeer=C:\SAS\
FoundationServers\Lev1\SASMeta\MetadataServer\trustedPeers.xml"
Note: In configuration files on z/OS, do not precede system options with a hyphen. Also, an equal sign must precede the first parameter that follows the OBJECTSERVERPARMS keyword. For example: 
objectserver  objectserverparms="cel=credentials protocol=bridge port=8561"

See Also

System Options:
OBJECTSERVERPARMS System Option
Copyright © SAS Institute Inc. All rights reserved.