Product Release Information

Table of Contents

1. Introduction
   • What is PDFKeeper?
   • About this user guide
2. Database Setup
   • Description
   • Table structure
   • Action steps
3. Database User Account Management
   • Recommendation
   • Granting access to the pdfkeeper schema

1. Introduction

What is PDFKeeper?

PDFKeeper is free, open source, PDF document storage software used for capturing, storing, and searching PDF documents using Oracle Database Express Edition.

PDFKeeper is perfect for anyone who wants to implement a low cost PDF document storage system and is capable of administrating a relational database.

About this guide

This guide provides the steps that need to be performed in order to setup Oracle Database XE for use with PDFKeeper. It is intended to be used by those involved in implementing and administering PDFKeeper. Before proceeding, make sure that all software required by PDFKeeper has been installed.

2. Database Setup

Description

Database Setup will need to be performed when implementing PDFKeeper, it will create the following:

• pdfkeeper schema account in the users tablespace.
• docs sequence used to generate document ID numbers, in the pdfkeeper schema.
• docs table used to store the documents, in the pdfkeeper schema.
• Oracle Text, lexer and datastore preferences; and attributes, in the ctxsys schema.
• docs table full-text search index, in the pdfkeeper schema.

Table structure

Each document is stored in the database as follows:

ID - Assigned to the document record by the database.

Title - Extracted from the PDF summary (InfoDictionary). This column is searchable.

Author - Extracted from the PDF summary (InfoDictionary). This column is searchable.

Subject - Extracted from the PDF summary (InfoDictionary). This column is searchable.

Keywords - Extracted from the PDF summary (InfoDictionary). This column is searchable.

Added - Date and time the document was added to the database. This column is searchable.

Notes - User editable notes. This column is searchable.

PDF - The contents of the PDF document. This column is searchable.

Action steps

1. Select Start | All Programs | PDFKeeper | Database Setup.
2. When prompted, enter the database connect string in the format: username@host:port
   • username is a database account that must be a member of SYSDBA. Note, SYSTEM is a member of SYSDBA.
   • host is the host name or IP address of the computer that is running Oracle Database XE Server. Specify localhost or 127.0.0.1 if logged onto the same system as Oracle Database XE Server.
   • port (optional) is the TCP port number on which the Oracle Net listener is listening. If not specified, the default port number 1521 is assumed.
3. Secure the pdfkeeper database user account by changing the password, the default password is pdfkeeper.
   1. On the system that has Oracle Server installed, log into Windows as the user that installed Oracle Server.
   2. Select Start | All Programs | Oracle Database Express Edition | Run SQL Command Line.
   3. When prompted, enter the following: connect / as sysdba
   4. Next, enter the following: alter user pdfkeeper identified by "new_password";

3. Database User Account Management

Recommendation

It is recommended that each user be assigned a personal database account, with only the required privileges. The pdfkeeper database account should only be used for pdfkeeper schema administration, not for general use. For more information on Managing Users, please refer to the Oracle Database Express Edition 2 Day DBA book in the Oracle Database Express Edition Documentation.

Granting access to the pdfkeeper schema

Perform the following steps for any user that will need access to the pdfkeeper schema:

1. If the user does not have a database user account, create one for the user:
   1. On the system that has Oracle Server installed, log into Windows as the user that installed Oracle Server.
   2. Select Start | All Programs | Oracle Database Express Edition | Run SQL Command Line.
   3. When prompted, enter the following: connect / as sysdba
   4. Next, enter the following: create user user_name default tablespace users identified by "password";
   5. Next, enter the following: grant connect, resource to user_name;
   6. Close SQL Command Line, enter: quit
2. Connect to Oracle Server as pdfkeeper
   1. Select Start | All Programs | Oracle Database Express Edition | Run SQL Command Line.
   2. When prompted, enter the following: connect pdfkeeper
   3. When prompted, enter the password
3. For a new account, enter the following statement to grant the user select/query access to the DOCS table:

   grant select on docs to user_name;

4. Grant/Revoke permissions as neccessary:

   To give the user the ability to upload documents, enter the following statements:

   grant insert on docs to user_name;

   grant select on docs_seq to user_name;

   To give the user the ability to edit document notes, enter the following statement:

   grant update on docs to user_name;

   To give the user the ability to delete documents, enter the following statement:

   grant delete on docs to user_name;

   To prevent the user from uploading documents, enter the following statements:

   revoke insert on docs from user_name;

   revoke select on docs_seq from user_name;

   To prevent the user from editing document notes, enter the following statement:

   revoke update on docs from user_name;

   To prevent the user from deleting documents, enter the following statement:

   revoke delete on docs from user_name;