8.2.1 string

Values of data type “string” have a value that is a sequence of Unicode characters. Any valid XML character that is allowed in XML PCDATA is allowed in the value of a string value. String values might be empty (such as, the string value might have zero length). A string value might have a multiline attribute on the <definition> element. If multiline has a value of "true", the Agent should present the value honoring any embedded end-of-line characters and allow the user to specify line breaks.

8.2.2 boolean

Values of data type “boolean” have a value that is either “true” or “false”. Boolean values might not have empty values. The content of the value element must match the following production:Boolean ::= 'true' | 'false'

Example:

    <definition
         type="boolean"
         name="perform-magic"
         display-name="Do what I mean, not what I say" >
         <value>true</value>
         <description>This is an example of a boolean value</description>
    </definition>

8.2.3 integer

Values of data type “integer” have a value that is one or more Unicode characters that match the XML specification pattern Digit. Integer values might optionally be preceded by a '-' (hyphen) character indicating negation. The minimum and maximum integer values are those that can be represented in a signed, twos-complement 32-bit value as in the Java language int type. Integer values may be restricted in range. A lower bound, an upper bound, or both may be specified. The content of the value element must match the following pattern:Integer ::= '-'? Digit+Digit ::= '1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'

Example:

     <definition
           type="integer"
           name="how-much"
           display-name="Enter the amount to send to Perin">
           <value>0</value>
            <description>This amount will be deducted automatically from your    credit card account and sent to Perin.</description>
    </definition>
    <definition
         type="integer"
         name="port-number"
         display-name="Enter the TCP port to use"
         range-lo="1024"
         range-hi="65535">
         <value>8080</value>
          <description>This is the TCP port that will be used for connecting to the application.</description>
     </definition>
     <definition
           type="integer"
           name="timeout"
           display-name="Timeout value in seconds"
           range-lo="1">
           <value>10</value>
    <description>This is the timeout value in seconds; the driver will wait up
to this number of seconds for a connection.</description>
    </definition>

8.2.4 real

Values of data type “real” have a value that describes a real (or floating-point) number. The total allowable range of values for a real value are those that can be represented by a 64-bit double-precision floating point value as in the Java language double type. Real values might be restricted in range. A lower bound, an upper bound, or both might be specified. The content of the value element must match the following production:Real ::= Integer | ('-'? Digit+ '.' Digit+)

Example:

        <definition
             type="real"
             name="multiplier"
             display-name="Factor by which to multiply collective IQ"
             range-hi="1.0">
             <value>0.6</value>
            <description>When one or more managers walk into a room, the collective IQ is affected. This value is used to calculate the approximate resulting collective IQ.</description>
         </definition>

8.2.5 dn

Values of data type “dn” have a value that must be a syntactically-legal distinguished name. DN values must be further qualified with a dn-type attribute that specifies the DN syntax. A DN value might have an empty value. If dn-space="dirxml", an object selection button should be presented.

Examples:

          <definition
              type="dn"
              name="user-account"
               display-name="Enter the user account to be used for authentication"
              dn-type="ldap">
              
              <value>cn=admin,ou=ITDept,o=TheCompany</value>
               <description>This value specifies the DN of a user account used to authenticate to the LDAP directory.</description>
              </definition>
              <definition type="dn" name="exchange-account"
              display-name="Enter the DN of the Exchange user"
              dn-type="custom"
              dn-delims="10./+=*\">
              
              <value>CN=Admin+UID=1056/OU=Mayberry</value>
         </definition>

8.2.6 enum

Values of data type “enum” have a value that is one of a defined set of strings. Each defined string must conform to the string production.

Example:

       <definition
          type="enum"
          name="magical-features"
          display-name="Choose the magical feature set">
          
          <value>full</value>
           <enum-choice display-name="Full-on, magical stuff">full</enum-choice>
           <enum-choice display-name="Partial magic, but no rabbits">partial</enumchoice>
           <enum-choice display-name="No magic, just boring normal life">none</enumchoice>
                </definition>
                <definition
                     display-name="xlfid(submit-method)Scheduled action"
                     name="action"
                     type="enum">
                     
   <enum-choice display-name="xlfid(start)Start the driver">start</enumchoice>
   <enum-choice display-name="xlfid(stop)Stop the driver">stop</enum-choice>
   <enum-choice display-name="xlfid(toggle)Toggle the driver">toggle</enumchoice>
   <value>start</value>
                  </definition>

8.2.7 list

Values of data type “list” have a value that is an ordered list of zero or more strings. The list value also specifies a delimiter character that is used when outputting the list value in a non-structured location (e.g., as a single string consisting of each individual string in the list separated by the delimiter character).

The content of each <item> element must match the following production:String ::= Char*The list items can be empty or duplicate other list items. The order of list items is significant. The Agent must preserve all characters in a list item exactly as specified by the user. This includes whitespace. The Agent serializing the definition XML must therefore specify an xml:space="preserve" attribute on the value element. It might also be necessary to use character entity references for some whitespace based on the XML rules for parsers:

Example:

<definition
display-name="List o' things"
item-separator=";"
name="ingredients"
type="list">

