Configuring MMC for External Databases - Quick Reference
| Mule Management Console (MMC) was deprecated in December 2015. Its End of Life is July 15, 2019. For more information see the MMC Migrator Tool or contact your Customer Success Manager to determine how you can migrate to Anypoint Runtime Manager. |
Enterprise Edition
MMC Versions 3.4.2 and Later
Overview
In MMC version 3.4.2 and above, configuring MMC to store data on an external databases has been greatly simplified.
The process involves two basic sets of tasks.
On the database server:
-
Create the database and schema
-
Define database user name, permissions and password
On MMC:
-
Modify the configuration file
web.xmlto tell MMC to use your desired database instead of MMC’s default database -
Modify a configuration file for your selected external database to set the parameters for connecting to the database
To learn how to configure each database server for MMC, refer to the relevant pages for the supported servers:
To learn how to configure MMC for each of the supported database servers, see the section below.
| Some distributions of MMC may include empty config files for other database engines, but these are not supported. Only the database servers listed above are supported for external data persistence. |
Configuring MMC
Before modifying MMC configuration files, ensure that MMC is not running.
Downloading Drivers for the External Database
To persist data on an external database, you will need to download and install the database driver for your selected database server. The documentation pages for each database engine (linked above) contain full details about driver installation, including download links from the database server vendors.
Defining the External Database for Environment or Tracking Data
Configuration file: <MMC_HOME>/WEB-INF/web.xml
This file contains a section called spring.profiles.active, shown below.
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>tracking-h2,env-derby</param-value>
</context-param>As you can see in the code above, the default databases that MMC uses internally are H2 for tracking data and Derby for storing environment data. To store tracking or environment data on external databases, you must modify the spring.profiles.active section according to the listings below.
Values for Tracking Data (Business Events)
-
tracking-h2(default) -
tracking-mysql -
tracking-oracle -
tracking-mssql -
tracking-postgres
Values for Environment Data
-
env-derby(default) -
env-mysql -
env-oracle -
env-msssql -
env-postgres
For example, if you are storing tracking information on a Postgres database, and environment information on an Oracle database, the section would like this.
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>tracking-postgres,env-oracle</param-value>
</context-param>Defining Parameters for the Database Connection
Configuration files in <MMC_HOME>/WEB-INF/classes/META-INF/databases
The directory named in the heading above contains configuration files whose names are in the format: <type of data>-<database name>.properties, where:
| string | description | example |
|---|---|---|
|
|
|
|
name of the database server to use |
|
For example, the file mmc-oracle.properties stores properties for connecting to an Oracle database that stores environment data; the file tracking-persistence-postgres.properties stores properties for connecting to a Postgres database that stores tracking data, etc.
These files define the parameters for connecting to the databases, including: driver, user, password, host, port, and others.
Complete list of files
mmc-derby.properties
mmc-mssql.properties
mmc-mysql.properties
mmc-oracle.properties
mmc-postgres.properties
tracking-persistence-h2.properties
tracking-persistence-mssql.properties
tracking-persistence-mysql.properties
tracking-persistence-oracle.properties
tracking-persistence-postgres.propertiesEach file contains the parameters listed in the table below, plus other possible additional parameters depending on each database server.
In the table below, the column labeled Modify marks which parameters you need to modify according to your setup – for example, you must replace the value of env.username with your own database user.
Parameters for Environment Database Config Files
| Parameter | Description | Modify |
|---|---|---|
|
Driver to use for connecting to the database |
|
|
Script to use for creating the tables in the target database |
|
|
Database user |
X |
|
Password for the database user |
X |
|
Hostname or IP address where the database server is listening |
X |
|
Port where the database server is listening |
X |
|
URL for connecting to the database |
|
|
Name of the database |
X |
|
(Oracle.) Service name for connecting to the external database |
X |
Parameters for Tracking Database Config Files
| Parameter | Description |
|---|---|
|
SQL server of the external database |
|
Driver to use for connecting to the database |
|
Hostname or IP address where the database server is listening |
|
Port where the database server is listening |
|
URL for connecting to the database |
|
Database user |
|
Password for the database user |
|
Name of the database |
|
The number of characters from a Business Events exception that will be stored in the tracking database. The default is 8000; the maximum allowed is 261120. |
All of these files include comments with helpful information, as you can see in the example below.
Complete Sample mmc-oracle.properties
env.driver=oracle.jdbc.driver.OracleDriver
env.script=oracle
env.username=mmc_status
#If you want to encrypt your password, set the value to ENC("encodedPassword").
#For encoding your password open a console and cd into the MMC install directory, cd encrypt folder
#and issue the command ./encrypt.sh input="mmc123" password=DEFAULTPASS
#where password refers to the encryption key to use and input is the value you want to encrypt.
#DEFAULTPASS is the default value set by MMC, refer to MMC docs at www.mulesoft.com for information on how
#to change that configuration value.
#env.password=ENC("HZe9CewttfG/PlAJSL8+KA==")
env.password=mmc123
env.host=localhost
env.port=1521
env.url=jdbc:oracle:thin:${env.username}/${env.password}@${env.host}:${env.port}/${env.servicename}
env.servicename=XEXDBAfter modifying the configuration files as needed, MMC is configured to store data on the external database(s) you specified. Start MMC to check your new configuration.