IBM R1 manual Chapter Customization sets, Creating a customization set

Page 54

Chapter 7

Customization sets

You can create what are in effect alternative versions of the application and send specified users to one or another of these rather than to the default interface when they log in. To do this, you copy the directories containing the files you want to change (or replace) into a directory structure that mimics your original, make your changes, and then, in the Administrator interface, specify the location of the customized files and the users to whom the interface that they define is applicable. These alternative sets of files and the information concerning their location and use are called customization sets.

The advantage of customization sets is that you can tailor the application’s look and feel and functionality for different sets of users rather than having to make global changes that affect all users. For example, you might want to create customization sets for different users based on their membership in one or the other of two different LDAP groups, providing one user interface and feature set for, say, users belonging to the Sales group and another for users in the Development group.

A customization set can include custom versions of any or all of the following:

The branding logo. This is the graphic that the application displays in the upper left corner of each page.

Images. These GIF files include icons, buttons, bullets, and the like, which you can edit or replace.

Help. See “Customizing Help” for a description of the Help system, how it works, and how you can customize it.

Cascading Style Sheets (CSSs). These control such display attributes as color and font.

JavaServer Pages (JSPs). See “Customizing JavaServer Pages” for a description of the various ways in which you can customize the application’s JSPs.

E-mail and notification templates. These files contain the resourced static text that appears in e-mail and other messages in the application.

Properties files. These files contain the resourced static text that appears elsewhere in the applicationlabels, button text, error message text, and so on.

The logoff URL. This is URL of the page to which the user is sent when he or she logs out of the application.

The information that you specify in the Administrator interface when you create a customization set on the LMM server is automatically communicated to the Delivery server (or servers). However, if you create a directory structure to hold custom files on the LMM server, you need to create a comparable structure on the Delivery server (or servers) and populate it with custom files if you want your changes to be uniform across the application. Similarly, if you have deployed the application such that some of the files the application uses are stored on an HTTP server, you need to copy their customized counterparts to the appropriate location or locations on that server.

Creating a customization set

The following steps assume that you’re creating a customization set on the LMM server for the users belonging to the LDAP group Sales and that, for simplicity, all the files of interest reside on the LMM server and that you want the customization set to use custom style sheets, images, resource strings and templates, and a customized Help system:

Chapter 7: Customization sets 49

Image 54
Contents Customization Guide Disclaimer Licensed Materials Property of IBMList of Trademarks Page Table of Contents Customization sets Creating a tabIndex Customizing the user interface Disclaimer and a word about conventions Acronyms and abbreviationsAcronym or What it stands for Abbreviation Page Chapter Changing settings through the user interface or XML Changing settingsPage Chapter Controlling access to features through permissions To add a role to the systemTo automatically assign a role to a user To modify permissions settings for an existing roleTo assign a role to a user To explicitly assign a role to a userControlling access to features Page Chapter Customizing Help Anatomy of a Help topicScript Mosaic-bg Background-repeat repeat-xScript Head Editing an existing Help topic Replacing a context-sensitive Help topicLmsform action=/prefSubmit.do % Adding your own Help topic HREF=shnotifications.html target=topNotifications/Abr HREF=shenrolled.html target=topEnrolled courses/AbrChapter Customizing JavaServer Pages OverviewAnatomy of a TLD file LMS JSP tag librariesServerNameWEB-INFtld Referencing the url tag in a JSP String formName = request.getParameterformNameDefining the url tag in the TLD file Rtexprvaluetrue/rtexprvalue Attribute Tag ServerNameWEB-INFclassescomlotuselearntaglibLearning Management System server Anatomy of a JSPDefining a page as a JSP Localizing page content Including tag library descriptor filesReferencing Struts tags Including JavaScript source code Including the JSPs that comprise the main templateDiv class=formBoxPositionInner Td class=formBoxTitleBg colspan=3 valign=middle nowrapLogicnotPresent LogicnotMatch DivLogicnotPresent logicpresent name=invalidForm LogicpresentDelivery server Localizing page textDisplaying errors to the user Script language=JavaScript src=js/delivery.js/scriptPopulating a frameset in a JSP Defining resizable frames Making global changes Frameset HtmlApplying customization sets Changing the application styleLanguage-version Editing existing CSS filesServerNamecsslanguageCodebrowserType Browser-versionChanging the font size or font style of the application Adding your own CSS filesReplacing CSS files @import urlmyStyles.cssUpdating page text ServerNameWEB-INFclassesresourcesserverNamepropertiesAdding and replacing graphics Titlelmsmessage key=application.title //titleApplication.title = IBM Lotus Learning Management System Lmslinklmsimg src=images/name.gif… //lmslinkImage.alt.logo = IBM Lotus Learning Management System Replacing the application logoLearning Management System server Delivery serverDeliverylogoURL resource=images/myCompanyLogo.gif Changing individual JSPsReplacing a reference to a CSS style Changing the style of an individual JSPEditing existing JSP tags Changing the functionality of an individual JSPSpecifying the next page to display Canceling the submission of a form Submitting a formEditing form Bean values with the lmshidden tag Lmshidden property=userEvent Removing JSP tagsLmshidden name=%=formName% property=unmodifiedKeywords Custom fieldsIt then checks to see if its a text box type field LogicnotPresent Logicequal Page Adding Ldap attributes to User Search pages Chapter Customizing SearchCustomizing user searches Attribute name=HealthPlanChoice type=java.lang.StringHealthPlanChoice = Employees Health Plan Removing fields from User Search pagesAdding custom fields to the Offerings Catalog Customizing Offerings Catalog searchesCustomizing course management and resource searches Removing fields from Offerings Search pagesRemoving fields from the Search pages Chapter Customization sets Creating a customization setLMM De en etc. SalesCS De en EtcPage Attribute Name Type Modified Size Path Customization sets Page Chapter Creating a tab UsersUsers.jsp @ taglib uri=/WEB-INF/tld/lms.tld prefix=lms %Td width=1 valign=top Page Users.rosterUsers.subtitle = Roster Users Navigation.xml Users.rosterUsers.search Users.rosterUsers.search.confirmTrail TrailManageProfiles TrailTrail TrailManageRoles Trail TrailManageUsersTarget tag struts action-mapping Content tag JSP file namesName tag page names and resourced text Label tag breadcrumbsUsers.rosterUsers.search.confirm Permissions tag permission to display Adding custom permissionsTitle tag title bar text HelpPage tag context-sensitive HelpName UpdatetimeOid Permid0000000000000000PERM 0000000000003000PERM 0000000000009300PERM Example Copy the JSPsPage Creating a tab END Index Content Area Creating a tab Div Second linked page customGoodbye.jsp looks like this Page Customtab.html Create Help filesCustomtabb.html Add permissions to the LMS database Select Maxpermid from PermissionEdit ApplicationResources.properties Edit navigation.xml NavigationNamestudenthome/name Assign permissionsCreating a tab Page Index