N1 Service Provisioning System 4.1 Reference Guide

The toplevelRef Installed Component Targeter

The <toplevelRef> element may be used as a targeter for the <checkDependency>, <createDependency>, <call>, <uninstall> and <addSnapshot> steps. It identifies a toplevel component reference declared or inherited by the current composite component. Only steps within composite components may use this targeter.

This targeter is semantically equivalent to the <installedComponent> targeter, except that the "name", "path" and "version" attributes are predefined based on the referenced component.

toplevelRef Targeter Attributes

Name 

Type 

Required 

Configurable 

Description 

name 

identifier 

Yes 

No 

The name of a toplevel component reference within this component. 

versionOp 

One of: 

  • “=”

  • “>=”

  • “>”

No 

No 

Specifies the operator to use when comparing the version of the referenced component against versions of components installed on the target host. If more than one installed component applies, the most recently installed is used. If unspecified, ">=" is used by default.  

only Compat 

Boolean 

No 

No 

If true, specifies that only components that are call compatible with the referenced should be matched. If unspecified, “false” is used by default. 

installPath 

String 

Yes 

Yes 

The install path of the referenced component. If unspecified, the most recent installation of the referenced component in any path is used. The value is converted to universal format prior to component resolution. 

host 

String 

Yes 

Yes 

The host on which the referenced component is installed. Defaults to the current host. See the <retarget> step host attribute for details.