PaperClip Audit System Installation Guide

Transcription

1 Installation Guide Version 1.0

2 Copyright Information Copyright 2005, PaperClip Software, Inc. The PaperClip32 product name and PaperClip Logo are registered trademarks of PaperClip Software, Inc. All brand and product names are registered trademarks of their respective corporations. Revision History Revision Comment Author Date A Initial Draft MAS 06/12/2005

3 Contents Revision History...2 Overview...4 pcaudit Processor...4 pcaudit Application...4 Installation...5 pcaudit Processor...5 Licensing...5 Required Software...5 Database...5 File Server Checklist...5 Install Procedure...6 pcaudit Application...12 Install Procedure...12

4 Overview The PaperClip Audit (pcaudit) system allows you to track operations in PaperClip32 s file/folder system. Folder and document operations such as create, modify, delete and document read operations such as view, print, and export. The system tracks the user that performed the operation, which folder or document, when the event occurred and which workstation was used. The Audit system provides an interface to query for specific events and generate printed reports. Reports can also be exported to file or to Microsoft Excel. The following components are included with the pcaudit System: pcaudit Processor The Audit Processor is a service that should be installed on a server that can run securely and undisturbed. The Audit Processor service does have an administrator s user interface which is used to set up working parameters of the service, start/stop, check system activity and view event/error logs. If an error occurs during operation, or if the service stops a notification is sent to the administrator. pcaudit Application The pcaudit application is the client application that users will work with. This component should be installed on any workstation where the audit system users work. Users can query the system's audit database and generate reports. Reports can be printed or exported to csv file or directly into Excel. All query results list to the screen for preview. The columns can be customized and fonts changed to control the output. The Audit system is secured by it's own security system. Audit administrators can create user accounts that grant access to the audit data. The system installs with the default admin account MANAGER with the same password. Page 4 Installation and User s Guide

5 Installation There are two different installations to run for the pcaudit System. The pcaudit processor install is run only once and is typically installed on a Windows server PC. The pcaudit Application needs to be installed on any workstation where the audit system users work. pcaudit Processor The Audit Processor is a service that should be installed on a server that can run securely and undisturbed. The Audit Processor service does have an administrator s user interface which is used to set up working parameters of the service, start/stop, check system activity and view event/error logs. If an error occurs during operation, or if the service stops a notification is sent to the administrator. Licensing PaperClip32 Make sure that you have obtained an updated PaperClip32 license file (PCLIPWIN.CFG) that includes the audit logging feature. Audit System Once installed the pcaudit processor will allow you to run for 30 days until you obtain a valid license code to run the processor. Details on how to do this are described in a following section. Required Software Windows XP/2000/2003. PaperClip32 version 5.6 build 419 or later. SQL client drivers and ODBC drivers for your PaperClip32 database. Microsoft SQL Server or Sybase SQLAnywhere. Microsoft.NET Framework 1.1 Database The Audit System uses its own database which can be secured separately from the PaperClip32 database. File Server Checklist Before you begin installation of the barcode Import service you should be able to answer the following questions: What type of database does my PaperClip32 system use? Make sure that you have the ability to access the PaperClip32 database (Via ODBC) from the PC where the pcaudit processor is being installed. You do not have to create an ODBC data source because the install will do it for you. Page 5 Installation and User s Guide

6 Install Procedure The pcaudit processor runs as a Windows service and should be installed on a Windows server or workstation PC that is turned on all of the time. Run Setup 1. Insert the PaperClip product CD and navigate to the \Audit\pcAuditProcessor directory. Run setup.exe. 2. Select the path where to install the Audit Processor and follow the screens to complete the installation. If you wish to access the audit database for running queries, reports, etc. on this same PC then you also need to run the pcaudit Application setup. Note: Windows service programs cannot access mapped drive letters. Use a native drive letter (c:, d:, etc.) or a UNC path. 3. You now need to configure the ODBC data sources for connecting to your SQL database. The database configuration procedure is slightly different for Sybase and MS SQL. Follow the procedure for your database. Microsoft SQL Server Configuration Your SQL database administrator needs to create a database named pcaudit with a default login user named pclip with password pclip. The password can be changed later if needed. The pclip user needs to have table creation rights to the database. Once this is done follow the steps below. Page 6 Installation and User s Guide

7 1. Browse to the "Utils" directory in "Program Files" under the "PaperClip32 PCAudit Processor" directory and run "PCAuditDBConfig.exe". The Audit System needs to connect to both the PaperClip32 database and its own database. This database configuration utility will create two ODBC data sources for this purpose. Select the SQL Server option for both PaperClip32 and PCAudit in the database configuration dialog. 2. Configure the database connection parameters for the PaperClip32 Database. The default data source name is the same as the default for the PaperClip32 installation. If you are installing the Audit processor on a PC that also has PaperClip32 installed make sure that you change the default data source name to a different name (eg; PaperClip32 Audit ). Select the ODBC driver for your Microsoft SQL server and specify the server name (or local ). Press the Create Sys DSN button. 3. Press the Test Database button to test access to the PaperClip32 database. 4. Configure the database connection parameters for the PCAudit Database. Select the ODBC Driver for your Microsoft SQL server and specify the server name. Press the Create Sys DSN button. 5. Press the Create Tables button to create the Audit system table schema. 6. Press the Test Database button to test access to the newly created tables. Page 7 Installation and User s Guide

