Download DataGate Client Setup Instructions

FCMAT/California School Information Services
Client Setup Instructions
for
SRRTS DataGate User Guide
Version 2.12
September 17, 2008
Copyright  2008, FCMAT/California School Information Services
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Table of Contents
1. Document Conventions ............................................................................................................4
2. Introduction ..............................................................................................................................5
2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
Formatting Conventions .............................................................................................................. 5
Web Based Client ........................................................................................................................ 5
Hardware Requirements .............................................................................................................. 6
Software Requirements ............................................................................................................... 6
Connectivity Requirements to the CSIS network for SRRTS ..................................................... 6
SRRTS Security .......................................................................................................................... 7
Steps in the Installation Process .................................................................................................. 7
Supported Versions of the Java Runtime Environment (JRE) .................................................... 8
3. Checking for Correct Browser Version .................................................................................9
4. JRE 1.5.0_11 Upgrade Instructions .....................................................................................10
5. Client Software Installation ..................................................................................................11
5.1
5.2
5.3
5.4
Removal of Existing JRE(s) ...................................................................................................... 11
Installation of the JRE from the CSIS Web Site ....................................................................... 12
Disable Client-side Java Caching and Automatic Updates ....................................................... 15
Cleanup and Restart .................................................................................................................. 19
6. Updating the Trusted Sites Setting With CSIS’ Secure URLs ..........................................20
7. Enabling the Java Console ....................................................................................................23
Appendix A: Java Applet Runtime Memory Settings ..............................................................26
Appendix B: Deleting Cached Files ............................................................................................28
Page 2 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Revision History
Name
Date
Reason For Changes
Version
Rick Logan
2008.09.17
Added Power user rights requirement
2.12
Robert Chen
2008.09.02
Removed stray NameSearch references
2.11
Robert Chen
2007.10.04
Removed NameSearch Instructions. Standardized
formatting on figure labels.
2.10
Slymon Ahmed
2007.07.25
Added instructions on setting Java memory parameters
2.9
Robert Chen
2007.05.24
Updated minimum system requirements. Added section
on enabling Java console.
2.8
Robert Chen
2007.04.13
Added additional steps to delete temporary files to
section 3.4
2.7
Robert Chen
2007.04.04
Added additional steps to disable Automatic Updates
to section 3.4
2.6
Robert Chen
2007.03.28
Added installation instructions for JRE 1.5.1_11 and
significantly reformatted document.
2.5
Slymon Ahmed
2004.01.14
Added installation instruction for JRE 1.3 and
instructions for setting up the Trusted Sites under IE.
2.4
Chula Ranasinghe
2003.08.06
Installing new JRE version
2.3
Dionne Gordon
2003.06.12
Update document to reflect current conventions,
standards and copyright material.
2.2
Slymon Ahmed and Jim
Petrick
2003.01.13
Updated hardware, software, browser requirements and
removed sections relating to Netscape
2.1
Dionne Gordon
2001.08.01
Update for procedural changes, upgrades to hardware
requirements and browser changes.
2.0
Robin Canale
2000.09.25
Updated to include instructions for downloading with
Netscape Browser
0.5
Robin Canale
2000.09.14
Updated to add hardware requirements
0.4
Robin Canale
2000.09.14
Updated to reflect change in installation process
0.3
Charles Burns
2000.09.14
Added pre-deployment Security Explanation.
0.2
Charles Burns
2000.09.08
Initial Draft
0.1
Page 3 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
1.
Document Conventions
The title page and header of this document contain a version number in the form X.Y.Z where:
X is the version number in sequence 1 through N
Y is the revision number in sequence .1 through .N
Z is the errata correction number in sequence .1 through N
Each new version represents substantial change to the document (for example, adding or deleting
elements, work products, or processes) and will be serially numbered to the right of the first
decimal (for example 3.1, 3.2 ...) once it has been approved by CSIS management.
Minor revisions (that is, format or spelling) will retain the version and revision number and only
increment the correction number to the right of the second decimal (for example 3.0.1, 3.1.1,
3.1.2,…).
CSIS software systems are sensitive only to the Version & Revision number (e.g. 3.1).
Correction numbers are not entered into CSIS software systems.
Page 4 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
2.
Introduction
Welcome to the California School Information Services (CSIS) State Reporting and Records
Transfer System (SRRTS) DataGate Client Setup Instructions. This guide provides step-by-step
instructions for installing the files required to run the SRRTS DataGate client.
2.1
Formatting Conventions
Throughout this User Guide, the following conventions have been followed:
Bold Type indicates words or characters that the user enters or menu selections and
buttons that activate functions.
Italic type indicates a placeholder for items that must be supplied, such as file names, or
important new terms, headings, and titles.
[Square brackets] are used to denote functions or components that are part of the system
design, but which are not functional at this time.
NOTES:

