6.1.1 Include Files

The following table describes the include files used to implement the Object Selector:

To use these files, include them in your task JSPs using the jsp:include action.

6.1.2 Parameter Variables

Use either OS_inc.jsp, OSBtn_inc.jsp, or OSLink_inc.jsp to insert a control that opens the Object Selector when clicked. Each of these controls use the following parameters to determine how the Object Selector operates:

6.1.3 Advanced Selection XML Syntax

The XML syntax definition of an Advanced Selection criterion is:

 <selection-criterion>
    <types>
         <id> ds-type1 </id>
         <id> ds-type2 </id>
         
    </types>
    <aux-types>
         <id> ds-auxtype1 </id>
         <id> ds-auxtype2 </id>
         
    </aux-types>
    <group>
       <row>
          <attribute> name </attribute>
          <operation> op </operation>
          <value> string </value>
          <row-op> and/or </row-op>
       </row>
       ...
       <group-op> and/or </group-op>
    </group>
    ...
 </selection-criterion>
 

6.1.4 Dynamically Enabling and Disabling the Object Selector

The user activates the Object Selector by clicking on an icon, link, or button, depending on whether you have used the OS.inc, OSLink.inc or OSBtn.inc files in your task. However, at times you might want to disable the Object Selector until certain steps have been performed in the task. This is accomplished using the IsOSAllowed() function (see OS.IsOSAllowed). You provide a JavaScript function that determines, at runtime, when the Object Selector is allowed to run. Each time the user clicks the Object Selector button, this function is called. You provide the logic to determine whether the Object Selector operation is allowed at that time. If so, you return Boolean true, otherwise false.

6.1.5 Pre-Processing and Post-Processing Routines (preOS and postOS)

It is often desirable for a task to perform some processing before the Object Selector executes or after it returns the selected objects to the task. You can do this by implementing JavaScript routines, preOS(controlName) and postOS(controlName) for your tasks.

If the Object Selector is enabled (see OS.IsOSAllowed), an attempt is made to call a JavaScript routine called preOS(controlName), if it exists. This enables you to do any processing you need before the Object Selector runs.

When the Object Selector finishes, the selected results are returned to either the specified control or callback routine and then the postOS(controlName) function is called, if it exists. At this point, you can do anything you want to clean up after the Object Selector in your task.

contolName is a string representing the HTML control that is associated with the Object Selector using the OS.Control parameter.

6.1.6 Making the Root Selectable

It is often necessary to allow the user to select the root of the tree as a place to perform operations (like create, delete, move, and modify). However, the root of the tree is not an object in DS, so you cannot search or browse to it directly. If you want your users to be able to select the root of the tree as a location to perform operations, simply specify [root] as the value of the OS.TypeFilter parameter.

6.1.7 Making Public and This Selectable

eDirectory has two other pseudo-objects that can be made selectable: This and Public. To make these selectable, specify [this] or [public] as the value of the OS.TypeFilter parameter.

6.1.8 Filtering on All Container Types

Sometimes you need to allow the user to select any container-type object in the directory, but it is not always possible to know what all the container types in the directory are at the time you create the task. The system administrator can extend the directory schema and create new container objects.

To enable users to select any container object in the directory, specify [containers] as the value of the OS.TypeFilter parameter. The Object Selector queries the directory to get a list of all containers in the tree and dynamically populates the type filter with the available container types.

6.1.9 Filtering on Containers that Are Partitions

eDirectory represents partitions as an attribute of a container class and does not currently provide the ability to find only containers that are partitions. However, to enable users to select only partition container objects in the directory, specify [partitions] as the value of the OS.TypeFilter parameter. All container objects are displayed, but only those that are partitions are selectable. If you want all containers that are not partitions, specify [non-partitions].

6.1.10 Object Selector Support in the iManager Tag Library

iManager 2.7 provides a custom tag library to developers who prefer using tag libraries in their JSP templates. Use these tags along with, or in place of, the auto-conversion tools the Conduit object creates during the port from .http files to .jsp files.

The following tags support the Object Selector:

The <iman:eMFrameScripts/> and <iman:osScripts/> tags define general data and routines used by most iManager tasks and those required specifically for the Object Selector. They must be included in the <head> section of the HTML task document.

The <iman:os attrib1 . . . attribn/> tag displays an Object Selector button in the task. You can provide values for all of the defined Object Selector values through the attributes listed in the following table:

The <iman:osFooter/> tag creates the form through which all data is posted between the Object Selector and the task that is using it. It must be placed at the bottom of the HTML before the </body> tag.

6.1.11 A JSP Tag Library Example: Delete User

 <%@  page pageEncoding="utf 8" contentType="text/html;charset=utf 8" %>
 <%@ taglib uri="/WEB INF/iman.tld" prefix="iman" %>
 <HEAD><TITLE>MyTask</TITLE>
 <iman:eMFrameScripts/>
 <iman:osScripts/>
 <script>
   function capitalize(controlName, results)
   {
     var strResults = "";
     for (i=0; i<results.length(); i++)
     {
       if (i>0) { strResults += "+" }
       strResults += results[i].toUpperCase();
     }
     document.CreateUserForm.elements[controlName].value=strResults;
   }
   function readyToSearch()  { return true }
 </script>
 </HEAD>
 <BODY TEXT="#000000" bgcolor="#FFFFFF" onLoad="returnFromOS()">
 <FORM name="DeleteUserForm" method=post action="webacc">
    <input type=hidden name="taskId" value="{VAR taskId}">
    <input type=hidden name="merge" value="dev,GenConf">
    <input type=hidden name="error" value="dev.GenErr">
    <input type=hidden name="nextState" value="doDeleteUser">
    <BR><FONT size=+1 color=#000080><B>Delete User</B></FONT><BR><BR>
    <FONT face="Helvetica,Arial" size= 1><NOBR>User name:</NOBR></FONT><BR>
    <input type=text name="DeleteUserName" value="" size=35>
    <iman:os control="DeleteUserName"
              callBack="capitalize"
              nameFilter="a*"
              typeFilter="User"
              initialContext="Novell"
              mode="browse"
              multiSelect="true"
              altText="User to delete"
              iconName="dev/add.gif"
              searchSubContainers="false"
              searchOnStartup="true"
              isOSAllowed="readyToSearch" />
    <br><br><input type=image name="Delete" alt="Delete" src="<path>/delete.gif" border=0
 </form>
 <iman:osFooter/>
 </BODY>
 

6.1.12 Troubleshooting