Java WebStart Software

The following PsyGrid software applications are distributed by a technology known as Java WebStart (which allows Java applications to be distributed over the internet):

The installation and uninstallation procedure for these applications is essentially the same and will be detailed below.

Preparation and Prerequisites

Configuring your computer

openCDMS software is able to run on any computer such as a desktop or a laptop. It has been tested on Windows XP, Mac OS X and Fedora Linux operating systems. Since it is a pure Java application it should work correctly on all operating systems.

Your computer must have a web browser such as Internet Explorer or Firefox installed. You will almost certainly have a web browser already installed on your computer, but if not contact your local IT support.

You computer must have the Java Runtime Environment (JRE) 5.0 or greater installed. To see if you have Java installed open a command prompt (on Windows go to the Start menu, then the Accessories sub-menu and select Command Prompt) and type

java -version

If you have Java installed you will see something like this:

java version "1.5.0_13"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_13-b05)
Java HotSpot(TM) Client VM (build 1.5.0_13-b05, mixed mode, sharing)

So long as the first line has the version as 1.5.x or 1.6.x then your JRE version is fine and no further action is required. If it is 1.4.x then you need to upgrade your JRE; please contact your local IT support.

If instead you see something like this then Java is not installed on your computer, and you need to contact your local IT support to resolve this before you may start using openCDMS software.

'java' is not recognized as an internal or external command, operable program or batch file.

Installing the openCDMS CA root certificate

Optional but recommended.

The openCDMS CA root certificate enables you computer to establish a secure trust relationship with the central openCDMS computers. You must download the appropriate certificate for the system you are using (see below) and save it to disk.

Table 2.1. URLS for root certificates

NHS systemhttps://developers.psygrid.org/twiki/pub/PsyGridDev/SystemSecurity/PsyGridCA.cer
Public internet system???
Test system???

Double click on this file when it has downloaded. You will see the following window open:

Figure 2.1. Certificate dialog

Certificate dialog

Click on the "Install Certificate Button", and you will see the following window:

Figure 2.2. Certificate Import Wizard dialog (1)

Certificate Import Wizard dialog (1)

Click on "Next" and the following window will appear:

Figure 2.3. Certificate Import Wizard dialog (2)

Certificate Import Wizard dialog (2)

Again, click on "Next", and you will see this window:

Figure 2.4. Certificate Import Wizard dialog (3)

Certificate Import Wizard dialog (3)

Now click on "Finish". You will see the following. Verify that the Thumbprint is as shown here. If in doubt contact openCDMS Support. When you are ready to proceed click on "Yes".

Figure 2.5. Security Warning dialog

Security Warning dialog

Then you will see the following confirmation:

Figure 2.6. Certificate Import Wizard success dialog

Certificate Import Wizard success dialog

Installation

Downloading and Installing openCDMS software

Open Internet Explorer (or any other web browser). Enter the URL for the openCDMS software that you wish to install (see below) in the address bar and press enter. A page will load which will be completely blank except for a link in the top left corner which will be something like "Launch Application". Click on the link.


If you are unable to open the URL then this means that you are unable to connect to the openCDMS servers. This is only likely to happen if you are trying to access the NHS system but don't have an NHS network connection. In this case you must find a computer connected to the NHS network, so contact your local IT support. If you are trying to access one of the systems hosted on the public internet then there may be a problem with your computer's network configuration; again you need to contact your local IT support.

If you have not installed the openCDMS CA root certificate, a dialog box will pop-up warning you that the remote site’s identity cannot be trusted. Click on "Yes". The software will then download onto your computer and you will see a "Java Loading" splash screen (the exact appearance of which depends on your JRE version).

Figure 2.7. Security Alert dialog

Security Alert dialog

Figure 2.8. Java Loading

Java Loading

If you get an error at this point you may need to configure the proxy settings for Java WebStart - see the section called “Configuring Java WebStart's proxy settings”

