The <attribute> element maps the attributes of a Java class from the plugged-in technology to JavaScript attributes that the Orchestrator JavaScript engine exposes.

The <attribute> element is optional. A plug-in can have an unlimited number of <attribute> elements. The <attribute> element has the following attributes.

Type

Value

Description

java-name

Java attribute

Name of the Java attribute. Mandatory attribute.

script-name

JavaScript object

Name of the corresponding JavaScript object. Mandatory attribute.

return-type

String

The type of object this attribute returns. Appears in the API Explorer documentation. Optional attribute.

read-only

true or false

If true, you cannot modify this attribute. Optional attribute.

is-optional

true or false

If true, this field can be null. Optional attribute.

show-in-api

true or false

If false, this attribute does not appear in API documentation. Optional attribute.

is-deprecated

true or false

If true, the object maps a deprecated attribute. Optional attribute.

since-version

Number

The version at which the attribute was deprecated. Optional attribute.

Table 1. Element Hierarchy

Parent Element

Child Elements

<attributes>

None