Defining Resource Attributes (Oracle Waveset 8.1.1 Deployment Guide)

Oracle Waveset 8.1.1 Deployment Guide

Defining Resource Attributes

You use the <ResourceAttribute> element, as shown in the following example, to define resource attributes in the prototypeXML string of the adapter Java file:

<ResourceAttribute name=’"+RA_HOST+"’ type=’string’ multi=’false’\n"+
description=’&lt;b&gt;host&lt;/b&gt;&lt;br&gt;Enter the resource host name.’>\n"+

Where the description field identifies the item-level help for the RA_HOST field and must not contain the < character. In the preceding example, the < characters are replaced by < and '.

The following table describes the keywords you can use in <ResourceAttribute> element.

Table 10–4 <ResourceAttribute> Element Keywords


Keyword	Description
`name`	Identifies the name of the attribute. NOTE: The `name` keyword is a reserved word in views and should not be used as a Identity System User Attribute on resource schema maps.
`type`	Identifies the data type used.
`multi`	Specifies whether multiple values can be accepted for the attribute. If `true`, a multi-line box displays.
`description`	Identifies the item-level help for the `RA_HOST` field. Waveset displays help with the item being described (host in this case) in bold text. Because the HTML brackets necessary to do this (< and >) interfere with XML parsing, they are replaced by `<` and `>`. After the binary is translated, the `description` value looks like: `Description=’<b>host</b> Enter the resource host name.’`
`facets`	Specifies the usage of this resource attribute. Valid values are provision: Used in standard processing (default value). activesync: Used in Active Sync processing for an Active Sync-enabled adapter.

The ResourceAttribute> element may also contain a ValidationPolicy element. A validation policy ensures the value a user specifies on the Resource Parameters page meets the requirements defined in a separate policy object.

The following sample causes the adapter to use the Port Policy to ensure the specified value is valid. The default Port Policy checks the value is an integer between 1 and 65536.

 <ResourceAttribute name='Port' value='123'>
    <ValidationPolicy>
      <ObjectRef type='Policy' id='#ID#PortPolicy' name='Port Policy'/>
    </ValidationPolicy>
  </ResourceAttribute>