Template - addLocalEnumProperty

Template - addLocalEnumProperty

Description :

This command adds a new local property of a string or integer enumeration type to a specified Component Template. If such a property already exists, the command fails.

Property names or values with spaces must be wrapped with quotes and escaped with a backslash, using a format like "\"prop name1\"".

Return type : void

Command Input :

Variable Name

Variable Type

Description

templateName

String

Name of the Component Template.

groupName

String

Name of the group that contains the Component Template.

elementType

String

Element type of the new enumerated type. This must be either String or Integer.

propertyName

String

Name of the property.

description

String

Short description of the property.

isEditable

Boolean

Indicates whether or not the property is editable.

isRequired

Boolean

Indicates whether or not the property is required.

isUsedInReports

Boolean

Indicates whether or not the property is used in reports.

enumDataNames

String

Names of the enumeration data.

enumDataValues

String

Values of the enumeration data.

defaultValue

String

The default value for the property.

Example

The following example adds a new string enumeration local property to the Component Template Apache in the folder /Applications/WebServers/Unix. The new enumeration property is called PROP1 and it contains a list of names/value pairs. The new enumeration property is used in reports.

Script

Template addLocalEnumProperty Apache /Applications/WebServers/Unix String PROP_1 "desc" true false true "aaa,\"b b b\"" "mmm,nnn" "mmm" 

Was this page helpful? Yes No Submitting... Thank you

Comments