Marker Of(rowstate) Description
Returns or sets the marker index of a row state.
Marker State(num) Description
Returns a marker state from the num given.
Row State(<n>) Description
Returns the row state changed from the initial condition of the active row or the nth row.
Selected(rowstate) Description
Returns or sets the selected index.
Selected State(num) Description
Returns a selected state from the num given.
Shade State(num) Description
The Shade State function assigns 5 shade levels to a color or hue.
SAS Integration Functions
Current Metadata Connection() Description
Returns the active SAS metadata server connection, if any, as a scriptable object.
Current SAS Connection() Description
Gets the active global SAS server connection, if any, as a scriptable object.
Chapter 2 JSL Functions 165
JSL Syntax Reference SAS Integration Functions
Get SAS Version Preference() Description
Returns the SAS version selected in the SAS Integration page of the Preferences as a string.
Meta Connect(<machine, port>, <authDomain>, <username>, <password>, <named arguments>)
Meta Connect(<Profile(profile name)>, <Password(password)>, <named arguments>)
Meta Connect(<Environment(environment name)>, <named arguments>) Description
Connects to a SAS Metadata Server. If no arguments are specified, an empty connection window appears. If some arguments are specified, a window partially filled in with the argument values appears. If all arguments are specified, the connection is made and no window appears.
Returns
1 if connection is successful, 0 if not.
Arguments
machine Optional: quoted string that contains the DNS name of the machine.
port Required if machine is specified. Quoted string or integer that contains the port on which the metadata server listens.
authDomain Optional: quoted string that contains the authentication domain for the credentials supplied. Not necessary unless username and password are included.
username Optional: quoted string that contains the user name for the connection.
password Optional: quoted string that contains the password for the connection.
Named Arguments
All named arguments are optional.
Profile("profile_name") A quoted string that contains the name of the metadata server connection profile from which connection information should be retrieved.
Environment("environment_name") A quoted string that contains the name of the WIP environment from which connection information should be retrieved.
Password("password") A quoted string that contains the password for the specified profile name.
CheckPreferenceOnly(0|1) If specified, Meta Connect returns the status of the I want to connect to a SAS Metadata Server option in the SAS Integration page of JMP
Preferences. If that box is checked, Meta Connect returns 1; if not, 0.
Repository("string") Takes a quoted string that contains the name of the repository to which to connect.
166 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
ProfileLookup(0|1) If machine and port are specified rather than a profile name, and ProfileLookup is specified, an attempt is made to find a metadata server connection profile with a machine name and port matching those provided. If one is found, other connection information (such as authentication domain, user name, and password) is obtained from that profile.
Prompt(Always|Never|IfNeeded) Takes one of the keywords Always (always prompt before attempting to connect), Never (never prompt, just fail), or IfNeeded (the default;
prompt if connection with the given parameters fails).
SASVersion("<version_number>" <,Strict>) Attempts to change the SAS version preference to the specified value before making the metadata server connection. If the SAS version is already locked to a different version than the one specified, the
SASVersion argument will fail. By default, if the SAS version cannot be set, JMP will try the metadata server connection. However, if you include Strict as the second
parameter, the inability to change the SAS version will be treated as an error, and JSL processing will stop. If you do not include Strict, the SAS version argument is treated as a hint and will set the version preference if it can. JMP will still try to connect if the version cannot be set. The order you put these arguments in can make a difference. The attempt to change the SAS Version is made immediately when that argument is
encountered. That can affect the validity of other arguments, particularly for
MetaConnect. For JMP 11, valid values for SASVersion are “9.1.3”, “9.2”, “9.3”, and “9.4”.
Note: Using the SASVersion argument has the same effect as changing the SAS Server Version on the SAS Integration Preferences page.
Notes
If no arguments are included and if no profile is saved, the Connect to SAS Metadata Server window appears.
Meta Create Profile(profile, <named arguments>) Description
Creates a metadata server connection profile and adds it to the current user’s set of saved metadata server connection profiles.
Returns
1 if profile was successfully created, otherwise 0.
Arguments
profile A quoted string that contains the name of the created profile. If a profile by the given name already exists, MetaCreateProfile fails unless Replace is specified.
Named Arguments
The following named arguments are all optional.
HostName("name") A quoted string that contains the name of the host computer running the SAS Metadata Server that this profile will connect to.
Chapter 2 JSL Functions 167
JSL Syntax Reference SAS Integration Functions
Port(n) The port number (n) that the SAS Metadata Server is listening for connections on.
AuthenticationDomain("domain") | AuthDomain("domain") A quoted string that sets the authentication domain to use for the connection.
Description("desc") | Desc("desc") A quoted string that sets a description for this profile.
Password("password") A quoted string that contains the password to store in this profile.
Replace(0|1) If name matches a profile that already exists, Replace must be specified for the existing profile to be replaced by the one provided. The default value is False (0).
Repository("repository") A quoted string that contains the name of the repository in the SAS Metadata Server that this profile will connect to. This option is valid only for connections to SAS 9.1.3 Metadata Servers.
UserName("username") A quoted string that contains the user name that this profile uses to connect to the SAS Metadata Server.
UseSingleSignOn(0|1) If specified, this profile attempts to use Single Sign-On (currently also known as Integrated Windows Authentication) to connect to the SAS Metadata Server. This option is valid only for connecting to SAS 9.2 or higher Metadata Servers. If UseSingleSignOn is True(1), UserName and Password cannot be specified. The default value is False (0).
Meta Delete Profile(name) Description
Deletes the named metadata server connection profile from the current user’s set of saved metadata server connection profiles
Returns
1 if profile was successfully deleted, otherwise 0.
Argument
name A quoted string that contains the name of the profile to delete.
Meta Disconnect() Description
Disconnect the current SAS Metadata Server connection, if any.
Returns Void.
168 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
Meta Get Repositories() Description
Gets a list of the repositories available on the current SAS Metadata Server connection.
Returns
A list of repository names as strings.
Meta Get Servers() Description
Get a list of the SAS Servers that are registered in the SAS Metadata Repository to which the session is currently connected.
Returns
A list of server names as strings.
Meta Get Stored Process(path) Description
Get a stored process object from the currently connected SAS Metadata Repository.
Returns
Stored Process scriptable object.
Arguments
path Quoted string that is the path to the stored process in metadata, starting at the BIP Tree.
Meta Is Connected() Description
Determines whether a current connection to a SAS Metadata Server exists.
Returns
1 if a connection exists; 0 otherwise.
Arguments None.
Meta Set Repository(repositoryName) Description
Set the SAS Metadata Repository to use for metadata searches.
Returns
1 if setting the repository was successful, 0 otherwise.
Chapter 2 JSL Functions 169
JSL Syntax Reference SAS Integration Functions
Arguments
repositoryName Quoted string that contains the name of the repository to make current.
SAS Assign Lib Refs(libref, path, <engine>, <engine options>) Description
Assign a SAS libref on the active global SAS server connection.
Returns
1 if successful, 0 otherwise.
Arguments
libref Quoted string that contains a library reference (8-character maximum) to assign.
path Quoted string that contains the full path on the SAS server to the library being assigned.
engine Optional, quoted string that contains the engine for the SAS server to use when accessing members of this library.
engine options Optional, quoted string that contains the options needed for the engine being used.
SAS Connect (<machine_name>, <port>, <named_arguments>) Description
Connect to a local, remote, or logical SAS server.
Returns
SAS Server scriptable object.
Arguments
machine_name Optional: quoted string that can contain a physical machine name or the name of a metadata-defined (logical) server. In the first case, the port must be provided.
In the second case, a port must not be provided. If neither name nor port are included, and JMP is running on Windows, a connection to SAS on the local machine (via COM) is attempted, and all named parameters are ignored.
port Optional: quoted string or integer. If name is a physical machine name, this is the port on that machine to connect to. If name is a metadata-defined (logical) server, port must not be included.
Named Arguments
All the 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.
170 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
ReplaceGlobalConnection(0|1) A Boolean. The default value is True. If True, and a successful SAS server connection is made, this connection replaces the active SAS connection that becomes the target of other global SAS JSL function calls. If False, the global SAS connection is not changed, and the returned SASServer scriptable object should be used to send messages to this server connection.
ShowDialog(0|1) A Boolean. The default value is False. If True, other arguments (except ReplaceGlobalConnection) are ignored and the SAS Server Connection window appears. This provides the JSL programmer a way to open the SAS Connect window.
Prompt(Always|Never|IfNeeded) A Keyword. Always means always prompt before attempting to connect. Never means never prompt even if the connection attempt fails (just fail and send an error message to the log), and IfNeeded (the default value) means prompt if the attempt to connect with the given parameters fails (or is not possible with the information given).
ConnectLibraries(0|1) A Boolean. Defaults to the SAS Integration Preference setting governing whether to automatically connect metadata-defined libraries when
connecting to a SAS server. If true, all metadata-defined libraries are connected at SAS server connection time, which can be time-consuming. If false, metadata-defined libraries are not connected. To connect specific libraries later, use the SAS Connect Libref global function or Connect Libref message to a SAS server object.
SASVersion("<version_number>" <,Strict>) Attempts to change the SAS version preference to the specified value before making the metadata server connection. If the SAS version is already locked to a different version than the one specified, the
SASVersion argument will fail. By default, if the SAS version cannot be set, the metadata server connection will still be tried. However, if you include Strict as the second parameter, the inability to change the SAS version will be treated as an error and JSL processing will stop. If you do not include Strict, the SAS version argument is treated as a hint and will set the version preference if it can, but if it cannot it will still try to connect. The order you put these arguments in can make a difference. The attempt to change the SAS Version is made immediately when that argument is encountered.
That can affect the validity of other arguments, particularly for MetaConnect. For JMP 11, valid values for SASVersion are “9.1.3”, “9.2”, “9.3”, and “9.4”. Note: Using the SASVersion argument has the same effect as changing the SAS Server Version on the SAS Integration Preferences page.
SAS Deassign Lib Refs(libref) Description
De-assign a SAS libref on the active global SAS server connection.
Returns
1 if successful; 0 otherwise.
Chapter 2 JSL Functions 171
JSL Syntax Reference SAS Integration Functions
Arguments
libref Quoted string that contains the library reference to de-assign.
SAS Disconnect() Description
Disconnect the active global SAS connection, if any.
Returns
1 if a SAS connection exists and was successfully disconnected, 0 otherwise.
Arguments None.
SAS Export Data(dt, "library", "dataset", <named_arguments>) Description
Exports a JMP data table to a SAS data set in a library on the active global SAS server connection.
Returns
1 if the data table was exported successfully; 0 otherwise.
Arguments
dt data table or a reference to a data table.
"library" the library to which to export the data table.
"dataset" the name of the new SAS data set.
Named Arguments
All the named arguments are optional.
Columns(list)|Columns(col1, col2, ...) A list of columns or a comma-separated list of columns.
Password("password") A string that contains the password to serve as the READ, WRITE, and ALTER password for the exported SAS data set. If the exported data set is replacing an existing data set with an ALTER password, this password is used as the ALTER password for overwriting the data set. If Password is specified, values for ReadPassword, WritePassword, and AlterPassword are ignored.
ReadPassword("password") A string that contains the password to serve as the READ password for the exported SAS data set.
WritePassword("password") A string that contains the password to serve as the WRITE password for the exported SAS data set.
172 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
AlterPassword("password") A string that contains the password to serve as the ALTER password for the exported SAS data set. If the exported data set is replacing an existing data set with an ALTER password, this password is used as the ALTER password for overwriting the data set.
PreserveSASColumnNames(0|1) A Boolean. If true and the JMP data table originally came from SAS, the original SAS column names are used in the exported SAS data set. The default value is False.
PreserveSASFormats(0|1) A Boolean. If true and the JMP data table originally came from SAS, the original SAS formats and informats are applied to the columns in the exported SAS data set. The default value is True.
ReplaceExisting(0|1) A Boolean. If true, an existing SAS data set with the specified name in the specified library is replaced by the exported SAS data set. If false, a data set with the specified name already exists in the specified library; the export is stopped. The default value is false.
SaveJMPMetadata(0|1) Includes SAS 9.4 Extended Attributed to store JMP metadata (such as table script and column properties). Default is 0 (disabled).
HonorExcludedRows(0|1) A Boolean. If true, any rows in the JMP data table that are marked as excluded are not exported. The default value is false.
Note
Information about the export is sent to the log.
SAS Get Data Sets(libref) Description
Returns a list of the data sets defined in a SAS library.
Returns
List of strings.
Arguments
libref Quoted string that contains the SAS libref or friendly library name associated with the library for which the list of defined SAS data sets is returned.
SAS Get File(source, dest, encoding) Description
Get a file from the active global SAS server connection. JMP creates a FILENAME statement (with an encoding, if specified) and uses it to read the file on the SAS server.
Returns
1 if successful, 0 otherwise.
Chapter 2 JSL Functions 173
JSL Syntax Reference SAS Integration Functions
Arguments
source Quoted string that contains the full path of file on the server to be downloaded to the client machine.
dest Quoted string that contains the full path on the client machine for where to put the copy of the file downloaded from the server.
encoding Quoted string that contains the encoding used in the file (for example, “utf-8”).
The server must support the specified encoding.
SAS Get File Names("fileref") Description
Get a list of filenames found in the given fileref on the active global SAS server connection.
Returns
List of strings.
Arguments
"fileref" Quoted string that contains the name of the fileref from which to retrieve filenames.
SAS Get File Names In Path("path") Description
Get a list of filenames found in the given path on the active global SAS server connection.
Returns
List of strings.
Arguments
"path" Quoted string that contains the directory path on the server from which to retrieve filenames.
SAS Get File Refs() Description
Get a list of the currently defined SAS filerefs on the active global SAS server connection.
Returns
List of two lists. The first list is a list of quoted strings of fileref names. The second is a corresponding list of quoted strings of physical names.
SAS Get Lib Refs(<named arguments>) Description
Get a list of the currently defined SAS librefs on the current global SAS server connection.
174 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
Returns
List of strings.
Named Arguments
Friendly Names(0|1) Optional, Boolean. If True, then for any libraries that have friendly names (metadata-defined libraries), the friendly name is returned rather than the 8-character libref.
SAS Get Log() Description
Retrieve the SAS Log from the active global SAS server connection.
Returns A string.
SAS Get Output() Description
Retrieve the listing output from the last submission of SAS code to the current global SAS server connection.
Returns A string.
SAS Get Results() Description
Retrieve the results of the previous SAS Submit as a scriptable object, which allows significant flexibility in what to do with the results.
Returns
A SAS Results Scriptable object.
SAS Get Var Names(string, <dataset>, <password("password")>) Description
Retrieves the variable names contained in the specified data set on the current global SAS server connection.
Returns
List of strings.
Chapter 2 JSL Functions 175
JSL Syntax Reference SAS Integration Functions
Arguments
string A quoted string that contains one of the following:
– The name of the SAS Library containing the SAS data set to be imported. In that case, the dataset name parameter is required.
– The full member name of the SAS data set to be imported, in the form
“libname.membername”.
– The SAS Folders tree path to a logical SAS data table to be imported. This option requires a connection to a SAS 9.2 or higher Metadata Server.
dataset Optional: quoted string that contains the name of the data set from which to retrieve variable names.
password("password") Optional, quoted string that contains the read password for the data set. If this is not provided and the data set has a read password, the user is prompted to enter it.
SAS Import Data(string, <dataset>, <named arguments>) Description
Import a SAS data set from the active global SAS server connection into a JMP table.
Returns
JMP Data Table object.
Arguments
string A quoted string that contains one of the following:
– The name of the SAS Library containing the SAS data set to be imported. In that case, the dataset name parameter is required.
– The full member name of the SAS data set to be imported, in the form
“libname.membername”.
– The SAS Folders tree path to a logical SAS data table to be imported. This option requires a connection to a SAS 9.2 or higher Metadata Server.
dataset Optional: quoted string that contains the name of the data set.
Named Arguments
All named arguments are optional.
Columns(list)|Columns(col1, col2, ...) A quoted string list or multiple strings that contain the names of columns to include in the import.
ConvertCustomFormats(0|1) The default value is True (1). If True and custom formats are found in the SAS data set being imported, an attempt is made to convert the SAS custom formats to JMP value labels for those columns.
176 JSL Functions Chapter 2
SAS Integration Functions JSL Syntax Reference
Invisible(0|1) The default value is False (0). If true, the JMP data table is created as a hidden table. Hidden data tables that never become visible or linked to an analysis
Invisible(0|1) The default value is False (0). If true, the JMP data table is created as a hidden table. Hidden data tables that never become visible or linked to an analysis