SAS Institute. The Power to Know

Base SAS(R) 9.2 Guide to Information Maps

Previous Page | Next Page

LIBNAME Statement for the Information Maps Engine

LIBNAME Statement Syntax

LIBNAME libref INFOMAPS MAPPATH="location" <options>;

Required Arguments

libref

is a SAS name that refers to the metadata server library to be accessed. A libref cannot exceed eight characters. For additional rules for SAS names, refer to SAS Language Reference: Dictionary.

INFOMAPS

is the engine name for the SAS Information Maps LIBNAME engine.

Alias: SASIOIME
MAPPATH="location"

specifies the path to the location within the SAS folders tree for the information maps you want to read.

The path is hierarchical with the slash (/) as the separator character. For example, mappath="/Users/myUserID/My Folder" . If the path does not contain a blank space (or spaces), enclosing the identifier in quotation marks is optional.

Alias: PATH=

LIBNAME Statement Options for Connecting to the SAS Metadata Server

The following LIBNAME statement options establish a connection to the metadata server.

DOMAIN="authentication-domain"

specifies an authentication domain to associate the user ID and password with. If you do not specify an authentication domain, then the user ID and password are associated with the DefaultAuth authentication domain. For information about authentication, see "Understanding Authentication in the SAS Intelligence Platform" in SAS Intelligence Platform: Security Administration Guide.

An authentication domain is a set of computing resources that use the same authentication process. An individual uses the same user ID and password for all of the resources in a particular authentication domain. Authentication domains provide logical groupings for resources and logins in a metadata repository. For example, when an application needs to locate credentials that enable a particular user to access a particular server, the application searches the metadata for logins that are associated with the authentication domain in which the target server is registered.

Alias: AUTHDOMAIN=
METAPASS="password"

specifies the password that corresponds to the user ID that connects to the metadata server. For example, metapass="My Password" or metapass=MyPassword . If the password is not encoded or does not contain a blank space (or spaces), enclosing the identifier in quotation marks is optional.

You can use the METAPASS= system option to specify a default password for connecting to the metadata server for the SAS session. See the METAPASS= system option in the SAS Language Reference: Dictionary.

If your metadata server supports single sign-on, you can omit the METAPASS= and METAUSER= options and connect through a trusted peer connection or through Integrated Windows Authentication. For more information, see the SAS Intelligence Platform: Security Administration Guide.

Alias: PASSWORD= | PW=
METAPORT=port-number

specifies the TCP port that the metadata server is listening to for connections. For example, metaport=8561 .

If this option is not specified, the value is obtained from the METAPORT= system option. See the METAPORT= system option in the SAS Language Reference: Dictionary.

Alias: PORT=
METASERVER="address"

specifies the network IP (Internet Protocol) address of the computer that hosts the metadata server. For example, metaserver="myip.mycompany.com" . Enclosing the identifier in quotation marks is optional.

If this option is not specified, the value is obtained from the METASERVER= system option. See the METASERVER= system option in SAS Language Reference: Dictionary.

Alias: SERVER= | HOST= | IPADDR=
METAUSER="user-ID"

specifies the user ID to connect to the metadata server. For example, metauser="My UserID" or metauser=myUserID . If the user ID does not contain a blank space (or spaces), enclosing the identifier in quotation mark is optional.

You can use the METAUSER= system option to specify a default user ID for connecting to the metadata server for the SAS session. See the METAUSER= system option in SAS Language Reference: Dictionary.

If your metadata server supports single sign-on, you can omit the METAUSER= and METAPASS= options and connect through a trusted peer connection or through Integrated Windows Authentication. For more information, see the SAS Intelligence Platform: Security Administration Guide.

Alias: USER= | USERID= | ID=
Restriction: In the metadata server, you must have at least one login definition that contains a user ID that corresponds to the user ID that you specify here. For information about login definitions, see the User Manager Help for logins in the SAS Management Console.
Restriction: If your metadata server runs in a Windows environment, then you must fully qualify the user ID by using the domain or machine name that you specified when your login object was created in a SAS Metadata Repository. For example: metauser="domain-name\user-ID" .

Other LIBNAME Statement Options for the Information Maps Engine

The following LIBNAME statement options for the Information Maps engine are global options that exist for the lifetime of the libref.

AGGREGATE=YES | NO

specifies whether detailed data or aggregated data should be used. Specify YES in order to see data items that do not support detailed data.

Default: NO
EXPCOLUMNLEN=integer

specifies the length of the SAS character column when a data item defined with an expression is encountered.

The EXPCOLUMNLEN= option doubles as a data set option. This means that this option value can be changed during a DATA step when the Information Maps engine is used. This changed value is in effect only during the execution of the DATA step. Once the DATA step is completed, the value will revert to the setting at the time of libref creation. For more information, see the EXPCOLUMNLEN= Data Set Option.

Default: 32
PRESERVE_MAP_NAMES=YES | NO

YES

specifies that information map names are read with special characters, and that the exact, case-sensitive spelling of the name is preserved.

Note:   To access information maps with special characters or blank spaces, you have to use SAS name literals. For more information about SAS name literals, see "Rules for Words and Names in the SAS Language" and "Avoiding Errors When Using Name Literals" in the SAS Language Reference: Concepts.  [cautionend]

NO

specifies that when you refer to an information map, the information map name is derived from SAS member names by using SAS member-name normalization. When you use SAS to read a list of information map names (for example, in the SAS Explorer window), the information maps whose names do not conform to the SAS member-name normalization rules do not appear in the output. The DATASETS procedure reports the number of information maps that cannot be displayed because their names cannot be normalized, as shown in the following example:

NOTE: Due to the PRESERVE_MAP_NAMES=NO LIBNAME option setting, 
  12 information map(s) have not been displayed.
You do not get this note when using the SAS Explorer window.

The SAS Explorer window displays information map names in capitalized form when PRESERVE_MAP_NAMES=NO. These information map names follow the SAS member-name normalization rules and might not represent the actual case of the information map name.

Default: YES
READBUFF=integer

specifies the number of rows to hold in memory for input into SAS. The value must be positive.

Choosing the optimum value for the READBUFF= option requires a detailed knowledge of the data that is returned from the information map and of the environment in which the SAS session runs. Buffering data reads can decrease network activities and increase performance. However, higher values for READBUFF= use more memory. In addition, if too many rows are selected at once, then the rows that are returned to the SAS application might be out of date. For example, if someone else modifies the rows after they are read, you do not see the changes.

A READBUFF= data set option is also available. You can use the data set option to adjust the buffer size during a DATA step when using the Information Maps engine. This changed value is in effect only during the execution of the DATA step. Once the DATA step is completed, the value reverts to the setting specified when libref was created. For more information, see the READBUFF= Data Set Option.

Alias: BUFFSIZE=
Default: 1000
SPOOL=YES | NO

YES

specifies that SAS creates a spool file into which it writes the rows of data that are read for the first time. For subsequent passes through the data, rows are read from the spool file, rather than being reread from the original data source(s). This guarantees that each pass through the data processes the same information.

NO

specifies that the required rows for all passes through the data are read from the original data source(s). No spool file is written. There is no guarantee that each pass through the data processes the same information.

Default: YES

Previous Page | Next Page | Top of Page