<value>
<item>Snips</item>
<item>Snails</item>
<item>Puppy Dog Tails</item>
<item>Sugar</item>
<item>Spice</item>
<item>Everything Nice</item>
</value>
</definition>

8.2.8 structured

Values of data type “structured” have two fundamental parts: a template that defines a set of simple types (string, enum, etc.), and zero or more instances that contain the actual values of the structured control value. In a sense structured values are similar to structures in the C programming language. The structured value also specifies delimiter strings that are used when outputting the value as a single string. The delimiters are used for string representation, but in a nodeset context, you get the <instance> node tree fragments. The string representation of the value contains all the components of the structured value separated by the delimiter, for example, <ipaddress>, <port>, and so on. However, the xml representation of the structured GCV has instances that contain the actual Global Definition values.

Example: Suggested Agent presentation for nested control value presentation with buttons for adding and removing instances. The example allows for template creation and editing.

<definition
display-name="Servers list"
value-separator=";"
instance-separator="&#10;"
name="servers"
type="structured">

<template>
<definition name="host" display-name="Host" type="string">
<value/>
</definition>
<definition name="port" display-name="TCP port" type="integer" rangelo="
1" range-hi="65535">
<value>1</value>
</definition>
</template>
<value>
<instance>
<definition name="host" display-name="Host" type="string">
<value>192.168.0.1</value>
</definition>
<definition name="port" display-name="TCP port" type="integer"
range-lo="1" range-hi="65535">
<value>8028</value>
</definition>
</instance>
<instance>
<definition name="host" display-name="Host" type="string">
<value>10.0.0.1</value>
</definition>
<definition name="port" display-name="TCP port" type="integer"
range-lo="1" range-hi="65535">
<value>8028</value>
</definition>
</instance>
</value>
</definition>

8.2.9 password-ref

Values of data type “password-ref” have a value that is the key value of a named password. Named password key values might be any non-empty sequence of Unicode characters. Because of the representation of CV definitions in XML, the actual set of Unicode characters allowed are those that are legal in XML PCCHAR data. The Agent presenting the password-ref value is responsible for setting any user-entered password value to the named password. If the referenced named password does not exist then the Agent must create it. The user-entered value must not be placed in the XML definition.

Example for Agent presentation of password field, associated confirmation field, and associated clear value button.

 <definition
   type="password-ref"
   name="account-pwd"
   display-name="Password for the authentication account">
 
   <value>auth-acct-pwd</value>
 </definition>

8.2.10 dn-ref

The dn-ref data type does not have a a value of its own. Instead, it assumes any value obtained from a DN-syntax eDirectory attribute on the object containing the value definition. The information about the eDirectory attribute is specified by XML attributes on the <definition> element.

The following example shows an Agent presentation of an entry field with the associated object selection button.

<definition 
       type="dn-ref" 
       name="pwd-policy" 
       display-name="Password Policy object used for password generation" 
       attr-name="nspmPasswordPolicyDN" 
       aux-class-name="DirXML-PasswordGeneration"> 
    <target-class>nspmPasswordPolicy</target-class> 
 <value>DirXML-PasswordPolicy.Password Policies.Security</value> 
</definition>

8.2.11 gcv-ref

A GCV reference value does not have a value of its own and is not defined with a <definition> element. Instead, a value is obtained from and stored to a GCV in an enclosing logical structure. For example, a gcv-ref value in shim parameters refers to a GCV defined for the driver. The GCV is specified by the name attribute on the <gcv-ref> element.

The following example shows an Agent presentation that depends on the referenced GCV:

<gcv-ref name="placement-base"/>

<definition display-name="Placement base container" name="placement-base" type="string">
               <description>This is  the placement base container</description>
              <value></value>
        </definition> 

8.7.1 Text Replacement

The following syntax is used to supply the value of a GCV via text replacement:

~gcv-name~

where "gcv-name" is the name of the desired GCV.

Text replacement works by replacing such references with the value of the GCV in policy source and in the following shim configuration fields:

In policy source (both DirXML-Script and XSLT) the text replacement is straightforward and consists of simply replacing the reference with the string value of the GCV with one exception: List values will be output as either a string or as structured XML depending on the replacement context. In particular, if the list GCV reference appears in element content then the list will be output in a structured form. If the list GCV reference appears in an attribute value then the list will be output as a delimited string.

Several examples will help to illustrate text replacement (note the use of quotes around the GCV reference when the result needs to be a string):

<definition
name="my-gcv"
type="string"
display-name="Source subtree"
>
<value>\mytree\novell\</value>
</definition>

<xsl:if test="starts-with(@src-dn,'~my-gcv~'">

<xsl:if test="starts-with(@src-dn,'\mytree\novell\'">

8.7.2 DirXML-Script Access

When the ~GCV~ notation is executed as a string replace at driver startup in XSLT or XPATH, the strings must be enclosed. However, in XPATH a single $GCV is sufficient, and need not be string enclosed.In variable expansion supporting fields, $GCVName$ is sufficient and is not equal to ~GCVName~ as the $GCVName$ expansion is executed at run time as it is encountered, but ~GCVName~ is evaluated at driver start time.

See the DirXML Script documentation for the full description. GCVs can be accessed in DirXML Script policies in several ways: