Diagnostic Tool 5.5.1

From ICISWiki

M.C. Habito, A.R. Llorca

ICIS Technical Documentation 5.5 > Diagnostic Tool 5.5 > Diagnostic Tool 5.5.1

Download

Latest version is here: Diagnostic 5.5.1.5

Introduction

The ICIS Installation Diagnostic Tool is an application that tests the different components of your ICIS installation to determine the cause of error situations. This is useful in troubleshooting when your ICIS application is not functioning properly.

User Interface: Version 5.5.1.5

Just choose the test(s) you want to perform and click on the "Run" button.

Configuration Test

(Can be used on datasources associated with different database backends (MS Access,MySQL, PostgreSQL))

Running the Configuration Test will produce the following results:

Operating System info, and ODBC settings:

===========================================================
System Configuration
===========================================================
 Operating System: 
           Microsoft Windows XP Professional Service Pack 2 (Build 2600)
 ICIS ODBC settings:
     Local GMS
              [Windows Data Source Name]    LOCAL-IRIS-TRAINING
              [Driver type]                 Microsoft Access Driver (*.mdb)
              [MDB path]                    E:\ICIS5\Database\IRIS\Local\Training.mdb
              [Status]                      OK
     Central GMS
              [Windows Data Source Name]    CENTRAL-IRIS-GMS
              [Driver type]                 Microsoft Access Driver (*.mdb)
              [MDB path]                    E:\ICIS5\Database\IRIS\Central\IRIS-GMS.mdb
              [Status]                      OK
     Local DMS
              [Windows Data Source Name]    LOCAL-IRIS-TRAINING
              [Driver type]                 Microsoft Access Driver (*.mdb)
              [MDB path]                    E:\ICIS5\Database\IRIS\Local\Training.mdb
              [Status]                      OK
     Central DMS
              [Windows Data Source Name]    CENTRAL-IRIS-DMS
              [Driver type]                 Microsoft Access Driver (*.mdb)
              [MDB path]                    E:\ICIS5\Database\IRIS\Central\IRIS-DMS.mdb
              [Status]                      OK
     IMS
              [Windows Data Source Name]    LOCAL-IRIS-TRAINING
              [Driver type]                 Microsoft Access Driver (*.mdb)
              [MDB path]                    E:\ICIS5\Database\IRIS\Local\Training.mdb
              [Status]                      OK

Option to change the ICIS configuration (.INI) file to use in the test

Option to specify which data source name(s) to test

Checking for existence of required resource files (LAUNCHER.TXT, ICIS32.DLL).

Checking for existence of data source name specified in ICIS configuration file.

Output MS Access database(.mdb) path / host associated with data source names

Version information of ICIS DLL and applications:

 ICIS module versions:
    ICIS32.DLL:        30 October 2007, 05:15:08 PM  (5.4.2.0)
    BROWSE.EXE:        25 October 2007, 06:01:22 PM  (5.4.2.0)
    SETGEN.EXE:        16 November 2007, 03:44:12 PM  (5.4.2.0)
    GMSSRCH.EXE:       08 November 2007, 11:09:30 AM  (5.4.2.3)
    GMSInput.EXE:      31 May 2007, 07:36:48 AM  (5.4.1.0)
    InTrack.EXE:       17 October 2007, 02:13:34 PM  (5.4.2.0)
    ICISworkbook.xla:  06 February 2008, 06:21:34 PM  (Version no. unknown)
    Data Validation Tool.exe: 14 January 2008, 04:45:56 PM  (5.5.1.1)

Checking of module version against ICIS32.dll version (algorithm refined).
Checking of ICIS32.dll version against ICIS release/schema version.

INI keys

Checks INI keys used by ICIS applications

Checking of database file location/path (i.e. .MDB file (MS Access)) associated with an ODBC data source name (refined algorithm).

Validation of file/directory paths specified in ICIS configuration (.INI) file.

ICIS.INI paths:
 ---------------
    [BROWSE]
         LASTDIR=E:\ICIS5               (OK) 
    [CONFIGURATION]
         LASTDIR=E:\ICIS5               (OK) 
    [WORKBOOK]
         WORKBOOK=E:\ICIS5\Exes         (OK) 
         LASTDIR=E:\ICIS5               (OK) 
    [RETRIEVER]
          FILE=E:\ICIS5\Database\IRIS\Local\Training-RTV.mdb (OK) 
    [HELPINI]
         IniPath=E:\ICIS5\EXES\         (OK)

