Main -> Documentation -> WebZ System Administration -> Access Component -> accessdb Database

accessdb Database

 

Contents

Introduction
Document Conventions
Tables in accessdb
   authos Table Structure
   inst Table Structure
   instdbill Table Structure
   dbs Table Structure
   userdb Table Structure
   resources Table Structure
   userresource Table Structure
Database Table Relationships
Sample Data for accessdb


Introduction

The accessdb database, part of the Access component, stores patron authentication, authorization, and initialization data for WebZ users. This topic presents the schema for the accessdb database by describing the purpose of each table, the structure of each table, and the relationships among the tables. It also explains how a sample data file included with WebZ for both UNIX and Windows NT systems illustrates some possible uses of this database.


Document Conventions

  • <WebZ_root> refers to the location of your installed WebZ environment.
  • Version 4.0.x refers to any SiteSearch version prior to 4.1.0; that is 4.0.2, 4.0.1, 4.0.0a, and 4.0.0.
  • tablename.columnname refers to a column in a specific database table. For example, authos.pwd refers to the pwd column in the authos table.
  • (Required) denotes required tables and required columns in database tables.

Tables in accessdb

The accessdb database includes six tables, as follows.

Table
Description

authos
(Required)

List of the system's authorized users, keys to data in other tables associated with each user, and optional information about users, such as name, address, and phone.
dbs
(Required)
List of all databases in your WebZ system available to patrons, even if they are only available to a subset of your patrons.
inst List of all institutions with which your authorized users are affiliated.
instdbill
(beginning with version 4.1.2)
List of interlibrary loan (ILL) services to use for each institution on a per-database. Used with ILL profiling.
resources List of all resources (generally servers) accessible from your WebZ system.
userdb
(Required)
Links users with the databases they are authorized to use.
userresource Links users to the resources they are authorized to use.

You have considerable latitude in modifying accessdb to meet your site's needs. As long as you include the required tables and the required columns in these tables, you can remove other tables and columns.

If you remove tables and/or columns, however, note that you must modify the [TablePurpose] and [ColumnPurpose] sections of AccessServer.ini accordingly to reflect the structure of accessdb.

Return to Contents

authos Table Structure

The authos table contains authentication data for your WebZ patrons (an autho, or a unique authentication value and, if appropriate, the password associated with this autho for each patron or patron group). At a minimum, it associates each autho or autho/password combination with the databases available to this patron(s) (through the userdbkey column) and the number of open sessions it can have. You can also associate autho and autho/password combinations with the resources they can access (through the userresourcekey column), with the interface style shown to the patron(s) who log in using this autho, and other identifying information (name, status, address, and so on).

Notes: (1) This table is required. Do not delete or rename it.
  (2) Beginning with the name column and continuing to the end of the table, you can use these columns to provide default name and address data about a patron your Interlibrary Loan (ILL) request form (<WebZ_root>/htdocs/obiv1/html/illform.html in the WebZ Out-of-the-Box Interface (OBI), version 1).
   
Column
Data
Type
Size
Description

autho
(Required)

CHAR 24

Unique authentication value, which can be one of three types:

  • user name
  • Internet Protocol (IP) address, in the form ip:ipaddress, where ipaddress can include wild card (*) characters, such as ip:132.174.*.*, and/or a range of IP addresses, like ip:132.174.211-214.*
  • Domain Name Server (DNS), in the form dn:domainnameserver, where domainnameserver can include wild card (*) characters, such as dn:*.oclc.org

You must edit the [JaSSI] section of the Access.ini configuration file to specify the type of authorization you plan to use.

pwd

CHAR 12

Password associated with the autho if the autho is a user name. The value of pwd should be NULL for an IP or DNS autho.

userdbkey
(Required)
CHAR 8

Identifier associated with a database or databases that this autho can access, as specified in the userdb table.

Defined in: userdb.userdbkey
userresourcekey CHAR 8

Identifier associated with a resource or group of resources that this autho can access, as specified in the resources table.

Defined in: resources.userresourcekey
instsym
(version 4.1.1 and earlier)
CHAR 8

Symbol (usually the OCLC symbol) for the institution associated with this autho. In version 4.1.1 and earlier, this column links the authos table to the inst table.

Defined in: inst.instsym (version 4.1.1 and earlier)

instkey
(beginning with version 4.1.2)

