The ScriptWrapper Utility

• For more information on Active Scripting, see http://msdn.microsoft.com/scripting.
• For more information about the BeanShell implementation of Java, see http://www.beanshell.org.
• For more information about Jython, see http://www.jython.org.

Example ScriptWrappers

#
# This is an example of a simple ScriptWrapper.
# Scripts can be used to perform simple calculations
# or to wrap any COM-enabled application.
#
# @description: example Active Scripting ScriptWrapper
# @author: Phoenix Integration
#

# define variables
variable: side double input lowerBound=0
variable: area double output
variable: volume double output

# anything after the following line is interpreted
# as the script
script:
option explicit

' the run routine is invoked each time the component
' is executed. Code outside subroutines is executed
' when the component is first loaded.
sub run
   area = 6 * side^2
   volume = side^3
end sub

#
# This is an example of a simple Java ScriptWrapper.
#
# @description: example BeanShell ScriptWrapper
# @author: Phoenix Integration
#

# define variables
variable: side double input lowerBound=0
variable: area double output
variable: volume double output

# anything after the following line is interpreted
# as the script
script: language="java"

// the run routine is invoked each time the component
// is executed. Code outside subroutines is executed
// when the component is first loaded.
void run()
{
   area.value = 6 * side.value * side.value;
   volume.value = side.value * side.value * side.value;
}

#
# This is an example of a simple Python ScriptWrapper.
#
# @description: example Python ScriptWrapper
# @author: Phoenix Integration
#

# define variables
variable: side double input lowerBound=0
variable: area double output
variable: volume double output

# anything after the following line is interpreted
# as the script
script: language="python"

# the run routine is invoked each time the component
# is executed. Code outside subroutines is executed
# when the component is first loaded.
def run():
   area.setValue( 6 * side.getValue() * side.getValue() )
   volume.setValue( side.getValue() * side.getValue() * side.getValue() )

Header Section

Variable Declarations

Syntax

variable: <name> <type> <input|output> [default=value]
                                       [description=string][units=value]
                                       [upperBound=value][lowerBound=value]
                                       [enumValues=val1,val2,...,valN]
                                       [enumAliases=val1,val2,...,valN]
                                       [className=value]

Arguments

Options

Example

After a variable has been declared, it is ready for use in the script. Each variable is represented by a variant object. The default property for each variable is it's .value property. This means that you can get and set variables just by accessing the variable. If the variable is an array, the value property is an indexed property meaning that it also requires an index value.

The example below shows how to use several variables from a script. Note that the scripting language displayed is VBScript. Semantics will vary from language to language.

variable: inputs double[] input
variable: average double output

script: language=VBScript

sub run
   dim i
   dim sum
   sum = 0

   for i = 0 to inputs.size-1
      sum = sum + inputs(i)
   next

   average = sum / inputs.size
end sub

Group Declarations

Syntax

setGroup "groupName"

Arguments

Example

The example below shows how to use the SetGroup statement in a script.

setGroup "Inputs"
variable: inputs double[] input
setGroup "Outputs"
variable: average double output
setGroup ""
variable: sum double output

Method Declarations

Syntax

method: methodName ["Full Name"] [downloadInputs]

Arguments

Example

The example below shows how to use the Method statement in a script. The example uses VBScript, the exact semantics of the example would be different for different languages.

variable: inputs double[] input
variable: average double output
method: aMethod "Method Number One"

script: language=VBScript

sub run
   dim i
   dim sum
   sum = 0

   for i = 0 to inputs.size-1
      sum = sum + inputs(i)
   next

   average = sum / inputs.size
end sub

sub aMethod
   MsgBox "aMethod Called"
end sub

The Script

Syntax

script: [language="value"][timeout="value"][timeoutVarName="value"]

Arguments

Options

OptionDescription

Script Methods

Available APIs

• ScriptWrapper VBScript Object API
• Java Object API (When using the Java scripting language or Jython, the entire Java API for Analysis Server is available)
• wrapper object
• types
• File Parsing API
  
• Python Object Library
  

File Parsing API

nD Arrays

Arrays in ScriptWrapper are handled through special variable classes which represent the array. These arrays are named after the base type of data that they hold, such as PHXDoubleArray. The array classes automatically handle arrays with any number of dimensions. By default arrays are "auto resizable", which means that if you have an array that is an input to your ScriptWrapper, the client can change the number of dimensions or length of the array at will. Ideally your ScriptWrapper should check the number of dimensions and length of the arrays before trying to use the input array.

Equally, your may change the size of your output arrays at any time by using the "setDimensions" method.

See the API documentation above for the language of your choice for more information on using the array classes.

Example ScriptWrappers

Visual Basic

• basic.scriptWrapper - a basic ScriptWrapper
• arrays.scriptWrapper - a ScriptWrapper that uses array variables
• groups.scriptWrapper - a VB ScriptWrapper that creates groups of variables

Java

• javaGroups.scriptWrapper - a Java ScriptWrapper that creates groups of variables
• msd.scriptWrapper - a ScriptWrapper that uses the File Parsing API to wrap an executable
• java2Darrays.scriptWrapper - uses 2D arrays in a variety of ways
• WingGeometry.scriptWrapper - a Java ScriptWrapper example that uses object variables

Python

• pythonGroups.scriptWrapper - a Python ScriptWrapper that creates groups of variables
• msdPython.scriptWrapper - a ScriptWrapper that uses the File Parsing API to wrap an executable
• python2Darrays.scriptWrapper - uses 2D arrays in a variety of ways
• WingGeometryPython.scriptWrapper - a Python ScriptWrapper example that uses object variables

See also Analysis Server