4.1 Creating a Property Book

Property books are types of tasks used to display and modify the attributes of a single object or a set of objects of the same type. Unlike tasks, where you decide what you want to do then follow a flow of UI screens until the task is accomplished, with property books you pick an object, view its attributes, and make changes to the attributes. The attribute data is displayed on pages. You can navigate among the pages by clicking on the tabs along the top of the property book or selecting the page in a list, depending on the type of device used to access iManager.

To create a property book, you need to:

4.1.1 Create the Java Class

To create a custom property book, create a Java class that extends com.novell.emframe.dev.PropertyBook.

NOTE:For property books that deal with eDirectory™ objects, use com.novell.emframe.dev.DirPropertyBook instead of creating your own class.

4.1.2 Create the Property Book Pages

Unlike tasks, property books do not use JSPs directly to create their user interfaces. Instead, property books display pages that are assigned to the property book. Pages are simple tasks with their own Java code and JSPs for their user interfaces. Pages can run outside of a book. For instructions on creating pages, see Creating a Property Book Page.

4.1.3 Create the XML Registration File

Property books must be defined in an XML registration file. Store the registration file in a \plugins directory inside your module. When iManager reads the registration file, it uses the <book> entry to create an rbsBook object in eDirectory.

Property books must be defined in a registration file using the <book> element.

For example:

 <book>
    <id>sdk.PropertyPageExample</id>
    <version>2.0.0</version>
    <required-version>2.7.0</required-version>
    <class-name>java:com.novell.emframe.dev.DirPropertyBook</class-name>
    <display-name-key>PropertyPageExample.BookDisplayName</display-name-key>
    <resource‑properties‑file>
       com.company.plugins.iManagerCodeExamplesResources
    </resource‑properties‑file>
    <object-type-name>User</object-type-name>
    <role-assignment>iManager Code Examples</role-assignment>
    <page-assignment>sdk.PPExampleTask1</page-assignment>
    <page-assignment>sdk.PPExampleTask2</page-assignment>
 </book>
 

For complete descriptions of supported XML elements for the property book registration file, see XML Schema for Installation and Registration Files.