You should see a progress bar which updates as the software is downloaded to your computer. When it has finished you will be asked if you would like to create Desktop Shortcuts - a clickable icon on your desktop that will allow you to launch the software without using a web browser. We recommend you click "Yes" to create the desktop shortcut; if you click "No" you will have to always start the software by entering the URL in your web browser.

Figure 2.9. Create shortcuts dialog

Create shortcuts dialog

The application will then launch and present you with the login screen.

Logging in

Use your openCDMS username and password (see the section called “Obtaining a openCDMS user name and password”) to log in. If you are unable to login (and you are certain you are entering the correct username and password!) then it is likely that some additional configuration is required, see the section called “Configuring proxy settings for openCDMS applications”.

Figure 2.10. Login dialog

Login dialog

Finding your proxy server settings

The next two sections are all to do with configuring your proxy-server settings, but before we can do that we need to find out what they are!

What is a proxy server? Basically it is a computer that acts as an intermediary between your computer and the wider network; and if it is not configured properly you will not be able to access other networked computers (such as the openCDMS servers).

To find out your proxy settings you have two options:

  • Ask your IT support team or a colleague.

  • Try to find them out yourself, which will be described below.

Open Internet Explorer and click on the "Tools" menu. Select "Internet Options...". In the "Internet Options" window select the "Connections" tab, then click on the "LAN Settings" button

Figure 2.11. LAN Settings Dialog

LAN Settings Dialog

If you use a proxy server, then either the "Use automatic configuration script" or "Use a proxy server for your LAN…" boxes will be ticked . If none of the boxes in the LAN Settings dialog is ticked then you don’t use a proxy server.

If "Use a proxy server for your LAN…" is ticked simply note down the Address and Port specified in the dialog

If "Use automatic configuration script" is ticked it is slightly more complicated so might be worth contacting your local IT support for assistance. But the procedure for finding the Address of your proxy server is as follows:

  • Copy and paste the URL of the proxy configuration script into the Address bar of Internet Explorer. Choose to save the file.

  • Open the file in Notepad or Wordpad, scroll through it and look for a line like this (where each X below represents a number from 0 to 999):

    else
        return “PROXY X.X.X.X”;
  • Note down the X.X.X.X - this is the proxy Address. The Port will be 80.

Configuring proxy settings for openCDMS applications

Depending upon your location you may need to configure openCDMS applications to use a proxy server so that they may communicate with the openCDMS servers. When you login for the first time the software shoudl tell you if you need to configure a proxy server, in which case you need to follow the steps int he rest of this section.

First, you need to find out what your proxy server settings are, which is detailed in the section called “Finding your proxy server settings”. Once you know what your proxy settings are, continue as below. Alternatively, if you have a colleague who is already using openCDMS successfuly you may use their proxy settings by exporting the settings from their computer then importing them into yours; see the section called “Importing and Exporting Proxy Settings” for more details.

On the login screen, press the "Settings…" button, the Application Settings dialog will be displayed.

Figure 2.12. Application Settings dialog

Application Settings dialog

Click the Edit button adjacent to "Proxy server settings" - the "Change Proxy Settings" dialog will be shown.

Figure 2.13. Change Proxy Settings dialog

Change Proxy Settings dialog

