For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Sample configuration files for MobileFirst Analytics

IBM MobileFirst™ Platform Foundation includes a number of sample configuration files to help you get started with the Ant tasks to install the MobileFirst Analytics Services, and the MobileFirst Analytics Console.

The easiest way to get started with the <installanalytics>, <updateanalytics>, and <uninstallanalytics> Ant tasks is by working with the sample configuration files provided in the Analytics/configuration-samples/ directory of the MobileFirst Server distribution.

Step 1

Pick the appropriate sample configuration file. The following XML files are provided. They are referred to as configure-file.xml in the next steps.

Table 1. Sample configuration files provided with IBM MobileFirst Platform Foundation

Task	Application server
Install MobileFirst Analytics Services and Console on WebSphere® Application Server Liberty profile	configure-liberty-analytics.xml
Install MobileFirst Analytics Services and Console on Apache Tomcat	configure-tomcat-analytics.xml
Install MobileFirst Analytics Services and Console on WebSphere Application Server full profile	configure-was-analytics.xml
Install MobileFirst Analytics Services and Console on WebSphere Application Server Network Deployment, single server	configure-wasnd-server-analytics.xml
Install MobileFirst Analytics Services and Console on WebSphere Application Server Network Deployment, cell	configure-wasnd-cell-analytics.xml
Install MobileFirst Analytics Services and Console on WebSphere Application Server Network Deployment, node	configure-wasnd-node.xml
Install MobileFirst Analytics Services and Console on WebSphere Application Server Network Deployment, cluster	configure-wasnd-cluster-analytics.xml

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-analytics.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 we must prevent other users on the same computer from learning these passwords, we must remove the read permissions of the file for users other than yourself. We 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 your application server is WebSphere Application Server Liberty profile, or Apache Tomcat, and the server is meant to be started only from your user account, we must also remove the read permissions for users other than yourself from the following files:

• 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 must be escaped when they are used in the values of the 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 section of the Apache Ant Manual.
• The ampersand character (& ) must be written as &amp;, unless you explicitly want to reference an XML entity.
• Double quotation marks (") must be written as &quot;, except when it is inside a string that is enclosed in single quotation marks.

Step 5

Run the command:

ant -f configure-file.xml install

This command installs your MobileFirst Analytics Services and MobileFirst Analytics Console components in the application server.

To install updated MobileFirst Analytics Services and MobileFirst Analytics Console components, for example if you apply a MobileFirst Server fix pack, run the following 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 Analytics Services and MobileFirst Analytics Console components.

Parent topic: Installation reference