Sample configuration files

IBM MobileFirst™ Platform Foundation includes a number of sample configuration files to help you get started with the Ant tasks to install the MobileFirst Server administration and the MobileFirst runtime environment.

The easiest way to get started with the <configuredatabase>, <installworklightadmin> and <configureapplicationserver> Ant tasks is by working with the sample configuration files provided in the WorklightServer/configuration-samples/ directory of the MobileFirst Server distribution.

Step 1

Pick the appropriate sample configuration file. The following files are provided

Table 1. Sample configuration files provided with IBM MobileFirst Platform Foundation
Task	Derby	DB2®	MySQL	Oracle	Cloudant®
Create databases with database administrator credentials	create-database-derby.xml	create-database-db2.xml	create-database-mysql.xml	create-database-oracle.xml	Not relevant for this database
Install MobileFirst Server administration and MobileFirst runtime environment on Liberty	configure-liberty-derby.xml	configure-liberty-db2.xml	configure-liberty-mysql.xml (See Note on MySQL)	configure-liberty-oracle.xml	configure-liberty-cloudant.xml
Install MobileFirst Server administration and MobileFirst runtime environment on WebSphere® Application Server full profile, single server	configure-was-derby.xml	configure-was-db2.xml	configure-was-mysql.xml (See Note on MySQL)	configure-was-oracle.xml	configure-was-cloudant.xml
Install MobileFirst Server administration and MobileFirst runtime environment on WebSphere Application Server Network Deployment (See Note on configuration files)	configure-wasnd-cluster-derby.xml configure-wasnd-server-derby.xml configure-wasnd-node-derby.xml configure-wasnd-cell-derby.xml	configure-wasnd-cluster-db2.xml configure-wasnd-server-db2.xml configure-wasnd-node-db2.xml configure-wasnd-cell-db2.xml	configure-wasnd-cluster-mysql.xml (See Note on MySQL) configure-wasnd-server-mysql.xml (See Note on MySQL) configure-wasnd-node-mysql.xml (See Note on MySQL) configure-wasnd-cell-mysql.xml	configure-wasnd-cluster-oracle.xml configure-wasnd-server-oracle.xml configure-wasnd-node-oracle.xml configure-wasnd-cell-oracle.xml	configure-wasnd-cluster-cloudant.xml configure-wasnd-server-cloudant.xml configure-wasnd-node-cloudant.xml configure-wasnd-cell-cloudant.xml
Install MobileFirst Server administration and MobileFirst runtime environment on Apache Tomcat	configure-tomcat-derby.xml	configure-tomcat-db2.xml	configure-tomcat-mysql.xml	configure-tomcat-oracle.xml	configure-tomcat-cloudant.xml
Install or upgrade IBM® Worklight V5.0.6 on Liberty	redeploy506-liberty-derby.xml	redeploy506-liberty-db2.xml	redeploy506-liberty-mysql.xml (See Note on MySQL)	redeploy506-liberty-oracle.xml	None
Install or upgrade IBM Worklight V5.0.6 on WebSphere Application Server full profile, single server	redeploy506-was-derby.xml	redeploy506-was-db2.xml	redeploy506-was-mysql.xml (See Note on MySQL)	redeploy506-was-oracle.xml	None
Install or upgrade IBM Worklight V5.0.6 on WebSphere Application Server Network Deployment (See Note on configuration files)	redeploy506-wasnd-cluster-derby.xml redeploy506-wasnd-server-derby.xml redeploy506-wasnd-node-derby.xml redeploy506-wasnd-cell-derby.xml	redeploy506-wasnd-cluster-db2.xml redeploy506-wasnd-server-db2.xml redeploy506-wasnd-node-db2.xml redeploy506-wasnd-cell-db2.xml	redeploy506-wasnd-cluster-mysql.xml (See Note on MySQL) redeploy506-wasnd-server-mysql.xml (See Note on MySQL) redeploy506-wasnd-node-mysql.xml (See Note on MySQL) redeploy506-wasnd-cell-mysql.xml	redeploy506-wasnd-cluster-oracle.xml redeploy506-wasnd-server-oracle.xml redeploy506-wasnd-node-oracle.xml redeploy506-wasnd-cell-oracle.xml	None
Install or upgrade IBM Worklight V5.0.6 on Apache Tomcat	redeploy506-tomcat-derby.xml	redeploy506-tomcat-db2.xml	redeploy506-tomcat-mysql.xml	redeploy506-tomcat-oracle.xml	None

