PaperClip32 Installation Guide for Workgroup and Enterprise Editions Document Revision 2.1 1
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. Installation PaperClip32 Workgroup and Enterprise Editions ii
Contents Introduction...5 Overview...5 Terminology used...5 Software Registration...6 Required Hardware for Workstations...6 Required Software...6 File Server Checklist...7 General Procedure...7 System Manager Setup Checklist...7 Workstation Checklist...8 Scanner Installation Checklist...8 Kofax Adrenaline Capture Engine...9 Installation Components...9 Setup Components on the CD-ROM...10 Setup Components on the File Server...10 Basic Steps for a Windows NT Server Installation...10 Installing PaperClip32...11 Examples...11 WAN Capability...16 PaperClip32 Workgroup Edition Database Installation...17 Overview...17 Considerations...17 ODBC 3.x Data Sources...18 Troubleshooting...18 Sybase SQL Anywhere (retail version) Installation...18 Running the Database Server...27 Database server command line switches...28 Microsoft SQL Server Small Business Server Edition Installation...35 PaperClip32 Enterprise Edition Database Installation...36 Overview...36 Considerations...36 Troubleshooting...36 SQL Database Server Installation...37 Installation PaperClip32 Workgroup and Enterprise Editions III
ODBC 3.x Data Sources...37 Microsoft SQL Server Installation...38 Oracle Installation...54 Checklist...54 Running PaperClip32...56 Appendix A Sybase Database Services...57 Installation PaperClip32 Workgroup and Enterprise Editions IV
Introduction Overview This chapter contains information about installing and running PaperClip32. It discusses installation of editions including the Workgroup Edition and the Enterprise Edition. It describes the Database Server, the PaperClip32 Server, Client, and Local Server Setup programs. See section "Terminology Used" (below) for definitions of these terms. The Workgroup Edition allows up to twenty clients and works with Microsoft SQL Small Business Server Edition that is shipped with the Back Office platform. The Workgroup edition can also be used with Sybase SQL Anywhere. The Enterprise Edition permits the installer to choose the database engine to use. Currently for this release both Microsoft SQL Server and Oracle are supported. Information on support for other databases is available from PaperClip Software, Inc. The setup for both the Workgroup and Enterprise Editions require that you must first install and setup your database server separately. Second, you must configure an ODBC (Open Database Connectivity) source on each client workstation to work with that database. The PaperClip32 Client Setup will configure the workstation with ODBC 3.x software. You should be familiar with ODBC issues, especially as they relate to the database of your choice. The PaperClip32 file server installation and workstation installation should be performed only after the object server and all peripherals have been installed and tested. Terminology used Database Server - Machine where the database runs (external to PaperClip32). File Server - Machine where the PaperClip32 software is installed. Client - Machine that will run PaperClip32. Local Server - In a WAN environment, a machine that holds a local copy of all of the executables, so they do not have to be fetched over a possibly slower connection. Note: These designations are logical, not physical. It is entirely acceptable for all of the above to run on one machine. In fact in smaller installations the Database Server and File Server are typically the same machine. In addition, an Administrator will automatically install a Client. That is, you can only run the Administrator software from a machine that has been configured as a Client. Installation PaperClip32 Workgroup and Enterprise Editions 5
Software Registration PaperClip32 uses a software security method not requiring the use of hardware key locks. An encrypted configuration file (PCLIPWIN.CFG) contains software registration information controlling the following parameters: Company Name and Location Number of users (Full use) Number of users (Desktop Workstation) Number of users (View only) PaperClip32 Edition and version Registration number Other parameters The PCLIPWIN.CFG file will be provided by your dealer based on your installation requirements. By default, the PaperClip32 installation program will install a limited use registration. This default PCLIPWIN.CFG file will allow full use of the system but limit the number of user accounts, drawers, folders and documents that can be created. Required Hardware for Workstations Minimum for Windows98 - IBM compatible Pentium+ with 32+ MB RAM Minimum for Windows NT 4.0 or Windows 2000 - IBM compatible Pentium+ with 32 MB RAM Hard drive recommended SVGA monitor and adapter supporting 800x600 minimum resolution Network interface card Scanner and interface card (optional) Required Software Windows NT 4.0, Windows 2000, Windows 2003 or Windows XP, Windows 98 with Microsoft Internet explorer 3.0 or above installed Support for Microsoft Fax requires the Wang Imaging component. This can be found in: - Microsoft Windows NT 4.0 or later - Microsoft Windows 98 or later Kofax Adrenaline Capture Engine version 3.x for scanning. The hardware version of this engine is included only with Kofax scanner cards. Installation PaperClip32 Workgroup and Enterprise Editions 6
TWAIN may be used for scanning. If a particular scanner supports TWAIN, the scanner manufacturer will provide the drivers. Workgroup Edition requires Microsoft SQL Small Business Server Edition (Back Office) or Sybase SQL Anywhere Studio version 5.1 or above. Enterprise Edition requires either Microsoft SQL Server version 6.5 or above, or Oracle version 7 or above. Note, Oracle requires separately purchased ODBC client drivers. File Server Checklist Before you begin installation of PaperClip32 you should be able to answer the following questions: Where will I install my Database Server? Where will I install PaperClip32 (which network server will be my File Server)? What path/drive mapping will be used? General Procedure Log in to your file server as the supervisor (NetWare) or administrator (Windows NT) 1. Install PaperClip32 file server component onto your file server. 2. Install PaperClip32 Administrator and Client components. 3. Follow the installation instructions to install PaperClip32 database components as needed for your particular database configuration. 4. Log in to PaperClip32 with both a username and password of MANAGER. 5. Set up workstation records for each PaperClip32 workstation. System Manager Setup Checklist 1. Define system parameters. 2. Add workstations. 3. Add user accounts. 4. Add task groups (optional). 5. Set up Workflow priorities, statuses, and processes (optional). 6. Set up PaperClip32 document types. 7. Set up initial drawers. 8. Set up overlay templates (optional). 9. Add distribution lists and route slips (optional). Installation PaperClip32 Workgroup and Enterprise Editions 7
Workstation Checklist 1. Ensure that the network driver is installed on the PC and the PC is communicating with the network. 2. Run the client PC installation for each user workstation. 3. Take note of the PC s Full computer name as configured in the System properties of Windows XP. The computer name will be used as the PaperClip32 workstation name when setting up PaperClip32 workstations. The following figure shows the Windows XP dialog box where this parameter is found: Note: If you have a dual boot system (Win95 + WinNT), you should not install locally unless your hard drive is partitioned. PaperClip32 does not run under those conditions (dual boot on a single partition). In this case you must install onto the network. Scanner Installation Checklist Follow the manufacturer s directions to install the scanner and test scanner operation with the utility program provided with the scanner board. Installation PaperClip32 Workgroup and Enterprise Editions 8
Note: If you are installing on Windows NT or Windows 2000 you must first run the NT ASPI install. Windows 98/XP will normally have ASPI already installed. Running the ASPI setup for Windows 98/XP will check first if installation is necessary. The NT ASPI install can be run from the PaperClip32 product CD main setup menu. There are some cases where this may fail. An example is a system configured for dual boot with Windows 95 installed on drive C and Windows NT installed on drive D. If you get an error message at system startup saying that a service failed to start, check the Event Log to see if it is the ASPI service. If it is, you will have to install ASPI manually. Follow these steps: 1. In the \NTASPI\MANUAL folder on the CD-ROM double click on ASPI.REG. You may get an error message indicating that the file could not be imported. This is expected and is not an error condition. 2. Copy ASPI32.SYS to \WINNT\SYSTEM32\DRIVERS 3. Copy WNASPI32.DLL to \WINNT\SYSTEM32 4. Copy WINASPI.DLL to \WINNT\SYSTEM 5. Copy WOWPOST.EXE to \WINNT\SYSTEM 6. Reboot your system Kofax Adrenaline Capture Engine If you are going to be using the Kofax Adrenaline Capture Engine for scanning follow the steps below to install the engine on your scanning workstation prior to configuring PaperClip32. Installation 1. Insert the Kofax CD in to the drive, the Kofax Installation Manager will then run. 2. Choose 32 bit engine 3. Select the product that you would like to install. (Adrenaline Capture Engine (32bit) selected) Configuration and Setup 1. In order to be able to select a scanner from the PaperClip32 Workstation configuration, you must create a scan source using the Kofax Source Manager. Run the Kofax Source Manager from the Control Panel 2. Select Create and give the new Source a name and when the source properties screen appears click OK. 3. Select your scanner from the list when the Select Scanner screen appears then click OK. Installation Components There are several PaperClip32 installation components. The following section describes the setup components on the CD-ROM and those components installed on the file server. This section does not describe installing the database server and client components that is described in a later section. Installation PaperClip32 Workgroup and Enterprise Editions 9
Setup Components on the CD-ROM These components are available when running SETUP.EXE from the root directory of the CD- ROM. This will run the PaperClip Product Line installation main menu. This starts up automatically when the CD is put in the drive. PaperClip32 Setup Main installation for all PaperClip32 editions including evaluation edition. On the CD as \PCLIP32\SETUP.EXE Installs the main PaperClip32 software on the file server Windows NT ASPI Setup On the CD as \NTASPI\SETUP.EXE Installs ASPI support for scanning under Windows NT Setup Components on the File Server In order to run these setup components, the PaperClip32 Setup must first be run from the CD-ROM. The following components are available in the SETUP subdirectory of the PaperClip32 working directory: Client Setup Installs the software for the Client workstation. Optionally installs the ODBC data source for PaperClip32 Sybase editions only. Run SETUP\CLIENT.EXE Local Server Setup Installs another copy of the PaperClip32 program files to a local server or workstation in a WAN environment. This optimizes program load time and swapping in a network environment. Run SETUP\PCLOCAL.EXE Basic Steps for a Windows NT Server Installation 1. Install the Database Server software. 2. Run the PaperClip32 setup on the CD. 3. Verify that PaperClip32 the can communicate with the database by running PaperClip32. 4. Optionally run the Local Server Setup on a workstation or local server PC. 5. Run the database Client Setup and PaperClip32 client setup on each client workstation. Installation PaperClip32 Workgroup and Enterprise Editions 10
Installing PaperClip32 This section describes the installation of all PaperClip32 components (File server and Client) by example for both Novell NetWare and Microsoft NT environments. You must do one of the following: 1. Have the same drive mapping, for the location where you install PaperClip32, for the File Server as well as all Clients. 2. Use a UNC (Universal Naming Convention) path when the Server Setup program asks you for a destination folder. If you are creating this folder on an NT Server you will have to create the folder and "share" it before beginning the installation, so that you may enter a valid UNC share. 3. After installation, manually edit the PCLIPWIN.INI file in the installed directory to set the "ShareLocation" value in the [Install] section to be the path to that directory from all of the Clients. Examples You must perform the one of the following installation cases; 1, 2 or 3 that fits your configuration. These examples do not include installing the Database Server, which is covered in a later section. 1. Have the same drive mapping, for the location where you install PaperClip32, for the file server as well as all clients. a. I plan to install PaperClip32 onto a Netware file server. I go to a workstation where I have drive P: mapped to the volume of interest on the file server. Inserting the CD- ROM into drive D:, I run: D:\PCLIP32\SETUP.EXE. The Setup program runs and asks me for a folder in which to install PaperClip32. I enter P:\PCLIP32. b. When Setup is complete, I test my installation by running PaperClip32 (assuming that I have already installed the database software. c. I then go to all of the Clients and again run P:\PCLIP32\SETUP\ CLIENT SETUP.EXE. 2. Use a UNC (Universal Naming Convention) path when the Server Setup program asks you for a destination folder. If you are creating this folder on an NT Server you will have to create the folder and "share" it before beginning the installation, so that you may enter a valid UNC share. I plan to install PaperClip32 on an NT 4.0 Server named "IMAGING". On IMAGING I create a folder: "C:\Pclip32". This will be the folder that the Server Setup program will suggest, by the way. I share the folder for read and write access by all users who will be running PaperClip32. I use the share name PC32. a. Inserting the CD-ROM into drive D:, I run: D:\PCLIP32\SETUP.EXE. The Setup program runs and asks me for a folder in which to install PaperClip32. I press the Browse button and enter \\IMAGING\PC32 in the entry field and continue the installation. Installation PaperClip32 Workgroup and Enterprise Editions 11
b. I continue as in example "1.b" (above), substituting "\\IMAGING\PC32" instead of "C:\PCLIP32" each time. 3. After installation, manually edit the PCLIPWIN.INI file in the installed directory to set the "ShareLocation" value in the [Install] section to be the path to that directory from all of the Clients. a. In the same scenario as "2." above, I forget to share the folder before running the Server Setup program. I use the default: "C:\Pclip32". b. After the Server Setup program is complete, I edit C:\Pclip32\PCLIPWIN.INI. A section of it looks like this: [Install] ShareLocation=C:\Pclip32 I change it to look like this: [Install] ShareLocation=\\IMAGING\PC32 c. I then proceed as in example "1.b" (above) substituting "\\IMAGING\PC32" instead of "P:\PCLIP32" each time. Installation PaperClip32 Workgroup and Enterprise Editions 12
PaperClip32 Setup This section describes the basic File Server Setup. Refer to the Examples given above to follow the installation as it pertains to your environment. 1. Select PaperClip32 Setup from the master setup by running AUTORUN.EXE in the root directory of the PaperClip32 product CD. Or, you can run SETUP.EXE in the \PCLIP32 directory on the CD. The license agreement screen will appear. 2. Select I Agree then press Next. 3. The readme information screen appears. Press Next. Installation PaperClip32 Workgroup and Enterprise Editions 13
4. Select Workgroup or Enterprise Edition then press Next. Note: You must obtain a license file from PaperClip Software for the specific edition that you are installing. 5. Enter the destination location (path) for installing the PaperClip32 program files then press Next. Installation PaperClip32 Workgroup and Enterprise Editions 14
6. The Select Components screen appears. Select Install Reporting Utility to be able to print PaperClip32 Configuration reports. Select Install PC32 Print Capture Driver to be able to create TIF files from any app and import them into PaperClip. Then select Next. Note: This step will load PaperClip32 Reports on the workstation from which you are installing PaperClip32. To load PaperClip32 Reports on another PaperClip32 client workstation, locate the Report Utility directory on the PaperClip32 installation CD and select Setup.exe. The PaperClip32 install program will now install to the file server all components needed to complete the PaperClip32 installation. A client for this workstation will automatically be set up as well. Be sure to test your installation before installing additional clients. Note: The default NOSS protocol for the installation is TCP/IP. This is the only protocol supported by NOSS32 v3.x. If you are upgrading from a previous version of PaperClip32 that was configured with a different NOSS protocol, you must run the NOSS Protocol Configuration utility and select the proper protocol for your NOSS installation. The PaperClip32 program installation is now complete. Other setup components are now available to be run from the file server. Client Setup In the PaperClip32 program directory run SETUP\CLIENT.EXE. Note: The Client setup must be run on all workstations running PaperClip32. This setup will install all the necessary client software to run PaperClip32. Installation PaperClip32 Workgroup and Enterprise Editions 15
WAN Capability Installing PaperClip32 in a WAN (Wide Area Network) environment involves the following steps: 1. The Main Server may be installed in one centrally convenient location on the WAN. 2. You have the option of installing PaperClip32 on one or more Local Servers on a WAN. 3. A client or workstation may be installed either from the Main Server or a Local Server. Note: A WAN installation of PaperClip32 can support a "mixed mode"; some users may execute directly from the Main Server installation while others may execute from a Local Server installation. Local Server Setup Run SETUP\PCLOCAL.EXE from the PaperClip32 directory on the file server. The Local Server Setup creates a copy of all the PaperClip32 executables so that (for instance) you don't have to load them over a low speed WAN. The Local Server Setup also creates a local copy of the Client Setup, but not the Local Server itself. Therefore, the following rules apply: 1. Any Local Server must be installed from the main site. 2. Any Client should be installed from the most local site. In any case the Client will run the executables located from the location where it is installed. Installation PaperClip32 Workgroup and Enterprise Editions 16
PaperClip32 Workgroup Edition Database Installation Overview PaperClip32 Workgroup Edition provides low to medium volume, high-security, document image management within a client/server environment. The SQL database offers users more efficient backup procedures, error logging, transaction logging, rollback, tunable parameters for tightening performance, greater database integrity, and improved security. The PaperClip32 Workgroup Edition works with Sybase SQL Anywhere (retail version) or Microsoft SQL Server Small Business Server edition (comes with Back Office). Considerations The Database Server Setup can take place before or after installing the PaperClip32 fileserver. Installing the database after PaperClip32 allows the PaperClip32 directory structure to be created giving you a place to create the Sybase SQL Anywhere database file if desired. There can be, in general, only one Database Server named pclip32. If you want to install another server, you will have to give it a different name and modify the ODBC sources on all Clients accordingly. You must use the ODBC administrator program (installed on every Client) to create an ODBC data the source, and then set the proper values in the PCLIPWIN.INI file in your installation folder on the File Server. When you create a database to be used with PaperClip32, be aware that PaperClip32, by default, assumes that the user "pclip" will exist with a password "pclip". This user is defined for the database (not a PaperClip32 user). This user must have resource authority (the ability to create database objects), but need not have DBA (full administration) authority. It is assumed, again by default, that an ODBC source will be created on each client named "PaperClip32 Database" which will be configured to communicate with the PaperClip32 database created on the database server. In order to change any of these three assumptions (user, password and ODBC source name) you will have to modify the 'User', 'Password' or 'Source' keys, respectively, in the ODBC section of the PCLIPWIN.INI file located in the PaperClip32 File Server install directory. Note, however, that the password is encrypted, so if you need to change that you will have to contact PaperClip Customer Services to determine what the encrypted string should be. As implied above, after setting up the Database Server and running the PaperClip32 Client Setup program (in addition to any client setup program required by the database), you will have to configure an ODBC source. Installation PaperClip32 Workgroup and Enterprise Editions 17
ODBC 3.x Data Sources Since the PaperClip32 Workgroup Edition Client setup does not create the ODBC data source, your must do this step manually. By default, PaperClip32 expects the data source to be named PaperClip32 Database. This can be changed in the PCLIPWIN.INI file if needed. One reason that you may want to change this is if you are running more that one installation of PaperClip32 on the same PC in which case you will need multiple data sources. The database user name and password in the PCLIPWIN.INI file override the setting in the ODBC data source. If you remove the user name and password from the PCLIPWIN.INI, the user name and password will be taken from the ODBC data source for database login. Create a PaperClip32 data source on each PC running PaperClip32 after installing the data base client drivers for your particular database. Follow the installation instructions from the database manufacture along with the installation instructions in the following sections. Make sure that you follow PaperClip s recommended settings for configuring the database drivers. We recommend that you use a System DSN (see ODBC administrator). When you use a System DSN all users of the workstation can share the DSN. Troubleshooting If you have difficulties communicating with the database, we recommend the following procedure: 1. Verify that you have installed all server and client components. 2. Verify that you have established compatible network protocol(s) between the client and server. 3. Attempt to connect to the database using a "native" program, i.e. one that does not use ODBC. For example, ISQL.EXE available with many databases. 4. Attempt to connect to the database using an ODBC compliant program that allows you to view the table structure, such as Microsoft Query or the Microsoft Access component of Microsoft Office. 5. If you can connect through ODBC, verify that the information in the PCLIPWIN.INI file matches that in the ODBC source you are using. Warning: Uninstalling PaperClip32 will delete the PCLIPWIN.CFG file unless it is set to readonly. Sybase SQL Anywhere (retail version) Installation The installation, as detailed in the following sections, will install all required SQL Anywhere components for the Database Server and all clients. For more details on the installation and configuration of the Sybase SQL Anywhere database please consult the Sybase installation and user guides. In addition, make sure that you follow the guidelines in this section for installing SQL Anywhere for use with PaperClip32. Installation PaperClip32 Workgroup and Enterprise Editions 18
Note: This installation procedure is for the retail version of SQL Anywhere for Windows platforms. The SQL Anywhere version included on the PaperClip32 Product CD will only work with the PaperClip32 Workgroup/Sybase Edition. Note: For installation on other supported platforms (NetWare and UNIX) refer to you Sybase documentation. Install SQL Anywhere 1. From the Sybase SQL Anywhere Studio CD run SETUP.EXE. 2. Check Adaptive Server Anywhere under Databases and uncheck Synchronization. Installation PaperClip32 Workgroup and Enterprise Editions 19
3. Scroll down and verify that Tools is checked then select Next. Creating the PaperClip32 Database Once the Sybase SQL Anywhere server is installed you must now create a database file for PaperClip32. Do this by running Sybase Central from the Sybase program group on your desktop. Follow the steps below to create the database. 1. Select Create Database in the Utilities tab. Installation PaperClip32 Workgroup and Enterprise Editions 20
2. Enter the path and file name for the PaperClip32 database file. Create a sub-directory named db in the PaperClip32 file server directory (where the PCIPWIN.INI file resides). The database file name should be pclip32.db. 3. Uncheck Maintain the following transaction log file. PaperClip will perform better without transaction logging. Installation PaperClip32 Workgroup and Enterprise Editions 21
4. Uncheck Install jconnect meta-information support: then select Next. 5. Select the settings as shown above for typical PaperClip32 installation then select Next. Installation PaperClip32 Workgroup and Enterprise Editions 22
6. Select 1024 byte page size then select Next. 7. Select Use the following supplied collation:, scroll down and select the 1252LATIN1 collation sequence, then select Next. Installation PaperClip32 Workgroup and Enterprise Editions 23
8. Select Finish to create the database. 9. Leave Sybase Central running in the background. 10. Start the Sybase Server by executing DBSrvr8.exe. In a default installation this executable is found in the C:\Program Files\Sybase\SQL Anywhere 8\win32 folder. 11. Fill out the Start Up options as above. This will manually start the database server. If successful, the Adaptive Server Anywhere screen will be displayed briefly then will minimize to an SQL icon in the System Tray. Creating the PaperClip32 User Once the database file is created you must now create a user so that PaperClip32 can connect to the database. Follow the steps below for creating the user. 1. Switch to SQL Central, press F11, and follow the steps to connect to the pclip32.db database using the default SQL Anywhere user DBA and password SQL. Installation PaperClip32 Workgroup and Enterprise Editions 24
2. Once connected as the DBA user, select the Users & Groups folder on the left, and right click in the right hand pane. Select New, User. 3. Name the new user pclip then select Next. Installation PaperClip32 Workgroup and Enterprise Editions 25
4. Enter and confirm the password pclip then select Next. 5. Select the above user authorities for PaperClip32 then select Finish. Installation PaperClip32 Workgroup and Enterprise Editions 26
Running the Database Server The SQL Anywhere database server can be installed and configured to run on Windows 98, Windows NT, Win2000 Server, WinXP, Win2003 Server, NetWare and UNIX. The following sections discuss how to run the server for each supported platform. Refer to the Sybase documentation for more information on configuring the database server. In the following examples \pclip32 refers to the PaperClip32 working directory C:\Program Files\Sybase\SQL Anywhere 9\win32 refers to the default installation directory for Sybase SQL Anywhere components. Use the appropriate paths for your installation Note: If you move the database file you will have to specify this location in the ODBC data source on each Client. SQL Anywhere on Windows NT/2000/2003 From the Start/Run box enter the following command string: C:\Program Files\Sybase\SQL Anywhere 9\win32\dbsrvr9.exe -ti 0 \pclip32\db\pclip32.db Note: In a Windows NT/2000 Environment, it may be desirable to start the database server as a Windows service. See Appendix A for details on creating a database service. SQL Anywhere on Windows 98/XP Create a Start-Up shortcut to run the server as follows: C:\Program Files\Sybase\SQL Anywhere 9\win32\dbsrvr9.exe -ti 0 \pclip32\db\pclip32.db SQL Anywhere on NetWare To start the database server from the NetWare console type the following command: load dbsrvr9 ti 0 sys:\sqlany9\pclip32.db The database file and the transaction log file must be on a NetWare volume, and the paths must be fully specified. The files cannot be on a DOS partition. NetWare allows you to have volumes that span 2 or more hard disks. When the database file is on one of these volumes, NetWare can sometimes perform multiple I/O operations at the same time, improving the performance of the SQL Anywhere. SQL Anywhere on UNIX From a command prompt run the following command string: C:\Program Files\Sybase\SQL Anywhere 9\win32\dbsrvr9.exe -ti 0 \pclip32\db\pclip32.db Installation PaperClip32 Workgroup and Enterprise Editions 27
Database server command line switches -ti n Disconnect connections that have not submitted a request for n minutes. The default is 240 (4 hours). A value of 0 will disable time-out disconnects, PaperClip32 must be configured this way. -n name Set the name of the database. Both database servers and databases can be named. Since a database server can load several databases, the database name is used to distinguish the different databases. By default, the database receives the name of the file with the path and extension removed. For example, if the server is started on.c:\sqlany9\pclip32.db and no -n switch is specified, then the name of the database is PCLIP32. -c size Set the size of the cache. The database server uses extra memory for caching database pages if it is set aside in the cache. Any cache size less than 10000 is assumed to be K-bytes (1K = 1024 bytes). Any cache size 10000 or greater is assumed to be in bytes. The cache size may also be specified as nk or nm (1M = 1024K). By default, the database server uses 2 megabytes of memory for caching. The more cache that can be given to the engine, the better will be its performance. Note for NetWare: There is a trade off between memory for database server and memory for the NetWare file system buffers. A larger database server cache will improve database server performance of at the expense of NetWare file system performance. If the database server cache is too big, NetWare will report an error that there is insufficient memory for cache buffers. NetWare memory requirements increase with every new directory and file on the file server. To track memory usage on the NetWare server, load MONITOR.NLM (if not already loaded) and select "Resource Utilization". Buying extra memory for your NetWare server computer could improve database performance and/or file server performance dramatically. Installation PaperClip32 Workgroup and Enterprise Editions 28
Client Workstation Installation You must install the SQL Anywhere client software on each PC where PaperClip32 will be running. Each PaperClip32 Workgroup client workstation needs to have the SQL Anywhere client software installed (As well as running the PaperClip32 Workgroup Client installation). Once the SQL Anywhere client is installed you will need to create an ODBC data source in order to allow PaperClip32 to connect to the database. Follow the steps below to do this: 1. Run SETUP.EXE on the Sybase SQL Anywhere Studio product CD. Work through the screens until you reach the Select Components screen shown below. 2. Open the Adaptive Server Anywhere branch. Uncheck all the options, and Check only Network database client, then scroll to reveal the Synchronization and Tools branches as shown below. Installation PaperClip32 Workgroup and Enterprise Editions 29
3. Uncheck Synchronization, and Tools. Scroll up and verify that the only component checked is Network database client then select Next. Continue through the remaining screens to complete the Client installation. This now completes the required database components to install. You must now set up an ODBC data source for each workstation to access the PaperClip32 database. Installation PaperClip32 Workgroup and Enterprise Editions 30
4. Run the 32-bit ODBC manager form the control panel, select the System DSN tab, and select Add to add a new data source. The following screen appears. 5. Select Adaptive Server Anywhere 9.0 for the database driver then select Finish. Installation PaperClip32 Workgroup and Enterprise Editions 31
6. Enter the data source name as PaperClip32 Database. Set all options as shown above then select the Login tab. Installation PaperClip32 Workgroup and Enterprise Editions 32
7. Enter the user name pclip and password pclip then select the Database tab. Installation PaperClip32 Workgroup and Enterprise Editions 33
8. Enter the pclip32 as the server name and the database name. Uncheck Automatically shut down database after last disconnect: then select the Network tab. If you declared a different name when starting your database server (refer to section Running the Database Server), substitute your name in this screen. Press OK to continue. Installation PaperClip32 Workgroup and Enterprise Editions 34
9. Check the network protocol that you are using for your LAN and check shared memory if this machine is also the database server. Accept the defaults on the remainder of the screen. There is no required action on the Advanced tab, select OK to save this configuration. Microsoft SQL Server Small Business Server Edition Installation This version of Microsoft SQL ships with Back Office. The installation procedure is the same as it is for the enterprise edition. Follow the installation instructions for installing Microsoft SQL Server in the Enterprise Edition section of this guide. Installation PaperClip32 Workgroup and Enterprise Editions 35
PaperClip32 Enterprise Edition Database Installation Overview PaperClip32 Enterprise Edition provides high-volume, high-security, document image management within a client/server environment. The SQL database offers users more efficient backup procedures, error logging, transaction logging, rollback, tunable parameters for tightening performance, greater database integrity, and improved security. Considerations The Database Server setup can occur at any time, since it is decoupled from the PaperClip32 installation procedures. Follow the instructions that come with the database engine to setup the software. The Database Server machine can be the same as that used for the PaperClip32 File Server or it can reside on its own machine. When you create a database to be used with PaperClip32, be aware that PaperClip32, by default, assumes that the user "pclip" will exist with a password "pclip". This user is defined for the database (not a PaperClip32 user). This user must have resource authority (the ability to create database objects), but need not have DBA (full administration) authority. It is assumed, again by default, that an ODBC source will be created on each client named "PaperClip32 Database" which will be configured to communicate with the PaperClip32 database created on the database server. In order to change any of these three assumptions (user, password and ODBC source name) you will have to modify the 'User', 'Password' or 'Source' keys, respectively, in the ODBC section of the PCLIPWIN.INI file located in the PaperClip32 File Server install directory. Note, however, that the password is encrypted, so if you need to change that you will have to contact PaperClip Customer Services to determine what the encrypted string should be. As implied above, after setting up the Database Server and running the PaperClip32 Client Setup program (in addition to any client setup program required by the database), you will have to configure an ODBC data source. Troubleshooting If you have difficulties communicating with the database, we recommend the following procedure: 1. Verify that you have installed all server and client components. 2. Verify that you have established compatible network protocol(s) between the client and server. 3. Attempt to connect to the database using a "native" program, i.e. one that does not use ODBC. For example, Sybase Central available with many databases. Installation PaperClip32 Workgroup and Enterprise Editions 36
4. Attempt to connect to the database using ODBC via the Test Connection button in the ODBC data source. 5. If you can connect through ODBC, verify that the information in the PCLIPWIN.INI file matches that in the ODBC source you are using. SQL Database Server Installation PaperClip32 supports different databases through ODBC. Depending on the particular database used please follow the appropriate sections herein provided. ODBC 3.x Data Sources Since the PaperClip32 Enterprise Edition Client setup does not create the ODBC data source, your must do this step manually. By default, PaperClip32 expects the data source to be named PaperClip32 Database. This can be changed in the PCLIPWIN.INI file if needed. One reason that you may want to change this is if you are running more that one installation of PaperClip32 on the same PC in which case you will need multiple data sources. The database user name and password in the PCLIPWIN.INI file override the setting in the ODBC data source. If you remove the user name and password from the PCLIPWIN.INI, the user name and password will be taken from the ODBC data source for database login. Create a PaperClip32 data source on each PC running PaperClip32 after installing the data base client drivers for your particular database. Follow the installation instructions from the database manufacture along with the installation instructions in the following sections. Make sure that you follow PaperClip s recommended settings for configuring the database drivers. We recommend that you use a System DSN (see ODBC administrator). When you use a System DSN all users of the workstation can share the DSN. Installation PaperClip32 Workgroup and Enterprise Editions 37
Microsoft SQL Server Installation This installation procedure was written for Microsoft SQL Server 2000. If you have chosen SQL Server as your database then these tasks must be completed before running PaperClip32. Server Installation 1. Install SQL Server according to manufactures instructions. 2. Create an SQL Server database using Enterprise Manager and assign a name using the steps that follow. 3. Highlight Databases then Right click and select New Database Installation PaperClip32 Workgroup and Enterprise Editions 38
4. Name the database PaperClip32. Installation PaperClip32 Workgroup and Enterprise Editions 39
5. On the Data Files tab, choose a location for the data file. PaperClip recommends that you set the file properties as shown above. Installation PaperClip32 Workgroup and Enterprise Editions 40
6. On the Transaction Log tab, choose a location for the log file. PaperClip recommends that you set the file properties as shown above. Press OK to finish. Installation PaperClip32 Workgroup and Enterprise Editions 41
7. Under Databases find and highlight PaperClip32. Right click and select Properties. Installation PaperClip32 Workgroup and Enterprise Editions 42
8. On the Options tab check the settings as shown above then press OK to finish. Installation PaperClip32 Workgroup and Enterprise Editions 43
9. Use Enterprise Manager to create a Login. 10. Expand the Security branch and highlight Logins. Right click and select New Login. Installation PaperClip32 Workgroup and Enterprise Editions 44
11. On the General tab enter the name pclip, select SQL Server Authentication, and enter the password pclip. Click OK to finish. Installation PaperClip32 Workgroup and Enterprise Editions 45
12. Use Enterprise Manager to change the owner of the PaperClip32 database. 13. In the Tools menu select SQL Query Analyzer. Installation PaperClip32 Workgroup and Enterprise Editions 46
14. Select the PaperClip32 database. 15. Execute the stored procedure sp_changedbowner to change the database owner to pclip as shown above. Installation PaperClip32 Workgroup and Enterprise Editions 47
16. On the Messages tab verify that the database owner has changed. Installation PaperClip32 Workgroup and Enterprise Editions 48
Workstation Installation The database workstation installation has two parts: 1. Microsoft SQL Server Client 2. ODBC Data source. Microsoft SQL Server Client Install the SQL Server 2000 client including SQL Query Analyzer and the SQL Server Client Network Utility. ODBC Data Source Define a data source for the SQL Server database that you previously installed. 1. Open the 32-bit ODBC Control Panel. The ODBC Data Source Administrator dialog box appears. 2. On the System DSN tab click on Add and the Create New Data Source dialog will appear. PaperClip recommends using a System DSN to allow all users of this workstation to share the data source. Installation PaperClip32 Workgroup and Enterprise Editions 49
3. Highlight SQL Server in the list then select Finish and the Microsoft SQL Server DSN Configuration dialog box will appear. 4. Fill in each field as follows: Name - The name of the data source (For example, PaperClip32). Description - A description of the data in the data source. Server - The name of the Server on your network where SQL Server was installed (DAVE\SQLSERVER2000 is only an example). Choose the correct Server from the drop down list. Press Next to continue. Installation PaperClip32 Workgroup and Enterprise Editions 50
5. Select SQL Server authentication and enter the Login ID pclip and Password pclip. Press the Client Configuration button. 6. Select the Network Libraries desired. PaperClip does not recommend named pipes. Press OK to continue. Installation PaperClip32 Workgroup and Enterprise Editions 51
7. Check Change the default database to: and select PaperClip32 from the drop down list. Press Next to continue. 8. Verify the settings as shown above and press finish. Installation PaperClip32 Workgroup and Enterprise Editions 52
9. Press Test Data Source to verify the connection to the database. 10. Verify that the test completed successfully and press OK. Installation PaperClip32 Workgroup and Enterprise Editions 53
Oracle Installation This installation outline was written using Oracle 8. Adjust as needed for other versions. Make sure that you follow this outline and use the suggested settings for proper operation with PaperClip32. This outline assumes the installer has experience with Oracle installations and does not require stepby-step instructions. Checklist If you have chosen Oracle as your database, complete the following tasks: 1. Install Oracle and create an Oracle database. 2. Install Oracle Tools including Administrator Tools and the SQL* Net Easy Configuration Utility. 3. Using the SQL*Net Easy Configuration utility, add a database alias for each workstation (client). 4. Install the appropriate DataDirect Connect for ODBC Driver for Windows for Oracle. This driver is required for each client workstation. 5. Define a data source for the Oracle ODBC driver using the ODBC (32-bit) Control Panel option (For guidance refer to ODBC instructions above for SQL Server). Installation PaperClip32 Workgroup and Enterprise Editions 54
Server Installation Follow the instructions included in your Oracle manuals to install the Oracle database server. To assure a smooth installation, be sure to adhere to the following guidelines: 1. Be sure to note both the name (e.g. SYSADM) and the password assigned to access the PaperClip32 database. You will need to have this information available when performing the ODBC setup. Remember that the user name pclip and password pclip are the default set in the PaperClip32 PCLIPWIN.INI file. You may use a different user name and password if you delete these settings in the PCLIPWIN.INI file and specify the user name in the ODBC data source. 2. Define an alias name for the PaperClip32 database in Oracle. The Oracle documentation describes how to use the Administrator Tools (Oracle Database Manager) to define the alias on the Oracle Server. You will need to have this information available when performing the ODBC setup. 3. After installing the Oracle back-end and the tools, use the Oracle Object Manager tool (in Oracle toolbar) to verify communication with the server that you will be using for the PaperClip32 installation. Note: The PaperClip32 database user created must have a Resource level role granted. Workstation Installation Requirements Oracle distribution CD DataDirect Connect for ODBC Driver Pack for Windows Establish Oracle install with Database Alias, Login and Password Establish TCP/IP network Install Oracle SQL Client Many application installers sense the version of Windows Client. Oracle Client installer does just that and will install the 32 bit version for Windows. Insert the Oracle distribution CD. Setup will autorun and detect what platform you are installing on (Windows 98/NT/2000/XP). When prompted for language, select English. PaperClip32 supports only English at this time. When prompted to select type of installation, select client products. When the client install prompts for type of installation, select Application User. The Oracle client software will now be installed onto your workstation. Once this installation is complete you must run the Oracle SQL Net Easy Configuration utility to Add a New Service (aka database alias) for your database. This alias will be used when creating your ODBC data source. Installation PaperClip32 Workgroup and Enterprise Editions 55
Run SQL Net Easy Configuration From the Oracle folder run the SQL Net Easy Configuration program and select Add Database Alias to add a new database alias for your Oracle database. Choose the appropriate protocol for your network. When prompted for host name and database instance, enter your server name and Oracle server database instance. Install DataDirect 32 bit ODBC Driver for Oracle Follow the instructions provided with the ODBC driver software to install the driver on each client workstation. Setup the ODBC data source. From the Windows control panel, run the ODBC32 manager to create a new data source. PaperClip suggests a System DSN. When prompted to select a driver, select the DataDirect 32-bit driver for Oracle. The ODBC Oracle Driver screen general tab requires the entry of a Data source name and server name. The data source name PaperClip32 Database is the default ODBC data source name when installing PaperClip32. For Server Name, use the name of the database alias created when the Oracle Database was installed. On the Advanced tab, make sure that the Enable Scrollable Cursors and the Application Using Threads options are selected. Note: The Default User Name field is only used if the user name is not specified in the PaperClip32 PCLIPWIN.INI file. By default the PCLIPWIN.INI file will specify the user name. Running PaperClip32 Double click on the PaperClip32 icon. The PaperClip32 Login dialog box will appear: Enter the user name MANAGER, followed by the password MANAGER. Click on OK once the information has been entered. The PaperClip32 application window will appear. Note: When running PaperClip32 for the first time there will be some delay before displaying the login dialog while the database tables are being created. Installation PaperClip32 Workgroup and Enterprise Editions 56
Appendix A Sybase Database Services If you have not already done so please install the PaperClip32 Workgroup Edition before continuing. When the database is served from a Windows NT or 2000 server it is preferable to have the database run as a service. This is accomplished by creating a service that will automatically start with Windows using the Sybase Central tool. Note: If you have not rebooted the server since the Sybase SQL Studio Anywhere install, do so now. Start SQL Central on the server. The default location for the program icon for SQL Central is in Start/Programs/Sybase SQL Anywhere 9. Highlight Services in the left hand box then double click Add Service in the right hand box. The Create New Service dialogs appear. Installation PaperClip32 Workgroup and Enterprise Editions 57
Name your service. We recommend naming the service pclip32. Select Next. Select the Type of service to be created. For PaperClip32 Workgroup Edition this must be Network Database Server. Select Next. Installation PaperClip32 Workgroup and Enterprise Editions 58
Select the executable to be used for this service. The default of DBSrv9.Exe is the correct executable. Make sure the path is correct. Select Next Enter the startup parameters including the path to the database and the name of the database server. PaperClip recommends using the parameters -ti 0 -tl 0 -c 5M -x tcpip c:\pclip32\db\pclip32.db -n pclip32 meaning Idle Timeout disabled (-ti 0), Liveness Timeout disabled (-tl 0), Set the Cache to use 5 Mb (-c 5M), Use only TCP/IP for communications (-x tcpip), The path to the database file (for a default install the path is c:\pclip32\db\pclip32db). Finally the database server name must be declared. We recommend using the name pclip32 (-n pclip32). Select Next Installation PaperClip32 Workgroup and Enterprise Editions 59
Select the account that the service will use. We recommend using the defaults for this screen, use Local System Account and Allow the service to interact with the desktop. Select Next. Select the startup method for the service. We recommend the default of Automatic. Select Next. Installation PaperClip32 Workgroup and Enterprise Editions 60
Check Start the service now if the database file is in place and ready to be served. You can start the service later using the Control Panel if you wish. Click Finish to create the service. The wizard will close and the new service will be listed. If you selected to start the service the status should say Running and the SQL Icon should appear in the System Tray. If you need to modify any of the choices made while running the wizard you can modify this service by highlighting the service name, right-clicking and selecting Properties. A tabbed Dialog box will appear that contains all of the data entered through the wizard. Installation PaperClip32 Workgroup and Enterprise Editions 61
DO NOT change anything on the Dependencies or Polling tabs. You can also control the service through the Windows Control Panel. For Windows 2000 servers the Control Panel is found under Start/Settings/Control Panel/Administrative Tools/Services. A sample of the Services Control Panel screen is reproduced below. Note the first entry is Adaptive Server Anywhere pclip32. Some of the Properties and the Status can be changed from this Control Panel. If you need to change any of the start up parameters, you must be done through Sybase Central. Installation PaperClip32 Workgroup and Enterprise Editions 62