Sys (TestOptimal 6.0.24 API)

java.lang.Object
- com.testoptimal.mscript.Sys

```
public class Sys
extends Object
```
Provides system functions for MScript.

Constructor Summary

Constructors
Constructor and Description

Sys(MbtScriptExecutor scriptExec_p)
INTERNAL USE ONLY

Constructors
Constructor and Description
`Sys(MbtScriptExecutor scriptExec_p)` INTERNAL USE ONLY

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort(String msg_p)` raises Exception to cause the MBT execution to abort.
`void`	`activateState(String stateID_p)` activates a specific state in the current model resulting in all transitions originating from the specified state to be dispatched for immediate execution.
`MCase`	`addMCase(String mcaseName_p)` Adds a new mcase and returns the MCase created that can be used to add navigation actions.
`Page`	`addPage(String pageName_p)` adds an UI page.
`void`	`addReqFailed(String tag_p, String msg_p)` adds a failed requirement check/validation message to the requirement stat.
`void`	`addReqFailed(String tag_p, String msg_p, String assertID_p)` adds a failed requirement check/validation message to the requirement stat.
`void`	`addReqPassed(String tag_p, String msg_p)` adds a successful requirement check/validation message to the requirement stat.
`void`	`addReqPassed(String tag_p, String msg_p, String assertID_p)` adds a successful requirement check/validation message to the requirement stat.
`int`	`addTestOutput(String text_p)` adds a line to the test output buffer to be written out to file at the end of the execution with call to $SYS.saveTestOutput(...)
`void`	`assertFalse(String tag_p, boolean condition_p, String failMsg_p)` performs the assert on the condition passed in to be false.
`void`	`assertFalse(String tag_p, boolean condition_p, String failMsg_p, String assertID_p)` performs the assert on the condition passed in to be false.
`void`	`assertTrue(String tag_p, boolean condition_p, String failMsg_p)` performs the assert on the condition passed in to be true.
`void`	`assertTrue(String tag_p, boolean condition_p, String failMsg_p, String assertID_p)` performs the assert on the condition passed in to be true.
`StateNode`	`findState(String stateID_p)` returns the state node.
`TransitionNode`	`findTransition(String stateID_p, String transID_p)` returns the transition node.
`String`	`genMSC(String chartLabel_p, String fileName_p)` generate Message Sequence Chart (MSC) from the home/start state to the current state.
`String`	`genMSC(String chartLabel_p, String fileName_p, String skinName_p)` generate Message Sequence Chart (MSC) from the home/start state to the current state.
`String`	`genMSC(String chartLabel_p, String fileName_p, String skinName_p, String bkgColor_p)` generate Message Sequence Chart (MSC) from the home/start state to the current state.
`String`	`genPath(String fileName_p)` generate traversal graph from home/start state to the current state.
`DataSet`	`getCurDataSet()` returns the data set assigned to the current state / transition.
`StateNode`	`getCurState()` returns current state object
`TransitionNode`	`getCurTrans()` returns current transition
`String`	`getCurTravUID()` returns the UID of current traversal which can be either a transition or a state.
`Object`	`getData(String fieldName_p)` returns the the data for the field name specified from the dataset assigned to the current state / transition.
`DataMgr`	`getDataMgr()` returns DataMgr which manages all data sets created/registered for the model execution.
`DataSet`	`getDataSet(String dsName_p)` returns the data set that has been created and registered to the model execution.
`String`	`getEnvVar(String varName_p)` Returns the value (String) for the environment variable (global variable in current server).
`ExecutionDirector`	`getExecDir()` returns execution director object of current model execution.
`MCaseMgr`	`getMCaseMgr()` returns MCaseMgr which manages all MCases created/registered for the model execution.
`String`	`getModelAbsolutePath()` returns absolute file path to the model folder
`ScxmlNode`	`getModelObj()` returns model object.
`String`	`getModelRelativePath()` returns relative file path to the model folder
`PageMgr`	`getPageMgr()` returns PageMgr which manages all page objects created/registered for the model execution.
`String`	`getPathName()` set current test path name.
`ModelExecDB`	`getStats()` returns the model execution stats collection object.
`int`	`getThreadID()` returns current virtual user (thread) id.
`Map<String,Object>`	`getVars()` returns all user variables.
`boolean`	`isModelRunning(String modelName_p)` returns true if the model specified is also running in the same server.
`boolean`	`isSubModel()` if the current model is a sub model.
`void`	`log(String msg_p)` logs a message to MScript log
`Page`	`page(String pageName_p)` returns page object for the page name specified.
`Map<String,Map<String,Object>>`	`readIndexMap(String filePath_p, String indexColName_p)` reads a tab delimited file from model's report folder and index it on the specified column for quick access.
`List<Map<String,Object>>`	`readTSV(String filePath_p)` reads a tab delimited file from model's dataset folder.
`String`	`saveTestOutput(String fileName_p)` saves the test output accumulated during model execution to a file.
`boolean`	`setAsyncTransThreadPoolSize(int threadPoolSize_p)` overrides the default AsyncTransThreadPoolSize setting from config.properties.
`boolean`	`setCurTransSatisfyingHint(String hint_p)` change the current transition's satisfying hint at runtime.
`void`	`setEnvVar(String varName_p, String toValue_p)` Set environment variable to the specified value - String only.
`void`	`setMaxAsyncTrans(int maxSize_p)` overrides the default MaxAsyncTrans setting from config.properties.
`void`	`setPathName(String name_p)` returns current test path name.
`boolean`	`setSeed(String seed_p)` initialize random number generator used by the sequencer to the specific seed.
`boolean`	`setTransGuardHint(String hint_p)` change the current transition's guard hint at runtime.
`String`	`trace()` returns the trace in a string of the traversals separated by comma leading up to the current state/transition.
`String`	`trace(int maxTraceCount_p, String delimiter_p)` returns the trace in a string of last maxLogCount_p traversals leading up to the current state/transition.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Sys
```
public Sys(MbtScriptExecutor scriptExec_p)
```
    INTERNAL USE ONLY
    
    Parameters:
    
    scriptExec_p -
- Method Detail
  - log
```
public void log(String msg_p)
```
    logs a message to MScript log
    
    Parameters:
    
    msg_p -
  - abort
```
public void abort(String msg_p)
           throws Exception
```
    raises Exception to cause the MBT execution to abort.
    Can be used anywhere in mScript. It will trigger Error if one is declared.
    
    This function is ignored when running the model in debug mode and AUT is disabled. The reason for this behavior is to allow users to continue to debug MScript error. Instead of abort the execution, it will just display an abort alert message indicating where the abort was triggered.
    
    Example: $sys.abort('Fatal error detected')
    
    Throws:
    
    Exception
  - isModelRunning
```
public boolean isModelRunning(String modelName_p)
```
    returns true if the model specified is also running in the same server. Example:
```
 $SYS.isModelRunning('model2')
 
```
    Parameters:
    
    modelName_p - name of the model
    
    Returns:
    
    true or false
  - trace
```
public String trace()
             throws Exception
```
    returns the trace in a string of the traversals separated by comma leading up to the current state/transition.
    Example: place in MBT_FAIL or MBT_ERROR triggers to print out the test sequence transitions that led to the current state/transition where the error/failure occurred.
    
    Example:
```
 $SYS.trace()
 
```
    Returns:
    
    String, example output as follows 'transName:transUID'.
    ContinueShopping:U101,AddItem:U112
    
    Throws:
    
    Exception
  - trace
```
public String trace(int maxTraceCount_p,
                    String delimiter_p)
             throws Exception
```
    returns the trace in a string of last maxLogCount_p traversals leading up to the current state/transition. Trace sequence is separated by the specified delimiter.
    Example: place in MBT_FAIL or MBT_ERROR triggers to print out the test sequence transitions that led to the current state/transition where the error/failure occurred.
```
 $SYS.trace(5,'|')
 
```
    Parameters:
    
    maxTraceCount_p - max number of traversals
    
    delimiter_p - delimiter to be used to separate the traversals.
    
    Returns:
    
    String, example output as follows 'transName:transUID'.
    ContinueShopping:U101|AddItem:U112
    
    Throws:
    
    Exception
  - genPath
```
public String genPath(String fileName_p)
               throws Exception
```
    generate traversal graph from home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test path that corresponds to a test case/scenario.
    CAUTION: this function is not thread-safe, i.e. if you are running multiple concurrent threads, the behavior may be un-predictable - it may contain traversals from other threads concurrently running.
    
    Parameters:
    
    fileName_p - name of the image file without extension. You may include "." in the file name, but the system will always add file extension that matches the image even if you have supplied the right extension.
    
    Returns:
    
    file name to the image generated and stored in the report folder of the model.
    
    Throws:
    
    Exception
  - genMSC
```
public String genMSC(String chartLabel_p,
                     String fileName_p)
              throws Exception
