Installation Parameters

Installation parameters can be defined as a "property" of each package and, depending on the configuration settings, are available for each package assignment, i.e. they can be changed in the context of the relevant policy.

Such an installation parameter can be used in the package script, for example, where the current value of the parameter is checked via an If query, in order to derive an action from this. During script creation, each parameter is shown in the list of available variables.

Area of use of installation parameters:
Providing "local parameters" for controlling the execution of a package (using corresponding control structures in the package script).

Parameter Types

The Packaging Workbench supports the following types of parameters:

Type Description

Boolean

Switch (true/false)

Date Time

Date with time

Integer

Whole number

IPv4 address

String formatted as IPv4 address (e.g. 192.168.178.255.

The type IPv4 address is available for installation parameters only.

IPv6 address

String formatted as IPv6 address (e.g. 2001:2:3:4:5:6:7:0). The notation can be abbreviated, for example 2000::1:2:0:3:4.

The type IPv6 address is available for installation parameters only.

Password field

Encrypted string

The type password field is available for variables and installation parameters only.

Option list

Fixed list of values.

For the displayed and the "internal" (assigned) option value, different values can be defined.

Text field

String (max. length: 4000)

Timeframe

Defines a timeframe as used, for example, for maintenance timeframes.
You can use such a variable to interactively specify times when the timeframe is active.

Use the IsInTimeFrame condition to run specific actions in an eScript Package depending on a timeframe.

Refer to Defining the Timeframe for more details on specifying timeframes.

Version

String formatted as version number (e.g. 2015.2.3, 7.3.0.2424, 7.2)

A version consists of two to four sets of numbers, each separated by a dot. Numbers with leading zeros are stored without the zeros (2015.02.003 is stored as 2015.2.3). Comparative operators (e.g. <= 2015.2) can be used to evaluate respective values.

 

For every parameter of a package, the following settings amongst others can be defined:

  • Default value
    Depending on the parameters type, a default value can be defined. This is optional.
  • Changeable per assignment
    The parameter value can be changed during assignment. This means that it is possible to change the parameter value for every policy instance.
  • Locked
    The parameter value must be unique for each policy instance. This setting is recommended, e.g. for computer-dependent licenses.
  • Allow empty value
    This setting is used to determine whether the parameter has to have a value as opposed to also being allowed to be "blank".