Macros for SAS Visual Analytics Integration

%RMVALOAD

%RMVALOAD Overview

%RMVALOAD loads a LASR table into memory. This macro can also be used to load a LASR table incrementally.
Note: This macro cannot be executed on z/OS or H6I (HP-UX on Itanium).

%RMVALOAD Syntax

%RMVALOAD(

FOLDER=folder-path
,GRIDHOST=grid-host-server
,GRIDINSTALLLOC=grid-install-location
,LASRLIBRARY=lasr-library-name
,LASRPORT=lasr-port
,LASRTAG=lasr-tag
,METAPASS=user-password
,METASERVER=name-of-metadata-server
,METAUSER=user-ID,
,SOURCELIBPATH=source-library-path

,TABLE=table-name
,TABLELABEL=table-label
<,APPEND=Y | N>
<,METAPORT=metadata-server-port>
<,METAREPOSITORY=name-of-metadata-repository>
<,SIGNER=authorization-web-service-uri>
<,TYPE=VA-environment-type>

);

%RMVALOAD Required Arguments

FOLDER=folder-path

specifies the metadata path for the folder in which to store the LASR table metadata.

GRIDHOST=grid-host-server

specifies the domain name of the Grid Host server in TCP/IP format.

GRIDINSTALLLOC=grid-install-location

specifies the location of the SAS High-Performance Analytics components. This parameter is required for a Massive Parallel Processing (MPP) type of environment.

LASRLIBRARY=lasr-library-name

specifies the LASR Library name to use in accessing the SAS LASR Analytic Server.

LASRPORT=lasr-port

specifies the port to use in accessing the SAS LASR Analytic Server, in integer format.

LASRTAG=lasr-tag

specifies the tag to use for accessing the SAS LASR Analytic Server.

METAPASS=user-password

specifies the password to use in authenticating the user ID to the metadata server. Do not enclose the value for this parameter in quotation marks.

You can use the PWENCODE form of the password. For more information about the PWENCODE procedure, see the Base SAS Procedures Guide.
Tip
If you use the PWENCODE form of the password, be sure to handle embedded braces ({}) carefully. Do not confuse them with square brackets ([]).

METASERVER=name-of-metadata-server

specifies the name of the repository in which to look for the specified job. The default value for this parameter is Foundation. Do not enclose the value for this parameter in quotation marks.

specifies the domain name of the metadata server in TCP/IP format.

METAUSER=user-ID

specifies the user ID to use in accessing the metadata server. Do not enclose the value for this parameter in quotation marks.

SOURCELIBPATH=source-library-path

specifies the source library path.

TABLE=table-name

specifies the table name to load to the SAS LASR Analytic Server.

TABLELABEL=table-label

specifies the table label to associate with the table to load to the SAS LASR Analytic Server.

%RMVALOAD Options

APPEND=Y | N

specifies whether to append to the existing table in the SAS LASR Analytic Server. The default value for this parameter is N.

METAPORT=metadata-server-port

specifies the port to use in accessing the metadata server, in integer format. The default value for this parameter is 8561. Do not enclose the value for this parameter in quotation marks.

METAREPOSITORY=name-of-metadata-repository

specifies the name of the repository in which to look for the specified job. The default value for this parameter is Foundation. Do not enclose the value for this parameter in quotation marks.

SIGNER=authorization-web-service-uri

specifies the URI for the SAS LASR authorization web service.

TYPE=SMP | MPP

specifies the type of SAS Visual Analytics environment. The default value for this parameter is SMP.

  • Specify SMP (that is, Symmetric Multi-Processing) if you are working with a non-distributed SAS Visual Analytics environment.
  • Specify MPP (that is, Massive Multi-Processing) if you are working with a distributed SAS Visual Analytics environment.

%RMVALOAD Notes

You can append data to an existing LASR table in both the non-distributed and distributed SAS Visual Analytics environments. The LASR table is available to applications during the append process. To incrementally load SAS IT Resource Management data, specify the optional parameter of APPEND=Y.

%RMVALOAD Example

