![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
defineScriptParamCombo name description optionList args | |
Assigns a combo parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamDate name description args | |
Assigns a date parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamEditCombo name description optionList args | |
Assigns an editable combo parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamFileCombo name description args | |
Assigns a file combo parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamGroup controllerParam controlledParamListList | |
Assigns a group parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamList name description optionList args | |
Assigns a list parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamMultiList name description optionList args | |
Assigns a multi list parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamNumber name description args | |
Assigns a number parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamPasswordText name description args | |
Assigns a password text parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamSeparator name description args | |
Adds a separator or headline to a script GUI (for new script format, T4x version >= 10) More... | |
defineScriptParamText name description args | |
Assigns a text parameter to a script (for new script format, T4x version >= 10) More... | |
defineScriptParamTimeDate name description args | |
Assigns a time date parameter to a script (for new script format, T4x version >= 10) More... | |
setScriptCategoryList categoryList | |
Sets a list of categories for a script. More... | |
setScriptComment comment | |
Sets a comment for a script. More... | |
setScriptDesc description | |
Sets a description for a script. More... | |
setScriptDictionary dictionary | |
Sets a dictionary for a script (for new script format, T4x version >= 10) More... | |
setScriptFlavour flavour | |
Sets a flavour for a script. More... | |
setScriptGui paramList | |
Assigns a list of representations of parameters as GUI to a script (for new script format, T4x version >= 10) More... | |
setScriptTagList tagList | |
Sets a list of tags for a script. More... | |
TestScript::defineScriptParamCombo | name description optionList args | ||
Assigns a combo parameter to a script (for new script format, T4x version >= 10)
Combo parameters are displayed in the script GUI as drop down box, allowing to select from a specified set of values. It is possible to select exactly one value.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
optionList | the set of allowed values |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamDate | name description args | ||
Assigns a date parameter to a script (for new script format, T4x version >= 10)
Date parameters are displayed in the script GUI as text box. A date picker appears when the text box is clicked, allowing the select a date
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamEditCombo | name description optionList args | ||
Assigns an editable combo parameter to a script (for new script format, T4x version >= 10)
Editable combo parameters are displayed in the script GUI as drop down box, allowing
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
optionList | the set of allowed values |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamFileCombo | name description args | ||
Assigns a file combo parameter to a script (for new script format, T4x version >= 10)
File combo parameters are displayed in the script GUI as drop down box, allowing to select from a specified set of values. The set of allowed values is determined at run-time as the set of files in the T4x upload folder. It is possible to select exactly one value.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamGroup | controllerParam controlledParamListList | ||
Assigns a group parameter to a script (for new script format, T4x version >= 10)
Group parameters are not displayed in the script GUI as a widget, but as a group of widgets separated from other parameter entry fields by somewhat larger spaces before and below the group. Groups are meaningful for the script GUI only and are ignored when executing a script from the the command line. A group consists of the following:
controllerParam | the representation of a combo parameter to be used as controller |
controlledParamListList | the list of lists of representations of parameters to be used as list of controlled branches |
TestScript::defineScriptParamList | name description optionList args | ||
Assigns a list parameter to a script (for new script format, T4x version >= 10)
List parameters are displayed in the script GUI as selection box, allowing to select from a specified set of values. It is possible to select exactly one value, or no value.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
optionList | the set of allowed values |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamMultiList | name description optionList args | ||
Assigns a multi list parameter to a script (for new script format, T4x version >= 10)
Multi list parameters are displayed in the script GUI as selection box, allowing to select from a specified set of values. It is possible to select one or more values, or no value.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
optionList | the set of allowed values |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamNumber | name description args | ||
Assigns a number parameter to a script (for new script format, T4x version >= 10)
Number parameters are displayed in the script GUI as text box, allowing to specify a numeric value.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamPasswordText | name description args | ||
Assigns a password text parameter to a script (for new script format, T4x version >= 10)
Password text parameters are displayed in the script GUI as text box, allowing to specify a password value. Characters in the password text box are shown as asteriscs.
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamSeparator | name description args | ||
Adds a separator or headline to a script GUI (for new script format, T4x version >= 10)
Separator parameters are displayed in the script GUI as a horizontal line or a headline label allowing to specify an arbitrary text value
name | the variable assigned to the parameter; for a separator this is obviously not relevant, as no values can be selected or entered, but for identification of the gui elements this name must not be empty and should be unique |
description | the label displayed in the script GUI for the parameter
|
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamText | name description args | ||
Assigns a text parameter to a script (for new script format, T4x version >= 10)
Text parameters are displayed in the script GUI as text box, allowing to specify an arbitrary text value
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::defineScriptParamTimeDate | name description args | ||
Assigns a time date parameter to a script (for new script format, T4x version >= 10)
Time date parameters are displayed in the script GUI as text box. A time-date picker appears when the text box is clicked, allowing the select a date with a time
name | the variable assigned to the parameter |
description | the label displayed in the script GUI for the parameter |
args | (optional) the following additional arguments (preceded by a "minus" symbol):
|
TestScript::setScriptCategoryList | categoryList | ||
Sets a list of categories for a script.
Scripts can have categories which can be used for filtering.
categoryList | list of categories |
TestScript::setScriptComment | comment | ||
Sets a comment for a script.
Scripts can have a comment which is displayed when pressing the help button. Comments can be specified in two ways:
The second way, illustrated below, is the way to go, when non-trivial comments are provided.
comment | the comment |
TestScript::setScriptDesc | description | ||
Sets a description for a script.
Scripts have a description which is displayed in the script overview
description | the description |
TestScript::setScriptDictionary | dictionary | ||
Sets a dictionary for a script (for new script format, T4x version >= 10)
Scripts can have a script dictionary. The script dictionary can be used to generate:
dictionary | the dictionary |
TestScript::setScriptFlavour | flavour | ||
Sets a flavour for a script.
Scripts have a flavour which is displayed as icon in the script overview. If no flavour is specified, then implicitly the flavour is "T4X"
TestScript::setScriptGui | paramList | ||
Assigns a list of representations of parameters as GUI to a script (for new script format, T4x version >= 10)
paramList | a list of representations of parameters |
TestScript::setScriptTagList | tagList | ||
Sets a list of tags for a script.
Scripts can have tags which can be used for filtering.
tagList | list of tags |