Diagnostic Checks

> Diagnostic Checks

Diagnostic Checks

The Diagnostics Manager program performs a number of checks on the server and client.

Checks performed on the server

The program checks whether there are any missing SYSPRO ports. The port files are located in the \Base\KB folder. If these port files are not numbered sequentially, then the program displays a message: Missing ports. First missing port is xxx.
The program checks the version of SQL Server installed and displays a message if it detects an unsupported version of SQL Server.
The program checks the size of the SRSQRT.TXT file in the \Base folder on the application server. This file is used to debug SYSPRO Reporting Services reports. If the file size exceeds 500MB, then the program displays a warning message.

SYSPRO Reporting Services use the ReportingServices.dll application extension. When this DLL is loaded and it finds the srsqrt.debug file (which you can create by saving a blank notepad file as a .debug file) in the application server's \Base folder, then the program creates the SRSQRT.TXT file and starts writing log information to this file. If you do not require this diagnostic file, then delete the srsqrt.debug file.
The program checks the size of RPT files in \Base\ReportingCustomized\DocumentTemplate or in \Base\ReportingCustomized\ReportTemplate. If any are found to be greater than 1MB, then this is reported in the Application Server Checks listview (Diagnostics Manager).
The program checks the size of the enetlog.dat file. If found to be greater than 500MB, then this is reported in the Application Server Checks listview (Diagnostics Manager).
The program checks the job logging file and job logging details file. These are C-ISAM files in the \Work folder on the application server and contain job logging details. If the size of these files exceed 500MB, then the program displays a warning message. You can purge the job logging files using the Job Logging Query program.
The program checks that the SYSTEM environment variable COBSW is set to -F. This variable is used by e.net Solutions and, if not defined, can cause unpredictable behavior in certain business objects. A warning message is displayed if this variable is not set correctly. A Windows administrator must create/correct this variable on the application server if it does not exist, or is set incorrectly.

Checks performed on the client