The following example loads the PCSDSK table (labeled HP Perf Agent Disk Stage Table) to the SAS LASR Analytic Server in a non-distributed SAS Visual Analytics environment:
%RMVALOAD(
         ,append=N
         ,folder=/Shared Metadata/LASR/ITRM
         ,gridHost=mygrid.subdomain.domain.com  
         ,gridInstallLoc=/opt/TKGrid
         ,lasrLibrary=Visual Analytic LASR
         ,lasrPort=10010
         ,lasrTag=ITRM
         ,metaPass=mypassword
         ,metaServer=mybox.subdomain.domain.com
         ,metaUser=myuserid
         ,signer=mywebserviceURI
         ,sourceLibPath=C:\MyDataMart\HPPerfAgent\HPPerfAgent1\stage
         ,table=pcsdsk
         ,tablelabel=HP Perf Agent Disk Stage Table
         ,type=SMP
        );
The following example loads the PCSDSK table (labeled HP Perf Agent Disk Stage Table) to the SAS LASR Analytic Server in a distributed SAS Visual Analytics environment:
%RMVALOAD(
          append=N
         ,folder=/Shared Metadata/LASR/ITRM
         ,gridHost=mygrid.subdomain.domain.com  
         ,gridInstallLoc=/opt/TKGrid
         ,lasrLibrary=Visual Analytic LASR
         ,lasrPort=10010
         ,lasrTag=ITRM
         ,metaPass=mypassword
         ,metaServer=mybox.subdomain.domain.com
         ,metaUser=myuserid
         ,signer=mywebserviceURI
         ,sourceLibPath=C:\MyDataMart\HPPerfAgent\HPPerfAgent1\stage
         ,table=pcsdsk
         ,tablelabel=HP Perf Agent Disk Stage Table
         ,type=MPP
        );

%RMVASTOP

%RMVASTOP Overview

%RMVASTOP stops the SAS LASR Analytic Server.
Note: This macro cannot be executed on z/OS or H6I (HP-UX on Itanium).

%RMVASTOP Syntax

%RMVASTOP(

GRIDHOST=grid-host-server
,GRIDINSTALLLOC=grid-install-location
,LASRPORT=lasr-port
<,SIGNER=authorization-web-service-uri>

<,TYPE=VA-environment-type>
);

%RMVASTOP Required Arguments

GRIDHOST=grid-host-server

specifies the domain name of the Grid Host server in TCP/IP format.

GRIDINSTALLLOC=grid-install-location

specifies the location of the SAS High-Performance Analytics components. This parameter is required for a Massive Parallel Processing (MPP) type of environment.

LASRPORT=lasr-port

specifies the port to use in accessing the SAS LASR Analytic Server, in integer format.

%RMVASTOP Options

SIGNER=authorization-web-service-uri

specifies the URI for the LASR authorization web service.

TYPE=SMP | MPP

specifies the type of SAS Visual Analytic environment. The default value for this parameter is SMP.

  • Specify SMP (that is, Symmetric Multi-Processing) if you are working with a non-distributed SAS Visual Analytic environment.
  • Specify MPP (that is, Massive Multi-Processing) if you are working with a distributed SAS Visual Analytic environment.

%RMVASTOP Example

The following example stops the SAS LASR Analytic Server in a non-distributed SAS Visual Analytics environment:
%RMVASTOP(
          gridHost=mygrid.subdomain.domain.com  
         ,lasrPort=10010
         ,signer=mywebserviceURI
         ,type=SMP
        );
The following example stops the SAS LASR Analytic Server in a distributed SAS Visual Analytics environment:
%RMVASTOP(
          gridHost=mygrid.subdomain.domain.com
         ,gridInstallLoc=/opt/TKGrid
         ,lasrPort=10010
         ,type=MPP
);

%RMVASTRT

%RMVASTRT Overview

Starts the SAS LASR Analytic Server.
Note: This macro cannot be executed on z/OS or H6I (HP-UX on Itanium).

%RMVASTRT Syntax

%RMVASTRT(
,GRIDHOST=grid-host-server
,GRIDINSTALLLOC=grid-install-location
,LASRPORT=lasr-port
,LASRTAG=lasr-tag
,PATH=signature-file-path
,NOCLASS=NOCLASS | [blank]
,NODES=number-of-machines
<,SIGNER=authorization-web-service-uri>
<,TYPE=VA-environment-type>

);

%RMVASTRT Required Arguments

GRIDHOST=grid-host-server

specifies the domain name of the Grid Host server in TCP/IP format.

GRIDINSTALLLOC=grid-install-location

specifies the location of the SAS High-Performance Analytics components. This parameter is required for a Massive Parallel Processing (MPP) type of environment.

LASRPORT=lasr-port

specifies the port to use in accessing the SAS LASR Analytic Server, in integer format.

LASRTAG=lasr-tag

specifies the tag to use for accessing the SAS LASR Analytic server.

PATH=signature-file-path

specifies the directory to use for storing the server and table signature files.

SIGNER=authorization-web-service-uri

specifies the URI for the SAS LASR authorization web service.

%RMVASTRT Options

NOCLASS=NOCLASS | [blank]

specifies that all character variables are not treated implicitly as classification variables. The default value for this parameter is NOCLASS.

Note: Specify NOCLASS in order to use the append data set that was specified in the %RMVALOAD macro.

NODES=ALL | number-of-machines

specifies the number of machines in the cluster. The default value for this parameter is ALL, which calculates the number automatically.

TYPE=SMP | MPP

specifies the type of SAS Visual Analytics environment. The default value for this parameter is SMP.

  • Specify SMP (that is, Symmetric Multi-Processing) if you are working with a non-distributed SAS Visual Analytics environment.
  • Specify MPP (that is, Massive Multi-Processing) if you are working with a distributed SAS Visual Analytics environment.

%RMVASTRT Example

The following example starts the SAS LASR Analytic Server in a non-distributed SAS Visual Analytics environment:
%RMVASTRT(
          gridHost=mygrid.subdomain.domain.com  
         ,lasrPort=10010
         ,lasrtag=ITRM
         ,path=C:\Temp
         ,signer=mywebserviceURI
         ,type=SMP
        );
The following example starts the SAS LASR Analytic Server in a distributed SAS Visual Analytics environment:
%RMVASTRT(
          gridHost=mygrid.subdomain.domain.com
         ,gridInstallLoc=/opt/TKGrid
         ,lasrPort=10010
         ,lasrtag=ITRM
         ,nodes=ALL
         ,path=/tmp
         ,type=MPP
        );

%RMVATBL

%RMVATBL Overview

%RMVATBL registers a LASR table in the SAS Metadata Repository.
Note: This macro cannot be executed on z/OS or H6I (HP-UX on Itanium).

%RMVATBL Syntax

%RMVATBL(

FOLDER=folder-path
,LASRLIBRARY=lasr-library-name
,METAPASS=user-password
,METASERVERname-of-metadata-server
,METAUSER=user-ID
,TABLE=table-name
<,METAPORT=metadata-server-port>
<,METAREPOSITORY=name-of-metadata-repository>
);

%RMVATBL Required Arguments

FOLDER=folder-path

specifies the metadata path for the folder in which to store the LASR table metadata.

LASRLIBRARY=lasr-library-name

specifies the LASR Library name to use in accessing the SAS LASR Analytic Server.

METAPASS=user-password

specifies the password to use in authenticating the user ID to the metadata server. Do not enclose the value for this parameter in quotation marks.

You can use the PWENCODE form of the password. For more information about the PWENCODE procedure, see the Base SAS Procedures Guide.
Tip
If you use the PWENCODE form of the password, be sure to handle embedded braces ({}) carefully. Do not confuse them with square brackets ([]).

METASERVER=name-of-metadata-server

specifies the domain name of the metadata server in TCP/IP format. Do not enclose the value for this parameter in quotation marks.

METAUSER=user-ID

specifies the user ID to use in accessing the metadata server. Do not enclose the value for this parameter in quotation marks.

TABLE=table-name

specifies the table name to load to the SAS LASR Analytic Server.

%RMVATBL Options

METAPORT=metadata-server-port

specifies the port to use in accessing the metadata server, in integer format. The default value for this parameter is 8561. Do not enclose the value for this parameter in quotation marks.

METAREPOSITORY=name-of-metadata-repository

specifies the name of the repository in which to look for the specified job. The default value for this parameter is Foundation. Do not enclose the value for this parameter in quotation marks.

%RMVATBL Example

The following example registers the LASR table called PCSDSK in the SAS Metadata Repository:
%RMVATBL(
          folder=/Shared Metadata/LASR/ITRM  
         ,lasrLibrary=Visual Analytic LASR
         ,metaPass=mypassword
         ,metaServer=mybox.subdomain.domain.com
         ,metaUser=myuserid
         ,table=pcsdsk
        );

%RMVAUNLD

%RMVAUNLD Overview

%RMVAUNLD unloads LASR tables from memory.
Note: This macro cannot be executed on z/OS or H6I (HP-UX on Itanium).

%RMVAUNLD Syntax

