rbdb Database

Contents

Introduction
Document Conventions
Tables in rbdb
   authos Table Structure
   members Table Structure
   groups Table Structure
   access Table Structure
   objects Table Structure
   dbs Table Structure
   pup Table Structure
   userresource Table Structure
   resources Table Structure
   default_groups Table Structure
Database Table Relationships
Sample Data for rbdb

Introduction

The rbdb database, part of the Access component, stores patron authentication and authorization data for Record Builder users. This topic presents the schema for the rbdb 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 Record Builder 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.
• tablename.columnname refers to a column in a specific database table. For example, authos.pwd refers to the pwd column in the authos table.

Tables in rbdb

The rbdb database includes ten tables, as follows:

Return to Contents

authos Table Structure

The authos table contains authentication data for your Record Builder users (an autho, or a unique authentication value, and the password associated with this autho). It associates an autho/password combination with a:

• member id, which governs the databases the user can work with and the privileges available to the user for each database
• the resources the user can access
• the number of open sessions for the autho/password.

Return to Contents

members Table Structure

The members table defines the groups to which each subset of Record Builder users (member id) belongs. A member id may belong to several groups and a group may have several member ids. Add a row to this table for each member id/group relationship.

Return to Contents

groups Table Structure

The groups table allows you to establish identifiers for groups of Record Builder users. This identifier, the gid, allows you to link these groups to the databases they can access and the privileges they have with each database (search, write, delete, administrative, import, export or view) in the access table.

Return to Contents

access Table Structure

The access table allows you to specify the Record Builder objects that a group of users can work with and the level of access they have for this object. At present, a Record Builder must be a database.

Return to Contents

objects Table Structure

The objects table contains identifiers for and descriptive information about Record Builder objects. In SiteSearch 4.1.x, all Record Builder objects must be databases. In the future, an object may consist of a subset of the records in a database, such as all the records of a certain type or specific fields in database records.

Return to Contents

dbs Table Structure

The dbs table contains a list of each database in your Record Builder environment. See the diagram in Database Table Relationships to see how the dbid links a database to a user group that has access to the database.

Return to Contents

pup Table Structure

The pup (persistent user profile) table stores information about each subset of Record Builder users (members.id, known in this table as pup.uid). If there are no rows for a member id at login, Record Builder adds this information to the pup table. At present, you should include these two rows for each id, substituting the appropriate uid for uid:

'uid','defaultrecordview','', NULL
'uid','defaultTemplate','dc', NULL

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 catalogers in a specific department, you could set up a row for the resource in the resources table, a row in this table with a userresourcekey for the department and the resourceid for the resource, and the userresourcekey for every authos/pwd eligible to use this resource in the authos table.

Return to Contents

resources Table Structure

The resources table contains a list of each resource (typically servers) in your Record Builder environment that you wish to restrict to specific users. 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.

Return to Contents

default_groups Table Structure

The default_groups table is not currently in use.

Return to Contents

Database Table Relationships

The following graphic shows each table in rbdb, its columns, and its relationships to other tables. Column titles in dark blue bold text link the tables together, as shown by the lines that connect them.

Return to Contents

Sample Data for rbdb

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

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

The sample data in rbdb illustrates these ways in which you can use the Access component to customize access to your Record Builder environment:

• setting up appropriate privileges (search, write, delete, admin, view, import and export) for user groups (catalogers, reviewers, administrators, searchers) on a per-database basis
• setting up userresourcekeys in the userresource table and assigning them to authos to limit access to selected resources to specific groups of users.

For example, in rbdb.dump for SiteSearch 4.2.0, the RBCataloger autho has a uid value of rbcat. As defined in the members table, the rbcat uid is a member of five groups: rbschgrp, rbedtgrp, rtwrtgrp, importgrp and exportgrp. In the access table, the rbschgrp has search access for all of the local databases shipped with Database Builder for use with Record Builder, the edtgrp has edit access (ability to add records for these databases to the Save database) for these databases, the rbwrtgrp has write access (ability to submit records) and delete access (ability to delete records ) for these databases. The importgrp and exportgrp groups allow import and export capabilities for all databases.

In contrast, the RBTrainee autho has a uid value of rbtrainee, which belongs to the rbschgrp, rbedtgrp, exportgrp and rbtrngrp groups. So RBTrainee has search and edit access for local databases because it is a member of the rbschgrp and rbedtgrps, but not have the write or delete access available to the rbwrtgrp group. Its membership in the rbtrngrp group provides delete access for only the Save database. RBTrainee also has privileges to export records from any local database.

Return to Contents

See Also

Access Component Overview
Access Server Configuration Files
Access Client Configuration Files
Configuring the Access Component for Record Builder (UNIX)
Configuring the Access Component for Record Builder (Windows NT)
Record Builder Process Model and System Overview
The updateSQL.pl Utility