iMgrXML

0 Likes

iMgrXML will provide useful troubleshooting hints for developers who create their own custom iManager modules.



iMgrXML will check for ...
  • availability of classes and attributes

  • referenced property files

  • referenced JSP templates


iMgrXML takes care of ...
  • INSTALL files ( /nps/portal/modules/[myModule]/install/*.xml)

  • PLUGIN files ( /nps/portal/modules/[myModule]/plugins/*.xml)

  • schema translation files ( /nps/portal/modules/[myModule]/plugins/*.xml)


Usage:



  • If possible, login to the target tree where iManager will be running.
    You'll get best results if you have Win32 file system access to the /nps/portal/modules path


  • Start the program and select the correct tree and XML file

    You may run the tool in various modes:


  • "Online-Live": You are online (connected to the correct target tree) and select the 'live' XML file (the one that is used by iManager)

    This is the recommended and most reliable mode, since it can run more thorough checks.


  • "Online-Copy": You are online (connected to the correct target tree) but do not select the 'live' XML file.

    Instead you may be using a local copy of the XML file. Sometimes this is the only alternative, e.g. if there is no direct client access to the XML like in some Linux environments

    This is the second-best mode


  • "Offline-Copy": You are offline (not connected to the correct target tree)

    This mode can still detect many issues, but the results may require more interpretation


  • Click on a warning message to locate the problem segment in the XML file


  • You can right-click on a report to save the text to a file



Warning Messages, possible causes and remedies:



Msg 001: Schema - Attribute not found


Explanation:

The requested schema attribute is not found in the current tree.

Remedy:

Offline mode: acceptable, since the live schema is not accessible

Online mode: Critical: there may be a attribute name typo in the XML or a missing schema extension



Msg 002: Auxiliary Attribute

Explanation:

The requested attribute is not found in the schema, but not assigned to the selected target class.

Remedy:

Offline mode: acceptable, if you are connected to a different tree

Online mode: acceptable, if the attribute is assigned to an auxiliary class which is assigned to the target object

make sure that the auxiliary class is referenced in the JSP (eDir$target$auxillaryClassExtension)




Msg 003: Key not found

Explanation:

A property key (used to load display names) is not found in a properties file.

Acceptable, if you do not have access to the properties file, or the properties file is packed in a JAR (e.g., eMFrame.jar)

Remedy:

If the properties file is not packed in a JAR, check the spelling and the path




Msg 004: File not found

Explanation:

A referenced JSP file cannot be located.

Acceptable, if you do not have access to the file system that contains the JSP

Remedy:

If required, check the spelling and the path




Msg 006: Schema - Class not found

Explanation:

The requested schema class is not found in the current tree.

Remedy:

Offline mode: acceptable, since the live schema is not accessible

Online mode: Critical: there may be a class name typo in the XML or a missing schema extension




Msg 007: Unknown Role ID

Explanation:

The analysed task refers to a task which is not defined in this XML file

Remedy:

This may acceptable if the role ID refers to a role, which is declared somewhere else.

Alternatively add a section to declare this role, or fix a role name typo




Msg 008: Duplicate ID

Explanation:

The analysed task declares the same ID more than once

Remedy:

IDs must be unique. Edit the XML and remove duplicates




Msg 009: Bad Class Name

Explanation:

The class name contains invalid characters (e.g. blanks)

Remedy:

Replace invalid characters by "_"




Msg 010: Missing JSP

Explanation:

A referenced JSP file cannot be located

Remedy:

Offline mode: acceptable, if you do not have file access to the referenced JSP file

Online mode: check the spelling and the path of the JSP file




Msg 100: XML Error

Explanation:

The XML syntax is not correct. Check the message for details.

Remedy:

Change the file and make it conform to the XML syntax




Labels:

Collateral
Comment List
Anonymous
Related Discussions
Recommended