2921103.1
Rev.: 2010-Jan-29
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
E-mail:
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com
Copyright © by Open Text Corporation, Open Text Inc.
Open Text Corporation is the owner of the trademarks Open Text, The Content Experts, Great Minds Working Together, Livelink, Livelink ECM, Livelink ECM-eDOCS, Livelink MeetingZone, MeetingZone, B2BScene, B2BScene.com, Client/Surfer, Collaboration, Creative Desktop, Further Faster, Hyperinnovation, Internet Anywhere ,Livelink IRIMS, IRIMS, IXOS, Livelink OnTime, OnTime, Livelink Remote Cache, Microstar, MyLivelink, O & Design, Odesta, Odesta Helix, Odesta Livelink, Open Text Intranet, Open Text Web Index, Personality +, Putting Knowledge To Work, Techlib, The Hyperlinked Organization, The Source For Business Knowledge, Worksmart, and World Of E among others. This list is not exhaustive.
ACKNOWLEDGEMENTS
SAP®, R/3® and SAP ArchiveLink® are registered trademarks of SAP AG.
Adobe® is a trademark of Adobe Systems Incorporated.
Lotus® and Lotus Notes® are registered trademarks of Lotus Development Corporation. Domino is a trademark of Lotus Development Corporation.
Microsoft®, Microsoft SQL®, and Microsoft SharePoint® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Oracle® is a registered trademark of Oracle Corporation.
Netscape and the Netscape N and Ship's Wheel logos are registered trademarks of Netscape Communications Corporation in the U.S. and other countries.
Firefox® is a registered trademark of the Mozilla Foundation.
Sentry Spelling-Checker Engine Copyright © 2000 Wintertree Software Inc.
WordNet 2.0 Copyright © 2003 by Princeton University. All rights reserved.
Outside In® Viewing Technology © 1992-2002 Stellent Chicago, Inc. All rights reserved. Outside In® HTML Export © 2002 Stellent Chicago, Inc. All rights reserved.
Portions of eDOCS DM are copyrighted by DataDirect Technologies, 1991-2002.
All other products or company names are used for identification purposes only, and are trademarks of their respective owners. All rights reserved.
3
Contents
Preface 11
About Open Text Collections Server (Formerly BASIS) and Open Text Library Management (Formerly Techlib) 12
References to BASIS in Documentation 12
References to Techib in Documentation 12
Collections Server Documentation 13
1.1 Library Management 13
1.2 Collections Server 13
1.3 Open Text Collections Server Webtop Suite 14
Overview of Library Management Architecture 17
2.1 Library Management OPAC Options 18
2.1.1 Open Text Library Management Integration 18
2.1.2 Collections Server Webtop OPAC 19
2.2 Three-Tier Architecture for the Library Staff Modules 19
Database Concepts 21
3.1 Collections Server Databases 21
3.1.1 Definition Database 23
3.1.2 Record Database 23
3.1.3 Thesaurus Database 23
3.2 Definition Database Structure 23
3.2.1 Actual Data Model 24
3.2.2 User Data Model 25
3.2.3 Structural Data Model 25
3.3 Database Creation 26
3.4 Record Relationships in Library Management 27
Database Security 31
4.1 Registering and Authorizing Users to Library Management 31
4.1.1 Displaying Registrations and Authorizations 33
4.1.2 Modifying or Deleting Registrations and Authorizations 33
4.1.3 Using a Procedure to Register and Authorize Many Users 35
4.2 Controlling Access to Modules and Tasks 36
4.3 Using Staff Security Task to Register and Authorize Users 36
4.3.1 Setting up the Staff Security Task to Register and Authorize Users 36
4.3.2 How the Staff Security Task to Register and Authorize Users Works 37
Performing Routine Maintenance 39
5.1 Establishing Backup and Recovery Procedures 39
Customizing Your Application 41
6.1 Change Management 42
6.1.1 Back up Application Before Making Changes 43
6.1.2 Set up a Test Area 43
6.1.3 Back up the Application Regularly 44
6.1.4 Prepare for Upgrades 44
6.2 Changing Profiling and System Settings from within the Application 44
6.3 Customizing Library Management Routines 45
Function Calls 46
Variable Names 46
6.4 Enabling References 46
6.5 Adding a Custom page 47
Directory Structure 49
File Naming Conventions 51
8.1 General Active Server Pages 51
8.2 Menu Pages 53
8.3 Reports 53
8.3.1 Report Lists 53
8.3.2 Report Pages and Report Layout for JasperReports 53
8.4 Images 54
8.4.1 Side Images 54
8.4.2 Top Images 54
8.4.3 Toolbar buttons 55
8.4.4 Toolbar icons 55
8.5 Include Files 56
Specifying Number of Result Set Members 56
Changing the Name of the Virtual Directory 56
Specifying Size of Acquisitions Request Lists 56
Specifying Number of Days Requests Displayed After Close 57
Changing the JasperReports locations 57
8.6 ActiveX Files 57
Customizing Graphics 60
9.1 Graphic Composition 60
9.1.1 Image sizes 62
9.2 Location of the Photoshop Graphic Files 62
9.3 Replacing Graphics 62
9.3.1 Login Form 62
9.3.2 Top Menu (Modules) 63
9.3.3 Side Menu (Tasks and Subtasks) 63
Example 64
Changing Database Server Connection Information 67
10.1 Changing a Data Source 67
10.2 Adding a Data Source 68
10.3 Adding/Changing Database Names on the Login Form 69
Changing Form Text and Field Labels 71
11.1 Changing a Field Label 71
11.2 Modifying the Table on the Check-out, Check-in, and Renew Forms 72
11.3 Changing from the Demonstration OPAC to the Actual OPAC 75
11.3.1 Changing the Default Database for Webtop OPAC 76
11.3.2 Changing the OPAC 76
11.3.3 Changing the Web Server OPAC URL 76
11.3.4 Changing to an External OPAC 76
11.4 Changing and Adding Resources URLs 76
11.5 Remove Database Information from Banner Hover Text 78
11.6 Report Maintenance Translation Tables 78
11.7 Changing State and Province List Order 78
Adding and Changing Fields 79
12.1 Determine Whether the Field is Defined in the Library Management Database 79
12.2 If Necessary, Revise and Apply Changes to the Database Definition 80
12.2.1 Some Dos and Don'ts for Modifying the DDB 81
DO 81
DON'T 82
12.2.2 Examples of Adding a Field and Changing a Field-Level Help 82
Example 1: Adding a Field 82
Example 2: Changing Field-Level Help for a Field 84
12.2.3 Applying the Revised Definition to the Database 86
Example: Entering and Applying Revised Definition to the Database 87
12.3 If Necessary, Create an Index for the Field 87
Example of Adding an Index After a Database Has Been Loaded 87
12.4 Determine Which Active Server Page to Modify 90
Example 1 90
Example 2 90
12.5 Determine the Type of Field 92
12.5.1 Simple Input Box 92
12.5.2 Textarea Box 93
Generic Example 94
12.5.3 Drop-Down Box (Word List or Code List) 94
Generic Example 94
12.5.4 Drop-Down Box (Values from Another Record Type) 95
Controlling Vendor Display 95
12.5.5 Display Only 95
Generic Example 96
12.5.6 Checkbox 96
Generic Example 96
12.6 Update the Active Server Pages 97
Example 1: Adding a Field Label and Checkbox to an ASP 97
Example 2: Adding a Field Label and Textarea Box 99
12.7 Update the Translation Table 99
Example 1 100
Example 2 100
12.8 Test the Changes 100
Example 1 100
Example 2 101
Customizing Authority Control 102
13.1 Modifying Authority Control Messages 103
13.2 Removing Search Control 104
13.3 Removing Data Validation 104
13.4 Removing Authority Control 104
13.5 Changing Thesaurus Databases/Authority Controlled Fields 105
13.6 Changing Term Relationship Names 106
13.7 Recognizing Trailing Periods 107
Adding Barcode Reader Support 108
14.1 Setting up Your Barcode Reader 109
14.2 Customizing Barcodes 109
14.3 Adding Barcode Support to a Form 109
Customizing Reports 112
15.1 Reports Overview 112
15.2 Using JasperReports 113
15.2.1 Making Library Management Reports Accessible to JasperReports 113
Using newer versions of iReport 113
Setting up a JDBC Resource for the Library Management Reports Database and iReport 113
15.2.2 JasperReports Generation Workflow 113
15.2.3 Role of a Report's ASP 114
Logic in Report ASPs 117
Defining the Report Item Tables in an ASP 118
Processing Virtual Columns 118
Updating the Collections Server Database 119
15.2.4 Role of the Access Reports Database 119
Basic Report Table 119
Report Item Tables 120
Role of JasperReports 121
Longevity of Browser Versions of Reports 121
Longevity of JasperReports Versions of Reports 121
Example of Rearranging Report Format and Removing a Field 122
Example of Adding Fields to a Report 124
15.2.6 Creating a New JasperReport 126
Some Tips for Creating New JasperReport Files 126
15.3 Creating a Report by Using an Existing Collections Server Procedure 127
15.3.1 Scope 127
15.3.2 Definitions 128
15.3.3 Reading the PROC 129
Text Records 129
FQM 129
Notes on LIBR_KEY Columns 129
Multiple Entities 129
Special Columns 130
15.3.4 Running a Collections Server PROC from the Library Management Interface 130
Overview 130
Creating the ASP page 130
Testing 131
Customizing Help Topics 132
16.1 Overview of Help Topics Relationships and Navigation 133
16.2 The Help Topics Search and Search Summary Forms 135
16.3 The Help Topics Thesauri 137
16.3.1 Titles Thesaurus 137
16.3.2 Keywrds Thesaurus 137
16.3.3 Revising Thesauri using Bulk Updates 138
16.4 The Help Topics Database 140
16.4.1 Checking Out and Modifying a Help Topic using Webtop 140
16.4.2 Checking In a Help Topic using Webtop 141
16.5 Understanding Syntax in ASPs for Help Topics 144
16.5.1 Linking Topics Together 144
16.5.2 Referencing Database Objects (Figures) within a Topic 145
16.5.3 Referencing File Objects (Buttons and Icons) within a Topic 145
16.5.4 Making Syntax Adjustments Before Checking Topics into the Database 146
16.5.5 Displaying Topic Content 146
16.6 Localizing and Customizing Topic Content 148
16.6.1. Topic Content 148
16.7 Modifying Help Topics Using the Administration Module 148
16.7.1 Exporting and Importing Help Topics 149
16.7.1.1 Making Exported Help Topics Available to Users 149
16.7.2 Administering Update Help Topics Access 150
Batch Delete Procedures 151
17.1 Delete Invoice Records (INVDEL.PRC) 151
17.2 Delete Order Records (PODEL.PRC) 152
17.3 Delete Prediction Records (PREDDEL.PRC) 154
17.4 Delete Subscription Records (SUBDEL.PRC) 155
Manipulating Date and Time Formats 156
18.1 Output Formats for Date and Time 157
18.2 Date Format and DM Locale Pattern 158
18.3 Adjusting Timeout Settings 158
18.3.1. ASP Session Timeout and Idle Timeout for the IIS application pool 158
18.3.2. Collections Server Timeout 158
18.3.3. Factors in Adjusting Timeout Settings 159
18.4 Specifying Local Library Time 160
Configuring Single Sign-on and Directory Services Integration 162
19.1 Using SSO 162
19.2 Changing the LDAP/SSO Settings 163
19.2.1 Changing LDAP/SSO Features Setup 163
19.2.2 Changing the LDAP Server Information 165
19.2.3 LDAP Directory Connection Field Descriptions 167
19.2.4 Defining LDAP Directory/Patron Record Mapping 169
19.3 Turning on the SSO/LDAP Features 170
19.4 SSO Authentication/Alternate User IDs 170
19.5 SSO/LDAP System Administrator User 171
Setting Up the Patron Notifications Feature 172
20.1 Adding Query Parameter Records 172
20.2 Adding Query Records 174
20.3 Setting Up the FQM Command Procedure 175
Using Cascading Style Sheets 177
Troubleshooting 179
22.1 Complex Report Error 179
22.2 Administering Digital Content Display 181
22.3 Specifying the Digital Content Module Temporary Directory 181
22.4 Reports Display Problems Using Internet Explorer 7.0 181
22.5 Turning off Concept Extraction 181
Titles Thesaurus 182
Index 189
169
Preface
Library Management is an integrated suite of modules that not only provide patron access to library collections and digital documents but also manage cataloging, circulation, serials control, and acquisitions functions. The Open Text Library Management Administration/Customization Guide is intended for system administrators (SAs), database administrators (DBAs) and Webmasters who will be customizing and maintaining Library Management. This application for special libraries and information centers is supported by Open Text Collections Server, which manages the application's databases.
This document is available in online form. For the latest version, go to the Documentation folder on the Collections Server and Library Management Support page at:
https://knowledge.opentext.com/
The user interface for the application employs Microsoft Active Server Pages (ASP). In the ASP environment the logic (or code) resides within each page, and a page is used to produce a form that appears within your browser. Some of the application logic is incorporated into customizable ActiveX controls. In addition, you can change the root directory name, Open DataBase Connectivity (ODBC) resources, form text, graphics, field labels, reports, and help topics; and you can add and change fields.
This guide is part of a suite of online documentation about Library Management. Within this guide are references to various Collections Server manuals, where you will find more detailed descriptions of various processes that support the administration and customization of Library Management. The availability of Collections Server manuals is described in the document ‘About documentation…’ on the Knowledge Center at https://knowledge.opentext.com/knowledge/llisapi.dll/open/2098858. Review your license agreement to learn which Collections Server and Library Management modules you are licensed to use. If, for example, you have a single application license for Library Management but not for Collections Server, you can use Collections Server only to administer and customize Library Management, not to develop your own Collections Server databases.
About Open Text Collections Server (Formerly BASIS) and Open Text Library Management (Formerly Techlib)
Open Text is changing the names of some products. Our content solutions for libraries and archives, BASIS and Techlib, are among the products being renamed. During the interim you will see references to both the legacy and new product names
BASIS Server / Livelink ECM - Collections Server / Open Text Collections Server
BASIS Techlib / Livelink ECM - Library Management
Livelink for Libraries / Open Text Library Management
BASIS Webtop / Livelink ECM - Collections Server Webtop / Open Text Collections Server Webtop Suite
Livelink Activator for BASIS / Livelink ECM - Collections Server Integration / Open Text Collections Server Integration
Livelink Cataloged Library / Livelink ECM - Library Management Integration / Open Text Library Management Integration
References to BASIS in Documentation
During the transition from legacy product names to the new product names, you will see references to both the old and new names in the products and product documentation. For example, in Collections Server 10 or later the installation directory is drive:\BASISserver10.1. Also, BASIS Server documentation may include references to BASIS, while installation documentation will refer to legacy product name only when describing a feature of the product that continues to use the legacy name (such as the installation directory).