Missing INI keys (if required) produce error messages

Missing INI keys (if optional) produce warning messages only

Database Test

Suggestion: When Automatic modification is enabled, it's best to select only ONE checkbox (or one group of checkboxes. E.g. GMS only, DMS only) PER RUN for faster performance.

If you choose to execute the Database Test, the application will show you the result similar to the following (in "Complete results" tab):

----------------------------------- 
Database Structure   
----------------------------------- 
Central GMS   
  table: ATRIBUTS (771780 records)   
  table: BIBREFS (257 records)   
  table: CHANGES (230089 records)   
  table: GEOREF (4219 records)   
  table: GERMPLSM (1935810 records)   
  table: INSTLN (72 records)   
  ...

Option to specify which database(s) to test

Option to check the schema of the Inventory Management System (IMS) and Gene Management System (GEMS)

Dynamic generation of SQL patches and automatic modification of databases to correspond to ICIS Schema version X.x:

Adding a DB table column ("ADD COLUMN")
Adding a DB index ("CREATE INDEX")
Modifying an existing table column ("ALTER/MODIFY COLUMN"): change to correct datatype/length
Creating a missing table

"Check" panel

In this panel, specify options for checking your database(s). All options are selected by default.

1. Check user/installation info (GMS):

* When you encounter error messages upon launching any of your ICIS applications (example: GMS_INVALID_INSTALLATION in Browse), this option will help you figure out the cause of the problem. This validates data stored in the USERS and INSTLN tables of the local and central GMS, based on the username and password you supplied in the INI file.

2. Check all tables:

* Checks if all required tables for ICIS 5.5 exist in your current ICIS setup

There are 4 tables introduced in ICIS 5.5 (Data Management System): LEVELS, REPRESTN, OBSUNIT, and STEFFECT. More information here

3. Check all table columns:

* Check if table columns exist in the tables of your current ICIS setup

* Check if table columns are of the correct datatype

* Check if table columns are of the correct length (for text).

There are 4 tables with changes in one or more of its columns:

1: INSTLN (Genealogy Management System): added column ULRECID (integer).

2. LISTDATA (Genealogy Management System): increased length of text column SOURCE to 255.

3. LISTNMS (Genealogy Management System): increased length of text column LISTDESC to 255.

4. STUDY (Data Management System) : added columns SSTATUS (integer), SHIERARCHY (integer).

4. Check all table indices:

Table indices significantly improve data retrieval performance of your ICIS applications (example: retrieving a study dataset using Workbook).

"Fix" / ICISAutoMod panel

In this panel, specify options for automatic modification ("ICISAutoMod") of databases in your current ICIS setup. The "ICISAutoMod" facility automatically upgrades your current ICIS databases to ICIS Schema version 5.5.

Database engines currently supported: MS Access, Mysql, Postgresql.

If your database is in Oracle, please download the patch SQLs files for upgrading from a v5.4 schema to v5.5. They are available on Cropforge: http://cropforge.org/frs/?group_id=5&release_id=427

All options are selected by default once ICISAutomod is enabled.

SCHEMA

1. Create missing tables: adds any missing tables (including column definitions) in your current ICIS database setup.

2. Create/alter table columns: adds/updates columns in existing tables in your current ICIS database setup.

3. Create/alter table indices: adds/updates indices defined on existing tables in your current ICIS database setup.

DATA

1. Populate/update table data: new DMS tables LEVELS,OBSUNIT,REPRESTN and STEFFECT require data in them (derived from other DMS tables).

