Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
mscriptfunc [2019/03/16 18:55]
admin [Plugins & MScript Functions] 		— (current)
Line 1: Line 1:
-=====MScript Functions===== 
- 
-//MScript Functions// are provided by //system// and //plugins//. They are embedded in //MScript// to perform actions including interacting with AUT. 
- 
-There are 5 types of MScript functions: 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/MbtScriptExecutor.html| System Functions]] - functions provided by the system 
-  - [[User Defined Functions]] - functions defined by the user within a model. 
-  - //Plugin Functions// - functions provided by the plugin, only available when the plugin is activated for the model 
-  - //Plugin Driver Functions// - functions provided by the native driver used by the plugin, for example //WebDriver// functions provided through [[selenium_plugin| SeleniumPlugin]] 
-  - //User MScript Functions// - functions provided by a java class written by users to extend MScript capability that can be imported into models 
- 
----- 
-==== Plugins & MScript Functions ==== 
- 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/SeleniumPlugin.html|web plugin functions]] - functions provided by [[selenium_plugin| SeleniumPlugin]]  
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/SeqOutPlugin.html|SeqOut plugin functions]] - functions provided by [[SeqOutPlugin|SeqOut plugin]] 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/RemoteCommandPlugin.html|Remote Command/Trigger Plugin functions]] - functions implemented by [[RemoteCommandPlugin|RemoteCommandPlugin]] and [[RemoteTriggerPlugin|RemoteTriggerPlugin]] plugins. 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/ServicePlugin.html|service plugin function]] - functions provided by [[ServicePlugin|ServicePlugin]] plugin. 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/DataGenPlugin.html|data generation function]] - functions provided by [[DataGenPlugin|DataGenPlugin]] plugin. 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/DataDesignPlugin.html|data design function]] - functions provided by [[DataGenPlugin|DataDesignPlugin]] plugin. 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/ConcurrentPlugin.html|Concurrent function]] - functions supported for concurrent modeling by [[EnterpriseEdition|EnterpriseEdition]] and [[Model Orchestration with LoadPlugin|LoadPlugin]]. 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/LoadPlugin.html|Model Orchestration & Load Modeling function]] - functions to support the orchestration of model executions and load testing by [[Model Orchestration with LoadPlugin|LoadPlugin]] 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/WinUIAPlugin.html|Windows UI App plugin functions]] - functions provided by [[WinUIAPlugin|WinUIAPlugin]] 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/XUIAPlugin.html| XUIA plugin functions]] - functions provided by [[XUIAPlugin|XUIA Plugin]] 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/SikuliPlugin.html| Sikuli plugin functions]] - functions provided by [[SikuliPlugin|Sikuli Plugin]] 
-  - [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/BAPlugin.html| BA plugin functions]] - functions provided by [[BAPlugin|BA Plugin]] 
- 
-With //Selenium, WinUIA, JavaUIA and XUIA// plugins, you may send keyboard function keys through MScript.  For example, [KEYS.ENTER] and [KEYS.TAB].  For more details, see [[Sending Keyboard Keys]]. 
- 
- 
----- 
-==== Calling Functions ==== 
-Except [[User Defined Functions]], functions are called like  
-  <log msg="Calling MyFunc, return value: $myFunc ('p1','p2')"/> 
- 
-The above mscript tag calls the function named //myFunc//, it passes two parameters to the function as required by this specific function and the return value from the function call is then concatenated with //Calling MyFunc, return value: // and printed to the MScript log file. 
- 
-All parameters must be enclosed by a set of single quotes.  
- 
-If the parameter value contains single quotes, those single quotes in the expression value do need to be escaped (prefixed) with "\". For example: 
- 
-      <action code="$click('xpath=id(\'order\')')"/> 
- 
-Notice that the single quotes around "order" are escaped as they are part of the parameter value. 
- 
-=== Function Parameters=== 
-Function can have parameters. Parameter values are passe by position, for example //$myFunc('abc','123')// where //abc// and //123// are parameter values for the function call.   
- 
-Most functions require some parameters while some don't.  If a function does not require parameter, the function call would look like //$myFunc()//. 
- 
-=== Function Return Value === 
-Functions may have return value as the one above or may not have return value. 
- 
-The return value can then be concatenated with other text string to form new text string as shown in the example above.   
- 
-Calling to a function that does not have return value will return an empty string. 
- 
- 
-=== Nested Function Call=== 
-You may nest the function call within the same mscript expression.  For example: 
-  <log msg="Random number is: $rand('0,', '$increment('upBound')')"/> 
- 
-In the above example, function call //$increment('upBound')// is first executed.  Let's assume the user variable //upBound// has the value of //5//, this function call will return //6// which is then used as the second parameter value to call //$rand('0','6')//. As the result, the above example will generate a random number between 0 and //6//. The return value from the //$rand('0','6')// is then concatenated with the static text //Random number is:// and written to mscript log file. 
- 
-There is no limit of how many levels for the nested function calls. 
-   
- 
----- 
-==== User Defined Functions ==== 
-[[User Defined Functions]] are functions define in //Functions// trigger within a model.   
- 
-Within //Functions// trigger, you use //<func>// tag to define the function. For example: 
-  <func name="myFunc"> 
-  ... mscript tags ... 
-  </func> 
- 
-Within the function //myFunc//, you can retrieve the parameters passed to the function by calling mscript function //$getFuncParam('paramName')//. For example: 
-  <func name="myFunc"> 
-      <log msg="Param p1: $getFuncParam('p1')"/> 
-  </func> 
-    
-[[User Defined Functions]] can return a value. To set the return value, call mscript function //$setFuncReturn('retVal')//. For example: 
-  <func name="myFunc"> 
-      <action code="$setFuncReturn('retVal')"/> 
-  </func> 
- 
-User defined functions can be shared with other models with the following MScript: 
-   $requires('userFuncModel'); 
-    
-The above MScript will include all user defined functions from the model called //userFuncModel// and make all user defined functions available to the current model. 
- 
-=== Calling User Defined Functions=== 
-[[User Defined Functions]] are functions define in //Functions// trigger within the model and thus it's model specific. 
-   
-[[User Defined Functions]] can be shared with other models using //$requires('modelName')//.  
- 
-To call [[User Defined Functions]] use the following syntax: 
-   $callFunc('myFunc','p1=v1','p2=v2') 
-where //p1// and //p2// are the parameter names and //v1// and //v2// are the parameter values for the corresponding parameters.  
- 
-[[User Defined Functions]] can return a value. The return value is then concatenated with other static string just like other function calls as described earlier. 
- 
- 
-=== Recursive Call=== 
-[[user_defined_functions|User Definfed Functions]] can recursively call itself.  However, caution must be taken not to cause infinite loop which will result server hang and crash. 
- 
- 
----- 
-==== Plugin Functions ==== 
-//Plugin Functions// are functions provided by the plugins which are specifically designed to interact with different type of AUT. Besides //TestOptimal// provided plugins, you may also create your own [[Custom Plugins | custom plugins]] to provide mscript functions. 
- 
-For example [[selenium_plugin|SeleniumPlugin]] provides a set of functions to allow you to drive web applications as show in the following: 
-   <action code="$click('id=button1')"/> 
-The //$Selenium.click(...)// is a plugin function implemented by [[selenium_plugin|SeleniumPlugin]] when called will click the button on the web page. 
- 
-Please note that //Selenium.// prefix to the function name is optional when the function name is unique. 
- 
----- 
-==== Plugin Native Driver Functions ==== 
-Some plugin uses 3rd party drivers to accomplish specific task, typically to interact with the AUT.  For example [[selenium_plugin|SeleniumPlugin]] uses //WebDriver// to drive the web applications.   
- 
-Each plugin has the option to expose the functions provided by the driver that it uses.  Not all plugins uses 3rd party drivers, neither do all plugins expose functions from the driver. Please refer to the specific plugin documentation page listed above for more information about the native functions exposed by the plugin. 
- 
-To call a native function, you must add a prefix underscore (_) to the native function name as shown in the following example: 
-   <action code="$_nativeFunc1('p1')"/> 
- 
----- 
-==== User MScript Functions ==== 
-//User MScript Functions// are functions that you implement by writing a simple java class. 
- 
-The java class just need to provide the constructor in the following signature: 
-    public MScriptImpl2(MbtScriptExecutor scrfiptExec_p) 
-     
-For each model, you can declare MScriptImpl java class in //MBT_start// trigger using MScript function [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/MbtScriptExecutor.html#addMScriptImpl(java.lang.String)| addMScriptImpl('class path')]] or [[http://testoptimal.com/javaDoc/reference/com/webmbt/plugin/MbtScriptExecutor.html#addMScriptImpl(java.lang.String, java.lang.String) | addMScriptImpl('class path','java source file')]]: 
-    <action code="$addMScriptImpl('com.abc.myClass')"/> 
-    or  
-    <action code="$addMScriptImpl('com.abc.myClass', 'javaFileName.java')"/> 
-     
-The first syntax requires that you have compiled your java class into jar file and deployed it to ''/lib/'' folder.  The second syntax dynamically compiles your java source code automatically when model executes. 
-     
-All of the public functions declared in your java class //MScriptImpl2// can be called with the following syntax: 
-    <action code="$_myMScriptFunc('p1')"/> 
-Notice the prefix of underscore (_) is required before the function name. 
- 
-//User MScript Functions// can return a String value.  The return value is then concatenated with other static text string to form another string. 
- 
----- 
-==== Element Locator & Special Char Encoding ==== 
- 
-If you plan to use xpath to locate the element on HTML page and have trouble finding the correct xpath string, you may want to check out [[WebMBT Builder | WebMBT Builder]] and [[UIRepo | UIRepo]] firefox add-on. 
- 
-In some rare case some special characters may cause problem to the mScript interpreter, in which case they can be encoded them using [[mscript_tokens | mscript tokens]], such as [lt] for "<" and [gt] for ">".