3.5 Creating Registration Files

Tasks and other plug-ins must be registered with iManager to be available to users. You register a plug-in by creating an XML file that describes the plug-in and placing the file in the appropriate directory. iManager provides a task for simplifying the creation of registration files. For more information see Section 3.5.1, Using the Create XML Install File Task.

A plug-in can be registered in one of two places: eDirectory or the file system. Plug-ins registered in eDirectory can take advantage of Role-Based Services to limit access to the plug-in tasks to those users who are assigned to the appropriate role. These types of plug-ins must be installed using the iManager Configuration Wizard. The registration files for these plug-ins require the <install> tag as the root element. They are stored in SDK_HOME/tomcat/webapps/nps/portal/modules/moduleID/install. These plug-ins usually contain only roles and tasks.

Plug-ins that are registered in the file system are available to anyone. They appear as property book pages in the ModifyObject task of the Object Management role. These global plug-ins are detected by iManager when it starts up, and they do not need to be installed. The registration files for file system plug-ins require the <plugin> tag as the root element. These files are stored in SDK_HOME/tomcat/webapps/nps/portal/modules/moduleID/plugins.

NOTE:If you have not set up RBS, you access all plug-ins in Unrestricted Access mode, which allows you to view all roles and tasks even if you do not have sufficient rights to use them. You must set up RBS if you want to use the Plug-In Studio. For instructions, see Setting Up Role-Based Services. For more information about connection modes, see Section 2.5, Connection Modes.

The following example is part of an install file for a plug-in that is registered in eDirectory:

 <install>
   <module>
     <id>base</id>  
     <version>1.0</version> 
     <required-version>2.7.0</required-version> 
     <resource-properties-file>BaseResources</resource-properties-file> 
     <description-key>EDirModuleDescription</description-key> 
   </module>
   <role>
     <id>eDirectory Administration</id> 
     <version>1.0</version> 
     <display-name-key>eDirectoryAdministrationDisplayName</display-name-key> 
     <resource-properties-file>BaseResources</resource-properties-file> 
   </role>     
   <task>
     <id>base.CloneObjects</id> 
     <version>1.0</version> 
     <required-version>2.7.0</required-version> 
     <type>snapinTask</type> 
     <class-name>com.novell.imanage.base.CloneObjectTask</class-name> 
     <merge-template>base.CloneObject</merge-template>
     <display-name-key>CloneObjectTaskDisplayName</display-name-key>
     <description-key>CloneObjectsDescription</description-key>
     <error-template>dev.GenConf</error-template> 
     <resource-properties-file>BaseResources</resource-properties-file> 
     <role-assignment>eDirectory Administration</role-assignment>
     <rights-assignment>
       <attribute-name>[Entry Rights]</attribute-name>
       <privilege>Browse</privilege>
       <privilege>Write</privilege>
     </rights-assignment>
   </task>
 .
 .
 .
 </install>
 

The following is an example of an install file for a global plug-in:

 <plugins>
   <task>
     <id>dev.Book</id>
     <class-name>com.novell.emframe.dev.Book</class-name>
   </task>
   <task>
     <id>dev.Page</id>
     <class-name>com.novell.emframe.dev.Page</class-name>
   </task>
   <task>
     <id>dev.Empty</id>
     <class-name>com.novell.emframe.dev.EmptyTask</class-name>
   </task>
 </plugins>
 

For more information about the available elements for registration files, see Section 12.2, XML Schema for Installation and Registration Files.

3.5.1 Using the Create XML Install File Task

The iManager Base Content plug-in provides a task that simplifies the creation of plug-in registration files. It collects information about your plug-in, creates a registration file, and enables you to install the plug-in in the current tree. It can create new registration files or update existing files.

To access the Create XML Install File task:

  1. Log in to iManager.

  2. Click the Developer icon The Developer icon that appears at the top of the iManager page..

  3. Click iManager Development > Create XML Install File.

  4. Follow the Wizard steps. For help during the task creation process, click Help The icon that appears on tasks that provide help information to users.. When you have saved the registration file, click Next.

  5. If you want to install the plug-in that you have just defined into the current tree, specify the collection into which the plug-in will be installed, then click Install.

  6. Click Finish to complete the wizard.