Installing the scorecard

Last updated: 2014 December 09

IMPORTANT NOTICE: The MQM Scorecard is currently under development. Not all functionality works as expected and the user management components are currently not functional. This software should be installed only by experienced developers and should not be used for any production task.

The installation process for the MQM scorecard is as described below.

Downloading the source

The Scorecard source files can be downloaded from http://www.qt21.eu/downloads/scorecard-2014-12-09.zip.

License

The Scorecard source code generated by the QTLaunchPad project is made available under the terms of the Eclipse Public License. The third-party modules listed below remain under their respective license terms.

System requirements

Server

The MQM Scorecard has the following system requirements for the server:

  • PHP 5.5 or higher
  • MySQL 5.5 or higher
  • Apache 2.x (the Scorecard should work under other server environments but has been tested only using Apache)
  • At last 20 MB of free disk space (Note: The Scorecard and associated files currently occupy ~3.5 MB, but the development version does verbose logging of data that quickly takes up disk space, so more space is highly recommended.)

For local deployment, the scorecard has been tested in XAMPP 1.8.2-6.

Browser

The MQM scorecard has been tested with current builds of Webkit (e.g., Safari), Chrome, and Mozilla (Firefox) as of November 2014. There are known rendering problems with Internet Explorer and use of Internet Explorer is not recommended.

The browser must support Javascript.

Dependencies

The Scorecard utilizes the following open-source libraries:

Appropriate versions of these are included in the Scorecard source code download.

Installation

To install the Scorecard, carry out the following steps.

  1. Create an empty MySQL database with an appropriate name (e.g., “scorecard”) and note this name. This database must have an associated user with the right to read and write data and change structure. In general this database should run on the same machine as the scorecard. If it does not, additional configuration will be needed that is beyond the scope of these instructions.
  2. Create a directory within the directory structure of the htdocs folder (the web-accessible folder of the server).
  3. Unzip the files contained in the install download ihe folder created in the previous step. Ensure that the parent directory and all files are publicly readable and executable (755)
  4. Locate the file scorecard_dev.sql and run the MySQL statements in it to configure the database set up in step 1.
  5. Open the file modules/database.php and configure it to match the database created in step 1:
  • In line 9 provide the name of the database.
  • In line 10, leave the value “localhost” unless you are using an externally located database (not recommended)
  • In line 11, provide the name of the user that has access to the database
  • In line 12, provide the password for this user.
  • After installing these files the scorecard can be accessed in the browser at http://<path to installation directory>/editor.php.
  • Because user management is currently under development, individual scorecards are accessed by adding the GET variable “id” to the end of the URL, e.g., http://<path to installation directory>/editor.php?id=20123
  • Troubleshooting

    The most common problems in installing and running the Scorecard have to do with permissions of the files (if files are not readable and executable, the scorecard will not load properly) or with improper database configuration. If the Scorecard will not run, both of these items should be checked. Additional problems could have to do with misconfiguration of the server or the MySQL database. Fixing these problems is beyond the scope of these instructions.