User Guide - MKS

Chapter 4: Source Integrity Interfaces
Environment
Variables
86
Environment variables are accessed by external programs configured
under the user toolbar buttons. When using these variables, the names
must be in uppercase or Source Integrity will not recognize them. You can
use the environment variables listed in this section.
Window Type Opened Associated Environment Variable
All The environment variable MKSSI_WINDOW is set in all cases.
If there is no active window, or no window, then:
MKSSI_WINDOW=none
If there is an active window, then:
MKSSI_WINDOW=[project|sandbox|projecthistory]
Otherwise, the value is set to a window-specific value:
MKSSI_WINDOW=archive
If the active window is a different window, then:
MKSSI_WINDOW=unknown
For example, a Project Modifications window that does not produce any specific
environment variables:
MKSSI_WINDOW=unknown
Note: For the values none and unknown, no other variables are set.
All known window types set three variables for the server:
MKSSI_HOST
MKSSI_PORT
MKSSI_USER
Because Source Integrity supports multiple connections to the server, you should
specify the following environment variables when running a command line
operation from the toolbar:
si --host=$MKSSI_HOST --port=$MKSSI_PORT
--user=$MKSSI_USER
u s e r g u i d e