test

N1 Service Provisioning System 4.1 Reference Guide

Using Substitution Variables

You can use simple substitution variables in any input source, including configuration files. You can use external component and target substitution variables in a number of places, including varList/var default values of installSteps, uninstallSteps, controlService and executionPlans.

The following is a complete list of what types of substitution variables can be used in what input sources:

Input source 

Type of variable allowed 

<component>/<varList>/<var>/default attribute 

variable settings override value 

  • component substitution references

  • host substitution references

  • external component substitution references (including nested and dependee as primary components)

  • session variable references

Input source 

Type of variable allowed 

<component>/<installList>/<installSteps>/ <paramList>/<param>/default attribute 

<component>/<uninstallList>/<uninstallSteps>/<paramList>/<param> \ 

/default attribute 

<component>/<controlList>/<control>/ <paramList>/<param>/default attribute 

<component>/<snapshotList>/<snapshot>/ <paramList>/<param>/default attribute 

  • component substitution references

  • host substitution references

  • external component substitution references

  • session variable references

Input source 

Type of variable allowed 

<component>/<installList>/<installSteps>/ <varList>/<var>/default attribute 

<component>/<uninstallList>/<uninstallSteps>/ < varList>/<var>/default attribute 

<component>/<controlList>/<control>/ < varList>/<var>/default attribute 

<component>/<snapshotList>/<snapshot>/<varlList>/<var>/default attribute 

  • local variable substitution references (previously declared)

  • parameter substitution references

  • component substitution references

  • host substitution references

  • external component substitution references

  • session variable references

Input source 

Type of variable allowed 

<component>/<installList>/<installSteps>/child steps 

<component>/<uninstallList>/<uninstallSteps>/child steps 

<component>/<controlList>/<control>/child steps 

<component/<snapshotList>/<snapshot>/<prepare>/child steps 

<component/<snapshotList>/<snapshot>/<capture>/child steps 

<component/<snapshotList>/<snapshot>/<cleanup>/child steps 

  • local variable substitution references

  • parameter substitution references

  • component substitution references

Input source 

Type of variable allowed 

<component>/<resourceRef>/<resource> 

<component>/installPath 

  • component substitution references (excluding rsrcInstallPath)

Input source 

Type of variable allowed 

<component>/<diff>/<ignore> 

configuration files 

component substitution references  

Input source 

Type of variable allowed 

<executionPlan>/<paramList>/<param>/default attribute 

session variable references 

Input source 

Type of variable allowed 

<executionPlan>/<varList>/<var>/default attribute 

<executionPlan>/*/<inlineSubplan>/<varList>/<var>/default attribute 

  • session variable references

  • local variable substitution references (previously declared)

  • unhidden local variable substitution references of enclosing plans

  • unhidden parameter substitution references

  • host substitution references (simple plans/subplans only)

  • external component substitution references (simple plans/subplans only, excluding container, nested, toplevel, and dependee as primary component)

Input source 

Type of variable allowed 

<executionPlan>/*/child steps 

  • local variable substitution references

  • unhidden local variable substitution references of enclosing plans

  • unhidden parameter substitution references

Input source 

Type of variable allowed 

hostAttributes 

session variable references 

The following configuration attributes of a component can include substitution variable definitions:

Parent element 

Substituable attribute 

capture/addFile 

component 

installSpec 

displayName 

installPath 

name 

installSpec 

path 

installSpec 

permissions 

installSpec 

user 

installSpec 

installSpec 

installSpec 

group 

deployMode 

diffDeploy 

diff/ignore 

path  

varList/var 

default 

paramList/param 

default 

capture/addFile 

path 

The following configuration attributes of steps within a component or plan can include substitution variable definitions:

parent element 

substitutable attribute 

argList/arg 

value 

execJavaexecJavaexecNative 

classNameclassPathdir 

execNative/ouputFile 

name 

execNative/errorFile 

name 

execNative/env 

name 

execNative/env 

value 

execNative/exec 

cmd 

execNative/exec/arg 

value 

execNative/shell 

cmd 

execNative/shell 

<body> 

execNative/successCriteria 

outputMatches 

execNative/successCriteria 

errorMatches 

execNative/inputText 

<body> 

execNative/inputFile 

name 

execNative 

if/condition/istrue 

if/condition/equals 

if/condition/equals 

if/condition/matches 

if/condition/matches 

userToRunAs 

value 

value1 

value2 

value 

pattern 

processTest 

processNamePattern 

processTest 

raise 

retarget 

retarget/varList/var 

user 

message 

host 

default 

sendCustomEvent 

message 

transform 

input 

transform 

output 

transform/stylesheet 

<body> 

transform/subst 

match 

transform/subst 

replace 

transform/source 

name 

uninstallComponent 

installPath 

urlTest 

url 

urlTest 

pattern 

The following configuration attributes of a plan can include substitution variable definitions:

parent element 

substitutable attribute 

varList/var 

default 

The following configuration attributes of installed component targeters can include substitution variable definitions:

parent element 

substitutable attribute 

installedComponent 

installedComponent 

systemType 

systemType 

toplevelRef 

toplevelRef 

installPath 

host 

installPath 

host 

installPath 

host 

The following configuration attributes of repository component targeters can include substitution variable definitions:

parent element 

substitutable attribute 

component 

toplevelRef 

host 

host