user manual

Customization Guide June 2003
Learning Management System R1
sof twa re

Summary of content (94 pages)

Removing JSP tags from the page source has a powerful effect on the resulting pages in the interface. Remove with care.

  • 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.

  • PAGE 51

    attribute HealthPlanChoice, the attribute link would look like this: 3. Modify the LMS file, ApplicationResources.

  • PAGE 52

    Customizing Offerings Catalog searches The Learning Management System allows you to create a pool of custom fields that can be applied to course offerings to add more details. Adding custom fields to the Offerings Catalog The custom field editor appears when you click Edit at the bottom of a Course Details page. Although you add a field in the context of a single Course Offering, custom fields are available to anyone who creates a Course Offering.

  • PAGE 53

    Removing fields from the Search pages If you want to remove fields from the Search pages, edit the appropriate .jsp to remove the code for the text and text box that you want to remove. • Course searches: searchCourses.jsp • Location searches: searchLocation.jsp • Room searches: searchRoom.jsp • Instructor searches: searchInstructors.jsp • Vendor searches: searchVendor.

  • 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.

  • PAGE 55

    1. Copy the application’s Web directory on the LMM server to a new Web directory and give it an appropriate namefor example, SalesCSand then copy the application’s resource files to a directory with the new name: LMM CSS images etc. WEB-INF classes com resources LMM properties templates lib etc. Thus: LMM CSS images etc. SalesCS CSS images etc. WEB-INF classes com resources LMM properties templates SalesCS properties templates lib etc.

  • PAGE 56

    2. Make whatever changes you want to the JavaServer Pages, Cascading Style Sheets, image files, properties files, and templates in the SalesCS directory hierarchy. 3. When you’ve finished, replicate your work (except for the templates folder) on the Delivery server (or servers). 4. Install your custom Help system. This is a three-step process: a. Install the default Help system, which means creating a directory on an HTTP server (in this example, myServer.myCompany.

  • PAGE 57

    locations in the Delivery server directory tree. In that case, the resource directory would again be named SalesCS. • Delivery Server Web Directory the name of the directory in which the customization set’s JSPs, images, CSS, and (depending on your configuration) Help files reside (in this case, SalesCS) on the Delivery server(s). • Matching Sting Typethe type of LDAP entity (user, group, or attribute) identified by the matching string you enter below.

  • PAGE 58

    Table of sample matching strings Type User Example Fulano de Tal/Cambridge/IBM cn=Fulano de Tal,ou=Cambridge,o=IBM cn=Jan Doe,ou=West5,ou=Weston,o=IBM Group Attribute */Cambridge/IBM *,ou=Cambridge,o=IBM * GroupCD/Groups/whatever cn=GroupCD,ou=Groups,o=whatever preferredLanguage=fr preferredLanguage=* preferredLanguage preferredLanguage= preferredLanguage!=* preferredLanguage!= preferredLanguage!=fr departmentNumber=1* sn=Jones matches A person (Fulano de Tal) at IBM in Cambridge Same as above A perso

  • PAGE 59

    • 6. Use text unchecked, the customization set uses the files in the LMM properties directory; checked, the files in the customization set’s properties directory are to be used. Reboot the server(s) to complete the process of defining and assigning the customization. Installing a customization set on the Offline Learning Client You can create what are, in effect, customization sets for use on the Offline Learning Client. To do this: 1.

  • PAGE 60

    file, inserting the custom files in the appropriate locations, overwriting any files in the default installation that have custom counterparts. Finally, if you changed lmsBrandingAbout.gif and included it in the Zip file (and the user entered the path to the Zip file at install time), the user will see the custom graphic file in the About box when he or she runs the Offline Learning Client. If you changed aboutDS.jsp and created a graphic for it (myAboutGraphic.

  • PAGE 61

    56 IBM Lotus Learning Management System Release 1 Customization Guide

  • PAGE 62

    Chapter 8 Creating a tab You can create a custom tabbed page to display along with the standard tabbed pages―Home, Student Catalog, Users, and so on. What you have to do to accomplish this depends on the sort of content you want the page to have. At a minimum, you need to do the following: 1. Create a JavaServer Page with the content you want to display when the user selects the tab. 2. Add a permission to the PERMISSION database table to control access to the page. (See “Adding custom Permissions.”) 3.

  • PAGE 63

    navigationTab.users = Users users.manageUsers.task = Manage Users The navigationTab.users and users.manageUsers.task resources in turn are specified in the

  • PAGE 69

    the user clicks Continue in the User search page and rostering has been successful] fail [the message box displayed when the user clicks Continue in the User search page and rostering has been unsuccessful] [group search, roster from file, auto-roster trails] ManageRoles etc. ManageProfiles etc. ManageUsers etc.

  • PAGE 70

    The tag: page names and resourced text The tag specifies the string to be used in the resource file ApplicationResources.properties when defining text elements displayed by a JSP. By convention, if a JSP is a link in a trail, its name is qualified by the name of the JSP that invoked it. So, for example, users is the name of the page from which the page named rosterUsers is invoked, and users.rosterUsers.desc is the string that ApplicationResources.

  • PAGE 71

    If you don’t want to display the breadcrumbs for a given JSP, you can include the tag in the or block and set it to yes. For example, you could suppress the breadcrumbs in the roster users confirmation box shown above as follows: confirm /default.do usersRosterConfirm.jsp users.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/ibm/webcam-r1/user-manual-english/page-72.html>PAGE 72</a></h6><p>The <title> tag: title bar text The <title> tag tag specifies the string in ApplicationResources.properties whose definition is displayed in the JSP’s title bar. The <permissions> tag: permission to display the page The <permissions> tag specifies the name of the permission (as it appears in the PERMISSION table in the LMS database) that a user needs to have been granted in order to display the JSP. Permissions and how to create them are described in “Adding custom permissions.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/ibm/webcam-r1/user-manual-english/page-73.html>PAGE 73</a></h6><p>PERMISSION table Field oid name perm_id description Datatype CHAR(20) VARCHAR(128) INTN VARCHAR(255) Allow Nulls N N N Y category INTN Y status updatetime CHAR(1) DATETIME Y Y Values nnnnnnnnnnnnnn00PERM X_Y n A description of what the permission allows a user to do -1 = checked method, 0 = Home, 1 = Student Catalog, 2 = Course Catalog, 3 = Users, 4 = Course Management, 5 = Resources, 6 = Reports, 7 = Settings A = active, I = inactive, D = delete The application supplies the date and time the reco</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/ibm/webcam-r1/user-manual-english/page-74.html>PAGE 74</a></h6><p>Sample PERMISSION records OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME OID PERM_ID NAME DESCRIPTION CATEGORY STATUS UPDATETIME 0000000000000000PERM 0 Home_Module Permission to see Home module 0 A 0000000000000100PERM 1 Home_Weeks_Activities View this week’s activities 0 A 00</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/ibm/webcam-r1/user-manual-english/page-75.html>PAGE 75</a></h6><p>CASCADED_PERMISSION table Field child_oid parent_oid Datatype CHAR(20) CHAR(20) Allow Null N N Values nnnnnnnnnnnnnn00PERM mmmmmmmmmmmmmm00PERM As mentioned earlier, if a user has been granted the parent permission, he or she is automatically granted the child permission. For example, a user who has been granted permission to manage user roles is automatically given permission to add roles to the system, that is, to execute the addRole method.</p></li><li><h6><a class="text-decoration-none text-link fw-bold" href=/manual/ibm/webcam-r1/user-manual-english/page-76.html>PAGE 76</a></h6><p><module> <name>users</name> <target>/userManagementInit.do</target> <content>users.jsp</content> <label>navigationTab.users</label> <title>users.manageUsers.task User_Management courseadmin/ch_users_overview.html … Example The following example describes the process of adding and granting access to a simple custom tabbed page (customTab.jsp) with links to two other pages (customHello.jsp and customGoodbye.jsp).

  • PAGE 77

    ------------------------------------------------------------------------%>

  • PAGE 78

    <%-----------------------------------------------------------------------END Hello ------------------------------------------------------------------------%> <%-----------------------------------------------------------------------START Goodbye ------------------------------------------------------------------------%>

  • PAGE 79

  • <%----------------------------------------------------------------------END Index Content Area ------------------------------------------------------------------------%> When a user with the appropriate permissions displays customTab.jsp, the page will look like this: The first linked page (customHello.jsp) looks like this: <%--------------------------------------------------------------------customHello.jsp Copyright (c) 2003, IBM Corporation. All rights reserved.

  • PAGE 80

  • PAGE 81

    ---------------------------------------------------------------------BEGIN Done button -----------------------------------------------------------------------%>

    PAGE 82

    The second linked page (customGoodbye.jsp) looks like this: <%--------------------------------------------------------------------customGoodbye.jsp Copyright (c) 2003, IBM Corporation. All rights reserved. Created: 05-30-02 The goodbye page for the auto greetings trail. ---------------------------------------------------------------------%> <%@ taglib uri="/WEB-INF/tld/lms.

  • PAGE 83

    PAGE 84

    2. Create Help files You need to associate a Help topic with each JSP so that when the user clicks? to display contextsensitive Help, the application will not display the Page Not Found screen. You could, of course, send the user to the index or table of contents or some other existing Help topic, but for the sake of illustration, assume that you would create a topic appropriate to the custom JSPs. You would then copy these files to the English-language course administrator Help directory (...

  • PAGE 85

    Greetings PAGE 86

    See “Chapter 4: Customizing Help” for instructions on how to create custom Help topics. 3. Add permissions to the LMS database A user needs permission to display the tabbed page and its two links. As in the case of Help, you could use existing permissions (making the appropriate changes in customTab.jsp’s blocks and in navigation.xml’s tag), but custom permissions give you more precise control over access.

  • PAGE 87

    INSERT INTO PERMISSION (OID, PERM_ID, NAME, DESCRIPTION, CATEGORY, STATUS) VALUES ('000000000042100PERM', 421,'Custom_Tab', 'Access Greetings page',7, 'A'); INSERT INTO PERMISSION (OID, PERM_ID, NAME, DESCRIPTION, CATEGORY, STATUS) VALUES ('000000000042200PERM', 422,'Say_Hello', 'Display Hello mesage',7, 'A'); INSERT INTO PERMISSION (OID, PERM_ID, NAME, DESCRIPTION, CATEGORY, STATUS) VALUES ('000000000042300PERM', 423,'Say_Goodbye', 'Display Goodbye message',7, 'A'); 4. Edit ApplicationResources.

  • PAGE 88

    Say_Hello.name = Say Hello Say_Goodbye = Display Goodbye message Say_Goodbye.name = Say Goodbye 5. Edit navigation.xml You need to add a block to navigation.xml to display the custom (Greetings) tab and the custom pages associated with it ( customTab.jsp, customHello.jsp and customGoodbye.jsp). Where you place this block relative to the other blocks in the file determines the order in which the tab appears with respect to the other tabs in the user interface.

  • PAGE 89

    customGoodbye.jsp customTab.goodbye.title courseadmin/ch_customtab.html studenthome etc. 6. Assign permissions Users need to be granted permission to display the tabbed page and either or both of the pages to which it offers links. You grant permissions through the LMS user interface.

  • PAGE 90

    To create a role and assign it to users: 1. Open the Users page and click Manage Roles. 2. Click Add Role. 3. Enter the name of the new role (for example, Greetings) and a description of what users assigned that role can do. 4. Click on the name of the role when it appears in the Roles page. 5. Select the permission category in which the permissions are listed (in this case, Settings). 6. Check the appropriate boxes and save your work. 7. Back out to the Users main page and click Manage Users.

  • PAGE 91

    86 IBM Lotus Learning Management System Release 1 Customization Guide

  • PAGE 92

    Index abbreviations, 2 acronyms, 2 catalog, 47 context-sensitive Help, 16 course offerings, 47 CSS files adding custom, 34 editing, 34 replacing, 34 custom fields, 47 customization sets, 49 applying, 32 creating, 49 installing on the Offline Learning Client, 54 Delivery Server activity.jsp file, 30 delivery.

  • PAGE 93

    Tag library descriptor files(TLD files), 20 users, 45 text XML settings files, 5 resourcing globally, 35 88 IBM Lotus Learning Management System Release 1 Customization Guide

  • PAGE 94

    Printed in USA