| Document number | Revision |
|---|---|
| DOCU13074 | 1 |
<parameter> Element - Schema Reference
<parameter> Element - Schema ReferenceDefinitionContent modelAttributesElementsSpecial elementsSamplesStandard definitionRelevant tools and utilitiesParameter accessibilityParameter definitions and priority
Definition
Parent element(s): <schema>.
The <parameter> element can be used to define or configure global definitions or rules that will be applied and enforced throughout Highstage.
Content model
The specification of what attributes, elements and data that are available and allowed within the <parameter> element.
Attributes
This section introduces you to the XML attributes and values that are available and can be included within the <parameter> element.
| Attribute | Description | Mandatory |
|---|---|---|
| name | Unique element name. | ✔️ |
| value | parameter specific value. | ✔️ |
Elements
Special elements
Samples
Standard definition
The following sample illustrates how a new global parameter can be created using the <parameter> element.
xxxxxxxxxx<parameter name="sampleParameter" value="Sample value" />
Relevant tools and utilities
Parameter accessibility
As an administrator in Highstage (with a set user level of AdminRead or AdminWrite), you can navigate to SYSTEM > PARAMETERS > ALL PARAMETERS to get an overview of all basic parameters and their configurations. It is these parameter configurations that dictates how your Highstage installation looks and functions.
Note: Making changes to parameter values requires a set user level of AdminWrite and subsequently a Reset of Highstage for all changes to take effect.
Tip: For more detailed information about available parameters that are not directly available in Highstage, please refer to our documentation regarding advanced parameters and their configuration capabilities.
Parameter definitions and priority
There are three specific ways in which a parameter can be defined in Highstage. It is important to know that these methods of defining parameters have a priority order. Parameters with a higher priority will overwrite parameters at a lower level (if the name is shared across parameter definitions).
Order of priority:
- Parameter(s) defined in
web.config.xmlhave highest priority (can be accessed on the dedicated Highstage server under.../TurboStage/TS_WebApp).
The parameters configured in web.config.xml can be configured using the <add> element.
The key attribute represents the parameter name and value represents the parameter value:
<configuration> <appSettings> <add key="sampleParameter" value="Sample value"/> <!-- Parameter defition for all Highstage applications --> <add key="ts:AnothersampleParameter" value="Another sample value"/> <!-- Parameter defition for specific Highstage application (ts) --> </appSettings></configuration>- Parameter(s) defined in Highstage has second highest priority (accessed by navigating to SYSTEM > PARAMETERS > ALL PARAMETERS in Highstage as an administrator with a set user level of AdminRead/AdminWrite ).
- Parameter(s) defined in
custom.schema.xmlhas the lowest priority (can be accessed and configured on the dedicated Highstage server under.../TurboStage/TS_WebApp/tweak).
Tip: For more detailed information about available parameters that are not directly available in Highstage, please refer to our documentation regarding advanced parameters and their configuration capabilities.
