OneClickExt properties¶

Default values for properties for server and client

In addition to the default values of the properties,
comments also provide explanations of the available properties.

SpectroSERVER configuration¶

Main Location Server and Backup Main Location Server
oneclickext.mls.primary: <MLS host>
oneclickext.mls.backup: <BLS host>

Hostname of the MOM (Main SpectroSERVER)
oneclickext.ss.host: <MLS host>

spectrum user, used by the application for connection to the Distributed Spectrum Environment
oneclickext.ss.user: <spectrum user>

should be set, when domain names are provided as FQDN (MapUpdate -v)
dcsspcexp.ss.domain.fqdn: true | false

Retry interval [ms] for connecting tio MOM
oneclickext.ss.retryIntervall: 1000
0 - unlimited
oneclickext.ss.retryCount: 300

defines, if all domains must be available
oneclickext.ss.connectAll: false

MOM polling interval [ms] (CORBAObjectMonitor)
oneclickext.ss.pollingIntervall: 1000

Interval [ms] for quering the domain list
oneclickext.ss.abfrageIntervall: 10000

each corba object monitor should use an own timer
oneclickext.ss.owntimer: true

Domains to be queried. This list has precedence over exclude.domains.list
oneclickext.ss.include.domains.list: <domainlist>

Domains not to be queried.
oneclickext.ss.exclude.domains.list: <domainlist>

RMI Parameters¶

oneclickext.rmi.port: <RMI port>
oneclickext.rmi.connport: <RMI connection port>

Settings for script execution¶

Number of threads for parallel execution
oneclickext.exec.threads: 32

Additional Properties¶

List of properties files with relative paths
oneclickext.additional.props: ../conf/testscript.props

ScriptLauncher classes¶

There are three ScriptLauncher classes
- ScriptLauncher: can only be launched on one model
- MultiScriptLauncher: launches on one or more models
in Spectrum on a Global Collection or on selected models
- GlobalScriptLauncher: launches without models

When starting scripts from OneClick, an alternative script
server can be specified. To do this, the script item is
extended to include the host and port:

<item name="SetModelName">
becomes
<item name="SetModelName_<hostname>_<port>">

The maximum number of models per script. Parallel execution and priority can be assigned per script.

Permissions for launching the ScriptLauncher via a website¶

A permission can be granted via the group or directly to the user.
To do this, the script items are assigned either to a group or to a user.
Users can be assigned to a group.

Script groups - Assignment of a script to a group
oneclickext.scripts.groups.<group name>: <script 1> <script 2> ...

Group permissions - Assignment of a group to a user
oneclickext.scripts.users.<user name>.groups: <group name>

Script permissions - Assignment of a script to a user
oneclickext.scripts.users.<user name>.scripts: <script 1> <script 2> ...

Configuration for OneClick script runner¶

Script command¶

oneclickext.scripts.<scriptitem>.command: <Windows or UNIX Command>
oneclickext.scripts.<scriptitem>.encoding: <CP437 on Windows | UTF-8 on UNIX>

Script execution¶

Per default all scripts are executed in parallel (limited by number of threads).
If needed, scripts can run successively:
oneclickext.scripts.<scriptitem>.exec.sequential: <true|false>
    The default setting is false.
Per default only one script runs per device/IP address. If set, modelHandle
is used to inhibit parallel execution for one device. Possible values:
    AUTO - model handle when run from Spectrum, ipAddress when run from command line
    NONE - no restriction

oneclickext.scripts.<scriptitem>.exec.type: <NONE|AUTO>
The default setting is AUTO.

Scripts of higher priority can be processed preferentially if the priority is set to highprio.
Scripts of the same priority are processed sequentially.

oneclickext.scripts.<scriptitem>.prio: <highprio|stdprio|lowprio>
The default setting is stdprio.

Status of Run Button:
The Run button can be disabled before starting; the button must
then be re-enabled in the dialogue box via an action.
oneclickext.scripts.<scriptitem>.runbutton.enabled: false

Control the output and exit code of the script¶

oneclickext.scripts.<scriptitem>.showOutput: <true|false>
The default setting is true.

oneclickext.scripts.<scriptitem>.showExitCode: <true|false>
The default setting is true.

Configuration for multiscripts¶

If a script has been started via MultiScriptLauncher, this must also
be enabled in the configuration. The maximum number of devices and an
attribute to distinguish between them must also be specified.
oneclickext.scripts.<scriptitem>.multidevice.active: <true|false>
The default setting is false.
oneclickext.scripts.<scriptitem>.multidevice.maxdevices: <n>
The default setting is 10
oneclickext.scripts.<scriptitem>.multidevice.attributes: 0x129e7

Each script for multiple devices requires the attributes Model_Name(0x1006e)
and Network_Address(0x12d7f). Additional mandatory attributes can be specified:
oneclickext.scripts.<scriptitem>.multidevice.attributes: <Attr ID> ...
Only these attributes can be used as parameters.

Definition of texts¶

Two texts are required:
Parameter text - displayed above the input masks and should briefly explain the function.
Security question – after clicking on the run button before execution, is an opportunity
to cancel the execution. Text parameters support multiple lines.
Parameter values can be included in the text %Pn%, n=1..x.

Security question
oneclickext.scripts.<scriptitem>.secquestion: <Question text including \n and %Pn%>
Parameter text.
oneclickext.scripts.<scriptitem>.paramtext: <parameter text including \n and %Pn%>

Parameter definition¶

Parameter list, all parameters are specified in the list; the order is relevant.
oneclickext.scripts.<scriptitem>.params: <p1 p2 p3 ... >