```
    generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test sequence that corresponds to a test case / scenario.
    CAUTION: this function is not thread-safe, i.e. if you are running multiple concurrent threads, the behavior may be un-predictable - it may contain traversals from other threads concurrently running.
    
    Parameters:
    
    fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
    
    Returns:
    
    file name to the image generated and stored in the report folder of the model.
    
    Throws:
    
    Exception
  - genMSC
```
public String genMSC(String chartLabel_p,
                     String fileName_p,
                     String skinName_p)
              throws Exception
```
    generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's onentry trigger to generate a test sequence that corresponds to a test case / scenario.
    CAUTION: this function is not thread-safe, i.e. if you are running multiple concurrent threads, the behavior may be un-predictable - it may contain traversals from other threads concurrently running.
    
    Parameters:
    
    fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
    
    skinName_p - name of the skin (Rose or BlueModern) to style the MSC.
    
    Returns:
    
    file name to the image generated and stored in the report folder of the model.
    
    Throws:
    
    Exception
  - genMSC
```
public String genMSC(String chartLabel_p,
                     String fileName_p,
                     String skinName_p,
                     String bkgColor_p)
              throws Exception
```
    generate Message Sequence Chart (MSC) from the home/start state to the current state. Typically you would call this function in the final state's trigger to generate a test sequence that corresponds to a test case / scenario.
    CAUTION: this function is not thread-safe, i.e. if you are running multiple concurrent threads, the behavior may be un-predictable - it may contain traversals from other threads concurrently running.
    
    Parameters:
    
    fileName_p - name of the image file without extension. You may include "." in the file name, but the system will add file extension that matches the image even if you have supplied the right extension.
    
    skinName_p - name of the skin (Rose or BlueModern) to style the MSC.
    
    bkgColor_p - background color to be used for MSC, use HTML color code
    
    Returns:
    
    file name to the image generated and stored in the report folder of the model.
    
    Throws:
    
    Exception
  - setTransGuardHint
```
public boolean setTransGuardHint(String hint_p)
```
    change the current transition's guard hint at runtime. The guard hint and satisfying hint work together. A transition with the matching satisfying hint will satisfy the guard of the transition with the guard hint when traversed.
    Guard hint is a code (or codes separated by comma).
    Example:
```
 $SYS.setCurTransGuardHint('Login')
 
```
    The above example sets the guard hint on the current transition to Login. When traversing this transition but the guard fails, the sequencer will attempt to find the transitions with the satisfying hint that matches the guard hint.
    
    The assumption is that when the transition with the matching satisfying hint is traversed, it will make the guard condition to true and this this transition can be traverse next.
    
    Can not be used in Debug Expression
    Parameters:
    
    hint_p -
  - setCurTransSatisfyingHint
```
public boolean setCurTransSatisfyingHint(String hint_p)
```
    change the current transition's satisfying hint at runtime. The guard hint and satisfying hint work together. A transition with the matching satisfying hint will satisfy the guard of the transition with guard hint when traversed.
    Must be executing a transition.
    
    Satisfying hint is a code (or codes separated by comma).
    Example:
```
 $SYS.setCurTransSatisfyingHint('Login')
 
```
    The above example sets the satisfying hint on the current transition to Login.
    
    Can not be used in Debug Expression
    Parameters:
    
    hint_p -
    
    Returns:
    
    true if successfully set, false if not currently executing a transition
  - findState
```
public StateNode findState(String stateID_p)
```
    returns the state node.
    
    Parameters:
    
    stateID_p - state id or state uid
  - findTransition
```
public TransitionNode findTransition(String stateID_p,
                                     String transID_p)
```
    returns the transition node.
    
    Parameters:
    
    stateID_p - state id or uid
    
    transID_p - transition id only
  - setSeed
```
public boolean setSeed(String seed_p)
```
    initialize random number generator used by the sequencer to the specific seed. By default system uses the default seed for the random number generator. Changing the random number generator seed will affect the actual test sequence generated while maintaining the same test coverage of the model. At times you may wish to try different seed just to get a different variation from the test sequence generated with the default seed.
    This function is usually called in the MBT_start trigger. However you may call it anywhere in MScript.
    
    Parameters:
    
    seed_p -
  - getEnvVar
```
public String getEnvVar(String varName_p)
                 throws MBTException