CHAR

8

Identifier that links this autho with an entry in the inst table.

Defined in: inst.instkey (beginning with version 4.1.2)
style CHAR 16

User interface style for this user. This determines the interface style presented to the user after he or she logs in.

If you specify an interface style, refer to the style by its name in the [InterfaceStyles] section of the JaSSIServer.ini configuration file.

If this value is NULL for a particular autho, the patron(s) using this autho receives an interface based on the interface style defined as the default interface style in JaSSIServer.ini or defined by a widget from index.html.

sessions
(Required)
INT -

Maximum number of simultaneous open sessions for an autho. It is most useful for authorization by IP address or a guest password assigned to a number of users.

If sessions = NULL, there can be an unlimited number of open sessions under a given autho.

name CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Name of the user associated with this autho.
clientid CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 User's identification number, such as a library card number, student ID, or faculty/staff ID.
status CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Status (such as faculty, student, or staff) of the user.
dept CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 User's departmental affiliation.
street CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 User's street address.
po CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 User's post office box.
city CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 User's city.
region CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 User's region (state or province).
country CHAR 12 User's country.
postcode CHAR 12 Patron's postal or zip code.
phone CHAR 24 Patron's phone number.
email CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Patron's e-mail address.
pager CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Patron's pager number.
lastdate CHAR 8 Date of last modification to an autho record. You must modify this value manually if you wish to use it.

Return to Contents


inst Table Structure

The inst table stores information about institutions with which your patrons are affiliated. It is designed to save information pertinent to interlibrary loan (ILL) requests that patrons initiate using WebZ's interlibrary loan processing options. This information includes the autho and password an institution uses to access OCLC's ILL server, and the institution's delivery and billing addresses for materials borrowed through ILL.

Information from this table for a particular instsym overrides a site's default ILL information, as specified in the [ILLServer], [IllInfo], [LibraryDeliveryInfo], and [LibraryBillingInfo] sections in the IllService.ini file, located in <WebZ_root>/ini/servers.

Storing ILL information in the inst table is most useful if patrons are affiliated with different institutions. If all patrons are associated with the same institution, it makes more sense to use the defaults in the appropriate ILL server configuration file instead.

