IBM R1 manual Chapter Customizing Search, Customizing user searches

Page 50

Chapter 6

Customizing Search

You can perform these types of searches in the user interface:

User Search

The User Search page appears when you roster or manage users in the Users module, when you enroll users or change their results in the Course Management module, when you supply contact information in the Course Catalog, and when you work with locations, rooms, or instructors in the Resources module.

Offerings Catalog Search

The Advanced Search page appears when you click Advanced Search from the Offerings Catalog search page.

Course and Resources Searches

The Course Management module has search pages for courses. The Resources module has search pages for Locations, Rooms, Vendors, and Instructors.

You can add and remove search criteria from User and Offering Catalog search pages. You can remove criteria from Course and Resources search pages.

Customizing user searches

Information about rostered users is contained in an LDAP directory used by the Learning Management System. The User Search page allows you to search for people by using attributes that are typically found in an LDAP directory, as well as some attributes that are specific to the Learning Management System.

Adding LDAP attributes to User Search pages

The default LDAP attributes supported are: First Name, Last Name, Common Name, User ID, E- mail Address, Department Number, and Organization. To add support for other attributes (including attributes custom to your LDAP directory), follow these steps:

1.Modify the <ldap> section of the LMS settings.xml file to:

Add an entry in the <ldap> / <users> / <attributes> subsection for each attribute you want to include (if it is not there already). This subsection is already populated with a number of attributes that aren't shown on the User Search page (BusinessCategory, City, Employee Number, Employee Type, and so on).

For example, to add the attribute HealthPlanChoice, the attribute line would look like this:

<attribute name="HealthPlanChoice" type="java.lang.String" />

Make sure a mapping exists for the attribute in the appropriate object classes in the <ldap> / <users> subsection. This is especially important for attributes that are custom to your LDAP directory. For example, if the custom attribute is named planChoice in your LDAP directory, the mapping would look like this:

<mapping name="HealthPlanChoice" ldapAttribute="planChoice" />

2.Modify the <user> / <customAttributes> subsection of the LMS settings.xml file to add an <attribute> entry for the attribute you added in Step 1. For example, for the

Chapter 6: Customizing Search 45

Image 50
Contents Customization Guide List of Trademarks DisclaimerLicensed Materials Property of IBM Page Table of Contents Index Customization setsCreating a tab 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 Lmsform action=/prefSubmit.do % Editing an existing Help topicReplacing a context-sensitive Help topic Adding your own Help topic HREF=shnotifications.html target=topNotifications/Abr HREF=shenrolled.html target=topEnrolled courses/AbrChapter Customizing JavaServer Pages OverviewServerNameWEB-INFtld Anatomy of a TLD fileLMS JSP tag libraries Defining the url tag in the TLD file Referencing the url tag in a JSPString formName = request.getParameterformName Rtexprvaluetrue/rtexprvalue Attribute Tag ServerNameWEB-INFclassescomlotuselearntaglibDefining a page as a JSP Learning Management System serverAnatomy of a JSP Referencing Struts tags Localizing page contentIncluding tag library descriptor files 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 textPopulating a frameset in a JSP Displaying errors to the userScript language=JavaScript src=js/delivery.js/script 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 JSPSpecifying the next page to display Editing existing JSP tagsChanging the functionality of an individual JSP Editing form Bean values with the lmshidden tag Canceling the submission of a formSubmitting a form 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