DocSTAR SQL Edition
Technical
Documentation
Chapter 1 Requirements ...... 1-3 Requirements ...... 1-4 Hardware ...... 1-4 Software ...... 1-4 Chapter 2 Setup...... 2-1 General Setup Guidelines ...... 2-2 Installation Scenarios ...... 2-2 Summary of Steps...... 2-3 Installation Steps for Scenarios ...... 2-5 DocSTAR Setup Routine ...... 2-6 Log files...... 2-7 Individual Setup Steps ...... 2-9 Prepare Existing DocSTAR Host...... 2-9 Setup NT Server...... 2-9 Setup SQL Server ...... 2-10 Copy existing DocSTAR 2.3 data to new NT server 2-12 Configure SQL Database Structures...... 2-12 Install ODBC Drivers...... 2-12 Install DocSTAR SE...... 2-13 Database Activity (Initialize, Update, or Upsize) 2-19 Restore DocSTAR SE Data on a Bare NT Server 2-25 Final DocSTAR Steps...... 2-25 Copy Setup Routines to Host...... 2-26 Manual Processes...... 2-29 Manually Configure SQL Database Structures 2-29 Manually Edit Data Source Names...... 2-34 Convert Jet Database to SQL Server Database using UPSIZVB3.EXE 2-39 Chapter 3 Maintenance...... 3-1
DocSTAR SQL Edition – Technical Documentation 1 -1 Maintenance ...... 3-2 SQL Server Maintenance ...... 3-2 Chapter 4 Troubleshooting ...... 4-1 Troubleshooting ...... 4-2 Error Messages ...... 4-2 ODBC & DSN...... 4-3 Restoring MASTER Database...... 4-3 Chapter 5 Utilities...... 5-1 Utilities...... 5-2 Data Manager...... 5-2 Concheck...... 5-4 Chapter 6 Glossary ...... 6-1 Glossary...... 6-2
1 -2 DocSTAR SQL Edition – Technical Documentation Chapter 1 Requirements
DocSTAR SQL Edition – Technical Documentation 1 -3 Requirements
DocSTAR SQL Edition requires:
Hardware DocSTAR SQL Server Host Computer
DocSTAR Scan Station
Network cards, hub, cables, etc.
Software Windows NT Server version 4.0 with service pack 4 installed
Windows SQL Server 7.0 Standard Edition, with service pack 1
Windows NT client access licenses and SQL Server client access licenses for all users
DocSTAR SQL Edition software CD. Contains:
DocSTAR SQL Edition Software \DSSQLED, SETUP.EXE
DocSTAR ODBC Drivers \DSODBC, SETUP.EXE
Microsoft SQL 7 Service Pack 1, \SQL7SP1, SETUP.BAT
Microsoft SQL 7 VB3 Fix, \SQL7FIX
ASPI Drivers for Windows NT, \ASPINT, INSTASPI.EXE
An existing DocSTAR Host can be used as a scan station to a new DocSTAR SQL Server installation. All data in the DocSTAR database can be moved to the new SQL Server Host during installation of the DocSTAR software. You should ensure beforehand that any existing data (document images, etc) recorded on optical media are in a format that will be directly readable under Windows NT. Media formatted with FAT32 may need conversion prior to installation.
1 -4 DocSTAR SQL Edition – Technical Documentation Chapter 2 Setup
DocSTAR SQL Edition – Technical Documentation 2 -1 General Setup Guidelines DocSTAR SQL Edition is installed through a very detailed process. The steps needed to install DocSTAR SE on a given machine will vary based on the particular installation and situation. Factors include whether this is a host or remote system, whether this is a new installation, an upgrade from and earlier DocSTAR version using a Jet database, or an update to DocSTAR SE, and whether this installation is happening in the factory or in the field. Below is a table that lists the types of or reasons for installation and the steps appropriate for each situation. The number indicates the order in which the steps should be taken. The sections which follow describe each of the steps. Follow the directions for the steps that are indicated for your situation.
Installation Scenarios
Host
1. Factory Installation of Host
When a new NT DocSTAR SE Server is built at the factory, all the components of DocSTAR must be installed as if this server will be used in a new installation, including a clean, initialized database. This will allow the technicians to thoroughly test the installation.
Note: If the new server is installed in a new site, little needs to be done on site. If the server is installed to upgrade an existing installation, additional steps will be taken at that time. 2. Field Configuration of Host – New Site
This situation occurs when a new NT DocSTAR SE server is placed at a customer site as a new DocSTAR. This system will not replace any existing systems or be expected to hold the data of another DocSTAR system, even if the customer has other DocSTAR systems in place. Very little has to happen in this situation, beyond physically connecting the server prepared at the factory. 3. Field Conversion of Host – Existing Site
When a new NT DocSTAR SE server replaces an existing DocSTAR system additional steps must be taken on-site to move the customer’s data from the existing system to the new server. The process begins with a factory-installed host. The customer’s data is moved to the new host, and then DocSTAR is reinstalled to customize the installation. However, the backbone pieces of NT and SQL Server do not have to be reinstalled. 4. Routine DocSTAR Reinstall on Host – Existing Site
Periodically, updates to the DocSTAR SE software will be available. At other times, a technician may choose to reinstall DocSTAR to correct a problem with corrupted files or a similar situation. In this situation, DocSTAR SE can easily be reinstalled, skipping the steps used to build a server from scratch. 5. Field Installation of DocSTAR SE on an existing NT Host– Existing Site
There are very few systems in the field that are already use an NT Server. For these situations where a new, factory-built NT Server isn’t needed, steps similar to those used in the factory are needed to install SQL Server and other background software. 6. Field Reinstallation on Bare Host Server– Existing Site
2 -2 DocSTAR SQL Edition – Technical Documentation In the case of an extreme failure, the technician may need to remove all software from a server and rebuild the server, beginning with installing the operating system. This situation will combine steps used in the factory to build a new server with steps used in the field to restore or move data from an existing system to a new one.
Remote
1. Initial Installation of DocSTAR SE on Remote station– New or Existing site
After the host is installed, the scan, view, and view/file stations can be installed. These are all considered remote stations. All steps for this installation are done on-site. 2. Routine DocSTAR SE reinstall on Remote station – Existing site
Similar to a host, updates to the DocSTAR SE software will be available or the technician may choose to reinstall DocSTAR to correct a problem. In this situation, DocSTAR SE can easily be reinstalled, skipping the other steps.
Summary of Steps
1. Prepare Existing Host
When converting an existing system to DocSTAR SE, some steps are needed to backup current data, etc. to prepare for the move. 2. Install NT Server
This involves installing the operating system. It needs only be done when loading a bare machine. 3. Setup SQL Server
This involves installing the SQL Server software and setting general configuration options. This is required when building a new system or before installing DocSTAR SE on one of the few NT servers that exist. 4. Copy existing DocSTAR 2.3 data to new NT server
This step is necessary when converting a DocSTAR 2.3 system to DocSTAR SE. It is done prior to installing DocSTAR SE so that the original DocSTAR configuration information is used. 5. Configure SQL Database Structures
Prior to loading any data, SQL Server requires you to define and configure the databases you will use. This step is required prior to loading any DocSTAR database onto a host. It will be done at the factory, except in cases where SQL Server itself is installed in the field. 6. Install ODBC Drivers
These drivers are required on both host and remote stations to communicate with the database. They will be installed on the host at the factory, when possible, and on remote systems on-site. 7. Install DocSTAR SE
Similar to other versions, this step will install the DocSTAR-specific family of software on both host or remote systems. This will be the piece used most often.
DocSTAR SQL Edition – Technical Documentation 2 -3 8. Database Activity (Initialize, Update, or Upsize)
Because the database installation now includes both the database tables and some additional code routines, it needs to be done whenever DocSTAR code is updated on a host. The initialization and update steps are similar to those used in the past. (Previously, one would run INITIALIZE from DocAdmin to initialize or DBUPDATE.EXE to update the database.) The new option, Upsize, is used to convert a DocSTAR 2.3 Jet database to a DocSTAR SE SQL Server database. An upsize will only be run once, on the first conversion of a system. 9. Restore DocSTAR SE Data on a bare NT Server
In the case of a complete reinstall in the field, after a system failure, data including the DocSTAR database, the INI files, and the Zylab full-text index need to be restored to the system. 10. Final DocSTAR Steps
This just includes some routine actions such as starting DocSTAR, etc. to finalize all the settings, etc. 11. Copy Setup Routines to Host
This step simply helps the user move setup routines and data to the network so that installation of remote systems is easier. It should be done anytime there is new DocSTAR SE software. It can be done at anytime, prior to installing DocSTAR on the remote systems.
2 -4 DocSTAR SQL Edition – Technical Documentation Installation Steps for Scenarios The following chart identifies the steps needed in a given situation. Look at the headings across the top of the chart to identify the appropriate scenario. Follow down the column to identify the steps needed and the order they should be executed in. Blank columns indicate a step that should be skipped. Numbers indicate a step to be taken and the sequence. Go to the specific directions for each step which follow for more detailed information about the step.
HOST REMOTE STATION STATION Factory New Site Existing Site New or Existing Site Existing Site 1. Factory 2. Field 3. Field 4. Routine 5. Field 6. Field 1. Initial 2. Routine Installation Config. Conversion DocSTAR Installation Reinstall on Installation reinstall Reinstall on existing Bare Host NT Host Server Prepare Existing Host 1 1 1 Install NT Server 1 2 Setup SQL Server 2 2 3 Copy existing DocSTAR 2.3 2 3 data to new NT Server Configure SQL Database 3 4 4 Structures Install ODBC Drivers 4 5 5 1 Install DocSTAR SE 5 3 1 6 6 2 1 Database Activity 6 1 4 2 7 7 (Init DB) (Init DB) (Upsize DB) (Update DB) (Upsize DB) (Init DB) Restore DocSTAR SE Data on a 8 bare NT Server Final DocSTAR Steps 7 2 5 3 8 9 Copy Setup Routines to Host 3 6 4 9 10
DocSTAR SQL Edition – Technical Documentation 2 -5 DocSTAR Setup Routines The steps that have been automated have been bundled together in a single setup routine. Within that routine you can select the steps you want to run. You may run the setup routine at anytime, selecting just the appropriate steps. The steps available from this routine are: · Configure SQL Database Structures · Install ODBC Drivers · Install DocSTAR SE · Database Activity (Initialize, Update, or Upsize) Steps 2 and 3 above can also be run using their individual setup routines.
1. To run the general setup routine from CD, insert the DocSTAR SE CD. Using NT Explorer, open the DSSQLED folder on the disk and double-click on SETUP.EXE.
To run the setup routine from the network, open the folder DOCSTAR\DATABASE\SETUP on the drive mapped to the host. Double-click on SETUP.EXE. a. You will be presented with a start up screen. Click Next> until you reach the screen with several options.
2 -6 DocSTAR SQL Edition – Technical Documentation
Figure 1 - DocSTAR Common Setup Routine
b. One or more options may be preselected, based on the current status of DocSTAR. Add or remove check marks until just the options you want are identified. c. Click Next>. The setup routine will go through each option that has been chosen, alerting you to when each step begins and finishes. Note: If you cancel in one step, the program will continue with the other selected options. You need to cancel each option that follows. 2. To run only the DocSTAR setup without running the general program, choose DSSETUP.EXE from the DSSQLED folder instead of SETUP.EXE. It will not present the additional options shown above. 3. To run only the ODBC setup without running the general program, choose ODBCSETUP.EXE.
Log files The following log files will contain information about the installation. This includes positive information such as which files where installed, the installation type (model, etc.) and INI file settings updated. It may include error information or otherwise indicate where the program was stopped or aborted. Some errors cannot be detected by the setup routine, such as failures from the scripting process. It will report at the end that the installation was successful, when there were some incomplete actions. It is important to
DocSTAR SQL Edition – Technical Documentation 2 -7 monitor the error messages so that you can make adjustments after the setup routine has completed, if necessary. Review the installation logs to verify success or identify problems. All installation logs are located with the main DocSTAR software, generally C:\DOCTAR. The following log files will be generated. 1. INSTALLS.LOG: (“S” for shell)
This contains details of the overall process when SETUP.EXE is run. It will contain details of the steps to configure database structures and most database activity. 2. INSTALLD.LOG: (“D” for DocSTAR)
This contains the details of installing the DocSTAR SE application specifically. 3. INSTALLO.LOG: (“O” for ODBC Setup)
This contains results of the step for ODBC Installation. 4. DSCREATE.TXT
This contains results of configuring the initial database files 5. DSMVLOG1.TXT and DSMVLOG2.TXT
These contain results of the process to convert or upsize a Jet database.
Common Errors The following are error messages or symptoms that may be experienced if the a step in the setup process is missed or not completed successfully. 1. Ntvdm.exe error Message: The drive is not ready for use; its door may be open. Please check drive X: and make sure that a disk is inserted and that the drive door is closed.
2 -8 DocSTAR SQL Edition – Technical Documentation Individual Setup Steps As shown above, there are several different steps used in the installation and setup procedure. Some steps are used in almost any instance while others are used only under special circumstances. The steps have been automated as much as possible but some manual input will be required at times. As much as possible, steps have been bundled together to minimize the number of programs to be started. For example, the main setup routine allows the most common, automated steps to be run as group and the user may choose to run some or all of the steps in this group, as necessary. Please refer to the table above to determine which steps to use in your situation and the order in which to perform them. Then find the matching section below for each step to be executed.
Prepare Existing DocSTAR Host Purpose: When converting an existing system to DocSTAR SE, some steps are needed to backup current data, etc. to prepare for the move. How: This requires manual steps, using standard utilities and manual processes.
1. Be sure that the host is running DocSTAR 2.3x or later. Any version of 2.3 is acceptable. If the host is still running DS 2.2x, it mu st be upgraded to DS2.3 before installing DocSTAR SE. (This is to simplify the installation process which might result from upgrading many different levels of DocSTAR software.) 2. Flush the Jukebox cache on the JukeBox Server application if a jukebox or drive tower is in use. 3. Close all applications including DocSTAR, JukeBox Server, Fax Server, Etc. 4. Perform a complete backup of database and text index. 5. Change or remove network share names on drives to prevent users from accessing unit. This “old host” will not be a host anymore and users shouldn’t be able to connect to it. As a separate process, the new host should be configured on the network and all required drive shares made available there.
Setup NT Server Purpose: This involves installing the operating system. It needs only be done when loading a bare machine. How: This requires manually installing NT Server software following the step-by-step instructions below
1. Install Microsoft NT Server 4.0. The machine name should be DOCSTARSQL as this is the default name used throughout the installation process. This name will also be used as your SQL Server name. If something other than the suggested name is used, you will need to substitute for it in subsequent steps. 2. Install NT Server Service Pack 5. IMPORTANT NOTE: DO NOT INSTALL SERVICE PACK 6 OR ABOVE. THERE ARE ISSUES WITH THESE SERVICE PATCH RELEASE AND HAS NOT BEEN APPROVED FOR INSTALLATION ON THE DOCSTAR SE SERVER. THIS ALSO APPLIES TO NT WORKSTATIONS WHERE A VIEW OR VIEW/ FILE LICENSE HAS BEEN INSTALLED. 3. Modify the following Registry key to prevent System Hard Error Messages per Microsoft Developers Network article Q124873 (on the Host only).
Using RegEdit modify: \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Windows\ErrorMode Change the error mode from 0 to 2. 4. Install Microsoft Internet Explorer (IE4.01 minimum) 5. Establish any mirroring or fault tolerant systems on primary hard disk drives 6. Connect scan station to host on secondary (local) network and thoroughly test network configuration before proceeding. The ConCheck utility can be used for this procedure.
DocSTAR SQL Edition – Technical Documentation 2 -9 7. The following checklist lists items which are generally setup on a DocSTAR NT Server. Refer to NT documentation for details on how to setup each item: 8. Video Driver · DHCP · Network Driver · Set Swap file to 256MB min · Set boot time to 5 seconds · Add license in license manager for each client purchases · Set system, app and error logs to clear automatically when necessary
Setup SQL Server Purpose: This involves installing the SQL Server software and setting general configuration options. This is required when building a new system or before installing DocSTAR SE on one of the few NT servers that exist. How: This requires manually installing SQL Server and the service packs following the step-by-step instructions below
1. Install Microsoft SQL Server 7.0 Standard Edition
This will create the SQL Server entity DOCSTARSQL. It will have the same name as the machine name given to NT.
To run, insert CD for Microsoft SQL Server 7.0. If AutoPlay does not start the setup program automatically, go to NT Explorer. Right click on the drive with the CD and click on AutoPlay. If that is not an option, run autorun.exe either from the Explorer or from the task bar. a. Click icon next to "Install SQL Server 7.0 Components" (3rd entry) b. On the screen titled “Install SQL Server 7.0 Components”, click icon next to "Database Server - Standard Edition" (1st entry) c. On the screen titled "Select Install Method", accept default: radio button selected is "Local Install - Install to the Local Machine" (1st entry) d. On the next several screens: follow standard setup and licensing instructions e. For the screen titled "Setup Type", accept default: Typical (1st entry) f. On the screen titled "Services Accounts", accept all defaults · Use same account (1st entry) · Service Settings Panel: Use a Domain User account (2nd entry): Username, password and domain as presented on screen g. Next several screens for licensing: answer routinely. Select Per Seat Licensing. h. On the final screen, accept option to restart machine and hit finish.
2. Install SQL Server Service Pack 2
Answer standard licensing questions and use default configuration options.
To run, insert the DocSTAR SQL Edition CD. Using NT Explorer, open the \SQL7SP2 folder on the disk and double-click on SETUP.BAT.
a. First two screens: follow standard setup and licensing instructions b. Screen titled "Connect to Server": Accept default: Windows NT account information (2nd entry)
2 -10 DocSTAR SQL Edition – Technical Documentation c. Let setup process run d. Final screen: Accept option to restart machine and hit finish.
3. Install SQL Server patch for VB3
Run the Query Analyzer by selecting the program from the SQL Server 7.0 group from the START menu. a. When prompted for a login, enter the NT machine name as the SQL Server name. Use defaults, SQL Server Authentication, UserID of SA and blank password. · If you used the recommended name DOCSTARSQL as the NT machine name, you can use the default presented · If you specified a different NT machine name, enter it again here as the SQL Server name
Figure 2 - Login To Query Analyzer
b. Leave the database selected as MASTER, shown in the database field on the toolbar. (The default for the SA user is the MASTER database). c. Load and run the script file sp_datatype_info.txt which is located in the \SQL7FIX folder to update the system stored procedure. · To load the script, either click on the Open Folder icon on the tool bar (2nd entry) or use menu items File, Open. Then select the script \SQL7FIX\sp_datatype_info.txt using the form presented. · To run the script, either click on the Run icon (green, right arrow), press F5, or use menu items Query, Execute. · Check the message in the lower half of the Query Analyzer screen to verify successful completion of the process.
The normal message includes the statement “Configuration option changed. Run the RECONFIGURE statement to install.” You can ignore this.
d. Exit Query Analyzer.
DocSTAR SQL Edition – Technical Documentation 2 -11
Copy existing DocSTAR 2.3 data to new NT server Purpose: This step is necessary when converting a DocSTAR 2.3 system to DocSTAR SE. It is done prior to installing DocSTAR SE so that the original DocSTAR configuration information is used. How: This requires manual steps, using standard utilities and manual processes.
1. IF YOU HAVEN’T ALREADY BACKED UP THE EXISTING DATABASE, DO SO NOW. 2. Copy C:\DOCSTAR directory and sub directories from previous host to this new machine. 3. Copy docstar.ini from the windows directory of the previous host to this new machine.
Configure SQL Database Structures Purpose: Prior to loading any data, SQL Server requires you to define and configure the databases you will use. This step is required prior to loading any DocSTAR database onto a host. It will be done at the factory, except in cases where SQL Server itself is installed in the field. How: This step is run by choosing an option from the main Setup utility. It may also be done manually by following the detailed instructions at the end of this section.
1. For this step, run SETUP.EXE, as described previously, and select the first option, Configure SQL Database Structures. (You may select more than one option at this time.) 2. At the end of the process, the log file will be displayed using the Notepad utility.
Please note any problems that were encountered and then exit the Notepad utility. The log files can be found later, with the other installation logs, in C:\DOCSTAR as DSCREATE.TXT. 3. When completed, the setup routine will continue on to the next step that was selected on the main screen.
Install ODBC Drivers Purpose: These drivers are required on both host and remote stations to communicate with the database. They will be installed on the host at the factory, when possible, and on remote systems on-site. How: This step is run by choosing an option from the main Setup utility. As an alternative, you may run ODBCSETUP.EXE which will allow only this installation step to be run. It may also be done manually by following the detailed instructions at the end of this section.
1. For this step, run SETUP.EXE, as described previously, and select the second option, ODBC Installation. (You may select more than one option at this time.) 2. You will be asked to confirm the Data Source Name. Under normal circumstances this will not be changed and you can just click Next>
2 -12 DocSTAR SQL Edition – Technical Documentation
Figure 3 - Confirm NT Server Name
3. You will receive a message indicating that the process has completed. Check the status information at the bottom to verify that the new ODBC connections are working. 4. When completed, the setup routine will continue on to the next step that was selected on the main screen.
Figure 4 - ODBC Installation Completion Message
Install DocSTAR SE Purpose: Similar to other versions, this step will install the DocSTAR-specific family of software on both host or remote systems. This will be the step used most often. How: This step is run by choosing an option from the main Setup utility. On a remote station, after the initial installation, you may find it easier to run DSSETUP.EXE. Because it does not offer the other
DocSTAR SQL Edition – Technical Documentation 2 -13 choices, it may be less confusing to the user.
Note: Some errors cannot be detected by the setup routine, such as failures from the scripting process. It will report at the end that the installation was successful, even when there were some incomplete actions. It is important to monitor the error messages so that you can make adjustments after the setup routine has completed, if necessary. Review the installation logs to verify success or identify problems.
Setup DocSTAR Host
1. For this step, run SETUP.EXE, as described previously, and select the third option, DocSTAR SE Installation. (You may select more than one option at this time. As a rule, you should always select Database Activity at the same time.)
The setup routine is similar to previous DocSTAR setup routines. Follow the screen directions when starting the setup.
There may be some times during the process when just the background screen appears, with no message about what’s currently happening. This is normal. Do not restart your machine, thinking the process has finished. A message will appear to tell you when the setup has completed.
a. Installation: Select Host System (2nd option) when asked to choose the type of installation such as Host, Scan Station, etc. Click Next >.
Figure 5 - DocSTAR Installation Selection
b. Model: You will be asked to select the type of host server being installed. Select DocSTAR Server for most systems. A DocSTAR DCL system is a special model. Click Next >.
2 -14 DocSTAR SQL Edition – Technical Documentation
Figure 6 - DocSTAR Host Model Selection c. Paths: You can set the paths to be used for the database, Inbox, and for archiving at this point. In previous versions, this was done through DocAdmin after the installation was completed.
The paths presented on the form will come from the existing DOCSTAR.INI, or will use defaults for an initial installation. · Update the paths if necessary and then click Next>.
Note: The paths can not be verified at this point so typos and misspellings will not be detected.
DocSTAR SQL Edition – Technical Documentation 2 -15
Figure 7 - Path Confirmation
d. Several screens will be presented as files are installed and settings updated. When the process has completed, a screen with a finished noticed will be displayed. e. When completed, the setup routine will continue on to the next step that was selected on the main screen.
Setup DocSTAR Remote Stations
Scan Station, View/File, or View Stations are considered “remote stations” to distinguish them from the Host. System should already be operational with Win95, Win98 or NT operating systems. Networking between it and the host should also be operational before installing DocSTAR SE.
This process is the same one used for the Host installation. Because some options are different on a remote station, some additional screens are presented Please read the description for setting up a host station for the general information. 1. For this step, run SETUP.EXE, or DSSETUP.EXE from X:\DOCSTAR\DATABASE\SETUP where X indicated the drive mapped to the host. Select the third option, DocSTAR SE Installation. (You may select more than one option at this time.)
Note: If you want to make use of the DEFAULTS.INI file in setting paths and mappings on remote stations, check the section Copy Setup Routines to Host if you haven’t already done so.
a. Installation: Select the appropriate type of station. · Scan Station: If a DocSTAR scanner is attached to this station, it is a scan station. · View/File: If user can see the Inbox or file new documents, select View/File. · View: If documents can be reviewed but the user can not see the Inbox or file newly scanned documents, choose View.
2 -16 DocSTAR SQL Edition – Technical Documentation
Figure 8 - DocSTAR Installation Selection b. Model: For scan stations, you will be asked to select the type of scanner used. There is not additional model information needed for View or View/File stations.
Figure 9 - DocSTAR Scanner Selection c. Host Mappings: You can set the mappings between the remote station and the Host station at this point. In previous versions, this was done after the installation, under DocAdmin.
DocSTAR SQL Edition – Technical Documentation 2 -17
The mappings presented on the form will come from an existing DOCSTAR.INI file if one exists or from a DEFAULTS.INI file that has been configured for this installation. If neither exist, the entries will be blank. · Update the mappings if necessary. If you do not know the mappings at this point, you may leave them blank and update later using DocAdmin.
Note: Although you do not have an entry for the archive path, you still need to map the drive.
Figure 10 - Remote Drive Mappings d. Paths: You can set the paths to be used for the database and inbox at this point. The archive path will be left blank on a remote stations. In previous versions, this was done through DocAdmin after the installation was completed.
The paths presented on the form will come from the existing DOCSTAR.INI, if one exists or from a DEFAULTS.INI file that has been configured for this installation. If neither exist it will use defaults for an initial installation.
The paths should reflect the mappings that were just set. The software will not do this automatically – you need to update the drive letters in the paths here if you changed the mappings in the previous step.
· Update the paths if necessary and then Click Next>.
If you do not know the correct paths, update them later using DocAdmin.
Note: The paths can not be verified at this point so typos and misspellings will not be detected.
2 -18 DocSTAR SQL Edition – Technical Documentation
Figure 11 - Remote Path Confirmation
f. Several screens will be presented as files are installed and settings updated. When the process has completed, a screen with a finished noticed will be displayed. g. When completed, the setup routine will continue on to the next step that was selected on the main screen.
Database Activity (Initialize, Update, or Upsize) Purpose: Because the database installation now involves both the database tables and some additional code modules, it needs to be done whenever DocSTAR code is updated on a host. The initialization and update steps are similar to those used in the past. (Previously, one would run INITIALIZE from DocAdmin to initialize or DBUPDATE.EXE to update the database.) The new option, Upsize, is used to convert a DocSTAR 2.3 Jet database to a DocSTAR SE SQL Server database. An upsize will only be run once, on the first conversion of a system. How: This step is run by choosing an option from the main Setup utility.
Before choosing an option for updating the database, it is important to understand the various options and their impacts. · Initialize Database
This option should be chosen only when no existing data needs to be preserved.
This option completely empties any existing SQL Server DocSTAR database as well as the full-text index used when searching for documents. It recreates empty tables and reloads all stored procedures.
DocSTAR SQL Edition – Technical Documentation 2 -19 · Convert Jet Database to SQL Server Database – “Upsizing”:
This option should be chosen when converting an existing DocSTAR 2.3x system to DocSTAR SE the first time only.
This option, also known as “upsizing”, will convert a DocSTAR database in Jet (the DOCUMENT.MDB) to a SQL Server database. It will move all existing JET database data into SQL tables as well as load all stored procedures. It leaves the full-text index (MAINIDX) untouched. At the end of this process, the users will have access to all the same documents that were available prior to this installation.
· Update SQL Server Database:
This option should be chosen whenever DocSTAR is reinstalled on an existing DocSTAR SE Host and the other Database Activity options are not appropriate. Choosing this option, even when it’s not really necessary will not do any damage.
With any DocSTAR update, there may be minor changes to the database structure such as adding new fields or tables. Under SQL Server, some processing routines (stored procedures) are also stored in the database. This option will post those changes to the database.
1. For this step, run SETUP.EXE, as described previously, and select the fourth option, DocSTAR SE Installation. (You may select more than one option at this time.)
a. You will be asked to choose the correct database action. An option may be pre-selected based on the current status of the host. Be sure to choose carefully to avoid losing any data.
Click Next>.
2 -20 DocSTAR SQL Edition – Technical Documentation
Figure 12 - DocSTAR Update Options
b. The routine will go through the necessary steps for the option chosen. At the end, it will confirm that the process has been completed. See the sections below for details on each database option.
Initialize Database Continue with this step only when no existing data needs to be preserved. 1. To initialize the database, 3 script files are run from within the setup routine. One creates the database tables, the second creates the indices for the tables and the third installs the DocSTAR-related stored procedures.
If you are initializing a database, you must run the all the scripts prior to running DocSTAR for it to perform correctly,. You can do this by Initializing the database from DocAdmin later (Initialize button), if you do not do it here. a. You will be shown a screen identifying the script to be run. Click on OK to continue.
DocSTAR SQL Edition – Technical Documentation 2 -21
Figure 13 - SQL Script Utility
b. Next, you're shown a screen to verify that there are no users on the system who may be trying to access the same database areas. Click OK to continue.
The previous screen will be redisplayed and then the first script will automatically begin processing. The window on the left side of that screen will show the progress as the tables or stored procedures are loaded.
If there are active users, you will not be able to run the scripts at this time. Normally, there won't be other users working during an installation but it may happen on an upgrade or reinstall.
2 -22 DocSTAR SQL Edition – Technical Documentation
Figure 14 - Current SQL Users c. After one script completes, the name of the next script will appear on the screen. Click OK to run the second script. Do this again for any additional scripts.
The screen to verify active users will not appear again, unless there is a delay between running the scripts. The system will check for users again only if more than 5 minutes elapse between one script finishing and the next one beginning.
DocSTAR SQL Edition – Technical Documentation 2 -23
Figure 15 - Running SQL Script Utility
Convert Jet Database to SQL Server Database – “Upsizing”
Choose this option when converting an existing DocSTAR 2.3x system to DocSTAR SE the first time only.
You should have made sure the DOCUMENT.MDB file is in place in the proper directory on the Host (c:\docstar\database, by default) before selecting this option.
Note: This process can also be run using a program that is provided, UPSIZVB3.EXE. It is a much slower process but provides the user with certain options such as converting specific tables. See instructions for running this program at the end of this section. This process includes several steps. 1. Initialize SQL Server tables.
Several scripts are run to clear the SQL Server tables. This is almost the same process used to initialize a database. However, the full-text index, which is not in the database, is not affected. Refer to the section on initializing the database for instructions on how to move through the screens.
2. Run processes to move the data
Two low-level routines are used to quickly move the data from the Jet database to the SQL Server database. At the end of these processes, the log files will be presented to you, using Notepad.
Please note any problems that were encountered and then exit the Notepad utility. The log files can be found later, with the other installation logs, in C:\DOCSTAR as DSMVLOG1.TXT and
2 -24 DocSTAR SQL Edition – Technical Documentation DSMVLOG2.TXT.
3. Run standard database update steps
The standard steps used in the Update option above are also run here. This will update the database structures with any changes unique to DocSTAR SE and will load all the stored procedures. 4. Move the original document.mdb file. It should be put in a safe place for reference but no longer in the database path. (Suggestion: c:\docstar\database_jet). This is to prevent a remote system that hasn’t been upgraded yet or one with an incorrectly installed system from accidentally accessing the wrong database.
Update SQL Server Database
Choose this option whenever DocSTAR is reinstalled on an existing DocSTAR SE Host so that database structures and stored procedures are updated.
1. Several scripts are run to update the database structures and stored procedures. Refer to the section on initializing the database for instructions on how to move through the screens.
This process to run scripts is the same one used initializing a database. However, some different scripts are used to update data structures instead of replacing them. a. The script DSTBLUPD.SQL will be run to update the database with any changes to the table structure. This replaces the DBUpdate function in the older setup routine. b. DSINDEX.SQL will be run to update or add any indices to the database tables. c. Finally, the script DSPROCS.SQL will be run to install or update all stored procedures.
Restore DocSTAR SE Data on a Bare NT Server Purpose: In the case of a complete reinstall in the field, after a system failure, data including the DocSTAR database, the INI files, and the Zylab full-text index need to be restored to the system. How:
Final DocSTAR Steps Purpose: This just includes some routine actions such as starting DocSTAR, etc. to finalize all the settings, etc. How: This requires manual steps, using standard utilities and manual processes.
Note: If either DocAdmin or DocSTAR can’t open the database properly, user DSUSER and the password may have been entered incorrectly when SQL Server was installed on the host. Go back to the step on Setting Security and Users to correct it. You may also have to confirm the DSN is setup correctly.
Messages for this error may be “Connection failed…..Login failed for user DSUSER” or “Unable to signon with default ID and Password.” Host Stations 1. Move the DOCUMENT.MDB.
If an existing Jet database was converted to SQL Server, and you haven’t done so yet, move the original document.mdb file. It should be in a safe place for reference but no longer in the database path. (Suggestion: c:\docstar\database_jet). This is to prevent a remote system that hasn’t been upgraded yet or
DocSTAR SQL Edition – Technical Documentation 2 -25 one with an incorrectly installed system from accidentally accessing the wrong database.
2. Add password to SA User Except in the case of a factory install, you should add a password on the SA login for SQL Server. This will prevent unauthorized users from changing any of the settings or accessing the SQL Server.
Refer to the section on Manually Configuring Database Structures, for additional help.
a. Use the SQL Enterprise Manager and open the security tree under the DOCSTARSQL server by expanding Security, then Logins. b. Double click on the SA login and change the password. Click OK and reenter the password to confirm. c. Exit Enterprise Manager.
3. Run the DocSTAR Administration to verify configuration a. Click Paths and confirm the paths that have been set. In particular, make sure that the archive volume and jukebox settings are correct. b. Click on Filing (Host) and verify that the Archive Volume Label is correct.
4. Fax Server: If this is a new DocSTAR system and the Fax Server is installed, start it up in order to create the database. If prompted to create a new database, click on YES. If you do not want to leave it running, click on CLOSE.
5. Running DocSTAR: Run DocSTAR prior to installing the other stations. They rely on some settings that DocSTAR needs to update.
6. Reboot the machine, if you have not already done so. Remote Stations 1. Checking drive mapping in Explorer. If you have not done so already, map the necessary drives from the host to the remote stations in Explorer. 2. Run DocAdmin to verify configuration a. Click on Network Mappings to map host drives to remote stations b. Click on Paths to update paths to use correct mapped drive letters c. Click on Filing (Station) to update any settings necessary. 3. Reboot and Run DocSTAR: It is always best to reboot system prior to running a new version of DocSTAR, especially if it was running DocSTAR or other applications previously.
Copy Setup Routines to Host Purpose: This step simply helps the user move setup routines and data to the network so that installation of remote systems is easier. It should be done anytime there is new DocSTAR SE software. It can be done at anytime, prior to installing DocSTAR on the remote systems.
How: This requires manual steps, using standard utilities and manual processes.
1. Copy setup routines to server: a. Using the DocSTAR SQL Edition CD, copy the setup program and files from the \DSSQLED folder to the directory C:\DOCSTAR\DATABASE\SETUP. On remote stations, you can use the network to install from these files instead of the disk to install DocSTAR.
2 -26 DocSTAR SQL Edition – Technical Documentation · SETUP.EXE, etc. Copy all files that start with SETUP including SETUP.EXE and SETUP.Wxx where xx is a number. · DSSETUP.EXE, etc Copy all files that start with DSSETUP including DSSETUP.EXE and DSSETUP.Wxx · ODBCSETUP.EXE, etc. Copy all files that start with ODBCSETUP including ODBCSETUP.EXE and ODBCSETUP.Wxx. 2. DEFAULTS.INI file:
The DEFAULTS.INI file is used during the DOCSTAR SE install process to set paths and mappings on remote stations. This saves the users from having to do it through DocAdmin later. Use this when the mappings for most stations are going to be the same.
Using the same directories as above, copy DEFAULTS.INI, if desired. Edit this file to identify the connect string, paths and mappings to be used.
The DEFAULTS.INI file has the following format:
[PATHS] inbox=C:\DOCSTAR\INBOX database=C:\DOCSTAR\DATABASE Connect=ODBC;DSN=DOCSTARSQL;Database=DOCSTARSQL
[MAPPINGS] ;local drive letter = server drive letter map1=H=C map2=I=D map3=J=F ;map4=S=H a. Paths section: The paths sections is the same as it is in the DocSTAR.INI of a remote station. It is not case-sensitive. Notice that the archive path is no longer needed on a remote station.
Edit the DEFAULTS.INI file to show the same paths that you would have to enter through DocAdmin. Also enter the connection string for SQL Server b. Mappings section: This section holds the same information as the mappings section in DocSTAR.INI of a remote station. The single difference is the use of a label (map1=) prior to the mapping. c. Skipping entries: Rather than removing entries that aren’t currently used, it is suggested that they be commented out. This is done by putting a semi-colon (;) in the first column. You don’t need to remove the rest of th line. This will the line to be ignored. At a later time, if you chose to use that entry, the format will be there. For example, at a later time if a fourth drive is used, just uncomment map4 by removing the semi-colon and update the S and H to the appropriate values. 3. When applying future upgrades, after the DocSTAR SQL Edition is installed on the host, an automatic upgrade process will allow a remote station to detect a change in the Host software and install the updated software. The initial version of DocSTAR SQL Edition must still be loaded manually on remote stations because this feature is not yet installed.
For example, when an update to DocSTAR SE is released you would install the new version on the host and then copy the installation files to the setup directory. Next you would start up Host DocSTAR once.
DocSTAR SQL Edition – Technical Documentation 2 -27 Remote stations will now be able to detect that there is an upgrade in place, prompt the user if they want to run the upgrade, and then run the setup program from the setup directory.
2 -28 DocSTAR SQL Edition – Technical Documentation Manual Processes The automated versions of these processes are used in the normal setup process. The manual processes are included here, in case more detailed information is needed.
Manually Configure SQL Database Structures 1. Create the database using Enterprise Manager. To run Enterprise Manager, select the program from the SQL Server 7.0 group from the START menu. a. Create DOCSTAR database · Open leaves on the tree on left hand panel until the server DOCSTARSQL is showing in the server group. · With the Server selected, right click, move the cursor to NEW, then DATABASE and click. · On the General tab, enter DOCSTAR as the database name. Accept the other defaults on this and the Transaction Log tab. Click OK.
Figure 16 - Create DocSTAR Database
b. Set security and users: · Expand the tree further. Expand the Server leaf and then the Security leaf until Logins is visible. · Right click the mouse on Logins. choose New Login, then Click. · On the General tab,
DocSTAR SQL Edition – Technical Documentation 2 -29 Note: You must enter a user DSUSER with the password SPUDSPUD for the DocSTAR application to work. You may not substitute another name or password. à Enter DSUSER as Name in the top of the form. à The password authentication process is case-sensitive at this point. In the Authentication section, click on SQL Server Authentication, then SPUDSPUD (all caps) as the password. à In the defaults section, select DocSTAR as the default database. Leave the language as
Figure 17 - Create DSUSER Login
· No changes are made on the Server Roles tab. · Click on the Database Access tab. à In the top list, databases, check the permit box for DocSTAR. à In the bottom list, check the following specific roles that the user DSUSER will be given to the DocSTAR database. Check the first 2 which are PUBLIC and DB_OWNER.
2 -30 DocSTAR SQL Edition – Technical Documentation
Figure 18 - Set Database Access Properties for DSUSER
· Click OK. · Re-enter the password when asked to confirm it. Remember to match the case of the original entry (all caps). c. Create a second user DSADMIN to be used for backup and restore procedures using some of the same procedures as above. · Go again to Logins, choose New Login, and click · On the General tab,
Follow the same procedure as for creating DSUSER. This time the user name is DSADMIN and the password is IKCMIKCM.
DocSTAR SQL Edition – Technical Documentation 2 -31
Figure 19 - Create DSADMIN Login
· On the Server Roles tab, à Check System Administrator role for this user. · No selections are made on the Database Access tab.
2 -32 DocSTAR SQL Edition – Technical Documentation
Figure 20 - Set Server Roles for DSADMIN
· Click OK. · Reenter password when asked to confirm it. Remember to match the case of the original entry (all caps). d. You can exit the Enterprise Manager now.
DocSTAR SQL Edition – Technical Documentation 2 -33 Manually Edit Data Source Names
The following steps are not necessary in a standard installation. The ODBC setup should have created two Data Source Names for use with DocSTAR, DOCSTARSQL and DOCSTARSQLBU.
If you want to add another the DSN manually or need to update one of the DocSTAR DSNs, follow the steps below. 1. Getting to the Data Source Configuration Screens a. Open the system Control Panel by selecting Settings and Control Panel from the Start menu. b. Double-click on the icon for ODBC Data Sources. c. On the first screen, titled ODBC Data Source Administrator, select the tab "System DSN" and click on Add.
Figure 21 - ODBC Data Source Administrator
d. On the next screen, titled Create New Data Source, select SQL Server from the list (probably the last entry) and click on FINISH. This will take you to the set of SQL Server-specific screens.
2 -34 DocSTAR SQL Edition – Technical Documentation
Figure 22 - Select ODBC Driver
2. Creating/Updating a DSN a. On the first screen, enter the Data Source Name DOCSTARSQL in the Name field (first field) and your server name in the Server field (last field) click NEXT.
Figure 23 - Specify Data Source Name and Server
DocSTAR SQL Edition – Technical Documentation 2 -35 b. Screen 2 · Select SQL Server Authentication. Enter the user id and passwords of DSUSER and SPUDSPUD in the Login and password fields. (Don’t click NEXT just yet)
Figure 24 - Select Authentication Method and User Name
· Click CLIENT CONFIGURATION to get to a sub screen. Select the TCP/IP as the option (2nd option) and click OK which brings you back to the Screen 2. · Click NEXT.
2 -36 DocSTAR SQL Edition – Technical Documentation
Figure 25 - Select Network Library Configuration c. On the third screen, listing the default database and other configuration options, accept the default settings and click NEXT.
Figure 26 - Select Default Database and Options d. On the final screen accept the default settings and click Finish. (This screen identifies the log files and use of regional settings.)
DocSTAR SQL Edition – Technical Documentation 2 -37
Figure 27 - Select Language and Log Options
e. You will get a confirmation screen. Click on TEST DATA SOURCE to verify that your DSN will work. Click OK.
Figure 28 - Test Data Source
3. Click OK on the ODBC Data Source Administrator screen and close the Control Panel
2 -38 DocSTAR SQL Edition – Technical Documentation Convert Jet Database to SQL Server Database using UPSIZVB3.EXE Use this process to convert all or part of a Jet database to a SQL Server database. Since this process can be much slower than the standard process, it is suggested that this be used when troubleshooting specific tables. 1. Make sure your docstar.mdb file is in place in the proper directory on the Host (c:\docstar\database, by default) and that SQL Server database structures have been created. 2. To run this program, use NT Explorer to open the C:\DOCSTAR folder and double-click on UPSIZVB3.EXE. As an alternative, select Run from the Start menu and enter UPSIZEVB3.EXE
Figure 29 - Upsize Utility
a. Verify that the Source and Destination strings are correct or update them as needed. Click Open DBs to open the source and destination databases. Any errors generated indicate an improper setup. b. Select all of the tables to be upsized in the table list. You can do this by clicking on the first table, holding the shift key and clicking on the last table, scrolling if necessary. c. Click Start Processing Tables to begin the upsize process. d. Monitor progress by checking the Overall Process Status section which will tell you how far along in the process you are. Look in the Current Table Status to see which table is currently being processed. (Tables are processed in alphabetical order.) e. When processing is finished, click Close DBs and click Exit program. f. Rerun the DocSTAR setup routine SETUP.EXE · Select the option Database Activity. Select the choice Update SQL Server Database to get DocSTAR SE specific changes and to load stored procedures.
DocSTAR SQL Edition – Technical Documentation 2 -39
Chapter 3 Maintenance
DocSTAR SQL Edition – Technical Documentation 3 -1 Maintenance
SQL Server Maintenance The SQL Server Maintenance schedule and activities have not yet been defined.
3 -2 DocSTAR SQL Edition – Technical Documentation Chapter 4 Troubleshooting
DocSTAR SQL Edition – Technical Documentation 4 -1 Troubleshooting
Error Messages DocSTAR SQL Edition error messages will appear similar to previous versions with one exception. Many errors reported by the SQL Server database engine will be reported as error number 3146 “ODBC – Call Failed”. In addition to this error message, more information is usually supplied and it is this additional information which is really critical to determining the error which has occurred. An example ODBC error is shown below:
Figure 30 - Sample ODBC Error Message
In this example, we can tell that the error occurred during backup, that is was due to an ODBC error which means it involves the SQL Server and specifically the remainder of the error message is important to determine the exact cause of the error. It is important to capture as much detail of the error message to help in diagnosing the problem. Reporting “ODBC call failed” is not enough. It essentially says “ERROR.” It does however indicate a SQL Server related error but the error may have occurred on the workstation or on the server. The details of the error message will tell us that. One tip that is useful for gathering information about error messages is the PrintScrn button found on the keyboard. When this button is pressed, the contents of the screen are copied to the system clipboard. They can then be pasted into an application and printed. For example, let’s say an error message appears on the screen. press PrintScrn button. Then, using the Windows Start menu, select Programs, Accessories and WordPad. Paste the screen picture into the new WordPad document by holding the CTRL key and typing V. This will insert the screen picture into a WordPad document which can be printed or even saved. This provides an easy method to capture all of the error message and a picture of the screen and what was happening. This method has proven useful to diagnosing errors. The contents of error messages are also saved to the error logs. DocSTAR SQL Edition now saves all users error messages in logs stored on the server. In addition, a separate log is generated for each unique user. This makes it easier to browse the logs for errors or to locate a specific error which occurred on a specific workstation. It may be possible to determine whether a given error or message is related to the SQL Server and ODBC components or if it is related to the rest of DocSTAR by examining the error message. Errors indicating “ODBC error” and “SQL Server” will likely indicate SQL Server type messages. Another example is connection problem message such as the following:
4 -2 DocSTAR SQL Edition – Technical Documentation
Figure 31 - Sample Connection Problem Error Message
This is an example of an error message which might appear when trying to run DocSTAR SQL Edition if there is a problem with the ODBC setup, or if the workstation cannot connect to the server.
ODBC & DSN Problems with ODBC setup and DSNs will usually show up immediately upon running DocSTAR or Administration. If ODBC is not installed correctly or the DSNs are not configured correctly, DocSTAR will be unable to connect to the SQL Server and errors will be displayed. You can refer to the Setup section of this manual titled “Manually Edit Data Source Names” to review the setup of DSNs by hand.
Restoring MASTER Database It may be necessary at some time to perform a complete restore of all SQL Server database backups to a new system or to a different system. This would be the case if the original system was destroyed and the offsite database backups need to be restored to a new system. This procedure is generally not necessary if you have a running system and you want to restore the DOCSTAR database back to a prior day. The MASTER database is a special database to SQL Server and cannot be restored in the normal process that the other databases are restored through the DocSTAR Administration program. In fact, the DocSTAR Administration program skips the MASTER database during a restore because it requires a special process to restore it. The following is the process to restore the MASTER database for SQL Server. If you are setting up a new system with the intent to restore a set of databases to it, you should perform the entire install, get the system working, then restore the MASTER database through this process and then restore the other databases through the DocSTAR Administration program. 1. Stop SQL Server.
Open the SQL Service Manager by double clicking on its icon which appears as a small traffic light in the lower right hand corner of the system task bar. Click on the Stop button to stop the SQL Server Service.
DocSTAR SQL Edition – Technical Documentation 4 -3
Figure 32 - SQL Service Manager
2. Start SQL Server in Single User Mode.
Open a Command Prompt window from the start menu. Execute the following command: C:\MSSQL7\BINN\SQLSERVR.EXE –m
Figure 33 - Starting SQL Server Single User Mode This will process for a moment, displaying messages and will then halt execution. You will not see the C:\> prompt at this point.
4 -4 DocSTAR SQL Edition – Technical Documentation
Figure 34 - SQL Server Running In Single User Mode
3. Locate the most recent backup files on the backup media. Use the file date to determine the latest date of the MASTER database backups and use the backup set number from this file. For example, if the MASTER1.BAK file has the newest file date, this is the most recent backup. If a number other than 1 is newer, use this number in the following command instead of the number 1. 4. Run the SQL Query Analyzer and login with user DSADMIN, password IKCMIKCM. Select the MASTER database and execute the following query:
docstar.dsuser.procDSDBRestore ‘f:\backup\master1.bak’, ‘DISK’, ‘MASTER’
This will restore the MASTER database from the specified file. SQL Server will halt execution once this command has been executed.
DocSTAR SQL Edition – Technical Documentation 4 -5
Figure 35 - Restoring MASTER Database
5. Close the Command Prompt and restart SQL Server using the SQL Service Manager 6. Run DocSTAR Administration and restore the DocSTAR databases normally. The system is now ready to run.
4 -6 DocSTAR SQL Edition – Technical Documentation Chapter 5 Utilities
DocSTAR SQL Edition – Technical Documentation 5 -1 Utilities
Data Manager The Data Manager has been modified to be compatible with DocSTAR SQL Server Edition. While most of the functions remain the same, some have been modified for easier user and a couple of new functions have been included. The File menu now has an option to “Open DocSTAR Database” which will open the default database specified in the DOCSTAR.INI file.
Figure 36 - Data Manager File Menu
Once you’ve opened the database, you may double click on a table name to open a scrollable dataset window to view data. Previously, double clicking on a table name opened the design window for the table. Since viewing data is a more common function, this was changed.
5 -2 DocSTAR SQL Edition – Technical Documentation
Figure 37 - Database Table View
A new window was added to allow creating queries and executing SQL statements directly. The SQL window will open with a default query for the table selected. You may edit this query to return data (a SELECT query) or you may edit it to make changes to the database data (UPDATE and DELETE queries.) Common queries can be saved to a file and reloaded and run. When a SELECT query is run, a scrollable dataset is returned for the resulting data. This may even include joined tables, however such a query might not be updateable depending on the exact syntax used.
Figure 38 - SQL Query Window
DocSTAR SQL Edition – Technical Documentation 5 -3 Update queries will return the number of records about to be affected and allow you to choose whether or not you want to perform the update query. This is a useful “safety check” to make sure you are about to update the quantity of records you expect. If complex SQL Server type queries are needed, there is an option to turn off the translation layer and perform queries in SQL Passthrough Syntax. The passthrough syntax is slightly different than the SQL syntax you might be used to. This option should only be used when required or suggested by a service technician.
Concheck The Concheck utility has been updated to work with a SQL database as well as a Jet database. You can use either Test Type when using DocSTAR SQL Edition. Both should work and each type can be used to test and troubleshoot a specific piece of the installed software.
Figure 39 - Concheck Utility The Jet test type will perform as prior versions of Concheck have. It will open a temporary Jet database on the path specified, which is usually a network shared path to the host computer. It will read and write data to this table and report any errors or problems. This test is exercising the Jet database installation and the network connection. Normal network conditions do not produce errors with the exception of an occasional retry. The new SQL DSN test will connect to the SQL Server database on the host computer using the specified DSN parameters. This test will create a temporary table in the DocSTAR database and will read and write data to it, reporting any errors or problems. This test is exercising the SQL database connection, ODBC drivers and the lower level network connection.
5 -4 DocSTAR SQL Edition – Technical Documentation Chapter 6 Glossary
DocSTAR SQL Edition – Technical Documentation 6 -1 Glossary
Client/Server – Is a description of a system where the a client computer makes requests to a server computer, the server fills the requests and returns the information to the client. The server is performing a specific task it is especially tuned for and the client is doing what it is tuned for. The fact that both operations typically run on different computers also helps to distribute the processing and may speed up operations. The opposite of client/server processing is client only processing where all clients perform all operations against one shared file. DSN – Data Source Name. This is a name given to a collection of settings which dictate how a connection to a database source will be used. It usually specifies the name of the server, the name of the database, what type of connection will be used (i.e. ODBC) and what type of network connection will be used (i.e. TCP/IP). Jet Database – This refers to the Microsoft Access database created by the Jet Database Engine software. Typically used by stand alone stations or small networks, this database works by having all clients update the database file directly. This is highly efficient for single user or small networks, but quickly becomes burdensome for large numbers of users as each must wait their turn to makes changes to the database and there is a high volume of network traffic to make these changes. ODBC – Open Database Connectivity. This is a standard application interface defined to allow programs to work with different databases from different vendors without having to write specific code for each vendor. The user application talks to the ODBC layer which then talks to the specific database. ODBC Driver – This refers to the piece of software used to interface between the ODBC standard application interface and a specific database or database vendor. Examples of ODBC drivers would be drivers for SQL Server, Oracle, Microsoft Access, etc. Round Trip – This refers to the request cycle from a client computer to a server computer. The client requests information, the server receives the request and returns the requested information, and the client receives the result. This is considered one round trip. It is often desirable to reduce the number of round trips made by the client to speed up operations. For example, rather than requesting titles for a group of documents one by one, a client might request an entire list of titles in one round trip. SQL – Structured Query Language. This is a computer language used by databases. It can be used to make requests for information from a database and to create or update information already in a database. Typically pronounced “see-quell”, some prefer to spell out the letters “S.Q.L.” An example is “SELECT * FROM tblDOCUMENT” SQL Server – This typically refers to Microsoft’s SQL Server database program. SQL Server is different from a Jet database system because all requests for information and changes to the database are made from “clients”, and handled by the “server.” Only the server actually makes changes to the database files directly. Microsoft’s SQL Server product is tuned to provide high volumes of data to many users. TCP/IP – Transmission Control Protocol / Internet Protocol. The Internet protocol is a network protocol to transfer information between two computers. Transmission Control Protocol is a protocol which runs on top of IP to ensure that the data transmitted is sent and received correctly. This protocol is the most commonly used networking protocol today and is used within companies and for the Internet.
6 -2 DocSTAR SQL Edition – Technical Documentation