Parameter width - The width of the input mask
oneclickext.scripts.<scriptitem>.width: <pixels>
The default setting is 180
Parameter name - shown on the left side
oneclickext.scripts.<scriptitem>.p<n>.name: <Parameter Name>

Value definition¶

Specify value. Value supports %DATE% variable (will be expanded to act. Date/Time)
oneclickext.scripts.<scriptitem>.p<n>.value: <any text>
Validate value (validators are defined globally)
oneclickext.scripts.<scriptitem>.p<n>.validator: <validator name>
Use system parameter as value
oneclickext.scripts.<scriptitem>.p<n>.sysparam: < osuser | specuser | starttime >
    for multiscripts also scriptip and scriptdns
    for commandline script also devlist and param<n>
    format for starttime is defined at oneclickext.scripts.starttime below
Use url parameter as value, specified in the url as <name>=<value>
oneclickext.scripts.<scriptitem>.p<n>.urlparam: <name>
Specify pulldown menu (ComboBox) with values, each value is delimited with a pipe symbol (|)
oneclickext.scripts.<scriptitem>.p<n>.combo: <text 1|text 2|text 3| ...>
Return Combo Index (1..n) instead of combo value
oneclickext.scripts.<scriptitem>.p<n>.comboidx: <true|false>
The default setting is false
Preselect entry n on combo box
oneclickext.scripts.<scriptitem>.p<n>.comboisel: <n>
Specify Combo Actions (actions can be defined globally)
These are executed only after a selection and can delete values, enable / disable inputs or buttons.
oneclickext.scripts.<scriptitem>.p<n>.comboaction.< n (selection)>.list: <action 1> [ <action 2> ... ]
oneclickext.scripts.<scriptitem>.p<n>.comboaction.<action 1>.action: <action>
oneclickext.scripts.<scriptitem>.p<n>.comboaction.<action 1>.value: <value>
oneclickext.scripts.<scriptitem>.p<n>.comboaction.<action 1>.param: <param>
Action values and parameters are described under Global Actions.
Read value from Spectrum. In case of read error the value will be used instead of attr value
if parameter is set and emptyvalueonerror is false
oneclickext.scripts.<scriptitem>.p<n>.attr: <attrId to read on selected model>
oneclickext.scripts.<scriptitem>.p<n>.devattr: <attrId to read on device of selected model>
(devattr are not supported for scripts for multiple devices)

Parameter options¶

shows * instead of value when set to false, not on ComboBox
oneclickext.scripts.<scriptitem>.p<n>.visible: <true|false>
The default setting is true
make parameter read only or editable, not on ComboBox
oneclickext.scripts.<scriptitem>.p<n>.editable: <true|false>
The default setting is true
hide this parameter, value will be passed to script, not on ComboBox
oneclickext.scripts.<scriptitem>.p<n>.hidden: <true|false>
The default setting is false
show empty value on read error
oneclickext.scripts.<scriptitem>.p<n>.emptyvalueonerror: <treu|false>
The default setting is false

Syslog settings¶

The script server can send a syslog when starting and after finishing a script.
Template for the syslog is defined on the script server.

oneclickext.scripts.<scriptitem>.startsyslog.enabled: <true|false>
    The default setting is false
oneclickext.scripts.<scriptitem>.endsyslog.enabled: <true|false>
    The default setting is false
oneclickext.scripts.<scriptitem>.startsyslog.pri: <pri>
    The default setting is 190
oneclickext.scripts.<scriptitem>.endsyslog.pri: <pri>
    The default setting is 191

Global Script settings¶

Validators¶

Values can be validated using regular expressions. If the regular expression
does not match, an error message is displayed.
oneclickext.scripts.validator.<validator name>.regexp: <Regular Expression>
oneclickext.scripts.validator.<validator name>.message: <Text for error message>
Example:
oneclickext.scripts.validator.valid_ip.regexp: \\d+\\.\\d+\\.\\d+\\.\\d+

Global Actions¶

Global actions have no reference to a parameter:
oneclickext.scripts.comboaction.<gaction name>.action: <action>
oneclickext.scripts.comboaction.<gaction name>.value: <value>
oneclickext.scripts.comboaction.<gaction name>.param: <param>
and can be used at parameter definition:
oneclickext.scripts.<scriptitem>.p<n>.comboaction.< n (selection)>.list: <gaction 1> [ <gaction 2> ... ]

Action values and params:¶

Action	Value	Parameter	Description
enable	n.a.	Pn	enable a parameter
disable	n.a.	Pn	disable a parameter
text	'text'	Pn	insert text
clear	n.a.	Pn	clear value
date	date specifier	Pn	set input to Date
rbenable	n.a.	n.a.	enable Run-Button

date specifier¶

    lastDay.from and lastDay.to
    lastWeek.from and lastWeek.to
    lastMonth.from and lastMonth.to

Date formatting¶

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800

Examples

Date and Time Pattern	Result
`yyyy.MM.dd G 'at' HH:mm:ss z`	`2001.07.04 AD at 12:08:56 PDT`
`EEE, MMM d, ''yy`	`Wed, Jul 4, '01`
`hh 'o''clock' a, zzzz`	`12 o'clock PM, Pacific Daylight Time`
`K:mm a, z`	`0:08 PM, PDT`
`yyyyy.MMMMM.dd GGG hh:mm aaa`	`02001.July.04 AD 12:08 PM`
`EEE, d MMM yyyy HH:mm:ss Z`	`Wed, 4 Jul 2001 12:08:56 -0700`
`yyMMddHHmmssZ`	`010704120856-0700`
`yyyy-MM-dd'T'HH:mm:ss.SSSZ`	`2001-07-04T12:08:56.235-0700`

oneclickext.scripts.starttime: <format>