Skip to content

Command Line Options

--desktop

The name of your SAS Analytics Pro Desktop

You can configure and run multiple "desktops" of SAS Analytics Pro. Each desktop is identified by a unique name, specified using the --desktop parameter. If you omit this parameter, the default desktop name is sas-analytics-pro. This feature allows you to maintain different SAS Analytics Pro desktops (e.g. for different projects).

⚠ If you intend on running multiple desktops at the same time you must ensure that all port numbers are unique (e.g. SAS Studio, Jupyter and SSHD).

Example

Create two environments to separate work on two different Clinical Trials: 

desktop_personal --desktop trial-a --configure
desktop_personal --desktop trial-b --configure

--selerity-home

The location to create your configuration files

Selerity Desktop (Personal) stores your settings in configuration files located on your local machine. By default, this location is your home directory. In some scenarios your home directory may not be suitable to store these configuration files (e.g. your network policy prohibits storing files in this location). In this situation you can use the --selerity-home parameter to specify another location.

⚠ The location you specify must already exist.

Example

Use the D:\SAS directory to store your configuration: 

desktop_personal --selerity-home D:\SAS --start

--start

Start SAS Analytics Pro Desktop

Example 
desktop_personal --start

--stop

Stop SAS Analytics Pro Desktop

Example 
desktop_personal --stop

--status

Get the status of your SAS Analytics Pro Desktop

Example 
desktop_personal --status

--configure

Configure (or reconfigure) your SAS Analytics Pro Desktop

You may configure your desktop at any time, but any changes made will only come into effect the next time you start your desktop.

Example 
desktop_personal --configure

--info

Display information about your SAS Analytics Pro Desktop

Information displayed includes:

  • Version of SAS Analytics Pro
  • SAS license
  • Add-Ons enabled
  • Mount paths
  • Docker Volumes
  • Credentials (when desktop is running)
  • Application links
  • Examples
Example 
desktop_personal --info

--latest

Check for latest version of SAS Analytics Pro

Download latest version of SAS Analytics Pro if a newer version is available. This can also be used with the --start option. If you use --latest while your desktop is already running, any newer image downloaded from SAS will be used the next time you start your desktop.

Example
Download new version if available
desktop_personal --latest
Download new version if available, and then start your desktop
desktop_personal --start --latest

--batch <saspgm.sas>

Run a SAS Batch Job

This option allows you to run SAS code in batch through SAS Analytics Pro. Your SAS code must be accessible within your desktop environment, and all file references within your code must also be accessible within your desktop environment. The command line option that points to your program file must be written as seen by your SAS Analytics Pro environment. For example, a SAS program saved as C:\Users\michael\selerity\personal\sas-analytics-pro\data\code\load_data.sas on your local Windows machine would be /data/code/load_data.sas as seen from within the environment.

Warning

Due to limitations within the container environment provided by SAS you cannot use a path or filename containing a space for the batch program.

Example 
desktop_personal --batch /data/code/load_data.sas

--sasoq

Run SAS Operational Qualification Tests

This option may be used by itself to run the standard set of Operational Qualification tests, or you can pass in specific tests to be executed.

Example
Run standard tests
desktop_personal --sasoq
Run just the SAS/GRAPH tests
desktop_personal --sasoq "-outdir /data/sasoq_results -tables *:graph"

--linemode

Run SAS in Interactive Line Mode

This option allows you to enter SAS statements line by line in response to prompts issued by SAS. SAS reads the source statements from the terminal as you enter them.

To exit from this mode, press Ctrl+D, or issue the endsas; statement.

Example 
desktop_personal --linemode

--show_mounts

Display which local directories are available in your desktop

Example 
desktop_personal --show_mounts

--configure-mounts

Configure which local directories are available in your desktop

Because SAS Analytics Pro runs within a container that is isolated from your local machine, files and directories that you want to use need to be "mounted" so they can be used within the container. This option allows you to specify which local directories you want to make available, and where those directories will be available from within the container.

As an example, you may have SAS datasets located in C:\SAS\Population that you want to use in SAS Analytics Pro - so you can tell the system to make those available within the container at a location such as /sasdata/population. This would allow you to issue a LIBNAME statement in SAS Analytics Pro such as LIBNAME POP '/sasdata/population';.

Note

You local fixed (i.e. not network) drives will be automatically mounted within the container under /mnt.

Windows
C Drive = /mnt/c
D Drive = /mnt/d
MacOS and Linux
root (/) = /mnt/host
Example 
desktop_personal --configure_mounts

--show_volumes

Display which Docker Volumes are available in your desktop

Example 
desktop_personal --show_volumes

--configure-volumes

Configure which Docker Volumes are available in your desktop

Volumes are a feature of Docker that allows you to create storage that is not tied to the local directory structure of the machine running Docker. One major benefit of this feature is the ability for you to connect to remote storage locations, such as Windows File Shares, and have the files located there available within your desktop.

As an example, you may a network drive (e.g. T) available on your machine that points to a Windows file share at \\fileserver\share that has files you would like to access within SAS. You can manually create a Docker Volume pointing to this network location and then use this option to connect it to your SAS desktop.

Note

The actual creation of a Docker Volume is outside the scope of this tool and must be done by the user manually in order to then use the --configure-volumes option to connect it to SAS Analytics Pro. While we do provide an example below, this is provided as-is for the user as a starting point while consulting the SAS and Docker documentation links provided.

The official SAS Analytics Pro Documentation has an example of the command needed to be executed manually to create a Docker Volume.

The official Docker Documentation should also be referenced.

Example

The following items are required in order to construct the correct Docker command to create the Docker Volume (which only needs to be done once):

  • File Server Name: \\fileserver
  • File Server's full DNS name: fileserver.corp.com
  • Share Name: share
  • User ID: john
  • Windows Domain for user: corp
  • Name you want to give the Docker Volume: t_drive
docker volume create --driver local --opt type=cifs --opt device=//fileserver/share --opt o=addr=fileserver.corp.com,username=john@corp,password=<MY_PASSWORD>,file_mode=0777,dir_mode=0777 t_drive
desktop_personal --configure_mounts

Notes for docker volume create

  • The traditional Windows \ is changed to / for the command
  • If your password has special characters such as ![]()\ or characters that have special meaning for your shell (e.g. $&* on Linux/Mac) then you must prefix those characters with the escape \ character

--examples

Display code examples for configured add-ons

The following add-ons can provide customised example code:

  • Python
  • SSHD (includes ssh and saspy examples)
Example 
desktop_personal --examples

--version

Show program version

Example 
desktop_personal --version