Installing PMF Analytics Receiver Server

PMF Analytics Receiver Server is implemented and shipped as Java EE standard web application archive (WAR) file. Therefore, it can be installed in any one of the following supported application server: WebSphere Application Server Liberty (WAR files only).

System requirements

For more details on the software and hardware requirements, see System requirements.

Capacity considerations

Capacity is the single-most common question. How much RAM do you need? How much disk space? How many nodes? The answer is always subjective.

PMF Analytics Receiver does not require disk space since it just receives logs from mobile applications and forwards them to analytics server, there is no storage of events data.

Installing PMF Analytics Receiver on WebSphere Application Server Liberty

Ensure that you already have the PMF Analytics Receiver WAR file. The analytics-receiver.war file is found in the <pmf_install_dir>\Analyticsreceiver folder.

For more information on the installation artifacts, see Installing PMF to an application server.

Create a server by running the following command in your ./wlp/bin folder.
```
./server create <serverName>
```

Install features by running the following command from your ./bin folder.

./featureManager install jsp-2.2 ssl-1.0 appSecurity-1.0 localConnector-1.0

Add the analytics-receiver.war file to the ./usr/servers/<serverName>/apps folder of your Liberty Server.

Replace the contents of the **** tag of the `./usr/servers//server.xml` file with the following content:

<featureManager>
     <feature>jsp-2.2</feature>
     <feature>ssl-1.0</feature>
     <feature>appSecurity-1.0</feature>
     <feature>localConnector-1.0</feature>
</featureManager>

Configure analytics-receiver.war as an application with role-based security in the server.xml file. The following example creates a basic hardcoded user registry and assigns a user to each of the different analytics roles.

<application id="analytics-receiver" name="analytics-receiver" location="analytics-receiver.war" type="war">
     <application-bnd>
         <security-role name="analytics_administrator">
             <user name="admin"/>
         </security-role>
         <security-role name="analytics_infrastructure">
             <user name="infrastructure"/>
         </security-role>
         <security-role name="analytics_support">
             <user name="support"/>
         </security-role>
         <security-role name="analytics_developer">
             <user name="developer"/>
         </security-role>
         <security-role name="analytics_business">
             <user name="business"/>
         </security-role>
     </application-bnd>
</application>

<basicRegistry id="worklight" realm="worklightRealm">
     <user name="business" password="demo"/>
     <user name="developer" password="demo"/>
     <user name="support" password="demo"/>
     <user name="infrastructure" password="demo"/>
     <user name="admin" password="admin"/>
</basicRegistry>

For more information on how to configure other user registry types, such as LDAP, see the Configuring a user registry for Liberty topic in the WebSphere Application Server product documentation.

Start the Liberty Server by running the following command inside your bin folder.
```
./server start <serverName>
```
Verify the service by invoking health URL.
```
http://localhost:9080/analytics-receiver/rest/data/health
```
For more information on administering WebSphere Application Server Liberty, see the Administering Liberty from the command line topic in the WebSphere Application Server product documentation.
Change the JAVA_HOME for Analytics.
- On the analytics server instance, go to the server.env file.
- Set the java home to java 8 by adding the following line.
  
  JAVA_HOME= <path to the jdk 8 folder> (path to directory above the bin)

Installing PMF Analytics Receiver with Ant tasks

Ensure that you have the necessary WAR and configuration files: analytics-receiver.war. The analytics-receiver.war file is found in the MobileFoundationServer\AnalyticsReceiver.

For more information on the installation artifacts, see Installing PMF to an application server.

You must run the Ant task on the computer where the application server is installed. If you want to start the Ant task from a computer on which PMF is not installed, you must copy the file \<pmf_install_dir\>/MobileFoundationServer/mfp-ant-deployer.jar to that computer.

Note: The pmf_install_dir is the directory where you installed PMF.

Edit the Ant script that you will use later to deploy PMF Analytics ReceiverWAR files.
- Review the sample configuration files in Sample configuration files for Persistent Mobile Foundation Analytics Receiver.
- Replace the placeholder values with 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 the Properties section of 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 it is inside a string that is enclosed in single quotation marks.

To deploy the WAR file, run the following command:

ant -f configure-appServer-analytics-receiver.xml install

Save the Ant file. You might need it later to apply a fix pack or perform an upgrade. If you do not want to save the passwords, you can replace them by ************ (12 asterisks) for interactive prompting.

Prerequisites to run the Analytics

For more information, see Prerequisites section - Installing and Configuring the Persistent Mobile Foundation Analytics Server.

▲

Last modified on