1.0 Introduction
2.0 Installation
3.0 Migrating Custom Tasks and Property Book Pages
3.1 What the Custom Task Migration Utility Does
3.2 Running the Custom Task Migration Utility
3.3 Installing the Migrated Tasks and Property Book Pages
4.0 Known Issues
4.1 MVOctetStringEditor Deprecated in iManager 2.0 or later
4.2 NumericStringEditor Deprecated in iManager 2.0 or later
5.0 Legal Notices
The Custom Task Migration Utility converts custom tasks and property book pages created with the Create iManager Task task in iManager 1.x to versions that you can install and run in iManager 2.5. The utility only converts tasks and pages developed entirely with Create iManager Task. To convert tasks and pages developed independently of Create iManager Task, including those developed with Create iManager Task that were subsequently modified by hand, use the ConvertToJsp and SnR utilities included with the iManager 2.X SDK. See the iManager 2.X SDK documentation for more information about these utilities.
IMPORTANT: In rare situations, the Custom Task Migration Utility might not be able to migrate your task or page. If this occurs, you need to recreate your task or page using the Plug-In Studio. The Custom Task Migration Utility was created to provide automated help in migrating iManager 1.x tasks and pages. Novell does not guarantee that the utility will work, and Novell will only provide limited support for it.
Tasks and pages created using Create iManager Task contain two files:
An HTML template file, which renders the HTML that iManager sends to the browser.
An XML file named install.xml for tasks or plugins.xml for property book pages.
Create iManager Task places the files in specific locations within the iManager 1.x directory structure. It also places a copy of these files in a ZIP file found in the TOMCAT_HOME/webapps/eMFrame/packages directory. The ZIP file itself is not used by iManager 1.x, but it is used by the migration utility to convert the files to iManager 2.5.
NOTE: Migrated tasks and pages cannot be modified in the iManager 2.x Plug-in Studio. Only tasks and pages that were created by the Plug-in Studio can be modified by it.
To install the Custom Task Migration Utility, unzip imanmig25.tgz to a directory of your choosing. This will create a subdirectory called iman25_migwiz.
The Custom Task Migration Utility
Finds the iManager 1.x directory and the iManager 2.5 custom.npm file
Extracts the iManager 1.x HTML template file (the file with an .htt extension) from the ZIP file located in the TOMCAT_HOME/webapps/eMFrame/packages directory
Converts the template file to a JSP file
Uses a pattern matching algorithm to locate and modify specific text in the JSP file so that it is compatible with iManager 2.5
Adds the resulting JSP page to the iManager 2.5 custom module by adding it to the custom.npm file, or creates a new custom.npm file if no custom.npm file is specified
Extracts the XML file from the same ZIP file from which the HTML template was taken
Modifies the XML and adds it to the custom.npm file for iManager 2.5.
NOTE: This utility was originally written to migrate
iManager 1.5 tasks to iManager 2.0. In the utility itself, you will
see reference to iManager 2.0. Ignore the iManager version. This
utility will still function correctly even though you are migrating
to iManager 2.5 instead of iManager 2.0.
To migrate your
custom tasks and property book pages:
Start the Custom Task Migration Utility. In Linux, execute migrate.sh. In Windows, execute migrate.bat. If you encounter problems, make sure that the PATH environment variable includes the path to your installation of JDK 1.4.x and that file permissions allow you to execute the file.
NOTE: The Custom Task Migration Utility is a Java application and should be able to run on any operating system where Java is installed. It was developed and tested with Java 1.4, which is the version of Java used by iManager 2.5.
In the iManager 1.x Directory field, enter the directory where iManager 1.x is installed. iManager 1.x is normally installed to run with Apache Tomcat. Tomcat and most other servlet container typically store files for Web applications like iManager in a directory called webapps. iManager is installed in a subdirectory of webapps named eMFrame. The exact location depends on the platform. The following are examples for some common iManager 1.x platforms:
In the iManager 2.0 Custom Module field, enter the directory of the iManager 2.5 custom module. If you have installed iManager 2.5 and have created custom tasks or property book pages with iManager 2.5, it created a module containing your customizations. This module is packaged in ZIP file format in a file called custom.npm. It is located in the packages directory under the iManager 2.5 directory structure. Like iManager 1.x, iManager 2.5 files are stored in a subdirectory of the servlet container webapps directory named nps. The following examples show the location of the custom.npm file for some common iManager 2.5 platforms:
If you do not have an existing custom.npm file, the utility creates a custom.npm file that contains only the tasks migrated from iManager 1.x in the directory that you specify. You can also leave the iManager 2.0 Custom Module field blank, and the new custom.npm file is created in the iManager 1.x directory.
The iManager 1.x Tasks area lists the iManager 1.x tasks that can be migrated. The iManager 2.0 Tasks box lists any existing iManager 2.5 tasks. Check the iManager 1.x tasks that you want to convert and click Migrate Tasks
(Conditional) If an iManager 1.x task already exists in iManager 2.5, the task name is italicized, and you will not be able to select that task. To migrate a duplicate task, you must first rename it. To rename a task, click Rename and enter a new name.
When the migration utility finishes converting the tasks, it displays a message dialog that reports how many tasks were migrated and the location of the custom.npm file. Make note of the location of the custom.npm file, then click OK.
To install the migrated tasks and property book pages:
1. Run iManager 2.5 and select the Configure button at the top of the iManager browser page.
2. Click Role Based Services > Plug-in Studio
3. Select Actions > Import
4. In the 'Collection:' field, input or browse to the RBS Collection object.
5. In the 'NPM file:' field, browse to the custom.npm generated by the Migration utility and select Import. Click Done when finished.
6. Restart Tomcat.
Tomcat sometimes requires several minutes to fully initialize. You might need to wait several minutes before you can connect to the iManager login page.
7. (Conditional) You might have iManager 1.x custom roles that contain only custom tasks and that were not re-created in your iManager 2.x collection after running the iManager Configuration Wizard with the Migrate a Previous Collection option. In this situation, re-create the roles in the 2.x collection and give them the exact same name they have in iManager 1.x. To do this, use the Create iManager Role task: Click the Configure button to show the Configure view. Click Role Based Services > RBS Configuration. On the 2.x Collection tab, click on the Collection where you want to create the role. Now select New > iManager Role, then complete the wizard.
a. Assign any custom property book pages to property books by going to Role Based Services > RBS Configuration. Click on the 2.x Collection you want to modify and then select the Property Book tab. Place a check in the box next to the property book you want to add a page to and then select Actions > Page List. You can now add the custom pages to the book.
8. Verify that the migrated tasks appear in the list of Roles and Tasks and that migrated property book pages appear in the property book. Use the Role Based Services > Edit Member Association task to add members to new roles.
This section lists problems that you might encounter while migrating iManager 1.x tasks and property book pages.
The MVOctetStringEditor control that is available in iManager 1.x is deprecated in iManager 2.0 and later. The migration utility cannot migrate tasks and pages that use this control.
The NumericStringEditor control that is available in iManager 1.x is deprecated in iManager 2.0 and later. The migration utility cannot migrate tasks and pages that use this control.
Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time, without obligation to notify any person or entity of such revisions or changes.
Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to notify any person or entity of such changes.
You may not export or re-export this product in violation of any applicable laws or regulations including, without limitation, U.S. export regulations or the laws of the country in which you reside.
Copyright © 2003-2004 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher.
Novell is a registered trademark of Novell, Inc. in the United States and other countries.
All third-party trademarks are the property of their respective owners.