```
    Returns the value (String) for the environment variable (global variable in current server). Initial values can be set in config.properties file as "ENV.varName=value".
    Example:
```
 $SYS.getEnvVar('var1')
 
```
    Parameters:
    
    varName_p - name of the variable.
    
    Throws:
    
    MBTException
  - setEnvVar
```
public void setEnvVar(String varName_p,
                      String toValue_p)
               throws Exception
```
    Set environment variable to the specified value - String only. The environment variables are configured/initialized from config.properties file and any updates by the model scripts will be saved into config.properties file, as ENV.varName=value. Example:
```
 $SYS.setEnvVar('myVar','123')
 
```
    Parameters:
    
    varName_p - variable name
    
    toValue_p - new value
    
    Throws:
    
    Exception
  - getExecDir
```
public ExecutionDirector getExecDir()
```
    returns execution director object of current model execution. Execution director object has methods to obtain execution setting object and virtual user (VU, threads) execution information.
    
    Returns:
  - assertTrue
```
public void assertTrue(String tag_p,
                       boolean condition_p,
                       String failMsg_p)
                throws Exception
```
    performs the assert on the condition passed in to be true. If check is successful, add positive check on the requirement tag, else add a negative check on the requirement tag with the failMsg_p passed in.
    
    Parameters:
    
    tag_p - one single tag id
    
    condition_p - boolean condition
    
    failMsg_p - message to be added to this check if condition_p is false.
    
    Throws:
    
    Exception
  - assertTrue
```
public void assertTrue(String tag_p,
                       boolean condition_p,
                       String failMsg_p,
                       String assertID_p)
                throws Exception
```
    performs the assert on the condition passed in to be true. If check is successful, add positive check on the requirement tag, else add a negative check on the requirement tag with the failMsg_p passed in.
    
    Parameters:
    
    tag_p - one single tag id
    
    condition_p - boolean condition
    
    failMsg_p - message to be added to this check if condition_p is false
    
    assertID_p - user assigned unique id for this specific call, this is usually used to find the same defect in the defect system from previous runs.
    
    Throws:
    
    Exception
  - assertFalse
```
public void assertFalse(String tag_p,
                        boolean condition_p,
                        String failMsg_p)
                 throws Exception
```
    performs the assert on the condition passed in to be false. If check is successful, add positive check on the requirement tag, else add a negative check on the requirement tag with the failMsg_p passed in.
    
    Parameters:
    
    tag_p - one single tag id
    
    condition_p - boolean condition
    
    failMsg_p - message to be added to this check if condition_p is true.
    
    Throws:
    
    Exception
  - assertFalse
```
public void assertFalse(String tag_p,
                        boolean condition_p,
                        String failMsg_p,
                        String assertID_p)
                 throws Exception
```
    performs the assert on the condition passed in to be false. If check is successful, add positive check on the requirement tag, else add a negative check on the requirement tag with the failMsg_p passed in.
    
    Parameters:
    
    tag_p - one single tag id
    
    condition_p - boolean condition
    
    failMsg_p - message to be added to this check if condition_p is true
    
    assertID_p - user assigned unique id for this specific call, this is usually used to find the same defect in the defect system from previous runs.
    
    Throws:
    
    Exception
  - addReqPassed
```
public void addReqPassed(String tag_p,
                         String msg_p)
                  throws Exception
```
    adds a successful requirement check/validation message to the requirement stat. A requirement may undergo several checks/validations per traversal of the state/transition.
    
    Parameters:
    
    tag_p - one single tag id
    
    msg_p - message to be added to this check.
    
    Throws:
    
    Exception
  - addReqPassed
```
public void addReqPassed(String tag_p,
                         String msg_p,
                         String assertID_p)
                  throws Exception
```
    adds a successful requirement check/validation message to the requirement stat. A requirement may undergo several checks/validations per traversal of the state/transition.
    
    Parameters:
    
    tag_p - one single tag id
    
    msg_p - message to be added to this check.
    
    assertID_p - user assigned unique id for this specific call, this is usually used to find the same defect in the defect system from previous runs.
    
    Throws:
    
    Exception
  - addReqFailed
```
public void addReqFailed(String tag_p,
                         String msg_p)
                  throws Exception
```
    adds a failed requirement check/validation message to the requirement stat. A requirement may undergo many checks/validations per traversal of the state/transition with some passed and some failed. Call this method for each failed check and call $sys.addReqPassed () for each successful check.
    
    Parameters:
    
    tag_p - one single tag id
    
    msg_p - message to be added to this check.
    
    Throws:
    
    Exception
  - addReqFailed
```
public void addReqFailed(String tag_p,
                         String msg_p,
                         String assertID_p)
                  throws Exception
```
    adds a failed requirement check/validation message to the requirement stat. A requirement may undergo many checks/validations per traversal of the state/transition with some passed and some failed. Call this method for each failed check and call $sys.addReqPassed () for each successful check. The assertID_p is specified to uniquely identify this failed check in defect system.
    
    Parameters:
    
    tag_p - one single tag id
    
    msg_p - message to be added to this check.
    
    assertID_p - user assigned unique id for this specific call, this is usually used to find the same defect in the defect system from previous runs.
    
    Throws:
    
    Exception
  - addTestOutput
```
public int addTestOutput(String text_p)
                  throws Exception
```
    adds a line to the test output buffer to be written out to file at the end of the execution with call to $SYS.saveTestOutput(...)
    
    Parameters:
    
    text_p -
    
    Returns:
    
    Throws:
    
    Exception
  - saveTestOutput
```
public String saveTestOutput(String fileName_p)
                      throws Exception
```
    saves the test output accumulated during model execution to a file. You may specify just the file name or the absolute file path to save the test output. If there is no test output in the buffer, it just return.
    
    Parameters:
    
    fileName_p -
    
    Returns:
    
    output file absolute path
    
    Throws:
    
    Exception
  - getStats
```
public ModelExecDB getStats()
                     throws Exception
```
    returns the model execution stats collection object.
    
    Returns:
    
    Throws:
    
    Exception
  - getModelObj
```
public ScxmlNode getModelObj()
```
    returns model object. Model object contains state diagram nodes and transitions and model version information.
    
    Returns:
  - getModelRelativePath
```
public String getModelRelativePath()
```
    returns relative file path to the model folder
    
    Returns:
  - getModelAbsolutePath
```
public String getModelAbsolutePath()
```
    returns absolute file path to the model folder
    
    Returns:
  - getThreadID
```
public int getThreadID()
```
    returns current virtual user (thread) id.
    
    Returns:
  - setPathName
```
public void setPathName(String name_p)
```
    returns current test path name.
  - getPathName
```
public String getPathName()
```
    set current test path name.
  - isSubModel
```
public boolean isSubModel()
```
    if the current model is a sub model. Use this function in the sub model to detect if it is being run inside another models.
    
    Returns:
  - getCurState
```
public StateNode getCurState()
```
    returns current state object
    Can not be used in Debug Expression
    
    Returns:
  - getCurTrans
```
public TransitionNode getCurTrans()
```
    returns current transition
    Can not be used in Debug Expression
    
    Returns:
  - getCurTravUID
```
public String getCurTravUID()
```
    returns the UID of current traversal which can be either a transition or a state.
    Can not be used in Debug Expression
    
    Returns:
  - getCurDataSet
```
public DataSet getCurDataSet()
                      throws MBTAbort
```
    returns the data set assigned to the current state / transition.
    Can not be used in Debug Expression
    
    Returns:
    
    DataSet object.
    
    Throws:
    
    MBTAbort
  - getData
```
public Object getData(String fieldName_p)
               throws MBTAbort
```
    returns the the data for the field name specified from the dataset assigned to the current state / transition.
    
    Returns:
    
    field data value.
    
    Throws:
    
    MBTAbort
  - setAsyncTransThreadPoolSize
```
public boolean setAsyncTransThreadPoolSize(int threadPoolSize_p)
```
    overrides the default AsyncTransThreadPoolSize setting from config.properties. AsyncTransThreadPoolSize sets the maximum number of transitions to be allowed to execute at any time. Note more transitions are allowed to be dispatched up to MaxAsyncTrans set in config.propoerties. When there are maximum number of transitions executing, any transitions dispatched will be placed in the queue. MaxAsyncTrans defines the maximum number of transitions allowed in the queue.
    Default value is 5.
    Example: $SYS.setAsyncTransThreadPoolSize(10)
    The above example overrides the maximum number of transitions to be executing at any time to 10.
    
    Parameters:
    
    threadPoolSize_p -
  - setMaxAsyncTrans
```
public void setMaxAsyncTrans(int maxSize_p)
```
    overrides the default MaxAsyncTrans setting from config.properties. MaxAsyncTrans sets the maximum number of transitions allowed to be waiting for execution when there are already maximum number of transitions already executing.
    Default value is 50.
    Example: $SYS.setMaxAsyncTrans(100)
    The above example overrides the maximum number of transitions allowed to wait for execution to 100.
    
    Parameters:
    
    maxSize_p -
  - activateState
```
public void activateState(String stateID_p)
                   throws Exception,
                          MBTAbort
```
    activates a specific state in the current model resulting in all transitions originating from the specified state to be dispatched for immediate execution. Any transitions with guard conditions must have guard conditions evaluated to true in order to participate in this operation.
    This should only be used for Concurrent models
    
    Can not be used in Debug Expression
    
    Throws:
    
    Exception
    
    MBTAbort
  - getDataMgr
```
public DataMgr getDataMgr()
```
    returns DataMgr which manages all data sets created/registered for the model execution.
    
    Returns:
  - getDataSet
```
public DataSet getDataSet(String dsName_p)
                   throws MBTAbort
```
    returns the data set that has been created and registered to the model execution.
    
    Parameters:
    
    dsName_p -
    
    Returns:
    
    Throws:
    
    MBTAbort
  - getPageMgr
```
public PageMgr getPageMgr()
```
    returns PageMgr which manages all page objects created/registered for the model execution.
    
    Returns:
  - page
```
public Page page(String pageName_p)
          throws MBTAbort
```
    returns page object for the page name specified.
    
    Parameters:
    
    pageName_p -
    
    Returns:
    
    Throws:
    
    MBTAbort - if page not found
  - getMCaseMgr
```
public MCaseMgr getMCaseMgr()
```
    returns MCaseMgr which manages all MCases created/registered for the model execution.
    
    Returns:
  - addMCase
```
public MCase addMCase(String mcaseName_p)
               throws MBTAbort
```
    Adds a new mcase and returns the MCase created that can be used to add navigation actions. For example, $SYS.addMCase('test case 1') .navigateToState('state 1') .exeuteTransition('trans 1', { state -> $SYS.log('MCase 1')});
    
    Parameters:
    
    mcaseName_p -
    
    Returns:
    
    Throws:
    
    MBTAbort
  - addPage
```
public Page addPage(String pageName_p)
             throws MBTAbort
```
    adds an UI page.
    
    Parameters:
    
    pageName_p -
    
    Returns:
    
    Page object to be used for chained action calls.
    
    Throws:
    
    MBTAbort
  - readTSV
```
public List<Map<String,Object>> readTSV(String filePath_p)
                                 throws Exception
```
    reads a tab delimited file from model's dataset folder.
    
    Parameters:
    
    filePath_p -
    
    Returns:
    
    List<Map<String, Object>> or null if file does not exist or empty
    
    Throws:
    
    Exception
  - readIndexMap
```
public Map<String,Map<String,Object>> readIndexMap(String filePath_p,
                                                   String indexColName_p)
                                            throws Exception
```
    reads a tab delimited file from model's report folder and index it on the specified column for quick access. You can save the indexed map returned from this function to a user variable. for example: $VAR.uimap = $SYS.readIndexMap ("myUIMap.tsv", "uiid"); You access the data element with: $SYS.log($VAR.uimap.uiid101.col2);
    
    Parameters:
    
    filePath_p -
    
    indexColName_p -
    
    Returns:
    
    Throws:
    
    Exception
  - getVars
```
public Map<String,Object> getVars()
```
    returns all user variables.
    
    Returns:
    
    HashMap of variables

Class Sys

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Sys

Method Detail

log

abort

isModelRunning

trace

trace

genPath

genMSC

genMSC

genMSC

setTransGuardHint

setCurTransSatisfyingHint

findState

findTransition

setSeed

getEnvVar

setEnvVar

getExecDir

assertTrue

assertTrue

assertFalse

assertFalse

addReqPassed

addReqPassed

addReqFailed

addReqFailed

addTestOutput

saveTestOutput

getStats

getModelObj

getModelRelativePath

getModelAbsolutePath

getThreadID

setPathName

getPathName

isSubModel

getCurState

getCurTrans

getCurTravUID

getCurDataSet

getData

setAsyncTransThreadPoolSize

setMaxAsyncTrans

activateState

getDataMgr

getDataSet

getPageMgr

page

getMCaseMgr

addMCase

addPage

readTSV

readIndexMap

getVars