2.2
Notes are used to offer the user tips, cautions, or information
useful to the function.
Web Based Client
The SRRTS software is World Wide Web based. This means that you can only access the
software with a Web Browser. CSIS does not supply the browser, but CSIS does require that the
browser be configured in a specific way with some additional components. This guide shows
how to retrieve those components and install them on the local browser.
The browsers that are supported in this release of SRRTS are Microsoft Explorer 6.0 or newer.
Download Instructions for the SRRTS DataGate using Internet Explorer is provided in this
document.
Note

The browser must be installed on the client computer before
installing any of the additional software as described in this guide
Page 5 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
2.3
Hardware Requirements
The minimum hardware configuration (where different, the recommended configuration is
presented within parentheses) for the DataGate is as follows:

Pentium 300+ (or equivalent)

256 MB memory

Screen Resolution 800x600 or higher

Hard drive Free Space of 1GB or more (depending on enrollment)
The LEA must have access to the Internet (CSIS does not support dial in).
Hardware requirements for larger LEAs participating in more robust SRRTS functionality, such
as State Reporting, utilizing larger file sizes, will require expanded hardware capability. The
minimum requirements for these LEAs should be:


Pentium 4 (or equivalent)

512 MB RAM (or more)

Screen Resolution 1024 x 768

Hard Drive Free Space 10 GB (or more)

The LEA must have access to the Internet (CSIS does not support dial in).
If LEAs need help understanding the minimum requirements, they should contact Support at 916325-9210 for further clarification.
2.4
Software Requirements
The SRRTS client is “thin” client architecture. The software components to be installed on the
client computer are:

Windows 2000, XP

Internet Explorer Version 6.0 or newer (no other Internet Browsers are currently
supported)
2.5
Connectivity Requirements to the CSIS network for SRRTS
The SRRTS was designed to be deployed as an Internet based application using well-established
protocols. The client computer must be able to communicate with the following ports on the
CSIS Web services network:

The LEA must have at least Power user rights on the PC (Windows)

Port 80 for standard HTTP communication
Page 6 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12

Port 443 for encrypted sessions via SSL

Port 25 for SMTP connectivity to CSIS's mail server (refer to the following paragraph)
IP addresses for some resources may change due to system requirements; it is recommended that
the LEA's allow communication over the ports listed above to the entire Web services network.
The use of port 25 is implied as that is a common means of local SMTP server connection to the
Internet; it may be that your particular installation depends upon another port being open for mail
services.
Content filtering should be checked, as SRRTS depends upon java applet being executed within
your Web browser. Any proxy or firewall that is used must allow all Java content. This includes
both class and .jar files.
2.6
SRRTS Security
The security design for authentication, authorization and encryption for SRRTS is based on
X.509 digital certificates. The X.509 digital certificate is a well-established Internet protocol for
establishing and confirming an individual’s identification and automatically establishing secure,
encrypted sessions between client computers and Web servers. Authorization (granting privileges
for specific functions to specific users) is handled by the SRRTS software and is completely
based on the username attached to the X.509 certificate being used.
Security for SRRTS includes the 3 X.509 components:

Secure Sockets Layer (SSL) 3.0, employing 128-bit encryption, is automatically enabled
upon establishing a connection with the SRRTS DataGate Server. Internet Explorer is
compatible with this automatic encryption and secure channel setup process.

The CSIS Server has been issued a Class 3 X.509 Digital Certificate to ensure users that
the destination of the data sent indeed a server at CSIS.

The third X.509 component, user authentication via client X.509 certificates, is also part
of SRRTS security architecture.
Note