Note on MySQL: : MySQL in combination with WebSphere Application Server Liberty profile or WebSphere Application Server full profile is not classified as a supported configuration. For more information, see WebSphere Application Server Support Statement. Consider using IBM DB2 or another database that is supported by WebSphere Application Server to benefit from a configuration that is fully supported by IBM Support.

Note on configuration files for WebSphere Application Server Network Deployment: The configuration files for wasnd contain a scope that can be set to cluster, node, server, or cell. For example, for configure-wasnd-cluster-derby.xml, the scope is cluster. These scope types define the deployment target as follows:

cluster: To deploy to a cluster.
server: To deploy to a single server that is managed by the deployment manager.
node: To deploy to all the servers that are running on a node, but that do not belong to a cluster.
cell: To deploy to all the servers on a cell.

Step 2

Change the file access rights of the sample file to be as restrictive as possible. Step 3 requires that you supply some passwords. If you must prevent other users on the same computer from learning these passwords, you must remove the read permissions of the file for users other than yourself. You can use a command, such as the following examples:

On UNIX:
chmod 600 configure-file.xml
On Windows:
cacls configure-file.xml /P Administrators:F %USERDOMAIN%\%USERNAME%:F

Step 3

Similarly, if the server is a WebSphere Application Server Liberty profile or Apache Tomcat server, and the server is meant to be started only from your user account, you must also remove the read permissions for users other than yourself from the following file:

For WebSphere Application Server Liberty profile: wlp/usr/servers/<server>/server.xml
For Apache Tomcat: conf/server.xml

Step 4

Replace the placeholder values for the properties at the beginning of the file.

Note: The following special characters need to be escaped when used in values in Ant XML scripts:

The dollar sign ($) must be written as $$, unless you explicitly want to reference an Ant variable through the syntax ${variable}, as described in Properties in the Apache Ant Manual.
The ampersand character (&) must be written as &, unless you explicitly want to reference an XML entity.
Double quotation marks (") must be written as ", except when inside a string that is enclosed in single quotation marks.

Step 5

In the <configureapplicationserver> and <unconfigureapplicationserver> invocations (in target install and uninstall), define MobileFirst properties. For a list of properties that can be set, see Configuration of MobileFirst applications on the server. In production, you must often define the following specific properties:

publicWorkLightHostname
publicWorkLightProtocol
publicWorkLightPort

Step 6

Note: You must run the following commands only if you are using a relational database. If you are using Cloudant, you must not run them.

Run the commands:

ant -f configure-file.xml admdatabases
ant -f configure-file.xml databases

These commands ensure that the designated databases exist and contain the required tables for IBM MobileFirst Platform Foundation. The target admdatabases must be run before the target databases. This is especially important in the case of an upgrade where management data is migrated from the runtime database to the administration database, which must be initialized first by the target admdatabases.

For an initial installation, and if a DBA did not create the databases manually, use the file in row "Create databases with database administrator credentials" of Table 1. These files add special parameters to the configuredatabase Ant task (the DBA credentials). The parameters enable the Ant task to create a database and a user if required.

Step 7

Run the command:

ant -f configure-file.xml adminstall

This command installs your Administration Services and MobileFirst Operations Console components onto the application server.

To install updated Administration Services and MobileFirst Operations Console components (for example, to apply a MobileFirst Server fix pack), run the command:

ant -f configure-file.xml minimal-admupdate

To reverse the installation step, run the command:

ant -f configure-file.xml admuninstall

This command uninstalls the Administration Services and MobileFirst Operations Console components.

Step 8

Run the command:

ant -f configure-file.xml install

This command installs your MobileFirst runtime environment as a .war file onto the application server.

To install an updated MobileFirst runtime environment onto the application server, run the command:

ant -f configure-file.xml minimal-update

To reverse the installation step, run the command:

ant -f configure-file.xml uninstall

This command uninstalls the MobileFirst runtime environment.

At least for WebSphere Application Server, it is a good idea to keep the modified configure-file.xml for later use when you install updates of the MobileFirst project's .war file. This file makes it possible to redeploy an updated .war file with the same MobileFirst properties. If you use the WebSphere Application Server administrative console to update the .war file, all properties that are configured for this web application are lost.