Predefined Component Variable Names

These predefined component variable names refer to the associated component attributes of the generation context:

• sys.name – Component name

• sys.version – Version number of the component in the standard format major.minor

• sys.description – Component description

• sys.label – Label of the component

• sys.softwareVendor – Software vendor that wrote the application that is modeled by the component

• sys.author – Creator of the component

• sys.path – Path of the component

  The sys.path variable is like the path attribute of the component, but it includes a trailing slash (/). sys.path can be directly combined with the sys.name variable to create the full name of the component.

  :[sys.path]:[sys.name]

• sys.rsrcInstallPath – Location where the component resource is installed

  The sys.rsrcInstallPath variable is in the file format of the remote agent on which the component is, or is being, installed. You can only use this variable for simple components. Since the value of this variable might require other dynamic component variables to be computed, you cannot use sys.rsrcInstallPath in a component variable default value or variable settings override value. This variable also cannot be used as the value of the <component> installPath attribute or in the <resourceRef>/<installSpec> element attributes. These restrictions prevent the possibility of circular references.

• sys.targetRefName – Name of the associated component targeting host

  The sys.targetRefName variable is only defined for targetable components. The component targeting host is defined by the resolved value of the hostName attribute of the targetable component's <targetRef> element. It cannot appear as a simple substitution variable in a component variable value because component variables might be used to compute the sys.targetRefName value. This variable is most often used with the <retarget> step to install or manipulate components that are in a targetable component.

Predefined component variables are always resolved relative to the actual component that is, or is being, installed even if the variable reference occurs in a base component. Predefined component variables are treated as PUBLIC variables.