2.7
Instructions for submitting applications to obtain Digital ID
Certificates are located on the CSIS DataGate Support Web page;
http://www.csis.k12.ca.us/support/
Steps in the Installation Process
This section provides information on the different steps involved in installing the files required to
run the SRRTS DataGate client successfully and they are as follows:
1. Verification of current browser version & encryption setting
2. Removal of existing JREs
3. Installing Sun Microsystems Java Runtime Environment
4. Updating the Trusted Sites setting with CSIS’ secure URLs
Page 7 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
 It is important that the installation process is completed in the order listed.
The Java Runtime Environment must be installed in the proper sequence because it automatically
overwrites any previously installed policy files. When this occurs, the proper policy file is not
available to the SRRTS application. As a result, the program will appear to “hang” whenever the
SRRTS application attempts to read or write a file to the local hard drive; such as perform an
import or list the files that need to be validated.
 The Trusted Sites setting in Internet Explorer must be setup correctly.
The Trusted Sites setting under the Internet Explorer browser allows users to added secure Web
site addresses or URLs so that the browser can read the content of secure sites correctly. The
CSIS secure URLs must be added under the Trusted Sites properties for the SRRTS reports to
display correctly.
2.8
Supported Versions of the Java Runtime Environment (JRE)
There are three different versions of the JRE that CSIS currently supports:
Current supported version
 JRE Version 1.5.0_11 is the latest version of the JRE that CSIS currently supports. CSIS
highly recommends that you use this version of the JRE. The other versions should only be
used in the event that the machine is not able to run this version or technical problems
prevent you from upgrading at this time.
Legacy support
These versions are still currently supported, however support for these versions will
eventually be discontinued so it is recommended that users use the current version instead if
possible.
 JRE Version 1.3.1_07 is for workstations that have a screen resolution of 1024 x 768 or
higher. This version is designed to work more efficiently with large extracts when at least
786MB of physical memory or higher is installed on the workstation. This version of the JRE
takes advantage of the higher memory size and optimizes import and validation processing
time.
 JRE Version 1.3 must be installed with screen resolution of 800 x 600 or higher.