Note: This table is optional. However, if you remove or modify columns in this table, you may want to modify your ILL request form (<WebZ_root>/htdocs/obiv1/html/illform.html in the WebZ Out-of-the-Box Interface (OBI), version 1 in SiteSearch 4.1.1 or earlier, or illform.html or a vendor-specif ILL form, beginning with SiteSearch 4.1.2, and the accompanying Java class, ORG.oclc.obi.illformscreen, accordingly.
   
Column
Data
Type
Size
Description

instkey
(beginning with version 4.1.2)

CHAR

8

Beginning with SiteSearch 4.1.2, this column links an autho to an institution's entry in the inst table through the instkey in the authos table. It is the key for the inst table. By using more than one instkey row for an institution, it is possible to specify different ILL-related information for the same institution.

Used in: authos.instkey (beginning with version 4.1.2)

 

instsym

CHAR

12
(beginning with version 4.1.2)

4
(version 4.1.1 or earlier)

Symbol (usually the OCLC symbol) for a specific institution. Beginning with version 4.1.2, include the name authority for the symbol, such as OCLC:ACQ. The name authority is required for compliance with the ILL Protocol Implementors Group (IPIG) profile.

In version 4.1.1 and previous versions, this is the key for this table and links an autho to a specific institution through the instsym field in the authos table.

Used in: authos.instsym (version 4.1.1 and earlier)

illdbkey
(beginning with version 4.1.2)

CHAR

12

Links this institution with its entries in the instdbill table for purposes of ILL profiling.

Used in: instdbill.illdbkey (beginning with version 4.1.2)

illautho

CHAR 12

Nine-digit authorization code that allows the institution to access to the OCLC Interlibrary Loan (ILL) system for this instsym.

illpwd CHAR 8 OCLC ILL password for the illautho that allows the institution to access to the ILL system.
reautholimit INT - Number of ILL requests a patron can make before she/he has to reauthorize. A value of 0 means that the patron can make unlimited requests.
chgsendto INT -

Flag that controls the value of the permissionToChangeSendList variable in an ISO-10161 ILL Request sent to OCLC if you are using the OCLC's ILL Direct Request Service and this service's Direct-to-Profile option.

For more information on permissionToChangeSendToList, see the Direct-to-Profile section in the OCLC ILL Direct Request Service Planning Guide.

Note:  

Not currently used in the WebZ OBI, version 1 or version 0. WebZ uses the value of the changeSendTo variable from OclcISOILL.ini (beginning with SiteSearch 4.1.2) or IllService.ini (SiteSearch 4.1.1 or earlier) for all ILL requests sent to OCLC's ILL Direct Request Service if you are using the Direct-to-Profile option.

To use the value from this column in ILL requests, edit the profilePatron method of the illformscreen class (ORG.oclc.obi.illformscreen) so that it retrieves this information.

orderpref CHAR 10

Flag that sets the preference code in in an ISO-10161 ILL Request sent to OCLC if you are using the OCLC's ILL Direct Request Service and this service's Direct-to-Profile or Direct-to-Lender option. The preference code allows you to indicate whether ILL Direct Request can change the order of the lender symbols you include in a request.

For more information on the preference code, see the OCLC ILL Direct Request Service Planning Guide.

Note:  

Not currently used in the WebZ OBI, version 1 or version 0. WebZ uses the value of the OrderPreference variable from OclcISOILL.ini (beginning with SiteSearch 4.1.2) or IllService.ini (SiteSearch 4.1.1 or earlier) for all ILL requests sent to OCLC's ILL Direct Request Service if you are using the Direct-to-Profile or Direct-to-Lender option.

To use the value from this column in ILL requests, edit the profilePatron method of the illformscreen class (ORG.oclc.obi.illformscreen) so that it retrieves this information.

oclcservtype CHAR 20

Indicates your OCLC ILL Direct Request processing option (if you are using this service), which must be one of the following:

  • directToReview
  • directToLender
  • directToProfile

For more information on the processing options, see WebZ and OCLC ILL Direct Request or the OCLC ILL Direct Request Service Planning Guide.

Note:  

Not currently used in the WebZ OBI, version 1 or version 0. WebZ uses the value of the OclcIllServiceType variable from OclcISOILL.ini (beginning with SiteSearch 4.1.2) or IllService.ini (SiteSearch 4.1.1 or earlier) to determine the Direct Request processing option for all ILL requests sent to OCLC's ILL Direct Request Service.

To use the value from this column in ILL requests, edit the profilePatron method of the illformscreen class (ORG.oclc.obi.illformscreen) so that it retrieves this information.

affiliations CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Names of the institution's ILL partners, affiliations, or groups, if applicable.
delname CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Name of the library where materials requested via ILL should be delivered (the "borrowing library").
deladdr CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Street address of the borrowing library.
delpo CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Post office box of the borrowing library.
delcity CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 City of the borrowing library.
delregion CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Region (state, province, etc.) of the borrowing library.
delzip CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Zip or postal code of the borrowing library.
delcountry CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Country of the borrowing library.
delfax CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Fax number of the borrowing library.
delemail CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 E-mail address at the borrowing library.
billname CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Name of the borrowing library that should be billed for the requested material.
billaddr CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 Street address of the borrowing library's billing address.
billpo CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Post office box of the borrowing library's billing address.
billcity CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 City of the borrowing library's billing address.
billzip CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Zip or postal code of the borrowing library's billing address.
billcountry CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12 Country of the borrowing library's billing address.
billaccount CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
12

Billing account number for the borrowing library. This can be any account number used for this purpose, such as a credit card number.

billcurrency CHAR 4 Type of currency you are using to pay for ILL transactions.
billmaxcost CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24

Maximum cost the borrowing library will pay for the requested material.

Note:

If you enter a value in this column, you must specify the type of currency by providing a value for billcurrency.

requesternote CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24 General note that appears in all requests associated with this institution. You can use this for any purpose you wish.

doublecheckdbs
(beginning with version 4.1.2)

CHAR

24

If WebZ is configured for ILL double check, this column indicates the database to check for an item when a patron from this institution submits an ILL request for an item. Works in conjunction with the doublecheckcontinue column in the instdbill table.

Return to Contents


instdbill Table Structure (beginning with version 4.1.2)

The instdbill table contains a list of the ILL services that each institution wishes to use for each database in the WebZ environment for which you have enabled patron-initiated ILL. This table allows you to set up ILL profiling on a per-institution, per-database basis. To apply profiling for a particular database, you set the value of its IllService variable to profiled in the [database] section of its database configuration file. When a patron makes an ILL request, the Access component finds the instkey value associated with the patron's autho/pwd combination in the authos table. The record associated with this instkey contains an illdbkey value. The illdbkey and the dbname columns are the keys to the instdbill table. By locating the row in in instdbill associated with a database and an institution, the Access component determines the ILL service to use for the this institution/database combination from the illserver value. Similarly, the doublecheckcontinue column indicates whether a patron can submit an ILL request for an item that his/her home library already owns.

Column
Data
Type
Size
Description

illdbkey

CHAR 8

Identifier for an institution's entries in the instdbill table. The illdbkey and dbname columns comprise the key to the instdbill table.

Defined in: inst.illdbkey

dbname

CHAR 24

Name for the database. The name must match the value of the dbName variable in the database's configuration file.

illserver CHAR 24

Name of the ILL service to use for this database (as indicated by dbname column in this table) for the institution associated with the value of the illdbkey column.

doublecheckcontinue

CHAR

6

If ILL double check is enabled, indicates whether to allow a patron (as indicated by autho/pwd combination in the authos/table) to submit an ILL request for an item held by the library indicated as the patron's "home" library. The doublecheckdbs column in the inst table contains the the name of the home library. Allowable values are:

true    Allow the patron to submit an ILL request when his/her home library holds the item requests.
false   Do not allow the patron to submit an ILL request when his/her home library holds the item requests.

Return to Contents


dbs Table Structure

The dbs table contains a list of each database in your WebZ environment. The dbid links a database to a user group with access to the database through the userdb table.

Notes:

(1) This table is required. Do not delete or rename it.

(2) If your patrons view local databases you build and maintain with Record Builder through your WebZ interface, remember to add these databases to this table.
(3) If you are using thesaurus databases to support vocabulary assisted searching, remember to add the thesaurus databases to this table.
 
Column
Data
Type
Size
Description

dbid
(Required)

INT -

Unique identifier associated with a database in your WebZ environment. Links this table to the userdb table.

Used in: userdb.dbid
userresource.dbid

dbname
(Required)

CHAR
(beginning with version 4.1.2)
TEXT
(version 4.1.1 and earlier)
24

Name for the database. The name must match the value of the dbName variable in the database's configuration file.

authotype INT - A generic flag that you can use to enable or disable access to selected databases, but is not currently used by the Access component.
sessions INT -

Maximum number of simultaneous open sessions for the database.

If sessions = NULL, no users can access the database.

Return to Contents

userdb Table Structure

The userdb table links the authos and dbs tables via the userdbkey column in the authos table and the dbid column in the dbs table. It allows you to specify the databases available to an autho or autho/pwd combination. For example, if faculty and staff can use all of your databases and students can use only a subset of these databases, you could set up two userdbkeys: one for faculty/staff (facstaff) and one for students (student). Then you would create a separate row in the table for each each database the facstaff group can use and and additional rows for the databases the students can use.

Column
Data
Type
Size
Description

userdbkey
(Required)

CHAR 8

Identifier associated with one or more patrons, through their authos. The userdb key allows you to associate this group of authos with the databases they have access to.

Used in: authos.userrdbkey

dbid

INT -

Identified for a database, as defined in the dbs table, available to the users with this userdbkey.

Defined in: dbs.dbid

Return to Contents

resources Table Structure

The resources table contains a list of each resource (typically servers) in your WebZ environment that you wish to restrict to specific patrons. The resources table can contain a row for any applicable server, such as Z39.50 servers and ILL servers. The resourceid column links a resource to a user group with to the resource through the userresource table.

If different groups of patrons access the same resource with different autho/password combinations:

  • Set up multiple rows for the resource, each with a unique resourceid, the same resourcename, and an applicable autho/password combination in the resourceautho and resourcepwd columns.
  • Link each resourceid with a userresourcekey in the userresource table and use this userresourcekey in the appropriate rows in the authos table.
  • Leave the autho and password variables blank in the resource's server configuration file.
  • Set the CheckNameAuthos variable to true in the [ZBase] section of in the Access.ini configuration file to enable ZBase name authorization. If you do not enable ZBase name authorization, the autho and/or password associated with a specific resource and authos value do not get passed to the resource when a patron tries to search a database hosted by the resource.

Column
Data
Type
Size
Description

resourceid

INT -

Unique identifier associated with a resource, usually a server.

Used in: userresource.resourceid

resourcename

CHAR 23

Name of the resource. This must match the resource's name in its server configuration file.

resourceautho CHAR 23 Autho or user name associated with the resource, if required and not stored in the resource's server configuration file.
resourcepwd CHAR 8 Password associated with the resource, if required and not stored in the resource's server configuration file.

Return to Contents

userresource Table Structure

The userresource table links the authos and resource tables via the userresourcekey column in the authos table and the resourceid column in the resources table. It allows you to specify the resources available to an autho or autho/pwd combination.

For example, if use of some resources is limited to a specific group, such as the faculty and students in a specific department, you could set up a row for the resource in the resources table and a row in the userresource table with a userresourcekey for the department and the resourceid for the resource, and add the userresourcekey to every autho/pwd eligible to use this resource in the authos table.

Beginning with version 4.1.2a, the userresource table has three new optional columns (dbid, db_autho, and db_password) that allow you to specify the autho and password to use to access a specific database. This may be useful when there are multiple authorizations for the same database server and you wish to define which authorization to use when someone from a patron group wishes to access a specific database.

Column
Data
Type
Size
Description

userresourcekey

CHAR 8

Identifier for a group of patrons eligible to use a specific resource in your WebZ environment.

Used in: authos.userresourcekey

resourceid

INT -

Identifier for a resource available to the patrons associated with the userresourcekey.

Defined in: resources.userresourcekey

dbid
(beginning with version 4.1.2a)

INT

-

Identifier for a database accessible on the resource indicated by the resourceid. This database is available to patrons with the autho and password specified in the db_autho and db_password columns, respectively.

Defined in: dbs.dbid

db_autho
(beginning with version 4.1.2a)

CHAR

24

Autho or user name associated with the database, if required and not stored in the resource's server configuration file. This overrides the value in the resourceautho column for the database's resource in the resources table.

db_password
(beginning with version 4.1.2a)

CHAR

24

Password associated with the database, if required and not stored in the resource's server configuration file. This overrides the value in the resourcepwd column for the database's resource in the resources table.

Return to Contents


Database Table Relationships

The following graphics show each table in accessdb, its columns, and its relationships to other tables. Column titles in dark blue bold text link the tables to one another, as shown by the lines that connect them. There is one graphic for accessdb beginning with SiteSearch 4.1.2a and another for accessdb for SiteSearch 4.1.1 and earlier versions. The only difference between the database tables in SiteSearch 4.1.2 and 4.1.2a is that the userresource table has three additional columns – dbid, db_autho, and db_password – in SiteSearch 4.1.2a.

accessdb schema graphic - beginning with SiteSearch 4.1.2

acessdb Schema graphic - SiteSearch 4.1.1 and earlier

Return to Contents


Sample Data for accessdb

The Access component includes a sample data file that you can use to create the accessdb database and populate it with sample data. The following table shows the name and location of the sample data file in different operating systems and SiteSearch versions.

SiteSearch
Version
Operating
System
Name and Location
of Sample Data File
4.1.2

UNIX

<WebZ_root>/mysql/accessdb.dump

Windows NT

<WebZ_root>/accesssql/accessdb.sql

4.1.0/4.1.1 UNIX <WebZ_root>/msql/accessdb.dump
Windows NT <WebZ_root>/accesssql/accessdb.sql
4.0.x UNIX <WebZ_root>/msql/bin/accessdb.dump
Windows NT <WebZ_root>/accesssql/accessdb.sql

You can examine the sample data file with any text editor. The procedures Configuring the Access Component for WebZ (UNIX) and Configuring the Access Component for WebZ (Windows NT) describe how to configure the Access component and create a sample accessdb database using this file.

The sample data in accessdb illustrates several ways in which you can use the Access component to customize access to your WebZ environment:

Return to Contents


See Also

Access Component Overview
Access Client Configuration Files
Access Server Configuration Files
Configuration Files that Support the Access Component
Configuring the Access Component for WebZ (UNIX)
Configuring the Access Component for WebZ (Windows NT)
SQL Scripts and Templates (UNIX)
WebZ and Interlibrary Loan
IllService.ini Configuration File
The updateSQL.pl Utility


[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: