SAS Server Objects

JMP Support 800.450.0135 (US)

Documentation Feedback
Your feedback is important to us. us any comments about our documentation.

JSL Syntax Reference • JSL Messages • SAS Integration Messages • SAS Server Objects

•

SAS Server Objects

sasconn<<Assign Libref("libref", "path", engine, engine options)

Assign a SAS libref on this SAS server connection.

See SAS Assign Lib Refs("libref", "path", <"engine">, <"engine options">) in JSL Functions.

sasconn<<Cancel Submit()

Cancels the currently running SAS Submit for this server that is presumably running asynchronously.

1 if a running submit was found and canceled; 0 otherwise.

sasconn<<Clear Log History()

Clears the SAS Log history for this server.

sasconn<<Clear Output History()

Clears the SAS Output history for this server.

sasconn<<Connect(<named arguments>)

Attempt to reconnect a SAS server connection object that has become disconnected.

1 if the connection was successful, 0 otherwise.

Named Arguments

All named arguments are optional.

UserName("name")

A quoted string that contains the user name for the connection.

Password("password")

A quoted string that contains the password for the connection.

Prompt(Always|Never|IfNeeded)

A keyword. Always means always prompt before attempt to connect. Never means never prompt even if the connection attempt fails (just fail with an error message going to the log), and IfNeeded (the default) means prompt if the attempt to connect with the given arguments fails (or is not possible with the information given).

sasconn<<Deassign Libref("libref")

De-assign a SAS libref on this SAS server connection.

Quoted string that contains the library reference.

sasconn<<Disconnect()

Disconnect this SAS server connection.

sasconn<Does Module Exist("moduleName")

Determines whether the specified SAS module exists in the SAS installation represented by the SAS connection. This can be helpful in determining whether certain SAS products are installed. The SAS DATA Step function MODEXIST is used to determine module existence. Because MODEXIST is new for SAS 9.2, this function throws an exception if it is called for a SAS connection that is not version SAS 9.2 or later.

1 if the specified module is found to exist, 0 if it does not exist.

The quoted SAS module, the existence of which should be checked. Do not include any extension.

sasconn<<Export Data(dt, "library", "dataset", <named arguments>)

Exports a JMP data table to the specified SAS data set in the specified library on the active SAS server connection.

1 if the data table was exported successfully; 0 otherwise.

See SAS Export Data(dt, "library", "dataset", <named_arguments>) in JSL Functions.

sasconn<<Get Data Sets("libref")

Returns a list of the data sets defined in a SAS library on this SAS server connection.

List of strings.

Quoted string that contains the SAS libref or friendly library name associated with the library for which the list of defined SAS data sets will be returned.

sasconn<<Get Error Count()

Gets the count of the number of errors encountered in the previous SAS Submit.

sasconn<<Get File("source", "dest")

Download a file from this SAS server connection.

See SAS Get File("source", "dest", "encoding") in JSL Functions.

sasconn<<Get File Names("fileref")

Get a list of filenames found in the given "fileref" on this SAS server connection.

List of strings.

Quoted string that contains the name of fileref from which to retrieve filenames.

sasconn<<Get File Names In Path("path")

Get a list of filenames found in the given "path" on this SAS server connection.

List of strings.

Quoted string that contains the directory path on the server from which to retrieve filenames.

sasconn<<Get File Refs()

Get a list of the currently defined SAS filerefs on this SAS server connection.

List of strings.

sasconn<<Get Librefs(<named arguments>)

Get a list of the currently defined SAS librefs on this SAS server connection.

List of strings.

See SAS Get Lib Refs(<named arguments>) in JSL Functions.

sasconn<<Get Log()

Retrieve the SAS Log from the last SAS Submit from this SAS server connection.

sasconn<<Get Option Name()

Query SAS for the value of a SAS option variable.

The following script iterates through the define variables and prints out the values:

option_names = sasconn << Get Option Names();

For(i=1, i <= N Items(option_names), i++,

	option_value = sasconn << Get Option Value (option_names[i]);

	output = option_names[i] || "=" || char(option_value) || "/!n";

	Write(output);

);

sasconn<<Get Output()

Retrieve the listing output from the last submission of SAS code to this SASServer object.

sasconn<<Get Results()

Retrieve the results of the previous SAS Submit as a scriptable object, which allows significant flexibility in what to do with the results.

A SAS Results Scriptable Object.

sasconn<<Get Submit Status()

Gets the current status of a SAS Submit for this server that is presumably running asynchronously.

1 if the submit has not started; 2 if the submit is running; 3 if the submit has been canceled; 10 if the submit has completed successfully; 11 if the submit has completed with errors.

sasconn<<Get Var Info("libref", "dataset", <"password">)

Returns information about the variables the specified SAS data set.

Quoted string that contains the library reference to de-assign.

Quoted string that contains the name of the data set from which to retrieve variable names.

Password("password")

A quoted string that contains the password for the connection.

sasconn<<Get Var Names("libref", "dataset", <named arguments>)

Retrieves the variable names contained in the specified data set on this SAS server connection.

List of strings.

See SAS Get Var Names(string, <"dataset">, <password("password")>) in JSL Functions.

sasconn<<Get Version(<"long">)

Returns the SAS version as a string such as “9.1” or “9.2”.

A string that contains the SAS version.

An optional quoted keyword that specifies to return the long SAS version, which corresponds to the SYSVLONG SAS macro. For example, "9.02.02M0P01152009".

sasconn<<Get Work Folder()

Returns the full path of the folder corresponding to the WORK library for this server.

A string that contains the work folder path.

sasconn<<Import Data("library", "dataset", <named arguments>)

Import a SAS data set from this SAS server connection into a JMP table.

JMP Data Table object.

See SAS Import Data(string, <"dataset">, <named arguments>) in JSL Functions.

sasconn<<Import Query("sqlquery", <named arguments>)

Execute the requested SQL query on this SAS server connection, importing the results into a JMP data table.

JMP data table object.

See SAS Import Query("sqlquery", <named arguments>) in JSL Functions.

sasconn<<Is Connected()

Determine whether this SAS Server object is currently connected to SAS.

1 if sasconn is connect, 0 otherwise.

sasconn<<Is Product Available("productName")

Determine whether the quoted SAS product is both licensed and installed in the session represented by the SAS connection. The SAS DATA Step functions SYSPROD and MODEXIST are used to determine the licensed and installed status of the product.

1 if the specified product is licensed, 0 if the product is not licensed, or -1 if the specified product is not recognized by SAS. This function throws an exception if the requested product is not one for which JMP knows how to check the installed status.

The quoted SAS product for which licensing should be checked. The product name can be specified with or without the “SAS/” prefix.

The MODEXIST function is new in SAS 9.2. For SAS 9.1.3, this function only checks the license, not the installed status. In other words, for SAS 9.1.3, this function operates the same way as Is Product Licensed().

sasconn<<Is Product Licensed("productName")

Determines whether the quoted SAS product is licensed in the session represented by the SAS connection. The SAS DATA Step function SYSPROD is used to determine the licensing status of the product.

1 if the specified product is licensed, 0 if the product is not licensed, or -1 if the specified product is not recognized by SAS.

The quoted SAS product for which licensing should be checked. The product name can be specified with or without the “SAS/” prefix.

sasconn<<Kill Session(<n>)

Immediately terminates the SAS connection.

An optional number. The system waits n seconds for a normal shut-down before immediately terminating the SAS connection.

sasconn<<Load Text File("path", <named arguments>)

Download the file specified in "path" from the active SAS server connection and retrieve its contents as a string.

See SAS Load Text File("path") in JSL Functions.

sasconn<<Open Log Window()

Opens (or brings to the front) the SAS Log window for this server.

sasconn<<Open Output Window()

Opens (or brings to the front) the SAS Output window for this server.

sasconn<<Open SAS Results()

Open the results from the previous SAS Submit. Intended to be used with asynchronous SAS submits or the use of the OnSubmitComplete option to SAS Submit to give the JSL author a way to conditionally open the results of a submit.

sasconn<<Open Submit Results()

Opens all the results from the last SAS Submit command.

sasconn<<Send File("source", "dest")

Upload a file to this SAS server connection.

See SAS Send File("source", "dest", "encoding") in JSL Functions.

sasconn<<Submit(sasCode, <named arguments>)

Submit some SAS code to this SAS server connection.

See SAS Submit("sasCode", <named arguments>) in JSL Functions.

sasconn<<Submit File("filename", <named arguments>)

Submit a SAS code file to this SAS server connection.

See SAS Submit File("filename", <named arguments>) in JSL Functions.

•

Help created on 7/12/2018