Page 8 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
3.
Checking for Correct Browser Version
1. Open Microsoft Explorer.
2. From the Help menu, click About Internet Explorer as shown in Figure 1.
Figure 1. Internet Explorer Help menu
3. On the About Internet Explorer Screen, check if the Version is 6.0 or above and the Cipher
Strength is 128-bit or above as shown in Figure 2.
Figure 2. Internet Explorer About window
If your Internet Explorer version is below version 6.0 or uses less than 128-bit encryption, you
will need to upgrade it to meet these specifications.
Page 9 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
4.
JRE 1.5.0_11 Upgrade Instructions
CSIS has recently added support for a newer version of the Java Runtime Environment (JRE). It
is recommended that LEAs upgrade to this version (1.5.0_11) when convenient as CSIS will
eventually discontinue support of 1.3.x versions (1.3.0-C and 1. .3.1_07-b02).
Note that if you continue to use the 1.3.x version of the JRE, you will continue to receive a
reminder that a newer version is available when you log into DataGate or TestGate. The reminder
will look similar to Figure 3 below.
Figure 3. JRE Version Warning
If you receive this message and decide to upgrade make sure to follow the instructions in this
guide to complete the upgrade. Do not accept prompts from Internet Explorer to upgrade and do
not use the JRE from Sun’s Web site, otherwise your installation may not work with DataGate or
TestGate.
The following steps are necessary to setup the JRE version 1.5.0_11 used by CSIS:
1.
2.
3.
4.
Removal of Existing JRE(s)
Installation of the JRE from the CSIS Web Site
Disable Client-side Java Caching
Cleanup and Restart
These steps must be followed in the order listed above or the installation may not complete
correctly.
This process can also be used to correct your JRE installation if multiple versions of the JRE
were installed by accident.
Page 10 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
5.
Client Software Installation
5.1
Removal of Existing JRE(s)
Before installing the JRE used by CSIS it is necessary to remove any other existing versions of
the JRE. This helps prevent software conflicts created by having multiple JREs installed.
a. Before starting the removal process, it is best for all other applications to be closed. At a
minimum, all Internet Explorer windows or any program using Java must be closed.
b. Open the Control Panel from the start menu as shown in Figure 4. Depending on your
computer configuration it may look like the left side or the right side of the Figure.
Figure 4. Start menu: Control Panel shortcut
c. Double-click the Add or Remove Programs icon. Find any existing JREs that are
installed. They may be listed as Java 2 Runtime Environment, JRE, or J2SE.
d. If multiple JREs are installed, they should be removed starting with the highest version
number and ending with the lowest. Select the JRE you want to remove so that the
Remove button appears as shown in Figure 5.
Figure 5. Add or Remove Programs Applet
Page 11 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
e. Click Remove.
f. Click Yes if prompted to continue removing the JRE.
g. Repeat steps d-f for each version of the JRE that you have installed.
h. After uninstalling the JRE(s) it may be necessary to remove directories not deleted by the
removal process. First, open My Computer from the start menu or from the icon on your
desktop.
i. Next open the C drive, usually listed as Local Disk (C:) by default.
j. Then open the Program Files folder. You may receive a message that the files are
hidden. If so, click the link that says Show the contents of this folder.
k. Look through the folder for any folders called Java or Javasoft. If any of these folders
exist they should be deleted by selecting the folder and then choosing the Delete option
from the File menu as shown in Figure 6.
Figure 6. Program Files Folder
5.2
Installation of the JRE from the CSIS Web Site
a. Open Internet Explorer. There should be a shortcut on your desktop or in the start
menu.
b. Go to the CSIS DataGate setup page (http://www.csis.k12.ca.us/setup/).
c. Click on the first link under Step 2 shown in Figure 7.
Page 12 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Figure 7. DataGate Setup Page
d. When presented with the File Download window shown in Figure 8, click Open or Run
(different versions of Windows will shown one button or the other).
Figure 8. File Download Window
e. If presented with any warnings about opening or running this file, allow the setup to run.
Page 13 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
f. When the License Agreement is presented, leave the option at Typical setup and click
Accept shown in Figure 9.
Figure 9. JRE Setup – License Agreement
g. The setup process may take a few minutes or longer. Once it is complete, click the Finish
button shown in Figure 10. Do not restart you computer after this setup completes.
Figure 10. JRE Setup – Installation Complete
Page 14 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
5.3
Disable Client-side Java Caching and Automatic Updates
If you use JRE version 1.5 or above, you need to disable client-side Java caching. If caching is
not disabled an older version of the SRRTS code may be used by your browser, which can lead to
various problems.
a. Open the Control Panel.
b. Double-click the Java icon shown in Figure 12.
Figure 11. Windows Control Panel
Note

On some operating systems, the Add or Remove Programs icon
may not be displayed by default. Click the Switch to Classic
View link on the left to reveal it.
Page 15 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
c. Click the Settings button shown in Figure 13.
Figure 12. Java Control Panel: General Tab
d. Click the View Applets button shown in Figure 14.
Figure 13. Java Control Panel: Temporary Files Settings
Page 16 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
e. Remove the check from the Enable Caching checkbox shown in Figure 15, then click
OK.
Figure 14. Java Applet Cache Viewer
f. Click OK to close the Temporary Files Settings window.
Now we need to delete the existing temporary Java files.
g. Click Delete Files.
h. Click the OK button shown in Figure 16.
Figure 15. Java Control Panel: Delete Temporary Files
Page 17 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Next we will disable automatic updates.
i. Click the Update tab shown in Figure 17.
Figure 16. Java Control Panel
j. Uncheck the Check for Updates Automatically checkbox.
k. A warning window may appear as shown in Figure 18. Click Never Check.
Figure 17. Java Update Warning
l. Click OK to close the Java Control Panel window.
Page 18 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
5.4
Cleanup and Restart
a. Next it is recommended that you empty your Temporary Internet Files folder. From the
Tools menu choose Internet Options.
b. Click Delete Files.
c. Check the Delete all offline content box and click OK.
d. Wait for the files to be deleted. It may take up to several minutes to finish if you have a
lot of temporary files. Then click OK to close the Internet Options window.
e. Now you need to restart your computer. To do this click the Shut Down option in the
start menu, select Restart from the selection box, and click OK.
f. Once your computer is done restarting, your installation should be complete. Try going to
TestGate or DataGate to test your installation. Note that you must also have a valid
certificate to access either site. See the section 2 of the SSID User’s Guide for details on
obtaining the Certificate if necessary.
Page 19 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
6.
Updating the Trusted Sites Setting With CSIS’ Secure
URLs
Open Internet Explorer and do the following:
1. From the Tools menu, click Internet Options as shown in Figure 19.
1
Figure 18. Internet Explorer: Tools menu
2. Click the Security tab shown in Figure 20.
3. Click the Trusted Sites icon.
4. Click the Sites button.
2
3
4
Figure 19. Internet Explorer: Internet Options
Page 20 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
When the Trusted Sites widow appears as below, add the following secure Web addresses:


https://www.csis.k12.ca.us
https://report.csis.k12.ca.us
1. Type each URL in the Add this web site to the zone: field shown in Figure 21.
2. Click Add.
3. Repeat above two steps until all the addresses have been added.
4. Click OK to close the window and return to the Security tab.
2
1
4
Figure 20. Internet Explorer: Trusted Sites list
Page 21 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
The security level for the Trusted Sites zone must be set to Medium. Take the following steps:
1. While in the Security tab, click the Trusted Sites icon as shown in Figure 22.
2. Click Default Level.
3. Move the lever up to Medium.
4. Click Apply.
5. Click OK.
1
3
2
4
5
Figure 21. Internet Explorer: Internet Options
Page 22 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
7.
Enabling the Java Console
1. Open the Control Panel from the start menu as shown in Figure 23. Depending on
your computer configuration it may look like the left side or the right side of the
Figure.
Figure 22. Start menu: Control Panel shortcut
2. Double-click the Java icon shown in Figure 24.
Figure 23. Windows Control Panel
Page 23 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
3. Click the Advanced tab shown in Figure 25.
Figure 24. Java Control Panel: General Tab
4. Click the plus (+) sign next to Java console shown in Figure 26.
Page 24 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Figure 25. Java Control Panel: Advanced Tab
5. Click the radio button next to Show console shown in Figure 27.
Figure 26. Java Control Panel: Advanced Tab Settings
6. Click OK to close the window shown in Figure 28.
Figure 27. Java Control Panel: Advanced Tab
Page 25 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Appendix A: Java Applet Runtime Memory Settings
If you receive an Error 1000 while accessing DataGate or have large amounts of data you may
need to adjust the Java Applet Runtime Settings. By adjusting the amount of Plug-in allocated
memory, you can optimize the SRRTS application and your data can be processed more
efficiently. Please note that this setting is very sensitive to different workstation environments. It
may take a few tries to configure your system correctly. CSIS strongly advises LEAs to contact
the CSIS support helpdesk and work with one of the support staff when making this change to
the java.
1. Open the Control Panel from the start menu as shown in Figure 29. Depending on
your computer configuration it may look like the left side or the right side of the
Figure.
Figure 28. Start menu: Control Panel shortcut
2. Double-click the Java icon shown in Figure 30.
Figure 29. Windows Control Panel
Page 26 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
3. Click the Java tab shown in Figure 31 and then click the View button under the
“Java Applet Runtime Settings” as shown below.
Figure 30. Java Control Panel: Java Tab
4. Double Click in the Java Runtime Parameters box and type in “–Xmx256m”
without the quotes as shown in Figure 32 below.
Note: You may need to adjust the actual memory value from 0 to 400 if necessary.
Figure 31. Java Runtime Settings
5. Click OK, and then click on Apply and OK to close the Java Control Panel.
6. Restart the browser.
Page 27 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
Appendix B: Deleting Cached Files
Another cause of errors in SRRTS can be java applets or files that were cached before caching
was disabled (Section 5.4). To delete stored applets follow these steps:
1. Open the Control Panel from the start menu as shown in Figure 32. Depending on
your computer configuration it may look like the left side or the right side of the
Figure.
Figure 32. Start menu: Control Panel shortcut
2. Double-click the Java icon shown in Figure 33.
Figure 33. Windows Control Panel
Page 28 of 29
Client Setup Instructions for SRRTS DataGate User Guide, Version 2.12
3. The General tab shown in Figure 34 click the Delete Files button in the Temporary
Internet Files section.
Figure 34. Java Control Panel: General Tab
4. Make sure that all the checkboxes are checked as shown in Figure 35 and click OK.
Figure 35. Java Control Panel: Delete Temporary Files
Page 29 of 29