%RMVAUNLD(
FOLDER=folder-path
,GRIDHOST=grid-host-server
,GRIDINSTALLLOC=grid-install-location
,LASRLIBRARY=lasr-library-name
,LASRPORT=lasr-port
,LASRTAG=lasr-tag
,METAPASS=user-password
,METASERVER=name-of-metadata-server
,METAUSER=user-ID
,TABLES=table-name1 <...table-nameN>
<,METAPORT=metadata-server-port>
<,METAREPOSITORY=name-of-metadata-repository>
<,SIGNER=authorization-web-service-uri>
<,TYPE=VA-environment-type>

);

%RMVAUNLD Required Arguments

FOLDER=folder-path

specifies the metadata path for the folder in which to store the LASR table metadata.

GRIDHOST=grid-host-server

specifies the domain name of the Grid Host server in TCP/IP format.

GRIDINSTALLLOC=grid-install-location

specifies the location of the SAS High-Performance Analytics components. This parameter is required for a Massive Parallel Processing (MPP) type of environment.

LASRLIBRARY=lasr-library-name

specifies the LASR Library name to use in accessing the SAS LASR Analytic Server.

LASRPORT=lasr-port

specifies the port to use in accessing the SAS LASR Analytic Server, in integer format.

LASRTAG=lasr-tag

specifies the tag to use for accessing the SAS LASR Analytic server.

METAPASS=user-password

specifies the password to use in authenticating the user ID to the metadata server. Do not enclose the value for this parameter in quotation marks.

You can use the PWENCODE form of the password. For more information about the PWENCODE procedure, see the Base SAS Procedures Guide.
Tip
If you use the PWENCODE form of the password, be sure to handle embedded braces ({}) carefully. Do not confuse them with square brackets ([]).

METASERVER=name-of-metadata-server

specifies the domain name of the metadata server in TCP/IP format. Do not enclose the value for this parameter in quotation marks.

METAUSER=user-ID

specifies the user ID to use in accessing the metadata server. Do not enclose the value for this parameter in quotation marks.

TABLES=table-name1<...table-nameN>

specifies the table names to load to the SAS LASR Analytic Server.

Note: One or multiple tables can be unloaded from the SAS LASR Analytic Server.

%RMVAUNLD Options

METAPORT=metadata-server-port

specifies the port to use in accessing the metadata server, in integer format. The default value for this parameter is 8561. Do not enclose the value for this parameter in quotation marks.

METAREPOSITORY=name-of-metadata-repository

specifies the name of the repository in which to look for the specified job. The default value for this parameter is Foundation. Do not enclose the value for this parameter in quotation marks.

SIGNER=authorization-web-service-uri

specifies the URI for the SAS LASR authorization web service.

TYPE=SMP | MPP

specifies the type of SAS Visual Analytics environment. The default value for this parameter is SMP.

  • Specify SMP (that is, Symmetric Multi-Processing) if you are working with a non-distributed SAS Visual Analytics environment.
  • Specify MPP (that is, Massive Multi-Processing) if you are working with a distributed SAS Visual Analytics environment.

%RMVAUNLD Example

The following example unloads the PCSDSK and PCSCPU tables from the SAS LASR Analytic Server in a non-distributed SAS Visual Analytics environment:
%RMVAUNLD(
          folder=/Shared Metadata/LASR/ITRM
         ,gridHost=mygrid.subdomain.domain.com  
         ,lasrLibrary=Visual Analytic LASR
         ,lasrPort=10010
         ,lasrTag=ITRM
         ,metaPass=mypassword
         ,metaServer=mybox.subdomain.domain.com
         ,metaUser=myuserid
         ,signer=mywebserviceURI
         ,tables=pcsdsk pcscpu
         ,type=SMP
        );
The following example unloads the PCSDSK and PCSCPU tables from the SAS LASR Analytic Server in a distributed SAS Visual Analytics environment:
%RMVAUNLD(
          folder=/Shared Metadata/LASR/ITRM
         ,gridHost=mygrid.subdomain.domain.com
         ,gridInstallLoc=/opt/TKGrid
         ,lasrLibrary=Visual Analytic LASR
         ,lasrPort=10010
         ,lasrTag=ITRM
         ,metaPass=mypassword
         ,metaServer=mybox.subdomain.domain.com
         ,metaUser=myuserid
         ,tables=pcsdsk pcscpu
         ,type=MPP
);