When you open the Proxy Settings dialog for the first time the only setting is "<Direct connection>" (i.e. no proxy server used) and this is shown as being used by the green tick next to it. To add your proxy server follow these steps:

  • Click the Add button - the Proxy Setting dialog is displayed.

    Figure 2.14. Proxy Setting Dialog

    Proxy Setting Dialog

  • Enter a Name for the proxy setting; it doesn't matter what this is but if you have more than one proxy setting defined they must have unique names.

  • Enter the Proxy Server Address and the Proxy Server Port Number that you noted down earlier. Leave Proxy Authentication Method as NONE.

  • Press the "Test" button. This will use the entered proxy settings to attempt to connect to the openCDMS servers. A message will be displayed telling you if this was successful or not. If the test is successful tick the Default checkbox (so that this proxy setting is used) then click the OK button to save the settings.

  • If the test was unsuccessful check the Address and Port you have entered to make sure they are correct. If they are, you may need to use proxy authentication.

  • Select the Proxy Authentication Method to be WINDOWS.

  • Enter your Windows Domain. If you don’t know what your Windows Domain is there are several ways to find out:

    • Ask your local IT support.

    • Press Ctrl-Alt-Delete. A dialog called "Windows Security" will open. In the "Login Information" section it will say "<Your Name> is logged on as <Domain>\<Username>". Note down what the Domain is then press Cancel.

    • Open the Windows Control Panel, and select "User Accounts" (see below).

      Figure 2.15. Control Panel

      Control Panel

      You will see the domain listed next to your user name…

      Figure 2.16. User Accounts

      User Accounts

  • Press the Test button again. You will be presented with a dialog called Enter Proxy Credentials. In here you need to enter the username and password that you use to login to your computer, not your openCDMS username and password.

    Figure 2.17. Enter Proxy Credentials

    Enter Proxy Credentials

  • If the test is successful tick the Default checkbox and click OK. Note that when you try to login to openCDMS the Enter Proxy Credentials dialog will be shown after you enter your openCDMS username and password and click Login. Again, you must enter your Windows username and password here.

  • If the test is unsuccessful please contact your local IT support or openCDMS Support for further assistance.

Assuming that the test was successful, you should now see your proxy configuration in the Change Proxy Settings dialog, and it should have the green tick against it, signifying that it is the default setting - if it is not ticked select it in the list, click Edit then tick the Default checkbox in the Proxy Setting dialog before clicking OK.

When you are happy with your settings click OK to save your settings and apply them. Clicking Cancel will abandon all changes made to the proxy settings.

Importing and Exporting Proxy Settings

Importing and exporting proxy settings allows a working proxy configuration to be used by multiple users, simplifying configuration. First, export the settings by clicking the Export button; you will be asked to specify a file to save the settings to. The exported settings can then be distributed to new users (by attaching to an email, putting them on a memory stick etc). To import the settings click the Import button and select the file containing the relevant settings. Any existing settings will be overwritten and the imported settings will be displayed in the Change Proxy Settings dialog. Click OK to save and apply the improted settings.

Configuring Java WebStart's proxy settings

Occasionally you may need to configure the proxy settings of Java WebStart in order to be able to download and install the openCDMS software. You will need to do this if you get an error after clicking on the link for the openCDMS software in your web browser. You will then see the Java splash screen :

Figure 2.18. Java Spash Screen

Java Spash Screen

Then you will get an error message:

Figure 2.19. Webstart Error Message

Webstart Error Message

So, if you see this error, perform the following steps.

First, find out your proxy settings (see the section called “Finding your proxy server settings”).

Once you have your proxy settings click the Windows "Start" menu and select "Run..."

Figure 2.20. Windows Start menu

Windows Start menu

Type "javaws -viewer" (without the quotes) into the Run dialog and click OK.

Figure 2.21. Run dialog

Run dialog

The "Java Cache Viewer" will be launched. Just click "Close", and the “Java Control Panel” should now be the active window.

Figure 2.22. Java Control Panel

Java Control Panel

Click the "Network Settings..." button. The "Network Settings" dialog will be opened, which is very similar to the dialog from Internet Explorer that we saw in earlier.

Figure 2.23. Java WebStart Network Settings

Java WebStart Network Settings

  • If in Step 1 "Use automatic configuration script" was ticked, select "Use automatic proxy configuration script" and enter the Address noted earlier into "Script location"

  • If in Step 1 "Use a proxy server..." was ticked, select "Use proxy server" and enter the Address and Port into the relevant boxes.

Click "OK" to close the "Network Settings" dialog, then click "Apply" in the "Java Control Panel". Now try to download/install the openCDMS software again. Hopefully it will now work.

What if it still doesn't work?

