Customizing HTML Views

All HTML pages displayed in the HTML Pane are generated dynamically based on predefined templates. The page template required to display an LDAP entry is chosen depending on the object class of the entry and, optionally, on the LDAP server where this entry is stored. If necessary, you can customize these templates to change how LDAP Administrator displays LDAP entries in the HTML Pane.

LDAP Administrator supplies HTML page templates for all commonly used and well-known object classes. If there is no template for an object class, the default template is used. If necessary, you can also customize the default template.

It is also possible to create custom views for any object class you need. For example, if you define your own LDAP object class, you can create an HTML template that will define how objects of this class will be displayed and edited in the HTML Pane.

HTML Page Templates

HTML page template is an HTML page that contains special placeholders that are replaced with corresponding data obtained from LDAP server at runtime. For example, if you want an HTML page to display the description attribute of an LDAP entry, you need to insert the following placeholder to the template of the page: ##ATTR_INFO:description##. When generating an HTML page, this placeholder will be replaced with the data necessary to display and edit the description attribute. For more details, please see Editing HTML Page Templates.

Each HTML Page template defines the representation of a specific LDAP object class. So, if you need to customize the view of a specific object class, you need to locate and modify the HTML page template that is used to display this class.

Locating HTML Templates

HTML page templates for LDAP object classes are stored in the 'HtmlView\html\entry' subfolder of the folder where LDAP Administrator is installed (by default - 'C:\Program Files\Softerra\LDAP Administrator\HtmlView\html\entry').

Templates for specific object classes are stored in folders named according to the object class name. For example, the template for the object class User will be located in the 'HtmlView\html\entry\objectclass_user' folder.

In case there is no template defined for an LDAP object class, the default template is used. The default template is located in the 'HtmlView/html/entry/default' folder.

The template for the representation of the RootDSE is located in folder 'HtmlView\html\entry\dntype_rootdse'.

Depending on the application interface language, the name of the template files is index.eng.html for English and index.deu.html for German.

Creating New HMTL Templates

LDAP Administrator provides predefined HTML page templates only for the commonly used object classes. If necessary, you can define a specific view for any LDAP object class by creating a custom HTML page template for this class.

To create a custom HTML page template for an object class, you need to create a new folder under 'HtmlView\html\entry' named objectclass_XXX, where XXX is the name of the object class, for which you want to create a new page template. For example, to create a specific template for the object class employee, you need to create folder 'HtmlView\html\entry\objectclass_employee'; in the new folder you need to create a template file named index.eng.html (for English) or index.deu.html (for German) and edit the content of the file. For more information, see Editing HTML Page Templates. It is highly recommended that you base your HTML page templates on the built-in templates supplied by LDAP Administrator.

Each new HTML page template should define these two constants and two scripts in its header:

<head>
    ...
   
    <script language="javascript">  
        var HTMLVIEW_PATH = '##HTML_PATH_WEB##/';
        var LANGUAGE = 'eng';
    </script>

    <script src="##HTML_PATH_WEB##/script/external/jQuery/jQueryLib.js"></script>
    <script src="##HTML_PATH_WEB##/script/Main.js"></script>
</head>

Creating Server-Specific HTML Templates

Along with the possibility to create custom representations for any LDAP object class, it is also possible to create different templates for displaying one and the same object class for different LDAP servers.

To create a server-specific HTML page template for an object class, in the folder where the template for the class is stored, create a new folder with a name that corresponds to the LDAP server. After this, in the new folder you need to create a template file named index.eng.html (for English) or index.deu.html (for German) and edit the content of the file.

For example, to create a custom view for the object class inetOrgPerson for OpenLDAP servers, you need to create a template file (e.g. index.eng.html) in folder 'HtmlView\html\entry\objectclass_inetOrgPerson\OpenLDAP'.

The following table contains names of the LDAP servers for which you can create customized views. Use server names from the table for the folder names when creating custom HTML page templates.

Apache	Isode	OpenDS
BEA WebLogic	MS Active Directory	OpenLDAP
Critical Path	MS ADAM	Oracle
Domino	MS Exchange	RedHat (Fedora)
IBM Lotus Domino	Netscape (iPlanet)	Siemens
IBM SecureWay	Novell
IBM zOS	OctetString