In order for Diagnostics Manager to detect problems on each client computer you must enable the option: Run check for all client machines and then save and exit the application. The next time anyone logs into SYSPRO, the diagnostics VBScript is executed automatically on the client computer. The output of the script is saved as an XML file (named by the client computer's machine name) in the \Base\Settings\diagnostics folder on the application server.

The diagnostics script is executed only ONCE on the client computer (i.e. not every time an operator logs in). If you want to re-check all client computers then you need to deselect the Run check for all client machines option and then enable it. This increments a version number which determines whether the client computer needs to re-run the diagnostics script.

Environmental checks

Field	Details/Check performed/Message/Action
OS Version	The program determines the version of the operating system. This is for information purposes only.
32/64 Bit	The program determines the operating system architecture (i.e. 32-bit/64-bit).
Network Speed	The program determines the speed of the network (in GB). If the speed is less than 100MB, then a warning message is displayed.
IP Address	The program determines the client workstation's IP address. This is for information purposes only.
CPU	The program determines the CPU details of the client workstation. This is for information purposes only.
RAM	The program determines the total memory of the client workstation. This is for information purposes only.
Available Memory	The program checks the available memory on the client workstation. If less than 10% of the total memory is available, then a warning message is displayed. You will need to contact your technical department
Machine Name	The program determines the client workstation's name. This is for information purposes only.
User Details	The program determines the network domain name and the Windows user (account) name. This is for information purposes only.

SRS checks

Field Details/Check performed/Message/Action

BaseDir

The program checks and validates the value of the registry key HKEY_LOCAL_MACHINE\SOFTWARE\SYSPRO\e.net solutions (32-bit) or HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\SYSPRO\e.net solutions (64-bit). There must be an entry with a valid path to the \BASE folder.

No BaseDir found for C:\{SYSPRO client installation folder}\Base. SRS/e.net Solutions might fail. Any business object calls inside vbScripts will not work.
Re-run diagnostics checks on all client workstations with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will attempt to update the registry with a valid BaseDir value on the client workstation.
Unable to check registry for a valid BaseDir. Error: Access denied to HKEY_LOCAL_MACHINE\{path}. Recommended value: C:\{SYSPRO client installation folder}\Base. Try running SYSPRO as Administrator.
You can either:
- Re-run diagnostics checks on all client workstations with the Auto correct problems option enabled. Run SYSPRO as a Windows Administrator.
- Manually correct the entry in the Windows Registry on the client workstation.
  Using Registry Editor incorrectly can cause serious, system-wide problems that may require you to re-install Windows to correct them. Microsoft cannot guarantee that any problems resulting from the use of Registry Editor can be solved. Use this tool at your own risk.

Crystal Updates

The program checks that a value of 1 is set against the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Business Objects\Suite 12.0\Crystal Reports\DisableCheckForUpdates (32-bit) or HKEY_LOCAL_MACHINE\SOFTWARE Wow6432Node\Business Objects\Suite 12.0\Crystal Reports\DisableCheckForUpdates (64-bit).

Crystal update check is enabled. Set HKEY_LOCAL_MACHINE\{path} = "1" to increase SRS performance.
Enable re-running of diagnostics checks on all client workstations, with the option Auto correct problems selected. The next time the Diagnostics Manager program runs, it will attempt to update the value of the DisableCheckForUpdates entry in the registry to 1 on the client workstation.
Auto correct failed with error: Access denied to HKEY_LOCAL_MACHINE\{path}. Recommended value: "1". Try running SYSPRO as Administrator.
You can either:
- Re-run diagnostics checks on all client workstations, with the Auto correct problems option enabled. Run SYSPRO as a Windows Administrator.
- Manually correct the entry in theWindows Registry on the client workstation.
  Using Registry Editor incorrectly can cause serious, system-wide problems that may require you to re-install Windows to correct them. Microsoft cannot guarantee that any problems resulting from the use of Registry Editor can be solved. Use this tool at your own risk.

CRConfig.XML

This file defines the configuration settings for Crystal Reports. If it does not exist, then the Java.exe process will not start up and you will be unable to print any SRS reports or documents.

The program checks that the CRConfig.XML file exists in the Program Files\Business Objects\Common\4.0\java folder (32-bit) or the Program Files (x86)\Business Objects\Common\4.0\java folder (64-bit).

CrConfig.xml does not exist! The Java.exe process will not start up and user will not be able to print any SRS reports or documents.
You need to re-install the SRS Runtime or the Crystal Designer from the SYSPRO installation DVD on the client workstation.

CrConfig -<JavaDir>

This element contains the directory of the Java executable. If the value is correct, then this field is not displayed in the Client Details window.

If the CRConfig.XML file exists, then the program checks the value of the following XML node within the file:

<Javaserver-configuration>
<DataDriverCommon>
<JavaDir>C:\ProgramFiles\Java\jre1.5.0_06\bin</JavaDir>
</DataDriverCommon>
</Javaserver-configuration>

The value is compared to the value of the registry entry: HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment\Javahome. This is used as the suggested value for the JavaDir element.

JavaDir not set to suggested. Suggested value: {path as defined in registry}\bin. The JavaDir node determines the Java.exe location.
Re-run diagnostics checks on all client workstations, with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will change this XML element value in the CRConfig.XML file to the suggested value.
You do not need to run SYSPRO as a Windows administrator.

CrConfig - <JavaServerTimeOut>

This element specifies the maximum amount of time the Java server will continue processing the request until it shuts itself down.

If the CRConfig.XML file exists, then the program checks the value of the following XML node within the file:

<Javaserver-configuration>
<DataDriverCommon>
<JavaServerTimeout>30000</JavaServerTimeout>
</DataDriverCommon>
</Javaserver-configuration>

The suggested value is greater than 30000.

Below recommended value found - {value}. This node specifies the Java.exe timeout limit during processing. Recommended value: 30000. Try running diagnostics check with Auto Correct to fix this.
Re-run diagnostics checks on all client workstations, with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will change this XML element value in the CRConfig.XML file to the suggested value.
You do not need to run SYSPRO as a Windows administrator.

CrConfig - <JavaServerStartupTimeout>

This element tells Crystal Reports how long to wait for the Java.exe process to start.

If the CRConfig.XML file exists, then the program determines the value of the following XML node within the file:

<Javaserver-configuration>
<DataDriverCommon>
<JavaServerStartupTimeout>30</JavaServerStartupTimeout>
</DataDriverCommon>
</Javaserver-configuration>

CrConfig - <JVMMinHeap>

This element specifies the minimum amount of heap space that the JVM (Java Virtual Machine) can allocate for running the Java server. This tag is set to 32MB by default.

If the CRConfig.XML file exists, then the program determines the value of the following XML node within the file:

<Javaserver-configuration>
<DataDriverCommon>
<JVMMinHeap>32000000</JVMMinHeap>
</DataDriverCommon>
</Javaserver-configuration>

CrConfig - <JVMMaxHeap>

If the CRConfig.XML file exists, then the program determines the value of the following XML node within the file:

<Javaserver-configuration>
<DataDriverCommon>
<JVMMaxHeap>1024000000</JVMMaxHeap>
</DataDriverCommon>
</Javaserver-configuration>

The suggested value is 1024000000.

Below recommended value found - {value}. This node specifies the memory limit for Java.exe. Try running diagnostics check with Auto Correct to fix this.
Re-run diagnostics checks on all client workstations, with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will change this XML element value in the CRConfig.XML file to the suggested value.
You do not need to run SYSPRO as a Windows administrator.

SRS Preferences

This file is used by SYSPRO Reporting Services and exists per operator code (OPERATOR.xml). Invalid SRS preference files can cause SYSPRO Reporting Services to fail.

The program checks that the operator's SRS preference file exists in the {%AllUsersProfile%}\SYSPRO\SRS folder. This is the operator logged into SYSPRO on the client workstation.


	The `%AllUsersProfile%` environmental Windows variable expands to the full path to the All Users profile directory. This profile contains resources and settings that are used by all system accounts.

SRS preference file invalid! Check {%AllUsersProfile%}\SYSPRO\SRS\{operator.xml}. Invalid SRS preference will cause SRS to fail.

A valid SRS preference file should be re-created the next time an SRS process starts on the client workstation.

Sxs.dll

This DLL is part of Windows. Errors with .NET user controls (when printing SRS documents) can be caused by errors in older versions of the Sxs.dll module.

The program checks that the Sxs.dll file exists in the Windows\System32 folder (32-bit) or Windows\SYSWOW64 folder (64-bit).

The minimum supported version is 5.1.2600.5699.

Sxs.dll NOT found. .NET User controls (i.e. SRS Doc Print) might fail on unsupported versions.

You need to install the correct file version from Microsoft's website.
Sxs.dll version {version} NOT supported. .NET User controls (i.e. SRS Doc Print) will fail on unsupported versions.

You need to install the correct file version from Microsoft's website.

ReportingServices.dll

This is the SYSPRO Reporting Services client component. It sends messages through the standard CCI infrastructure to call programs or business objects on the application server. If this file does not exist, SRS will fail.

The program checks that the ReportingServices.dll file exists in the \Base folder.

C:\{SYSPRO installation folder}\Base\ReportingServices.dll - missing! SRS will fail.

You need to re-install SYSPRO on the client workstation(s).

File/Permission checks

Field	Details/Check performed/Message/Action
%TEMP%	This Windows temporary path is used by SYSPRO programs and SYSPRO Reporting Services as the temporary folder during processing. SYSPRO/SRS diagnostics log files are also written to this temporary folder. The program determines the value of the environment variable `%TEMP%`. The default value of this variable is `%SystemDrive%\Documents and Settings\{username}\Local Settings\Temp` for Windows XP and `%SystemDrive%\Users\{username}\AppData\Local\Temp` for Windows 7.
%TEMP% Access	The local Windows user account needs read and write access to the temporary folder in order for SYSPRO and SYSPRO Reporting Services to work correctly. Attempts to create a test file (`SysproTest.txt`) within the `%TEMP%` folder. `Access Denied to {%TEMP%}. SRS cannot create the TEMP files it needs for rendering reports. SRS will fail!` Contact your system administrator. The local Windows account needs read/write access to the Windows temporary folder.
%TEMP%Delete Access	The program attempts to delete the test file that was created within the `%TEMP%` folder. `Access Denied to delete from {%TEMP%}. User does not have access to delete files in your local TEMP directory! SRS cannot delete the TEMP files it created.` Contact your system administrator. The local Windows account needs read/write access to the Windows temporary folder.
Base\Settings Access	Various configurations and settings are saved to this folder, including customization and layout settings. The program attempts to create a test file (`SysproText.txt`) within the`\BASE\SETTINGS` folder. `Access Denied to C:\{SYSPRO Installation folder}\Base\Settings. Your customizations and layouts will not be saved!'` Contact your system administrator. The local Windows account needs read/write access to the SYSPRO `Base\Settings` folder.

Miscellaneous checks

Field Details/Check performed/Message/Action

Adobe Flash Player

This is required for SYSPRO Executive Dashboards.

The program checks that the Flash Player exists in the registry (located in HKEY_LOCAL_MACHINE\SOFTWARE\Macromedia\FlashPlayer for 32-bit or HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Macromedia\FlashPlayer for 64-bit).

Flash player not installed! The executive dashboards will fail.
You need to install the latest Adobe Flash Player from Adobe's website (if you intend using SYSPRO Executive Dashboards.)

Interop.Encore.dll

This is used in .NET user controls. If it does not exist, any .NET user control will fail.

The program checks that the Interop.Encore.dll file exists in the \BASE folder.

C:\{SYSPRO installation folder}\Base\interop.encore.dll missing! Any .NET user controls will fail. Try manually copying the file from the server.
You can either:
- Manually copy this file from the application server.
- Re-install SYSPRO on the client workstation.

MAPI33.dll

This is used to resolve email addresses and to use the address book in Microsoft Outlook.

The program checks that the MAPI33.dll file exists in the \BASE folder:

C:\{SYSPRO installation folder}\Base\mapi33.dll is missing! The emailing name resolution will fail.
You can either:
- Manually copy this file from the application server.
- Re-install SYSPRO on the client workstation.

Xerces-c_2_1_0.dll

This file is used by SYSPRO Reporting Services. If it does not exist, XML parsing will fail.

The program checks that the Xerces-c_2_1_0.dll file exists in the \BASE folder.

C:\{SYSPRO installation folder}\Base\Xerces-c_2_1_0.dll missing! XML parsing will fail.
You can either:
- Manually copy this file from the application server.
- Re-install SYSPRO on the client workstation.

SYSPROEmailClient

The SYSPROEmailClient.exe is a client-side .NET assembly/executable that sends mail using something other than Simple MAPI. This is supported for Microsoft Outlook 2003 and later.

In order to use this executable you need to have the relevant Outlook PIAs (for the specific version of Microsoft Outlook that you are using) installed as a prerequisite.

The program checks that the SYSPROEmailClient.exe file (SYSPROEmailClient64.exe for 64-bit) exists in the \BASE folder.

C:\{SYSPRO installation folder}\Base\SYSPROEmailClient.exe missing! Emailing using Outlook will fail.
You can either:
- Manually copy this file from the application server.
- Re-install SYSPRO on the client workstation.

SYSPROAnalytics folder

The DLLs and executables for SYSPRO Analytics are copied to this folder.

If this folder does not exist, you might get a SYSPRO self-healing error.

The program checks that the \BASE\SYSPROAnalytics folder exists.

C:\{SYSPRO installation folder}\Base\SysproAnalytics missing! User might get a SYSPRO self-healing error. Try Auto Correct to resolve.
You can either:
- Re-run diagnostics checks on all client workstations, with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will attempt to create this folder on the client workstation.
- Manually create this folder within the C:\{SYSPRO installation folder}\Base folder of the client workstation.
Auto correct failed with error: xxx. Manually create this folder on the client machine. User might get SYSPRO self-healing error.
Manually create this folder within the C:\{SYSPRO installation folder}\Base folder of the client workstation.

Outlook

Microsoft Outlook is the supported email client in SYSPRO. The version of the installed Microsoft Outlook is displayed in the Client Details window.

If the version is not one of the supported versions, then the warning message Outlook Unsupported is displayed.

The program checks the version of Microsoft Outlook currently installed (located in the registry path: HKEY_CLASSES_ROOT\Outlook.Application\CurVer\).

A value of 14 indicates Office 2010; a value of 12 indicates Office 2007 and a value of 11 indicates Office 2003. Any other value indicates an unsupported version.

Outlook not Installed

You need to install a supported version of Microsoft Outlook if you want to use it as your email client.

Outlook PIAs

This is required to include the .NET Programmability Support used in SYSPRO Office Integration. Primary Interop Assemblies (PIAs) make Microsoft Office applications available to Microsoft Visual Studio .NET developers.

The program checks that the installed Primary Interop Assemblies are for the correct version of Microsoft Outlook (located in the registry path: HKEY_CLASSES_ROOT\Installer\Products). The Outlook PIAs cannot be checked for unsupported versions of Office.

The Office Primary Interop Assemblies are NOT installed for {OUTLOOK version}. Email using Outlook email client might fail. You can obtain this from Microsoft.
You need to install the relevant Outlook PIA's from Microsoft's website (for the specific version of Microsoft Outlook that you are using).

Verify Client Components Check

If the client components do not match the components on the server, you can get various errors on the client workstation, including dialog and screenset errors.

The program checks that:

the files in the \SCREENS folder on the client workstation is the same as on the server.
the user interface controls in the \Base\Bin and \Base\UI folders on the application server and client workstation match.
the files indicated in the \PROGRAMS\IMPMOS.IMP file exist.


	These checks are not performed within the VBscript, but by the Diagnostics Manager program. The `IMPMOS.IMP` file (in the `\Programs` folder on the application server) contains a list of files to be validated in a client/server environment. When the Verify Client Components Check option is enabled, this file is copied to the `\Base\Setting` folder on the client workstation.

The client components do not match the components on the server. Try and run the diagnostics check with the Auto Correct Problems option checked.

You can either:
- Re-run diagnostics checks on all client workstations with the Auto correct problems option enabled. The next time the Diagnostics Manager program runs, it will attempt to match the client components with the components on the application server.
- Re-install SYSPRO on the client workstation.