Extension point for defining kit variables.(c) SAP AG 2003-2006. All rights reserved.
Defines a new kit variable.The variable definition.<h2>Xml definition of a variable in a configuration file</h2>
<pre>
<CONFIGURE type="VARIABLES">
? <HEADER>
? <PRAGMA># Pragmas section</PRAGMA>
? <SCRIPT># Code section. Place here functions\variables
which you want to address from within the variable tags
</SCRIPT>
</HEADER>
<VARIABLES>
+ <VARIABLE id="com.sap.mypackage:variableId">
# For complete description of variable
definition see <q ref="core.env:KitVariables!VARIABLE_DEF">VARIABLE_DEF</q>
? <PROPERTIES>
* <propertyName type="[function | ]"/>
# Represents a property of the variable
You can assign the 'type' attribute for
evaluating the value of the property
as a function
</PROPERTIES>
</VARIABLE>
</VARIABLES>
</CONFIGURE>
</pre>
<h2>Example</h2>
<pre>
<CONFIGURE type="VARIABLES">
<VARIABLES>
<VARIABLE id="CacheEnabled">
<PROPERTIES>
<type>bool</type>
<dflt>true</dflt>
<scope>user</scope>
</PROPERTIES>
</VARIABLE>
</VARIABLES>
</CONFIGURE>
</pre>
Gets the value of a specified kit variable.Variable Id.Default value to use in case the variable is empty or undefined.The requested variable value.This method is equivalent to the <q ref="core.lib:Global!GETVAR">GETVAR</q> macro.<q ref="core.lib:Global!GETVAR">GETVAR</q>
Gets the definition of a specified kit variable.Variable Id.The variable definition object.
Gets the table of all variable values.The table of all variables and their values, indexed by Id.Variable id's are stored in uppercase. Use <q ref="core.lib:Basic!UPPER">UPPER</q> macro to convert the variable name to uppercase
before using it the index in the table of variable values.
Removes a specified kit variable.Variable Id.
Resets a specified kit variable to its default value.Variable Id.
Sets the value of a specified kit variable.Variable Id.New variable value (if the value is empty or omitted, the variable will be deleted).This method is equivalent to the <q ref="core.lib:Global!SETVAR">SETVAR</q> macro.<q ref="core.lib:Global!SETVAR">SETVAR</q>
Represents a Storyboard variable definition.The VARIABLE_DEF structure is made of:
<table class="BOTH"><tr><td class="H V">Name </td><td class=H>Type </td><td class=H>Description </td></tr><tr><td class=V>id </td><td>QName </td><td>Variable id - must be prefixed with namespace e.g. com.sap.mypackage:id </td></tr><tr><td class=V>type </td><td>Enum </td><td>Variable type: {str </td><td>int </td><td>float </td><td>bool </td><td>obj </td><td>arr} </td></tr><tr><td class=V>dflt </td><td>Variant </td><td>Default value for the variable </td></tr><tr><td class=V>scope </td><td>Enum </td><td>Variable scope: {user </td><td>system} </td></tr></table>