8 Sybase SQLAnywhere Configuration During setup a pcaudit.db file is copied into your Program Files directory where the audit system was installed in a subdirectory named \Sybase. You can first configure a Sybase service for this DB file before proceeding using Sybase Central. This is not mandatory as you can also run the local Sybase DB engine from the ODBC data source configured in the next steps. Note: The pcaudit.db file installed is for Sybase version 9. If you are running Sybase 8 contact Paperclip support for a compatible DB file. Follow the steps below to setup your data sources. 1. Browse to the "Utils" directory in "Program Files" under the "PaperClip32 PCAudit Processor" directory and run "PCAuditDBConfig.exe". The Audit System needs to connect to both the PaperClip32 database and its own database. This database configuration utility will create two ODBC data sources for this purpose.. Select the Sybase option for both PaperClip32 and PCAudit in the database configuration dialog. 2. Configure the database connection parameters for the PaperClip32 Database. Select the ODBC driver for your Sybase database. 3. If you have configured Sybase to run as a service then enter the Sybase server name. Otherwise check the File checkbox and specify the full path of the Pclip32.db database file. Press the Create Sys DSN button. 4. Press the Test Database button to test the connection to the PaperClip32 database. Page 8 Installation and User s Guide

9 5. Configure the database connection parameters for the PCAudit Database. Select the ODBC Driver for your Sybase database. 6. If you have configured Sybase to run as a service then enter the Sybase server name. Otherwise check the File checkbox and specify the full path of the pcaudit.db database file. The default location for this file is in your Program Files directory where the audit system was installed in a subdirectory named \Sybase. Press the Create Sys DSN button. 7. Press the Create Tables button to create the Audit system table schema. 8. Press the Test Database button to test access to the newly created tables. Audit Processor Setup Once you have configured your database access you will need to run the Audit Processor Administrator in order to setup operating parameters for the system. Launch the pcaudit Processor Administrator from your program files menu. 1. You will be prompted to configure the Service Manager. Press Yes to confingure. 2. You will need to login as MANAGER with password MANAGER and configure the processor s properties upon first time startup. Page 9 Installation and User s Guide

10 3. Fill out the configuration form. Make sure that you enter a valid mail server address and administrator account for alert messages. Once you have completed this screen press Add. 4. Start the processor by pressing the Start button. Page 10 Installation and User s Guide

11 Request License Key The Audit Processor will run for 14 days until you obtain a license key from PaperClip Software. Follow the procedure below to obtain a license: 1. From the Audit Processor Administrator s Help menu select Request License Code. The following dialog will appear: 2. Copy the selected text into an message and send it to support@paperclip.com. Include your company name in the message body or title for your request. 3. PaperClip Software will send you back a similar encoded text block which you will need to copy into the Enter License Code dialog accessed from the Audit Processor Administrator s Help menu. Page 11 Installation and User s Guide

12 pcaudit Application The Audit System Application is the client program that users will work with. This component should be installed on any workstation where the audit system users work. Users can query the system's audit database and generate reports. Reports can be printed or exported to CSV file or directly into Excel. All query results list to the screen for preview. The columns can be customized and fonts changed to control the output. The Audit system is secured by it's own security system. Audit administrators can create user accounts that grant access to the audit data. The system installs with the default admin account MANAGER with the same password. Install Procedure Install the pcaudit Application on any PC where users need access to the auditing system for queries, reports, etc. Run Setup 1. Insert the PaperClip product CD and navigate to the \Audit\pcAudit directory. Run setup.exe. 2. Browse to the "Utils" directory in "Program Files" under the "PaperClip32 PCAudit" directory and run "PCAuditDBConfig.exe". 3. Follow the same procedure for configuring the data source as described for the Audit Processor database configuration however, only configure the pcaudit side. The PaperClip32 settings do nothing for this component it is only needed for the processor configuration. The pcaudit Application only connects to the Audit System database. Test the connection. 4. Launch the Audit System from your program files menu. You will need to login as MANAGER with password MANAGER. You can use this administrator account to add other users if needed. Page 12 Installation and User s Guide

13 Setup Users Select Users from the Admin menu to setup users for the Audit System. The default user MANAGER with password MANAGER is provided upon install you should change the password for this account. Users such as MANAGER with administrator rights have the added ability to add, modify, delete and lock user accounts. Page 13 Installation and User s Guide

14 User accounts for the Audit System allow access to the Audit System database only not PaperClip32. Audit System users will be able to query the audit data and generate reports. Note that all Folder and Document data fields are stored in the audit database and are readable by audit system users no matter what PaperClip32 security is on those objects. Page 14 Installation and User s Guide