JSL Syntax Reference • JSL Messages • SAS Integration Messages • Stored Processes

For the latest version of JMP Help, visit JMP.com/help.

Previous
 • 
Next
Stored Processes
stp<<Begin Run(<named arguments>)
Function
Start this stored process executing in the background. This message is paired with End Run, which should also be called at some point after Begin Run to wait for the stored process to complete.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
Same as Run, except AutoOpenResults and NoAlerts are not supported. They are available on EndRun.
AutoResume(<"filename">)
Optional, quoted string. If specified with no argument, it specifies that the stored process results should be auto-opened when the stored process completes. If filename is specified, filename is opened rather than all results of the stored process being auto-opened.
AutoResumeScript("script")
Optional, quoted string that specifies that after stored process execution completes, script should be evaluated. If the script is a function taking at least one argument, the function is evaluated with the scriptable stored process object passed as the first (and only) argument. AutoResume and AutoResumeScript are mutually exclusive.
stp<<Delete Results(<named arguments>)
Function
Delete all results from the execution of this stored process.
Returns
1 if deletion is successful, 0 otherwise (error message to JMP log).
Arguments
NoAlerts(0|1)
Optional, Boolean. If True, the user is not prompted for confirmation before the attempt is made to delete results.
DeleteDirectory(0|1)
Optional, Boolean. If true, deletes the directory containing the stored process results along with the result files themselves. The default value is true.
stp<<Edit Param Values()
Function
Opens the stored process window for interactively setting parameter values.
Returns
1 if the user clicks OK to dismiss the window, 0 if the user clicks Cancel.
stp<<End Run(<named arguments>)
Function
Waits a specified amount of time (or forever) for a stored process started with Begin Run to complete. If the stored process is complete, retrieves the results, and opens them.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
AutoOpenResults(0|1)
Optional, Boolean. If True, results are automatically opened if the stored process completes in the time specified by MaxWait. If False, results are not automatically opened, and can be manually opened via the object returned by the Get Results message. Default is True.
MaxWait(milliseconds)
Optional, an integer. Specifies the maximum amount of time in milliseconds to wait for the stored process to complete. If MaxWait is not specified, End Run waits forever for the stored process to complete.
NoAlerts(0|1)
Optional, Boolean. If True, error messages are sent to the JMP log rather than message boxes. The default value is False.
stp<<Get Metadata Id()
Function
Returns the metadata ID of the stored process.
Returns
String.
stp<<Get Metadata Path()
Function
Returns the full metadata path of the stored process.
Returns
String.
Stp<<Get Name()
Function
Returns the name of the stored process.
Returns
String.
stp<<Get Param Enum Labels("name")
Function
Get the enumeration labels for a parameter.
Returns
List of strings.
Arguments
name
Quoted string that contains the name of the parameter whose enumeration labels to retrieve.
stp<<Get Param Enum Values("name")
Function
Get the possible enumerated values for a parameter.
Returns
List of strings.
Arguments
name
Quoted string that contains the name of the parameter whose possible enumerated values to retrieve.
stp<<Get Param Names(<named arguments>)
Function
Get a list of parameter names for this stored process of specific types.
Returns
List of strings.
Arguments
Visible(0|1)
Optional, Boolean. If True, get only visible parameters. If False, get only non-visible parameters. If not specified, get both visible and non-visible parameters.
Modifiable(0|1)
Optional, Boolean. If True, get only modifiable parameters. If False, get only non-modifiable parameters. If not specified, get both modifiable and non-modifiable parameters.
Required(0|1)
Optional, Boolean. If True, get only required parameters. If False, get only non-required parameters. If not specified, get both required and non-required parameters.
Expert(0|1)
Optional, Boolean. If True, get only expert parameters. If False, get only non-expert parameters. If not specified, get both expert and non-expert parameters.
stp<<Get Param Value("name")
Function
Get the current value of the specified parameter.
Returns
String.
Arguments
name
Quoted string that contains the name of the parameter whose value to retrieve.
stp<<Get Results()
Function
Get the results generated by the execution of this stored process as a scriptable object.
Returns
SAS Results scriptable object.
stp<<Get Status()
Function
Get the execution status of the stored process.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
stp<<Get Status Message()
Function
Get the message associated with the failure of the stored process, if any.
Returns
String.
stp<<Reset Param Values()
Function
Reset all parameter values to their metadata-defined default values.
Returns
Void.
stp<<Run(<named arguments>)
Function
Execute this stored process object in the foreground.
Returns
-1 = execution failed.
1 = not started.
2 = running.
3 = canceled.
10 = completed successfully.
11 = completed with errors.
Arguments
AutoOpenResults(0|1)
Optional, Boolean. If True, results are automatically opened when the stored process completes. If False, results are not auto-opened, and can be manually opened via the object returned by the GetResults message. The default value is True.
UserName("username")
Optional, quoted string that contains the user name under which to run the stored process.
Password("password")
Optional, quoted string that contains the password for Username.
AuthDomain("authDomain")
Optional, quoted string that contains the authentication domain of the credentials (username, password) given.
ODSDest("dest")
Optional, quoted string that contains an ODS destination (HTML, PDF, tagsets.SASReport12) for any ODS-generated results from the stored process. This requires the stored process SAS code to call %STPBEGIN. The default value is HTML.
GraphicsDevice("device")
Optional, quoted string that contains the SAS graphics device to use when generating graphics in ODS results. This requires the stored process SAS code to call %STPBEGIN. The default value is GIF.
ODSStyle("styleName")
Optional, quoted string that contains an ODS style to apply to the results. This requires the stored process SAS code to call %STPBEGIN. There is no default value.
ODSStyleSheet("cssFile")
Optional, quoted string that contains the full path to a CSS file on the client machine that is to be applied to generated ODS results. This requires the stored process SAS code to call %STPBEGIN. There is no default value.
NoAlerts(0|1)
Optional, Boolean. If True, error messages are sent to the JMP log rather than message boxes. The default value is False.
stp<<Set Param Value("name", "value")
Function
Sets the value of the specified stored process parameter to the specified value.
Returns
1 if successful, 0 otherwise (value can violate the parameter’s constraints).
Arguments
name
Quoted string that contains the name of the parameter whose value to set.
value
Quoted string that contains the value to which to set the parameter.
stp<<Set Results Directory("directory")
Function
Sets the directory on the client machine where stored process results are placed.
Returns
String.
Arguments
directory
Quoted string that contains the full path of the directory where results of the stored process execution should be placed. The directory must exist or be creatable. If the results directory is not set, a temporary location appropriate for the operating system will be used, and that directory can be retrieved from the stored process Results scriptable object after the stored process executes.

Previous
 • 
Next
Help created on 3/19/2020