Onyx Installation Guide

Skip to end of metadata
Go to start of metadata

Contents of this Guide


Introduction

Onyx is a web application that runs on a server. Users access it on client workstations via a browser over a local network.

This guide is for whoever will set up Onyx in an assessment centre--typically, a system administrator. 

The guide covers hardware and software requirements and includes procedures for deploying Onyx on a server and setting up the client workstations.

What You Need from Your Organization

Your organization should provide you with the following:

  • A war file (custom-onyx.war) that contains a version of Onyx customized to your organization's requirements
  • An appointment list (may be an Excel or XML file)
The war file is actually a zip file. You will need some information from two files in the war file before they are extracted during installation.Your organization may provide you with copies of the files. Or you can extract copies of the two files from the war file:
  • onyx-config.properties
  • export-destinations.xml

Hardware Requirements

Server Hardware Requirements
Component
Requirement
CPU
Recent server-grade or high-end consumer-grade processor
Memory (RAM)
Minimum: 2 GB
Disk space
Minimum: 160 GB
Rule of thumb calculation:  10 GB for operating system + ((8 GB/2000 participants) * (expected number of participants))
Workstation Hardware Requirements
Component
Requirement
CPU
Mid to high-end consumer-grade processor
Memory (RAM)
Minimum: 1 GB
Disk space
Enough to satisfy the requirements of any proprietary software that comes with instruments that will be connected to and launched by Onyx.
Onyx does not have any storage requirements for client workstations.
USB ports
Minimum: 2 (if barcode scanner and electronic signature pad will be used); as many as possible
Number of additional ports required depends on the number of instruments that will be connected to the workstation. 
COM ports
Depends on number of instruments that will be connected
Display
Minimum resolution: 1024 x 768
If using touchscreens: touchscreen monitors should have a sturdy base so they are stable during use.

Software Requirements

Server Software Requirements

You must install the following software on the Onyx server.

Software Suggested Version Download Link Use Installation/Configuration
Firefox
Latest
http://www.mozilla-europe.org/en/firefox Browser- useful for checking Onyx
JRE JRE 1.6.x http://www.java.com/en/download/manual.jsp
or
http://java.sun.com/javase/downloads/index.jsp
Java runtime environment - needed  to run Tomcat and Onyx http://java.sun.com/javase/6/webnotes/install/index.html
Tomcat 6.0.x http://tomcat.apache.org/download-60.cgi Servlet container - needed to run Onyx Fine-tuning Tomcat
MySQL 5.0.x http://www.mysql.com/downloads/mysql/ Database management system - stores data collected using Onyx
Configuring MySQL
Custom war file for Onyx
(custom-onyx.war)

Get it from whoever customized Onyx for your organization
Contains all Onyx files
Deploying Onyx
JCE
(if required by your organization)
Latest
http://java.sun.com/javase/downloads/index.jsp Java Cryptography Extension.
In most cases, Onyx's default handling of encryption should be sufficient.
Only install JCE if your organization has specified that it should be installed.
Copy the jar files from the downloaded jce zip file to this directory:
JAVA_HOME\Java\jre6\lib\security

which is usually:
C:\Program Files\Java\jre6\lib\security
Workstation Software Requirements

You must install the following software on each Onyx workstation.

Software Suggested Version Download Link Use Installation/Configuration
Prism 1.0b3 or later http://labs.mozilla.com/projects/prism Stripped-down Firefox browser (no menus or toolbars). Makes Onyx look like a standalone application Prism
Firefox
Latest http://www.mozilla-europe.org/en/firefox
Needed to import an SSL certificate.
 
Acrobat Reader
Latest
http://get.adobe.com/uk/reader/
Browser plug-in - needed to display electronic consent forms and participant reports (PDF files).
 
Search Onyx Documentation
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.