This document sets forth the requirements and configuration suggestions for using MySQL with ScrumWorks Pro. The Hypersonic database is recommended ease of set up and administration. MySQL is recommended when user load and/or data becomes large enough to degrade Hypersonic performance. Note, MySQL set up and administration requires systems administration skills.
Quick Links
MySQL Requirements and Configuration Documentation Home

MySQL Requirements and Configuration

MySQL Support
Your ScrumWorks Pro license or support contract does not include technical support related to MySQL installation, configuration, or troubleshooting of any kind. Please refer to the MySQL web site for documentation and support related to MySQL.

» top

MySQL Requirements
MySQL components are not bundled with ScrumWorks Pro, and all MySQL components must be downloaded from the MySQL web site directly for licensing reasons. Using MySQL with ScrumWorks Pro requires:
  • ScrumWorks Pro release 3+
  • MySQL 5.0.x or 5.1.x Community Edition or Enterprise Edition

  • MySQL Connector/J version 5.1

    MySQL Connector/J version 5.1 is required for the ScrumWorks Pro Server to communicate with the MySQL server. Specifically, minor update 5.1.7 or higher is required. The ScrumWorks MySQL installer or transfer tool will prompt you to manually download this component. You can get the latest version from the MySQL Connector/J web site.

  • Empty MySQL database

    ScrumWorks Pro needs an empty database created in your MySQL installation configured to use the UTF-8 character set. A MySQL user must also be supplied with permissions to drop and create tables inside that database. Note that general MySQL security practices recommend creating users with special permissions rather than using the "root" user directly.

» top

Enabling InnoDB Storage Engine
The InnoDB storage engine is required due to the way ScrumWorks Pro handles transactions. Failure to use InnoDB tables will result in an unstable system and upgrade issues. To enable InnoDB on a MySQL server:
  1. Locate the MySQL configuration file. On Unix systems this is typically called "my.cnf", while on Windows "my.ini"
  2. Edit the configuration file and remove or comment-out the line "skip-innodb", if it exists in the file.
  3. Uncomment or add a line "innodb"
  4. InnoDB related configuration options can be uncommented or added; please read MySQL's documentation on InnoDB related configuration options (external link).
  5. Restart the MySQL server.

» top

Configuring Connection Pool Sizes

ScrumWorks Pro 3.0 (MySQL) shipped with a maximum connection pool size of 20. ScrumWorks Pro 3.1+ (MySQL) ships with a maximum connection pool size of 50. This is often sufficient for moderate use, but organizations experiencing connection pool issues will need to increase this value. Users will see an error "No ManagedConnections available" when the connection pool is insufficient.

Contact your MySQL administrator to find out what you can safely change this parameter to. You can increase the connection pool size:

  1. Shut down your ScrumWorks Pro server
  2. Edit the file INSTALL_DIR/server/scrumworks/deploy/scrumworks-mysql-ds.xml
  3. Find the option <max-pool-size>20</max-pool-size>
  4. Change "20" to the value supplied by your MySQL database administrator
  5. Save your changes
  6. Restart your ScrumWorks Pro server

» top

Documentation Home | Web Client User Guide | Support and Training | ScrumWorks Desktop Client
Copyright © 2011 CollabNet, Inc. All rights reserved.