MySQL Configuration for Enablement Features

MySQL is a relational database primarily used for SCORM tracking and reporting data for enablement resources.  Included are tables for other features such as tracking video pause/resume.

These instructions describe how to connect to the MySQL server, establish the enablement database, and populate the database with initial data.

Before configuring MySQL for Communities' enablement feature, be sure to

• install MySQL server Community Server version 5.6
  • version 5.7 is not supported for SCORM
  • may be same server as author AEM instance
• on all AEM instances, install the official JDBC driver for MySQL
• install MySQL workbench
• on all AEM instances, install the SCORM package

MySQL should be downloaded and installed following the instructions for the target OS.

As SQL is case insensitive, for case sensitive operating systems, it is necessary to include a setting to lower case all table names.

For example, to specify all lower case table names on a Linux OS :

• edit file /etc/my.cnf
• in the [mysqld] section, add the following line :
    lower_case_table_names = 1

To provide better multilingual support, it is necessary to use the UTF8 character set.

Change MySQL to have UTF8 as its character set :

• mysql> SET NAMES 'utf8';

Change the MySQL database to default to UTF8 :

• edit file /etc/my.cnf
• in the [client] section, add the following line:
    default-character-set=utf8
• in the [mysqld] section, add the following line:
    character-set-server=utf8

MySQL Workbench provides an UI for executing SQL scripts which install the schema and initial data. 

MySQL Workbench should be downloaded and installed following the instructions for the target OS.

When the MySQL Workbench is first launched, unless already in use for other purposes, it will not yet show any connections :

1. select the '+' icon to the right of MySQL Connections.
2. in the dialog Setup New Connection, enter values appropriate for your platform
   for demonstration purposes, with the author AEM instance and MySQL on the same server :
   • Connection Name: Enablement
   • Connection Method: Standard (TCP/IP)
   • Hostname: 127.0.0.1
   • Username: root
   • Password: no password by default
   • Default Schema: leave blank
3. select Test Connection to verify the connection to the running MySQL service

Notes :

• the default port is 3306
• the Connection Name chosen is entered as the datasource name in JDBC OSGi configuration

Upon opening the new Enablement connection, notice there is a test schema and default user accounts.

The SQL scripts are obtained using CRXDE Lite on the author instance.  The SCORM package must be already be installed :

1. browse to CRXDE Lite
   • for example, http://localhost:4502/crx/de
2. expand the /libs/social/config/scorm/ folder
3. download* database_scormengine.sql
4. download* database_scorm_integration.sql

* One method for downloading the schema is to

• select the jcr:content node for the sql file
• notice the value for the jcr:data property is a view link
• select the view link to save the data to a local file

The Enablement SCORM Database to be created is :

• name : ScormEngineDB
• created from scripts :
  • schema : database_scormengine.sql
  • data : database_scorm_integration.sql

Follow the steps below (open, execute) to install each SQL script .  Refresh when necessary to see the results of the script execution.

Be sure to install the schema before installing the data.

In the MySQL Workbench

• from the File pulldown menu
• select Open SQL Script ... 
• in this order, select one of  :
  1. database_scormengine.sql
  2. database_scorm_integration.sql

In the Workbench window for the file opened in Step 1, select the lightening (flash) icon to execute the script.

Note that the execution of the database_scormengine.sql script to create the SCORM database may take a minute to complete.

Once the scripts are executed, it is necessary to refresh the SCHEMAS section of the Navigator in order to see the new database. Use the refresh icon to the right of 'SCHEMAS' :

After installing and refreshing SCHEMAS, the scormenginedb will be visible.

The OSGi configuration for Day Commons JDBC Connections Pool configures the MySQL JDBC Driver.

All publish and author AEM instances should point to the same MySQL server.  

When MySQL runs on a server different from AEM, the server hostname must be specified in place of 'localhost' in the JDBC connector (which populates the ScormEngine config).

• on each author and publish AEM instance
• signed in with administrator privileges
• access the web console
  • for example, http://localhost:4502/system/console/configMgr
• locate the Day Commons JDBC Connections Pool
• select the '+' icon to create a new configuration

• enter the following values :
  • JDBC driver class : com.mysql.jdbc.Driver
  • JDBC connection URI : jdbc:mysql://localhost:3306/aem62reporting
    specify server in place of localhost if MySQL server is not the same as 'this' AEM server
    
  • Username : root
    or enter the configured Username for the MySQL server, if not 'root'
  • Password : 
    clear this field if no password set for MySQL,
    else enter the configured password for the MySQL Username
  • ...
  • Datasource name : name entered for the MySQL connection, for example, 'enablement'
• select Save

The OSGi configuration for AEM Communities ScormEngine Service configures SCORM for an enablement community's use of the MySQL server.

This configuration is present when the SCORM package is installed.

All publish and author instances point to the same MySQL server.  

When MySQL runs on a server different from AEM, the server hostname must be specified in place of 'localhost' in the ScormEngine Serivce, which is typically populated from the JDBC Connection config.

• on each author and publish AEM instance
• signed in with administrator privileges
• access the web console
  • for example, http://localhost:4502/system/console/configMgr
• locate the AEM Communities ScormEngine Service
• select the edit icon

• verify the following parameter values are consistent with the JDBC Connection config :
  • JDBC connection URI : jdbc:mysql://localhost:3306/ScormEngineDB
    ScormEngineDB is the default database name in the SQL scripts
  • Username : root
    or enter the configured Username for the MySQL server, if not 'root'
  • Password : 
    clear this field if no password set for MySQL,
    else enter the configured password for the MySQL Username
• regarding the following parameter :
  • Scorm User Password : DO NOT EDIT
    For internal use only.  It is for a special service user used by AEM Communities to communicate with the scorm engine.
    
• select Save

To ensure enablement courses work correctly in all browsers, it is necessary to add Mozilla as a User Agent that is not checked by the CSRF filter.

• on each publish AEM instance
• signed in with administrator privileges
• access the web console
  • for example, http://localhost:4503/system/console/configMgr
• locate Adobe Granite CSRF Filter
• select the edit icon

• select the [+] icon to add a Safe User Agent
• enter Mozilla/*
• select Save