2. Fill NULL columns with default values: (Cropforge feature request #1009 for ICIS Schema)

(Very important for databases in MS Access because running this SQL "ALTER TABLE STUDY ADD COLUMN ... LONG NOT NULL DEFAULT ..." does not populate column value for existing STUDY records, but only takes effect for records newly added)

* STUDY table only (Data Management System):

i. Sets the value of column SSTATUS (Default=1).

Column SSTATUS makes this possible for Workbook v5.5.1: (Like a list in SetGen, a Workbook study can also be Locked, Hidden, or Final)

ii. Sets the values of column SHIERARCHY (Default=0)

Column SHIERARCHY makes this possible for Workbook v5.5.1: (Workbook v5.5.1 now allows studies to be organized into folders similar to SetGen lists)

* All tables: all columns with NULL values in all tables in the specified database(s) are populated with values.

i. Set to "-" (dash) if text datatype

ii. Set to "0" if numeric datatype. (In most cases, 0 is the default..some are 1).

Other procedures

1. Re-assign unique sequential LRECIDs in GMS.LISTDATA table

LRECID is now globally assigned.

Miscellaneous

Display of detections are classified into two categories: Errors (critical issues) and Warnings (less-critical issues).

Informative error/warning messages. Error/warning messages have variations to help pinpoint the cause of the issue and/or recommend a solution to the issue.

Indents,extra spaces between sections, improved section headers/dividers placed in "Results" textfile for better readability

Expandable box for displaying diagnostic results. At the end of the test, the form window is automatically maximized.

"About" form with more information, plus the GNU General Public License. CRIL and IRRI logos also included.

Application icon

Message box appears at the end of the test, with summary of number of errors and warnings.

Error Codes

Reference of error codes and the recommended action to fix the error situation.

Error-0001: Invalid ODBC DSN

Message	Description	Recommended action
Error-0001: Invalid ODBC DSN. *The DSN <ini_dsn>* specified in the INI file is not a Windows DSN**	The indicated ODBC DSN supplied in the ICIS.INI file does not exist as a Windows System DSN or Windows User DSN	Navigate to "Control Panel". Then click on "Administrative Tools". Click on "Data Sources". Check if the DSN exists in the ODBC Data Sources Panel (as System DSN or User DSN)
Error-0001: Invalid ODBC DSN. Microsoft Access database (.MDB) specified for the DSN does not exist	Wrong filename / path	Make sure DSN points to an .MDB with correct filename/path
Error-0001: Invalid ODBC DSN. Microsoft Access database (.MDB) specified for the DSN does not exist	There is no MDB associated with this DSN.	Make sure DSN points to an .MDB

Error-0002: ODBC Connection failed for ODBC DSN

Message	Description	Recommended action
Error-0002: ODBC Connection failed for ODBC DSN. No username (UID) supplied in configuration (.INI) file	Blank UID in INI file	Supply with complete and correct connection credentials. Check your ICIS configuration (.INI) file.
Error-0002: ODBC Connection failed for ODBC DSN. No password (PWD) supplied in configuration (.INI) file	Blank PWD in INI file	(Same as above)

Error-0003: Module is not compatible with ICIS32.dll. Please upgrade your module to version a.B.x.x

Summary:

An ICIS application module is not compatible with the ICIS application installed (DLL compatibility issue)

Action:

Download the module with the correct version compatible with the installed ICIS application package release. http://cropforge.org

MODULE VERSIONING   
Format: a.B.c.d
   
Where:
   
a = foundation class
   
B = dll compatibility
   
c = additional functions/features
   
d = bugfix

Error-0004: ICIS32.dll is not compatible with ICIS release (foundation class). Please upgrade your ICIS32.dll to version A.b.x.x

Summary:

The ICIS32.dll is not compatible with the ICIS application package installed (foundation class compatibility issue)

Action:

Download the ICIS32.dll with the correct version compatible with the installed ICIS application release. http://cropforge.org

DLL versioning   
Format: A.b.c.d
   
Where:
   
A = foundation class (ICIS Annual Workshop).
   
b = change in the db structure or change in technology or algorithm (e.g. Web service)
   
c = additional functions/features
   
d = bugfix

Error-0005: Missing USERS record.

No record with INI file UID/PWD combination <ini_username/ini_password> in both Local & Central GMS

Error-0006: Missing INSTLN record

Message	Description	Recommended action
Error-0006: Missing INSTLN record	There is no INSTLN record with Installation ID <instalid>

Error-0007: DB table not found

Summary:

An ICIS database table is missing.

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create missing tables" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Error-0008: DB table column not found

Summary:

A column from an ICIS database table is missing.

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create/alter table columns" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Error-0009: Resource file is missing <filepath>

Summary:

A required resource file is missing. The existence of the following files are checked: LAUNCHER.TXT, ICIS32.DLL

Action:

Make sure the file exists in the specified directory.

Error-0011: File path specified in ICIS.INI does not exist

Summary:

File/directory path specified in ICIS.INI file is invalid. INI key is required.

Action:

Modify file/directory in ICIS.INI file (section(s) and key(s) with the invalid path

Error-0012: Datatype mismatch

Variations:

Error-0012: Datatype mismatch -DB table column must be TEXT/ STRING
Error-0012: Datatype mismatch -DB table column must be INTEGER/ LONG INTEGER
Error-0012: Datatype mismatch -DB table column must be FLOAT/ DOUBLE

Summary:

An ICIS table column is of the wrong datatype.

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create/alter table columns" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Error-0013: Multiple records in USERS table with UID/PWD combination (from INI file) <ini_username> / <ini_password>

Summary:

There must be only one USERS record (in local/central GMS) with the UID/PWD combination specified in the INI file

Action:

Delete other USERS records with the same UID/PWD combination, or define a different UID/PWD pair.

Error-0014: USERID = 0 not allowed

Summary:

Action:

Error-0015: USERID > 0 not allowed, when user is not in Central [Local GMS]

Summary:

Action:

Error-0016: USERID < 1 [Central GMS]

Error-0017 : [Local GMS].USERS.USERID <userid> does not belong to Installation <instalid>

Error-0018: DB table is empty

Summary:

Table has no records. There are some tables that require data. Example: GMS.INSTLN, GMS.USERS, DMS.LEVELS, DMS.OBSUNIT, DMS.STEFFECT, DMS.REPRESTN

Action:

Make sure the table has at least one record in it.
If missing tables are any of the following: LEVELS, OBSUNIT, STEFFECT, REPRESTN...

1. Click "Reset"

2. Select your INI file (Configuration Test)

3. Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)

4. Select "Populate/update table data" option

5. Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Error-0019: Missing INI key and/or value for key <ini_key> under section <ini_section> of the ICIS configuration (.INI) file

Summary:

There is no key and/or value specified for key [ini_key] under section [ini_section], or the section-key combination does not exist in the ICIS configuration file. For REQUIRED INI keys.

Action:

Supply the missing value for section-key pair in the ICIS configuration file.

Error-0020: INSTALID = 0 not allowed [Local GMS]

Summary:

Action:

Error-0021: INSTALID < 0 not allowed [Central GMS]

Summary:

Action:

Error-0022: A positive USERID can not belong to a negative INSTALID [Local GMS.USERS]

Error-0023: Multiple records in INSTLN table

Message	Description	Recommended action
Error-0023: Multiple records in INSTLN table	Ideally, the INSTLN table in the local GMS must only have ONE record in it	When errors are encountered, delete other INSTLN records; reduce table contents to only one record.

Error-0024: Local GMS Installation IDs (INSTALID) do not match for USERS and INSTLN tables

Error-0025: Cannot proceed with re-assignment of LRECID in LISTDATA table

Bug: Application error. [procedure name]

Summary:

There is a programming error in the ICIS installation diagnostic tool.

Action:

Submit bug report at CropForge: ICIS Communication > Bug Tracker

Warning Codes

Warning-0001: DB index not found

Summary:

An index from an ICIS database table is missing.

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create/alter table indices" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Warning-0002: Size/length mismatch : DB table column must be of length X

Summary:

An ICIS table column is not of the correct length or size.

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create/alter table columns" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Warning-0003: DB index requires modification

Summary:

A database table index exists but requires an update (i.e. columns included in index definition are different)

Action:

Click "Reset"
Select your INI file (Configuration Test)
Select the "Automatic modification/upgrade (ICISAutoMod) to ICIS v5.5" option (Database Test: "Fix" tab)
Select "Create/alter table indices" option
Click "Run". The tool will make the database changes for you (if you have write access to the specific database you want to modify)

Warning-0004: ICIS32.dll (vX.X.x.x) may not be compatible with ICIS release (foundation class). If problems are encountered, use ICIS32.dll Version X.X.x.x instead

Summary:

The ICIS32.DLL is a newer version than the ICIS release foundation class. E.g. ICIS32.DLL is v5.5.x.x while the foundation class is 5.4.x.x

Action:

If problems occur, download the appropriate version of the ICIS32.DLL from Cropforge

Warning-0005: Module may not be compatible with ICIS32.dll. If problems are encountered, use <module_name> Version X.X.x.x instead

Summary:

The Module is a newer version than the ICIS32.dll. E.g. SETGEN.EXE is v5.5.x.x while the ICIS32.DLL is 5.4.x.x. Current ICIS installation is v5.4

Action:

If problems occur, download the appropriate version of the ICIS application module from CropForge

Warning-0006: File path specified in ICIS.INI does not exist

Summary:

File/directory path specified in ICIS.INI file is invalid. INI key is optional.

Action:

Modify file/directory in ICIS.INI file (section(s) and key(s) with the invalid path

Warning-0007: Missing INI value for key <ini_key> under section <ini_section> of the ICIS configuration (.INI) file

Summary:

There is no value specified for key [ini_key] under section [ini_section], or the section-key combination does not exist in the ICIS configuration file. For OPTIONAL INI keys.

Action:

Supply the missing value for section-key pair in the ICIS configuration file.

WHAT'S NEW in Version 5.5.1

* The Installation Diagnostic Tool is now applicable to the following database engines: MS Access, MySQL and PostgreSQL.

CONFIGURATION TEST

Support for both Windows System DSNs and Windows User DSNs.
Check: ICIS32.DLL may not be compatible with ICIS release (foundation class)
Check: Module may not be compatible with ICIS32.DLL
Check existence of INI keys (for required INI keys and optional INI keys)
Output MS Access database(.mdb) path / host associated with data source names
Added option to show/hide database backends associated with data source names
Generate a new INI file based on the ICIS .INI template and diagnostic results. as of v5.5.1.3

Select "Generate new INI file" option

Show regenerated INI

DATABASE TEST

Option to check local database only, central database only, or both (for GMS and DMS).
Check GEMS database structure
Check existence of tables. Create them if missing.
Refined/additional checks for handling GMS_INVALID_USER, GMS_INVALID_PASSWORD and GMS_INVALID_INSTALLATION errors
Check data type of table columns
Some missing tables only generate a warning message (not an error)
Check if a table is empty. Populate it with data if empty (applicable to some tables)
Fill NULL columns with default values: '-' (dash) for text, 0 for numeric (1 for some columns)
Disabled changing of .SQL templates
Patch files saved with .SQL extension (previously saved as .TXT)
Dynamic creation of SQL patches based on backend (add/alter/drop table columns, add table indices).

[Regardless of the existing ICIS schema version of the actual database, it will be updated to the latest ICIS Schema version (determined by .SQL file used as template). i.e. If the latest version is 5.4, you can update from a 5.2 to 5.4... from 5.3 to 5.4, etc. (Previous release of Installation Diagnostic Tool could only update an ICIS Schema 5.3 database to a 5.4)]

DLL TEST

Removed; troubleshooting already handled by Database test.

MISCELLANEOUS

Option to email results to ICIS team/administrator for further technical support

(Click the button with the envelope icon after running the tool)

Application version number visible on main form.

Test outputs are grouped into 3. Introduced 3 tabsheets that display the following:
- Errors only.
- Warnings only.
- Complete results: Errors, warnings, other information are displayed together on one sheet.

Separate form for displaying components related to "View .SQLs" (to de-clutter the main interface)

"About" form has links to the following:
- Online documentation (technical documentation on ICISWiki)
- CropForge page for submitting new feature request
- CropForge page for submitting new bug report

Added timestamp on results text file name

Improved display of error & warning messages:

1. "Grouping" of errors & warnings into categories

2. Clearly indicated if problem has been fixed or not.

Diagnostic Changes.txt

//	Legend:		[+] Addition/New feature
//			[-] Removal
//			[*] Modification/Bug Fix
//
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.5
#
######################################################################
[*] Minor modifications in error messaging
[*] Minor fixes in form component behavior
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.4 
#
######################################################################
[*] Fixed bug in checking of filepaths
[*] Improved display of progress: allow clicking/minimizing of form, avoid "Not responding" caption [Cropforge Feature Request #1151]
[+] Check if required DLLs/OCXs exist [CropForge Feature Request #1249]
[+] Added new folder called "dlls" (under icis_diag_resources) containing all DLLs required by ICIS applications.
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.3 
#
######################################################################
[*] Improved algorithm for regeneration of INI file
[*] Fixed bugs in behavior of form components in Database Test panel
[+] Creation of folder "results" for storing result files
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.2 
#
######################################################################
[*] Modified configuration test-database test dependency. Defined separate flags for database groups (eg. GMS, DMS, IMS, GEMS)
[+] Added functionality to regenerate a new INI file (to include missing INI keys and/or values) [Cropforge feature request # 1154]
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.1 
#
######################################################################
[*] Modified SQL for inserting data into DMS.OBSUNIT table: exclude records with OUNITIDs appearing more than once.
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.1.0 (OFFICIAL RELEASE) 
#
######################################################################
[*] Improved contents of error/warning messsages
###############################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.16
#
######################################################################
[*] Improved display of error & warning messages (Made recommendations/solutions more visible)
[+] Added function to open any CropWiki articles on the web related to INI key issues
[*] If not in FIX mode, change label of <<<startpatch>>> to "Recommendation" to avoid confusion.
[+] Display database types on form.
[*] Other/advanced FIX options (e.g. Change INT to LONGINT) moved to a separate section
[*] Checking for INI keys: in error message, use quotes ("") instead of square brackets at the beginning and end of a missing INI key. Example. "LASTDIR" instead of [LASTDIR]
[*] Modified SQL for inserting data into DMS.LEVELS table: exclude records with LEVELNOs appearing more than once.
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.15
#
######################################################################
[*] Bug fix: set ExtendedAnsiSQL property during connection to database (instead of editing registry values).
[*] Auto-modification panel: "Update column data: Fill NULLs with default values" not selected by default 
[*] Improved checking of ICIS INI keys
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.14
#
######################################################################
[+] Set ExtendedAnsiSQL property of DSN to 0/1 (Cropforge feature request # 1097)
[+] Check for INI keys used by GEMS catalog (Cropforge feature request # 1093)
[+] Check for additional INI keys used by Workbook and In-track
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.13
#
######################################################################
[-] Removed error message: checking of local INSTLN record with central INSTLN record
[*] Bug fix: Tool does not flag missing UID/PWD in INI file (Cropforge Bug # 1077)
[+] DB test auto-modification -- GMS.LISTDATA table: increase length of SOURCE column to 255
[+] DB test auto-modification -- GMS.INSTLN table: added new column ULRECID
[-] Removed DLL test (DB test already handles troubleshooting for DLL errors)
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.12
#
######################################################################
[*] Bug fix: Certain missing tables must not produce error message (Cropforge Bug #1018)
[*] Bug fix: INTEGER columns should not be changed to LONGINT by default (CropForge Bug #1015)
[*] Bug fix: MS Access -- default values not set for new columns in existing records (CropForge Bug #1008)
[+] Option to check local and/or central database (CropForge feature request #1016)
[+] Make "fill table with data" function optional (CropForge feature request #1014) 
[*] Check for table indices disabled temporarily.
[*] Cleaned some code; removed garbage in output file
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.10 
#
######################################################################
[*] Bug fix: "Internal function failed to execute" message in Database Test (Cropforge bug #989)
[+] Include .mdb paths associated with DSNs in results (Cropforge feature request #967)
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.9 
#
######################################################################
[+] Option to create missing tables (Cropforge feature request #646)
[+] Option to email diagnostic tool results to ICIS team for support (Cropforge feature request #968)
[+] Check consistency of sequence of columns in a table (Cropforge feature request #977)
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.8 
#
######################################################################
[+] Added existence check for [GMSSRCH] INI keys: 
LOCAL_DB_SEARCH=
DEF_CASE_FOR_NAME_SEARCH=
DEF_TAB=
ALPHASORT_NAME=
STUDYSQL=
[+] Database test: added existence check for 4 new DMS tables (LEVELS, REPRESTN, OBSUNIT, STEFFECT)
[*] Bug fix: Modified algorithm for database auto-modification with setting of DEFAULTs
[*] Bug fix: Modified algorithm for checking of INSTLN/USERS records
  (no error if UID/PWD in ini file references INSTALLATION and USER records in the CENTRAL)
[+] DB test auto-modification -- GMS.LISTNMS table: increase length of LISTDESC column to 255 (CropForge feature request #934)
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.7 
#
######################################################################
[*] Adding missing table columns: include default values & NOT NULL constraints in auto-modification SQL patches
[+] Option to check for existence of INI keys (flagged as warning)
- Includes check for SHOW_PREFID ini key for showing/hiding preferred ID with the preferred name in ICIS   applications.
[+] Added checkboxes: specify whether to check...1) version numbers of ICIS32.DLL & ICIS applications; 2) INI file paths; 3) existence of INI keys 
[-] removed "Test is aborted" pop-up window (divert message to statusbar instead).
[*] Added timestamp on results text file name
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.6 
#
######################################################################
[*] Refined the algorithm for local & central USERS table checking (some errors are flagged only if the local userid is positive)
[+] Added exception handling to remove pop-up message upon closing of main form (if DLL test was performed)
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.5 
#
######################################################################
[*] Modified algorithm for existence check for tables [function CheckTableName()]
################################################################################
#
#	INSTALLATION DIAGNOSTIC TOOL V5.5.0.4 
#
######################################################################
[+] DB test auto-modification -- DMS.STUDY table: added new columns SSTATUS and SHIERARCHY
[*] New look for main form (colors/images)
[*] Modified algorithm for checking local & central USERS table
[*] Modified algorithm for checking table schema & integer length
[+] Application version number visible on main form
[-] Changing of .SQL file templates removed (to reduce error occurrence)
[+] Option to set new column names to lowercase/uppercase (Auto-modification facility)
[*] Improved error messages for DLL test

Diagnostic Tool 5.5.1

From ICISWiki

Contents

Download

Introduction

Configuration Test

Operating System info, and ODBC settings:

Version information of ICIS DLL and applications:

INI keys

Database Test

"Check" panel

"Fix" / ICISAutoMod panel

SCHEMA

DATA

Other procedures

Miscellaneous

Error Codes

Error-0001: Invalid ODBC DSN

Error-0002: ODBC Connection failed for ODBC DSN

Error-0003: Module is not compatible with ICIS32.dll. Please upgrade your module to version a.B.x.x

Error-0004: ICIS32.dll is not compatible with ICIS release (foundation class). Please upgrade your ICIS32.dll to version A.b.x.x

Error-0005: Missing USERS record.

Error-0006: Missing INSTLN record

Error-0007: DB table not found

Error-0008: DB table column not found

Error-0009: Resource file is missing <filepath>

Error-0011: File path specified in ICIS.INI does not exist

Error-0012: Datatype mismatch

Error-0013: Multiple records in USERS table with UID/PWD combination (from INI file) <ini_username> / <ini_password>

Error-0014: USERID = 0 not allowed

Error-0015: USERID > 0 not allowed, when user is not in Central [Local GMS]

Error-0016: USERID < 1 [Central GMS]

Error-0017 : [Local GMS].USERS.USERID <userid> does not belong to Installation <instalid>

Error-0018: DB table is empty

Error-0019: Missing INI key and/or value for key <ini_key> under section <ini_section> of the ICIS configuration (.INI) file

Error-0020: INSTALID = 0 not allowed [Local GMS]

Error-0021: INSTALID < 0 not allowed [Central GMS]

Error-0022: A positive USERID can not belong to a negative INSTALID [Local GMS.USERS]

Error-0023: Multiple records in INSTLN table

Error-0024: Local GMS Installation IDs (INSTALID) do not match for USERS and INSTLN tables

Error-0025: Cannot proceed with re-assignment of LRECID in LISTDATA table

Bug: Application error. [procedure name]

Warning Codes

Warning-0001: DB index not found

Warning-0002: Size/length mismatch : DB table column must be of length X

Warning-0003: DB index requires modification

Warning-0004: ICIS32.dll (vX.X.x.x) may not be compatible with ICIS release (foundation class). If problems are encountered, use ICIS32.dll Version X.X.x.x instead

Warning-0005: Module may not be compatible with ICIS32.dll. If problems are encountered, use <module_name> Version X.X.x.x instead

Warning-0006: File path specified in ICIS.INI does not exist

Warning-0007: Missing INI value for key <ini_key> under section <ini_section> of the ICIS configuration (.INI) file

WHAT'S NEW in Version 5.5.1

CONFIGURATION TEST

DATABASE TEST

DLL TEST

MISCELLANEOUS

Diagnostic Changes.txt

Views

Personal tools

Navigation

Search

Toolbox