When I was doing this myself I had problems when using the “Automatic proxy configuration script” option for the Java WebStart proxy. If your Internet Explorer settings are for a Proxy Configuration Script, and using this for the Java WebStart proxy still does not fix the problem try the following:

  • Copy and paste the URL of the proxy configuration script into the Address bar of Internet Explorer. Choose to save the file. Then open the file in Notepad or Wordpad, scroll through it and look for a line like this (where each X below represents a number from 0 to 999):

    else
        return “PROXY X.X.X.X”;
  • Now go through Section 2 above again, but in the "Network Settings" dialog select "Use proxy server" and enter the X.X.X.X numbers here. Enter 80 for "Port".

  • Click OK, then Apply, then try to download/install the openCDMS software again.

Who can I contact to get further help?

We suggest that you contact your local IT support team in the first instance. This document will hopefully give them all the information that they require to configure the Proxy for Java WebStart.

Failing that, or if your IT support need more info, contact openCDMS Support.

Troubleshooting Installation

Java not installed or enabled in your web browser

If you see the following dialog box in Internet Explorer after entering the URL of the openCDMS software that you are trying to install.

Figure 2.24. Java not installed dialog

Java not installed dialog

This means that either Java is not installed on enabled on your browser. Please contact PsyGrid Support.

Wrong Java version installed

If you see the following message during installation, click on details

Figure 2.25. Wrong java version installed (1)

Wrong java version installed (1)

This usually means you have the wrong version of Java installed. Please contact either openCDMS Support or your local NHS IT support. You need the Java Virtual Machine version of 1.5 (5.0) or higher. See the section called “Configuring your computer” for details of how to check if you have Java installed

Figure 2.26. Wrong java version installed (2)

Wrong java version installed (2)

Using different computers and/or logins

If you intend to work from more than one computer then the openCDMS software will have to be installed on all computers that you use.

Also, note that the openCDMS software applications store data on your computer's hard-drive between sessions. This is particularly pertinent for openCDMS Collect where data that has been entered but not committed to the central database is stored (encrypted) on your hard-drive. Therefore if you do some work using one computer, log off, then move to a different computer and logon there, any data stored on the hard-drive of the first computer will not be available to you.

Furthermore, the location on your computer's hard-drive where data is stored between sessions is dependent on the username that you use to login to the computer. If you use different computer logins then data from sessions where another login was used will not be available to you. This is particularly important to note when you share your computer with other users, who may have left the machine logged in with another username. If in doubt, log out then log back in again using your own username.

We recommend that, if at all possible, you always use openCDMS software using the same computer, and you always login to that computer with the same username. This will minimize the chances of any data going 'missing'. If this is not possible then please contact openCDMS Support for advice pertinent to your exact situation.

Uninstallation

You may want to remove the openCDMS software from your computer if you are no longer using it, or if you want to make sure that you have the latest version installed (the software should update automatically when a new version is deployed but occasionally this does not happen).

  • Select "Run..." from the Windows Start menu.

  • Type "javaws -viewer" (without the quotes) into the Run dialog and click OK.

    Figure 2.27. Run dialog

    Run dialog

  • The Java Cache Viewer will be displayed. In the "Show:" drop-down list select "Applications" to make sure that only applications are displayed in the list.

    Figure 2.28. Java Cache Viewer

    Java Cache Viewer

  • Locate the application that you wish to uninstall, right click on it and select Delete.

  • If you wish to now re-install the software just follow the steps in the section called “Downloading and Installing openCDMS software” in the same way as when the software was installed originally

Note that uninstalling an application in this way does not remove from your computers hard-drive any files that the application uses to store data between sessions. This is an advanced topic and if you require to do this please contact openCDMS Support for assistance.

Re-installation

It has been reported by some users that openCDMS applications sometimes go "missing" i.e. double-clicking on a desktop icon gives an error. To re-install the application follow these steps:

  • Follow the steps detailed in the section called “Uninstallation” up until viewing the list of applications in the Java Cache Viewer.

  • The application you were trying to start will not appear in this list. Close the Java Cache Viewer.

  • You should now see a window Java Control Panel. In the General tab, Temporary Internet Files section click Settings...

  • The click Delete Files... Leave both checkboxes checked and click OK.

  • You should now be able to re-install the openCDMS application by entering the relevant URL in your web browser.